@atproto/did 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @atproto/did
+
+## 0.1.0
+
+### Minor Changes
+
+- [#2482](https://github.com/bluesky-social/atproto/pull/2482) [`a8d6c1123`](https://github.com/bluesky-social/atproto/commit/a8d6c112359f5c4c0cfbe2df63443ed275f2a646) Thanks [@matthieusieben](https://github.com/matthieusieben)! - Add OAuth provider capability & support for DPoP signed tokens

package/LICENSE.txt

@@ -0,0 +1,7 @@
+Dual MIT/Apache-2.0 License
+
+Copyright (c) 2022-2024 Bluesky 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>).
+
+Downstream projects and end users may chose either license individually, or both together, at their discretion. The motivation for this dual-licensing is the additional software patent assurance provided by Apache 2.0.

package/dist/did-document.d.ts

@@ -0,0 +1,335 @@
+import { z } from 'zod';
+import { Did } from './did.js';
+/**
+ * Each service map MUST contain id, type, and serviceEndpoint properties.
+ * @see {@link https://www.w3.org/TR/did-core/#services}
+ */
+declare const didServiceSchema: z.ZodObject<{
+    id: z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodString]>;
+    type: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>;
+    serviceEndpoint: z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodString, string, string>>, z.ZodArray<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodString, string, string>>]>, "atleastone">]>;
+}, "strip", z.ZodTypeAny, {
+    type: string | string[];
+    id: string;
+    serviceEndpoint: string | Record<string, string> | [string | Record<string, string>, ...(string | Record<string, string>)[]];
+}, {
+    type: string | string[];
+    id: string;
+    serviceEndpoint: string | Record<string, string> | [string | Record<string, string>, ...(string | Record<string, string>)[]];
+}>;
+export type DidService = z.infer<typeof didServiceSchema>;
+/**
+ * @note This schema is incomplete
+ * @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[]]>]>;
+    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.ZodEffects<z.ZodString, string, string>, "many">>;
+    service: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodString]>;
+        type: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>;
+        serviceEndpoint: z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodString, string, string>>, z.ZodArray<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodString, string, string>>]>, "atleastone">]>;
+    }, "strip", z.ZodTypeAny, {
+        type: string | string[];
+        id: string;
+        serviceEndpoint: string | Record<string, string> | [string | Record<string, string>, ...(string | Record<string, string>)[]];
+    }, {
+        type: string | string[];
+        id: string;
+        serviceEndpoint: string | Record<string, string> | [string | Record<string, string>, ...(string | Record<string, string>)[]];
+    }>, "many">>;
+    authentication: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodString]>, z.ZodObject<{
+        id: z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodString]>;
+        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">]>;
+        publicKeyJwk: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        publicKeyMultibase: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        id: string;
+        controller: `did:${string}:${string}` | `did:${string}:${string}`[];
+        publicKeyJwk?: Record<string, unknown> | undefined;
+        publicKeyMultibase?: string | undefined;
+    }, {
+        type: string;
+        id: string;
+        controller: string | string[];
+        publicKeyJwk?: Record<string, unknown> | undefined;
+        publicKeyMultibase?: string | undefined;
+    }>]>, "many">>;
+    verificationMethod: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodObject<{
+        id: z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodString]>;
+        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">]>;
+        publicKeyJwk: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        publicKeyMultibase: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        id: string;
+        controller: `did:${string}:${string}` | `did:${string}:${string}`[];
+        publicKeyJwk?: Record<string, unknown> | undefined;
+        publicKeyMultibase?: string | undefined;
+    }, {
+        type: string;
+        id: string;
+        controller: string | string[];
+        publicKeyJwk?: Record<string, unknown> | undefined;
+        publicKeyMultibase?: string | undefined;
+    }>, z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodString]>]>, "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;
+    alsoKnownAs?: string[] | undefined;
+    service?: {
+        type: string | string[];
+        id: string;
+        serviceEndpoint: string | Record<string, string> | [string | Record<string, string>, ...(string | Record<string, string>)[]];
+    }[] | undefined;
+    authentication?: (string | {
+        type: string;
+        id: string;
+        controller: `did:${string}:${string}` | `did:${string}:${string}`[];
+        publicKeyJwk?: Record<string, unknown> | undefined;
+        publicKeyMultibase?: string | undefined;
+    })[] | undefined;
+    verificationMethod?: (string | {
+        type: string;
+        id: string;
+        controller: `did:${string}:${string}` | `did:${string}:${string}`[];
+        publicKeyJwk?: Record<string, unknown> | undefined;
+        publicKeyMultibase?: string | undefined;
+    })[] | undefined;
+}, {
+    id: string;
+    '@context': "https://www.w3.org/ns/did/v1" | [string, ...string[]];
+    controller?: string | string[] | undefined;
+    alsoKnownAs?: string[] | undefined;
+    service?: {
+        type: string | string[];
+        id: string;
+        serviceEndpoint: string | Record<string, string> | [string | Record<string, string>, ...(string | Record<string, string>)[]];
+    }[] | undefined;
+    authentication?: (string | {
+        type: string;
+        id: string;
+        controller: string | string[];
+        publicKeyJwk?: Record<string, unknown> | undefined;
+        publicKeyMultibase?: string | undefined;
+    })[] | undefined;
+    verificationMethod?: (string | {
+        type: string;
+        id: string;
+        controller: string | string[];
+        publicKeyJwk?: Record<string, unknown> | undefined;
+        publicKeyMultibase?: string | undefined;
+    })[] | undefined;
+}>;
+export type DidDocument<Method extends string = string> = z.infer<typeof didDocumentSchema> & {
+    id: Did<Method>;
+};
+export declare const didDocumentValidator: z.ZodEffects<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[]]>]>;
+    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.ZodEffects<z.ZodString, string, string>, "many">>;
+    service: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodString]>;
+        type: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>;
+        serviceEndpoint: z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodString, string, string>>, z.ZodArray<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodString, string, string>>]>, "atleastone">]>;
+    }, "strip", z.ZodTypeAny, {
+        type: string | string[];
+        id: string;
+        serviceEndpoint: string | Record<string, string> | [string | Record<string, string>, ...(string | Record<string, string>)[]];
+    }, {
+        type: string | string[];
+        id: string;
+        serviceEndpoint: string | Record<string, string> | [string | Record<string, string>, ...(string | Record<string, string>)[]];
+    }>, "many">>;
+    authentication: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodString]>, z.ZodObject<{
+        id: z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodString]>;
+        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">]>;
+        publicKeyJwk: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        publicKeyMultibase: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        id: string;
+        controller: `did:${string}:${string}` | `did:${string}:${string}`[];
+        publicKeyJwk?: Record<string, unknown> | undefined;
+        publicKeyMultibase?: string | undefined;
+    }, {
+        type: string;
+        id: string;
+        controller: string | string[];
+        publicKeyJwk?: Record<string, unknown> | undefined;
+        publicKeyMultibase?: string | undefined;
+    }>]>, "many">>;
+    verificationMethod: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodObject<{
+        id: z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodString]>;
+        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">]>;
+        publicKeyJwk: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        publicKeyMultibase: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        id: string;
+        controller: `did:${string}:${string}` | `did:${string}:${string}`[];
+        publicKeyJwk?: Record<string, unknown> | undefined;
+        publicKeyMultibase?: string | undefined;
+    }, {
+        type: string;
+        id: string;
+        controller: string | string[];
+        publicKeyJwk?: Record<string, unknown> | undefined;
+        publicKeyMultibase?: string | undefined;
+    }>, z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodString]>]>, "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;
+    alsoKnownAs?: string[] | undefined;
+    service?: {
+        type: string | string[];
+        id: string;
+        serviceEndpoint: string | Record<string, string> | [string | Record<string, string>, ...(string | Record<string, string>)[]];
+    }[] | undefined;
+    authentication?: (string | {
+        type: string;
+        id: string;
+        controller: `did:${string}:${string}` | `did:${string}:${string}`[];
+        publicKeyJwk?: Record<string, unknown> | undefined;
+        publicKeyMultibase?: string | undefined;
+    })[] | undefined;
+    verificationMethod?: (string | {
+        type: string;
+        id: string;
+        controller: `did:${string}:${string}` | `did:${string}:${string}`[];
+        publicKeyJwk?: Record<string, unknown> | undefined;
+        publicKeyMultibase?: string | undefined;
+    })[] | undefined;
+}, {
+    id: string;
+    '@context': "https://www.w3.org/ns/did/v1" | [string, ...string[]];
+    controller?: string | string[] | undefined;
+    alsoKnownAs?: string[] | undefined;
+    service?: {
+        type: string | string[];
+        id: string;
+        serviceEndpoint: string | Record<string, string> | [string | Record<string, string>, ...(string | Record<string, string>)[]];
+    }[] | undefined;
+    authentication?: (string | {
+        type: string;
+        id: string;
+        controller: string | string[];
+        publicKeyJwk?: Record<string, unknown> | undefined;
+        publicKeyMultibase?: string | undefined;
+    })[] | undefined;
+    verificationMethod?: (string | {
+        type: string;
+        id: string;
+        controller: string | string[];
+        publicKeyJwk?: Record<string, unknown> | undefined;
+        publicKeyMultibase?: string | undefined;
+    })[] | undefined;
+}>, {
+    id: `did:${string}:${string}`;
+    '@context': "https://www.w3.org/ns/did/v1" | [string, ...string[]];
+    controller?: `did:${string}:${string}` | `did:${string}:${string}`[] | undefined;
+    alsoKnownAs?: string[] | undefined;
+    service?: {
+        type: string | string[];
+        id: string;
+        serviceEndpoint: string | Record<string, string> | [string | Record<string, string>, ...(string | Record<string, string>)[]];
+    }[] | undefined;
+    authentication?: (string | {
+        type: string;
+        id: string;
+        controller: `did:${string}:${string}` | `did:${string}:${string}`[];
+        publicKeyJwk?: Record<string, unknown> | undefined;
+        publicKeyMultibase?: string | undefined;
+    })[] | undefined;
+    verificationMethod?: (string | {
+        type: string;
+        id: string;
+        controller: `did:${string}:${string}` | `did:${string}:${string}`[];
+        publicKeyJwk?: Record<string, unknown> | undefined;
+        publicKeyMultibase?: string | undefined;
+    })[] | undefined;
+}, {
+    id: string;
+    '@context': "https://www.w3.org/ns/did/v1" | [string, ...string[]];
+    controller?: string | string[] | undefined;
+    alsoKnownAs?: string[] | undefined;
+    service?: {
+        type: string | string[];
+        id: string;
+        serviceEndpoint: string | Record<string, string> | [string | Record<string, string>, ...(string | Record<string, string>)[]];
+    }[] | undefined;
+    authentication?: (string | {
+        type: string;
+        id: string;
+        controller: string | string[];
+        publicKeyJwk?: Record<string, unknown> | undefined;
+        publicKeyMultibase?: string | undefined;
+    })[] | undefined;
+    verificationMethod?: (string | {
+        type: string;
+        id: string;
+        controller: string | string[];
+        publicKeyJwk?: Record<string, unknown> | undefined;
+        publicKeyMultibase?: string | undefined;
+    })[] | undefined;
+}>, {
+    id: `did:${string}:${string}`;
+    '@context': "https://www.w3.org/ns/did/v1" | [string, ...string[]];
+    controller?: `did:${string}:${string}` | `did:${string}:${string}`[] | undefined;
+    alsoKnownAs?: string[] | undefined;
+    service?: {
+        type: string | string[];
+        id: string;
+        serviceEndpoint: string | Record<string, string> | [string | Record<string, string>, ...(string | Record<string, string>)[]];
+    }[] | undefined;
+    authentication?: (string | {
+        type: string;
+        id: string;
+        controller: `did:${string}:${string}` | `did:${string}:${string}`[];
+        publicKeyJwk?: Record<string, unknown> | undefined;
+        publicKeyMultibase?: string | undefined;
+    })[] | undefined;
+    verificationMethod?: (string | {
+        type: string;
+        id: string;
+        controller: `did:${string}:${string}` | `did:${string}:${string}`[];
+        publicKeyJwk?: Record<string, unknown> | undefined;
+        publicKeyMultibase?: string | undefined;
+    })[] | undefined;
+}, {
+    id: string;
+    '@context': "https://www.w3.org/ns/did/v1" | [string, ...string[]];
+    controller?: string | string[] | undefined;
+    alsoKnownAs?: string[] | undefined;
+    service?: {
+        type: string | string[];
+        id: string;
+        serviceEndpoint: string | Record<string, string> | [string | Record<string, string>, ...(string | Record<string, string>)[]];
+    }[] | undefined;
+    authentication?: (string | {
+        type: string;
+        id: string;
+        controller: string | string[];
+        publicKeyJwk?: Record<string, unknown> | undefined;
+        publicKeyMultibase?: string | undefined;
+    })[] | undefined;
+    verificationMethod?: (string | {
+        type: string;
+        id: string;
+        controller: string | string[];
+        publicKeyJwk?: Record<string, unknown> | undefined;
+        publicKeyMultibase?: string | undefined;
+    })[] | undefined;
+}>;
+export {};
+//# sourceMappingURL=did-document.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"did-document.d.ts","sourceRoot":"","sources":["../src/did-document.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EAAE,GAAG,EAAa,MAAM,UAAU,CAAA;AAqEzC;;;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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAgC7B,CAAA"}

package/dist/did-document.js

@@ -0,0 +1,135 @@
+"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");
+/**
+ * RFC3968 compliant URI
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc3986}
+ */
+const rfc3968UriSchema = zod_1.z.string().refine((data) => {
+    try {
+        new URL(data);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}, 'RFC3968 compliant URI');
+const didControllerSchema = zod_1.z.union([did_js_1.didSchema, zod_1.z.array(did_js_1.didSchema)]);
+/**
+ * @note this schema might be too permissive
+ */
+const didRelativeUriSchema = zod_1.z.union([
+    rfc3968UriSchema,
+    zod_1.z.string().regex(/^#[^#]+$/),
+]);
+const didVerificationMethodSchema = zod_1.z.object({
+    id: didRelativeUriSchema,
+    type: zod_1.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(),
+});
+/**
+ * The value of the id property MUST be a URI conforming to [RFC3986]. A
+ * conforming producer MUST NOT produce multiple service entries with the same
+ * id. A conforming consumer MUST produce an error if it detects multiple
+ * service entries with the same id.
+ *
+ * @note Normally, only rfc3968UriSchema should be allowed here. However, the
+ *   did:plc uses relative URI. For this reason, we also allow relative URIs
+ *   here.
+ */
+const didServiceIdSchema = didRelativeUriSchema;
+/**
+ * The value of the type property MUST be a string or a set of strings. In order
+ * to maximize interoperability, the service type and its associated properties
+ * 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())]);
+/**
+ * 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
+ * URIs conforming to [RFC3986] and normalized according to the Normalization
+ * and Comparison rules in RFC3986 and to any normalization rules in its
+ * applicable URI scheme specification.
+ */
+const didServiceEndpointSchema = zod_1.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)]))
+        .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({
+    id: didServiceIdSchema,
+    type: didServiceTypeSchema,
+    serviceEndpoint: didServiceEndpointSchema,
+});
+const didAuthenticationSchema = zod_1.z.union([
+    //
+    didRelativeUriSchema,
+    didVerificationMethodSchema,
+]);
+/**
+ * @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())
+            .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]))
+        .optional(),
+});
+// @TODO: add other refinements ?
+exports.didDocumentValidator = exports.didDocumentSchema
+    .superRefine((data, ctx) => {
+    if (data.service) {
+        for (let i = 0; i < data.service.length; i++) {
+            if (data.service[i].id === data.id) {
+                ctx.addIssue({
+                    code: zod_1.z.ZodIssueCode.custom,
+                    message: `Service id must be different from the document id`,
+                    path: ['service', i, 'id'],
+                });
+            }
+        }
+    }
+})
+    .superRefine((data, ctx) => {
+    if (data.service) {
+        const normalizedIds = data.service.map((s) => s.id?.startsWith('#') ? `${data.id}${s.id}` : s.id);
+        for (let i = 0; i < normalizedIds.length; i++) {
+            for (let j = i + 1; j < normalizedIds.length; j++) {
+                if (normalizedIds[i] === normalizedIds[j]) {
+                    ctx.addIssue({
+                        code: zod_1.z.ZodIssueCode.custom,
+                        message: `Duplicate service id (${normalizedIds[j]}) found in the document`,
+                        path: ['service', j, 'id'],
+                    });
+                }
+            }
+        }
+    }
+});
+//# sourceMappingURL=did-document.js.map

package/dist/did-document.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"did-document.js","sourceRoot":"","sources":["../src/did-document.ts"],"names":[],"mappings":";;;AAAA,6BAAuB;AAEvB,qCAAyC;AAEzC;;;;GAIG;AACH,MAAM,gBAAgB,GAAG,OAAC,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;IAClD,IAAI,CAAC;QACH,IAAI,GAAG,CAAC,IAAI,CAAC,CAAA;QACb,OAAO,IAAI,CAAA;IACb,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAA;IACd,CAAC;AACH,CAAC,EAAE,uBAAuB,CAAC,CAAA;AAE3B,MAAM,mBAAmB,GAAG,OAAC,CAAC,KAAK,CAAC,CAAC,kBAAS,EAAE,OAAC,CAAC,KAAK,CAAC,kBAAS,CAAC,CAAC,CAAC,CAAA;AAEpE;;GAEG;AACH,MAAM,oBAAoB,GAAG,OAAC,CAAC,KAAK,CAAC;IACnC,gBAAgB;IAChB,OAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC;CAC7B,CAAC,CAAA;AAEF,MAAM,2BAA2B,GAAG,OAAC,CAAC,MAAM,CAAC;IAC3C,EAAE,EAAE,oBAAoB;IACxB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACvB,UAAU,EAAE,mBAAmB;IAC/B,YAAY,EAAE,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC1D,kBAAkB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC1C,CAAC,CAAA;AAEF;;;;;;;;;GASG;AACH,MAAM,kBAAkB,GAAG,oBAAoB,CAAA;AAE/C;;;;;GAKG;AACH,MAAM,oBAAoB,GAAG,OAAC,CAAC,KAAK,CAAC,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAA;AAEvE;;;;;;GAMG;AACH,MAAM,wBAAwB,GAAG,OAAC,CAAC,KAAK,CAAC;IACvC,gBAAgB;IAChB,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,gBAAgB,CAAC;IACtC,OAAC;SACE,KAAK,CAAC,OAAC,CAAC,KAAK,CAAC,CAAC,gBAAgB,EAAE,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC;SAC1E,QAAQ,EAAE;CACd,CAAC,CAAA;AAEF;;;GAGG;AACH,MAAM,gBAAgB,GAAG,OAAC,CAAC,MAAM,CAAC;IAChC,EAAE,EAAE,kBAAkB;IACtB,IAAI,EAAE,oBAAoB;IAC1B,eAAe,EAAE,wBAAwB;CAC1C,CAAC,CAAA;AAIF,MAAM,uBAAuB,GAAG,OAAC,CAAC,KAAK,CAAC;IACtC,EAAE;IACF,oBAAoB;IACpB,2BAA2B;CAC5B,CAAC,CAAA;AAEF;;;GAGG;AACU,QAAA,iBAAiB,GAAG,OAAC,CAAC,MAAM,CAAC;IACxC,UAAU,EAAE,OAAC,CAAC,KAAK,CAAC;QAClB,OAAC,CAAC,OAAO,CAAC,8BAA8B,CAAC;QACzC,OAAC;aACE,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC;aACvB,QAAQ,EAAE;aACV,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,8BAA8B,EAAE;YAC5D,OAAO,EAAE,qDAAqD;SAC/D,CAAC;KACL,CAAC;IACF,EAAE,EAAE,kBAAS;IACb,UAAU,EAAE,mBAAmB,CAAC,QAAQ,EAAE;IAC1C,WAAW,EAAE,OAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,QAAQ,EAAE;IACjD,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,QAAQ,EAAE;IAC7C,cAAc,EAAE,OAAC,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC,QAAQ,EAAE;IAC3D,kBAAkB,EAAE,OAAC;SAClB,KAAK,CAAC,OAAC,CAAC,KAAK,CAAC,CAAC,2BAA2B,EAAE,oBAAoB,CAAC,CAAC,CAAC;SACnE,QAAQ,EAAE;CACd,CAAC,CAAA;AAMF,iCAAiC;AACpB,QAAA,oBAAoB,GAAG,yBAAiB;KAClD,WAAW,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;IACzB,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;QACjB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC7C,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,EAAE,CAAC;gBACnC,GAAG,CAAC,QAAQ,CAAC;oBACX,IAAI,EAAE,OAAC,CAAC,YAAY,CAAC,MAAM;oBAC3B,OAAO,EAAE,mDAAmD;oBAC5D,IAAI,EAAE,CAAC,SAAS,EAAE,CAAC,EAAE,IAAI,CAAC;iBAC3B,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC,CAAC;KACD,WAAW,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;IACzB,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;QACjB,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAC3C,CAAC,CAAC,EAAE,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CACnD,CAAA;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,aAAa,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC9C,KAAK,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,aAAa,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAClD,IAAI,aAAa,CAAC,CAAC,CAAC,KAAK,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC;oBAC1C,GAAG,CAAC,QAAQ,CAAC;wBACX,IAAI,EAAE,OAAC,CAAC,YAAY,CAAC,MAAM;wBAC3B,OAAO,EAAE,yBAAyB,aAAa,CAAC,CAAC,CAAC,yBAAyB;wBAC3E,IAAI,EAAE,CAAC,SAAS,EAAE,CAAC,EAAE,IAAI,CAAC;qBAC3B,CAAC,CAAA;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC,CAAC,CAAA"}

package/dist/did-error.d.ts

@@ -0,0 +1,16 @@
+export declare class DidError extends Error {
+    readonly did: string;
+    readonly code: string;
+    readonly status: number;
+    constructor(did: string, message: string, code: string, status?: number, cause?: unknown);
+    /**
+     * For compatibility with error handlers in common HTTP frameworks.
+     */
+    get statusCode(): number;
+    toString(): string;
+    static from(cause: unknown, did: string): DidError;
+}
+export declare class InvalidDidError extends DidError {
+    constructor(did: string, message: string, cause?: unknown);
+}
+//# sourceMappingURL=did-error.d.ts.map

package/dist/did-error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"did-error.d.ts","sourceRoot":"","sources":["../src/did-error.ts"],"names":[],"mappings":"AAAA,qBAAa,QAAS,SAAQ,KAAK;aAEf,GAAG,EAAE,MAAM;aAEX,IAAI,EAAE,MAAM;aACZ,MAAM;gBAHN,GAAG,EAAE,MAAM,EAC3B,OAAO,EAAE,MAAM,EACC,IAAI,EAAE,MAAM,EACZ,MAAM,SAAM,EAC5B,KAAK,CAAC,EAAE,OAAO;IAKjB;;OAEG;IACH,IAAI,UAAU,WAEb;IAEQ,QAAQ;IAIjB,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,GAAG,QAAQ;CAoBnD;AAED,qBAAa,eAAgB,SAAQ,QAAQ;gBAC/B,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,OAAO;CAG1D"}

package/dist/did-error.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InvalidDidError = exports.DidError = void 0;
+class DidError extends Error {
+    constructor(did, message, code, status = 400, cause) {
+        super(message, { cause });
+        Object.defineProperty(this, "did", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: did
+        });
+        Object.defineProperty(this, "code", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: code
+        });
+        Object.defineProperty(this, "status", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: status
+        });
+    }
+    /**
+     * For compatibility with error handlers in common HTTP frameworks.
+     */
+    get statusCode() {
+        return this.status;
+    }
+    toString() {
+        return `${this.constructor.name} ${this.code} (${this.did}): ${this.message}`;
+    }
+    static from(cause, did) {
+        if (cause instanceof DidError) {
+            return cause;
+        }
+        const message = cause instanceof Error
+            ? cause.message
+            : typeof cause === 'string'
+                ? cause
+                : 'An unknown error occurred';
+        const status = (typeof cause?.['statusCode'] === 'number'
+            ? cause['statusCode']
+            : undefined) ??
+            (typeof cause?.['status'] === 'number' ? cause['status'] : undefined);
+        return new DidError(did, message, 'did-unknown-error', status, cause);
+    }
+}
+exports.DidError = DidError;
+class InvalidDidError extends DidError {
+    constructor(did, message, cause) {
+        super(did, message, 'did-invalid', 400, cause);
+    }
+}
+exports.InvalidDidError = InvalidDidError;
+//# sourceMappingURL=did-error.js.map

package/dist/did-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"did-error.js","sourceRoot":"","sources":["../src/did-error.ts"],"names":[],"mappings":";;;AAAA,MAAa,QAAS,SAAQ,KAAK;IACjC,YACkB,GAAW,EAC3B,OAAe,EACC,IAAY,EACZ,SAAS,GAAG,EAC5B,KAAe;QAEf,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAA;QANzB;;;;mBAAgB,GAAG;WAAQ;QAE3B;;;;mBAAgB,IAAI;WAAQ;QAC5B;;;;mBAAgB,MAAM;WAAM;IAI9B,CAAC;IAED;;OAEG;IACH,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,MAAM,CAAA;IACpB,CAAC;IAEQ,QAAQ;QACf,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE,CAAA;IAC/E,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,KAAc,EAAE,GAAW;QACrC,IAAI,KAAK,YAAY,QAAQ,EAAE,CAAC;YAC9B,OAAO,KAAK,CAAA;QACd,CAAC;QAED,MAAM,OAAO,GACX,KAAK,YAAY,KAAK;YACpB,CAAC,CAAC,KAAK,CAAC,OAAO;YACf,CAAC,CAAC,OAAO,KAAK,KAAK,QAAQ;gBACzB,CAAC,CAAC,KAAK;gBACP,CAAC,CAAC,2BAA2B,CAAA;QAEnC,MAAM,MAAM,GACV,CAAC,OAAO,KAAK,EAAE,CAAC,YAAY,CAAC,KAAK,QAAQ;YACxC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC;YACrB,CAAC,CAAC,SAAS,CAAC;YACd,CAAC,OAAO,KAAK,EAAE,CAAC,QAAQ,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;QAEvE,OAAO,IAAI,QAAQ,CAAC,GAAG,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,EAAE,KAAK,CAAC,CAAA;IACvE,CAAC;CACF;AA1CD,4BA0CC;AAED,MAAa,eAAgB,SAAQ,QAAQ;IAC3C,YAAY,GAAW,EAAE,OAAe,EAAE,KAAe;QACvD,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,aAAa,EAAE,GAAG,EAAE,KAAK,CAAC,CAAA;IAChD,CAAC;CACF;AAJD,0CAIC"}

package/dist/did.d.ts

@@ -0,0 +1,56 @@
+import { z } from 'zod';
+declare const DID_PREFIX = "did:";
+export { DID_PREFIX };
+/**
+ * Type representation of a Did, with method.
+ *
+ * ```bnf
+ * did                = "did:" method-name ":" method-specific-id
+ * method-name        = 1*method-char
+ * method-char        = %x61-7A / DIGIT
+ * method-specific-id = *( *idchar ":" ) 1*idchar
+ * idchar             = ALPHA / DIGIT / "." / "-" / "_" / pct-encoded
+ * pct-encoded        = "%" HEXDIG HEXDIG
+ * ```
+ *
+ * @example
+ * ```ts
+ * type DidWeb = Did<'web'> // `did:web:${string}`
+ * type DidCustom = Did<'web' | 'plc'> // `did:${'web' | 'plc'}:${string}`
+ * type DidNever = Did<' invalid 🥴 '> // never
+ * type DidFoo = Did<'foo' | ' invalid 🥴 '> // `did:foo:${string}`
+ * ```
+ *
+ * @see {@link https://www.w3.org/TR/did-core/#did-syntax}
+ */
+export type Did<M extends string = string> = `did:${AsDidMethod<M>}:${string}`;
+/**
+ * DID Method
+ */
+export type AsDidMethod<M> = string extends M ? string : AsDidMethodInternal<M, ''>;
+type AlphanumericChar = DigitChar | LowerAlphaChar;
+type DigitChar = '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9';
+type LowerAlphaChar = 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | 'h' | 'i' | 'j' | 'k' | 'l' | 'm' | 'n' | 'o' | 'p' | 'q' | 'r' | 's' | 't' | 'u' | 'v' | 'w' | 'x' | 'y' | 'z';
+type AsDidMethodInternal<S, Acc extends string> = S extends `${infer H}${infer T}` ? H extends AlphanumericChar ? AsDidMethodInternal<T, `${Acc}${H}`> : never : Acc extends '' ? never : Acc;
+/**
+ * DID Method-name check function.
+ *
+ * Check if the input is a valid DID method name, at the position between
+ * `start` (inclusive) and `end` (exclusive).
+ */
+export declare function checkDidMethod(input: string, start?: number, end?: number): void;
+/**
+ * This method assumes the input is a valid Did
+ */
+export declare function extractDidMethod<D extends Did>(did: D): D extends `did:${AsDidMethod<infer M extends string>}:${string}` ? M : string;
+/**
+ * DID Method-specific identifier check function.
+ *
+ * Check if the input is a valid DID method-specific identifier, at the position
+ * between `start` (inclusive) and `end` (exclusive).
+ */
+export declare function checkDidMsid(input: string, start?: number, end?: number): void;
+export declare function checkDid(input: unknown): asserts input is Did;
+export declare function isDid(input: unknown): input is Did;
+export declare const didSchema: z.ZodEffects<z.ZodString, `did:${string}:${string}`, string>;
+//# sourceMappingURL=did.d.ts.map

package/dist/did.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"did.d.ts","sourceRoot":"","sources":["../src/did.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAGvB,QAAA,MAAM,UAAU,SAAS,CAAA;AAEzB,OAAO,EAAE,UAAU,EAAE,CAAA;AAErB;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,MAAM,GAAG,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,OAAO,WAAW,CAAC,CAAC,CAAC,IAAI,MAAM,EAAE,CAAA;AAE9E;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,MAAM,SAAS,CAAC,GACzC,MAAM,GACN,mBAAmB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;AAE9B,KAAK,gBAAgB,GAAG,SAAS,GAAG,cAAc,CAAA;AAClD,KAAK,SAAS,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAA;AAC1E,KAAK,cAAc,GACf,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,CAAA;AAEP,KAAK,mBAAmB,CACtB,CAAC,EACD,GAAG,SAAS,MAAM,IAChB,CAAC,SAAS,GAAG,MAAM,CAAC,GAAG,MAAM,CAAC,EAAE,GAChC,CAAC,SAAS,gBAAgB,GACxB,mBAAmB,CAAC,CAAC,EAAE,GAAG,GAAG,GAAG,CAAC,EAAE,CAAC,GACpC,KAAK,GACP,GAAG,SAAS,EAAE,GACZ,KAAK,GACL,GAAG,CAAA;AAET;;;;;GAKG;AACH,wBAAgB,cAAc,CAC5B,KAAK,EAAE,MAAM,EACb,KAAK,SAAI,EACT,GAAG,SAAe,GACjB,IAAI,CA0BN;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,GAAG,EAAE,GAAG,EAAE,CAAC,iFAIrD;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAC1B,KAAK,EAAE,MAAM,EACb,KAAK,SAAI,EACT,GAAG,SAAe,GACjB,IAAI,CAuEN;AAED,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,KAAK,IAAI,GAAG,CAqB7D;AAED,wBAAgB,KAAK,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,GAAG,CAUlD;AAED,eAAO,MAAM,SAAS,8DAalB,CAAA"}