@twin.org/immutable-proof-models 0.0.1-next.25 → 0.0.1-next.27

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.
      */
@@ -56,6 +48,10 @@ var properties = {
 		type: "string",
 		description: "The id of the proof."
 	},
+	nodeIdentity: {
+		type: "string",
+		description: "The id of the node who created the proof."
+	},
 	userIdentity: {
 		type: "string",
 		description: "The id of the user who created the proof."
@@ -69,7 +65,7 @@ var properties = {
 		description: "The hash of the object associated with the proof."
 	},
 	proof: {
-		$ref: "https://schema.twindev.org/did/DidProof",
+		$ref: "https://schema.twindev.org/did/DataIntegrityProof",
 		description: "The proof which can be undefined if it has not yet been issued."
 	},
 	immutableReceipt: {
@@ -81,6 +77,7 @@ var required = [
 	"@context",
 	"type",
 	"id",
+	"nodeIdentity",
 	"userIdentity",
 	"proofObjectHash"
 ];
@@ -112,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.
 /**
@@ -120,7 +134,7 @@ class ImmutableProofDataTypes {
 // eslint-disable-next-line @typescript-eslint/naming-convention
 const ImmutableProofFailure = {
     /**
-     * Proof not yes issued.
+     * Proof not yet issued.
      */
     NotIssued: "notIssued",
     /**
@@ -154,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.
      */
@@ -54,6 +46,10 @@ var properties = {
 		type: "string",
 		description: "The id of the proof."
 	},
+	nodeIdentity: {
+		type: "string",
+		description: "The id of the node who created the proof."
+	},
 	userIdentity: {
 		type: "string",
 		description: "The id of the user who created the proof."
@@ -67,7 +63,7 @@ var properties = {
 		description: "The hash of the object associated with the proof."
 	},
 	proof: {
-		$ref: "https://schema.twindev.org/did/DidProof",
+		$ref: "https://schema.twindev.org/did/DataIntegrityProof",
 		description: "The proof which can be undefined if it has not yet been issued."
 	},
 	immutableReceipt: {
@@ -79,6 +75,7 @@ var required = [
 	"@context",
 	"type",
 	"id",
+	"nodeIdentity",
 	"userIdentity",
 	"proofObjectHash"
 ];
@@ -110,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.
 /**
@@ -118,7 +132,7 @@ class ImmutableProofDataTypes {
 // eslint-disable-next-line @typescript-eslint/naming-convention
 const ImmutableProofFailure = {
     /**
-     * Proof not yes issued.
+     * Proof not yet issued.
      */
     NotIssued: "notIssued",
     /**
@@ -152,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 { IDidProof } from "@twin.org/standards-w3c-did";
+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[]
     ];
     /**
@@ -21,6 +22,10 @@ export interface IImmutableProof {
      * The id of the proof.
      */
     id: string;
+    /**
+     * The id of the node who created the proof.
+     */
+    nodeIdentity: string;
     /**
      * The id of the user who created the proof.
      */
@@ -36,7 +41,7 @@ export interface IImmutableProof {
     /**
      * The proof which can be undefined if it has not yet been issued.
      */
-    proof?: IDidProof;
+    proof?: IDataIntegrityProof;
     /**
      * The immutable receipt detail for where the proof is stored.
      */

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

@@ -7,22 +7,22 @@ import type { IImmutableProofVerification } from "./IImmutableProofVerification"
  */
 export interface IImmutableProofComponent extends IComponent {
     /**
-     * Create a new authentication proof.
-     * @param proofObject The object for the proof as JSON-LD.
+     * Create a new proof.
+     * @param document The document to create the proof for.
      * @param userIdentity The identity to create the immutable proof operation with.
      * @param nodeIdentity The node identity to use for vault operations.
-     * @returns The id of the new authentication proof.
+     * @returns The id of the new proof.
      */
-    create(proofObject: IJsonLdNodeObject, userIdentity?: string, nodeIdentity?: string): Promise<string>;
+    create(document: IJsonLdNodeObject, userIdentity?: string, nodeIdentity?: string): Promise<string>;
     /**
-     * Get an authentication proof.
+     * Get a proof.
      * @param id The id of the proof to get.
      * @returns The proof.
      * @throws NotFoundError if the proof is not found.
      */
     get(id: string): Promise<IImmutableProof>;
     /**
-     * Verify an authentication proof.
+     * Verify a proof.
      * @param id The id of the proof to verify.
      * @returns The result of the verification and any failures.
      * @throws NotFoundError if the proof is not found.

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/api/IImmutableProofCreateRequest.d.ts

@@ -8,8 +8,8 @@ export interface IImmutableProofCreateRequest {
      */
     body: {
         /**
-         * The proof object to create the proof for.
+         * The document to create the proof for.
          */
-        proofObject: IJsonLdNodeObject;
+        document: IJsonLdNodeObject;
     };
 }

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/immutableProofFailure.d.ts

@@ -3,7 +3,7 @@
  */
 export declare const ImmutableProofFailure: {
     /**
-     * Proof not yes issued.
+     * Proof not yet issued.
      */
     readonly NotIssued: "notIssued";
     /**

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.25
+## v0.0.1-next.27
 
 - 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/IImmutableProof.md

@@ -28,6 +28,14 @@ The id of the proof.
 
 ***
 
+### nodeIdentity
+
+> **nodeIdentity**: `string`
+
+The id of the node who created the proof.
+
+***
+
 ### userIdentity
 
 > **userIdentity**: `string`
@@ -54,7 +62,7 @@ The hash of the object associated with the proof.
 
 ### proof?
 
-> `optional` **proof**: `IDidProof`
+> `optional` **proof**: `IDataIntegrityProof`
 
 The proof which can be undefined if it has not yet been issued.
 

package/docs/reference/interfaces/IImmutableProofComponent.md

@@ -10,17 +10,17 @@ Interface describing an immutable proof contract.
 
 ### create()
 
-> **create**(`proofObject`, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
+> **create**(`document`, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
 
-Create a new authentication proof.
+Create a new proof.
 
 #### Parameters
 
-##### proofObject
+##### document
 
 `IJsonLdNodeObject`
 
-The object for the proof as JSON-LD.
+The document to create the proof for.
 
 ##### userIdentity?
 
@@ -38,7 +38,7 @@ The node identity to use for vault operations.
 
 `Promise`\<`string`\>
 
-The id of the new authentication proof.
+The id of the new proof.
 
 ***
 
@@ -46,7 +46,7 @@ The id of the new authentication proof.
 
 > **get**(`id`): `Promise`\<[`IImmutableProof`](IImmutableProof.md)\>
 
-Get an authentication proof.
+Get a proof.
 
 #### Parameters
 
@@ -72,7 +72,7 @@ NotFoundError if the proof is not found.
 
 > **verify**(`id`): `Promise`\<[`IImmutableProofVerification`](IImmutableProofVerification.md)\>
 
-Verify an authentication proof.
+Verify a proof.
 
 #### Parameters
 

package/docs/reference/interfaces/IImmutableProofCreateRequest.md

@@ -10,8 +10,8 @@ Create a proof.
 
 The parameters from the body.
 
-#### proofObject
+#### document
 
-> **proofObject**: `IJsonLdNodeObject`
+> **document**: `IJsonLdNodeObject`
 
-The proof object to create the proof for.
+The document to create the proof for.

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/ImmutableProofFailure.md

@@ -10,7 +10,7 @@ The failure reason of the proof.
 
 > `readonly` **NotIssued**: `"notIssued"` = `"notIssued"`
 
-Proof not yes issued.
+Proof not yet issued.
 
 ### ProofMissing
 

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.25",
+	"version": "0.0.1-next.27",
 	"description": "Models which define the structure of the immutable proof connectors and services",
 	"repository": {
 		"type": "git",