@twin.org/api-server-fastify 0.0.2-next.3 → 0.0.2-next.5

package/dist/cjs/index.cjs

@@ -5,7 +5,6 @@ var FastifyCors = require('@fastify/cors');
 var apiModels = require('@twin.org/api-models');
 var apiProcessors = require('@twin.org/api-processors');
 var core = require('@twin.org/core');
-var loggingModels = require('@twin.org/logging-models');
 var web = require('@twin.org/web');
 var Fastify = require('fastify');
 var fp = require('fastify-plugin');
@@ -48,10 +47,15 @@ class FastifyWebServer {
      */
     CLASS_NAME = "FastifyWebServer";
     /**
-     * The logging connector.
+     * The logging component type.
      * @internal
      */
-    _loggingConnector;
+    _loggingComponentType;
+    /**
+     * The logging component.
+     * @internal
+     */
+    _loggingComponent;
     /**
      * The options for the server.
      * @internal
@@ -87,8 +91,9 @@ class FastifyWebServer {
      * @param options The options for the server.
      */
     constructor(options) {
-        this._loggingConnector = core.Is.stringValue(options?.loggingConnectorType)
-            ? loggingModels.LoggingConnectorFactory.get(options.loggingConnectorType)
+        this._loggingComponentType = options?.loggingComponentType;
+        this._loggingComponent = core.Is.stringValue(options?.loggingComponentType)
+            ? core.ComponentFactory.get(options.loggingComponentType)
             : undefined;
         this._fastify = Fastify({
             maxParamLength: 2000,
@@ -129,7 +134,7 @@ class FastifyWebServer {
         if (core.Is.arrayValue(socketRoutes) && !core.Is.arrayValue(socketRouteProcessors)) {
             throw new core.GeneralError(this.CLASS_NAME, "noSocketProcessors");
         }
-        await this._loggingConnector?.log({
+        await this._loggingComponent?.log({
             level: "info",
             ts: Date.now(),
             source: this.CLASS_NAME,
@@ -174,7 +179,7 @@ class FastifyWebServer {
                 err = errorAndCode.error;
                 httpStatusCode = errorAndCode.httpStatusCode;
             }
-            await this._loggingConnector?.log({
+            await this._loggingComponent?.log({
                 level: "error",
                 ts: Date.now(),
                 source: this.CLASS_NAME,
@@ -195,7 +200,7 @@ class FastifyWebServer {
     async start() {
         const host = this._options?.host ?? FastifyWebServer._DEFAULT_HOST;
         const port = this._options?.port ?? FastifyWebServer._DEFAULT_PORT;
-        await this._loggingConnector?.log({
+        await this._loggingComponent?.log({
             level: "info",
             ts: Date.now(),
             source: this.CLASS_NAME,
@@ -210,7 +215,7 @@ class FastifyWebServer {
                 await this._fastify.listen({ port, host });
                 const addresses = this._fastify.addresses();
                 const protocol = core.Is.object(this._fastify.initialConfig.https) ? "https://" : "http://";
-                await this._loggingConnector?.log({
+                await this._loggingComponent?.log({
                     level: "info",
                     ts: Date.now(),
                     source: this.CLASS_NAME,
@@ -224,7 +229,7 @@ class FastifyWebServer {
                 this._started = true;
             }
             catch (err) {
-                await this._loggingConnector?.log({
+                await this._loggingComponent?.log({
                     level: "error",
                     ts: Date.now(),
                     source: this.CLASS_NAME,
@@ -242,7 +247,7 @@ class FastifyWebServer {
         if (this._started) {
             this._started = false;
             await this._fastify.close();
-            await this._loggingConnector?.log({
+            await this._loggingComponent?.log({
                 level: "info",
                 ts: Date.now(),
                 source: this.CLASS_NAME,
@@ -263,7 +268,7 @@ class FastifyWebServer {
                 if (!path.startsWith("/")) {
                     path = `/${path}`;
                 }
-                await this._loggingConnector?.log({
+                await this._loggingComponent?.log({
                     level: "info",
                     ts: Date.now(),
                     source: this.CLASS_NAME,
@@ -290,7 +295,7 @@ class FastifyWebServer {
                 const pathParts = path.split("/");
                 const namespace = `/${pathParts[0]}`;
                 const topic = pathParts.slice(1).join("/");
-                await this._loggingConnector?.log({
+                await this._loggingComponent?.log({
                     level: "info",
                     ts: Date.now(),
                     source: this.CLASS_NAME,
@@ -314,7 +319,7 @@ class FastifyWebServer {
                     try {
                         for (const socketRouteProcessor of socketRouteProcessors) {
                             if (socketRouteProcessor.connected) {
-                                await socketRouteProcessor.connected(socketServerRequest, socketRoute);
+                                await socketRouteProcessor.connected(socketServerRequest, socketRoute, this._loggingComponentType);
                             }
                         }
                     }
@@ -329,7 +334,7 @@ class FastifyWebServer {
                             // The socket disconnected so notify any processors
                             for (const socketRouteProcessor of socketRouteProcessors) {
                                 if (socketRouteProcessor.disconnected) {
-                                    await socketRouteProcessor.disconnected(socketServerRequest, socketRoute);
+                                    await socketRouteProcessor.disconnected(socketServerRequest, socketRoute, this._loggingComponentType);
                                 }
                             }
                         }
@@ -388,17 +393,17 @@ class FastifyWebServer {
         try {
             for (const routeProcessor of restRouteProcessors) {
                 if (routeProcessor.pre) {
-                    await routeProcessor.pre(httpServerRequest, httpResponse, restRoute, httpRequestIdentity, processorState);
+                    await routeProcessor.pre(httpServerRequest, httpResponse, restRoute, httpRequestIdentity, processorState, this._loggingComponentType);
                 }
             }
             for (const routeProcessor of restRouteProcessors) {
                 if (routeProcessor.process) {
-                    await routeProcessor.process(httpServerRequest, httpResponse, restRoute, httpRequestIdentity, processorState);
+                    await routeProcessor.process(httpServerRequest, httpResponse, restRoute, httpRequestIdentity, processorState, this._loggingComponentType);
                 }
             }
             for (const routeProcessor of restRouteProcessors) {
                 if (routeProcessor.post) {
-                    await routeProcessor.post(httpServerRequest, httpResponse, restRoute, httpRequestIdentity, processorState);
+                    await routeProcessor.post(httpServerRequest, httpResponse, restRoute, httpRequestIdentity, processorState, this._loggingComponentType);
                 }
             }
         }
@@ -455,12 +460,12 @@ class FastifyWebServer {
                 // The post processors are called after the response has been emitted
                 for (const postSocketRouteProcessor of socketRouteProcessors) {
                     if (postSocketRouteProcessor.post) {
-                        await postSocketRouteProcessor.post(socketServerRequest, response, socketRoute, httpRequestIdentity, responseProcessorState);
+                        await postSocketRouteProcessor.post(socketServerRequest, response, socketRoute, httpRequestIdentity, responseProcessorState, this._loggingComponentType);
                     }
                 }
             }
             catch (err) {
-                this._loggingConnector?.log({
+                this._loggingComponent?.log({
                     level: "error",
                     ts: Date.now(),
                     source: this.CLASS_NAME,
@@ -475,7 +480,7 @@ class FastifyWebServer {
         try {
             for (const socketRouteProcessor of socketRouteProcessors) {
                 if (socketRouteProcessor.pre) {
-                    await socketRouteProcessor.pre(socketServerRequest, httpResponse, socketRoute, httpRequestIdentity, processorState);
+                    await socketRouteProcessor.pre(socketServerRequest, httpResponse, socketRoute, httpRequestIdentity, processorState, this._loggingComponentType);
                 }
             }
             // We always call all the processors regardless of any response set by a previous processor.
@@ -488,7 +493,7 @@ class FastifyWebServer {
                 if (socketRouteProcessor.process) {
                     await socketRouteProcessor.process(socketServerRequest, httpResponse, socketRoute, httpRequestIdentity, processorState, async (topic, processResponse) => {
                         await postProcessEmit(topic, processResponse, processorState);
-                    });
+                    }, this._loggingComponentType);
                 }
             }
             // If the processors set the status to any kind of error then we should emit this manually

package/dist/esm/index.mjs

@@ -2,8 +2,7 @@ import FastifyCompress from '@fastify/compress';
 import FastifyCors from '@fastify/cors';
 import { HttpErrorHelper } from '@twin.org/api-models';
 import { JsonLdMimeTypeProcessor } from '@twin.org/api-processors';
-import { StringHelper, Is, GeneralError, BaseError } from '@twin.org/core';
-import { LoggingConnectorFactory } from '@twin.org/logging-models';
+import { StringHelper, ComponentFactory, Is, GeneralError, BaseError } from '@twin.org/core';
 import { HttpStatusCode, HttpMethod, HeaderTypes } from '@twin.org/web';
 import Fastify from 'fastify';
 import fp from 'fastify-plugin';
@@ -46,10 +45,15 @@ class FastifyWebServer {
      */
     CLASS_NAME = "FastifyWebServer";
     /**
-     * The logging connector.
+     * The logging component type.
      * @internal
      */
-    _loggingConnector;
+    _loggingComponentType;
+    /**
+     * The logging component.
+     * @internal
+     */
+    _loggingComponent;
     /**
      * The options for the server.
      * @internal
@@ -85,8 +89,9 @@ class FastifyWebServer {
      * @param options The options for the server.
      */
     constructor(options) {
-        this._loggingConnector = Is.stringValue(options?.loggingConnectorType)
-            ? LoggingConnectorFactory.get(options.loggingConnectorType)
+        this._loggingComponentType = options?.loggingComponentType;
+        this._loggingComponent = Is.stringValue(options?.loggingComponentType)
+            ? ComponentFactory.get(options.loggingComponentType)
             : undefined;
         this._fastify = Fastify({
             maxParamLength: 2000,
@@ -127,7 +132,7 @@ class FastifyWebServer {
         if (Is.arrayValue(socketRoutes) && !Is.arrayValue(socketRouteProcessors)) {
             throw new GeneralError(this.CLASS_NAME, "noSocketProcessors");
         }
-        await this._loggingConnector?.log({
+        await this._loggingComponent?.log({
             level: "info",
             ts: Date.now(),
             source: this.CLASS_NAME,
@@ -172,7 +177,7 @@ class FastifyWebServer {
                 err = errorAndCode.error;
                 httpStatusCode = errorAndCode.httpStatusCode;
             }
-            await this._loggingConnector?.log({
+            await this._loggingComponent?.log({
                 level: "error",
                 ts: Date.now(),
                 source: this.CLASS_NAME,
@@ -193,7 +198,7 @@ class FastifyWebServer {
     async start() {
         const host = this._options?.host ?? FastifyWebServer._DEFAULT_HOST;
         const port = this._options?.port ?? FastifyWebServer._DEFAULT_PORT;
-        await this._loggingConnector?.log({
+        await this._loggingComponent?.log({
             level: "info",
             ts: Date.now(),
             source: this.CLASS_NAME,
@@ -208,7 +213,7 @@ class FastifyWebServer {
                 await this._fastify.listen({ port, host });
                 const addresses = this._fastify.addresses();
                 const protocol = Is.object(this._fastify.initialConfig.https) ? "https://" : "http://";
-                await this._loggingConnector?.log({
+                await this._loggingComponent?.log({
                     level: "info",
                     ts: Date.now(),
                     source: this.CLASS_NAME,
@@ -222,7 +227,7 @@ class FastifyWebServer {
                 this._started = true;
             }
             catch (err) {
-                await this._loggingConnector?.log({
+                await this._loggingComponent?.log({
                     level: "error",
                     ts: Date.now(),
                     source: this.CLASS_NAME,
@@ -240,7 +245,7 @@ class FastifyWebServer {
         if (this._started) {
             this._started = false;
             await this._fastify.close();
-            await this._loggingConnector?.log({
+            await this._loggingComponent?.log({
                 level: "info",
                 ts: Date.now(),
                 source: this.CLASS_NAME,
@@ -261,7 +266,7 @@ class FastifyWebServer {
                 if (!path.startsWith("/")) {
                     path = `/${path}`;
                 }
-                await this._loggingConnector?.log({
+                await this._loggingComponent?.log({
                     level: "info",
                     ts: Date.now(),
                     source: this.CLASS_NAME,
@@ -288,7 +293,7 @@ class FastifyWebServer {
                 const pathParts = path.split("/");
                 const namespace = `/${pathParts[0]}`;
                 const topic = pathParts.slice(1).join("/");
-                await this._loggingConnector?.log({
+                await this._loggingComponent?.log({
                     level: "info",
                     ts: Date.now(),
                     source: this.CLASS_NAME,
@@ -312,7 +317,7 @@ class FastifyWebServer {
                     try {
                         for (const socketRouteProcessor of socketRouteProcessors) {
                             if (socketRouteProcessor.connected) {
-                                await socketRouteProcessor.connected(socketServerRequest, socketRoute);
+                                await socketRouteProcessor.connected(socketServerRequest, socketRoute, this._loggingComponentType);
                             }
                         }
                     }
@@ -327,7 +332,7 @@ class FastifyWebServer {
                             // The socket disconnected so notify any processors
                             for (const socketRouteProcessor of socketRouteProcessors) {
                                 if (socketRouteProcessor.disconnected) {
-                                    await socketRouteProcessor.disconnected(socketServerRequest, socketRoute);
+                                    await socketRouteProcessor.disconnected(socketServerRequest, socketRoute, this._loggingComponentType);
                                 }
                             }
                         }
@@ -386,17 +391,17 @@ class FastifyWebServer {
         try {
             for (const routeProcessor of restRouteProcessors) {
                 if (routeProcessor.pre) {
-                    await routeProcessor.pre(httpServerRequest, httpResponse, restRoute, httpRequestIdentity, processorState);
+                    await routeProcessor.pre(httpServerRequest, httpResponse, restRoute, httpRequestIdentity, processorState, this._loggingComponentType);
                 }
             }
             for (const routeProcessor of restRouteProcessors) {
                 if (routeProcessor.process) {
-                    await routeProcessor.process(httpServerRequest, httpResponse, restRoute, httpRequestIdentity, processorState);
+                    await routeProcessor.process(httpServerRequest, httpResponse, restRoute, httpRequestIdentity, processorState, this._loggingComponentType);
                 }
             }
             for (const routeProcessor of restRouteProcessors) {
                 if (routeProcessor.post) {
-                    await routeProcessor.post(httpServerRequest, httpResponse, restRoute, httpRequestIdentity, processorState);
+                    await routeProcessor.post(httpServerRequest, httpResponse, restRoute, httpRequestIdentity, processorState, this._loggingComponentType);
                 }
             }
         }
@@ -453,12 +458,12 @@ class FastifyWebServer {
                 // The post processors are called after the response has been emitted
                 for (const postSocketRouteProcessor of socketRouteProcessors) {
                     if (postSocketRouteProcessor.post) {
-                        await postSocketRouteProcessor.post(socketServerRequest, response, socketRoute, httpRequestIdentity, responseProcessorState);
+                        await postSocketRouteProcessor.post(socketServerRequest, response, socketRoute, httpRequestIdentity, responseProcessorState, this._loggingComponentType);
                     }
                 }
             }
             catch (err) {
-                this._loggingConnector?.log({
+                this._loggingComponent?.log({
                     level: "error",
                     ts: Date.now(),
                     source: this.CLASS_NAME,
@@ -473,7 +478,7 @@ class FastifyWebServer {
         try {
             for (const socketRouteProcessor of socketRouteProcessors) {
                 if (socketRouteProcessor.pre) {
-                    await socketRouteProcessor.pre(socketServerRequest, httpResponse, socketRoute, httpRequestIdentity, processorState);
+                    await socketRouteProcessor.pre(socketServerRequest, httpResponse, socketRoute, httpRequestIdentity, processorState, this._loggingComponentType);
                 }
             }
             // We always call all the processors regardless of any response set by a previous processor.
@@ -486,7 +491,7 @@ class FastifyWebServer {
                 if (socketRouteProcessor.process) {
                     await socketRouteProcessor.process(socketServerRequest, httpResponse, socketRoute, httpRequestIdentity, processorState, async (topic, processResponse) => {
                         await postProcessEmit(topic, processResponse, processorState);
-                    });
+                    }, this._loggingComponentType);
                 }
             }
             // If the processors set the status to any kind of error then we should emit this manually

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

@@ -5,9 +5,9 @@ import type { IFastifyWebServerConfig } from "./IFastifyWebServerConfig";
  */
 export interface IFastifyWebServerConstructorOptions {
     /**
-     * The type of the logging connector to use, if undefined, no logging will happen.
+     * The type of the logging component to use, if undefined, no logging will happen.
      */
-    loggingConnectorType?: string;
+    loggingComponentType?: string;
     /**
      * Additional configuration for the server.
      */

package/docs/changelog.md

@@ -1,5 +1,42 @@
 # @twin.org/api-server-fastify - Changelog
 
+## [0.0.2-next.5](https://github.com/twinfoundation/api/compare/api-server-fastify-v0.0.2-next.4...api-server-fastify-v0.0.2-next.5) (2025-07-25)
+
+
+### Features
+
+* add json-ld mime type processor and auth admin component ([8861791](https://github.com/twinfoundation/api/commit/88617916e23bfbca023dbae1976fe421983a02ff))
+* add logging component type to request contexts ([210de1b](https://github.com/twinfoundation/api/commit/210de1b9e1c91079b59a2b90ddd57569668d647d))
+* add socket id, connect and disconnect ([20b0d0e](https://github.com/twinfoundation/api/commit/20b0d0ec279cab46141fee09de2c4a7087cdce16))
+* improve socket route logging ([b8d9519](https://github.com/twinfoundation/api/commit/b8d95199f838ac6ba9f45c30ef7c4e613201ff53))
+* update dependencies ([1171dc4](https://github.com/twinfoundation/api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
+* use shared store mechanism ([#19](https://github.com/twinfoundation/api/issues/19)) ([32116df](https://github.com/twinfoundation/api/commit/32116df3b4380a30137f5056f242a5c99afa2df9))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-core bumped from 0.0.2-next.4 to 0.0.2-next.5
+    * @twin.org/api-models bumped from 0.0.2-next.4 to 0.0.2-next.5
+    * @twin.org/api-processors bumped from 0.0.2-next.4 to 0.0.2-next.5
+
+## [0.0.2-next.4](https://github.com/twinfoundation/api/compare/api-server-fastify-v0.0.2-next.3...api-server-fastify-v0.0.2-next.4) (2025-07-25)
+
+
+### Features
+
+* add logging component type to request contexts ([210de1b](https://github.com/twinfoundation/api/commit/210de1b9e1c91079b59a2b90ddd57569668d647d))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-core bumped from 0.0.2-next.3 to 0.0.2-next.4
+    * @twin.org/api-models bumped from 0.0.2-next.3 to 0.0.2-next.4
+    * @twin.org/api-processors bumped from 0.0.2-next.3 to 0.0.2-next.4
+
 ## [0.0.2-next.3](https://github.com/twinfoundation/api/compare/api-server-fastify-v0.0.2-next.2...api-server-fastify-v0.0.2-next.3) (2025-07-24)
 
 

package/docs/reference/interfaces/IFastifyWebServerConstructorOptions.md

@@ -4,11 +4,11 @@ The options for the Fastify web server constructor.
 
 ## Properties
 
-### loggingConnectorType?
+### loggingComponentType?
 
-> `optional` **loggingConnectorType**: `string`
+> `optional` **loggingComponentType**: `string`
 
-The type of the logging connector to use, if undefined, no logging will happen.
+The type of the logging component to use, if undefined, no logging will happen.
 
 ***
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/api-server-fastify",
-	"version": "0.0.2-next.3",
+	"version": "0.0.2-next.5",
 	"description": "Use Fastify as the core web server for APIs",
 	"repository": {
 		"type": "git",
@@ -16,9 +16,9 @@
 	"dependencies": {
 		"@fastify/compress": "8.1.0",
 		"@fastify/cors": "11.0.1",
-		"@twin.org/api-core": "0.0.2-next.3",
-		"@twin.org/api-models": "0.0.2-next.3",
-		"@twin.org/api-processors": "0.0.2-next.3",
+		"@twin.org/api-core": "0.0.2-next.5",
+		"@twin.org/api-models": "0.0.2-next.5",
+		"@twin.org/api-processors": "0.0.2-next.5",
 		"@twin.org/core": "next",
 		"@twin.org/logging-models": "next",
 		"@twin.org/nameof": "next",