@dittolive/ditto 1.1.2 → 1.1.3

package/types/ditto.d.ts

@@ -334,6 +334,8 @@ interface IdentityManual {
     certificate: string;
 }
 /**
+ * Deprecated - use `IdentityOnlinePlaygroundV2` instead.
+ *
  * Test a Ditto Cloud app without authentication ("Playground mode"). This mode
  * offers no security and must only be used for development.
  */
@@ -346,6 +348,40 @@ interface IdentityOnlinePlayground {
     appID: string;
     /** If true, auto-configure sync with Ditto Cloud. Default is `true`. */
     enableDittoCloudSync?: boolean;
+    /**
+     * A custom Ditto Cloud URL.
+     * @internal
+     */
+    customDittoCloudURL?: string;
+}
+/**
+ * Test a Ditto Cloud app with weak shared token authentication ("Playground
+ * mode"). This mode is not secure and must only be used for development.
+ */
+interface IdentityOnlinePlaygroundV2 {
+    type: 'onlinePlaygroundV2';
+    /**
+     * An ID identifying this app registration on the Ditto portal, which can be
+     * found at https://portal.ditto.live.
+     */
+    appID: string;
+    /**
+     * A shared token used to set up the OnlinePlayground session. This token is
+     * provided by the Ditto Portal when setting up the application.
+     */
+    token: string;
+    /** If true, auto-configure sync with Ditto Cloud. Default is `true`. */
+    enableDittoCloudSync?: boolean;
+    /**
+     * If specified, use a custom authentication service instead of Ditto Cloud.
+     * @internal
+     */
+    customAuthURL?: string;
+    /**
+     * A custom Ditto Cloud URL.
+     * @internal
+     */
+    customDittoCloudURL?: string;
 }
 /**
  * Deprecated - use `IdentityOnlineWithAuthentication` instead.
@@ -391,6 +427,11 @@ interface IdentityOnline {
      * If specified, use a custom authentication service instead of Ditto Cloud.
      */
     customAuthURL?: string;
+    /**
+     * A custom Ditto Cloud URL.
+     * @internal
+     */
+    customDittoCloudURL?: string;
 }
 /**
  * Run Ditto in secure production mode, logging on to Ditto Cloud or an
@@ -431,19 +472,21 @@ interface IdentityOnlineWithAuthentication {
      * If specified, use a custom authentication service instead of Ditto Cloud.
      */
     customAuthURL?: string;
+    /**
+     * A custom Ditto Cloud URL.
+     * @internal
+     */
+    customDittoCloudURL?: string;
 }
 /**
  * The various identity configurations that you can use when initializing a
  * `Ditto` instance.
  */
-declare type Identity = IdentityDevelopment | IdentityOfflinePlayground | IdentitySharedKey | IdentityProduction | IdentityManual | IdentityOnlinePlayground | IdentityOnline | IdentityOnlineWithAuthentication;
+declare type Identity = IdentityDevelopment | IdentityOfflinePlayground | IdentitySharedKey | IdentityProduction | IdentityManual | IdentityOnlinePlayground | IdentityOnlinePlaygroundV2 | IdentityOnline | IdentityOnlineWithAuthentication;
 /** The list of identity types that require activation through an offlineLicenseToken */
 declare const IdentityTypesRequiringOfflineLicenseToken: string[];
 
-/**
- * TODO: document.
- * @internal
- */
+/** @internal */
 declare class Bridge<JSClass extends object, FFIType> {
     type: Function;
     release: (pointer: Pointer<FFIType>) => void;
@@ -452,18 +495,24 @@ declare class Bridge<JSClass extends object, FFIType> {
      * that is called whenever a registered object is garbage collected, passing
      * the associated `pointer` to it. The release function is then responsible
      * to free or drop the corresponding native object.
+     *
+     * @internal
      */
     constructor(type: Function, release: (pointer: Pointer<FFIType>) => void, options?: {});
     /**
      * Returns the FFI pointer for `object` if registered, otherwise returns
      * `undefined`. If `object` has been unregistered before, returns
      * `undefined`, too.
+     *
+     * @internal
      */
     pointerFor(object: JSClass): Pointer<FFIType> | undefined;
     /**
      * Convenience method, returns the object for the FFI `pointer` if registered,
      * otherwise returns `undefined`. If the object associated with the `pointer`
      * has been unregistered before, returns `undefined`, too.
+     *
+     * @internal
      */
     objectFor(pointer: Pointer<FFIType>): JSClass | undefined;
     /**
@@ -472,16 +521,20 @@ declare class Bridge<JSClass extends object, FFIType> {
      * returns after registering. If no `create` function is given, uses the
      * type of the bridge as a constructor and creates a new instance of it
      * without passing any parameters.
+     *
+     * @internal
      */
-    bridge(pointer: Pointer<FFIType>, create?: () => JSClass, options?: {}): JSClass;
-    /**
-     * TODO: document.
-     */
+    bridge(pointer: Pointer<FFIType>, objectOrCreate?: object | (() => JSClass), options?: {}): JSClass;
+    /** @internal */
     register(object: JSClass, pointer: Pointer<FFIType>): void;
-    /**
-     * TODO: document.
-     */
+    /** @internal */
     unregister(object: JSClass): void;
+    /** @internal */
+    unregisterAll(): void;
+    /** @internal */
+    get count(): number;
+    /** @internal */
+    static readonly all: any[];
     private metaByAddrMap;
     private finalizationRegistry;
     private finalize;
@@ -2244,9 +2297,7 @@ declare class Ditto {
     private validateIdentity;
     private setSyncEnabled;
 }
-/**
- * @internal
- */
+/** @internal */
 declare const dittoBridge: Bridge<Ditto, "CDitto_t">;
 
 /** @internal */
@@ -2424,7 +2475,6 @@ declare class NotAvailableAuthenticator extends Authenticator {
     loginWithUsernameAndPassword(username: string, password: string, provider: string): Promise<void>;
     logout(cleanupFn?: (Ditto: any) => void): Promise<void>;
     '@ditto.authenticationExpiring': (secondsRemaining: any) => never;
-    /** @internal */
     '@ditto.authClientValidityChanged': (isWebValid: boolean, isX509Valid: boolean) => void;
 }
 
@@ -2636,5 +2686,5 @@ declare class CBOR {
     static decode(data: Uint8Array): any;
 }
 
-export { Attachment, AttachmentFetchEvent, AttachmentFetchEventCompleted, AttachmentFetchEventDeleted, AttachmentFetchEventProgress, AttachmentFetchEventType, AttachmentFetcher, AttachmentToken, AuthenticationHandler, AuthenticationStatus, Authenticator, CBOR, Collection, CollectionsEvent, CollectionsEventParams, ConditionSource, Counter, CustomLogCallback, Ditto, Document, DocumentIDValue, DocumentLike, DocumentPath, DocumentValue, Identity, IdentityDevelopment, IdentityManual, IdentityOfflinePlayground, IdentityOnline, IdentityOnlinePlayground, IdentityOnlineWithAuthentication, IdentityProduction, IdentitySharedKey, IdentityTypesRequiringOfflineLicenseToken, InitOptions, InsertOptions, KeepAlive, LiveQuery, LiveQueryEvent, LiveQueryEventInitial, LiveQueryEventUpdate, LiveQueryEventUpdateParams, LiveQueryMove, LogLevel, Logger, MutableDocument, MutableDocumentLike, MutableDocumentPath, NotAvailableAuthenticator, Observer, ObserverOptions, OnlineAuthenticator, PendingCursorOperation, PendingIDSpecificOperation, PresenceConnectionType, QueryArguments, QueryObservationHandler, RemotePeer, SingleDocumentLiveQueryEvent, SingleObservationHandler, SortDirection, Store, Subscription, SubscriptionContextInfo, TransportCondition, TransportConfig, TransportConfigConnect, TransportConfigGlobal, TransportConfigLan, TransportConfigListen, TransportConfigListenHTTP, TransportConfigListenTCP, TransportConfigPeerToPeer, UpdateResult, UpdateResultType, UpdateResultsMap, UpsertOptions, Value, WebAssemblyModule, WriteStrategy, __log, attachmentBridge, dittoBridge, documentBridge, init, mutableDocumentBridge, validateDocumentIDCBOR, validateDocumentIDValue };
+export { Attachment, AttachmentFetchEvent, AttachmentFetchEventCompleted, AttachmentFetchEventDeleted, AttachmentFetchEventProgress, AttachmentFetchEventType, AttachmentFetcher, AttachmentToken, AuthenticationHandler, AuthenticationStatus, Authenticator, CBOR, Collection, CollectionsEvent, CollectionsEventParams, ConditionSource, Counter, CustomLogCallback, Ditto, Document, DocumentIDValue, DocumentLike, DocumentPath, DocumentValue, Identity, IdentityDevelopment, IdentityManual, IdentityOfflinePlayground, IdentityOnline, IdentityOnlinePlayground, IdentityOnlinePlaygroundV2, IdentityOnlineWithAuthentication, IdentityProduction, IdentitySharedKey, IdentityTypesRequiringOfflineLicenseToken, InitOptions, InsertOptions, KeepAlive, LiveQuery, LiveQueryEvent, LiveQueryEventInitial, LiveQueryEventUpdate, LiveQueryEventUpdateParams, LiveQueryMove, LogLevel, Logger, MutableDocument, MutableDocumentLike, MutableDocumentPath, NotAvailableAuthenticator, Observer, ObserverOptions, OnlineAuthenticator, PendingCursorOperation, PendingIDSpecificOperation, PresenceConnectionType, QueryArguments, QueryObservationHandler, RemotePeer, SingleDocumentLiveQueryEvent, SingleObservationHandler, SortDirection, Store, Subscription, SubscriptionContextInfo, TransportCondition, TransportConfig, TransportConfigConnect, TransportConfigGlobal, TransportConfigLan, TransportConfigListen, TransportConfigListenHTTP, TransportConfigListenTCP, TransportConfigPeerToPeer, UpdateResult, UpdateResultType, UpdateResultsMap, UpsertOptions, Value, WebAssemblyModule, WriteStrategy, __log, attachmentBridge, dittoBridge, documentBridge, init, mutableDocumentBridge, validateDocumentIDCBOR, validateDocumentIDValue };
 //# sourceMappingURL=ditto.d.ts.map