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

package/dist/es/models/services/IUrlTransformerComponent.js.map

@@ -1 +1 @@
-{"version":3,"file":"IUrlTransformerComponent.js","sourceRoot":"","sources":["../../../../src/models/services/IUrlTransformerComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IHttpRequestQuery } from \"../protocol/IHttpRequestQuery.js\";\n\n/**\n * The URL transformer component for encrypting and decrypting URL parameters.\n */\nexport interface IUrlTransformerComponent extends IComponent {\n\t/**\n\t * Encrypt a named token value and append it as a query parameter to the given URL.\n\t * The URL param name is resolved from the configured token name dictionary using the id.\n\t * @param url The URL to append the encrypted token to.\n\t * @param id The logical token identifier (e.g. \"tenant\").\n\t * @param value The value to encrypt and add.\n\t * @returns The URL with the encrypted token added as a query parameter.\n\t */\n\taddEncryptedQueryParamToUrl(url: string, id: string, value: string): Promise<string>;\n\n\t/**\n\t * Get a named token value from the query parameters.\n\t * The URL param name is resolved from the configured token name dictionary using the id.\n\t * @param queryParams The HTTP request query containing the parameters.\n\t * @param id The logical token identifier (e.g. \"tenant\").\n\t * @returns The decrypted token value if it exists.\n\t */\n\tgetEncryptedQueryParam(\n\t\tqueryParams: IHttpRequestQuery | undefined,\n\t\tid: string\n\t): Promise<string | undefined>;\n\n\t/**\n\t * Add encrypted key/value pairs to a URL's query string.\n\t * Existing query parameters on the URL are preserved; the provided params are\n\t * merged in and then encrypted before being written back to the URL.\n\t * @param url The base URL to add parameters to.\n\t * @param params The key/value pairs to encrypt and append.\n\t * @returns The URL with the encrypted parameters added.\n\t */\n\taddEncryptedParamsToUrl(url: string, params: IHttpRequestQuery): Promise<string>;\n\n\t/**\n\t * Decrypt specified keys from a query parameter object and return their plain-text values.\n\t * @param queryParams The HTTP request query containing the encrypted parameters.\n\t * @param keys The keys to decrypt.\n\t * @returns A map of the decrypted key/value pairs that were present.\n\t */\n\tgetDecryptedParamsFromQueryParams(\n\t\tqueryParams: IHttpRequestQuery | undefined,\n\t\tkeys: string[]\n\t): Promise<IHttpRequestQuery>;\n\n\t/**\n\t * Encrypt query parameters using the URL transformer's encryption mechanism.\n\t * @param httpRequestQuery The HTTP request query containing the parameters to encrypt.\n\t * @param keys The keys of the parameters to encrypt.\n\t * @returns A promise that resolves when the query parameters have been encrypted.\n\t */\n\tencryptQueryParams(\n\t\thttpRequestQuery: IHttpRequestQuery | undefined,\n\t\tkeys: string[]\n\t): Promise<void>;\n\n\t/**\n\t * Decrypt query parameters using the URL transformer's encryption mechanism.\n\t * @param httpRequestQuery The HTTP request query containing the encrypted values.\n\t * @param keys The keys of the parameters to decrypt.\n\t * @returns A promise that resolves when the query parameters have been decrypted.\n\t */\n\tdecryptQueryParams(\n\t\thttpRequestQuery: IHttpRequestQuery | undefined,\n\t\tkeys: string[]\n\t): Promise<void>;\n\n\t/**\n\t * Encrypt a parameter value.\n\t * @param paramValue The value of the parameter to encrypt.\n\t * @returns A promise that resolves to the encrypted value of the parameter.\n\t */\n\tencryptParam(paramValue: string): Promise<string>;\n\n\t/**\n\t * Decrypt a parameter value.\n\t * @param encryptedValue The encrypted value of the parameter.\n\t * @returns A promise that resolves to the decrypted value of the parameter.\n\t */\n\tdecryptParam(encryptedValue: string): Promise<string>;\n}\n"]}
+{"version":3,"file":"IUrlTransformerComponent.js","sourceRoot":"","sources":["../../../../src/models/services/IUrlTransformerComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IHttpRequestQuery } from \"../protocol/IHttpRequestQuery.js\";\n\n/**\n * The URL transformer component for encrypting and decrypting URL parameters.\n */\nexport interface IUrlTransformerComponent extends IComponent {\n\t/**\n\t * Encrypt a named token value and append it as a query parameter to the given URL.\n\t * The URL param name is resolved from the configured token name dictionary using the id.\n\t * @param url The URL to append the encrypted token to.\n\t * @param id The logical token identifier (e.g. \"tenant\").\n\t * @param value The value to encrypt and add.\n\t * @returns The URL with the encrypted token added as a query parameter.\n\t */\n\taddEncryptedQueryParamToUrl(url: string, id: string, value: string): Promise<string>;\n\n\t/**\n\t * Get a named token value from the query parameters.\n\t * The URL param name is resolved from the configured token name dictionary using the id.\n\t * @param queryParams The HTTP request query containing the parameters.\n\t * @param id The logical token identifier (e.g. \"tenant\").\n\t * @returns The decrypted token value if it exists.\n\t */\n\tgetEncryptedQueryParam(\n\t\tqueryParams: IHttpRequestQuery | undefined,\n\t\tid: string\n\t): Promise<string | undefined>;\n\n\t/**\n\t * Add encrypted key/value pairs to a URL's query string.\n\t * Existing query parameters on the URL are preserved; the provided params are\n\t * merged in and then encrypted before being written back to the URL.\n\t * @param url The base URL to add parameters to.\n\t * @param params The key/value pairs to encrypt and append.\n\t * @returns The URL with the encrypted parameters added.\n\t */\n\taddEncryptedToUrl(url: string, params: IHttpRequestQuery): Promise<string>;\n\n\t/**\n\t * Decrypt specified keys from a query parameter object and return their plain-text values.\n\t * @param queryParams The HTTP request query containing the encrypted parameters.\n\t * @param keys The keys to decrypt.\n\t * @returns A map of the decrypted key/value pairs that were present.\n\t */\n\tgetDecryptedFromQueryParams(\n\t\tqueryParams: IHttpRequestQuery | undefined,\n\t\tkeys: string[]\n\t): Promise<IHttpRequestQuery>;\n\n\t/**\n\t * Encrypt query parameters using the URL transformer's encryption mechanism.\n\t * @param httpRequestQuery The HTTP request query containing the parameters to encrypt.\n\t * @param keys The keys of the parameters to encrypt.\n\t * @returns A promise that resolves when the query parameters have been encrypted.\n\t */\n\tencryptQueryParams(\n\t\thttpRequestQuery: IHttpRequestQuery | undefined,\n\t\tkeys: string[]\n\t): Promise<void>;\n\n\t/**\n\t * Decrypt query parameters using the URL transformer's encryption mechanism.\n\t * @param httpRequestQuery The HTTP request query containing the encrypted values.\n\t * @param keys The keys of the parameters to decrypt.\n\t * @returns A promise that resolves when the query parameters have been decrypted.\n\t */\n\tdecryptQueryParams(\n\t\thttpRequestQuery: IHttpRequestQuery | undefined,\n\t\tkeys: string[]\n\t): Promise<void>;\n\n\t/**\n\t * Encrypt a parameter value.\n\t * @param paramValue The value of the parameter to encrypt.\n\t * @returns A promise that resolves to the encrypted value of the parameter.\n\t */\n\tencryptParam(paramValue: string): Promise<string>;\n\n\t/**\n\t * Decrypt a parameter value.\n\t * @param encryptedValue The encrypted value of the parameter.\n\t * @returns A promise that resolves to the decrypted value of the parameter.\n\t */\n\tdecryptParam(encryptedValue: string): Promise<string>;\n}\n"]}

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

@@ -29,14 +29,14 @@ export interface IUrlTransformerComponent extends IComponent {
      * @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>;
+    addEncryptedToUrl(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>;
+    getDecryptedFromQueryParams(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.

package/docs/changelog.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.0.3-next.31](https://github.com/twinfoundation/twin-api/compare/api-models-v0.0.3-next.30...api-models-v0.0.3-next.31) (2026-05-06)
+
+
+### Features
+
+* update health format ([cfbfbbb](https://github.com/twinfoundation/twin-api/commit/cfbfbbb2e9afbd2574ffd2446ad51e4217437951))
+
 ## [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)
 
 

package/docs/reference/interfaces/IUrlTransformerComponent.md

@@ -72,9 +72,9 @@ The decrypted token value if it exists.
 
 ***
 
-### addEncryptedParamsToUrl() {#addencryptedparamstourl}
+### addEncryptedToUrl() {#addencryptedtourl}
 
-> **addEncryptedParamsToUrl**(`url`, `params`): `Promise`\<`string`\>
+> **addEncryptedToUrl**(`url`, `params`): `Promise`\<`string`\>
 
 Add encrypted key/value pairs to a URL's query string.
 Existing query parameters on the URL are preserved; the provided params are
@@ -102,9 +102,9 @@ The URL with the encrypted parameters added.
 
 ***
 
-### getDecryptedParamsFromQueryParams() {#getdecryptedparamsfromqueryparams}
+### getDecryptedFromQueryParams() {#getdecryptedfromqueryparams}
 
-> **getDecryptedParamsFromQueryParams**(`queryParams`, `keys`): `Promise`\<[`IHttpRequestQuery`](IHttpRequestQuery.md)\>
+> **getDecryptedFromQueryParams**(`queryParams`, `keys`): `Promise`\<[`IHttpRequestQuery`](IHttpRequestQuery.md)\>
 
 Decrypt specified keys from a query parameter object and return their plain-text values.
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/api-models",
-	"version": "0.0.3-next.30",
+	"version": "0.0.3-next.31",
 	"description": "Shared API contracts, route types, and response models used across services and clients.",
 	"repository": {
 		"type": "git",