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

package/src/common/index.ts

@@ -18,7 +18,6 @@ import {
 
 /**
  * Interface representing the return type for various Dapp request types.
- * @interface
  */
 export interface PopupReturnType {
   [DappRequestType.Auth]: AuthResponseData;
@@ -42,9 +41,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/src/connectionsStorage/index.ts

@@ -2,20 +2,23 @@ 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 function isSelectorMatch(
   a: AccountSelector,
@@ -26,34 +29,38 @@ export function isSelectorMatch(
 
 /**
  * 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,
@@ -63,19 +70,17 @@ export interface ConnectionsRepo {
 
 /**
  * Class representing a local storage-based repository for managing connections.
- * @class
- * @implements {ConnectionsRepo}
  */
 export class ConnectionsRepoLocalStorage implements ConnectionsRepo {
   /**
    * 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(private readonly storageKey = "ccc-joy-id-signer") {}
 
   /**
    * 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(): Promise<[AccountSelector, Connection][]> {
     return JSON.parse(window.localStorage.getItem(this.storageKey) ?? "[]");
@@ -83,8 +88,8 @@ export class ConnectionsRepoLocalStorage implements 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.
    */
   async get(selector: AccountSelector): Promise<Connection | undefined> {
     return (await this.readConnections()).find(([s]) =>
@@ -94,9 +99,9 @@ export class ConnectionsRepoLocalStorage implements ConnectionsRepo {
 
   /**
    * 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: AccountSelector,

package/src/evm/index.ts

@@ -8,18 +8,16 @@ import {
 } 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 {
   private connection?: 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(): Connection {
     if (!this.isConnected() || !this.connection) {
@@ -34,7 +32,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(
@@ -49,8 +47,7 @@ export class EvmSigner extends ccc.SignerEvm {
 
   /**
    * Gets the configuration for JoyID.
-   * @private
-   * @returns {object} The configuration object.
+   * @returns The configuration object.
    */
   private getConfig() {
     return {
@@ -75,7 +72,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(): Promise<void> {
     const config = this.getConfig();
@@ -102,7 +99,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(): Promise<boolean> {
     if (this.connection) {
@@ -114,8 +111,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: string | ccc.BytesLike): Promise<ccc.Hex> {
     const { address } = this.assertConnection();
@@ -142,8 +139,7 @@ export class EvmSigner extends ccc.SignerEvm {
 
   /**
    * Saves the current connection.
-   * @private
-   * @returns {Promise<void>}
+   * @returns
    */
   private async saveConnection(): Promise<void> {
     return this.connectionsRepo.set(
@@ -157,8 +153,7 @@ export class EvmSigner extends ccc.SignerEvm {
 
   /**
    * Restores the previous connection.
-   * @private
-   * @returns {Promise<void>}
+   * @returns
    */
   private async restoreConnection(): Promise<void> {
     this.connection = await this.connectionsRepo.get({

package/src/nostr/index.ts

@@ -8,18 +8,16 @@ import {
 } 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 {
   private connection?: 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(): Connection {
     if (!this.isConnected() || !this.connection) {
@@ -34,7 +32,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(
@@ -49,8 +47,7 @@ export class NostrSigner extends ccc.SignerNostr {
 
   /**
    * Gets the configuration for JoyID.
-   * @private
-   * @returns {object} The configuration object.
+   * @returns The configuration object.
    */
   private getConfig() {
     return {
@@ -67,7 +64,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(): Promise<void> {
     const config = this.getConfig();
@@ -93,7 +90,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(): Promise<boolean> {
     if (this.connection) {
@@ -124,8 +121,7 @@ export class NostrSigner extends ccc.SignerNostr {
 
   /**
    * Saves the current connection.
-   * @private
-   * @returns {Promise<void>}
+   * @returns
    */
   private async saveConnection(): Promise<void> {
     return this.connectionsRepo.set(
@@ -139,8 +135,7 @@ export class NostrSigner extends ccc.SignerNostr {
 
   /**
    * Restores the previous connection.
-   * @private
-   * @returns {Promise<void>}
+   * @returns
    */
   private async restoreConnection(): Promise<void> {
     this.connection = await this.connectionsRepo.get({

package/src/signerFactory/index.ts

@@ -9,10 +9,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: ccc.Client,

package/typedoc.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPoints": ["./src/index.ts", "./src/advanced.ts"],
+  "extends": ["../../typedoc.base.json"],
+  "name": "@ckb-ccc joy-id"
+}