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

package/dist.commonjs/btc/index.js

@@ -6,16 +6,14 @@ const common_1 = require("@joyid/common");
 const index_js_1 = require("../common/index.js");
 const index_js_2 = require("../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
  */
 class BitcoinSigner extends core_1.ccc.SignerBtc {
     /**
      * 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) {
@@ -55,7 +53,6 @@ class BitcoinSigner extends core_1.ccc.SignerBtc {
     }
     /**
      * Gets the configuration for JoyID.
-     * @private
      * @returns The configuration object.
      */
     getConfig() {
@@ -85,7 +82,7 @@ class BitcoinSigner extends core_1.ccc.SignerBtc {
     }
     /**
      * 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.
      */
     async getBtcAccount() {
         const { address } = this.assertConnection();
@@ -93,7 +90,7 @@ class BitcoinSigner extends core_1.ccc.SignerBtc {
     }
     /**
      * 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.
      */
     async getBtcPublicKey() {
         const { publicKey } = this.assertConnection();
@@ -101,7 +98,7 @@ class BitcoinSigner extends core_1.ccc.SignerBtc {
     }
     /**
      * 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();
@@ -127,7 +124,7 @@ class BitcoinSigner extends core_1.ccc.SignerBtc {
     }
     /**
      * 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) {
@@ -141,8 +138,8 @@ class BitcoinSigner extends core_1.ccc.SignerBtc {
     }
     /**
      * 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.
      */
     async signMessageRaw(message) {
         const { address } = this.assertConnection();

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

@@ -1,9 +1,8 @@
 import { ccc } from "@ckb-ccc/core";
 import { ConnectionsRepo } from "../connectionsStorage/index.js";
 /**
- * Class representing a CKB signer that extends Signer from @ckb-ccc/core.
- * @class
- * @extends {ccc.Signer}
+ * Class representing a CKB signer that extends Signer
+ * @public
  */
 export declare class CkbSigner extends ccc.Signer {
     private readonly name;
@@ -13,84 +12,80 @@ export declare class CkbSigner extends ccc.Signer {
     private readonly connectionsRepo;
     /**
      * Gets the signer type.
-     * @returns {ccc.SignerType} The type of the signer.
+     * @returns The type of the signer.
      */
     get type(): ccc.SignerType;
     /**
      * Gets the sign type.
-     * @returns {ccc.SignerSignType} The sign type.
+     * @returns The sign type.
      */
     get signType(): ccc.SignerSignType;
     private connection?;
     /**
      * Ensures that the signer is connected and returns the connection.
-     * @private
      * @throws Will throw an error if not connected.
-     * @returns {Promise<Connection>} A promise that resolves to the current connection.
+     * @returns A promise that resolves to the current connection.
      */
     private assertConnection;
     /**
      * Creates an instance of CkbSigner.
-     * @param {ccc.Client} client - The client instance.
-     * @param {string} name - The name of the signer.
-     * @param {string} icon - The icon URL of the signer.
-     * @param {string} [_appUri] - The application URI.
-     * @param {string} [_aggregatorUri] - The aggregator URI.
-     * @param {ConnectionsRepo} [connectionsRepo=new ConnectionsRepoLocalStorage()] - The connections repository.
+     * @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 _aggregatorUri - The aggregator URI.
+     * @param connectionsRepo - The connections repository.
      */
     constructor(client: ccc.Client, name: string, icon: string, _appUri?: string | undefined, _aggregatorUri?: string | undefined, connectionsRepo?: ConnectionsRepo);
     /**
      * Gets the configuration for JoyID.
-     * @private
      * @returns The configuration object.
      */
     private getConfig;
     /**
      * Gets the aggregator URI.
-     * @private
-     * @returns {string} The aggregator URI.
+     * @returns The aggregator URI.
      */
     private getAggregatorUri;
     /**
      * 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>;
     /**
      * Gets the internal address.
-     * @returns {Promise<string>} A promise that resolves to the internal address.
+     * @returns A promise that resolves to the internal address.
      */
     getInternalAddress(): Promise<string>;
     /**
      * Gets the identity of the signer.
-     * @returns {Promise<string>} A promise that resolves to the identity.
+     * @returns A promise that resolves to the identity.
      */
     getIdentity(): Promise<string>;
     /**
      * Gets the address object.
-     * @returns {Promise<ccc.Address>} A promise that resolves to the address object.
+     * @returns A promise that resolves to the address object.
      */
     getAddressObj(): Promise<ccc.Address>;
     /**
      * Gets the address objects.
-     * @returns {Promise<ccc.Address[]>} A promise that resolves to an array of address objects.
+     * @returns A promise that resolves to an array of address objects.
      */
     getAddressObjs(): Promise<ccc.Address[]>;
     /**
      * Prepares a transaction.
-     * @param {ccc.TransactionLike} txLike - The transaction-like object.
-     * @returns {Promise<ccc.Transaction>} A promise that resolves to the prepared transaction.
+     * @param txLike - The transaction-like object.
+     * @returns A promise that resolves to the prepared transaction.
      */
     prepareTransaction(txLike: ccc.TransactionLike): Promise<ccc.Transaction>;
     /**
      * Prepares a transaction for a sub key.
-     * @private
      * @param tx - The transaction object.
      * @param witness - The witness arguments.
      * @throws Will throw an error if no COTA cells are found for the sub key wallet.
@@ -98,26 +93,24 @@ export declare class CkbSigner extends ccc.Signer {
     private prepareTransactionForSubKey;
     /**
      * Signs a transaction.
-     * @param {ccc.TransactionLike} txLike - The transaction-like object.
-     * @returns {Promise<ccc.Transaction>} A promise that resolves to the signed transaction.
+     * @param txLike - The transaction-like object.
+     * @returns A promise that resolves to the signed transaction.
      */
     signOnlyTransaction(txLike: ccc.TransactionLike): Promise<ccc.Transaction>;
     /**
      * Signs a raw message with the 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>;
     /**
      * Saves the current connection.
-     * @private
-     * @returns {Promise<void>}
+     * @returns
      */
     private saveConnection;
     /**
      * Restores the previous connection.
-     * @private
-     * @returns {Promise<void>}
+     * @returns
      */
     private restoreConnection;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/ckb/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAIpC,OAAO,EAEL,eAAe,EAEhB,MAAM,gCAAgC,CAAC;AAExC;;;;GAIG;AACH,qBAAa,SAAU,SAAQ,GAAG,CAAC,MAAM;IA4CrC,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;IACzB,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC;IAChC,OAAO,CAAC,QAAQ,CAAC,eAAe;IA/ClC;;;OAGG;IACH,IAAI,IAAI,IAAI,GAAG,CAAC,UAAU,CAEzB;IAED;;;OAGG;IACH,IAAI,QAAQ,IAAI,GAAG,CAAC,cAAc,CAEjC;IAED,OAAO,CAAC,UAAU,CAAC,CAAa;IAEhC;;;;;OAKG;YACW,gBAAgB;IAQ9B;;;;;;;;OAQG;gBAED,MAAM,EAAE,GAAG,CAAC,MAAM,EACD,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,oBAAQ,EAChB,cAAc,CAAC,oBAAQ,EACvB,eAAe,GAAE,eAAmD;IAKvF;;;;OAIG;IACH,OAAO,CAAC,SAAS;IAYjB;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;IAUxB;;;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;;;OAGG;IACG,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC;IAI3C;;;OAGG;IACG,WAAW,IAAI,OAAO,CAAC,MAAM,CAAC;IAQpC;;;OAGG;IACG,aAAa,IAAI,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC;IAO3C;;;OAGG;IACG,cAAc,IAAI,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IAI9C;;;;OAIG;IACG,kBAAkB,CACtB,MAAM,EAAE,GAAG,CAAC,eAAe,GAC1B,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC;IAmB3B;;;;;;OAMG;YACW,2BAA2B;IA0CzC;;;;OAIG;IACG,mBAAmB,CACvB,MAAM,EAAE,GAAG,CAAC,eAAe,GAC1B,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC;IA8C3B;;;;OAIG;IACG,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC;IA2BtE;;;;OAIG;YACW,cAAc;IAU5B;;;;OAIG;YACW,iBAAiB;CAMhC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/ckb/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAIpC,OAAO,EAEL,eAAe,EAEhB,MAAM,gCAAgC,CAAC;AAExC;;;GAGG;AACH,qBAAa,SAAU,SAAQ,GAAG,CAAC,MAAM;IA2CrC,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;IACzB,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC;IAChC,OAAO,CAAC,QAAQ,CAAC,eAAe;IA9ClC;;;OAGG;IACH,IAAI,IAAI,IAAI,GAAG,CAAC,UAAU,CAEzB;IAED;;;OAGG;IACH,IAAI,QAAQ,IAAI,GAAG,CAAC,cAAc,CAEjC;IAED,OAAO,CAAC,UAAU,CAAC,CAAa;IAEhC;;;;OAIG;YACW,gBAAgB;IAQ9B;;;;;;;;OAQG;gBAED,MAAM,EAAE,GAAG,CAAC,MAAM,EACD,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,oBAAQ,EAChB,cAAc,CAAC,oBAAQ,EACvB,eAAe,GAAE,eAAmD;IAKvF;;;OAGG;IACH,OAAO,CAAC,SAAS;IAYjB;;;OAGG;IACH,OAAO,CAAC,gBAAgB;IAUxB;;;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;;;OAGG;IACG,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC;IAI3C;;;OAGG;IACG,WAAW,IAAI,OAAO,CAAC,MAAM,CAAC;IAQpC;;;OAGG;IACG,aAAa,IAAI,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC;IAO3C;;;OAGG;IACG,cAAc,IAAI,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IAI9C;;;;OAIG;IACG,kBAAkB,CACtB,MAAM,EAAE,GAAG,CAAC,eAAe,GAC1B,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC;IAmB3B;;;;;OAKG;YACW,2BAA2B;IA0CzC;;;;OAIG;IACG,mBAAmB,CACvB,MAAM,EAAE,GAAG,CAAC,eAAe,GAC1B,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC;IA8C3B;;;;OAIG;IACG,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC;IA2BtE;;;OAGG;YACW,cAAc;IAU5B;;;OAGG;YACW,iBAAiB;CAMhC"}

package/dist.commonjs/ckb/index.js

@@ -7,30 +7,28 @@ const common_1 = require("@joyid/common");
 const index_js_1 = require("../common/index.js");
 const index_js_2 = require("../connectionsStorage/index.js");
 /**
- * Class representing a CKB signer that extends Signer from @ckb-ccc/core.
- * @class
- * @extends {ccc.Signer}
+ * Class representing a CKB signer that extends Signer
+ * @public
  */
 class CkbSigner extends core_1.ccc.Signer {
     /**
      * Gets the signer type.
-     * @returns {ccc.SignerType} The type of the signer.
+     * @returns The type of the signer.
      */
     get type() {
         return core_1.ccc.SignerType.CKB;
     }
     /**
      * Gets the sign type.
-     * @returns {ccc.SignerSignType} The sign type.
+     * @returns The sign type.
      */
     get signType() {
         return core_1.ccc.SignerSignType.JoyId;
     }
     /**
      * Ensures that the signer is connected and returns the connection.
-     * @private
      * @throws Will throw an error if not connected.
-     * @returns {Promise<Connection>} A promise that resolves to the current connection.
+     * @returns A promise that resolves to the current connection.
      */
     async assertConnection() {
         if (!(await this.isConnected()) || !this.connection) {
@@ -40,12 +38,12 @@ class CkbSigner extends core_1.ccc.Signer {
     }
     /**
      * Creates an instance of CkbSigner.
-     * @param {ccc.Client} client - The client instance.
-     * @param {string} name - The name of the signer.
-     * @param {string} icon - The icon URL of the signer.
-     * @param {string} [_appUri] - The application URI.
-     * @param {string} [_aggregatorUri] - The aggregator URI.
-     * @param {ConnectionsRepo} [connectionsRepo=new ConnectionsRepoLocalStorage()] - The connections repository.
+     * @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 _aggregatorUri - The aggregator URI.
+     * @param connectionsRepo - The connections repository.
      */
     constructor(client, name, icon, _appUri, _aggregatorUri, connectionsRepo = new index_js_2.ConnectionsRepoLocalStorage()) {
         super(client);
@@ -57,7 +55,6 @@ class CkbSigner extends core_1.ccc.Signer {
     }
     /**
      * Gets the configuration for JoyID.
-     * @private
      * @returns The configuration object.
      */
     getConfig() {
@@ -72,8 +69,7 @@ class CkbSigner extends core_1.ccc.Signer {
     }
     /**
      * Gets the aggregator URI.
-     * @private
-     * @returns {string} The aggregator URI.
+     * @returns The aggregator URI.
      */
     getAggregatorUri() {
         if (this._aggregatorUri) {
@@ -85,7 +81,7 @@ class CkbSigner extends core_1.ccc.Signer {
     }
     /**
      * 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();
@@ -107,7 +103,7 @@ class CkbSigner extends core_1.ccc.Signer {
     }
     /**
      * 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) {
@@ -118,14 +114,14 @@ class CkbSigner extends core_1.ccc.Signer {
     }
     /**
      * Gets the internal address.
-     * @returns {Promise<string>} A promise that resolves to the internal address.
+     * @returns A promise that resolves to the internal address.
      */
     async getInternalAddress() {
         return (await this.assertConnection()).address;
     }
     /**
      * Gets the identity of the signer.
-     * @returns {Promise<string>} A promise that resolves to the identity.
+     * @returns A promise that resolves to the identity.
      */
     async getIdentity() {
         const connection = await this.assertConnection();
@@ -136,22 +132,22 @@ class CkbSigner extends core_1.ccc.Signer {
     }
     /**
      * Gets the address object.
-     * @returns {Promise<ccc.Address>} A promise that resolves to the address object.
+     * @returns A promise that resolves to the address object.
      */
     async getAddressObj() {
         return await core_1.ccc.Address.fromString(await this.getInternalAddress(), this.client);
     }
     /**
      * Gets the address objects.
-     * @returns {Promise<ccc.Address[]>} A promise that resolves to an array of address objects.
+     * @returns A promise that resolves to an array of address objects.
      */
     async getAddressObjs() {
         return [await this.getAddressObj()];
     }
     /**
      * Prepares a transaction.
-     * @param {ccc.TransactionLike} txLike - The transaction-like object.
-     * @returns {Promise<ccc.Transaction>} A promise that resolves to the prepared transaction.
+     * @param txLike - The transaction-like object.
+     * @returns A promise that resolves to the prepared transaction.
      */
     async prepareTransaction(txLike) {
         const tx = core_1.ccc.Transaction.from(txLike);
@@ -168,7 +164,6 @@ class CkbSigner extends core_1.ccc.Signer {
     }
     /**
      * Prepares a transaction for a sub key.
-     * @private
      * @param tx - The transaction object.
      * @param witness - The witness arguments.
      * @throws Will throw an error if no COTA cells are found for the sub key wallet.
@@ -201,8 +196,8 @@ class CkbSigner extends core_1.ccc.Signer {
     }
     /**
      * Signs a transaction.
-     * @param {ccc.TransactionLike} txLike - The transaction-like object.
-     * @returns {Promise<ccc.Transaction>} A promise that resolves to the signed transaction.
+     * @param txLike - The transaction-like object.
+     * @returns A promise that resolves to the signed transaction.
      */
     async signOnlyTransaction(txLike) {
         const tx = core_1.ccc.Transaction.from(txLike);
@@ -236,8 +231,8 @@ class CkbSigner extends core_1.ccc.Signer {
     }
     /**
      * Signs a raw message with the 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.
      */
     async signMessageRaw(message) {
         const { address } = await this.assertConnection();
@@ -257,8 +252,7 @@ class CkbSigner extends core_1.ccc.Signer {
     }
     /**
      * Saves the current connection.
-     * @private
-     * @returns {Promise<void>}
+     * @returns
      */
     async saveConnection() {
         return this.connectionsRepo.set({
@@ -268,8 +262,7 @@ class CkbSigner extends core_1.ccc.Signer {
     }
     /**
      * Restores the previous connection.
-     * @private
-     * @returns {Promise<void>}
+     * @returns
      */
     async restoreConnection() {
         this.connection = await this.connectionsRepo.get({

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

@@ -1,7 +1,6 @@
 import { AuthResponseData, DappRequestType, EvmWeb2LoginResponse, PopupConfigOptions, SignCkbTxResponseData, SignCotaNFTResponseData, SignEvmTxResponseData, SignMessageResponseData, SignNostrEventData } from "@joyid/common";
 /**
  * Interface representing the return type for various Dapp request types.
- * @interface
  */
 export interface PopupReturnType {
     [DappRequestType.Auth]: AuthResponseData;
@@ -24,9 +23,9 @@ export interface PopupReturnType {
 }
 /**
  * Creates a popup window for JoyID Dapp requests.
- * @param {string} url - The URL to open in the popup.
- * @param {PopupConfigOptions<T> & { joyidAppURL: string }} config - The popup configuration options.
- * @returns {Promise<PopupReturnType[T]>} A promise that resolves to the response data of the requested type.
+ * @param url - The URL to open in the popup.
+ * @param config - The popup configuration options.
+ * @returns A promise that resolves to the response data of the requested type.
  * @throws {PopupNotSupportedError} If popups are not supported in the current browser.
  * @throws {PopupCancelledError} If the popup is closed by the user.
  * @throws {PopupTimeoutError} If the popup operation times out.

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/common/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,eAAe,EACf,oBAAoB,EAEpB,kBAAkB,EAGlB,qBAAqB,EACrB,uBAAuB,EACvB,qBAAqB,EACrB,uBAAuB,EACvB,kBAAkB,EAInB,MAAM,eAAe,CAAC;AAEvB;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,gBAAgB,CAAC;IACzC,CAAC,eAAe,CAAC,WAAW,CAAC,EAAE,uBAAuB,CAAC;IACvD,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,qBAAqB,CAAC;IACjD,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,qBAAqB,CAAC;IAClD,CAAC,eAAe,CAAC,aAAa,CAAC,EAAE;QAC/B,KAAK,EAAE,MAAM,EAAE,CAAC;KACjB,CAAC;IACF,CAAC,eAAe,CAAC,SAAS,CAAC,EAAE,qBAAqB,CAAC;IACnD,CAAC,eAAe,CAAC,WAAW,CAAC,EAAE,uBAAuB,CAAC;IACvD,CAAC,eAAe,CAAC,YAAY,CAAC,EAAE,qBAAqB,CAAC;IACtD,CAAC,eAAe,CAAC,cAAc,CAAC,EAAE,kBAAkB,CAAC;IACrD,CAAC,eAAe,CAAC,mBAAmB,CAAC,EAAE,GAAG,CAAC;IAC3C,CAAC,eAAe,CAAC,mBAAmB,CAAC,EAAE,GAAG,CAAC;IAC3C,CAAC,eAAe,CAAC,WAAW,CAAC,EAAE,GAAG,CAAC;IACnC,CAAC,eAAe,CAAC,cAAc,CAAC,EAAE,GAAG,CAAC;IACtC,CAAC,eAAe,CAAC,kBAAkB,CAAC,EAAE,GAAG,CAAC;IAC1C,CAAC,eAAe,CAAC,YAAY,CAAC,EAAE,oBAAoB,CAAC;CACtD;AAED;;;;;;;;GAQG;AACH,wBAAsB,WAAW,CAAC,CAAC,SAAS,eAAe,EACzD,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,kBAAkB,CAAC,CAAC,CAAC,GAAG;IAAE,WAAW,EAAE,MAAM,CAAA;CAAE,GACtD,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CA0D7B"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/common/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,eAAe,EACf,oBAAoB,EAEpB,kBAAkB,EAGlB,qBAAqB,EACrB,uBAAuB,EACvB,qBAAqB,EACrB,uBAAuB,EACvB,kBAAkB,EAInB,MAAM,eAAe,CAAC;AAEvB;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,gBAAgB,CAAC;IACzC,CAAC,eAAe,CAAC,WAAW,CAAC,EAAE,uBAAuB,CAAC;IACvD,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,qBAAqB,CAAC;IACjD,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,qBAAqB,CAAC;IAClD,CAAC,eAAe,CAAC,aAAa,CAAC,EAAE;QAC/B,KAAK,EAAE,MAAM,EAAE,CAAC;KACjB,CAAC;IACF,CAAC,eAAe,CAAC,SAAS,CAAC,EAAE,qBAAqB,CAAC;IACnD,CAAC,eAAe,CAAC,WAAW,CAAC,EAAE,uBAAuB,CAAC;IACvD,CAAC,eAAe,CAAC,YAAY,CAAC,EAAE,qBAAqB,CAAC;IACtD,CAAC,eAAe,CAAC,cAAc,CAAC,EAAE,kBAAkB,CAAC;IACrD,CAAC,eAAe,CAAC,mBAAmB,CAAC,EAAE,GAAG,CAAC;IAC3C,CAAC,eAAe,CAAC,mBAAmB,CAAC,EAAE,GAAG,CAAC;IAC3C,CAAC,eAAe,CAAC,WAAW,CAAC,EAAE,GAAG,CAAC;IACnC,CAAC,eAAe,CAAC,cAAc,CAAC,EAAE,GAAG,CAAC;IACtC,CAAC,eAAe,CAAC,kBAAkB,CAAC,EAAE,GAAG,CAAC;IAC1C,CAAC,eAAe,CAAC,YAAY,CAAC,EAAE,oBAAoB,CAAC;CACtD;AAED;;;;;;;;GAQG;AACH,wBAAsB,WAAW,CAAC,CAAC,SAAS,eAAe,EACzD,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,kBAAkB,CAAC,CAAC,CAAC,GAAG;IAAE,WAAW,EAAE,MAAM,CAAA;CAAE,GACtD,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CA0D7B"}

package/dist.commonjs/common/index.js

@@ -4,9 +4,9 @@ exports.createPopup = void 0;
 const common_1 = require("@joyid/common");
 /**
  * Creates a popup window for JoyID Dapp requests.
- * @param {string} url - The URL to open in the popup.
- * @param {PopupConfigOptions<T> & { joyidAppURL: string }} config - The popup configuration options.
- * @returns {Promise<PopupReturnType[T]>} A promise that resolves to the response data of the requested type.
+ * @param url - The URL to open in the popup.
+ * @param config - The popup configuration options.
+ * @returns A promise that resolves to the response data of the requested type.
  * @throws {PopupNotSupportedError} If popups are not supported in the current browser.
  * @throws {PopupCancelledError} If the popup is closed by the user.
  * @throws {PopupTimeoutError} If the popup operation times out.

package/dist.commonjs/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.commonjs/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.commonjs/connectionsStorage/index.js

@@ -2,10 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConnectionsRepoLocalStorage = exports.isSelectorMatch = void 0;
 /**
- * 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
  */
 function isSelectorMatch(a, filter) {
     return a.uri === filter.uri && a.addressType.startsWith(filter.addressType);
@@ -13,37 +13,35 @@ function isSelectorMatch(a, filter) {
 exports.isSelectorMatch = isSelectorMatch;
 /**
  * Class representing a local storage-based repository for managing connections.
- * @class
- * @implements {ConnectionsRepo}
  */
 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();