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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/docs/changelog.md +28 -0
  2. package/docs/reference/classes/HostingService.md +5 -5
  3. package/docs/reference/classes/InformationService.md +11 -11
  4. package/docs/reference/interfaces/IHostingServiceConfig.md +3 -3
  5. package/docs/reference/interfaces/IHostingServiceConstructorOptions.md +9 -3
  6. package/docs/reference/interfaces/IInformationServiceConfig.md +5 -5
  7. package/docs/reference/interfaces/IInformationServiceConstructorOptions.md +1 -1
  8. package/package.json +2 -2
package/docs/changelog.md CHANGED
@@ -1,5 +1,33 @@
1
1
  # Changelog
2
2
 
3
+ ## [0.0.3-next.23](https://github.com/twinfoundation/api/compare/api-service-v0.0.3-next.22...api-service-v0.0.3-next.23) (2026-04-14)
4
+
5
+
6
+ ### Miscellaneous Chores
7
+
8
+ * **api-service:** Synchronize repo versions
9
+
10
+
11
+ ### Dependencies
12
+
13
+ * The following workspace dependencies were updated
14
+ * dependencies
15
+ * @twin.org/api-models bumped from 0.0.3-next.22 to 0.0.3-next.23
16
+
17
+ ## [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)
18
+
19
+
20
+ ### Miscellaneous Chores
21
+
22
+ * **api-service:** Synchronize repo versions
23
+
24
+
25
+ ### Dependencies
26
+
27
+ * The following workspace dependencies were updated
28
+ * dependencies
29
+ * @twin.org/api-models bumped from 0.0.3-next.21 to 0.0.3-next.22
30
+
3
31
  ## [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)
4
32
 
5
33
 
package/docs/reference/classes/HostingService.md CHANGED
@@ -28,7 +28,7 @@ The options to create the service.
28
28
 
29
29
  ## Properties
30
30
 
31
- ### CLASS\_NAME
31
+ ### CLASS\_NAME {#class_name}
32
32
 
33
33
  > `readonly` `static` **CLASS\_NAME**: `string`
34
34
 
@@ -36,7 +36,7 @@ Runtime name for the class.
36
36
 
37
37
  ## Methods
38
38
 
39
- ### className()
39
+ ### className() {#classname}
40
40
 
41
41
  > **className**(): `string`
42
42
 
@@ -54,7 +54,7 @@ The class name of the component.
54
54
 
55
55
  ***
56
56
 
57
- ### getPublicOrigin()
57
+ ### getPublicOrigin() {#getpublicorigin}
58
58
 
59
59
  > **getPublicOrigin**(`serverRequestUrl?`): `Promise`\<`string`\>
60
60
 
@@ -80,7 +80,7 @@ The public origin.
80
80
 
81
81
  ***
82
82
 
83
- ### getTenantOrigin()
83
+ ### getTenantOrigin() {#gettenantorigin}
84
84
 
85
85
  > **getTenantOrigin**(`tenantId`): `Promise`\<`string` \| `undefined`\>
86
86
 
@@ -106,7 +106,7 @@ The public origin for the tenant.
106
106
 
107
107
  ***
108
108
 
109
- ### buildPublicUrl()
109
+ ### buildPublicUrl() {#buildpublicurl}
110
110
 
111
111
  > **buildPublicUrl**(`url`): `Promise`\<`string`\>
112
112
 
package/docs/reference/classes/InformationService.md CHANGED
@@ -28,7 +28,7 @@ The options to create the service.
28
28
 
29
29
  ## Properties
30
30
 
31
- ### CLASS\_NAME
31
+ ### CLASS\_NAME {#class_name}
32
32
 
33
33
  > `readonly` `static` **CLASS\_NAME**: `string`
34
34
 
@@ -36,7 +36,7 @@ Runtime name for the class.
36
36
 
37
37
  ## Methods
38
38
 
39
- ### className()
39
+ ### className() {#classname}
40
40
 
41
41
  > **className**(): `string`
42
42
 
@@ -54,7 +54,7 @@ The class name of the component.
54
54
 
55
55
  ***
56
56
 
57
- ### start()
57
+ ### start() {#start}
58
58
 
59
59
  > **start**(): `Promise`\<`void`\>
60
60
 
@@ -72,7 +72,7 @@ Nothing.
72
72
 
73
73
  ***
74
74
 
75
- ### root()
75
+ ### root() {#root}
76
76
 
77
77
  > **root**(): `Promise`\<`string`\>
78
78
 
@@ -90,7 +90,7 @@ The root information.
90
90
 
91
91
  ***
92
92
 
93
- ### info()
93
+ ### info() {#info}
94
94
 
95
95
  > **info**(): `Promise`\<`IServerInfo`\>
96
96
 
@@ -108,7 +108,7 @@ The service information.
108
108
 
109
109
  ***
110
110
 
111
- ### favicon()
111
+ ### favicon() {#favicon}
112
112
 
113
113
  > **favicon**(): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\> \| `undefined`\>
114
114
 
@@ -126,7 +126,7 @@ The favicon.
126
126
 
127
127
  ***
128
128
 
129
- ### spec()
129
+ ### spec() {#spec}
130
130
 
131
131
  > **spec**(): `Promise`\<`unknown`\>
132
132
 
@@ -144,7 +144,7 @@ The OpenAPI spec.
144
144
 
145
145
  ***
146
146
 
147
- ### livez()
147
+ ### livez() {#livez}
148
148
 
149
149
  > **livez**(): `Promise`\<`boolean`\>
150
150
 
@@ -162,7 +162,7 @@ True if the server is live.
162
162
 
163
163
  ***
164
164
 
165
- ### health()
165
+ ### health() {#health}
166
166
 
167
167
  > **health**(): `Promise`\<`IHealthInfo`\>
168
168
 
@@ -180,7 +180,7 @@ The service health.
180
180
 
181
181
  ***
182
182
 
183
- ### setComponentHealth()
183
+ ### setComponentHealth() {#setcomponenthealth}
184
184
 
185
185
  > **setComponentHealth**(`name`, `status`, `details?`, `tenantId?`): `Promise`\<`void`\>
186
186
 
@@ -224,7 +224,7 @@ Nothing.
224
224
 
225
225
  ***
226
226
 
227
- ### removeComponentHealth()
227
+ ### removeComponentHealth() {#removecomponenthealth}
228
228
 
229
229
  > **removeComponentHealth**(`name`, `tenantId?`): `Promise`\<`void`\>
230
230
 
package/docs/reference/interfaces/IHostingServiceConfig.md CHANGED
@@ -4,7 +4,7 @@ Configuration for the hosting service.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### localOrigin
7
+ ### localOrigin {#localorigin}
8
8
 
9
9
  > **localOrigin**: `string`
10
10
 
@@ -12,8 +12,8 @@ The local origin, must be provided as a fallback e.g. http://localhost:1234.
12
12
 
13
13
  ***
14
14
 
15
- ### publicOrigin?
15
+ ### publicOrigin? {#publicorigin}
16
16
 
17
- > `optional` **publicOrigin**: `string`
17
+ > `optional` **publicOrigin?**: `string`
18
18
 
19
19
  The APIs public base URL e.g. "https://api.example.com:1234".
package/docs/reference/interfaces/IHostingServiceConstructorOptions.md CHANGED
@@ -4,15 +4,21 @@ Options for the IHostingService constructor.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### tenantAdminComponentType?
7
+ ### tenantAdminComponentType? {#tenantadmincomponenttype}
8
8
 
9
- > `optional` **tenantAdminComponentType**: `string`
9
+ > `optional` **tenantAdminComponentType?**: `string`
10
10
 
11
11
  The tenant admin component type.
12
12
 
13
+ #### Default
14
+
15
+ ```ts
16
+ tenant-admin
17
+ ```
18
+
13
19
  ***
14
20
 
15
- ### config
21
+ ### config {#config}
16
22
 
17
23
  > **config**: [`IHostingServiceConfig`](IHostingServiceConfig.md)
18
24
 
package/docs/reference/interfaces/IInformationServiceConfig.md CHANGED
@@ -4,7 +4,7 @@ Configuration for the information service.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### serverInfo
7
+ ### serverInfo {#serverinfo}
8
8
 
9
9
  > **serverInfo**: `IServerInfo`
10
10
 
@@ -12,16 +12,16 @@ The server information.
12
12
 
13
13
  ***
14
14
 
15
- ### openApiSpecPath?
15
+ ### openApiSpecPath? {#openapispecpath}
16
16
 
17
- > `optional` **openApiSpecPath**: `string`
17
+ > `optional` **openApiSpecPath?**: `string`
18
18
 
19
19
  The path to the OpenAPI Spec.
20
20
 
21
21
  ***
22
22
 
23
- ### favIconPath?
23
+ ### favIconPath? {#faviconpath}
24
24
 
25
- > `optional` **favIconPath**: `string`
25
+ > `optional` **favIconPath?**: `string`
26
26
 
27
27
  The path to the favicon.
package/docs/reference/interfaces/IInformationServiceConstructorOptions.md CHANGED
@@ -4,7 +4,7 @@ Options for the InformationService constructor.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### config
7
+ ### config {#config}
8
8
 
9
9
  > **config**: [`IInformationServiceConfig`](IInformationServiceConfig.md)
10
10
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/api-service",
3
- "version": "0.0.3-next.21",
3
+ "version": "0.0.3-next.23",
4
4
  "description": "Information and hosting service implementations with generated REST route handlers.",
5
5
  "repository": {
6
6
  "type": "git",
@@ -14,7 +14,7 @@
14
14
  "node": ">=20.0.0"
15
15
  },
16
16
  "dependencies": {
17
- "@twin.org/api-models": "0.0.3-next.21",
17
+ "@twin.org/api-models": "0.0.3-next.23",
18
18
  "@twin.org/context": "next",
19
19
  "@twin.org/core": "next",
20
20
  "@twin.org/nameof": "next",