@twin.org/immutable-proof-service 0.0.1-next.1

package/docs/reference/classes/ImmutableProof.md

@@ -0,0 +1,69 @@
+# Class: ImmutableProof
+
+Class describing the immutable proof.
+
+## Constructors
+
+### new ImmutableProof()
+
+> **new ImmutableProof**(): [`ImmutableProof`](ImmutableProof.md)
+
+#### Returns
+
+[`ImmutableProof`](ImmutableProof.md)
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+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`
+
+The date/time of when the proof was created.
+
+***
+
+### proofObjectId?
+
+> `optional` **proofObjectId**: `string`
+
+The associated id for the item.
+
+***
+
+### proofObjectHash
+
+> **proofObjectHash**: `string`
+
+The associated hash for the item.
+
+***
+
+### immutableStorageId?
+
+> `optional` **immutableStorageId**: `string`
+
+The immutable storage id.

package/docs/reference/classes/ImmutableProofService.md

@@ -0,0 +1,197 @@
+# Class: ImmutableProofService
+
+Class for performing immutable proof operations.
+
+## Implements
+
+- `IImmutableProofComponent`
+
+## Constructors
+
+### new ImmutableProofService()
+
+> **new ImmutableProofService**(`options`?): [`ImmutableProofService`](ImmutableProofService.md)
+
+Create a new instance of ImmutableProofService.
+
+#### Parameters
+
+• **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-proof".
+
+• **options.config?**: [`IImmutableProofServiceConfig`](../interfaces/IImmutableProofServiceConfig.md)
+
+The configuration for the connector.
+
+• **options.identityConnectorType?**: `string`
+
+The identity connector type, defaults to "identity".
+
+#### Returns
+
+[`ImmutableProofService`](ImmutableProofService.md)
+
+## Properties
+
+### NAMESPACE
+
+> `readonly` `static` **NAMESPACE**: `string` = `"immutable-proof"`
+
+The namespace for the service.
+
+***
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+#### Implementation of
+
+`IImmutableProofComponent.CLASS_NAME`
+
+## Methods
+
+### create()
+
+> **create**(`proofObject`, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
+
+Create a new authentication proof.
+
+#### Parameters
+
+• **proofObject**: `IJsonLdNodeObject`
+
+The object for the proof as JSON-LD.
+
+• **userIdentity?**: `string`
+
+The identity to create the immutable proof operation with.
+
+• **nodeIdentity?**: `string`
+
+The node identity to use for vault operations.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The id of the new authentication proof.
+
+#### Implementation of
+
+`IImmutableProofComponent.create`
+
+***
+
+### get()
+
+> **get**(`id`): `Promise`\<`IImmutableProof`\>
+
+Get an authentication proof.
+
+#### Parameters
+
+• **id**: `string`
+
+The id of the proof to get.
+
+#### Returns
+
+`Promise`\<`IImmutableProof`\>
+
+The proof.
+
+#### Throws
+
+NotFoundError if the proof is not found.
+
+#### Implementation of
+
+`IImmutableProofComponent.get`
+
+***
+
+### verify()
+
+> **verify**(`id`, `proofObject`): `Promise`\<`object`\>
+
+Verify an authentication proof.
+
+#### Parameters
+
+• **id**: `string`
+
+The id of the proof to verify.
+
+• **proofObject**: `IJsonLdNodeObject`
+
+The object to verify as JSON-LD.
+
+#### Returns
+
+`Promise`\<`object`\>
+
+The result of the verification and any failures.
+
+##### verified
+
+> **verified**: `boolean`
+
+##### failure?
+
+> `optional` **failure**: `ImmutableProofFailure`
+
+#### Throws
+
+NotFoundError if the proof is not found.
+
+#### Implementation of
+
+`IImmutableProofComponent.verify`
+
+***
+
+### removeImmutable()
+
+> **removeImmutable**(`id`, `nodeIdentity`?): `Promise`\<`void`\>
+
+Remove the immutable storage for the proof.
+
+#### Parameters
+
+• **id**: `string`
+
+The id of the proof to remove the storage from.
+
+• **nodeIdentity?**: `string`
+
+The node identity to use for vault operations.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Throws
+
+NotFoundError if the proof is not found.
+
+#### Implementation of
+
+`IImmutableProofComponent.removeImmutable`

package/docs/reference/functions/generateRestRoutesImmutableProof.md

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

package/docs/reference/functions/immutableProofCreate.md

@@ -0,0 +1,25 @@
+# Function: immutableProofCreate()
+
+> **immutableProofCreate**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`ICreatedResponse`\>
+
+Create a proof.
+
+## Parameters
+
+• **httpRequestContext**: `IHttpRequestContext`
+
+The request context for the API.
+
+• **componentName**: `string`
+
+The name of the component to use in the routes.
+
+• **request**: `IImmutableProofCreateRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`ICreatedResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/immutableProofGet.md

@@ -0,0 +1,25 @@
+# Function: immutableProofGet()
+
+> **immutableProofGet**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IImmutableProofGetResponse`\>
+
+Get the proof.
+
+## Parameters
+
+• **httpRequestContext**: `IHttpRequestContext`
+
+The request context for the API.
+
+• **componentName**: `string`
+
+The name of the component to use in the routes.
+
+• **request**: `IImmutableProofGetRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IImmutableProofGetResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/immutableProofVerify.md

@@ -0,0 +1,25 @@
+# Function: immutableProofVerify()
+
+> **immutableProofVerify**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IImmutableProofVerifyResponse`\>
+
+Verify the proof.
+
+## Parameters
+
+• **httpRequestContext**: `IHttpRequestContext`
+
+The request context for the API.
+
+• **componentName**: `string`
+
+The name of the component to use in the routes.
+
+• **request**: `IImmutableProofVerifyRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IImmutableProofVerifyResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/initSchema.md

@@ -0,0 +1,9 @@
+# Function: initSchema()
+
+> **initSchema**(): `void`
+
+Initialize the schema for the immutable proof entity storage connector.
+
+## Returns
+
+`void`

package/docs/reference/index.md

@@ -0,0 +1,23 @@
+# @twin.org/immutable-proof-service
+
+## Classes
+
+- [ImmutableProof](classes/ImmutableProof.md)
+- [ImmutableProofService](classes/ImmutableProofService.md)
+
+## Interfaces
+
+- [IImmutableProofServiceConfig](interfaces/IImmutableProofServiceConfig.md)
+
+## Variables
+
+- [tagsImmutableProof](variables/tagsImmutableProof.md)
+- [restEntryPoints](variables/restEntryPoints.md)
+
+## Functions
+
+- [generateRestRoutesImmutableProof](functions/generateRestRoutesImmutableProof.md)
+- [immutableProofCreate](functions/immutableProofCreate.md)
+- [immutableProofGet](functions/immutableProofGet.md)
+- [immutableProofVerify](functions/immutableProofVerify.md)
+- [initSchema](functions/initSchema.md)

package/docs/reference/interfaces/IImmutableProofServiceConfig.md

@@ -0,0 +1,31 @@
+# Interface: IImmutableProofServiceConfig
+
+Configuration for the immutable proof service.
+
+## Properties
+
+### assertionMethodId?
+
+> `optional` **assertionMethodId**: `string`
+
+The assertion method id to use for the stream.
+
+#### Default
+
+```ts
+immutable-proof
+```
+
+***
+
+### proofConfigKeyId?
+
+> `optional` **proofConfigKeyId**: `string`
+
+The key to use in the proof config.
+
+#### Default
+
+```ts
+immutable-proof
+```

package/docs/reference/variables/restEntryPoints.md

@@ -0,0 +1,3 @@
+# Variable: restEntryPoints
+
+> `const` **restEntryPoints**: `IRestRouteEntryPoint`[]

package/docs/reference/variables/tagsImmutableProof.md

@@ -0,0 +1,5 @@
+# Variable: tagsImmutableProof
+
+> `const` **tagsImmutableProof**: `ITag`[]
+
+The tag to associate with the routes.

package/locales/en.json

@@ -0,0 +1,12 @@
+{
+	"error": {
+		"immutableProofService": {
+			"namespaceMismatch": "The namespace in the urn \"{id}\" does not match the namespace of the Immutable Proof service \"{namespace}\"",
+			"createFailed": "Creating the proof failed",
+			"getFailed": "Getting the proof failed",
+			"verifyFailed": "Verifying the proof failed",
+			"removeImmutableFailed": "Removing immutable entry from the Immutable Proof failed",
+			"proofNotFound": "The proof with the Id \"{notFoundId}\" was not found"
+		}
+	}
+}

package/package.json

@@ -0,0 +1,51 @@
+{
+	"name": "@twin.org/immutable-proof-service",
+	"version": "0.0.1-next.1",
+	"description": "Immutable proof contract implementation and REST endpoint definitions",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/immutable-proof.git",
+		"directory": "packages/immutable-proof-service"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@twin.org/api-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.1",
+		"@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"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs",
+			"types": "./dist/types/index.d.ts"
+		},
+		"./locales": "./locales"
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}