@3sixty/api-models 0.0.0-stage → 0.20.0-next.1

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

@@ -0,0 +1 @@
+{"version":3,"file":"IInternalServerErrorResponse.js","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 \"@3sixty/core\";\nimport type { HttpStatusCode } from \"@3sixty/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","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 \"@3sixty/core\";\nimport type { HttpStatusCode } from \"@3sixty/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/INotImplementedResponse.js

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

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

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

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"ITooManyRequestsResponse.js","sources":["../../../../../src/models/responses/errors/ITooManyRequestsResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IError } from \"@3sixty/core\";\nimport type { HttpStatusCode } from \"@3sixty/web\";\n\n/**\n * The request resulted in too many requests, see the content for more details.\n */\nexport interface ITooManyRequestsResponse {\n\t/**\n\t * Response status code.\n\t */\n\tstatusCode: typeof HttpStatusCode.tooManyRequests;\n\n\t/**\n\t * The body which contains the error.\n\t */\n\tbody: IError;\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","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 \"@3sixty/core\";\nimport type { HttpStatusCode } from \"@3sixty/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","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 \"@3sixty/core\";\nimport type { HttpStatusCode } from \"@3sixty/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","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 \"@3sixty/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","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 \"@3sixty/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","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 \"@3sixty/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","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 \"@3sixty/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,2 @@
+export {};
+//# sourceMappingURL=IBaseRoute.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"IBaseRoute.js","sources":["../../../../src/models/routes/IBaseRoute.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// Copyright 2026 3Sixty Trade Ltd.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IRouteAuthorization } from \"./IRouteAuthorization.js\";\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 requirement for this route.\n\t * @default false\n\t */\n\tskipAuth?: boolean;\n\n\t/**\n\t * Skips the tenant requirement for this route.\n\t * @default false\n\t */\n\tskipTenant?: boolean;\n\n\t/**\n\t * Requires authorization for this route.\n\t * @default true\n\t */\n\trequiresAuthorization?: boolean;\n\n\t/**\n\t * The default authorization which can access this route, used to seed the RBAC rules.\n\t */\n\tdefaultAuthorization?: IRouteAuthorization;\n\n\t/**\n\t * Set to true to prevent callers from using the overrideTenant query parameter on this route.\n\t * Tenant override is allowed by default, but you must hold the escalated privilege role to use it.\n\t * @default false\n\t */\n\tdisableTenantOverride?: boolean;\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","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","sources":["../../../../src/models/routes/IRestRoute.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HttpMethod } from \"@3sixty/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\t/**\n\t * The name of the body size limit to apply to the route, only used by methods that carry a body.\n\t * If not provided, the default body size limit will be used. The body size limits are defined in the web server options.\n\t */\n\tbodyLimit?: string;\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","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","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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IRestRouteRequestExample.js","sources":["../../../../src/models/routes/IRestRouteRequestExample.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IRestRouteExample } from \"./IRestRouteExample.js\";\n\n/**\n * Interface which defines a REST route request example.\n */\nexport interface IRestRouteRequestExample<T> extends IRestRouteExample {\n\t/**\n\t * The example request object.\n\t */\n\trequest: T;\n}\n"]}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IRestRouteResponseAttachmentOptions.js","sources":["../../../../src/models/routes/IRestRouteResponseAttachmentOptions.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 response for attachments.\n */\nexport interface IRestRouteResponseAttachmentOptions {\n\t/**\n\t * The content type to use in the response.\n\t */\n\tmimeType?: string;\n\n\t/**\n\t * The filename to use in content disposition.\n\t */\n\tfilename?: string;\n\n\t/**\n\t * Whether to inline the content.\n\t */\n\tinline?: boolean;\n}\n"]}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IRestRouteResponseExample.js","sources":["../../../../src/models/routes/IRestRouteResponseExample.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IRestRouteExample } from \"./IRestRouteExample.js\";\n\n/**\n * Interface which defines a REST route response example.\n */\nexport interface IRestRouteResponseExample<T> extends IRestRouteExample {\n\t/**\n\t * The example response object.\n\t */\n\tresponse: T;\n}\n"]}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IRestRouteResponseOptions.js","sources":["../../../../src/models/routes/IRestRouteResponseOptions.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IRestRouteResponseAttachmentOptions } from \"./IRestRouteResponseAttachmentOptions.js\";\n\n/**\n * Interface which defines a REST route response.\n */\nexport interface IRestRouteResponseOptions {\n\t/**\n\t * Additional options that can be used to control the response.\n\t */\n\tattachment?: IRestRouteResponseAttachmentOptions;\n}\n"]}

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

@@ -0,0 +1,4 @@
+// Copyright 2026 3Sixty Trade Ltd.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IRouteAuthorization.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"IRouteAuthorization.js","sources":["../../../../src/models/routes/IRouteAuthorization.ts"],"names":[],"mappings":"AAAA,mCAAmC;AACnC,uCAAuC","sourcesContent":["// Copyright 2026 3Sixty Trade Ltd.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Interface which defines the default authorization permission for a route used to seed the RBAC rules.\n */\nexport interface IRouteAuthorization {\n\t/**\n\t * The permission string for the route.\n\t */\n\tpermission: string;\n\n\t/**\n\t * The optional role string for the route.\n\t */\n\trole?: string;\n\n\t/**\n\t * The optional array of inherited permissions for the route.\n\t */\n\tinherits?: string[];\n}\n"]}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"ISocketRoute.js","sources":["../../../../src/models/routes/ISocketRoute.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IBaseRoute } from \"./IBaseRoute.js\";\nimport type { IHttpRequest } from \"../protocol/IHttpRequest.js\";\nimport type { IHttpResponse } from \"../protocol/IHttpResponse.js\";\nimport type { ISocketRequestContext } from \"../protocol/ISocketRequestContext.js\";\n\n/**\n * Interface which defines a socket route.\n */\nexport interface ISocketRoute<\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 = any\n> extends IBaseRoute {\n\t/**\n\t * The handler module.\n\t */\n\thandler: (\n\t\t/**\n\t\t * The request context.\n\t\t */\n\t\tsocketRequestContext: ISocketRequestContext,\n\n\t\t/**\n\t\t * The request object.\n\t\t */\n\t\trequest: T,\n\n\t\t/**\n\t\t * The function to emit an event.\n\t\t */\n\t\temit: (event: string, response: U) => Promise<void>\n\t) => Promise<void>;\n\n\t/**\n\t * The connected handler.\n\t */\n\tconnected?: (\n\t\t/**\n\t\t * The request context.\n\t\t */\n\t\tsocketRequestContext: ISocketRequestContext\n\t) => Promise<void>;\n\n\t/**\n\t * The disconnected handler.\n\t */\n\tdisconnected?: (\n\t\t/**\n\t\t * The request context.\n\t\t */\n\t\tsocketRequestContext: ISocketRequestContext\n\t) => Promise<void>;\n}\n"]}

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

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

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

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

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"ITag.js","sources":["../../../../src/models/routes/ITag.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Tag for routes used to generate OpenAPI information.\n */\nexport interface ITag {\n\t/**\n\t * The name of the tag.\n\t */\n\tname: string;\n\n\t/**\n\t * Description for the tag.\n\t */\n\tdescription: string;\n}\n"]}

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

@@ -0,0 +1,17 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The names of the well-known body size limits for routes.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const HttpBodyLimit = {
+    /**
+     * The server default limit.
+     */
+    Default: "default",
+    /**
+     * A large limit for routes carrying file payloads, defaults to 25 MiB.
+     */
+    Large: "large"
+};
+//# sourceMappingURL=httpBodyLimit.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"httpBodyLimit.js","sources":["../../../../src/models/routes/httpBodyLimit.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,aAAa,GAAG;IAC5B;;OAEG;IACH,OAAO,EAAE,SAAS;IAElB;;OAEG;IACH,KAAK,EAAE,OAAO;CACL,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The names of the well-known body size limits for routes.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const HttpBodyLimit = {\n\t/**\n\t * The server default limit.\n\t */\n\tDefault: \"default\",\n\n\t/**\n\t * A large limit for routes carrying file payloads, defaults to 25 MiB.\n\t */\n\tLarge: \"large\"\n} as const;\n\n/**\n * The names of the well-known body size limits for routes.\n */\nexport type HttpBodyLimit = (typeof HttpBodyLimit)[keyof typeof HttpBodyLimit];\n"]}

package/dist/es/models/server/IBaseRouteProcessor.js

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

package/dist/es/models/server/IBaseRouteProcessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IBaseRouteProcessor.js","sources":["../../../../src/models/server/IBaseRouteProcessor.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// Copyright 2026 3Sixty Trade Ltd.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IContextIds } from \"@3sixty/context\";\nimport type { IComponent } from \"@3sixty/core\";\nimport type { IHttpResponse } from \"../protocol/IHttpResponse.js\";\nimport type { IHttpServerRequest } from \"../protocol/IHttpServerRequest.js\";\nimport type { IBaseRoute } from \"../routes/IBaseRoute.js\";\n\n/**\n * The definition for a base processor for handling REST routes.\n */\nexport interface IBaseRouteProcessor<T = IBaseRoute, R = IHttpServerRequest> extends IComponent {\n\t/**\n\t * Pre process the REST request for the specified route.\n\t * @param request The request to handle.\n\t * @param response The response data to send if any.\n\t * @param route The route being requested, if a matching one was found.\n\t * @param contextIds The context IDs of the request.\n\t * @param processorState The state handed through the processors.\n\t * @param componentTypes The component types for the request.\n\t * @param componentTypes.loggingComponentType The logging component type.\n\t * @returns Promise that resolves when the request is processed.\n\t */\n\tpre?(\n\t\trequest: R,\n\t\tresponse: IHttpResponse,\n\t\troute: T | undefined,\n\t\tcontextIds: IContextIds,\n\t\tprocessorState: { [id: string]: unknown },\n\t\tcomponentTypes?: {\n\t\t\tloggingComponentType?: string;\n\t\t}\n\t): Promise<void>;\n\n\t/**\n\t * Post process the REST request for the specified route.\n\t * @param request The request to handle.\n\t * @param response The response data to send if any.\n\t * @param route The route being requested, if a matching one was found.\n\t * @param contextIds The context IDs of the request.\n\t * @param processorState The state handed through the processors.\n\t * @param componentTypes The component types for the request.\n\t * @param componentTypes.loggingComponentType The logging component type.\n\t * @returns Promise that resolves when the request is processed.\n\t */\n\tpost?(\n\t\trequest: R,\n\t\tresponse: IHttpResponse,\n\t\troute: T | undefined,\n\t\tcontextIds: IContextIds,\n\t\tprocessorState: { [id: string]: unknown },\n\t\tcomponentTypes?: {\n\t\t\tloggingComponentType?: string;\n\t\t}\n\t): Promise<void>;\n}\n"]}

package/dist/es/models/server/IMimeTypeProcessor.js

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

package/dist/es/models/server/IMimeTypeProcessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IMimeTypeProcessor.js","sources":["../../../../src/models/server/IMimeTypeProcessor.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@3sixty/core\";\n\n/**\n * The definition for a handler for a specific MIME type.\n */\nexport interface IMimeTypeProcessor extends IComponent {\n\t/**\n\t * Get the MIME types that this handler can handle.\n\t * @returns The MIME types that this handler can handle.\n\t */\n\tgetTypes(): string[];\n\n\t/**\n\t * Handle content.\n\t * @param body The body to process.\n\t * @returns The processed body.\n\t */\n\thandle(body: Uint8Array): Promise<unknown>;\n}\n"]}

package/dist/es/models/server/IRestRouteProcessor.js

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

package/dist/es/models/server/IRestRouteProcessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IRestRouteProcessor.js","sources":["../../../../src/models/server/IRestRouteProcessor.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IBaseRouteProcessor } from \"./IBaseRouteProcessor.js\";\nimport type { IHttpResponse } from \"../protocol/IHttpResponse.js\";\nimport type { IHttpServerRequest } from \"../protocol/IHttpServerRequest.js\";\nimport type { IRestRoute } from \"../routes/IRestRoute.js\";\n\n/**\n * The definition for a processor for handling REST routes.\n */\nexport interface IRestRouteProcessor extends IBaseRouteProcessor<IRestRoute> {\n\t/**\n\t * Process the REST request for the specified route.\n\t * @param request The request to handle.\n\t * @param response The response data to send if any.\n\t * @param route The route being requested, if a matching one was found.\n\t * @param processorState The state handed through the processors.\n\t * @param componentTypes The component types for the request.\n\t * @param componentTypes.loggingComponentType The logging component type.\n\t * @returns Promise that resolves when the request is processed.\n\t */\n\tprocess?(\n\t\trequest: IHttpServerRequest,\n\t\tresponse: IHttpResponse,\n\t\troute: IRestRoute | undefined,\n\t\tprocessorState: { [id: string]: unknown },\n\t\tcomponentTypes?: {\n\t\t\tloggingComponentType?: string;\n\t\t}\n\t): Promise<void>;\n}\n"]}

package/dist/es/models/server/ISocketRouteProcessor.js

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

package/dist/es/models/server/ISocketRouteProcessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ISocketRouteProcessor.js","sources":["../../../../src/models/server/ISocketRouteProcessor.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IBaseRouteProcessor } from \"./IBaseRouteProcessor.js\";\nimport type { IHttpResponse } from \"../protocol/IHttpResponse.js\";\nimport type { ISocketServerRequest } from \"../protocol/ISocketServerRequest.js\";\nimport type { ISocketRoute } from \"../routes/ISocketRoute.js\";\n\n/**\n * The definition for a processor for handling socket routes.\n */\nexport interface ISocketRouteProcessor extends IBaseRouteProcessor<\n\tISocketRoute,\n\tISocketServerRequest\n> {\n\t/**\n\t * Process the connected event.\n\t * @param request The server request object containing the socket id and other parameters.\n\t * @param route The route being requested, if a matching one was found.\n\t * @param loggingComponentType The logging component type for the request.\n\t * @returns Promise that resolves when the request is processed.\n\t */\n\tconnected?(\n\t\trequest: ISocketServerRequest,\n\t\troute: ISocketRoute | undefined,\n\t\tloggingComponentType?: string\n\t): Promise<void>;\n\n\t/**\n\t * Process the disconnected event.\n\t * @param request The server request object containing the socket id and other parameters.\n\t * @param route The route being requested, if a matching one was found.\n\t * @param loggingComponentType The logging component type for the request.\n\t * @returns Promise that resolves when the request is processed.\n\t */\n\tdisconnected?(\n\t\trequest: ISocketServerRequest,\n\t\troute: ISocketRoute | undefined,\n\t\tloggingComponentType?: string\n\t): Promise<void>;\n\n\t/**\n\t * Process the REST request for the specified route.\n\t * @param request The server request object containing the socket id and other parameters.\n\t * @param response The response data to send if any.\n\t * @param route The route being requested, if a matching one was found.\n\t * @param processorState The state handed through the processors.\n\t * @param responseEmitter The function to emit a response.\n\t * @param loggingComponentType The logging component type for the request.\n\t * @returns Promise that resolves when the request is processed.\n\t */\n\tprocess?(\n\t\trequest: ISocketServerRequest,\n\t\tresponse: IHttpResponse,\n\t\troute: ISocketRoute | undefined,\n\t\tprocessorState: { [id: string]: unknown },\n\t\tresponseEmitter: (topic: string, response: IHttpResponse) => Promise<void>,\n\t\tloggingComponentType?: string\n\t): Promise<void>;\n}\n"]}

package/dist/es/models/server/IWebServer.js

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

package/dist/es/models/server/IWebServer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IWebServer.js","sources":["../../../../src/models/server/IWebServer.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@3sixty/core\";\nimport type { IRestRouteProcessor } from \"./IRestRouteProcessor.js\";\nimport type { ISocketRouteProcessor } from \"./ISocketRouteProcessor.js\";\nimport type { IWebServerOptions } from \"./IWebServerOptions.js\";\nimport type { IRestRoute } from \"../routes/IRestRoute.js\";\nimport type { ISocketRoute } from \"../routes/ISocketRoute.js\";\n\n/**\n * Interface describing a web server.\n */\nexport interface IWebServer<T> extends IComponent {\n\t/**\n\t * Get the web server instance.\n\t * @returns The web server instance.\n\t */\n\tgetInstance(): T;\n\n\t/**\n\t * Build the server.\n\t * @param restRouteProcessors The processors for incoming requests over REST.\n\t * @param restRoutes The REST routes.\n\t * @param socketRouteProcessors The processors for incoming requests over Sockets.\n\t * @param socketRoutes The socket routes.\n\t * @param options Options for building the server.\n\t * @returns A promise that resolves when the server is fully built and ready to start.\n\t */\n\tbuild(\n\t\trestRouteProcessors?: IRestRouteProcessor[],\n\t\trestRoutes?: IRestRoute[],\n\t\tsocketRouteProcessors?: ISocketRouteProcessor[],\n\t\tsocketRoutes?: ISocketRoute[],\n\t\toptions?: IWebServerOptions\n\t): Promise<void>;\n\n\t/**\n\t * Start the server.\n\t * @returns A promise that resolves when the server is listening for connections.\n\t */\n\tstart(): Promise<void>;\n\n\t/**\n\t * Stop the server.\n\t * @returns A promise that resolves when the server has shut down all connections.\n\t */\n\tstop(): Promise<void>;\n}\n"]}

package/dist/es/models/server/IWebServerOptions.js

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

package/dist/es/models/server/IWebServerOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IWebServerOptions.js","sources":["../../../../src/models/server/IWebServerOptions.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HttpMethod } from \"@3sixty/web\";\n\n/**\n * Options for the web server.\n */\nexport interface IWebServerOptions {\n\t/**\n\t * The port to bind the web server to.\n\t * @default 3000\n\t */\n\tport?: number;\n\n\t/**\n\t * The address to bind the web server to.\n\t * @default localhost\n\t */\n\thost?: string;\n\n\t/**\n\t * The methods that the server accepts.\n\t * @default [\"GET\", \"PUT\", \"POST\", \"PATCH\", \"DELETE\", \"OPTIONS\"]\n\t */\n\tmethods?: HttpMethod[];\n\n\t/**\n\t * Any additional allowed headers.\n\t */\n\tallowedHeaders?: string[];\n\n\t/**\n\t * And additional exposed headers.\n\t */\n\texposedHeaders?: string[];\n\n\t/**\n\t * The allowed CORS domains.\n\t * @default [\"*\"]\n\t */\n\tcorsOrigins?: string | string[];\n\n\t/**\n\t * The public origin of the server, used for constructing the request URL.\n\t * If not provided, it will be determined from the incoming request.\n\t */\n\tpublicOrigin?: string;\n\n\t/**\n\t * Named body size limits in bytes for REST routes, referenced by a route's bodyLimit name.\n\t * Merged over the server's built-in limits; the \"default\" entry applies to routes with no bodyLimit name.\n\t */\n\tbodyLimits?: { [name: string]: number };\n\n\t/**\n\t * Custom configuration for the web server.\n\t */\n\tcustomWebConfig?: unknown;\n\n\t/**\n\t * Custom configuration for the socket server.\n\t */\n\tcustomSocketConfig?: unknown;\n}\n"]}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IHealthApplicationCallback.js","sources":["../../../../src/models/services/IHealthApplicationCallback.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IHealth } from \"../IHealth.js\";\n\n/**\n * Callback invoked by a component to supply a deferred application health result.\n * Only called when healthApplication returns undefined.\n */\nexport type HealthApplicationCallback = (result: IHealth[]) => Promise<void>;\n"]}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IHealthComponent.js","sources":["../../../../src/models/services/IHealthComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@3sixty/core\";\nimport type { HealthStatus } from \"../healthStatus.js\";\nimport type { IHealth } from \"../IHealth.js\";\n\n/**\n * The health component for the server.\n */\nexport interface IHealthComponent extends IComponent {\n\t/**\n\t * Get the server health.\n\t * @returns The service health.\n\t */\n\thealthStatus(): Promise<{ status: HealthStatus; components: IHealth[] }>;\n}\n"]}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IHealthProviderComponent.js","sources":["../../../../src/models/services/IHealthProviderComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IContextIds } from \"@3sixty/context\";\nimport type { IHealth } from \"../IHealth.js\";\nimport type { HealthApplicationCallback } from \"./IHealthApplicationCallback.js\";\n\n/**\n * The health provider component for the server.\n */\nexport interface IHealthProviderComponent {\n\t/**\n\t * Returns the health status of the component.\n\t * @returns The health status of the component, can return multiple entries for elements within the component.\n\t */\n\thealth?(): Promise<IHealth[]>;\n\n\t/**\n\t * Initialize the application health processing for a component.\n\t * @param contextIds The context IDs provisioned during the init pass.\n\t * @returns A promise that resolves when the initialization is complete.\n\t */\n\thealthApplicationInit?(contextIds: IContextIds): Promise<void>;\n\n\t/**\n\t * Returns the application health status of the component, context IDs from init are set in the current context.\n\t * Returns undefined when the result will be provided asynchronously via the callback.\n\t * @param callback The callback to invoke when a deferred health result is ready.\n\t * @returns The health status, or undefined if the result will be provided via the callback.\n\t */\n\thealthApplication?(callback: HealthApplicationCallback): Promise<IHealth[] | undefined>;\n\n\t/**\n\t * Teardown the application health processing for a component.\n\t * @returns A promise that resolves when the teardown is complete.\n\t */\n\thealthApplicationTeardown?(): Promise<void>;\n}\n"]}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IInformationComponent.js","sources":["../../../../src/models/services/IInformationComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@3sixty/core\";\nimport type { IServerInfo } from \"./IServerInfo.js\";\n\n/**\n * The information component for the server.\n */\nexport interface IInformationComponent extends IComponent {\n\t/**\n\t * Get the root information.\n\t * @returns The root information.\n\t */\n\troot(): Promise<string>;\n\n\t/**\n\t * Get the server information.\n\t * @returns The service information.\n\t */\n\tinfo(): Promise<IServerInfo>;\n\n\t/**\n\t * Get the favicon.\n\t * @returns The favicon.\n\t */\n\tfavicon(): Promise<Uint8Array | undefined>;\n\n\t/**\n\t * Get the OpenAPI spec.\n\t * @returns The OpenAPI spec.\n\t */\n\tspec(): Promise<unknown>;\n\n\t/**\n\t * Is the server live.\n\t * @returns The livez status of the server.\n\t */\n\tlivez(): Promise<{ status: \"alive\" | \"dead\" }>;\n\n\t/**\n\t * Is the server ready.\n\t * @returns The readyz status of the server.\n\t */\n\treadyz(): Promise<{ status: \"ready\" | \"not ready\" }>;\n}\n"]}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IPlatformComponent.js","sources":["../../../../src/models/services/IPlatformComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// Copyright 2026 3Sixty Trade Ltd.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IContextIds } from \"@3sixty/context\";\nimport type { IComponent } from \"@3sixty/core\";\nimport type { TenantEventCallback } from \"./tenantEventCallback.js\";\nimport type { TenantEventType } from \"./tenantEventType.js\";\n\n/**\n * Interface for the platform component.\n */\nexport interface IPlatformComponent extends IComponent {\n\t/**\n\t * Indicates whether the component is running in a multi-tenant environment.\n\t * @returns True if the component is running in a multi-tenant environment, false otherwise.\n\t */\n\tisMultiTenant(): boolean;\n\n\t/**\n\t * Execute a method, if single tenant will run once, if multi-tenant will run for each tenant.\n\t * @param method The method to run for each tenant, returning false will stop any further iterations.\n\t * @returns A promise that resolves when the method has been executed for all applicable tenants.\n\t */\n\texecute(method: () => Promise<undefined | boolean> | Promise<void>): Promise<void>;\n\n\t/**\n\t * Get the local origin context IDs for the given URL.\n\t * @param url The URL to check.\n\t * @returns A promise that resolves to the context IDs if the URL is a local origin, undefined otherwise.\n\t */\n\tgetLocalOriginContext(url: string): Promise<IContextIds | undefined>;\n\n\t/**\n\t * Registers a callback to be invoked when a tenant event occurs.\n\t * @param callbackId A unique identifier for the callback.\n\t * @param callback The callback to invoke when a tenant event occurs.\n\t */\n\tregisterTenantEventCallback(callbackId: string, callback: TenantEventCallback): void;\n\n\t/**\n\t * Unregisters a previously registered tenant event callback.\n\t * @param callbackId The identifier of the callback to unregister.\n\t */\n\tunregisterTenantEventCallback(callbackId: string): void;\n\n\t/**\n\t * Fires all registered tenant event callbacks.\n\t * @param tenantId The ID of the tenant for which the event occurred.\n\t * @param eventType The type of event that occurred.\n\t * @returns A promise that resolves when all callbacks have been invoked.\n\t */\n\tfireTenantEvent(tenantId: string, eventType: TenantEventType): Promise<void>;\n}\n"]}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IServerInfo.js","sources":["../../../../src/models/services/IServerInfo.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The information about the server.\n */\nexport interface IServerInfo {\n\t/**\n\t * The application name.\n\t */\n\tname: string;\n\n\t/**\n\t * The version of the server.\n\t */\n\tversion: string;\n}\n"]}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"ITenant.js","sources":["../../../../src/models/services/ITenant.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Model defining the tenant.\n */\nexport interface ITenant {\n\t/**\n\t * The unique identifier for the tenant.\n\t */\n\tid: string;\n\n\t/**\n\t * The api key for the tenant.\n\t */\n\tapiKey: string;\n\n\t/**\n\t * The label of the tenant.\n\t */\n\tlabel: string;\n\n\t/**\n\t * The date the tenant was created.\n\t */\n\tdateCreated: string;\n\n\t/**\n\t * The date the tenant was modified.\n\t */\n\tdateModified: string;\n\n\t/**\n\t * The public origin available to the public for accessing the API.\n\t */\n\tpublicOrigin?: string;\n\n\t/**\n\t * The organization id for the tenant.\n\t */\n\torganizationId: string;\n\n\t/**\n\t * Optional list of organization aliases that can are used for legacy lookups.\n\t */\n\torganizationIdLegacy?: string[];\n}\n"]}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"ITenantAdminComponent.js","sources":["../../../../src/models/services/ITenantAdminComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@3sixty/core\";\nimport type { EntityCondition } from \"@3sixty/entity\";\nimport type { ITenant } from \"./ITenant.js\";\n\n/**\n * Configuration for the tenant admin component\n */\nexport interface ITenantAdminComponent extends IComponent {\n\t/**\n\t * Create a tenant.\n\t * @param tenant The tenant to store.\n\t * @returns The tenant id.\n\t */\n\tcreate(\n\t\ttenant: Omit<ITenant, \"id\" | \"dateCreated\" | \"dateModified\"> & { id?: string }\n\t): Promise<string>;\n\n\t/**\n\t * Update a tenant.\n\t * @param tenant The tenant to update.\n\t * @returns A promise that resolves when the tenant has been updated.\n\t */\n\tupdate(tenant: Partial<Omit<ITenant, \"dateCreated\" | \"dateModified\">>): Promise<void>;\n\n\t/**\n\t * Get a tenant by its id.\n\t * @param tenantId The id of the tenant.\n\t * @returns The tenant.\n\t * @throws Error if the tenant is not found.\n\t */\n\tget(tenantId: string): Promise<ITenant>;\n\n\t/**\n\t * Get a tenant by its api key.\n\t * @param apiKey The api key of the tenant.\n\t * @returns The tenant.\n\t * @throws Error if the tenant is not found.\n\t */\n\tgetByApiKey(apiKey: string): Promise<ITenant>;\n\n\t/**\n\t * Get a tenant by its public origin.\n\t * @param publicOrigin The origin of the tenant.\n\t * @returns The tenant.\n\t * @throws Error if the tenant is not found.\n\t */\n\tgetByPublicOrigin(publicOrigin: string): Promise<ITenant>;\n\n\t/**\n\t * Remove a tenant by its id.\n\t * @param tenantId The id of the tenant.\n\t * @returns A promise that resolves when the tenant has been removed.\n\t * @throws Error if the tenant is not found.\n\t */\n\tremove(tenantId: string): Promise<void>;\n\n\t/**\n\t * Get a tenant by its organization id, optionally searching legacy ids.\n\t * @param organizationId The organization id of the tenant.\n\t * @param includeLegacy Whether to also search the legacy organization id array.\n\t * @returns The tenant.\n\t * @throws Error if the tenant is not found.\n\t */\n\tgetTenantByOrganizationId(organizationId: string, includeLegacy?: boolean): Promise<ITenant>;\n\n\t/**\n\t * Query tenants with pagination.\n\t * @param conditions The conditions to filter the tenants.\n\t * @param properties The properties to include in the returned tenants.\n\t * @param cursor The cursor to start from.\n\t * @param limit The maximum number of tenants to return.\n\t * @returns The tenants and the next cursor if more tenants are available.\n\t */\n\tquery(\n\t\tconditions?: EntityCondition<ITenant>,\n\t\tproperties?: (keyof ITenant)[],\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{ tenants: ITenant[]; cursor?: string }>;\n}\n"]}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"tenantEventCallback.js","sources":["../../../../src/models/services/tenantEventCallback.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 3Sixty Trade Ltd.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { TenantEventType } from \"./tenantEventType.js\";\n\n/**\n * Callback invoked when a tenant event occurs.\n * Failures in the callback will be logged but will not prevent other callbacks from being invoked.\n */\nexport type TenantEventCallback = (tenantId: string, eventType: TenantEventType) => Promise<void>;\n"]}

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

@@ -0,0 +1,21 @@
+// Copyright 2026 3Sixty Trade Ltd.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The type of event that occurred for a tenant.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const TenantEventType = {
+    /**
+     * The tenant was created.
+     */
+    Created: "created",
+    /**
+     * The tenant was updated.
+     */
+    Updated: "updated",
+    /**
+     * The tenant was deleted.
+     */
+    Deleted: "deleted"
+};
+//# sourceMappingURL=tenantEventType.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"tenantEventType.js","sources":["../../../../src/models/services/tenantEventType.ts"],"names":[],"mappings":"AAAA,mCAAmC;AACnC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,eAAe,GAAG;IAC9B;;OAEG;IACH,OAAO,EAAE,SAAS;IAElB;;OAEG;IACH,OAAO,EAAE,SAAS;IAElB;;OAEG;IACH,OAAO,EAAE,SAAS;CACT,CAAC","sourcesContent":["// Copyright 2026 3Sixty Trade Ltd.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The type of event that occurred for a tenant.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const TenantEventType = {\n\t/**\n\t * The tenant was created.\n\t */\n\tCreated: \"created\",\n\n\t/**\n\t * The tenant was updated.\n\t */\n\tUpdated: \"updated\",\n\n\t/**\n\t * The tenant was deleted.\n\t */\n\tDeleted: \"deleted\"\n} as const;\n\n/**\n * The type of event that occurred for a tenant.\n */\nexport type TenantEventType = (typeof TenantEventType)[keyof typeof TenantEventType];\n"]}

package/dist/types/errors/forbiddenError.d.ts

@@ -0,0 +1,20 @@
+import { BaseError } from "@3sixty/core";
+/**
+ * Class to handle errors which are triggered by forbidden actions.
+ */
+export declare class ForbiddenError extends BaseError {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of ForbiddenError.
+     * @param source The source of the error.
+     * @param message The message as a code.
+     * @param properties Any additional information for the error.
+     * @param cause The cause of the error if we have wrapped another error.
+     */
+    constructor(source: string, message: string, properties?: {
+        [id: string]: unknown;
+    }, cause?: unknown);
+}

package/dist/types/errors/tooManyRequestsError.d.ts

@@ -0,0 +1,22 @@
+import { BaseError } from "@3sixty/core";
+/**
+ * Class to handle errors which are triggered by too many requests.
+ */
+export declare class TooManyRequestsError extends BaseError {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of TooManyRequestsError.
+     * @param source The source of the error.
+     * @param message The message as a code.
+     * @param requestCount The current request count.
+     * @param nextRequestTime The time when the next request can be made, as date ISO string.
+     * @param properties Any additional information for the error.
+     * @param cause The cause of the error if we have wrapped another error.
+     */
+    constructor(source: string, message: string, requestCount: number, nextRequestTime: string, properties?: {
+        [id: string]: unknown;
+    }, cause?: unknown);
+}

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

@@ -0,0 +1,6 @@
+import { Factory } from "@3sixty/core";
+import type { IMimeTypeProcessor } from "../models/server/IMimeTypeProcessor.js";
+/**
+ * Factory for creating implementation of mime type processor types.
+ */
+export declare const MimeTypeProcessorFactory: Factory<IMimeTypeProcessor>;

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

@@ -0,0 +1,6 @@
+import { Factory } from "@3sixty/core";
+import type { IRestClientProcessor } from "../models/client/IRestClientProcessor.js";
+/**
+ * Factory for creating implementation of REST client processor types.
+ */
+export declare const RestClientProcessorFactory: Factory<IRestClientProcessor>;

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

@@ -0,0 +1,6 @@
+import { Factory } from "@3sixty/core";
+import type { IRestRouteProcessor } from "../models/server/IRestRouteProcessor.js";
+/**
+ * Factory for creating implementation of REST route processor types.
+ */
+export declare const RestRouteProcessorFactory: Factory<IRestRouteProcessor>;

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

@@ -0,0 +1,6 @@
+import { Factory } from "@3sixty/core";
+import type { ISocketRouteProcessor } from "../models/server/ISocketRouteProcessor.js";
+/**
+ * Factory for creating implementation of socket route processor types.
+ */
+export declare const SocketRouteProcessorFactory: Factory<ISocketRouteProcessor>;

package/dist/types/helpers/httpErrorHelper.d.ts

@@ -0,0 +1,32 @@
+import { type IError } from "@3sixty/core";
+import { HttpStatusCode } from "@3sixty/web";
+import type { IHttpResponse } from "../models/protocol/IHttpResponse.js";
+/**
+ * Class to help with processing http errors.
+ */
+export declare class HttpErrorHelper {
+    /**
+     * Mapping of error types to status codes.
+     */
+    static readonly ERROR_TYPE_MAP: {
+        [id: string]: HttpStatusCode;
+    };
+    /**
+     * 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: unknown, includeStack?: boolean): {
+        error: IError;
+        httpStatusCode: 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.
+     * @param includeStack Should the stack be included in the error.
+     */
+    static buildResponse(response: IHttpResponse, error: IError, statusCode: HttpStatusCode, includeStack: boolean): void;
+}