@dittolive/ditto 1.1.1 → 1.1.2

package/types/ditto.d.ts

@@ -437,6 +437,8 @@ interface IdentityOnlineWithAuthentication {
  * `Ditto` instance.
  */
 declare type Identity = IdentityDevelopment | IdentityOfflinePlayground | IdentitySharedKey | IdentityProduction | IdentityManual | IdentityOnlinePlayground | IdentityOnline | IdentityOnlineWithAuthentication;
+/** The list of identity types that require activation through an offlineLicenseToken */
+declare const IdentityTypesRequiringOfflineLicenseToken: string[];
 
 /**
  * TODO: document.
@@ -1718,8 +1720,8 @@ declare class Collection {
      * attachment into a document.
      *
      * ``` JavaScript
-     * const attachment = collection.newAttachment('/path/to/my/file.pdf')
-     * collection.insert({ _id: '123', attachment, other: 'some-string' })
+     * const attachment = await collection.newAttachment('/path/to/my/file.pdf')
+     * await collection.insert({ _id: '123', attachment, other: 'some-string' })
      * }
      * ```
      *
@@ -1730,7 +1732,7 @@ declare class Collection {
      */
     newAttachment(pathOrData: string | Uint8Array, metadata?: {
         [key: string]: string;
-    }): Attachment;
+    }): Promise<Attachment>;
     /**
      * Trigger an attachment to be downloaded locally to the device and observe
      * its progress as it does so.
@@ -1962,14 +1964,14 @@ declare class Store {
      * Returns the names of all available collections in the store of the
      * related {@link Ditto} instance.
      */
-    collectionNames(): string[];
+    collectionNames(): Promise<string[]>;
     /** @internal */
     constructor(ditto: Ditto);
     /**
      * Private method, used only by the Portal https://github.com/getditto/ditto/pull/3652
      * @internal
      */
-    registerLiveQueryWebhook(collectionName: string, query: string, url: string): DocumentIDValue;
+    registerLiveQueryWebhook(collectionName: string, query: string, url: string): Promise<DocumentIDValue>;
 }
 
 /** @internal */
@@ -2065,9 +2067,9 @@ declare class Ditto {
      */
     readonly siteID: number | BigInt;
     /**
-     * Returns `true` if a license token has been set, otherwise returns `false`.
+     * Returns `true` if an offline license token has been set, otherwise returns `false`.
      *
-     * @see {@link setLicenseToken | setLicenseToken()}
+     * @see {@link setOfflineOnlyLicenseToken | setOfflineOnlyLicenseToken()}
      */
     readonly isActivated: boolean;
     /**
@@ -2103,17 +2105,37 @@ declare class Ditto {
      */
     constructor(identity?: Identity, path?: string);
     /**
-     * Activate a `Ditto` instance by setting a license token. You cannot sync
-     * with `Ditto` before you have activated it.
+     * @deprecated use {@link setOfflineOnlyLicenseToken | setOfflineOnlyLicenseToken()} instead.
+     * Activate a `Ditto` instance by setting an offline only license token. You cannot initiate sync
+     * with `Ditto` before you have activated it. The offline license token is only valid for identities
+     * of type `development`, `manual`, `offlinePlayground`, and `sharedKey`.
      *
      * @param licenseToken the license token to activate the `Ditto` instance
-     * with. You can find yours on the Ditto portal (https://portal.ditto.live).
+     * with. You can find yours on the [Ditto portal](https://portal.ditto.live).
+     */
+    setAccessLicense(accessLicense: string): void;
+    /**
+     * Activate a `Ditto` instance by setting an offline only license token. You cannot initiate sync
+     * with `Ditto` before you have activated it. The offline license token is only valid for identities
+     * of type `development`, `manual`, `offlinePlayground`, and `sharedKey`.
+     *
+     * @deprecated use {@link setOfflineOnlyLicenseToken} for identities of type `development`, `manual`,
+     * `offlinePlayground`, and `sharedKey`.
+     *
+     *
+     * @param licenseToken the license token to activate the `Ditto` instance
+     * with. You can find yours on the [Ditto portal](https://portal.ditto.live).
      */
     setLicenseToken(licenseToken: string): void;
     /**
-     * @deprecated use {@link setLicenseToken | setLicenseToken()} instead.
+     * Activate a `Ditto` instance by setting an offline only license token. You cannot initiate sync
+     * with `Ditto` before you have activated it. The offline license token is only valid for identities
+     * of type `development`, `manual`, `offlinePlayground`, and `sharedKey`.
+     *
+     * @param licenseToken the license token to activate the `Ditto` instance
+     * with. You can find yours on the [Ditto portal](https://portal.ditto.live).
      */
-    setAccessLicense(accessLicense: string): void;
+    setOfflineOnlyLicenseToken(licenseToken: string): void;
     /**
      * Returns the current transport configuration, frozen. If you want to modify
      * the transport config, make a {@link TransportConfig.copy | copy} first. Or
@@ -2614,5 +2636,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, 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, 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