@did-btcr2/cli 0.1.0 → 0.1.2

package/dist/types/src/cli.d.ts

@@ -0,0 +1,113 @@
+import { Command } from 'commander';
+/**
+ * CLI tool for the did:btcr2 method.
+ * @type {DidBtcr2Cli}
+ * @class DidBtcr2Cli
+ */
+export declare class DidBtcr2Cli {
+    readonly program: Command;
+    constructor();
+    /**
+     * Configures the CLI commands.
+     * @returns {void}
+     */
+    private configureCommands;
+    /**
+     * Invokes a command with the provided request.
+     * @param {object} request The command request
+     * @param {any} request.options The command options
+     * @param {CommandRequest['action']} request.action The command action
+     * @param {Btcr2Command} request.command The command instance
+     * @returns {Promise<CommandResult>} The command result
+     */
+    private invokeCommand;
+    /**
+     * Runs the CLI with the provided argv or process.argv.
+     * @param {string[]} [argv] The argv array to use. Defaults to process.argv.
+     */
+    run(argv?: string[]): Promise<void>;
+    /**
+     * Normalizes argv to ensure it has at least two elements.
+     * @param {string[]} argv The argv array to normalize
+     * @returns {string[]} Normalized argv array
+     */
+    private normalizeArgv;
+    /**
+     * Handles errors thrown during CLI execution.
+     * @param {unknown} error The error to handle
+     * @returns {void}
+     */
+    private handleError;
+    /**
+     * Parses create command options and throws CLIError on invalid input.
+     * @param {object} options The create command options
+     * @param {string} options.type The identifier type
+     * @param {string} options.network The bitcoin network
+     * @param {string} options.bytes The genesis bytes as a hex string
+     * @returns {CreateCommandOptions} The parsed create command options
+     */
+    private parseCreateOptions;
+    /**
+     * Parses resolve command options and throws CLIError on invalid input.
+     * @param {object} options The resolve command options
+     * @param {string} options.identifier The did:btcr2 identifier
+     * @param {string} [options.resolutionOptions] JSON string of resolution options
+     * @param {string} [options.resolutionOptionsPath] Path to a JSON file of resolution options
+     * @returns {Promise<ResolveCommandOptions>} The parsed resolve command options
+     */
+    private parseResolveOptions;
+    /**
+     * Parses update command options and throws CLIError on invalid input.
+     * @param {object} options The update command options
+     * @param {string} options.identifier The did:btcr2 identifier
+     * @param {string} options.sourceDocument The source DID document as a JSON string
+     * @param {number} options.sourceVersionId The source version ID as a number
+     * @param {string} options.patch The JSON Patch operations as a JSON string array
+     * @param {string} options.verificationMethodId The DID document verification method ID as a string
+     * @param {string} options.beaconIds The beacon IDs as a JSON string array
+     * @returns {UpdateCommandOptions} The parsed update command options
+     */
+    private parseUpdateOptions;
+    /**
+     * Parses a JSON option and throws a CLIError on failure.
+     * @param {string} value JSON string to parse
+     * @param {string} errorMessage Error message to use on failure
+     * @param {Record<string, any>} data Additional data to include in the error
+     * @returns {T} Parsed JSON object
+     */
+    private parseJsonOption;
+    /**
+     * Parses resolution options from JSON string or file path.
+     * @param {object} options The options containing resolution options
+     * @param {string} [options.resolutionOptions] JSON string of resolution options
+     * @param {string} [options.resolutionOptionsPath] Path to a JSON file of resolution options
+     * @returns {Promise<any>} The parsed resolution options
+     */
+    private parseResolutionOptions;
+    /**
+     * Validates the did:btcr2 identifier format.
+     * @param {string} identifier The identifier to validate
+     * @param {Record<string, any>} data Additional data to include in the error
+     * @returns {void}
+     */
+    private validateIdentifier;
+    /**
+     * Validates if the provided network is supported.
+     * @param {string} network The network to validate
+     * @returns {boolean} True if the network is valid
+     */
+    private isNetworkValid;
+    /**
+     * Prints the command result to the console.
+     * @param {CommandResult} result The command result to print
+     * @returns {void}
+     */
+    private printResult;
+    /**
+     * Logs a payload to the console, formatting objects as JSON.
+     * @param {unknown} payload The payload to log
+     * @returns {void}
+     */
+    private log;
+}
+//# sourceMappingURL=cli.d.ts.map

package/dist/types/src/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../../src/cli.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAkB,MAAM,WAAW,CAAC;AAcpD;;;;GAIG;AACH,qBAAa,WAAW;IACtB,SAAgB,OAAO,EAAE,OAAO,CAAC;;IAUjC;;;OAGG;IACH,OAAO,CAAC,iBAAiB;IAsEzB;;;;;;;OAOG;YACW,aAAa;IAQ3B;;;OAGG;IACU,GAAG,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE;IAUhC;;;;OAIG;IACH,OAAO,CAAC,aAAa;IAMrB;;;;OAIG;IACH,OAAO,CAAC,WAAW;IAanB;;;;;;;OAOG;IACH,OAAO,CAAC,kBAAkB;IA6B1B;;;;;;;OAOG;YACW,mBAAmB;IAajC;;;;;;;;;;OAUG;IACH,OAAO,CAAC,kBAAkB;IAmC1B;;;;;;OAMG;IACH,OAAO,CAAC,eAAe;IAYvB;;;;;;OAMG;YACW,sBAAsB;IAmBpC;;;;;OAKG;IACH,OAAO,CAAC,kBAAkB;IAY1B;;;;OAIG;IACH,OAAO,CAAC,cAAc;IAItB;;;;OAIG;IACH,OAAO,CAAC,WAAW;IAqBnB;;;;OAIG;IACH,OAAO,CAAC,GAAG;CAOZ"}

package/dist/types/src/command.d.ts

@@ -0,0 +1,55 @@
+import { PatchOperation } from '@did-btcr2/common';
+import { DidDocument, DidResolutionOptions, DidResolutionResult, SignalsMetadata } from '@did-btcr2/method';
+export type NetworkOption = 'bitcoin' | 'testnet3' | 'testnet4' | 'signet' | 'mutinynet' | 'regtest';
+export interface CommandInterface {
+    execute(request: CommandRequest): Promise<CommandResult>;
+}
+export interface CreateCommandOptions {
+    type: 'k' | 'x';
+    bytes: string;
+    network: NetworkOption;
+}
+export interface ResolveCommandOptions {
+    identifier: string;
+    options?: DidResolutionOptions;
+}
+export interface UpdateCommandOptions {
+    identifier: string;
+    sourceDocument: DidDocument;
+    sourceVersionId: number;
+    patch: PatchOperation[];
+    verificationMethodId: string;
+    beaconIds: string[];
+}
+export interface DeactivateCommandOptions {
+}
+export type CommandRequest = {
+    action: 'create';
+    options: CreateCommandOptions;
+} | {
+    action: 'resolve' | 'read';
+    options: ResolveCommandOptions;
+} | {
+    action: 'update';
+    options: UpdateCommandOptions;
+} | {
+    action: 'deactivate' | 'delete';
+    options: DeactivateCommandOptions;
+};
+export type CommandResult = {
+    action: 'create';
+    did: string;
+} | {
+    action: 'resolve' | 'read';
+    resolution: DidResolutionResult;
+} | {
+    action: 'update';
+    metadata: SignalsMetadata;
+} | {
+    action: 'deactivate' | 'delete';
+    message: string;
+};
+export default class Btcr2Command implements CommandInterface {
+    execute(request: CommandRequest): Promise<CommandResult>;
+}
+//# sourceMappingURL=command.d.ts.map

package/dist/types/src/command.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"command.d.ts","sourceRoot":"","sources":["../../../src/command.ts"],"names":[],"mappings":"AAAA,OAAO,EAAwC,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACzF,OAAO,EAAY,WAAW,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEtH,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,QAAQ,GAAG,WAAW,GAAG,SAAS,CAAC;AAErG,MAAM,WAAW,gBAAgB;IAC/B,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;CAC1D;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,GAAG,GAAG,GAAG,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,aAAa,CAAC;CACxB;AAED,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,oBAAoB,CAAC;CAChC;AAED,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,WAAW,CAAC;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,KAAK,EAAE,cAAc,EAAE,CAAC;IACxB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,SAAS,EAAE,MAAM,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,wBAAwB;CAExC;AAED,MAAM,MAAM,cAAc,GACtB;IAAE,MAAM,EAAE,QAAQ,CAAC;IAAC,OAAO,EAAE,oBAAoB,CAAC;CAAE,GACpD;IAAE,MAAM,EAAE,SAAS,GAAG,MAAM,CAAC;IAAC,OAAO,EAAE,qBAAqB,CAAC;CAAE,GAC/D;IAAE,MAAM,EAAE,QAAQ,CAAC;IAAC,OAAO,EAAE,oBAAoB,CAAC;CAAE,GACpD;IAAE,MAAM,EAAE,YAAY,GAAG,QAAQ,CAAC;IAAC,OAAO,EAAE,wBAAwB,CAAC;CAAE,CAAC;AAE5E,MAAM,MAAM,aAAa,GACrB;IAAE,MAAM,EAAE,QAAQ,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;CAAE,GAClC;IAAE,MAAM,EAAE,SAAS,GAAG,MAAM,CAAC;IAAC,UAAU,EAAE,mBAAmB,CAAC;CAAE,GAChE;IAAE,MAAM,EAAE,QAAQ,CAAC;IAAC,QAAQ,EAAE,eAAe,CAAC;CAAE,GAChD;IAAE,MAAM,EAAE,YAAY,GAAG,QAAQ,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;CAAE,CAAC;AAE1D,MAAM,CAAC,OAAO,OAAO,YAAa,YAAW,gBAAgB;IACrD,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC;CA8B/D"}

package/dist/types/src/error.d.ts

@@ -0,0 +1,8 @@
+import { DidMethodError } from '@did-btcr2/common';
+/**
+ * Custom CLI Error class extending DidMethodError.
+ */
+export declare class CLIError extends DidMethodError {
+    constructor(message: string, type?: string, data?: Record<string, any>);
+}
+//# sourceMappingURL=error.d.ts.map

package/dist/types/src/error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../../src/error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAEnD;;GAEG;AACH,qBAAa,QAAS,SAAQ,cAAc;gBAC9B,OAAO,EAAE,MAAM,EAAE,IAAI,GAAE,MAAmB,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAGnF"}

package/dist/types/src/index.d.ts

@@ -0,0 +1,4 @@
+export * from './cli.js';
+export * from './command.js';
+export * from './error.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC"}

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@did-btcr2/cli",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "type": "module",
   "description": "CLI for interacting with did-btcr2-js, the JavaScript/TypeScript reference implementation of the did:btcr2 method. Exposes various parts of multiple packages in the did-btcr2-js monorepo.",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
   "types": "./dist/types/index.d.ts",
   "bin": {
-    "btcr2": "./dist/esm/cli.js"
+    "btcr2": "./dist/esm/bin/btcr2.js"
   },
   "exports": {
     ".": {
@@ -58,7 +58,7 @@
   "dependencies": {
     "commander": "^13.1.0",
     "@did-btcr2/common": "2.2.2",
-    "@did-btcr2/method": "0.18.0"
+    "@did-btcr2/method": "0.18.1"
   },
   "devDependencies": {
     "@eslint/js": "^9.21.0",
@@ -86,27 +86,22 @@
     "typescript-eslint": "^8.25.0"
   },
   "scripts": {
-    "clean": "rimraf dist coverage tests/compiled",
-    "wipe": "rimraf node_modules pnpm-lock.json",
-    "wipe:clean": "pnpm wipe && pnpm clean",
-    "wipe:install": "pnpm wipe && pnpm install",
-    "clean:install": "pnpm clean && pnpm install",
-    "wipe:clean:install": "pnpm wipe:clean && pnpm install",
+    "clean:build": "rimraf dist",
+    "clean:tests": "rimraf coverage tests/compiled",
+    "clean:deps": "rimraf node_modules pnpm-lock.json",
+    "clean": "pnpm clean:build && pnpm clean:tests",
+    "wipe": "pnpm clean && pnpm clean:deps",
     "reinstall": "pnpm install --force",
-    "build": "pnpm clean && pnpm build:esm && pnpm build:cjs",
+    "build": "pnpm clean:build && pnpm build:esm && pnpm build:cjs",
     "build:esm": "rimraf dist/esm dist/types && pnpm tsc -p tsconfig.json",
     "build:cjs": "rimraf dist/cjs && tsc -p tsconfig.cjs.json && echo '{\"type\": \"commonjs\"}' > ./dist/cjs/package.json",
-    "build:tests": "pnpm tsc -p tests/tsconfig.json",
+    "build:tests": "pnpm clean:tests && pnpm tsc -p tests/tsconfig.json",
     "build:all": "pnpm build && pnpm build:tests",
-    "release": "pnpm build && pnpm pack && mv *.tgz ../../release/cli",
     "lint": "eslint . --max-warnings 0",
     "lint:fix": "eslint . --fix",
-    "test": "pnpm c8 --omit-relative mocha",
-    "build:test": "pnpm build && pnpm build:tests && pnpm c8 --omit-relative mocha",
-    "build:lint:test": "pnpm build && pnpm build:tests && pnpm lint:fix",
-    "prepublish": "pnpm build",
-    "version": "pnpm version",
-    "version:no-git": "pnpm version --no-commit-hooks --no-git-tag-version",
-    "version:new": "[ -z \"$NEW_VERSION\" ] && echo 'ERROR: NEW_VERSION is not set' && exit 1 || (git checkout -b $NEW_VERSION && git tag $NEW_VERSION && pnpm version:no-git $NEW_VERSION)"
+    "test": "pnpm c8 mocha",
+    "build:test": "pnpm build && pnpm build:tests && pnpm c8 mocha",
+    "build:lint": "pnpm build && pnpm build:tests && pnpm lint:fix",
+    "prepublish": "pnpm build"
   }
 }