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

package/dist/cjs/index.cjs

@@ -84,9 +84,6 @@ class FastifyWebServer {
     /**
      * Create a new instance of FastifyWebServer.
      * @param options The options for the server.
-     * @param options.loggingConnectorType The type of the logging connector to use, if undefined, no logging will happen.
-     * @param options.mimeTypeProcessors Additional MIME type processors.
-     * @param options.config Additional configuration for the server.
      */
     constructor(options) {
         this._loggingConnector = core.Is.stringValue(options?.loggingConnectorType)

package/dist/esm/index.mjs

@@ -82,9 +82,6 @@ class FastifyWebServer {
     /**
      * Create a new instance of FastifyWebServer.
      * @param options The options for the server.
-     * @param options.loggingConnectorType The type of the logging connector to use, if undefined, no logging will happen.
-     * @param options.mimeTypeProcessors Additional MIME type processors.
-     * @param options.config Additional configuration for the server.
      */
     constructor(options) {
         this._loggingConnector = Is.stringValue(options?.loggingConnectorType)

package/dist/types/fastifyWebServer.d.ts

@@ -1,6 +1,6 @@
-import { type IMimeTypeProcessor, type IRestRoute, type IRestRouteProcessor, type ISocketRoute, type ISocketRouteProcessor, type IWebServer, type IWebServerOptions } from "@twin.org/api-models";
+import { type IRestRoute, type IRestRouteProcessor, type ISocketRoute, type ISocketRouteProcessor, type IWebServer, type IWebServerOptions } from "@twin.org/api-models";
 import { type FastifyInstance } from "fastify";
-import type { IFastifyWebServerConfig } from "./models/IFastifyWebServerConfig";
+import type { IFastifyWebServerConstructorOptions } from "./models/IFastifyWebServerConstructorOptions";
 /**
  * Implementation of the web server using Fastify.
  */
@@ -12,15 +12,8 @@ export declare class FastifyWebServer implements IWebServer<FastifyInstance> {
     /**
      * Create a new instance of FastifyWebServer.
      * @param options The options for the server.
-     * @param options.loggingConnectorType The type of the logging connector to use, if undefined, no logging will happen.
-     * @param options.mimeTypeProcessors Additional MIME type processors.
-     * @param options.config Additional configuration for the server.
      */
-    constructor(options?: {
-        loggingConnectorType?: string;
-        config?: IFastifyWebServerConfig;
-        mimeTypeProcessors?: IMimeTypeProcessor[];
-    });
+    constructor(options?: IFastifyWebServerConstructorOptions);
     /**
      * Get the web server instance.
      * @returns The web server instance.

package/dist/types/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./fastifyWebServer";
 export * from "./models/IFastifyWebServerConfig";
+export * from "./models/IFastifyWebServerConstructorOptions";

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

@@ -0,0 +1,19 @@
+import type { IMimeTypeProcessor } from "@twin.org/api-models";
+import type { IFastifyWebServerConfig } from "./IFastifyWebServerConfig";
+/**
+ * The options for the Fastify web server constructor.
+ */
+export interface IFastifyWebServerConstructorOptions {
+    /**
+     * The type of the logging connector to use, if undefined, no logging will happen.
+     */
+    loggingConnectorType?: string;
+    /**
+     * Additional configuration for the server.
+     */
+    config?: IFastifyWebServerConfig;
+    /**
+     * Additional MIME type processors.
+     */
+    mimeTypeProcessors?: IMimeTypeProcessor[];
+}

package/docs/changelog.md

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

package/docs/reference/classes/FastifyWebServer.md

@@ -16,21 +16,11 @@ Create a new instance of FastifyWebServer.
 
 #### Parameters
 
-• **options?**
+##### options?
 
-The options for the server.
-
-• **options.loggingConnectorType?**: `string`
-
-The type of the logging connector to use, if undefined, no logging will happen.
-
-• **options.config?**: [`IFastifyWebServerConfig`](../interfaces/IFastifyWebServerConfig.md)
-
-Additional configuration for the server.
-
-• **options.mimeTypeProcessors?**: `IMimeTypeProcessor`[]
+[`IFastifyWebServerConstructorOptions`](../interfaces/IFastifyWebServerConstructorOptions.md)
 
-Additional MIME type processors.
+The options for the server.
 
 #### Returns
 
@@ -48,13 +38,13 @@ Runtime name for the class.
 
 ### getInstance()
 
-> **getInstance**(): `FastifyInstance`\<`RawServerDefault`, `IncomingMessage`, `ServerResponse`\<`IncomingMessage`\>, `FastifyBaseLogger`, `FastifyTypeProviderDefault`\>
+> **getInstance**(): `FastifyInstance`\<`IncomingMessage`, `ServerResponse`\>
 
 Get the web server instance.
 
 #### Returns
 
-`FastifyInstance`\<`RawServerDefault`, `IncomingMessage`, `ServerResponse`\<`IncomingMessage`\>, `FastifyBaseLogger`, `FastifyTypeProviderDefault`\>
+`FastifyInstance`\<`IncomingMessage`, `ServerResponse`\>
 
 The web server instance.
 
@@ -72,23 +62,33 @@ Build the server.
 
 #### Parameters
 
-• **restRouteProcessors?**: `IRestRouteProcessor`[]
+##### restRouteProcessors?
+
+`IRestRouteProcessor`[]
 
 The processors for incoming requests over REST.
 
-• **restRoutes?**: `IRestRoute`\<`any`, `any`\>[]
+##### restRoutes?
+
+`IRestRoute`[]
 
 The REST routes.
 
-• **socketRouteProcessors?**: `ISocketRouteProcessor`[]
+##### socketRouteProcessors?
+
+`ISocketRouteProcessor`[]
 
 The processors for incoming requests over Sockets.
 
-• **socketRoutes?**: `ISocketRoute`\<`any`, `any`\>[]
+##### socketRoutes?
+
+`ISocketRoute`[]
 
 The socket routes.
 
-• **options?**: `IWebServerOptions`
+##### options?
+
+`IWebServerOptions`
 
 Options for building the server.
 

package/docs/reference/index.md

@@ -7,3 +7,4 @@
 ## Interfaces
 
 - [IFastifyWebServerConfig](interfaces/IFastifyWebServerConfig.md)
+- [IFastifyWebServerConstructorOptions](interfaces/IFastifyWebServerConstructorOptions.md)

package/docs/reference/interfaces/IFastifyWebServerConstructorOptions.md

@@ -0,0 +1,27 @@
+# Interface: IFastifyWebServerConstructorOptions
+
+The options for the Fastify web server constructor.
+
+## Properties
+
+### loggingConnectorType?
+
+> `optional` **loggingConnectorType**: `string`
+
+The type of the logging connector to use, if undefined, no logging will happen.
+
+***
+
+### config?
+
+> `optional` **config**: [`IFastifyWebServerConfig`](IFastifyWebServerConfig.md)
+
+Additional configuration for the server.
+
+***
+
+### mimeTypeProcessors?
+
+> `optional` **mimeTypeProcessors**: `IMimeTypeProcessor`[]
+
+Additional MIME type processors.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/api-server-fastify",
-	"version": "0.0.1-next.25",
+	"version": "0.0.1-next.26",
 	"description": "Use Fastify as the core web server for APIs",
 	"repository": {
 		"type": "git",
@@ -15,14 +15,14 @@
 	},
 	"dependencies": {
 		"@fastify/compress": "8.0.1",
-		"@fastify/cors": "10.0.1",
-		"@twin.org/api-core": "0.0.1-next.25",
-		"@twin.org/api-models": "0.0.1-next.25",
+		"@fastify/cors": "10.0.2",
+		"@twin.org/api-core": "0.0.1-next.26",
+		"@twin.org/api-models": "0.0.1-next.26",
 		"@twin.org/core": "next",
 		"@twin.org/logging-models": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next",
-		"fastify": "5.1.0",
+		"fastify": "5.2.1",
 		"socket.io": "4.8.1"
 	},
 	"main": "./dist/cjs/index.cjs",