npm - @twin.org/api-models - Versions diffs - 0.0.3-next.9 → 0.9.0 - Mend

@twin.org/api-models 0.0.3-next.9 → 0.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (148) hide show

package/dist/types/models/client/IAuthenticationGenerator.d.ts DELETED Viewed

@@ -1,14 +0,0 @@
-import type { IComponent } from "@twin.org/core";
-import type { IHttpHeaders } from "@twin.org/web";
-/**
- * Definition for the authentication generator component.
- */
-export interface IAuthenticationGenerator extends IComponent {
-    /**
-     * Adds authentication information to the request headers.
-     * @param requestHeaders The request headers to add authentication information to.
-     * @param authData Optional authentication data passed from the request.
-     * @returns A promise that resolves when the authentication information has been added.
-     */
-    addAuthentication(requestHeaders: IHttpHeaders, authData?: unknown): Promise<void>;
-}

package/dist/types/models/services/IHealthComponentInfo.d.ts DELETED Viewed

@@ -1,18 +0,0 @@
-import type { HealthStatus } from "./healthStatus.js";
-/**
- * The health component information.
- */
-export interface IHealthComponentInfo {
-    /**
-     * 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/IHealthInfo.d.ts DELETED Viewed

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

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

@@ -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 DELETED Viewed

@@ -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/IHealthComponentInfo.md DELETED Viewed

@@ -1,27 +0,0 @@
-# Interface: IHealthComponentInfo
-The health component information.
-## Properties
-### 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/interfaces/IHealthInfo.md DELETED Viewed

@@ -1,19 +0,0 @@
-# Interface: IHealthInfo
-The status of the server.
-## Properties
-### status
-> **status**: [`HealthStatus`](../type-aliases/HealthStatus.md)
-The status.
-***
-### components?
-> `optional` **components**: [`IHealthComponentInfo`](IHealthComponentInfo.md)[]
-The status of the components.

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

@@ -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 DELETED Viewed

@@ -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 DELETED Viewed

@@ -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.