@docknetwork/wallet-sdk-core 1.5.14 → 1.7.6

package/lib/wallet.js

@@ -1,6 +1,15 @@
 "use strict";
+/**
+ * @module wallet
+ * @description Core wallet functionality for the Dock Wallet SDK.
+ * This module provides the main wallet creation and management functions.
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createWallet = exports.WalletEvents = exports.ensureDocumentContext = void 0;
+exports.WalletEvents = void 0;
+exports.ensureDocumentContext = ensureDocumentContext;
+exports.createWallet = createWallet;
+const types_1 = require("./types");
+Object.defineProperty(exports, "WalletEvents", { enumerable: true, get: function () { return types_1.WalletEvents; } });
 const wallet_wasm_1 = require("./wallet-wasm");
 const events_1 = require("events");
 const wallet_1 = require("@docknetwork/wallet-sdk-wasm/lib/services/wallet");
@@ -9,6 +18,12 @@ const did_provider_1 = require("./did-provider");
 function once(emitter, eventName) {
     return new Promise(resolve => emitter.once(eventName, resolve));
 }
+/**
+ * Ensures a document has the proper @context for Universal Wallet compatibility
+ * @param {Object} document - The document to add context to
+ * @returns {Object} The document with @context added if it was missing
+ * @private
+ */
 function ensureDocumentContext(document) {
     if (document['@context']) {
         return document;
@@ -18,26 +33,27 @@ function ensureDocumentContext(document) {
         '@context': ['https://w3id.org/wallet/v1'],
     };
 }
-exports.ensureDocumentContext = ensureDocumentContext;
-exports.WalletEvents = {
-    ready: 'ready',
-    error: 'error',
-    migrated: 'migrated',
-    statusUpdated: 'status-updated',
-    documentAdded: 'document-added',
-    documentUpdated: 'document-updated',
-    documentRemoved: 'document-removed',
-    walletDeleted: 'wallet-deleted',
-    walletImported: 'wallet-imported',
-    networkUpdated: 'network-updated',
-    networkConnected: 'network-connected',
-    networkError: 'network-error',
-};
 /**
- * Create wallet
+ * Creates a new wallet instance with the provided data store.
+ * The wallet provides secure storage and management of DIDs, credentials, keys, and other documents.
+ *
+ * @param {CreateWalletProps} props - Configuration options for wallet creation
+ * @param {DataStore} props.dataStore - The data store implementation to use for persistence
+ * @returns {Promise<IWallet>} A promise that resolves to the created wallet instance
+ * @see {@link IWallet} - The interface defining all available wallet methods
+ *
+ * @example
+ * import { createWallet } from '@docknetwork/wallet-sdk-core';
+ * import { createDataStore } from '@docknetwork/wallet-sdk-data-store';
  *
- * @param createWalletProps
- * @returns {Promise<IWallet>}
+ * const dataStore = await createDataStore();
+ * const wallet = await createWallet({ dataStore });
+ *
+ * // The wallet implements the IWallet interface
+ * await wallet.addDocument(myCredential);
+ * const documents = await wallet.getAllDocuments();
+ *
+ * @throws {Error} If the data store is not properly initialized
  */
 async function createWallet({ dataStore, }) {
     let status;
@@ -55,57 +71,169 @@ async function createWallet({ dataStore, }) {
                 dataStore,
             });
         },
+        /**
+         * Deletes the entire wallet and all its documents
+         * @memberof IWallet
+         * @returns {Promise<void>}
+         * @fires WalletEvents.walletDeleted
+         */
         deleteWallet: async () => {
             await dataStore.documents.removeAllDocuments();
-            eventEmitter.emit(exports.WalletEvents.walletDeleted);
+            eventEmitter.emit(types_1.WalletEvents.walletDeleted);
         },
+        /**
+         * Sets the wallet status
+         * @memberof IWallet
+         * @param {string} newStatus - The new status to set
+         */
         setStatus(newStatus) {
             status = newStatus;
         },
+        /**
+         * Sets the active network for the wallet
+         * @memberof IWallet
+         * @param {string} networkId - The network identifier to switch to
+         * @returns {Promise<void>}
+         * @fires WalletEvents.networkUpdated
+         */
         setNetwork: async (networkId) => {
             await dataStore.setNetwork(networkId);
-            eventEmitter.emit(exports.WalletEvents.networkUpdated, networkId);
+            eventEmitter.emit(types_1.WalletEvents.networkUpdated, networkId);
         },
+        /**
+         * Gets the current network ID
+         * @memberof IWallet
+         * @returns {string} The current network identifier
+         */
         getNetworkId: () => {
             return dataStore.networkId;
         },
+        /**
+         * Retrieves a document by its ID
+         * @memberof IWallet
+         * @param {string} id - The unique identifier of the document
+         * @returns {Promise<WalletDocument>} The document with the specified ID
+         * @throws {Error} If document is not found
+         */
         getDocumentById: (id) => dataStore.documents.getDocumentById(id),
+        /**
+         * Retrieves all documents stored in the wallet
+         * @memberof IWallet
+         * @returns {Promise<WalletDocument[]>} Array of all documents in the wallet
+         */
         getAllDocuments: () => dataStore.documents.getAllDocuments(),
+        /**
+         * Retrieves multiple documents by their IDs
+         * @memberof IWallet
+         * @param {string[]} idList - Array of document IDs to retrieve
+         * @returns {Promise<WalletDocument[]>} Array of documents matching the provided IDs
+         */
         getDocumentsById: (idList) => dataStore.documents.getDocumentsById(idList),
+        /**
+         * Retrieves all documents of a specific type
+         * @memberof IWallet
+         * @param {string} type - The document type to filter by (e.g., 'VerifiableCredential', 'DIDDocument')
+         * @returns {Promise<WalletDocument[]>} Array of documents matching the specified type
+         */
         getDocumentsByType: (type) => dataStore.documents.getDocumentsByType(type),
+        /**
+         * Adds a new document to the wallet
+         * @memberof IWallet
+         * @param {any} json - The document to add (must have valid JSON-LD structure)
+         * @param {any} [options] - Optional parameters for document creation
+         * @returns {Promise<WalletDocument>} The created document with generated metadata
+         * @fires WalletEvents.documentAdded
+         * @example
+         * const credential = {
+         *   "@context": ["https://www.w3.org/2018/credentials/v1"],
+         *   "type": ["VerifiableCredential"],
+         *   "issuer": "did:dock:123",
+         *   "credentialSubject": { "name": "John Doe" }
+         * };
+         * const addedDoc = await wallet.addDocument(credential);
+         */
         addDocument: (json) => {
             return dataStore.documents.addDocument(json).then(result => {
-                eventEmitter.emit(exports.WalletEvents.documentAdded, result);
+                eventEmitter.emit(types_1.WalletEvents.documentAdded, result);
                 return result;
             });
         },
+        /**
+         * Updates an existing document
+         * @memberof IWallet
+         * @param {any} document - The document with updated data (must include ID)
+         * @param {any} [options] - Optional parameters for document update
+         * @returns {Promise<WalletDocument>} The updated document
+         * @fires WalletEvents.documentUpdated
+         * @throws {Error} If document doesn't exist
+         */
         updateDocument: (document) => {
             return dataStore.documents.updateDocument(document).then(result => {
-                eventEmitter.emit(exports.WalletEvents.documentUpdated, result);
+                eventEmitter.emit(types_1.WalletEvents.documentUpdated, result);
                 return result;
             });
         },
+        /**
+         * Removes a document from the wallet
+         * @memberof IWallet
+         * @param {string} id - The ID of the document to remove
+         * @param {any} [options] - Optional parameters for document removal
+         * @returns {Promise<void>}
+         * @fires WalletEvents.documentRemoved
+         * @throws {Error} If document is not found
+         */
         removeDocument: async (id) => {
             const document = await wallet.getDocumentById(id);
             return dataStore.documents.removeDocument(id).then(result => {
-                eventEmitter.emit(exports.WalletEvents.documentRemoved, document);
+                eventEmitter.emit(types_1.WalletEvents.documentRemoved, document);
                 return result;
             });
         },
+        /**
+         * Gets all documents correlated to a specific document
+         * @memberof IWallet
+         * @param {string} documentId - The ID of the document to find correlations for
+         * @returns {Promise<WalletDocument[]>} Array of correlated documents
+         */
         getDocumentCorrelations: (documentId) => {
             return dataStore.documents.getDocumentCorrelations(documentId);
         },
+        /**
+         * Retrieves the keypair associated with an account
+         * @memberof IWallet
+         * @param {string} accountId - The account ID to get the keypair for
+         * @returns {Promise<any>} The keypair associated with the account
+         */
         getAccountKeyPair: async (accountId) => {
             const correlations = await dataStore.documents.getDocumentCorrelations(accountId);
             const keyPair = correlations.find(correlation => correlation.type === 'KeyringPair');
             return keyPair?.value;
         },
+        /**
+         * Decrypts and retrieves documents from an encrypted wallet without importing
+         * @memberof IWallet
+         * @param {any} json - The encrypted wallet JSON
+         * @param {string} password - Password to decrypt the wallet
+         * @returns {Promise<any>} Array of decrypted documents
+         */
         getDocumentsFromEncryptedWallet: async (json, password) => {
             return wallet_1.walletService.getDocumentsFromEncryptedWallet({
                 encryptedJSONWallet: json,
                 password,
             });
         },
+        /**
+         * Imports documents from an encrypted Universal Wallet 2020 JSON
+         * @memberof IWallet
+         * @param {any} json - The encrypted wallet JSON
+         * @param {string} password - Password to decrypt the wallet
+         * @returns {Promise<void>}
+         * @see {@link https://w3c-ccg.github.io/universal-wallet-interop-spec/}
+         * @example
+         * // Import from encrypted wallet backup
+         * const walletBackup = { ... }; // encrypted wallet JSON
+         * await wallet.importUniversalWalletJSON(walletBackup, 'mypassword');
+         */
         importUniversalWalletJSON: async (json, password) => {
             const documents = await wallet_1.walletService.getDocumentsFromEncryptedWallet({
                 encryptedJSONWallet: json,
@@ -117,6 +245,14 @@ async function createWallet({ dataStore, }) {
             });
             return documents;
         },
+        /**
+         * Exports specified documents as an encrypted JSON (test)
+         * @memberof IWallet
+         * @param {Object} params - Export parameters
+         * @param {any[]} params.documents - Documents to export
+         * @param {string} params.password - Password for encryption
+         * @returns {Promise<any>} Encrypted wallet JSON
+         */
         exportDocuments: async (params) => {
             const documents = params.documents.map(ensureDocumentContext);
             return wallet_1.walletService.exportDocuments({
@@ -124,6 +260,17 @@ async function createWallet({ dataStore, }) {
                 password: params.password,
             });
         },
+        /**
+         * Exports the entire wallet as an encrypted Universal Wallet 2020 JSON
+         * @memberof IWallet
+         * @param {string} password - Password for encryption
+         * @returns {any} Encrypted Universal Wallet JSON representation
+         * @see {@link https://w3c-ccg.github.io/universal-wallet-interop-spec/}
+         * @example
+         * // Create encrypted backup of entire wallet
+         * const backup = await wallet.exportUniversalWalletJSON('mypassword');
+         * // Save backup to file or cloud storage
+         */
         exportUniversalWalletJSON: async (password) => {
             let documents = await dataStore.documents.getAllDocuments(true);
             const result = await wallet.exportDocuments({
@@ -137,12 +284,11 @@ async function createWallet({ dataStore, }) {
     await (0, did_provider_1.ensureDID)({
         wallet,
     });
-    [exports.WalletEvents.networkUpdated, exports.WalletEvents.walletDeleted].forEach(event => eventEmitter.on(event, () => {
+    [types_1.WalletEvents.networkUpdated, types_1.WalletEvents.walletDeleted].forEach(event => eventEmitter.on(event, () => {
         (0, did_provider_1.ensureDID)({
             wallet,
         });
     }));
     return wallet;
 }
-exports.createWallet = createWallet;
 //# sourceMappingURL=wallet.js.map

package/lib/wallet.js.map

@@ -1 +1 @@
-{"version":3,"file":"wallet.js","sourceRoot":"","sources":["../src/wallet.ts"],"names":[],"mappings":";;;AACA,+CAA6C;AAC7C,mCAAoC;AACpC,6EAA+E;AAC/E,4EAA8F;AAC9F,iDAAyC;AAGzC,SAAS,IAAI,CAAC,OAAqB,EAAE,SAAiB;IACpD,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;AAClE,CAAC;AAED,SAAgB,qBAAqB,CAAC,QAAQ;IAC5C,IAAI,QAAQ,CAAC,UAAU,CAAC,EAAE;QACxB,OAAO,QAAQ,CAAC;KACjB;IAED,OAAO;QACL,GAAG,QAAQ;QACX,UAAU,EAAE,CAAC,4BAA4B,CAAC;KAC3C,CAAC;AACJ,CAAC;AATD,sDASC;AAOY,QAAA,YAAY,GAAG;IAC1B,KAAK,EAAE,OAAO;IACd,KAAK,EAAE,OAAO;IACd,QAAQ,EAAE,UAAU;IACpB,aAAa,EAAE,gBAAgB;IAC/B,aAAa,EAAE,gBAAgB;IAC/B,eAAe,EAAE,kBAAkB;IACnC,eAAe,EAAE,kBAAkB;IACnC,aAAa,EAAE,gBAAgB;IAC/B,cAAc,EAAE,iBAAiB;IACjC,cAAc,EAAE,iBAAiB;IACjC,gBAAgB,EAAE,mBAAmB;IACrC,YAAY,EAAE,eAAe;CAC9B,CAAC;AAEF;;;;;GAKG;AACI,KAAK,UAAU,YAAY,CAAC,EACjC,SAAS,GACS;IAClB,IAAI,MAAM,CAAC;IAEX,MAAM,YAAY,GAAG,IAAI,qBAAY,EAAE,CAAC;IAExC,MAAM,MAAM,GAAG;QACb,YAAY,EAAE,YAAY;QAC1B,YAAY,EAAE,CAAC,SAAiB,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,EAAE,SAAS,CAAQ;QACzE,SAAS;QACT,SAAS;YACP,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,sBAAsB,EAAE,KAAK,EAAE,QAAa,EAAE,EAAE;YAC9C,OAAO,SAAS,CAAC,sBAAsB,CAAC;gBACtC,QAAQ;gBACR,SAAS;aACV,CAAC,CAAC;QACL,CAAC;QACD,YAAY,EAAE,KAAK,IAAI,EAAE;YACvB,MAAM,SAAS,CAAC,SAAS,CAAC,kBAAkB,EAAE,CAAC;YAE/C,YAAY,CAAC,IAAI,CAAC,oBAAY,CAAC,aAAa,CAAC,CAAC;QAChD,CAAC;QACD,SAAS,CAAC,SAAiB;YACzB,MAAM,GAAG,SAAS,CAAC;QACrB,CAAC;QACD,UAAU,EAAE,KAAK,EAAE,SAAiB,EAAE,EAAE;YACtC,MAAM,SAAS,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;YACtC,YAAY,CAAC,IAAI,CAAC,oBAAY,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC;QAC5D,CAAC;QACD,YAAY,EAAE,GAAG,EAAE;YACjB,OAAO,SAAS,CAAC,SAAS,CAAC;QAC7B,CAAC;QACD,eAAe,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,eAAe,CAAC,EAAE,CAAC;QAChE,eAAe,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,eAAe,EAAE;QAC5D,gBAAgB,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,gBAAgB,CAAC,MAAM,CAAC;QAC1E,kBAAkB,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,kBAAkB,CAAC,IAAI,CAAC;QAC1E,WAAW,EAAE,CAAC,IAAS,EAAE,EAAE;YACzB,OAAO,SAAS,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;gBACzD,YAAY,CAAC,IAAI,CAAC,oBAAY,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;gBACtD,OAAO,MAAM,CAAC;YAChB,CAAC,CAAC,CAAC;QACL,CAAC;QACD,cAAc,EAAE,CAAC,QAAa,EAAE,EAAE;YAChC,OAAO,SAAS,CAAC,SAAS,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;gBAChE,YAAY,CAAC,IAAI,CAAC,oBAAY,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;gBACxD,OAAO,MAAM,CAAC;YAChB,CAAC,CAAC,CAAC;QACL,CAAC;QACD,cAAc,EAAE,KAAK,EAAE,EAAU,EAAE,EAAE;YACnC,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;YAElD,OAAO,SAAS,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;gBAC1D,YAAY,CAAC,IAAI,CAAC,oBAAY,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;gBAC1D,OAAO,MAAM,CAAC;YAChB,CAAC,CAAC,CAAC;QACL,CAAC;QACD,uBAAuB,EAAE,CAAC,UAAkB,EAAE,EAAE;YAC9C,OAAO,SAAS,CAAC,SAAS,CAAC,uBAAuB,CAAC,UAAU,CAAC,CAAC;QACjE,CAAC;QACD,iBAAiB,EAAE,KAAK,EAAE,SAAiB,EAAE,EAAE;YAC7C,MAAM,YAAY,GAAG,MAAM,SAAS,CAAC,SAAS,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;YAElF,MAAM,OAAO,GAAG,YAAY,CAAC,IAAI,CAC/B,WAAW,CAAC,EAAE,CAAC,WAAW,CAAC,IAAI,KAAK,aAAa,CAClD,CAAC;YAEF,OAAO,OAAO,EAAE,KAAK,CAAC;QACxB,CAAC;QACD,+BAA+B,EAAE,KAAK,EAAE,IAAS,EAAE,QAAgB,EAAE,EAAE;YACrE,OAAO,sBAAa,CAAC,+BAA+B,CAAC;gBACnD,mBAAmB,EAAE,IAAI;gBACzB,QAAQ;aACT,CAAC,CAAC;QACL,CAAC;QACD,yBAAyB,EAAE,KAAK,EAAE,IAAS,EAAE,QAAgB,EAAE,EAAE;YAC/D,MAAM,SAAS,GAAG,MAAM,sBAAa,CAAC,+BAA+B,CAAC;gBACpE,mBAAmB,EAAE,IAAI;gBACzB,QAAQ;aACT,CAAC,CAAC;YAEH,MAAM,IAAA,wCAA8B,EAAC;gBACnC,SAAS;gBACT,SAAS;aACV,CAAC,CAAC;YAEH,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,eAAe,EAAE,KAAK,EAAE,MAA0C,EAAE,EAAE;YACpE,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;YAC9D,OAAO,sBAAa,CAAC,eAAe,CAAC;gBACnC,SAAS;gBACT,QAAQ,EAAE,MAAM,CAAC,QAAQ;aAC1B,CAAC,CAAC;QACL,CAAC;QACD,yBAAyB,EAAE,KAAK,EAAE,QAAgB,EAAE,EAAE;YACpD,IAAI,SAAS,GAAG,MAAM,SAAS,CAAC,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;YAEhE,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,eAAe,CAAC;gBAC1C,SAAS;gBACT,QAAQ;aACT,CAAC,CAAC;YAEH,OAAO,MAAM,CAAC;QAChB,CAAC;KACS,CAAC;IAEb,MAAM,IAAA,4BAAc,EAAC,MAAM,CAAC,CAAC;IAE7B,MAAM,IAAA,wBAAS,EAAC;QACd,MAAM;KACP,CAAC,CAAC;IAEH,CAAC,oBAAY,CAAC,cAAc,EAAE,oBAAY,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CACxE,YAAY,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;QAC1B,IAAA,wBAAS,EAAC;YACR,MAAM;SACP,CAAC,CAAC;IACL,CAAC,CAAC,CACH,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC;AA5HD,oCA4HC"}
+{"version":3,"file":"wallet.js","sourceRoot":"","sources":["../src/wallet.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;AA6BH,sDASC;AAyBD,oCA+PC;AA5TD,mCAAiE;AAkB/D,6FAlBkC,oBAAY,OAkBlC;AAfd,+CAA6C;AAC7C,mCAAoC;AACpC,6EAA+E;AAC/E,4EAA8F;AAC9F,iDAAyC;AAGzC,SAAS,IAAI,CAAC,OAAqB,EAAE,SAAiB;IACpD,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;AAClE,CAAC;AASD;;;;;GAKG;AACH,SAAgB,qBAAqB,CAAC,QAAQ;IAC5C,IAAI,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;QACzB,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO;QACL,GAAG,QAAQ;QACX,UAAU,EAAE,CAAC,4BAA4B,CAAC;KAC3C,CAAC;AACJ,CAAC;AAGD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACI,KAAK,UAAU,YAAY,CAAC,EACjC,SAAS,GACS;IAClB,IAAI,MAAM,CAAC;IAEX,MAAM,YAAY,GAAG,IAAI,qBAAY,EAAE,CAAC;IAExC,MAAM,MAAM,GAAG;QACb,YAAY,EAAE,YAAY;QAC1B,YAAY,EAAE,CAAC,SAAiB,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,EAAE,SAAS,CAAQ;QACzE,SAAS;QACT,SAAS;YACP,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,sBAAsB,EAAE,KAAK,EAAE,QAAa,EAAE,EAAE;YAC9C,OAAO,SAAS,CAAC,sBAAsB,CAAC;gBACtC,QAAQ;gBACR,SAAS;aACV,CAAC,CAAC;QACL,CAAC;QACD;;;;;WAKG;QACH,YAAY,EAAE,KAAK,IAAI,EAAE;YACvB,MAAM,SAAS,CAAC,SAAS,CAAC,kBAAkB,EAAE,CAAC;YAE/C,YAAY,CAAC,IAAI,CAAC,oBAAY,CAAC,aAAa,CAAC,CAAC;QAChD,CAAC;QACD;;;;WAIG;QACH,SAAS,CAAC,SAAiB;YACzB,MAAM,GAAG,SAAS,CAAC;QACrB,CAAC;QACD;;;;;;WAMG;QACH,UAAU,EAAE,KAAK,EAAE,SAAiB,EAAE,EAAE;YACtC,MAAM,SAAS,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;YACtC,YAAY,CAAC,IAAI,CAAC,oBAAY,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC;QAC5D,CAAC;QACD;;;;WAIG;QACH,YAAY,EAAE,GAAG,EAAE;YACjB,OAAO,SAAS,CAAC,SAAS,CAAC;QAC7B,CAAC;QACD;;;;;;WAMG;QACH,eAAe,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,eAAe,CAAC,EAAE,CAAC;QAChE;;;;WAIG;QACH,eAAe,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,eAAe,EAAE;QAC5D;;;;;WAKG;QACH,gBAAgB,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,gBAAgB,CAAC,MAAM,CAAC;QAC1E;;;;;WAKG;QACH,kBAAkB,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,kBAAkB,CAAC,IAAI,CAAC;QAC1E;;;;;;;;;;;;;;;WAeG;QACH,WAAW,EAAE,CAAC,IAAS,EAAE,EAAE;YACzB,OAAO,SAAS,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;gBACzD,YAAY,CAAC,IAAI,CAAC,oBAAY,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;gBACtD,OAAO,MAAM,CAAC;YAChB,CAAC,CAAC,CAAC;QACL,CAAC;QACD;;;;;;;;WAQG;QACH,cAAc,EAAE,CAAC,QAAa,EAAE,EAAE;YAChC,OAAO,SAAS,CAAC,SAAS,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;gBAChE,YAAY,CAAC,IAAI,CAAC,oBAAY,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;gBACxD,OAAO,MAAM,CAAC;YAChB,CAAC,CAAC,CAAC;QACL,CAAC;QACD;;;;;;;;WAQG;QACH,cAAc,EAAE,KAAK,EAAE,EAAU,EAAE,EAAE;YACnC,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;YAElD,OAAO,SAAS,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;gBAC1D,YAAY,CAAC,IAAI,CAAC,oBAAY,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;gBAC1D,OAAO,MAAM,CAAC;YAChB,CAAC,CAAC,CAAC;QACL,CAAC;QACD;;;;;WAKG;QACH,uBAAuB,EAAE,CAAC,UAAkB,EAAE,EAAE;YAC9C,OAAO,SAAS,CAAC,SAAS,CAAC,uBAAuB,CAAC,UAAU,CAAC,CAAC;QACjE,CAAC;QACD;;;;;WAKG;QACH,iBAAiB,EAAE,KAAK,EAAE,SAAiB,EAAE,EAAE;YAC7C,MAAM,YAAY,GAAG,MAAM,SAAS,CAAC,SAAS,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;YAElF,MAAM,OAAO,GAAG,YAAY,CAAC,IAAI,CAC/B,WAAW,CAAC,EAAE,CAAC,WAAW,CAAC,IAAI,KAAK,aAAa,CAClD,CAAC;YAEF,OAAO,OAAO,EAAE,KAAK,CAAC;QACxB,CAAC;QACD;;;;;;WAMG;QACH,+BAA+B,EAAE,KAAK,EAAE,IAAS,EAAE,QAAgB,EAAE,EAAE;YACrE,OAAO,sBAAa,CAAC,+BAA+B,CAAC;gBACnD,mBAAmB,EAAE,IAAI;gBACzB,QAAQ;aACT,CAAC,CAAC;QACL,CAAC;QACD;;;;;;;;;;;WAWG;QACH,yBAAyB,EAAE,KAAK,EAAE,IAAS,EAAE,QAAgB,EAAE,EAAE;YAC/D,MAAM,SAAS,GAAG,MAAM,sBAAa,CAAC,+BAA+B,CAAC;gBACpE,mBAAmB,EAAE,IAAI;gBACzB,QAAQ;aACT,CAAC,CAAC;YAEH,MAAM,IAAA,wCAA8B,EAAC;gBACnC,SAAS;gBACT,SAAS;aACV,CAAC,CAAC;YAEH,OAAO,SAAS,CAAC;QACnB,CAAC;QACD;;;;;;;WAOG;QACH,eAAe,EAAE,KAAK,EAAE,MAA0C,EAAE,EAAE;YACpE,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;YAC9D,OAAO,sBAAa,CAAC,eAAe,CAAC;gBACnC,SAAS;gBACT,QAAQ,EAAE,MAAM,CAAC,QAAQ;aAC1B,CAAC,CAAC;QACL,CAAC;QACD;;;;;;;;;;WAUG;QACH,yBAAyB,EAAE,KAAK,EAAE,QAAgB,EAAE,EAAE;YACpD,IAAI,SAAS,GAAG,MAAM,SAAS,CAAC,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;YAEhE,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,eAAe,CAAC;gBAC1C,SAAS;gBACT,QAAQ;aACT,CAAC,CAAC;YAEH,OAAO,MAAM,CAAC;QAChB,CAAC;KACS,CAAC;IAEb,MAAM,IAAA,4BAAc,EAAC,MAAM,CAAC,CAAC;IAE7B,MAAM,IAAA,wBAAS,EAAC;QACd,MAAM;KACP,CAAC,CAAC;IAEH,CAAC,oBAAY,CAAC,cAAc,EAAE,oBAAY,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CACxE,YAAY,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;QAC1B,IAAA,wBAAS,EAAC;YACR,MAAM;SACP,CAAC,CAAC;IACL,CAAC,CAAC,CACH,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/package.json

@@ -1,35 +1,43 @@
 {
   "name": "@docknetwork/wallet-sdk-core",
-  "version": "1.5.14",
-  "license": "https://github.com/docknetwork/react-native-sdk/LICENSE",
+  "version": "1.7.6",
+  "license": "https://github.com/docknetwork/wallet-sdk/LICENSE",
   "repository": {
     "type": "git",
-    "url": "https://github.com/docknetwork/react-native-sdk",
+    "url": "https://github.com/docknetwork/wallet-sdk",
     "directory": "packages/core"
   },
   "scripts": {
     "test": "jest",
     "prepublishOnly": "npm run build",
-    "build": "rm -rf lib && rm -rf tsconfig.build.tsbuildinfo && tsc -p tsconfig.build.json && node ../../scripts/fix-build-imports.js ./lib"
+    "build": "rm -rf lib && rm -rf tsconfig.build.tsbuildinfo && tsc -p tsconfig.build.json && node ../../scripts/fix-build-imports.js ./lib",
+    "docs": "node generate-docs.js",
+    "docs:clean": "rm -rf ../../jsdocs/core.md ../../jsdocs/core/",
+    "docs:build": "npm run docs:clean && npm run docs"
   },
   "peerDependencies": {
-    "typeorm": "^0.3.15",
+    "@docknetwork/wallet-sdk-data-store": "^1.5.14",
     "reflect-metadata": "^0.1.13",
     "sqlite3": "^5.0.2",
-    "@docknetwork/wallet-sdk-data-store": "^1.5.14"
+    "typeorm": "^0.3.15"
   },
   "dependencies": {
-    "@docknetwork/wallet-sdk-wasm": "^1.5.14",
+    "@docknetwork/wallet-sdk-wasm": "^1.7.6",
     "futoin-hkdf": "^1.5.3"
   },
   "devDependencies": {
-    "@docknetwork/wallet-sdk-data-store": "^1.5.14",
+    "@babel/parser": "^7.28.4",
+    "@babel/preset-typescript": "^7.27.1",
+    "@docknetwork/wallet-sdk-data-store": "^1.7.6",
+    "better-docs": "^2.7.3",
     "jest": "29.1.0",
+    "jsdoc": "^4.0.2",
+    "jsdoc-babel": "^0.5.0",
+    "reflect-metadata": "^0.1.13",
+    "sqlite3": "^5.0.2",
     "ts-jest": "29.1.0",
     "ts-node": "^10.9.1",
-    "typescript": "^5.0.4",
     "typeorm": "^0.3.15",
-    "sqlite3": "^5.0.2",
-    "reflect-metadata": "^0.1.13"
+    "typescript": "^5.9.2"
   }
 }

package/src/biometric-provider.ts

@@ -1,5 +1,27 @@
+/**
+ * @module biometric-provider
+ * @description Biometric plugin for the Truvera Wallet SDK.
+ * This module provides functions for biometric enrollment, matching, and identity verification processes.
+ */
+
 import {WalletDocument} from '@docknetwork/wallet-sdk-wasm/src/types';
-import {IWallet} from './types';
+import {
+  IWallet,
+  BiometricsProviderConfigs,
+  IDVProcessOptions,
+  BiometricPlugin,
+  IDVProvider,
+  IDVProviderFactory,
+  IBiometricProvider,
+} from './types';
+export type {
+  BiometricsProviderConfigs,
+  IDVProcessOptions,
+  BiometricPlugin,
+  IDVProvider,
+  IDVProviderFactory,
+  IBiometricProvider,
+};
 import {
   createCredentialProvider,
   Credential,
@@ -9,49 +31,107 @@ import assert from 'assert';
 import {EventEmitter} from 'events';
 import {createDIDProvider} from './did-provider';
 
-export type BiometricsProviderConfigs<E> = {
-  // Generic configs used by the biometric provider
-  enrollmentCredentialType: string;
-  biometricMatchCredentialType: string;
-  // IDV specific configs, it depends on the IDV provider and its implementation
-  idvConfigs: E;
-};
-
-export interface IDVProcessOptions {
-  onDeepLink?: () => void;
-  onMessage?: () => void;
-  onError?: (error: Error) => void;
-  onCancel?: () => void;
-  onComplete?: (credential: any) => void;
-}
-
-export interface BiometricPlugin {
-  onEnroll(walletDID: string): Promise<WalletDocument>;
-  onMatch(
-    walletDID: string,
-    enrollmentCredential: Credential,
-  ): Promise<WalletDocument>;
-}
-
 let currentConfigs: BiometricsProviderConfigs<unknown> = null;
 
+/**
+ * Sets the global biometric provider configurations for the SDK
+ * @param {BiometricsProviderConfigs<unknown>} configs - The biometric provider configurations to set
+ * @param {string} configs.enrollmentCredentialType - The credential type for enrollment
+ * @param {string} configs.biometricMatchCredentialType - The credential type for biometric matching
+ * @param {any} [configs.idvProvider] - Optional IDV provider configuration
+ * @example
+ * import { setConfigs } from '@docknetwork/wallet-sdk-core/biometric-provider';
+ *
+ * setConfigs({
+ *   enrollmentCredentialType: 'BiometricEnrollment',
+ *   biometricMatchCredentialType: 'BiometricMatch',
+ *   idvProvider: myIDVProviderConfig
+ * });
+ */
 export function setConfigs(configs: BiometricsProviderConfigs<unknown>) {
   currentConfigs = configs;
 }
 
+/**
+ * Checks if the biometric plugin is enabled by verifying if biometric match credential type is configured
+ * @returns {boolean} True if biometric match credential type is configured, false otherwise
+ * @example
+ * import { isBiometricPluginEnabled, setConfigs } from '@docknetwork/wallet-sdk-core/biometric-provider';
+ *
+ * // Before configuration
+ * console.log(isBiometricPluginEnabled()); // false
+ *
+ * // After configuration
+ * setConfigs({
+ *   enrollmentCredentialType: 'BiometricEnrollment',
+ *   biometricMatchCredentialType: 'BiometricMatch'
+ * });
+ * console.log(isBiometricPluginEnabled()); // true
+ */
 export function isBiometricPluginEnabled() {
   return !!currentConfigs?.biometricMatchCredentialType;
 }
 
+/**
+ * Asserts that biometric provider configurations are available
+ * @throws {Error} If biometric provider configs are not set
+ * @example
+ * import { assertConfigs } from '@docknetwork/wallet-sdk-core/biometric-provider';
+ *
+ * try {
+ *   assertConfigs();
+ *   console.log('Biometric configs are available');
+ * } catch (error) {
+ *   console.error('Biometric configs missing:', error.message);
+ * }
+ */
 export function assertConfigs() {
   assert(!!currentConfigs, 'Missing biometric provider configs');
 }
 
+/**
+ * Gets the current biometric provider configurations
+ * @returns {BiometricsProviderConfigs<unknown>} The current biometric provider configurations
+ * @throws {Error} If biometric provider configs are not set
+ * @example
+ * import { getBiometricConfigs } from '@docknetwork/wallet-sdk-core/biometric-provider';
+ *
+ * try {
+ *   const configs = getBiometricConfigs();
+ *   console.log('Enrollment credential type:', configs.enrollmentCredentialType);
+ *   console.log('Match credential type:', configs.biometricMatchCredentialType);
+ * } catch (error) {
+ *   console.error('Failed to get configs:', error.message);
+ * }
+ */
 export function getBiometricConfigs() {
   assertConfigs();
   return currentConfigs;
 }
 
+/**
+ * Checks if a proof request requires biometric credentials
+ * @param {any} proofRequest - The proof request to analyze
+ * @returns {boolean} True if the proof request requires biometric credentials
+ * @example
+ * import { hasProofOfBiometrics } from '@docknetwork/wallet-sdk-core/biometric-provider';
+ *
+ * const proofRequest = {
+ *   input_descriptors: [{
+ *     constraints: {
+ *       fields: [{
+ *         path: ['$.credentialSubject.biometric.id']
+ *       }, {
+ *         path: ['$.credentialSubject.biometric.created']
+ *       }]
+ *     }
+ *   }]
+ * };
+ *
+ * if (hasProofOfBiometrics(proofRequest)) {
+ *   console.log('This proof request requires biometric verification');
+ * }
+ */
 export function hasProofOfBiometrics(proofRequest) {
   const fields = proofRequest.input_descriptors
     ?.map(input => input.constraints?.fields)
@@ -72,24 +152,33 @@ export const IDV_EVENTS = {
   onComplete: 'onComplete',
 };
 
-export interface IDVProvider {
-  enroll(
-    walletDID: string,
-    proofRequest: any,
-  ): Promise<{enrollmentCredential: Credential; matchCredential: Credential}>;
-  match(
-    walletDID: string,
-    enrollmentCredential: Credential,
-    proofRequest: any,
-  ): Promise<{
-    matchCredential: Credential;
-  }>;
-}
-
-export interface IDVProviderFactory {
-  create(eventEmitter: EventEmitter, wallet: IWallet): IDVProvider;
-}
 
+/**
+ * Creates a biometric provider instance for identity verification and biometric credential management
+ * @param {Object} params - Provider configuration
+ * @param {IWallet} params.wallet - The wallet instance to use for credential storage
+ * @param {IDVProviderFactory} params.idvProviderFactory - Factory for creating IDV provider instances
+ * @returns {IBiometricProvider} A biometric provider instance with identity verification methods
+ * @throws {Error} If wallet or idvProviderFactory is not provided
+ * @see {@link IBiometricProvider} - The interface defining all available biometric provider methods
+ * @example
+ * import { createBiometricProvider } from '@docknetwork/wallet-sdk-core';
+ *
+ * const biometricProvider = createBiometricProvider({
+ *   wallet,
+ *   idvProviderFactory: myIDVFactory
+ * });
+ *
+ * // Start identity verification process
+ * const result = await biometricProvider.startIDV(proofRequest);
+ * console.log('Enrollment credential:', result.enrollmentCredential);
+ * console.log('Match credential:', result.matchCredential);
+ *
+ * // Listen for IDV events
+ * biometricProvider.eventEmitter.on('onComplete', (data) => {
+ *   console.log('IDV process completed:', data);
+ * });
+ */
 export function createBiometricProvider({
   wallet,
   idvProviderFactory,
@@ -103,6 +192,24 @@ export function createBiometricProvider({
   const idvProvider = idvProviderFactory.create(eventEmitter, wallet);
 
 
+  /**
+   * Starts the identity verification process using biometric credentials
+   * @memberof IBiometricProvider
+   * @param {any} proofRequest - The proof request containing biometric requirements
+   * @returns {Promise<{enrollmentCredential: Credential, matchCredential: Credential}>} The enrollment and match credentials
+   * @throws {Error} If IDV process fails or biometric configs are missing
+   * @example
+   * const result = await biometricProvider.startIDV({
+   *   input_descriptors: [{
+   *     constraints: {
+   *       fields: [{
+   *         path: ['$.credentialSubject.biometric.id'],
+   *         purpose: 'Biometric ID verification'
+   *       }]
+   *     }
+   *   }]
+   * });
+   */
   async function startIDV(proofRequest: any): Promise<{
     enrollmentCredential: Credential;
     matchCredential: Credential;
@@ -167,7 +274,15 @@ export function createBiometricProvider({
   }
 
   return {
+    /**
+     * Starts the identity verification process using biometric credentials
+     * @memberof IBiometricProvider
+     */
     startIDV,
+    /**
+     * Event emitter for IDV process events (onDeepLink, onMessage, onError, onCancel, onComplete)
+     * @memberof IBiometricProvider
+     */
     eventEmitter,
   };
 }