@docknetwork/wallet-sdk-wasm 1.5.11 → 1.7.0

package/lib/src/services/relay-service/service.d.ts

@@ -1,19 +1,147 @@
+/**
+ * @module relay-service
+ * @description DIDComm message relay service for the Wallet SDK.
+ * This module provides functionality for sending, receiving, and managing DIDComm messages
+ * through a relay service, including push notification support.
+ */
 import { SendMessageParams, GetMessagesParams, ResolveDidcommMessageParams, RegisterDIDPushNotificationParams, AckMessagesParams } from './configs';
 import { RelayService as relayServiceClient } from '@docknetwork/wallet-sdk-relay-service/lib';
 /**
- * RelayService
+ * Service class for managing DIDComm message relay operations
+ * @class
+ * @description Provides methods for sending, receiving, and acknowledging DIDComm messages
+ * through a relay service infrastructure
  */
 export declare class RelayService {
     name: string;
     rpcMethods: (((params: AckMessagesParams) => any) | ((params: GetMessagesParams) => any) | ((params: RegisterDIDPushNotificationParams) => any) | ((params: ResolveDidcommMessageParams) => any) | ((params: SendMessageParams) => any))[];
+    /**
+     * Creates a new RelayService instance
+     * @constructor
+     */
     constructor();
+    /**
+     * Sends a DIDComm message through the relay service
+     * @param {SendMessageParams} params - Message parameters
+     * @param {Object} params.keyPairDoc - Key pair document for message encryption
+     * @param {Object} params.message - The message payload to send
+     * @param {string} params.recipientDid - DID of the message recipient
+     * @param {string} [params.type] - Message type identifier
+     * @returns {Promise<Object>} Result of the send operation
+     * @throws {Error} If validation fails or sending fails
+     * @example
+     * const result = await relayService.sendMessage({
+     *   keyPairDoc: senderKeyPair,
+     *   message: { content: 'Hello' },
+     *   recipientDid: 'did:key:recipient123',
+     *   type: 'basic-message'
+     * });
+     */
     sendMessage(params: SendMessageParams): any;
+    /**
+     * Acknowledges receipt of messages from the relay service
+     * @param {AckMessagesParams} params - Acknowledgment parameters
+     * @param {string} params.did - DID acknowledging the messages
+     * @param {Array<string>} params.messageIds - Array of message IDs to acknowledge
+     * @returns {Promise<Object>} Result of the acknowledgment operation
+     * @example
+     * await relayService.ackMessages({
+     *   did: 'did:key:holder123',
+     *   messageIds: ['msg-1', 'msg-2']
+     * });
+     */
     ackMessages(params: AckMessagesParams): any;
+    /**
+     * Resolves and decrypts a DIDComm message
+     * @param {ResolveDidcommMessageParams} params - Resolution parameters
+     * @param {Object} params.encryptedMessage - The encrypted message to resolve
+     * @param {Object} params.keyPairDoc - Key pair document for decryption
+     * @returns {Promise<Object>} The decrypted and resolved message
+     * @throws {Error} If validation fails or resolution fails
+     * @example
+     * const decrypted = await relayService.resolveDidcommMessage({
+     *   encryptedMessage: encryptedData,
+     *   keyPairDoc: recipientKeyPair
+     * });
+     */
     resolveDidcommMessage(params: ResolveDidcommMessageParams): any;
+    /**
+     * Signs a JWT using the provided key pair
+     * @param {ResolveDidcommMessageParams} params - Signing parameters
+     * @param {Object} params.payload - JWT payload to sign
+     * @param {Object} params.keyPairDoc - Key pair document for signing
+     * @returns {Promise<string>} The signed JWT token
+     * @throws {Error} If validation fails or signing fails
+     * @example
+     * const jwt = await relayService.signJwt({
+     *   payload: { sub: 'did:key:123', iat: Date.now() },
+     *   keyPairDoc: signerKeyPair
+     * });
+     */
     signJwt(params: ResolveDidcommMessageParams): any;
+    /**
+     * Retrieves messages from the relay service
+     * @param {GetMessagesParams} params - Retrieval parameters
+     * @param {Object} params.keyPairDocs - Key pair documents for decryption
+     * @param {number} [params.limit] - Maximum number of messages to retrieve
+     * @param {boolean} [params.skipMessageResolution] - Whether to skip message resolution
+     * @returns {Promise<Array>} Array of retrieved messages
+     * @throws {Error} If validation fails or retrieval fails
+     * @example
+     * const messages = await relayService.getMessages({
+     *   keyPairDocs: [keyPairDoc1, keyPairDoc2],
+     *   limit: 50,
+     *   skipMessageResolution: false
+     * });
+     */
     getMessages(params: GetMessagesParams): any;
+    /**
+     * Registers a DID for push notifications
+     * @param {RegisterDIDPushNotificationParams} params - Registration parameters
+     * @param {string} params.did - The DID to register for notifications
+     * @param {string} params.deviceToken - Device token for push notifications
+     * @param {string} [params.platform] - Platform identifier (ios, android, etc.)
+     * @returns {Promise<Object>} Result of the registration
+     * @throws {Error} If validation fails or registration fails
+     * @example
+     * await relayService.registerDIDPushNotification({
+     *   did: 'did:key:holder123',
+     *   deviceToken: 'fcm-token-123',
+     *   platform: 'android'
+     * });
+     */
     registerDIDPushNotification(params: RegisterDIDPushNotificationParams): any;
 }
+/**
+ * Low-level relay service client for direct API access
+ * @type {Object}
+ * @see {@link RelayService} - Higher-level service wrapper
+ */
 export { relayServiceClient };
+/**
+ * Singleton instance of the relay service
+ * @type {RelayService}
+ * @example
+ * import { relayService } from '@docknetwork/wallet-sdk-wasm/services/relay-service';
+ *
+ * // Send a DIDComm message
+ * await relayService.sendMessage({
+ *   keyPairDoc: senderKeyPair,
+ *   message: { type: 'greeting', content: 'Hello!' },
+ *   recipientDid: 'did:key:recipient123'
+ * });
+ *
+ * // Retrieve messages
+ * const messages = await relayService.getMessages({
+ *   keyPairDocs: [recipientKeyPair],
+ *   limit: 10
+ * });
+ *
+ * // Acknowledge messages
+ * await relayService.ackMessages({
+ *   did: 'did:key:recipient123',
+ *   messageIds: messages.map(m => m.id)
+ * });
+ */
 export declare const relayService: RelayService;
 //# sourceMappingURL=service.d.ts.map

package/lib/src/services/relay-service/service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../../../src/services/relay-service/service.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,iBAAiB,EACjB,2BAA2B,EAC3B,iCAAiC,EAGjC,iBAAiB,EAClB,MAAM,WAAW,CAAC;AAEnB,OAAO,EAAC,YAAY,IAAI,kBAAkB,EAAC,MAAM,2CAA2C,CAAC;AAE7F;;GAEG;AACH,qBAAa,YAAY;IACvB,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,aAkBU,iBAAiB,sBAcjB,iBAAiB,sBAKD,iCAAiC,sBAfvC,2BAA2B,sBATrC,iBAAiB,aANnC;;IAMF,WAAW,CAAC,MAAM,EAAE,iBAAiB;IAKrC,WAAW,CAAC,MAAM,EAAE,iBAAiB;IAIrC,qBAAqB,CAAC,MAAM,EAAE,2BAA2B;IAKzD,OAAO,CAAC,MAAM,EAAE,2BAA2B;IAK3C,WAAW,CAAC,MAAM,EAAE,iBAAiB;IAKrC,2BAA2B,CAAC,MAAM,EAAE,iCAAiC;CAItE;AAED,OAAO,EAAC,kBAAkB,EAAC,CAAC;AAE5B,eAAO,MAAM,YAAY,EAAE,YAAiC,CAAC"}
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../../../src/services/relay-service/service.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EACL,iBAAiB,EACjB,iBAAiB,EACjB,2BAA2B,EAC3B,iCAAiC,EAGjC,iBAAiB,EAClB,MAAM,WAAW,CAAC;AAEnB,OAAO,EAAC,YAAY,IAAI,kBAAkB,EAAC,MAAM,2CAA2C,CAAC;AAE7F;;;;;GAKG;AACH,qBAAa,YAAY;IACvB,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,aAmDU,iBAAiB,sBAuDjB,iBAAiB,sBAoBD,iCAAiC,sBA1DvC,2BAA2B,sBAlCrC,iBAAiB,aA3BnC;IAEF;;;OAGG;;IAKH;;;;;;;;;;;;;;;;OAgBG;IACH,WAAW,CAAC,MAAM,EAAE,iBAAiB;IAKrC;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,MAAM,EAAE,iBAAiB;IAIrC;;;;;;;;;;;;OAYG;IACH,qBAAqB,CAAC,MAAM,EAAE,2BAA2B;IAKzD;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,MAAM,EAAE,2BAA2B;IAK3C;;;;;;;;;;;;;;OAcG;IACH,WAAW,CAAC,MAAM,EAAE,iBAAiB;IAKrC;;;;;;;;;;;;;;OAcG;IACH,2BAA2B,CAAC,MAAM,EAAE,iCAAiC;CAItE;AAED;;;;GAIG;AACH,OAAO,EAAC,kBAAkB,EAAC,CAAC;AAE5B;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,YAAY,EAAE,YAAiC,CAAC"}

package/lib/src/services/rpc-service-client.d.ts

@@ -1,7 +1,7 @@
 export class RpcService {
     constructor(serviceName: any);
-    serviceName: string;
-    sandbox: Boolean;
+    serviceName: any;
+    sandbox: boolean;
     call(method: any, ...params: any[]): Promise<any>;
 }
 //# sourceMappingURL=rpc-service-client.d.ts.map

package/lib/src/services/rpc-service-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rpc-service-client.d.ts","sourceRoot":"","sources":["../../../src/services/rpc-service-client.js"],"names":[],"mappings":"AAGA;IAIE,8BAKC;IARD,aAAa,MAAM,CAAC;IACpB,SAAS,OAAO,CAAC;IASjB,kDAOC;CACF"}
+{"version":3,"file":"rpc-service-client.d.ts","sourceRoot":"","sources":["../../../src/services/rpc-service-client.js"],"names":[],"mappings":"AAGA;IACE,8BAKC;IAFC,iBAA8B;IAC9B,iBAAoB;IAGtB,kDAOC;CACF"}

package/lib/src/services/storage/index.d.ts

@@ -1,2 +1,2 @@
-export { storageService } from "./service";
+export let storageService: any;
 //# sourceMappingURL=index.d.ts.map

package/lib/src/services/storage/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/storage/index.js"],"names":[],"mappings":""}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/storage/index.js"],"names":[],"mappings":"AAGA,+BAAmB"}

package/lib/src/services/storage/service-rpc.d.ts

@@ -0,0 +1,9 @@
+export class StorageServiceRpc extends RpcService {
+    constructor();
+    setItem(...args: any[]): Promise<any>;
+    removeItem(...args: any[]): Promise<any>;
+    getItem(...args: any[]): Promise<any>;
+    getAllKeys(): Promise<any>;
+}
+import { RpcService } from '../rpc-service-client';
+//# sourceMappingURL=service-rpc.d.ts.map

package/lib/src/services/storage/service-rpc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"service-rpc.d.ts","sourceRoot":"","sources":["../../../../src/services/storage/service-rpc.js"],"names":[],"mappings":"AAEA;IACE,cAEC;IAED,sCAEC;IAED,yCAEC;IAED,sCAEC;IAED,2BAEC;CACF;2BAtBwB,uBAAuB"}

package/lib/src/services/storage/service.d.ts

@@ -4,6 +4,7 @@ export declare class StorageService {
     setItem(...args: any[]): Promise<any>;
     removeItem(...args: any[]): Promise<any>;
     getItem(...args: any[]): Promise<any>;
+    getAllKeys(): Promise<string[]>;
 }
 export declare const storageService: StorageService;
 //# sourceMappingURL=service.d.ts.map

package/lib/src/services/storage/service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../../../src/services/storage/service.ts"],"names":[],"mappings":"AACA,qBAAa,cAAc;IACzB,UAAU,uBAUQ,QAAQ,GAAG,CAAC,IAN5B;;IAMF,OAAO,CAAC,GAAG,IAAI,OAAA,GAAG,OAAO,CAAC,GAAG,CAAC;IAI9B,UAAU,CAAC,GAAG,IAAI,OAAA,GAAG,OAAO,CAAC,GAAG,CAAC;IAIjC,OAAO,CAAC,GAAG,IAAI,OAAA,GAAG,OAAO,CAAC,GAAG,CAAC;CAG/B;AAED,eAAO,MAAM,cAAc,EAAE,cAAqC,CAAC"}
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../../../src/services/storage/service.ts"],"names":[],"mappings":"AACA,qBAAa,cAAc;IACzB,UAAU,uBAWQ,QAAQ,GAAG,CAAC,IAN5B;;IAMF,OAAO,CAAC,GAAG,IAAI,OAAA,GAAG,OAAO,CAAC,GAAG,CAAC;IAI9B,UAAU,CAAC,GAAG,IAAI,OAAA,GAAG,OAAO,CAAC,GAAG,CAAC;IAIjC,OAAO,CAAC,GAAG,IAAI,OAAA,GAAG,OAAO,CAAC,GAAG,CAAC;IAI9B,UAAU,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;CAGhC;AAED,eAAO,MAAM,cAAc,EAAE,cAAqC,CAAC"}

package/lib/src/services/util-crypto/service.d.ts

@@ -1,5 +1,5 @@
 export declare class UtilCryptoService {
-    rpcMethods: (((numWords?: number) => string) | ((phrase: any) => Uint8Array) | ((value: any) => boolean) | ((hex: string) => string))[];
+    rpcMethods: (((value: any) => boolean) | ((numWords?: number) => string) | ((phrase: any) => Uint8Array) | ((hex: string) => string))[];
     constructor();
     mnemonicGenerate(numWords?: number): string;
     mnemonicToMiniSecret(phrase: any): Uint8Array;