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

package/docs/open-api/spec.json

@@ -63,7 +63,7 @@
 								"schema": {
 									"type": "string"
 								},
-								"description": "e.g. test:1234567890"
+								"description": "e.g. test%3A1234567890"
 							}
 						}
 					},
@@ -165,7 +165,7 @@
 							"type": "string"
 						},
 						"style": "simple",
-						"example": "ais:1234567890"
+						"example": "immutable-proof:1234567890"
 					},
 					{
 						"name": "accept",
@@ -189,26 +189,37 @@
 						"content": {
 							"application/json": {
 								"schema": {
-									"$ref": "https://schema.twindev.org/immutable-proof/ImmutableProof"
+									"$ref": "https://schema.twindev.org/w3c-did/DidVerifiableCredential"
 								},
 								"examples": {
 									"immutableProofGetResponseExample": {
 										"value": {
 											"@context": [
+												"https://www.w3.org/2018/credentials/v1",
 												"https://schema.twindev.org/immutable-proof/",
 												"https://schema.twindev.org/common/"
 											],
-											"type": "ImmutableProof",
-											"id": "ais:1234567890",
-											"proofObjectId": "test:1234567890",
-											"proofObjectHash": "EAOKyDN0mYQbBh91eMdVeroxQx1H4GfnRbmt6n/2L/Y=",
+											"type": [
+												"VerifiableCredential",
+												"ImmutableProof"
+											],
+											"id": "immutable-proof:1234567890",
+											"credentialSubject": {
+												"id": "ais:1234567890",
+												"proofIntegrity": "EAOKyDN0mYQbBh91eMdVeroxQx1H4GfnRbmt6n/2L/Y="
+											},
 											"proof": {
-												"@context": "https://www.w3.org/ns/credentials/v2",
 												"type": "DataIntegrityProof",
 												"cryptosuite": "eddsa-jcs-2022",
 												"created": "2024-08-22T11:56:56.272Z",
 												"proofPurpose": "assertionMethod",
-												"proofValue": "7DdiPPYtxLjCD3wA1po2rv..."
+												"proofValue": "7DdiPPYtxLjCD3wA1po2rv...",
+												"verificationMethod": "did:iota:testnet:0xcb07cabaa2f23b7e53d8cdc4228efb351ebb270554d13bc382e4f94ca8d3136b#immutable-proof-assertion",
+												"verifiableStorageId": "verifiable-storage:1234567890",
+												"immutableReceipt": {
+													"id": "immutable-receipt:1234567890",
+													"type": "ImmutableReceipt"
+												}
 											}
 										}
 									}
@@ -216,26 +227,37 @@
 							},
 							"application/ld+json": {
 								"schema": {
-									"$ref": "https://schema.twindev.org/immutable-proof/ImmutableProof"
+									"$ref": "https://schema.twindev.org/w3c-did/DidVerifiableCredential"
 								},
 								"examples": {
 									"immutableProofJsonLdGetResponseExample": {
 										"value": {
 											"@context": [
+												"https://www.w3.org/2018/credentials/v1",
 												"https://schema.twindev.org/immutable-proof/",
 												"https://schema.twindev.org/common/"
 											],
-											"type": "ImmutableProof",
-											"id": "ais:1234567890",
-											"proofObjectId": "test:1234567890",
-											"proofObjectHash": "EAOKyDN0mYQbBh91eMdVeroxQx1H4GfnRbmt6n/2L/Y=",
+											"type": [
+												"VerifiableCredential",
+												"ImmutableProof"
+											],
+											"id": "immutable-proof:1234567890",
+											"credentialSubject": {
+												"id": "ais:1234567890",
+												"proofIntegrity": "EAOKyDN0mYQbBh91eMdVeroxQx1H4GfnRbmt6n/2L/Y="
+											},
 											"proof": {
-												"@context": "https://www.w3.org/ns/credentials/v2",
 												"type": "DataIntegrityProof",
 												"cryptosuite": "eddsa-jcs-2022",
 												"created": "2024-08-22T11:56:56.272Z",
 												"proofPurpose": "assertionMethod",
-												"proofValue": "7DdiPPYtxLjCD3wA1po2rv..."
+												"proofValue": "7DdiPPYtxLjCD3wA1po2rv...",
+												"verificationMethod": "did:iota:testnet:0xcb07cabaa2f23b7e53d8cdc4228efb351ebb270554d13bc382e4f94ca8d3136b#immutable-proof-assertion",
+												"verifiableStorageId": "verifiable-storage:1234567890",
+												"immutableReceipt": {
+													"id": "immutable-receipt:1234567890",
+													"type": "ImmutableReceipt"
+												}
 											}
 										}
 									}
@@ -349,7 +371,7 @@
 							"type": "string"
 						},
 						"style": "simple",
-						"example": "ais:1234567890"
+						"example": "immutable-proof:1234567890"
 					},
 					{
 						"name": "accept",
@@ -387,7 +409,7 @@
 											"@context": "https://schema.twindev.org/immutable-proof/",
 											"type": "ImmutableProofVerification",
 											"verified": false,
-											"failure": "proofTypeMismatch"
+											"failure": "verificationFailure"
 										}
 									}
 								}
@@ -478,132 +500,8 @@
 	},
 	"components": {
 		"schemas": {
-			"DataIntegrityProof": {
-				"type": "object",
-				"properties": {
-					"@context": {
-						"anyOf": [
-							{
-								"type": "string",
-								"const": "https://www.w3.org/ns/credentials/v2"
-							},
-							{
-								"type": "array",
-								"minItems": 1,
-								"prefixItems": [
-									{
-										"type": "string",
-										"const": "https://www.w3.org/ns/credentials/v2"
-									}
-								],
-								"items": {
-									"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
-								}
-							}
-						],
-						"description": "JSON-LD Context."
-					},
-					"type": {
-						"type": "string",
-						"const": "DataIntegrityProof",
-						"description": "JSON-LD Type."
-					},
-					"cryptosuite": {
-						"anyOf": [
-							{
-								"$ref": "#/components/schemas/DidCryptoSuites"
-							},
-							{
-								"type": "string"
-							}
-						],
-						"description": "An identifier for the cryptographic suite that can be used to verify the proof."
-					},
-					"id": {
-						"type": "string",
-						"description": "The id of the proof."
-					},
-					"proofPurpose": {
-						"type": "string",
-						"description": "The reason the proof was created."
-					},
-					"proofValue": {
-						"type": "string",
-						"description": "Contains the base-encoded binary data necessary to verify the digital proof using the verificationMethod specified."
-					},
-					"verificationMethod": {
-						"type": "string",
-						"description": "The verification method of the proof."
-					},
-					"created": {
-						"type": "string",
-						"description": "The iso date of when the proof was created."
-					},
-					"expires": {
-						"type": "string",
-						"description": "The iso date of when the proof expires."
-					},
-					"domain": {
-						"anyOf": [
-							{
-								"type": "string"
-							},
-							{
-								"type": "array",
-								"items": {
-									"type": "string"
-								}
-							}
-						],
-						"description": "One or more security domains in which the proof is meant to be used."
-					},
-					"challenge": {
-						"anyOf": [
-							{
-								"type": "string"
-							},
-							{
-								"type": "array",
-								"items": {
-									"type": "string"
-								}
-							}
-						],
-						"description": "Provided to mitigate replay attacks on domains."
-					},
-					"previousProof": {
-						"type": "string",
-						"description": "Identifies another data integrity proof that MUST verify before the current proof is processed"
-					},
-					"nonce": {
-						"type": "string",
-						"description": "Use of this field is to increase privacy by decreasing linkability that is the result of deterministically generated signatures."
-					}
-				},
-				"required": [
-					"type",
-					"cryptosuite",
-					"proofPurpose"
-				],
-				"additionalProperties": false,
-				"description": "Interface describing a did proof. https://www.w3.org/TR/vc-data-integrity/"
-			},
-			"DidCryptoSuites": {
-				"anyOf": [
-					{
-						"type": "string",
-						"const": "eddsa-jcs-2022",
-						"description": "The type for EdDSA crypto suite for JSON Canonicalization Scheme [RFC8785]. https://www.w3.org/TR/vc-di-eddsa/#eddsa-jcs-2022"
-					},
-					{
-						"type": "string",
-						"const": "eddsa-rdfc-2022",
-						"description": "The type for EdDSA crypto suite for RDF Dataset Canonicalization. https://www.w3.org/TR/vc-di-eddsa/#eddsa-rdfc-2022"
-					}
-				],
-				"description": "The types for DID Proof crypto suites."
-			},
 			"Error": {
+				"description": "Model to describe serialized error.",
 				"type": "object",
 				"properties": {
 					"name": {
@@ -634,9 +532,7 @@
 				"required": [
 					"name",
 					"message"
-				],
-				"additionalProperties": false,
-				"description": "Model to describe serialized error."
+				]
 			},
 			"ImmutableProofCreateRequest": {
 				"type": "object",
@@ -648,45 +544,20 @@
 				"required": [
 					"document"
 				],
-				"additionalProperties": false,
 				"description": "The parameters from the body."
 			},
 			"NotFoundResponse": {
 				"type": "object",
-				"additionalProperties": false,
 				"properties": {
 					"notFoundId": {
 						"type": "string",
 						"description": "The id if the item that was not found."
-					},
-					"name": {
-						"type": "string",
-						"description": "The name for the error."
-					},
-					"message": {
-						"type": "string",
-						"description": "The message for the error."
-					},
-					"source": {
-						"type": "string",
-						"description": "The source of the error."
-					},
-					"properties": {
-						"type": "object",
-						"additionalProperties": {},
-						"description": "Any additional information for the error."
-					},
-					"stack": {
-						"type": "string",
-						"description": "The stack trace for the error."
-					},
-					"cause": {
-						"$ref": "#/components/schemas/Error"
 					}
 				},
-				"required": [
-					"message",
-					"name"
+				"allOf": [
+					{
+						"$ref": "#/components/schemas/Error"
+					}
 				],
 				"description": "The body which contains the error."
 			}

package/docs/reference/classes/ImmutableProof.md

@@ -14,7 +14,7 @@ Class describing the immutable proof.
 
 ## Properties
 
-### id
+### id {#id}
 
 > **id**: `string`
 
@@ -22,7 +22,15 @@ The id of the proof.
 
 ***
 
-### dateCreated
+### organizationId {#organizationid}
+
+> **organizationId**: `string`
+
+The organization id.
+
+***
+
+### dateCreated {#datecreated}
 
 > **dateCreated**: `string`
 
@@ -30,24 +38,32 @@ The date/time of when the proof was created.
 
 ***
 
-### proofObjectId?
+### proofObjectId? {#proofobjectid}
 
-> `optional` **proofObjectId**: `string`
+> `optional` **proofObjectId?**: `string`
 
 The associated id for the item.
 
 ***
 
-### proofObjectHash
+### proofObjectIntegrity {#proofobjectintegrity}
 
-> **proofObjectHash**: `string`
+> **proofObjectIntegrity**: `string`
 
-The associated hash for the item.
+The associated integrity for the item.
 
 ***
 
-### verifiableStorageId?
+### verifiableStorageId? {#verifiablestorageid}
 
-> `optional` **verifiableStorageId**: `string`
+> `optional` **verifiableStorageId?**: `string`
 
 The verifiable storage id.
+
+***
+
+### vcContext? {#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

@@ -28,7 +28,7 @@ The dependencies for the immutable proof connector.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -36,7 +36,7 @@ Runtime name for the class.
 
 ## Methods
 
-### className()
+### className() {#classname}
 
 > **className**(): `string`
 
@@ -54,7 +54,7 @@ The class name of the component.
 
 ***
 
-### start()
+### start() {#start}
 
 > **start**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
 
@@ -80,7 +80,7 @@ Nothing.
 
 ***
 
-### create()
+### create() {#create}
 
 > **create**(`document`): `Promise`\<`string`\>
 
@@ -106,9 +106,9 @@ The id of the new proof.
 
 ***
 
-### get()
+### get() {#get}
 
-> **get**(`id`): `Promise`\<`IImmutableProof`\>
+> **get**(`id`): `Promise`\<`IDidVerifiableCredential`\>
 
 Get a proof.
 
@@ -122,7 +122,7 @@ The id of the proof to get.
 
 #### Returns
 
-`Promise`\<`IImmutableProof`\>
+`Promise`\<`IDidVerifiableCredential`\>
 
 The proof.
 
@@ -136,7 +136,7 @@ NotFoundError if the proof is not found.
 
 ***
 
-### verify()
+### verify() {#verify}
 
 > **verify**(`id`): `Promise`\<`IImmutableProofVerification`\>
 
@@ -166,7 +166,7 @@ NotFoundError if the proof is not found.
 
 ***
 
-### removeVerifiable()
+### removeVerifiable() {#removeverifiable}
 
 > **removeVerifiable**(`id`): `Promise`\<`void`\>
 

package/docs/reference/interfaces/IImmutableProofServiceConfig.md

@@ -4,9 +4,9 @@ Configuration for the immutable proof service.
 
 ## Properties
 
-### verificationMethodId?
+### verificationMethodId? {#verificationmethodid}
 
-> `optional` **verificationMethodId**: `string`
+> `optional` **verificationMethodId?**: `string`
 
 The verification method id to use for the proof.
 

package/docs/reference/interfaces/IImmutableProofServiceConstructorOptions.md

@@ -4,9 +4,9 @@ Options for the immutable proof service constructor.
 
 ## Properties
 
-### immutableProofEntityStorageType?
+### immutableProofEntityStorageType? {#immutableproofentitystoragetype}
 
-> `optional` **immutableProofEntityStorageType**: `string`
+> `optional` **immutableProofEntityStorageType?**: `string`
 
 The entity storage for proofs.
 
@@ -18,9 +18,9 @@ immutable-proof
 
 ***
 
-### verifiableStorageType?
+### verifiableStorageType? {#verifiablestoragetype}
 
-> `optional` **verifiableStorageType**: `string`
+> `optional` **verifiableStorageType?**: `string`
 
 The verifiable storage.
 
@@ -32,9 +32,23 @@ verifiable-storage
 
 ***
 
-### identityConnectorType?
+### loggingComponentType? {#loggingcomponenttype}
 
-> `optional` **identityConnectorType**: `string`
+> `optional` **loggingComponentType?**: `string`
+
+The logging component type.
+
+#### Default
+
+```ts
+logging
+```
+
+***
+
+### identityConnectorType? {#identityconnectortype}
+
+> `optional` **identityConnectorType?**: `string`
 
 The identity connector type.
 
@@ -46,11 +60,11 @@ identity
 
 ***
 
-### backgroundTaskConnectorType?
+### backgroundTaskComponentType? {#backgroundtaskcomponenttype}
 
-> `optional` **backgroundTaskConnectorType**: `string`
+> `optional` **backgroundTaskComponentType?**: `string`
 
-The background task connector type.
+The background task component type.
 
 #### Default
 
@@ -60,16 +74,16 @@ background-task
 
 ***
 
-### eventBusComponentType?
+### eventBusComponentType? {#eventbuscomponenttype}
 
-> `optional` **eventBusComponentType**: `string`
+> `optional` **eventBusComponentType?**: `string`
 
 The event bus component type, defaults to no event bus.
 
 ***
 
-### config?
+### config? {#config}
 
-> `optional` **config**: [`IImmutableProofServiceConfig`](IImmutableProofServiceConfig.md)
+> `optional` **config?**: [`IImmutableProofServiceConfig`](IImmutableProofServiceConfig.md)
 
 The configuration for the connector.

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,7 +1,7 @@
 {
 	"name": "@twin.org/immutable-proof-service",
-	"version": "0.0.3-next.1",
-	"description": "Immutable proof contract implementation and REST endpoint definitions",
+	"version": "0.0.3-next.11",
+	"description": "Core proof lifecycle service with route helpers for create, get, and verify operations",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/twinfoundation/immutable-proof.git",
@@ -24,8 +24,9 @@
 		"@twin.org/entity-storage-models": "next",
 		"@twin.org/event-bus-models": "next",
 		"@twin.org/identity-models": "next",
-		"@twin.org/immutable-proof-models": "0.0.3-next.1",
-		"@twin.org/immutable-proof-task": "0.0.3-next.1",
+		"@twin.org/immutable-proof-models": "0.0.3-next.11",
+		"@twin.org/immutable-proof-task": "0.0.3-next.11",
+		"@twin.org/logging-models": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/standards-w3c-did": "next",
 		"@twin.org/vault-models": "next",