@twin.org/api-processors 0.0.1-next.10

package/docs/reference/classes/NodeIdentityProcessor.md

@@ -0,0 +1,95 @@
+# Class: NodeIdentityProcessor
+
+Adds a node identity to the request identity.
+
+## Implements
+
+- `IHttpRestRouteProcessor`
+
+## Constructors
+
+### new NodeIdentityProcessor()
+
+> **new NodeIdentityProcessor**(): [`NodeIdentityProcessor`](NodeIdentityProcessor.md)
+
+#### Returns
+
+[`NodeIdentityProcessor`](NodeIdentityProcessor.md)
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+#### Implementation of
+
+`IHttpRestRouteProcessor.CLASS_NAME`
+
+## Methods
+
+### start()
+
+> **start**(`nodeIdentity`, `nodeLoggingConnectorType`?): `Promise`\<`void`\>
+
+The service needs to be started when the application is initialized.
+
+#### Parameters
+
+• **nodeIdentity**: `string`
+
+The identity of the node.
+
+• **nodeLoggingConnectorType?**: `string`
+
+The node logging connector type, defaults to "node-logging".
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IHttpRestRouteProcessor.start`
+
+***
+
+### pre()
+
+> **pre**(`request`, `response`, `route`, `requestIdentity`, `processorState`): `Promise`\<`void`\>
+
+Pre process the REST request for the specified route.
+
+#### Parameters
+
+• **request**: `IHttpServerRequest`\<`any`\>
+
+The incoming request.
+
+• **response**: `IHttpResponse`\<`any`\>
+
+The outgoing response.
+
+• **route**: `undefined` \| `IRestRoute`\<`any`, `any`\>
+
+The route to process.
+
+• **requestIdentity**: `IHttpRequestIdentity`
+
+The identity context for the request.
+
+• **processorState**
+
+The state handed through the processors.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+`IHttpRestRouteProcessor.pre`

package/docs/reference/classes/RouteProcessor.md

@@ -0,0 +1,81 @@
+# Class: RouteProcessor
+
+Process the REST request and hands it on to the route handler.
+
+## Implements
+
+- `IHttpRestRouteProcessor`
+
+## Constructors
+
+### new RouteProcessor()
+
+> **new RouteProcessor**(`options`?): [`RouteProcessor`](RouteProcessor.md)
+
+Create a new instance of RouteProcessor.
+
+#### Parameters
+
+• **options?**
+
+Options for the processor.
+
+• **options.config?**: [`IRouteProcessorConfig`](../interfaces/IRouteProcessorConfig.md)
+
+The configuration for the processor.
+
+#### Returns
+
+[`RouteProcessor`](RouteProcessor.md)
+
+Promise that resolves when the processor is initialized.
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+#### Implementation of
+
+`IHttpRestRouteProcessor.CLASS_NAME`
+
+## Methods
+
+### process()
+
+> **process**(`request`, `response`, `route`, `requestIdentity`, `processorState`): `Promise`\<`void`\>
+
+Process the REST request for the specified route.
+
+#### Parameters
+
+• **request**: `IHttpServerRequest`\<`any`\>
+
+The incoming request.
+
+• **response**: `IHttpResponse`\<`any`\>
+
+The outgoing response.
+
+• **route**: `undefined` \| `IRestRoute`\<`any`, `any`\>
+
+The route to process.
+
+• **requestIdentity**: `IHttpRequestIdentity`
+
+The identity context for the request.
+
+• **processorState**
+
+The state handed through the processors.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+`IHttpRestRouteProcessor.process`

package/docs/reference/classes/StaticUserIdentityProcessor.md

@@ -0,0 +1,81 @@
+# Class: StaticUserIdentityProcessor
+
+Adds a static user identity to the request context.
+
+## Implements
+
+- `IHttpRestRouteProcessor`
+
+## Constructors
+
+### new StaticUserIdentityProcessor()
+
+> **new StaticUserIdentityProcessor**(`options`): [`StaticUserIdentityProcessor`](StaticUserIdentityProcessor.md)
+
+Create a new instance of StaticIdentityProcessor.
+
+#### Parameters
+
+• **options**
+
+Options for the processor.
+
+• **options.config**: [`IStaticUserIdentityProcessorConfig`](../interfaces/IStaticUserIdentityProcessorConfig.md)
+
+The configuration for the processor.
+
+#### Returns
+
+[`StaticUserIdentityProcessor`](StaticUserIdentityProcessor.md)
+
+Promise that resolves when the processor is initialized.
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+#### Implementation of
+
+`IHttpRestRouteProcessor.CLASS_NAME`
+
+## Methods
+
+### pre()
+
+> **pre**(`request`, `response`, `route`, `requestIdentity`, `processorState`): `Promise`\<`void`\>
+
+Pre process the REST request for the specified route.
+
+#### Parameters
+
+• **request**: `IHttpServerRequest`\<`any`\>
+
+The incoming request.
+
+• **response**: `IHttpResponse`\<`any`\>
+
+The outgoing response.
+
+• **route**: `undefined` \| `IRestRoute`\<`any`, `any`\>
+
+The route to process.
+
+• **requestIdentity**: `IHttpRequestIdentity`
+
+The identity context for the request.
+
+• **processorState**
+
+The state handed through the processors.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+`IHttpRestRouteProcessor.pre`

package/docs/reference/index.md

@@ -0,0 +1,15 @@
+# @twin.org/api-processors
+
+## Classes
+
+- [RouteProcessor](classes/RouteProcessor.md)
+- [NodeIdentityProcessor](classes/NodeIdentityProcessor.md)
+- [StaticUserIdentityProcessor](classes/StaticUserIdentityProcessor.md)
+- [LoggingProcessor](classes/LoggingProcessor.md)
+
+## Interfaces
+
+- [IRequestLoggingProcessorConfig](interfaces/IRequestLoggingProcessorConfig.md)
+- [IResponseLoggingProcessorConfig](interfaces/IResponseLoggingProcessorConfig.md)
+- [IRouteProcessorConfig](interfaces/IRouteProcessorConfig.md)
+- [IStaticUserIdentityProcessorConfig](interfaces/IStaticUserIdentityProcessorConfig.md)

package/docs/reference/interfaces/IRequestLoggingProcessorConfig.md

@@ -0,0 +1,27 @@
+# Interface: IRequestLoggingProcessorConfig
+
+Configuration for the request logging processor.
+
+## Properties
+
+### includeBody?
+
+> `optional` **includeBody**: `boolean`
+
+Include the body objects when logging the information.
+
+***
+
+### fullBase64?
+
+> `optional` **fullBase64**: `boolean`
+
+Show the full base64 content for data, default to abbreviate.
+
+***
+
+### obfuscateProperties?
+
+> `optional` **obfuscateProperties**: `string`[]
+
+List of property names to obfuscate, can be regex, defaults to "password".

package/docs/reference/interfaces/IResponseLoggingProcessorConfig.md

@@ -0,0 +1,11 @@
+# Interface: IResponseLoggingProcessorConfig
+
+Configuration for the response logging processor.
+
+## Properties
+
+### includeBody?
+
+> `optional` **includeBody**: `boolean`
+
+Include the body objects when logging the information.

package/docs/reference/interfaces/IRouteProcessorConfig.md

@@ -0,0 +1,11 @@
+# Interface: IRouteProcessorConfig
+
+Configuration for the route processor.
+
+## Properties
+
+### includeErrorStack?
+
+> `optional` **includeErrorStack**: `boolean`
+
+Include the stack with errors.

package/docs/reference/interfaces/IStaticUserIdentityProcessorConfig.md

@@ -0,0 +1,11 @@
+# Interface: IStaticUserIdentityProcessorConfig
+
+Configuration for the static identity processor.
+
+## Properties
+
+### userIdentity
+
+> **userIdentity**: `string`
+
+The fixed user identity for request context.

package/locales/en.json

@@ -0,0 +1,12 @@
+{
+	"error": {
+		"routeProcessor": {
+			"routeNotFound": "The web server could not find the route \"{notFoundId}\""
+		},
+		"jwtIdentityProcessor": {
+			"jwtMissing": "The JSON Web token could not be found in the authorization header or a cookie",
+			"jwtSignatureInvalid": "The JSON Web token signature could not be validated",
+			"jwtExpired": "The JSON Web token has expired"
+		}
+	}
+}

package/package.json

@@ -0,0 +1,42 @@
+{
+	"name": "@twin.org/api-processors",
+	"version": "0.0.1-next.10",
+	"description": "Route processors for use with API servers",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/api.git",
+		"directory": "packages/api-processors"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@twin.org/api-models": "0.0.1-next.10",
+		"@twin.org/core": "next",
+		"@twin.org/entity": "next",
+		"@twin.org/entity-storage-models": "next",
+		"@twin.org/logging-models": "next",
+		"@twin.org/nameof": "next",
+		"@twin.org/web": "next"
+	},
+	"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"
+		}
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}