@dittolive/ditto 4.12.0 → 5.0.0-experimental.js-cocoapods-publishing.3

package/types/ditto.d.ts

@@ -693,7 +693,7 @@ declare class Authenticator {
     /** @internal */
     constructor(keepAlive: KeepAlive);
     /** @internal */
-    '@ditto.authenticationExpiring'(secondsRemaining: number): void;
+    '@ditto.authenticationExpiring'(number: any): void;
     /** @internal */
     close(): void;
     /** @internal */
@@ -4421,7 +4421,6 @@ type Connection = {
      * and stable for any two peers.
      */
     peerKeyString2: string;
-    approximateDistanceInMeters?: number;
 };
 /**
  * The operating system a peer is running on, if known.
@@ -4647,28 +4646,53 @@ declare class Presence {
  *
  * Create a sync subscription by calling
  * {@link Sync.registerSubscription | `ditto.sync.registerSubscription()`}.
- *
- * @template T The type of query arguments passed to the sync subscription.
  */
-declare class SyncSubscription<T extends DQLQueryArguments = DQLQueryArguments> {
+declare class SyncSubscription {
     /**
      * Documents matching this query will be included in the sync subscription.
      */
-    readonly queryString: string;
+    get queryString(): string;
     /**
-     * The query arguments of the sync subscription (as passed when
-     * adding it to the store).
+     * The query arguments of the sync subscription (as passed when adding it to
+     * the store).
+     *
+     * Note that this value is not guaranteed to be strictly equal to the value
+     * used when registering the sync subscription. In particular, any
+     * {@link Attachment} values in query arguments will be represented by that
+     * attachment's {@link AttachmentToken} here.
+     *
+     * Also see {@link queryArgumentsCBORData} and
+     * {@link queryArgumentsJSONString} for the raw serialized representations of
+     * the query arguments.
      */
-    readonly queryArguments?: Readonly<T>;
+    get queryArguments(): Readonly<any> | undefined;
     /**
-     * The {@link Ditto} instance this sync subscription belongs to.
+     * The query arguments of the sync subscription, serialized as CBOR, (as
+     * passed when adding it to the store).
+     *
+     * Note that any {@link Attachment} values passed in as query arguments when
+     * creating this sync subscription will be represented by that attachment's
+     * {@link AttachmentToken} here.
      */
-    readonly ditto: Ditto;
+    get queryArgumentsCBORData(): Uint8Array | undefined;
+    /**
+     * The query arguments of the sync subscription, serialized as JSON, (as
+     * passed when adding it to the store).
+     *
+     * Note that any {@link Attachment} values passed in as query arguments when
+     * creating this sync subscription will be represented by that attachment's
+     * {@link AttachmentToken} here.
+     */
+    get queryArgumentsJSONString(): string | undefined;
     /**
      * `true` when the sync subscription has been cancelled or the {@link Ditto}
      * instance managing this subscription has been closed.
      */
     get isCancelled(): boolean;
+    /**
+     * The {@link Ditto} instance this sync subscription belongs to.
+     */
+    readonly ditto: Ditto;
     /**
      * Cancels the sync subscription and unregisters it. No-op
      * if the sync subscription has already been cancelled or the {@link Ditto}
@@ -4676,22 +4700,8 @@ declare class SyncSubscription<T extends DQLQueryArguments = DQLQueryArguments>
      */
     cancel(): void;
     /** @internal */
-    constructor(ditto: Ditto, query: string, queryArguments: T | null, queryArgumentsCBOR: Uint8Array | null);
-    /**
-     * The CBOR-encoded query arguments, or `null` if no query arguments were
-     * passed in.
-     *
-     * @internal
-     */
-    readonly queryArgumentsCBOR: Uint8Array | null;
-    /**
-     * `true` when the sync subscription has been cancelled.
-     *
-     * We mark the sync subscription as cancelled here as an optimization to avoid
-     * a scan of all subscriptions in the store whenever the `isCancelled`
-     * property is checked.
-     */
-    private _isCancelled;
+    constructor(ditto: Ditto);
+    private deref;
 }
 
 /**
@@ -4713,7 +4723,7 @@ declare class Sync {
      * {@link SyncSubscription.cancel | SyncSubscription.cancel()} to remove an
      * existing sync subscription.
      */
-    readonly subscriptions: Readonly<Array<SyncSubscription<any>>>;
+    get subscriptions(): Readonly<Array<SyncSubscription>>;
     /**
      * Returns `true` if sync is active, otherwise returns `false`. Use
      * {@link Sync.start | ditto.sync.start()} to activate and
@@ -4764,7 +4774,6 @@ declare class Sync {
      * @param query a string containing a valid query expressed in DQL.
      * @param queryArguments an object containing the arguments for the query.
      * Example: `{mileage: 123}` for a query with `:mileage` placeholder.
-     * @template T The type of the query arguments.
      * @returns An active `SyncSubscription` for the passed in query and
      * arguments. It will remain active until it is
      * {@link SyncSubscription.cancel | cancelled} or the {@link Ditto} instance
@@ -4777,26 +4786,9 @@ declare class Sync {
      * `SELECT` query.
      * @throws {@link DittoError} may throw other errors.
      */
-    registerSubscription<T extends DQLQueryArguments = DQLQueryArguments>(query: string, queryArguments?: T): SyncSubscription<T>;
+    registerSubscription(query: string, queryArguments?: DQLQueryArguments): SyncSubscription;
     /** @internal */
     constructor(ditto: Ditto);
-    /**
-     * Removes the passed in `syncSubscription`, configuring Ditto to not receive
-     * updates for documents matching the corresponding query anymore. No-op if
-     * the passed in `syncSubscription` has already been removed.
-     *
-     * This must only be called by the sync subscription itself.
-     *
-     * @param syncSubscription the sync subscription to remove
-     * @returns `true` if the passed in sync subscription could be found and has
-     * been removed, otherwise returns `false`.
-     * @throws {@link DittoError} `internal`: if the replication subscription does not
-     * belong to this store
-     * @throws {@link DittoError} `internal`: if the replication subscription has not
-     * been cancelled yet
-     * @internal
-     */
-    unregisterSubscription(syncSubscription: SyncSubscription): boolean;
     /** @internal */
     close(): void;
 }
@@ -5430,6 +5422,8 @@ declare class Bridge<T extends object, FFIType> {
     /** @internal */
     static readonly differ: Bridge<Differ, "dittoffi_differ_t">;
     /** @internal */
+    static readonly syncSubscription: Bridge<SyncSubscription, "dittoffi_sync_subscription_t">;
+    /** @internal */
     static readonly ditto: Bridge<Ditto, "CDitto_t">;
     private internalType;
     /**
@@ -5463,8 +5457,6 @@ type PresenceConnectionType = 'WiFi' | 'WebSocket' | 'AWDL' | 'BLE';
 type RemotePeer = {
     networkID: string;
     deviceName: string;
-    rssi?: number;
-    approximateDistanceInMeters?: number;
     connections: PresenceConnectionType[];
 };
 /**
@@ -5865,20 +5857,6 @@ declare class Ditto {
      * @deprecated use {@link Sync.stop | ditto.sync.stop()} instead.
      */
     stopSync(): void;
-    /**
-     * Registers an observer for info about Ditto peers in range of this device.
-     *
-     * Ditto will prevent the process from exiting as long as there are active
-     * peers observers (not relevant when running in the browser).
-     *
-     * @param callback called immediately with the current state of peers
-     * in range and whenever that state changes. Then it will be invoked
-     * repeatedly when Ditto devices come and go, or the active connections to
-     * them change.
-     *
-     * @deprecated please use {@link Presence.observe | presence.observe()} instead.
-     */
-    observePeers(callback: (peersData: RemotePeer[]) => void): Observer;
     /**
      * Register observer for changes of underlying transport conditions.
      *
@@ -5980,7 +5958,6 @@ declare class Ditto {
      */
     deferCloseAsync<T>(closure: (dittoHandle: Handle<Ditto, FFIDitto>) => Promise<T>): Promise<T>;
     private deferCloseAllowed;
-    private presenceManager;
     private transportConditionsManager;
     private _isClosed;
     /** Set of pending operations that need to complete before the Ditto instance can be closed in a safe manner. */
@@ -6129,7 +6106,7 @@ type DQLQueryArguments = {
 /**
  * Individual value in a {@link DQLQueryArguments} object.
  */
-type DQLQueryArgumentValue = string | number | boolean | Uint8Array | null | Attachment | DocumentID | DQLQueryArgumentValue[] | {
+type DQLQueryArgumentValue = string | number | boolean | Uint8Array | null | Attachment | AttachmentToken | DocumentID | DQLQueryArgumentValue[] | {
     [key: string]: DQLQueryArgumentValue;
 };
 
@@ -6354,6 +6331,8 @@ declare class CBOR {
     /** @internal */
     static encode(data: any): Uint8Array;
     /** @internal */
+    static encodeWithReplacer(data: any, replacer: (key: any, value: any) => any): Uint8Array;
+    /** @internal */
     static decode(data: Uint8Array, reviver?: (key: any, value: any) => any): any;
 }