@cef-ebsi/ebsi-uri 0.1.0-alpha.0

package/dist/index.js

@@ -0,0 +1,97 @@
+export const SCHEME = "ebsi";
+export const PRODUCTION_NETWORK = "production";
+export const NETWORKS = [
+    PRODUCTION_NETWORK,
+    "preprod",
+    "conformance",
+    "pilot",
+    "test",
+];
+export const HOSTS = {
+    test: "api-test.ebsi.eu",
+    pilot: "api-pilot.ebsi.",
+    conformance: "api-conformance.ebsi.eu",
+    preprod: "api-preprod.ebsi.",
+    production: "api.ebsi.",
+};
+function isNetwork(network) {
+    return network !== undefined && NETWORKS.includes(network);
+}
+export function parse(uriString) {
+    const [scheme, firstComponent, secondComponent, ...rest] = uriString.split(":");
+    if (scheme !== SCHEME) {
+        throw new Error("Invalid URI: scheme must be 'ebsi'");
+    }
+    const network = isNetwork(firstComponent)
+        ? firstComponent
+        : PRODUCTION_NETWORK;
+    const service = isNetwork(firstComponent) ? secondComponent : firstComponent;
+    if (!service || service.startsWith("/")) {
+        throw new Error(`No service found in EBSI URI '${uriString}'`);
+    }
+    const resource = (isNetwork(firstComponent) ? rest : [secondComponent, ...rest]).join(":");
+    if (!resource) {
+        throw new Error(`No resource found in EBSI URI '${uriString}'`);
+    }
+    return {
+        network,
+        service,
+        resource,
+    };
+}
+export function serialize(components) {
+    const { network, service, resource } = components;
+    const networkName = network === PRODUCTION_NETWORK ? "" : `${network}:`;
+    return `${SCHEME}:${networkName}${service}:${resource}`;
+}
+export function toUrl(uriString, options) {
+    const { network, service, resource } = parse(uriString);
+    const host = options.hosts[network];
+    if (!host) {
+        throw new Error(`No host for network ${network}`);
+    }
+    const serviceVersion = options.services[service];
+    if (serviceVersion === undefined) {
+        throw new Error(`Unsupported service: ${service}`);
+    }
+    return `https://${host}/${service}/${serviceVersion}${resource}`;
+}
+export function fromUrl(url, options) {
+    let urlObject;
+    try {
+        urlObject = new URL(url);
+    }
+    catch {
+        throw new Error("Invalid URL");
+    }
+    const { host, pathname, search, hash } = urlObject;
+    const network = Object.keys(HOSTS).find((n) => host.includes(HOSTS[n]));
+    if (!network) {
+        throw new Error(`No network configured for host ${host}`);
+    }
+    const [service, serviceVersion, ...rest] = pathname
+        .split("/")
+        .filter(Boolean);
+    const resource = rest.join("/");
+    if (!service) {
+        throw new Error(`No service found in EBSI URI ${url}`);
+    }
+    if (!serviceVersion) {
+        throw new Error(`No service version found in EBSI URI ${url}`);
+    }
+    if (options?.services) {
+        const supportedServiceVersion = options.services[service];
+        if (!supportedServiceVersion) {
+            throw new Error(`Unsupported service '${service}'`);
+        }
+        if (serviceVersion !== supportedServiceVersion) {
+            throw new Error(`Unsupported version '${serviceVersion}' of service '${service}'`);
+        }
+    }
+    return serialize({
+        network,
+        service,
+        resource: `/${resource}${search}${hash}`,
+    });
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC;AAE7B,MAAM,CAAC,MAAM,kBAAkB,GAAG,YAAY,CAAC;AAE/C,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,kBAAkB;IAClB,SAAS;IACT,aAAa;IACb,OAAO;IACP,MAAM;CACE,CAAC;AAEX,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB,IAAI,EAAE,kBAAkB;IACxB,KAAK,EAAE,iBAAiB;IACxB,WAAW,EAAE,yBAAyB;IACtC,OAAO,EAAE,mBAAmB;IAC5B,UAAU,EAAE,WAAW;CACmB,CAAC;AAY7C,SAAS,SAAS,CAAC,OAA2B;IAC5C,OAAO,OAAO,KAAK,SAAS,IAAI,QAAQ,CAAC,QAAQ,CAAC,OAAkB,CAAC,CAAC;AACxE,CAAC;AAmBD,MAAM,UAAU,KAAK,CAAC,SAAiB;IACrC,MAAM,CAAC,MAAM,EAAE,cAAc,EAAE,eAAe,EAAE,GAAG,IAAI,CAAC,GACtD,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAEvB,IAAI,MAAM,KAAK,MAAM,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACxD,CAAC;IAED,MAAM,OAAO,GAAY,SAAS,CAAC,cAAc,CAAC;QAChD,CAAC,CAAC,cAAc;QAChB,CAAC,CAAC,kBAAkB,CAAC;IAEvB,MAAM,OAAO,GAAG,SAAS,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,cAAc,CAAC;IAE7E,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACxC,MAAM,IAAI,KAAK,CAAC,iCAAiC,SAAS,GAAG,CAAC,CAAC;IACjE,CAAC;IAED,MAAM,QAAQ,GAAG,CACf,SAAS,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,eAAe,EAAE,GAAG,IAAI,CAAC,CAC9D,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAEZ,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,kCAAkC,SAAS,GAAG,CAAC,CAAC;IAClE,CAAC;IAGD,OAAO;QACL,OAAO;QACP,OAAO;QACP,QAAQ;KACmB,CAAC;AAChC,CAAC;AAgBD,MAAM,UAAU,SAAS,CAAC,UAA6B;IACrD,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC;IAElD,MAAM,WAAW,GAAG,OAAO,KAAK,kBAAkB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,OAAO,GAAG,CAAC;IAGxE,OAAO,GAAG,MAAM,IAAI,WAAW,GAAG,OAAO,IAAI,QAAQ,EAAE,CAAC;AAC1D,CAAC;AAgBD,MAAM,UAAU,KAAK,CACnB,SAAiB,EACjB,OAUC;IAED,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;IAGxD,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAEpC,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,uBAAuB,OAAO,EAAE,CAAC,CAAC;IACpD,CAAC;IAGD,MAAM,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAEjD,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;QACjC,MAAM,IAAI,KAAK,CAAC,wBAAwB,OAAO,EAAE,CAAC,CAAC;IACrD,CAAC;IAGD,OAAO,WAAW,IAAI,IAAI,OAAO,IAAI,cAAc,GAAG,QAAQ,EAAE,CAAC;AACnE,CAAC;AAaD,MAAM,UAAU,OAAO,CACrB,GAAW,EACX,OAKC;IAGD,IAAI,SAAc,CAAC;IACnB,IAAI,CAAC;QACH,SAAS,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;IAC3B,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC;IACjC,CAAC;IAED,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,SAAS,CAAC;IAGnD,MAAM,OAAO,GAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAA4B,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CACxE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CACxB,CAAC;IAEF,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CAAC,kCAAkC,IAAI,EAAE,CAAC,CAAC;IAC5D,CAAC;IAGD,MAAM,CAAC,OAAO,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC,GAAG,QAAQ;SAChD,KAAK,CAAC,GAAG,CAAC;SACV,MAAM,CAAC,OAAO,CAAC,CAAC;IACnB,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAEhC,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CAAC,gCAAgC,GAAG,EAAE,CAAC,CAAC;IACzD,CAAC;IAED,IAAI,CAAC,cAAc,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CAAC,wCAAwC,GAAG,EAAE,CAAC,CAAC;IACjE,CAAC;IAGD,IAAI,OAAO,EAAE,QAAQ,EAAE,CAAC;QACtB,MAAM,uBAAuB,GAAG,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAE1D,IAAI,CAAC,uBAAuB,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CAAC,wBAAwB,OAAO,GAAG,CAAC,CAAC;QACtD,CAAC;QAED,IAAI,cAAc,KAAK,uBAAuB,EAAE,CAAC;YAC/C,MAAM,IAAI,KAAK,CACb,wBAAwB,cAAc,iBAAiB,OAAO,GAAG,CAClE,CAAC;QACJ,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC;QACf,OAAO;QACP,OAAO;QACP,QAAQ,EAAE,IAAI,QAAQ,GAAG,MAAM,GAAG,IAAI,EAAE;KACzC,CAAC,CAAC;AACL,CAAC"}

package/dist/resolver.d.ts

@@ -0,0 +1,6 @@
+import type { DIDResolver } from "did-resolver";
+export interface ResolverOptions {
+    registry?: string;
+}
+export declare function getResolver(resolverOptions: ResolverOptions): Record<"ebsi", DIDResolver>;
+//# sourceMappingURL=resolver.d.ts.map

package/dist/resolver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolver.d.ts","sourceRoot":"","sources":["../src/resolver.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAGV,WAAW,EAEZ,MAAM,cAAc,CAAC;AAKtB,MAAM,WAAW,eAAe;IAI9B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAKD,wBAAgB,WAAW,CACzB,eAAe,EAAE,eAAe,GAC/B,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAqC7B"}

package/dist/resolver.js

@@ -0,0 +1,34 @@
+import { DID_RESOLUTION_ERROR_CODES } from "./constants.js";
+import { resolve as resolveV1 } from "./resolvers/v1.js";
+import { validate } from "./validator.js";
+export function getResolver(resolverOptions) {
+    async function resolve(did, _, __, didResolutionOptions) {
+        if (!resolverOptions || typeof resolverOptions !== "object") {
+            return {
+                didDocument: null,
+                didDocumentMetadata: {},
+                didResolutionMetadata: {
+                    error: DID_RESOLUTION_ERROR_CODES.CONFIGURATION_ERROR,
+                    message: "Invalid or missing resolver options",
+                },
+            };
+        }
+        try {
+            validate(did);
+        }
+        catch (e) {
+            const message = e instanceof Error ? e.message : "Unknown error";
+            return {
+                didDocument: null,
+                didDocumentMetadata: {},
+                didResolutionMetadata: {
+                    error: "invalidDid",
+                    message,
+                },
+            };
+        }
+        return resolveV1(did, resolverOptions.registry, didResolutionOptions);
+    }
+    return { ebsi: resolve };
+}
+//# sourceMappingURL=resolver.js.map

package/dist/resolver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolver.js","sourceRoot":"","sources":["../src/resolver.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,0BAA0B,EAAE,MAAM,gBAAgB,CAAC;AAC5D,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAY1C,MAAM,UAAU,WAAW,CACzB,eAAgC;IAEhC,KAAK,UAAU,OAAO,CACpB,GAAW,EACX,CAAY,EACZ,EAAW,EACX,oBAA2C;QAE3C,IAAI,CAAC,eAAe,IAAI,OAAO,eAAe,KAAK,QAAQ,EAAE,CAAC;YAC5D,OAAO;gBACL,WAAW,EAAE,IAAI;gBACjB,mBAAmB,EAAE,EAAE;gBACvB,qBAAqB,EAAE;oBACrB,KAAK,EAAE,0BAA0B,CAAC,mBAAmB;oBACrD,OAAO,EAAE,qCAAqC;iBAC/C;aACF,CAAC;QACJ,CAAC;QAGD,IAAI,CAAC;YACH,QAAQ,CAAC,GAAG,CAAC,CAAC;QAChB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,OAAO,GAAG,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC;YACjE,OAAO;gBACL,WAAW,EAAE,IAAI;gBACjB,mBAAmB,EAAE,EAAE;gBACvB,qBAAqB,EAAE;oBACrB,KAAK,EAAE,YAAY;oBACnB,OAAO;iBACR;aACF,CAAC;QACJ,CAAC;QAED,OAAO,SAAS,CAAC,GAAG,EAAE,eAAe,CAAC,QAAQ,EAAE,oBAAoB,CAAC,CAAC;IACxE,CAAC;IAED,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;AAC3B,CAAC"}

package/dist/resolvers/v1.d.ts

@@ -0,0 +1,3 @@
+import type { DIDResolutionOptions, DIDResolutionResult } from "did-resolver";
+export declare function resolve(did: string, registry?: string, didResolutionOptions?: DIDResolutionOptions): Promise<DIDResolutionResult>;
+//# sourceMappingURL=v1.d.ts.map

package/dist/resolvers/v1.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"v1.d.ts","sourceRoot":"","sources":["../../src/resolvers/v1.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAEV,oBAAoB,EACpB,mBAAmB,EACpB,MAAM,cAAc,CAAC;AAyDtB,wBAAsB,OAAO,CAC3B,GAAG,EAAE,MAAM,EACX,QAAQ,CAAC,EAAE,MAAM,EACjB,oBAAoB,CAAC,EAAE,oBAAoB,GAC1C,OAAO,CAAC,mBAAmB,CAAC,CA+E9B"}

package/dist/resolvers/v1.js

@@ -0,0 +1,109 @@
+import axios from "axios";
+import { ProblemDetailsError } from "../errors.js";
+import { DID_RESOLUTION_ERROR_CODES, } from "../constants.js";
+const AXIOS_TIMEOUT = 15_000;
+const SUPPORTED_CONTENT_TYPES = [
+    "application/did+ld+json",
+    "application/did+json",
+];
+function isSupportedContentType(contentType) {
+    return SUPPORTED_CONTENT_TYPES.includes(contentType);
+}
+async function get(url, contentType, timeout) {
+    try {
+        const response = await axios.get(url, {
+            headers: {
+                accept: contentType,
+            },
+            timeout: timeout || AXIOS_TIMEOUT,
+        });
+        return response.data;
+    }
+    catch (e) {
+        let message = "";
+        if (axios.isAxiosError(e)) {
+            try {
+                const { detail, title } = e.response?.data;
+                message = detail || title;
+            }
+            catch (err) {
+                message = e.message;
+            }
+            throw new ProblemDetailsError(e.response?.status || 500, e.response?.statusText || "", {
+                detail: message,
+            });
+        }
+        throw e;
+    }
+}
+export async function resolve(did, registry, didResolutionOptions) {
+    if (!registry) {
+        return {
+            didDocument: null,
+            didDocumentMetadata: {},
+            didResolutionMetadata: {
+                error: DID_RESOLUTION_ERROR_CODES.CONFIGURATION_ERROR,
+                message: "A DID registry must be defined in order to resolve EBSI DID method v1 documents",
+            },
+        };
+    }
+    let accept = "application/did+ld+json";
+    if (didResolutionOptions && didResolutionOptions.accept) {
+        if (!isSupportedContentType(didResolutionOptions.accept)) {
+            return {
+                didDocument: null,
+                didDocumentMetadata: {},
+                didResolutionMetadata: {
+                    error: DID_RESOLUTION_ERROR_CODES.REPRESENTATION_NOT_SUPPORTED,
+                    message: `Representation ${didResolutionOptions.accept} is not supported. Valid representations include: ${SUPPORTED_CONTENT_TYPES.join(", ")}`,
+                },
+            };
+        }
+        accept = didResolutionOptions.accept;
+    }
+    try {
+        const timeout = didResolutionOptions &&
+            typeof didResolutionOptions["timeout"] === "number"
+            ? didResolutionOptions["timeout"]
+            : AXIOS_TIMEOUT;
+        const didDocument = await get(`${registry}/${did}`, accept, timeout);
+        return {
+            didDocument,
+            didDocumentMetadata: {},
+            didResolutionMetadata: { contentType: accept },
+        };
+    }
+    catch (e) {
+        let error = DID_RESOLUTION_ERROR_CODES.UNKNOWN_ERROR;
+        let message = "";
+        if (e instanceof ProblemDetailsError) {
+            if (e.status === 400) {
+                error = DID_RESOLUTION_ERROR_CODES.INVALID_DID;
+                message = e.detail || e.title || "Bad Request";
+            }
+            else if (e.status === 404) {
+                error = DID_RESOLUTION_ERROR_CODES.NOT_FOUND;
+                message = e.detail || e.title || "Not Found";
+            }
+            else if (e.status === 500) {
+                error = DID_RESOLUTION_ERROR_CODES.INTERNAL_SERVER_ERROR;
+                message = e.detail || e.title || "Internal Server Error";
+            }
+            else {
+                message = e.detail || e.title || "unknown";
+            }
+        }
+        else if (e instanceof Error) {
+            message = e.message;
+        }
+        return {
+            didDocument: null,
+            didDocumentMetadata: {},
+            didResolutionMetadata: {
+                error,
+                message: `${message} | Registry used: ${registry}`,
+            },
+        };
+    }
+}
+//# sourceMappingURL=v1.js.map

package/dist/resolvers/v1.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"v1.js","sourceRoot":"","sources":["../../src/resolvers/v1.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAM1B,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,EACL,0BAA0B,GAE3B,MAAM,iBAAiB,CAAC;AAEzB,MAAM,aAAa,GAAG,MAAM,CAAC;AAE7B,MAAM,uBAAuB,GAAG;IAC9B,yBAAyB;IACzB,sBAAsB;CACd,CAAC;AAGX,SAAS,sBAAsB,CAC7B,WAAmB;IAEnB,OAAO,uBAAuB,CAAC,QAAQ,CAAC,WAA0B,CAAC,CAAC;AACtE,CAAC;AAED,KAAK,UAAU,GAAG,CAChB,GAAW,EACX,WAAwB,EACxB,OAAe;IAEf,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAc,GAAG,EAAE;YACjD,OAAO,EAAE;gBACP,MAAM,EAAE,WAAW;aACpB;YACD,OAAO,EAAE,OAAO,IAAI,aAAa;SAClC,CAAC,CAAC;QACH,OAAO,QAAQ,CAAC,IAAI,CAAC;IACvB,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,IAAI,OAAO,GAAG,EAAE,CAAC;QACjB,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC;YAC1B,IAAI,CAAC;gBACH,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC,QAAQ,EAAE,IAA2B,CAAC;gBAClE,OAAO,GAAG,MAAM,IAAI,KAAK,CAAC;YAC5B,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,OAAO,GAAG,CAAC,CAAC,OAAO,CAAC;YACtB,CAAC;YAED,MAAM,IAAI,mBAAmB,CAC3B,CAAC,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,EACzB,CAAC,CAAC,QAAQ,EAAE,UAAU,IAAI,EAAE,EAC5B;gBACE,MAAM,EAAE,OAAO;aAChB,CACF,CAAC;QACJ,CAAC;QAED,MAAM,CAAC,CAAC;IACV,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,OAAO,CAC3B,GAAW,EACX,QAAiB,EACjB,oBAA2C;IAE3C,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO;YACL,WAAW,EAAE,IAAI;YACjB,mBAAmB,EAAE,EAAE;YACvB,qBAAqB,EAAE;gBACrB,KAAK,EAAE,0BAA0B,CAAC,mBAAmB;gBACrD,OAAO,EACL,iFAAiF;aACpF;SACF,CAAC;IACJ,CAAC;IAED,IAAI,MAAM,GAAgB,yBAAyB,CAAC;IACpD,IAAI,oBAAoB,IAAI,oBAAoB,CAAC,MAAM,EAAE,CAAC;QACxD,IAAI,CAAC,sBAAsB,CAAC,oBAAoB,CAAC,MAAM,CAAC,EAAE,CAAC;YACzD,OAAO;gBACL,WAAW,EAAE,IAAI;gBACjB,mBAAmB,EAAE,EAAE;gBACvB,qBAAqB,EAAE;oBACrB,KAAK,EAAE,0BAA0B,CAAC,4BAA4B;oBAC9D,OAAO,EAAE,kBACP,oBAAoB,CAAC,MACvB,qDAAqD,uBAAuB,CAAC,IAAI,CAC/E,IAAI,CACL,EAAE;iBACJ;aACF,CAAC;QACJ,CAAC;QAED,MAAM,GAAG,oBAAoB,CAAC,MAAM,CAAC;IACvC,CAAC;IAGD,IAAI,CAAC;QACH,MAAM,OAAO,GACX,oBAAoB;YACpB,OAAO,oBAAoB,CAAC,SAAS,CAAC,KAAK,QAAQ;YACjD,CAAC,CAAC,oBAAoB,CAAC,SAAS,CAAC;YACjC,CAAC,CAAC,aAAa,CAAC;QAEpB,MAAM,WAAW,GAAG,MAAM,GAAG,CAAC,GAAG,QAAQ,IAAI,GAAG,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAErE,OAAO;YACL,WAAW;YACX,mBAAmB,EAAE,EAAE;YACvB,qBAAqB,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE;SAC/C,CAAC;IACJ,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,IAAI,KAAK,GACP,0BAA0B,CAAC,aAAa,CAAC;QAC3C,IAAI,OAAO,GAAG,EAAE,CAAC;QAEjB,IAAI,CAAC,YAAY,mBAAmB,EAAE,CAAC;YACrC,IAAI,CAAC,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBACrB,KAAK,GAAG,0BAA0B,CAAC,WAAW,CAAC;gBAC/C,OAAO,GAAG,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,KAAK,IAAI,aAAa,CAAC;YACjD,CAAC;iBAAM,IAAI,CAAC,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBAC5B,KAAK,GAAG,0BAA0B,CAAC,SAAS,CAAC;gBAC7C,OAAO,GAAG,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,KAAK,IAAI,WAAW,CAAC;YAC/C,CAAC;iBAAM,IAAI,CAAC,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBAC5B,KAAK,GAAG,0BAA0B,CAAC,qBAAqB,CAAC;gBACzD,OAAO,GAAG,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,KAAK,IAAI,uBAAuB,CAAC;YAC3D,CAAC;iBAAM,CAAC;gBACN,OAAO,GAAG,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,KAAK,IAAI,SAAS,CAAC;YAC7C,CAAC;QACH,CAAC;aAAM,IAAI,CAAC,YAAY,KAAK,EAAE,CAAC;YAC9B,OAAO,GAAG,CAAC,CAAC,OAAO,CAAC;QACtB,CAAC;QAED,OAAO;YACL,WAAW,EAAE,IAAI;YACjB,mBAAmB,EAAE,EAAE;YACvB,qBAAqB,EAAE;gBACrB,KAAK;gBACL,OAAO,EAAE,GAAG,OAAO,qBAAqB,QAAQ,EAAE;aACnD;SACF,CAAC;IACJ,CAAC;AACH,CAAC"}

package/dist/util.d.ts

@@ -0,0 +1,3 @@
+import { SUPPORTED_VERSIONS } from "./constants.js";
+export declare function createDid(subjectIdentifierBytes: ArrayLike<number>, version?: (typeof SUPPORTED_VERSIONS)[number]): string;
+//# sourceMappingURL=util.d.ts.map

package/dist/util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AACA,OAAO,EAIL,kBAAkB,EACnB,MAAM,gBAAgB,CAAC;AASxB,wBAAgB,SAAS,CACvB,sBAAsB,EAAE,SAAS,CAAC,MAAM,CAAC,EACzC,OAAO,GAAE,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,CAAgB,GAC1D,MAAM,CAmBR"}

package/dist/util.js

@@ -0,0 +1,13 @@
+import { base58btc } from "multiformats/bases/base58";
+import { EBSI_DID_METHOD_PREFIX, EBSI_DID_SPECS, LEGAL_ENTITY, } from "./constants.js";
+export function createDid(subjectIdentifierBytes, version = LEGAL_ENTITY) {
+    const bytesArray = new Uint8Array(1 + EBSI_DID_SPECS[version].BYTE_LENGTH);
+    bytesArray.set([EBSI_DID_SPECS[version].VERSION_ID]);
+    if (subjectIdentifierBytes.length !== EBSI_DID_SPECS[version].BYTE_LENGTH) {
+        throw new Error(`Invalid subject identifier length. Expected: ${EBSI_DID_SPECS[version].BYTE_LENGTH} bytes. Received: ${subjectIdentifierBytes.length} bytes.`);
+    }
+    bytesArray.set(subjectIdentifierBytes, 1);
+    const methodSpecificIdentifier = base58btc.encode(bytesArray);
+    return `${EBSI_DID_METHOD_PREFIX}${methodSpecificIdentifier}`;
+}
+//# sourceMappingURL=util.js.map

package/dist/util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,EACL,sBAAsB,EACtB,cAAc,EACd,YAAY,GAEb,MAAM,gBAAgB,CAAC;AASxB,MAAM,UAAU,SAAS,CACvB,sBAAyC,EACzC,UAA+C,YAAY;IAG3D,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC,CAAC,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC,WAAW,CAAC,CAAC;IAG3E,UAAU,CAAC,GAAG,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC;IAErD,IAAI,sBAAsB,CAAC,MAAM,KAAK,cAAc,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,CAAC;QAC1E,MAAM,IAAI,KAAK,CACb,gDAAgD,cAAc,CAAC,OAAO,CAAC,CAAC,WAAW,qBAAqB,sBAAsB,CAAC,MAAM,SAAS,CAC/I,CAAC;IACJ,CAAC;IAED,UAAU,CAAC,GAAG,CAAC,sBAAsB,EAAE,CAAC,CAAC,CAAC;IAG1C,MAAM,wBAAwB,GAAG,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAE9D,OAAO,GAAG,sBAAsB,GAAG,wBAAwB,EAAE,CAAC;AAChE,CAAC"}

package/dist/validator.d.ts

@@ -0,0 +1,2 @@
+export declare function validate(did: string): number;
+//# sourceMappingURL=validator.d.ts.map

package/dist/validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validator.d.ts","sourceRoot":"","sources":["../src/validator.ts"],"names":[],"mappings":"AAaA,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAsD5C"}

package/dist/validator.js

@@ -0,0 +1,35 @@
+import { base58btc } from "multiformats/bases/base58";
+import { EBSI_DID_METHOD_PREFIX, EBSI_DID_SPECS, SUPPORTED_VERSIONS, } from "./constants.js";
+export function validate(did) {
+    if (!did || typeof did !== "string") {
+        throw new Error("The DID must be a string");
+    }
+    if (!did.startsWith(EBSI_DID_METHOD_PREFIX)) {
+        throw new Error(`The DID must start with "${EBSI_DID_METHOD_PREFIX}"`);
+    }
+    const methodSpecificIdentifier = did.substring(EBSI_DID_METHOD_PREFIX.length);
+    if (!methodSpecificIdentifier.startsWith("z")) {
+        throw new Error('The method-specific identifier must start with "z" (multibase base58btc-encoded)');
+    }
+    let decodedIdentifier;
+    try {
+        decodedIdentifier = base58btc.decode(methodSpecificIdentifier);
+    }
+    catch (e) {
+        throw new Error("The method-specific identifier is not a valid multibase base58btc-encoded string");
+    }
+    const version = decodedIdentifier[0];
+    if (!version) {
+        throw new Error("No version found");
+    }
+    const didSpecsKey = SUPPORTED_VERSIONS.find((specKey) => version === EBSI_DID_SPECS[specKey].VERSION_ID);
+    if (!didSpecsKey) {
+        throw new Error(`Unsupported version "${version}"`);
+    }
+    if (decodedIdentifier.byteLength - 1 !==
+        EBSI_DID_SPECS[didSpecsKey].BYTE_LENGTH) {
+        throw new Error(`The subject identifier length (${decodedIdentifier.byteLength - 1} bytes) does not match the expected length (${EBSI_DID_SPECS[didSpecsKey].BYTE_LENGTH} bytes)`);
+    }
+    return version;
+}
+//# sourceMappingURL=validator.js.map

package/dist/validator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validator.js","sourceRoot":"","sources":["../src/validator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,EACL,sBAAsB,EACtB,cAAc,EACd,kBAAkB,GACnB,MAAM,gBAAgB,CAAC;AAQxB,MAAM,UAAU,QAAQ,CAAC,GAAW;IAClC,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QACpC,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;IAC9C,CAAC;IAED,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,sBAAsB,CAAC,EAAE,CAAC;QAC5C,MAAM,IAAI,KAAK,CAAC,4BAA4B,sBAAsB,GAAG,CAAC,CAAC;IACzE,CAAC;IAED,MAAM,wBAAwB,GAAG,GAAG,CAAC,SAAS,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC;IAE9E,IAAI,CAAC,wBAAwB,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QAC9C,MAAM,IAAI,KAAK,CACb,kFAAkF,CACnF,CAAC;IACJ,CAAC;IAED,IAAI,iBAA6B,CAAC;IAClC,IAAI,CAAC;QACH,iBAAiB,GAAG,SAAS,CAAC,MAAM,CAAC,wBAAwB,CAAC,CAAC;IACjE,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CACb,kFAAkF,CACnF,CAAC;IACJ,CAAC;IAED,MAAM,OAAO,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC;IAErC,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACtC,CAAC;IAED,MAAM,WAAW,GAAG,kBAAkB,CAAC,IAAI,CACzC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,KAAK,cAAc,CAAC,OAAO,CAAC,CAAC,UAAU,CAC5D,CAAC;IAEF,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,wBAAwB,OAAO,GAAG,CAAC,CAAC;IACtD,CAAC;IAED,IACE,iBAAiB,CAAC,UAAU,GAAG,CAAC;QAChC,cAAc,CAAC,WAAW,CAAC,CAAC,WAAW,EACvC,CAAC;QACD,MAAM,IAAI,KAAK,CACb,kCACE,iBAAiB,CAAC,UAAU,GAAG,CACjC,+CACE,cAAc,CAAC,WAAW,CAAC,CAAC,WAC9B,SAAS,CACV,CAAC;IACJ,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@cef-ebsi/ebsi-uri",
+  "version": "0.1.0-alpha.0",
+  "description": "EBSI URIs parser and serializer",
+  "license": "EUPL-1.2",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "bitbucket",
+    "url": "https://ec.europa.eu/digital-building-blocks/code/scm/ebsi/core-libs.git",
+    "directory": "packages/ebsi-uri"
+  },
+  "type": "module",
+  "exports": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "src"
+  ],
+  "scripts": {
+    "prepare": "yarn build",
+    "build": "tsc -p tsconfig/tsconfig.build.esm.json",
+    "clean": "rimraf dist coverage",
+    "lint": "yarn lint:tsc",
+    "lint:tsc": "tsc --noEmit --incremental false",
+    "test": "vitest --run",
+    "test:unit": "yarn test unit",
+    "test:e2e": "echo \"Info: there's no e2e tests for @cef-ebsi/ebsi-uri\" && exit 0",
+    "test:ci": "yarn test:unit --coverage --reporter=default --reporter=vitest-sonar-reporter"
+  },
+  "gitHead": "b504c213dd26aeadb1e29da81c731dddea581006"
+}

package/src/index.ts

@@ -0,0 +1,230 @@
+export const SCHEME = "ebsi";
+
+export const PRODUCTION_NETWORK = "production";
+
+export const NETWORKS = [
+  PRODUCTION_NETWORK,
+  "preprod",
+  "conformance",
+  "pilot",
+  "test",
+] as const;
+
+export const HOSTS = {
+  test: "api-test.ebsi.eu",
+  pilot: "api-pilot.ebsi.",
+  conformance: "api-conformance.ebsi.eu",
+  preprod: "api-preprod.ebsi.",
+  production: "api.ebsi.",
+} as const satisfies Record<Network, string>;
+
+export type Network = (typeof NETWORKS)[number];
+
+export type EBSIURIComponents = {
+  network?: Network;
+  service?: string;
+  resource?: string;
+};
+
+export type SupportedServices = Record<string, string>;
+
+function isNetwork(network: string | undefined): network is Network {
+  return network !== undefined && NETWORKS.includes(network as Network);
+}
+
+/**
+ * Parse an EBSI URI.
+ * @example
+ * ```js
+ * parse("ebsi:test:did-registry:/identifiers/did:ebsi:zx23VhpbGYeqF2MRJk3HzPw")
+ * ```
+ * returns
+ * ```json
+ * {
+ *   "network": "test",
+ *   "service": "did-registry",
+ *   "resource": "/identifiers/did:ebsi:zx23VhpbGYeqF2MRJk3HzPw"
+ * }
+ * ```
+ * @param uriString - EBSI URI to parse, e.g. "ebsi:test:did-registry:/identifiers/did:ebsi:zx23VhpbGYeqF2MRJk3HzPw"
+ * @returns EBSI URI components
+ */
+export function parse(uriString: string) {
+  const [scheme, firstComponent, secondComponent, ...rest] =
+    uriString.split(":");
+
+  if (scheme !== SCHEME) {
+    throw new Error("Invalid URI: scheme must be 'ebsi'");
+  }
+
+  const network: Network = isNetwork(firstComponent)
+    ? firstComponent
+    : PRODUCTION_NETWORK;
+
+  const service = isNetwork(firstComponent) ? secondComponent : firstComponent;
+
+  if (!service || service.startsWith("/")) {
+    throw new Error(`No service found in EBSI URI '${uriString}'`);
+  }
+
+  const resource = (
+    isNetwork(firstComponent) ? rest : [secondComponent, ...rest]
+  ).join(":");
+
+  if (!resource) {
+    throw new Error(`No resource found in EBSI URI '${uriString}'`);
+  }
+
+  // Return EBSI URI components
+  return {
+    network,
+    service,
+    resource,
+  } satisfies EBSIURIComponents;
+}
+
+/**
+ * Serialize EBSI URI components.
+ * @example
+ * ```js
+ * serialize({
+ *   "network": "test",
+ *   "service": "did-registry",
+ *   "resource": "/identifiers/did:ebsi:zx23VhpbGYeqF2MRJk3HzPw"
+ * })
+ * ```
+ * returns `ebsi:test:did-registry:/identifiers/did:ebsi:zx23VhpbGYeqF2MRJk3HzPw`
+ * @param components - EBSI URI components
+ * @returns EBSI URI
+ */
+export function serialize(components: EBSIURIComponents) {
+  const { network, service, resource } = components;
+
+  const networkName = network === PRODUCTION_NETWORK ? "" : `${network}:`;
+
+  // Return EBSI URI
+  return `${SCHEME}:${networkName}${service}:${resource}`;
+}
+
+/**
+ * Transform an EBSI URI into a URL.
+ * @example
+ * ```js
+ * toUrl("ebsi:test:did-registry:/identifiers/did:ebsi:zx23VhpbGYeqF2MRJk3HzPw", {
+ *   services: { "did-registry": "v4" },
+ *   hosts: { test: "api-test.ebsi.eu" }
+ * })
+ * ```
+ * returns `https://api-test.ebsi.eu/did-registry/v4/identifiers/did:ebsi:zx23VhpbGYeqF2MRJk3HzPw`
+ * @param uriString - EBSI URI
+ * @param options - Supported services and hosts
+ * @returns URL
+ */
+export function toUrl(
+  uriString: string,
+  options: {
+    /**
+     * Map of supported services and their versions
+     */
+    readonly services: SupportedServices;
+
+    /**
+     * Map of supported networks and their hosts
+     */
+    readonly hosts: Partial<Record<Network, string>>;
+  },
+): string {
+  const { network, service, resource } = parse(uriString);
+
+  // Replace host
+  const host = options.hosts[network];
+
+  if (!host) {
+    throw new Error(`No host for network ${network}`);
+  }
+
+  // Get service version
+  const serviceVersion = options.services[service];
+
+  if (serviceVersion === undefined) {
+    throw new Error(`Unsupported service: ${service}`);
+  }
+
+  // Return URL
+  return `https://${host}/${service}/${serviceVersion}${resource}`;
+}
+
+/**
+ * Transform a URL into an EBSI URI.
+ * @example
+ * ```js
+ * fromUrl("https://api-test.ebsi.eu/did-registry/v4/identifiers/did:ebsi:zx23VhpbGYeqF2MRJk3HzPw")
+ * ```
+ * returns `ebsi:test:did-registry:/identifiers/did:ebsi:zx23VhpbGYeqF2MRJk3HzPw`
+ * @param url - URL to transform
+ * @param options - Supported services
+ * @returns EBSI URI
+ */
+export function fromUrl(
+  url: string,
+  options?: {
+    /**
+     * Map of supported services and their versions
+     */
+    services?: SupportedServices;
+  },
+) {
+  // Parse URL
+  let urlObject: URL;
+  try {
+    urlObject = new URL(url);
+  } catch {
+    throw new Error("Invalid URL");
+  }
+
+  const { host, pathname, search, hash } = urlObject;
+
+  // Identify network
+  const network = (Object.keys(HOSTS) as (keyof typeof HOSTS)[]).find((n) =>
+    host.includes(HOSTS[n]),
+  );
+
+  if (!network) {
+    throw new Error(`No network configured for host ${host}`);
+  }
+
+  // Extract service and resource from pathname: /<service>/<serviceVersion>/<resource>
+  const [service, serviceVersion, ...rest] = pathname
+    .split("/")
+    .filter(Boolean); // Remove empty path segments
+  const resource = rest.join("/");
+
+  if (!service) {
+    throw new Error(`No service found in EBSI URI ${url}`);
+  }
+
+  if (!serviceVersion) {
+    throw new Error(`No service version found in EBSI URI ${url}`);
+  }
+
+  // Check if the service and its version are supported
+  if (options?.services) {
+    const supportedServiceVersion = options.services[service];
+
+    if (!supportedServiceVersion) {
+      throw new Error(`Unsupported service '${service}'`);
+    }
+
+    if (serviceVersion !== supportedServiceVersion) {
+      throw new Error(
+        `Unsupported version '${serviceVersion}' of service '${service}'`,
+      );
+    }
+  }
+
+  return serialize({
+    network,
+    service,
+    resource: `/${resource}${search}${hash}`,
+  });
+}