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

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"
 										}
 									}
 								}
@@ -200,8 +200,6 @@
 											],
 											"type": "ImmutableProof",
 											"id": "ais:1234567890",
-											"nodeIdentity": "node-1",
-											"userIdentity": "user-1",
 											"proofObjectId": "test:1234567890",
 											"proofObjectHash": "EAOKyDN0mYQbBh91eMdVeroxQx1H4GfnRbmt6n/2L/Y=",
 											"proof": {
@@ -229,8 +227,6 @@
 											],
 											"type": "ImmutableProof",
 											"id": "ais:1234567890",
-											"nodeIdentity": "node-1",
-											"userIdentity": "user-1",
 											"proofObjectId": "test:1234567890",
 											"proofObjectHash": "EAOKyDN0mYQbBh91eMdVeroxQx1H4GfnRbmt6n/2L/Y=",
 											"proof": {
@@ -266,7 +262,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "GeneralError",
-											"message": "component.error",
+											"message": "errorMessage",
 											"properties": {
 												"foo": "bar"
 											}
@@ -287,7 +283,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "UnauthorizedError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}
@@ -305,7 +301,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "NotFoundError",
-											"message": "component.error",
+											"message": "errorMessage",
 											"properties": {
 												"notFoundId": "1"
 											}
@@ -326,7 +322,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "InternalServerError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}
@@ -409,7 +405,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "GeneralError",
-											"message": "component.error",
+											"message": "errorMessage",
 											"properties": {
 												"foo": "bar"
 											}
@@ -430,7 +426,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "UnauthorizedError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}
@@ -448,7 +444,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "NotFoundError",
-											"message": "component.error",
+											"message": "errorMessage",
 											"properties": {
 												"notFoundId": "1"
 											}
@@ -469,7 +465,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "InternalServerError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}
@@ -494,15 +490,15 @@
 							{
 								"type": "array",
 								"minItems": 1,
-								"items": {
-									"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
-								},
 								"prefixItems": [
 									{
 										"type": "string",
 										"const": "https://www.w3.org/ns/credentials/v2"
 									}
-								]
+								],
+								"items": {
+									"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+								}
 							}
 						],
 						"description": "JSON-LD Context."
@@ -554,12 +550,9 @@
 							},
 							{
 								"type": "array",
-								"items": false,
-								"prefixItems": [
-									{
-										"type": "string"
-									}
-								]
+								"items": {
+									"type": "string"
+								}
 							}
 						],
 						"description": "One or more security domains in which the proof is meant to be used."
@@ -571,12 +564,9 @@
 							},
 							{
 								"type": "array",
-								"items": false,
-								"prefixItems": [
-									{
-										"type": "string"
-									}
-								]
+								"items": {
+									"type": "string"
+								}
 							}
 						],
 						"description": "Provided to mitigate replay attacks on domains."

package/docs/reference/classes/ImmutableProof.md

@@ -22,22 +22,6 @@ The id of the proof.
 
 ***
 
-### nodeIdentity
-
-> **nodeIdentity**: `string`
-
-The identity of the node which controls the proof.
-
-***
-
-### userIdentity
-
-> **userIdentity**: `string`
-
-The identity of the user which created the proof.
-
-***
-
 ### dateCreated
 
 > **dateCreated**: `string`

package/docs/reference/classes/ImmutableProofService.md

@@ -30,41 +30,69 @@ The dependencies for the immutable proof connector.
 
 ### CLASS\_NAME
 
-> `readonly` **CLASS\_NAME**: `string`
+> `readonly` `static` **CLASS\_NAME**: `string`
 
 Runtime name for the class.
 
+## Methods
+
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
 #### Implementation of
 
-`IImmutableProofComponent.CLASS_NAME`
+`IImmutableProofComponent.className`
 
-## Methods
+***
 
-### create()
+### start()
 
-> **create**(`document`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`string`\>
+> **start**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
 
-Create a new proof.
+The component needs to be started when the node is initialized.
 
 #### Parameters
 
-##### document
+##### nodeLoggingComponentType?
 
-`IJsonLdNodeObject`
+`string`
 
-The document to create the proof for.
+The node logging component type.
 
-##### userIdentity?
+#### Returns
 
-`string`
+`Promise`\<`void`\>
 
-The identity to create the immutable proof operation with.
+Nothing.
 
-##### nodeIdentity?
+#### Implementation of
 
-`string`
+`IImmutableProofComponent.start`
 
-The node identity to use for vault operations.
+***
+
+### create()
+
+> **create**(`document`): `Promise`\<`string`\>
+
+Create a new proof.
+
+#### Parameters
+
+##### document
+
+`IJsonLdNodeObject`
+
+The document to create the proof for.
 
 #### Returns
 
@@ -140,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.
 
@@ -152,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/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/immutable-proof-service",
-	"version": "0.0.2-next.2",
+	"version": "0.0.3-next.1",
 	"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,30 +24,43 @@
 		"@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.2",
-		"@twin.org/immutable-proof-task": "0.0.2-next.2",
+		"@twin.org/immutable-proof-models": "0.0.3-next.1",
+		"@twin.org/immutable-proof-task": "0.0.3-next.1",
 		"@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"
-	]
+	],
+	"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"
 }