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

package/dist/es/factories/authenticationGeneratorFactory.js

@@ -0,0 +1,9 @@
+// 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

@@ -0,0 +1 @@
+{"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/factories/mimeTypeProcessorFactory.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"mimeTypeProcessorFactory.js","sourceRoot":"","sources":["../../../src/factories/mimeTypeProcessorFactory.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAGzC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,wBAAwB,GACpC,OAAO,CAAC,aAAa,CAAqB,qBAAqB,CAAC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Factory } from \"@twin.org/core\";\nimport type { IMimeTypeProcessor } from \"../models/server/IMimeTypeProcessor.js\";\n\n/**\n * Factory for creating implementation of mime type processor types.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const MimeTypeProcessorFactory =\n\tFactory.createFactory<IMimeTypeProcessor>(\"mime-type-processor\");\n"]}

package/dist/es/factories/restRouteProcessorFactory.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"restRouteProcessorFactory.js","sourceRoot":"","sources":["../../../src/factories/restRouteProcessorFactory.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAGzC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,yBAAyB,GACrC,OAAO,CAAC,aAAa,CAAsB,sBAAsB,CAAC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Factory } from \"@twin.org/core\";\nimport type { IRestRouteProcessor } from \"../models/server/IRestRouteProcessor.js\";\n\n/**\n * Factory for creating implementation of REST route processor types.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const RestRouteProcessorFactory =\n\tFactory.createFactory<IRestRouteProcessor>(\"rest-route-processor\");\n"]}

package/dist/es/factories/socketRouteProcessorFactory.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"socketRouteProcessorFactory.js","sourceRoot":"","sources":["../../../src/factories/socketRouteProcessorFactory.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAGzC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,2BAA2B,GACvC,OAAO,CAAC,aAAa,CAAwB,wBAAwB,CAAC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Factory } from \"@twin.org/core\";\nimport type { ISocketRouteProcessor } from \"../models/server/ISocketRouteProcessor.js\";\n\n/**\n * Factory for creating implementation of socket route processor types.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const SocketRouteProcessorFactory =\n\tFactory.createFactory<ISocketRouteProcessor>(\"socket-route-processor\");\n"]}

package/dist/es/helpers/httpErrorHelper.js

@@ -0,0 +1,60 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { AlreadyExistsError, BaseError, ConflictError, GuardError, NotFoundError, NotImplementedError, UnauthorizedError, UnprocessableError, ValidationError } from "@twin.org/core";
+import { HeaderTypes, HttpStatusCode, MimeTypes } from "@twin.org/web";
+/**
+ * Class to help with processing http errors.
+ */
+export 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;
+    }
+}
+//# sourceMappingURL=httpErrorHelper.js.map

package/dist/es/helpers/httpErrorHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"httpErrorHelper.js","sourceRoot":"","sources":["../../../src/helpers/httpErrorHelper.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EACN,kBAAkB,EAClB,SAAS,EACT,aAAa,EACb,UAAU,EAEV,aAAa,EACb,mBAAmB,EACnB,iBAAiB,EACjB,kBAAkB,EAClB,eAAe,EACf,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAGvE;;GAEG;AACH,MAAM,OAAO,eAAe;IAC3B;;;;;OAKG;IACI,MAAM,CAAC,YAAY,CACzB,GAAY,EACZ,YAAsB;QAKtB,MAAM,KAAK,GAAc,SAAS,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAElD,4DAA4D;QAC5D,oDAAoD;QACpD,MAAM,SAAS,GAAG,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAE3C,IAAI,cAAc,GAAmB,cAAc,CAAC,mBAAmB,CAAC;QACxE,IACC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC;YACpE,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC,CAAC,EACxE,CAAC;YACF,cAAc,GAAG,cAAc,CAAC,UAAU,CAAC;QAC5C,CAAC;aAAM,IACN,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;YACvE,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,EAAE,kBAAkB,CAAC,UAAU,CAAC,CAAC,EAC3E,CAAC;YACF,cAAc,GAAG,cAAc,CAAC,QAAQ,CAAC;QAC1C,CAAC;aAAM,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC;YACpF,cAAc,GAAG,cAAc,CAAC,QAAQ,CAAC;QAC1C,CAAC;aAAM,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,EAAE,iBAAiB,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC;YACxF,cAAc,GAAG,cAAc,CAAC,YAAY,CAAC;QAC9C,CAAC;aAAM,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,EAAE,mBAAmB,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC;YAC1F,cAAc,GAAG,cAAc,CAAC,SAAS,CAAC;QAC3C,CAAC;aAAM,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,EAAE,kBAAkB,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC;YACzF,cAAc,GAAG,cAAc,CAAC,mBAAmB,CAAC;QACrD,CAAC;QAED,MAAM,WAAW,GAAG,KAAK,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;QAErD,OAAO;YACN,KAAK,EAAE,WAAW;YAClB,cAAc;SACd,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,aAAa,CAC1B,QAAuB,EACvB,KAAa,EACb,UAA0B;QAE1B,QAAQ,CAAC,OAAO,KAAK,EAAE,CAAC;QACxB,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,WAAW,CAAC,GAAG,GAAG,SAAS,CAAC,IAAI,iBAAiB,CAAC;QAC/E,QAAQ,CAAC,IAAI,GAAG,KAAK,CAAC;QACtB,QAAQ,CAAC,UAAU,GAAG,UAAU,CAAC;IAClC,CAAC;CACD","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport {\n\tAlreadyExistsError,\n\tBaseError,\n\tConflictError,\n\tGuardError,\n\ttype IError,\n\tNotFoundError,\n\tNotImplementedError,\n\tUnauthorizedError,\n\tUnprocessableError,\n\tValidationError\n} from \"@twin.org/core\";\nimport { HeaderTypes, HttpStatusCode, MimeTypes } from \"@twin.org/web\";\nimport type { IHttpResponse } from \"../models/protocol/IHttpResponse.js\";\n\n/**\n * Class to help with processing http errors.\n */\nexport class HttpErrorHelper {\n\t/**\n\t * Process the errors from the routes.\n\t * @param err The error to process.\n\t * @param includeStack Should the stack be included in the error.\n\t * @returns The status code and additional error data.\n\t */\n\tpublic static processError(\n\t\terr: unknown,\n\t\tincludeStack?: boolean\n\t): {\n\t\terror: IError;\n\t\thttpStatusCode: HttpStatusCode;\n\t} {\n\t\tconst error: BaseError = BaseError.fromError(err);\n\n\t\t// If the error or any of its sub errors are of the specific\n\t\t// types then set the http response code accordingly\n\t\tconst flattened = BaseError.flatten(error);\n\n\t\tlet httpStatusCode: HttpStatusCode = HttpStatusCode.internalServerError;\n\t\tif (\n\t\t\tflattened.some(e => BaseError.isErrorName(e, GuardError.CLASS_NAME)) ||\n\t\t\tflattened.some(e => BaseError.isErrorName(e, ValidationError.CLASS_NAME))\n\t\t) {\n\t\t\thttpStatusCode = HttpStatusCode.badRequest;\n\t\t} else if (\n\t\t\tflattened.some(e => BaseError.isErrorName(e, ConflictError.CLASS_NAME)) ||\n\t\t\tflattened.some(e => BaseError.isErrorName(e, AlreadyExistsError.CLASS_NAME))\n\t\t) {\n\t\t\thttpStatusCode = HttpStatusCode.conflict;\n\t\t} else if (flattened.some(e => BaseError.isErrorName(e, NotFoundError.CLASS_NAME))) {\n\t\t\thttpStatusCode = HttpStatusCode.notFound;\n\t\t} else if (flattened.some(e => BaseError.isErrorName(e, UnauthorizedError.CLASS_NAME))) {\n\t\t\thttpStatusCode = HttpStatusCode.unauthorized;\n\t\t} else if (flattened.some(e => BaseError.isErrorName(e, NotImplementedError.CLASS_NAME))) {\n\t\t\thttpStatusCode = HttpStatusCode.forbidden;\n\t\t} else if (flattened.some(e => BaseError.isErrorName(e, UnprocessableError.CLASS_NAME))) {\n\t\t\thttpStatusCode = HttpStatusCode.unprocessableEntity;\n\t\t}\n\n\t\tconst returnError = error.toJsonObject(includeStack);\n\n\t\treturn {\n\t\t\terror: returnError,\n\t\t\thttpStatusCode\n\t\t};\n\t}\n\n\t/**\n\t * Build an error response.\n\t * @param response The response to build the error into.\n\t * @param error The error to build the response for.\n\t * @param statusCode The status code to use for the error.\n\t */\n\tpublic static buildResponse(\n\t\tresponse: IHttpResponse,\n\t\terror: IError,\n\t\tstatusCode: HttpStatusCode\n\t): void {\n\t\tresponse.headers ??= {};\n\t\tresponse.headers[HeaderTypes.ContentType] = `${MimeTypes.Json}; charset=utf-8`;\n\t\tresponse.body = error;\n\t\tresponse.statusCode = statusCode;\n\t}\n}\n"]}

package/dist/es/helpers/httpParameterHelper.js

@@ -0,0 +1,41 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Is } from "@twin.org/core";
+/**
+ * Class to help with handling http parameters.
+ */
+export 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);
+    }
+}
+//# sourceMappingURL=httpParameterHelper.js.map

package/dist/es/helpers/httpParameterHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"httpParameterHelper.js","sourceRoot":"","sources":["../../../src/helpers/httpParameterHelper.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAEpC;;GAEG;AACH,MAAM,OAAO,mBAAmB;IAC/B;;;;OAIG;IACI,MAAM,CAAC,eAAe,CAAa,MAAe;QACxD,OAAO,MAAM,EAAE,KAAK,CAAC,GAAG,CAAQ,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,aAAa,CAAa,MAAY;QACnD,OAAO,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,gBAAgB,CAAc,KAAc;QACzD,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,KAAK,CAAC,KAAK,CAAO,CAAC,CAAC,CAAC,SAAS,CAAC;IAC9D,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,cAAc,CAAc,KAAS;QAClD,OAAO,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAC5D,CAAC;CACD","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Is } from \"@twin.org/core\";\n\n/**\n * Class to help with handling http parameters.\n */\nexport class HttpParameterHelper {\n\t/**\n\t * Convert list query to array.\n\t * @param values The values query string.\n\t * @returns The array of values.\n\t */\n\tpublic static arrayFromString<T = string>(values?: string): T[] | undefined {\n\t\treturn values?.split(\",\") as T[];\n\t}\n\n\t/**\n\t * Convert array of values to query string.\n\t * @param values The values to combine string.\n\t * @returns The combined.\n\t */\n\tpublic static arrayToString<T = string>(values?: T[]): string | undefined {\n\t\treturn values?.join(\",\");\n\t}\n\n\t/**\n\t * Convert object string to object.\n\t * @param value The value query string.\n\t * @returns The object.\n\t */\n\tpublic static objectFromString<T = unknown>(value?: string): T | undefined {\n\t\treturn Is.json(value) ? (JSON.parse(value) as T) : undefined;\n\t}\n\n\t/**\n\t * Convert object to query string.\n\t * @param value The value to convert to a string.\n\t * @returns The converted object.\n\t */\n\tpublic static objectToString<T = unknown>(value?: T): string | undefined {\n\t\treturn Is.empty(value) ? undefined : JSON.stringify(value);\n\t}\n}\n"]}

package/dist/es/index.js

@@ -0,0 +1,59 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./factories/authenticationGeneratorFactory.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 "./models/api/IServerFavIconResponse.js";
+export * from "./models/api/IServerHealthResponse.js";
+export * from "./models/api/IServerInfoResponse.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/protocol/IHttpRequest.js";
+export * from "./models/protocol/IHttpRequestContext.js";
+export * from "./models/protocol/IHttpRequestPathParams.js";
+export * from "./models/protocol/IHttpRequestQuery.js";
+export * from "./models/protocol/IHttpResponse.js";
+export * from "./models/protocol/IHttpServerRequest.js";
+export * from "./models/protocol/ISocketRequestContext.js";
+export * from "./models/protocol/ISocketServerRequest.js";
+export * from "./models/requests/INoContentRequest.js";
+export * from "./models/responses/errors/IBadRequestResponse.js";
+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/IUnauthorizedResponse.js";
+export * from "./models/responses/errors/IUnprocessableEntityResponse.js";
+export * from "./models/responses/success/IAcceptedResponse.js";
+export * from "./models/responses/success/ICreatedResponse.js";
+export * from "./models/responses/success/INoContentResponse.js";
+export * from "./models/responses/success/IOkResponse.js";
+export * from "./models/routes/IBaseRoute.js";
+export * from "./models/routes/IBaseRouteEntryPoint.js";
+export * from "./models/routes/IRestRoute.js";
+export * from "./models/routes/IRestRouteEntryPoint.js";
+export * from "./models/routes/IRestRouteExample.js";
+export * from "./models/routes/IRestRouteRequestExample.js";
+export * from "./models/routes/IRestRouteResponseAttachmentOptions.js";
+export * from "./models/routes/IRestRouteResponseExample.js";
+export * from "./models/routes/IRestRouteResponseOptions.js";
+export * from "./models/routes/ISocketRoute.js";
+export * from "./models/routes/ISocketRouteEntryPoint.js";
+export * from "./models/routes/ITag.js";
+export * from "./models/server/IBaseRouteProcessor.js";
+export * from "./models/server/IMimeTypeProcessor.js";
+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/IInformationComponent.js";
+export * from "./models/services/IServerInfo.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,+CAA+C,CAAC;AAC9D,cAAc,yCAAyC,CAAC;AACxD,cAAc,0CAA0C,CAAC;AACzD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,8BAA8B,CAAC;AAC7C,cAAc,kCAAkC,CAAC;AACjD,cAAc,wCAAwC,CAAC;AACvD,cAAc,uCAAuC,CAAC;AACtD,cAAc,qCAAqC,CAAC;AACpD,cAAc,qCAAqC,CAAC;AACpD,cAAc,qCAAqC,CAAC;AACpD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,0CAA0C,CAAC;AACzD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,mCAAmC,CAAC;AAClD,cAAc,0CAA0C,CAAC;AACzD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,wCAAwC,CAAC;AACvD,cAAc,oCAAoC,CAAC;AACnD,cAAc,yCAAyC,CAAC;AACxD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,wCAAwC,CAAC;AACvD,cAAc,kDAAkD,CAAC;AACjE,cAAc,gDAAgD,CAAC;AAC/D,cAAc,iDAAiD,CAAC;AAChE,cAAc,2DAA2D,CAAC;AAC1E,cAAc,gDAAgD,CAAC;AAC/D,cAAc,oDAAoD,CAAC;AACnE,cAAc,2DAA2D,CAAC;AAC1E,cAAc,iDAAiD,CAAC;AAChE,cAAc,gDAAgD,CAAC;AAC/D,cAAc,kDAAkD,CAAC;AACjE,cAAc,2CAA2C,CAAC;AAC1D,cAAc,+BAA+B,CAAC;AAC9C,cAAc,yCAAyC,CAAC;AACxD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,yCAAyC,CAAC;AACxD,cAAc,sCAAsC,CAAC;AACrD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,wDAAwD,CAAC;AACvE,cAAc,8CAA8C,CAAC;AAC7D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,iCAAiC,CAAC;AAChD,cAAc,2CAA2C,CAAC;AAC1D,cAAc,yBAAyB,CAAC;AACxC,cAAc,wCAAwC,CAAC;AACvD,cAAc,uCAAuC,CAAC;AACtD,cAAc,wCAAwC,CAAC;AACvD,cAAc,0CAA0C,CAAC;AACzD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,sCAAsC,CAAC;AACrD,cAAc,mCAAmC,CAAC;AAClD,cAAc,kCAAkC,CAAC;AACjD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,kCAAkC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./factories/authenticationGeneratorFactory.js\";\nexport * from \"./factories/mimeTypeProcessorFactory.js\";\nexport * from \"./factories/restRouteProcessorFactory.js\";\nexport * from \"./factories/socketRouteProcessorFactory.js\";\nexport * from \"./helpers/httpErrorHelper.js\";\nexport * from \"./helpers/httpParameterHelper.js\";\nexport * from \"./models/api/IServerFavIconResponse.js\";\nexport * from \"./models/api/IServerHealthResponse.js\";\nexport * from \"./models/api/IServerInfoResponse.js\";\nexport * from \"./models/api/IServerRootResponse.js\";\nexport * from \"./models/api/IServerSpecResponse.js\";\nexport * from \"./models/client/IAuthenticationGenerator.js\";\nexport * from \"./models/config/IBaseRestClientConfig.js\";\nexport * from \"./models/config/IBaseSocketClientConfig.js\";\nexport * from \"./models/protocol/IHttpRequest.js\";\nexport * from \"./models/protocol/IHttpRequestContext.js\";\nexport * from \"./models/protocol/IHttpRequestPathParams.js\";\nexport * from \"./models/protocol/IHttpRequestQuery.js\";\nexport * from \"./models/protocol/IHttpResponse.js\";\nexport * from \"./models/protocol/IHttpServerRequest.js\";\nexport * from \"./models/protocol/ISocketRequestContext.js\";\nexport * from \"./models/protocol/ISocketServerRequest.js\";\nexport * from \"./models/requests/INoContentRequest.js\";\nexport * from \"./models/responses/errors/IBadRequestResponse.js\";\nexport * from \"./models/responses/errors/IConflictResponse.js\";\nexport * from \"./models/responses/errors/IForbiddenResponse.js\";\nexport * from \"./models/responses/errors/IInternalServerErrorResponse.js\";\nexport * from \"./models/responses/errors/INotFoundResponse.js\";\nexport * from \"./models/responses/errors/IUnauthorizedResponse.js\";\nexport * from \"./models/responses/errors/IUnprocessableEntityResponse.js\";\nexport * from \"./models/responses/success/IAcceptedResponse.js\";\nexport * from \"./models/responses/success/ICreatedResponse.js\";\nexport * from \"./models/responses/success/INoContentResponse.js\";\nexport * from \"./models/responses/success/IOkResponse.js\";\nexport * from \"./models/routes/IBaseRoute.js\";\nexport * from \"./models/routes/IBaseRouteEntryPoint.js\";\nexport * from \"./models/routes/IRestRoute.js\";\nexport * from \"./models/routes/IRestRouteEntryPoint.js\";\nexport * from \"./models/routes/IRestRouteExample.js\";\nexport * from \"./models/routes/IRestRouteRequestExample.js\";\nexport * from \"./models/routes/IRestRouteResponseAttachmentOptions.js\";\nexport * from \"./models/routes/IRestRouteResponseExample.js\";\nexport * from \"./models/routes/IRestRouteResponseOptions.js\";\nexport * from \"./models/routes/ISocketRoute.js\";\nexport * from \"./models/routes/ISocketRouteEntryPoint.js\";\nexport * from \"./models/routes/ITag.js\";\nexport * from \"./models/server/IBaseRouteProcessor.js\";\nexport * from \"./models/server/IMimeTypeProcessor.js\";\nexport * from \"./models/server/IRestRouteProcessor.js\";\nexport * from \"./models/server/ISocketRouteProcessor.js\";\nexport * from \"./models/server/IWebServer.js\";\nexport * from \"./models/server/IWebServerOptions.js\";\nexport * from \"./models/services/healthStatus.js\";\nexport * from \"./models/services/IHealthInfo.js\";\nexport * from \"./models/services/IInformationComponent.js\";\nexport * from \"./models/services/IServerInfo.js\";\n"]}

package/dist/es/models/api/IServerFavIconResponse.js

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

package/dist/es/models/api/IServerFavIconResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IServerFavIconResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IServerFavIconResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes, HttpStatusCode } from \"@twin.org/web\";\n\n/**\n * The favicon for the server.\n */\nexport interface IServerFavIconResponse {\n\t/**\n\t * Additional response headers.\n\t */\n\theaders?: {\n\t\t/**\n\t\t * The content type for the response.\n\t\t */\n\t\t[HeaderTypes.ContentType]?: string;\n\t};\n\n\t/**\n\t * Response status code.\n\t */\n\tstatusCode?: HttpStatusCode;\n\n\t/**\n\t * The favicon for the server.\n\t */\n\tbody?: Uint8Array;\n}\n"]}

package/dist/es/models/api/IServerHealthResponse.js

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

package/dist/es/models/api/IServerHealthResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IServerHealthResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IServerHealthResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IHealthInfo } from \"../services/IHealthInfo.js\";\n\n/**\n * The health of the server.\n */\nexport interface IServerHealthResponse {\n\t/**\n\t * The information for the server.\n\t */\n\tbody: IHealthInfo;\n}\n"]}

package/dist/es/models/api/IServerInfoResponse.js

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

package/dist/es/models/api/IServerInfoResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IServerInfoResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IServerInfoResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IServerInfo } from \"../services/IServerInfo.js\";\n\n/**\n * The information about the server.\n */\nexport interface IServerInfoResponse {\n\t/**\n\t * The information for the server.\n\t */\n\tbody: IServerInfo;\n}\n"]}

package/dist/es/models/api/IServerRootResponse.js

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

package/dist/es/models/api/IServerRootResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IServerRootResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IServerRootResponse.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The root text for the server.\n */\nexport interface IServerRootResponse {\n\t/**\n\t * The root text for the server.\n\t */\n\tbody: string;\n}\n"]}

package/dist/es/models/api/IServerSpecResponse.js

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

package/dist/es/models/api/IServerSpecResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IServerSpecResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IServerSpecResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HttpStatusCode } from \"@twin.org/web\";\n\n/**\n * The OpenAPI spec for the endpoints.\n */\nexport interface IServerSpecResponse {\n\t/**\n\t * Response status code.\n\t */\n\tstatusCode?: HttpStatusCode;\n\n\t/**\n\t * The spec for the server.\n\t */\n\tbody?: unknown;\n}\n"]}

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

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

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

@@ -0,0 +1 @@
+{"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/config/IBaseRestClientConfig.js

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

package/dist/es/models/config/IBaseRestClientConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IBaseRestClientConfig.js","sourceRoot":"","sources":["../../../../src/models/config/IBaseRestClientConfig.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IHttpHeaders } from \"@twin.org/web\";\n\n/**\n * Definition for the configuration of a rest client.\n */\nexport interface IBaseRestClientConfig {\n\t/**\n\t * The endpoint where the api is hosted.\n\t */\n\tendpoint: string;\n\n\t/**\n\t * The prefix to the routes.\n\t */\n\tpathPrefix?: string;\n\n\t/**\n\t * The headers to include in requests.\n\t */\n\theaders?: IHttpHeaders;\n\n\t/**\n\t * Timeout for requests in ms.\n\t */\n\ttimeout?: number;\n\n\t/**\n\t * Include credentials in the request, defaults to true.\n\t */\n\tincludeCredentials?: boolean;\n}\n"]}

package/dist/es/models/config/IBaseSocketClientConfig.js

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

package/dist/es/models/config/IBaseSocketClientConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IBaseSocketClientConfig.js","sourceRoot":"","sources":["../../../../src/models/config/IBaseSocketClientConfig.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IHttpHeaders } from \"@twin.org/web\";\n\n/**\n * Definition for the configuration of a socket service.\n */\nexport interface IBaseSocketClientConfig {\n\t/**\n\t * Base path for the socket service, defaults to /socket.\n\t */\n\tbasePath?: string;\n\n\t/**\n\t * The endpoint where the api is hosted.\n\t */\n\tendpoint: string;\n\n\t/**\n\t * The prefix to the routes.\n\t */\n\tpathPrefix?: string;\n\n\t/**\n\t * The headers to include in requests.\n\t */\n\theaders?: IHttpHeaders;\n}\n"]}

package/dist/es/models/protocol/IHttpRequest.js

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

package/dist/es/models/protocol/IHttpRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IHttpRequest.js","sourceRoot":"","sources":["../../../../src/models/protocol/IHttpRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IHttpHeaders } from \"@twin.org/web\";\nimport type { IHttpRequestPathParams } from \"./IHttpRequestPathParams.js\";\nimport type { IHttpRequestQuery } from \"./IHttpRequestQuery.js\";\n\n/**\n * Model for the standard parameters for an http request.\n */\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport interface IHttpRequest<T = any> {\n\t/**\n\t * Incoming Http Headers.\n\t */\n\theaders?: IHttpHeaders;\n\n\t/**\n\t * The path parameters.\n\t */\n\tpathParams?: IHttpRequestPathParams;\n\n\t/**\n\t * The query parameters.\n\t */\n\tquery?: IHttpRequestQuery;\n\n\t/**\n\t * Data to return send as the body.\n\t */\n\tbody?: T;\n}\n"]}

package/dist/es/models/protocol/IHttpRequestContext.js

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

package/dist/es/models/protocol/IHttpRequestContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IHttpRequestContext.js","sourceRoot":"","sources":["../../../../src/models/protocol/IHttpRequestContext.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IHttpServerRequest } from \"./IHttpServerRequest.js\";\n\n/**\n * Context data from the HTTP request.\n */\nexport interface IHttpRequestContext {\n\t/**\n\t * The raw HTTP request.\n\t */\n\tserverRequest: IHttpServerRequest;\n\n\t/**\n\t * The state handed through the processors.\n\t */\n\tprocessorState: { [id: string]: unknown };\n\n\t/**\n\t * Logging component type for the request.\n\t */\n\tloggingComponentType?: string;\n}\n"]}

package/dist/es/models/protocol/IHttpRequestPathParams.js

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

package/dist/es/models/protocol/IHttpRequestPathParams.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IHttpRequestPathParams.js","sourceRoot":"","sources":["../../../../src/models/protocol/IHttpRequestPathParams.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Model for the standard parameters for an http request.\n */\nexport interface IHttpRequestPathParams {\n\t[id: string]: string | number | boolean;\n}\n"]}

package/dist/es/models/protocol/IHttpRequestQuery.js

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

package/dist/es/models/protocol/IHttpRequestQuery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IHttpRequestQuery.js","sourceRoot":"","sources":["../../../../src/models/protocol/IHttpRequestQuery.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Model used for Http request query parameters.\n */\nexport interface IHttpRequestQuery {\n\t[id: string]: string | number | boolean;\n}\n"]}

package/dist/es/models/protocol/IHttpResponse.js

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

package/dist/es/models/protocol/IHttpResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IHttpResponse.js","sourceRoot":"","sources":["../../../../src/models/protocol/IHttpResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HttpStatusCode, IHttpHeaders } from \"@twin.org/web\";\n\n/**\n * Model for the standard parameters for an http response.\n */\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport interface IHttpResponse<T = any> {\n\t/**\n\t * Response status code.\n\t */\n\tstatusCode?: HttpStatusCode;\n\n\t/**\n\t * Response headers.\n\t */\n\theaders?: IHttpHeaders;\n\n\t/**\n\t * Data to return as the main payload.\n\t */\n\tbody?: T;\n}\n"]}

package/dist/es/models/protocol/IHttpServerRequest.js

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

package/dist/es/models/protocol/IHttpServerRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IHttpServerRequest.js","sourceRoot":"","sources":["../../../../src/models/protocol/IHttpServerRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HttpMethod } from \"@twin.org/web\";\nimport type { IHttpRequest } from \"./IHttpRequest.js\";\n\n/**\n * Model for the standard parameters for an http request.\n */\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport interface IHttpServerRequest<T = any> extends IHttpRequest<T> {\n\t/**\n\t * The request method.\n\t */\n\tmethod?: HttpMethod;\n\n\t/**\n\t * The request url.\n\t */\n\turl?: string;\n}\n"]}

package/dist/es/models/protocol/ISocketRequestContext.js

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

package/dist/es/models/protocol/ISocketRequestContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ISocketRequestContext.js","sourceRoot":"","sources":["../../../../src/models/protocol/ISocketRequestContext.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IHttpRequestContext } from \"./IHttpRequestContext.js\";\n\n/**\n * Context data from the socket request.\n */\nexport interface ISocketRequestContext extends IHttpRequestContext {\n\t/**\n\t * The id of the socket.\n\t */\n\tsocketId: string;\n}\n"]}

package/dist/es/models/protocol/ISocketServerRequest.js

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

package/dist/es/models/protocol/ISocketServerRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ISocketServerRequest.js","sourceRoot":"","sources":["../../../../src/models/protocol/ISocketServerRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IHttpServerRequest } from \"./IHttpServerRequest.js\";\n\n/**\n * Model for the standard parameters for an http request.\n */\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport interface ISocketServerRequest<T = any> extends IHttpServerRequest<T> {\n\t/**\n\t * The socket id.\n\t */\n\tsocketId: string;\n}\n"]}

package/dist/es/models/requests/INoContentRequest.js

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

package/dist/es/models/requests/INoContentRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"INoContentRequest.js","sourceRoot":"","sources":["../../../../src/models/requests/INoContentRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IHttpRequest } from \"../protocol/IHttpRequest.js\";\n\n/**\n * A REST request with no input parameters.\n */\nexport interface INoContentRequest extends IHttpRequest {\n\t/**\n\t * Incoming Http Headers.\n\t */\n\theaders?: never;\n\n\t/**\n\t * The path parameters.\n\t */\n\tpathParams?: never;\n\n\t/**\n\t * The query parameters.\n\t */\n\tquery?: never;\n\n\t/**\n\t * Data to return send as the body.\n\t */\n\tbody?: never;\n}\n"]}

package/dist/es/models/responses/errors/IBadRequestResponse.js

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

package/dist/es/models/responses/errors/IBadRequestResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IBadRequestResponse.js","sourceRoot":"","sources":["../../../../../src/models/responses/errors/IBadRequestResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IError } from \"@twin.org/core\";\nimport type { HttpStatusCode } from \"@twin.org/web\";\n\n/**\n * The server cannot process the request, see the content for more details.\n */\nexport interface IBadRequestResponse {\n\t/**\n\t * Response status code.\n\t */\n\tstatusCode: typeof HttpStatusCode.badRequest;\n\n\t/**\n\t * The body which contains the error.\n\t */\n\tbody: IError;\n}\n"]}

package/dist/es/models/responses/errors/IConflictResponse.js

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

package/dist/es/models/responses/errors/IConflictResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IConflictResponse.js","sourceRoot":"","sources":["../../../../../src/models/responses/errors/IConflictResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IError } from \"@twin.org/core\";\nimport type { HttpStatusCode } from \"@twin.org/web\";\n\n/**\n * The request resulted in a conflicting operation, see the content for more details.\n */\nexport interface IConflictResponse {\n\t/**\n\t * Response status code.\n\t */\n\tstatusCode: typeof HttpStatusCode.conflict;\n\n\t/**\n\t * The body which contains the error.\n\t */\n\tbody: IError & {\n\t\t/**\n\t\t * The conflicting items.\n\t\t */\n\t\tconflicts: string[];\n\t};\n}\n"]}

package/dist/es/models/responses/errors/IForbiddenResponse.js

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

package/dist/es/models/responses/errors/IForbiddenResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IForbiddenResponse.js","sourceRoot":"","sources":["../../../../../src/models/responses/errors/IForbiddenResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IError } from \"@twin.org/core\";\nimport type { HttpStatusCode } from \"@twin.org/web\";\n\n/**\n * The operation that you tried to perform is not possible, see the content for more details.\n */\nexport interface IForbiddenResponse {\n\t/**\n\t * Response status code.\n\t */\n\tstatusCode: typeof HttpStatusCode.forbidden;\n\n\t/**\n\t * The body which contains the error.\n\t */\n\tbody: IError;\n}\n"]}

package/dist/es/models/responses/errors/IInternalServerErrorResponse.js

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

package/dist/es/models/responses/errors/IInternalServerErrorResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IInternalServerErrorResponse.js","sourceRoot":"","sources":["../../../../../src/models/responses/errors/IInternalServerErrorResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IError } from \"@twin.org/core\";\nimport type { HttpStatusCode } from \"@twin.org/web\";\n\n/**\n * The server has encountered a situation it does not know how to handle, see the content for more details.\n */\nexport interface IInternalServerErrorResponse {\n\t/**\n\t * Response status code.\n\t */\n\tstatusCode: typeof HttpStatusCode.internalServerError;\n\n\t/**\n\t * The body which contains the error.\n\t */\n\tbody: IError;\n}\n"]}

package/dist/es/models/responses/errors/INotFoundResponse.js

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

package/dist/es/models/responses/errors/INotFoundResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"INotFoundResponse.js","sourceRoot":"","sources":["../../../../../src/models/responses/errors/INotFoundResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IError } from \"@twin.org/core\";\nimport type { HttpStatusCode } from \"@twin.org/web\";\n\n/**\n * The resource you tried to access does not exist, see the content for more details.\n */\nexport interface INotFoundResponse {\n\t/**\n\t * Response status code.\n\t */\n\tstatusCode: typeof HttpStatusCode.notFound;\n\n\t/**\n\t * The body which contains the error.\n\t */\n\tbody: IError & {\n\t\t/**\n\t\t * The id if the item that was not found.\n\t\t */\n\t\tnotFoundId?: string;\n\t};\n}\n"]}

package/dist/es/models/responses/errors/IUnauthorizedResponse.js

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

package/dist/es/models/responses/errors/IUnauthorizedResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IUnauthorizedResponse.js","sourceRoot":"","sources":["../../../../../src/models/responses/errors/IUnauthorizedResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IError } from \"@twin.org/core\";\nimport type { HttpStatusCode } from \"@twin.org/web\";\n\n/**\n * You are not authorized to use the API or no credentials were supplied, see the content for more details.\n */\nexport interface IUnauthorizedResponse {\n\t/**\n\t * Response status code.\n\t */\n\tstatusCode: typeof HttpStatusCode.unauthorized;\n\n\t/**\n\t * The body which contains the error.\n\t */\n\tbody: IError;\n}\n"]}

package/dist/es/models/responses/errors/IUnprocessableEntityResponse.js

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

package/dist/es/models/responses/errors/IUnprocessableEntityResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IUnprocessableEntityResponse.js","sourceRoot":"","sources":["../../../../../src/models/responses/errors/IUnprocessableEntityResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IError } from \"@twin.org/core\";\nimport type { HttpStatusCode } from \"@twin.org/web\";\n\n/**\n * The server cannot process the request, see the content for more details.\n */\nexport interface IUnprocessableEntityResponse {\n\t/**\n\t * Response status code.\n\t */\n\tstatusCode: typeof HttpStatusCode.unprocessableEntity;\n\n\t/**\n\t * The body which contains the error.\n\t */\n\tbody: IError;\n}\n"]}

package/dist/es/models/responses/success/IAcceptedResponse.js

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

package/dist/es/models/responses/success/IAcceptedResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAcceptedResponse.js","sourceRoot":"","sources":["../../../../../src/models/responses/success/IAcceptedResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HttpStatusCode } from \"@twin.org/web\";\n\n/**\n * The rest request ended in accepted response.\n */\nexport interface IAcceptedResponse {\n\t/**\n\t * Response status code.\n\t */\n\tstatusCode: typeof HttpStatusCode.accepted;\n\n\t/**\n\t * Additional response headers.\n\t */\n\theaders: {\n\t\t/**\n\t\t * The location where the resource was accepted.\n\t\t */\n\t\tlocation: string;\n\t};\n}\n"]}

package/dist/es/models/responses/success/ICreatedResponse.js

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

package/dist/es/models/responses/success/ICreatedResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ICreatedResponse.js","sourceRoot":"","sources":["../../../../../src/models/responses/success/ICreatedResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes, HttpStatusCode } from \"@twin.org/web\";\n\n/**\n * The rest request ended in created response.\n */\nexport interface ICreatedResponse {\n\t/**\n\t * Response status code.\n\t */\n\tstatusCode: typeof HttpStatusCode.created;\n\n\t/**\n\t * Additional response headers.\n\t */\n\theaders: {\n\t\t/**\n\t\t * The location where the resource was created.\n\t\t */\n\t\t[HeaderTypes.Location]: string;\n\t};\n}\n"]}

package/dist/es/models/responses/success/INoContentResponse.js

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

package/dist/es/models/responses/success/INoContentResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"INoContentResponse.js","sourceRoot":"","sources":["../../../../../src/models/responses/success/INoContentResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HttpStatusCode } from \"@twin.org/web\";\n\n/**\n * The rest request ended in success with no data.\n */\nexport interface INoContentResponse {\n\t/**\n\t * Response status code.\n\t */\n\tstatusCode: typeof HttpStatusCode.noContent;\n}\n"]}

package/dist/es/models/responses/success/IOkResponse.js

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

package/dist/es/models/responses/success/IOkResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IOkResponse.js","sourceRoot":"","sources":["../../../../../src/models/responses/success/IOkResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HttpStatusCode } from \"@twin.org/web\";\n\n/**\n * The rest request ended in success with no data.\n */\nexport interface IOkResponse {\n\t/**\n\t * Response status code.\n\t */\n\tstatusCode: typeof HttpStatusCode.ok;\n}\n"]}

package/dist/es/models/routes/IBaseRoute.js

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

package/dist/es/models/routes/IBaseRoute.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IBaseRoute.js","sourceRoot":"","sources":["../../../../src/models/routes/IBaseRoute.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Interface which defines a route.\n */\nexport interface IBaseRoute {\n\t/**\n\t * The id of the operation.\n\t */\n\toperationId: string;\n\n\t/**\n\t * The path to use for routing.\n\t */\n\tpath: string;\n\n\t/**\n\t * Skips the authentication for this route.\n\t */\n\tskipAuth?: boolean;\n\n\t/**\n\t * The features supported by additional processors to run for this route.\n\t */\n\tprocessorFeatures?: string[];\n\n\t/**\n\t * The data for additional processors to run for this route.\n\t */\n\tprocessorData?: {\n\t\t[key: string]: unknown;\n\t};\n}\n"]}

package/dist/es/models/routes/IBaseRouteEntryPoint.js

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

package/dist/es/models/routes/IBaseRouteEntryPoint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IBaseRouteEntryPoint.js","sourceRoot":"","sources":["../../../../src/models/routes/IBaseRouteEntryPoint.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ITag } from \"./ITag.js\";\n\n/**\n * Route entry points are used for exposing the routes from a package.\n */\nexport interface IBaseRouteEntryPoint<T> {\n\t/**\n\t * The name of the routes.\n\t */\n\tname: string;\n\n\t/**\n\t * The default base route name for the routes.\n\t */\n\tdefaultBaseRoute: string;\n\n\t/**\n\t * The tags for the routes.\n\t */\n\ttags: ITag[];\n\n\t/**\n\t * The method to generate the routes.\n\t */\n\tgenerateRoutes: (baseRouteName: string, componentName: string) => T[];\n}\n"]}

package/dist/es/models/routes/IRestRoute.js

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

package/dist/es/models/routes/IRestRoute.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IRestRoute.js","sourceRoot":"","sources":["../../../../src/models/routes/IRestRoute.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HttpMethod } from \"@twin.org/web\";\nimport type { IBaseRoute } from \"./IBaseRoute.js\";\nimport type { IRestRouteRequestExample } from \"./IRestRouteRequestExample.js\";\nimport type { IRestRouteResponseExample } from \"./IRestRouteResponseExample.js\";\nimport type { IRestRouteResponseOptions } from \"./IRestRouteResponseOptions.js\";\nimport type { IHttpRequest } from \"../protocol/IHttpRequest.js\";\nimport type { IHttpRequestContext } from \"../protocol/IHttpRequestContext.js\";\nimport type { IHttpResponse } from \"../protocol/IHttpResponse.js\";\n\n/**\n * Interface which defines a REST route.\n */\nexport interface IRestRoute<\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\tT extends IHttpRequest = any,\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\tU extends IHttpResponse & IRestRouteResponseOptions = any\n> extends IBaseRoute {\n\t/**\n\t * Summary of what task the operation performs.\n\t */\n\tsummary: string;\n\n\t/**\n\t * Tag for the operation.\n\t */\n\ttag: string;\n\n\t/**\n\t * The http method.\n\t */\n\tmethod: HttpMethod;\n\n\t/**\n\t * The handler module.\n\t */\n\thandler: (\n\t\t/**\n\t\t * The http request context.\n\t\t */\n\t\thttpRequestContext: IHttpRequestContext,\n\n\t\t/**\n\t\t * The request object, combined query param, path params and body.\n\t\t */\n\t\trequest: T\n\t) => Promise<U>;\n\n\t/**\n\t * The type of the request object.\n\t */\n\trequestType?: {\n\t\t/**\n\t\t * The object type for the request.\n\t\t */\n\t\ttype: string;\n\n\t\t/**\n\t\t * The mime type of the request, defaults to \"application/json\" if there is a body.\n\t\t */\n\t\tmimeType?: string;\n\n\t\t/**\n\t\t * Example objects for the request.\n\t\t */\n\t\texamples?: IRestRouteRequestExample<T>[];\n\t};\n\n\t/**\n\t * The type of the response object.\n\t */\n\tresponseType?: {\n\t\t/**\n\t\t * The object type of the response.\n\t\t */\n\t\ttype: string;\n\n\t\t/**\n\t\t * The mime type of the response, defaults to \"application/json\" if there is a body.\n\t\t */\n\t\tmimeType?: string;\n\n\t\t/**\n\t\t * Example objects of the response.\n\t\t */\n\t\texamples?: IRestRouteResponseExample<U>[];\n\t}[];\n\n\t/**\n\t * Exclude the route from being included in the spec file.\n\t */\n\texcludeFromSpec?: boolean;\n}\n"]}

package/dist/es/models/routes/IRestRouteEntryPoint.js

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

package/dist/es/models/routes/IRestRouteEntryPoint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IRestRouteEntryPoint.js","sourceRoot":"","sources":["../../../../src/models/routes/IRestRouteEntryPoint.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IBaseRouteEntryPoint } from \"./IBaseRouteEntryPoint.js\";\nimport type { IRestRoute } from \"./IRestRoute.js\";\n\n/**\n * Route entry points are used for exposing the REST routes from a package.\n */\nexport type IRestRouteEntryPoint = IBaseRouteEntryPoint<IRestRoute>;\n"]}

package/dist/es/models/routes/IRestRouteExample.js

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

package/dist/es/models/routes/IRestRouteExample.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IRestRouteExample.js","sourceRoot":"","sources":["../../../../src/models/routes/IRestRouteExample.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Interface which defines a REST route example.\n */\nexport interface IRestRouteExample {\n\t/**\n\t * Example objects for the request.\n\t */\n\tid: string;\n\n\t/**\n\t * Description of the example.\n\t */\n\tdescription?: string;\n}\n"]}

package/dist/es/models/routes/IRestRouteRequestExample.js

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