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

package/dist/es/index.js

@@ -0,0 +1,8 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./informationRoutes.js";
+export * from "./informationService.js";
+export * from "./models/IInformationServiceConfig.js";
+export * from "./models/IInformationServiceConstructorOptions.js";
+export * from "./restEntryPoints.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,uCAAuC,CAAC;AACtD,cAAc,mDAAmD,CAAC;AAClE,cAAc,sBAAsB,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./informationRoutes.js\";\nexport * from \"./informationService.js\";\nexport * from \"./models/IInformationServiceConfig.js\";\nexport * from \"./models/IInformationServiceConstructorOptions.js\";\nexport * from \"./restEntryPoints.js\";\n"]}

package/dist/{esm/index.mjs → es/informationRoutes.js}

@@ -1,11 +1,9 @@
-import { ComponentFactory, Is, Guards } from '@twin.org/core';
-import { MimeTypes, HeaderTypes, HttpStatusCode } from '@twin.org/web';
-import { readFile } from 'node:fs/promises';
-
+import { ComponentFactory, Is } from "@twin.org/core";
+import { HeaderTypes, HttpStatusCode, MimeTypes } from "@twin.org/web";
 /**
  * The tag to associate with the routes.
  */
-const tagsInformation = [
+export const tagsInformation = [
     {
         name: "Info",
         description: "Information endpoints for the REST server."
@@ -17,14 +15,14 @@ const tagsInformation = [
  * @param componentName The name of the component to use in the routes stored in the ComponentFactory.
  * @returns The generated routes.
  */
-function generateRestRoutesInformation(baseRouteName, componentName) {
+export function generateRestRoutesInformation(baseRouteName, componentName) {
     const rootRoute = {
         operationId: "serverRoot",
         summary: "Get the root text page",
         tag: tagsInformation[0].name,
         method: "GET",
         path: `${baseRouteName}/`,
-        handler: async (httpRequestContext, request) => serverRoot(httpRequestContext, componentName),
+        handler: async (httpRequestContext, request) => serverRoot(httpRequestContext, componentName, request),
         responseType: [
             {
                 type: "IServerRootResponse",
@@ -48,7 +46,7 @@ function generateRestRoutesInformation(baseRouteName, componentName) {
         tag: tagsInformation[0].name,
         method: "GET",
         path: `${baseRouteName}/info`,
-        handler: async (httpRequestContext, request) => serverInfo(httpRequestContext, componentName),
+        handler: async (httpRequestContext, request) => serverInfo(httpRequestContext, componentName, request),
         responseType: [
             {
                 type: "IServerInfoResponse",
@@ -74,7 +72,7 @@ function generateRestRoutesInformation(baseRouteName, componentName) {
         tag: tagsInformation[0].name,
         method: "GET",
         path: `${baseRouteName}/favicon.ico`,
-        handler: async (httpRequestContext, request) => serverFavIcon(httpRequestContext, componentName),
+        handler: async (httpRequestContext, request) => serverFavIcon(httpRequestContext, componentName, request),
         responseType: [
             {
                 type: "IServerFavIconResponse",
@@ -89,7 +87,7 @@ function generateRestRoutesInformation(baseRouteName, componentName) {
         tag: tagsInformation[0].name,
         method: "GET",
         path: `${baseRouteName}/health`,
-        handler: async (httpRequestContext, request) => serverHealth(httpRequestContext, componentName),
+        handler: async (httpRequestContext, request) => serverHealth(httpRequestContext, componentName, request),
         responseType: [
             {
                 type: "IServerHealthResponse",
@@ -164,7 +162,7 @@ function generateRestRoutesInformation(baseRouteName, componentName) {
         tag: tagsInformation[0].name,
         method: "GET",
         path: `${baseRouteName}/spec`,
-        handler: async (httpRequestContext, request) => serverSpec(httpRequestContext, componentName),
+        handler: async (httpRequestContext, request) => serverSpec(httpRequestContext, componentName, request),
         responseType: [
             {
                 type: "IServerSpecResponse",
@@ -194,7 +192,7 @@ function generateRestRoutesInformation(baseRouteName, componentName) {
  * @param request The request.
  * @returns The response object with additional http response properties.
  */
-async function serverRoot(httpRequestContext, componentName, request) {
+export async function serverRoot(httpRequestContext, componentName, request) {
     const component = ComponentFactory.get(componentName);
     return {
         body: await component.root()
@@ -207,7 +205,7 @@ async function serverRoot(httpRequestContext, componentName, request) {
  * @param request The request.
  * @returns The response object with additional http response properties.
  */
-async function serverInfo(httpRequestContext, componentName, request) {
+export async function serverInfo(httpRequestContext, componentName, request) {
     const component = ComponentFactory.get(componentName);
     return {
         body: await component.info()
@@ -220,7 +218,7 @@ async function serverInfo(httpRequestContext, componentName, request) {
  * @param request The request.
  * @returns The response object with additional http response properties.
  */
-async function serverHealth(httpRequestContext, componentName, request) {
+export async function serverHealth(httpRequestContext, componentName, request) {
     const component = ComponentFactory.get(componentName);
     return {
         body: await component.health()
@@ -233,7 +231,7 @@ async function serverHealth(httpRequestContext, componentName, request) {
  * @param request The request.
  * @returns The response object with additional http response properties.
  */
-async function serverFavIcon(httpRequestContext, componentName, request) {
+export async function serverFavIcon(httpRequestContext, componentName, request) {
     const component = ComponentFactory.get(componentName);
     const favIcon = await component.favicon();
     if (Is.uint8Array(favIcon)) {
@@ -255,7 +253,7 @@ async function serverFavIcon(httpRequestContext, componentName, request) {
  * @param request The request.
  * @returns The response object with additional http response properties.
  */
-async function serverSpec(httpRequestContext, componentName, request) {
+export async function serverSpec(httpRequestContext, componentName, request) {
     const component = ComponentFactory.get(componentName);
     const spec = await component.spec();
     if (Is.objectValue(spec)) {
@@ -267,171 +265,4 @@ async function serverSpec(httpRequestContext, componentName, request) {
         statusCode: HttpStatusCode.notFound
     };
 }
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * The information service for the server.
- */
-class InformationService {
-    /**
-     * Runtime name for the class.
-     */
-    CLASS_NAME = "InformationService";
-    /**
-     * The server information.
-     * @internal
-     */
-    _serverInfo;
-    /**
-     * The server health.
-     * @internal
-     */
-    _healthInfo;
-    /**
-     * The path to the favicon Spec.
-     * @internal
-     */
-    _faviconPath;
-    /**
-     * The favicon.
-     * @internal
-     */
-    _favicon;
-    /**
-     * The path to the OpenAPI Spec.
-     * @internal
-     */
-    _openApiSpecPath;
-    /**
-     * The OpenAPI spec.
-     * @internal
-     */
-    _openApiSpec;
-    /**
-     * Create a new instance of InformationService.
-     * @param options The options to create the service.
-     */
-    constructor(options) {
-        Guards.object(this.CLASS_NAME, "options", options);
-        Guards.object(this.CLASS_NAME, "options.config", options.config);
-        Guards.object(this.CLASS_NAME, "options.config.serverInfo", options.config.serverInfo);
-        this._serverInfo = options.config.serverInfo;
-        this._healthInfo = {
-            status: "ok"
-        };
-        this._faviconPath = options.config.favIconPath;
-        this._openApiSpecPath = options.config.openApiSpecPath;
-    }
-    /**
-     * The service needs to be started when the application is initialized.
-     * @returns Nothing.
-     */
-    async start() {
-        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.
-     * @returns The service information.
-     */
-    async info() {
-        return this._serverInfo;
-    }
-    /**
-     * Get the favicon.
-     * @returns The favicon.
-     */
-    async favicon() {
-        return this._favicon;
-    }
-    /**
-     * Get the OpenAPI spec.
-     * @returns The OpenAPI spec.
-     */
-    async spec() {
-        return this._openApiSpec;
-    }
-    /**
-     * Get the server health.
-     * @returns The service health.
-     */
-    async health() {
-        let errorCount = 0;
-        let warningCount = 0;
-        if (Is.arrayValue(this._healthInfo.components)) {
-            errorCount = this._healthInfo.components.filter(c => c.status === "error").length;
-            warningCount = this._healthInfo.components.filter(c => c.status === "warning").length;
-        }
-        if (errorCount > 0) {
-            this._healthInfo.status = "error";
-        }
-        else if (warningCount > 0) {
-            this._healthInfo.status = "warning";
-        }
-        else {
-            this._healthInfo.status = "ok";
-        }
-        return this._healthInfo;
-    }
-    /**
-     * Set the status of a component.
-     * @param name The component name.
-     * @param status The status of the component.
-     * @param details The details for the status.
-     * @returns Nothing.
-     */
-    async setComponentHealth(name, status, details) {
-        const component = this._healthInfo.components?.find(c => c.name === name);
-        if (Is.undefined(component)) {
-            this._healthInfo.components ??= [];
-            this._healthInfo.components.push({
-                name,
-                status,
-                details
-            });
-        }
-        else {
-            component.status = status;
-            component.details = details;
-        }
-    }
-    /**
-     * Remove the status of a component.
-     * @param name The component name.
-     * @returns Nothing.
-     */
-    async removeComponentHealth(name) {
-        if (Is.arrayValue(this._healthInfo.components)) {
-            const componentIndex = this._healthInfo.components.findIndex(c => c.name === name);
-            if (componentIndex !== -1) {
-                this._healthInfo.components.splice(componentIndex, 1);
-            }
-        }
-    }
-}
-
-const restEntryPoints = [
-    {
-        name: "information",
-        defaultBaseRoute: "",
-        tags: tagsInformation,
-        generateRoutes: generateRestRoutesInformation
-    }
-];
-
-export { InformationService, generateRestRoutesInformation, restEntryPoints, serverFavIcon, serverHealth, serverInfo, serverRoot, serverSpec, tagsInformation };
+//# sourceMappingURL=informationRoutes.js.map

package/dist/es/informationRoutes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"informationRoutes.js","sourceRoot":"","sources":["../../src/informationRoutes.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,gBAAgB,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAEtD,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAEvE;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAW;IACtC;QACC,IAAI,EAAE,MAAM;QACZ,WAAW,EAAE,4CAA4C;KACzD;CACD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,UAAU,6BAA6B,CAC5C,aAAqB,EACrB,aAAqB;IAErB,MAAM,SAAS,GAAe;QAC7B,WAAW,EAAE,YAAY;QACzB,OAAO,EAAE,wBAAwB;QACjC,GAAG,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,IAAI;QAC5B,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,GAAG,aAAa,GAAG;QACzB,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAC9C,UAAU,CAAC,kBAAkB,EAAE,aAAa,EAAE,OAAO,CAAC;QACvD,YAAY,EAAE;YACb;gBACC,IAAI,uBAA+B;gBACnC,QAAQ,EAAE,SAAS,CAAC,SAAS;gBAC7B,QAAQ,EAAE;oBACT;wBACC,EAAE,EAAE,oBAAoB;wBACxB,WAAW,EAAE,oCAAoC;wBACjD,QAAQ,EAAE;4BACT,IAAI,EAAE,oBAAoB;yBAC1B;qBACD;iBACD;aACD;SACD;QACD,QAAQ,EAAE,IAAI;KACd,CAAC;IAEF,MAAM,gBAAgB,GAAuD;QAC5E,WAAW,EAAE,mBAAmB;QAChC,OAAO,EAAE,oCAAoC;QAC7C,GAAG,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,IAAI;QAC5B,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,GAAG,aAAa,OAAO;QAC7B,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAC9C,UAAU,CAAC,kBAAkB,EAAE,aAAa,EAAE,OAAO,CAAC;QACvD,YAAY,EAAE;YACb;gBACC,IAAI,uBAA+B;gBACnC,QAAQ,EAAE;oBACT;wBACC,EAAE,EAAE,qBAAqB;wBACzB,WAAW,EAAE,2CAA2C;wBACxD,QAAQ,EAAE;4BACT,IAAI,EAAE;gCACL,IAAI,EAAE,YAAY;gCAClB,OAAO,EAAE,OAAO;6BAChB;yBACD;qBACD;iBACD;aACD;SACD;QACD,QAAQ,EAAE,IAAI;KACd,CAAC;IAEF,MAAM,YAAY,GAA0D;QAC3E,WAAW,EAAE,eAAe;QAC5B,OAAO,EAAE,gCAAgC;QACzC,GAAG,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,IAAI;QAC5B,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,GAAG,aAAa,cAAc;QACpC,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAC9C,aAAa,CAAC,kBAAkB,EAAE,aAAa,EAAE,OAAO,CAAC;QAC1D,YAAY,EAAE;YACb;gBACC,IAAI,0BAAkC;gBACtC,QAAQ,EAAE,cAAc;aACxB;SACD;QACD,QAAQ,EAAE,IAAI;KACd,CAAC;IAEF,MAAM,WAAW,GAAyD;QACzE,WAAW,EAAE,cAAc;QAC3B,OAAO,EAAE,+BAA+B;QACxC,GAAG,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,IAAI;QAC5B,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,GAAG,aAAa,SAAS;QAC/B,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAC9C,YAAY,CAAC,kBAAkB,EAAE,aAAa,EAAE,OAAO,CAAC;QACzD,YAAY,EAAE;YACb;gBACC,IAAI,yBAAiC;gBACrC,QAAQ,EAAE;oBACT;wBACC,EAAE,EAAE,kBAAkB;wBACtB,WAAW,EAAE,sCAAsC;wBACnD,QAAQ,EAAE;4BACT,IAAI,EAAE;gCACL,MAAM,EAAE,IAAI;gCACZ,UAAU,EAAE;oCACX;wCACC,IAAI,EAAE,UAAU;wCAChB,MAAM,EAAE,IAAI;qCACZ;oCACD;wCACC,IAAI,EAAE,SAAS;wCACf,MAAM,EAAE,IAAI;qCACZ;iCACD;6BACD;yBACD;qBACD;oBACD;wBACC,EAAE,EAAE,uBAAuB;wBAC3B,WAAW,EAAE,oDAAoD;wBACjE,QAAQ,EAAE;4BACT,IAAI,EAAE;gCACL,MAAM,EAAE,SAAS;gCACjB,UAAU,EAAE;oCACX;wCACC,IAAI,EAAE,UAAU;wCAChB,MAAM,EAAE,SAAS;wCACjB,OAAO,EAAE,+BAA+B;qCACxC;oCACD;wCACC,IAAI,EAAE,SAAS;wCACf,MAAM,EAAE,IAAI;qCACZ;iCACD;6BACD;yBACD;qBACD;oBACD;wBACC,EAAE,EAAE,qBAAqB;wBACzB,WAAW,EAAE,kDAAkD;wBAC/D,QAAQ,EAAE;4BACT,IAAI,EAAE;gCACL,MAAM,EAAE,OAAO;gCACf,UAAU,EAAE;oCACX;wCACC,IAAI,EAAE,UAAU;wCAChB,MAAM,EAAE,IAAI;qCACZ;oCACD;wCACC,IAAI,EAAE,SAAS;wCACf,MAAM,EAAE,OAAO;wCACf,OAAO,EAAE,sBAAsB;qCAC/B;iCACD;6BACD;yBACD;qBACD;iBACD;aACD;SACD;QACD,QAAQ,EAAE,IAAI;KACd,CAAC;IAEF,MAAM,SAAS,GAAuD;QACrE,WAAW,EAAE,YAAY;QACzB,OAAO,EAAE,iDAAiD;QAC1D,GAAG,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,IAAI;QAC5B,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,GAAG,aAAa,OAAO;QAC7B,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAC9C,UAAU,CAAC,kBAAkB,EAAE,aAAa,EAAE,OAAO,CAAC;QACvD,YAAY,EAAE;YACb;gBACC,IAAI,uBAA+B;gBACnC,QAAQ,EAAE;oBACT;wBACC,EAAE,EAAE,cAAc;wBAClB,WAAW,EAAE,oCAAoC;wBACjD,QAAQ,EAAE;4BACT,IAAI,EAAE;gCACL,OAAO,EAAE,OAAO;gCAChB,IAAI,EAAE,EAAE;gCACR,KAAK,EAAE,EAAE;6BACT;yBACD;qBACD;iBACD;aACD;SACD;QACD,QAAQ,EAAE,IAAI;KACd,CAAC;IAEF,OAAO,CAAC,SAAS,EAAE,YAAY,EAAE,gBAAgB,EAAE,WAAW,EAAE,SAAS,CAAC,CAAC;AAC5E,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC/B,kBAAuC,EACvC,aAAqB,EACrB,OAA0B;IAE1B,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAAwB,aAAa,CAAC,CAAC;IAC7E,OAAO;QACN,IAAI,EAAE,MAAM,SAAS,CAAC,IAAI,EAAE;KAC5B,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC/B,kBAAuC,EACvC,aAAqB,EACrB,OAA0B;IAE1B,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAAwB,aAAa,CAAC,CAAC;IAC7E,OAAO;QACN,IAAI,EAAE,MAAM,SAAS,CAAC,IAAI,EAAE;KAC5B,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CACjC,kBAAuC,EACvC,aAAqB,EACrB,OAA0B;IAE1B,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAAwB,aAAa,CAAC,CAAC;IAC7E,OAAO;QACN,IAAI,EAAE,MAAM,SAAS,CAAC,MAAM,EAAE;KAC9B,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAClC,kBAAuC,EACvC,aAAqB,EACrB,OAA0B;IAE1B,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAAwB,aAAa,CAAC,CAAC;IAC7E,MAAM,OAAO,GAAG,MAAM,SAAS,CAAC,OAAO,EAAE,CAAC;IAE1C,IAAI,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QAC5B,OAAO;YACN,OAAO,EAAE;gBACR,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,cAAc;aACzC;YACD,IAAI,EAAE,OAAO;SACb,CAAC;IACH,CAAC;IACD,OAAO;QACN,UAAU,EAAE,cAAc,CAAC,QAAQ;KACnC,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC/B,kBAAuC,EACvC,aAAqB,EACrB,OAA0B;IAE1B,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAAwB,aAAa,CAAC,CAAC;IAC7E,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,IAAI,EAAE,CAAC;IAEpC,IAAI,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;QAC1B,OAAO;YACN,IAAI,EAAE,IAAI;SACV,CAAC;IACH,CAAC;IACD,OAAO;QACN,UAAU,EAAE,cAAc,CAAC,QAAQ;KACnC,CAAC;AACH,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {\n\tIHttpRequestContext,\n\tIInformationComponent,\n\tINoContentRequest,\n\tIRestRoute,\n\tIServerFavIconResponse,\n\tIServerHealthResponse,\n\tIServerInfoResponse,\n\tIServerRootResponse,\n\tIServerSpecResponse,\n\tITag\n} from \"@twin.org/api-models\";\nimport { ComponentFactory, Is } from \"@twin.org/core\";\nimport { nameof } from \"@twin.org/nameof\";\nimport { HeaderTypes, HttpStatusCode, MimeTypes } from \"@twin.org/web\";\n\n/**\n * The tag to associate with the routes.\n */\nexport const tagsInformation: ITag[] = [\n\t{\n\t\tname: \"Info\",\n\t\tdescription: \"Information endpoints for the REST server.\"\n\t}\n];\n\n/**\n * The REST routes for server information.\n * @param baseRouteName Prefix to prepend to the paths.\n * @param componentName The name of the component to use in the routes stored in the ComponentFactory.\n * @returns The generated routes.\n */\nexport function generateRestRoutesInformation(\n\tbaseRouteName: string,\n\tcomponentName: string\n): IRestRoute[] {\n\tconst rootRoute: IRestRoute = {\n\t\toperationId: \"serverRoot\",\n\t\tsummary: \"Get the root text page\",\n\t\ttag: tagsInformation[0].name,\n\t\tmethod: \"GET\",\n\t\tpath: `${baseRouteName}/`,\n\t\thandler: async (httpRequestContext, request) =>\n\t\t\tserverRoot(httpRequestContext, componentName, request),\n\t\tresponseType: [\n\t\t\t{\n\t\t\t\ttype: nameof<IServerRootResponse>(),\n\t\t\t\tmimeType: MimeTypes.PlainText,\n\t\t\t\texamples: [\n\t\t\t\t\t{\n\t\t\t\t\t\tid: \"serverRootResponse\",\n\t\t\t\t\t\tdescription: \"The response for the root request.\",\n\t\t\t\t\t\tresponse: {\n\t\t\t\t\t\t\tbody: \"API Server - 1.0.0\"\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t}\n\t\t],\n\t\tskipAuth: true\n\t};\n\n\tconst informationRoute: IRestRoute<INoContentRequest, IServerInfoResponse> = {\n\t\toperationId: \"serverInformation\",\n\t\tsummary: \"Get the information for the server\",\n\t\ttag: tagsInformation[0].name,\n\t\tmethod: \"GET\",\n\t\tpath: `${baseRouteName}/info`,\n\t\thandler: async (httpRequestContext, request) =>\n\t\t\tserverInfo(httpRequestContext, componentName, request),\n\t\tresponseType: [\n\t\t\t{\n\t\t\t\ttype: nameof<IServerInfoResponse>(),\n\t\t\t\texamples: [\n\t\t\t\t\t{\n\t\t\t\t\t\tid: \"informationResponse\",\n\t\t\t\t\t\tdescription: \"The response for the information request.\",\n\t\t\t\t\t\tresponse: {\n\t\t\t\t\t\t\tbody: {\n\t\t\t\t\t\t\t\tname: \"API Server\",\n\t\t\t\t\t\t\t\tversion: \"1.0.0\"\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t}\n\t\t],\n\t\tskipAuth: true\n\t};\n\n\tconst favIconRoute: IRestRoute<INoContentRequest, IServerFavIconResponse> = {\n\t\toperationId: \"serverFavIcon\",\n\t\tsummary: \"Get the favicon for the server\",\n\t\ttag: tagsInformation[0].name,\n\t\tmethod: \"GET\",\n\t\tpath: `${baseRouteName}/favicon.ico`,\n\t\thandler: async (httpRequestContext, request) =>\n\t\t\tserverFavIcon(httpRequestContext, componentName, request),\n\t\tresponseType: [\n\t\t\t{\n\t\t\t\ttype: nameof<IServerFavIconResponse>(),\n\t\t\t\tmimeType: \"image/x-icon\"\n\t\t\t}\n\t\t],\n\t\tskipAuth: true\n\t};\n\n\tconst healthRoute: IRestRoute<INoContentRequest, IServerHealthResponse> = {\n\t\toperationId: \"serverHealth\",\n\t\tsummary: \"Get the health for the server\",\n\t\ttag: tagsInformation[0].name,\n\t\tmethod: \"GET\",\n\t\tpath: `${baseRouteName}/health`,\n\t\thandler: async (httpRequestContext, request) =>\n\t\t\tserverHealth(httpRequestContext, componentName, request),\n\t\tresponseType: [\n\t\t\t{\n\t\t\t\ttype: nameof<IServerHealthResponse>(),\n\t\t\t\texamples: [\n\t\t\t\t\t{\n\t\t\t\t\t\tid: \"healthResponseOK\",\n\t\t\t\t\t\tdescription: \"The response for the health request.\",\n\t\t\t\t\t\tresponse: {\n\t\t\t\t\t\t\tbody: {\n\t\t\t\t\t\t\t\tstatus: \"ok\",\n\t\t\t\t\t\t\t\tcomponents: [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\tname: \"Database\",\n\t\t\t\t\t\t\t\t\t\tstatus: \"ok\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\tname: \"Storage\",\n\t\t\t\t\t\t\t\t\t\tstatus: \"ok\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tid: \"healthResponseWarning\",\n\t\t\t\t\t\tdescription: \"The response for the health request with warnings.\",\n\t\t\t\t\t\tresponse: {\n\t\t\t\t\t\t\tbody: {\n\t\t\t\t\t\t\t\tstatus: \"warning\",\n\t\t\t\t\t\t\t\tcomponents: [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\tname: \"Database\",\n\t\t\t\t\t\t\t\t\t\tstatus: \"warning\",\n\t\t\t\t\t\t\t\t\t\tdetails: \"The database is running slow.\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\tname: \"Storage\",\n\t\t\t\t\t\t\t\t\t\tstatus: \"ok\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tid: \"healthResponseError\",\n\t\t\t\t\t\tdescription: \"The response for the health request with errors.\",\n\t\t\t\t\t\tresponse: {\n\t\t\t\t\t\t\tbody: {\n\t\t\t\t\t\t\t\tstatus: \"error\",\n\t\t\t\t\t\t\t\tcomponents: [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\tname: \"Database\",\n\t\t\t\t\t\t\t\t\t\tstatus: \"ok\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\tname: \"Storage\",\n\t\t\t\t\t\t\t\t\t\tstatus: \"error\",\n\t\t\t\t\t\t\t\t\t\tdetails: \"The storage is full.\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t}\n\t\t],\n\t\tskipAuth: true\n\t};\n\n\tconst specRoute: IRestRoute<INoContentRequest, IServerSpecResponse> = {\n\t\toperationId: \"serverSpec\",\n\t\tsummary: \"Get the OpenAPI specification for the endpoints\",\n\t\ttag: tagsInformation[0].name,\n\t\tmethod: \"GET\",\n\t\tpath: `${baseRouteName}/spec`,\n\t\thandler: async (httpRequestContext, request) =>\n\t\t\tserverSpec(httpRequestContext, componentName, request),\n\t\tresponseType: [\n\t\t\t{\n\t\t\t\ttype: nameof<IServerSpecResponse>(),\n\t\t\t\texamples: [\n\t\t\t\t\t{\n\t\t\t\t\t\tid: \"specResponse\",\n\t\t\t\t\t\tdescription: \"The response for the spec request.\",\n\t\t\t\t\t\tresponse: {\n\t\t\t\t\t\t\tbody: {\n\t\t\t\t\t\t\t\topenapi: \"3.1.0\",\n\t\t\t\t\t\t\t\tinfo: {},\n\t\t\t\t\t\t\t\tpaths: {}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t}\n\t\t],\n\t\tskipAuth: true\n\t};\n\n\treturn [rootRoute, favIconRoute, informationRoute, healthRoute, specRoute];\n}\n\n/**\n * Get the root for the server.\n * @param httpRequestContext The request context for the API.\n * @param componentName The name of the component to use in the routes.\n * @param request The request.\n * @returns The response object with additional http response properties.\n */\nexport async function serverRoot(\n\thttpRequestContext: IHttpRequestContext,\n\tcomponentName: string,\n\trequest: INoContentRequest\n): Promise<IServerRootResponse> {\n\tconst component = ComponentFactory.get<IInformationComponent>(componentName);\n\treturn {\n\t\tbody: await component.root()\n\t};\n}\n\n/**\n * Get the information for the server.\n * @param httpRequestContext The request context for the API.\n * @param componentName The name of the component to use in the routes.\n * @param request The request.\n * @returns The response object with additional http response properties.\n */\nexport async function serverInfo(\n\thttpRequestContext: IHttpRequestContext,\n\tcomponentName: string,\n\trequest: INoContentRequest\n): Promise<IServerInfoResponse> {\n\tconst component = ComponentFactory.get<IInformationComponent>(componentName);\n\treturn {\n\t\tbody: await component.info()\n\t};\n}\n\n/**\n * Get the health for the server.\n * @param httpRequestContext The request context for the API.\n * @param componentName The name of the component to use in the routes.\n * @param request The request.\n * @returns The response object with additional http response properties.\n */\nexport async function serverHealth(\n\thttpRequestContext: IHttpRequestContext,\n\tcomponentName: string,\n\trequest: INoContentRequest\n): Promise<IServerHealthResponse> {\n\tconst component = ComponentFactory.get<IInformationComponent>(componentName);\n\treturn {\n\t\tbody: await component.health()\n\t};\n}\n\n/**\n * Get the favicon for the server.\n * @param httpRequestContext The request context for the API.\n * @param componentName The name of the component to use in the routes.\n * @param request The request.\n * @returns The response object with additional http response properties.\n */\nexport async function serverFavIcon(\n\thttpRequestContext: IHttpRequestContext,\n\tcomponentName: string,\n\trequest: INoContentRequest\n): Promise<IServerFavIconResponse> {\n\tconst component = ComponentFactory.get<IInformationComponent>(componentName);\n\tconst favIcon = await component.favicon();\n\n\tif (Is.uint8Array(favIcon)) {\n\t\treturn {\n\t\t\theaders: {\n\t\t\t\t[HeaderTypes.ContentType]: \"image/x-icon\"\n\t\t\t},\n\t\t\tbody: favIcon\n\t\t};\n\t}\n\treturn {\n\t\tstatusCode: HttpStatusCode.notFound\n\t};\n}\n\n/**\n * Get the spec for the server.\n * @param httpRequestContext The request context for the API.\n * @param componentName The name of the component to use in the routes.\n * @param request The request.\n * @returns The response object with additional http response properties.\n */\nexport async function serverSpec(\n\thttpRequestContext: IHttpRequestContext,\n\tcomponentName: string,\n\trequest: INoContentRequest\n): Promise<IServerSpecResponse> {\n\tconst component = ComponentFactory.get<IInformationComponent>(componentName);\n\tconst spec = await component.spec();\n\n\tif (Is.objectValue(spec)) {\n\t\treturn {\n\t\t\tbody: spec\n\t\t};\n\t}\n\treturn {\n\t\tstatusCode: HttpStatusCode.notFound\n\t};\n}\n"]}

package/dist/es/informationService.js

@@ -0,0 +1,166 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { readFile } from "node:fs/promises";
+import { Guards, Is } from "@twin.org/core";
+/**
+ * The information service for the server.
+ */
+export class InformationService {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "InformationService";
+    /**
+     * The server information.
+     * @internal
+     */
+    _serverInfo;
+    /**
+     * The server health.
+     * @internal
+     */
+    _healthInfo;
+    /**
+     * The path to the favicon Spec.
+     * @internal
+     */
+    _faviconPath;
+    /**
+     * The favicon.
+     * @internal
+     */
+    _favicon;
+    /**
+     * The path to the OpenAPI Spec.
+     * @internal
+     */
+    _openApiSpecPath;
+    /**
+     * The OpenAPI spec.
+     * @internal
+     */
+    _openApiSpec;
+    /**
+     * Create a new instance of InformationService.
+     * @param options The options to create the service.
+     */
+    constructor(options) {
+        Guards.object(InformationService.CLASS_NAME, "options", options);
+        Guards.object(InformationService.CLASS_NAME, "options.config", options.config);
+        Guards.object(InformationService.CLASS_NAME, "options.config.serverInfo", options.config.serverInfo);
+        this._serverInfo = options.config.serverInfo;
+        this._healthInfo = {
+            status: "ok"
+        };
+        this._faviconPath = options.config.favIconPath;
+        this._openApiSpecPath = options.config.openApiSpecPath;
+    }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return InformationService.CLASS_NAME;
+    }
+    /**
+     * The service needs to be started when the application is initialized.
+     * @returns Nothing.
+     */
+    async start() {
+        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.
+     * @returns The service information.
+     */
+    async info() {
+        return this._serverInfo;
+    }
+    /**
+     * Get the favicon.
+     * @returns The favicon.
+     */
+    async favicon() {
+        return this._favicon;
+    }
+    /**
+     * Get the OpenAPI spec.
+     * @returns The OpenAPI spec.
+     */
+    async spec() {
+        return this._openApiSpec;
+    }
+    /**
+     * Get the server health.
+     * @returns The service health.
+     */
+    async health() {
+        let errorCount = 0;
+        let warningCount = 0;
+        if (Is.arrayValue(this._healthInfo.components)) {
+            errorCount = this._healthInfo.components.filter(c => c.status === "error").length;
+            warningCount = this._healthInfo.components.filter(c => c.status === "warning").length;
+        }
+        if (errorCount > 0) {
+            this._healthInfo.status = "error";
+        }
+        else if (warningCount > 0) {
+            this._healthInfo.status = "warning";
+        }
+        else {
+            this._healthInfo.status = "ok";
+        }
+        return this._healthInfo;
+    }
+    /**
+     * Set the status of a component.
+     * @param name The component name.
+     * @param status The status of the component.
+     * @param details The details for the status.
+     * @returns Nothing.
+     */
+    async setComponentHealth(name, status, details) {
+        const component = this._healthInfo.components?.find(c => c.name === name);
+        if (Is.undefined(component)) {
+            this._healthInfo.components ??= [];
+            this._healthInfo.components.push({
+                name,
+                status,
+                details
+            });
+        }
+        else {
+            component.status = status;
+            component.details = details;
+        }
+    }
+    /**
+     * Remove the status of a component.
+     * @param name The component name.
+     * @returns Nothing.
+     */
+    async removeComponentHealth(name) {
+        if (Is.arrayValue(this._healthInfo.components)) {
+            const componentIndex = this._healthInfo.components.findIndex(c => c.name === name);
+            if (componentIndex !== -1) {
+                this._healthInfo.components.splice(componentIndex, 1);
+            }
+        }
+    }
+}
+//# sourceMappingURL=informationService.js.map

package/dist/es/informationService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"informationService.js","sourceRoot":"","sources":["../../src/informationService.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAO5C,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAI5C;;GAEG;AACH,MAAM,OAAO,kBAAkB;IAC9B;;OAEG;IACI,MAAM,CAAU,UAAU,wBAAwC;IAEzE;;;OAGG;IACc,WAAW,CAAc;IAE1C;;;OAGG;IACc,WAAW,CAAc;IAE1C;;;OAGG;IACc,YAAY,CAAU;IAEvC;;;OAGG;IACK,QAAQ,CAAc;IAE9B;;;OAGG;IACc,gBAAgB,CAAU;IAE3C;;;OAGG;IACK,YAAY,CAAU;IAE9B;;;OAGG;IACH,YAAY,OAA8C;QACzD,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,UAAU,aAAmB,OAAO,CAAC,CAAC;QACvE,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,UAAU,oBAA0B,OAAO,CAAC,MAAM,CAAC,CAAC;QACrF,MAAM,CAAC,MAAM,CACZ,kBAAkB,CAAC,UAAU,+BAE7B,OAAO,CAAC,MAAM,CAAC,UAAU,CACzB,CAAC;QAEF,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC;QAC7C,IAAI,CAAC,WAAW,GAAG;YAClB,MAAM,EAAE,IAAI;SACZ,CAAC;QACF,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC;QAC/C,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC;IACxD,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,kBAAkB,CAAC,UAAU,CAAC;IACtC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,KAAK;QACjB,MAAM,WAAW,GAAG,IAAI,CAAC,gBAAgB,CAAC;QAC1C,IAAI,EAAE,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,CAAC;YACjC,MAAM,aAAa,GAAG,MAAM,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;YAC1D,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAC/C,CAAC;QAED,MAAM,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC;QACtC,IAAI,EAAE,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,CAAC;YACjC,IAAI,CAAC,QAAQ,GAAG,MAAM,QAAQ,CAAC,WAAW,CAAC,CAAC;QAC7C,CAAC;IACF,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,IAAI;QAChB,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;IACjE,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,IAAI;QAChB,OAAO,IAAI,CAAC,WAAW,CAAC;IACzB,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,OAAO;QACnB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACtB,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,IAAI;QAChB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,MAAM;QAClB,IAAI,UAAU,GAAG,CAAC,CAAC;QACnB,IAAI,YAAY,GAAG,CAAC,CAAC;QAErB,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC;YAChD,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,OAAO,CAAC,CAAC,MAAM,CAAC;YAClF,YAAY,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,MAAM,CAAC;QACvF,CAAC;QAED,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC;YACpB,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,OAAO,CAAC;QACnC,CAAC;aAAM,IAAI,YAAY,GAAG,CAAC,EAAE,CAAC;YAC7B,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,SAAS,CAAC;QACrC,CAAC;aAAM,CAAC;YACP,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,IAAI,CAAC;QAChC,CAAC;QAED,OAAO,IAAI,CAAC,WAAW,CAAC;IACzB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,kBAAkB,CAC9B,IAAY,EACZ,MAAoB,EACpB,OAAgB;QAEhB,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;QAE1E,IAAI,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC;YAC7B,IAAI,CAAC,WAAW,CAAC,UAAU,KAAK,EAAE,CAAC;YACnC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC;gBAChC,IAAI;gBACJ,MAAM;gBACN,OAAO;aACP,CAAC,CAAC;QACJ,CAAC;aAAM,CAAC;YACP,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC;YAC1B,SAAS,CAAC,OAAO,GAAG,OAAO,CAAC;QAC7B,CAAC;IACF,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,qBAAqB,CAAC,IAAY;QAC9C,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC;YAChD,MAAM,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;YACnF,IAAI,cAAc,KAAK,CAAC,CAAC,EAAE,CAAC;gBAC3B,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;YACvD,CAAC;QACF,CAAC;IACF,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { readFile } from \"node:fs/promises\";\nimport type {\n\tHealthStatus,\n\tIHealthInfo,\n\tIInformationComponent,\n\tIServerInfo\n} from \"@twin.org/api-models\";\nimport { Guards, Is } from \"@twin.org/core\";\nimport { nameof } from \"@twin.org/nameof\";\nimport type { IInformationServiceConstructorOptions } from \"./models/IInformationServiceConstructorOptions.js\";\n\n/**\n * The information service for the server.\n */\nexport class InformationService implements IInformationComponent {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<InformationService>();\n\n\t/**\n\t * The server information.\n\t * @internal\n\t */\n\tprivate readonly _serverInfo: IServerInfo;\n\n\t/**\n\t * The server health.\n\t * @internal\n\t */\n\tprivate readonly _healthInfo: IHealthInfo;\n\n\t/**\n\t * The path to the favicon Spec.\n\t * @internal\n\t */\n\tprivate readonly _faviconPath?: string;\n\n\t/**\n\t * The favicon.\n\t * @internal\n\t */\n\tprivate _favicon?: Uint8Array;\n\n\t/**\n\t * The path to the OpenAPI Spec.\n\t * @internal\n\t */\n\tprivate readonly _openApiSpecPath?: string;\n\n\t/**\n\t * The OpenAPI spec.\n\t * @internal\n\t */\n\tprivate _openApiSpec?: string;\n\n\t/**\n\t * Create a new instance of InformationService.\n\t * @param options The options to create the service.\n\t */\n\tconstructor(options: IInformationServiceConstructorOptions) {\n\t\tGuards.object(InformationService.CLASS_NAME, nameof(options), options);\n\t\tGuards.object(InformationService.CLASS_NAME, nameof(options.config), options.config);\n\t\tGuards.object(\n\t\t\tInformationService.CLASS_NAME,\n\t\t\tnameof(options.config.serverInfo),\n\t\t\toptions.config.serverInfo\n\t\t);\n\n\t\tthis._serverInfo = options.config.serverInfo;\n\t\tthis._healthInfo = {\n\t\t\tstatus: \"ok\"\n\t\t};\n\t\tthis._faviconPath = options.config.favIconPath;\n\t\tthis._openApiSpecPath = options.config.openApiSpecPath;\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn InformationService.CLASS_NAME;\n\t}\n\n\t/**\n\t * The service needs to be started when the application is initialized.\n\t * @returns Nothing.\n\t */\n\tpublic async start(): Promise<void> {\n\t\tconst openApiPath = this._openApiSpecPath;\n\t\tif (Is.stringValue(openApiPath)) {\n\t\t\tconst contentBuffer = await readFile(openApiPath, \"utf8\");\n\t\t\tthis._openApiSpec = JSON.parse(contentBuffer);\n\t\t}\n\n\t\tconst favIconPath = this._faviconPath;\n\t\tif (Is.stringValue(favIconPath)) {\n\t\t\tthis._favicon = await readFile(favIconPath);\n\t\t}\n\t}\n\n\t/**\n\t * Get the root information.\n\t * @returns The root information.\n\t */\n\tpublic async root(): Promise<string> {\n\t\treturn `${this._serverInfo.name} - ${this._serverInfo.version}`;\n\t}\n\n\t/**\n\t * Get the server information.\n\t * @returns The service information.\n\t */\n\tpublic async info(): Promise<IServerInfo> {\n\t\treturn this._serverInfo;\n\t}\n\n\t/**\n\t * Get the favicon.\n\t * @returns The favicon.\n\t */\n\tpublic async favicon(): Promise<Uint8Array | undefined> {\n\t\treturn this._favicon;\n\t}\n\n\t/**\n\t * Get the OpenAPI spec.\n\t * @returns The OpenAPI spec.\n\t */\n\tpublic async spec(): Promise<unknown> {\n\t\treturn this._openApiSpec;\n\t}\n\n\t/**\n\t * Get the server health.\n\t * @returns The service health.\n\t */\n\tpublic async health(): Promise<IHealthInfo> {\n\t\tlet errorCount = 0;\n\t\tlet warningCount = 0;\n\n\t\tif (Is.arrayValue(this._healthInfo.components)) {\n\t\t\terrorCount = this._healthInfo.components.filter(c => c.status === \"error\").length;\n\t\t\twarningCount = this._healthInfo.components.filter(c => c.status === \"warning\").length;\n\t\t}\n\n\t\tif (errorCount > 0) {\n\t\t\tthis._healthInfo.status = \"error\";\n\t\t} else if (warningCount > 0) {\n\t\t\tthis._healthInfo.status = \"warning\";\n\t\t} else {\n\t\t\tthis._healthInfo.status = \"ok\";\n\t\t}\n\n\t\treturn this._healthInfo;\n\t}\n\n\t/**\n\t * Set the status of a component.\n\t * @param name The component name.\n\t * @param status The status of the component.\n\t * @param details The details for the status.\n\t * @returns Nothing.\n\t */\n\tpublic async setComponentHealth(\n\t\tname: string,\n\t\tstatus: HealthStatus,\n\t\tdetails?: string\n\t): Promise<void> {\n\t\tconst component = this._healthInfo.components?.find(c => c.name === name);\n\n\t\tif (Is.undefined(component)) {\n\t\t\tthis._healthInfo.components ??= [];\n\t\t\tthis._healthInfo.components.push({\n\t\t\t\tname,\n\t\t\t\tstatus,\n\t\t\t\tdetails\n\t\t\t});\n\t\t} else {\n\t\t\tcomponent.status = status;\n\t\t\tcomponent.details = details;\n\t\t}\n\t}\n\n\t/**\n\t * Remove the status of a component.\n\t * @param name The component name.\n\t * @returns Nothing.\n\t */\n\tpublic async removeComponentHealth(name: string): Promise<void> {\n\t\tif (Is.arrayValue(this._healthInfo.components)) {\n\t\t\tconst componentIndex = this._healthInfo.components.findIndex(c => c.name === name);\n\t\t\tif (componentIndex !== -1) {\n\t\t\t\tthis._healthInfo.components.splice(componentIndex, 1);\n\t\t\t}\n\t\t}\n\t}\n}\n"]}

package/dist/es/models/IInformationServiceConfig.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IInformationServiceConfig.js.map

package/dist/es/models/IInformationServiceConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IInformationServiceConfig.js","sourceRoot":"","sources":["../../../src/models/IInformationServiceConfig.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IServerInfo } from \"@twin.org/api-models\";\n\n/**\n * Configuration for the information service.\n */\nexport interface IInformationServiceConfig {\n\t/**\n\t * The server information.\n\t */\n\tserverInfo: IServerInfo;\n\n\t/**\n\t * The path to the OpenAPI Spec.\n\t */\n\topenApiSpecPath?: string;\n\n\t/**\n\t * The path to the favicon.\n\t */\n\tfavIconPath?: string;\n}\n"]}

package/dist/es/models/IInformationServiceConstructorOptions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IInformationServiceConstructorOptions.js.map

package/dist/es/models/IInformationServiceConstructorOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IInformationServiceConstructorOptions.js","sourceRoot":"","sources":["../../../src/models/IInformationServiceConstructorOptions.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IInformationServiceConfig } from \"./IInformationServiceConfig.js\";\n\n/**\n * Options for the InformationService constructor.\n */\nexport interface IInformationServiceConstructorOptions {\n\t/**\n\t * The configuration for the service.\n\t */\n\tconfig: IInformationServiceConfig;\n}\n"]}

package/dist/es/restEntryPoints.js

@@ -0,0 +1,10 @@
+import { generateRestRoutesInformation, tagsInformation } from "./informationRoutes.js";
+export const restEntryPoints = [
+    {
+        name: "information",
+        defaultBaseRoute: "",
+        tags: tagsInformation,
+        generateRoutes: generateRestRoutesInformation
+    }
+];
+//# sourceMappingURL=restEntryPoints.js.map

package/dist/es/restEntryPoints.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"restEntryPoints.js","sourceRoot":"","sources":["../../src/restEntryPoints.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,6BAA6B,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAExF,MAAM,CAAC,MAAM,eAAe,GAA2B;IACtD;QACC,IAAI,EAAE,aAAa;QACnB,gBAAgB,EAAE,EAAE;QACpB,IAAI,EAAE,eAAe;QACrB,cAAc,EAAE,6BAA6B;KAC7C;CACD,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IRestRouteEntryPoint } from \"@twin.org/api-models\";\nimport { generateRestRoutesInformation, tagsInformation } from \"./informationRoutes.js\";\n\nexport const restEntryPoints: IRestRouteEntryPoint[] = [\n\t{\n\t\tname: \"information\",\n\t\tdefaultBaseRoute: \"\",\n\t\ttags: tagsInformation,\n\t\tgenerateRoutes: generateRestRoutesInformation\n\t}\n];\n"]}

package/dist/types/index.d.ts

@@ -1,5 +1,5 @@
-export * from "./informationRoutes";
-export * from "./informationService";
-export * from "./models/IInformationServiceConfig";
-export * from "./models/IInformationServiceConstructorOptions";
-export * from "./restEntryPoints";
+export * from "./informationRoutes.js";
+export * from "./informationService.js";
+export * from "./models/IInformationServiceConfig.js";
+export * from "./models/IInformationServiceConstructorOptions.js";
+export * from "./restEntryPoints.js";

package/dist/types/informationService.d.ts

@@ -1,5 +1,5 @@
 import type { HealthStatus, IHealthInfo, IInformationComponent, IServerInfo } from "@twin.org/api-models";
-import type { IInformationServiceConstructorOptions } from "./models/IInformationServiceConstructorOptions";
+import type { IInformationServiceConstructorOptions } from "./models/IInformationServiceConstructorOptions.js";
 /**
  * The information service for the server.
  */
@@ -7,12 +7,17 @@ export declare class InformationService implements IInformationComponent {
     /**
      * Runtime name for the class.
      */
-    readonly CLASS_NAME: string;
+    static readonly CLASS_NAME: string;
     /**
      * Create a new instance of InformationService.
      * @param options The options to create the service.
      */
     constructor(options: IInformationServiceConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
     /**
      * The service needs to be started when the application is initialized.
      * @returns Nothing.

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

@@ -1,4 +1,4 @@
-import type { IInformationServiceConfig } from "./IInformationServiceConfig";
+import type { IInformationServiceConfig } from "./IInformationServiceConfig.js";
 /**
  * Options for the InformationService constructor.
  */

package/docs/changelog.md

@@ -1,5 +1,97 @@
 # @twin.org/api-service - Changelog
 
+## [0.0.3-next.2](https://github.com/twinfoundation/api/compare/api-service-v0.0.3-next.1...api-service-v0.0.3-next.2) (2025-11-12)
+
+
+### Miscellaneous Chores
+
+* **api-service:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.3-next.1 to 0.0.3-next.2
+
+## [0.0.3-next.1](https://github.com/twinfoundation/api/compare/api-service-v0.0.3-next.0...api-service-v0.0.3-next.1) (2025-11-10)
+
+
+### Features
+
+* add context id features ([#42](https://github.com/twinfoundation/api/issues/42)) ([0186055](https://github.com/twinfoundation/api/commit/0186055c48afde842a4254b4df9ac9249c40fe40))
+* add root, favicon routes ([71da1c3](https://github.com/twinfoundation/api/commit/71da1c3a93c349588aff7084d1d8d6a29a277da8))
+* add validate-locales ([cdba610](https://github.com/twinfoundation/api/commit/cdba610a0acb5022d2e3ce729732e6646a297e5e))
+* eslint migration to flat config ([0dd5820](https://github.com/twinfoundation/api/commit/0dd5820e3af97350fd08b8d226f4a6c1a9246805))
+* remove unused namespace ([08478f2](https://github.com/twinfoundation/api/commit/08478f27efda9beb0271fdb22f6972e918361965))
+* update dependencies ([1171dc4](https://github.com/twinfoundation/api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
+* update framework core ([d8eebf2](https://github.com/twinfoundation/api/commit/d8eebf267fa2a0abaa84e58590496e9d20490cfa))
+* update IComponent signatures ([915ce37](https://github.com/twinfoundation/api/commit/915ce37712326ab4aa6869c350eabaa4622e8430))
+* 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-models bumped from 0.0.3-next.0 to 0.0.3-next.1
+
+## [0.0.2-next.13](https://github.com/twinfoundation/api/compare/api-service-v0.0.2-next.12...api-service-v0.0.2-next.13) (2025-10-09)
+
+
+### Miscellaneous Chores
+
+* **api-service:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.2-next.12 to 0.0.2-next.13
+
+## [0.0.2-next.12](https://github.com/twinfoundation/api/compare/api-service-v0.0.2-next.11...api-service-v0.0.2-next.12) (2025-10-09)
+
+
+### Features
+
+* add validate-locales ([cdba610](https://github.com/twinfoundation/api/commit/cdba610a0acb5022d2e3ce729732e6646a297e5e))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.2-next.11 to 0.0.2-next.12
+
+## [0.0.2-next.11](https://github.com/twinfoundation/api/compare/api-service-v0.0.2-next.10...api-service-v0.0.2-next.11) (2025-09-29)
+
+
+### Features
+
+* update IComponent signatures ([915ce37](https://github.com/twinfoundation/api/commit/915ce37712326ab4aa6869c350eabaa4622e8430))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.2-next.10 to 0.0.2-next.11
+
+## [0.0.2-next.10](https://github.com/twinfoundation/api/compare/api-service-v0.0.2-next.9...api-service-v0.0.2-next.10) (2025-09-23)
+
+
+### Miscellaneous Chores
+
+* **api-service:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.2-next.9 to 0.0.2-next.10
+
 ## [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)
 
 

package/docs/reference/classes/InformationService.md

@@ -30,15 +30,29 @@ The options to create the service.
 
 ### CLASS\_NAME
 
-> `readonly` **CLASS\_NAME**: `string`
+> `readonly` `static` **CLASS\_NAME**: `string`
 
 Runtime name for the class.
 
+## Methods
+
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
 #### Implementation of
 
-`IInformationComponent.CLASS_NAME`
+`IInformationComponent.className`
 
-## Methods
+***
 
 ### start()
 
@@ -96,13 +110,13 @@ The service information.
 
 ### favicon()
 
-> **favicon**(): `Promise`\<`undefined` \| `Uint8Array`\<`ArrayBufferLike`\>\>
+> **favicon**(): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\> \| `undefined`\>
 
 Get the favicon.
 
 #### Returns
 
-`Promise`\<`undefined` \| `Uint8Array`\<`ArrayBufferLike`\>\>
+`Promise`\<`Uint8Array`\<`ArrayBufferLike`\> \| `undefined`\>
 
 The favicon.
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/api-service",
-	"version": "0.0.2-next.9",
+	"version": "0.0.3-next.2",
 	"description": "Information contract implementation and REST endpoint definitions",
 	"repository": {
 		"type": "git",
@@ -14,26 +14,39 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/api-models": "0.0.2-next.9",
+		"@twin.org/api-models": "0.0.3-next.2",
 		"@twin.org/core": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		}
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/types",
 		"locales",
 		"docs"
-	]
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"api",
+		"service",
+		"microservice",
+		"business-logic"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/api/issues"
+	},
+	"homepage": "https://twindev.org"
 }

package/dist/cjs/index.cjs

@@ -1,447 +0,0 @@
-'use strict';
-
-var core = require('@twin.org/core');
-var web = require('@twin.org/web');
-var promises = require('node:fs/promises');
-
-/**
- * The tag to associate with the routes.
- */
-const tagsInformation = [
-    {
-        name: "Info",
-        description: "Information endpoints for the REST server."
-    }
-];
-/**
- * The REST routes for server information.
- * @param baseRouteName Prefix to prepend to the paths.
- * @param componentName The name of the component to use in the routes stored in the ComponentFactory.
- * @returns The generated routes.
- */
-function generateRestRoutesInformation(baseRouteName, componentName) {
-    const rootRoute = {
-        operationId: "serverRoot",
-        summary: "Get the root text page",
-        tag: tagsInformation[0].name,
-        method: "GET",
-        path: `${baseRouteName}/`,
-        handler: async (httpRequestContext, request) => serverRoot(httpRequestContext, componentName),
-        responseType: [
-            {
-                type: "IServerRootResponse",
-                mimeType: web.MimeTypes.PlainText,
-                examples: [
-                    {
-                        id: "serverRootResponse",
-                        description: "The response for the root request.",
-                        response: {
-                            body: "API Server - 1.0.0"
-                        }
-                    }
-                ]
-            }
-        ],
-        skipAuth: true
-    };
-    const informationRoute = {
-        operationId: "serverInformation",
-        summary: "Get the information for the server",
-        tag: tagsInformation[0].name,
-        method: "GET",
-        path: `${baseRouteName}/info`,
-        handler: async (httpRequestContext, request) => serverInfo(httpRequestContext, componentName),
-        responseType: [
-            {
-                type: "IServerInfoResponse",
-                examples: [
-                    {
-                        id: "informationResponse",
-                        description: "The response for the information request.",
-                        response: {
-                            body: {
-                                name: "API Server",
-                                version: "1.0.0"
-                            }
-                        }
-                    }
-                ]
-            }
-        ],
-        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",
-        tag: tagsInformation[0].name,
-        method: "GET",
-        path: `${baseRouteName}/health`,
-        handler: async (httpRequestContext, request) => serverHealth(httpRequestContext, componentName),
-        responseType: [
-            {
-                type: "IServerHealthResponse",
-                examples: [
-                    {
-                        id: "healthResponseOK",
-                        description: "The response for the health request.",
-                        response: {
-                            body: {
-                                status: "ok",
-                                components: [
-                                    {
-                                        name: "Database",
-                                        status: "ok"
-                                    },
-                                    {
-                                        name: "Storage",
-                                        status: "ok"
-                                    }
-                                ]
-                            }
-                        }
-                    },
-                    {
-                        id: "healthResponseWarning",
-                        description: "The response for the health request with warnings.",
-                        response: {
-                            body: {
-                                status: "warning",
-                                components: [
-                                    {
-                                        name: "Database",
-                                        status: "warning",
-                                        details: "The database is running slow."
-                                    },
-                                    {
-                                        name: "Storage",
-                                        status: "ok"
-                                    }
-                                ]
-                            }
-                        }
-                    },
-                    {
-                        id: "healthResponseError",
-                        description: "The response for the health request with errors.",
-                        response: {
-                            body: {
-                                status: "error",
-                                components: [
-                                    {
-                                        name: "Database",
-                                        status: "ok"
-                                    },
-                                    {
-                                        name: "Storage",
-                                        status: "error",
-                                        details: "The storage is full."
-                                    }
-                                ]
-                            }
-                        }
-                    }
-                ]
-            }
-        ],
-        skipAuth: true
-    };
-    const specRoute = {
-        operationId: "serverSpec",
-        summary: "Get the OpenAPI specification for the endpoints",
-        tag: tagsInformation[0].name,
-        method: "GET",
-        path: `${baseRouteName}/spec`,
-        handler: async (httpRequestContext, request) => serverSpec(httpRequestContext, componentName),
-        responseType: [
-            {
-                type: "IServerSpecResponse",
-                examples: [
-                    {
-                        id: "specResponse",
-                        description: "The response for the spec request.",
-                        response: {
-                            body: {
-                                openapi: "3.1.0",
-                                info: {},
-                                paths: {}
-                            }
-                        }
-                    }
-                ]
-            }
-        ],
-        skipAuth: true
-    };
-    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.
- * @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 serverInfo(httpRequestContext, componentName, request) {
-    const component = core.ComponentFactory.get(componentName);
-    return {
-        body: await component.info()
-    };
-}
-/**
- * Get the health 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 serverHealth(httpRequestContext, componentName, request) {
-    const component = core.ComponentFactory.get(componentName);
-    return {
-        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.
- * @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 serverSpec(httpRequestContext, componentName, request) {
-    const component = core.ComponentFactory.get(componentName);
-    const spec = await component.spec();
-    if (core.Is.objectValue(spec)) {
-        return {
-            body: spec
-        };
-    }
-    return {
-        statusCode: web.HttpStatusCode.notFound
-    };
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * The information service for the server.
- */
-class InformationService {
-    /**
-     * Runtime name for the class.
-     */
-    CLASS_NAME = "InformationService";
-    /**
-     * The server information.
-     * @internal
-     */
-    _serverInfo;
-    /**
-     * The server health.
-     * @internal
-     */
-    _healthInfo;
-    /**
-     * The path to the favicon Spec.
-     * @internal
-     */
-    _faviconPath;
-    /**
-     * The favicon.
-     * @internal
-     */
-    _favicon;
-    /**
-     * The path to the OpenAPI Spec.
-     * @internal
-     */
-    _openApiSpecPath;
-    /**
-     * The OpenAPI spec.
-     * @internal
-     */
-    _openApiSpec;
-    /**
-     * Create a new instance of InformationService.
-     * @param options The options to create the service.
-     */
-    constructor(options) {
-        core.Guards.object(this.CLASS_NAME, "options", options);
-        core.Guards.object(this.CLASS_NAME, "options.config", options.config);
-        core.Guards.object(this.CLASS_NAME, "options.config.serverInfo", options.config.serverInfo);
-        this._serverInfo = options.config.serverInfo;
-        this._healthInfo = {
-            status: "ok"
-        };
-        this._faviconPath = options.config.favIconPath;
-        this._openApiSpecPath = options.config.openApiSpecPath;
-    }
-    /**
-     * The service needs to be started when the application is initialized.
-     * @returns Nothing.
-     */
-    async start() {
-        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.
-     * @returns The service information.
-     */
-    async info() {
-        return this._serverInfo;
-    }
-    /**
-     * Get the favicon.
-     * @returns The favicon.
-     */
-    async favicon() {
-        return this._favicon;
-    }
-    /**
-     * Get the OpenAPI spec.
-     * @returns The OpenAPI spec.
-     */
-    async spec() {
-        return this._openApiSpec;
-    }
-    /**
-     * Get the server health.
-     * @returns The service health.
-     */
-    async health() {
-        let errorCount = 0;
-        let warningCount = 0;
-        if (core.Is.arrayValue(this._healthInfo.components)) {
-            errorCount = this._healthInfo.components.filter(c => c.status === "error").length;
-            warningCount = this._healthInfo.components.filter(c => c.status === "warning").length;
-        }
-        if (errorCount > 0) {
-            this._healthInfo.status = "error";
-        }
-        else if (warningCount > 0) {
-            this._healthInfo.status = "warning";
-        }
-        else {
-            this._healthInfo.status = "ok";
-        }
-        return this._healthInfo;
-    }
-    /**
-     * Set the status of a component.
-     * @param name The component name.
-     * @param status The status of the component.
-     * @param details The details for the status.
-     * @returns Nothing.
-     */
-    async setComponentHealth(name, status, details) {
-        const component = this._healthInfo.components?.find(c => c.name === name);
-        if (core.Is.undefined(component)) {
-            this._healthInfo.components ??= [];
-            this._healthInfo.components.push({
-                name,
-                status,
-                details
-            });
-        }
-        else {
-            component.status = status;
-            component.details = details;
-        }
-    }
-    /**
-     * Remove the status of a component.
-     * @param name The component name.
-     * @returns Nothing.
-     */
-    async removeComponentHealth(name) {
-        if (core.Is.arrayValue(this._healthInfo.components)) {
-            const componentIndex = this._healthInfo.components.findIndex(c => c.name === name);
-            if (componentIndex !== -1) {
-                this._healthInfo.components.splice(componentIndex, 1);
-            }
-        }
-    }
-}
-
-const restEntryPoints = [
-    {
-        name: "information",
-        defaultBaseRoute: "",
-        tags: tagsInformation,
-        generateRoutes: generateRestRoutesInformation
-    }
-];
-
-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;