@3sixty/api-processors 0.0.0-stage → 0.20.0-next.1

package/docs/reference/index.md

@@ -0,0 +1,23 @@
+# @3sixty/api-processors
+
+## Classes
+
+- [RestRouteProcessor](classes/RestRouteProcessor.md)
+- [SocketRouteProcessor](classes/SocketRouteProcessor.md)
+- [ContextIdProcessor](classes/ContextIdProcessor.md)
+- [StaticContextIdProcessor](classes/StaticContextIdProcessor.md)
+- [LoggingProcessor](classes/LoggingProcessor.md)
+- [JsonLdMimeTypeProcessor](classes/JsonLdMimeTypeProcessor.md)
+- [JwtMimeTypeProcessor](classes/JwtMimeTypeProcessor.md)
+
+## Interfaces
+
+- [IContextIdProcessorConfig](interfaces/IContextIdProcessorConfig.md)
+- [IContextIdProcessorConstructorOptions](interfaces/IContextIdProcessorConstructorOptions.md)
+- [ILoggingProcessorConfig](interfaces/ILoggingProcessorConfig.md)
+- [ILoggingProcessorConstructorOptions](interfaces/ILoggingProcessorConstructorOptions.md)
+- [IRestRouteProcessorConstructorOptions](interfaces/IRestRouteProcessorConstructorOptions.md)
+- [IRouteProcessorConfig](interfaces/IRouteProcessorConfig.md)
+- [ISocketRouteProcessorConstructorOptions](interfaces/ISocketRouteProcessorConstructorOptions.md)
+- [IStaticContextIdProcessorConfig](interfaces/IStaticContextIdProcessorConfig.md)
+- [IStaticContextIdProcessorConstructorOptions](interfaces/IStaticContextIdProcessorConstructorOptions.md)

package/docs/reference/interfaces/IContextIdProcessorConfig.md

@@ -0,0 +1,19 @@
+# Interface: IContextIdProcessorConfig
+
+Configuration for the context id processor.
+
+## Properties
+
+### key {#key}
+
+> **key**: `string`
+
+The fixed identity key for request context.
+
+***
+
+### authOnly? {#authonly}
+
+> `optional` **authOnly?**: `boolean`
+
+Only add the identity if the request is authenticated.

package/docs/reference/interfaces/IContextIdProcessorConstructorOptions.md

@@ -0,0 +1,11 @@
+# Interface: IContextIdProcessorConstructorOptions
+
+Options for the ContextIdProcessor constructor.
+
+## Properties
+
+### config {#config}
+
+> **config**: [`IContextIdProcessorConfig`](IContextIdProcessorConfig.md)
+
+The configuration for the processor.

package/docs/reference/interfaces/ILoggingProcessorConfig.md

@@ -0,0 +1,36 @@
+# Interface: ILoggingProcessorConfig
+
+Configuration for the request logging processor.
+
+## Properties
+
+### includeBody? {#includebody}
+
+> `optional` **includeBody?**: `boolean`
+
+Include the body objects when logging the information.
+
+***
+
+### fullBase64? {#fullbase64}
+
+> `optional` **fullBase64?**: `boolean`
+
+Show the full base64 content for data, default to abbreviate.
+
+***
+
+### obfuscateProperties? {#obfuscateproperties}
+
+> `optional` **obfuscateProperties?**: `string`[]
+
+List of property names to obfuscate, can be regex, defaults to "password".
+
+***
+
+### excludePaths? {#excludepaths}
+
+> `optional` **excludePaths?**: `string`[]
+
+Request URL path prefixes to exclude from logging, defaults to ["/logging"].
+Use this to prevent the logging endpoint itself from appearing in its own output.

package/docs/reference/interfaces/ILoggingProcessorConstructorOptions.md

@@ -0,0 +1,19 @@
+# Interface: ILoggingProcessorConstructorOptions
+
+Options for the LoggingProcessor constructor.
+
+## Properties
+
+### loggingComponentType? {#loggingcomponenttype}
+
+> `optional` **loggingComponentType?**: `string`
+
+The type for the logging component.
+
+***
+
+### config? {#config}
+
+> `optional` **config?**: [`ILoggingProcessorConfig`](ILoggingProcessorConfig.md)
+
+The configuration for the logging processor.

package/docs/reference/interfaces/IRestRouteProcessorConstructorOptions.md

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

package/docs/reference/interfaces/IRouteProcessorConfig.md

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

package/docs/reference/interfaces/ISocketRouteProcessorConstructorOptions.md

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

package/docs/reference/interfaces/IStaticContextIdProcessorConfig.md

@@ -0,0 +1,27 @@
+# Interface: IStaticContextIdProcessorConfig
+
+Configuration for the static id processor.
+
+## Properties
+
+### key {#key}
+
+> **key**: `string`
+
+The fixed identity key for request context.
+
+***
+
+### value {#value}
+
+> **value**: `string`
+
+The fixed identity value for request context.
+
+***
+
+### authOnly? {#authonly}
+
+> `optional` **authOnly?**: `boolean`
+
+Only add the identity if the request is authenticated.

package/docs/reference/interfaces/IStaticContextIdProcessorConstructorOptions.md

@@ -0,0 +1,11 @@
+# Interface: IStaticContextIdProcessorConstructorOptions
+
+Options for the StaticContextIdProcessor constructor.
+
+## Properties
+
+### config {#config}
+
+> **config**: [`IStaticContextIdProcessorConfig`](IStaticContextIdProcessorConfig.md)
+
+The configuration for the processor.

package/locales/en.json

@@ -0,0 +1,22 @@
+{
+	"error": {
+		"restRouteProcessor": {
+			"routeNotFound": "The web server could not find the REST route \"{notFoundId}\""
+		},
+		"socketRouteProcessor": {
+			"routeNotFound": "The web server could not find the socket route \"{notFoundId}\""
+		},
+		"jsonLdMimeTypeProcessor": {
+			"invalidJsonLd": "The JSON-LD content is invalid or missing '@context'."
+		},
+		"loggingProcessor": {
+			"responseMessage": "<=== {statusCode} {method} {requestUrl} duration: {elapsedMicroSeconds}µs"
+		}
+	},
+	"info": {
+		"loggingProcessor": {
+			"requestMessage": "===> {method} {requestUrl}",
+			"responseMessage": "<=== {statusCode} {method} {requestUrl} duration: {elapsedMicroSeconds}µs"
+		}
+	}
+}

package/package.json

@@ -1,6 +1,51 @@
 {
-  "name": "@3sixty/api-processors",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+	"name": "@3sixty/api-processors",
+	"version": "0.20.0-next.1",
+	"description": "Reusable request and route processors for logging, context handling, and content negotiation.",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/3sixtyglobal/api.git",
+		"directory": "packages/api-processors"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=24.0.0"
+	},
+	"dependencies": {
+		"@3sixty/api-models": "0.20.0-next.1",
+		"@3sixty/context": "next",
+		"@3sixty/core": "next",
+		"@3sixty/logging-models": "next",
+		"@3sixty/nameof": "next",
+		"@3sixty/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"
+		}
+	},
+	"files": [
+		"dist/es",
+		"dist/types",
+		"locales",
+		"docs"
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"api"
+	],
+	"bugs": {
+		"url": "git+https://github.com/3sixtyglobal/api/issues"
+	},
+	"homepage": "https://3sixty.global"
+}