@twin.org/api-service 0.0.2-next.7 → 0.0.2-next.9

package/dist/cjs/index.cjs

@@ -22,17 +22,26 @@ const tagsInformation = [
 function generateRestRoutesInformation(baseRouteName, componentName) {
     const rootRoute = {
         operationId: "serverRoot",
-        summary: "Get the root blank page",
+        summary: "Get the root text page",
         tag: tagsInformation[0].name,
         method: "GET",
         path: `${baseRouteName}/`,
-        handler: async () => ({}),
+        handler: async (httpRequestContext, request) => serverRoot(httpRequestContext, componentName),
         responseType: [
             {
-                type: "INoContentResponse"
+                type: "IServerRootResponse",
+                mimeType: web.MimeTypes.PlainText,
+                examples: [
+                    {
+                        id: "serverRootResponse",
+                        description: "The response for the root request.",
+                        response: {
+                            body: "API Server - 1.0.0"
+                        }
+                    }
+                ]
             }
         ],
-        excludeFromSpec: true,
         skipAuth: true
     };
     const informationRoute = {
@@ -61,6 +70,21 @@ function generateRestRoutesInformation(baseRouteName, componentName) {
         ],
         skipAuth: true
     };
+    const favIconRoute = {
+        operationId: "serverFavIcon",
+        summary: "Get the favicon for the server",
+        tag: tagsInformation[0].name,
+        method: "GET",
+        path: `${baseRouteName}/favicon.ico`,
+        handler: async (httpRequestContext, request) => serverFavIcon(httpRequestContext, componentName),
+        responseType: [
+            {
+                type: "IServerFavIconResponse",
+                mimeType: "image/x-icon"
+            }
+        ],
+        skipAuth: true
+    };
     const healthRoute = {
         operationId: "serverHealth",
         summary: "Get the health for the server",
@@ -163,7 +187,20 @@ function generateRestRoutesInformation(baseRouteName, componentName) {
         ],
         skipAuth: true
     };
-    return [rootRoute, informationRoute, healthRoute, specRoute];
+    return [rootRoute, favIconRoute, informationRoute, healthRoute, specRoute];
+}
+/**
+ * Get the root for the server.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+async function serverRoot(httpRequestContext, componentName, request) {
+    const component = core.ComponentFactory.get(componentName);
+    return {
+        body: await component.root()
+    };
 }
 /**
  * Get the information for the server.
@@ -191,6 +228,28 @@ async function serverHealth(httpRequestContext, componentName, request) {
         body: await component.health()
     };
 }
+/**
+ * Get the favicon for the server.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+async function serverFavIcon(httpRequestContext, componentName, request) {
+    const component = core.ComponentFactory.get(componentName);
+    const favIcon = await component.favicon();
+    if (core.Is.uint8Array(favIcon)) {
+        return {
+            headers: {
+                [web.HeaderTypes.ContentType]: "image/x-icon"
+            },
+            body: favIcon
+        };
+    }
+    return {
+        statusCode: web.HttpStatusCode.notFound
+    };
+}
 /**
  * Get the spec for the server.
  * @param httpRequestContext The request context for the API.
@@ -231,6 +290,16 @@ class InformationService {
      * @internal
      */
     _healthInfo;
+    /**
+     * The path to the favicon Spec.
+     * @internal
+     */
+    _faviconPath;
+    /**
+     * The favicon.
+     * @internal
+     */
+    _favicon;
     /**
      * The path to the OpenAPI Spec.
      * @internal
@@ -253,6 +322,7 @@ class InformationService {
         this._healthInfo = {
             status: "ok"
         };
+        this._faviconPath = options.config.favIconPath;
         this._openApiSpecPath = options.config.openApiSpecPath;
     }
     /**
@@ -260,11 +330,22 @@ class InformationService {
      * @returns Nothing.
      */
     async start() {
-        const filename = this._openApiSpecPath;
-        if (core.Is.stringValue(filename)) {
-            const contentBuffer = await promises.readFile(filename, "utf8");
+        const openApiPath = this._openApiSpecPath;
+        if (core.Is.stringValue(openApiPath)) {
+            const contentBuffer = await promises.readFile(openApiPath, "utf8");
             this._openApiSpec = JSON.parse(contentBuffer);
         }
+        const favIconPath = this._faviconPath;
+        if (core.Is.stringValue(favIconPath)) {
+            this._favicon = await promises.readFile(favIconPath);
+        }
+    }
+    /**
+     * Get the root information.
+     * @returns The root information.
+     */
+    async root() {
+        return `${this._serverInfo.name} - ${this._serverInfo.version}`;
     }
     /**
      * Get the server information.
@@ -273,6 +354,13 @@ class InformationService {
     async info() {
         return this._serverInfo;
     }
+    /**
+     * Get the favicon.
+     * @returns The favicon.
+     */
+    async favicon() {
+        return this._favicon;
+    }
     /**
      * Get the OpenAPI spec.
      * @returns The OpenAPI spec.
@@ -351,7 +439,9 @@ const restEntryPoints = [
 exports.InformationService = InformationService;
 exports.generateRestRoutesInformation = generateRestRoutesInformation;
 exports.restEntryPoints = restEntryPoints;
+exports.serverFavIcon = serverFavIcon;
 exports.serverHealth = serverHealth;
 exports.serverInfo = serverInfo;
+exports.serverRoot = serverRoot;
 exports.serverSpec = serverSpec;
 exports.tagsInformation = tagsInformation;

package/dist/esm/index.mjs

@@ -1,5 +1,5 @@
 import { ComponentFactory, Is, Guards } from '@twin.org/core';
-import { HttpStatusCode } from '@twin.org/web';
+import { MimeTypes, HeaderTypes, HttpStatusCode } from '@twin.org/web';
 import { readFile } from 'node:fs/promises';
 
 /**
@@ -20,17 +20,26 @@ const tagsInformation = [
 function generateRestRoutesInformation(baseRouteName, componentName) {
     const rootRoute = {
         operationId: "serverRoot",
-        summary: "Get the root blank page",
+        summary: "Get the root text page",
         tag: tagsInformation[0].name,
         method: "GET",
         path: `${baseRouteName}/`,
-        handler: async () => ({}),
+        handler: async (httpRequestContext, request) => serverRoot(httpRequestContext, componentName),
         responseType: [
             {
-                type: "INoContentResponse"
+                type: "IServerRootResponse",
+                mimeType: MimeTypes.PlainText,
+                examples: [
+                    {
+                        id: "serverRootResponse",
+                        description: "The response for the root request.",
+                        response: {
+                            body: "API Server - 1.0.0"
+                        }
+                    }
+                ]
             }
         ],
-        excludeFromSpec: true,
         skipAuth: true
     };
     const informationRoute = {
@@ -59,6 +68,21 @@ function generateRestRoutesInformation(baseRouteName, componentName) {
         ],
         skipAuth: true
     };
+    const favIconRoute = {
+        operationId: "serverFavIcon",
+        summary: "Get the favicon for the server",
+        tag: tagsInformation[0].name,
+        method: "GET",
+        path: `${baseRouteName}/favicon.ico`,
+        handler: async (httpRequestContext, request) => serverFavIcon(httpRequestContext, componentName),
+        responseType: [
+            {
+                type: "IServerFavIconResponse",
+                mimeType: "image/x-icon"
+            }
+        ],
+        skipAuth: true
+    };
     const healthRoute = {
         operationId: "serverHealth",
         summary: "Get the health for the server",
@@ -161,7 +185,20 @@ function generateRestRoutesInformation(baseRouteName, componentName) {
         ],
         skipAuth: true
     };
-    return [rootRoute, informationRoute, healthRoute, specRoute];
+    return [rootRoute, favIconRoute, informationRoute, healthRoute, specRoute];
+}
+/**
+ * Get the root for the server.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+async function serverRoot(httpRequestContext, componentName, request) {
+    const component = ComponentFactory.get(componentName);
+    return {
+        body: await component.root()
+    };
 }
 /**
  * Get the information for the server.
@@ -189,6 +226,28 @@ async function serverHealth(httpRequestContext, componentName, request) {
         body: await component.health()
     };
 }
+/**
+ * Get the favicon for the server.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+async function serverFavIcon(httpRequestContext, componentName, request) {
+    const component = ComponentFactory.get(componentName);
+    const favIcon = await component.favicon();
+    if (Is.uint8Array(favIcon)) {
+        return {
+            headers: {
+                [HeaderTypes.ContentType]: "image/x-icon"
+            },
+            body: favIcon
+        };
+    }
+    return {
+        statusCode: HttpStatusCode.notFound
+    };
+}
 /**
  * Get the spec for the server.
  * @param httpRequestContext The request context for the API.
@@ -229,6 +288,16 @@ class InformationService {
      * @internal
      */
     _healthInfo;
+    /**
+     * The path to the favicon Spec.
+     * @internal
+     */
+    _faviconPath;
+    /**
+     * The favicon.
+     * @internal
+     */
+    _favicon;
     /**
      * The path to the OpenAPI Spec.
      * @internal
@@ -251,6 +320,7 @@ class InformationService {
         this._healthInfo = {
             status: "ok"
         };
+        this._faviconPath = options.config.favIconPath;
         this._openApiSpecPath = options.config.openApiSpecPath;
     }
     /**
@@ -258,11 +328,22 @@ class InformationService {
      * @returns Nothing.
      */
     async start() {
-        const filename = this._openApiSpecPath;
-        if (Is.stringValue(filename)) {
-            const contentBuffer = await readFile(filename, "utf8");
+        const openApiPath = this._openApiSpecPath;
+        if (Is.stringValue(openApiPath)) {
+            const contentBuffer = await readFile(openApiPath, "utf8");
             this._openApiSpec = JSON.parse(contentBuffer);
         }
+        const favIconPath = this._faviconPath;
+        if (Is.stringValue(favIconPath)) {
+            this._favicon = await readFile(favIconPath);
+        }
+    }
+    /**
+     * Get the root information.
+     * @returns The root information.
+     */
+    async root() {
+        return `${this._serverInfo.name} - ${this._serverInfo.version}`;
     }
     /**
      * Get the server information.
@@ -271,6 +352,13 @@ class InformationService {
     async info() {
         return this._serverInfo;
     }
+    /**
+     * Get the favicon.
+     * @returns The favicon.
+     */
+    async favicon() {
+        return this._favicon;
+    }
     /**
      * Get the OpenAPI spec.
      * @returns The OpenAPI spec.
@@ -346,4 +434,4 @@ const restEntryPoints = [
     }
 ];
 
-export { InformationService, generateRestRoutesInformation, restEntryPoints, serverHealth, serverInfo, serverSpec, tagsInformation };
+export { InformationService, generateRestRoutesInformation, restEntryPoints, serverFavIcon, serverHealth, serverInfo, serverRoot, serverSpec, tagsInformation };

package/dist/types/informationRoutes.d.ts

@@ -1,4 +1,4 @@
-import type { IHttpRequestContext, INoContentRequest, IRestRoute, IServerHealthResponse, IServerInfoResponse, IServerSpecResponse, ITag } from "@twin.org/api-models";
+import type { IHttpRequestContext, INoContentRequest, IRestRoute, IServerFavIconResponse, IServerHealthResponse, IServerInfoResponse, IServerRootResponse, IServerSpecResponse, ITag } from "@twin.org/api-models";
 /**
  * The tag to associate with the routes.
  */
@@ -10,6 +10,14 @@ export declare const tagsInformation: ITag[];
  * @returns The generated routes.
  */
 export declare function generateRestRoutesInformation(baseRouteName: string, componentName: string): IRestRoute[];
+/**
+ * Get the root for the server.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function serverRoot(httpRequestContext: IHttpRequestContext, componentName: string, request: INoContentRequest): Promise<IServerRootResponse>;
 /**
  * Get the information for the server.
  * @param httpRequestContext The request context for the API.
@@ -26,6 +34,14 @@ export declare function serverInfo(httpRequestContext: IHttpRequestContext, comp
  * @returns The response object with additional http response properties.
  */
 export declare function serverHealth(httpRequestContext: IHttpRequestContext, componentName: string, request: INoContentRequest): Promise<IServerHealthResponse>;
+/**
+ * Get the favicon for the server.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function serverFavIcon(httpRequestContext: IHttpRequestContext, componentName: string, request: INoContentRequest): Promise<IServerFavIconResponse>;
 /**
  * Get the spec for the server.
  * @param httpRequestContext The request context for the API.

package/dist/types/informationService.d.ts

@@ -18,11 +18,21 @@ export declare class InformationService implements IInformationComponent {
      * @returns Nothing.
      */
     start(): Promise<void>;
+    /**
+     * Get the root information.
+     * @returns The root information.
+     */
+    root(): Promise<string>;
     /**
      * Get the server information.
      * @returns The service information.
      */
     info(): Promise<IServerInfo>;
+    /**
+     * Get the favicon.
+     * @returns The favicon.
+     */
+    favicon(): Promise<Uint8Array | undefined>;
     /**
      * Get the OpenAPI spec.
      * @returns The OpenAPI spec.

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

@@ -11,4 +11,8 @@ export interface IInformationServiceConfig {
      * The path to the OpenAPI Spec.
      */
     openApiSpecPath?: string;
+    /**
+     * The path to the favicon.
+     */
+    favIconPath?: string;
 }

package/docs/changelog.md

@@ -1,5 +1,33 @@
 # @twin.org/api-service - Changelog
 
+## [0.0.2-next.9](https://github.com/twinfoundation/api/compare/api-service-v0.0.2-next.8...api-service-v0.0.2-next.9) (2025-08-29)
+
+
+### Features
+
+* eslint migration to flat config ([0dd5820](https://github.com/twinfoundation/api/commit/0dd5820e3af97350fd08b8d226f4a6c1a9246805))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.2-next.8 to 0.0.2-next.9
+
+## [0.0.2-next.8](https://github.com/twinfoundation/api/compare/api-service-v0.0.2-next.7...api-service-v0.0.2-next.8) (2025-08-21)
+
+
+### Features
+
+* add root, favicon routes ([71da1c3](https://github.com/twinfoundation/api/commit/71da1c3a93c349588aff7084d1d8d6a29a277da8))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.2-next.7 to 0.0.2-next.8
+
 ## [0.0.2-next.7](https://github.com/twinfoundation/api/compare/api-service-v0.0.2-next.6...api-service-v0.0.2-next.7) (2025-08-20)
 
 

package/docs/reference/classes/InformationService.md

@@ -58,6 +58,24 @@ Nothing.
 
 ***
 
+### root()
+
+> **root**(): `Promise`\<`string`\>
+
+Get the root information.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The root information.
+
+#### Implementation of
+
+`IInformationComponent.root`
+
+***
+
 ### info()
 
 > **info**(): `Promise`\<`IServerInfo`\>
@@ -76,6 +94,24 @@ The service information.
 
 ***
 
+### favicon()
+
+> **favicon**(): `Promise`\<`undefined` \| `Uint8Array`\<`ArrayBufferLike`\>\>
+
+Get the favicon.
+
+#### Returns
+
+`Promise`\<`undefined` \| `Uint8Array`\<`ArrayBufferLike`\>\>
+
+The favicon.
+
+#### Implementation of
+
+`IInformationComponent.favicon`
+
+***
+
 ### spec()
 
 > **spec**(): `Promise`\<`unknown`\>

package/docs/reference/functions/serverFavIcon.md

@@ -0,0 +1,31 @@
+# Function: serverFavIcon()
+
+> **serverFavIcon**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IServerFavIconResponse`\>
+
+Get the favicon for the server.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`INoContentRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IServerFavIconResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/serverRoot.md

@@ -0,0 +1,31 @@
+# Function: serverRoot()
+
+> **serverRoot**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IServerRootResponse`\>
+
+Get the root for the server.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`INoContentRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IServerRootResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/index.md

@@ -17,6 +17,8 @@
 ## Functions
 
 - [generateRestRoutesInformation](functions/generateRestRoutesInformation.md)
+- [serverRoot](functions/serverRoot.md)
 - [serverInfo](functions/serverInfo.md)
 - [serverHealth](functions/serverHealth.md)
+- [serverFavIcon](functions/serverFavIcon.md)
 - [serverSpec](functions/serverSpec.md)

package/docs/reference/interfaces/IInformationServiceConfig.md

@@ -17,3 +17,11 @@ The server information.
 > `optional` **openApiSpecPath**: `string`
 
 The path to the OpenAPI Spec.
+
+***
+
+### favIconPath?
+
+> `optional` **favIconPath**: `string`
+
+The path to the favicon.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/api-service",
-	"version": "0.0.2-next.7",
+	"version": "0.0.2-next.9",
 	"description": "Information contract implementation and REST endpoint definitions",
 	"repository": {
 		"type": "git",
@@ -14,7 +14,7 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/api-models": "0.0.2-next.7",
+		"@twin.org/api-models": "0.0.2-next.9",
 		"@twin.org/core": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"