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

package/docs/reference/classes/ImmutableProof.md

@@ -22,19 +22,11 @@ The id of the proof.
 
 ***
 
-### nodeIdentity
+### organizationId
 
-> **nodeIdentity**: `string`
+> **organizationId**: `string`
 
-The identity of the node which controls the proof.
-
-***
-
-### userIdentity
-
-> **userIdentity**: `string`
-
-The identity of the user which created the proof.
+The organization id.
 
 ***
 
@@ -54,11 +46,11 @@ The associated id for the item.
 
 ***
 
-### proofObjectHash
+### proofObjectIntegrity
 
-> **proofObjectHash**: `string`
+> **proofObjectIntegrity**: `string`
 
-The associated hash for the item.
+The associated integrity for the item.
 
 ***
 
@@ -67,3 +59,11 @@ The associated hash for the item.
 > `optional` **verifiableStorageId**: `string`
 
 The verifiable storage id.
+
+***
+
+### vcContext?
+
+> `optional` **vcContext**: `"https://www.w3.org/2018/credentials/v1"` \| `"https://www.w3.org/ns/credentials/v2"`
+
+The verifiable credential context.

package/docs/reference/classes/ImmutableProofService.md

@@ -36,31 +36,63 @@ Runtime name for the class.
 
 ## Methods
 
-### create()
+### className()
 
-> **create**(`document`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`string`\>
+> **className**(): `string`
 
-Create a new proof.
+Returns the class name of the component.
 
-#### Parameters
+#### Returns
 
-##### document
+`string`
 
-`IJsonLdNodeObject`
+The class name of the component.
 
-The document to create the proof for.
+#### Implementation of
 
-##### userIdentity?
+`IImmutableProofComponent.className`
 
-`string`
+***
 
-The identity to create the immutable proof operation with.
+### start()
 
-##### nodeIdentity?
+> **start**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
+
+The component needs to be started when the node is initialized.
+
+#### Parameters
+
+##### nodeLoggingComponentType?
 
 `string`
 
-The node identity to use for vault operations.
+The node logging component type.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IImmutableProofComponent.start`
+
+***
+
+### create()
+
+> **create**(`document`): `Promise`\<`string`\>
+
+Create a new proof.
+
+#### Parameters
+
+##### document
+
+`IJsonLdNodeObject`
+
+The document to create the proof for.
 
 #### Returns
 
@@ -76,7 +108,7 @@ The id of the new proof.
 
 ### get()
 
-> **get**(`id`): `Promise`\<`IImmutableProof`\>
+> **get**(`id`): `Promise`\<`IDidVerifiableCredential`\>
 
 Get a proof.
 
@@ -90,7 +122,7 @@ The id of the proof to get.
 
 #### Returns
 
-`Promise`\<`IImmutableProof`\>
+`Promise`\<`IDidVerifiableCredential`\>
 
 The proof.
 
@@ -136,7 +168,7 @@ NotFoundError if the proof is not found.
 
 ### removeVerifiable()
 
-> **removeVerifiable**(`id`, `nodeIdentity?`): `Promise`\<`void`\>
+> **removeVerifiable**(`id`): `Promise`\<`void`\>
 
 Remove the verifiable storage for the proof.
 
@@ -148,12 +180,6 @@ Remove the verifiable storage for the proof.
 
 The id of the proof to remove the storage from.
 
-##### nodeIdentity?
-
-`string`
-
-The node identity to use for vault operations.
-
 #### Returns
 
 `Promise`\<`void`\>

package/docs/reference/interfaces/IImmutableProofServiceConstructorOptions.md

@@ -32,6 +32,20 @@ verifiable-storage
 
 ***
 
+### loggingComponentType?
+
+> `optional` **loggingComponentType**: `string`
+
+The logging component type.
+
+#### Default
+
+```ts
+logging
+```
+
+***
+
 ### identityConnectorType?
 
 > `optional` **identityConnectorType**: `string`
@@ -46,11 +60,11 @@ identity
 
 ***
 
-### backgroundTaskConnectorType?
+### backgroundTaskComponentType?
 
-> `optional` **backgroundTaskConnectorType**: `string`
+> `optional` **backgroundTaskComponentType**: `string`
 
-The background task connector type.
+The background task component type.
 
 #### Default
 

package/locales/en.json

@@ -6,7 +6,13 @@
 			"getFailed": "Getting the proof failed",
 			"verifyFailed": "Verifying the proof failed",
 			"removeVerifiableFailed": "Removing verifiable entry from the Immutable Proof failed",
-			"proofNotFound": "The proof with the Id \"{notFoundId}\" was not found"
+			"proofNotFound": "The proof with the Id \"{notFoundId}\" was not found",
+			"createProofFailed": "Creating the immutable proof failed"
+		}
+	},
+	"info": {
+		"immutableProofService": {
+			"createdProof": "The immutable proof with Id \"{proofId}\" has been created successfully"
 		}
 	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/immutable-proof-service",
-	"version": "0.0.2-next.3",
+	"version": "0.0.3-next.10",
 	"description": "Immutable proof contract implementation and REST endpoint definitions",
 	"repository": {
 		"type": "git",
@@ -16,6 +16,7 @@
 	"dependencies": {
 		"@twin.org/api-models": "next",
 		"@twin.org/background-task-models": "next",
+		"@twin.org/context": "next",
 		"@twin.org/core": "next",
 		"@twin.org/crypto": "next",
 		"@twin.org/data-json-ld": "next",
@@ -23,28 +24,27 @@
 		"@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.3",
-		"@twin.org/immutable-proof-task": "0.0.2-next.3",
+		"@twin.org/immutable-proof-models": "0.0.3-next.10",
+		"@twin.org/immutable-proof-task": "0.0.3-next.10",
+		"@twin.org/logging-models": "next",
 		"@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"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/types",
 		"locales",
 		"docs"