@arcblock/did-connect-js 1.30.0 → 4.0.0-beta.10

package/lib/authenticator/wallet.d.cts

@@ -1,270 +0,0 @@
-import BaseAuthenticator from "./base.cjs";
-
-//#region src/authenticator/wallet.d.ts
-interface ApplicationInfo {
-  name: string;
-  description: string;
-  icon: string;
-  link?: string;
-  path?: string;
-  publisher?: string;
-}
-interface ChainInfo {
-  id: string;
-  type: string;
-  host: string;
-}
-interface WalletAuthenticatorConfig {
-  wallet: any;
-  appInfo: ApplicationInfo | ((params: any) => ApplicationInfo | Promise<ApplicationInfo>);
-  memberAppInfo?: ApplicationInfo | ((params: any) => ApplicationInfo | Promise<ApplicationInfo>) | null;
-  delegator?: any;
-  delegation?: string | ((params: any) => string | Promise<string>);
-  timeout?: number;
-  chainInfo?: ChainInfo | ((params: any) => ChainInfo | Promise<ChainInfo>);
-  baseUrl?: string;
-  tokenKey?: string;
-}
-declare class WalletAuthenticator extends BaseAuthenticator {
-  wallet: any;
-  appInfo: any;
-  memberAppInfo: any;
-  chainInfo: any;
-  delegator: any;
-  delegation: any;
-  baseUrl: string;
-  tokenKey: string;
-  timeout: number;
-  static formatDisplay(display: any): string;
-  /**
-   * Creates an instance of DID Authenticator.
-   *
-   * @class
-   * @param {object} config
-   * @param {WalletObject|Function} config.wallet - wallet instance {@see @ocap/wallet} or a function that returns wallet instance
-   * @param {WalletObject|Function} [config.delegator] - the party that authorizes `wallet` to perform actions on behalf of `wallet`
-   * @param {string|Function} [config.delegation] - the jwt token that proves delegation relationship
-   * @param {ApplicationInfo|Function} config.appInfo - application basic info or a function that returns application info
-   * @param {ChainInfo|Function} config.chainInfo - application chain info or a function that returns chain info
-   * @param {Number} [config.timeout=8000] - timeout in milliseconds when generating claim
-   * @param {object} [config.baseUrl] - url to assemble wallet request uri, can be inferred from request object
-   * @param {string} [config.tokenKey='_t_'] - query param key for `token`
-   */
-  constructor({
-    wallet,
-    appInfo,
-    memberAppInfo,
-    delegator,
-    delegation,
-    timeout,
-    chainInfo,
-    baseUrl,
-    tokenKey
-  }: WalletAuthenticatorConfig);
-  /**
-   * Generate a deep link url that can be displayed as QRCode for DID Wallet to consume
-   *
-   * @method
-   * @param {object} params
-   * @param {string} params.baseUrl - baseUrl inferred from request object
-   * @param {string} params.pathname - wallet callback pathname
-   * @param {string} params.token - action token
-   * @param {object} params.query - params that should be persisted in wallet callback url
-   * @returns {string}
-   */
-  uri({
-    baseUrl,
-    pathname,
-    token,
-    query
-  }?: {
-    baseUrl?: string;
-    pathname?: string;
-    token?: string;
-    query?: Record<string, any>;
-  }): string;
-  /**
-   * Compute public url to return to wallet
-   *
-   * @method
-   * @param {string} pathname
-   * @param {object} params
-   * @returns {string}
-   */
-  getPublicUrl(pathname: string, params?: Record<string, any>, baseUrl?: string): string;
-  /**
-   * Sign a plain response, usually on auth success or error
-   *
-   * @method
-   * @param {object} params
-   * @param {object} params.response - response
-   * @param {string} params.errorMessage - error message, default to empty
-   * @param {string} params.successMessage - success message, default to empty
-   * @param {string} params.nextWorkflow - https://github.com/ArcBlock/ABT-DID-Protocol#concatenate-multiple-workflow
-   * @param {string} params.nextUrl - tell wallet do open this url in webview
-   * @param {object} params.cookies - key-value pairs to be set as cookie before open nextUrl
-   * @param {object} params.storages - key-value pairs to be set as localStorage before open nextUrl
-   * @param {string} baseUrl
-   * @param {object} request
-   * @returns {Promise<object>} { appPk, agentPk, authInfo }
-   */
-  signResponse({
-    response,
-    errorMessage,
-    successMessage,
-    nextWorkflow,
-    nextUrl,
-    cookies,
-    storages
-  }: {
-    response?: any;
-    errorMessage?: string;
-    successMessage?: string;
-    nextWorkflow?: string;
-    nextUrl?: string;
-    cookies?: Record<string, any>;
-    storages?: any;
-  }, baseUrl: string, request: any, extraParams?: Record<string, any>): Promise<any>;
-  /**
-   * Sign a auth response that returned to wallet: tell the wallet the appInfo/chainInfo
-   *
-   * @method
-   * @param {object} params
-   * @param {object} params.claims - info required by application to complete the auth
-   * @param {string} params.pathname - pathname to assemble callback url
-   * @param {string} params.baseUrl - baseUrl
-   * @param {object} params.challenge - random challenge to be included in the body
-   * @param {object} params.extraParams - extra query params and locale
-   * @param {object} params.request
-   * @param {object} params.context
-   * @param {string} params.context.token - action token
-   * @param {number} params.context.currentStep - current step
-   * @param {string} [params.context.sharedKey] - shared key between app and wallet
-   * @param {string} [params.context.encryptionKey] - encryption key from wallet
-   * @param {Function} [params.context.mfaCode] - function used to generate mfa code
-   * @param {string} params.context.userDid - decoded from req.query, base58
-   * @param {string} params.context.userPk - decoded from req.query, base58
-   * @param {string} params.context.didwallet - DID Wallet os and version
-   * @returns {Promise<object>} { appPk, agentPk, sharedKey, authInfo }
-   */
-  sign({
-    context,
-    request,
-    claims,
-    pathname,
-    baseUrl,
-    challenge,
-    extraParams
-  }: {
-    context: any;
-    request: any;
-    claims: any;
-    pathname?: string;
-    baseUrl?: string;
-    challenge?: string;
-    extraParams?: Record<string, any>;
-  }): Promise<any>;
-  /**
-   * Determine chainInfo on the fly
-   *
-   * @param {object} params - contains the context of this request
-   * @param {object|undefined} [info=undefined] - chain info object or function
-   * @returns {Promise<ChainInfo>}
-   * @memberof WalletAuthenticator
-   */
-  getChainInfo(params: any, info?: any): Promise<ChainInfo>;
-  /**
-   * Determine appInfo/memberAppInfo on the fly
-   *
-   * @param {object} params - contains the context of this request
-   * @param {string} key - appInfo | memberAppInfo
-   * @returns {Promise<ApplicationInfo>}
-   * @memberof WalletAuthenticator
-   */
-  getAppInfo(params: any, key?: 'appInfo' | 'memberAppInfo'): Promise<any>;
-  getWalletInfo(params: any): Promise<any>;
-  getDelegator(params: any): Promise<any>;
-  getDelegation(params: any): Promise<any>;
-  /**
-   * Verify a DID auth response sent from DID Wallet
-   *
-   * @method
-   * @param {object} data
-   * @param {string} [locale=en]
-   * @param {boolean} [enforceTimestamp=true]
-   * @returns Promise<boolean>
-   */
-  verify(data: any, locale?: string, enforceTimestamp?: boolean): Promise<{
-    token: any;
-    userDid: string;
-    userPk: any;
-    claims: any;
-    action: any;
-    challenge: any;
-    timestamp: string;
-  }>;
-  genRequestedClaims({
-    claims,
-    context,
-    extraParams
-  }: {
-    claims: any;
-    context: any;
-    extraParams: Record<string, any>;
-  }): Promise<any[]>;
-  getClaimInfo({
-    claim,
-    context,
-    extraParams
-  }: {
-    claim: any;
-    context: any;
-    extraParams: Record<string, any>;
-  }): Promise<any>;
-  signature({
-    claim,
-    context,
-    extraParams
-  }: {
-    claim: any;
-    context: any;
-    extraParams: Record<string, any>;
-  }): Promise<{
-    type: string;
-    description: any;
-    origin: string;
-    typeUrl: any;
-    display: string;
-    method: any;
-    digest: any;
-    chainInfo: any;
-    meta: any;
-    mfa: any;
-    nonce: any;
-    requirement: any;
-  }>;
-  prepareTx({
-    claim,
-    context,
-    extraParams
-  }: {
-    claim: any;
-    context: any;
-    extraParams: Record<string, any>;
-  }): Promise<{
-    type: string;
-    description: any;
-    partialTx: string;
-    display: string;
-    requirement: any;
-    chainInfo: any;
-    meta: any;
-    mfa: any;
-    nonce: any;
-  }>;
-  _validateAppInfo(info: any, allowEmpty?: boolean): any;
-  _isValidChainInfo(x: any): boolean;
-  tryWithTimeout<T>(asyncFn: () => Promise<T>, label?: string): Promise<T>;
-}
-//#endregion
-export { ApplicationInfo, ChainInfo, WalletAuthenticatorConfig, WalletAuthenticator as default };

package/lib/did/did-connect/package.cjs

@@ -1,121 +0,0 @@
-const require_rolldown_runtime = require('../../_virtual/rolldown_runtime.cjs');
-
-//#region package.json
-var require_package = /* @__PURE__ */ require_rolldown_runtime.__commonJSMin(((exports, module) => {
-	module.exports = {
-		"name": "@arcblock/did-connect-js",
-		"description": "Helper function to setup DID Connect support on a node.js web server",
-		"type": "module",
-		"version": "1.20.2",
-		"author": {
-			"name": "wangshijun",
-			"email": "shijun@arcblock.io",
-			"url": "https://github.com/wangshijun"
-		},
-		"contributors": ["wangshijun <shijun@arcblock.io> (https://github.com/wangshijun)"],
-		"bugs": {
-			"url": "https://github.com/ArcBlock/blockchain/issues",
-			"email": "shijun@arcblock.io"
-		},
-		"publishConfig": { "access": "public" },
-		"dependencies": {
-			"@arcblock/did": "workspace:*",
-			"@arcblock/jwt": "workspace:*",
-			"@arcblock/validator": "workspace:*",
-			"@ocap/client": "workspace:*",
-			"@ocap/mcrypto": "workspace:*",
-			"@ocap/util": "workspace:*",
-			"@ocap/wallet": "workspace:*",
-			"cors": "^2.8.5",
-			"debug": "^4.4.3",
-			"json-stable-stringify": "^1.0.1",
-			"lodash": "^4.17.23",
-			"tweetnacl-sealedbox-js": "^1.2.0"
-		},
-		"devDependencies": {
-			"@arcblock/did-agent-storage-memory": "^1.8.0",
-			"@arcblock/did-connect-storage-memory": "^1.8.0",
-			"@ocap/e2e-test": "workspace:*",
-			"@types/cors": "^2.8.17",
-			"@types/debug": "^4.1.12",
-			"@types/json-stable-stringify": "^1.0.36",
-			"@types/lodash": "^4.17.13",
-			"@types/node": "^22.7.5",
-			"axios": "^1.13.4",
-			"remark-cli": "^10.0.1",
-			"remark-preset-github": "^4.0.4",
-			"hono": "^4.7.0",
-			"tsdown": "^0.18.4",
-			"tweetnacl": "^1.0.3"
-		},
-		"remarkConfig": { "plugins": ["preset-github", [{ "repository": "ArcBlock/blockchain" }]] },
-		"homepage": "https://www.arcblock.io/docs/did-connect-sdk",
-		"keywords": [
-			"blockchain",
-			"arcblock",
-			"sdk",
-			"nodejs"
-		],
-		"license": "Apache-2.0",
-		"sideEffects": false,
-		"main": "./lib/index.cjs",
-		"module": "./esm/index.mjs",
-		"types": "./esm/index.d.mts",
-		"exports": {
-			".": {
-				"types": "./esm/index.d.mts",
-				"import": "./esm/index.mjs",
-				"default": "./lib/index.cjs"
-			},
-			"./lib/schema": {
-				"types": "./esm/schema/index.d.mts",
-				"import": "./esm/schema/index.mjs",
-				"default": "./lib/schema/index.cjs"
-			},
-			"./lib/schema/*": {
-				"types": "./esm/schema/*.d.mts",
-				"import": "./esm/schema/*.mjs",
-				"default": "./lib/schema/*.cjs"
-			},
-			"./lib/*.js": {
-				"types": "./esm/*.d.mts",
-				"import": "./esm/*.mjs",
-				"default": "./lib/*.cjs"
-			},
-			"./lib/*": {
-				"types": "./esm/*.d.mts",
-				"import": "./esm/*.mjs",
-				"default": "./lib/*.cjs"
-			}
-		},
-		"files": ["lib", "esm"],
-		"repository": {
-			"type": "git",
-			"url": "https://github.com/ArcBlock/blockchain/tree/master/did/did-connect"
-		},
-		"scripts": {
-			"lint": "biome check",
-			"lint:fix": "biome check --write",
-			"docs": "bun run gen-dts && bun run gen-docs && bun run cleanup-docs && bun run format-docs",
-			"cleanup-docs": "node ../../scripts/cleanup-docs.js docs/README.md $npm_package_name",
-			"gen-docs": "jsdoc2md lib/**/*.js lib/**/**/*.js > docs/README.md",
-			"gen-dts": "j2d lib/index.js",
-			"format-docs": "remark . -o",
-			"test": "bun test",
-			"coverage": "npm run test -- --coverage",
-			"build": "tsdown",
-			"build:watch": "tsdown -w",
-			"clean": "rm -rf lib esm"
-		},
-		"resolutions": { "tweetnacl": "1.0.3" },
-		"gitHead": "87990c8b5e215107fc587c1ced0d6b3e2cd2483e"
-	};
-}));
-
-//#endregion
-Object.defineProperty(exports, 'default', {
-  enumerable: true,
-  get: function () {
-    return require_package();
-  }
-});

package/lib/handlers/base.cjs

@@ -1,40 +0,0 @@
-Object.defineProperty(exports, '__esModule', { value: true });
-const require_rolldown_runtime = require('../_virtual/rolldown_runtime.cjs');
-const require_protocol = require('../protocol.cjs');
-let node_events = require("node:events");
-let lodash_omit = require("lodash/omit");
-lodash_omit = require_rolldown_runtime.__toESM(lodash_omit);
-
-//#region src/handlers/base.ts
-var BaseHandler = class extends node_events.EventEmitter {
-	/**
-	* Creates an instance of DID Auth Handlers.
-	*
-	* @class
-	* @param {object} config
-	* @param {function} config.pathTransformer - function to transform path when generate action;
-	* @param {object} config.tokenStorage - function to generate action token
-	* @param {object} config.authenticator - Authenticator instance that can to jwt sign/verify
-	* @param {function} [config.onConnect=noop] - function called when wallet selected did
-	*/
-	constructor({ pathTransformer, tokenStorage, authenticator, onConnect }) {
-		super();
-		this.authenticator = authenticator;
-		this.tokenStorage = tokenStorage;
-		this.tokenStorage.on("create", (data) => this.emit("created", data));
-		this.tokenStorage.on("destroy", (token) => this.emit("deleted", { token }));
-		this.tokenStorage.on("update", async (data) => {
-			if (!data) return;
-			const payload = await this.tokenStorage.read(data.token);
-			this.emit("updated", (0, lodash_omit.default)(payload, require_protocol.PROTECTED_KEYS));
-		});
-		if (typeof pathTransformer === "function") this.pathTransformer = pathTransformer;
-		else this.pathTransformer = (v) => v;
-		if (typeof onConnect === "function") this.onConnect = onConnect;
-		else this.onConnect = () => {};
-	}
-};
-var base_default = BaseHandler;
-
-//#endregion
-exports.default = base_default;

package/lib/handlers/base.d.cts

@@ -1,32 +0,0 @@
-import { EventEmitter } from "node:events";
-
-//#region src/handlers/base.d.ts
-declare class BaseHandler extends EventEmitter {
-  authenticator: any;
-  tokenStorage: any;
-  pathTransformer: (v: string) => string;
-  onConnect: (...args: any[]) => any;
-  /**
-   * Creates an instance of DID Auth Handlers.
-   *
-   * @class
-   * @param {object} config
-   * @param {function} config.pathTransformer - function to transform path when generate action;
-   * @param {object} config.tokenStorage - function to generate action token
-   * @param {object} config.authenticator - Authenticator instance that can to jwt sign/verify
-   * @param {function} [config.onConnect=noop] - function called when wallet selected did
-   */
-  constructor({
-    pathTransformer,
-    tokenStorage,
-    authenticator,
-    onConnect
-  }: {
-    pathTransformer?: (v: string) => string;
-    tokenStorage: any;
-    authenticator: any;
-    onConnect?: (...args: any[]) => any;
-  });
-}
-//#endregion
-export { BaseHandler as default };