@arcblock/did 1.29.18 → 1.29.20

package/lib/name.d.cts

@@ -0,0 +1,62 @@
+//#region src/name.d.ts
+/**
+ * DID Name Hierarchy Parser
+ *
+ * DNS-style right-to-left name resolution for did:name identifiers.
+ * Supports global names, delegated sub-names, and .local domains.
+ */
+/** Parsed name hierarchy */
+interface NameHierarchy {
+  /** Name segments split by '.' */
+  segments: string[];
+  /** Top-level domain (rightmost segment) */
+  tld: string;
+  /** Whether this is a .local name */
+  isLocal: boolean;
+  /** Whether this is a global name (single segment, not .local) */
+  isGlobal: boolean;
+  /** Number of segments */
+  depth: number;
+}
+/** Resolve route types */
+type ResolveRoute = {
+  type: 'global';
+  name: string;
+} | {
+  type: 'local';
+  name: string;
+} | {
+  type: 'delegated';
+  tld: string;
+  subName: string;
+};
+/**
+ * Parse a name identifier into its hierarchy components.
+ *
+ * @param name - The name to parse (e.g. 'robertmao', 'bob.myorg', 'anything.local')
+ * @returns Parsed hierarchy
+ * @throws If name is invalid
+ */
+declare function parseNameHierarchy(name: unknown): NameHierarchy;
+/**
+ * Determine the resolve route for a name.
+ *
+ * - Single segment (e.g. 'robertmao') → global route
+ * - Ends with '.local' → local route
+ * - Multi-segment (e.g. 'bob.myorg') → delegated route
+ *
+ * @param name - The name to route
+ * @returns The resolve route
+ * @throws If name is invalid
+ */
+declare function getResolveRoute(name: string): ResolveRoute;
+/**
+ * Check if a name is a .local name.
+ */
+declare function isLocalName(name: string): boolean;
+/**
+ * Check if a name is a global name (single segment, not .local).
+ */
+declare function isGlobalName(name: string): boolean;
+//#endregion
+export { NameHierarchy, ResolveRoute, getResolveRoute, isGlobalName, isLocalName, parseNameHierarchy };

package/lib/parse.cjs

@@ -0,0 +1,91 @@
+const require_method = require('./method.cjs');
+
+//#region src/parse.ts
+/**
+* Universal DID Parser
+*
+* Parses, formats, and extracts components from DID strings.
+* Supports all registered methods (abt, afs, aos, spaces, name).
+*/
+/** DID format regex: did:{method}:{identifier} where method is [a-z0-9]+ */
+const DID_REGEX = /^did:([a-z0-9]+):(.+)$/;
+/**
+* Parse a full DID string into its components.
+*
+* @param did - Full DID string (e.g. 'did:abt:z1abc...')
+* @returns Parsed DID object
+* @throws If the input is not a valid DID string
+*/
+function parse(did) {
+	if (typeof did !== "string") throw new Error("DID must be a string");
+	if (!did) throw new Error("DID string cannot be empty");
+	const match = did.match(DID_REGEX);
+	if (!match) throw new Error("Invalid DID format");
+	const [, method, identifier] = match;
+	if (!method) throw new Error("Invalid DID format");
+	if (!identifier) throw new Error("Invalid DID format");
+	if (!require_method.isKnownMethod(method)) throw new Error(`Unknown DID method: ${method}`);
+	return {
+		method,
+		identifier,
+		full: did
+	};
+}
+/**
+* Format an identifier and method into a full DID string.
+*
+* Handles idempotency: if the identifier already has a `did:{method}:` prefix
+* matching the target method, returns it as-is.
+*
+* @param identifier - The identifier (address or name)
+* @param method - The DID method (default: 'abt')
+* @returns Full DID string
+* @throws If the method is unknown or identifier is empty
+*/
+function formatDid(identifier, method = require_method.DEFAULT_METHOD) {
+	if (!identifier) throw new Error("Identifier cannot be empty");
+	if (!require_method.isKnownMethod(method)) throw new Error(`Unknown DID method: ${method}`);
+	const prefix = `did:${method}:`;
+	if (identifier.startsWith(prefix)) return identifier;
+	if (identifier.startsWith("did:")) {
+		const match = identifier.match(DID_REGEX);
+		if (match) {
+			if (match[1] === method) return identifier;
+			return `did:${method}:${match[2]}`;
+		}
+	}
+	return `did:${method}:${identifier}`;
+}
+/**
+* Extract the method from a DID string.
+*
+* @param did - A DID string or bare address
+* @returns The method string, or null if no prefix found
+*/
+function extractMethod(did) {
+	if (typeof did !== "string" || !did) return null;
+	const match = did.match(DID_REGEX);
+	if (!match) return null;
+	const method = match[1];
+	if (require_method.isKnownMethod(method)) return method;
+	return null;
+}
+/**
+* Extract the identifier from a DID string, stripping the `did:{method}:` prefix.
+* If the input has no prefix, returns it as-is.
+*
+* @param did - A DID string or bare address
+* @returns The identifier portion
+*/
+function extractIdentifier(did) {
+	if (typeof did !== "string" || !did) return "";
+	const match = did.match(/^did:[a-z0-9]+:(.+)$/);
+	if (match) return match[1];
+	return did;
+}
+
+//#endregion
+exports.extractIdentifier = extractIdentifier;
+exports.extractMethod = extractMethod;
+exports.formatDid = formatDid;
+exports.parse = parse;

package/lib/parse.d.cts

@@ -0,0 +1,50 @@
+import { DIDMethod } from "./method.cjs";
+
+//#region src/parse.d.ts
+
+/** Parsed DID structure */
+interface ParsedDID {
+  /** The method component (e.g. 'abt', 'afs', 'name') */
+  method: DIDMethod;
+  /** The identifier component (everything after did:{method}:) */
+  identifier: string;
+  /** The full DID string */
+  full: string;
+}
+/**
+ * Parse a full DID string into its components.
+ *
+ * @param did - Full DID string (e.g. 'did:abt:z1abc...')
+ * @returns Parsed DID object
+ * @throws If the input is not a valid DID string
+ */
+declare function parse(did: unknown): ParsedDID;
+/**
+ * Format an identifier and method into a full DID string.
+ *
+ * Handles idempotency: if the identifier already has a `did:{method}:` prefix
+ * matching the target method, returns it as-is.
+ *
+ * @param identifier - The identifier (address or name)
+ * @param method - The DID method (default: 'abt')
+ * @returns Full DID string
+ * @throws If the method is unknown or identifier is empty
+ */
+declare function formatDid(identifier: string, method?: DIDMethod): string;
+/**
+ * Extract the method from a DID string.
+ *
+ * @param did - A DID string or bare address
+ * @returns The method string, or null if no prefix found
+ */
+declare function extractMethod(did: unknown): DIDMethod | null;
+/**
+ * Extract the identifier from a DID string, stripping the `did:{method}:` prefix.
+ * If the input has no prefix, returns it as-is.
+ *
+ * @param did - A DID string or bare address
+ * @returns The identifier portion
+ */
+declare function extractIdentifier(did: unknown): string;
+//#endregion
+export { ParsedDID, extractIdentifier, extractMethod, formatDid, parse };

package/lib/short-form.cjs

@@ -0,0 +1,47 @@
+const require_parse = require('./parse.cjs');
+const require_index = require('./index.cjs');
+
+//#region src/short-form.ts
+/**
+* Short-form DID Resolution
+*
+* Deterministic expansion of short-form identifiers to full DIDs.
+* Based on base58 checksum validation (not heuristic guessing).
+*
+* Rules:
+* - Already a full DID (starts with "did:") → return as-is
+* - Valid cryptographic address (passes isValid checksum) → did:abt:{address}
+* - Everything else → did:name:{input}
+*/
+/**
+* Expand a short-form identifier to a full DID.
+*
+* @param input - Short-form identifier (address, name, or full DID)
+* @returns Full DID string
+* @throws If input is not a non-empty string
+*/
+function expandShortForm(input) {
+	if (typeof input !== "string") throw new Error("Input must be a string");
+	if (!input) throw new Error("Input cannot be empty");
+	if (input.startsWith("did:")) return input;
+	if (require_index.isValid(input)) return require_parse.formatDid(input, "abt");
+	return require_parse.formatDid(input, "name");
+}
+/**
+* Convert a full DID to its short form (strip the did:{method}: prefix).
+*
+* @param did - Full DID string
+* @returns Short-form identifier
+* @throws If input is not a non-empty string
+*/
+function toShortForm(did) {
+	if (typeof did !== "string") throw new Error("Input must be a string");
+	if (!did) throw new Error("Input cannot be empty");
+	const match = did.match(/^did:[a-z0-9]+:(.+)$/);
+	if (match) return match[1];
+	return did;
+}
+
+//#endregion
+exports.expandShortForm = expandShortForm;
+exports.toShortForm = toShortForm;

package/lib/short-form.d.cts

@@ -0,0 +1,30 @@
+//#region src/short-form.d.ts
+/**
+ * Short-form DID Resolution
+ *
+ * Deterministic expansion of short-form identifiers to full DIDs.
+ * Based on base58 checksum validation (not heuristic guessing).
+ *
+ * Rules:
+ * - Already a full DID (starts with "did:") → return as-is
+ * - Valid cryptographic address (passes isValid checksum) → did:abt:{address}
+ * - Everything else → did:name:{input}
+ */
+/**
+ * Expand a short-form identifier to a full DID.
+ *
+ * @param input - Short-form identifier (address, name, or full DID)
+ * @returns Full DID string
+ * @throws If input is not a non-empty string
+ */
+declare function expandShortForm(input: unknown): string;
+/**
+ * Convert a full DID to its short form (strip the did:{method}: prefix).
+ *
+ * @param did - Full DID string
+ * @returns Short-form identifier
+ * @throws If input is not a non-empty string
+ */
+declare function toShortForm(did: unknown): string;
+//#endregion
+export { expandShortForm, toShortForm };

package/lib/util.cjs

@@ -14,7 +14,7 @@ const DID_PREFIX = "did:abt:";
 const toBytes = (did) => {
 	try {
 		if ((0, _ocap_util.isHexStrict)(did)) return Buffer.from((0, _ocap_util.stripHexPrefix)(did), "hex");
-		let bytes = (0, _ocap_util.fromBase58)(did.replace(DID_PREFIX, ""));
+		let bytes = (0, _ocap_util.fromBase58)(did.replace(/^did:[a-z0-9]+:/, ""));
 		while (bytes.length < 26) bytes = Buffer.concat([Uint8Array.from([0]), Uint8Array.from(bytes)]);
 		return bytes;
 	} catch (err) {

package/lib/validate.cjs

@@ -0,0 +1,36 @@
+const require_method = require('./method.cjs');
+const require_index = require('./index.cjs');
+
+//#region src/validate.ts
+/**
+* DID Validation Functions
+*
+* isValid and isFromPublicKey remain in index.ts (too many dependencies to move).
+* This file provides isKnownDid which covers all methods including did:name.
+*/
+/**
+* Check if a DID string is a known valid DID.
+*
+* Unlike `isValid` (which only validates cryptographic addresses),
+* `isKnownDid` covers all known methods:
+* - Crypto methods (abt/afs/aos/spaces): delegates to `isValid` for checksum validation
+* - Alias methods (name): checks for non-empty identifier
+* - Unknown methods: returns false
+* - Bare cryptographic addresses: delegates to `isValid`
+*
+* @param did - DID string to validate
+* @returns true if the DID is valid for its method
+*/
+function isKnownDid(did) {
+	if (typeof did !== "string" || !did) return false;
+	const match = did.match(/^did:([a-z0-9]+):(.*)$/);
+	if (!match) return require_index.isValid(did);
+	const [, method, identifier] = match;
+	if (!identifier) return false;
+	if (require_method.isCryptoMethod(method)) return require_index.isValid(did);
+	if (require_method.isAliasMethod(method)) return true;
+	return false;
+}
+
+//#endregion
+exports.isKnownDid = isKnownDid;

package/lib/validate.d.cts

@@ -0,0 +1,23 @@
+//#region src/validate.d.ts
+/**
+ * DID Validation Functions
+ *
+ * isValid and isFromPublicKey remain in index.ts (too many dependencies to move).
+ * This file provides isKnownDid which covers all methods including did:name.
+ */
+/**
+ * Check if a DID string is a known valid DID.
+ *
+ * Unlike `isValid` (which only validates cryptographic addresses),
+ * `isKnownDid` covers all known methods:
+ * - Crypto methods (abt/afs/aos/spaces): delegates to `isValid` for checksum validation
+ * - Alias methods (name): checks for non-empty identifier
+ * - Unknown methods: returns false
+ * - Bare cryptographic addresses: delegates to `isValid`
+ *
+ * @param did - DID string to validate
+ * @returns true if the DID is valid for its method
+ */
+declare function isKnownDid(did: unknown): boolean;
+//#endregion
+export { isKnownDid };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcblock/did",
-  "version": "1.29.18",
+  "version": "1.29.20",
   "type": "module",
   "description": "Javascript lib to work with ArcBlock DID",
   "keywords": [
@@ -69,8 +69,8 @@
     "url": "https://github.com/ArcBlock/blockchain/issues"
   },
   "dependencies": {
-    "@ocap/mcrypto": "1.29.18",
-    "@ocap/util": "1.29.18",
+    "@ocap/mcrypto": "1.29.20",
+    "@ocap/util": "1.29.20",
     "bn.js": "5.2.3",
     "debug": "^4.4.3",
     "lodash": "^4.17.23"