@ckb-ccc/joy-id 0.0.12-alpha.0 → 0.0.12

package/dist/connectionsStorage/index.d.ts

@@ -1,80 +1,85 @@
 import { ccc } from "@ckb-ccc/core";
 /**
  * Type representing an account selector with a URI and address type.
- * @typedef {Object} AccountSelector
- * @property {string} uri - The URI of the account.
- * @property {string} addressType - The address type of the account.
  */
 export type AccountSelector = {
+    /**
+     * The URI of the account.
+     */
     uri: string;
+    /**
+     * The address type of the account.
+     */
     addressType: string;
 };
 /**
- * Checks if two AccountSelectors are equal.
- * @param {AccountSelector} a - The first account selector.
- * @param {AccountSelector} b - The second account selector.
- * @returns {boolean} True if the selectors are equal, false otherwise.
+ * Checks if a AccountSelector matches the filter
+ * @param a - The first account selector.
+ * @param filter - The account selector filter.
+ * @returns True if the selector matches the filter
  */
 export declare function isSelectorMatch(a: AccountSelector, filter: AccountSelector): boolean;
 /**
  * Type representing a connection with an address, public key, and key type.
- * @typedef {Object} Connection
- * @property {string} address - The address of the connection.
- * @property {ccc.Hex} publicKey - The public key of the connection.
- * @property {string} keyType - The key type of the connection.
  */
 export type Connection = {
+    /**
+     * The address of the connection.
+     */
     readonly address: string;
+    /**
+     * The public key of the connection.
+     */
     readonly publicKey: ccc.Hex;
+    /**
+     * The key type of the connection.
+     */
     readonly keyType: string;
 };
 /**
  * Interface representing a repository for managing connections.
- * @interface
  */
 export interface ConnectionsRepo {
     /**
      * Gets a connection for the given selector.
-     * @param {AccountSelector} selector - The account selector.
-     * @returns {Promise<Connection | undefined>} A promise that resolves to the connection, if found.
+     * @param selector - The account selector.
+     * @returns A promise that resolves to the connection, if found.
      */
     get(selector: AccountSelector): Promise<Connection | undefined>;
     /**
      * Sets a connection for the given selector.
-     * @param {AccountSelector} selector - The account selector.
-     * @param {Connection | undefined} connection - The connection to set.
-     * @returns {Promise<void>} A promise that resolves when the connection is set.
+     * @param selector - The account selector.
+     * @param connection - The connection to set.
+     * @returns A promise that resolves when the connection is set.
      */
     set(selector: AccountSelector, connection: Connection | undefined): Promise<void>;
 }
 /**
  * Class representing a local storage-based repository for managing connections.
- * @class
- * @implements {ConnectionsRepo}
  */
 export declare class ConnectionsRepoLocalStorage implements ConnectionsRepo {
     private readonly storageKey;
     /**
      * Creates an instance of ConnectionsRepoLocalStorage.
-     * @param {string} [storageKey="ccc-joy-id-signer"] - The local storage key.
+     * @param [storageKey="ccc-joy-id-signer"] - The local storage key.
      */
     constructor(storageKey?: string);
     /**
      * Reads all connections from local storage.
-     * @returns {Promise<[AccountSelector, Connection][]>} A promise that resolves to an array of selectors and connections.
+     * @returns A promise that resolves to an array of selectors and connections.
      */
     readConnections(): Promise<[AccountSelector, Connection][]>;
     /**
      * Gets a connection for the given selector.
-     * @param {AccountSelector} selector - The account selector.
-     * @returns {Promise<Connection | undefined>} A promise that resolves to the connection, if found.
+     * @param selector - The account selector.
+     * @returns A promise that resolves to the connection, if found.
      */
     get(selector: AccountSelector): Promise<Connection | undefined>;
     /**
      * Sets a connection for the given selector.
-     * @param {AccountSelector} selector - The account selector.
-     * @param {Connection | undefined} connection - The connection to set.
-     * @returns {Promise<void>}
+     * @param selector - The account selector.
+     * @param connection - The connection to set.
+     * @returns
      */
     set(selector: AccountSelector, connection: Connection | undefined): Promise<void>;
 }

package/dist/connectionsStorage/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/connectionsStorage/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAEpC;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,eAAe,CAC7B,CAAC,EAAE,eAAe,EAClB,MAAM,EAAE,eAAe,GACtB,OAAO,CAET;AAED;;;;;;GAMG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,SAAS,EAAE,GAAG,CAAC,GAAG,CAAC;IAC5B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;OAIG;IACH,GAAG,CAAC,QAAQ,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC;IAEhE;;;;;OAKG;IACH,GAAG,CACD,QAAQ,EAAE,eAAe,EACzB,UAAU,EAAE,UAAU,GAAG,SAAS,GACjC,OAAO,CAAC,IAAI,CAAC,CAAC;CAClB;AAED;;;;GAIG;AACH,qBAAa,2BAA4B,YAAW,eAAe;IAKrD,OAAO,CAAC,QAAQ,CAAC,UAAU;IAJvC;;;OAGG;gBAC0B,UAAU,SAAsB;IAE7D;;;OAGG;IACG,eAAe,IAAI,OAAO,CAAC,CAAC,eAAe,EAAE,UAAU,CAAC,EAAE,CAAC;IAIjE;;;;OAIG;IACG,GAAG,CAAC,QAAQ,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAMrE;;;;;OAKG;IACG,GAAG,CACP,QAAQ,EAAE,eAAe,EACzB,UAAU,EAAE,UAAU,GAAG,SAAS,GACjC,OAAO,CAAC,IAAI,CAAC;CAoBjB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/connectionsStorage/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAEpC;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,eAAe,CAC7B,CAAC,EAAE,eAAe,EAClB,MAAM,EAAE,eAAe,GACtB,OAAO,CAET;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,GAAG,CAAC,GAAG,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;OAIG;IACH,GAAG,CAAC,QAAQ,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC;IAEhE;;;;;OAKG;IACH,GAAG,CACD,QAAQ,EAAE,eAAe,EACzB,UAAU,EAAE,UAAU,GAAG,SAAS,GACjC,OAAO,CAAC,IAAI,CAAC,CAAC;CAClB;AAED;;GAEG;AACH,qBAAa,2BAA4B,YAAW,eAAe;IAKrD,OAAO,CAAC,QAAQ,CAAC,UAAU;IAJvC;;;OAGG;gBAC0B,UAAU,SAAsB;IAE7D;;;OAGG;IACG,eAAe,IAAI,OAAO,CAAC,CAAC,eAAe,EAAE,UAAU,CAAC,EAAE,CAAC;IAIjE;;;;OAIG;IACG,GAAG,CAAC,QAAQ,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAMrE;;;;;OAKG;IACG,GAAG,CACP,QAAQ,EAAE,eAAe,EACzB,UAAU,EAAE,UAAU,GAAG,SAAS,GACjC,OAAO,CAAC,IAAI,CAAC;CAoBjB"}

package/dist/connectionsStorage/index.js

@@ -1,45 +1,43 @@
 /**
- * Checks if two AccountSelectors are equal.
- * @param {AccountSelector} a - The first account selector.
- * @param {AccountSelector} b - The second account selector.
- * @returns {boolean} True if the selectors are equal, false otherwise.
+ * Checks if a AccountSelector matches the filter
+ * @param a - The first account selector.
+ * @param filter - The account selector filter.
+ * @returns True if the selector matches the filter
  */
 export function isSelectorMatch(a, filter) {
     return a.uri === filter.uri && a.addressType.startsWith(filter.addressType);
 }
 /**
  * Class representing a local storage-based repository for managing connections.
- * @class
- * @implements {ConnectionsRepo}
  */
 export class ConnectionsRepoLocalStorage {
     /**
      * Creates an instance of ConnectionsRepoLocalStorage.
-     * @param {string} [storageKey="ccc-joy-id-signer"] - The local storage key.
+     * @param [storageKey="ccc-joy-id-signer"] - The local storage key.
      */
     constructor(storageKey = "ccc-joy-id-signer") {
         this.storageKey = storageKey;
     }
     /**
      * Reads all connections from local storage.
-     * @returns {Promise<[AccountSelector, Connection][]>} A promise that resolves to an array of selectors and connections.
+     * @returns A promise that resolves to an array of selectors and connections.
      */
     async readConnections() {
         return JSON.parse(window.localStorage.getItem(this.storageKey) ?? "[]");
     }
     /**
      * Gets a connection for the given selector.
-     * @param {AccountSelector} selector - The account selector.
-     * @returns {Promise<Connection | undefined>} A promise that resolves to the connection, if found.
+     * @param selector - The account selector.
+     * @returns A promise that resolves to the connection, if found.
      */
     async get(selector) {
         return (await this.readConnections()).find(([s]) => isSelectorMatch(selector, s))?.[1];
     }
     /**
      * Sets a connection for the given selector.
-     * @param {AccountSelector} selector - The account selector.
-     * @param {Connection | undefined} connection - The connection to set.
-     * @returns {Promise<void>}
+     * @param selector - The account selector.
+     * @param connection - The connection to set.
+     * @returns
      */
     async set(selector, connection) {
         const connections = await this.readConnections();

package/dist/evm/index.d.ts

@@ -1,9 +1,8 @@
 import { ccc } from "@ckb-ccc/core";
 import { ConnectionsRepo } from "../connectionsStorage/index.js";
 /**
- * Class representing an EVM signer that extends SignerEvm from @ckb-ccc/core.
- * @class
- * @extends {ccc.SignerEvm}
+ * Class representing an EVM signer that extends SignerEvm
+ * @public
  */
 export declare class EvmSigner extends ccc.SignerEvm {
     private readonly name;
@@ -13,9 +12,8 @@ export declare class EvmSigner extends ccc.SignerEvm {
     private connection?;
     /**
      * Ensures that the signer is connected and returns the connection.
-     * @private
      * @throws Will throw an error if not connected.
-     * @returns {Connection} The current connection.
+     * @returns The current connection.
      */
     private assertConnection;
     /**
@@ -23,14 +21,13 @@ export declare class EvmSigner extends ccc.SignerEvm {
      * @param client - The client instance.
      * @param name - The name of the signer.
      * @param icon - The icon URL of the signer.
-     * @param appUri - The application URI.
+     * @param _appUri - The application URI.
      * @param connectionsRepo - The connections repository.
      */
     constructor(client: ccc.Client, name: string, icon: string, _appUri?: string | undefined, connectionsRepo?: ConnectionsRepo);
     /**
      * Gets the configuration for JoyID.
-     * @private
-     * @returns {object} The configuration object.
+     * @returns The configuration object.
      */
     private getConfig;
     /**
@@ -40,31 +37,29 @@ export declare class EvmSigner extends ccc.SignerEvm {
     getEvmAccount(): Promise<ccc.Hex>;
     /**
      * Connects to the provider by requesting authentication.
-     * @returns {Promise<void>} A promise that resolves when the connection is established.
+     * @returns A promise that resolves when the connection is established.
      */
     connect(): Promise<void>;
     disconnect(): Promise<void>;
     /**
      * Checks if the signer is connected.
-     * @returns {Promise<boolean>} A promise that resolves to true if connected, false otherwise.
+     * @returns A promise that resolves to true if connected, false otherwise.
      */
     isConnected(): Promise<boolean>;
     /**
      * Signs a raw message with the EVM account.
-     * @param {string | ccc.BytesLike} message - The message to sign.
-     * @returns {Promise<ccc.Hex>} A promise that resolves to the signed message.
+     * @param message - The message to sign.
+     * @returns A promise that resolves to the signed message.
      */
     signMessageRaw(message: string | ccc.BytesLike): Promise<ccc.Hex>;
     /**
      * Saves the current connection.
-     * @private
-     * @returns {Promise<void>}
+     * @returns
      */
     private saveConnection;
     /**
      * Restores the previous connection.
-     * @private
-     * @returns {Promise<void>}
+     * @returns
      */
     private restoreConnection;
 }

package/dist/evm/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/evm/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAGpC,OAAO,EAEL,eAAe,EAEhB,MAAM,gCAAgC,CAAC;AAExC;;;;GAIG;AACH,qBAAa,SAAU,SAAQ,GAAG,CAAC,SAAS;IA2BxC,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;IACzB,OAAO,CAAC,QAAQ,CAAC,eAAe;IA7BlC,OAAO,CAAC,UAAU,CAAC,CAAa;IAEhC;;;;;OAKG;IACH,OAAO,CAAC,gBAAgB;IAQxB;;;;;;;OAOG;gBAED,MAAM,EAAE,GAAG,CAAC,MAAM,EACD,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,oBAAQ,EAChB,eAAe,GAAE,eAAmD;IAKvF;;;;OAIG;IACH,OAAO,CAAC,SAAS;IAajB;;;OAGG;IACG,aAAa,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;IAIvC;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAgBxB,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAOjC;;;OAGG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAQrC;;;;OAIG;IACG,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;IAuBvE;;;;OAIG;YACW,cAAc;IAU5B;;;;OAIG;YACW,iBAAiB;CAMhC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/evm/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAGpC,OAAO,EAEL,eAAe,EAEhB,MAAM,gCAAgC,CAAC;AAExC;;;GAGG;AACH,qBAAa,SAAU,SAAQ,GAAG,CAAC,SAAS;IA0BxC,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;IACzB,OAAO,CAAC,QAAQ,CAAC,eAAe;IA5BlC,OAAO,CAAC,UAAU,CAAC,CAAa;IAEhC;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;IAQxB;;;;;;;OAOG;gBAED,MAAM,EAAE,GAAG,CAAC,MAAM,EACD,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,oBAAQ,EAChB,eAAe,GAAE,eAAmD;IAKvF;;;OAGG;IACH,OAAO,CAAC,SAAS;IAajB;;;OAGG;IACG,aAAa,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;IAIvC;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAgBxB,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAOjC;;;OAGG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAQrC;;;;OAIG;IACG,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;IAuBvE;;;OAGG;YACW,cAAc;IAU5B;;;OAGG;YACW,iBAAiB;CAMhC"}

package/dist/evm/index.js

@@ -3,16 +3,14 @@ import { DappRequestType, buildJoyIDURL } from "@joyid/common";
 import { createPopup } from "../common/index.js";
 import { ConnectionsRepoLocalStorage, } from "../connectionsStorage/index.js";
 /**
- * Class representing an EVM signer that extends SignerEvm from @ckb-ccc/core.
- * @class
- * @extends {ccc.SignerEvm}
+ * Class representing an EVM signer that extends SignerEvm
+ * @public
  */
 export class EvmSigner extends ccc.SignerEvm {
     /**
      * Ensures that the signer is connected and returns the connection.
-     * @private
      * @throws Will throw an error if not connected.
-     * @returns {Connection} The current connection.
+     * @returns The current connection.
      */
     assertConnection() {
         if (!this.isConnected() || !this.connection) {
@@ -25,7 +23,7 @@ export class EvmSigner extends ccc.SignerEvm {
      * @param client - The client instance.
      * @param name - The name of the signer.
      * @param icon - The icon URL of the signer.
-     * @param appUri - The application URI.
+     * @param _appUri - The application URI.
      * @param connectionsRepo - The connections repository.
      */
     constructor(client, name, icon, _appUri, connectionsRepo = new ConnectionsRepoLocalStorage()) {
@@ -37,8 +35,7 @@ export class EvmSigner extends ccc.SignerEvm {
     }
     /**
      * Gets the configuration for JoyID.
-     * @private
-     * @returns {object} The configuration object.
+     * @returns The configuration object.
      */
     getConfig() {
         return {
@@ -60,7 +57,7 @@ export class EvmSigner extends ccc.SignerEvm {
     }
     /**
      * Connects to the provider by requesting authentication.
-     * @returns {Promise<void>} A promise that resolves when the connection is established.
+     * @returns A promise that resolves when the connection is established.
      */
     async connect() {
         const config = this.getConfig();
@@ -82,7 +79,7 @@ export class EvmSigner extends ccc.SignerEvm {
     }
     /**
      * Checks if the signer is connected.
-     * @returns {Promise<boolean>} A promise that resolves to true if connected, false otherwise.
+     * @returns A promise that resolves to true if connected, false otherwise.
      */
     async isConnected() {
         if (this.connection) {
@@ -93,8 +90,8 @@ export class EvmSigner extends ccc.SignerEvm {
     }
     /**
      * Signs a raw message with the EVM account.
-     * @param {string | ccc.BytesLike} message - The message to sign.
-     * @returns {Promise<ccc.Hex>} A promise that resolves to the signed message.
+     * @param message - The message to sign.
+     * @returns A promise that resolves to the signed message.
      */
     async signMessageRaw(message) {
         const { address } = this.assertConnection();
@@ -110,8 +107,7 @@ export class EvmSigner extends ccc.SignerEvm {
     }
     /**
      * Saves the current connection.
-     * @private
-     * @returns {Promise<void>}
+     * @returns
      */
     async saveConnection() {
         return this.connectionsRepo.set({
@@ -121,8 +117,7 @@ export class EvmSigner extends ccc.SignerEvm {
     }
     /**
      * Restores the previous connection.
-     * @private
-     * @returns {Promise<void>}
+     * @returns
      */
     async restoreConnection() {
         this.connection = await this.connectionsRepo.get({

package/dist/nostr/index.d.ts

@@ -1,9 +1,8 @@
 import { ccc } from "@ckb-ccc/core";
 import { ConnectionsRepo } from "../connectionsStorage/index.js";
 /**
- * Class representing a Nostr signer that extends SignerNostr from @ckb-ccc/core.
- * @class
- * @extends {ccc.SignerNostr}
+ * Class representing a Nostr signer that extends SignerNostr
+ * @public
  */
 export declare class NostrSigner extends ccc.SignerNostr {
     private readonly name;
@@ -13,9 +12,8 @@ export declare class NostrSigner extends ccc.SignerNostr {
     private connection?;
     /**
      * Ensures that the signer is connected and returns the connection.
-     * @private
      * @throws Will throw an error if not connected.
-     * @returns {Connection} The current connection.
+     * @returns The current connection.
      */
     private assertConnection;
     /**
@@ -23,39 +21,36 @@ export declare class NostrSigner extends ccc.SignerNostr {
      * @param client - The client instance.
      * @param name - The name of the signer.
      * @param icon - The icon URL of the signer.
-     * @param appUri - The application URI.
+     * @param _appUri - The application URI.
      * @param connectionsRepo - The connections repository.
      */
     constructor(client: ccc.Client, name: string, icon: string, _appUri?: string | undefined, connectionsRepo?: ConnectionsRepo);
     /**
      * Gets the configuration for JoyID.
-     * @private
-     * @returns {object} The configuration object.
+     * @returns The configuration object.
      */
     private getConfig;
     /**
      * Connects to the provider by requesting authentication.
-     * @returns {Promise<void>} A promise that resolves when the connection is established.
+     * @returns A promise that resolves when the connection is established.
      */
     connect(): Promise<void>;
     disconnect(): Promise<void>;
     /**
      * Checks if the signer is connected.
-     * @returns {Promise<boolean>} A promise that resolves to true if connected, false otherwise.
+     * @returns A promise that resolves to true if connected, false otherwise.
      */
     isConnected(): Promise<boolean>;
     getNostrPublicKey(): Promise<ccc.Hex>;
     signNostrEvent(event: ccc.NostrEvent): Promise<Required<ccc.NostrEvent>>;
     /**
      * Saves the current connection.
-     * @private
-     * @returns {Promise<void>}
+     * @returns
      */
     private saveConnection;
     /**
      * Restores the previous connection.
-     * @private
-     * @returns {Promise<void>}
+     * @returns
      */
     private restoreConnection;
 }

package/dist/nostr/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/nostr/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAGpC,OAAO,EAEL,eAAe,EAEhB,MAAM,gCAAgC,CAAC;AAExC;;;;GAIG;AACH,qBAAa,WAAY,SAAQ,GAAG,CAAC,WAAW;IA2B5C,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;IACzB,OAAO,CAAC,QAAQ,CAAC,eAAe;IA7BlC,OAAO,CAAC,UAAU,CAAC,CAAa;IAEhC;;;;;OAKG;IACH,OAAO,CAAC,gBAAgB;IAQxB;;;;;;;OAOG;gBAED,MAAM,EAAE,GAAG,CAAC,MAAM,EACD,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,oBAAQ,EAChB,eAAe,GAAE,eAAmD;IAKvF;;;;OAIG;IACH,OAAO,CAAC,SAAS;IAajB;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAexB,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAOjC;;;OAGG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAS/B,iBAAiB,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;IAIrC,cAAc,CAClB,KAAK,EAAE,GAAG,CAAC,UAAU,GACpB,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAYpC;;;;OAIG;YACW,cAAc;IAU5B;;;;OAIG;YACW,iBAAiB;CAMhC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/nostr/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAGpC,OAAO,EAEL,eAAe,EAEhB,MAAM,gCAAgC,CAAC;AAExC;;;GAGG;AACH,qBAAa,WAAY,SAAQ,GAAG,CAAC,WAAW;IA0B5C,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;IACzB,OAAO,CAAC,QAAQ,CAAC,eAAe;IA5BlC,OAAO,CAAC,UAAU,CAAC,CAAa;IAEhC;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;IAQxB;;;;;;;OAOG;gBAED,MAAM,EAAE,GAAG,CAAC,MAAM,EACD,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,oBAAQ,EAChB,eAAe,GAAE,eAAmD;IAKvF;;;OAGG;IACH,OAAO,CAAC,SAAS;IAajB;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAexB,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAOjC;;;OAGG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAS/B,iBAAiB,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;IAIrC,cAAc,CAClB,KAAK,EAAE,GAAG,CAAC,UAAU,GACpB,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAYpC;;;OAGG;YACW,cAAc;IAU5B;;;OAGG;YACW,iBAAiB;CAMhC"}

package/dist/nostr/index.js

@@ -3,16 +3,14 @@ import { DappRequestType, buildJoyIDURL } from "@joyid/common";
 import { createPopup } from "../common/index.js";
 import { ConnectionsRepoLocalStorage, } from "../connectionsStorage/index.js";
 /**
- * Class representing a Nostr signer that extends SignerNostr from @ckb-ccc/core.
- * @class
- * @extends {ccc.SignerNostr}
+ * Class representing a Nostr signer that extends SignerNostr
+ * @public
  */
 export class NostrSigner extends ccc.SignerNostr {
     /**
      * Ensures that the signer is connected and returns the connection.
-     * @private
      * @throws Will throw an error if not connected.
-     * @returns {Connection} The current connection.
+     * @returns The current connection.
      */
     assertConnection() {
         if (!this.isConnected() || !this.connection) {
@@ -25,7 +23,7 @@ export class NostrSigner extends ccc.SignerNostr {
      * @param client - The client instance.
      * @param name - The name of the signer.
      * @param icon - The icon URL of the signer.
-     * @param appUri - The application URI.
+     * @param _appUri - The application URI.
      * @param connectionsRepo - The connections repository.
      */
     constructor(client, name, icon, _appUri, connectionsRepo = new ConnectionsRepoLocalStorage()) {
@@ -37,8 +35,7 @@ export class NostrSigner extends ccc.SignerNostr {
     }
     /**
      * Gets the configuration for JoyID.
-     * @private
-     * @returns {object} The configuration object.
+     * @returns The configuration object.
      */
     getConfig() {
         return {
@@ -53,7 +50,7 @@ export class NostrSigner extends ccc.SignerNostr {
     }
     /**
      * Connects to the provider by requesting authentication.
-     * @returns {Promise<void>} A promise that resolves when the connection is established.
+     * @returns A promise that resolves when the connection is established.
      */
     async connect() {
         const config = this.getConfig();
@@ -75,7 +72,7 @@ export class NostrSigner extends ccc.SignerNostr {
     }
     /**
      * Checks if the signer is connected.
-     * @returns {Promise<boolean>} A promise that resolves to true if connected, false otherwise.
+     * @returns A promise that resolves to true if connected, false otherwise.
      */
     async isConnected() {
         if (this.connection) {
@@ -97,8 +94,7 @@ export class NostrSigner extends ccc.SignerNostr {
     }
     /**
      * Saves the current connection.
-     * @private
-     * @returns {Promise<void>}
+     * @returns
      */
     async saveConnection() {
         return this.connectionsRepo.set({
@@ -108,8 +104,7 @@ export class NostrSigner extends ccc.SignerNostr {
     }
     /**
      * Restores the previous connection.
-     * @private
-     * @returns {Promise<void>}
+     * @returns
      */
     async restoreConnection() {
         this.connection = await this.connectionsRepo.get({

package/dist/signerFactory/index.d.ts

@@ -3,10 +3,12 @@ import { ccc } from "@ckb-ccc/core";
  * Gets the JoyID signers based on the client, name, and icon.
  * If the browser is standalone or a webview, returns SignerAlwaysError instances.
  * Otherwise, returns instances of CkbSigner, BitcoinSigner, and EvmSigner.
- * @param {ccc.Client} client - The client instance.
- * @param {string} name - The name of the signer.
- * @param {string} icon - The icon URL of the signer.
- * @returns {ccc.SignerInfo[]} An array of signer information objects.
+ * @public
+ *
+ * @param client - The client instance.
+ * @param name - The name of the signer.
+ * @param icon - The icon URL of the signer.
+ * @returns An array of signer information objects.
  */
 export declare function getJoyIdSigners(client: ccc.Client, name: string, icon: string, preferredNetworks?: ccc.NetworkPreference[]): ccc.SignerInfo[];
 //# sourceMappingURL=index.d.ts.map

package/dist/signerFactory/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/signerFactory/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAOpC;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,GAAG,CAAC,MAAM,EAClB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,iBAAiB,CAAC,EAAE,GAAG,CAAC,iBAAiB,EAAE,GAC1C,GAAG,CAAC,UAAU,EAAE,CA8ClB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/signerFactory/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAOpC;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,GAAG,CAAC,MAAM,EAClB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,iBAAiB,CAAC,EAAE,GAAG,CAAC,iBAAiB,EAAE,GAC1C,GAAG,CAAC,UAAU,EAAE,CA8ClB"}

package/dist/signerFactory/index.js

@@ -8,10 +8,12 @@ import { NostrSigner } from "../nostr/index.js";
  * Gets the JoyID signers based on the client, name, and icon.
  * If the browser is standalone or a webview, returns SignerAlwaysError instances.
  * Otherwise, returns instances of CkbSigner, BitcoinSigner, and EvmSigner.
- * @param {ccc.Client} client - The client instance.
- * @param {string} name - The name of the signer.
- * @param {string} icon - The icon URL of the signer.
- * @returns {ccc.SignerInfo[]} An array of signer information objects.
+ * @public
+ *
+ * @param client - The client instance.
+ * @param name - The name of the signer.
+ * @param icon - The icon URL of the signer.
+ * @returns An array of signer information objects.
  */
 export function getJoyIdSigners(client, name, icon, preferredNetworks) {
     if (isStandaloneBrowser() || ccc.isWebview(window.navigator.userAgent)) {

package/dist.commonjs/btc/index.d.ts

@@ -1,9 +1,8 @@
 import { ccc } from "@ckb-ccc/core";
 import { ConnectionsRepo } from "../connectionsStorage/index.js";
 /**
- * Class representing a Bitcoin signer that extends SignerBtc from @ckb-ccc/core.
- * @class
- * @extends {ccc.SignerBtc}
+ * Class representing a Bitcoin signer that extends SignerBtc
+ * @public
  */
 export declare class BitcoinSigner extends ccc.SignerBtc {
     readonly name: string;
@@ -16,9 +15,8 @@ export declare class BitcoinSigner extends ccc.SignerBtc {
     private network;
     /**
      * Ensures that the signer is connected and returns the connection.
-     * @private
      * @throws Will throw an error if not connected.
-     * @returns {Connection} The current connection.
+     * @returns The current connection.
      */
     private assertConnection;
     /**
@@ -33,35 +31,34 @@ export declare class BitcoinSigner extends ccc.SignerBtc {
     constructor(client: ccc.Client, name: string, icon: string, preferredNetworks?: ccc.NetworkPreference[], addressType?: "auto" | "p2wpkh" | "p2tr", _appUri?: string | undefined, connectionsRepo?: ConnectionsRepo);
     /**
      * Gets the configuration for JoyID.
-     * @private
      * @returns The configuration object.
      */
     private getConfig;
     disconnect(): Promise<void>;
     /**
      * Gets the Bitcoin account address.
-     * @returns {Promise<string>} A promise that resolves to the Bitcoin account address.
+     * @returns A promise that resolves to the Bitcoin account address.
      */
     getBtcAccount(): Promise<string>;
     /**
      * Gets the Bitcoin public key.
-     * @returns {Promise<ccc.Hex>} A promise that resolves to the Bitcoin public key.
+     * @returns A promise that resolves to the Bitcoin public key.
      */
     getBtcPublicKey(): Promise<ccc.Hex>;
     /**
      * Connects to the provider by requesting authentication.
-     * @returns {Promise<void>} A promise that resolves when the connection is established.
+     * @returns A promise that resolves when the connection is established.
      */
     connect(): Promise<void>;
     /**
      * Checks if the signer is connected.
-     * @returns {Promise<boolean>} A promise that resolves to true if connected, false otherwise.
+     * @returns A promise that resolves to true if connected, false otherwise.
      */
     isConnected(): Promise<boolean>;
     /**
      * Signs a raw message with the Bitcoin account.
-     * @param {string | ccc.BytesLike} message - The message to sign.
-     * @returns {Promise<string>} A promise that resolves to the signed message.
+     * @param message - The message to sign.
+     * @returns A promise that resolves to the signed message.
      */
     signMessageRaw(message: string | ccc.BytesLike): Promise<string>;
 }

package/dist.commonjs/btc/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/btc/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAGpC,OAAO,EAEL,eAAe,EAEhB,MAAM,gCAAgC,CAAC;AAExC;;;;GAIG;AACH,qBAAa,aAAc,SAAQ,GAAG,CAAC,SAAS;aA6B5B,IAAI,EAAE,MAAM;aACZ,IAAI,EAAE,MAAM;IAC5B,OAAO,CAAC,QAAQ,CAAC,iBAAiB;aAYlB,WAAW,EAAE,MAAM,GAAG,QAAQ,GAAG,MAAM;IACvD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;IACzB,OAAO,CAAC,QAAQ,CAAC,eAAe;IA5ClC,OAAO,CAAC,UAAU,CAAC,CAAa;IAChC,OAAO,CAAC,OAAO,CAAgB;IAE/B;;;;;OAKG;IACH,OAAO,CAAC,gBAAgB;IAQxB;;;;;;;;OAQG;gBAED,MAAM,EAAE,GAAG,CAAC,MAAM,EACF,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACX,iBAAiB,GAAE,GAAG,CAAC,iBAAiB,EAWxD,EACe,WAAW,GAAE,MAAM,GAAG,QAAQ,GAAG,MAAe,EAC/C,OAAO,CAAC,oBAAQ,EAChB,eAAe,GAAE,eAAmD;IAKvF;;;;OAIG;IACH,OAAO,CAAC,SAAS;IA6BX,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IASjC;;;OAGG;IACG,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAKtC;;;OAGG;IACG,eAAe,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;IAKzC;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IA+B9B;;;OAGG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAYrC;;;;OAIG;IACG,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC;CAsBvE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/btc/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAGpC,OAAO,EAEL,eAAe,EAEhB,MAAM,gCAAgC,CAAC;AAExC;;;GAGG;AACH,qBAAa,aAAc,SAAQ,GAAG,CAAC,SAAS;aA4B5B,IAAI,EAAE,MAAM;aACZ,IAAI,EAAE,MAAM;IAC5B,OAAO,CAAC,QAAQ,CAAC,iBAAiB;aAYlB,WAAW,EAAE,MAAM,GAAG,QAAQ,GAAG,MAAM;IACvD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;IACzB,OAAO,CAAC,QAAQ,CAAC,eAAe;IA3ClC,OAAO,CAAC,UAAU,CAAC,CAAa;IAChC,OAAO,CAAC,OAAO,CAAgB;IAE/B;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;IAQxB;;;;;;;;OAQG;gBAED,MAAM,EAAE,GAAG,CAAC,MAAM,EACF,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACX,iBAAiB,GAAE,GAAG,CAAC,iBAAiB,EAWxD,EACe,WAAW,GAAE,MAAM,GAAG,QAAQ,GAAG,MAAe,EAC/C,OAAO,CAAC,oBAAQ,EAChB,eAAe,GAAE,eAAmD;IAKvF;;;OAGG;IACH,OAAO,CAAC,SAAS;IA6BX,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IASjC;;;OAGG;IACG,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAKtC;;;OAGG;IACG,eAAe,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;IAKzC;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IA+B9B;;;OAGG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAYrC;;;;OAIG;IACG,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC;CAsBvE"}