@twin.org/api-rest-client 0.0.2-next.1 → 0.0.2-next.11

package/dist/cjs/index.cjs

@@ -20,6 +20,14 @@ class InformationClient extends apiCore.BaseRestClient {
     constructor(config) {
         super("InformationClient", config, "");
     }
+    /**
+     * Get the server root.
+     * @returns The root root.
+     */
+    async root() {
+        const response = await this.fetch("/", "GET");
+        return response.body;
+    }
     /**
      * Get the server information.
      * @returns The service information.
@@ -28,6 +36,14 @@ class InformationClient extends apiCore.BaseRestClient {
         const response = await this.fetch("/info", "GET");
         return response.body;
     }
+    /**
+     * Get the favicon.
+     * @returns The favicon.
+     */
+    async favicon() {
+        const response = await this.fetch("/favicon.ico", "GET");
+        return response.body;
+    }
     /**
      * Get the OpenAPI spec.
      * @returns The OpenAPI spec.

package/dist/esm/index.mjs

@@ -18,6 +18,14 @@ class InformationClient extends BaseRestClient {
     constructor(config) {
         super("InformationClient", config, "");
     }
+    /**
+     * Get the server root.
+     * @returns The root root.
+     */
+    async root() {
+        const response = await this.fetch("/", "GET");
+        return response.body;
+    }
     /**
      * Get the server information.
      * @returns The service information.
@@ -26,6 +34,14 @@ class InformationClient extends BaseRestClient {
         const response = await this.fetch("/info", "GET");
         return response.body;
     }
+    /**
+     * Get the favicon.
+     * @returns The favicon.
+     */
+    async favicon() {
+        const response = await this.fetch("/favicon.ico", "GET");
+        return response.body;
+    }
     /**
      * Get the OpenAPI spec.
      * @returns The OpenAPI spec.

package/dist/types/informationClient.d.ts

@@ -13,11 +13,21 @@ export declare class InformationClient extends BaseRestClient implements IInform
      * @param config The configuration for the client.
      */
     constructor(config: IBaseRestClientConfig);
+    /**
+     * Get the server root.
+     * @returns The root root.
+     */
+    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,156 @@
 # @twin.org/api-rest-client - Changelog
 
+## [0.0.2-next.11](https://github.com/twinfoundation/api/compare/api-rest-client-v0.0.2-next.10...api-rest-client-v0.0.2-next.11) (2025-09-29)
+
+
+### Features
+
+* update IComponent signatures ([915ce37](https://github.com/twinfoundation/api/commit/915ce37712326ab4aa6869c350eabaa4622e8430))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-core bumped from 0.0.2-next.10 to 0.0.2-next.11
+    * @twin.org/api-models bumped from 0.0.2-next.10 to 0.0.2-next.11
+
+## [0.0.2-next.10](https://github.com/twinfoundation/api/compare/api-rest-client-v0.0.2-next.9...api-rest-client-v0.0.2-next.10) (2025-09-23)
+
+
+### Miscellaneous Chores
+
+* **api-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-core bumped from 0.0.2-next.9 to 0.0.2-next.10
+    * @twin.org/api-models bumped from 0.0.2-next.9 to 0.0.2-next.10
+
+## [0.0.2-next.9](https://github.com/twinfoundation/api/compare/api-rest-client-v0.0.2-next.8...api-rest-client-v0.0.2-next.9) (2025-08-29)
+
+
+### Features
+
+* eslint migration to flat config ([0dd5820](https://github.com/twinfoundation/api/commit/0dd5820e3af97350fd08b8d226f4a6c1a9246805))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-core bumped from 0.0.2-next.8 to 0.0.2-next.9
+    * @twin.org/api-models bumped from 0.0.2-next.8 to 0.0.2-next.9
+
+## [0.0.2-next.8](https://github.com/twinfoundation/api/compare/api-rest-client-v0.0.2-next.7...api-rest-client-v0.0.2-next.8) (2025-08-21)
+
+
+### Features
+
+* add root, favicon routes ([71da1c3](https://github.com/twinfoundation/api/commit/71da1c3a93c349588aff7084d1d8d6a29a277da8))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-core bumped from 0.0.2-next.7 to 0.0.2-next.8
+    * @twin.org/api-models bumped from 0.0.2-next.7 to 0.0.2-next.8
+
+## [0.0.2-next.7](https://github.com/twinfoundation/api/compare/api-rest-client-v0.0.2-next.6...api-rest-client-v0.0.2-next.7) (2025-08-20)
+
+
+### Miscellaneous Chores
+
+* **api-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-core bumped from 0.0.2-next.6 to 0.0.2-next.7
+    * @twin.org/api-models bumped from 0.0.2-next.6 to 0.0.2-next.7
+
+## [0.0.2-next.6](https://github.com/twinfoundation/api/compare/api-rest-client-v0.0.2-next.5...api-rest-client-v0.0.2-next.6) (2025-08-19)
+
+
+### Features
+
+* update framework core ([d8eebf2](https://github.com/twinfoundation/api/commit/d8eebf267fa2a0abaa84e58590496e9d20490cfa))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-core bumped from 0.0.2-next.5 to 0.0.2-next.6
+    * @twin.org/api-models bumped from 0.0.2-next.5 to 0.0.2-next.6
+
+## [0.0.2-next.5](https://github.com/twinfoundation/api/compare/api-rest-client-v0.0.2-next.4...api-rest-client-v0.0.2-next.5) (2025-07-25)
+
+
+### Features
+
+* update dependencies ([1171dc4](https://github.com/twinfoundation/api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
+* use shared store mechanism ([#19](https://github.com/twinfoundation/api/issues/19)) ([32116df](https://github.com/twinfoundation/api/commit/32116df3b4380a30137f5056f242a5c99afa2df9))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-core bumped from 0.0.2-next.4 to 0.0.2-next.5
+    * @twin.org/api-models bumped from 0.0.2-next.4 to 0.0.2-next.5
+
+## [0.0.2-next.4](https://github.com/twinfoundation/api/compare/api-rest-client-v0.0.2-next.3...api-rest-client-v0.0.2-next.4) (2025-07-25)
+
+
+### Miscellaneous Chores
+
+* **api-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-core bumped from 0.0.2-next.3 to 0.0.2-next.4
+    * @twin.org/api-models bumped from 0.0.2-next.3 to 0.0.2-next.4
+
+## [0.0.2-next.3](https://github.com/twinfoundation/api/compare/api-rest-client-v0.0.2-next.2...api-rest-client-v0.0.2-next.3) (2025-07-24)
+
+
+### Miscellaneous Chores
+
+* **api-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-core bumped from 0.0.2-next.2 to 0.0.2-next.3
+    * @twin.org/api-models bumped from 0.0.2-next.2 to 0.0.2-next.3
+
+## [0.0.2-next.2](https://github.com/twinfoundation/api/compare/api-rest-client-v0.0.2-next.1...api-rest-client-v0.0.2-next.2) (2025-07-17)
+
+
+### Miscellaneous Chores
+
+* **api-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-core bumped from 0.0.2-next.1 to 0.0.2-next.2
+    * @twin.org/api-models bumped from 0.0.2-next.1 to 0.0.2-next.2
+
 ## [0.0.2-next.1](https://github.com/twinfoundation/api/compare/api-rest-client-v0.0.2-next.0...api-rest-client-v0.0.2-next.1) (2025-07-08)
 
 

package/docs/reference/classes/InformationClient.md

@@ -48,6 +48,24 @@ Runtime name for the class.
 
 ## Methods
 
+### root()
+
+> **root**(): `Promise`\<`string`\>
+
+Get the server root.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The root root.
+
+#### Implementation of
+
+`IInformationComponent.root`
+
+***
+
 ### info()
 
 > **info**(): `Promise`\<`IServerInfo`\>
@@ -66,6 +84,24 @@ The service information.
 
 ***
 
+### favicon()
+
+> **favicon**(): `Promise`\<`undefined` \| `Uint8Array`\<`ArrayBufferLike`\>\>
+
+Get the favicon.
+
+#### Returns
+
+`Promise`\<`undefined` \| `Uint8Array`\<`ArrayBufferLike`\>\>
+
+The favicon.
+
+#### Implementation of
+
+`IInformationComponent.favicon`
+
+***
+
 ### spec()
 
 > **spec**(): `Promise`\<`unknown`\>

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/api-rest-client",
-	"version": "0.0.2-next.1",
+	"version": "0.0.2-next.11",
 	"description": "Information contract implementation which can connect to REST endpoints",
 	"repository": {
 		"type": "git",
@@ -14,8 +14,8 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/api-core": "0.0.2-next.1",
-		"@twin.org/api-models": "0.0.2-next.1",
+		"@twin.org/api-core": "0.0.2-next.11",
+		"@twin.org/api-models": "0.0.2-next.11",
 		"@twin.org/core": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"