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

package/dist/cjs/index.cjs

@@ -248,7 +248,6 @@ class InformationService {
     /**
      * Create a new instance of InformationService.
      * @param options The options to create the service.
-     * @param options.config The configuration for the service.
      */
     constructor(options) {
         core.Guards.object(this.CLASS_NAME, "options", options);

package/dist/esm/index.mjs

@@ -246,7 +246,6 @@ class InformationService {
     /**
      * Create a new instance of InformationService.
      * @param options The options to create the service.
-     * @param options.config The configuration for the service.
      */
     constructor(options) {
         Guards.object(this.CLASS_NAME, "options", options);

package/dist/types/index.d.ts

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

package/dist/types/informationService.d.ts

@@ -1,5 +1,5 @@
 import type { HealthStatus, IHealthInfo, IInformationComponent, IServerInfo } from "@twin.org/api-models";
-import type { IInformationServiceConfig } from "./models/IInformationServiceConfig";
+import type { IInformationServiceConstructorOptions } from "./models/IInformationServiceConstructorOptions";
 /**
  * The information service for the server.
  */
@@ -15,11 +15,8 @@ export declare class InformationService implements IInformationComponent {
     /**
      * Create a new instance of InformationService.
      * @param options The options to create the service.
-     * @param options.config The configuration for the service.
      */
-    constructor(options: {
-        config: IInformationServiceConfig;
-    });
+    constructor(options: IInformationServiceConstructorOptions);
     /**
      * The service needs to be started when the application is initialized.
      * @returns Nothing.

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,5 @@
 # @twin.org/api-service - Changelog
 
-## v0.0.1-next.25
+## v0.0.1-next.26
 
 - Initial Release

package/docs/reference/classes/InformationService.md

@@ -16,13 +16,11 @@ Create a new instance of InformationService.
 
 #### Parameters
 
-• **options**
+##### options
 
-The options to create the service.
-
-• **options.config**: [`IInformationServiceConfig`](../interfaces/IInformationServiceConfig.md)
+[`IInformationServiceConstructorOptions`](../interfaces/IInformationServiceConstructorOptions.md)
 
-The configuration for the service.
+The options to create the service.
 
 #### Returns
 
@@ -130,15 +128,21 @@ 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.
 
@@ -162,7 +166,9 @@ Remove the status of a component.
 
 #### Parameters
 
-• **name**: `string`
+##### name
+
+`string`
 
 The component name.
 

package/docs/reference/functions/generateRestRoutesInformation.md

@@ -6,11 +6,15 @@ 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.
 

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

@@ -7,6 +7,7 @@
 ## Interfaces
 
 - [IInformationServiceConfig](interfaces/IInformationServiceConfig.md)
+- [IInformationServiceConstructorOptions](interfaces/IInformationServiceConstructorOptions.md)
 
 ## Variables
 

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.25",
+	"version": "0.0.1-next.26",
 	"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.25",
+		"@twin.org/api-models": "0.0.1-next.26",
 		"@twin.org/core": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"