@twin.org/api-service 0.0.3-next.4 → 0.0.3-next.41

package/dist/types/urlTransformerService.d.ts

@@ -0,0 +1,94 @@
+import type { IHttpRequestQuery, IUrlTransformerComponent } from "@twin.org/api-models";
+import type { IUrlTransformerServiceConstructorOptions } from "./models/IUrlTransformerServiceConstructorOptions.js";
+/**
+ * The URL transformer service for encrypting and decrypting URL parameters.
+ */
+export declare class UrlTransformerService implements IUrlTransformerComponent {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of UrlTransformerService.
+     * @param options The options to create the service.
+     */
+    constructor(options?: IUrlTransformerServiceConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
+    /**
+     * The component needs to be started when the node is initialized.
+     * @returns Nothing.
+     */
+    start(): Promise<void>;
+    /**
+     * Encrypt a named token value and append it as a query parameter to the given URL.
+     * @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.
+     * @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.
+     * @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.
+     */
+    addEncryptedToUrl(url: string, params: IHttpRequestQuery): Promise<string>;
+    /**
+     * Get an encrypted value from a URL's query string.
+     * @param url The URL to extract the encrypted value from.
+     * @param id The logical identifier for the value to retrieve (e.g. "tenant").
+     * @returns The decrypted value if it exists.
+     */
+    getEncryptedFromUrl(url: string, id: string): Promise<string | undefined>;
+    /**
+     * 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.
+     */
+    getDecryptedFromQueryParams(queryParams: IHttpRequestQuery | undefined, keys: string[]): Promise<IHttpRequestQuery>;
+    /**
+     * Encrypt query parameters.
+     * @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.
+     * @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>;
+    /**
+     * Get the parameter name for a given key.
+     * @param key The key of the parameter.
+     * @returns The parameter name.
+     */
+    getParamName(key: string): string | undefined;
+}