@twin.org/api-processors 0.0.1-next.25 → 0.0.1-next.26

package/dist/cjs/index.cjs

@@ -27,8 +27,6 @@ class RestRouteProcessor {
     /**
      * Create a new instance of RouteProcessor.
      * @param options Options for the processor.
-     * @param options.config The configuration for the processor.
-     * @returns Promise that resolves when the processor is initialized.
      */
     constructor(options) {
         this._includeErrorStack = options?.config?.includeErrorStack ?? false;
@@ -138,8 +136,6 @@ class SocketRouteProcessor {
     /**
      * Create a new instance of SocketRouteProcessor.
      * @param options Options for the processor.
-     * @param options.config The configuration for the processor.
-     * @returns Promise that resolves when the processor is initialized.
      */
     constructor(options) {
         this._includeErrorStack = options?.config?.includeErrorStack ?? false;
@@ -254,8 +250,6 @@ class StaticUserIdentityProcessor {
     /**
      * Create a new instance of StaticIdentityProcessor.
      * @param options Options for the processor.
-     * @param options.config The configuration for the processor.
-     * @returns Promise that resolves when the processor is initialized.
      */
     constructor(options) {
         core.Guards.object(this.CLASS_NAME, "options", options);
@@ -311,11 +305,8 @@ class LoggingProcessor {
      */
     _obfuscateProperties;
     /**
-     * Create a new instance of RequestLoggingProcessor.
+     * Create a new instance of LoggingProcessor.
      * @param options Options for the processor.
-     * @param options.loggingConnectorType The type for the logging connector, defaults to "logging".
-     * @param options.config The configuration for the processor.
-     * @returns Promise that resolves when the processor is initialized.
      */
     constructor(options) {
         this._loggingConnector = loggingModels.LoggingConnectorFactory.get(options?.loggingConnectorType ?? "logging");

package/dist/esm/index.mjs

@@ -25,8 +25,6 @@ class RestRouteProcessor {
     /**
      * Create a new instance of RouteProcessor.
      * @param options Options for the processor.
-     * @param options.config The configuration for the processor.
-     * @returns Promise that resolves when the processor is initialized.
      */
     constructor(options) {
         this._includeErrorStack = options?.config?.includeErrorStack ?? false;
@@ -136,8 +134,6 @@ class SocketRouteProcessor {
     /**
      * Create a new instance of SocketRouteProcessor.
      * @param options Options for the processor.
-     * @param options.config The configuration for the processor.
-     * @returns Promise that resolves when the processor is initialized.
      */
     constructor(options) {
         this._includeErrorStack = options?.config?.includeErrorStack ?? false;
@@ -252,8 +248,6 @@ class StaticUserIdentityProcessor {
     /**
      * Create a new instance of StaticIdentityProcessor.
      * @param options Options for the processor.
-     * @param options.config The configuration for the processor.
-     * @returns Promise that resolves when the processor is initialized.
      */
     constructor(options) {
         Guards.object(this.CLASS_NAME, "options", options);
@@ -309,11 +303,8 @@ class LoggingProcessor {
      */
     _obfuscateProperties;
     /**
-     * Create a new instance of RequestLoggingProcessor.
+     * Create a new instance of LoggingProcessor.
      * @param options Options for the processor.
-     * @param options.loggingConnectorType The type for the logging connector, defaults to "logging".
-     * @param options.config The configuration for the processor.
-     * @returns Promise that resolves when the processor is initialized.
      */
     constructor(options) {
         this._loggingConnector = LoggingConnectorFactory.get(options?.loggingConnectorType ?? "logging");

package/dist/types/data/restRouteProcessor.d.ts

@@ -1,5 +1,5 @@
 import { type IHttpRequestIdentity, type IHttpResponse, type IRestRouteProcessor, type IHttpServerRequest, type IRestRoute } from "@twin.org/api-models";
-import type { IRouteProcessorConfig } from "../models/IRouteProcessorConfig";
+import type { IRestRouteProcessorConstructorOptions } from "../models/IRestRouteProcessorConstructorOptions";
 /**
  * Process the REST request and hands it on to the route handler.
  */
@@ -15,12 +15,8 @@ export declare class RestRouteProcessor implements IRestRouteProcessor {
     /**
      * Create a new instance of RouteProcessor.
      * @param options Options for the processor.
-     * @param options.config The configuration for the processor.
-     * @returns Promise that resolves when the processor is initialized.
      */
-    constructor(options?: {
-        config?: IRouteProcessorConfig;
-    });
+    constructor(options?: IRestRouteProcessorConstructorOptions);
     /**
      * Process the REST request for the specified route.
      * @param request The incoming request.

package/dist/types/data/socketRouteProcessor.d.ts

@@ -1,5 +1,5 @@
 import { type IHttpRequestIdentity, type IHttpResponse, type IHttpServerRequest, type ISocketRoute, type ISocketRouteProcessor } from "@twin.org/api-models";
-import type { IRouteProcessorConfig } from "../models/IRouteProcessorConfig";
+import type { ISocketRouteProcessorConstructorOptions } from "../models/ISocketRouteProcessorConstructorOptions";
 /**
  * Process the socket request and hands it on to the route handler.
  */
@@ -15,12 +15,8 @@ export declare class SocketRouteProcessor implements ISocketRouteProcessor {
     /**
      * Create a new instance of SocketRouteProcessor.
      * @param options Options for the processor.
-     * @param options.config The configuration for the processor.
-     * @returns Promise that resolves when the processor is initialized.
      */
-    constructor(options?: {
-        config?: IRouteProcessorConfig;
-    });
+    constructor(options?: ISocketRouteProcessorConstructorOptions);
     /**
      * Process the REST request for the specified route.
      * @param request The incoming request.

package/dist/types/identity/staticUserIdentityProcessor.d.ts

@@ -1,5 +1,5 @@
 import type { IBaseRoute, IBaseRouteProcessor, IHttpRequestIdentity, IHttpResponse, IHttpServerRequest } from "@twin.org/api-models";
-import type { IStaticUserIdentityProcessorConfig } from "../models/IStaticUserIdentityProcessorConfig";
+import type { IStaticUserIdentityProcessorConstructorOptions } from "../models/IStaticUserIdentityProcessorConstructorOptions";
 /**
  * Adds a static user identity to the request context.
  */
@@ -15,12 +15,8 @@ export declare class StaticUserIdentityProcessor implements IBaseRouteProcessor
     /**
      * Create a new instance of StaticIdentityProcessor.
      * @param options Options for the processor.
-     * @param options.config The configuration for the processor.
-     * @returns Promise that resolves when the processor is initialized.
      */
-    constructor(options: {
-        config: IStaticUserIdentityProcessorConfig;
-    });
+    constructor(options: IStaticUserIdentityProcessorConstructorOptions);
     /**
      * Pre process the REST request for the specified route.
      * @param request The incoming request.

package/dist/types/index.d.ts

@@ -5,5 +5,9 @@ export * from "./identity/staticUserIdentityProcessor";
 export * from "./logging/loggingProcessor";
 export * from "./mimeType/jwtMimeTypeProcessor";
 export * from "./models/ILoggingProcessorConfig";
+export * from "./models/ILoggingProcessorConstructorOptions";
+export * from "./models/IRestRouteProcessorConstructorOptions";
 export * from "./models/IRouteProcessorConfig";
+export * from "./models/ISocketRouteProcessorConstructorOptions";
 export * from "./models/IStaticUserIdentityProcessorConfig";
+export * from "./models/IStaticUserIdentityProcessorConstructorOptions";

package/dist/types/logging/loggingProcessor.d.ts

@@ -1,5 +1,5 @@
 import type { IBaseRoute, IBaseRouteProcessor, IHttpRequestIdentity, IHttpResponse, IHttpServerRequest } from "@twin.org/api-models";
-import type { ILoggingProcessorConfig } from "../models/ILoggingProcessorConfig";
+import type { ILoggingProcessorConstructorOptions } from "../models/ILoggingProcessorConstructorOptions";
 /**
  * Process the REST request and log its information.
  */
@@ -13,16 +13,10 @@ export declare class LoggingProcessor implements IBaseRouteProcessor {
      */
     readonly CLASS_NAME: string;
     /**
-     * Create a new instance of RequestLoggingProcessor.
+     * Create a new instance of LoggingProcessor.
      * @param options Options for the processor.
-     * @param options.loggingConnectorType The type for the logging connector, defaults to "logging".
-     * @param options.config The configuration for the processor.
-     * @returns Promise that resolves when the processor is initialized.
      */
-    constructor(options?: {
-        loggingConnectorType?: string;
-        config?: ILoggingProcessorConfig;
-    });
+    constructor(options?: ILoggingProcessorConstructorOptions);
     /**
      * Pre process the REST request for the specified route.
      * @param request The incoming request.

package/dist/types/models/ILoggingProcessorConstructorOptions.d.ts

@@ -0,0 +1,15 @@
+import type { ILoggingProcessorConfig } from "./ILoggingProcessorConfig";
+/**
+ * Options for the LoggingProcessor constructor.
+ */
+export interface ILoggingProcessorConstructorOptions {
+    /**
+     * The type for the logging connector.
+     * @default logging
+     */
+    loggingConnectorType?: string;
+    /**
+     *
+     */
+    config?: ILoggingProcessorConfig;
+}

package/dist/types/models/IRestRouteProcessorConstructorOptions.d.ts

@@ -0,0 +1,10 @@
+import type { IRouteProcessorConfig } from "../models/IRouteProcessorConfig";
+/**
+ * Options for the RestRouteProcessor constructor.
+ */
+export interface IRestRouteProcessorConstructorOptions {
+    /**
+     * The configuration for the processor.
+     */
+    config?: IRouteProcessorConfig;
+}

package/dist/types/models/ISocketRouteProcessorConstructorOptions.d.ts

@@ -0,0 +1,10 @@
+import type { IRouteProcessorConfig } from "./IRouteProcessorConfig";
+/**
+ * Options for the SocketRouteProcessor constructor.
+ */
+export interface ISocketRouteProcessorConstructorOptions {
+    /**
+     * The configuration for the processor.
+     */
+    config?: IRouteProcessorConfig;
+}

package/dist/types/models/IStaticUserIdentityProcessorConstructorOptions.d.ts

@@ -0,0 +1,10 @@
+import type { IStaticUserIdentityProcessorConfig } from "./IStaticUserIdentityProcessorConfig";
+/**
+ * Options for the StaticUserIdentityProcessor constructor.
+ */
+export interface IStaticUserIdentityProcessorConstructorOptions {
+    /**
+     * The configuration for the processor.
+     */
+    config: IStaticUserIdentityProcessorConfig;
+}

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/api-processors - Changelog
 
-## v0.0.1-next.25
+## v0.0.1-next.26
 
 - Initial Release

package/docs/reference/classes/JwtMimeTypeProcessor.md

@@ -64,7 +64,9 @@ Handle content.
 
 #### Parameters
 
-• **body**: `Uint8Array`
+##### body
+
+`Uint8Array`
 
 The body to process.
 

package/docs/reference/classes/LoggingProcessor.md

@@ -12,28 +12,20 @@ Process the REST request and log its information.
 
 > **new LoggingProcessor**(`options`?): [`LoggingProcessor`](LoggingProcessor.md)
 
-Create a new instance of RequestLoggingProcessor.
+Create a new instance of LoggingProcessor.
 
 #### Parameters
 
-• **options?**
+##### options?
 
-Options for the processor.
-
-• **options.loggingConnectorType?**: `string`
-
-The type for the logging connector, defaults to "logging".
-
-• **options.config?**: [`ILoggingProcessorConfig`](../interfaces/ILoggingProcessorConfig.md)
+[`ILoggingProcessorConstructorOptions`](../interfaces/ILoggingProcessorConstructorOptions.md)
 
-The configuration for the processor.
+Options for the processor.
 
 #### Returns
 
 [`LoggingProcessor`](LoggingProcessor.md)
 
-Promise that resolves when the processor is initialized.
-
 ## Properties
 
 ### NAMESPACE
@@ -64,23 +56,31 @@ Pre process the REST request for the specified route.
 
 #### Parameters
 
-• **request**: `IHttpServerRequest`\<`any`\>
+##### request
+
+`IHttpServerRequest`
 
 The incoming request.
 
-• **response**: `IHttpResponse`\<`any`\>
+##### response
+
+`IHttpResponse`
 
 The outgoing response.
 
-• **route**: `undefined` \| `IBaseRoute`
+##### route
 
 The route to process.
 
-• **requestIdentity**: `IHttpRequestIdentity`
+`undefined` | `IBaseRoute`
+
+##### requestIdentity
+
+`IHttpRequestIdentity`
 
 The identity context for the request.
 
-• **processorState**
+##### processorState
 
 The state handed through the processors.
 
@@ -102,23 +102,31 @@ Post process the REST request for the specified route.
 
 #### Parameters
 
-• **request**: `IHttpServerRequest`\<`any`\>
+##### request
+
+`IHttpServerRequest`
 
 The incoming request.
 
-• **response**: `IHttpResponse`\<`any`\>
+##### response
+
+`IHttpResponse`
 
 The outgoing response.
 
-• **route**: `undefined` \| `IBaseRoute`
+##### route
 
 The route to process.
 
-• **requestIdentity**: `IHttpRequestIdentity`
+`undefined` | `IBaseRoute`
+
+##### requestIdentity
+
+`IHttpRequestIdentity`
 
 The identity context for the request.
 
-• **processorState**
+##### processorState
 
 The state handed through the processors.
 

package/docs/reference/classes/NodeIdentityProcessor.md

@@ -46,11 +46,15 @@ The service needs to be started when the application is initialized.
 
 #### Parameters
 
-• **nodeIdentity**: `string`
+##### nodeIdentity
+
+`string`
 
 The identity of the node.
 
-• **nodeLoggingConnectorType?**: `string`
+##### nodeLoggingConnectorType?
+
+`string`
 
 The node logging connector type, defaults to "node-logging".
 
@@ -74,23 +78,31 @@ Pre process the REST request for the specified route.
 
 #### Parameters
 
-• **request**: `IHttpServerRequest`\<`any`\>
+##### request
+
+`IHttpServerRequest`
 
 The incoming request.
 
-• **response**: `IHttpResponse`\<`any`\>
+##### response
+
+`IHttpResponse`
 
 The outgoing response.
 
-• **route**: `undefined` \| `IBaseRoute`
+##### route
 
 The route to process.
 
-• **requestIdentity**: `IHttpRequestIdentity`
+`undefined` | `IBaseRoute`
+
+##### requestIdentity
+
+`IHttpRequestIdentity`
 
 The identity context for the request.
 
-• **processorState**
+##### processorState
 
 The state handed through the processors.
 

package/docs/reference/classes/RestRouteProcessor.md

@@ -16,20 +16,16 @@ Create a new instance of RouteProcessor.
 
 #### Parameters
 
-• **options?**
+##### options?
 
-Options for the processor.
-
-• **options.config?**: [`IRouteProcessorConfig`](../interfaces/IRouteProcessorConfig.md)
+[`IRestRouteProcessorConstructorOptions`](../interfaces/IRestRouteProcessorConstructorOptions.md)
 
-The configuration for the processor.
+Options for the processor.
 
 #### Returns
 
 [`RestRouteProcessor`](RestRouteProcessor.md)
 
-Promise that resolves when the processor is initialized.
-
 ## Properties
 
 ### NAMESPACE
@@ -60,23 +56,31 @@ Process the REST request for the specified route.
 
 #### Parameters
 
-• **request**: `IHttpServerRequest`\<`any`\>
+##### request
+
+`IHttpServerRequest`
 
 The incoming request.
 
-• **response**: `IHttpResponse`\<`any`\>
+##### response
+
+`IHttpResponse`
 
 The outgoing response.
 
-• **route**: `undefined` \| `IRestRoute`\<`any`, `any`\>
+##### route
 
 The route to process.
 
-• **requestIdentity**: `IHttpRequestIdentity`
+`undefined` | `IRestRoute`
+
+##### requestIdentity
+
+`IHttpRequestIdentity`
 
 The identity context for the request.
 
-• **processorState**
+##### processorState
 
 The state handed through the processors.
 

package/docs/reference/classes/SocketRouteProcessor.md

@@ -16,20 +16,16 @@ Create a new instance of SocketRouteProcessor.
 
 #### Parameters
 
-• **options?**
+##### options?
 
-Options for the processor.
-
-• **options.config?**: [`IRouteProcessorConfig`](../interfaces/IRouteProcessorConfig.md)
+[`ISocketRouteProcessorConstructorOptions`](../interfaces/ISocketRouteProcessorConstructorOptions.md)
 
-The configuration for the processor.
+Options for the processor.
 
 #### Returns
 
 [`SocketRouteProcessor`](SocketRouteProcessor.md)
 
-Promise that resolves when the processor is initialized.
-
 ## Properties
 
 ### NAMESPACE
@@ -60,27 +56,37 @@ Process the REST request for the specified route.
 
 #### Parameters
 
-• **request**: `IHttpServerRequest`\<`any`\>
+##### request
+
+`IHttpServerRequest`
 
 The incoming request.
 
-• **response**: `IHttpResponse`\<`any`\>
+##### response
+
+`IHttpResponse`
 
 The outgoing response.
 
-• **route**: `undefined` \| `ISocketRoute`\<`any`, `any`\>
+##### route
 
 The route to process.
 
-• **requestIdentity**: `IHttpRequestIdentity`
+`undefined` | `ISocketRoute`
+
+##### requestIdentity
+
+`IHttpRequestIdentity`
 
 The identity context for the request.
 
-• **processorState**
+##### processorState
 
 The state handed through the processors.
 
-• **responseEmitter**
+##### responseEmitter
+
+(`topic`, `response`) => `Promise`\<`void`\>
 
 The function to emit a response.
 

package/docs/reference/classes/StaticUserIdentityProcessor.md

@@ -16,20 +16,16 @@ Create a new instance of StaticIdentityProcessor.
 
 #### Parameters
 
-• **options**
+##### options
 
-Options for the processor.
-
-• **options.config**: [`IStaticUserIdentityProcessorConfig`](../interfaces/IStaticUserIdentityProcessorConfig.md)
+[`IStaticUserIdentityProcessorConstructorOptions`](../interfaces/IStaticUserIdentityProcessorConstructorOptions.md)
 
-The configuration for the processor.
+Options for the processor.
 
 #### Returns
 
 [`StaticUserIdentityProcessor`](StaticUserIdentityProcessor.md)
 
-Promise that resolves when the processor is initialized.
-
 ## Properties
 
 ### NAMESPACE
@@ -60,23 +56,31 @@ Pre process the REST request for the specified route.
 
 #### Parameters
 
-• **request**: `IHttpServerRequest`\<`any`\>
+##### request
+
+`IHttpServerRequest`
 
 The incoming request.
 
-• **response**: `IHttpResponse`\<`any`\>
+##### response
+
+`IHttpResponse`
 
 The outgoing response.
 
-• **route**: `undefined` \| `IBaseRoute`
+##### route
 
 The route to process.
 
-• **requestIdentity**: `IHttpRequestIdentity`
+`undefined` | `IBaseRoute`
+
+##### requestIdentity
+
+`IHttpRequestIdentity`
 
 The identity context for the request.
 
-• **processorState**
+##### processorState
 
 The state handed through the processors.
 

package/docs/reference/index.md

@@ -12,5 +12,9 @@
 ## Interfaces
 
 - [ILoggingProcessorConfig](interfaces/ILoggingProcessorConfig.md)
+- [ILoggingProcessorConstructorOptions](interfaces/ILoggingProcessorConstructorOptions.md)
+- [IRestRouteProcessorConstructorOptions](interfaces/IRestRouteProcessorConstructorOptions.md)
 - [IRouteProcessorConfig](interfaces/IRouteProcessorConfig.md)
+- [ISocketRouteProcessorConstructorOptions](interfaces/ISocketRouteProcessorConstructorOptions.md)
 - [IStaticUserIdentityProcessorConfig](interfaces/IStaticUserIdentityProcessorConfig.md)
+- [IStaticUserIdentityProcessorConstructorOptions](interfaces/IStaticUserIdentityProcessorConstructorOptions.md)

package/docs/reference/interfaces/ILoggingProcessorConstructorOptions.md

@@ -0,0 +1,23 @@
+# Interface: ILoggingProcessorConstructorOptions
+
+Options for the LoggingProcessor constructor.
+
+## Properties
+
+### loggingConnectorType?
+
+> `optional` **loggingConnectorType**: `string`
+
+The type for the logging connector.
+
+#### Default
+
+```ts
+logging
+```
+
+***
+
+### config?
+
+> `optional` **config**: [`ILoggingProcessorConfig`](ILoggingProcessorConfig.md)

package/docs/reference/interfaces/IRestRouteProcessorConstructorOptions.md

@@ -0,0 +1,11 @@
+# Interface: IRestRouteProcessorConstructorOptions
+
+Options for the RestRouteProcessor constructor.
+
+## Properties
+
+### config?
+
+> `optional` **config**: [`IRouteProcessorConfig`](IRouteProcessorConfig.md)
+
+The configuration for the processor.

package/docs/reference/interfaces/ISocketRouteProcessorConstructorOptions.md

@@ -0,0 +1,11 @@
+# Interface: ISocketRouteProcessorConstructorOptions
+
+Options for the SocketRouteProcessor constructor.
+
+## Properties
+
+### config?
+
+> `optional` **config**: [`IRouteProcessorConfig`](IRouteProcessorConfig.md)
+
+The configuration for the processor.

package/docs/reference/interfaces/IStaticUserIdentityProcessorConstructorOptions.md

@@ -0,0 +1,11 @@
+# Interface: IStaticUserIdentityProcessorConstructorOptions
+
+Options for the StaticUserIdentityProcessor constructor.
+
+## Properties
+
+### config
+
+> **config**: [`IStaticUserIdentityProcessorConfig`](IStaticUserIdentityProcessorConfig.md)
+
+The configuration for the processor.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/api-processors",
-	"version": "0.0.1-next.25",
+	"version": "0.0.1-next.26",
 	"description": "Route processors for use with API servers",
 	"repository": {
 		"type": "git",
@@ -14,7 +14,7 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/api-models": "0.0.1-next.25",
+		"@twin.org/api-models": "0.0.1-next.26",
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
 		"@twin.org/entity-storage-models": "next",