@dittolive/ditto 3.0.0 → 4.0.0-alpha2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dittolive/ditto",
-  "version": "3.0.0",
+  "version": "4.0.0-alpha2",
   "description": "Ditto is a cross-platform embeddable NoSQL database that can sync with or without an internet connection.",
   "homepage": "https://ditto.live",
   "license": "SEE LICENSE IN LICENSE.md",
@@ -45,6 +45,6 @@
   },
 
   "devDependencies": {
-    "serve": "^14.0.1"
+    "serve": "^14.1.2"
   }
 }

package/types/ditto.d.ts

@@ -1,7 +1,7 @@
 /**
  * Describes the direction when sorting a query.
  */
-declare type SortDirection = 'ascending' | 'descending';
+type SortDirection = 'ascending' | 'descending';
 /**
  * Defines the various strategies available when inserting a document into a
  * collection.
@@ -21,37 +21,37 @@ declare type SortDirection = 'ascending' | 'descending';
  *    data amongst all peers and that you expect to be mutated or overwritten in
  *    due course.
  */
-declare type WriteStrategy = 'merge' | 'insertIfAbsent' | 'insertDefaultIfAbsent';
+type WriteStrategy = 'merge' | 'insertIfAbsent' | 'insertDefaultIfAbsent';
 /**
  * Represents a dictionary of values to be incorporated into a query keyed
  * by the placeholder used within that query. See method
  * {@link Collection.find | find()} of {@link Collection} for more info.
  */
-declare type QueryArguments = {
+type QueryArguments = {
     [key: string]: any;
 };
 
 /** @internal */
-declare type Pointer<Type> = {
+type Pointer<Type> = {
     type: Type;
     addr: string;
 };
 /** @internal */
-declare type FFIAuthClient = 'CAuthClient_t';
+type FFIAuthClient = 'CAuthClient_t';
 /** @internal */
-declare type OrderBy = {
+type OrderBy = {
     query: string;
     direction: 'Ascending' | 'Descending';
 };
 /** @internal */
-declare type PathAccessorType = 'String' | 'Number' | 'Int' | 'UInt' | 'Float' | 'Double' | 'Bool' | 'Null' | 'Object' | 'Array' | 'Any' | 'Counter' | 'Register' | 'Attachment' | 'Rga' | 'RWMap';
+type PathAccessorType = 'String' | 'Number' | 'Int' | 'UInt' | 'Float' | 'Double' | 'Bool' | 'Null' | 'Object' | 'Array' | 'Any' | 'Counter' | 'Register' | 'Attachment' | 'Rga' | 'RWMap';
 /** Various options to pass the web assembly module to Ditto. */
-declare type WebAssemblyModule = RequestInfo | URL | Response | BufferSource | WebAssembly.Module | string | null;
+type WebAssemblyModule = RequestInfo | URL | Response | BufferSource | WebAssembly.Module | string | null;
 
 /**
  * Available options for {@link init | init()}.
  */
-declare type InitOptions = {
+type InitOptions = {
     /**
      * You can explicitly pass the WebAssembly module or its location via the
      * `webAssemblyModule` option. By default, Ditto tries to load the WebAssembly
@@ -165,6 +165,23 @@ interface TransportConfigGlobal {
      * Ditto's permissions system.
      */
     syncGroup: number;
+    /**
+     * The routing hint for this device.
+     *
+     * A routing hint is a performance tuning option which can improve the performance of
+     * applications that use large collections. Ditto will make a best effort to co-locate data for
+     * the same routing key. In most circumstances, this should substantially improve responsiveness
+     * of the Ditto Cloud.
+     *
+     * The value of the routing hint is application specific - you are free to chose any value.
+     * Devices which you expect to operate on much the same data should be configured to
+     * use the same value.
+     *
+     * A routing hint does not partition data. The value of the routing hint will not affect the data
+     * returned for a query. The routing hint only improves the efficiency of the Cloud's
+     * ability to satisfy the query.
+     */
+    routingHint: number;
 }
 /**
  * A configuration object specifying which network transports Ditto should
@@ -367,7 +384,7 @@ interface IdentityOnlineWithAuthentication {
  * The various identity configurations that you can use when initializing a
  * `Ditto` instance.
  */
-declare type Identity = IdentityOfflinePlayground | IdentitySharedKey | IdentityManual | IdentityOnlinePlayground | IdentityOnlineWithAuthentication;
+type Identity = IdentityOfflinePlayground | IdentitySharedKey | IdentityManual | IdentityOnlinePlayground | IdentityOnlineWithAuthentication;
 /** The list of identity types that require activation through an offlineLicenseToken */
 declare const IdentityTypesRequiringOfflineLicenseToken: string[];
 
@@ -426,7 +443,7 @@ declare class Bridge<JSClass extends object, FFIType> {
 }
 
 /** Represents a unique identifier for a {@link Document}. */
-declare type DocumentIDValue = any;
+type DocumentIDValue = any;
 /** Represents a unique identifier for a {@link Document}. */
 declare class DocumentID {
     /**
@@ -509,7 +526,7 @@ declare function validateDocumentIDCBOR(idCBOR: Uint8Array): Uint8Array;
 /**
  * The types of an {@link UpdateResult}.
  */
-declare type UpdateResultType = 'set' | 'incremented' | 'removed';
+type UpdateResultType = 'set' | 'incremented' | 'removed';
 declare class UpdateResult {
     /** The update result's type. */
     readonly type: UpdateResultType;
@@ -620,25 +637,6 @@ declare class MutableRegister extends Register {
     constructor(value: any);
 }
 
-/**
- * Represents a CRDT Replicated Growable Array (RGA).
- *
- * RGAs are deprecated and you should instead use a `Register` containing an
- * array.
- */
-declare class RGA {
-    /** The array representation of the RGA. */
-    get value(): any[];
-    /** @internal */
-    private constructor();
-    /** @internal */
-    static '@ditto.create'(path: any, value: any): RGA;
-    /** @internal */
-    protected '@ditto.path': any;
-    /** @internal */
-    protected '@ditto.value': any;
-}
-
 /**
  * Serves as a token for a specific attachment that you can pass to a call to
  * {@link Collection.fetchAttachment | fetchAttachment()} on a
@@ -706,14 +704,6 @@ declare class DocumentPath {
      * {@link Register} if possible, otherwise returns `null`.
      */
     get register(): Register | null;
-    /**
-     * Returns the value at the previously specified key in the document as an
-     * {@link RGA} if possible, otherwise returns `null`.
-     *
-     * @deprecated RGA usage should be replaced. Use arrays inside Registers
-     * instead.
-     */
-    get rga(): RGA | null;
     /**
      * Returns the value at the previously specified key in the document as an
      * {@link AttachmentToken} if possible, otherwise returns `null`.
@@ -770,18 +760,6 @@ declare class MutableDocumentPath {
      * {@link MutableRegister} if possible, otherwise returns `null`.
      */
     get register(): MutableRegister | null;
-    /**
-     * Returns the value at the previously specified key in the document as a
-     * {@link RGA} if possible, otherwise returns `null`.
-     *
-     * Note that the returned type, {@link RGA}, is deprecated and does not allow
-     * any mutation. RGAs cannot be created or mutated with this version of the
-     * SDK; they can only be read and this is for backwards compatibility reasons.
-     *
-     * @deprecated RGA usage should be replaced. Use arrays inside Registers
-     * instead.
-     */
-    get rga(): RGA | null;
     /**
      * Returns the value at the previously specified key in the document as a
      * {@link AttachmentToken} if possible, otherwise returns `null`.
@@ -798,8 +776,6 @@ declare class MutableDocumentPath {
     set(value: any, isDefault?: boolean): void;
     /**
      * Removes a value at the document's key-path defined by the receiver.
-     * If removing an index from an `RGA`, any subsequent indexes will be shifted
-     * left to fill the gap.
      */
     remove(): void;
     /** @internal */
@@ -822,7 +798,7 @@ declare class MutableDocumentPath {
  * A document value is a JavaScript object containing values for keys that
  * can be serialized via CBOR.
  */
-declare type DocumentValue = Record<string, any>;
+type DocumentValue = Record<string, any>;
 /** A document belonging to a {@link Collection} with an inner value. */
 declare class Document {
     /**
@@ -938,11 +914,11 @@ declare const attachmentBridge: Bridge<Attachment, "AttachmentHandle_t">;
  * The types of attachment fetch events that can be delivered to an attachment
  * fetcher's `callback`.
  */
-declare type AttachmentFetchEventType = 'Completed' | 'Progress' | 'Deleted';
+type AttachmentFetchEventType = 'Completed' | 'Progress' | 'Deleted';
 /**
  * An attachment fetch event used when the attachment's download has completed.
  */
-declare type AttachmentFetchEventCompleted = {
+type AttachmentFetchEventCompleted = {
     type: 'Completed';
     attachment: Attachment;
 };
@@ -950,7 +926,7 @@ declare type AttachmentFetchEventCompleted = {
  * An attachment fetch event used when the attachment's download progressed but
  * is not yet complete.
  */
-declare type AttachmentFetchEventProgress = {
+type AttachmentFetchEventProgress = {
     type: 'Progress';
     totalBytes: number | BigInt;
     downloadedBytes: number | BigInt;
@@ -958,7 +934,7 @@ declare type AttachmentFetchEventProgress = {
 /**
  * An attachment fetch event used when the attachment is deleted.
  */
-declare type AttachmentFetchEventDeleted = {
+type AttachmentFetchEventDeleted = {
     type: 'Deleted';
 };
 /**
@@ -977,7 +953,7 @@ declare type AttachmentFetchEventDeleted = {
  * {@link Collection.fetchAttachment | fetchAttachment()} on a
  * {@link Collection} instance.
  */
-declare type AttachmentFetchEvent = AttachmentFetchEventCompleted | AttachmentFetchEventProgress | AttachmentFetchEventDeleted;
+type AttachmentFetchEvent = AttachmentFetchEventCompleted | AttachmentFetchEventProgress | AttachmentFetchEventDeleted;
 
 /**
  * These objects are returned by calls to
@@ -1228,7 +1204,7 @@ declare class LiveQueryEventUpdate {
  * Represents events delivered by a {@link LiveQuery}, which can be initial
  * (fired immediately upon registration) or an update (all subsequent events).
  */
-declare type LiveQueryEvent = LiveQueryEventInitial | LiveQueryEventUpdate;
+type LiveQueryEvent = LiveQueryEventInitial | LiveQueryEventUpdate;
 /**
  * Provides information about a live query event relating to a single document
  * live query.
@@ -1257,7 +1233,7 @@ declare class SingleDocumentLiveQueryEvent {
  * The closure that is called whenever the documents covered by a live query
  * change.
  */
-declare type QueryObservationHandler = (documents: Document[], event: LiveQueryEvent, signalNext?: () => void) => void | Promise<void>;
+type QueryObservationHandler = (documents: Document[], event: LiveQueryEvent, signalNext?: () => void) => void | Promise<void>;
 /**
  * These objects are returned when using `find`-like functionality on
  * {@link Collection}.
@@ -1454,7 +1430,7 @@ declare class PendingCursorOperation implements PromiseLike<Document[]> {
  * The closure that is called whenever a single documunent covered by a
  * live query changes.
  */
-declare type SingleObservationHandler = (document: Document | null, event: SingleDocumentLiveQueryEvent, signalNext?: () => void) => void | Promise<void>;
+type SingleObservationHandler = (document: Document | null, event: SingleDocumentLiveQueryEvent, signalNext?: () => void) => void | Promise<void>;
 /**
  * These objects are returned when using {@link Collection.findByID | findByID()}
  * functionality on {@link Collection | collections}.
@@ -1586,7 +1562,7 @@ declare class PendingIDSpecificOperation implements PromiseLike<Document | undef
     private get query();
 }
 
-declare type UpsertOptions = {
+type UpsertOptions = {
     writeStrategy?: WriteStrategy;
 };
 /**
@@ -1778,7 +1754,7 @@ declare class CollectionsEvent {
  * The closure that is called whenever the collections covered by a live query
  * change.
  */
-declare type CollectionsObservationHandler = (event: CollectionsEvent, signalNext?: () => void) => void | Promise<void>;
+type CollectionsObservationHandler = (event: CollectionsEvent, signalNext?: () => void) => void | Promise<void>;
 /**
  * These objects are returned when calling
  * {@link Store.collections | collections()} on {@link Store}.
@@ -1947,7 +1923,7 @@ interface ObserverRemoving {
     removeObserver(token: any): any;
 }
 /** @internal */
-declare type ObserverOptions = {
+type ObserverOptions = {
     stopsWhenFinalized?: boolean;
 };
 /**
@@ -1979,7 +1955,7 @@ declare class Observer {
 }
 
 /** Types of connections that can be established between two peers. */
-declare type ConnectionType = 'P2PWiFi' | 'WebSocket' | 'AccessPoint' | 'Bluetooth';
+type ConnectionType = 'P2PWiFi' | 'WebSocket' | 'AccessPoint' | 'Bluetooth';
 /**
  * An opaque address uniquely identifying another peer on the Ditto mesh
  * network.
@@ -1989,7 +1965,7 @@ declare type ConnectionType = 'P2PWiFi' | 'WebSocket' | 'AccessPoint' | 'Bluetoo
  * {@link addressToString | addressToString()} to compare individual addresses
  * with each other.
  */
-declare type Address = {
+type Address = {
     siteId: string;
     pubkey: Uint8Array;
 };
@@ -2000,7 +1976,7 @@ declare type Address = {
  */
 declare function addressToString(address: Address): string;
 /** Represents a connection between two peers on the Ditto mesh network. */
-declare type Connection = {
+type Connection = {
     /** Unique identifier for the connection. */
     id: string;
     /** Type of transport enabling this connection. */
@@ -2012,7 +1988,7 @@ declare type Connection = {
     approximateDistanceInMeters?: number;
 };
 /** An instance of Ditto taking part in the Ditto mesh network. */
-declare type Peer = {
+type Peer = {
     /**
      * Address to contact this peer via Ditto Bus, unique with a Ditto mesh
      * network.
@@ -2042,7 +2018,7 @@ declare type Peer = {
  * other. The `localPeer` is the entry point, all others are remote peers known
  * by the local peer (either directly or via other remote peers).
  */
-declare type PresenceGraph = {
+type PresenceGraph = {
     /**
      * Returns the local peer (usually the peer that is represented by the
      * currently running Ditto instance). The `localPeer` is the entry point, all
@@ -2092,19 +2068,19 @@ declare class Presence {
 }
 
 /** Types of connections that can be established between two peers. */
-declare type TransportCondition = 'Unknown' | 'OK' | 'GenericFailure' | 'AppInBackground' | 'MDNSFailure' | 'TCPListenFailure' | 'NoBLECentralPermission' | 'NoBLEPeripheralPermission' | 'CannotEstablishConnection' | 'BLEDisabled' | 'NoBLEHardware' | 'WiFiDisabled' | 'TemporarilyUnavailable';
+type TransportCondition = 'Unknown' | 'OK' | 'GenericFailure' | 'AppInBackground' | 'MDNSFailure' | 'TCPListenFailure' | 'NoBLECentralPermission' | 'NoBLEPeripheralPermission' | 'CannotEstablishConnection' | 'BLEDisabled' | 'NoBLEHardware' | 'WiFiDisabled' | 'TemporarilyUnavailable';
 /** The source for a transport condition. */
-declare type ConditionSource = 'BLE' | 'TCP' | 'AWDL' | 'MDNS';
+type ConditionSource = 'BLE' | 'TCP' | 'AWDL' | 'MDNS';
 /**
  * Types of connections that can be established between two peers.
  * @deprecated replaced by {@link ConnectionType}.
  */
-declare type PresenceConnectionType = 'WiFi' | 'WebSocket' | 'AWDL' | 'BLE';
+type PresenceConnectionType = 'WiFi' | 'WebSocket' | 'AWDL' | 'BLE';
 /**
  * A peer object with information about an observed peer.
  * @deprecated replaced by {@link Peer}.
  */
-declare type RemotePeer = {
+type RemotePeer = {
     networkID: string;
     deviceName: string;
     rssi?: number;
@@ -2295,14 +2271,14 @@ declare class Ditto {
     runGarbageCollection(): void;
     /**
      * Explicitly opt-in to disabling the ability to sync with Ditto peers running
-     * any version of the SDK in the v2 series of releases.
+     * any version of the SDK in the v3 series of releases.
      *
      * Assuming this succeeds then this peer will only be able to sync with other
-     * peers using SDKs in the v3 series of releases. Note that this disabling of
+     * peers using SDKs in the v4 series of releases. Note that this disabling of
      * sync spreads to peers that sync with a peer that has disabled, or has
-     * (transitively) had disabled, syncing with v2 SDK peers.
+     * (transitively) had disabled, syncing with v3 SDK peers.
      */
-    disableSyncWithV2(): void;
+    disableSyncWithV3(): void;
     /** @internal */
     keepAlive: KeepAlive;
     private sync;
@@ -2319,9 +2295,9 @@ declare class Ditto {
 declare const dittoBridge: Bridge<Ditto, "CDitto_t">;
 
 /** @internal */
-declare type ObserverToken = string;
+type ObserverToken = string;
 /** @internal */
-declare type ObserverManagerConstructorOptions = {
+type ObserverManagerConstructorOptions = {
     keepAlive?: KeepAlive;
     register?: (callback: (...args: any[]) => void) => void;
     unregister?: () => void;
@@ -2371,7 +2347,7 @@ declare class ObserverManager {
 /**
  * Provides info about the authentication status.
  */
-declare type AuthenticationStatus = {
+type AuthenticationStatus = {
     /**
      * Returns `true` if authenticated, otherwise returns `false`.
      */
@@ -2504,12 +2480,12 @@ declare class Value {
 }
 
 /** The log levels supported by Ditto. */
-declare type LogLevel = 'Error' | 'Warning' | 'Info' | 'Debug' | 'Verbose';
+type LogLevel = 'Error' | 'Warning' | 'Info' | 'Debug' | 'Verbose';
 /**
  * Closure that {@link Logger.setCustomLogCallback} can be set as a custom
  * log callback on {@link Logger}.
  */
-declare type CustomLogCallback = (logLevel: LogLevel, message: string) => void;
+type CustomLogCallback = (logLevel: LogLevel, message: string) => void;
 /**
  * Class with static methods to customize the logging behavior from Ditto and
  * log messages with the Ditto logging infrastructure.
@@ -2623,5 +2599,5 @@ declare class CBOR {
     static decode(data: Uint8Array): any;
 }
 
-export { Address, Attachment, AttachmentFetchEvent, AttachmentFetchEventCompleted, AttachmentFetchEventDeleted, AttachmentFetchEventProgress, AttachmentFetchEventType, AttachmentFetcher, AttachmentToken, AuthenticationHandler, AuthenticationStatus, Authenticator, CBOR, Collection, CollectionsEvent, CollectionsEventParams, CollectionsObservationHandler, ConditionSource, Connection, ConnectionType, Counter, CustomLogCallback, Ditto, Document, DocumentID, DocumentIDValue, DocumentPath, DocumentValue, Identity, IdentityManual, IdentityOfflinePlayground, IdentityOnlinePlayground, IdentityOnlineWithAuthentication, IdentitySharedKey, IdentityTypesRequiringOfflineLicenseToken, InitOptions, KeepAlive, LiveQuery, LiveQueryEvent, LiveQueryEventInitial, LiveQueryEventUpdate, LiveQueryEventUpdateParams, LiveQueryMove, LogLevel, Logger, MutableCounter, MutableDocument, MutableDocumentPath, MutableRegister, NotAvailableAuthenticator, Observer, ObserverOptions, OnlineAuthenticator, Peer, PendingCollectionsOperation, PendingCursorOperation, PendingIDSpecificOperation, Presence, PresenceConnectionType, PresenceGraph, QueryArguments, QueryObservationHandler, RGA, Register, RemotePeer, SingleDocumentLiveQueryEvent, SingleObservationHandler, SortDirection, Store, Subscription, TransportCondition, TransportConfig, TransportConfigConnect, TransportConfigGlobal, TransportConfigLan, TransportConfigListen, TransportConfigListenHTTP, TransportConfigListenTCP, TransportConfigPeerToPeer, UpdateResult, UpdateResultType, UpdateResultsMap, UpsertOptions, Value, WebAssemblyModule, WriteStrategy, addressToString, attachmentBridge, dittoBridge, documentBridge, init, mutableDocumentBridge, validateDocumentIDCBOR, validateDocumentIDValue };
+export { Address, Attachment, AttachmentFetchEvent, AttachmentFetchEventCompleted, AttachmentFetchEventDeleted, AttachmentFetchEventProgress, AttachmentFetchEventType, AttachmentFetcher, AttachmentToken, AuthenticationHandler, AuthenticationStatus, Authenticator, CBOR, Collection, CollectionsEvent, CollectionsEventParams, CollectionsObservationHandler, ConditionSource, Connection, ConnectionType, Counter, CustomLogCallback, Ditto, Document, DocumentID, DocumentIDValue, DocumentPath, DocumentValue, Identity, IdentityManual, IdentityOfflinePlayground, IdentityOnlinePlayground, IdentityOnlineWithAuthentication, IdentitySharedKey, IdentityTypesRequiringOfflineLicenseToken, InitOptions, KeepAlive, LiveQuery, LiveQueryEvent, LiveQueryEventInitial, LiveQueryEventUpdate, LiveQueryEventUpdateParams, LiveQueryMove, LogLevel, Logger, MutableCounter, MutableDocument, MutableDocumentPath, MutableRegister, NotAvailableAuthenticator, Observer, ObserverOptions, OnlineAuthenticator, Peer, PendingCollectionsOperation, PendingCursorOperation, PendingIDSpecificOperation, Presence, PresenceConnectionType, PresenceGraph, QueryArguments, QueryObservationHandler, Register, RemotePeer, SingleDocumentLiveQueryEvent, SingleObservationHandler, SortDirection, Store, Subscription, TransportCondition, TransportConfig, TransportConfigConnect, TransportConfigGlobal, TransportConfigLan, TransportConfigListen, TransportConfigListenHTTP, TransportConfigListenTCP, TransportConfigPeerToPeer, UpdateResult, UpdateResultType, UpdateResultsMap, UpsertOptions, Value, WebAssemblyModule, WriteStrategy, addressToString, attachmentBridge, dittoBridge, documentBridge, init, mutableDocumentBridge, validateDocumentIDCBOR, validateDocumentIDValue };
 //# sourceMappingURL=ditto.d.ts.map