@twin.org/api-service 0.0.3-next.20 → 0.0.3-next.22

package/README.md

@@ -1,6 +1,6 @@
 # TWIN API Service
 
-Implementation of the information service.
+This package provides information and hosting service implementations with generated REST route handlers.
 
 ## Installation
 

package/docs/changelog.md

@@ -1,4 +1,32 @@
-# @twin.org/api-service - Changelog
+# Changelog
+
+## [0.0.3-next.22](https://github.com/twinfoundation/api/compare/api-service-v0.0.3-next.21...api-service-v0.0.3-next.22) (2026-03-27)
+
+
+### 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.21 to 0.0.3-next.22
+
+## [0.0.3-next.21](https://github.com/twinfoundation/api/compare/api-service-v0.0.3-next.20...api-service-v0.0.3-next.21) (2026-03-11)
+
+
+### 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.20 to 0.0.3-next.21
 
 ## [0.0.3-next.20](https://github.com/twinfoundation/api/compare/api-service-v0.0.3-next.19...api-service-v0.0.3-next.20) (2026-02-09)
 

package/docs/examples.md

@@ -1 +1,74 @@
-# @twin.org/api-service - Examples
+# Service Examples
+
+These snippets demonstrate how to configure service-level URL generation and expose operational information for monitoring.
+
+## InformationService
+
+```typescript
+import { InformationService } from '@twin.org/api-service';
+
+const infoService = new InformationService({
+  config: {
+    serverInfo: {
+      name: 'Twin API',
+      version: '1.2.0'
+    }
+  }
+});
+
+await infoService.start();
+console.log(infoService.className()); // InformationService
+
+const root = await infoService.root();
+const info = await infoService.info();
+const favicon = await infoService.favicon();
+
+console.log(root); // Twin API - 1.2.0
+console.log(info.version); // 1.2.0
+console.log((favicon?.byteLength ?? 0) > 0); // true
+```
+
+```typescript
+import { InformationService } from '@twin.org/api-service';
+
+const infoService = new InformationService({
+  config: {
+    serverInfo: {
+      name: 'Twin API',
+      version: '1.2.0'
+    }
+  }
+});
+
+const spec = await infoService.spec();
+const live = await infoService.livez();
+const health = await infoService.health();
+
+await infoService.setComponentHealth('queue', 'ok');
+await infoService.removeComponentHealth('queue');
+
+console.log(typeof spec); // undefined
+console.log(live); // true
+console.log(health.status); // ok
+```
+
+## HostingService
+
+```typescript
+import { HostingService } from '@twin.org/api-service';
+
+const hostingService = new HostingService({
+  config: {
+    localOrigin: 'http://localhost:3000',
+    publicOrigin: 'https://api.example.org'
+  }
+});
+
+console.log(hostingService.className()); // HostingService
+
+const publicOrigin = await hostingService.getPublicOrigin('http://localhost:3000/users');
+const usersUrl = await hostingService.buildPublicUrl('http://localhost:3000/users');
+
+console.log(publicOrigin); // https://api.example.org
+console.log(usersUrl); // https://api.example.org/users
+```

package/docs/reference/classes/HostingService.md

@@ -28,7 +28,7 @@ The options to create the service.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -36,7 +36,7 @@ Runtime name for the class.
 
 ## Methods
 
-### className()
+### className() {#classname}
 
 > **className**(): `string`
 
@@ -54,7 +54,7 @@ The class name of the component.
 
 ***
 
-### getPublicOrigin()
+### getPublicOrigin() {#getpublicorigin}
 
 > **getPublicOrigin**(`serverRequestUrl?`): `Promise`\<`string`\>
 
@@ -80,7 +80,7 @@ The public origin.
 
 ***
 
-### getTenantOrigin()
+### getTenantOrigin() {#gettenantorigin}
 
 > **getTenantOrigin**(`tenantId`): `Promise`\<`string` \| `undefined`\>
 
@@ -106,7 +106,7 @@ The public origin for the tenant.
 
 ***
 
-### buildPublicUrl()
+### buildPublicUrl() {#buildpublicurl}
 
 > **buildPublicUrl**(`url`): `Promise`\<`string`\>
 

package/docs/reference/classes/InformationService.md

@@ -28,7 +28,7 @@ The options to create the service.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -36,7 +36,7 @@ Runtime name for the class.
 
 ## Methods
 
-### className()
+### className() {#classname}
 
 > **className**(): `string`
 
@@ -54,7 +54,7 @@ The class name of the component.
 
 ***
 
-### start()
+### start() {#start}
 
 > **start**(): `Promise`\<`void`\>
 
@@ -72,7 +72,7 @@ Nothing.
 
 ***
 
-### root()
+### root() {#root}
 
 > **root**(): `Promise`\<`string`\>
 
@@ -90,7 +90,7 @@ The root information.
 
 ***
 
-### info()
+### info() {#info}
 
 > **info**(): `Promise`\<`IServerInfo`\>
 
@@ -108,7 +108,7 @@ The service information.
 
 ***
 
-### favicon()
+### favicon() {#favicon}
 
 > **favicon**(): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\> \| `undefined`\>
 
@@ -126,7 +126,7 @@ The favicon.
 
 ***
 
-### spec()
+### spec() {#spec}
 
 > **spec**(): `Promise`\<`unknown`\>
 
@@ -144,7 +144,7 @@ The OpenAPI spec.
 
 ***
 
-### livez()
+### livez() {#livez}
 
 > **livez**(): `Promise`\<`boolean`\>
 
@@ -162,7 +162,7 @@ True if the server is live.
 
 ***
 
-### health()
+### health() {#health}
 
 > **health**(): `Promise`\<`IHealthInfo`\>
 
@@ -180,7 +180,7 @@ The service health.
 
 ***
 
-### setComponentHealth()
+### setComponentHealth() {#setcomponenthealth}
 
 > **setComponentHealth**(`name`, `status`, `details?`, `tenantId?`): `Promise`\<`void`\>
 
@@ -224,7 +224,7 @@ Nothing.
 
 ***
 
-### removeComponentHealth()
+### removeComponentHealth() {#removecomponenthealth}
 
 > **removeComponentHealth**(`name`, `tenantId?`): `Promise`\<`void`\>
 

package/docs/reference/interfaces/IHostingServiceConfig.md

@@ -4,7 +4,7 @@ Configuration for the hosting service.
 
 ## Properties
 
-### localOrigin
+### localOrigin {#localorigin}
 
 > **localOrigin**: `string`
 
@@ -12,8 +12,8 @@ The local origin, must be provided as a fallback e.g. http://localhost:1234.
 
 ***
 
-### publicOrigin?
+### publicOrigin? {#publicorigin}
 
-> `optional` **publicOrigin**: `string`
+> `optional` **publicOrigin?**: `string`
 
 The APIs public base URL e.g. "https://api.example.com:1234".

package/docs/reference/interfaces/IHostingServiceConstructorOptions.md

@@ -4,9 +4,9 @@ Options for the IHostingService constructor.
 
 ## Properties
 
-### tenantAdminComponentType?
+### tenantAdminComponentType? {#tenantadmincomponenttype}
 
-> `optional` **tenantAdminComponentType**: `string`
+> `optional` **tenantAdminComponentType?**: `string`
 
 The tenant admin component type.
 
@@ -18,7 +18,7 @@ tenant-admin
 
 ***
 
-### config
+### config {#config}
 
 > **config**: [`IHostingServiceConfig`](IHostingServiceConfig.md)
 

package/docs/reference/interfaces/IInformationServiceConfig.md

@@ -4,7 +4,7 @@ Configuration for the information service.
 
 ## Properties
 
-### serverInfo
+### serverInfo {#serverinfo}
 
 > **serverInfo**: `IServerInfo`
 
@@ -12,16 +12,16 @@ The server information.
 
 ***
 
-### openApiSpecPath?
+### openApiSpecPath? {#openapispecpath}
 
-> `optional` **openApiSpecPath**: `string`
+> `optional` **openApiSpecPath?**: `string`
 
 The path to the OpenAPI Spec.
 
 ***
 
-### favIconPath?
+### favIconPath? {#faviconpath}
 
-> `optional` **favIconPath**: `string`
+> `optional` **favIconPath?**: `string`
 
 The path to the favicon.

package/docs/reference/interfaces/IInformationServiceConstructorOptions.md

@@ -4,7 +4,7 @@ Options for the InformationService constructor.
 
 ## Properties
 
-### config
+### config {#config}
 
 > **config**: [`IInformationServiceConfig`](IInformationServiceConfig.md)
 

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@twin.org/api-service",
-	"version": "0.0.3-next.20",
-	"description": "Information contract implementation and REST endpoint definitions",
+	"version": "0.0.3-next.22",
+	"description": "Information and hosting service implementations with generated REST route handlers.",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/twinfoundation/api.git",
@@ -14,7 +14,7 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/api-models": "0.0.3-next.20",
+		"@twin.org/api-models": "0.0.3-next.22",
 		"@twin.org/context": "next",
 		"@twin.org/core": "next",
 		"@twin.org/nameof": "next",