@enbox/dids 0.0.1

package/dist/esm/did-error.js

@@ -0,0 +1,62 @@
+/**
+ * A custom error class for DID-related errors.
+ */
+export class DidError extends Error {
+    /**
+     * Constructs an instance of DidError, a custom error class for handling DID-related errors.
+     *
+     * @param code - A {@link DidErrorCode} representing the specific type of error encountered.
+     * @param message - A human-readable description of the error.
+     */
+    constructor(code, message) {
+        super(`${code}: ${message}`);
+        this.code = code;
+        this.name = 'DidError';
+        // Ensures that instanceof works properly, the correct prototype chain when using inheritance,
+        // and that V8 stack traces (like Chrome, Edge, and Node.js) are more readable and relevant.
+        Object.setPrototypeOf(this, new.target.prototype);
+        // Captures the stack trace in V8 engines (like Chrome, Edge, and Node.js).
+        // In non-V8 environments, the stack trace will still be captured.
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, DidError);
+        }
+    }
+}
+/**
+ * An enumeration of possible DID error codes.
+ */
+export var DidErrorCode;
+(function (DidErrorCode) {
+    /** The DID supplied does not conform to valid syntax. */
+    DidErrorCode["InvalidDid"] = "invalidDid";
+    /** The supplied method name is not supported by the DID method and/or DID resolver implementation. */
+    DidErrorCode["MethodNotSupported"] = "methodNotSupported";
+    /** An unexpected error occurred during the requested DID operation. */
+    DidErrorCode["InternalError"] = "internalError";
+    /** The DID document supplied does not conform to valid syntax. */
+    DidErrorCode["InvalidDidDocument"] = "invalidDidDocument";
+    /** The byte length of a DID document does not match the expected value. */
+    DidErrorCode["InvalidDidDocumentLength"] = "invalidDidDocumentLength";
+    /** The DID URL supplied to the dereferencing function does not conform to valid syntax. */
+    DidErrorCode["InvalidDidUrl"] = "invalidDidUrl";
+    /** The given proof of a previous DID is invalid */
+    DidErrorCode["InvalidPreviousDidProof"] = "invalidPreviousDidProof";
+    /** An invalid public key is detected during a DID operation. */
+    DidErrorCode["InvalidPublicKey"] = "invalidPublicKey";
+    /** The byte length of a public key does not match the expected value. */
+    DidErrorCode["InvalidPublicKeyLength"] = "invalidPublicKeyLength";
+    /** An invalid public key type was detected during a DID operation. */
+    DidErrorCode["InvalidPublicKeyType"] = "invalidPublicKeyType";
+    /** Verification of a signature failed during a DID operation. */
+    DidErrorCode["InvalidSignature"] = "invalidSignature";
+    /** The DID resolver was unable to find the DID document resulting from the resolution request. */
+    DidErrorCode["NotFound"] = "notFound";
+    /**
+     * The representation requested via the `accept` input metadata property is not supported by the
+     * DID method and/or DID resolver implementation.
+     */
+    DidErrorCode["RepresentationNotSupported"] = "representationNotSupported";
+    /** The type of a public key is not supported by the DID method and/or DID resolver implementation. */
+    DidErrorCode["UnsupportedPublicKeyType"] = "unsupportedPublicKeyType";
+})(DidErrorCode || (DidErrorCode = {}));
+//# sourceMappingURL=did-error.js.map

package/dist/esm/did-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"did-error.js","sourceRoot":"","sources":["../../src/did-error.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,KAAK;IACjC;;;;;OAKG;IACH,YAAmB,IAAkB,EAAE,OAAe;QACpD,KAAK,CAAC,GAAG,IAAI,KAAK,OAAO,EAAE,CAAC,CAAC;QADZ,SAAI,GAAJ,IAAI,CAAc;QAEnC,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC;QAEvB,8FAA8F;QAC9F,4FAA4F;QAC5F,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAElD,2EAA2E;QAC3E,kEAAkE;QAClE,IAAI,KAAK,CAAC,iBAAiB,EAAE,CAAC;YAC5B,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAC1C,CAAC;IACH,CAAC;CACF;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,YA6CX;AA7CD,WAAY,YAAY;IACtB,yDAAyD;IACzD,yCAAyB,CAAA;IAEzB,sGAAsG;IACtG,yDAAyC,CAAA;IAEzC,uEAAuE;IACvE,+CAA+B,CAAA;IAE/B,kEAAkE;IAClE,yDAAyC,CAAA;IAEzC,2EAA2E;IAC3E,qEAAqD,CAAA;IAErD,2FAA2F;IAC3F,+CAA+B,CAAA;IAE/B,mDAAmD;IACnD,mEAAmD,CAAA;IAEnD,gEAAgE;IAChE,qDAAqC,CAAA;IAErC,yEAAyE;IACzE,iEAAiD,CAAA;IAEjD,sEAAsE;IACtE,6DAA6C,CAAA;IAE7C,iEAAiE;IACjE,qDAAqC,CAAA;IAErC,kGAAkG;IAClG,qCAAqB,CAAA;IAErB;;;OAGG;IACH,yEAAyD,CAAA;IAEzD,sGAAsG;IACtG,qEAAqD,CAAA;AACvD,CAAC,EA7CW,YAAY,KAAZ,YAAY,QA6CvB"}

package/dist/esm/did.js

@@ -0,0 +1,114 @@
+/**
+ * The `Did` class represents a Decentralized Identifier (DID) Uniform Resource Identifier (URI).
+ *
+ * This class provides a method for parsing a DID URI string into its component parts, as well as a
+ * method for serializing a DID URI object into a string.
+ *
+ * A DID URI is composed of the following components:
+ * - scheme
+ * - method
+ * - id
+ * - path
+ * - query
+ * - fragment
+ * - params
+ *
+ * @see {@link https://www.w3.org/TR/did-core/#did-syntax | DID Core Specification, § DID Syntax}
+ */
+export class Did {
+    /**
+     * Constructs a new `Did` instance from individual components.
+     *
+     * @param params - An object containing the parameters to be included in the DID URI.
+     * @param params.method - The name of the DID method.
+     * @param params.id - The DID method identifier.
+     * @param params.path - Optional. The path component of the DID URI.
+     * @param params.query - Optional. The query component of the DID URI.
+     * @param params.fragment - Optional. The fragment component of the DID URI.
+     * @param params.params - Optional. The query parameters in the DID URI.
+     */
+    constructor({ method, id, path, query, fragment, params }) {
+        this.uri = `did:${method}:${id}`;
+        this.method = method;
+        this.id = id;
+        this.path = path;
+        this.query = query;
+        this.fragment = fragment;
+        this.params = params;
+    }
+    /**
+     * Parses a DID URI string into its individual components.
+     *
+     * @example
+     * ```ts
+     * const did = Did.parse('did:example:123?service=agent&relativeRef=/credentials#degree');
+     *
+     * console.log(did.uri)      // Output: 'did:example:123'
+     * console.log(did.method)   // Output: 'example'
+     * console.log(did.id)       // Output: '123'
+     * console.log(did.query)    // Output: 'service=agent&relativeRef=/credentials'
+     * console.log(did.fragment) // Output: 'degree'
+     * console.log(did.params)   // Output: { service: 'agent', relativeRef: '/credentials' }
+     * ```
+     *
+     * @params didUri - The DID URI string to be parsed.
+     * @returns A `Did` object representing the parsed DID URI, or `null` if the input string is not a valid DID URI.
+     */
+    static parse(didUri) {
+        // Return null if the input string is empty or not provided.
+        if (!didUri)
+            return null;
+        // Execute the regex pattern on the input string to extract URI components.
+        const match = Did.DID_URI_PATTERN.exec(didUri);
+        // If the pattern does not match, or if the required groups are not found, return null.
+        if (!match || !match.groups)
+            return null;
+        // Extract the method, id, params, path, query, and fragment from the regex match groups.
+        const { method, id, path, query, fragment } = match.groups;
+        // Initialize a new Did object with the uri, method and id.
+        const did = {
+            uri: `did:${method}:${id}`,
+            method,
+            id,
+        };
+        // If path is present, add it to the Did object.
+        if (path)
+            did.path = path;
+        // If query is present, add it to the Did object, removing the leading '?'.
+        if (query)
+            did.query = query.slice(1);
+        // If fragment is present, add it to the Did object, removing the leading '#'.
+        if (fragment)
+            did.fragment = fragment.slice(1);
+        // If query params are present, parse them into a key-value object and add to the Did object.
+        if (query) {
+            const parsedParams = {};
+            // Split the query string by '&' to get individual parameter strings.
+            const paramPairs = query.slice(1).split('&');
+            for (const pair of paramPairs) {
+                // Split each parameter string by '=' to separate keys and values.
+                const [key, value] = pair.split('=');
+                parsedParams[key] = value;
+            }
+            did.params = parsedParams;
+        }
+        return did;
+    }
+}
+/** Regular expression pattern for matching the method component of a DID URI. */
+Did.METHOD_PATTERN = '([a-z0-9]+)';
+/** Regular expression pattern for matching percent-encoded characters in a method identifier. */
+Did.PCT_ENCODED_PATTERN = '(?:%[0-9a-fA-F]{2})';
+/** Regular expression pattern for matching the characters allowed in a method identifier. */
+Did.ID_CHAR_PATTERN = `(?:[a-zA-Z0-9._-]|${Did.PCT_ENCODED_PATTERN})`;
+/** Regular expression pattern for matching the method identifier component of a DID URI. */
+Did.METHOD_ID_PATTERN = `((?:${Did.ID_CHAR_PATTERN}*:)*(${Did.ID_CHAR_PATTERN}+))`;
+/** Regular expression pattern for matching the path component of a DID URI. */
+Did.PATH_PATTERN = `(/[^#?]*)?`;
+/** Regular expression pattern for matching the query component of a DID URI. */
+Did.QUERY_PATTERN = `([?][^#]*)?`;
+/** Regular expression pattern for matching the fragment component of a DID URI. */
+Did.FRAGMENT_PATTERN = `(#.*)?`;
+/** Regular expression pattern for matching all of the components of a DID URI. */
+Did.DID_URI_PATTERN = new RegExp(`^did:(?<method>${Did.METHOD_PATTERN}):(?<id>${Did.METHOD_ID_PATTERN})(?<path>${Did.PATH_PATTERN})(?<query>${Did.QUERY_PATTERN})(?<fragment>${Did.FRAGMENT_PATTERN})$`);
+//# sourceMappingURL=did.js.map

package/dist/esm/did.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"did.js","sourceRoot":"","sources":["../../src/did.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,OAAO,GAAG;IA8Ed;;;;;;;;;;OAUG;IACH,YAAY,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAOtD;QACC,IAAI,CAAC,GAAG,GAAG,OAAO,MAAM,IAAI,EAAE,EAAE,CAAC;QACjC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,KAAK,CAAC,MAAc;QACzB,4DAA4D;QAC5D,IAAI,CAAC,MAAM;YAAE,OAAO,IAAI,CAAC;QAEzB,2EAA2E;QAC3E,MAAM,KAAK,GAAG,GAAG,CAAC,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAE/C,uFAAuF;QACvF,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,MAAM;YAAE,OAAO,IAAI,CAAC;QAEzC,yFAAyF;QACzF,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAC,MAAM,CAAC;QAE3D,2DAA2D;QAC3D,MAAM,GAAG,GAAQ;YACf,GAAG,EAAE,OAAO,MAAM,IAAI,EAAE,EAAE;YAC1B,MAAM;YACN,EAAE;SACH,CAAC;QAEF,gDAAgD;QAChD,IAAI,IAAI;YAAE,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC;QAE1B,2EAA2E;QAC3E,IAAI,KAAK;YAAE,GAAG,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAEtC,8EAA8E;QAC9E,IAAI,QAAQ;YAAE,GAAG,CAAC,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAE/C,6FAA6F;QAC7F,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,YAAY,GAAG,EAA4B,CAAC;YAClD,qEAAqE;YACrE,MAAM,UAAU,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC7C,KAAK,MAAM,IAAI,IAAI,UAAU,EAAE,CAAC;gBAC9B,kEAAkE;gBAClE,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACrC,YAAY,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YAC5B,CAAC;YACD,GAAG,CAAC,MAAM,GAAG,YAAY,CAAC;QAC5B,CAAC;QAED,OAAO,GAAG,CAAC;IACb,CAAC;;AAtKD,iFAAiF;AACjE,kBAAc,GAAG,aAAa,CAAC;AAC/C,iGAAiG;AACjF,uBAAmB,GAAG,qBAAqB,CAAC;AAC5D,6FAA6F;AAC7E,mBAAe,GAAG,qBAAqB,GAAG,CAAC,mBAAmB,GAAG,CAAC;AAClF,4FAA4F;AAC5E,qBAAiB,GAAG,OAAO,GAAG,CAAC,eAAe,QAAQ,GAAG,CAAC,eAAe,KAAK,CAAC;AAC/F,+EAA+E;AAC/D,gBAAY,GAAG,YAAY,CAAC;AAC5C,gFAAgF;AAChE,iBAAa,GAAG,aAAa,CAAC;AAC9C,mFAAmF;AACnE,oBAAgB,GAAG,QAAQ,CAAC;AAC5C,kFAAkF;AAClE,mBAAe,GAAG,IAAI,MAAM,CAC1C,kBAAkB,GAAG,CAAC,cAAc,WAAW,GAAG,CAAC,iBAAiB,YAAY,GAAG,CAAC,YAAY,aAAa,GAAG,CAAC,aAAa,gBAAgB,GAAG,CAAC,gBAAgB,IAAI,CACvK,CAAC"}

package/dist/esm/index.js

@@ -0,0 +1,16 @@
+export * from './types/did-core.js';
+export * from './types/did-resolution.js';
+export * from './did.js';
+export * from './did-error.js';
+export * from './bearer-did.js';
+export * from './methods/did-dht.js';
+export * from './methods/did-ion.js';
+export * from './methods/did-jwk.js';
+export * from './methods/did-key.js';
+export * from './methods/did-method.js';
+export * from './methods/did-web.js';
+export * from './resolver/resolver-cache-level.js';
+export * from './resolver/resolver-cache-noop.js';
+export * from './resolver/universal-resolver.js';
+export * as utils from './utils.js';
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,2BAA2B,CAAC;AAI1C,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAEhC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AAErC,cAAc,oCAAoC,CAAC;AACnD,cAAc,mCAAmC,CAAC;AAClD,cAAc,kCAAkC,CAAC;AAEjD,OAAO,KAAK,KAAK,MAAM,YAAY,CAAC"}