@twin.org/immutable-proof-service 0.0.1-next.27 → 0.0.1-next.28

package/dist/cjs/index.cjs

@@ -10,7 +10,7 @@ var crypto = require('@twin.org/crypto');
 var dataJsonLd = require('@twin.org/data-json-ld');
 var entityStorageModels = require('@twin.org/entity-storage-models');
 var identityModels = require('@twin.org/identity-models');
-var immutableStorageModels = require('@twin.org/immutable-storage-models');
+var verifiableStorageModels = require('@twin.org/verifiable-storage-models');
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
@@ -43,9 +43,9 @@ exports.ImmutableProof = class ImmutableProof {
      */
     proofObjectHash;
     /**
-     * The immutable storage id.
+     * The verifiable storage id.
      */
-    immutableStorageId;
+    verifiableStorageId;
 };
 __decorate([
     entity.property({ type: "string", isPrimary: true }),
@@ -74,7 +74,7 @@ __decorate([
 __decorate([
     entity.property({ type: "string", optional: true }),
     __metadata("design:type", String)
-], exports.ImmutableProof.prototype, "immutableStorageId", void 0);
+], exports.ImmutableProof.prototype, "verifiableStorageId", void 0);
 exports.ImmutableProof = __decorate([
     entity.entity()
 ], exports.ImmutableProof);
@@ -387,10 +387,10 @@ class ImmutableProofService {
      */
     _proofStorage;
     /**
-     * The immutable storage for the credentials.
+     * The verifiable storage for the credentials.
      * @internal
      */
-    _immutableStorage;
+    _verifiableStorage;
     /**
      * The background task connector.
      * @internal
@@ -417,7 +417,7 @@ class ImmutableProofService {
      */
     constructor(options) {
         this._proofStorage = entityStorageModels.EntityStorageConnectorFactory.get(options?.immutableProofEntityStorageType ?? core.StringHelper.kebabCase("ImmutableProof"));
-        this._immutableStorage = immutableStorageModels.ImmutableStorageConnectorFactory.get(options?.immutableStorageType ?? "immutable-storage");
+        this._verifiableStorage = verifiableStorageModels.VerifiableStorageConnectorFactory.get(options?.verifiableStorageType ?? "verifiable-storage");
         this._identityConnectorType = options?.identityConnectorType ?? "identity";
         this._identityConnector = identityModels.IdentityConnectorFactory.get(this._identityConnectorType);
         this._backgroundTaskConnector = backgroundTaskModels.BackgroundTaskConnectorFactory.get(options?.backgroundTaskConnectorType ?? "background-task");
@@ -528,13 +528,13 @@ class ImmutableProofService {
         }
     }
     /**
-     * Remove the immutable storage for the proof.
+     * Remove the verifiable storage for the proof.
      * @param id The id of the proof to remove the storage from.
      * @param nodeIdentity The node identity to use for vault operations.
      * @returns Nothing.
      * @throws NotFoundError if the proof is not found.
      */
-    async removeImmutable(id, nodeIdentity) {
+    async removeVerifiable(id, nodeIdentity) {
         core.Guards.stringValue(this.CLASS_NAME, "id", id);
         core.Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
         const urnParsed = core.Urn.fromValidString(id);
@@ -550,14 +550,14 @@ class ImmutableProofService {
             if (core.Is.empty(streamEntity)) {
                 throw new core.NotFoundError(this.CLASS_NAME, "proofNotFound", id);
             }
-            if (core.Is.stringValue(streamEntity.immutableStorageId)) {
-                await this._immutableStorage.remove(nodeIdentity, streamEntity.immutableStorageId);
-                delete streamEntity.immutableStorageId;
+            if (core.Is.stringValue(streamEntity.verifiableStorageId)) {
+                await this._verifiableStorage.remove(nodeIdentity, streamEntity.verifiableStorageId);
+                delete streamEntity.verifiableStorageId;
                 await this._proofStorage.set(streamEntity);
             }
         }
         catch (error) {
-            throw new core.GeneralError(this.CLASS_NAME, "removeImmutableFailed", undefined, error);
+            throw new core.GeneralError(this.CLASS_NAME, "removeVerifiableFailed", undefined, error);
         }
     }
     /**
@@ -605,8 +605,8 @@ class ImmutableProofService {
                     proofEntity.dateCreated = immutableProof.proof.created;
                 }
                 const compacted = await dataJsonLd.JsonLdProcessor.compact(immutableProof, immutableProof["@context"]);
-                const immutableStoreResult = await this._immutableStorage.store(proofEntity.nodeIdentity, core.ObjectHelper.toBytes(compacted));
-                proofEntity.immutableStorageId = immutableStoreResult.id;
+                const verifiableCreateResult = await this._verifiableStorage.create(proofEntity.nodeIdentity, core.ObjectHelper.toBytes(compacted));
+                proofEntity.verifiableStorageId = verifiableCreateResult.id;
                 await this._proofStorage.set(proofEntity);
                 await this._eventBusComponent?.publish(immutableProofModels.ImmutableProofTopics.ProofCreated, { id: new core.Urn(ImmutableProofService.NAMESPACE, task.payload.proofId).toString() });
             }
@@ -630,9 +630,9 @@ class ImmutableProofService {
         let proofJsonLd = this.proofEntityToJsonLd(proofEntity);
         let verified = false;
         let failure = immutableProofModels.ImmutableProofFailure.NotIssued;
-        if (core.Is.stringValue(proofEntity.immutableStorageId)) {
+        if (core.Is.stringValue(proofEntity.verifiableStorageId)) {
             failure = immutableProofModels.ImmutableProofFailure.ProofMissing;
-            const immutableResult = await this._immutableStorage.get(proofEntity.immutableStorageId);
+            const immutableResult = await this._verifiableStorage.get(proofEntity.verifiableStorageId);
             if (core.Is.uint8Array(immutableResult.data)) {
                 proofJsonLd = core.ObjectHelper.fromBytes(immutableResult.data);
                 const unsecureDocument = core.ObjectHelper.clone(proofJsonLd);

package/dist/esm/index.mjs

@@ -8,7 +8,7 @@ import { Sha256 } from '@twin.org/crypto';
 import { JsonLdHelper, JsonLdProcessor } from '@twin.org/data-json-ld';
 import { EntityStorageConnectorFactory } from '@twin.org/entity-storage-models';
 import { IdentityConnectorFactory } from '@twin.org/identity-models';
-import { ImmutableStorageConnectorFactory } from '@twin.org/immutable-storage-models';
+import { VerifiableStorageConnectorFactory } from '@twin.org/verifiable-storage-models';
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
@@ -41,9 +41,9 @@ let ImmutableProof = class ImmutableProof {
      */
     proofObjectHash;
     /**
-     * The immutable storage id.
+     * The verifiable storage id.
      */
-    immutableStorageId;
+    verifiableStorageId;
 };
 __decorate([
     property({ type: "string", isPrimary: true }),
@@ -72,7 +72,7 @@ __decorate([
 __decorate([
     property({ type: "string", optional: true }),
     __metadata("design:type", String)
-], ImmutableProof.prototype, "immutableStorageId", void 0);
+], ImmutableProof.prototype, "verifiableStorageId", void 0);
 ImmutableProof = __decorate([
     entity()
 ], ImmutableProof);
@@ -385,10 +385,10 @@ class ImmutableProofService {
      */
     _proofStorage;
     /**
-     * The immutable storage for the credentials.
+     * The verifiable storage for the credentials.
      * @internal
      */
-    _immutableStorage;
+    _verifiableStorage;
     /**
      * The background task connector.
      * @internal
@@ -415,7 +415,7 @@ class ImmutableProofService {
      */
     constructor(options) {
         this._proofStorage = EntityStorageConnectorFactory.get(options?.immutableProofEntityStorageType ?? StringHelper.kebabCase("ImmutableProof"));
-        this._immutableStorage = ImmutableStorageConnectorFactory.get(options?.immutableStorageType ?? "immutable-storage");
+        this._verifiableStorage = VerifiableStorageConnectorFactory.get(options?.verifiableStorageType ?? "verifiable-storage");
         this._identityConnectorType = options?.identityConnectorType ?? "identity";
         this._identityConnector = IdentityConnectorFactory.get(this._identityConnectorType);
         this._backgroundTaskConnector = BackgroundTaskConnectorFactory.get(options?.backgroundTaskConnectorType ?? "background-task");
@@ -526,13 +526,13 @@ class ImmutableProofService {
         }
     }
     /**
-     * Remove the immutable storage for the proof.
+     * Remove the verifiable storage for the proof.
      * @param id The id of the proof to remove the storage from.
      * @param nodeIdentity The node identity to use for vault operations.
      * @returns Nothing.
      * @throws NotFoundError if the proof is not found.
      */
-    async removeImmutable(id, nodeIdentity) {
+    async removeVerifiable(id, nodeIdentity) {
         Guards.stringValue(this.CLASS_NAME, "id", id);
         Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
         const urnParsed = Urn.fromValidString(id);
@@ -548,14 +548,14 @@ class ImmutableProofService {
             if (Is.empty(streamEntity)) {
                 throw new NotFoundError(this.CLASS_NAME, "proofNotFound", id);
             }
-            if (Is.stringValue(streamEntity.immutableStorageId)) {
-                await this._immutableStorage.remove(nodeIdentity, streamEntity.immutableStorageId);
-                delete streamEntity.immutableStorageId;
+            if (Is.stringValue(streamEntity.verifiableStorageId)) {
+                await this._verifiableStorage.remove(nodeIdentity, streamEntity.verifiableStorageId);
+                delete streamEntity.verifiableStorageId;
                 await this._proofStorage.set(streamEntity);
             }
         }
         catch (error) {
-            throw new GeneralError(this.CLASS_NAME, "removeImmutableFailed", undefined, error);
+            throw new GeneralError(this.CLASS_NAME, "removeVerifiableFailed", undefined, error);
         }
     }
     /**
@@ -603,8 +603,8 @@ class ImmutableProofService {
                     proofEntity.dateCreated = immutableProof.proof.created;
                 }
                 const compacted = await JsonLdProcessor.compact(immutableProof, immutableProof["@context"]);
-                const immutableStoreResult = await this._immutableStorage.store(proofEntity.nodeIdentity, ObjectHelper.toBytes(compacted));
-                proofEntity.immutableStorageId = immutableStoreResult.id;
+                const verifiableCreateResult = await this._verifiableStorage.create(proofEntity.nodeIdentity, ObjectHelper.toBytes(compacted));
+                proofEntity.verifiableStorageId = verifiableCreateResult.id;
                 await this._proofStorage.set(proofEntity);
                 await this._eventBusComponent?.publish(ImmutableProofTopics.ProofCreated, { id: new Urn(ImmutableProofService.NAMESPACE, task.payload.proofId).toString() });
             }
@@ -628,9 +628,9 @@ class ImmutableProofService {
         let proofJsonLd = this.proofEntityToJsonLd(proofEntity);
         let verified = false;
         let failure = ImmutableProofFailure.NotIssued;
-        if (Is.stringValue(proofEntity.immutableStorageId)) {
+        if (Is.stringValue(proofEntity.verifiableStorageId)) {
             failure = ImmutableProofFailure.ProofMissing;
-            const immutableResult = await this._immutableStorage.get(proofEntity.immutableStorageId);
+            const immutableResult = await this._verifiableStorage.get(proofEntity.verifiableStorageId);
             if (Is.uint8Array(immutableResult.data)) {
                 proofJsonLd = ObjectHelper.fromBytes(immutableResult.data);
                 const unsecureDocument = ObjectHelper.clone(proofJsonLd);

package/dist/types/entities/immutableProof.d.ts

@@ -27,7 +27,7 @@ export declare class ImmutableProof {
      */
     proofObjectHash: string;
     /**
-     * The immutable storage id.
+     * The verifiable storage id.
      */
-    immutableStorageId?: string;
+    verifiableStorageId?: string;
 }

package/dist/types/immutableProofService.d.ts

@@ -41,11 +41,11 @@ export declare class ImmutableProofService implements IImmutableProofComponent {
      */
     verify(id: string): Promise<IImmutableProofVerification>;
     /**
-     * Remove the immutable storage for the proof.
+     * Remove the verifiable storage for the proof.
      * @param id The id of the proof to remove the storage from.
      * @param nodeIdentity The node identity to use for vault operations.
      * @returns Nothing.
      * @throws NotFoundError if the proof is not found.
      */
-    removeImmutable(id: string, nodeIdentity?: string): Promise<void>;
+    removeVerifiable(id: string, nodeIdentity?: string): Promise<void>;
 }

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

@@ -9,10 +9,10 @@ export interface IImmutableProofServiceConstructorOptions {
      */
     immutableProofEntityStorageType?: string;
     /**
-     * The immutable storage.
-     * @default immutable-storage
+     * The verifiable storage.
+     * @default verifiable-storage
      */
-    immutableStorageType?: string;
+    verifiableStorageType?: string;
     /**
      * The identity connector type.
      * @default identity

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/immutable-proof-service - Changelog
 
-## v0.0.1-next.27
+## v0.0.1-next.28
 
 - Initial Release

package/docs/reference/classes/ImmutableProof.md

@@ -62,8 +62,8 @@ The associated hash for the item.
 
 ***
 
-### immutableStorageId?
+### verifiableStorageId?
 
-> `optional` **immutableStorageId**: `string`
+> `optional` **verifiableStorageId**: `string`
 
-The immutable storage id.
+The verifiable storage id.

package/docs/reference/classes/ImmutableProofService.md

@@ -146,11 +146,11 @@ NotFoundError if the proof is not found.
 
 ***
 
-### removeImmutable()
+### removeVerifiable()
 
-> **removeImmutable**(`id`, `nodeIdentity`?): `Promise`\<`void`\>
+> **removeVerifiable**(`id`, `nodeIdentity`?): `Promise`\<`void`\>
 
-Remove the immutable storage for the proof.
+Remove the verifiable storage for the proof.
 
 #### Parameters
 
@@ -178,4 +178,4 @@ NotFoundError if the proof is not found.
 
 #### Implementation of
 
-`IImmutableProofComponent.removeImmutable`
+`IImmutableProofComponent.removeVerifiable`

package/docs/reference/interfaces/IImmutableProofServiceConstructorOptions.md

@@ -18,16 +18,16 @@ immutable-proof
 
 ***
 
-### immutableStorageType?
+### verifiableStorageType?
 
-> `optional` **immutableStorageType**: `string`
+> `optional` **verifiableStorageType**: `string`
 
-The immutable storage.
+The verifiable storage.
 
 #### Default
 
 ```ts
-immutable-storage
+verifiable-storage
 ```
 
 ***

package/locales/en.json

@@ -5,7 +5,7 @@
 			"createFailed": "Creating the proof failed",
 			"getFailed": "Getting the proof failed",
 			"verifyFailed": "Verifying the proof failed",
-			"removeImmutableFailed": "Removing immutable entry from the Immutable Proof failed",
+			"removeVerifiableFailed": "Removing verifiable entry from the Immutable Proof failed",
 			"proofNotFound": "The proof with the Id \"{notFoundId}\" was not found"
 		}
 	}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/immutable-proof-service",
-	"version": "0.0.1-next.27",
+	"version": "0.0.1-next.28",
 	"description": "Immutable proof contract implementation and REST endpoint definitions",
 	"repository": {
 		"type": "git",
@@ -23,12 +23,12 @@
 		"@twin.org/entity-storage-models": "next",
 		"@twin.org/event-bus-models": "next",
 		"@twin.org/identity-models": "next",
-		"@twin.org/immutable-proof-models": "0.0.1-next.27",
-		"@twin.org/immutable-proof-task": "0.0.1-next.27",
-		"@twin.org/immutable-storage-models": "next",
+		"@twin.org/immutable-proof-models": "0.0.1-next.28",
+		"@twin.org/immutable-proof-task": "0.0.1-next.28",
 		"@twin.org/nameof": "next",
 		"@twin.org/standards-w3c-did": "next",
 		"@twin.org/vault-models": "next",
+		"@twin.org/verifiable-storage-models": "next",
 		"@twin.org/web": "next",
 		"jsonschema": "1.5.0"
 	},