@twin.org/api-service 0.0.1-next.15 → 0.0.1-next.17

package/dist/cjs/index.cjs

@@ -211,21 +211,16 @@ async function serverSpec(httpRequestContext, componentName, request) {
     };
 }
 
-const restEntryPoints = [
-    {
-        name: "information",
-        defaultBaseRoute: "",
-        tags: tagsInformation,
-        generateRoutes: generateRestRoutesInformation
-    }
-];
-
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
  * The information service for the server.
  */
 class InformationService {
+    /**
+     * The namespace supported by the information service.
+     */
+    static NAMESPACE = "information";
     /**
      * Runtime name for the class.
      */
@@ -252,15 +247,18 @@ class InformationService {
     _openApiSpec;
     /**
      * Create a new instance of InformationService.
-     * @param serverInfo The server information.
-     * @param openApiSpecPath The path to the spec file.
+     * @param options The options to create the service.
+     * @param options.config The configuration for the service.
      */
-    constructor(serverInfo, openApiSpecPath) {
-        this._serverInfo = serverInfo;
+    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._openApiSpecPath = openApiSpecPath;
+        this._openApiSpecPath = options.config.openApiSpecPath;
     }
     /**
      * The service needs to be started when the application is initialized.
@@ -346,6 +344,15 @@ class InformationService {
     }
 }
 
+const restEntryPoints = [
+    {
+        name: "information",
+        defaultBaseRoute: "",
+        tags: tagsInformation,
+        generateRoutes: generateRestRoutesInformation
+    }
+];
+
 exports.InformationService = InformationService;
 exports.generateRestRoutesInformation = generateRestRoutesInformation;
 exports.restEntryPoints = restEntryPoints;

package/dist/esm/index.mjs

@@ -1,4 +1,4 @@
-import { ComponentFactory, Is } from '@twin.org/core';
+import { ComponentFactory, Is, Guards } from '@twin.org/core';
 import { HttpStatusCode } from '@twin.org/web';
 import { readFile } from 'node:fs/promises';
 
@@ -209,21 +209,16 @@ async function serverSpec(httpRequestContext, componentName, request) {
     };
 }
 
-const restEntryPoints = [
-    {
-        name: "information",
-        defaultBaseRoute: "",
-        tags: tagsInformation,
-        generateRoutes: generateRestRoutesInformation
-    }
-];
-
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
  * The information service for the server.
  */
 class InformationService {
+    /**
+     * The namespace supported by the information service.
+     */
+    static NAMESPACE = "information";
     /**
      * Runtime name for the class.
      */
@@ -250,15 +245,18 @@ class InformationService {
     _openApiSpec;
     /**
      * Create a new instance of InformationService.
-     * @param serverInfo The server information.
-     * @param openApiSpecPath The path to the spec file.
+     * @param options The options to create the service.
+     * @param options.config The configuration for the service.
      */
-    constructor(serverInfo, openApiSpecPath) {
-        this._serverInfo = serverInfo;
+    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._openApiSpecPath = openApiSpecPath;
+        this._openApiSpecPath = options.config.openApiSpecPath;
     }
     /**
      * The service needs to be started when the application is initialized.
@@ -344,4 +342,13 @@ class InformationService {
     }
 }
 
+const restEntryPoints = [
+    {
+        name: "information",
+        defaultBaseRoute: "",
+        tags: tagsInformation,
+        generateRoutes: generateRestRoutesInformation
+    }
+];
+
 export { InformationService, generateRestRoutesInformation, restEntryPoints, serverHealth, serverInfo, serverSpec, tagsInformation };

package/dist/types/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./informationRoutes";
-export * from "./restEntryPoints";
 export * from "./informationService";
+export * from "./models/IInformationServiceConfig";
+export * from "./restEntryPoints";

package/dist/types/informationService.d.ts

@@ -1,18 +1,25 @@
 import type { HealthStatus, IHealthInfo, IInformationComponent, IServerInfo } from "@twin.org/api-models";
+import type { IInformationServiceConfig } from "./models/IInformationServiceConfig";
 /**
  * The information service for the server.
  */
 export declare class InformationService implements IInformationComponent {
+    /**
+     * The namespace supported by the information service.
+     */
+    static readonly NAMESPACE: string;
     /**
      * Runtime name for the class.
      */
     readonly CLASS_NAME: string;
     /**
      * Create a new instance of InformationService.
-     * @param serverInfo The server information.
-     * @param openApiSpecPath The path to the spec file.
+     * @param options The options to create the service.
+     * @param options.config The configuration for the service.
      */
-    constructor(serverInfo: IServerInfo, openApiSpecPath?: string);
+    constructor(options: {
+        config: IInformationServiceConfig;
+    });
     /**
      * The service needs to be started when the application is initialized.
      * @returns Nothing.

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

@@ -0,0 +1,14 @@
+import type { IServerInfo } from "@twin.org/api-models";
+/**
+ * Configuration for the information service.
+ */
+export interface IInformationServiceConfig {
+    /**
+     * The server information.
+     */
+    serverInfo: IServerInfo;
+    /**
+     * The path to the OpenAPI Spec.
+     */
+    openApiSpecPath?: string;
+}

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/api-service - Changelog
 
-## v0.0.1-next.15
+## v0.0.1-next.17
 
 - Initial Release

package/docs/reference/classes/InformationService.md

@@ -10,19 +10,19 @@ The information service for the server.
 
 ### new InformationService()
 
-> **new InformationService**(`serverInfo`, `openApiSpecPath`?): [`InformationService`](InformationService.md)
+> **new InformationService**(`options`): [`InformationService`](InformationService.md)
 
 Create a new instance of InformationService.
 
 #### Parameters
 
-• **serverInfo**: `IServerInfo`
+• **options**
 
-The server information.
+The options to create the service.
 
-• **openApiSpecPath?**: `string`
+• **options.config**: [`IInformationServiceConfig`](../interfaces/IInformationServiceConfig.md)
 
-The path to the spec file.
+The configuration for the service.
 
 #### Returns
 
@@ -30,6 +30,14 @@ The path to the spec file.
 
 ## Properties
 
+### NAMESPACE
+
+> `readonly` `static` **NAMESPACE**: `string` = `"information"`
+
+The namespace supported by the information service.
+
+***
+
 ### CLASS\_NAME
 
 > `readonly` **CLASS\_NAME**: `string`

package/docs/reference/index.md

@@ -4,6 +4,10 @@
 
 - [InformationService](classes/InformationService.md)
 
+## Interfaces
+
+- [IInformationServiceConfig](interfaces/IInformationServiceConfig.md)
+
 ## Variables
 
 - [tagsInformation](variables/tagsInformation.md)

package/docs/reference/interfaces/IInformationServiceConfig.md

@@ -0,0 +1,19 @@
+# Interface: IInformationServiceConfig
+
+Configuration for the information service.
+
+## Properties
+
+### serverInfo
+
+> **serverInfo**: `IServerInfo`
+
+The server information.
+
+***
+
+### openApiSpecPath?
+
+> `optional` **openApiSpecPath**: `string`
+
+The path to the OpenAPI Spec.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/api-service",
-	"version": "0.0.1-next.15",
+	"version": "0.0.1-next.17",
 	"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.1-next.15",
+		"@twin.org/api-models": "0.0.1-next.17",
 		"@twin.org/core": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"