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

package/dist/es/models/services/IHostingComponent.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IHostingComponent.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"IHostingComponent.js","sourceRoot":"","sources":["../../../../src/models/services/IHostingComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\n\n/**\n * The information about the hosting of the API.\n */\nexport interface IHostingComponent extends IComponent {\n\t/**\n\t * Get the public origin for the hosting.\n\t * @param serverRequestUrl The url of the current server request if there is one.\n\t * @returns The public origin.\n\t */\n\tgetPublicOrigin(serverRequestUrl?: string): Promise<string>;\n\n\t/**\n\t * Get the public origin for the tenant if one exists.\n\t * @param tenantId The tenant identifier.\n\t * @returns The public origin for the tenant.\n\t */\n\tgetTenantOrigin(tenantId: string): Promise<string | undefined>;\n\n\t/**\n\t * Build a public url based on the public origin and the url provided.\n\t * @param url The url to build upon the public origin.\n\t * @returns The full url based on the public origin.\n\t */\n\tbuildPublicUrl(url: string): Promise<string>;\n}\n"]}

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

@@ -1 +1 @@
-{"version":3,"file":"IInformationComponent.js","sourceRoot":"","sources":["../../../../src/models/services/IInformationComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { HealthStatus } from \"./healthStatus.js\";\nimport type { IHealthInfo } from \"./IHealthInfo.js\";\nimport type { IServerInfo } from \"./IServerInfo.js\";\n\n/**\n * The information component for the server.\n */\nexport interface IInformationComponent extends IComponent {\n\t/**\n\t * Get the root information.\n\t * @returns The root information.\n\t */\n\troot(): Promise<string>;\n\n\t/**\n\t * Get the server information.\n\t * @returns The service information.\n\t */\n\tinfo(): Promise<IServerInfo>;\n\n\t/**\n\t * Get the favicon.\n\t * @returns The favicon.\n\t */\n\tfavicon(): Promise<Uint8Array | undefined>;\n\n\t/**\n\t * Get the OpenAPI spec.\n\t * @returns The OpenAPI spec.\n\t */\n\tspec(): Promise<unknown>;\n\n\t/**\n\t * Get the server health.\n\t * @returns The service health.\n\t */\n\thealth(): Promise<IHealthInfo>;\n\n\t/**\n\t * Set the status of a component.\n\t * @param name The component name.\n\t * @param status The status of the component.\n\t * @param details The details for the status.\n\t * @returns Nothing.\n\t */\n\tsetComponentHealth(name: string, status: HealthStatus, details?: string): Promise<void>;\n\n\t/**\n\t * Remove the status of a component.\n\t * @param name The component name.\n\t * @returns Nothing.\n\t */\n\tremoveComponentHealth(name: string): Promise<void>;\n}\n"]}
+{"version":3,"file":"IInformationComponent.js","sourceRoot":"","sources":["../../../../src/models/services/IInformationComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IServerInfo } from \"./IServerInfo.js\";\n\n/**\n * The information component for the server.\n */\nexport interface IInformationComponent extends IComponent {\n\t/**\n\t * Get the root information.\n\t * @returns The root information.\n\t */\n\troot(): Promise<string>;\n\n\t/**\n\t * Get the server information.\n\t * @returns The service information.\n\t */\n\tinfo(): Promise<IServerInfo>;\n\n\t/**\n\t * Get the favicon.\n\t * @returns The favicon.\n\t */\n\tfavicon(): Promise<Uint8Array | undefined>;\n\n\t/**\n\t * Get the OpenAPI spec.\n\t * @returns The OpenAPI spec.\n\t */\n\tspec(): Promise<unknown>;\n\n\t/**\n\t * Is the server live.\n\t * @returns The livez status of the server.\n\t */\n\tlivez(): Promise<{ status: \"alive\" | \"dead\" }>;\n\n\t/**\n\t * Is the server ready.\n\t * @returns The readyz status of the server.\n\t */\n\treadyz(): Promise<{ status: \"ready\" | \"not ready\" }>;\n}\n"]}

package/dist/es/models/services/ITenant.js

@@ -0,0 +1,4 @@
+// Copyright 2025 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=ITenant.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ITenant.js","sourceRoot":"","sources":["../../../../src/models/services/ITenant.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Model defining the tenant.\n */\nexport interface ITenant {\n\t/**\n\t * The unique identifier for the tenant.\n\t */\n\tid: string;\n\n\t/**\n\t * The api key for the tenant.\n\t */\n\tapiKey: string;\n\n\t/**\n\t * The label of the tenant.\n\t */\n\tlabel: string;\n\n\t/**\n\t * The date the tenant was created.\n\t */\n\tdateCreated: string;\n\n\t/**\n\t * The date the tenant was modified.\n\t */\n\tdateModified: string;\n\n\t/**\n\t * The public origin available to the public for accessing the API.\n\t */\n\tpublicOrigin?: string;\n\n\t/**\n\t * Indicates whether the tenant is the node tenant.\n\t */\n\tisNodeTenant: boolean;\n}\n"]}

package/dist/es/models/services/ITenantAdminComponent.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ITenantAdminComponent.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ITenantAdminComponent.js","sourceRoot":"","sources":["../../../../src/models/services/ITenantAdminComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { ITenant } from \"./ITenant.js\";\n\n/**\n * Configuration for the tenant admin component\n */\nexport interface ITenantAdminComponent extends IComponent {\n\t/**\n\t * Create a tenant.\n\t * @param tenant The tenant to store.\n\t * @returns The tenant id.\n\t */\n\tcreate(\n\t\ttenant: Omit<ITenant, \"id\" | \"dateCreated\" | \"dateModified\"> & { id?: string }\n\t): Promise<string>;\n\n\t/**\n\t * Update a tenant.\n\t * @param tenant The tenant to update.\n\t * @returns Nothing.\n\t */\n\tupdate(tenant: Partial<Omit<ITenant, \"dateCreated\" | \"dateModified\">>): Promise<void>;\n\n\t/**\n\t * Get a tenant by its id.\n\t * @param tenantId The id of the tenant.\n\t * @returns The tenant.\n\t * @throws Error if the tenant is not found.\n\t */\n\tget(tenantId: string): Promise<ITenant>;\n\n\t/**\n\t * Get a tenant by its api key.\n\t * @param apiKey The api key of the tenant.\n\t * @returns The tenant.\n\t * @throws Error if the tenant is not found.\n\t */\n\tgetByApiKey(apiKey: string): Promise<ITenant>;\n\n\t/**\n\t * Get a tenant by its public origin.\n\t * @param publicOrigin The origin of the tenant.\n\t * @returns The tenant.\n\t * @throws Error if the tenant is not found.\n\t */\n\tgetByPublicOrigin(publicOrigin: string): Promise<ITenant>;\n\n\t/**\n\t * Remove a tenant by its id.\n\t * @param tenantId The id of the tenant.\n\t * @returns Nothing.\n\t * @throws Error if the tenant is not found.\n\t */\n\tremove(tenantId: string): Promise<void>;\n\n\t/**\n\t * Query tenants with pagination.\n\t * @param options Optional query options.\n\t * @param options.isNodeTenant Whether to filter for node admin tenants.\n\t * @param cursor The cursor to start from.\n\t * @param limit The maximum number of tenants to return.\n\t * @returns The tenants and the next cursor if more tenants are available.\n\t */\n\tquery(\n\t\toptions?: { isNodeTenant?: boolean },\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{ tenants: ITenant[]; cursor?: string }>;\n}\n"]}

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

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IUrlTransformerComponent.js.map

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

@@ -0,0 +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"]}

package/dist/types/errors/forbiddenError.d.ts

@@ -0,0 +1,20 @@
+import { BaseError } from "@twin.org/core";
+/**
+ * Class to handle errors which are triggered by forbidden actions.
+ */
+export declare class ForbiddenError extends BaseError {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of ForbiddenError.
+     * @param source The source of the error.
+     * @param message The message as a code.
+     * @param properties Any additional information for the error.
+     * @param cause The cause of the error if we have wrapped another error.
+     */
+    constructor(source: string, message: string, properties?: {
+        [id: string]: unknown;
+    }, cause?: unknown);
+}

package/dist/types/errors/tooManyRequestsError.d.ts

@@ -0,0 +1,22 @@
+import { BaseError } from "@twin.org/core";
+/**
+ * Class to handle errors which are triggered by too many requests.
+ */
+export declare class TooManyRequestsError extends BaseError {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of TooManyRequestsError.
+     * @param source The source of the error.
+     * @param message The message as a code.
+     * @param requestCount The current request count.
+     * @param nextRequestTime The time when the next request can be made, as date ISO string.
+     * @param properties Any additional information for the error.
+     * @param cause The cause of the error if we have wrapped another error.
+     */
+    constructor(source: string, message: string, requestCount: number, nextRequestTime: string, properties?: {
+        [id: string]: unknown;
+    }, cause?: unknown);
+}

package/dist/types/helpers/httpErrorHelper.d.ts

@@ -5,6 +5,12 @@ import type { IHttpResponse } from "../models/protocol/IHttpResponse.js";
  * Class to help with processing http errors.
  */
 export declare class HttpErrorHelper {
+    /**
+     * Mapping of error types to status codes.
+     */
+    static readonly ERROR_TYPE_MAP: {
+        [id: string]: HttpStatusCode;
+    };
     /**
      * Process the errors from the routes.
      * @param err The error to process.

package/dist/types/helpers/httpUrlHelper.d.ts

@@ -0,0 +1,55 @@
+/**
+ * Class to help with handling http URLs.
+ */
+export declare class HttpUrlHelper {
+    /**
+     * Extract the origin from the url which includes protocol,host,port.
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/URL/origin
+     * @param url The url to extract the origin from.
+     * @returns The extracted origin.
+     */
+    static extractOrigin(url: string): string | undefined;
+    /**
+     * Extract the path from the url.
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/URL/pathname
+     * @param url The url to extract the path from.
+     * @returns The extracted path.
+     */
+    static extractPath(url: string): string | undefined;
+    /**
+     * Extract the search from the url.
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/URL/search
+     * @param url The url to extract the search from.
+     * @returns The extracted search.
+     */
+    static extractSearch(url: string): string | undefined;
+    /**
+     * Extract the path and search from the url.
+     * @param url The url to extract the path and search from.
+     * @returns The extracted path and search.
+     */
+    static extractPathAndSearch(url: string): string | undefined;
+    /**
+     * Combine the urls parts.
+     * @param origin The origin to combine.
+     * @param pathAndSearch The path and search to combine.
+     * @returns The combined parts.
+     */
+    static combineParts(origin: string, pathAndSearch: string): string | undefined;
+    /**
+     * Encode a single URL path segment per RFC 3986 §3.3.
+     * Unlike encodeURIComponent, sub-delimiters ($ & + , ; =) and the colon and
+     * at-sign characters that are valid unencoded in path segments are preserved.
+     * @see https://datatracker.ietf.org/doc/html/rfc3986#section-3.3
+     * @param segment The raw path segment value to encode.
+     * @returns The percent-encoded path segment.
+     */
+    static encodeUriPathSegment(segment: string): string;
+    /**
+     * Replace the origin in the url.
+     * @param url The url to replace the origin in.
+     * @param newOrigin The new origin to use.
+     * @returns The url with the replaced origin.
+     */
+    static replaceOrigin(url: string, newOrigin?: string): string;
+}

package/dist/types/index.d.ts

@@ -1,17 +1,21 @@
-export * from "./factories/authenticationGeneratorFactory.js";
+export * from "./errors/forbiddenError.js";
+export * from "./errors/tooManyRequestsError.js";
 export * from "./factories/mimeTypeProcessorFactory.js";
 export * from "./factories/restRouteProcessorFactory.js";
 export * from "./factories/socketRouteProcessorFactory.js";
 export * from "./helpers/httpErrorHelper.js";
 export * from "./helpers/httpParameterHelper.js";
+export * from "./helpers/httpUrlHelper.js";
 export * from "./models/api/IServerFavIconResponse.js";
 export * from "./models/api/IServerHealthResponse.js";
 export * from "./models/api/IServerInfoResponse.js";
+export * from "./models/api/IServerLivezResponse.js";
+export * from "./models/api/IServerReadyzResponse.js";
 export * from "./models/api/IServerRootResponse.js";
 export * from "./models/api/IServerSpecResponse.js";
-export * from "./models/client/IAuthenticationGenerator.js";
 export * from "./models/config/IBaseRestClientConfig.js";
 export * from "./models/config/IBaseSocketClientConfig.js";
+export * from "./models/httpContextIdKeys.js";
 export * from "./models/protocol/IHttpRequest.js";
 export * from "./models/protocol/IHttpRequestContext.js";
 export * from "./models/protocol/IHttpRequestPathParams.js";
@@ -26,6 +30,8 @@ export * from "./models/responses/errors/IConflictResponse.js";
 export * from "./models/responses/errors/IForbiddenResponse.js";
 export * from "./models/responses/errors/IInternalServerErrorResponse.js";
 export * from "./models/responses/errors/INotFoundResponse.js";
+export * from "./models/responses/errors/INotImplementedResponse.js";
+export * from "./models/responses/errors/ITooManyRequestsResponse.js";
 export * from "./models/responses/errors/IUnauthorizedResponse.js";
 export * from "./models/responses/errors/IUnprocessableEntityResponse.js";
 export * from "./models/responses/success/IAcceptedResponse.js";
@@ -50,7 +56,10 @@ export * from "./models/server/IRestRouteProcessor.js";
 export * from "./models/server/ISocketRouteProcessor.js";
 export * from "./models/server/IWebServer.js";
 export * from "./models/server/IWebServerOptions.js";
-export * from "./models/services/healthStatus.js";
-export * from "./models/services/IHealthInfo.js";
+export * from "./models/services/IHealthComponent.js";
+export * from "./models/services/IHostingComponent.js";
 export * from "./models/services/IInformationComponent.js";
+export * from "./models/services/IUrlTransformerComponent.js";
 export * from "./models/services/IServerInfo.js";
+export * from "./models/services/ITenant.js";
+export * from "./models/services/ITenantAdminComponent.js";

package/dist/types/models/api/IServerHealthResponse.d.ts

@@ -1,10 +1,13 @@
-import type { IHealthInfo } from "../services/IHealthInfo.js";
+import type { HealthStatus, IHealth } from "@twin.org/core";
 /**
  * The health of the server.
  */
 export interface IServerHealthResponse {
     /**
-     * The information for the server.
+     * The health for the server.
      */
-    body: IHealthInfo;
+    body: {
+        status: HealthStatus;
+        components: IHealth[];
+    };
 }

package/dist/types/models/api/IServerLivezResponse.d.ts

@@ -0,0 +1,16 @@
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
+/**
+ * The livez of the server.
+ */
+export interface IServerLivezResponse {
+    /**
+     * The headers for the response.
+     */
+    headers: {
+        [HeaderTypes.ContentType]: typeof MimeTypes.PlainText;
+    };
+    /**
+     * The livez information for the server.
+     */
+    body: "alive" | "dead";
+}

package/dist/types/models/api/IServerReadyzResponse.d.ts

@@ -0,0 +1,16 @@
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
+/**
+ * The readyz of the server.
+ */
+export interface IServerReadyzResponse {
+    /**
+     * The headers for the response.
+     */
+    headers: {
+        [HeaderTypes.ContentType]: typeof MimeTypes.PlainText;
+    };
+    /**
+     * The readyz information for the server.
+     */
+    body: "ready" | "not ready";
+}

package/dist/types/models/api/IServerRootResponse.d.ts

@@ -1,7 +1,14 @@
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
 /**
  * The root text for the server.
  */
 export interface IServerRootResponse {
+    /**
+     * The headers for the response.
+     */
+    headers: {
+        [HeaderTypes.ContentType]: typeof MimeTypes.PlainText;
+    };
     /**
      * The root text for the server.
      */

package/dist/types/models/config/IBaseRestClientConfig.d.ts

@@ -1,3 +1,4 @@
+import type { IError } from "@twin.org/core";
 import type { IHttpHeaders } from "@twin.org/web";
 /**
  * Definition for the configuration of a rest client.
@@ -23,4 +24,19 @@ export interface IBaseRestClientConfig {
      * Include credentials in the request, defaults to true.
      */
     includeCredentials?: boolean;
+    /**
+     * Hook to provide headers asynchronously.
+     * @returns A promise that resolves to the headers.
+     */
+    customHeaders?: () => Promise<IHttpHeaders>;
+    /**
+     * Hook to provide an authorization header value asynchronously.
+     * @returns A promise that resolves to the authorization header value.
+     */
+    customAuthHeader?: () => Promise<string>;
+    /**
+     * Hook to handle authorization failures asynchronously.
+     * @returns A promise that resolves when the auth failure handling is complete.
+     */
+    onAuthFailure?: (err: IError) => Promise<void>;
 }

package/dist/types/models/httpContextIdKeys.d.ts

@@ -0,0 +1,21 @@
+/**
+ * HTTP definition of some context keys.
+ */
+export declare const HttpContextIdKeys: {
+    /**
+     * IP address of the client.
+     */
+    readonly IpAddress: "ipAddress";
+    /**
+     * User agent of the client.
+     */
+    readonly UserAgent: "userAgent";
+    /**
+     * Correlation ID of the request.
+     */
+    readonly CorrelationId: "correlationId";
+};
+/**
+ * HTTP definition of some context keys.
+ */
+export type HttpContextIdKeys = (typeof HttpContextIdKeys)[keyof typeof HttpContextIdKeys];

package/dist/types/models/protocol/IHttpRequestContext.d.ts

@@ -17,4 +17,8 @@ export interface IHttpRequestContext {
      * Logging component type for the request.
      */
     loggingComponentType?: string;
+    /**
+     * Hosting component type for the request.
+     */
+    hostingComponentType?: string;
 }

package/dist/types/models/protocol/IHttpRequestPathParams.d.ts

@@ -2,5 +2,5 @@
  * Model for the standard parameters for an http request.
  */
 export interface IHttpRequestPathParams {
-    [id: string]: string | number | boolean;
+    [id: string]: string;
 }

package/dist/types/models/protocol/IHttpRequestQuery.d.ts

@@ -2,5 +2,5 @@
  * Model used for Http request query parameters.
  */
 export interface IHttpRequestQuery {
-    [id: string]: string | number | boolean;
+    [id: string]: string;
 }

package/dist/types/models/protocol/IHttpServerRequest.d.ts

@@ -5,11 +5,11 @@ import type { IHttpRequest } from "./IHttpRequest.js";
  */
 export interface IHttpServerRequest<T = any> extends IHttpRequest<T> {
     /**
-     * The request method.
+     * The request url.
      */
-    method?: HttpMethod;
+    url: string;
     /**
-     * The request url.
+     * The request method.
      */
-    url?: string;
+    method?: HttpMethod;
 }

package/dist/types/models/responses/errors/IConflictResponse.d.ts

@@ -11,10 +11,5 @@ export interface IConflictResponse {
     /**
      * The body which contains the error.
      */
-    body: IError & {
-        /**
-         * The conflicting items.
-         */
-        conflicts: string[];
-    };
+    body: IError;
 }

package/dist/types/models/responses/errors/INotImplementedResponse.d.ts

@@ -0,0 +1,15 @@
+import type { IError } from "@twin.org/core";
+import type { HttpStatusCode } from "@twin.org/web";
+/**
+ * The operation that you tried to perform is not implemented, see the content for more details.
+ */
+export interface INotImplementedResponse {
+    /**
+     * Response status code.
+     */
+    statusCode: typeof HttpStatusCode.notImplemented;
+    /**
+     * The body which contains the error.
+     */
+    body: IError;
+}

package/dist/types/models/responses/errors/ITooManyRequestsResponse.d.ts

@@ -0,0 +1,15 @@
+import type { IError } from "@twin.org/core";
+import type { HttpStatusCode } from "@twin.org/web";
+/**
+ * The request resulted in too many requests, see the content for more details.
+ */
+export interface ITooManyRequestsResponse {
+    /**
+     * Response status code.
+     */
+    statusCode: typeof HttpStatusCode.tooManyRequests;
+    /**
+     * The body which contains the error.
+     */
+    body: IError;
+}

package/dist/types/models/routes/IBaseRoute.d.ts

@@ -11,9 +11,17 @@ export interface IBaseRoute {
      */
     path: string;
     /**
-     * Skips the authentication for this route.
+     * Skips the authentication requirement for this route.
      */
     skipAuth?: boolean;
+    /**
+     * Skips the tenant requirement for this route.
+     */
+    skipTenant?: boolean;
+    /**
+     * The user must have one of the specified scopes to access the route.
+     */
+    requiredScope?: string[];
     /**
      * The features supported by additional processors to run for this route.
      */

package/dist/types/models/server/IBaseRouteProcessor.d.ts

@@ -21,12 +21,17 @@ export interface IBaseRouteProcessor<T = IBaseRoute, R = IHttpServerRequest> ext
      * @param route The route being requested, if a matching one was found.
      * @param contextIds The context IDs of the request.
      * @param processorState The state handed through the processors.
-     * @param loggingComponentType The logging component type for the request.
+     * @param componentTypes The component types for the request.
+     * @param componentTypes.loggingComponentType The logging component type.
+     * @param componentTypes.hostingComponentType The hosting component type.
      * @returns Promise that resolves when the request is processed.
      */
     pre?(request: R, response: IHttpResponse, route: T | undefined, contextIds: IContextIds, processorState: {
         [id: string]: unknown;
-    }, loggingComponentType?: string): Promise<void>;
+    }, componentTypes?: {
+        loggingComponentType?: string;
+        hostingComponentType?: string;
+    }): Promise<void>;
     /**
      * Post process the REST request for the specified route.
      * @param request The request to handle.
@@ -34,10 +39,15 @@ export interface IBaseRouteProcessor<T = IBaseRoute, R = IHttpServerRequest> ext
      * @param route The route being requested, if a matching one was found.
      * @param contextIds The context IDs of the request.
      * @param processorState The state handed through the processors.
-     * @param loggingComponentType The logging component type for the request.
+     * @param componentTypes The component types for the request.
+     * @param componentTypes.loggingComponentType The logging component type.
+     * @param componentTypes.hostingComponentType The hosting component type.
      * @returns Promise that resolves when the request is processed.
      */
     post?(request: R, response: IHttpResponse, route: T | undefined, contextIds: IContextIds, processorState: {
         [id: string]: unknown;
-    }, loggingComponentType?: string): Promise<void>;
+    }, componentTypes?: {
+        loggingComponentType?: string;
+        hostingComponentType?: string;
+    }): Promise<void>;
 }

package/dist/types/models/server/IRestRouteProcessor.d.ts

@@ -12,10 +12,15 @@ export interface IRestRouteProcessor extends IBaseRouteProcessor<IRestRoute> {
      * @param response The response data to send if any.
      * @param route The route being requested, if a matching one was found.
      * @param processorState The state handed through the processors.
-     * @param loggingComponentType The logging component type for the request.
+     * @param componentTypes The component types for the request.
+     * @param componentTypes.loggingComponentType The logging component type.
+     * @param componentTypes.hostingComponentType The hosting component type.
      * @returns Promise that resolves when the request is processed.
      */
     process?(request: IHttpServerRequest, response: IHttpResponse, route: IRestRoute | undefined, processorState: {
         [id: string]: unknown;
-    }, loggingComponentType?: string): Promise<void>;
+    }, componentTypes?: {
+        loggingComponentType?: string;
+        hostingComponentType?: string;
+    }): Promise<void>;
 }

package/dist/types/models/server/IWebServer.d.ts

@@ -1,3 +1,4 @@
+import type { IComponent, IHealth } from "@twin.org/core";
 import type { IRestRouteProcessor } from "./IRestRouteProcessor.js";
 import type { ISocketRouteProcessor } from "./ISocketRouteProcessor.js";
 import type { IWebServerOptions } from "./IWebServerOptions.js";
@@ -6,7 +7,7 @@ import type { ISocketRoute } from "../routes/ISocketRoute.js";
 /**
  * Interface describing a web server.
  */
-export interface IWebServer<T> {
+export interface IWebServer<T> extends IComponent {
     /**
      * Get the web server instance.
      * @returns The web server instance.
@@ -32,4 +33,9 @@ export interface IWebServer<T> {
      * @returns Nothing.
      */
     stop(): Promise<void>;
+    /**
+     * Returns the health status of the component.
+     * @returns The health status of the component, can return multiple entries for elements within the component.
+     */
+    health(): Promise<IHealth[]>;
 }

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

@@ -0,0 +1,14 @@
+import type { HealthStatus, IComponent, IHealth } from "@twin.org/core";
+/**
+ * The health component for the server.
+ */
+export interface IHealthComponent extends IComponent {
+    /**
+     * Get the server health.
+     * @returns The service health.
+     */
+    healthStatus(): Promise<{
+        status: HealthStatus;
+        components: IHealth[];
+    }>;
+}

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

@@ -0,0 +1,24 @@
+import type { IComponent } from "@twin.org/core";
+/**
+ * The information about the hosting of the API.
+ */
+export interface IHostingComponent extends IComponent {
+    /**
+     * Get the public origin for the hosting.
+     * @param serverRequestUrl The url of the current server request if there is one.
+     * @returns The public origin.
+     */
+    getPublicOrigin(serverRequestUrl?: string): Promise<string>;
+    /**
+     * Get the public origin for the tenant if one exists.
+     * @param tenantId The tenant identifier.
+     * @returns The public origin for the tenant.
+     */
+    getTenantOrigin(tenantId: string): Promise<string | undefined>;
+    /**
+     * Build a public url based on the public origin and the url provided.
+     * @param url The url to build upon the public origin.
+     * @returns The full url based on the public origin.
+     */
+    buildPublicUrl(url: string): Promise<string>;
+}

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

@@ -1,6 +1,4 @@
 import type { IComponent } from "@twin.org/core";
-import type { HealthStatus } from "./healthStatus.js";
-import type { IHealthInfo } from "./IHealthInfo.js";
 import type { IServerInfo } from "./IServerInfo.js";
 /**
  * The information component for the server.
@@ -27,22 +25,17 @@ export interface IInformationComponent extends IComponent {
      */
     spec(): Promise<unknown>;
     /**
-     * Get the server health.
-     * @returns The service health.
+     * Is the server live.
+     * @returns The livez status of the server.
      */
-    health(): Promise<IHealthInfo>;
+    livez(): Promise<{
+        status: "alive" | "dead";
+    }>;
     /**
-     * Set the status of a component.
-     * @param name The component name.
-     * @param status The status of the component.
-     * @param details The details for the status.
-     * @returns Nothing.
+     * Is the server ready.
+     * @returns The readyz status of the server.
      */
-    setComponentHealth(name: string, status: HealthStatus, details?: string): Promise<void>;
-    /**
-     * Remove the status of a component.
-     * @param name The component name.
-     * @returns Nothing.
-     */
-    removeComponentHealth(name: string): Promise<void>;
+    readyz(): Promise<{
+        status: "ready" | "not ready";
+    }>;
 }

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

@@ -0,0 +1,33 @@
+/**
+ * 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;
+    /**
+     * Indicates whether the tenant is the node tenant.
+     */
+    isNodeTenant: boolean;
+}