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

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

@@ -0,0 +1,29 @@
+/**
+ * Model defining the tenant.
+ */
+export interface ITenant {
+    /**
+     * The unique identifier for the tenant.
+     */
+    id: string;
+    /**
+     * The api key for the tenant.
+     */
+    apiKey: string;
+    /**
+     * The label of the tenant.
+     */
+    label: string;
+    /**
+     * The date the tenant was created.
+     */
+    dateCreated: string;
+    /**
+     * The date the tenant was modified.
+     */
+    dateModified: string;
+    /**
+     * The public origin available to the public for accessing the API.
+     */
+    publicOrigin?: string;
+}

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

@@ -0,0 +1,60 @@
+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 properties The properties to include in the returned 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(properties: (keyof ITenant)[] | undefined, cursor?: string, limit?: number): Promise<{
+        tenants: ITenant[];
+        cursor?: string;
+    }>;
+}

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

@@ -0,0 +1,12 @@
+import type { IComponent } from "@twin.org/core";
+/**
+ * Interface for the tenant component.
+ */
+export interface ITenantComponent extends IComponent {
+    /**
+     * Run a per tenant operation.
+     * @param method The method to run for each tenant.
+     * @returns Nothing.
+     */
+    runPerTenant(method: () => Promise<void>): Promise<void>;
+}

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

@@ -0,0 +1,79 @@
+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.
+     */
+    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 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>;
+    /**
+     * Get the parameter name for a given key.
+     * @param key The key of the parameter.
+     * @returns The parameter name.
+     */
+    getParamName(key: string): string | undefined;
+}