@twin.org/notarization-service 0.0.3-next.1

package/dist/es/notarizationService.js

@@ -0,0 +1,151 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { GeneralError, Guards, Urn } from "@twin.org/core";
+import { NotarizationConnectorFactory } from "@twin.org/notarization-models";
+/**
+ * Service for notarization operations.
+ */
+export class NotarizationService {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "NotarizationService";
+    /**
+     * The namespace supported by the notarization service.
+     * @internal
+     */
+    static _NAMESPACE = "notarization";
+    /**
+     * The default namespace for the connector to use.
+     * @internal
+     */
+    _defaultNamespace;
+    /**
+     * Create a new instance of NotarizationService.
+     * @param options The constructor options.
+     */
+    constructor(options) {
+        const names = NotarizationConnectorFactory.names();
+        if (names.length === 0) {
+            throw new GeneralError(NotarizationService.CLASS_NAME, "noConnectors");
+        }
+        this._defaultNamespace = options?.config?.defaultNamespace ?? names[0];
+    }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return NotarizationService.CLASS_NAME;
+    }
+    /**
+     * Create a new notarization.
+     * @param notarization The notarization data without generated fields.
+     * @param namespace The namespace of the connector to use for the notarization, defaults to service configured namespace.
+     * @param controllerIdentity The identity to perform the notarization operation with.
+     * @returns The generated notarization id.
+     */
+    async create(notarization, namespace, controllerIdentity) {
+        Guards.object(NotarizationService.CLASS_NAME, "notarization", notarization);
+        if (namespace !== undefined) {
+            Guards.stringValue(NotarizationService.CLASS_NAME, "namespace", namespace);
+        }
+        Guards.stringValue(NotarizationService.CLASS_NAME, "controllerIdentity", controllerIdentity);
+        try {
+            const connectorNamespace = namespace ?? this._defaultNamespace;
+            const notarizationConnector = NotarizationConnectorFactory.get(connectorNamespace);
+            const notarizationId = await notarizationConnector.create(controllerIdentity, notarization);
+            return notarizationId;
+        }
+        catch (error) {
+            throw new GeneralError(NotarizationService.CLASS_NAME, "createFailed", undefined, error);
+        }
+    }
+    /**
+     * Get an existing notarization.
+     * @param id The id of the notarization to get.
+     * @returns The notarization.
+     */
+    async get(id) {
+        Urn.guard(NotarizationService.CLASS_NAME, "id", id);
+        try {
+            const notarizationConnector = this.getConnector(id);
+            const result = await notarizationConnector.get(id);
+            return result;
+        }
+        catch (error) {
+            throw new GeneralError(NotarizationService.CLASS_NAME, "getFailed", undefined, error);
+        }
+    }
+    /**
+     * Remove an existing notarization.
+     * @param id The id of the notarization to remove.
+     * @param controllerIdentity The identity to perform the notarization operation with.
+     * @returns Nothing.
+     */
+    async remove(id, controllerIdentity) {
+        Urn.guard(NotarizationService.CLASS_NAME, "id", id);
+        Guards.stringValue(NotarizationService.CLASS_NAME, "controllerIdentity", controllerIdentity);
+        try {
+            const notarizationConnector = this.getConnector(id);
+            await notarizationConnector.remove(controllerIdentity, id);
+        }
+        catch (error) {
+            throw new GeneralError(NotarizationService.CLASS_NAME, "removeFailed", undefined, error);
+        }
+    }
+    /**
+     * Update an existing notarization.
+     * @param notarization The notarization to update.
+     * @param controllerIdentity The identity to perform the notarization operation with.
+     * @returns Nothing.
+     */
+    async update(notarization, controllerIdentity) {
+        Guards.object(NotarizationService.CLASS_NAME, "notarization", notarization);
+        Urn.guard(NotarizationService.CLASS_NAME, "notarization.id", notarization.id);
+        Guards.stringValue(NotarizationService.CLASS_NAME, "controllerIdentity", controllerIdentity);
+        try {
+            const notarizationConnector = this.getConnector(notarization.id);
+            await notarizationConnector.update(controllerIdentity, notarization);
+        }
+        catch (error) {
+            throw new GeneralError(NotarizationService.CLASS_NAME, "updateFailed", undefined, error);
+        }
+    }
+    /**
+     * Transfer an existing notarization.
+     * @param id The id of the notarization to transfer.
+     * @param recipientAddress The recipient address.
+     * @param controllerIdentity The identity to perform the notarization operation with.
+     * @returns Nothing.
+     */
+    async transfer(id, recipientAddress, controllerIdentity) {
+        Urn.guard(NotarizationService.CLASS_NAME, "id", id);
+        Guards.stringValue(NotarizationService.CLASS_NAME, "recipientAddress", recipientAddress);
+        Guards.stringValue(NotarizationService.CLASS_NAME, "controllerIdentity", controllerIdentity);
+        try {
+            const notarizationConnector = this.getConnector(id);
+            await notarizationConnector.transfer(controllerIdentity, id, recipientAddress);
+        }
+        catch (error) {
+            throw new GeneralError(NotarizationService.CLASS_NAME, "transferFailed", undefined, error);
+        }
+    }
+    /**
+     * Get the connector from the id.
+     * @param id The id of the notarization in urn format.
+     * @returns The connector.
+     * @internal
+     */
+    getConnector(id) {
+        const idUrn = Urn.fromValidString(id);
+        if (idUrn.namespaceIdentifier() !== NotarizationService._NAMESPACE) {
+            throw new GeneralError(NotarizationService.CLASS_NAME, "namespaceMismatch", {
+                namespace: NotarizationService._NAMESPACE,
+                id
+            });
+        }
+        return NotarizationConnectorFactory.get(idUrn.namespaceMethod());
+    }
+}
+//# sourceMappingURL=notarizationService.js.map

package/dist/es/notarizationService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notarizationService.js","sourceRoot":"","sources":["../../src/notarizationService.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAE3D,OAAO,EACN,4BAA4B,EAI5B,MAAM,+BAA+B,CAAC;AAGvC;;GAEG;AACH,MAAM,OAAO,mBAAmB;IAC/B;;OAEG;IACI,MAAM,CAAU,UAAU,yBAAyC;IAE1E;;;OAGG;IACK,MAAM,CAAU,UAAU,GAAW,cAAc,CAAC;IAE5D;;;OAGG;IACc,iBAAiB,CAAS;IAE3C;;;OAGG;IACH,YAAY,OAAgD;QAC3D,MAAM,KAAK,GAAG,4BAA4B,CAAC,KAAK,EAAE,CAAC;QACnD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACxB,MAAM,IAAI,YAAY,CAAC,mBAAmB,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;QACxE,CAAC;QAED,IAAI,CAAC,iBAAiB,GAAG,OAAO,EAAE,MAAM,EAAE,gBAAgB,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC;IACxE,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,mBAAmB,CAAC,UAAU,CAAC;IACvC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CAClB,YAAuD,EACvD,SAAkB,EAClB,kBAA2B;QAE3B,MAAM,CAAC,MAAM,CAAC,mBAAmB,CAAC,UAAU,kBAAwB,YAAY,CAAC,CAAC;QAClF,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC7B,MAAM,CAAC,WAAW,CAAC,mBAAmB,CAAC,UAAU,eAAqB,SAAS,CAAC,CAAC;QAClF,CAAC;QACD,MAAM,CAAC,WAAW,CACjB,mBAAmB,CAAC,UAAU,wBAE9B,kBAAkB,CAClB,CAAC;QAEF,IAAI,CAAC;YACJ,MAAM,kBAAkB,GAAG,SAAS,IAAI,IAAI,CAAC,iBAAiB,CAAC;YAE/D,MAAM,qBAAqB,GAC1B,4BAA4B,CAAC,GAAG,CAAyB,kBAAkB,CAAC,CAAC;YAE9E,MAAM,cAAc,GAAG,MAAM,qBAAqB,CAAC,MAAM,CAAC,kBAAkB,EAAE,YAAY,CAAC,CAAC;YAE5F,OAAO,cAAc,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,MAAM,IAAI,YAAY,CAAC,mBAAmB,CAAC,UAAU,EAAE,cAAc,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;QAC1F,CAAC;IACF,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,GAAG,CAAC,EAAU;QAC1B,GAAG,CAAC,KAAK,CAAC,mBAAmB,CAAC,UAAU,QAAc,EAAE,CAAC,CAAC;QAE1D,IAAI,CAAC;YACJ,MAAM,qBAAqB,GAAG,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;YACpD,MAAM,MAAM,GAAG,MAAM,qBAAqB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAEnD,OAAO,MAAM,CAAC;QACf,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,MAAM,IAAI,YAAY,CAAC,mBAAmB,CAAC,UAAU,EAAE,WAAW,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;QACvF,CAAC;IACF,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,kBAA2B;QAC1D,GAAG,CAAC,KAAK,CAAC,mBAAmB,CAAC,UAAU,QAAc,EAAE,CAAC,CAAC;QAC1D,MAAM,CAAC,WAAW,CACjB,mBAAmB,CAAC,UAAU,wBAE9B,kBAAkB,CAClB,CAAC;QAEF,IAAI,CAAC;YACJ,MAAM,qBAAqB,GAAG,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;YACpD,MAAM,qBAAqB,CAAC,MAAM,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAC;QAC5D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,MAAM,IAAI,YAAY,CAAC,mBAAmB,CAAC,UAAU,EAAE,cAAc,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;QAC1F,CAAC;IACF,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,YAA2B,EAAE,kBAA2B;QAC3E,MAAM,CAAC,MAAM,CAAC,mBAAmB,CAAC,UAAU,kBAAwB,YAAY,CAAC,CAAC;QAClF,GAAG,CAAC,KAAK,CAAC,mBAAmB,CAAC,UAAU,qBAA2B,YAAY,CAAC,EAAE,CAAC,CAAC;QACpF,MAAM,CAAC,WAAW,CACjB,mBAAmB,CAAC,UAAU,wBAE9B,kBAAkB,CAClB,CAAC;QAEF,IAAI,CAAC;YACJ,MAAM,qBAAqB,GAAG,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;YACjE,MAAM,qBAAqB,CAAC,MAAM,CAAC,kBAAkB,EAAE,YAAY,CAAC,CAAC;QACtE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,MAAM,IAAI,YAAY,CAAC,mBAAmB,CAAC,UAAU,EAAE,cAAc,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;QAC1F,CAAC;IACF,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,QAAQ,CACpB,EAAU,EACV,gBAAwB,EACxB,kBAA2B;QAE3B,GAAG,CAAC,KAAK,CAAC,mBAAmB,CAAC,UAAU,QAAc,EAAE,CAAC,CAAC;QAC1D,MAAM,CAAC,WAAW,CAAC,mBAAmB,CAAC,UAAU,sBAA4B,gBAAgB,CAAC,CAAC;QAC/F,MAAM,CAAC,WAAW,CACjB,mBAAmB,CAAC,UAAU,wBAE9B,kBAAkB,CAClB,CAAC;QAEF,IAAI,CAAC;YACJ,MAAM,qBAAqB,GAAG,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;YACpD,MAAM,qBAAqB,CAAC,QAAQ,CAAC,kBAAkB,EAAE,EAAE,EAAE,gBAAgB,CAAC,CAAC;QAChF,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,MAAM,IAAI,YAAY,CAAC,mBAAmB,CAAC,UAAU,EAAE,gBAAgB,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;QAC5F,CAAC;IACF,CAAC;IAED;;;;;OAKG;IACK,YAAY,CAAC,EAAU;QAC9B,MAAM,KAAK,GAAG,GAAG,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;QAEtC,IAAI,KAAK,CAAC,mBAAmB,EAAE,KAAK,mBAAmB,CAAC,UAAU,EAAE,CAAC;YACpE,MAAM,IAAI,YAAY,CAAC,mBAAmB,CAAC,UAAU,EAAE,mBAAmB,EAAE;gBAC3E,SAAS,EAAE,mBAAmB,CAAC,UAAU;gBACzC,EAAE;aACF,CAAC,CAAC;QACJ,CAAC;QAED,OAAO,4BAA4B,CAAC,GAAG,CAAyB,KAAK,CAAC,eAAe,EAAE,CAAC,CAAC;IAC1F,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { GeneralError, Guards, Urn } from \"@twin.org/core\";\nimport { nameof } from \"@twin.org/nameof\";\nimport {\n\tNotarizationConnectorFactory,\n\ttype INotarization,\n\ttype INotarizationComponent,\n\ttype INotarizationConnector\n} from \"@twin.org/notarization-models\";\nimport type { INotarizationServiceConstructorOptions } from \"./models/INotarizationServiceConstructorOptions.js\";\n\n/**\n * Service for notarization operations.\n */\nexport class NotarizationService implements INotarizationComponent {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<NotarizationService>();\n\n\t/**\n\t * The namespace supported by the notarization service.\n\t * @internal\n\t */\n\tprivate static readonly _NAMESPACE: string = \"notarization\";\n\n\t/**\n\t * The default namespace for the connector to use.\n\t * @internal\n\t */\n\tprivate readonly _defaultNamespace: string;\n\n\t/**\n\t * Create a new instance of NotarizationService.\n\t * @param options The constructor options.\n\t */\n\tconstructor(options?: INotarizationServiceConstructorOptions) {\n\t\tconst names = NotarizationConnectorFactory.names();\n\t\tif (names.length === 0) {\n\t\t\tthrow new GeneralError(NotarizationService.CLASS_NAME, \"noConnectors\");\n\t\t}\n\n\t\tthis._defaultNamespace = options?.config?.defaultNamespace ?? names[0];\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn NotarizationService.CLASS_NAME;\n\t}\n\n\t/**\n\t * Create a new notarization.\n\t * @param notarization The notarization data without generated fields.\n\t * @param namespace The namespace of the connector to use for the notarization, defaults to service configured namespace.\n\t * @param controllerIdentity The identity to perform the notarization operation with.\n\t * @returns The generated notarization id.\n\t */\n\tpublic async create(\n\t\tnotarization: Omit<INotarization, \"id\" | \"dateCreated\">,\n\t\tnamespace?: string,\n\t\tcontrollerIdentity?: string\n\t): Promise<string> {\n\t\tGuards.object(NotarizationService.CLASS_NAME, nameof(notarization), notarization);\n\t\tif (namespace !== undefined) {\n\t\t\tGuards.stringValue(NotarizationService.CLASS_NAME, nameof(namespace), namespace);\n\t\t}\n\t\tGuards.stringValue(\n\t\t\tNotarizationService.CLASS_NAME,\n\t\t\tnameof(controllerIdentity),\n\t\t\tcontrollerIdentity\n\t\t);\n\n\t\ttry {\n\t\t\tconst connectorNamespace = namespace ?? this._defaultNamespace;\n\n\t\t\tconst notarizationConnector =\n\t\t\t\tNotarizationConnectorFactory.get<INotarizationConnector>(connectorNamespace);\n\n\t\t\tconst notarizationId = await notarizationConnector.create(controllerIdentity, notarization);\n\n\t\t\treturn notarizationId;\n\t\t} catch (error) {\n\t\t\tthrow new GeneralError(NotarizationService.CLASS_NAME, \"createFailed\", undefined, error);\n\t\t}\n\t}\n\n\t/**\n\t * Get an existing notarization.\n\t * @param id The id of the notarization to get.\n\t * @returns The notarization.\n\t */\n\tpublic async get(id: string): Promise<INotarization> {\n\t\tUrn.guard(NotarizationService.CLASS_NAME, nameof(id), id);\n\n\t\ttry {\n\t\t\tconst notarizationConnector = this.getConnector(id);\n\t\t\tconst result = await notarizationConnector.get(id);\n\n\t\t\treturn result;\n\t\t} catch (error) {\n\t\t\tthrow new GeneralError(NotarizationService.CLASS_NAME, \"getFailed\", undefined, error);\n\t\t}\n\t}\n\n\t/**\n\t * Remove an existing notarization.\n\t * @param id The id of the notarization to remove.\n\t * @param controllerIdentity The identity to perform the notarization operation with.\n\t * @returns Nothing.\n\t */\n\tpublic async remove(id: string, controllerIdentity?: string): Promise<void> {\n\t\tUrn.guard(NotarizationService.CLASS_NAME, nameof(id), id);\n\t\tGuards.stringValue(\n\t\t\tNotarizationService.CLASS_NAME,\n\t\t\tnameof(controllerIdentity),\n\t\t\tcontrollerIdentity\n\t\t);\n\n\t\ttry {\n\t\t\tconst notarizationConnector = this.getConnector(id);\n\t\t\tawait notarizationConnector.remove(controllerIdentity, id);\n\t\t} catch (error) {\n\t\t\tthrow new GeneralError(NotarizationService.CLASS_NAME, \"removeFailed\", undefined, error);\n\t\t}\n\t}\n\n\t/**\n\t * Update an existing notarization.\n\t * @param notarization The notarization to update.\n\t * @param controllerIdentity The identity to perform the notarization operation with.\n\t * @returns Nothing.\n\t */\n\tpublic async update(notarization: INotarization, controllerIdentity?: string): Promise<void> {\n\t\tGuards.object(NotarizationService.CLASS_NAME, nameof(notarization), notarization);\n\t\tUrn.guard(NotarizationService.CLASS_NAME, nameof(notarization.id), notarization.id);\n\t\tGuards.stringValue(\n\t\t\tNotarizationService.CLASS_NAME,\n\t\t\tnameof(controllerIdentity),\n\t\t\tcontrollerIdentity\n\t\t);\n\n\t\ttry {\n\t\t\tconst notarizationConnector = this.getConnector(notarization.id);\n\t\t\tawait notarizationConnector.update(controllerIdentity, notarization);\n\t\t} catch (error) {\n\t\t\tthrow new GeneralError(NotarizationService.CLASS_NAME, \"updateFailed\", undefined, error);\n\t\t}\n\t}\n\n\t/**\n\t * Transfer an existing notarization.\n\t * @param id The id of the notarization to transfer.\n\t * @param recipientAddress The recipient address.\n\t * @param controllerIdentity The identity to perform the notarization operation with.\n\t * @returns Nothing.\n\t */\n\tpublic async transfer(\n\t\tid: string,\n\t\trecipientAddress: string,\n\t\tcontrollerIdentity?: string\n\t): Promise<void> {\n\t\tUrn.guard(NotarizationService.CLASS_NAME, nameof(id), id);\n\t\tGuards.stringValue(NotarizationService.CLASS_NAME, nameof(recipientAddress), recipientAddress);\n\t\tGuards.stringValue(\n\t\t\tNotarizationService.CLASS_NAME,\n\t\t\tnameof(controllerIdentity),\n\t\t\tcontrollerIdentity\n\t\t);\n\n\t\ttry {\n\t\t\tconst notarizationConnector = this.getConnector(id);\n\t\t\tawait notarizationConnector.transfer(controllerIdentity, id, recipientAddress);\n\t\t} catch (error) {\n\t\t\tthrow new GeneralError(NotarizationService.CLASS_NAME, \"transferFailed\", undefined, error);\n\t\t}\n\t}\n\n\t/**\n\t * Get the connector from the id.\n\t * @param id The id of the notarization in urn format.\n\t * @returns The connector.\n\t * @internal\n\t */\n\tprivate getConnector(id: string): INotarizationConnector {\n\t\tconst idUrn = Urn.fromValidString(id);\n\n\t\tif (idUrn.namespaceIdentifier() !== NotarizationService._NAMESPACE) {\n\t\t\tthrow new GeneralError(NotarizationService.CLASS_NAME, \"namespaceMismatch\", {\n\t\t\t\tnamespace: NotarizationService._NAMESPACE,\n\t\t\t\tid\n\t\t\t});\n\t\t}\n\n\t\treturn NotarizationConnectorFactory.get<INotarizationConnector>(idUrn.namespaceMethod());\n\t}\n}\n"]}

package/dist/es/restEntryPoints.js

@@ -0,0 +1,10 @@
+import { generateRestRoutesNotarization, tagsNotarization } from "./notarizationRoutes.js";
+export const restEntryPoints = [
+    {
+        name: "notarization",
+        defaultBaseRoute: "notarization",
+        tags: tagsNotarization,
+        generateRoutes: generateRestRoutesNotarization
+    }
+];
+//# sourceMappingURL=restEntryPoints.js.map

package/dist/es/restEntryPoints.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"restEntryPoints.js","sourceRoot":"","sources":["../../src/restEntryPoints.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,8BAA8B,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAE3F,MAAM,CAAC,MAAM,eAAe,GAA2B;IACtD;QACC,IAAI,EAAE,cAAc;QACpB,gBAAgB,EAAE,cAAc;QAChC,IAAI,EAAE,gBAAgB;QACtB,cAAc,EAAE,8BAA8B;KAC9C;CACD,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IRestRouteEntryPoint } from \"@twin.org/api-models\";\nimport { generateRestRoutesNotarization, tagsNotarization } from \"./notarizationRoutes.js\";\n\nexport const restEntryPoints: IRestRouteEntryPoint[] = [\n\t{\n\t\tname: \"notarization\",\n\t\tdefaultBaseRoute: \"notarization\",\n\t\ttags: tagsNotarization,\n\t\tgenerateRoutes: generateRestRoutesNotarization\n\t}\n];\n"]}

package/dist/types/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./models/INotarizationServiceConfig.js";
+export * from "./models/INotarizationServiceConstructorOptions.js";
+export * from "./notarizationRoutes.js";
+export * from "./notarizationService.js";
+export * from "./restEntryPoints.js";

package/dist/types/models/INotarizationServiceConfig.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Configuration for the Notarization Service.
+ */
+export interface INotarizationServiceConfig {
+    /**
+     * What is the default connector to use for notarization. If not provided the first connector from the factory will be used.
+     */
+    defaultNamespace?: string;
+}

package/dist/types/models/INotarizationServiceConstructorOptions.d.ts

@@ -0,0 +1,10 @@
+import type { INotarizationServiceConfig } from "./INotarizationServiceConfig.js";
+/**
+ * Options for the notarization service constructor.
+ */
+export interface INotarizationServiceConstructorOptions {
+    /**
+     * The configuration for the service.
+     */
+    config?: INotarizationServiceConfig;
+}

package/dist/types/notarizationRoutes.d.ts

@@ -0,0 +1,53 @@
+import type { ICreatedResponse, IHttpRequestContext, INoContentResponse, IRestRoute, ITag } from "@twin.org/api-models";
+import type { INotarizationCreateRequest, INotarizationGetRequest, INotarizationGetResponse, INotarizationRemoveRequest, INotarizationTransferRequest, INotarizationUpdateRequest } from "@twin.org/notarization-models";
+/**
+ * The tag to associate with the routes.
+ */
+export declare const tagsNotarization: ITag[];
+/**
+ * The REST routes for notarization.
+ * @param baseRouteName Prefix to prepend to the paths.
+ * @param componentName The name of the component to use in the routes stored in the ComponentFactory.
+ * @returns The generated routes.
+ */
+export declare function generateRestRoutesNotarization(baseRouteName: string, componentName: string): IRestRoute[];
+/**
+ * Perform the create notarization operation.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function notarizationCreate(httpRequestContext: IHttpRequestContext, componentName: string, request: INotarizationCreateRequest): Promise<ICreatedResponse>;
+/**
+ * Perform the remove notarization operation.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function notarizationRemove(httpRequestContext: IHttpRequestContext, componentName: string, request: INotarizationRemoveRequest): Promise<INoContentResponse>;
+/**
+ * Perform the get notarization operation.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function notarizationGet(httpRequestContext: IHttpRequestContext, componentName: string, request: INotarizationGetRequest): Promise<INotarizationGetResponse>;
+/**
+ * Perform the update notarization operation.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function notarizationUpdate(httpRequestContext: IHttpRequestContext, componentName: string, request: INotarizationUpdateRequest): Promise<INoContentResponse>;
+/**
+ * Perform the transfer notarization operation.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function notarizationTransfer(httpRequestContext: IHttpRequestContext, componentName: string, request: INotarizationTransferRequest): Promise<INoContentResponse>;

package/dist/types/notarizationService.d.ts

@@ -0,0 +1,57 @@
+import { type INotarization, type INotarizationComponent } from "@twin.org/notarization-models";
+import type { INotarizationServiceConstructorOptions } from "./models/INotarizationServiceConstructorOptions.js";
+/**
+ * Service for notarization operations.
+ */
+export declare class NotarizationService implements INotarizationComponent {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of NotarizationService.
+     * @param options The constructor options.
+     */
+    constructor(options?: INotarizationServiceConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
+    /**
+     * Create a new notarization.
+     * @param notarization The notarization data without generated fields.
+     * @param namespace The namespace of the connector to use for the notarization, defaults to service configured namespace.
+     * @param controllerIdentity The identity to perform the notarization operation with.
+     * @returns The generated notarization id.
+     */
+    create(notarization: Omit<INotarization, "id" | "dateCreated">, namespace?: string, controllerIdentity?: string): Promise<string>;
+    /**
+     * Get an existing notarization.
+     * @param id The id of the notarization to get.
+     * @returns The notarization.
+     */
+    get(id: string): Promise<INotarization>;
+    /**
+     * Remove an existing notarization.
+     * @param id The id of the notarization to remove.
+     * @param controllerIdentity The identity to perform the notarization operation with.
+     * @returns Nothing.
+     */
+    remove(id: string, controllerIdentity?: string): Promise<void>;
+    /**
+     * Update an existing notarization.
+     * @param notarization The notarization to update.
+     * @param controllerIdentity The identity to perform the notarization operation with.
+     * @returns Nothing.
+     */
+    update(notarization: INotarization, controllerIdentity?: string): Promise<void>;
+    /**
+     * Transfer an existing notarization.
+     * @param id The id of the notarization to transfer.
+     * @param recipientAddress The recipient address.
+     * @param controllerIdentity The identity to perform the notarization operation with.
+     * @returns Nothing.
+     */
+    transfer(id: string, recipientAddress: string, controllerIdentity?: string): Promise<void>;
+}

package/dist/types/restEntryPoints.d.ts

@@ -0,0 +1,2 @@
+import type { IRestRouteEntryPoint } from "@twin.org/api-models";
+export declare const restEntryPoints: IRestRouteEntryPoint[];

package/docs/changelog.md

@@ -0,0 +1,19 @@
+# Changelog
+
+## [0.0.3-next.1](https://github.com/twinfoundation/notarization/compare/notarization-service-v0.0.3-next.0...notarization-service-v0.0.3-next.1) (2026-04-16)
+
+
+### Features
+
+* initial commit ([2271741](https://github.com/twinfoundation/notarization/commit/2271741a6f3daae544b24ccd47a5075a1a2eaaac))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/notarization-models bumped from 0.0.3-next.0 to 0.0.3-next.1
+  * devDependencies
+    * @twin.org/notarization-connector-entity-storage bumped from 0.0.3-next.0 to 0.0.3-next.1
+
+## Changelog

package/docs/examples.md

@@ -0,0 +1,185 @@
+# Notarization Service Examples
+
+Use these snippets to compose connector-backed orchestration and expose HTTP route handlers for request processing.
+
+## NotarizationService
+
+```typescript
+import {
+  NotarizationConnectorFactory,
+  NotarizationMode,
+  type INotarization,
+  type INotarizationConnector
+} from '@twin.org/notarization-models';
+import { NotarizationService } from '@twin.org/notarization-service';
+
+class DemoConnector implements INotarizationConnector {
+  private readonly store: Map<string, INotarization>;
+
+  constructor() {
+    this.store = new Map<string, INotarization>();
+  }
+
+  public className(): string {
+    return 'DemoConnector';
+  }
+
+  public async create(
+    controllerIdentity: string,
+    notarization: Omit<INotarization, 'id' | 'dateCreated'>
+  ): Promise<string> {
+    const id = 'notarization:urn:notarization:demo:1';
+    this.store.set(id, {
+      ...notarization,
+      id,
+      mode: notarization.mode ?? NotarizationMode.Dynamic,
+      dateCreated: new Date().toISOString()
+    });
+    return id;
+  }
+
+  public async get(id: string): Promise<INotarization> {
+    const value = this.store.get(id);
+    if (!value) {
+      throw new Error('Missing notarization');
+    }
+    return value;
+  }
+
+  public async remove(controllerIdentity: string, id: string): Promise<void> {
+    this.store.delete(id);
+  }
+
+  public async update(controllerIdentity: string, notarization: INotarization): Promise<void> {
+    this.store.set(notarization.id, notarization);
+  }
+
+  public async transfer(
+    controllerIdentity: string,
+    id: string,
+    recipientAddress: string
+  ): Promise<void> {
+    const value = this.store.get(id);
+    if (!value) {
+      throw new Error('Missing notarization');
+    }
+    this.store.set(id, value);
+  }
+}
+
+NotarizationConnectorFactory.register('demo', () => new DemoConnector());
+
+const service = new NotarizationService({
+  config: {
+    defaultNamespace: 'demo'
+  }
+});
+
+const id = await service.create(
+  {
+    mode: NotarizationMode.Dynamic,
+    data: new Uint8Array([1, 2, 3]),
+    description: 'Created via service'
+  },
+  'demo',
+  'did:example:controller'
+);
+
+const notarization = await service.get(id);
+console.log(notarization.id); // notarization:urn:notarization:demo:1
+```
+
+```typescript
+import { NotarizationMode } from '@twin.org/notarization-models';
+import { NotarizationService } from '@twin.org/notarization-service';
+
+const service = new NotarizationService({
+  config: {
+    defaultNamespace: 'demo'
+  }
+});
+
+await service.update(
+  {
+    id: 'notarization:urn:notarization:demo:1',
+    mode: NotarizationMode.Dynamic,
+    dateCreated: '2026-01-01T00:00:00.000Z',
+    data: new Uint8Array([9, 9, 9]),
+    description: 'Updated via service'
+  },
+  'did:example:controller'
+);
+
+await service.transfer(
+  'notarization:urn:notarization:demo:1',
+  'did:example:recipient',
+  'did:example:controller'
+);
+
+await service.remove('notarization:urn:notarization:demo:1', 'did:example:controller');
+```
+
+## generateRestRoutesNotarization
+
+```typescript
+import { ContextIdKeys, ContextIdStore } from '@twin.org/context';
+import { ComponentFactory } from '@twin.org/core';
+import {
+  NotarizationMode,
+  type INotarization,
+  type INotarizationComponent
+} from '@twin.org/notarization-models';
+import { generateRestRoutesNotarization } from '@twin.org/notarization-service';
+
+class DemoComponent implements INotarizationComponent {
+  public className(): string {
+    return 'DemoComponent';
+  }
+
+  public async create(
+    notarization: Omit<INotarization, 'id' | 'dateCreated'>,
+    namespace?: string,
+    controllerIdentity?: string
+  ): Promise<string> {
+    return 'notarization:urn:notarization:demo:route-1';
+  }
+
+  public async get(id: string): Promise<INotarization> {
+    return {
+      id,
+      mode: NotarizationMode.Dynamic,
+      dateCreated: '2026-01-01T00:00:00.000Z',
+      data: new Uint8Array([1]),
+      description: 'Route response'
+    };
+  }
+
+  public async remove(id: string, controllerIdentity?: string): Promise<void> {}
+  public async update(notarization: INotarization, controllerIdentity?: string): Promise<void> {}
+  public async transfer(
+    id: string,
+    recipientAddress: string,
+    controllerIdentity?: string
+  ): Promise<void> {}
+}
+
+ComponentFactory.register('notarization', () => new DemoComponent());
+
+const routes = generateRestRoutesNotarization('/notarization', 'notarization');
+const createRoute = routes.find(route => route.operationId === 'notarizationCreate');
+
+const response = await ContextIdStore.run(
+  { [ContextIdKeys.Organization]: 'did:example:organisation' },
+  async () =>
+    createRoute?.handler({} as never, {
+      body: {
+        mode: NotarizationMode.Dynamic,
+        data: new Uint8Array([1, 2]),
+        description: 'Created by route',
+        namespace: 'demo'
+      }
+    })
+);
+
+console.log(response?.statusCode); // 201
+```