@sovereignbase/explorer 0.0.0-alpha.5 → 0.0.0-alpha.6

package/dist/class.d.cts

@@ -1,7 +1,7 @@
 
 import { URLString } from "@sovereignbase/storage";
 import { DeepReadonly } from "@sovereignbase/utils";
-import { CipherKey } from "@sovereignbase/cryptosuite";
+import { CipherKey, CipherMessage, DecapsulateKey, EncapsulateKey, KeyOffer } from "@sovereignbase/cryptosuite";
 import { SequencedArrayChange, SequencedArrayDelta } from "@sovereignbase/sequenced";
 import { DeviceBindingStorage } from "@sovereignbase/hardware-bound";
 /**
@@ -73,6 +73,8 @@ export type AuthenticationResult =
 export type AuthenticationSetupParams = Readonly<{
   /** The display name assigned to the credential. */
   credentialName: string;
+  /** Optional virtual entropy used to establish an existing database. */
+  virtualEntropy?: Uint8Array;
   /** The storage mechanism used to bind the credential to the device. */
   bindingStorage: DeviceBindingStorage;
 }>;
@@ -135,20 +137,27 @@ export declare class ExplorerError extends Error {
   constructor(code: ExplorerErrorCode, message?: string, options?: ErrorOptions);
 }
 /**
- * Provides authentication, encrypted object storage, and access to
- * the database's synchronized entries.
+ * Provides access to an authenticated Sovereignbase database.
  *
- * Maintains the authenticated database context and exposes static methods
- * for managing stored objects, observing entries, and applying remote deltas.
+ * Manages database authentication, encrypted object storage, credential
+ * registration, database linking, and synchronized entries.
  */
 export declare class Explorer {
   /** The identifier of the authenticated database. */
   static databaseID: string;
-  /** Indicates whether the database has been authenticated. */
+  /** Indicates whether a database has been authenticated. */
   static isAuthenticated: boolean;
+  /** The base URL used to access database objects. */
   private static storageURL;
+  /** The event target used for Explorer events. */
   private static eventTarget?;
+  /** The data PIN associated with the current session. */
+  private static dataPIN;
+  /** The virtual entropy associated with the authenticated database. */
+  private static virtualEntropy;
+  /** The secret used to access the authenticated database. */
   private static databaseSecret;
+  /** The credential information associated with the current authentication. */
   private static sessionCredential?;
   /**
    * Caches cipher keys by object identifier.
@@ -158,48 +167,80 @@ export declare class Explorer {
    */
   static readonly cipherKeyCache: Map<string, CipherKey>;
   /**
-   * Authenticates a database using a data PIN and device-bound entropy.
+   * Authenticates a database using a data PIN and an existing device binding.
    *
-   * Derives the credential and database identifiers from cryptographic
-   * secrets. When setup parameters are provided, creates and stores a
-   * new credential. Otherwise, loads the existing credential.
+   * Establishes the authenticated database context and records the credential
+   * used for authentication.
    *
-   * Records the authenticated credential in the database's credential list.
+   * When setup parameters are provided, registers a credential using the
+   * supplied virtual entropy or generates new virtual entropy.
    *
-   * @param dataPIN The PIN used to derive the credential and database secrets.
-   * @param storageURL The base URL used to access persisted database objects.
-   * @param setupParams Optional parameters for creating a new credential.
+   * @param dataPIN The PIN associated with the database.
+   * @param storageURL The base URL used to access database objects.
+   * @param setupParams Optional parameters for registering a credential.
+   *
+   * @param credentialId An optional credential identifier used to restrict credential selection.
    * @returns The authentication result.
    */
-  static authenticate(dataPIN: string, storageURL: URLString, setupParams?: AuthenticationSetupParams): Promise<AuthenticationResult>;
+  static authenticate(dataPIN: string, storageURL: URLString, setupParams?: AuthenticationSetupParams, credentialId?: string): Promise<AuthenticationResult>;
+  /** The number of consecutive failed database linking PIN attempts. */
+  private static failCounter;
+  /**
+   * Prepares an authenticated database for linking to another device.
+   *
+   * Verifies the current data PIN and prepares an encrypted transfer
+   * containing the information required to access the same database.
+   *
+   * Repeated PIN failures cause the current page to reload.
+   *
+   * @param dataPIN The PIN associated with the authenticated database.
+   * @param encapsulateKey The key used to establish encryption for the transfer.
+   * @returns The key offer and encrypted transfer message, or `false`
+   * if the supplied PIN is incorrect.
+   */
+  static prepareDatabaseLink(dataPIN: string, encapsulateKey: EncapsulateKey): Promise<[keyOffer: KeyOffer, cipherMessage: CipherMessage] | false>;
   /**
-   * Permanently revokes a credential and deletes its persisted data.
+   * Links the current device to an existing database.
    *
-   * Removes the credential from the database's registered credentials.
+   * Accesses the transferred database information, creates a device binding,
+   * and registers a credential for the existing database.
+   *
+   * @param keyOffer The key offer associated with the database link.
+   * @param cipherMessage The encrypted database linking message.
+   * @param decapsulateKey The key used to establish decryption for the transfer.
+   * @param credentialName The display name assigned to the new credential.
+   * @param storageURL The base URL used to access database objects.
+   * @returns `true` if the database was linked and authenticated;
+   * otherwise, `false`.
+   */
+  static linkToDatabase(keyOffer: KeyOffer, cipherMessage: CipherMessage, decapsulateKey: DecapsulateKey, credentialName: string, storageURL: URLString): Promise<boolean>;
+  /**
+   * Permanently revokes a registered database credential.
+   *
+   * Removes the credential's persisted data and registration from
+   * the authenticated database.
    *
    * @param credentialID The identifier of the credential to revoke.
    * @throws {ExplorerError} If the database is not authenticated.
    */
   static permanentlyDeleteCredential(credentialID: string): Promise<void>;
   /**
-   * Returns the registered credentials and optionally observes their changes.
-   *
-   * The returned tuple contains a cleanup function, the current credential
-   * entries, and the identifier of the current session's credential.
+   * Returns the registered database credentials.
    *
-   * The cleanup function removes the registered change listener, if any.
+   * Optionally registers a listener for changes to the credential entries.
+   * The returned cleanup function removes the registered listener.
    *
    * @param onChange An optional callback invoked when the entries change.
-   * @returns The cleanup function, credential entries, and session credential ID.
+   * @returns The cleanup function, credential entries, and identifier
+   * of the current session's credential.
    * @throws {ExplorerError} If the database is not authenticated.
    */
   static listCredentialEntries(onChange?: (splice: CredentialEntriesChange) => void): Promise<[cleanup: () => void, entries: DeepReadonly<Array<CredentialEntry>>, sessionCredentialID: string]>;
   /**
-   * Returns the recently accessed objects and optionally observes their changes.
+   * Returns the recently accessed database objects.
    *
-   * The returned tuple contains a cleanup function and the current recent
-   * entries. The cleanup function removes the registered change listener,
-   * if any.
+   * Optionally registers a listener for changes to the recent entries.
+   * The returned cleanup function removes the registered listener.
    *
    * @param onChange An optional callback invoked when the entries change.
    * @returns The cleanup function and recent entries.
@@ -207,9 +248,9 @@ export declare class Explorer {
    */
   static listRecentEntries(onChange?: (splice: RecentEntriesChange) => void): Promise<[cleanup: () => void, entries: DeepReadonly<Array<RecentEntry>>]>;
   /**
-   * Loads an encrypted object using its identifier and cipher key.
+   * Loads an encrypted database object by its identifier.
    *
-   * Caches the cipher key if the identifier has not been encountered before.
+   * Caches the supplied cipher key if no key has been cached for the object.
    *
    * @typeParam T The expected type of the loaded object.
    * @param id The identifier of the object to load.
@@ -219,9 +260,9 @@ export declare class Explorer {
    */
   static loadObjectByID<T>(id: string, cipherKey: CipherKey, onNetworkResponse?: (data: unknown) => void | Promise<void>): Promise<T | undefined>;
   /**
-   * Encrypts and stores an object using its identifier and cipher key.
+   * Encrypts and stores a database object by its identifier.
    *
-   * Caches the cipher key if the identifier has not been encountered before.
+   * Caches the supplied cipher key if no key has been cached for the object.
    *
    * @typeParam T The type of the object to store.
    * @param id The identifier of the object to store.
@@ -230,7 +271,9 @@ export declare class Explorer {
    */
   static storeObjectByID<T>(id: string, object: T, cipherKey: CipherKey): Promise<void>;
   /**
-   * Deletes a persisted object using its identifier.
+   * Deletes a database object by its identifier.
+   *
+   * Removes the persisted object and its corresponding recent entry.
    *
    * @param id The identifier of the object to delete.
    */
@@ -247,8 +290,9 @@ export declare class Explorer {
    */
   static apply(data: unknown): void;
   /**
-   * Registers an event listener for the specified event type.
+   * Registers an event listener for the specified Explorer event.
    *
+   * @typeParam K The event name that determines the event detail type.
    * @param type The event type.
    * @param listener The event listener, or `null`.
    * @param options The event listener options.
@@ -258,14 +302,16 @@ export declare class Explorer {
    * Removes an event listener previously registered with
    * {@link addEventListener}.
    *
+   * @typeParam K The event name that determines the listener type.
    * @param type The event type.
    * @param listener The event listener to remove, or `null`.
    * @param options The event listener options.
    */
   static removeEventListener<K extends keyof ExplorerEventMap>(type: K, listener: ExplorerEventListenerFor<K> | null, options?: boolean | EventListenerOptions): void;
   /**
-   * Dispatches an event to the registered listeners.
+   * Dispatches an Explorer event to registered listeners.
    *
+   * @typeParam K The event name that determines the event detail type.
    * @param type The event type.
    * @param detail The value exposed through `CustomEvent.detail`.
    */
@@ -277,6 +323,7 @@ export declare class Explorer {
    * @returns Whether the value has a string discriminator.
    */
   private static isExplorerDelta;
+  /** The cached recent entries list. */
   private static recentEntries?;
   /**
    * Loads or returns the cached recent entries list.
@@ -288,6 +335,7 @@ export declare class Explorer {
    * @throws {ExplorerError} If the database is not authenticated.
    */
   private static loadRecentEntries;
+  /** The cached credential entries list. */
   private static credentialEntries?;
   /**
    * Loads or returns the cached credential entries list.

package/dist/class.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"class.d.cts","names":[],"sources":["../src/RecentEntries/class.ts","../src/CredentialEntries/class.ts","../src/.types/type.ts","../src/.errors/class.ts","../src/class.ts"],"mappings":";;;;;;;;;KAsBY;;EAEV;;EAGA;;EAGA,WAAW;;EAGX;;;;;KAMU,qBAAqB,2BACb,aAAa,oBAAoB;;;;KAMzC,sBAAsB,aAChC,qBAAqB;;;;KCpBX;;EAEV;;EAGA,SAAS;;EAGT,SAAS;;EAGT;;EAGA;;EAGA;;EAGA,YAAY;;IAEV;;IAGA;;;;;;KAqCQ,yBAAyB,+BACb,aAAa,oBAAoB;;;;KAM7C,0BAA0B,aACpC,qBAAqB;;;;YC1FX;;;;;;;;;;YAWA,4BAA4B;;EAEtC;;EAGA,gBAAgB;;;;;;;;YASN,gBACV,qBAAqB;;;;YAKX;;EAEV;;EAGA,OAAO;;;;;;;YAQG,sBAAsB,gBAAgB,sBAC5C,OAAO,YAAY,iBAAiB;EACpC,YAAY,OAAO,YAAY,iBAAiB;;;;;;;YAO1C,yBAAyB,oBACnC,gBAAgB,mBACZ,sBAAsB,KACtB;;KC9DM;;;;;;;;;;;;;;;qBAgBC,sBAAsB;;WAExB,MAAM;;;;;;;;EAUb,YAAA,MAAM,mBACN,kBACA,UAAU;;;;;;;;;qBCcD;;SAEG;;SAGA;iBAGC;iBACA;iBACA;iBACA;;;;;;;kBAQQ,gBAAgB,YAAY;;;;;;;;;;;;;;;SAgB/B,aAClB,iBACA,YAAY,WACZ,cAAc,4BACb,QAAQ;;;;;;;;;SA4FS,4BAClB,uBACC;;;;;;;;;;;;;SAsBiB,sBAClB,YAAY,QAAQ,mCACnB,SAEC,qBACA,SAAS,aAAa,MAAM,mBAC5B;;;;;;;;;;;;SAoCgB,kBAClB,YAAY,QAAQ,+BACnB,SAAS,qBAAqB,SAAS,aAAa,MAAM;;;;;;;;;;;;SAgCzC,eAAe,GACjC,YACA,WAAW,WACX,qBAAqB,yBAAyB,gBAC7C,QAAQ;;;;;;;;;;;SA0BS,gBAAgB,GAClC,YACA,QAAQ,GACR,WAAW,YACV;;;;;;SAoBiB,iBAAiB,aAAa;;;;;;;;;;;SAmBpC,MAAM;;;;;;;;SAmCN,iBAAiB,gBAAgB,kBAC7C,MAAM,GACN,UAAU,yBAAyB,WACnC,oBAAoB;;;;;;;;;SAqBR,oBAAoB,gBAAgB,kBAChD,MAAM,GACN,UAAU,yBAAyB,WACnC,oBAAoB;;;;;;;SAmBR,cAAc,gBAAgB,kBAC1C,MAAM,GACN,QAAQ,iBAAiB;;;;;;;iBAsBZ;iBAIA;;;;;;;;;;iBAWM;iBA8BN;;;;;;;;;;iBAWM"}
+{"version":3,"file":"class.d.cts","names":[],"sources":["../src/RecentEntries/class.ts","../src/CredentialEntries/class.ts","../src/.types/type.ts","../src/.errors/class.ts","../src/class.ts"],"mappings":";;;;;;;;;KAsBY;;EAEV;;EAGA;;EAGA,WAAW;;EAGX;;;;;KAMU,qBAAqB,2BACb,aAAa,oBAAoB;;;;KAMzC,sBAAsB,aAChC,qBAAqB;;;;KCpBX;;EAEV;;EAGA,SAAS;;EAGT,SAAS;;EAGT;;EAGA;;EAGA;;EAGA,YAAY;;IAEV;;IAGA;;;;;;KAqCQ,yBAAyB,+BACb,aAAa,oBAAoB;;;;KAM7C,0BAA0B,aACpC,qBAAqB;;;;YC1FX;;;;;;;;;;YAWA,4BAA4B;;EAEtC;;EAGA,iBAAiB;;EAGjB,gBAAgB;;;;;;;;YASN,gBACV,qBAAqB;;;;YAKX;;EAEV;;EAGA,OAAO;;;;;;;YAQG,sBAAsB,gBAAgB,sBAC5C,OAAO,YAAY,iBAAiB;EACpC,YAAY,OAAO,YAAY,iBAAiB;;;;;;;YAO1C,yBAAyB,oBACnC,gBAAgB,mBACZ,sBAAsB,KACtB;;KCjEM;;;;;;;;;;;;;;;qBAgBC,sBAAsB;;WAExB,MAAM;;;;;;;;EAUb,YAAA,MAAM,mBACN,kBACA,UAAU;;;;;;;;qBCuBD;;SAEG;;SAGA;;iBAGC;;iBAGA;;iBAGA;;iBAGA;;iBAGA;;iBAGA;;;;;;;kBAQQ,gBAAgB,YAAY;;;;;;;;;;;;;;;;;SAkB/B,aAClB,iBACA,YAAY,WACZ,cAAc,2BACd,wBACC,QAAQ;;iBA4FI;;;;;;;;;;;;;;SAeK,oBAClB,iBACA,gBAAgB,iBACf,SAAS,UAAU,UAAU,eAAe;;;;;;;;;;;;;;;SAwC3B,eAClB,UAAU,UACV,eAAe,eACf,gBAAgB,gBAChB,wBACA,YAAY,YACX;;;;;;;;;;SAyCiB,4BAClB,uBACC;;;;;;;;;;;;SAqBiB,sBAClB,YAAY,QAAQ,mCACnB,SAEC,qBACA,SAAS,aAAa,MAAM,mBAC5B;;;;;;;;;;;SAmCgB,kBAClB,YAAY,QAAQ,+BACnB,SAAS,qBAAqB,SAAS,aAAa,MAAM;;;;;;;;;;;;SAgCzC,eAAe,GACjC,YACA,WAAW,WACX,qBAAqB,yBAAyB,gBAC7C,QAAQ;;;;;;;;;;;SA0BS,gBAAgB,GAClC,YACA,QAAQ,GACR,WAAW,YACV;;;;;;;;SAsBiB,iBAAiB,aAAa;;;;;;;;;;;SAmBpC,MAAM;;;;;;;;;SAoCN,iBAAiB,gBAAgB,kBAC7C,MAAM,GACN,UAAU,yBAAyB,WACnC,oBAAoB;;;;;;;;;;SAsBR,oBAAoB,gBAAgB,kBAChD,MAAM,GACN,UAAU,yBAAyB,WACnC,oBAAoB;;;;;;;;SAoBR,cAAc,gBAAgB,kBAC1C,MAAM,GACN,QAAQ,iBAAiB;;;;;;;iBAsBZ;;iBAKA;;;;;;;;;;iBAWM;;iBA+BN;;;;;;;;;;iBAWM"}

package/dist/class.d.ts

@@ -2,7 +2,7 @@
 import { URLString } from "@sovereignbase/storage";
 import { DeepReadonly } from "@sovereignbase/utils";
 import { DeviceBindingStorage } from "@sovereignbase/hardware-bound";
-import { CipherKey } from "@sovereignbase/cryptosuite";
+import { CipherKey, CipherMessage, DecapsulateKey, EncapsulateKey, KeyOffer } from "@sovereignbase/cryptosuite";
 import { SequencedArrayChange, SequencedArrayDelta } from "@sovereignbase/sequenced";
 /**
  * Describes an entry in the recent objects list.
@@ -73,6 +73,8 @@ export type AuthenticationResult =
 export type AuthenticationSetupParams = Readonly<{
   /** The display name assigned to the credential. */
   credentialName: string;
+  /** Optional virtual entropy used to establish an existing database. */
+  virtualEntropy?: Uint8Array;
   /** The storage mechanism used to bind the credential to the device. */
   bindingStorage: DeviceBindingStorage;
 }>;
@@ -135,20 +137,27 @@ export declare class ExplorerError extends Error {
   constructor(code: ExplorerErrorCode, message?: string, options?: ErrorOptions);
 }
 /**
- * Provides authentication, encrypted object storage, and access to
- * the database's synchronized entries.
+ * Provides access to an authenticated Sovereignbase database.
  *
- * Maintains the authenticated database context and exposes static methods
- * for managing stored objects, observing entries, and applying remote deltas.
+ * Manages database authentication, encrypted object storage, credential
+ * registration, database linking, and synchronized entries.
  */
 export declare class Explorer {
   /** The identifier of the authenticated database. */
   static databaseID: string;
-  /** Indicates whether the database has been authenticated. */
+  /** Indicates whether a database has been authenticated. */
   static isAuthenticated: boolean;
+  /** The base URL used to access database objects. */
   private static storageURL;
+  /** The event target used for Explorer events. */
   private static eventTarget?;
+  /** The data PIN associated with the current session. */
+  private static dataPIN;
+  /** The virtual entropy associated with the authenticated database. */
+  private static virtualEntropy;
+  /** The secret used to access the authenticated database. */
   private static databaseSecret;
+  /** The credential information associated with the current authentication. */
   private static sessionCredential?;
   /**
    * Caches cipher keys by object identifier.
@@ -158,48 +167,80 @@ export declare class Explorer {
    */
   static readonly cipherKeyCache: Map<string, CipherKey>;
   /**
-   * Authenticates a database using a data PIN and device-bound entropy.
+   * Authenticates a database using a data PIN and an existing device binding.
    *
-   * Derives the credential and database identifiers from cryptographic
-   * secrets. When setup parameters are provided, creates and stores a
-   * new credential. Otherwise, loads the existing credential.
+   * Establishes the authenticated database context and records the credential
+   * used for authentication.
    *
-   * Records the authenticated credential in the database's credential list.
+   * When setup parameters are provided, registers a credential using the
+   * supplied virtual entropy or generates new virtual entropy.
    *
-   * @param dataPIN The PIN used to derive the credential and database secrets.
-   * @param storageURL The base URL used to access persisted database objects.
-   * @param setupParams Optional parameters for creating a new credential.
+   * @param dataPIN The PIN associated with the database.
+   * @param storageURL The base URL used to access database objects.
+   * @param setupParams Optional parameters for registering a credential.
+   *
+   * @param credentialId An optional credential identifier used to restrict credential selection.
    * @returns The authentication result.
    */
-  static authenticate(dataPIN: string, storageURL: URLString, setupParams?: AuthenticationSetupParams): Promise<AuthenticationResult>;
+  static authenticate(dataPIN: string, storageURL: URLString, setupParams?: AuthenticationSetupParams, credentialId?: string): Promise<AuthenticationResult>;
+  /** The number of consecutive failed database linking PIN attempts. */
+  private static failCounter;
+  /**
+   * Prepares an authenticated database for linking to another device.
+   *
+   * Verifies the current data PIN and prepares an encrypted transfer
+   * containing the information required to access the same database.
+   *
+   * Repeated PIN failures cause the current page to reload.
+   *
+   * @param dataPIN The PIN associated with the authenticated database.
+   * @param encapsulateKey The key used to establish encryption for the transfer.
+   * @returns The key offer and encrypted transfer message, or `false`
+   * if the supplied PIN is incorrect.
+   */
+  static prepareDatabaseLink(dataPIN: string, encapsulateKey: EncapsulateKey): Promise<[keyOffer: KeyOffer, cipherMessage: CipherMessage] | false>;
   /**
-   * Permanently revokes a credential and deletes its persisted data.
+   * Links the current device to an existing database.
    *
-   * Removes the credential from the database's registered credentials.
+   * Accesses the transferred database information, creates a device binding,
+   * and registers a credential for the existing database.
+   *
+   * @param keyOffer The key offer associated with the database link.
+   * @param cipherMessage The encrypted database linking message.
+   * @param decapsulateKey The key used to establish decryption for the transfer.
+   * @param credentialName The display name assigned to the new credential.
+   * @param storageURL The base URL used to access database objects.
+   * @returns `true` if the database was linked and authenticated;
+   * otherwise, `false`.
+   */
+  static linkToDatabase(keyOffer: KeyOffer, cipherMessage: CipherMessage, decapsulateKey: DecapsulateKey, credentialName: string, storageURL: URLString): Promise<boolean>;
+  /**
+   * Permanently revokes a registered database credential.
+   *
+   * Removes the credential's persisted data and registration from
+   * the authenticated database.
    *
    * @param credentialID The identifier of the credential to revoke.
    * @throws {ExplorerError} If the database is not authenticated.
    */
   static permanentlyDeleteCredential(credentialID: string): Promise<void>;
   /**
-   * Returns the registered credentials and optionally observes their changes.
-   *
-   * The returned tuple contains a cleanup function, the current credential
-   * entries, and the identifier of the current session's credential.
+   * Returns the registered database credentials.
    *
-   * The cleanup function removes the registered change listener, if any.
+   * Optionally registers a listener for changes to the credential entries.
+   * The returned cleanup function removes the registered listener.
    *
    * @param onChange An optional callback invoked when the entries change.
-   * @returns The cleanup function, credential entries, and session credential ID.
+   * @returns The cleanup function, credential entries, and identifier
+   * of the current session's credential.
    * @throws {ExplorerError} If the database is not authenticated.
    */
   static listCredentialEntries(onChange?: (splice: CredentialEntriesChange) => void): Promise<[cleanup: () => void, entries: DeepReadonly<Array<CredentialEntry>>, sessionCredentialID: string]>;
   /**
-   * Returns the recently accessed objects and optionally observes their changes.
+   * Returns the recently accessed database objects.
    *
-   * The returned tuple contains a cleanup function and the current recent
-   * entries. The cleanup function removes the registered change listener,
-   * if any.
+   * Optionally registers a listener for changes to the recent entries.
+   * The returned cleanup function removes the registered listener.
    *
    * @param onChange An optional callback invoked when the entries change.
    * @returns The cleanup function and recent entries.
@@ -207,9 +248,9 @@ export declare class Explorer {
    */
   static listRecentEntries(onChange?: (splice: RecentEntriesChange) => void): Promise<[cleanup: () => void, entries: DeepReadonly<Array<RecentEntry>>]>;
   /**
-   * Loads an encrypted object using its identifier and cipher key.
+   * Loads an encrypted database object by its identifier.
    *
-   * Caches the cipher key if the identifier has not been encountered before.
+   * Caches the supplied cipher key if no key has been cached for the object.
    *
    * @typeParam T The expected type of the loaded object.
    * @param id The identifier of the object to load.
@@ -219,9 +260,9 @@ export declare class Explorer {
    */
   static loadObjectByID<T>(id: string, cipherKey: CipherKey, onNetworkResponse?: (data: unknown) => void | Promise<void>): Promise<T | undefined>;
   /**
-   * Encrypts and stores an object using its identifier and cipher key.
+   * Encrypts and stores a database object by its identifier.
    *
-   * Caches the cipher key if the identifier has not been encountered before.
+   * Caches the supplied cipher key if no key has been cached for the object.
    *
    * @typeParam T The type of the object to store.
    * @param id The identifier of the object to store.
@@ -230,7 +271,9 @@ export declare class Explorer {
    */
   static storeObjectByID<T>(id: string, object: T, cipherKey: CipherKey): Promise<void>;
   /**
-   * Deletes a persisted object using its identifier.
+   * Deletes a database object by its identifier.
+   *
+   * Removes the persisted object and its corresponding recent entry.
    *
    * @param id The identifier of the object to delete.
    */
@@ -247,8 +290,9 @@ export declare class Explorer {
    */
   static apply(data: unknown): void;
   /**
-   * Registers an event listener for the specified event type.
+   * Registers an event listener for the specified Explorer event.
    *
+   * @typeParam K The event name that determines the event detail type.
    * @param type The event type.
    * @param listener The event listener, or `null`.
    * @param options The event listener options.
@@ -258,14 +302,16 @@ export declare class Explorer {
    * Removes an event listener previously registered with
    * {@link addEventListener}.
    *
+   * @typeParam K The event name that determines the listener type.
    * @param type The event type.
    * @param listener The event listener to remove, or `null`.
    * @param options The event listener options.
    */
   static removeEventListener<K extends keyof ExplorerEventMap>(type: K, listener: ExplorerEventListenerFor<K> | null, options?: boolean | EventListenerOptions): void;
   /**
-   * Dispatches an event to the registered listeners.
+   * Dispatches an Explorer event to registered listeners.
    *
+   * @typeParam K The event name that determines the event detail type.
    * @param type The event type.
    * @param detail The value exposed through `CustomEvent.detail`.
    */
@@ -277,6 +323,7 @@ export declare class Explorer {
    * @returns Whether the value has a string discriminator.
    */
   private static isExplorerDelta;
+  /** The cached recent entries list. */
   private static recentEntries?;
   /**
    * Loads or returns the cached recent entries list.
@@ -288,6 +335,7 @@ export declare class Explorer {
    * @throws {ExplorerError} If the database is not authenticated.
    */
   private static loadRecentEntries;
+  /** The cached credential entries list. */
   private static credentialEntries?;
   /**
    * Loads or returns the cached credential entries list.

package/dist/class.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"class.d.ts","names":[],"sources":["../src/RecentEntries/class.ts","../src/CredentialEntries/class.ts","../src/.types/type.ts","../src/.errors/class.ts","../src/class.ts"],"mappings":";;;;;;;;;KAsBY;;EAEV;;EAGA;;EAGA,WAAW;;EAGX;;;;;KAMU,qBAAqB,2BACb,aAAa,oBAAoB;;;;KAMzC,sBAAsB,aAChC,qBAAqB;;;;KCpBX;;EAEV;;EAGA,SAAS;;EAGT,SAAS;;EAGT;;EAGA;;EAGA;;EAGA,YAAY;;IAEV;;IAGA;;;;;;KAqCQ,yBAAyB,+BACb,aAAa,oBAAoB;;;;KAM7C,0BAA0B,aACpC,qBAAqB;;;;YC1FX;;;;;;;;;;YAWA,4BAA4B;;EAEtC;;EAGA,gBAAgB;;;;;;;;YASN,gBACV,qBAAqB;;;;YAKX;;EAEV;;EAGA,OAAO;;;;;;;YAQG,sBAAsB,gBAAgB,sBAC5C,OAAO,YAAY,iBAAiB;EACpC,YAAY,OAAO,YAAY,iBAAiB;;;;;;;YAO1C,yBAAyB,oBACnC,gBAAgB,mBACZ,sBAAsB,KACtB;;KC9DM;;;;;;;;;;;;;;;qBAgBC,sBAAsB;;WAExB,MAAM;;;;;;;;EAUb,YAAA,MAAM,mBACN,kBACA,UAAU;;;;;;;;;qBCcD;;SAEG;;SAGA;iBAGC;iBACA;iBACA;iBACA;;;;;;;kBAQQ,gBAAgB,YAAY;;;;;;;;;;;;;;;SAgB/B,aAClB,iBACA,YAAY,WACZ,cAAc,4BACb,QAAQ;;;;;;;;;SA4FS,4BAClB,uBACC;;;;;;;;;;;;;SAsBiB,sBAClB,YAAY,QAAQ,mCACnB,SAEC,qBACA,SAAS,aAAa,MAAM,mBAC5B;;;;;;;;;;;;SAoCgB,kBAClB,YAAY,QAAQ,+BACnB,SAAS,qBAAqB,SAAS,aAAa,MAAM;;;;;;;;;;;;SAgCzC,eAAe,GACjC,YACA,WAAW,WACX,qBAAqB,yBAAyB,gBAC7C,QAAQ;;;;;;;;;;;SA0BS,gBAAgB,GAClC,YACA,QAAQ,GACR,WAAW,YACV;;;;;;SAoBiB,iBAAiB,aAAa;;;;;;;;;;;SAmBpC,MAAM;;;;;;;;SAmCN,iBAAiB,gBAAgB,kBAC7C,MAAM,GACN,UAAU,yBAAyB,WACnC,oBAAoB;;;;;;;;;SAqBR,oBAAoB,gBAAgB,kBAChD,MAAM,GACN,UAAU,yBAAyB,WACnC,oBAAoB;;;;;;;SAmBR,cAAc,gBAAgB,kBAC1C,MAAM,GACN,QAAQ,iBAAiB;;;;;;;iBAsBZ;iBAIA;;;;;;;;;;iBAWM;iBA8BN;;;;;;;;;;iBAWM"}
+{"version":3,"file":"class.d.ts","names":[],"sources":["../src/RecentEntries/class.ts","../src/CredentialEntries/class.ts","../src/.types/type.ts","../src/.errors/class.ts","../src/class.ts"],"mappings":";;;;;;;;;KAsBY;;EAEV;;EAGA;;EAGA,WAAW;;EAGX;;;;;KAMU,qBAAqB,2BACb,aAAa,oBAAoB;;;;KAMzC,sBAAsB,aAChC,qBAAqB;;;;KCpBX;;EAEV;;EAGA,SAAS;;EAGT,SAAS;;EAGT;;EAGA;;EAGA;;EAGA,YAAY;;IAEV;;IAGA;;;;;;KAqCQ,yBAAyB,+BACb,aAAa,oBAAoB;;;;KAM7C,0BAA0B,aACpC,qBAAqB;;;;YC1FX;;;;;;;;;;YAWA,4BAA4B;;EAEtC;;EAGA,iBAAiB;;EAGjB,gBAAgB;;;;;;;;YASN,gBACV,qBAAqB;;;;YAKX;;EAEV;;EAGA,OAAO;;;;;;;YAQG,sBAAsB,gBAAgB,sBAC5C,OAAO,YAAY,iBAAiB;EACpC,YAAY,OAAO,YAAY,iBAAiB;;;;;;;YAO1C,yBAAyB,oBACnC,gBAAgB,mBACZ,sBAAsB,KACtB;;KCjEM;;;;;;;;;;;;;;;qBAgBC,sBAAsB;;WAExB,MAAM;;;;;;;;EAUb,YAAA,MAAM,mBACN,kBACA,UAAU;;;;;;;;qBCuBD;;SAEG;;SAGA;;iBAGC;;iBAGA;;iBAGA;;iBAGA;;iBAGA;;iBAGA;;;;;;;kBAQQ,gBAAgB,YAAY;;;;;;;;;;;;;;;;;SAkB/B,aAClB,iBACA,YAAY,WACZ,cAAc,2BACd,wBACC,QAAQ;;iBA4FI;;;;;;;;;;;;;;SAeK,oBAClB,iBACA,gBAAgB,iBACf,SAAS,UAAU,UAAU,eAAe;;;;;;;;;;;;;;;SAwC3B,eAClB,UAAU,UACV,eAAe,eACf,gBAAgB,gBAChB,wBACA,YAAY,YACX;;;;;;;;;;SAyCiB,4BAClB,uBACC;;;;;;;;;;;;SAqBiB,sBAClB,YAAY,QAAQ,mCACnB,SAEC,qBACA,SAAS,aAAa,MAAM,mBAC5B;;;;;;;;;;;SAmCgB,kBAClB,YAAY,QAAQ,+BACnB,SAAS,qBAAqB,SAAS,aAAa,MAAM;;;;;;;;;;;;SAgCzC,eAAe,GACjC,YACA,WAAW,WACX,qBAAqB,yBAAyB,gBAC7C,QAAQ;;;;;;;;;;;SA0BS,gBAAgB,GAClC,YACA,QAAQ,GACR,WAAW,YACV;;;;;;;;SAsBiB,iBAAiB,aAAa;;;;;;;;;;;SAmBpC,MAAM;;;;;;;;;SAoCN,iBAAiB,gBAAgB,kBAC7C,MAAM,GACN,UAAU,yBAAyB,WACnC,oBAAoB;;;;;;;;;;SAsBR,oBAAoB,gBAAgB,kBAChD,MAAM,GACN,UAAU,yBAAyB,WACnC,oBAAoB;;;;;;;;SAoBR,cAAc,gBAAgB,kBAC1C,MAAM,GACN,QAAQ,iBAAiB;;;;;;;iBAsBZ;;iBAKA;;;;;;;;;;iBAWM;;iBA+BN;;;;;;;;;;iBAWM"}