@twin.org/immutable-proof-models 0.0.1-next.26 → 0.0.1-next.28

package/dist/cjs/index.cjs

@@ -9,14 +9,6 @@ var dataCore = require('@twin.org/data-core');
  */
 // eslint-disable-next-line @typescript-eslint/naming-convention
 const ImmutableProofTypes = {
-    /**
-     * The context root for the immutable proof types.
-     */
-    ContextRoot: "https://schema.twindev.org/immutable-proof/",
-    /**
-     * The context root for the common types.
-     */
-    ContextRootCommon: "https://schema.twindev.org/common/",
     /**
      * Represents Immutable Proof.
      */
@@ -117,6 +109,23 @@ class ImmutableProofDataTypes {
     }
 }
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The contexts of immutable proof data.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const ImmutableProofContexts = {
+    /**
+     * The context root for the immutable proof types.
+     */
+    ContextRoot: "https://schema.twindev.org/immutable-proof/",
+    /**
+     * The context root for the common types.
+     */
+    ContextRootCommon: "https://schema.twindev.org/common/"
+};
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -159,6 +168,7 @@ const ImmutableProofTopics = {
     ProofCreated: "immutable-proof:proof-created"
 };
 
+exports.ImmutableProofContexts = ImmutableProofContexts;
 exports.ImmutableProofDataTypes = ImmutableProofDataTypes;
 exports.ImmutableProofFailure = ImmutableProofFailure;
 exports.ImmutableProofTopics = ImmutableProofTopics;

package/dist/esm/index.mjs

@@ -7,14 +7,6 @@ import { DataTypeHandlerFactory } from '@twin.org/data-core';
  */
 // eslint-disable-next-line @typescript-eslint/naming-convention
 const ImmutableProofTypes = {
-    /**
-     * The context root for the immutable proof types.
-     */
-    ContextRoot: "https://schema.twindev.org/immutable-proof/",
-    /**
-     * The context root for the common types.
-     */
-    ContextRootCommon: "https://schema.twindev.org/common/",
     /**
      * Represents Immutable Proof.
      */
@@ -115,6 +107,23 @@ class ImmutableProofDataTypes {
     }
 }
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The contexts of immutable proof data.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const ImmutableProofContexts = {
+    /**
+     * The context root for the immutable proof types.
+     */
+    ContextRoot: "https://schema.twindev.org/immutable-proof/",
+    /**
+     * The context root for the common types.
+     */
+    ContextRootCommon: "https://schema.twindev.org/common/"
+};
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -157,4 +166,4 @@ const ImmutableProofTopics = {
     ProofCreated: "immutable-proof:proof-created"
 };
 
-export { ImmutableProofDataTypes, ImmutableProofFailure, ImmutableProofTopics, ImmutableProofTypes };
+export { ImmutableProofContexts, ImmutableProofDataTypes, ImmutableProofFailure, ImmutableProofTopics, ImmutableProofTypes };

package/dist/types/index.d.ts

@@ -8,6 +8,7 @@ export * from "./models/eventBus/IImmutableProofEventBusProofCreated";
 export * from "./models/IImmutableProof";
 export * from "./models/IImmutableProofComponent";
 export * from "./models/IImmutableProofVerification";
+export * from "./models/immutableProofContexts";
 export * from "./models/immutableProofFailure";
 export * from "./models/immutableProofTopics";
 export * from "./models/immutableProofTypes";

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

@@ -1,5 +1,6 @@
 import type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import type { IDataIntegrityProof } from "@twin.org/standards-w3c-did";
+import type { ImmutableProofContexts } from "./immutableProofContexts";
 import type { ImmutableProofTypes } from "./immutableProofTypes";
 /**
  * Interface describing an immutable proof state.
@@ -9,8 +10,8 @@ export interface IImmutableProof {
      * JSON-LD Context.
      */
     "@context": [
-        typeof ImmutableProofTypes.ContextRoot,
-        typeof ImmutableProofTypes.ContextRootCommon,
+        typeof ImmutableProofContexts.ContextRoot,
+        typeof ImmutableProofContexts.ContextRootCommon,
         ...IJsonLdContextDefinitionElement[]
     ];
     /**

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

@@ -29,11 +29,11 @@ export interface IImmutableProofComponent extends IComponent {
      */
     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/IImmutableProofVerification.d.ts

@@ -1,3 +1,4 @@
+import type { ImmutableProofContexts } from "./immutableProofContexts";
 import type { ImmutableProofFailure } from "./immutableProofFailure";
 import type { ImmutableProofTypes } from "./immutableProofTypes";
 /**
@@ -7,7 +8,7 @@ export interface IImmutableProofVerification {
     /**
      * JSON-LD Context.
      */
-    "@context": typeof ImmutableProofTypes.ContextRoot;
+    "@context": typeof ImmutableProofContexts.ContextRoot;
     /**
      * JSON-LD Type.
      */

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

@@ -0,0 +1,17 @@
+/**
+ * The contexts of immutable proof data.
+ */
+export declare const ImmutableProofContexts: {
+    /**
+     * The context root for the immutable proof types.
+     */
+    readonly ContextRoot: "https://schema.twindev.org/immutable-proof/";
+    /**
+     * The context root for the common types.
+     */
+    readonly ContextRootCommon: "https://schema.twindev.org/common/";
+};
+/**
+ * The contexts of immutable proof data.
+ */
+export type ImmutableProofContexts = (typeof ImmutableProofContexts)[keyof typeof ImmutableProofContexts];

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

@@ -2,14 +2,6 @@
  * The types of immutable proof data.
  */
 export declare const ImmutableProofTypes: {
-    /**
-     * The context root for the immutable proof types.
-     */
-    readonly ContextRoot: "https://schema.twindev.org/immutable-proof/";
-    /**
-     * The context root for the common types.
-     */
-    readonly ContextRootCommon: "https://schema.twindev.org/common/";
     /**
      * Represents Immutable Proof.
      */

package/docs/changelog.md

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

package/docs/reference/index.md

@@ -18,12 +18,14 @@
 
 ## Type Aliases
 
+- [ImmutableProofContexts](type-aliases/ImmutableProofContexts.md)
 - [ImmutableProofFailure](type-aliases/ImmutableProofFailure.md)
 - [ImmutableProofTopics](type-aliases/ImmutableProofTopics.md)
 - [ImmutableProofTypes](type-aliases/ImmutableProofTypes.md)
 
 ## Variables
 
+- [ImmutableProofContexts](variables/ImmutableProofContexts.md)
 - [ImmutableProofFailure](variables/ImmutableProofFailure.md)
 - [ImmutableProofTopics](variables/ImmutableProofTopics.md)
 - [ImmutableProofTypes](variables/ImmutableProofTypes.md)

package/docs/reference/interfaces/IImmutableProofComponent.md

@@ -94,11 +94,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
 

package/docs/reference/type-aliases/ImmutableProofContexts.md

@@ -0,0 +1,5 @@
+# Type Alias: ImmutableProofContexts
+
+> **ImmutableProofContexts**: *typeof* [`ImmutableProofContexts`](../variables/ImmutableProofContexts.md)\[keyof *typeof* [`ImmutableProofContexts`](../variables/ImmutableProofContexts.md)\]
+
+The contexts of immutable proof data.

package/docs/reference/variables/ImmutableProofContexts.md

@@ -0,0 +1,19 @@
+# Variable: ImmutableProofContexts
+
+> `const` **ImmutableProofContexts**: `object`
+
+The contexts of immutable proof data.
+
+## Type declaration
+
+### ContextRoot
+
+> `readonly` **ContextRoot**: `"https://schema.twindev.org/immutable-proof/"` = `"https://schema.twindev.org/immutable-proof/"`
+
+The context root for the immutable proof types.
+
+### ContextRootCommon
+
+> `readonly` **ContextRootCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
+
+The context root for the common types.

package/docs/reference/variables/ImmutableProofTypes.md

@@ -6,18 +6,6 @@ The types of immutable proof data.
 
 ## Type declaration
 
-### ContextRoot
-
-> `readonly` **ContextRoot**: `"https://schema.twindev.org/immutable-proof/"` = `"https://schema.twindev.org/immutable-proof/"`
-
-The context root for the immutable proof types.
-
-### ContextRootCommon
-
-> `readonly` **ContextRootCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
-
-The context root for the common types.
-
 ### ImmutableProof
 
 > `readonly` **ImmutableProof**: `"ImmutableProof"` = `"ImmutableProof"`

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/immutable-proof-models",
-	"version": "0.0.1-next.26",
+	"version": "0.0.1-next.28",
 	"description": "Models which define the structure of the immutable proof connectors and services",
 	"repository": {
 		"type": "git",