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

package/docs/reference/interfaces/ISocketRouteProcessor.md

@@ -8,9 +8,29 @@ The definition for a processor for handling socket routes.
 
 ## Methods
 
+### features()?
+
+> `optional` **features**(): `string`[]
+
+Features supported by this processor.
+If a route has any of these features listed, this processor will be run for that route.
+If this is not implemented, the processor will run for all routes.
+
+#### Returns
+
+`string`[]
+
+The features supported by this processor.
+
+#### Inherited from
+
+[`IBaseRouteProcessor`](IBaseRouteProcessor.md).[`features`](IBaseRouteProcessor.md#features)
+
+***
+
 ### pre()?
 
-> `optional` **pre**(`request`, `response`, `route`, `requestIdentity`, `processorState`, `loggingComponentType?`): `Promise`\<`void`\>
+> `optional` **pre**(`request`, `response`, `route`, `contextIds`, `processorState`, `loggingComponentType?`): `Promise`\<`void`\>
 
 Pre process the REST request for the specified route.
 
@@ -32,13 +52,13 @@ The response data to send if any.
 
 The route being requested, if a matching one was found.
 
-`undefined` | [`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\>
+[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> | `undefined`
 
-##### requestIdentity
+##### contextIds
 
-[`IHttpRequestIdentity`](IHttpRequestIdentity.md)
+`IContextIds`
 
-The identity context for the request.
+The context IDs of the request.
 
 ##### processorState
 
@@ -64,7 +84,7 @@ Promise that resolves when the request is processed.
 
 ### post()?
 
-> `optional` **post**(`request`, `response`, `route`, `requestIdentity`, `processorState`, `loggingComponentType?`): `Promise`\<`void`\>
+> `optional` **post**(`request`, `response`, `route`, `contextIds`, `processorState`, `loggingComponentType?`): `Promise`\<`void`\>
 
 Post process the REST request for the specified route.
 
@@ -86,13 +106,13 @@ The response data to send if any.
 
 The route being requested, if a matching one was found.
 
-`undefined` | [`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\>
+[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> | `undefined`
 
-##### requestIdentity
+##### contextIds
 
-[`IHttpRequestIdentity`](IHttpRequestIdentity.md)
+`IContextIds`
 
-The identity context for the request.
+The context IDs of the request.
 
 ##### processorState
 
@@ -134,7 +154,7 @@ The server request object containing the socket id and other parameters.
 
 The route being requested, if a matching one was found.
 
-`undefined` | [`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\>
+[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> | `undefined`
 
 ##### loggingComponentType?
 
@@ -168,7 +188,7 @@ The server request object containing the socket id and other parameters.
 
 The route being requested, if a matching one was found.
 
-`undefined` | [`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\>
+[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> | `undefined`
 
 ##### loggingComponentType?
 
@@ -186,7 +206,7 @@ Promise that resolves when the request is processed.
 
 ### process()?
 
-> `optional` **process**(`request`, `response`, `route`, `requestIdentity`, `processorState`, `responseEmitter`, `loggingComponentType?`): `Promise`\<`void`\>
+> `optional` **process**(`request`, `response`, `route`, `processorState`, `responseEmitter`, `loggingComponentType?`): `Promise`\<`void`\>
 
 Process the REST request for the specified route.
 
@@ -208,13 +228,7 @@ The response data to send if any.
 
 The route being requested, if a matching one was found.
 
-`undefined` | [`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\>
-
-##### requestIdentity
-
-[`IHttpRequestIdentity`](IHttpRequestIdentity.md)
-
-The identity context for the request.
+[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> | `undefined`
 
 ##### processorState
 

package/docs/reference/variables/AuthenticationGeneratorFactory.md

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

package/locales/en.json

@@ -1,9 +1 @@
-{
-	"error": {
-		"baseRestClient": {
-			"missingRouteProp": "Missing route parameter in data \"{routeProp}\" for route \"{route}\"",
-			"decodingFailed": "Decoding JSON failed for route \"{route}\"",
-			"failureStatusText": "The request to the API failed: \"{statusText}\""
-		}
-	}
-}
+{}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/api-models",
-	"version": "0.0.2-next.9",
+	"version": "0.0.3-next.1",
 	"description": "Contains models and classes for use with APIs",
 	"repository": {
 		"type": "git",
@@ -14,25 +14,40 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
+		"@twin.org/context": "next",
 		"@twin.org/core": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		}
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/types",
 		"locales",
 		"docs"
-	]
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"api",
+		"models",
+		"types",
+		"interfaces",
+		"schemas"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/api/issues"
+	},
+	"homepage": "https://twindev.org"
 }

package/dist/cjs/index.cjs

@@ -1,154 +0,0 @@
-'use strict';
-
-var core = require('@twin.org/core');
-var web = require('@twin.org/web');
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Factory for creating implementation of mime type processor types.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const MimeTypeProcessorFactory = core.Factory.createFactory("mime-type-processor");
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Factory for creating implementation of REST route processor types.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const RestRouteProcessorFactory = core.Factory.createFactory("rest-route-processor");
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Factory for creating implementation of socket route processor types.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const SocketRouteProcessorFactory = core.Factory.createFactory("socket-route-processor");
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Class to help with processing http errors.
- */
-class HttpErrorHelper {
-    /**
-     * Process the errors from the routes.
-     * @param err The error to process.
-     * @param includeStack Should the stack be included in the error.
-     * @returns The status code and additional error data.
-     */
-    static processError(err, includeStack) {
-        const error = core.BaseError.fromError(err);
-        // If the error or any of its sub errors are of the specific
-        // types then set the http response code accordingly
-        const flattened = core.BaseError.flatten(error);
-        let httpStatusCode = web.HttpStatusCode.internalServerError;
-        if (flattened.some(e => core.BaseError.isErrorName(e, core.GuardError.CLASS_NAME)) ||
-            flattened.some(e => core.BaseError.isErrorName(e, core.ValidationError.CLASS_NAME))) {
-            httpStatusCode = web.HttpStatusCode.badRequest;
-        }
-        else if (flattened.some(e => core.BaseError.isErrorName(e, core.ConflictError.CLASS_NAME)) ||
-            flattened.some(e => core.BaseError.isErrorName(e, core.AlreadyExistsError.CLASS_NAME))) {
-            httpStatusCode = web.HttpStatusCode.conflict;
-        }
-        else if (flattened.some(e => core.BaseError.isErrorName(e, core.NotFoundError.CLASS_NAME))) {
-            httpStatusCode = web.HttpStatusCode.notFound;
-        }
-        else if (flattened.some(e => core.BaseError.isErrorName(e, core.UnauthorizedError.CLASS_NAME))) {
-            httpStatusCode = web.HttpStatusCode.unauthorized;
-        }
-        else if (flattened.some(e => core.BaseError.isErrorName(e, core.NotImplementedError.CLASS_NAME))) {
-            httpStatusCode = web.HttpStatusCode.forbidden;
-        }
-        else if (flattened.some(e => core.BaseError.isErrorName(e, core.UnprocessableError.CLASS_NAME))) {
-            httpStatusCode = web.HttpStatusCode.unprocessableEntity;
-        }
-        const returnError = error.toJsonObject(includeStack);
-        return {
-            error: returnError,
-            httpStatusCode
-        };
-    }
-    /**
-     * Build an error response.
-     * @param response The response to build the error into.
-     * @param error The error to build the response for.
-     * @param statusCode The status code to use for the error.
-     */
-    static buildResponse(response, error, statusCode) {
-        response.headers ??= {};
-        response.headers[web.HeaderTypes.ContentType] = `${web.MimeTypes.Json}; charset=utf-8`;
-        response.body = error;
-        response.statusCode = statusCode;
-    }
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Class to help with handling http parameters.
- */
-class HttpParameterHelper {
-    /**
-     * Convert list query to array.
-     * @param values The values query string.
-     * @returns The array of values.
-     */
-    static arrayFromString(values) {
-        return values?.split(",");
-    }
-    /**
-     * Convert array of values to query string.
-     * @param values The values to combine string.
-     * @returns The combined.
-     */
-    static arrayToString(values) {
-        return values?.join(",");
-    }
-    /**
-     * Convert object string to object.
-     * @param value The value query string.
-     * @returns The object.
-     */
-    static objectFromString(value) {
-        return core.Is.json(value) ? JSON.parse(value) : undefined;
-    }
-    /**
-     * Convert object to query string.
-     * @param value The value to convert to a string.
-     * @returns The converted object.
-     */
-    static objectToString(value) {
-        return core.Is.empty(value) ? undefined : JSON.stringify(value);
-    }
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * The health status of the component.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const HealthStatus = {
-    /**
-     * OK.
-     */
-    Ok: "ok",
-    /**
-     * Warning.
-     */
-    Warning: "warning",
-    /**
-     * Error.
-     */
-    Error: "error"
-};
-
-exports.HealthStatus = HealthStatus;
-exports.HttpErrorHelper = HttpErrorHelper;
-exports.HttpParameterHelper = HttpParameterHelper;
-exports.MimeTypeProcessorFactory = MimeTypeProcessorFactory;
-exports.RestRouteProcessorFactory = RestRouteProcessorFactory;
-exports.SocketRouteProcessorFactory = SocketRouteProcessorFactory;

package/dist/esm/index.mjs

@@ -1,147 +0,0 @@
-import { Factory, BaseError, GuardError, ValidationError, ConflictError, AlreadyExistsError, NotFoundError, UnauthorizedError, NotImplementedError, UnprocessableError, Is } from '@twin.org/core';
-import { HttpStatusCode, MimeTypes, HeaderTypes } from '@twin.org/web';
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Factory for creating implementation of mime type processor types.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const MimeTypeProcessorFactory = Factory.createFactory("mime-type-processor");
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Factory for creating implementation of REST route processor types.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const RestRouteProcessorFactory = Factory.createFactory("rest-route-processor");
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Factory for creating implementation of socket route processor types.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const SocketRouteProcessorFactory = Factory.createFactory("socket-route-processor");
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Class to help with processing http errors.
- */
-class HttpErrorHelper {
-    /**
-     * Process the errors from the routes.
-     * @param err The error to process.
-     * @param includeStack Should the stack be included in the error.
-     * @returns The status code and additional error data.
-     */
-    static processError(err, includeStack) {
-        const error = BaseError.fromError(err);
-        // If the error or any of its sub errors are of the specific
-        // types then set the http response code accordingly
-        const flattened = BaseError.flatten(error);
-        let httpStatusCode = HttpStatusCode.internalServerError;
-        if (flattened.some(e => BaseError.isErrorName(e, GuardError.CLASS_NAME)) ||
-            flattened.some(e => BaseError.isErrorName(e, ValidationError.CLASS_NAME))) {
-            httpStatusCode = HttpStatusCode.badRequest;
-        }
-        else if (flattened.some(e => BaseError.isErrorName(e, ConflictError.CLASS_NAME)) ||
-            flattened.some(e => BaseError.isErrorName(e, AlreadyExistsError.CLASS_NAME))) {
-            httpStatusCode = HttpStatusCode.conflict;
-        }
-        else if (flattened.some(e => BaseError.isErrorName(e, NotFoundError.CLASS_NAME))) {
-            httpStatusCode = HttpStatusCode.notFound;
-        }
-        else if (flattened.some(e => BaseError.isErrorName(e, UnauthorizedError.CLASS_NAME))) {
-            httpStatusCode = HttpStatusCode.unauthorized;
-        }
-        else if (flattened.some(e => BaseError.isErrorName(e, NotImplementedError.CLASS_NAME))) {
-            httpStatusCode = HttpStatusCode.forbidden;
-        }
-        else if (flattened.some(e => BaseError.isErrorName(e, UnprocessableError.CLASS_NAME))) {
-            httpStatusCode = HttpStatusCode.unprocessableEntity;
-        }
-        const returnError = error.toJsonObject(includeStack);
-        return {
-            error: returnError,
-            httpStatusCode
-        };
-    }
-    /**
-     * Build an error response.
-     * @param response The response to build the error into.
-     * @param error The error to build the response for.
-     * @param statusCode The status code to use for the error.
-     */
-    static buildResponse(response, error, statusCode) {
-        response.headers ??= {};
-        response.headers[HeaderTypes.ContentType] = `${MimeTypes.Json}; charset=utf-8`;
-        response.body = error;
-        response.statusCode = statusCode;
-    }
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Class to help with handling http parameters.
- */
-class HttpParameterHelper {
-    /**
-     * Convert list query to array.
-     * @param values The values query string.
-     * @returns The array of values.
-     */
-    static arrayFromString(values) {
-        return values?.split(",");
-    }
-    /**
-     * Convert array of values to query string.
-     * @param values The values to combine string.
-     * @returns The combined.
-     */
-    static arrayToString(values) {
-        return values?.join(",");
-    }
-    /**
-     * Convert object string to object.
-     * @param value The value query string.
-     * @returns The object.
-     */
-    static objectFromString(value) {
-        return Is.json(value) ? JSON.parse(value) : undefined;
-    }
-    /**
-     * Convert object to query string.
-     * @param value The value to convert to a string.
-     * @returns The converted object.
-     */
-    static objectToString(value) {
-        return Is.empty(value) ? undefined : JSON.stringify(value);
-    }
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * The health status of the component.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const HealthStatus = {
-    /**
-     * OK.
-     */
-    Ok: "ok",
-    /**
-     * Warning.
-     */
-    Warning: "warning",
-    /**
-     * Error.
-     */
-    Error: "error"
-};
-
-export { HealthStatus, HttpErrorHelper, HttpParameterHelper, MimeTypeProcessorFactory, RestRouteProcessorFactory, SocketRouteProcessorFactory };

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

@@ -1,13 +0,0 @@
-/**
- * Context data from the HTTP request identity.
- */
-export interface IHttpRequestIdentity {
-    /**
-     * The identity of the node the request is being performed on.
-     */
-    nodeIdentity?: string;
-    /**
-     * The identity of the requestor if there is an authenticated user.
-     */
-    userIdentity?: string;
-}

package/docs/reference/interfaces/IHttpRequestIdentity.md

@@ -1,23 +0,0 @@
-# Interface: IHttpRequestIdentity
-
-Context data from the HTTP request identity.
-
-## Extended by
-
-- [`IHttpRequestContext`](IHttpRequestContext.md)
-
-## Properties
-
-### nodeIdentity?
-
-> `optional` **nodeIdentity**: `string`
-
-The identity of the node the request is being performed on.
-
-***
-
-### userIdentity?
-
-> `optional` **userIdentity**: `string`
-
-The identity of the requestor if there is an authenticated user.