@twin.org/api-models 0.0.3-next.5 → 0.0.3-next.50

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

@@ -1,27 +0,0 @@
-import type { HealthStatus } from "./healthStatus.js";
-/**
- * The status of the server.
- */
-export interface IHealthInfo {
-    /**
-     * The status.
-     */
-    status: HealthStatus;
-    /**
-     * The status of the components.
-     */
-    components?: {
-        /**
-         * The name of the component.
-         */
-        name: string;
-        /**
-         * The status of the component.
-         */
-        status: HealthStatus;
-        /**
-         * The details for the status.
-         */
-        details?: string;
-    }[];
-}

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

@@ -1,21 +0,0 @@
-/**
- * The health status of the component.
- */
-export declare const HealthStatus: {
-    /**
-     * OK.
-     */
-    readonly Ok: "ok";
-    /**
-     * Warning.
-     */
-    readonly Warning: "warning";
-    /**
-     * Error.
-     */
-    readonly Error: "error";
-};
-/**
- * The health status of the component.
- */
-export type HealthStatus = (typeof HealthStatus)[keyof typeof HealthStatus];

package/docs/reference/interfaces/IAuthenticationGenerator.md

@@ -1,35 +0,0 @@
-# Interface: IAuthenticationGenerator
-
-Definition for the authentication generator component.
-
-## Extends
-
-- `IComponent`
-
-## Methods
-
-### addAuthentication()
-
-> **addAuthentication**(`requestHeaders`, `authData?`): `Promise`\<`void`\>
-
-Adds authentication information to the request headers.
-
-#### Parameters
-
-##### requestHeaders
-
-`IHttpHeaders`
-
-The request headers to add authentication information to.
-
-##### authData?
-
-`unknown`
-
-Optional authentication data passed from the request.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-A promise that resolves when the authentication information has been added.

package/docs/reference/interfaces/IHealthInfo.md

@@ -1,37 +0,0 @@
-# Interface: IHealthInfo
-
-The status of the server.
-
-## Properties
-
-### status
-
-> **status**: [`HealthStatus`](../type-aliases/HealthStatus.md)
-
-The status.
-
-***
-
-### components?
-
-> `optional` **components**: `object`[]
-
-The status of the components.
-
-#### name
-
-> **name**: `string`
-
-The name of the component.
-
-#### status
-
-> **status**: [`HealthStatus`](../type-aliases/HealthStatus.md)
-
-The status of the component.
-
-#### details?
-
-> `optional` **details**: `string`
-
-The details for the status.

package/docs/reference/type-aliases/HealthStatus.md

@@ -1,5 +0,0 @@
-# Type Alias: HealthStatus
-
-> **HealthStatus** = *typeof* [`HealthStatus`](../variables/HealthStatus.md)\[keyof *typeof* [`HealthStatus`](../variables/HealthStatus.md)\]
-
-The health status of the component.

package/docs/reference/variables/AuthenticationGeneratorFactory.md

@@ -1,5 +0,0 @@
-# Variable: AuthenticationGeneratorFactory
-
-> `const` **AuthenticationGeneratorFactory**: `Factory`\<[`IAuthenticationGenerator`](../interfaces/IAuthenticationGenerator.md)\>
-
-Factory for creating implementation of authentication generator types.

package/docs/reference/variables/HealthStatus.md

@@ -1,25 +0,0 @@
-# Variable: HealthStatus
-
-> `const` **HealthStatus**: `object`
-
-The health status of the component.
-
-## Type Declaration
-
-### Ok
-
-> `readonly` **Ok**: `"ok"` = `"ok"`
-
-OK.
-
-### Warning
-
-> `readonly` **Warning**: `"warning"` = `"warning"`
-
-Warning.
-
-### Error
-
-> `readonly` **Error**: `"error"` = `"error"`
-
-Error.