@twin.org/api-models 0.0.2-next.7 → 0.0.2-next.8

package/dist/types/index.d.ts

@@ -3,8 +3,10 @@ export * from "./factories/restRouteProcessorFactory";
 export * from "./factories/socketRouteProcessorFactory";
 export * from "./helpers/httpErrorHelper";
 export * from "./helpers/httpParameterHelper";
+export * from "./models/api/IServerFavIconResponse";
 export * from "./models/api/IServerHealthResponse";
 export * from "./models/api/IServerInfoResponse";
+export * from "./models/api/IServerRootResponse";
 export * from "./models/api/IServerSpecResponse";
 export * from "./models/config/IBaseRestClientConfig";
 export * from "./models/config/IBaseSocketClientConfig";

package/dist/types/models/api/IServerFavIconResponse.d.ts

@@ -0,0 +1,23 @@
+import type { HeaderTypes, HttpStatusCode } from "@twin.org/web";
+/**
+ * The favicon for the server.
+ */
+export interface IServerFavIconResponse {
+    /**
+     * Additional response headers.
+     */
+    headers?: {
+        /**
+         * The content type for the response.
+         */
+        [HeaderTypes.ContentType]?: string;
+    };
+    /**
+     * Response status code.
+     */
+    statusCode?: HttpStatusCode;
+    /**
+     * The favicon for the server.
+     */
+    body?: Uint8Array;
+}

package/dist/types/models/api/IServerRootResponse.d.ts

@@ -0,0 +1,9 @@
+/**
+ * The root text for the server.
+ */
+export interface IServerRootResponse {
+    /**
+     * The root text for the server.
+     */
+    body: string;
+}

package/dist/types/models/services/IInformationComponent.d.ts

@@ -6,11 +6,21 @@ import type { IServerInfo } from "./IServerInfo";
  * The information component for the server.
  */
 export interface IInformationComponent extends IComponent {
+    /**
+     * Get the root information.
+     * @returns The root information.
+     */
+    root(): Promise<string>;
     /**
      * Get the server information.
      * @returns The service information.
      */
     info(): Promise<IServerInfo>;
+    /**
+     * Get the favicon.
+     * @returns The favicon.
+     */
+    favicon(): Promise<Uint8Array | undefined>;
     /**
      * Get the OpenAPI spec.
      * @returns The OpenAPI spec.

package/docs/changelog.md

@@ -1,5 +1,12 @@
 # @twin.org/api-models - Changelog
 
+## [0.0.2-next.8](https://github.com/twinfoundation/api/compare/api-models-v0.0.2-next.7...api-models-v0.0.2-next.8) (2025-08-21)
+
+
+### Features
+
+* add root, favicon routes ([71da1c3](https://github.com/twinfoundation/api/commit/71da1c3a93c349588aff7084d1d8d6a29a277da8))
+
 ## [0.0.2-next.7](https://github.com/twinfoundation/api/compare/api-models-v0.0.2-next.6...api-models-v0.0.2-next.7) (2025-08-20)
 
 

package/docs/reference/index.md

@@ -7,8 +7,10 @@
 
 ## Interfaces
 
+- [IServerFavIconResponse](interfaces/IServerFavIconResponse.md)
 - [IServerHealthResponse](interfaces/IServerHealthResponse.md)
 - [IServerInfoResponse](interfaces/IServerInfoResponse.md)
+- [IServerRootResponse](interfaces/IServerRootResponse.md)
 - [IServerSpecResponse](interfaces/IServerSpecResponse.md)
 - [IBaseRestClientConfig](interfaces/IBaseRestClientConfig.md)
 - [IBaseSocketClientConfig](interfaces/IBaseSocketClientConfig.md)

package/docs/reference/interfaces/IInformationComponent.md

@@ -8,6 +8,20 @@ The information component for the server.
 
 ## Methods
 
+### root()
+
+> **root**(): `Promise`\<`string`\>
+
+Get the root information.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The root information.
+
+***
+
 ### info()
 
 > **info**(): `Promise`\<[`IServerInfo`](IServerInfo.md)\>
@@ -22,6 +36,20 @@ The service information.
 
 ***
 
+### favicon()
+
+> **favicon**(): `Promise`\<`undefined` \| `Uint8Array`\<`ArrayBufferLike`\>\>
+
+Get the favicon.
+
+#### Returns
+
+`Promise`\<`undefined` \| `Uint8Array`\<`ArrayBufferLike`\>\>
+
+The favicon.
+
+***
+
 ### spec()
 
 > **spec**(): `Promise`\<`unknown`\>

package/docs/reference/interfaces/IServerFavIconResponse.md

@@ -0,0 +1,33 @@
+# Interface: IServerFavIconResponse
+
+The favicon for the server.
+
+## Properties
+
+### headers?
+
+> `optional` **headers**: `object`
+
+Additional response headers.
+
+#### content-type?
+
+> `optional` **content-type**: `string`
+
+The content type for the response.
+
+***
+
+### statusCode?
+
+> `optional` **statusCode**: `HttpStatusCode`
+
+Response status code.
+
+***
+
+### body?
+
+> `optional` **body**: `Uint8Array`\<`ArrayBufferLike`\>
+
+The favicon for the server.

package/docs/reference/interfaces/IServerRootResponse.md

@@ -0,0 +1,11 @@
+# Interface: IServerRootResponse
+
+The root text for the server.
+
+## Properties
+
+### body
+
+> **body**: `string`
+
+The root text for the server.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/api-models",
-	"version": "0.0.2-next.7",
+	"version": "0.0.2-next.8",
 	"description": "Contains models and classes for use with APIs",
 	"repository": {
 		"type": "git",