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

package/docs/reference/classes/ImmutableProof.md

@@ -14,7 +14,7 @@ Class describing the immutable proof.
 
 ## Properties
 
-### id
+### id {#id}
 
 > **id**: `string`
 
@@ -22,7 +22,7 @@ The id of the proof.
 
 ***
 
-### organizationId
+### organizationId {#organizationid}
 
 > **organizationId**: `string`
 
@@ -30,7 +30,7 @@ The organization id.
 
 ***
 
-### dateCreated
+### dateCreated {#datecreated}
 
 > **dateCreated**: `string`
 
@@ -38,15 +38,15 @@ The date/time of when the proof was created.
 
 ***
 
-### proofObjectId?
+### proofObjectId? {#proofobjectid}
 
-> `optional` **proofObjectId**: `string`
+> `optional` **proofObjectId?**: `string`
 
 The associated id for the item.
 
 ***
 
-### proofObjectIntegrity
+### proofObjectIntegrity {#proofobjectintegrity}
 
 > **proofObjectIntegrity**: `string`
 
@@ -54,16 +54,16 @@ The associated integrity for the item.
 
 ***
 
-### verifiableStorageId?
+### notarizationId? {#notarizationid}
 
-> `optional` **verifiableStorageId**: `string`
+> `optional` **notarizationId?**: `string`
 
-The verifiable storage id.
+The notarization id.
 
 ***
 
-### vcContext?
+### vcContext? {#vccontext}
 
-> `optional` **vcContext**: `"https://www.w3.org/2018/credentials/v1"` \| `"https://www.w3.org/ns/credentials/v2"`
+> `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

@@ -12,7 +12,7 @@ Class for performing immutable proof operations.
 
 > **new ImmutableProofService**(`options?`): `ImmutableProofService`
 
-Create a new instance of ImmutableProofService.
+Creates an instance of ImmutableProofService.
 
 #### Parameters
 
@@ -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`\>
 
@@ -72,7 +72,7 @@ The node logging component type.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the background task handler has been registered.
 
 #### Implementation of
 
@@ -80,9 +80,9 @@ Nothing.
 
 ***
 
-### create()
+### create() {#create}
 
-> **create**(`document`): `Promise`\<`string`\>
+> **create**(`document`, `options?`): `Promise`\<`string`\>
 
 Create a new proof.
 
@@ -94,6 +94,16 @@ Create a new proof.
 
 The document to create the proof for.
 
+##### options?
+
+Optional settings for the proof.
+
+###### deleteLock?
+
+`string`
+
+An ISO 8601 date-time string specifying when the notarization lock expires; if omitted no lock is applied.
+
 #### Returns
 
 `Promise`\<`string`\>
@@ -106,9 +116,9 @@ The id of the new proof.
 
 ***
 
-### get()
+### get() {#get}
 
-> **get**(`id`): `Promise`\<`IDidVerifiableCredential`\>
+> **get**(`id`): `Promise`\<`IImmutableProofCredential`\>
 
 Get a proof.
 
@@ -122,7 +132,7 @@ The id of the proof to get.
 
 #### Returns
 
-`Promise`\<`IDidVerifiableCredential`\>
+`Promise`\<`IImmutableProofCredential`\>
 
 The proof.
 
@@ -136,7 +146,7 @@ NotFoundError if the proof is not found.
 
 ***
 
-### verify()
+### verify() {#verify}
 
 > **verify**(`id`): `Promise`\<`IImmutableProofVerification`\>
 
@@ -166,11 +176,41 @@ NotFoundError if the proof is not found.
 
 ***
 
-### removeVerifiable()
+### remove() {#remove}
+
+> **remove**(`id`): `Promise`\<`void`\>
+
+Remove the proof and its notarization.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the proof to remove.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the proof and its notarization have been removed.
+
+#### Throws
+
+NotFoundError if the proof is not found.
+
+#### Implementation of
+
+`IImmutableProofComponent.remove`
+
+***
+
+### removeNotarization() {#removenotarization}
 
-> **removeVerifiable**(`id`): `Promise`\<`void`\>
+> **removeNotarization**(`id`): `Promise`\<`void`\>
 
-Remove the verifiable storage for the proof.
+Remove only the notarization for the proof, keeping the proof entity.
 
 #### Parameters
 
@@ -178,13 +218,13 @@ Remove the verifiable storage for the proof.
 
 `string`
 
-The id of the proof to remove the storage from.
+The id of the proof to remove the notarization from.
 
 #### Returns
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the notarization has been removed.
 
 #### Throws
 
@@ -192,4 +232,4 @@ NotFoundError if the proof is not found.
 
 #### Implementation of
 
-`IImmutableProofComponent.removeVerifiable`
+`IImmutableProofComponent.removeNotarization`

package/docs/reference/functions/immutableProofGet.md

@@ -2,7 +2,7 @@
 
 > **immutableProofGet**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IImmutableProofGetResponse`\>
 
-Get the proof.
+Get a proof.
 
 ## Parameters
 

package/docs/reference/functions/immutableProofRemove.md

@@ -0,0 +1,31 @@
+# Function: immutableProofRemove()
+
+> **immutableProofRemove**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Remove the proof and its notarization.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`IImmutableProofRemoveRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/immutableProofRemoveNotarization.md

@@ -0,0 +1,31 @@
+# Function: immutableProofRemoveNotarization()
+
+> **immutableProofRemoveNotarization**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Remove the notarization for a proof, keeping the proof entity.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`IImmutableProofRemoveNotarizationRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/immutableProofVerify.md

@@ -2,7 +2,7 @@
 
 > **immutableProofVerify**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IImmutableProofVerifyResponse`\>
 
-Verify the proof.
+Verify a proof.
 
 ## Parameters
 

package/docs/reference/index.md

@@ -21,4 +21,6 @@
 - [immutableProofCreate](functions/immutableProofCreate.md)
 - [immutableProofGet](functions/immutableProofGet.md)
 - [immutableProofVerify](functions/immutableProofVerify.md)
+- [immutableProofRemove](functions/immutableProofRemove.md)
+- [immutableProofRemoveNotarization](functions/immutableProofRemoveNotarization.md)
 - [initSchema](functions/initSchema.md)

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,37 +18,31 @@ immutable-proof
 
 ***
 
-### verifiableStorageType?
+### notarizationConnectorType? {#notarizationconnectortype}
 
-> `optional` **verifiableStorageType**: `string`
+> `optional` **notarizationConnectorType?**: `string`
 
-The verifiable storage.
+The notarization connector type.
 
 #### Default
 
 ```ts
-verifiable-storage
+notarization
 ```
 
 ***
 
-### loggingComponentType?
+### loggingComponentType? {#loggingcomponenttype}
 
-> `optional` **loggingComponentType**: `string`
+> `optional` **loggingComponentType?**: `string`
 
 The logging component type.
 
-#### Default
-
-```ts
-logging
-```
-
 ***
 
-### identityConnectorType?
+### identityConnectorType? {#identityconnectortype}
 
-> `optional` **identityConnectorType**: `string`
+> `optional` **identityConnectorType?**: `string`
 
 The identity connector type.
 
@@ -60,9 +54,9 @@ identity
 
 ***
 
-### backgroundTaskComponentType?
+### backgroundTaskComponentType? {#backgroundtaskcomponenttype}
 
-> `optional` **backgroundTaskComponentType**: `string`
+> `optional` **backgroundTaskComponentType?**: `string`
 
 The background task component type.
 
@@ -74,16 +68,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/docs/reference/variables/restEntryPoints.md

@@ -1,3 +1,5 @@
 # Variable: restEntryPoints
 
 > `const` **restEntryPoints**: `IRestRouteEntryPoint`[]
+
+The REST entry points for the immutable proof service.

package/locales/en.json

@@ -5,7 +5,8 @@
 			"createFailed": "Creating the proof failed",
 			"getFailed": "Getting the proof failed",
 			"verifyFailed": "Verifying the proof failed",
-			"removeVerifiableFailed": "Removing verifiable entry from the Immutable Proof failed",
+			"removeFailed": "Removing the Immutable Proof failed",
+			"removeNotarizationFailed": "Removing notarization entry from the Immutable Proof failed",
 			"proofNotFound": "The proof with the Id \"{notFoundId}\" was not found",
 			"createProofFailed": "Creating the immutable proof failed"
 		}

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/immutable-proof-service",
-	"version": "0.0.3-next.8",
-	"description": "Immutable proof contract implementation and REST endpoint definitions",
+	"version": "0.9.0-next.1",
+	"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",
+		"url": "git+https://github.com/iotaledger/twin-immutable-proof.git",
 		"directory": "packages/immutable-proof-service"
 	},
 	"author": "martyn.janes@iota.org",
@@ -14,24 +14,24 @@
 		"node": ">=20.0.0"
 	},
 	"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",
-		"@twin.org/entity": "next",
-		"@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.8",
-		"@twin.org/immutable-proof-task": "0.0.3-next.8",
-		"@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"
+		"@twin.org/api-models": "0.9.0-next.1",
+		"@twin.org/background-task-models": "0.9.0-next.1",
+		"@twin.org/context": "0.9.0-next.1",
+		"@twin.org/core": "0.9.0-next.1",
+		"@twin.org/crypto": "0.9.0-next.1",
+		"@twin.org/data-json-ld": "0.9.0-next.1",
+		"@twin.org/entity": "0.9.0-next.1",
+		"@twin.org/entity-storage-models": "0.9.0-next.1",
+		"@twin.org/event-bus-models": "0.9.0-next.1",
+		"@twin.org/identity-models": "0.9.0-next.1",
+		"@twin.org/immutable-proof-models": "0.9.0-next.1",
+		"@twin.org/immutable-proof-task": "0.9.0-next.1",
+		"@twin.org/logging-models": "0.9.0-next.1",
+		"@twin.org/nameof": "0.9.0-next.1",
+		"@twin.org/notarization-models": "0.9.0-next.1",
+		"@twin.org/standards-w3c-did": "0.9.0-next.1",
+		"@twin.org/vault-models": "0.9.0-next.1",
+		"@twin.org/web": "0.9.0-next.1"
 	},
 	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
@@ -61,7 +61,7 @@
 		"business-logic"
 	],
 	"bugs": {
-		"url": "git+https://github.com/twinfoundation/immutable-proof/issues"
+		"url": "git+https://github.com/iotaledger/twin-immutable-proof/issues"
 	},
 	"homepage": "https://twindev.org"
 }