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

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,18 @@
-# @twin.org/api-service - Changelog
+# Changelog
+
+## [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/interfaces/IHostingServiceConstructorOptions.md

@@ -10,12 +10,6 @@ Options for the IHostingService constructor.
 
 The tenant admin component type.
 
-#### Default
-
-```ts
-tenant-admin
-```
-
 ***
 
 ### config

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.21",
+	"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.21",
 		"@twin.org/context": "next",
 		"@twin.org/core": "next",
 		"@twin.org/nameof": "next",