npm - @atproto/did - Versions diffs - 0.2.4 → 0.4.0-next.0 - Mend

@atproto/did 0.2.4 → 0.4.0-next.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (31) hide show

package/CHANGELOG.md +22 -0
package/LICENSE.txt +1 -1
package/dist/atproto.js +37 -51
package/dist/atproto.js.map +1 -1
package/dist/did-document.d.ts +24 -24
package/dist/did-document.d.ts.map +1 -1
package/dist/did-document.js +42 -38
package/dist/did-document.js.map +1 -1
package/dist/did-error.js +5 -25
package/dist/did-error.js.map +1 -1
package/dist/did.js +24 -33
package/dist/did.js.map +1 -1
package/dist/index.js +6 -22
package/dist/index.js.map +1 -1
package/dist/lib/uri.js +3 -8
package/dist/lib/uri.js.map +1 -1
package/dist/methods/plc.js +9 -15
package/dist/methods/plc.js.map +1 -1
package/dist/methods/web.js +24 -33
package/dist/methods/web.js.map +1 -1
package/dist/methods.js +2 -18
package/dist/methods.js.map +1 -1
package/dist/utils.js +1 -4
package/dist/utils.js.map +1 -1
package/jest.config.cjs +15 -0
package/package.json +8 -7
package/src/did-document.ts +21 -14
package/tests/methods/plc.test.ts +2 -2
package/tests/methods/web.test.ts +2 -2
package/tsconfig.build.tsbuildinfo +1 -1
package/jest.config.js +0 -13

package/CHANGELOG.md CHANGED Viewed

@@ -1,5 +1,27 @@
 # @atproto/did
+## 0.4.0-next.0
+### Minor Changes
+- [#4929](https://github.com/bluesky-social/atproto/pull/4929) [`bb7491c`](https://github.com/bluesky-social/atproto/commit/bb7491c29e06181e1d2f8cf6eb454f9bb8ab961b) Thanks [@devinivy](https://github.com/devinivy)! - **BREAKING:** Drop support for Node.js 18 and 20. Node.js 22 is now the minimum supported version. Docker images now use Node.js 24.
+- [#4943](https://github.com/bluesky-social/atproto/pull/4943) [`07ae5d4`](https://github.com/bluesky-social/atproto/commit/07ae5d4452df51e045e0239da7a04cf0bc154028) Thanks [@devinivy](https://github.com/devinivy)! - **BREAKING:** Convert to pure ESM. All packages now ship `"type": "module"` with ES module output and Node16 module resolution.
+  Node.js 22's `require()` compatibility layer can still load these packages in CommonJS code.
+- [#4930](https://github.com/bluesky-social/atproto/pull/4930) [`042df15`](https://github.com/bluesky-social/atproto/commit/042df15087c0e62cd1e715fcbf58852fab875af9) Thanks [@devinivy](https://github.com/devinivy)! - Build with TypeScript 6.0. Emitted `.d.ts` files now use TypeScript 6's stricter `Uint8Array<ArrayBuffer>` typing in places where Web/Node APIs require buffer-backed (not shared-memory) byte arrays. Consumers compiling against these types on older TypeScript should see no runtime impact, but may need to widen or cast in spots that previously relied on `Uint8Array` defaulting to `<ArrayBufferLike>`.
+  Internal: tsconfig `moduleResolution: "node"` is silenced via `ignoreDeprecations: "6.0"` for now; the proper migration to `node16`/`bundler` resolution is deferred.
+## 0.3.0
+### Minor Changes
+- [#4580](https://github.com/bluesky-social/atproto/pull/4580) [`d54d707`](https://github.com/bluesky-social/atproto/commit/d54d7077eb32041e1f61c312efa1dd0d768c774e) Thanks [@matthieusieben](https://github.com/matthieusieben)! - Allow DID document to omit the `@context` root property
+- [#4580](https://github.com/bluesky-social/atproto/pull/4580) [`d54d707`](https://github.com/bluesky-social/atproto/commit/d54d7077eb32041e1f61c312efa1dd0d768c774e) Thanks [@matthieusieben](https://github.com/matthieusieben)! - Disallow string values in `verificationMethod` array (as per spec)
 ## 0.2.4
 ### Patch Changes

package/LICENSE.txt CHANGED Viewed

@@ -1,6 +1,6 @@
 Dual MIT/Apache-2.0 License
-Copyright (c) 2022-2025 Bluesky Social PBC, and Contributors
+Copyright (c) 2022-2026 Bluesky Social PBC, and Contributors
 Except as otherwise noted in individual files, this software is licensed under the MIT license (<http://opensource.org/licenses/MIT>), or the Apache License, Version 2.0 (<http://www.apache.org/licenses/LICENSE-2.0>).

package/dist/atproto.js CHANGED Viewed

@@ -1,59 +1,46 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ATPROTO_VERIFICATION_METHOD_TYPES = exports.isAtprotoAudience = exports.atprotoDidSchema = void 0;
-exports.isAtprotoDid = isAtprotoDid;
-exports.asAtprotoDid = asAtprotoDid;
-exports.assertAtprotoDid = assertAtprotoDid;
-exports.assertAtprotoDidWeb = assertAtprotoDidWeb;
-exports.isAtprotoDidWeb = isAtprotoDidWeb;
-exports.extractAtprotoData = extractAtprotoData;
-exports.extractPdsUrl = extractPdsUrl;
-exports.isAtprotoAka = isAtprotoAka;
-exports.isAtprotoPersonalDataServerService = isAtprotoPersonalDataServerService;
-exports.isAtprotoVerificationMethod = isAtprotoVerificationMethod;
-const zod_1 = require("zod");
-const did_error_js_1 = require("./did-error.js");
-const uri_js_1 = require("./lib/uri.js");
-const methods_js_1 = require("./methods.js");
-const utils_js_1 = require("./utils.js");
-exports.atprotoDidSchema = zod_1.z
+import { z } from 'zod';
+import { DidError, InvalidDidError } from './did-error.js';
+import { canParse, isFragment } from './lib/uri.js';
+import { DID_PLC_PREFIX, DID_WEB_PREFIX, assertDidPlc, assertDidWeb, isDidPlc, isDidWeb, } from './methods.js';
+import { matchesIdentifier } from './utils.js';
+export const atprotoDidSchema = z
     .string()
     .refine(isAtprotoDid, `Atproto only allows "plc" and "web" DID methods`);
-function isAtprotoDid(input) {
-    return (0, methods_js_1.isDidPlc)(input) || isAtprotoDidWeb(input);
+export function isAtprotoDid(input) {
+    return isDidPlc(input) || isAtprotoDidWeb(input);
 }
-function asAtprotoDid(input) {
+export function asAtprotoDid(input) {
     assertAtprotoDid(input);
     return input;
 }
-function assertAtprotoDid(input) {
+export function assertAtprotoDid(input) {
     if (typeof input !== 'string') {
-        throw new did_error_js_1.InvalidDidError(typeof input, `DID must be a string`);
+        throw new InvalidDidError(typeof input, `DID must be a string`);
     }
-    else if (input.startsWith(methods_js_1.DID_PLC_PREFIX)) {
-        (0, methods_js_1.assertDidPlc)(input);
+    else if (input.startsWith(DID_PLC_PREFIX)) {
+        assertDidPlc(input);
     }
-    else if (input.startsWith(methods_js_1.DID_WEB_PREFIX)) {
+    else if (input.startsWith(DID_WEB_PREFIX)) {
         assertAtprotoDidWeb(input);
     }
     else {
-        throw new did_error_js_1.InvalidDidError(input, `Atproto only allows "plc" and "web" DID methods`);
+        throw new InvalidDidError(input, `Atproto only allows "plc" and "web" DID methods`);
     }
 }
-function assertAtprotoDidWeb(input) {
-    (0, methods_js_1.assertDidWeb)(input);
+export function assertAtprotoDidWeb(input) {
+    assertDidWeb(input);
     if (isDidWebWithPath(input)) {
-        throw new did_error_js_1.InvalidDidError(input, `Atproto does not allow path components in Web DIDs`);
+        throw new InvalidDidError(input, `Atproto does not allow path components in Web DIDs`);
     }
     if (isDidWebWithHttpsPort(input)) {
-        throw new did_error_js_1.InvalidDidError(input, `Atproto does not allow port numbers in Web DIDs, except for localhost`);
+        throw new InvalidDidError(input, `Atproto does not allow port numbers in Web DIDs, except for localhost`);
     }
 }
 /**
  * @see {@link https://atproto.com/specs/did#blessed-did-methods}
  */
-function isAtprotoDidWeb(input) {
-    if (!(0, methods_js_1.isDidWeb)(input)) {
+export function isAtprotoDidWeb(input) {
+    if (!isDidWeb(input)) {
         return false;
     }
     if (isDidWebWithPath(input)) {
@@ -65,7 +52,7 @@ function isAtprotoDidWeb(input) {
     return true;
 }
 function isDidWebWithPath(did) {
-    return did.includes(':', methods_js_1.DID_WEB_PREFIX.length);
+    return did.includes(':', DID_WEB_PREFIX.length);
 }
 function isLocalhostDid(did) {
     return (did === 'did:web:localhost' ||
@@ -75,17 +62,17 @@ function isLocalhostDid(did) {
 function isDidWebWithHttpsPort(did) {
     if (isLocalhostDid(did))
         return false;
-    const pathIdx = did.indexOf(':', methods_js_1.DID_WEB_PREFIX.length);
+    const pathIdx = did.indexOf(':', DID_WEB_PREFIX.length);
     const hasPort = pathIdx === -1
         ? // No path component, check if there's a port separator anywhere after
             // the "did:web:" prefix
-            did.includes('%3A', methods_js_1.DID_WEB_PREFIX.length)
+            did.includes('%3A', DID_WEB_PREFIX.length)
         : // There is a path component; if there is an encoded colon *before* it,
             // then there is a port number
             did.lastIndexOf('%3A', pathIdx) !== -1;
     return hasPort;
 }
-const isAtprotoAudience = (value) => {
+export const isAtprotoAudience = (value) => {
     if (typeof value !== 'string')
         return false;
     const hashIndex = value.indexOf('#');
@@ -93,10 +80,9 @@ const isAtprotoAudience = (value) => {
         return false;
     if (value.indexOf('#', hashIndex + 1) !== -1)
         return false;
-    return ((0, uri_js_1.isFragment)(value, hashIndex + 1) && isAtprotoDid(value.slice(0, hashIndex)));
+    return (isFragment(value, hashIndex + 1) && isAtprotoDid(value.slice(0, hashIndex)));
 };
-exports.isAtprotoAudience = isAtprotoAudience;
-function extractAtprotoData(document) {
+export function extractAtprotoData(document) {
     return {
         did: document.id,
         aka: document.alsoKnownAs?.find(isAtprotoAka)?.slice(5),
@@ -104,31 +90,31 @@ function extractAtprotoData(document) {
         pds: document.service?.find((isAtprotoPersonalDataServerService), document),
     };
 }
-function extractPdsUrl(document) {
+export function extractPdsUrl(document) {
     const service = document.service?.find(isAtprotoPersonalDataServerService, document);
     if (!service) {
-        throw new did_error_js_1.DidError(document.id, `Document ${document.id} does not contain a (valid) #atproto_pds service URL`, 'did-service-not-found');
+        throw new DidError(document.id, `Document ${document.id} does not contain a (valid) #atproto_pds service URL`, 'did-service-not-found');
     }
     return new URL(service.serviceEndpoint);
 }
-function isAtprotoAka(value) {
+export function isAtprotoAka(value) {
     return value.startsWith('at://');
 }
-function isAtprotoPersonalDataServerService(service) {
+export function isAtprotoPersonalDataServerService(service) {
     return (service?.type === 'AtprotoPersonalDataServer' &&
         typeof service.serviceEndpoint === 'string' &&
-        (0, uri_js_1.canParse)(service.serviceEndpoint) &&
-        (0, utils_js_1.matchesIdentifier)(this.id, 'atproto_pds', service.id));
+        canParse(service.serviceEndpoint) &&
+        matchesIdentifier(this.id, 'atproto_pds', service.id));
 }
-exports.ATPROTO_VERIFICATION_METHOD_TYPES = Object.freeze([
+export const ATPROTO_VERIFICATION_METHOD_TYPES = Object.freeze([
     'EcdsaSecp256r1VerificationKey2019',
     'EcdsaSecp256k1VerificationKey2019',
     'Multikey',
 ]);
-function isAtprotoVerificationMethod(method) {
+export function isAtprotoVerificationMethod(method) {
     return (typeof method === 'object' &&
         typeof method?.publicKeyMultibase === 'string' &&
-        exports.ATPROTO_VERIFICATION_METHOD_TYPES.includes(method.type) &&
-        (0, utils_js_1.matchesIdentifier)(this.id, 'atproto', method.id));
+        ATPROTO_VERIFICATION_METHOD_TYPES.includes(method.type) &&
+        matchesIdentifier(this.id, 'atproto', method.id));
 }
 //# sourceMappingURL=atproto.js.map

package/dist/atproto.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"atproto.js","sourceRoot":"","sources":["../src/atproto.ts"],"names":[],"mappings":";;;AAyBA,oCAEC;AAED,oCAGC;AAED,4CAaC;AAED,kDAkBC;AAKD,0CAcC;AAmDD,gDAeC;AAED,sCAeC;AAGD,oCAEC;AAUD,gFAYC;AAmBD,kEAiBC;AAxOD,6BAAuB;AAEvB,iDAA0D;AAE1D,yCAAmD;AACnD,6CAOqB;AACrB,yCAA0D;AAQ7C,QAAA,gBAAgB,GAAG,OAAC;KAC9B,MAAM,EAAE;KACR,MAAM,CAAC,YAAY,EAAE,iDAAiD,CAAC,CAAA;AAE1E,SAAgB,YAAY,CAAC,KAAc;IACzC,OAAO,IAAA,qBAAQ,EAAC,KAAK,CAAC,IAAI,eAAe,CAAC,KAAK,CAAC,CAAA;AAClD,CAAC;AAED,SAAgB,YAAY,CAAI,KAAQ;IACtC,gBAAgB,CAAC,KAAK,CAAC,CAAA;IACvB,OAAO,KAAK,CAAA;AACd,CAAC;AAED,SAAgB,gBAAgB,CAAC,KAAc;IAC7C,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,MAAM,IAAI,8BAAe,CAAC,OAAO,KAAK,EAAE,sBAAsB,CAAC,CAAA;IACjE,CAAC;SAAM,IAAI,KAAK,CAAC,UAAU,CAAC,2BAAc,CAAC,EAAE,CAAC;QAC5C,IAAA,yBAAY,EAAC,KAAK,CAAC,CAAA;IACrB,CAAC;SAAM,IAAI,KAAK,CAAC,UAAU,CAAC,2BAAc,CAAC,EAAE,CAAC;QAC5C,mBAAmB,CAAC,KAAK,CAAC,CAAA;IAC5B,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,8BAAe,CACvB,KAAK,EACL,iDAAiD,CAClD,CAAA;IACH,CAAC;AACH,CAAC;AAED,SAAgB,mBAAmB,CACjC,KAAc;IAEd,IAAA,yBAAY,EAAC,KAAK,CAAC,CAAA;IAEnB,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,8BAAe,CACvB,KAAK,EACL,oDAAoD,CACrD,CAAA;IACH,CAAC;IAED,IAAI,qBAAqB,CAAC,KAAK,CAAC,EAAE,CAAC;QACjC,MAAM,IAAI,8BAAe,CACvB,KAAK,EACL,uEAAuE,CACxE,CAAA;IACH,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAgB,eAAe,CAAC,KAAc;IAC5C,IAAI,CAAC,IAAA,qBAAQ,EAAC,KAAK,CAAC,EAAE,CAAC;QACrB,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC5B,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,qBAAqB,CAAC,KAAK,CAAC,EAAE,CAAC;QACjC,OAAO,KAAK,CAAA;IACd,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC;AAED,SAAS,gBAAgB,CAAC,GAAe;IACvC,OAAO,GAAG,CAAC,QAAQ,CAAC,GAAG,EAAE,2BAAc,CAAC,MAAM,CAAC,CAAA;AACjD,CAAC;AAED,SAAS,cAAc,CAAC,GAAe;IACrC,OAAO,CACL,GAAG,KAAK,mBAAmB;QAC3B,GAAG,CAAC,UAAU,CAAC,oBAAoB,CAAC;QACpC,GAAG,CAAC,UAAU,CAAC,sBAAsB,CAAC,CACvC,CAAA;AACH,CAAC;AAED,SAAS,qBAAqB,CAAC,GAAe;IAC5C,IAAI,cAAc,CAAC,GAAG,CAAC;QAAE,OAAO,KAAK,CAAA;IAErC,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,2BAAc,CAAC,MAAM,CAAC,CAAA;IAEvD,MAAM,OAAO,GACX,OAAO,KAAK,CAAC,CAAC;QACZ,CAAC,CAAC,sEAAsE;YACtE,wBAAwB;YACxB,GAAG,CAAC,QAAQ,CAAC,KAAK,EAAE,2BAAc,CAAC,MAAM,CAAC;QAC5C,CAAC,CAAC,uEAAuE;YACvE,8BAA8B;YAC9B,GAAG,CAAC,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAA;IAE5C,OAAO,OAAO,CAAA;AAChB,CAAC;AAGM,MAAM,iBAAiB,GAAG,CAAC,KAAc,EAA4B,EAAE;IAC5E,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAA;IAC3C,MAAM,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;IACpC,IAAI,SAAS,KAAK,CAAC,CAAC;QAAE,OAAO,KAAK,CAAA;IAClC,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;QAAE,OAAO,KAAK,CAAA;IAC1D,OAAO,CACL,IAAA,mBAAU,EAAC,KAAK,EAAE,SAAS,GAAG,CAAC,CAAC,IAAI,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAC5E,CAAA;AACH,CAAC,CAAA;AARY,QAAA,iBAAiB,qBAQ7B;AAWD,SAAgB,kBAAkB,CAChC,QAAwB;IAExB,OAAO;QACL,GAAG,EAAE,QAAQ,CAAC,EAAE;QAChB,GAAG,EAAE,QAAQ,CAAC,WAAW,EAAE,IAAI,CAAC,YAAY,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;QACvD,GAAG,EAAE,QAAQ,CAAC,kBAAkB,EAAE,IAAI,CACpC,CAAA,2BAA8B,CAAA,EAC9B,QAAQ,CACT;QACD,GAAG,EAAE,QAAQ,CAAC,OAAO,EAAE,IAAI,CACzB,CAAA,kCAAqC,CAAA,EACrC,QAAQ,CACT;KACF,CAAA;AACH,CAAC;AAED,SAAgB,aAAa,CAAC,QAA4B;IACxD,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,EAAE,IAAI,CACpC,kCAAkC,EAClC,QAAQ,CACT,CAAA;IAED,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,uBAAQ,CAChB,QAAQ,CAAC,EAAE,EACX,YAAY,QAAQ,CAAC,EAAE,sDAAsD,EAC7E,uBAAuB,CACxB,CAAA;IACH,CAAC;IAED,OAAO,IAAI,GAAG,CAAC,OAAO,CAAC,eAAe,CAAC,CAAA;AACzC,CAAC;AAGD,SAAgB,YAAY,CAAC,KAAa;IACxC,OAAO,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;AAClC,CAAC;AAUD,SAAgB,kCAAkC,CAIhD,OAAsC;IAEtC,OAAO,CACL,OAAO,EAAE,IAAI,KAAK,2BAA2B;QAC7C,OAAO,OAAO,CAAC,eAAe,KAAK,QAAQ;QAC3C,IAAA,iBAAQ,EAAC,OAAO,CAAC,eAAe,CAAC;QACjC,IAAA,4BAAiB,EAAC,IAAI,CAAC,EAAE,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,CAAC,CACtD,CAAA;AACH,CAAC;AAEY,QAAA,iCAAiC,GAAG,MAAM,CAAC,MAAM,CAAC;IAC7D,mCAAmC;IACnC,mCAAmC;IACnC,UAAU;CACF,CAAC,CAAA;AAaX,SAAgB,2BAA2B,CAIzC,MAG6D;IAE7D,OAAO,CACL,OAAO,MAAM,KAAK,QAAQ;QAC1B,OAAO,MAAM,EAAE,kBAAkB,KAAK,QAAQ;QAC7C,yCAAwD,CAAC,QAAQ,CAChE,MAAM,CAAC,IAAI,CACZ;QACD,IAAA,4BAAiB,EAAC,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE,CAAC,CACjD,CAAA;AACH,CAAC","sourcesContent":["import { z } from 'zod'\nimport { DidDocument, DidService } from './did-document.js'\nimport { DidError, InvalidDidError } from './did-error.js'\nimport { Did } from './did.js'\nimport { canParse, isFragment } from './lib/uri.js'\nimport {\n DID_PLC_PREFIX,\n DID_WEB_PREFIX,\n assertDidPlc,\n assertDidWeb,\n isDidPlc,\n isDidWeb,\n} from './methods.js'\nimport { Identifier, matchesIdentifier } from './utils.js'\n\n// This file contains atproto-specific DID validation utilities.\n\nexport type AtprotoIdentityDidMethods = 'plc' \| 'web'\nexport type AtprotoDid = Did<AtprotoIdentityDidMethods>\nexport type AtprotoDidDocument = DidDocument<AtprotoIdentityDidMethods>\n\nexport const atprotoDidSchema = z\n .string()\n .refine(isAtprotoDid, `Atproto only allows \"plc\" and \"web\" DID methods`)\n\nexport function isAtprotoDid(input: unknown): input is AtprotoDid {\n return isDidPlc(input) \|\| isAtprotoDidWeb(input)\n}\n\nexport function asAtprotoDid<T>(input: T) {\n assertAtprotoDid(input)\n return input\n}\n\nexport function assertAtprotoDid(input: unknown): asserts input is AtprotoDid {\n if (typeof input !== 'string') {\n throw new InvalidDidError(typeof input, `DID must be a string`)\n } else if (input.startsWith(DID_PLC_PREFIX)) {\n assertDidPlc(input)\n } else if (input.startsWith(DID_WEB_PREFIX)) {\n assertAtprotoDidWeb(input)\n } else {\n throw new InvalidDidError(\n input,\n `Atproto only allows \"plc\" and \"web\" DID methods`,\n )\n }\n}\n\nexport function assertAtprotoDidWeb(\n input: unknown,\n): asserts input is Did<'web'> {\n assertDidWeb(input)\n\n if (isDidWebWithPath(input)) {\n throw new InvalidDidError(\n input,\n `Atproto does not allow path components in Web DIDs`,\n )\n }\n\n if (isDidWebWithHttpsPort(input)) {\n throw new InvalidDidError(\n input,\n `Atproto does not allow port numbers in Web DIDs, except for localhost`,\n )\n }\n}\n\n/*\n @see {@link https://atproto.com/specs/did#blessed-did-methods}\n /\nexport function isAtprotoDidWeb(input: unknown): input is Did<'web'> {\n if (!isDidWeb(input)) {\n return false\n }\n\n if (isDidWebWithPath(input)) {\n return false\n }\n\n if (isDidWebWithHttpsPort(input)) {\n return false\n }\n\n return true\n}\n\nfunction isDidWebWithPath(did: Did<'web'>): boolean {\n return did.includes(':', DID_WEB_PREFIX.length)\n}\n\nfunction isLocalhostDid(did: Did<'web'>): boolean {\n return (\n did === 'did:web:localhost' \|\|\n did.startsWith('did:web:localhost:') \|\|\n did.startsWith('did:web:localhost%3A')\n )\n}\n\nfunction isDidWebWithHttpsPort(did: Did<'web'>): boolean {\n if (isLocalhostDid(did)) return false\n\n const pathIdx = did.indexOf(':', DID_WEB_PREFIX.length)\n\n const hasPort =\n pathIdx === -1\n ? // No path component, check if there's a port separator anywhere after\n // the \"did:web:\" prefix\n did.includes('%3A', DID_WEB_PREFIX.length)\n : // There is a path component; if there is an encoded colon before* it,\n // then there is a port number\n did.lastIndexOf('%3A', pathIdx) !== -1\n\n return hasPort\n}\n\nexport type AtprotoAudience = `${AtprotoDid}#${string}`\nexport const isAtprotoAudience = (value: unknown): value is AtprotoAudience => {\n if (typeof value !== 'string') return false\n const hashIndex = value.indexOf('#')\n if (hashIndex === -1) return false\n if (value.indexOf('#', hashIndex + 1) !== -1) return false\n return (\n isFragment(value, hashIndex + 1) && isAtprotoDid(value.slice(0, hashIndex))\n )\n}\n\nexport type AtprotoData<\n M extends AtprotoIdentityDidMethods = AtprotoIdentityDidMethods,\n> = {\n did: Did<M>\n aka?: string\n key?: AtprotoVerificationMethod<M>\n pds?: AtprotoPersonalDataServerService<M>\n}\n\nexport function extractAtprotoData<M extends AtprotoIdentityDidMethods>(\n document: DidDocument<M>,\n): AtprotoData<M> {\n return {\n did: document.id,\n aka: document.alsoKnownAs?.find(isAtprotoAka)?.slice(5),\n key: document.verificationMethod?.find(\n isAtprotoVerificationMethod<M>,\n document,\n ),\n pds: document.service?.find(\n isAtprotoPersonalDataServerService<M>,\n document,\n ),\n }\n}\n\nexport function extractPdsUrl(document: AtprotoDidDocument): URL {\n const service = document.service?.find(\n isAtprotoPersonalDataServerService,\n document,\n )\n\n if (!service) {\n throw new DidError(\n document.id,\n `Document ${document.id} does not contain a (valid) #atproto_pds service URL`,\n 'did-service-not-found',\n )\n }\n\n return new URL(service.serviceEndpoint)\n}\n\nexport type AtprotoAka = `at://${string}`\nexport function isAtprotoAka(value: string): value is AtprotoAka {\n return value.startsWith('at://')\n}\n\nexport type AtprotoPersonalDataServerService<\n M extends AtprotoIdentityDidMethods = AtprotoIdentityDidMethods,\n> = DidService & {\n id: Identifier<Did<M>, 'atproto_pds'>\n type: 'AtprotoPersonalDataServer'\n serviceEndpoint: string\n}\n\nexport function isAtprotoPersonalDataServerService<\n M extends AtprotoIdentityDidMethods = AtprotoIdentityDidMethods,\n>(\n this: DidDocument<M>,\n service: null \| undefined \| DidService,\n): service is AtprotoPersonalDataServerService<M> {\n return (\n service?.type === 'AtprotoPersonalDataServer' &&\n typeof service.serviceEndpoint === 'string' &&\n canParse(service.serviceEndpoint) &&\n matchesIdentifier(this.id, 'atproto_pds', service.id)\n )\n}\n\nexport const ATPROTO_VERIFICATION_METHOD_TYPES = Object.freeze([\n 'EcdsaSecp256r1VerificationKey2019',\n 'EcdsaSecp256k1VerificationKey2019',\n 'Multikey',\n] as const)\nexport type SupportedAtprotoVerificationMethodType =\n (typeof ATPROTO_VERIFICATION_METHOD_TYPES)[number]\n\ntype VerificationMethod = NonNullable<DidDocument['verificationMethod']>[number]\nexport type AtprotoVerificationMethod<\n M extends AtprotoIdentityDidMethods = AtprotoIdentityDidMethods,\n> = Extract<VerificationMethod, object> & {\n id: Identifier<Did<M>, 'atproto'>\n type: SupportedAtprotoVerificationMethodType\n publicKeyMultibase: string\n}\n\nexport function isAtprotoVerificationMethod<\n M extends AtprotoIdentityDidMethods = AtprotoIdentityDidMethods,\n>(\n this: DidDocument<M>,\n method:\n \| null\n \| undefined\n \| NonNullable<DidDocument<M>['verificationMethod']>[number],\n): method is AtprotoVerificationMethod<M> {\n return (\n typeof method === 'object' &&\n typeof method?.publicKeyMultibase === 'string' &&\n (ATPROTO_VERIFICATION_METHOD_TYPES as readonly unknown[]).includes(\n method.type,\n ) &&\n matchesIdentifier(this.id, 'atproto', method.id)\n )\n}\n"]}
1	+ {"version":3,"file":"atproto.js","sourceRoot":"","sources":["../src/atproto.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAE1D,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AACnD,OAAO,EACL,cAAc,EACd,cAAc,EACd,YAAY,EACZ,YAAY,EACZ,QAAQ,EACR,QAAQ,GACT,MAAM,cAAc,CAAA;AACrB,OAAO,EAAc,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAQ1D,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC;KAC9B,MAAM,EAAE;KACR,MAAM,CAAC,YAAY,EAAE,iDAAiD,CAAC,CAAA;AAE1E,MAAM,UAAU,YAAY,CAAC,KAAc;IACzC,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,eAAe,CAAC,KAAK,CAAC,CAAA;AAClD,CAAC;AAED,MAAM,UAAU,YAAY,CAAI,KAAQ;IACtC,gBAAgB,CAAC,KAAK,CAAC,CAAA;IACvB,OAAO,KAAK,CAAA;AACd,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,KAAc;IAC7C,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,MAAM,IAAI,eAAe,CAAC,OAAO,KAAK,EAAE,sBAAsB,CAAC,CAAA;IACjE,CAAC;SAAM,IAAI,KAAK,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,CAAC;QAC5C,YAAY,CAAC,KAAK,CAAC,CAAA;IACrB,CAAC;SAAM,IAAI,KAAK,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,CAAC;QAC5C,mBAAmB,CAAC,KAAK,CAAC,CAAA;IAC5B,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,eAAe,CACvB,KAAK,EACL,iDAAiD,CAClD,CAAA;IACH,CAAC;AACH,CAAC;AAED,MAAM,UAAU,mBAAmB,CACjC,KAAc;IAEd,YAAY,CAAC,KAAK,CAAC,CAAA;IAEnB,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,eAAe,CACvB,KAAK,EACL,oDAAoD,CACrD,CAAA;IACH,CAAC;IAED,IAAI,qBAAqB,CAAC,KAAK,CAAC,EAAE,CAAC;QACjC,MAAM,IAAI,eAAe,CACvB,KAAK,EACL,uEAAuE,CACxE,CAAA;IACH,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,KAAc;IAC5C,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACrB,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC5B,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,qBAAqB,CAAC,KAAK,CAAC,EAAE,CAAC;QACjC,OAAO,KAAK,CAAA;IACd,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC;AAED,SAAS,gBAAgB,CAAC,GAAe;IACvC,OAAO,GAAG,CAAC,QAAQ,CAAC,GAAG,EAAE,cAAc,CAAC,MAAM,CAAC,CAAA;AACjD,CAAC;AAED,SAAS,cAAc,CAAC,GAAe;IACrC,OAAO,CACL,GAAG,KAAK,mBAAmB;QAC3B,GAAG,CAAC,UAAU,CAAC,oBAAoB,CAAC;QACpC,GAAG,CAAC,UAAU,CAAC,sBAAsB,CAAC,CACvC,CAAA;AACH,CAAC;AAED,SAAS,qBAAqB,CAAC,GAAe;IAC5C,IAAI,cAAc,CAAC,GAAG,CAAC;QAAE,OAAO,KAAK,CAAA;IAErC,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,cAAc,CAAC,MAAM,CAAC,CAAA;IAEvD,MAAM,OAAO,GACX,OAAO,KAAK,CAAC,CAAC;QACZ,CAAC,CAAC,sEAAsE;YACtE,wBAAwB;YACxB,GAAG,CAAC,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAC,MAAM,CAAC;QAC5C,CAAC,CAAC,uEAAuE;YACvE,8BAA8B;YAC9B,GAAG,CAAC,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAA;IAE5C,OAAO,OAAO,CAAA;AAChB,CAAC;AAGD,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,KAAc,EAA4B,EAAE;IAC5E,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAA;IAC3C,MAAM,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;IACpC,IAAI,SAAS,KAAK,CAAC,CAAC;QAAE,OAAO,KAAK,CAAA;IAClC,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;QAAE,OAAO,KAAK,CAAA;IAC1D,OAAO,CACL,UAAU,CAAC,KAAK,EAAE,SAAS,GAAG,CAAC,CAAC,IAAI,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAC5E,CAAA;AACH,CAAC,CAAA;AAWD,MAAM,UAAU,kBAAkB,CAChC,QAAwB;IAExB,OAAO;QACL,GAAG,EAAE,QAAQ,CAAC,EAAE;QAChB,GAAG,EAAE,QAAQ,CAAC,WAAW,EAAE,IAAI,CAAC,YAAY,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;QACvD,GAAG,EAAE,QAAQ,CAAC,kBAAkB,EAAE,IAAI,CACpC,CAAA,2BAA8B,CAAA,EAC9B,QAAQ,CACT;QACD,GAAG,EAAE,QAAQ,CAAC,OAAO,EAAE,IAAI,CACzB,CAAA,kCAAqC,CAAA,EACrC,QAAQ,CACT;KACF,CAAA;AACH,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,QAA4B;IACxD,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,EAAE,IAAI,CACpC,kCAAkC,EAClC,QAAQ,CACT,CAAA;IAED,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,QAAQ,CAChB,QAAQ,CAAC,EAAE,EACX,YAAY,QAAQ,CAAC,EAAE,sDAAsD,EAC7E,uBAAuB,CACxB,CAAA;IACH,CAAC;IAED,OAAO,IAAI,GAAG,CAAC,OAAO,CAAC,eAAe,CAAC,CAAA;AACzC,CAAC;AAGD,MAAM,UAAU,YAAY,CAAC,KAAa;IACxC,OAAO,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;AAClC,CAAC;AAUD,MAAM,UAAU,kCAAkC,CAIhD,OAAsC;IAEtC,OAAO,CACL,OAAO,EAAE,IAAI,KAAK,2BAA2B;QAC7C,OAAO,OAAO,CAAC,eAAe,KAAK,QAAQ;QAC3C,QAAQ,CAAC,OAAO,CAAC,eAAe,CAAC;QACjC,iBAAiB,CAAC,IAAI,CAAC,EAAE,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,CAAC,CACtD,CAAA;AACH,CAAC;AAED,MAAM,CAAC,MAAM,iCAAiC,GAAG,MAAM,CAAC,MAAM,CAAC;IAC7D,mCAAmC;IACnC,mCAAmC;IACnC,UAAU;CACF,CAAC,CAAA;AAaX,MAAM,UAAU,2BAA2B,CAIzC,MAG6D;IAE7D,OAAO,CACL,OAAO,MAAM,KAAK,QAAQ;QAC1B,OAAO,MAAM,EAAE,kBAAkB,KAAK,QAAQ;QAC7C,iCAAwD,CAAC,QAAQ,CAChE,MAAM,CAAC,IAAI,CACZ;QACD,iBAAiB,CAAC,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE,CAAC,CACjD,CAAA;AACH,CAAC","sourcesContent":["import { z } from 'zod'\nimport { DidDocument, DidService } from './did-document.js'\nimport { DidError, InvalidDidError } from './did-error.js'\nimport { Did } from './did.js'\nimport { canParse, isFragment } from './lib/uri.js'\nimport {\n DID_PLC_PREFIX,\n DID_WEB_PREFIX,\n assertDidPlc,\n assertDidWeb,\n isDidPlc,\n isDidWeb,\n} from './methods.js'\nimport { Identifier, matchesIdentifier } from './utils.js'\n\n// This file contains atproto-specific DID validation utilities.\n\nexport type AtprotoIdentityDidMethods = 'plc' \| 'web'\nexport type AtprotoDid = Did<AtprotoIdentityDidMethods>\nexport type AtprotoDidDocument = DidDocument<AtprotoIdentityDidMethods>\n\nexport const atprotoDidSchema = z\n .string()\n .refine(isAtprotoDid, `Atproto only allows \"plc\" and \"web\" DID methods`)\n\nexport function isAtprotoDid(input: unknown): input is AtprotoDid {\n return isDidPlc(input) \|\| isAtprotoDidWeb(input)\n}\n\nexport function asAtprotoDid<T>(input: T) {\n assertAtprotoDid(input)\n return input\n}\n\nexport function assertAtprotoDid(input: unknown): asserts input is AtprotoDid {\n if (typeof input !== 'string') {\n throw new InvalidDidError(typeof input, `DID must be a string`)\n } else if (input.startsWith(DID_PLC_PREFIX)) {\n assertDidPlc(input)\n } else if (input.startsWith(DID_WEB_PREFIX)) {\n assertAtprotoDidWeb(input)\n } else {\n throw new InvalidDidError(\n input,\n `Atproto only allows \"plc\" and \"web\" DID methods`,\n )\n }\n}\n\nexport function assertAtprotoDidWeb(\n input: unknown,\n): asserts input is Did<'web'> {\n assertDidWeb(input)\n\n if (isDidWebWithPath(input)) {\n throw new InvalidDidError(\n input,\n `Atproto does not allow path components in Web DIDs`,\n )\n }\n\n if (isDidWebWithHttpsPort(input)) {\n throw new InvalidDidError(\n input,\n `Atproto does not allow port numbers in Web DIDs, except for localhost`,\n )\n }\n}\n\n/*\n @see {@link https://atproto.com/specs/did#blessed-did-methods}\n /\nexport function isAtprotoDidWeb(input: unknown): input is Did<'web'> {\n if (!isDidWeb(input)) {\n return false\n }\n\n if (isDidWebWithPath(input)) {\n return false\n }\n\n if (isDidWebWithHttpsPort(input)) {\n return false\n }\n\n return true\n}\n\nfunction isDidWebWithPath(did: Did<'web'>): boolean {\n return did.includes(':', DID_WEB_PREFIX.length)\n}\n\nfunction isLocalhostDid(did: Did<'web'>): boolean {\n return (\n did === 'did:web:localhost' \|\|\n did.startsWith('did:web:localhost:') \|\|\n did.startsWith('did:web:localhost%3A')\n )\n}\n\nfunction isDidWebWithHttpsPort(did: Did<'web'>): boolean {\n if (isLocalhostDid(did)) return false\n\n const pathIdx = did.indexOf(':', DID_WEB_PREFIX.length)\n\n const hasPort =\n pathIdx === -1\n ? // No path component, check if there's a port separator anywhere after\n // the \"did:web:\" prefix\n did.includes('%3A', DID_WEB_PREFIX.length)\n : // There is a path component; if there is an encoded colon before* it,\n // then there is a port number\n did.lastIndexOf('%3A', pathIdx) !== -1\n\n return hasPort\n}\n\nexport type AtprotoAudience = `${AtprotoDid}#${string}`\nexport const isAtprotoAudience = (value: unknown): value is AtprotoAudience => {\n if (typeof value !== 'string') return false\n const hashIndex = value.indexOf('#')\n if (hashIndex === -1) return false\n if (value.indexOf('#', hashIndex + 1) !== -1) return false\n return (\n isFragment(value, hashIndex + 1) && isAtprotoDid(value.slice(0, hashIndex))\n )\n}\n\nexport type AtprotoData<\n M extends AtprotoIdentityDidMethods = AtprotoIdentityDidMethods,\n> = {\n did: Did<M>\n aka?: string\n key?: AtprotoVerificationMethod<M>\n pds?: AtprotoPersonalDataServerService<M>\n}\n\nexport function extractAtprotoData<M extends AtprotoIdentityDidMethods>(\n document: DidDocument<M>,\n): AtprotoData<M> {\n return {\n did: document.id,\n aka: document.alsoKnownAs?.find(isAtprotoAka)?.slice(5),\n key: document.verificationMethod?.find(\n isAtprotoVerificationMethod<M>,\n document,\n ),\n pds: document.service?.find(\n isAtprotoPersonalDataServerService<M>,\n document,\n ),\n }\n}\n\nexport function extractPdsUrl(document: AtprotoDidDocument): URL {\n const service = document.service?.find(\n isAtprotoPersonalDataServerService,\n document,\n )\n\n if (!service) {\n throw new DidError(\n document.id,\n `Document ${document.id} does not contain a (valid) #atproto_pds service URL`,\n 'did-service-not-found',\n )\n }\n\n return new URL(service.serviceEndpoint)\n}\n\nexport type AtprotoAka = `at://${string}`\nexport function isAtprotoAka(value: string): value is AtprotoAka {\n return value.startsWith('at://')\n}\n\nexport type AtprotoPersonalDataServerService<\n M extends AtprotoIdentityDidMethods = AtprotoIdentityDidMethods,\n> = DidService & {\n id: Identifier<Did<M>, 'atproto_pds'>\n type: 'AtprotoPersonalDataServer'\n serviceEndpoint: string\n}\n\nexport function isAtprotoPersonalDataServerService<\n M extends AtprotoIdentityDidMethods = AtprotoIdentityDidMethods,\n>(\n this: DidDocument<M>,\n service: null \| undefined \| DidService,\n): service is AtprotoPersonalDataServerService<M> {\n return (\n service?.type === 'AtprotoPersonalDataServer' &&\n typeof service.serviceEndpoint === 'string' &&\n canParse(service.serviceEndpoint) &&\n matchesIdentifier(this.id, 'atproto_pds', service.id)\n )\n}\n\nexport const ATPROTO_VERIFICATION_METHOD_TYPES = Object.freeze([\n 'EcdsaSecp256r1VerificationKey2019',\n 'EcdsaSecp256k1VerificationKey2019',\n 'Multikey',\n] as const)\nexport type SupportedAtprotoVerificationMethodType =\n (typeof ATPROTO_VERIFICATION_METHOD_TYPES)[number]\n\ntype VerificationMethod = NonNullable<DidDocument['verificationMethod']>[number]\nexport type AtprotoVerificationMethod<\n M extends AtprotoIdentityDidMethods = AtprotoIdentityDidMethods,\n> = Extract<VerificationMethod, object> & {\n id: Identifier<Did<M>, 'atproto'>\n type: SupportedAtprotoVerificationMethodType\n publicKeyMultibase: string\n}\n\nexport function isAtprotoVerificationMethod<\n M extends AtprotoIdentityDidMethods = AtprotoIdentityDidMethods,\n>(\n this: DidDocument<M>,\n method:\n \| null\n \| undefined\n \| NonNullable<DidDocument<M>['verificationMethod']>[number],\n): method is AtprotoVerificationMethod<M> {\n return (\n typeof method === 'object' &&\n typeof method?.publicKeyMultibase === 'string' &&\n (ATPROTO_VERIFICATION_METHOD_TYPES as readonly unknown[]).includes(\n method.type,\n ) &&\n matchesIdentifier(this.id, 'atproto', method.id)\n )\n}\n"]}

package/dist/did-document.d.ts CHANGED Viewed

@@ -23,7 +23,7 @@ export type DidService = z.infer<typeof didServiceSchema>;
  * @see {@link https://www.w3.org/TR/did-core/#production-0}
  */
 export declare const didDocumentSchema: z.ZodObject<{
-    '@context': z.ZodUnion<[z.ZodLiteral<"https://www.w3.org/ns/did/v1">, z.ZodEffects<z.ZodArray<z.ZodString, "atleastone">, [string, ...string[]], [string, ...string[]]>]>;
+    '@context': z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"https://www.w3.org/ns/did/v1">, z.ZodEffects<z.ZodArray<z.ZodString, "atleastone">, [string, ...string[]], [string, ...string[]]>]>>;
     id: z.ZodEffects<z.ZodString, `did:${string}:${string}`, string>;
     controller: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, `did:${string}:${string}`, string>, z.ZodArray<z.ZodEffects<z.ZodString, `did:${string}:${string}`, string>, "many">]>>;
     alsoKnownAs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
@@ -59,7 +59,7 @@ export declare const didDocumentSchema: z.ZodObject<{
         publicKeyJwk?: Record<string, unknown> | undefined;
         publicKeyMultibase?: string | undefined;
     }>]>, "many">>;
-    verificationMethod: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodObject<{
+    verificationMethod: z.ZodOptional<z.ZodArray<z.ZodObject<{
         id: z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>]>;
         type: z.ZodString;
         controller: z.ZodUnion<[z.ZodEffects<z.ZodString, `did:${string}:${string}`, string>, z.ZodArray<z.ZodEffects<z.ZodString, `did:${string}:${string}`, string>, "many">]>;
@@ -77,11 +77,11 @@ export declare const didDocumentSchema: z.ZodObject<{
         controller: string | string[];
         publicKeyJwk?: Record<string, unknown> | undefined;
         publicKeyMultibase?: string | undefined;
-    }>, z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>]>]>, "many">>;
+    }>, "many">>;
 }, "strip", z.ZodTypeAny, {
     id: `did:${string}:${string}`;
-    '@context': "https://www.w3.org/ns/did/v1" | [string, ...string[]];
     controller?: `did:${string}:${string}` | `did:${string}:${string}`[] | undefined;
+    '@context'?: "https://www.w3.org/ns/did/v1" | [string, ...string[]] | undefined;
     alsoKnownAs?: string[] | undefined;
     service?: {
         type: string | string[];
@@ -95,17 +95,17 @@ export declare const didDocumentSchema: z.ZodObject<{
         publicKeyJwk?: Record<string, unknown> | undefined;
         publicKeyMultibase?: string | undefined;
     })[] | undefined;
-    verificationMethod?: (string | {
+    verificationMethod?: {
         type: string;
         id: string;
         controller: `did:${string}:${string}` | `did:${string}:${string}`[];
         publicKeyJwk?: Record<string, unknown> | undefined;
         publicKeyMultibase?: string | undefined;
-    })[] | undefined;
+    }[] | undefined;
 }, {
     id: string;
-    '@context': "https://www.w3.org/ns/did/v1" | [string, ...string[]];
     controller?: string | string[] | undefined;
+    '@context'?: "https://www.w3.org/ns/did/v1" | [string, ...string[]] | undefined;
     alsoKnownAs?: string[] | undefined;
     service?: {
         type: string | string[];
@@ -119,19 +119,19 @@ export declare const didDocumentSchema: z.ZodObject<{
         publicKeyJwk?: Record<string, unknown> | undefined;
         publicKeyMultibase?: string | undefined;
     })[] | undefined;
-    verificationMethod?: (string | {
+    verificationMethod?: {
         type: string;
         id: string;
         controller: string | string[];
         publicKeyJwk?: Record<string, unknown> | undefined;
         publicKeyMultibase?: string | undefined;
-    })[] | undefined;
+    }[] | undefined;
 }>;
 export type DidDocument<Method extends string = string> = z.infer<typeof didDocumentSchema> & {
     id: Did<Method>;
 };
 export declare const didDocumentValidator: z.ZodEffects<z.ZodObject<{
-    '@context': z.ZodUnion<[z.ZodLiteral<"https://www.w3.org/ns/did/v1">, z.ZodEffects<z.ZodArray<z.ZodString, "atleastone">, [string, ...string[]], [string, ...string[]]>]>;
+    '@context': z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"https://www.w3.org/ns/did/v1">, z.ZodEffects<z.ZodArray<z.ZodString, "atleastone">, [string, ...string[]], [string, ...string[]]>]>>;
     id: z.ZodEffects<z.ZodString, `did:${string}:${string}`, string>;
     controller: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, `did:${string}:${string}`, string>, z.ZodArray<z.ZodEffects<z.ZodString, `did:${string}:${string}`, string>, "many">]>>;
     alsoKnownAs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
@@ -167,7 +167,7 @@ export declare const didDocumentValidator: z.ZodEffects<z.ZodObject<{
         publicKeyJwk?: Record<string, unknown> | undefined;
         publicKeyMultibase?: string | undefined;
     }>]>, "many">>;
-    verificationMethod: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodObject<{
+    verificationMethod: z.ZodOptional<z.ZodArray<z.ZodObject<{
         id: z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>]>;
         type: z.ZodString;
         controller: z.ZodUnion<[z.ZodEffects<z.ZodString, `did:${string}:${string}`, string>, z.ZodArray<z.ZodEffects<z.ZodString, `did:${string}:${string}`, string>, "many">]>;
@@ -185,11 +185,11 @@ export declare const didDocumentValidator: z.ZodEffects<z.ZodObject<{
         controller: string | string[];
         publicKeyJwk?: Record<string, unknown> | undefined;
         publicKeyMultibase?: string | undefined;
-    }>, z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>]>]>, "many">>;
+    }>, "many">>;
 }, "strip", z.ZodTypeAny, {
     id: `did:${string}:${string}`;
-    '@context': "https://www.w3.org/ns/did/v1" | [string, ...string[]];
     controller?: `did:${string}:${string}` | `did:${string}:${string}`[] | undefined;
+    '@context'?: "https://www.w3.org/ns/did/v1" | [string, ...string[]] | undefined;
     alsoKnownAs?: string[] | undefined;
     service?: {
         type: string | string[];
@@ -203,17 +203,17 @@ export declare const didDocumentValidator: z.ZodEffects<z.ZodObject<{
         publicKeyJwk?: Record<string, unknown> | undefined;
         publicKeyMultibase?: string | undefined;
     })[] | undefined;
-    verificationMethod?: (string | {
+    verificationMethod?: {
         type: string;
         id: string;
         controller: `did:${string}:${string}` | `did:${string}:${string}`[];
         publicKeyJwk?: Record<string, unknown> | undefined;
         publicKeyMultibase?: string | undefined;
-    })[] | undefined;
+    }[] | undefined;
 }, {
     id: string;
-    '@context': "https://www.w3.org/ns/did/v1" | [string, ...string[]];
     controller?: string | string[] | undefined;
+    '@context'?: "https://www.w3.org/ns/did/v1" | [string, ...string[]] | undefined;
     alsoKnownAs?: string[] | undefined;
     service?: {
         type: string | string[];
@@ -227,17 +227,17 @@ export declare const didDocumentValidator: z.ZodEffects<z.ZodObject<{
         publicKeyJwk?: Record<string, unknown> | undefined;
         publicKeyMultibase?: string | undefined;
     })[] | undefined;
-    verificationMethod?: (string | {
+    verificationMethod?: {
         type: string;
         id: string;
         controller: string | string[];
         publicKeyJwk?: Record<string, unknown> | undefined;
         publicKeyMultibase?: string | undefined;
-    })[] | undefined;
+    }[] | undefined;
 }>, {
     id: `did:${string}:${string}`;
-    '@context': "https://www.w3.org/ns/did/v1" | [string, ...string[]];
     controller?: `did:${string}:${string}` | `did:${string}:${string}`[] | undefined;
+    '@context'?: "https://www.w3.org/ns/did/v1" | [string, ...string[]] | undefined;
     alsoKnownAs?: string[] | undefined;
     service?: {
         type: string | string[];
@@ -251,17 +251,17 @@ export declare const didDocumentValidator: z.ZodEffects<z.ZodObject<{
         publicKeyJwk?: Record<string, unknown> | undefined;
         publicKeyMultibase?: string | undefined;
     })[] | undefined;
-    verificationMethod?: (string | {
+    verificationMethod?: {
         type: string;
         id: string;
         controller: `did:${string}:${string}` | `did:${string}:${string}`[];
         publicKeyJwk?: Record<string, unknown> | undefined;
         publicKeyMultibase?: string | undefined;
-    })[] | undefined;
+    }[] | undefined;
 }, {
     id: string;
-    '@context': "https://www.w3.org/ns/did/v1" | [string, ...string[]];
     controller?: string | string[] | undefined;
+    '@context'?: "https://www.w3.org/ns/did/v1" | [string, ...string[]] | undefined;
     alsoKnownAs?: string[] | undefined;
     service?: {
         type: string | string[];
@@ -275,13 +275,13 @@ export declare const didDocumentValidator: z.ZodEffects<z.ZodObject<{
         publicKeyJwk?: Record<string, unknown> | undefined;
         publicKeyMultibase?: string | undefined;
     })[] | undefined;
-    verificationMethod?: (string | {
+    verificationMethod?: {
         type: string;
         id: string;
         controller: string | string[];
         publicKeyJwk?: Record<string, unknown> | undefined;
         publicKeyMultibase?: string | undefined;
-    })[] | undefined;
+    }[] | undefined;
 }>;
 export {};
 //# sourceMappingURL=did-document.d.ts.map

package/dist/did-document.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"did-document.d.ts","sourceRoot":"","sources":["../src/did-document.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AACvB,OAAO,EAAE,GAAG,EAAa,MAAM,UAAU,CAAA;~~AA+EzC~~;;;GAGG;AACH,QAAA,MAAM,gBAAgB;;;;;;;;;;;;EAIpB,CAAA;AAEF,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;~~AAQzD~~;;;GAGG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;~~EAkB5B~~,CAAA;AAEF,MAAM,MAAM,WAAW,CAAC,MAAM,SAAS,MAAM,GAAG,MAAM,IAAI,CAAC,CAAC,KAAK,CAC/D,OAAO,iBAAiB,CACzB,GAAG;IAAE,EAAE,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;CAAE,CAAA;AAGvB,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAwB7B,CAAA"}
1	+ {"version":3,"file":"did-document.d.ts","sourceRoot":"","sources":["../src/did-document.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AACvB,OAAO,EAAE,GAAG,EAAa,MAAM,UAAU,CAAA;AAkFzC;;;GAGG;AACH,QAAA,MAAM,gBAAgB;;;;;;;;;;;;EAIpB,CAAA;AAEF,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;AAWzD;;;GAGG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAmB5B,CAAA;AAEF,MAAM,MAAM,WAAW,CAAC,MAAM,SAAS,MAAM,GAAG,MAAM,IAAI,CAAC,CAAC,KAAK,CAC/D,OAAO,iBAAiB,CACzB,GAAG;IAAE,EAAE,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;CAAE,CAAA;AAGvB,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAwB7B,CAAA"}

package/dist/did-document.js CHANGED Viewed

@@ -1,43 +1,43 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.didDocumentValidator = exports.didDocumentSchema = void 0;
-const zod_1 = require("zod");
-const did_js_1 = require("./did.js");
-const uri_js_1 = require("./lib/uri.js");
+import { z } from 'zod';
+import { didSchema } from './did.js';
+import { isFragment } from './lib/uri.js';
 /**
  * RFC3968 compliant URI
  *
  * @see {@link https://www.rfc-editor.org/rfc/rfc3986}
  */
-const rfc3968UriSchema = zod_1.z.string().url('RFC3968 compliant URI');
-const didControllerSchema = zod_1.z.union([did_js_1.didSchema, zod_1.z.array(did_js_1.didSchema)]);
+const rfc3968UriSchema = z.string().url('RFC3968 compliant URI');
+const didControllerSchema = z.union([didSchema, z.array(didSchema)]);
 /**
  * @note this schema is too permissive
  */
-const didRelativeUriSchema = zod_1.z.union([
+const didRelativeUriSchema = z.union([
     rfc3968UriSchema.refine((value) => {
         const fragmentIndex = value.indexOf('#');
         if (fragmentIndex === -1)
             return false;
-        return (0, uri_js_1.isFragment)(value, fragmentIndex + 1);
+        return isFragment(value, fragmentIndex + 1);
     }, {
         message: 'Missing or invalid fragment in RFC3968 URI',
     }),
-    zod_1.z
+    z
         .string()
         .refine((value) => value.charCodeAt(0) === 35 /* # */, {
         message: 'Fragment must start with #',
     })
-        .refine((value) => (0, uri_js_1.isFragment)(value, 1), {
+        .refine((value) => isFragment(value, 1), {
         message: 'Invalid char in URI fragment',
     }),
 ]);
-const didVerificationMethodSchema = zod_1.z.object({
+/**
+ * @see {@link https://www.w3.org/TR/did-1.0/#verification-material Verification Material}
+ */
+const didVerificationMethodSchema = z.object({
     id: didRelativeUriSchema,
-    type: zod_1.z.string().min(1),
+    type: z.string().min(1),
     controller: didControllerSchema,
-    publicKeyJwk: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()).optional(),
-    publicKeyMultibase: zod_1.z.string().optional(),
+    publicKeyJwk: z.record(z.string(), z.unknown()).optional(),
+    publicKeyMultibase: z.string().optional(),
 });
 /**
  * The value of the id property MUST be a URI conforming to [RFC3986]. A
@@ -56,7 +56,7 @@ const didServiceIdSchema = didRelativeUriSchema;
  * SHOULD be registered in the DID Specification Registries
  * [DID-SPEC-REGISTRIES].
  */
-const didServiceTypeSchema = zod_1.z.union([zod_1.z.string(), zod_1.z.array(zod_1.z.string())]);
+const didServiceTypeSchema = z.union([z.string(), z.array(z.string())]);
 /**
  * The value of the serviceEndpoint property MUST be a string, a map, or a set
  * composed of one or more strings and/or maps. All string values MUST be valid
@@ -64,23 +64,26 @@ const didServiceTypeSchema = zod_1.z.union([zod_1.z.string(), zod_1.z.array(zod_
  * and Comparison rules in RFC3986 and to any normalization rules in its
  * applicable URI scheme specification.
  */
-const didServiceEndpointSchema = zod_1.z.union([
+const didServiceEndpointSchema = z.union([
     rfc3968UriSchema,
-    zod_1.z.record(zod_1.z.string(), rfc3968UriSchema),
-    zod_1.z
-        .array(zod_1.z.union([rfc3968UriSchema, zod_1.z.record(zod_1.z.string(), rfc3968UriSchema)]))
+    z.record(z.string(), rfc3968UriSchema),
+    z
+        .array(z.union([rfc3968UriSchema, z.record(z.string(), rfc3968UriSchema)]))
         .nonempty(),
 ]);
 /**
  * Each service map MUST contain id, type, and serviceEndpoint properties.
  * @see {@link https://www.w3.org/TR/did-core/#services}
  */
-const didServiceSchema = zod_1.z.object({
+const didServiceSchema = z.object({
     id: didServiceIdSchema,
     type: didServiceTypeSchema,
     serviceEndpoint: didServiceEndpointSchema,
 });
-const didAuthenticationSchema = zod_1.z.union([
+/**
+ * @see {@link https://www.w3.org/TR/did-1.0/#referring-to-verification-methods Referring to Verification Methods}
+ */
+const verificationMethodReference = z.union([
     //
     didRelativeUriSchema,
     didVerificationMethodSchema,
@@ -89,27 +92,28 @@ const didAuthenticationSchema = zod_1.z.union([
  * @note This schema is incomplete
  * @see {@link https://www.w3.org/TR/did-core/#production-0}
  */
-exports.didDocumentSchema = zod_1.z.object({
-    '@context': zod_1.z.union([
-        zod_1.z.literal('https://www.w3.org/ns/did/v1'),
-        zod_1.z
-            .array(zod_1.z.string().url())
+export const didDocumentSchema = z.object({
+    '@context': z
+        .union([
+        z.literal('https://www.w3.org/ns/did/v1'),
+        z
+            .array(z.string().url())
             .nonempty()
             .refine((data) => data[0] === 'https://www.w3.org/ns/did/v1', {
             message: 'First @context must be https://www.w3.org/ns/did/v1',
         }),
-    ]),
-    id: did_js_1.didSchema,
-    controller: didControllerSchema.optional(),
-    alsoKnownAs: zod_1.z.array(rfc3968UriSchema).optional(),
-    service: zod_1.z.array(didServiceSchema).optional(),
-    authentication: zod_1.z.array(didAuthenticationSchema).optional(),
-    verificationMethod: zod_1.z
-        .array(zod_1.z.union([didVerificationMethodSchema, didRelativeUriSchema]))
+    ])
+        // @NOTE @context is required by producers, but optional for consumers.
         .optional(),
+    id: didSchema,
+    controller: didControllerSchema.optional(),
+    alsoKnownAs: z.array(rfc3968UriSchema).optional(),
+    service: z.array(didServiceSchema).optional(),
+    authentication: z.array(verificationMethodReference).optional(),
+    verificationMethod: z.array(didVerificationMethodSchema).optional(),
 });
 // @TODO: add other refinements ?
-exports.didDocumentValidator = exports.didDocumentSchema
+export const didDocumentValidator = didDocumentSchema
     // Ensure that every service id is unique
     .superRefine(({ id: did, service }, ctx) => {
     if (service) {
@@ -124,7 +128,7 @@ exports.didDocumentValidator = exports.didDocumentSchema
             }
             else {
                 ctx.addIssue({
-                    code: zod_1.z.ZodIssueCode.custom,
+                    code: z.ZodIssueCode.custom,
                     message: `Duplicate service id (${current.id}) found in the document`,
                     path: ['service', i, 'id'],
                 });