@twin.org/api-service 0.0.1-next.8 → 0.0.1

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,17 @@ 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.
      */
-    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.
@@ -339,13 +336,22 @@ class InformationService {
     async removeComponentHealth(name) {
         if (core.Is.arrayValue(this._healthInfo.components)) {
             const componentIndex = this._healthInfo.components.findIndex(c => c.name === name);
-            if (componentIndex >= 0) {
+            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;

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,17 @@ 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.
      */
-    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.
@@ -337,11 +334,20 @@ class InformationService {
     async removeComponentHealth(name) {
         if (Is.arrayValue(this._healthInfo.components)) {
             const componentIndex = this._healthInfo.components.findIndex(c => c.name === name);
-            if (componentIndex >= 0) {
+            if (componentIndex !== -1) {
                 this._healthInfo.components.splice(componentIndex, 1);
             }
         }
     }
 }
 
+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,5 @@
 export * from "./informationRoutes";
-export * from "./restEntryPoints";
 export * from "./informationService";
+export * from "./models/IInformationServiceConfig";
+export * from "./models/IInformationServiceConstructorOptions";
+export * from "./restEntryPoints";

package/dist/types/informationService.d.ts

@@ -1,18 +1,22 @@
 import type { HealthStatus, IHealthInfo, IInformationComponent, IServerInfo } from "@twin.org/api-models";
+import type { IInformationServiceConstructorOptions } from "./models/IInformationServiceConstructorOptions";
 /**
  * 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.
      */
-    constructor(serverInfo: IServerInfo, openApiSpecPath?: string);
+    constructor(options: IInformationServiceConstructorOptions);
     /**
      * 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/dist/types/models/IInformationServiceConstructorOptions.d.ts

@@ -0,0 +1,10 @@
+import type { IInformationServiceConfig } from "./IInformationServiceConfig";
+/**
+ * Options for the InformationService constructor.
+ */
+export interface IInformationServiceConstructorOptions {
+    /**
+     * The configuration for the service.
+     */
+    config: IInformationServiceConfig;
+}

package/docs/changelog.md

@@ -1,5 +1,89 @@
 # @twin.org/api-service - Changelog
 
-## v0.0.1-next.8
+## 0.0.1 (2025-07-03)
+
+
+### Features
+
+* release to production ([70ee2d5](https://github.com/twinfoundation/api/commit/70ee2d56a1dc9537d7c9c154d4cb78a235678a3a))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from ^0.0.0 to ^0.0.1
+
+## [0.0.1-next.36](https://github.com/twinfoundation/api/compare/api-service-v0.0.1-next.35...api-service-v0.0.1-next.36) (2025-06-17)
+
+
+### Miscellaneous Chores
+
+* **api-service:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.1-next.35 to 0.0.1-next.36
+
+## [0.0.1-next.35](https://github.com/twinfoundation/api/compare/api-service-v0.0.1-next.34...api-service-v0.0.1-next.35) (2025-06-11)
+
+
+### Features
+
+* update dependencies ([1171dc4](https://github.com/twinfoundation/api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.1-next.34 to 0.0.1-next.35
+
+## [0.0.1-next.34](https://github.com/twinfoundation/api/compare/api-service-v0.0.1-next.33...api-service-v0.0.1-next.34) (2025-05-27)
+
+
+### Miscellaneous Chores
+
+* **api-service:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.1-next.33 to 0.0.1-next.34
+
+## [0.0.1-next.33](https://github.com/twinfoundation/api/compare/api-service-v0.0.1-next.32...api-service-v0.0.1-next.33) (2025-04-17)
+
+
+### Features
+
+* 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.1-next.32 to 0.0.1-next.33
+
+## [0.0.1-next.32](https://github.com/twinfoundation/api/compare/api-service-v0.0.1-next.31...api-service-v0.0.1-next.32) (2025-03-28)
+
+
+### Miscellaneous Chores
+
+* **api-service:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.1-next.31 to 0.0.1-next.32
+
+## v0.0.1-next.31
 
 - Initial Release

package/docs/reference/classes/InformationService.md

@@ -8,28 +8,34 @@ The information service for the server.
 
 ## Constructors
 
-### new InformationService()
+### Constructor
 
-> **new InformationService**(`serverInfo`, `openApiSpecPath`?): [`InformationService`](InformationService.md)
+> **new InformationService**(`options`): `InformationService`
 
 Create a new instance of InformationService.
 
 #### Parameters
 
-• **serverInfo**: `IServerInfo`
+##### options
 
-The server information.
+[`IInformationServiceConstructorOptions`](../interfaces/IInformationServiceConstructorOptions.md)
 
-• **openApiSpecPath?**: `string`
-
-The path to the spec file.
+The options to create the service.
 
 #### Returns
 
-[`InformationService`](InformationService.md)
+`InformationService`
 
 ## Properties
 
+### NAMESPACE
+
+> `readonly` `static` **NAMESPACE**: `string` = `"information"`
+
+The namespace supported by the information service.
+
+***
+
 ### CLASS\_NAME
 
 > `readonly` **CLASS\_NAME**: `string`
@@ -116,21 +122,27 @@ The service health.
 
 ### setComponentHealth()
 
-> **setComponentHealth**(`name`, `status`, `details`?): `Promise`\<`void`\>
+> **setComponentHealth**(`name`, `status`, `details?`): `Promise`\<`void`\>
 
 Set the status of a component.
 
 #### Parameters
 
-• **name**: `string`
+##### name
+
+`string`
 
 The component name.
 
-• **status**: `HealthStatus`
+##### status
+
+`HealthStatus`
 
 The status of the component.
 
-• **details?**: `string`
+##### details?
+
+`string`
 
 The details for the status.
 
@@ -154,7 +166,9 @@ Remove the status of a component.
 
 #### Parameters
 
-• **name**: `string`
+##### name
+
+`string`
 
 The component name.
 

package/docs/reference/functions/generateRestRoutesInformation.md

@@ -1,21 +1,25 @@
 # Function: generateRestRoutesInformation()
 
-> **generateRestRoutesInformation**(`baseRouteName`, `componentName`): `IRestRoute`[]
+> **generateRestRoutesInformation**(`baseRouteName`, `componentName`): `IRestRoute`\<`any`, `any`\>[]
 
 The REST routes for server information.
 
 ## Parameters
 
-• **baseRouteName**: `string`
+### baseRouteName
+
+`string`
 
 Prefix to prepend to the paths.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes stored in the ComponentFactory.
 
 ## Returns
 
-`IRestRoute`[]
+`IRestRoute`\<`any`, `any`\>[]
 
 The generated routes.

package/docs/reference/functions/serverHealth.md

@@ -6,15 +6,21 @@ Get the health for the server.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes.
 
-• **request**: `INoContentRequest`
+### request
+
+`INoContentRequest`
 
 The request.
 

package/docs/reference/functions/serverInfo.md

@@ -6,15 +6,21 @@ Get the information for the server.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes.
 
-• **request**: `INoContentRequest`
+### request
+
+`INoContentRequest`
 
 The request.
 

package/docs/reference/functions/serverSpec.md

@@ -6,15 +6,21 @@ Get the spec for the server.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes.
 
-• **request**: `INoContentRequest`
+### request
+
+`INoContentRequest`
 
 The request.
 

package/docs/reference/index.md

@@ -4,6 +4,11 @@
 
 - [InformationService](classes/InformationService.md)
 
+## Interfaces
+
+- [IInformationServiceConfig](interfaces/IInformationServiceConfig.md)
+- [IInformationServiceConstructorOptions](interfaces/IInformationServiceConstructorOptions.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/docs/reference/interfaces/IInformationServiceConstructorOptions.md

@@ -0,0 +1,11 @@
+# Interface: IInformationServiceConstructorOptions
+
+Options for the InformationService constructor.
+
+## Properties
+
+### config
+
+> **config**: [`IInformationServiceConfig`](IInformationServiceConfig.md)
+
+The configuration for the service.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/api-service",
-	"version": "0.0.1-next.8",
+	"version": "0.0.1",
 	"description": "Information contract implementation and REST endpoint definitions",
 	"repository": {
 		"type": "git",
@@ -14,19 +14,19 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/api-models": "0.0.1-next.8",
-		"@twin.org/core": "next",
-		"@twin.org/nameof": "next",
-		"@twin.org/web": "next"
+		"@twin.org/api-models": "^0.0.1",
+		"@twin.org/core": "^0.0.1",
+		"@twin.org/nameof": "^0.0.1",
+		"@twin.org/web": "^0.0.1"
 	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
+			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs",
-			"types": "./dist/types/index.d.ts"
+			"import": "./dist/esm/index.mjs"
 		}
 	},
 	"files": [