@twin.org/immutable-proof-service 0.0.1-next.9 → 0.0.1

package/docs/reference/classes/ImmutableProof.md

@@ -4,13 +4,13 @@ Class describing the immutable proof.
 
 ## Constructors
 
-### new ImmutableProof()
+### Constructor
 
-> **new ImmutableProof**(): [`ImmutableProof`](ImmutableProof.md)
+> **new ImmutableProof**(): `ImmutableProof`
 
 #### Returns
 
-[`ImmutableProof`](ImmutableProof.md)
+`ImmutableProof`
 
 ## Properties
 
@@ -62,8 +62,8 @@ The associated hash for the item.
 
 ***
 
-### immutableStorageId?
+### verifiableStorageId?
 
-> `optional` **immutableStorageId**: `string`
+> `optional` **verifiableStorageId**: `string`
 
-The immutable storage id.
+The verifiable storage id.

package/docs/reference/classes/ImmutableProofService.md

@@ -8,45 +8,23 @@ Class for performing immutable proof operations.
 
 ## Constructors
 
-### new ImmutableProofService()
+### Constructor
 
-> **new ImmutableProofService**(`options`?): [`ImmutableProofService`](ImmutableProofService.md)
+> **new ImmutableProofService**(`options?`): `ImmutableProofService`
 
 Create a new instance of ImmutableProofService.
 
 #### Parameters
 
-• **options?**
+##### options?
 
-The dependencies for the immutable proof connector.
-
-• **options.vaultConnectorType?**: `string`
-
-The vault connector type, defaults to "vault".
-
-• **options.immutableProofEntityStorageType?**: `string`
-
-The entity storage for proofs, defaults to "immutable-proof".
-
-• **options.immutableStorageType?**: `string`
-
-The immutable storage, defaults to "immutable-storage".
-
-• **options.identityConnectorType?**: `string`
-
-The identity connector type, defaults to "identity".
-
-• **options.backgroundTaskConnectorType?**: `string`
-
-The background task connector type, defaults to "background-task".
+[`IImmutableProofServiceConstructorOptions`](../interfaces/IImmutableProofServiceConstructorOptions.md)
 
-• **options.config?**: [`IImmutableProofServiceConfig`](../interfaces/IImmutableProofServiceConfig.md)
-
-The configuration for the connector.
+The dependencies for the immutable proof connector.
 
 #### Returns
 
-[`ImmutableProofService`](ImmutableProofService.md)
+`ImmutableProofService`
 
 ## Properties
 
@@ -72,21 +50,27 @@ Runtime name for the class.
 
 ### create()
 
-> **create**(`proofObject`, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
+> **create**(`document`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`string`\>
 
-Create a new authentication proof.
+Create a new proof.
 
 #### Parameters
 
-• **proofObject**: `IJsonLdNodeObject`
+##### document
+
+`IJsonLdNodeObject`
 
-The object for the proof as JSON-LD.
+The document to create the proof for.
 
-• **userIdentity?**: `string`
+##### userIdentity?
+
+`string`
 
 The identity to create the immutable proof operation with.
 
-• **nodeIdentity?**: `string`
+##### nodeIdentity?
+
+`string`
 
 The node identity to use for vault operations.
 
@@ -94,7 +78,7 @@ The node identity to use for vault operations.
 
 `Promise`\<`string`\>
 
-The id of the new authentication proof.
+The id of the new proof.
 
 #### Implementation of
 
@@ -106,11 +90,13 @@ The id of the new authentication proof.
 
 > **get**(`id`): `Promise`\<`IImmutableProof`\>
 
-Get an authentication proof.
+Get a proof.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the proof to get.
 
@@ -132,19 +118,17 @@ NotFoundError if the proof is not found.
 
 ### verify()
 
-> **verify**(`id`, `proofObject`): `Promise`\<`IImmutableProofVerification`\>
+> **verify**(`id`): `Promise`\<`IImmutableProofVerification`\>
 
-Verify an authentication proof.
+Verify a proof.
 
 #### Parameters
 
-• **id**: `string`
+##### id
 
-The id of the proof to verify.
-
-• **proofObject**: `IJsonLdNodeObject`
+`string`
 
-The object to verify as JSON-LD.
+The id of the proof to verify.
 
 #### Returns
 
@@ -162,19 +146,23 @@ NotFoundError if the proof is not found.
 
 ***
 
-### removeImmutable()
+### removeVerifiable()
 
-> **removeImmutable**(`id`, `nodeIdentity`?): `Promise`\<`void`\>
+> **removeVerifiable**(`id`, `nodeIdentity?`): `Promise`\<`void`\>
 
-Remove the immutable storage for the proof.
+Remove the verifiable storage for the proof.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the proof to remove the storage from.
 
-• **nodeIdentity?**: `string`
+##### nodeIdentity?
+
+`string`
 
 The node identity to use for vault operations.
 
@@ -190,4 +178,4 @@ NotFoundError if the proof is not found.
 
 #### Implementation of
 
-`IImmutableProofComponent.removeImmutable`
+`IImmutableProofComponent.removeVerifiable`

package/docs/reference/functions/generateRestRoutesImmutableProof.md

@@ -1,21 +1,25 @@
 # Function: generateRestRoutesImmutableProof()
 
-> **generateRestRoutesImmutableProof**(`baseRouteName`, `componentName`): `IRestRoute`[]
+> **generateRestRoutesImmutableProof**(`baseRouteName`, `componentName`): `IRestRoute`\<`any`, `any`\>[]
 
 The REST routes for immutable proof.
 
 ## Parameters
 
-• **baseRouteName**: `string`
+### baseRouteName
+
+`string`
 
 Prefix to prepend to the paths.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes stored in the ComponentFactory.
 
 ## Returns
 
-`IRestRoute`[]
+`IRestRoute`\<`any`, `any`\>[]
 
 The generated routes.

package/docs/reference/functions/immutableProofCreate.md

@@ -6,15 +6,21 @@ Create a proof.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes.
 
-• **request**: `IImmutableProofCreateRequest`
+### request
+
+`IImmutableProofCreateRequest`
 
 The request.
 

package/docs/reference/functions/immutableProofGet.md

@@ -6,15 +6,21 @@ Get the proof.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes.
 
-• **request**: `IImmutableProofGetRequest`
+### request
+
+`IImmutableProofGetRequest`
 
 The request.
 

package/docs/reference/functions/immutableProofVerify.md

@@ -6,15 +6,21 @@ Verify the proof.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes.
 
-• **request**: `IImmutableProofVerifyRequest`
+### request
+
+`IImmutableProofVerifyRequest`
 
 The request.
 

package/docs/reference/index.md

@@ -8,6 +8,7 @@
 ## Interfaces
 
 - [IImmutableProofServiceConfig](interfaces/IImmutableProofServiceConfig.md)
+- [IImmutableProofServiceConstructorOptions](interfaces/IImmutableProofServiceConstructorOptions.md)
 
 ## Variables
 

package/docs/reference/interfaces/IImmutableProofServiceConfig.md

@@ -4,28 +4,14 @@ Configuration for the immutable proof service.
 
 ## Properties
 
-### assertionMethodId?
+### verificationMethodId?
 
-> `optional` **assertionMethodId**: `string`
+> `optional` **verificationMethodId**: `string`
 
-The assertion method id to use for the stream.
+The verification method id to use for the proof.
 
 #### Default
 
 ```ts
 immutable-proof-assertion
 ```
-
-***
-
-### proofHashKeyId?
-
-> `optional` **proofHashKeyId**: `string`
-
-The key to use in the proof hash.
-
-#### Default
-
-```ts
-immutable-proof-hash
-```

package/docs/reference/interfaces/IImmutableProofServiceConstructorOptions.md

@@ -0,0 +1,75 @@
+# Interface: IImmutableProofServiceConstructorOptions
+
+Options for the immutable proof service constructor.
+
+## Properties
+
+### immutableProofEntityStorageType?
+
+> `optional` **immutableProofEntityStorageType**: `string`
+
+The entity storage for proofs.
+
+#### Default
+
+```ts
+immutable-proof
+```
+
+***
+
+### verifiableStorageType?
+
+> `optional` **verifiableStorageType**: `string`
+
+The verifiable storage.
+
+#### Default
+
+```ts
+verifiable-storage
+```
+
+***
+
+### identityConnectorType?
+
+> `optional` **identityConnectorType**: `string`
+
+The identity connector type.
+
+#### Default
+
+```ts
+identity
+```
+
+***
+
+### backgroundTaskConnectorType?
+
+> `optional` **backgroundTaskConnectorType**: `string`
+
+The background task connector type.
+
+#### Default
+
+```ts
+background-task
+```
+
+***
+
+### eventBusComponentType?
+
+> `optional` **eventBusComponentType**: `string`
+
+The event bus component type, defaults to no event bus.
+
+***
+
+### config?
+
+> `optional` **config**: [`IImmutableProofServiceConfig`](IImmutableProofServiceConfig.md)
+
+The configuration for the connector.

package/locales/en.json

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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/immutable-proof-service",
-	"version": "0.0.1-next.9",
+	"version": "0.0.1",
 	"description": "Immutable proof contract implementation and REST endpoint definitions",
 	"repository": {
 		"type": "git",
@@ -14,31 +14,31 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/api-models": "next",
-		"@twin.org/background-task-models": "next",
-		"@twin.org/core": "next",
-		"@twin.org/crypto": "next",
-		"@twin.org/data-json-ld": "next",
-		"@twin.org/data-schema-org": "next",
-		"@twin.org/entity": "next",
-		"@twin.org/entity-storage-models": "next",
-		"@twin.org/identity-models": "next",
-		"@twin.org/immutable-proof-models": "0.0.1-next.9",
-		"@twin.org/immutable-storage-models": "next",
-		"@twin.org/nameof": "next",
-		"@twin.org/standards-w3c-did": "next",
-		"@twin.org/vault-models": "next",
-		"@twin.org/web": "next",
-		"jsonschema": "1.4.1"
+		"@twin.org/api-models": "^0.0.2-next.1",
+		"@twin.org/background-task-models": "^0.0.1",
+		"@twin.org/core": "^0.0.1",
+		"@twin.org/crypto": "^0.0.1",
+		"@twin.org/data-json-ld": "^0.0.1",
+		"@twin.org/entity": "^0.0.1",
+		"@twin.org/entity-storage-models": "^0.0.1",
+		"@twin.org/event-bus-models": "^0.0.1",
+		"@twin.org/identity-models": "^0.0.1",
+		"@twin.org/immutable-proof-models": "^0.0.1",
+		"@twin.org/immutable-proof-task": "^0.0.1",
+		"@twin.org/nameof": "^0.0.1",
+		"@twin.org/standards-w3c-did": "^0.0.1",
+		"@twin.org/vault-models": "^0.0.1",
+		"@twin.org/verifiable-storage-models": "^0.0.1",
+		"@twin.org/web": "^0.0.1"
 	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
+			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs",
-			"types": "./dist/types/index.d.ts"
+			"import": "./dist/esm/index.mjs"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},