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

package/docs/reference/variables/HttpContextIdKeys.md

@@ -0,0 +1,25 @@
+# Variable: HttpContextIdKeys
+
+> `const` **HttpContextIdKeys**: `object`
+
+HTTP definition of some context keys.
+
+## Type Declaration
+
+### IpAddress {#ipaddress}
+
+> `readonly` **IpAddress**: `"ipAddress"` = `"ipAddress"`
+
+IP address of the client.
+
+### UserAgent {#useragent}
+
+> `readonly` **UserAgent**: `"userAgent"` = `"userAgent"`
+
+User agent of the client.
+
+### CorrelationId {#correlationid}
+
+> `readonly` **CorrelationId**: `"correlationId"` = `"correlationId"`
+
+Correlation ID of the request.

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/api-models",
-	"version": "0.0.3-next.4",
-	"description": "Contains models and classes for use with APIs",
+	"version": "0.0.3-next.40",
+	"description": "Shared API contracts, route types, and response models used across services and clients.",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/twinfoundation/api.git",
+		"url": "git+https://github.com/iotaledger/twin-api.git",
 		"directory": "packages/api-models"
 	},
 	"author": "martyn.janes@iota.org",
@@ -47,7 +47,7 @@
 		"schemas"
 	],
 	"bugs": {
-		"url": "git+https://github.com/twinfoundation/api/issues"
+		"url": "git+https://github.com/iotaledger/twin-api/issues"
 	},
 	"homepage": "https://twindev.org"
 }

package/dist/es/factories/authenticationGeneratorFactory.js

@@ -1,9 +0,0 @@
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-import { Factory } from "@twin.org/core";
-/**
- * Factory for creating implementation of authentication generator types.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-export const AuthenticationGeneratorFactory = Factory.createFactory("authentication-generator");
-//# sourceMappingURL=authenticationGeneratorFactory.js.map

package/dist/es/factories/authenticationGeneratorFactory.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"authenticationGeneratorFactory.js","sourceRoot":"","sources":["../../../src/factories/authenticationGeneratorFactory.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAGzC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,8BAA8B,GAAG,OAAO,CAAC,aAAa,CAClE,0BAA0B,CAC1B,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Factory } from \"@twin.org/core\";\nimport type { IAuthenticationGenerator } from \"../models/client/IAuthenticationGenerator.js\";\n\n/**\n * Factory for creating implementation of authentication generator types.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const AuthenticationGeneratorFactory = Factory.createFactory<IAuthenticationGenerator>(\n\t\"authentication-generator\"\n);\n"]}

package/dist/es/models/client/IAuthenticationGenerator.js

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

package/dist/es/models/client/IAuthenticationGenerator.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"IAuthenticationGenerator.js","sourceRoot":"","sources":["../../../../src/models/client/IAuthenticationGenerator.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IHttpHeaders } from \"@twin.org/web\";\n\n/**\n * Definition for the authentication generator component.\n */\nexport interface IAuthenticationGenerator extends IComponent {\n\t/**\n\t * Adds authentication information to the request headers.\n\t * @param requestHeaders The request headers to add authentication information to.\n\t * @param authData Optional authentication data passed from the request.\n\t * @returns A promise that resolves when the authentication information has been added.\n\t */\n\taddAuthentication(requestHeaders: IHttpHeaders, authData?: unknown): Promise<void>;\n}\n"]}

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

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

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

@@ -1 +0,0 @@
-{"version":3,"file":"IHealthInfo.js","sourceRoot":"","sources":["../../../../src/models/services/IHealthInfo.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HealthStatus } from \"./healthStatus.js\";\n\n/**\n * The status of the server.\n */\nexport interface IHealthInfo {\n\t/**\n\t * The status.\n\t */\n\tstatus: HealthStatus;\n\n\t/**\n\t * The status of the components.\n\t */\n\tcomponents?: {\n\t\t/**\n\t\t * The name of the component.\n\t\t */\n\t\tname: string;\n\n\t\t/**\n\t\t * The status of the component.\n\t\t */\n\t\tstatus: HealthStatus;\n\n\t\t/**\n\t\t * The details for the status.\n\t\t */\n\t\tdetails?: string;\n\t}[];\n}\n"]}

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

@@ -1,21 +0,0 @@
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * The health status of the component.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-export const HealthStatus = {
-    /**
-     * OK.
-     */
-    Ok: "ok",
-    /**
-     * Warning.
-     */
-    Warning: "warning",
-    /**
-     * Error.
-     */
-    Error: "error"
-};
-//# sourceMappingURL=healthStatus.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"healthStatus.js","sourceRoot":"","sources":["../../../../src/models/services/healthStatus.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,YAAY,GAAG;IAC3B;;OAEG;IACH,EAAE,EAAE,IAAI;IAER;;OAEG;IACH,OAAO,EAAE,SAAS;IAElB;;OAEG;IACH,KAAK,EAAE,OAAO;CACL,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The health status of the component.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const HealthStatus = {\n\t/**\n\t * OK.\n\t */\n\tOk: \"ok\",\n\n\t/**\n\t * Warning.\n\t */\n\tWarning: \"warning\",\n\n\t/**\n\t * Error.\n\t */\n\tError: \"error\"\n} as const;\n\n/**\n * The health status of the component.\n */\nexport type HealthStatus = (typeof HealthStatus)[keyof typeof HealthStatus];\n"]}

package/dist/types/factories/authenticationGeneratorFactory.d.ts

@@ -1,6 +0,0 @@
-import { Factory } from "@twin.org/core";
-import type { IAuthenticationGenerator } from "../models/client/IAuthenticationGenerator.js";
-/**
- * Factory for creating implementation of authentication generator types.
- */
-export declare const AuthenticationGeneratorFactory: Factory<IAuthenticationGenerator>;

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

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