From ad2d4574c1521d0341ea1981d1dd21f05d03886c Mon Sep 17 00:00:00 2001 From: Andrew Bulat Date: Tue, 19 Nov 2024 04:07:41 +0000 Subject: [PATCH] Move types required for user-provided LiveObjects typings to ably.d.ts --- ably.d.ts | 25 ++++++++++++++++++++++--- src/plugins/liveobjects/livemap.ts | 8 ++++---- src/plugins/liveobjects/liveobjects.ts | 3 +-- src/plugins/liveobjects/typings.ts | 22 ---------------------- 4 files changed, 27 insertions(+), 31 deletions(-) delete mode 100644 src/plugins/liveobjects/typings.ts diff --git a/ably.d.ts b/ably.d.ts index 9154ef81c..35254837f 100644 --- a/ably.d.ts +++ b/ably.d.ts @@ -2029,13 +2029,32 @@ export declare interface PushChannel { * Enables the LiveObjects state to be subscribed to for a channel. */ export declare interface LiveObjects { - getRoot(): Promise; + getRoot(): Promise>; } // TODO: document public API for LiveObjects -export declare interface LiveMap extends LiveObject { - get(key: string): LiveObject | StateValue | undefined; +declare global { + // a global interface which can be used by users to define their own types for LiveObjects. + export interface LiveObjectsTypes { + [key: string]: unknown; + } +} + +// LiveMap type representation of how it looks to the user. A mapping of string keys to scalar values (StateValue) or other Live Objects. +export type LiveMapType = { [key: string]: StateValue | LiveMap | LiveCounter | undefined }; + +export type DefaultRoot = + // we need a way to know when no types were provided by the user. + // we expect a "root" property to be set on LiveObjectsTypes interface, e.g. it won't be "unknown" anymore + unknown extends LiveObjectsTypes['root'] + ? LiveMapType // no types provided by the user, use the default map type for the root + : LiveObjectsTypes['root'] extends LiveMapType + ? LiveObjectsTypes['root'] // "root" was provided by the user, and it is of an expected type, we can use this interface for the root object in LiveObjects. + : `Provided type definition for the "root" object in LiveObjectsTypes is not of an expected LiveMapType type`; + +export declare interface LiveMap extends LiveObject { + get(key: TKey): T[TKey]; size(): number; } diff --git a/src/plugins/liveobjects/livemap.ts b/src/plugins/liveobjects/livemap.ts index c452b71d2..3d5109436 100644 --- a/src/plugins/liveobjects/livemap.ts +++ b/src/plugins/liveobjects/livemap.ts @@ -1,5 +1,6 @@ import deepEqual from 'deep-equal'; +import type * as API from '../../../ably'; import { LiveObject, LiveObjectData, LiveObjectUpdate, LiveObjectUpdateNoop } from './liveobject'; import { LiveObjects } from './liveobjects'; import { @@ -13,7 +14,6 @@ import { StateValue, } from './statemessage'; import { DefaultTimeserial, Timeserial } from './timeserial'; -import { LiveMapType } from './typings'; export interface ObjectIdStateData { /** A reference to another state object, used to support composable state objects. */ @@ -46,7 +46,7 @@ export interface LiveMapUpdate extends LiveObjectUpdate { update: { [keyName: string]: 'updated' | 'removed' }; } -export class LiveMap extends LiveObject { +export class LiveMap extends LiveObject { constructor( liveObjects: LiveObjects, private _semantics: MapSemantics, @@ -60,7 +60,7 @@ export class LiveMap extends LiveObject(liveobjects: LiveObjects, objectId: string): LiveMap { + static zeroValue(liveobjects: LiveObjects, objectId: string): LiveMap { return new LiveMap(liveobjects, MapSemantics.LWW, objectId); } @@ -70,7 +70,7 @@ export class LiveMap extends LiveObject(liveobjects: LiveObjects, stateObject: StateObject): LiveMap { + static fromStateObject(liveobjects: LiveObjects, stateObject: StateObject): LiveMap { const obj = new LiveMap(liveobjects, stateObject.map?.semantics!, stateObject.objectId); obj.overrideWithStateObject(stateObject); return obj; diff --git a/src/plugins/liveobjects/liveobjects.ts b/src/plugins/liveobjects/liveobjects.ts index 741544d55..75b743d5b 100644 --- a/src/plugins/liveobjects/liveobjects.ts +++ b/src/plugins/liveobjects/liveobjects.ts @@ -8,7 +8,6 @@ import { LiveObject, LiveObjectUpdate } from './liveobject'; import { LiveObjectsPool, ROOT_OBJECT_ID } from './liveobjectspool'; import { StateMessage } from './statemessage'; import { SyncLiveObjectsDataPool } from './syncliveobjectsdatapool'; -import { DefaultRoot, LiveMapType } from './typings'; enum LiveObjectsEvents { SyncCompleted = 'SyncCompleted', @@ -42,7 +41,7 @@ export class LiveObjects { * A user can provide an explicit type for the getRoot method to explicitly set the LiveObjects type structure on this particular channel. * This is useful when working with LiveObjects on multiple channels with different underlying data. */ - async getRoot(): Promise> { + async getRoot(): Promise> { // SYNC is currently in progress, wait for SYNC sequence to finish if (this._syncInProgress) { await this._eventEmitter.once(LiveObjectsEvents.SyncCompleted); diff --git a/src/plugins/liveobjects/typings.ts b/src/plugins/liveobjects/typings.ts deleted file mode 100644 index 879b6a29c..000000000 --- a/src/plugins/liveobjects/typings.ts +++ /dev/null @@ -1,22 +0,0 @@ -import { LiveCounter } from './livecounter'; -import { LiveMap } from './livemap'; -import { StateValue } from './statemessage'; - -declare global { - // define a global interface which can be used by users to define their own types for LiveObjects. - export interface LiveObjectsTypes { - [key: string]: unknown; - } -} - -// LiveMap type representation of how it looks to the end-user. A mapping of string keys to the scalar values (StateValue) or other Live Objects. -export type LiveMapType = { [key: string]: StateValue | LiveMap | LiveCounter | undefined }; - -export type DefaultRoot = - // we need a way to understand when no types were provided by the user. - // we expect a "root" property to be set on LiveObjectsTypes interface, e.g. it won't be "unknown" anymore - unknown extends LiveObjectsTypes['root'] - ? LiveMapType // no types provided by the user, use the default map type for the root - : LiveObjectsTypes['root'] extends LiveMapType - ? LiveObjectsTypes['root'] // "root" was provided by the user, and it is of an expected type, we can use this interface for the root object in LiveObjects. - : `Provided type definition for the "root" object in LiveObjectsTypes is not of an expected LiveMapType type`;