@arcblock/did-connect-js 1.29.23 → 4.0.0-beta.1

package/lib/handlers/util.d.cts

@@ -1,70 +0,0 @@
-import { ConnectRequest, ConnectResponse, NextFunction } from "../types.cjs";
-
-//#region src/handlers/util.d.ts
-declare const errors: Record<string, Record<string, string>>;
-declare const preparePathname: (path: string, req: ConnectRequest) => string;
-declare const prepareBaseUrl: (req: ConnectRequest, params?: Record<string, any>) => string;
-declare const getStepChallenge: () => any;
-declare const parseWalletUA: (userAgent: string) => {
-  os: string;
-  version: string;
-  jwt: string;
-};
-declare const isDeepLink: (str: string) => boolean;
-declare const isConnectedOnly: (params: any, sessionUserDid?: string) => boolean | string;
-interface CreateHandlersOptions {
-  action: string;
-  pathname: string;
-  claims: any;
-  onStart: (...args: any[]) => any;
-  onConnect: (...args: any[]) => any;
-  onAuth: (...args: any[]) => any;
-  onDecline: (...args: any[]) => any;
-  onComplete: (...args: any[]) => any;
-  onExpire: (...args: any[]) => any;
-  onError: (...args: any[]) => any;
-  pathTransformer: (v: string) => string;
-  tokenStorage: any;
-  authenticator: any;
-  authPrincipal: any;
-  persistentDynamicClaims?: boolean;
-  getSignParams?: (req: ConnectRequest) => any;
-  getPathName?: (pathname: string, req: ConnectRequest) => string;
-  options: {
-    tokenKey: string;
-    encKey: string;
-    versionKey: string;
-    cleanupDelay: number;
-  };
-}
-declare function createHandlers({
-  action,
-  pathname,
-  claims,
-  onStart,
-  onConnect,
-  onAuth,
-  onDecline,
-  onComplete,
-  onExpire,
-  onError,
-  pathTransformer,
-  tokenStorage,
-  authenticator,
-  authPrincipal,
-  persistentDynamicClaims,
-  getSignParams,
-  getPathName,
-  options
-}: CreateHandlersOptions): {
-  generateSession: (req: ConnectRequest, res: ConnectResponse) => Promise<void>;
-  expireSession: (req: ConnectRequest, res: ConnectResponse) => Promise<void>;
-  checkSession: (req: ConnectRequest, res: ConnectResponse) => Promise<void>;
-  onAuthRequest: (req: ConnectRequest, res: ConnectResponse) => Promise<void>;
-  onAuthResponse: (req: ConnectRequest, res: ConnectResponse) => Promise<void>;
-  ensureContext: (req: ConnectRequest, _res: ConnectResponse, next: NextFunction) => Promise<void>;
-  ensureSignedJson: (req: ConnectRequest, res: ConnectResponse, next: NextFunction) => void;
-  createExtraParams: (locale: string, params: any, extra?: any) => any;
-};
-//#endregion
-export { CreateHandlersOptions, createHandlers as default, errors, getStepChallenge, isConnectedOnly, isDeepLink, parseWalletUA, prepareBaseUrl, preparePathname };

package/lib/handlers/wallet.cjs

@@ -1,139 +0,0 @@
-Object.defineProperty(exports, '__esModule', { value: true });
-const require_package$1 = require('../package.cjs');
-const require_adapters_detect = require('../adapters/detect.cjs');
-const require_adapters_express = require('../adapters/express.cjs');
-const require_adapters_hono = require('../adapters/hono.cjs');
-const require_handlers_base = require('./base.cjs');
-const require_handlers_util = require('./util.cjs');
-
-//#region src/handlers/wallet.ts
-const debug = require("debug")(`${require_package$1.default.name}:handlers:wallet`);
-const noop = () => {};
-/**
-* Events that are emitted during an DID Connect process
-*
-*  - scanned: when the qrcode is scanned by wallet
-*  - succeed: when authentication complete
-*  - error: when something goes wrong
-*
-* @class WalletHandlers
-* @extends {EventEmitter}
-*/
-var WalletHandlers = class extends require_handlers_base.default {
-	/**
-	* Creates an instance of DID Auth Handlers.
-	*
-	* @class
-	* @param {object} config
-	* @param {object} config.tokenStorage - function to generate action token
-	* @param {object} config.authenticator - Authenticator instance that can to jwt sign/verify
-	* @param {function} [config.pathTransformer=null] - how should we update pathname
-	* @param {function} [config.onConnect=noop] - function called before each auth request send back to app, used to check for permission, throw error to halt the auth process
-	* @param {object} [config.options={}] - custom options to define all handlers attached
-	* @param {string} [config.options.prefix='/api/did'] - url prefix for this group endpoints
-	* @param {number} [config.options.cleanupDelay=60000] - how long to wait before cleanup finished session
-	* @param {string} [config.options.tokenKey='_t_'] - query param key for `token`
-	* @param {string} [config.options.encKey='_ek_'] - query param key for encryption key
-	* @param {string} [config.options.versionKey='_v_'] - query param key for protocol `version`
-	*/
-	constructor({ pathTransformer, tokenStorage, authenticator, onConnect = noop, options = {} }) {
-		super({
-			pathTransformer,
-			tokenStorage,
-			authenticator,
-			onConnect
-		});
-		this.options = {
-			prefix: "/api/did",
-			cleanupDelay: 6e4,
-			tokenKey: "_t_",
-			encKey: "_ek_",
-			versionKey: "_v_",
-			...options
-		};
-	}
-	/**
-	* Attach routes and handlers for authenticator
-	* Now express app have route handlers attached to the following url
-	* - `GET /api/did/{action}/token` create new token
-	* - `GET /api/did/{action}/status` check for token status
-	* - `GET /api/did/{action}/timeout` expire a token
-	* - `GET /api/did/{action}/auth` create auth response
-	* - `POST /api/did/{action}/auth` process payment request
-	*
-	* @method
-	* @param {object} config
-	* @param {object} config.app - express instance to attach routes to
-	* @param {object} [config.claims] - claims for this request
-	* @param {string} config.action - action of this group of routes
-	* @param {function} [config.onStart=noop] - callback when a new action start
-	* @param {function} [config.onConnect=noop] - callback when a new action start
-	* @param {function} config.onAuth - callback when user completed auth in DID Wallet, and data posted back
-	* @param {function} [config.onDecline=noop] - callback when user has declined in wallet
-	* @param {function} [config.onComplete=noop] - callback when the whole auth process is done, action token is removed
-	* @param {function} [config.onExpire=noop] - callback when the action token expired
-	* @param {function} [config.onError=console.error] - callback when there are some errors
-	* @param {boolean|string|did} [config.authPrincipal=true] - whether should we do auth principal claim first
-	* @param {boolean} [config.persistentDynamicClaims=false] - whether should we persist dynamic claims
-	* @return void
-	*/
-	attach({ app, action, claims = void 0, onStart = noop, onConnect, onAuth, onDecline = noop, onComplete = noop, onExpire = noop, onError = console.error, authPrincipal = true, persistentDynamicClaims = false }) {
-		if (typeof onAuth !== "function") throw new Error("onAuth callback is required to attach did auth handlers");
-		if (typeof onDecline !== "function") throw new Error("onDecline callback is required to attach did auth handlers");
-		if (typeof onComplete !== "function") throw new Error("onComplete callback is required to attach did auth handlers");
-		const { prefix } = this.options;
-		const pathname = `${prefix}/${action}/auth`;
-		debug("attach routes", {
-			action,
-			prefix,
-			pathname
-		});
-		const onConnectWrapped = async (...args) => {
-			if (typeof this.onConnect === "function") await this.onConnect(...args);
-			if (typeof onConnect === "function") return onConnect(...args);
-		};
-		const { generateSession, expireSession, checkSession, onAuthRequest, onAuthResponse, ensureContext, ensureSignedJson } = require_handlers_util.default({
-			action,
-			pathname,
-			claims,
-			onStart,
-			onConnect: onConnectWrapped,
-			onAuth,
-			onDecline,
-			onComplete,
-			onExpire,
-			onError,
-			authPrincipal,
-			persistentDynamicClaims,
-			options: this.options,
-			pathTransformer: this.pathTransformer,
-			tokenStorage: this.tokenStorage,
-			authenticator: this.authenticator
-		});
-		const handlerFns = {
-			generateSession,
-			checkSession,
-			expireSession,
-			onAuthRequest,
-			onAuthResponse,
-			ensureContext,
-			ensureSignedJson
-		};
-		if (require_adapters_detect.isHonoApp(app)) return require_adapters_hono.attachHono({
-			app,
-			prefix,
-			action,
-			handlers: handlerFns
-		});
-		return require_adapters_express.attachExpress({
-			app,
-			prefix,
-			action,
-			handlers: handlerFns
-		});
-	}
-};
-var wallet_default = WalletHandlers;
-
-//#endregion
-exports.default = wallet_default;

package/lib/handlers/wallet.d.cts

@@ -1,119 +0,0 @@
-import { ConnectRequest, ConnectResponse } from "../types.cjs";
-import BaseHandler from "./base.cjs";
-
-//#region src/handlers/wallet.d.ts
-
-/**
- * Events that are emitted during an DID Connect process
- *
- *  - scanned: when the qrcode is scanned by wallet
- *  - succeed: when authentication complete
- *  - error: when something goes wrong
- *
- * @class WalletHandlers
- * @extends {EventEmitter}
- */
-declare class WalletHandlers extends BaseHandler {
-  options: {
-    prefix: string;
-    cleanupDelay: number;
-    tokenKey: string;
-    encKey: string;
-    versionKey: string;
-  };
-  /**
-   * Creates an instance of DID Auth Handlers.
-   *
-   * @class
-   * @param {object} config
-   * @param {object} config.tokenStorage - function to generate action token
-   * @param {object} config.authenticator - Authenticator instance that can to jwt sign/verify
-   * @param {function} [config.pathTransformer=null] - how should we update pathname
-   * @param {function} [config.onConnect=noop] - function called before each auth request send back to app, used to check for permission, throw error to halt the auth process
-   * @param {object} [config.options={}] - custom options to define all handlers attached
-   * @param {string} [config.options.prefix='/api/did'] - url prefix for this group endpoints
-   * @param {number} [config.options.cleanupDelay=60000] - how long to wait before cleanup finished session
-   * @param {string} [config.options.tokenKey='_t_'] - query param key for `token`
-   * @param {string} [config.options.encKey='_ek_'] - query param key for encryption key
-   * @param {string} [config.options.versionKey='_v_'] - query param key for protocol `version`
-   */
-  constructor({
-    pathTransformer,
-    tokenStorage,
-    authenticator,
-    onConnect,
-    options
-  }: {
-    pathTransformer?: (v: string) => string;
-    tokenStorage: any;
-    authenticator: any;
-    onConnect?: (...args: any[]) => any;
-    options?: Partial<{
-      prefix: string;
-      cleanupDelay: number;
-      tokenKey: string;
-      encKey: string;
-      versionKey: string;
-    }>;
-  });
-  /**
-   * Attach routes and handlers for authenticator
-   * Now express app have route handlers attached to the following url
-   * - `GET /api/did/{action}/token` create new token
-   * - `GET /api/did/{action}/status` check for token status
-   * - `GET /api/did/{action}/timeout` expire a token
-   * - `GET /api/did/{action}/auth` create auth response
-   * - `POST /api/did/{action}/auth` process payment request
-   *
-   * @method
-   * @param {object} config
-   * @param {object} config.app - express instance to attach routes to
-   * @param {object} [config.claims] - claims for this request
-   * @param {string} config.action - action of this group of routes
-   * @param {function} [config.onStart=noop] - callback when a new action start
-   * @param {function} [config.onConnect=noop] - callback when a new action start
-   * @param {function} config.onAuth - callback when user completed auth in DID Wallet, and data posted back
-   * @param {function} [config.onDecline=noop] - callback when user has declined in wallet
-   * @param {function} [config.onComplete=noop] - callback when the whole auth process is done, action token is removed
-   * @param {function} [config.onExpire=noop] - callback when the action token expired
-   * @param {function} [config.onError=console.error] - callback when there are some errors
-   * @param {boolean|string|did} [config.authPrincipal=true] - whether should we do auth principal claim first
-   * @param {boolean} [config.persistentDynamicClaims=false] - whether should we persist dynamic claims
-   * @return void
-   */
-  attach({
-    app,
-    action,
-    claims,
-    onStart,
-    onConnect,
-    onAuth,
-    onDecline,
-    onComplete,
-    onExpire,
-    onError,
-    authPrincipal,
-    persistentDynamicClaims
-  }: {
-    app: any;
-    action: string;
-    claims?: any;
-    onStart?: (...args: any[]) => any;
-    onConnect?: (...args: any[]) => any;
-    onAuth: (...args: any[]) => any;
-    onDecline?: (...args: any[]) => any;
-    onComplete?: (...args: any[]) => any;
-    onExpire?: (...args: any[]) => any;
-    onError?: (...args: any[]) => any;
-    authPrincipal?: boolean | string | any;
-    persistentDynamicClaims?: boolean;
-  }): {
-    generateSession: (req: ConnectRequest, res: ConnectResponse) => Promise<void>;
-    expireSession: (req: ConnectRequest, res: ConnectResponse) => Promise<void>;
-    checkSession: (req: ConnectRequest, res: ConnectResponse) => Promise<void>;
-    onAuthRequest: (req: ConnectRequest, res: ConnectResponse) => Promise<void>;
-    onAuthResponse: (req: ConnectRequest, res: ConnectResponse) => Promise<void>;
-  };
-}
-//#endregion
-export { WalletHandlers as default };

package/lib/index.cjs

@@ -1,16 +0,0 @@
-const require_authenticator_wallet = require('./authenticator/wallet.cjs');
-const require_adapters_detect = require('./adapters/detect.cjs');
-const require_adapters_express = require('./adapters/express.cjs');
-const require_adapters_hono = require('./adapters/hono.cjs');
-const require_handlers_wallet = require('./handlers/wallet.cjs');
-const require_storage_kv = require('./storage/kv.cjs');
-
-exports.CloudflareKVStorage = require_storage_kv.default;
-exports.WalletAuthenticator = require_authenticator_wallet.default;
-exports.WalletHandlers = require_handlers_wallet.default;
-exports.attachExpress = require_adapters_express.attachExpress;
-exports.attachHono = require_adapters_hono.attachHono;
-exports.createHonoRequest = require_adapters_hono.createHonoRequest;
-exports.createHonoResponse = require_adapters_hono.createHonoResponse;
-exports.isExpressApp = require_adapters_detect.isExpressApp;
-exports.isHonoApp = require_adapters_detect.isHonoApp;

package/lib/index.d.cts

@@ -1,8 +0,0 @@
-import { isExpressApp, isHonoApp } from "./adapters/detect.cjs";
-import { ConnectRequest, ConnectResponse, NextFunction } from "./types.cjs";
-import { attachExpress } from "./adapters/express.cjs";
-import { attachHono, createHonoRequest, createHonoResponse } from "./adapters/hono.cjs";
-import WalletAuthenticator from "./authenticator/wallet.cjs";
-import CloudflareKVStorage from "./storage/kv.cjs";
-import WalletHandlers from "./handlers/wallet.cjs";
-export { CloudflareKVStorage, type ConnectRequest, type ConnectResponse, type NextFunction, WalletAuthenticator, WalletHandlers, attachExpress, attachHono, createHonoRequest, createHonoResponse, isExpressApp, isHonoApp };

package/lib/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/protocol.cjs

@@ -1,46 +0,0 @@
-const require_rolldown_runtime = require('./_virtual/rolldown_runtime.cjs');
-let _ocap_util = require("@ocap/util");
-let _arcblock_jwt = require("@arcblock/jwt");
-let _ocap_mcrypto_lib_crypter_aes = require("@ocap/mcrypto/lib/crypter/aes");
-_ocap_mcrypto_lib_crypter_aes = require_rolldown_runtime.__toESM(_ocap_mcrypto_lib_crypter_aes);
-
-//#region src/protocol.ts
-const VERSION = "1.0.0";
-const decrypt = (data, config = {}, dataKey = "userInfo") => {
-	try {
-		(0, _arcblock_jwt.decode)(data[dataKey]);
-		return data;
-	} catch {}
-	if (config.sharedKey && data.version === VERSION) data[dataKey] = _ocap_mcrypto_lib_crypter_aes.default.decrypt((0, _ocap_util.fromBase58)(data[dataKey]), config.sharedKey, "buffer").toString("utf8");
-	return data;
-};
-const encrypt = (data, config = {}, dataKey = "authInfo") => {
-	const { clientVersion, sharedKey } = config || {};
-	if (data.sensitive && sharedKey && clientVersion === VERSION) {
-		data.version = VERSION;
-		data[dataKey] = _ocap_mcrypto_lib_crypter_aes.default.encrypt(data[dataKey], sharedKey, "base58");
-	}
-	delete data.sensitive;
-	return data;
-};
-const PROTECTED_KEYS = [
-	"challenge",
-	"nonce",
-	"sharedKey",
-	"encryptionKey"
-];
-const SESSION_STATUS = {
-	CREATED: "created",
-	SUCCEED: "succeed",
-	ERROR: "error",
-	BUSY: "busy",
-	SCANNED: "scanned",
-	FORBIDDEN: "forbidden"
-};
-
-//#endregion
-exports.PROTECTED_KEYS = PROTECTED_KEYS;
-exports.SESSION_STATUS = SESSION_STATUS;
-exports.VERSION = VERSION;
-exports.decrypt = decrypt;
-exports.encrypt = encrypt;

package/lib/protocol.d.cts

@@ -1,15 +0,0 @@
-//#region src/protocol.d.ts
-declare const VERSION = "1.0.0";
-declare const decrypt: (data: any, config?: any, dataKey?: string) => any;
-declare const encrypt: (data: any, config?: any, dataKey?: string) => any;
-declare const PROTECTED_KEYS: string[];
-declare const SESSION_STATUS: {
-  readonly CREATED: "created";
-  readonly SUCCEED: "succeed";
-  readonly ERROR: "error";
-  readonly BUSY: "busy";
-  readonly SCANNED: "scanned";
-  readonly FORBIDDEN: "forbidden";
-};
-//#endregion
-export { PROTECTED_KEYS, SESSION_STATUS, VERSION, decrypt, encrypt };