@did-btcr2/kms 0.2.0 → 0.4.0

package/dist/types/interface.d.ts

@@ -1,80 +1,110 @@
 import { Bytes, HashBytes, KeyBytes, SignatureBytes } from '@did-btcr2/common';
 import { SchnorrKeyPair } from '@did-btcr2/keypair';
+/** Opaque key identifier string. */
 export type KeyIdentifier = string;
+/** Supported signature schemes. */
+export type SigningScheme = 'schnorr' | 'ecdsa';
+/** Options for sign and verify operations. */
+export type SignOptions = {
+    /** Signature scheme. Defaults to 'schnorr'. */
+    scheme?: SigningScheme;
+};
+/** Stored key entry with optional secret key and metadata tags. */
+export type KeyEntry = {
+    /** Secret key bytes. Undefined for public-key-only (watch-only) entries. */
+    secretKey?: KeyBytes;
+    /** Compressed secp256k1 public key bytes. Always present. */
+    publicKey: KeyBytes;
+    /** Arbitrary metadata tags (e.g. derivation path, account, DID). */
+    tags?: Record<string, string>;
+};
+/** Options for importing a key. */
+export type ImportKeyOptions = {
+    /** Custom key identifier. Auto-generated URN if omitted. */
+    id?: KeyIdentifier;
+    /** Whether to set this key as the active key. Defaults to false. */
+    setActive?: boolean;
+    /** Metadata tags to associate with the key. */
+    tags?: Record<string, string>;
+};
+/** Options for generating a key. */
+export type GenerateKeyOptions = {
+    /** Whether to set the generated key as the active key. Defaults to false. */
+    setActive?: boolean;
+    /** Metadata tags to associate with the key. */
+    tags?: Record<string, string>;
+};
 /**
- * The interface for the Kms class.
+ * Interface for key management operations.
  * @interface KeyManager
- * @type {KeyManager}
  */
 export interface KeyManager {
-    /**
-     * The ID of the active key.
-     * @readonly
-     * @type {KeyIdentifier}
-     */
+    /** The ID of the active key. */
     readonly activeKeyId?: KeyIdentifier;
     /**
-     * Set the active key id.
-     * @param id The key id to set as active.
+     * Set the active key.
+     * @param id The key identifier to set as active.
+     * @throws {KeyManagerError} If the key is not found.
      */
     setActiveKey(id: KeyIdentifier): void;
     /**
-     * Import a key pair.
-     * @param {SchnorrKeyPair} keyPair The secret key to import.
-     * @param {{ id?: KeyIdentifier, setActive?: boolean }} options The options for importing the key pair.
-     * @param {KeyIdentifier} [options.id] The ID of the key to import (optional).
-     * @param {boolean} [options.setActive] Whether to set the key as active (optional, default: false).
-     * @returns {KeyIdentifier} A promise that resolves to the key identifier of the imported key.
+     * Import a key pair. May be public-key-only for watch-only entries.
+     * @param keyPair The key pair to import.
+     * @param options Import options.
+     * @returns The key identifier of the imported key.
+     * @throws {KeyManagerError} If the key already exists.
      */
-    importKey(keyPair: SchnorrKeyPair, options: {
-        id?: KeyIdentifier;
-        setActive?: boolean;
-    }): KeyIdentifier;
+    importKey(keyPair: SchnorrKeyPair, options?: ImportKeyOptions): KeyIdentifier;
     /**
-     * Removes a key from the key store.
-     * @param {KeyIdentifier} id The key identifier of the key to remove.
-     * @param {{ force?: boolean }} options The options for removing the key.
-     * @param {boolean} [options.force] Whether to force the removal of the key.
-     * @returns {void} A promise that resolves when the key is removed.
+     * Remove a key from the store.
+     * @param id The key identifier to remove.
+     * @param options Removal options.
+     * @throws {KeyManagerError} If removing the active key without force, or key not found.
      */
-    removeKey(id: KeyIdentifier, options: {
+    removeKey(id: KeyIdentifier, options?: {
         force?: boolean;
     }): void;
     /**
-     * Lists all key identifiers in the key store.
-     * @returns {KeyIdentifier[]} An array of key identifiers.
+     * List all key identifiers.
+     * @returns Array of key identifiers.
      */
     listKeys(): KeyIdentifier[];
     /**
-     * Gets the public key associated with the ID or active key.
-     * @param {KeyIdentifier} [id] The ID of the key to get the public key for.
-     * @returns {KeyBytes} A promise resolving to the public key bytes.
+     * Get the compressed public key bytes for a key.
+     * @param id Key identifier. Uses active key if omitted.
+     * @returns Compressed secp256k1 public key bytes.
+     * @throws {KeyManagerError} If key not found or no active key set.
      */
     getPublicKey(id?: KeyIdentifier): KeyBytes;
     /**
-     * Signs the given data using the key associated with the key ID.
-     * @param {Bytes} data The data to sign.
-     * @param {KeyIdentifier} [id] The ID of the key to sign the data with.
-     * @returns {SignatureBytes} A promise resolving to the signature of the data.
+     * Sign data using the specified key.
+     * @param data The data to sign.
+     * @param id Key identifier. Uses active key if omitted.
+     * @param options Signing options (scheme defaults to 'schnorr').
+     * @returns The signature bytes.
+     * @throws {KeyManagerError} If key not found, no active key, or key cannot sign.
      */
-    sign(data: Bytes, id?: KeyIdentifier): SignatureBytes;
+    sign(data: Bytes, id?: KeyIdentifier, options?: SignOptions): SignatureBytes;
     /**
-     * Verifies a signature using the key associated with the key ID.
-     * @param {KeyIdentifier} id The ID of the key to verify the signature with.
-     * @param {SignatureBytes} signature The signature to verify.
-     * @param {Hex} data The data to verify the signature with.
-     * @returns {boolean} A promise resolving to a boolean indicating the verification result.
+     * Verify a signature using the specified key.
+     * @param signature The signature to verify.
+     * @param data The data that was signed.
+     * @param id Key identifier. Uses active key if omitted.
+     * @param options Verification options (scheme defaults to 'schnorr').
+     * @returns True if the signature is valid.
+     * @throws {KeyManagerError} If key not found or no active key set.
      */
-    verify(signature: SignatureBytes, data: Bytes, id?: KeyIdentifier): boolean;
+    verify(signature: SignatureBytes, data: Bytes, id?: KeyIdentifier, options?: SignOptions): boolean;
     /**
-     * Computes the hash of the given data.
-     * @param {Uint8Array} data The data to hash.
-     * @returns {HashBytes} The hash of the data.
+     * Compute a SHA-256 hash of the given data.
+     * @param data The data to hash.
+     * @returns The hash bytes.
      */
     digest(data: Uint8Array): HashBytes;
     /**
-     * Generates a new key pair and stores it in the key store.
-     * @returns {KeyIdentifier} The identifier of the newly generated key.
+     * Generate a new key pair and store it.
+     * @param options Generation options.
+     * @returns The key identifier of the generated key.
      */
-    generateKey(): KeyIdentifier;
+    generateKey(options?: GenerateKeyOptions): KeyIdentifier;
 }

package/dist/types/interface.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"interface.d.ts","sourceRoot":"","sources":["../../src/interface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAC/E,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEpD,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AAEnC;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACzB;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,aAAa,CAAA;IAEpC;;;OAGG;IACH,YAAY,CAAC,EAAE,EAAE,aAAa,GAAG,IAAI,CAAC;IAEtC;;;;;;;OAOG;IACH,SAAS,CAAC,OAAO,EAAE,cAAc,EAAE,OAAO,EAAE;QAAE,EAAE,CAAC,EAAE,aAAa,CAAC;QAAC,SAAS,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,aAAa,CAAC;IAExG;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,EAAE,aAAa,EAAE,OAAO,EAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAEjE;;;OAGG;IACH,QAAQ,IAAI,aAAa,EAAE,CAAC;IAE5B;;;;OAIG;IACH,YAAY,CAAC,EAAE,CAAC,EAAE,aAAa,GAAG,QAAQ,CAAC;IAE3C;;;;;OAKG;IACH,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,EAAE,aAAa,GAAG,cAAc,CAAC;IAEtD;;;;;;OAMG;IACH,MAAM,CAAC,SAAS,EAAE,cAAc,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC;IAE5E;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,UAAU,GAAG,SAAS,CAAC;IAEpC;;;OAGG;IACH,WAAW,IAAI,aAAa,CAAC;CAC9B"}
+{"version":3,"file":"interface.d.ts","sourceRoot":"","sources":["../../src/interface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAC/E,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEpD,oCAAoC;AACpC,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AAEnC,mCAAmC;AACnC,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,OAAO,CAAC;AAEhD,8CAA8C;AAC9C,MAAM,MAAM,WAAW,GAAG;IACxB,+CAA+C;IAC/C,MAAM,CAAC,EAAE,aAAa,CAAC;CACxB,CAAC;AAEF,mEAAmE;AACnE,MAAM,MAAM,QAAQ,GAAG;IACrB,4EAA4E;IAC5E,SAAS,CAAC,EAAE,QAAQ,CAAC;IACrB,6DAA6D;IAC7D,SAAS,EAAE,QAAQ,CAAC;IACpB,oEAAoE;IACpE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC/B,CAAC;AAEF,mCAAmC;AACnC,MAAM,MAAM,gBAAgB,GAAG;IAC7B,4DAA4D;IAC5D,EAAE,CAAC,EAAE,aAAa,CAAC;IACnB,oEAAoE;IACpE,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,+CAA+C;IAC/C,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC/B,CAAC;AAEF,oCAAoC;AACpC,MAAM,MAAM,kBAAkB,GAAG;IAC/B,6EAA6E;IAC7E,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,+CAA+C;IAC/C,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC/B,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,gCAAgC;IAChC,QAAQ,CAAC,WAAW,CAAC,EAAE,aAAa,CAAC;IAErC;;;;OAIG;IACH,YAAY,CAAC,EAAE,EAAE,aAAa,GAAG,IAAI,CAAC;IAEtC;;;;;;OAMG;IACH,SAAS,CAAC,OAAO,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,aAAa,CAAC;IAE9E;;;;;OAKG;IACH,SAAS,CAAC,EAAE,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAElE;;;OAGG;IACH,QAAQ,IAAI,aAAa,EAAE,CAAC;IAE5B;;;;;OAKG;IACH,YAAY,CAAC,EAAE,CAAC,EAAE,aAAa,GAAG,QAAQ,CAAC;IAE3C;;;;;;;OAOG;IACH,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,cAAc,CAAC;IAE7E;;;;;;;;OAQG;IACH,MAAM,CAAC,SAAS,EAAE,cAAc,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC;IAEnG;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,UAAU,GAAG,SAAS,CAAC;IAEpC;;;;OAIG;IACH,WAAW,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,aAAa,CAAC;CAC1D"}

package/dist/types/kms.d.ts

@@ -1,106 +1,118 @@
 import { Bytes, HashBytes, KeyBytes, SignatureBytes } from '@did-btcr2/common';
 import { SchnorrKeyPair } from '@did-btcr2/keypair';
-import { KeyIdentifier, KeyManager } from './interface.js';
+import { GenerateKeyOptions, ImportKeyOptions, KeyEntry, KeyIdentifier, KeyManager, SignOptions } from './interface.js';
 import { KeyValueStore } from './store.js';
 /**
- * Class for managing cryptographic keys for the BTCR2 DID method.
- * @class Kms
- * @type {Kms}
+ * Key Management System for the did:btcr2 DID method.
+ *
+ * Implements the {@link KeyManager} interface with a pluggable
+ * {@link KeyValueStore} (defaults to {@link MemoryStore}).
+ *
+ * Supports both signing (secret key present) and watch-only
+ * (public-key-only) key entries, and both Schnorr and ECDSA
+ * signature schemes.
+ *
  */
 export declare class Kms implements KeyManager {
     #private;
     /**
-     * Creates an instance of KeyManager.
-     * @param {KeyValueStore<KeyIdentifier, KeyBytes>} store An optional property to specify a custom
-     * `KeyValueStore` instance for key management. If not provided, {@link KeyManager} uses a default `MemoryStore`
-     * instance. This store is responsible for managing cryptographic keys, allowing them to be retrieved, stored, and
-     * managed during cryptographic operations.
+     * Create a new KMS instance.
+     *
+     * @param {KeyValueStore<KeyIdentifier, KeyEntry>} [store] Optional key-value store.
+     * Defaults to in-memory store if not provided.
      */
-    constructor(store?: KeyValueStore<KeyIdentifier, KeyBytes>);
+    constructor(store?: KeyValueStore<KeyIdentifier, KeyEntry>);
     /**
-     * Gets the ID of the active key.
-     * @returns {KeyIdentifier | undefined} The ID of the active key.
+     * Get the active key identifier.
+     *
+     * @returns {KeyIdentifier | undefined} The active key identifier, or undefined if none is set.
      */
     get activeKeyId(): KeyIdentifier | undefined;
     /**
-     * Removes a key from the key store.
-     * @param {KeyIdentifier} id The key identifier of the key to remove.
-     * @param {{ force?: boolean }} options The options for removing the key.
-     * @param {boolean} [options.force] Whether to force the removal of the key.
-     * @returns {void} A promise that resolves when the key is removed.
-     * @throws {KeyManagerError} If attempting to remove the active key without force.
-     */
-    removeKey(id: KeyIdentifier, options?: {
-        force?: boolean;
-    }): void;
-    /**
-     * Lists all key identifiers in the key store.
-     * @returns {Promise<KeyIdentifier[]>} A promise that resolves to an array of key identifiers.
-     */
-    listKeys(): KeyIdentifier[];
-    /**
-     * Sets the active key to the key associated with the given ID.
-     * @param {KeyIdentifier} id The ID of the key to set as active.
-     * @returns {Promise<void>} A promise that resolves when the active key is set.
+     * Set the active key.
+     *
+     * @param id The key identifier to set as active.
      * @throws {KeyManagerError} If the key is not found.
      */
     setActiveKey(id: KeyIdentifier): void;
     /**
-     * Gets the public key associated with the given ID or the active key if no ID is provided.
-     * @param {KeyIdentifier} [id] The ID of the key to get the public key for.
-     * @returns {Promise<KeyBytes>} A promise resolving to the public key bytes.
+     * Get the compressed public key bytes for a key.
+     *
+     * @param id Key identifier. Uses active key if omitted.
+     * @returns Compressed secp256k1 public key bytes.
+     * @throws {KeyManagerError} If key not found or no active key set.
      */
     getPublicKey(id?: KeyIdentifier): KeyBytes;
     /**
-     * Signs the given data using the key associated with the key ID.
+     * Sign data using the specified key.
+     *
      * @param {Bytes} data The data to sign.
-     * @param {KeyIdentifier} [id] The ID of the key to sign the data with.
-     * @returns {Promise<SignatureBytes>} A promise resolving to the signature of the data.
+     * @param {KeyIdentifier} [id] Key identifier. Uses active key if omitted.
+     * @param {SignOptions} [options] Signing options (scheme defaults to 'schnorr').
+     * @returns {SignatureBytes} The signature bytes.
+     * @throws {KeyManagerError} If key not found, no active key, or key cannot sign.
      */
-    sign(data: Bytes, id?: KeyIdentifier): SignatureBytes;
+    sign(data: Bytes, id?: KeyIdentifier, options?: SignOptions): SignatureBytes;
     /**
-     * Verifies a signature using the key associated with the key ID.
-     * @param {KeyIdentifier} id The ID of the key to verify the signature with.
-     * @param {SignatureBytes} signature The signature to verify.
-     * @param {Hex} data The data to verify the signature with.
-     * @returns {Promise<boolean>} A promise resolving to a boolean indicating the verification result.
+     * Verify a signature using the specified key.
+     *
+     * @param {SignatureBytes} signature The signature bytes to verify.
+     * @param {Bytes} data The data that was signed.
+     * @param {KeyIdentifier} [id] Key identifier. Uses active key if omitted.
+     * @param {SignOptions} [options] Verification options (scheme defaults to 'schnorr').
+     * @returns {boolean} True if the signature is valid, false otherwise.
+     * @throws {KeyManagerError} If key not found or no active key set.
      */
-    verify(signature: SignatureBytes, data: Bytes, id?: KeyIdentifier): boolean;
+    verify(signature: SignatureBytes, data: Bytes, id?: KeyIdentifier, options?: SignOptions): boolean;
     /**
-     * Imports a key pair into the key store.
+     * Import a key pair into the KMS.
+     *
      * @param {SchnorrKeyPair} keyPair The key pair to import.
-     * @param {{ id?: KeyIdentifier; setActive?: boolean }} options The options for importing the key pair.
-     * @param {KeyIdentifier} [options.id] The ID of the key to import (optional).
-     * @param {boolean} [options.setActive] Whether to set the key as active (optional, default: true).
-     * @returns {Promise<KeyIdentifier>} A promise resolving to the ID of the imported key.
+     * @param {ImportKeyOptions} [options] Import options (id, tags, setActive).
+     * @returns {KeyIdentifier} The identifier of the imported key.
+     * @throws {KeyManagerError} If a key with the same identifier already exists.
      */
-    importKey(keyPair: SchnorrKeyPair, options?: {
-        id?: KeyIdentifier;
-        setActive?: boolean;
-    }): KeyIdentifier;
+    importKey(keyPair: SchnorrKeyPair, options?: ImportKeyOptions): KeyIdentifier;
     /**
-     * Computes the hash of the given data.
-     * @param {Uint8Array} data The data to hash.
-     * @returns {HashBytes} The hash of the data.
+     * Remove a key from the KMS.
+     *
+     * @param {KeyIdentifier} id The key identifier to remove.
+     * @param {Object} [options] Removal options.
+     * @param {boolean} [options.force=false] Force removal of active key.
+     * @throws {KeyManagerError} If key not found or attempting to remove active key without force.
      */
-    digest(data: Uint8Array): HashBytes;
+    removeKey(id: KeyIdentifier, options?: {
+        force?: boolean;
+    }): void;
     /**
-     * Generates a new key pair and stores it in the key store.
-     * @returns {KeyIdentifier} The key identifier of the generated key.
+     * List all key identifiers in the KMS.
+     *
+     * @returns {KeyIdentifier[]} Array of key identifiers.
      */
-    generateKey(): KeyIdentifier;
+    listKeys(): KeyIdentifier[];
+    /**
+     * Compute the SHA-256 digest of the given data.
+     *
+     * @param {Uint8Array} data The data to digest.
+     * @returns {HashBytes} The SHA-256 hash of the data.
+     */
+    digest(data: Uint8Array): HashBytes;
     /**
-     * Initializes a singleton KeyManager instance.
-     * @param {SchnorrKeyPair} keyPair The secret key to import.
-     * @param {string} id The ID to set as the active key.
-     * @returns {void}
+     * Generate a new secp256k1 key pair and store it in the KMS.
+     *
+     * @param {GenerateKeyOptions} [options] Generation options (tags, setActive).
+     * @returns {KeyIdentifier} The identifier of the generated key.
      */
-    static initialize(keyPair: SchnorrKeyPair, id: string): Kms;
+    generateKey(options?: GenerateKeyOptions): KeyIdentifier;
     /**
-     * Retrieves a keypair from the key store using the provided key ID.
-     * @public
-     * @param {KeyIdentifier} id The ID of the keypair to retrieve.
-     * @returns {Promise<SchnorrKeyPair | undefined>} The retrieved keypair, or undefined if not found.
+     * Export the key pair for a stored key.
+     *
+     * Only available on the concrete {@link Kms} class, not on the
+     * {@link KeyManager} interface. HSM or hardware-backed implementations
+     * may not support key export.
+     *
+     * @param {KeyIdentifier} id The key identifier to export.
+     * @returns {SchnorrKeyPair} The reconstructed SchnorrKeyPair.
      */
-    static getKey(id?: KeyIdentifier): SchnorrKeyPair | undefined;
+    exportKey(id: KeyIdentifier): SchnorrKeyPair;
 }

package/dist/types/kms.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"kms.d.ts","sourceRoot":"","sources":["../../src/kms.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAmB,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAChG,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEpD,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAe,MAAM,YAAY,CAAC;AAExD;;;;GAIG;AACH,qBAAa,GAAI,YAAW,UAAU;;IA+BpC;;;;;;OAMG;gBACS,KAAK,CAAC,EAAE,aAAa,CAAC,aAAa,EAAE,QAAQ,CAAC;IAK1D;;;OAGG;IACH,IAAI,WAAW,IAAI,aAAa,GAAG,SAAS,CAE3C;IAuCD;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,EAAE,aAAa,EAAE,OAAO,GAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAO,GAAG,IAAI;IAoBrE;;;OAGG;IACH,QAAQ,IAAI,aAAa,EAAE;IAI3B;;;;;OAKG;IACH,YAAY,CAAC,EAAE,EAAE,aAAa,GAAG,IAAI;IAQrC;;;;OAIG;IACH,YAAY,CAAC,EAAE,CAAC,EAAE,aAAa,GAAG,QAAQ;IAQ1C;;;;;OAKG;IACH,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,EAAE,aAAa,GAAG,cAAc;IAarD;;;;;;OAMG;IACH,MAAM,CAAC,SAAS,EAAE,cAAc,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,EAAE,aAAa,GAAG,OAAO;IAQ3E;;;;;;;OAOG;IACH,SAAS,CACP,OAAO,EAAE,cAAc,EACvB,OAAO,GAAE;QACP,EAAE,CAAC,EAAE,aAAa,CAAC;QACnB,SAAS,CAAC,EAAE,OAAO,CAAA;KACf,GACL,aAAa;IA6BhB;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,UAAU,GAAG,SAAS;IAInC;;;OAGG;IACH,WAAW,IAAI,aAAa;IAe5B;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CAAC,OAAO,EAAE,cAAc,EAAE,EAAE,EAAE,MAAM,GAAG,GAAG;IAgC3D;;;;;OAKG;IACH,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,aAAa,GAAG,cAAc,GAAG,SAAS;CAY9D"}
+{"version":3,"file":"kms.d.ts","sourceRoot":"","sources":["../../src/kms.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,EACL,SAAS,EACT,QAAQ,EAER,cAAc,EACf,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEpD,OAAO,EACL,kBAAkB,EAClB,gBAAgB,EAChB,QAAQ,EACR,aAAa,EACb,UAAU,EACV,WAAW,EACZ,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,aAAa,EAAe,MAAM,YAAY,CAAC;AAExD;;;;;;;;;;GAUG;AACH,qBAAa,GAAI,YAAW,UAAU;;IAIpC;;;;;OAKG;gBACS,KAAK,CAAC,EAAE,aAAa,CAAC,aAAa,EAAE,QAAQ,CAAC;IAI1D;;;;OAIG;IACH,IAAI,WAAW,IAAI,aAAa,GAAG,SAAS,CAE3C;IAqCD;;;;;OAKG;IACH,YAAY,CAAC,EAAE,EAAE,aAAa,GAAG,IAAI;IAKrC;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,CAAC,EAAE,aAAa,GAAG,QAAQ;IAI1C;;;;;;;;OAQG;IACH,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,EAAE,aAAa,EAAE,OAAO,GAAE,WAAgB,GAAG,cAAc;IAUhF;;;;;;;;;OASG;IACH,MAAM,CAAC,SAAS,EAAE,cAAc,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,EAAE,aAAa,EAAE,OAAO,GAAE,WAAgB,GAAG,OAAO;IAMtG;;;;;;;OAOG;IACH,SAAS,CAAC,OAAO,EAAE,cAAc,EAAE,OAAO,GAAE,gBAAqB,GAAG,aAAa;IA8BjF;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,EAAE,aAAa,EAAE,OAAO,GAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAO,GAAG,IAAI;IAmBrE;;;;OAIG;IACH,QAAQ,IAAI,aAAa,EAAE;IAI3B;;;;;OAKG;IACH,MAAM,CAAC,IAAI,EAAE,UAAU,GAAG,SAAS;IAInC;;;;;OAKG;IACH,WAAW,CAAC,OAAO,GAAE,kBAAuB,GAAG,aAAa;IAmB5D;;;;;;;;;OASG;IACH,SAAS,CAAC,EAAE,EAAE,aAAa,GAAG,cAAc;CAO7C"}

package/dist/types/store.d.ts

@@ -1,123 +1,33 @@
 /**
- * Re-implmentation of a interface for a generic key-value store.
+ * Interface for a generic key-value store.
  */
 export interface KeyValueStore<K, V> {
-    /**
-     * Clears the store, removing all key-value pairs.
-     *
-     * @returns {void} when the store has been cleared.
-     */
+    /** Clear all entries. */
     clear(): void;
-    /**
-     * Closes the store, freeing up any resources used. After calling this method, no other operations can be performed on the store.
-     *
-     * @returns {void} when the store has been closed.
-     */
+    /** Close the store, freeing resources. */
     close(): void;
-    /**
-     * Deletes a key-value pair from the store.
-     *
-     * @param {K} key - The key of the value to delete.
-     * @returns {boolean | void} True if the element existed and has been removed, or false if the element does not exist.
-     */
+    /** Delete an entry by key. Returns true if the entry existed. */
     delete(key: K): boolean | void;
-    /**
-     * Fetches a value from the store given its key.
-     *
-     * @param {K} key - The key of the value to retrieve.
-     * @returns {V | undefined} The value associated with the key, or `undefined` if no value exists for that key.
-     */
+    /** Get an entry by key. Returns undefined if not found. */
     get(key: K): V | undefined;
-    /**
-     * Sets the value for a key in the store.
-     *
-     * @param {K} key - The key under which to store the value.
-     * @param {V} value - The value to be stored.
-     * @returns {void} once the value has been set.
-     */
+    /** Check if a key exists in the store. */
+    has(key: K): boolean;
+    /** Set a value for a key. */
     set(key: K, value: V): void;
-    /**
-     * Fetches the keys and values as a nested array.
-     *
-     * @returns {Array<[K, V]>} An array of key-value pair arrays in the store.
-     */
+    /** Get all entries as key-value tuples. */
     entries(): Array<[K, V]>;
 }
 /**
- * Re-implementation of a simple in-memory key-value store.
- *
- * The `MemoryStore` class is an implementation of
- * `KeyValueStore` that holds data in memory.
- *
- * It provides a basic key-value store that works synchronously and keeps all
- * data in memory. This can be used for testing, or for handling small amounts
- * of data with simple key-value semantics.
- *
- * Example usage:
- *
- * ```ts
- * const memoryStore = new MemoryStore<string, number>();
- * await memoryStore.set("key1", 1);
- * const value = await memoryStore.get("key1");
- * console.log(value); // 1
- * ```
- *
- * @public
+ * In-memory key-value store backed by a Map.
  */
 export declare class MemoryStore<K, V> implements KeyValueStore<K, V> {
-    /**
-     * A private field that contains the Map used as the key-value store.
-     */
-    private store;
-    /**
-     * Clears all entries in the key-value store.
-     *
-     * @returns {void} returns once the operation is complete.
-     */
+    #private;
     clear(): void;
-    /**
-     * This operation is no-op for `MemoryStore`.
-     */
     close(): void;
-    /**
-     * Deletes an entry from the key-value store by its key.
-     *
-     * @param {K} id - The key of the entry to delete.
-     * @returns {boolean} a boolean indicating whether the entry was successfully deleted.
-     */
-    delete(id: K): boolean;
-    /**
-     * Retrieves the value of an entry by its key.
-     *
-     * @param {K} id - The key of the entry to retrieve.
-     * @returns {V | undefined} the value of the entry, or `undefined` if the entry does not exist.
-     */
-    get(id: K): V | undefined;
-    /**
-     * Checks for the presence of an entry by key.
-     *
-     * @param {K} id - The key to check for the existence of.
-     * @returns {boolean} a boolean indicating whether an element with the specified key exists or not.
-     */
-    has(id: K): boolean;
-    /**
-     * Retrieves all values in the key-value store.
-  
-     * @returns {Array<V>} an array of all values in the store.
-     */
+    delete(key: K): boolean;
+    get(key: K): V | undefined;
+    has(key: K): boolean;
     list(): Array<V>;
-    /**
-     * Retrieves all entries in the key-value store.
-     *
-     * @returns {Array<[K, V]>} an array of key-value pairs in the store.
-     */
     entries(): Array<[K, V]>;
-    /**
-     * Sets the value of an entry in the key-value store.
-     *
-     * @param {K} id - The key of the entry to set.
-     * @param {V} key - The new value for the entry.
-     * @returns {void} once operation is complete.
-     */
-    set(id: K, key: V): void;
+    set(key: K, value: V): void;
 }

package/dist/types/store.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../../src/store.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,EAAE,CAAC;IACjC;;;;OAIG;IACH,KAAK,IAAI,IAAI,CAAC;IAEd;;;;OAIG;IACH,KAAK,IAAI,IAAI,CAAC;IAEd;;;;;OAKG;IACH,MAAM,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO,GAAG,IAAI,CAAC;IAE/B;;;;;OAKG;IACH,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC;IAE3B;;;;;;OAMG;IACH,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC;IAE5B;;;;OAIG;IACH,OAAO,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;CAC1B;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,WAAW,CAAC,CAAC,EAAE,CAAC,CAAE,YAAW,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC;IAC3D;;OAEG;IACH,OAAO,CAAC,KAAK,CAAwB;IAErC;;;;OAIG;IACH,KAAK,IAAI,IAAI;IAIb;;OAEG;IACH,KAAK,IAAI,IAAI;IAIb;;;;;OAKG;IACH,MAAM,CAAC,EAAE,EAAE,CAAC,GAAG,OAAO;IAItB;;;;;OAKG;IACH,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS;IAIzB;;;;;OAKG;IACH,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,OAAO;IAInB;;;;OAIG;IACH,IAAI,IAAI,KAAK,CAAC,CAAC,CAAC;IAIhB;;;;OAIG;IACH,OAAO,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAIxB;;;;;;OAMG;IACH,GAAG,CAAC,EAAE,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,IAAI;CAGzB"}
+{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../../src/store.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,EAAE,CAAC;IACjC,yBAAyB;IACzB,KAAK,IAAI,IAAI,CAAC;IAEd,0CAA0C;IAC1C,KAAK,IAAI,IAAI,CAAC;IAEd,iEAAiE;IACjE,MAAM,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO,GAAG,IAAI,CAAC;IAE/B,2DAA2D;IAC3D,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC;IAE3B,0CAA0C;IAC1C,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC;IAErB,6BAA6B;IAC7B,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC;IAE5B,2CAA2C;IAC3C,OAAO,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;CAC1B;AAED;;GAEG;AACH,qBAAa,WAAW,CAAC,CAAC,EAAE,CAAC,CAAE,YAAW,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC;;IAG3D,KAAK,IAAI,IAAI;IAIb,KAAK,IAAI,IAAI;IAIb,MAAM,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO;IAIvB,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS;IAI1B,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO;IAIpB,IAAI,IAAI,KAAK,CAAC,CAAC,CAAC;IAIhB,OAAO,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAIxB,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI;CAG5B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@did-btcr2/kms",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "type": "module",
   "description": "Key manager that can be used with the did:btcr2 DID method",
   "main": "./dist/cjs/index.js",
@@ -56,10 +56,8 @@
   ],
   "dependencies": {
     "@noble/hashes": "^2.0.1",
-    "@did-btcr2/bitcoin": "0.3.4",
-    "@did-btcr2/common": "3.1.0",
-    "@did-btcr2/cryptosuite": "5.0.0",
-    "@did-btcr2/keypair": "0.9.0"
+    "@did-btcr2/common": "5.0.0",
+    "@did-btcr2/keypair": "0.10.0"
   },
   "devDependencies": {
     "@eslint/js": "^9.22.0",

package/src/index.ts

@@ -1,4 +1,3 @@
 export * from './interface.js';
 export * from './kms.js';
-export * from './signer.js';
 export * from './store.js';