@twin.org/notarization-service 0.0.3-next.1

package/docs/reference/classes/NotarizationService.md

@@ -0,0 +1,219 @@
+# Class: NotarizationService
+
+Service for notarization operations.
+
+## Implements
+
+- `INotarizationComponent`
+
+## Constructors
+
+### Constructor
+
+> **new NotarizationService**(`options?`): `NotarizationService`
+
+Create a new instance of NotarizationService.
+
+#### Parameters
+
+##### options?
+
+[`INotarizationServiceConstructorOptions`](../interfaces/INotarizationServiceConstructorOptions.md)
+
+The constructor options.
+
+#### Returns
+
+`NotarizationService`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`INotarizationComponent.className`
+
+***
+
+### create() {#create}
+
+> **create**(`notarization`, `namespace?`, `controllerIdentity?`): `Promise`\<`string`\>
+
+Create a new notarization.
+
+#### Parameters
+
+##### notarization
+
+`Omit`\<`INotarization`, `"id"` \| `"dateCreated"`\>
+
+The notarization data without generated fields.
+
+##### namespace?
+
+`string`
+
+The namespace of the connector to use for the notarization, defaults to service configured namespace.
+
+##### controllerIdentity?
+
+`string`
+
+The identity to perform the notarization operation with.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The generated notarization id.
+
+#### Implementation of
+
+`INotarizationComponent.create`
+
+***
+
+### get() {#get}
+
+> **get**(`id`): `Promise`\<`INotarization`\>
+
+Get an existing notarization.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the notarization to get.
+
+#### Returns
+
+`Promise`\<`INotarization`\>
+
+The notarization.
+
+#### Implementation of
+
+`INotarizationComponent.get`
+
+***
+
+### remove() {#remove}
+
+> **remove**(`id`, `controllerIdentity?`): `Promise`\<`void`\>
+
+Remove an existing notarization.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the notarization to remove.
+
+##### controllerIdentity?
+
+`string`
+
+The identity to perform the notarization operation with.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`INotarizationComponent.remove`
+
+***
+
+### update() {#update}
+
+> **update**(`notarization`, `controllerIdentity?`): `Promise`\<`void`\>
+
+Update an existing notarization.
+
+#### Parameters
+
+##### notarization
+
+`INotarization`
+
+The notarization to update.
+
+##### controllerIdentity?
+
+`string`
+
+The identity to perform the notarization operation with.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`INotarizationComponent.update`
+
+***
+
+### transfer() {#transfer}
+
+> **transfer**(`id`, `recipientAddress`, `controllerIdentity?`): `Promise`\<`void`\>
+
+Transfer an existing notarization.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the notarization to transfer.
+
+##### recipientAddress
+
+`string`
+
+The recipient address.
+
+##### controllerIdentity?
+
+`string`
+
+The identity to perform the notarization operation with.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`INotarizationComponent.transfer`

package/docs/reference/functions/generateRestRoutesNotarization.md

@@ -0,0 +1,25 @@
+# Function: generateRestRoutesNotarization()
+
+> **generateRestRoutesNotarization**(`baseRouteName`, `componentName`): `IRestRoute`\<`any`, `any`\>[]
+
+The REST routes for notarization.
+
+## 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`\<`any`, `any`\>[]
+
+The generated routes.

package/docs/reference/functions/notarizationCreate.md

@@ -0,0 +1,31 @@
+# Function: notarizationCreate()
+
+> **notarizationCreate**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`ICreatedResponse`\>
+
+Perform the create notarization operation.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`INotarizationCreateRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`ICreatedResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/notarizationGet.md

@@ -0,0 +1,31 @@
+# Function: notarizationGet()
+
+> **notarizationGet**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INotarizationGetResponse`\>
+
+Perform the get notarization operation.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`INotarizationGetRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INotarizationGetResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/notarizationRemove.md

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

package/docs/reference/functions/notarizationTransfer.md

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

package/docs/reference/functions/notarizationUpdate.md

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

package/docs/reference/index.md

@@ -0,0 +1,24 @@
+# @twin.org/notarization-service
+
+## Classes
+
+- [NotarizationService](classes/NotarizationService.md)
+
+## Interfaces
+
+- [INotarizationServiceConfig](interfaces/INotarizationServiceConfig.md)
+- [INotarizationServiceConstructorOptions](interfaces/INotarizationServiceConstructorOptions.md)
+
+## Variables
+
+- [tagsNotarization](variables/tagsNotarization.md)
+- [restEntryPoints](variables/restEntryPoints.md)
+
+## Functions
+
+- [generateRestRoutesNotarization](functions/generateRestRoutesNotarization.md)
+- [notarizationCreate](functions/notarizationCreate.md)
+- [notarizationRemove](functions/notarizationRemove.md)
+- [notarizationGet](functions/notarizationGet.md)
+- [notarizationUpdate](functions/notarizationUpdate.md)
+- [notarizationTransfer](functions/notarizationTransfer.md)

package/docs/reference/interfaces/INotarizationServiceConfig.md

@@ -0,0 +1,11 @@
+# Interface: INotarizationServiceConfig
+
+Configuration for the Notarization Service.
+
+## Properties
+
+### defaultNamespace? {#defaultnamespace}
+
+> `optional` **defaultNamespace?**: `string`
+
+What is the default connector to use for notarization. If not provided the first connector from the factory will be used.

package/docs/reference/interfaces/INotarizationServiceConstructorOptions.md

@@ -0,0 +1,11 @@
+# Interface: INotarizationServiceConstructorOptions
+
+Options for the notarization service constructor.
+
+## Properties
+
+### config? {#config}
+
+> `optional` **config?**: [`INotarizationServiceConfig`](INotarizationServiceConfig.md)
+
+The configuration for the service.

package/docs/reference/variables/restEntryPoints.md

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

package/docs/reference/variables/tagsNotarization.md

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

package/locales/en.json

@@ -0,0 +1,13 @@
+{
+	"error": {
+		"notarizationService": {
+			"namespaceMismatch": "The namespace in the urn \"{id}\" does not match the namespace of the notarization service \"{namespace}\"",
+			"noConnectors": "There are no connectors registered with the notarization factory",
+			"createFailed": "The creation of the notarization failed",
+			"getFailed": "The retrieval of the notarization failed",
+			"removeFailed": "The removal of the notarization failed",
+			"updateFailed": "The update of the notarization failed",
+			"transferFailed": "The transfer of the notarization failed"
+		}
+	}
+}

package/package.json

@@ -0,0 +1,58 @@
+{
+	"name": "@twin.org/notarization-service",
+	"version": "0.0.3-next.1",
+	"description": "Notarization service orchestration with REST route generation.",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/notarization.git",
+		"directory": "packages/notarization-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/context": "next",
+		"@twin.org/core": "next",
+		"@twin.org/entity": "next",
+		"@twin.org/nameof": "next",
+		"@twin.org/notarization-models": "0.0.3-next.1",
+		"@twin.org/web": "next"
+	},
+	"main": "./dist/es/index.js",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/types/index.d.ts",
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
+		},
+		"./locales/*.json": "./locales/*.json"
+	},
+	"files": [
+		"dist/es",
+		"dist/types",
+		"locales",
+		"docs"
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"notarization",
+		"tokens",
+		"assets",
+		"service",
+		"microservice",
+		"business-logic"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/notarization/issues"
+	},
+	"homepage": "https://twindev.org"
+}