@interop/did-method-peer 0.0.0-stage → 0.1.0

package/dist/numalgo4.js

@@ -0,0 +1,309 @@
+/**
+ * The pure did:peer numalgo 4 codec: encode an input document into a long or
+ * short form, decode a long form back into its input document (verifying the
+ * hash), and contextualize a decoded document into a DID document. Everything
+ * here is synchronous, does no I/O and imports no key suite. References stay
+ * relative, exactly as the spec and the reference implementations leave them;
+ * the driver performs reference resolution on top of this output.
+ */
+import { base58 } from '@scure/base';
+import { sha256 } from '@noble/hashes/sha2.js';
+import { concatBytes } from '@noble/hashes/utils.js';
+import { DIDResolutionError } from '@interop/data-integrity-core';
+import { deepClone } from '@interop/did-io';
+import { MAX_LONG_FORM_LENGTH, MULTIBASE_BASE58BTC_PREFIX, MULTICODEC_JSON_HEADER, MULTIHASH_SHA2_256_HEADER, NUMALGO_4_PREFIX } from './constants.js';
+import { METHOD_PROPERTIES, isPlainObject } from './resources.js';
+export { MAX_LONG_FORM_LENGTH } from './constants.js';
+/**
+ * Matches a long form: a fixed `zQm` prefix (every hash is a base58btc
+ * sha2-256 multihash), 44 more base58 characters, then the encoded document,
+ * at least 6 base58 characters (what `{}` encodes to). Bitcoin alphabet.
+ */
+export const LONG_FORM_PATTERN = /^did:peer:4zQm[1-9A-HJ-NP-Za-km-z]{44}:z[1-9A-HJ-NP-Za-km-z]{6,}$/;
+/**
+ * Matches a short form: `did:peer:4` followed by the 46-character hash.
+ */
+export const SHORT_FORM_PATTERN = /^did:peer:4zQm[1-9A-HJ-NP-Za-km-z]{44}$/;
+const PROBLEM_TYPES = {
+    invalidDid: {
+        type: 'https://www.w3.org/ns/did#INVALID_DID',
+        title: 'The DID is invalid.'
+    },
+    invalidDidUrl: {
+        type: 'https://www.w3.org/ns/did#INVALID_DID_URL',
+        title: 'The DID URL is invalid.'
+    },
+    methodNotSupported: {
+        type: 'https://www.w3.org/ns/did#METHOD_NOT_SUPPORTED',
+        title: 'The DID method is not supported.'
+    },
+    notFound: {
+        type: 'https://www.w3.org/ns/did#NOT_FOUND',
+        title: 'The DID document was not found.'
+    },
+    internalError: {
+        type: 'https://www.w3.org/ns/did#INTERNAL_ERROR',
+        title: 'An internal error occurred during resolution.'
+    }
+};
+/**
+ * Builds a `DIDResolutionError` with the spec problem details for its code.
+ * The codec and the driver throw this directly (no private error class), so
+ * `CachedResolver.resolveDID()` produces the right envelope without a
+ * translation layer.
+ *
+ * @param options {object}
+ * @param options.code {IDIDResolutionErrorCode}
+ * @param options.message {string}
+ * @param [options.cause] {unknown}
+ *
+ * @returns {DIDResolutionError}
+ */
+export function resolutionError({ code, message, cause }) {
+    const problem = PROBLEM_TYPES[code];
+    return new DIDResolutionError(message, {
+        code,
+        problemDetails: problem ? { ...problem, detail: message } : undefined,
+        cause
+    });
+}
+function invalidDid(message, cause) {
+    return resolutionError({ code: 'invalidDid', message, cause });
+}
+/**
+ * Produces the encoded document: the input document JSON-stringified without
+ * whitespace, UTF-8 encoded, prefixed with the multicodec `json` header and
+ * multibase base58btc encoded.
+ */
+function encodeDocument(inputDocument) {
+    const bytes = new TextEncoder().encode(JSON.stringify(inputDocument));
+    try {
+        return (MULTIBASE_BASE58BTC_PREFIX +
+            base58.encode(concatBytes(MULTICODEC_JSON_HEADER, bytes)));
+    }
+    catch (cause) {
+        // @scure/base refuses base58 inputs over 2048 bytes (quadratic encoder).
+        throw new Error(`Input document is too large to base58-encode (${bytes.length} bytes of JSON).`, { cause });
+    }
+}
+/**
+ * Hashes an encoded document string (including its leading `z`) with
+ * sha2-256 and returns the base58btc multibase of the sha2-256 multihash.
+ */
+function hashEncodedDocument(encodedDocument) {
+    const digest = sha256(new TextEncoder().encode(encodedDocument));
+    return (MULTIBASE_BASE58BTC_PREFIX +
+        base58.encode(concatBytes(MULTIHASH_SHA2_256_HEADER, digest)));
+}
+/**
+ * Encodes an input document into its long form. Does not validate; validation
+ * is the driver's job at `generate()` time.
+ *
+ * @param options {object}
+ * @param options.inputDocument {InputDocument}
+ *
+ * @returns {string} The long form `did:peer:4{hash}:{encoded document}`.
+ */
+export function encodeLongForm({ inputDocument }) {
+    const encodedDocument = encodeDocument(inputDocument);
+    const hash = hashEncodedDocument(encodedDocument);
+    return `${NUMALGO_4_PREFIX}${hash}:${encodedDocument}`;
+}
+/**
+ * Encodes an input document into its short form. Does not validate.
+ *
+ * @param options {object}
+ * @param options.inputDocument {InputDocument}
+ *
+ * @returns {string} The short form `did:peer:4{hash}`.
+ */
+export function encodeShortForm({ inputDocument }) {
+    return `${NUMALGO_4_PREFIX}${hashEncodedDocument(encodeDocument(inputDocument))}`;
+}
+/**
+ * Whether a string starts with the numalgo 4 prefix `did:peer:4`.
+ *
+ * @param did {string}
+ *
+ * @returns {boolean}
+ */
+export function isDidPeer4(did) {
+    return typeof did === 'string' && did.startsWith(NUMALGO_4_PREFIX);
+}
+/**
+ * Whether a string matches the long form grammar. Does not verify the hash.
+ *
+ * @param did {string}
+ *
+ * @returns {boolean}
+ */
+export function isLongForm(did) {
+    return typeof did === 'string' && LONG_FORM_PATTERN.test(did);
+}
+/**
+ * Whether a string matches the short form grammar.
+ *
+ * @param did {string}
+ *
+ * @returns {boolean}
+ */
+export function isShortForm(did) {
+    return typeof did === 'string' && SHORT_FORM_PATTERN.test(did);
+}
+/**
+ * Returns the short form of a long form by string surgery (regex guarded). It
+ * does not verify the hash; callers that need that call `decode` first.
+ *
+ * @param options {object}
+ * @param options.did {string} - A long form.
+ *
+ * @throws {DIDResolutionError} `invalidDid` if `did` is not a long form.
+ *
+ * @returns {string} The short form.
+ */
+export function longToShort({ did }) {
+    if (!isLongForm(did)) {
+        throw invalidDid(`Not a did:peer numalgo 4 long form: "${String(did)}".`);
+    }
+    return did.slice(0, did.lastIndexOf(':'));
+}
+/**
+ * Decodes a long form into its input document, verifying the hash over the
+ * encoded document string exactly as present in the DID. Rejects anything that
+ * is not a numalgo 4 long form, a long form over `MAX_LONG_FORM_LENGTH`, a
+ * hash mismatch, a bad multicodec prefix, invalid UTF-8 or JSON, and a payload
+ * that is not a plain object. Returns a freshly parsed document on every call.
+ *
+ * @param options {object}
+ * @param options.did {string} - A long form.
+ *
+ * @throws {TypeError} If `did` is not a string.
+ * @throws {DIDResolutionError} With code `invalidDid` for every other failure.
+ *
+ * @returns {InputDocument} The input document, relative references intact.
+ */
+export function decode({ did }) {
+    if (typeof did !== 'string') {
+        throw new TypeError('"did" must be a string.');
+    }
+    if (!isDidPeer4(did)) {
+        throw invalidDid(`Not a did:peer numalgo 4 DID: "${did}".`);
+    }
+    if (did.length > MAX_LONG_FORM_LENGTH) {
+        throw invalidDid(`Long form exceeds the maximum length of ${MAX_LONG_FORM_LENGTH} characters.`);
+    }
+    if (isShortForm(did)) {
+        throw invalidDid(`Cannot decode a short form; the document is not recoverable from "${did}".`);
+    }
+    if (!isLongForm(did)) {
+        throw invalidDid(`Malformed did:peer numalgo 4 long form: "${did}".`);
+    }
+    const separator = did.lastIndexOf(':');
+    const hash = did.slice(NUMALGO_4_PREFIX.length, separator);
+    const encodedDocument = did.slice(separator + 1);
+    if (hashEncodedDocument(encodedDocument) !== hash) {
+        throw invalidDid('Long form hash does not match its encoded document; the DID is corrupt or tampered.');
+    }
+    let bytes;
+    try {
+        bytes = base58.decode(encodedDocument.slice(1));
+    }
+    catch (cause) {
+        throw invalidDid('Encoded document is not valid base58btc.', cause);
+    }
+    if (bytes.length < MULTICODEC_JSON_HEADER.length ||
+        bytes[0] !== MULTICODEC_JSON_HEADER[0] ||
+        bytes[1] !== MULTICODEC_JSON_HEADER[1]) {
+        throw invalidDid('Encoded document does not carry the multicodec json prefix.');
+    }
+    let parsed;
+    try {
+        const text = new TextDecoder('utf-8', { fatal: true }).decode(bytes.subarray(MULTICODEC_JSON_HEADER.length));
+        parsed = JSON.parse(text);
+    }
+    catch (cause) {
+        throw invalidDid('Encoded document is not valid UTF-8 JSON.', cause);
+    }
+    if (!isPlainObject(parsed)) {
+        throw invalidDid('Encoded document is not a JSON object.');
+    }
+    return parsed;
+}
+/**
+ * Contextualizes a decoded input document: deep-copies it, sets the root `id`,
+ * appends `alsoKnownAs`, and sets `controller` on every verification method
+ * (listed or embedded) that has no own `controller` property. Relative
+ * references are left relative. Total over hash-valid input: a shape it cannot
+ * handle is `invalidDid` rather than a bare `TypeError`.
+ */
+function contextualize({ inputDocument, did, alsoKnownAs }) {
+    const doc = deepClone(inputDocument);
+    doc.id = did;
+    if (!Object.hasOwn(doc, 'alsoKnownAs')) {
+        doc.alsoKnownAs = [alsoKnownAs];
+    }
+    else if (Array.isArray(doc.alsoKnownAs)) {
+        doc.alsoKnownAs.push(alsoKnownAs);
+    }
+    else {
+        throw invalidDid('"alsoKnownAs" in the encoded document is not an array.');
+    }
+    for (const property of METHOD_PROPERTIES) {
+        if (!Object.hasOwn(doc, property)) {
+            continue;
+        }
+        const entries = doc[property];
+        if (!Array.isArray(entries)) {
+            throw invalidDid(`"${property}" in the encoded document is not an array.`);
+        }
+        for (const entry of entries) {
+            if (typeof entry === 'string') {
+                continue;
+            }
+            if (!isPlainObject(entry)) {
+                throw invalidDid(`"${property}" in the encoded document holds an entry that is neither a reference nor a verification method.`);
+            }
+            if (!Object.hasOwn(entry, 'controller')) {
+                entry.controller = did;
+            }
+        }
+    }
+    return doc;
+}
+/**
+ * Resolves a long form to its DID document: `decode` (regex, length and hash
+ * checks) followed by contextualization with the long form as `id` and the
+ * short form appended to `alsoKnownAs`. References stay relative.
+ *
+ * @param options {object}
+ * @param options.did {string} - A long form.
+ *
+ * @returns {IDIDDocument}
+ */
+export function resolveLongForm({ did }) {
+    const inputDocument = decode({ did });
+    return contextualize({
+        inputDocument,
+        did,
+        alsoKnownAs: longToShort({ did })
+    });
+}
+/**
+ * Resolves a short form from its long form: decodes the long form (so the
+ * regex and hash checks run), then contextualizes with the short form as `id`
+ * and the long form appended to `alsoKnownAs`. References stay relative.
+ *
+ * @param options {object}
+ * @param options.longFormDid {string} - The long form previously seen.
+ *
+ * @returns {IDIDDocument}
+ */
+export function resolveShortForm({ longFormDid }) {
+    const inputDocument = decode({ did: longFormDid });
+    return contextualize({
+        inputDocument,
+        did: longToShort({ did: longFormDid }),
+        alsoKnownAs: longFormDid
+    });
+}
+//# sourceMappingURL=numalgo4.js.map

package/dist/numalgo4.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"numalgo4.js","sourceRoot":"","sources":["../src/numalgo4.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAA;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,EACL,kBAAkB,EAGnB,MAAM,8BAA8B,CAAA;AACrC,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EACL,oBAAoB,EACpB,0BAA0B,EAC1B,sBAAsB,EACtB,yBAAyB,EACzB,gBAAgB,EACjB,MAAM,gBAAgB,CAAA;AACvB,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AAGjE,OAAO,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAA;AAErD;;;;GAIG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAC5B,mEAAmE,CAAA;AAErE;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,yCAAyC,CAAA;AAE3E,MAAM,aAAa,GAAoD;IACrE,UAAU,EAAE;QACV,IAAI,EAAE,uCAAuC;QAC7C,KAAK,EAAE,qBAAqB;KAC7B;IACD,aAAa,EAAE;QACb,IAAI,EAAE,2CAA2C;QACjD,KAAK,EAAE,yBAAyB;KACjC;IACD,kBAAkB,EAAE;QAClB,IAAI,EAAE,gDAAgD;QACtD,KAAK,EAAE,kCAAkC;KAC1C;IACD,QAAQ,EAAE;QACR,IAAI,EAAE,qCAAqC;QAC3C,KAAK,EAAE,iCAAiC;KACzC;IACD,aAAa,EAAE;QACb,IAAI,EAAE,0CAA0C;QAChD,KAAK,EAAE,+CAA+C;KACvD;CACF,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,eAAe,CAAC,EAC9B,IAAI,EACJ,OAAO,EACP,KAAK,EAKN;IACC,MAAM,OAAO,GAAG,aAAa,CAAC,IAAI,CAAC,CAAA;IACnC,OAAO,IAAI,kBAAkB,CAAC,OAAO,EAAE;QACrC,IAAI;QACJ,cAAc,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,SAAS;QACrE,KAAK;KACN,CAAC,CAAA;AACJ,CAAC;AAED,SAAS,UAAU,CAAC,OAAe,EAAE,KAAe;IAClD,OAAO,eAAe,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAA;AAChE,CAAC;AAED;;;;GAIG;AACH,SAAS,cAAc,CAAC,aAA4B;IAClD,MAAM,KAAK,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAA;IACrE,IAAI,CAAC;QACH,OAAO,CACL,0BAA0B;YAC1B,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,sBAAsB,EAAE,KAAK,CAAC,CAAC,CAC1D,CAAA;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,yEAAyE;QACzE,MAAM,IAAI,KAAK,CACb,iDAAiD,KAAK,CAAC,MAAM,kBAAkB,EAC/E,EAAE,KAAK,EAAE,CACV,CAAA;IACH,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,SAAS,mBAAmB,CAAC,eAAuB;IAClD,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAA;IAChE,OAAO,CACL,0BAA0B;QAC1B,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,yBAAyB,EAAE,MAAM,CAAC,CAAC,CAC9D,CAAA;AACH,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,cAAc,CAAC,EAC7B,aAAa,EAGd;IACC,MAAM,eAAe,GAAG,cAAc,CAAC,aAAa,CAAC,CAAA;IACrD,MAAM,IAAI,GAAG,mBAAmB,CAAC,eAAe,CAAC,CAAA;IACjD,OAAO,GAAG,gBAAgB,GAAG,IAAI,IAAI,eAAe,EAAE,CAAA;AACxD,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,eAAe,CAAC,EAC9B,aAAa,EAGd;IACC,OAAO,GAAG,gBAAgB,GAAG,mBAAmB,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC,EAAE,CAAA;AACnF,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CAAC,GAAW;IACpC,OAAO,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAA;AACpE,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CAAC,GAAW;IACpC,OAAO,OAAO,GAAG,KAAK,QAAQ,IAAI,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AAC/D,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CAAC,GAAW;IACrC,OAAO,OAAO,GAAG,KAAK,QAAQ,IAAI,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AAChE,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,WAAW,CAAC,EAAE,GAAG,EAAmB;IAClD,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACrB,MAAM,UAAU,CAAC,wCAAwC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IAC3E,CAAC;IACD,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAA;AAC3C,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,MAAM,CAAC,EAAE,GAAG,EAAmB;IAC7C,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC5B,MAAM,IAAI,SAAS,CAAC,yBAAyB,CAAC,CAAA;IAChD,CAAC;IACD,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACrB,MAAM,UAAU,CAAC,kCAAkC,GAAG,IAAI,CAAC,CAAA;IAC7D,CAAC;IACD,IAAI,GAAG,CAAC,MAAM,GAAG,oBAAoB,EAAE,CAAC;QACtC,MAAM,UAAU,CACd,2CAA2C,oBAAoB,cAAc,CAC9E,CAAA;IACH,CAAC;IACD,IAAI,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC;QACrB,MAAM,UAAU,CACd,qEAAqE,GAAG,IAAI,CAC7E,CAAA;IACH,CAAC;IACD,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACrB,MAAM,UAAU,CAAC,4CAA4C,GAAG,IAAI,CAAC,CAAA;IACvE,CAAC;IACD,MAAM,SAAS,GAAG,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,CAAA;IACtC,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,gBAAgB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;IAC1D,MAAM,eAAe,GAAG,GAAG,CAAC,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,CAAA;IAChD,IAAI,mBAAmB,CAAC,eAAe,CAAC,KAAK,IAAI,EAAE,CAAC;QAClD,MAAM,UAAU,CACd,qFAAqF,CACtF,CAAA;IACH,CAAC;IACD,IAAI,KAAiB,CAAA;IACrB,IAAI,CAAC;QACH,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;IACjD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,UAAU,CAAC,0CAA0C,EAAE,KAAK,CAAC,CAAA;IACrE,CAAC;IACD,IACE,KAAK,CAAC,MAAM,GAAG,sBAAsB,CAAC,MAAM;QAC5C,KAAK,CAAC,CAAC,CAAC,KAAK,sBAAsB,CAAC,CAAC,CAAC;QACtC,KAAK,CAAC,CAAC,CAAC,KAAK,sBAAsB,CAAC,CAAC,CAAC,EACtC,CAAC;QACD,MAAM,UAAU,CACd,6DAA6D,CAC9D,CAAA;IACH,CAAC;IACD,IAAI,MAAe,CAAA;IACnB,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,IAAI,WAAW,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,CAC3D,KAAK,CAAC,QAAQ,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAC9C,CAAA;QACD,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IAC3B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,UAAU,CAAC,2CAA2C,EAAE,KAAK,CAAC,CAAA;IACtE,CAAC;IACD,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;QAC3B,MAAM,UAAU,CAAC,wCAAwC,CAAC,CAAA;IAC5D,CAAC;IACD,OAAO,MAAM,CAAA;AACf,CAAC;AAED;;;;;;GAMG;AACH,SAAS,aAAa,CAAC,EACrB,aAAa,EACb,GAAG,EACH,WAAW,EAKZ;IACC,MAAM,GAAG,GAAG,SAAS,CAAC,aAAa,CAAC,CAAA;IACpC,GAAG,CAAC,EAAE,GAAG,GAAG,CAAA;IACZ,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,aAAa,CAAC,EAAE,CAAC;QACvC,GAAG,CAAC,WAAW,GAAG,CAAC,WAAW,CAAC,CAAA;IACjC,CAAC;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC;QAC1C,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;IACnC,CAAC;SAAM,CAAC;QACN,MAAM,UAAU,CAAC,wDAAwD,CAAC,CAAA;IAC5E,CAAC;IACD,KAAK,MAAM,QAAQ,IAAI,iBAAiB,EAAE,CAAC;QACzC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,EAAE,CAAC;YAClC,SAAQ;QACV,CAAC;QACD,MAAM,OAAO,GAAG,GAAG,CAAC,QAAQ,CAAC,CAAA;QAC7B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YAC5B,MAAM,UAAU,CAAC,IAAI,QAAQ,4CAA4C,CAAC,CAAA;QAC5E,CAAC;QACD,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAC5B,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAC9B,SAAQ;YACV,CAAC;YACD,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC1B,MAAM,UAAU,CACd,IAAI,QAAQ,iGAAiG,CAC9G,CAAA;YACH,CAAC;YACD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,YAAY,CAAC,EAAE,CAAC;gBACxC,KAAK,CAAC,UAAU,GAAG,GAAG,CAAA;YACxB,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,GAA8B,CAAA;AACvC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,eAAe,CAAC,EAAE,GAAG,EAAmB;IACtD,MAAM,aAAa,GAAG,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,CAAA;IACrC,OAAO,aAAa,CAAC;QACnB,aAAa;QACb,GAAG;QACH,WAAW,EAAE,WAAW,CAAC,EAAE,GAAG,EAAE,CAAC;KAClC,CAAC,CAAA;AACJ,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,gBAAgB,CAAC,EAC/B,WAAW,EAGZ;IACC,MAAM,aAAa,GAAG,MAAM,CAAC,EAAE,GAAG,EAAE,WAAW,EAAE,CAAC,CAAA;IAClD,OAAO,aAAa,CAAC;QACnB,aAAa;QACb,GAAG,EAAE,WAAW,CAAC,EAAE,GAAG,EAAE,WAAW,EAAE,CAAC;QACtC,WAAW,EAAE,WAAW;KACzB,CAAC,CAAA;AACJ,CAAC"}

package/dist/resources.d.ts

@@ -0,0 +1,27 @@
+/**
+ * The properties whose entries are verification methods or references to
+ * them.
+ */
+export declare const METHOD_PROPERTIES: string[];
+/**
+ * Every property whose entries carry a resource id.
+ */
+export declare const RESOURCE_PROPERTIES: string[];
+export declare function isPlainObject(value: unknown): value is Record<string, unknown>;
+/**
+ * Finds the object entry with the given `id` across `properties`, searched in
+ * order. String entries are references and are skipped.
+ *
+ * @param options {object}
+ * @param options.document {Record<string, unknown>}
+ * @param options.id {string}
+ * @param [options.properties] {string[]} - Defaults to `RESOURCE_PROPERTIES`.
+ *
+ * @returns {Record<string, unknown> | undefined}
+ */
+export declare function findResource({ document, id, properties }: {
+    document: Record<string, unknown>;
+    id: string;
+    properties?: string[];
+}): Record<string, unknown> | undefined;
+//# sourceMappingURL=resources.d.ts.map

package/dist/resources.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resources.d.ts","sourceRoot":"","sources":["../src/resources.ts"],"names":[],"mappings":"AAQA;;;GAGG;AACH,eAAO,MAAM,iBAAiB,UAG7B,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,mBAAmB,UAAoC,CAAA;AAEpE,wBAAgB,aAAa,CAC3B,KAAK,EAAE,OAAO,GACb,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAElC;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,YAAY,CAAC,EAC3B,QAAQ,EACR,EAAE,EACF,UAAgC,EACjC,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC,EAAE,EAAE,MAAM,CAAA;IACV,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;CACtB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAYtC"}

package/dist/resources.js

@@ -0,0 +1,47 @@
+/**
+ * Shared helpers for walking the resource arrays of an input or DID document:
+ * `verificationMethod`, the five verification relationships and `service`.
+ * Imported by the codec, the input document helpers and the driver alike, so
+ * the plain-object test and the property lists exist once.
+ */
+import { VERIFICATION_RELATIONSHIPS } from '@interop/did-io';
+/**
+ * The properties whose entries are verification methods or references to
+ * them.
+ */
+export const METHOD_PROPERTIES = [
+    'verificationMethod',
+    ...VERIFICATION_RELATIONSHIPS
+];
+/**
+ * Every property whose entries carry a resource id.
+ */
+export const RESOURCE_PROPERTIES = [...METHOD_PROPERTIES, 'service'];
+export function isPlainObject(value) {
+    return typeof value === 'object' && value !== null && !Array.isArray(value);
+}
+/**
+ * Finds the object entry with the given `id` across `properties`, searched in
+ * order. String entries are references and are skipped.
+ *
+ * @param options {object}
+ * @param options.document {Record<string, unknown>}
+ * @param options.id {string}
+ * @param [options.properties] {string[]} - Defaults to `RESOURCE_PROPERTIES`.
+ *
+ * @returns {Record<string, unknown> | undefined}
+ */
+export function findResource({ document, id, properties = RESOURCE_PROPERTIES }) {
+    for (const property of properties) {
+        const entries = document[property];
+        if (!Array.isArray(entries)) {
+            continue;
+        }
+        const match = entries.find(entry => isPlainObject(entry) && entry.id === id);
+        if (match) {
+            return match;
+        }
+    }
+    return undefined;
+}
+//# sourceMappingURL=resources.js.map

package/dist/resources.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resources.js","sourceRoot":"","sources":["../src/resources.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,0BAA0B,EAAE,MAAM,iBAAiB,CAAA;AAE5D;;;GAGG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,oBAAoB;IACpB,GAAG,0BAA0B;CAC9B,CAAA;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,GAAG,iBAAiB,EAAE,SAAS,CAAC,CAAA;AAEpE,MAAM,UAAU,aAAa,CAC3B,KAAc;IAEd,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;AAC7E,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,YAAY,CAAC,EAC3B,QAAQ,EACR,EAAE,EACF,UAAU,GAAG,mBAAmB,EAKjC;IACC,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE,CAAC;QAClC,MAAM,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAA;QAClC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YAC5B,SAAQ;QACV,CAAC;QACD,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,EAAE,KAAK,EAAE,CAAC,CAAA;QAC5E,IAAI,KAAK,EAAE,CAAC;YACV,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAA;AAClB,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,67 @@
+/**
+ * Shared types for the did:peer driver: the key suite registry shapes (the
+ * same contract `@interop/did-method-key` and `@interop/did-web-resolver`
+ * use, so one suite registers with every did-io driver), the input document
+ * type, and the `LongFormStore` the driver consults to resolve short forms.
+ */
+import type { AbstractKeyPair } from '@interop/data-integrity-core';
+/**
+ * The id-less, relative-reference document a did:peer numalgo 4 DID is derived
+ * from. The codec never inspects its shape beyond what contextualization
+ * needs, so it is a plain JSON object.
+ */
+export type InputDocument = Record<string, unknown>;
+/**
+ * A multibase-multikey deserializer: converts a `{publicKeyMultibase}` value
+ * into a live key pair instance.
+ */
+export type FromMultibase = (options: {
+    publicKeyMultibase: string;
+}) => Promise<AbstractKeyPair>;
+/**
+ * A key suite class usable for did:peer generation and key rebuilding via
+ * `DidPeerDriver.use({ keyPairClass })`. The static `multibaseHeader` (the
+ * 4-character multibase-multikey prefix, e.g. `z6Mk` for Ed25519) lets the
+ * driver register the suite without the caller knowing that prefix.
+ */
+export interface KeyPairClass {
+    multibaseHeader: string;
+    from: FromMultibase;
+    generate?: (options?: object) => Promise<AbstractKeyPair>;
+}
+/**
+ * An entry in the driver's registry of key suites, keyed by multibase header.
+ */
+export interface RegisteredKeyType {
+    fromMultibase: FromMultibase;
+    generate?: (options?: object) => Promise<AbstractKeyPair>;
+    enableEncryptionKeyDerivation?: boolean;
+}
+/**
+ * The driver's memory of long forms, keyed by short form. A short form is only
+ * a hash, so it resolves only after its long form has been seen; the driver
+ * writes `set(shortForm, longForm)` from `generate()` and (with
+ * `rememberOnResolve`) from a successful long form `get()`, and reads
+ * `get(shortForm)` for a short form. Positional parameters, so that a plain
+ * `Map<string, string>` satisfies the interface and a persistent store returns
+ * promises from the same two methods. The driver never deletes; a store grows
+ * by one entry per distinct long form resolved, and the store implementer owns
+ * bounds and eviction.
+ */
+export interface LongFormStore {
+    get(shortForm: string): string | undefined | Promise<string | undefined>;
+    set(shortForm: string, longForm: string): unknown;
+}
+/**
+ * Constructor options for `DidPeerDriver` and `driver()`.
+ */
+export interface DidPeerDriverOptions {
+    longFormStore?: LongFormStore;
+    /**
+     * Whether a successful long form `get()` writes the long form store so the
+     * counterpart's short form resolves later. Default `true`; a verifier that
+     * only fetches key nodes sets it to `false`. `generate()` writes regardless.
+     */
+    rememberOnResolve?: boolean;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAA;AAEnE;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAEnD;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,EAAE;IACpC,kBAAkB,EAAE,MAAM,CAAA;CAC3B,KAAK,OAAO,CAAC,eAAe,CAAC,CAAA;AAE9B;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,eAAe,EAAE,MAAM,CAAA;IACvB,IAAI,EAAE,aAAa,CAAA;IACnB,QAAQ,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,eAAe,CAAC,CAAA;CAC1D;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,aAAa,EAAE,aAAa,CAAA;IAC5B,QAAQ,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,eAAe,CAAC,CAAA;IACzD,6BAA6B,CAAC,EAAE,OAAO,CAAA;CACxC;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,aAAa;IAC5B,GAAG,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;IACxE,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAA;CAClD;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;CAC5B"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,97 @@
 {
   "name": "@interop/did-method-peer",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "description": "A did:peer (numalgo 4) DID method driver for @interop/did-io: long and short form codec, DID document generation and resolution, for the browser, Node.js, and React Native.",
+  "version": "0.1.0",
+  "type": "module",
+  "scripts": {
+    "build": "pnpm run clear && tsc",
+    "clear": "rimraf dist/*",
+    "dev": "vite",
+    "fix": "eslint --fix src test && pnpm run format",
+    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\" \"*.md\"",
+    "lint": "eslint src test",
+    "prepare": "pnpm run build",
+    "rebuild": "pnpm run clear && pnpm run build",
+    "typecheck": "tsc -p tsconfig.dev.json",
+    "test": "pnpm run fix && pnpm run lint && pnpm run typecheck && pnpm run test:node && pnpm run test:browser",
+    "test:browser": "playwright test",
+    "test:node": "vitest run",
+    "test:coverage": "vitest run --coverage"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE.md"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "react-native": "./dist/index.js",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./codec": {
+      "types": "./dist/codec.d.ts",
+      "react-native": "./dist/codec.js",
+      "import": "./dist/codec.js",
+      "default": "./dist/codec.js"
+    }
+  },
+  "module": "dist/index.js",
+  "browser": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "sideEffects": false,
+  "dependencies": {
+    "@interop/bnid": "^6.0.2",
+    "@interop/data-integrity-core": "^8.10.0",
+    "@interop/did-io": "^4.3.0",
+    "@interop/x25519-key-agreement-key": "^5.4.3",
+    "@noble/hashes": "^2.2.0",
+    "@scure/base": "^2.2.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^10.0.1",
+    "@interop/ed25519-signature": "^7.2.5",
+    "@interop/ed25519-verification-key": "^8.2.2",
+    "@interop/jsonld-signatures": "^11.9.0",
+    "@interop/security-document-loader": "^10.1.6",
+    "@interop/zcap": "^11.4.0",
+    "@playwright/test": "^1.60.0",
+    "@types/node": "^26.0.1",
+    "@vitest/coverage-v8": "^4.1.7",
+    "eslint": "^10.4.0",
+    "eslint-config-prettier": "^10.1.8",
+    "globals": "^17.6.0",
+    "prettier": "^3.8.3",
+    "rimraf": "^6.1.3",
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.59.4",
+    "vite": "^8.0.14",
+    "vitest": "^4.1.7"
+  },
+  "publishConfig": {
+			"access": "public"
+  },
+  "keywords": [
+    "did",
+    "did:peer",
+    "didcomm",
+    "did-io",
+    "isomorphic"
+  ],
+  "packageManager": "pnpm@11.5.0",
+  "engines": {
+    "node": ">=24.0"
+  },
+  "author": {
+    "name": "Interop Alliance",
+    "url": "https://github.com/interop-alliance/"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/interop-alliance/did-method-peer.git"
+  },
+  "homepage": "https://github.com/interop-alliance/did-method-peer",
+  "bugs": "https://github.com/interop-alliance/did-method-peer/issues"
+}