@twin.org/immutable-proof-service 0.0.2-next.1 → 0.0.2-next.3

package/dist/cjs/index.cjs

@@ -363,15 +363,15 @@ async function immutableProofVerify(httpRequestContext, componentName, request)
  * Class for performing immutable proof operations.
  */
 class ImmutableProofService {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "ImmutableProofService";
     /**
      * The namespace for the service.
      * @internal
      */
     static _NAMESPACE = "immutable-proof";
-    /**
-     * Runtime name for the class.
-     */
-    CLASS_NAME = "ImmutableProofService";
     /**
      * The configuration for the connector.
      * @internal
@@ -417,7 +417,7 @@ class ImmutableProofService {
      * @param options The dependencies for the immutable proof connector.
      */
     constructor(options) {
-        this._proofStorage = entityStorageModels.EntityStorageConnectorFactory.get(options?.immutableProofEntityStorageType ?? core.StringHelper.kebabCase("ImmutableProof"));
+        this._proofStorage = entityStorageModels.EntityStorageConnectorFactory.get(options?.immutableProofEntityStorageType ?? "immutable-proof");
         this._verifiableStorage = verifiableStorageModels.VerifiableStorageConnectorFactory.get(options?.verifiableStorageType ?? "verifiable-storage");
         this._identityConnectorType = options?.identityConnectorType ?? "identity";
         this._identityConnector = identityModels.IdentityConnectorFactory.get(this._identityConnectorType);
@@ -439,13 +439,13 @@ class ImmutableProofService {
      * @returns The id of the new proof.
      */
     async create(document, userIdentity, nodeIdentity) {
-        core.Guards.object(this.CLASS_NAME, "document", document);
-        core.Guards.stringValue(this.CLASS_NAME, "userIdentity", userIdentity);
-        core.Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
+        core.Guards.object(ImmutableProofService.CLASS_NAME, "document", document);
+        core.Guards.stringValue(ImmutableProofService.CLASS_NAME, "userIdentity", userIdentity);
+        core.Guards.stringValue(ImmutableProofService.CLASS_NAME, "nodeIdentity", nodeIdentity);
         try {
             const validationFailures = [];
             await dataJsonLd.JsonLdHelper.validate(document, validationFailures);
-            core.Validation.asValidationError(this.CLASS_NAME, "document", validationFailures);
+            core.Validation.asValidationError(ImmutableProofService.CLASS_NAME, "document", validationFailures);
             const id = core.Converter.bytesToHex(core.RandomHelper.generate(32), false);
             const dateCreated = new Date(Date.now()).toISOString();
             const proofObjectId = core.ObjectHelper.extractProperty(document, ["@id", "id"], false);
@@ -474,7 +474,7 @@ class ImmutableProofService {
             return new core.Urn(ImmutableProofService._NAMESPACE, id).toString();
         }
         catch (error) {
-            throw new core.GeneralError(this.CLASS_NAME, "createFailed", undefined, error);
+            throw new core.GeneralError(ImmutableProofService.CLASS_NAME, "createFailed", undefined, error);
         }
     }
     /**
@@ -484,10 +484,10 @@ class ImmutableProofService {
      * @throws NotFoundError if the proof is not found.
      */
     async get(id) {
-        core.Guards.stringValue(this.CLASS_NAME, "id", id);
+        core.Guards.stringValue(ImmutableProofService.CLASS_NAME, "id", id);
         const urnParsed = core.Urn.fromValidString(id);
         if (urnParsed.namespaceIdentifier() !== ImmutableProofService._NAMESPACE) {
-            throw new core.GeneralError(this.CLASS_NAME, "namespaceMismatch", {
+            throw new core.GeneralError(ImmutableProofService.CLASS_NAME, "namespaceMismatch", {
                 namespace: ImmutableProofService._NAMESPACE,
                 id
             });
@@ -497,7 +497,7 @@ class ImmutableProofService {
             return dataJsonLd.JsonLdProcessor.compact(immutableProof, immutableProof["@context"]);
         }
         catch (error) {
-            throw new core.GeneralError(this.CLASS_NAME, "getFailed", undefined, error);
+            throw new core.GeneralError(ImmutableProofService.CLASS_NAME, "getFailed", undefined, error);
         }
     }
     /**
@@ -507,10 +507,10 @@ class ImmutableProofService {
      * @throws NotFoundError if the proof is not found.
      */
     async verify(id) {
-        core.Guards.stringValue(this.CLASS_NAME, "id", id);
+        core.Guards.stringValue(ImmutableProofService.CLASS_NAME, "id", id);
         const urnParsed = core.Urn.fromValidString(id);
         if (urnParsed.namespaceIdentifier() !== ImmutableProofService._NAMESPACE) {
-            throw new core.GeneralError(this.CLASS_NAME, "namespaceMismatch", {
+            throw new core.GeneralError(ImmutableProofService.CLASS_NAME, "namespaceMismatch", {
                 namespace: ImmutableProofService._NAMESPACE,
                 id
             });
@@ -525,7 +525,7 @@ class ImmutableProofService {
             };
         }
         catch (error) {
-            throw new core.GeneralError(this.CLASS_NAME, "verifyFailed", undefined, error);
+            throw new core.GeneralError(ImmutableProofService.CLASS_NAME, "verifyFailed", undefined, error);
         }
     }
     /**
@@ -536,11 +536,11 @@ class ImmutableProofService {
      * @throws NotFoundError if the proof is not found.
      */
     async removeVerifiable(id, nodeIdentity) {
-        core.Guards.stringValue(this.CLASS_NAME, "id", id);
-        core.Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
+        core.Guards.stringValue(ImmutableProofService.CLASS_NAME, "id", id);
+        core.Guards.stringValue(ImmutableProofService.CLASS_NAME, "nodeIdentity", nodeIdentity);
         const urnParsed = core.Urn.fromValidString(id);
         if (urnParsed.namespaceIdentifier() !== ImmutableProofService._NAMESPACE) {
-            throw new core.GeneralError(this.CLASS_NAME, "namespaceMismatch", {
+            throw new core.GeneralError(ImmutableProofService.CLASS_NAME, "namespaceMismatch", {
                 namespace: ImmutableProofService._NAMESPACE,
                 id
             });
@@ -549,7 +549,7 @@ class ImmutableProofService {
             const streamId = urnParsed.namespaceSpecific(0);
             const streamEntity = await this._proofStorage.get(streamId);
             if (core.Is.empty(streamEntity)) {
-                throw new core.NotFoundError(this.CLASS_NAME, "proofNotFound", id);
+                throw new core.NotFoundError(ImmutableProofService.CLASS_NAME, "proofNotFound", id);
             }
             if (core.Is.stringValue(streamEntity.verifiableStorageId)) {
                 await this._verifiableStorage.remove(nodeIdentity, streamEntity.verifiableStorageId);
@@ -558,7 +558,7 @@ class ImmutableProofService {
             }
         }
         catch (error) {
-            throw new core.GeneralError(this.CLASS_NAME, "removeVerifiableFailed", undefined, error);
+            throw new core.GeneralError(ImmutableProofService.CLASS_NAME, "removeVerifiableFailed", undefined, error);
         }
     }
     /**
@@ -627,7 +627,7 @@ class ImmutableProofService {
         const proofId = urnParsed.namespaceSpecific(0);
         const proofEntity = await this._proofStorage.get(proofId);
         if (core.Is.empty(proofEntity)) {
-            throw new core.NotFoundError(this.CLASS_NAME, "proofNotFound", id);
+            throw new core.NotFoundError(ImmutableProofService.CLASS_NAME, "proofNotFound", id);
         }
         let proofJsonLd = this.proofEntityToJsonLd(proofEntity);
         let verified = false;

package/dist/esm/index.mjs

@@ -1,5 +1,5 @@
 import { property, SortDirection, entity, EntitySchemaFactory, EntitySchemaHelper } from '@twin.org/entity';
-import { Guards, ComponentFactory, StringHelper, Is, Validation, Converter, RandomHelper, ObjectHelper, Urn, GeneralError, NotFoundError, JsonHelper } from '@twin.org/core';
+import { Guards, ComponentFactory, Is, Validation, Converter, RandomHelper, ObjectHelper, Urn, GeneralError, NotFoundError, JsonHelper } from '@twin.org/core';
 import { ImmutableProofTypes, ImmutableProofContexts, ImmutableProofFailure, ImmutableProofTopics } from '@twin.org/immutable-proof-models';
 import { DidCryptoSuites, ProofTypes, DidContexts } from '@twin.org/standards-w3c-did';
 import { HttpStatusCode, HeaderTypes, MimeTypes } from '@twin.org/web';
@@ -361,15 +361,15 @@ async function immutableProofVerify(httpRequestContext, componentName, request)
  * Class for performing immutable proof operations.
  */
 class ImmutableProofService {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "ImmutableProofService";
     /**
      * The namespace for the service.
      * @internal
      */
     static _NAMESPACE = "immutable-proof";
-    /**
-     * Runtime name for the class.
-     */
-    CLASS_NAME = "ImmutableProofService";
     /**
      * The configuration for the connector.
      * @internal
@@ -415,7 +415,7 @@ class ImmutableProofService {
      * @param options The dependencies for the immutable proof connector.
      */
     constructor(options) {
-        this._proofStorage = EntityStorageConnectorFactory.get(options?.immutableProofEntityStorageType ?? StringHelper.kebabCase("ImmutableProof"));
+        this._proofStorage = EntityStorageConnectorFactory.get(options?.immutableProofEntityStorageType ?? "immutable-proof");
         this._verifiableStorage = VerifiableStorageConnectorFactory.get(options?.verifiableStorageType ?? "verifiable-storage");
         this._identityConnectorType = options?.identityConnectorType ?? "identity";
         this._identityConnector = IdentityConnectorFactory.get(this._identityConnectorType);
@@ -437,13 +437,13 @@ class ImmutableProofService {
      * @returns The id of the new proof.
      */
     async create(document, userIdentity, nodeIdentity) {
-        Guards.object(this.CLASS_NAME, "document", document);
-        Guards.stringValue(this.CLASS_NAME, "userIdentity", userIdentity);
-        Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
+        Guards.object(ImmutableProofService.CLASS_NAME, "document", document);
+        Guards.stringValue(ImmutableProofService.CLASS_NAME, "userIdentity", userIdentity);
+        Guards.stringValue(ImmutableProofService.CLASS_NAME, "nodeIdentity", nodeIdentity);
         try {
             const validationFailures = [];
             await JsonLdHelper.validate(document, validationFailures);
-            Validation.asValidationError(this.CLASS_NAME, "document", validationFailures);
+            Validation.asValidationError(ImmutableProofService.CLASS_NAME, "document", validationFailures);
             const id = Converter.bytesToHex(RandomHelper.generate(32), false);
             const dateCreated = new Date(Date.now()).toISOString();
             const proofObjectId = ObjectHelper.extractProperty(document, ["@id", "id"], false);
@@ -472,7 +472,7 @@ class ImmutableProofService {
             return new Urn(ImmutableProofService._NAMESPACE, id).toString();
         }
         catch (error) {
-            throw new GeneralError(this.CLASS_NAME, "createFailed", undefined, error);
+            throw new GeneralError(ImmutableProofService.CLASS_NAME, "createFailed", undefined, error);
         }
     }
     /**
@@ -482,10 +482,10 @@ class ImmutableProofService {
      * @throws NotFoundError if the proof is not found.
      */
     async get(id) {
-        Guards.stringValue(this.CLASS_NAME, "id", id);
+        Guards.stringValue(ImmutableProofService.CLASS_NAME, "id", id);
         const urnParsed = Urn.fromValidString(id);
         if (urnParsed.namespaceIdentifier() !== ImmutableProofService._NAMESPACE) {
-            throw new GeneralError(this.CLASS_NAME, "namespaceMismatch", {
+            throw new GeneralError(ImmutableProofService.CLASS_NAME, "namespaceMismatch", {
                 namespace: ImmutableProofService._NAMESPACE,
                 id
             });
@@ -495,7 +495,7 @@ class ImmutableProofService {
             return JsonLdProcessor.compact(immutableProof, immutableProof["@context"]);
         }
         catch (error) {
-            throw new GeneralError(this.CLASS_NAME, "getFailed", undefined, error);
+            throw new GeneralError(ImmutableProofService.CLASS_NAME, "getFailed", undefined, error);
         }
     }
     /**
@@ -505,10 +505,10 @@ class ImmutableProofService {
      * @throws NotFoundError if the proof is not found.
      */
     async verify(id) {
-        Guards.stringValue(this.CLASS_NAME, "id", id);
+        Guards.stringValue(ImmutableProofService.CLASS_NAME, "id", id);
         const urnParsed = Urn.fromValidString(id);
         if (urnParsed.namespaceIdentifier() !== ImmutableProofService._NAMESPACE) {
-            throw new GeneralError(this.CLASS_NAME, "namespaceMismatch", {
+            throw new GeneralError(ImmutableProofService.CLASS_NAME, "namespaceMismatch", {
                 namespace: ImmutableProofService._NAMESPACE,
                 id
             });
@@ -523,7 +523,7 @@ class ImmutableProofService {
             };
         }
         catch (error) {
-            throw new GeneralError(this.CLASS_NAME, "verifyFailed", undefined, error);
+            throw new GeneralError(ImmutableProofService.CLASS_NAME, "verifyFailed", undefined, error);
         }
     }
     /**
@@ -534,11 +534,11 @@ class ImmutableProofService {
      * @throws NotFoundError if the proof is not found.
      */
     async removeVerifiable(id, nodeIdentity) {
-        Guards.stringValue(this.CLASS_NAME, "id", id);
-        Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
+        Guards.stringValue(ImmutableProofService.CLASS_NAME, "id", id);
+        Guards.stringValue(ImmutableProofService.CLASS_NAME, "nodeIdentity", nodeIdentity);
         const urnParsed = Urn.fromValidString(id);
         if (urnParsed.namespaceIdentifier() !== ImmutableProofService._NAMESPACE) {
-            throw new GeneralError(this.CLASS_NAME, "namespaceMismatch", {
+            throw new GeneralError(ImmutableProofService.CLASS_NAME, "namespaceMismatch", {
                 namespace: ImmutableProofService._NAMESPACE,
                 id
             });
@@ -547,7 +547,7 @@ class ImmutableProofService {
             const streamId = urnParsed.namespaceSpecific(0);
             const streamEntity = await this._proofStorage.get(streamId);
             if (Is.empty(streamEntity)) {
-                throw new NotFoundError(this.CLASS_NAME, "proofNotFound", id);
+                throw new NotFoundError(ImmutableProofService.CLASS_NAME, "proofNotFound", id);
             }
             if (Is.stringValue(streamEntity.verifiableStorageId)) {
                 await this._verifiableStorage.remove(nodeIdentity, streamEntity.verifiableStorageId);
@@ -556,7 +556,7 @@ class ImmutableProofService {
             }
         }
         catch (error) {
-            throw new GeneralError(this.CLASS_NAME, "removeVerifiableFailed", undefined, error);
+            throw new GeneralError(ImmutableProofService.CLASS_NAME, "removeVerifiableFailed", undefined, error);
         }
     }
     /**
@@ -625,7 +625,7 @@ class ImmutableProofService {
         const proofId = urnParsed.namespaceSpecific(0);
         const proofEntity = await this._proofStorage.get(proofId);
         if (Is.empty(proofEntity)) {
-            throw new NotFoundError(this.CLASS_NAME, "proofNotFound", id);
+            throw new NotFoundError(ImmutableProofService.CLASS_NAME, "proofNotFound", id);
         }
         let proofJsonLd = this.proofEntityToJsonLd(proofEntity);
         let verified = false;

package/dist/types/immutableProofService.d.ts

@@ -8,7 +8,7 @@ export declare class ImmutableProofService implements IImmutableProofComponent {
     /**
      * Runtime name for the class.
      */
-    readonly CLASS_NAME: string;
+    static readonly CLASS_NAME: string;
     /**
      * Create a new instance of ImmutableProofService.
      * @param options The dependencies for the immutable proof connector.

package/docs/changelog.md

@@ -1,5 +1,35 @@
 # @twin.org/immutable-proof-service - Changelog
 
+## [0.0.2-next.3](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-service-v0.0.2-next.2...immutable-proof-service-v0.0.2-next.3) (2025-10-09)
+
+
+### Features
+
+* add validate-locales ([d6a7c07](https://github.com/twinfoundation/immutable-proof/commit/d6a7c0794a1922981a42f56cc24724d7cee727f6))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/immutable-proof-models bumped from 0.0.2-next.2 to 0.0.2-next.3
+    * @twin.org/immutable-proof-task bumped from 0.0.2-next.2 to 0.0.2-next.3
+
+## [0.0.2-next.2](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-service-v0.0.2-next.1...immutable-proof-service-v0.0.2-next.2) (2025-08-29)
+
+
+### Features
+
+* eslint migration to flat config ([c8536f2](https://github.com/twinfoundation/immutable-proof/commit/c8536f219c7709c6c08b9266e537831f9054dda9))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/immutable-proof-models bumped from 0.0.2-next.1 to 0.0.2-next.2
+    * @twin.org/immutable-proof-task bumped from 0.0.2-next.1 to 0.0.2-next.2
+
 ## [0.0.2-next.1](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-service-v0.0.2-next.0...immutable-proof-service-v0.0.2-next.1) (2025-08-20)
 
 

package/docs/open-api/spec.json

@@ -78,7 +78,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "GeneralError",
-											"message": "component.error",
+											"message": "errorMessage",
 											"properties": {
 												"foo": "bar"
 											}
@@ -99,7 +99,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "UnauthorizedError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}
@@ -117,7 +117,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "NotFoundError",
-											"message": "component.error",
+											"message": "errorMessage",
 											"properties": {
 												"notFoundId": "1"
 											}
@@ -138,7 +138,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "InternalServerError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}
@@ -266,7 +266,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "GeneralError",
-											"message": "component.error",
+											"message": "errorMessage",
 											"properties": {
 												"foo": "bar"
 											}
@@ -287,7 +287,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "UnauthorizedError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}
@@ -305,7 +305,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "NotFoundError",
-											"message": "component.error",
+											"message": "errorMessage",
 											"properties": {
 												"notFoundId": "1"
 											}
@@ -326,7 +326,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "InternalServerError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}
@@ -409,7 +409,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "GeneralError",
-											"message": "component.error",
+											"message": "errorMessage",
 											"properties": {
 												"foo": "bar"
 											}
@@ -430,7 +430,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "UnauthorizedError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}
@@ -448,7 +448,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "NotFoundError",
-											"message": "component.error",
+											"message": "errorMessage",
 											"properties": {
 												"notFoundId": "1"
 											}
@@ -469,7 +469,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "InternalServerError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}

package/docs/reference/classes/ImmutableProofService.md

@@ -30,14 +30,10 @@ The dependencies for the immutable proof connector.
 
 ### CLASS\_NAME
 
-> `readonly` **CLASS\_NAME**: `string`
+> `readonly` `static` **CLASS\_NAME**: `string`
 
 Runtime name for the class.
 
-#### Implementation of
-
-`IImmutableProofComponent.CLASS_NAME`
-
 ## Methods
 
 ### create()

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/immutable-proof-service",
-	"version": "0.0.2-next.1",
+	"version": "0.0.2-next.3",
 	"description": "Immutable proof contract implementation and REST endpoint definitions",
 	"repository": {
 		"type": "git",
@@ -23,8 +23,8 @@
 		"@twin.org/entity-storage-models": "next",
 		"@twin.org/event-bus-models": "next",
 		"@twin.org/identity-models": "next",
-		"@twin.org/immutable-proof-models": "0.0.2-next.1",
-		"@twin.org/immutable-proof-task": "0.0.2-next.1",
+		"@twin.org/immutable-proof-models": "0.0.2-next.3",
+		"@twin.org/immutable-proof-task": "0.0.2-next.3",
 		"@twin.org/nameof": "next",
 		"@twin.org/standards-w3c-did": "next",
 		"@twin.org/vault-models": "next",
@@ -48,5 +48,20 @@
 		"dist/types",
 		"locales",
 		"docs"
-	]
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"immutable-proof",
+		"service",
+		"microservice",
+		"business-logic"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/immutable-proof/issues"
+	},
+	"homepage": "https://twindev.org"
 }