@twin.org/api-models 0.0.3-next.3 → 0.0.3-next.30

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

@@ -0,0 +1,63 @@
+import type { IComponent } from "@twin.org/core";
+import type { ITenant } from "./ITenant.js";
+/**
+ * Configuration for the tenant admin component
+ */
+export interface ITenantAdminComponent extends IComponent {
+    /**
+     * Create a tenant.
+     * @param tenant The tenant to store.
+     * @returns The tenant id.
+     */
+    create(tenant: Omit<ITenant, "id" | "dateCreated" | "dateModified"> & {
+        id?: string;
+    }): Promise<string>;
+    /**
+     * Update a tenant.
+     * @param tenant The tenant to update.
+     * @returns Nothing.
+     */
+    update(tenant: Partial<Omit<ITenant, "dateCreated" | "dateModified">>): Promise<void>;
+    /**
+     * Get a tenant by its id.
+     * @param tenantId The id of the tenant.
+     * @returns The tenant.
+     * @throws Error if the tenant is not found.
+     */
+    get(tenantId: string): Promise<ITenant>;
+    /**
+     * Get a tenant by its api key.
+     * @param apiKey The api key of the tenant.
+     * @returns The tenant.
+     * @throws Error if the tenant is not found.
+     */
+    getByApiKey(apiKey: string): Promise<ITenant>;
+    /**
+     * Get a tenant by its public origin.
+     * @param publicOrigin The origin of the tenant.
+     * @returns The tenant.
+     * @throws Error if the tenant is not found.
+     */
+    getByPublicOrigin(publicOrigin: string): Promise<ITenant>;
+    /**
+     * Remove a tenant by its id.
+     * @param tenantId The id of the tenant.
+     * @returns Nothing.
+     * @throws Error if the tenant is not found.
+     */
+    remove(tenantId: string): Promise<void>;
+    /**
+     * Query tenants with pagination.
+     * @param options Optional query options.
+     * @param options.isNodeTenant Whether to filter for node admin tenants.
+     * @param cursor The cursor to start from.
+     * @param limit The maximum number of tenants to return.
+     * @returns The tenants and the next cursor if more tenants are available.
+     */
+    query(options?: {
+        isNodeTenant?: boolean;
+    }, cursor?: string, limit?: number): Promise<{
+        tenants: ITenant[];
+        cursor?: string;
+    }>;
+}

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

@@ -0,0 +1,66 @@
+import type { IComponent } from "@twin.org/core";
+import type { IHttpRequestQuery } from "../protocol/IHttpRequestQuery.js";
+/**
+ * The URL transformer component for encrypting and decrypting URL parameters.
+ */
+export interface IUrlTransformerComponent extends IComponent {
+    /**
+     * Encrypt a named token value and append it as a query parameter to the given URL.
+     * The URL param name is resolved from the configured token name dictionary using the id.
+     * @param url The URL to append the encrypted token to.
+     * @param id The logical token identifier (e.g. "tenant").
+     * @param value The value to encrypt and add.
+     * @returns The URL with the encrypted token added as a query parameter.
+     */
+    addEncryptedQueryParamToUrl(url: string, id: string, value: string): Promise<string>;
+    /**
+     * Get a named token value from the query parameters.
+     * The URL param name is resolved from the configured token name dictionary using the id.
+     * @param queryParams The HTTP request query containing the parameters.
+     * @param id The logical token identifier (e.g. "tenant").
+     * @returns The decrypted token value if it exists.
+     */
+    getEncryptedQueryParam(queryParams: IHttpRequestQuery | undefined, id: string): Promise<string | undefined>;
+    /**
+     * Add encrypted key/value pairs to a URL's query string.
+     * Existing query parameters on the URL are preserved; the provided params are
+     * merged in and then encrypted before being written back to the URL.
+     * @param url The base URL to add parameters to.
+     * @param params The key/value pairs to encrypt and append.
+     * @returns The URL with the encrypted parameters added.
+     */
+    addEncryptedParamsToUrl(url: string, params: IHttpRequestQuery): Promise<string>;
+    /**
+     * Decrypt specified keys from a query parameter object and return their plain-text values.
+     * @param queryParams The HTTP request query containing the encrypted parameters.
+     * @param keys The keys to decrypt.
+     * @returns A map of the decrypted key/value pairs that were present.
+     */
+    getDecryptedParamsFromQueryParams(queryParams: IHttpRequestQuery | undefined, keys: string[]): Promise<IHttpRequestQuery>;
+    /**
+     * Encrypt query parameters using the URL transformer's encryption mechanism.
+     * @param httpRequestQuery The HTTP request query containing the parameters to encrypt.
+     * @param keys The keys of the parameters to encrypt.
+     * @returns A promise that resolves when the query parameters have been encrypted.
+     */
+    encryptQueryParams(httpRequestQuery: IHttpRequestQuery | undefined, keys: string[]): Promise<void>;
+    /**
+     * Decrypt query parameters using the URL transformer's encryption mechanism.
+     * @param httpRequestQuery The HTTP request query containing the encrypted values.
+     * @param keys The keys of the parameters to decrypt.
+     * @returns A promise that resolves when the query parameters have been decrypted.
+     */
+    decryptQueryParams(httpRequestQuery: IHttpRequestQuery | undefined, keys: string[]): Promise<void>;
+    /**
+     * Encrypt a parameter value.
+     * @param paramValue The value of the parameter to encrypt.
+     * @returns A promise that resolves to the encrypted value of the parameter.
+     */
+    encryptParam(paramValue: string): Promise<string>;
+    /**
+     * Decrypt a parameter value.
+     * @param encryptedValue The encrypted value of the parameter.
+     * @returns A promise that resolves to the decrypted value of the parameter.
+     */
+    decryptParam(encryptedValue: string): Promise<string>;
+}

package/docs/changelog.md

@@ -1,173 +1,393 @@
-# @twin.org/api-models - Changelog
+# Changelog
 
-## [0.0.3-next.3](https://github.com/twinfoundation/api/compare/api-models-v0.0.3-next.2...api-models-v0.0.3-next.3) (2025-11-14)
+## [0.0.3-next.30](https://github.com/twinfoundation/twin-api/compare/api-models-v0.0.3-next.29...api-models-v0.0.3-next.30) (2026-05-05)
+
+
+### Features
+
+* separate service responsibilities ([#116](https://github.com/twinfoundation/twin-api/issues/116)) ([2234648](https://github.com/twinfoundation/twin-api/commit/2234648de4a2de5b7356aadde328f40470bc12e3))
+
+## [0.0.3-next.29](https://github.com/twinfoundation/twin-api/compare/api-models-v0.0.3-next.28...api-models-v0.0.3-next.29) (2026-05-01)
+
+
+### Features
+
+* hosting service ([#109](https://github.com/twinfoundation/twin-api/issues/109)) ([985bf1f](https://github.com/twinfoundation/twin-api/commit/985bf1f5c07b09ecb800df7120bc2422ac7a6d25))
+
+## [0.0.3-next.28](https://github.com/twinfoundation/twin-api/compare/api-models-v0.0.3-next.27...api-models-v0.0.3-next.28) (2026-04-30)
+
+
+### Miscellaneous Chores
+
+* **api-models:** Synchronize repo versions
+
+## [0.0.3-next.27](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.3-next.26...api-models-v0.0.3-next.27) (2026-04-23)
+
+
+### Miscellaneous Chores
+
+* **api-models:** Synchronize repo versions
+
+## [0.0.3-next.26](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.3-next.25...api-models-v0.0.3-next.26) (2026-04-22)
+
+
+### Bug Fixes
+
+* prevent error body masking 4xx as 500, run pre-processors in context scope ([#102](https://github.com/iotaledger/twin-api/issues/102)) ([5fbe14c](https://github.com/iotaledger/twin-api/commit/5fbe14c98e11e77a30e16704dcb8bfba7705926b))
+
+## [0.0.3-next.25](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.3-next.24...api-models-v0.0.3-next.25) (2026-04-14)
+
+
+### Miscellaneous Chores
+
+* **api-models:** Synchronize repo versions
+
+## [0.0.3-next.24](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.3-next.23...api-models-v0.0.3-next.24) (2026-04-14)
+
+
+### Miscellaneous Chores
+
+* **api-models:** Synchronize repo versions
+
+## [0.0.3-next.23](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.3-next.22...api-models-v0.0.3-next.23) (2026-04-14)
+
+
+### Features
+
+* auth enhancements ([#93](https://github.com/iotaledger/twin-api/issues/93)) ([921a50c](https://github.com/iotaledger/twin-api/commit/921a50cd89d26e530a6be6174a5a803060fa0eb6))
+
+## [0.0.3-next.22](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.3-next.21...api-models-v0.0.3-next.22) (2026-03-27)
+
+
+### Features
+
+* add new error types ([#86](https://github.com/iotaledger/twin-api/issues/86)) ([71e3c07](https://github.com/iotaledger/twin-api/commit/71e3c07c792984af01c307943e0e09a3ae98710d))
+
+## [0.0.3-next.21](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.3-next.20...api-models-v0.0.3-next.21) (2026-03-11)
+
+
+### Miscellaneous Chores
+
+* **api-models:** Synchronize repo versions
+
+## [0.0.3-next.20](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.3-next.19...api-models-v0.0.3-next.20) (2026-02-09)
+
+
+### Miscellaneous Chores
+
+* **api-models:** Synchronize repo versions
+
+## [0.0.3-next.19](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.3-next.18...api-models-v0.0.3-next.19) (2026-02-06)
+
+
+### Miscellaneous Chores
+
+* **api-models:** Synchronize repo versions
+
+## [0.0.3-next.18](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.3-next.17...api-models-v0.0.3-next.18) (2026-02-04)
+
+
+### Features
+
+* tenant api and scopes ([#75](https://github.com/iotaledger/twin-api/issues/75)) ([c663141](https://github.com/iotaledger/twin-api/commit/c663141091e8974d769f8f9904ecdab009ebd083))
+
+## [0.0.3-next.17](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.3-next.16...api-models-v0.0.3-next.17) (2026-01-26)
+
+
+### Features
+
+* update public origin building ([6c8e042](https://github.com/iotaledger/twin-api/commit/6c8e0422d9ddbed42a843e1c23498c99977b2fc7))
+
+## [0.0.3-next.16](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.3-next.15...api-models-v0.0.3-next.16) (2026-01-26)
+
+
+### Features
+
+* public base url ([#70](https://github.com/iotaledger/twin-api/issues/70)) ([5b958cd](https://github.com/iotaledger/twin-api/commit/5b958cd91e8a38cdae2835ff5f2356c7e48d37c3))
+
+## [0.0.3-next.15](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.3-next.14...api-models-v0.0.3-next.15) (2026-01-22)
+
+
+### Miscellaneous Chores
+
+* **api-models:** Synchronize repo versions
+
+## [0.0.3-next.14](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.3-next.13...api-models-v0.0.3-next.14) (2026-01-20)
+
+
+### Features
+
+* export error type map ([#68](https://github.com/iotaledger/twin-api/issues/68)) ([697dfc4](https://github.com/iotaledger/twin-api/commit/697dfc4c9f6a7be493bf4b3619d7bcebf2e4584e))
+
+## [0.0.3-next.13](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.3-next.12...api-models-v0.0.3-next.13) (2026-01-19)
+
+
+### Features
+
+* remove authentication generators ([#66](https://github.com/iotaledger/twin-api/issues/66)) ([adaa169](https://github.com/iotaledger/twin-api/commit/adaa1698df1c5ccb0ad645a7a7c0d3ef82ef6ac1))
+
+## [0.0.3-next.12](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.3-next.11...api-models-v0.0.3-next.12) (2026-01-12)
+
+
+### Miscellaneous Chores
+
+* **api-models:** Synchronize repo versions
+
+## [0.0.3-next.11](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.3-next.10...api-models-v0.0.3-next.11) (2026-01-08)
+
+
+### Miscellaneous Chores
+
+* **api-models:** Synchronize repo versions
+
+## [0.0.3-next.10](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.3-next.9...api-models-v0.0.3-next.10) (2026-01-05)
+
+
+### Miscellaneous Chores
+
+* **api-models:** Synchronize repo versions
+
+## [0.0.3-next.9](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.3-next.8...api-models-v0.0.3-next.9) (2026-01-05)
+
+
+### Features
+
+* add authentication generators and process features option ([a67edf1](https://github.com/iotaledger/twin-api/commit/a67edf1df212bd8ab94a40cddf5338551155696f))
+* add context id features ([#42](https://github.com/iotaledger/twin-api/issues/42)) ([0186055](https://github.com/iotaledger/twin-api/commit/0186055c48afde842a4254b4df9ac9249c40fe40))
+* add livez endpoint ([#57](https://github.com/iotaledger/twin-api/issues/57)) ([ef007db](https://github.com/iotaledger/twin-api/commit/ef007db8201736dd3053211f849ffd03baaa485e))
+* add logging component type to request contexts ([210de1b](https://github.com/iotaledger/twin-api/commit/210de1b9e1c91079b59a2b90ddd57569668d647d))
+* add root, favicon routes ([71da1c3](https://github.com/iotaledger/twin-api/commit/71da1c3a93c349588aff7084d1d8d6a29a277da8))
+* add socket id, connect and disconnect ([20b0d0e](https://github.com/iotaledger/twin-api/commit/20b0d0ec279cab46141fee09de2c4a7087cdce16))
+* add validate-locales ([cdba610](https://github.com/iotaledger/twin-api/commit/cdba610a0acb5022d2e3ce729732e6646a297e5e))
+* decodeURIComponent for query and path params ([ead68a2](https://github.com/iotaledger/twin-api/commit/ead68a257425c10dd912497f7edd473c469ca132))
+* eslint migration to flat config ([0dd5820](https://github.com/iotaledger/twin-api/commit/0dd5820e3af97350fd08b8d226f4a6c1a9246805))
+* update dependencies ([1171dc4](https://github.com/iotaledger/twin-api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
+* update framework core ([d8eebf2](https://github.com/iotaledger/twin-api/commit/d8eebf267fa2a0abaa84e58590496e9d20490cfa))
+* update IComponent signatures ([915ce37](https://github.com/iotaledger/twin-api/commit/915ce37712326ab4aa6869c350eabaa4622e8430))
+* use new includeStackTrace flag for toJsonObject ([6452b15](https://github.com/iotaledger/twin-api/commit/6452b153af786eee14b21152420f8a2578b70593))
+* use shared store mechanism ([#19](https://github.com/iotaledger/twin-api/issues/19)) ([32116df](https://github.com/iotaledger/twin-api/commit/32116df3b4380a30137f5056f242a5c99afa2df9))
+* validationError mapped to http status badrequest ([adc5eb1](https://github.com/iotaledger/twin-api/commit/adc5eb11d987abb0ab9f7e0dc8e1fdae207e436e))
+
+
+### Bug Fixes
+
+* error handling make sure primary error takes precedence ([84b61f2](https://github.com/iotaledger/twin-api/commit/84b61f27fe5e4919c0c9f9a1edc8ff46dc45c1f7))
+
+## [0.0.3-next.8](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.3-next.7...api-models-v0.0.3-next.8) (2025-12-17)
+
+
+### Miscellaneous Chores
+
+* **api-models:** Synchronize repo versions
+
+## [0.0.3-next.7](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.3-next.6...api-models-v0.0.3-next.7) (2025-11-26)
+
+
+### Bug Fixes
+
+* error handling make sure primary error takes precedence ([84b61f2](https://github.com/iotaledger/twin-api/commit/84b61f27fe5e4919c0c9f9a1edc8ff46dc45c1f7))
+
+## [0.0.3-next.6](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.3-next.5...api-models-v0.0.3-next.6) (2025-11-20)
+
+
+### Miscellaneous Chores
+
+* **api-models:** Synchronize repo versions
+
+## [0.0.3-next.5](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.3-next.4...api-models-v0.0.3-next.5) (2025-11-14)
+
+
+### Features
+
+* decodeURIComponent for query and path params ([ead68a2](https://github.com/iotaledger/twin-api/commit/ead68a257425c10dd912497f7edd473c469ca132))
+
+## [0.0.3-next.4](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.3-next.3...api-models-v0.0.3-next.4) (2025-11-14)
+
+
+### Features
+
+* add authentication generators and process features option ([a67edf1](https://github.com/iotaledger/twin-api/commit/a67edf1df212bd8ab94a40cddf5338551155696f))
+* add context id features ([#42](https://github.com/iotaledger/twin-api/issues/42)) ([0186055](https://github.com/iotaledger/twin-api/commit/0186055c48afde842a4254b4df9ac9249c40fe40))
+* add logging component type to request contexts ([210de1b](https://github.com/iotaledger/twin-api/commit/210de1b9e1c91079b59a2b90ddd57569668d647d))
+* add root, favicon routes ([71da1c3](https://github.com/iotaledger/twin-api/commit/71da1c3a93c349588aff7084d1d8d6a29a277da8))
+* add socket id, connect and disconnect ([20b0d0e](https://github.com/iotaledger/twin-api/commit/20b0d0ec279cab46141fee09de2c4a7087cdce16))
+* add validate-locales ([cdba610](https://github.com/iotaledger/twin-api/commit/cdba610a0acb5022d2e3ce729732e6646a297e5e))
+* eslint migration to flat config ([0dd5820](https://github.com/iotaledger/twin-api/commit/0dd5820e3af97350fd08b8d226f4a6c1a9246805))
+* update dependencies ([1171dc4](https://github.com/iotaledger/twin-api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
+* update framework core ([d8eebf2](https://github.com/iotaledger/twin-api/commit/d8eebf267fa2a0abaa84e58590496e9d20490cfa))
+* update IComponent signatures ([915ce37](https://github.com/iotaledger/twin-api/commit/915ce37712326ab4aa6869c350eabaa4622e8430))
+* use new includeStackTrace flag for toJsonObject ([6452b15](https://github.com/iotaledger/twin-api/commit/6452b153af786eee14b21152420f8a2578b70593))
+* use shared store mechanism ([#19](https://github.com/iotaledger/twin-api/issues/19)) ([32116df](https://github.com/iotaledger/twin-api/commit/32116df3b4380a30137f5056f242a5c99afa2df9))
+* validationError mapped to http status badrequest ([adc5eb1](https://github.com/iotaledger/twin-api/commit/adc5eb11d987abb0ab9f7e0dc8e1fdae207e436e))
+
+## [0.0.3-next.3](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.3-next.2...api-models-v0.0.3-next.3) (2025-11-14)
 
 
 ### Miscellaneous Chores
 
 * **api-models:** Synchronize repo versions
 
-## [0.0.3-next.2](https://github.com/twinfoundation/api/compare/api-models-v0.0.3-next.1...api-models-v0.0.3-next.2) (2025-11-12)
+## [0.0.3-next.2](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.3-next.1...api-models-v0.0.3-next.2) (2025-11-12)
 
 
 ### Miscellaneous Chores
 
 * **api-models:** Synchronize repo versions
 
-## [0.0.3-next.1](https://github.com/twinfoundation/api/compare/api-models-v0.0.3-next.0...api-models-v0.0.3-next.1) (2025-11-10)
+## [0.0.3-next.1](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.3-next.0...api-models-v0.0.3-next.1) (2025-11-10)
 
 
 ### Features
 
-* add authentication generators and process features option ([a67edf1](https://github.com/twinfoundation/api/commit/a67edf1df212bd8ab94a40cddf5338551155696f))
-* add context id features ([#42](https://github.com/twinfoundation/api/issues/42)) ([0186055](https://github.com/twinfoundation/api/commit/0186055c48afde842a4254b4df9ac9249c40fe40))
-* add logging component type to request contexts ([210de1b](https://github.com/twinfoundation/api/commit/210de1b9e1c91079b59a2b90ddd57569668d647d))
-* add root, favicon routes ([71da1c3](https://github.com/twinfoundation/api/commit/71da1c3a93c349588aff7084d1d8d6a29a277da8))
-* add socket id, connect and disconnect ([20b0d0e](https://github.com/twinfoundation/api/commit/20b0d0ec279cab46141fee09de2c4a7087cdce16))
-* add validate-locales ([cdba610](https://github.com/twinfoundation/api/commit/cdba610a0acb5022d2e3ce729732e6646a297e5e))
-* eslint migration to flat config ([0dd5820](https://github.com/twinfoundation/api/commit/0dd5820e3af97350fd08b8d226f4a6c1a9246805))
-* update dependencies ([1171dc4](https://github.com/twinfoundation/api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
-* update framework core ([d8eebf2](https://github.com/twinfoundation/api/commit/d8eebf267fa2a0abaa84e58590496e9d20490cfa))
-* update IComponent signatures ([915ce37](https://github.com/twinfoundation/api/commit/915ce37712326ab4aa6869c350eabaa4622e8430))
-* use new includeStackTrace flag for toJsonObject ([6452b15](https://github.com/twinfoundation/api/commit/6452b153af786eee14b21152420f8a2578b70593))
-* use shared store mechanism ([#19](https://github.com/twinfoundation/api/issues/19)) ([32116df](https://github.com/twinfoundation/api/commit/32116df3b4380a30137f5056f242a5c99afa2df9))
-* validationError mapped to http status badrequest ([adc5eb1](https://github.com/twinfoundation/api/commit/adc5eb11d987abb0ab9f7e0dc8e1fdae207e436e))
+* add authentication generators and process features option ([a67edf1](https://github.com/iotaledger/twin-api/commit/a67edf1df212bd8ab94a40cddf5338551155696f))
+* add context id features ([#42](https://github.com/iotaledger/twin-api/issues/42)) ([0186055](https://github.com/iotaledger/twin-api/commit/0186055c48afde842a4254b4df9ac9249c40fe40))
+* add logging component type to request contexts ([210de1b](https://github.com/iotaledger/twin-api/commit/210de1b9e1c91079b59a2b90ddd57569668d647d))
+* add root, favicon routes ([71da1c3](https://github.com/iotaledger/twin-api/commit/71da1c3a93c349588aff7084d1d8d6a29a277da8))
+* add socket id, connect and disconnect ([20b0d0e](https://github.com/iotaledger/twin-api/commit/20b0d0ec279cab46141fee09de2c4a7087cdce16))
+* add validate-locales ([cdba610](https://github.com/iotaledger/twin-api/commit/cdba610a0acb5022d2e3ce729732e6646a297e5e))
+* eslint migration to flat config ([0dd5820](https://github.com/iotaledger/twin-api/commit/0dd5820e3af97350fd08b8d226f4a6c1a9246805))
+* update dependencies ([1171dc4](https://github.com/iotaledger/twin-api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
+* update framework core ([d8eebf2](https://github.com/iotaledger/twin-api/commit/d8eebf267fa2a0abaa84e58590496e9d20490cfa))
+* update IComponent signatures ([915ce37](https://github.com/iotaledger/twin-api/commit/915ce37712326ab4aa6869c350eabaa4622e8430))
+* use new includeStackTrace flag for toJsonObject ([6452b15](https://github.com/iotaledger/twin-api/commit/6452b153af786eee14b21152420f8a2578b70593))
+* use shared store mechanism ([#19](https://github.com/iotaledger/twin-api/issues/19)) ([32116df](https://github.com/iotaledger/twin-api/commit/32116df3b4380a30137f5056f242a5c99afa2df9))
+* validationError mapped to http status badrequest ([adc5eb1](https://github.com/iotaledger/twin-api/commit/adc5eb11d987abb0ab9f7e0dc8e1fdae207e436e))
 
-## [0.0.2-next.13](https://github.com/twinfoundation/api/compare/api-models-v0.0.2-next.12...api-models-v0.0.2-next.13) (2025-10-09)
+## [0.0.2-next.13](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.2-next.12...api-models-v0.0.2-next.13) (2025-10-09)
 
 
 ### Miscellaneous Chores
 
 * **api-models:** Synchronize repo versions
 
-## [0.0.2-next.12](https://github.com/twinfoundation/api/compare/api-models-v0.0.2-next.11...api-models-v0.0.2-next.12) (2025-10-09)
+## [0.0.2-next.12](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.2-next.11...api-models-v0.0.2-next.12) (2025-10-09)
 
 
 ### Features
 
-* add validate-locales ([cdba610](https://github.com/twinfoundation/api/commit/cdba610a0acb5022d2e3ce729732e6646a297e5e))
+* add validate-locales ([cdba610](https://github.com/iotaledger/twin-api/commit/cdba610a0acb5022d2e3ce729732e6646a297e5e))
 
-## [0.0.2-next.11](https://github.com/twinfoundation/api/compare/api-models-v0.0.2-next.10...api-models-v0.0.2-next.11) (2025-09-29)
+## [0.0.2-next.11](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.2-next.10...api-models-v0.0.2-next.11) (2025-09-29)
 
 
 ### Features
 
-* update IComponent signatures ([915ce37](https://github.com/twinfoundation/api/commit/915ce37712326ab4aa6869c350eabaa4622e8430))
+* update IComponent signatures ([915ce37](https://github.com/iotaledger/twin-api/commit/915ce37712326ab4aa6869c350eabaa4622e8430))
 
-## [0.0.2-next.10](https://github.com/twinfoundation/api/compare/api-models-v0.0.2-next.9...api-models-v0.0.2-next.10) (2025-09-23)
+## [0.0.2-next.10](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.2-next.9...api-models-v0.0.2-next.10) (2025-09-23)
 
 
 ### Features
 
-* add authentication generators and process features option ([a67edf1](https://github.com/twinfoundation/api/commit/a67edf1df212bd8ab94a40cddf5338551155696f))
+* add authentication generators and process features option ([a67edf1](https://github.com/iotaledger/twin-api/commit/a67edf1df212bd8ab94a40cddf5338551155696f))
 
-## [0.0.2-next.9](https://github.com/twinfoundation/api/compare/api-models-v0.0.2-next.8...api-models-v0.0.2-next.9) (2025-08-29)
+## [0.0.2-next.9](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.2-next.8...api-models-v0.0.2-next.9) (2025-08-29)
 
 
 ### Features
 
-* eslint migration to flat config ([0dd5820](https://github.com/twinfoundation/api/commit/0dd5820e3af97350fd08b8d226f4a6c1a9246805))
+* eslint migration to flat config ([0dd5820](https://github.com/iotaledger/twin-api/commit/0dd5820e3af97350fd08b8d226f4a6c1a9246805))
 
-## [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)
+## [0.0.2-next.8](https://github.com/iotaledger/twin-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))
+* add root, favicon routes ([71da1c3](https://github.com/iotaledger/twin-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)
+## [0.0.2-next.7](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.2-next.6...api-models-v0.0.2-next.7) (2025-08-20)
 
 
 ### Miscellaneous Chores
 
 * **api-models:** Synchronize repo versions
 
-## [0.0.2-next.6](https://github.com/twinfoundation/api/compare/api-models-v0.0.2-next.5...api-models-v0.0.2-next.6) (2025-08-19)
+## [0.0.2-next.6](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.2-next.5...api-models-v0.0.2-next.6) (2025-08-19)
 
 
 ### Features
 
-* update framework core ([d8eebf2](https://github.com/twinfoundation/api/commit/d8eebf267fa2a0abaa84e58590496e9d20490cfa))
+* update framework core ([d8eebf2](https://github.com/iotaledger/twin-api/commit/d8eebf267fa2a0abaa84e58590496e9d20490cfa))
 
-## [0.0.2-next.5](https://github.com/twinfoundation/api/compare/api-models-v0.0.2-next.4...api-models-v0.0.2-next.5) (2025-07-25)
+## [0.0.2-next.5](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.2-next.4...api-models-v0.0.2-next.5) (2025-07-25)
 
 
 ### Features
 
-* add logging component type to request contexts ([210de1b](https://github.com/twinfoundation/api/commit/210de1b9e1c91079b59a2b90ddd57569668d647d))
-* add socket id, connect and disconnect ([20b0d0e](https://github.com/twinfoundation/api/commit/20b0d0ec279cab46141fee09de2c4a7087cdce16))
-* update dependencies ([1171dc4](https://github.com/twinfoundation/api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
-* use new includeStackTrace flag for toJsonObject ([6452b15](https://github.com/twinfoundation/api/commit/6452b153af786eee14b21152420f8a2578b70593))
-* use shared store mechanism ([#19](https://github.com/twinfoundation/api/issues/19)) ([32116df](https://github.com/twinfoundation/api/commit/32116df3b4380a30137f5056f242a5c99afa2df9))
-* validationError mapped to http status badrequest ([adc5eb1](https://github.com/twinfoundation/api/commit/adc5eb11d987abb0ab9f7e0dc8e1fdae207e436e))
+* add logging component type to request contexts ([210de1b](https://github.com/iotaledger/twin-api/commit/210de1b9e1c91079b59a2b90ddd57569668d647d))
+* add socket id, connect and disconnect ([20b0d0e](https://github.com/iotaledger/twin-api/commit/20b0d0ec279cab46141fee09de2c4a7087cdce16))
+* update dependencies ([1171dc4](https://github.com/iotaledger/twin-api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
+* use new includeStackTrace flag for toJsonObject ([6452b15](https://github.com/iotaledger/twin-api/commit/6452b153af786eee14b21152420f8a2578b70593))
+* use shared store mechanism ([#19](https://github.com/iotaledger/twin-api/issues/19)) ([32116df](https://github.com/iotaledger/twin-api/commit/32116df3b4380a30137f5056f242a5c99afa2df9))
+* validationError mapped to http status badrequest ([adc5eb1](https://github.com/iotaledger/twin-api/commit/adc5eb11d987abb0ab9f7e0dc8e1fdae207e436e))
 
-## [0.0.2-next.4](https://github.com/twinfoundation/api/compare/api-models-v0.0.2-next.3...api-models-v0.0.2-next.4) (2025-07-25)
+## [0.0.2-next.4](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.2-next.3...api-models-v0.0.2-next.4) (2025-07-25)
 
 
 ### Features
 
-* add logging component type to request contexts ([210de1b](https://github.com/twinfoundation/api/commit/210de1b9e1c91079b59a2b90ddd57569668d647d))
+* add logging component type to request contexts ([210de1b](https://github.com/iotaledger/twin-api/commit/210de1b9e1c91079b59a2b90ddd57569668d647d))
 
-## [0.0.2-next.3](https://github.com/twinfoundation/api/compare/api-models-v0.0.2-next.2...api-models-v0.0.2-next.3) (2025-07-24)
+## [0.0.2-next.3](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.2-next.2...api-models-v0.0.2-next.3) (2025-07-24)
 
 
 ### Features
 
-* add socket id, connect and disconnect ([20b0d0e](https://github.com/twinfoundation/api/commit/20b0d0ec279cab46141fee09de2c4a7087cdce16))
+* add socket id, connect and disconnect ([20b0d0e](https://github.com/iotaledger/twin-api/commit/20b0d0ec279cab46141fee09de2c4a7087cdce16))
 
-## [0.0.2-next.2](https://github.com/twinfoundation/api/compare/api-models-v0.0.2-next.1...api-models-v0.0.2-next.2) (2025-07-17)
+## [0.0.2-next.2](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.2-next.1...api-models-v0.0.2-next.2) (2025-07-17)
 
 
 ### Miscellaneous Chores
 
 * **api-models:** Synchronize repo versions
 
-## [0.0.2-next.1](https://github.com/twinfoundation/api/compare/api-models-v0.0.2-next.0...api-models-v0.0.2-next.1) (2025-07-08)
+## [0.0.2-next.1](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.2-next.0...api-models-v0.0.2-next.1) (2025-07-08)
 
 
 ### Features
 
-* update dependencies ([1171dc4](https://github.com/twinfoundation/api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
-* use new includeStackTrace flag for toJsonObject ([6452b15](https://github.com/twinfoundation/api/commit/6452b153af786eee14b21152420f8a2578b70593))
-* use shared store mechanism ([#19](https://github.com/twinfoundation/api/issues/19)) ([32116df](https://github.com/twinfoundation/api/commit/32116df3b4380a30137f5056f242a5c99afa2df9))
-* validationError mapped to http status badrequest ([adc5eb1](https://github.com/twinfoundation/api/commit/adc5eb11d987abb0ab9f7e0dc8e1fdae207e436e))
+* update dependencies ([1171dc4](https://github.com/iotaledger/twin-api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
+* use new includeStackTrace flag for toJsonObject ([6452b15](https://github.com/iotaledger/twin-api/commit/6452b153af786eee14b21152420f8a2578b70593))
+* use shared store mechanism ([#19](https://github.com/iotaledger/twin-api/issues/19)) ([32116df](https://github.com/iotaledger/twin-api/commit/32116df3b4380a30137f5056f242a5c99afa2df9))
+* validationError mapped to http status badrequest ([adc5eb1](https://github.com/iotaledger/twin-api/commit/adc5eb11d987abb0ab9f7e0dc8e1fdae207e436e))
 
 ## 0.0.1 (2025-07-03)
 
 
 ### Features
 
-* release to production ([70ee2d5](https://github.com/twinfoundation/api/commit/70ee2d56a1dc9537d7c9c154d4cb78a235678a3a))
+* release to production ([70ee2d5](https://github.com/iotaledger/twin-api/commit/70ee2d56a1dc9537d7c9c154d4cb78a235678a3a))
 
-## [0.0.1-next.36](https://github.com/twinfoundation/api/compare/api-models-v0.0.1-next.35...api-models-v0.0.1-next.36) (2025-06-17)
+## [0.0.1-next.36](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.1-next.35...api-models-v0.0.1-next.36) (2025-06-17)
 
 
 ### Features
 
-* use new includeStackTrace flag for toJsonObject ([6452b15](https://github.com/twinfoundation/api/commit/6452b153af786eee14b21152420f8a2578b70593))
+* use new includeStackTrace flag for toJsonObject ([6452b15](https://github.com/iotaledger/twin-api/commit/6452b153af786eee14b21152420f8a2578b70593))
 
-## [0.0.1-next.35](https://github.com/twinfoundation/api/compare/api-models-v0.0.1-next.34...api-models-v0.0.1-next.35) (2025-06-11)
+## [0.0.1-next.35](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.1-next.34...api-models-v0.0.1-next.35) (2025-06-11)
 
 
 ### Features
 
-* update dependencies ([1171dc4](https://github.com/twinfoundation/api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
+* update dependencies ([1171dc4](https://github.com/iotaledger/twin-api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
 
-## [0.0.1-next.34](https://github.com/twinfoundation/api/compare/api-models-v0.0.1-next.33...api-models-v0.0.1-next.34) (2025-05-27)
+## [0.0.1-next.34](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.1-next.33...api-models-v0.0.1-next.34) (2025-05-27)
 
 
 ### Features
 
-* validationError mapped to http status badrequest ([adc5eb1](https://github.com/twinfoundation/api/commit/adc5eb11d987abb0ab9f7e0dc8e1fdae207e436e))
+* validationError mapped to http status badrequest ([adc5eb1](https://github.com/iotaledger/twin-api/commit/adc5eb11d987abb0ab9f7e0dc8e1fdae207e436e))
 
-## [0.0.1-next.33](https://github.com/twinfoundation/api/compare/api-models-v0.0.1-next.32...api-models-v0.0.1-next.33) (2025-04-17)
+## [0.0.1-next.33](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.1-next.32...api-models-v0.0.1-next.33) (2025-04-17)
 
 
 ### Features
 
-* use shared store mechanism ([#19](https://github.com/twinfoundation/api/issues/19)) ([32116df](https://github.com/twinfoundation/api/commit/32116df3b4380a30137f5056f242a5c99afa2df9))
+* use shared store mechanism ([#19](https://github.com/iotaledger/twin-api/issues/19)) ([32116df](https://github.com/iotaledger/twin-api/commit/32116df3b4380a30137f5056f242a5c99afa2df9))
 
-## [0.0.1-next.32](https://github.com/twinfoundation/api/compare/api-models-v0.0.1-next.31...api-models-v0.0.1-next.32) (2025-03-28)
+## [0.0.1-next.32](https://github.com/iotaledger/twin-api/compare/api-models-v0.0.1-next.31...api-models-v0.0.1-next.32) (2025-03-28)
 
 
 ### Miscellaneous Chores