@twin.org/engine-server-types 0.0.3-next.14 → 0.0.3-next.16

package/dist/es/components/hosting.js

@@ -0,0 +1,27 @@
+import { HostingService } from "@twin.org/api-service";
+import { ComponentFactory } from "@twin.org/core";
+import { HostingComponentType } from "../models/types/hostingComponentType.js";
+/**
+ * Initialise the hosting component.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @returns The instance created and the factory for it.
+ */
+export async function initialiseHostingComponent(engineCore, context, instanceConfig) {
+    let component;
+    let instanceType;
+    if (instanceConfig.type === HostingComponentType.Service) {
+        component = new HostingService({
+            tenantAdminComponentType: engineCore.getRegisteredInstanceTypeOptional("tenantAdminComponent"),
+            config: instanceConfig.options.config
+        });
+        instanceType = "hosting-service";
+    }
+    return {
+        component,
+        instanceType,
+        factory: ComponentFactory
+    };
+}
+//# sourceMappingURL=hosting.js.map

package/dist/es/components/hosting.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hosting.js","sourceRoot":"","sources":["../../../src/components/hosting.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAmB,MAAM,gBAAgB,CAAC;AAKnE,OAAO,EAAE,oBAAoB,EAAE,MAAM,yCAAyC,CAAC;AAE/E;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAC/C,UAA4C,EAC5C,OAAgD,EAChD,cAAsC;IAEtC,IAAI,SAAwC,CAAC;IAC7C,IAAI,YAAgC,CAAC;IAErC,IAAI,cAAc,CAAC,IAAI,KAAK,oBAAoB,CAAC,OAAO,EAAE,CAAC;QAC1D,SAAS,GAAG,IAAI,cAAc,CAAC;YAC9B,wBAAwB,EACvB,UAAU,CAAC,iCAAiC,CAAC,sBAAsB,CAAC;YACrE,MAAM,EAAE,cAAc,CAAC,OAAO,CAAC,MAAM;SACrC,CAAC,CAAC;QACH,YAAY,oBAAkC,CAAC;IAChD,CAAC;IAED,OAAO;QACN,SAAS;QACT,YAAY;QACZ,OAAO,EAAE,gBAAgB;KACzB,CAAC;AACH,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IHostingComponent } from \"@twin.org/api-models\";\nimport { HostingService } from \"@twin.org/api-service\";\nimport { ComponentFactory, type IComponent } from \"@twin.org/core\";\nimport type { IEngineCore, IEngineCoreContext } from \"@twin.org/engine-models\";\nimport { nameofKebabCase } from \"@twin.org/nameof\";\nimport type { HostingComponentConfig } from \"../models/config/hostingComponentConfig.js\";\nimport type { IEngineServerConfig } from \"../models/IEngineServerConfig.js\";\nimport { HostingComponentType } from \"../models/types/hostingComponentType.js\";\n\n/**\n * Initialise the hosting component.\n * @param engineCore The engine core.\n * @param context The context for the engine.\n * @param instanceConfig The instance config.\n * @returns The instance created and the factory for it.\n */\nexport async function initialiseHostingComponent(\n\tengineCore: IEngineCore<IEngineServerConfig>,\n\tcontext: IEngineCoreContext<IEngineServerConfig>,\n\tinstanceConfig: HostingComponentConfig\n): Promise<{ instanceType?: string; factory?: typeof ComponentFactory; component?: IComponent }> {\n\tlet component: IHostingComponent | undefined;\n\tlet instanceType: string | undefined;\n\n\tif (instanceConfig.type === HostingComponentType.Service) {\n\t\tcomponent = new HostingService({\n\t\t\ttenantAdminComponentType:\n\t\t\t\tengineCore.getRegisteredInstanceTypeOptional(\"tenantAdminComponent\"),\n\t\t\tconfig: instanceConfig.options.config\n\t\t});\n\t\tinstanceType = nameofKebabCase(HostingService);\n\t}\n\n\treturn {\n\t\tcomponent,\n\t\tinstanceType,\n\t\tfactory: ComponentFactory\n\t};\n}\n"]}

package/dist/es/index.js

@@ -2,12 +2,14 @@
 // SPDX-License-Identifier: Apache-2.0.
 export * from "./components/authentication.js";
 export * from "./components/authenticationAdmin.js";
+export * from "./components/hosting.js";
 export * from "./components/information.js";
 export * from "./components/mimeTypeProcessor.js";
 export * from "./components/restRouteProcessor.js";
 export * from "./components/socketRouteProcessor.js";
 export * from "./models/config/authenticationAdminComponentConfig.js";
 export * from "./models/config/authenticationComponentConfig.js";
+export * from "./models/config/hostingComponentConfig.js";
 export * from "./models/config/informationComponentConfig.js";
 export * from "./models/config/mimeTypeProcessorConfig.js";
 export * from "./models/config/restRouteProcessorConfig.js";
@@ -15,6 +17,7 @@ export * from "./models/config/socketRouteProcessorConfig.js";
 export * from "./models/IEngineServerConfig.js";
 export * from "./models/types/authenticationAdminComponentType.js";
 export * from "./models/types/authenticationComponentType.js";
+export * from "./models/types/hostingComponentType.js";
 export * from "./models/types/informationComponentType.js";
 export * from "./models/types/mimeTypeProcessorType.js";
 export * from "./models/types/restRouteProcessorType.js";

package/dist/es/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,qCAAqC,CAAC;AACpD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,mCAAmC,CAAC;AAClD,cAAc,oCAAoC,CAAC;AACnD,cAAc,sCAAsC,CAAC;AACrD,cAAc,uDAAuD,CAAC;AACtE,cAAc,kDAAkD,CAAC;AACjE,cAAc,+CAA+C,CAAC;AAC9D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,6CAA6C,CAAC;AAC5D,cAAc,+CAA+C,CAAC;AAC9D,cAAc,iCAAiC,CAAC;AAChD,cAAc,oDAAoD,CAAC;AACnE,cAAc,+CAA+C,CAAC;AAC9D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,yCAAyC,CAAC;AACxD,cAAc,0CAA0C,CAAC;AACzD,cAAc,4CAA4C,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./components/authentication.js\";\nexport * from \"./components/authenticationAdmin.js\";\nexport * from \"./components/information.js\";\nexport * from \"./components/mimeTypeProcessor.js\";\nexport * from \"./components/restRouteProcessor.js\";\nexport * from \"./components/socketRouteProcessor.js\";\nexport * from \"./models/config/authenticationAdminComponentConfig.js\";\nexport * from \"./models/config/authenticationComponentConfig.js\";\nexport * from \"./models/config/informationComponentConfig.js\";\nexport * from \"./models/config/mimeTypeProcessorConfig.js\";\nexport * from \"./models/config/restRouteProcessorConfig.js\";\nexport * from \"./models/config/socketRouteProcessorConfig.js\";\nexport * from \"./models/IEngineServerConfig.js\";\nexport * from \"./models/types/authenticationAdminComponentType.js\";\nexport * from \"./models/types/authenticationComponentType.js\";\nexport * from \"./models/types/informationComponentType.js\";\nexport * from \"./models/types/mimeTypeProcessorType.js\";\nexport * from \"./models/types/restRouteProcessorType.js\";\nexport * from \"./models/types/socketRouteProcessorType.js\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,qCAAqC,CAAC;AACpD,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,mCAAmC,CAAC;AAClD,cAAc,oCAAoC,CAAC;AACnD,cAAc,sCAAsC,CAAC;AACrD,cAAc,uDAAuD,CAAC;AACtE,cAAc,kDAAkD,CAAC;AACjE,cAAc,2CAA2C,CAAC;AAC1D,cAAc,+CAA+C,CAAC;AAC9D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,6CAA6C,CAAC;AAC5D,cAAc,+CAA+C,CAAC;AAC9D,cAAc,iCAAiC,CAAC;AAChD,cAAc,oDAAoD,CAAC;AACnE,cAAc,+CAA+C,CAAC;AAC9D,cAAc,wCAAwC,CAAC;AACvD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,yCAAyC,CAAC;AACxD,cAAc,0CAA0C,CAAC;AACzD,cAAc,4CAA4C,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./components/authentication.js\";\nexport * from \"./components/authenticationAdmin.js\";\nexport * from \"./components/hosting.js\";\nexport * from \"./components/information.js\";\nexport * from \"./components/mimeTypeProcessor.js\";\nexport * from \"./components/restRouteProcessor.js\";\nexport * from \"./components/socketRouteProcessor.js\";\nexport * from \"./models/config/authenticationAdminComponentConfig.js\";\nexport * from \"./models/config/authenticationComponentConfig.js\";\nexport * from \"./models/config/hostingComponentConfig.js\";\nexport * from \"./models/config/informationComponentConfig.js\";\nexport * from \"./models/config/mimeTypeProcessorConfig.js\";\nexport * from \"./models/config/restRouteProcessorConfig.js\";\nexport * from \"./models/config/socketRouteProcessorConfig.js\";\nexport * from \"./models/IEngineServerConfig.js\";\nexport * from \"./models/types/authenticationAdminComponentType.js\";\nexport * from \"./models/types/authenticationComponentType.js\";\nexport * from \"./models/types/hostingComponentType.js\";\nexport * from \"./models/types/informationComponentType.js\";\nexport * from \"./models/types/mimeTypeProcessorType.js\";\nexport * from \"./models/types/restRouteProcessorType.js\";\nexport * from \"./models/types/socketRouteProcessorType.js\";\n"]}

package/dist/es/models/IEngineServerConfig.js.map

@@ -1 +1 @@
-{"version":3,"file":"IEngineServerConfig.js","sourceRoot":"","sources":["../../../src/models/IEngineServerConfig.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IWebServerOptions } from \"@twin.org/api-models\";\nimport type { IEngineCoreTypeConfig } from \"@twin.org/engine-models\";\nimport type { IEngineConfig } from \"@twin.org/engine-types\";\nimport type { AuthenticationAdminComponentConfig } from \"./config/authenticationAdminComponentConfig.js\";\nimport type { AuthenticationComponentConfig } from \"./config/authenticationComponentConfig.js\";\nimport type { InformationComponentConfig } from \"./config/informationComponentConfig.js\";\nimport type { MimeTypeProcessorConfig } from \"./config/mimeTypeProcessorConfig.js\";\nimport type { RestRouteProcessorConfig } from \"./config/restRouteProcessorConfig.js\";\nimport type { SocketRouteProcessorConfig } from \"./config/socketRouteProcessorConfig.js\";\n\n/**\n * Extended engine server config with known types.\n */\nexport interface IEngineServerConfig extends IEngineConfig {\n\t/**\n\t * Configuration for the web server.\n\t */\n\tweb?: IWebServerOptions;\n\n\t/**\n\t * The types to initialise in the engine.\n\t */\n\ttypes: IEngineConfig[\"types\"] & {\n\t\t[type: string]: IEngineCoreTypeConfig[] | undefined;\n\n\t\t/**\n\t\t * Information component options which can be overridden by individual components by specifying types other than default..\n\t\t */\n\t\tinformationComponent?: IEngineCoreTypeConfig<InformationComponentConfig>[];\n\n\t\t/**\n\t\t * REST route processors options which can be overridden by individual components by specifying types other than default..\n\t\t */\n\t\trestRouteProcessor?: IEngineCoreTypeConfig<RestRouteProcessorConfig>[];\n\n\t\t/**\n\t\t * Socket route processors options which can be overridden by individual components by specifying types other than default..\n\t\t */\n\t\tsocketRouteProcessor?: IEngineCoreTypeConfig<SocketRouteProcessorConfig>[];\n\n\t\t/**\n\t\t * Mime type processors options which can be overridden by individual components by specifying types other than default..\n\t\t */\n\t\tmimeTypeProcessor?: IEngineCoreTypeConfig<MimeTypeProcessorConfig>[];\n\n\t\t/**\n\t\t * Authentication component options which can be overridden by individual components by specifying types other than default..\n\t\t */\n\t\tauthenticationComponent?: IEngineCoreTypeConfig<AuthenticationComponentConfig>[];\n\n\t\t/**\n\t\t * Authentication admin component options which can be overridden by individual components by specifying types other than default..\n\t\t */\n\t\tauthenticationAdminComponent?: IEngineCoreTypeConfig<AuthenticationAdminComponentConfig>[];\n\t};\n}\n"]}
+{"version":3,"file":"IEngineServerConfig.js","sourceRoot":"","sources":["../../../src/models/IEngineServerConfig.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IWebServerOptions } from \"@twin.org/api-models\";\nimport type { IEngineCoreTypeConfig } from \"@twin.org/engine-models\";\nimport type { IEngineConfig } from \"@twin.org/engine-types\";\nimport type { AuthenticationAdminComponentConfig } from \"./config/authenticationAdminComponentConfig.js\";\nimport type { AuthenticationComponentConfig } from \"./config/authenticationComponentConfig.js\";\nimport type { HostingComponentConfig } from \"./config/hostingComponentConfig.js\";\nimport type { InformationComponentConfig } from \"./config/informationComponentConfig.js\";\nimport type { MimeTypeProcessorConfig } from \"./config/mimeTypeProcessorConfig.js\";\nimport type { RestRouteProcessorConfig } from \"./config/restRouteProcessorConfig.js\";\nimport type { SocketRouteProcessorConfig } from \"./config/socketRouteProcessorConfig.js\";\n\n/**\n * Extended engine server config with known types.\n */\nexport interface IEngineServerConfig extends IEngineConfig {\n\t/**\n\t * Configuration for the web server.\n\t */\n\tweb?: IWebServerOptions;\n\n\t/**\n\t * The types to initialise in the engine.\n\t */\n\ttypes: IEngineConfig[\"types\"] & {\n\t\t[type: string]: IEngineCoreTypeConfig[] | undefined;\n\n\t\t/**\n\t\t * Information component options which can be overridden by individual components by specifying types other than default.\n\t\t */\n\t\tinformationComponent?: IEngineCoreTypeConfig<InformationComponentConfig>[];\n\n\t\t/**\n\t\t * Hosting component options which can be overridden by individual components by specifying types other than default.\n\t\t */\n\t\thostingComponent?: IEngineCoreTypeConfig<HostingComponentConfig>[];\n\n\t\t/**\n\t\t * REST route processors options which can be overridden by individual components by specifying types other than default.\n\t\t */\n\t\trestRouteProcessor?: IEngineCoreTypeConfig<RestRouteProcessorConfig>[];\n\n\t\t/**\n\t\t * Socket route processors options which can be overridden by individual components by specifying types other than default.\n\t\t */\n\t\tsocketRouteProcessor?: IEngineCoreTypeConfig<SocketRouteProcessorConfig>[];\n\n\t\t/**\n\t\t * Mime type processors options which can be overridden by individual components by specifying types other than default.\n\t\t */\n\t\tmimeTypeProcessor?: IEngineCoreTypeConfig<MimeTypeProcessorConfig>[];\n\n\t\t/**\n\t\t * Authentication component options which can be overridden by individual components by specifying types other than default.\n\t\t */\n\t\tauthenticationComponent?: IEngineCoreTypeConfig<AuthenticationComponentConfig>[];\n\n\t\t/**\n\t\t * Authentication admin component options which can be overridden by individual components by specifying types other than default.\n\t\t */\n\t\tauthenticationAdminComponent?: IEngineCoreTypeConfig<AuthenticationAdminComponentConfig>[];\n\t};\n}\n"]}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"hostingComponentConfig.js","sourceRoot":"","sources":["../../../../src/models/config/hostingComponentConfig.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IHostingServiceConstructorOptions } from \"@twin.org/api-service\";\nimport type { HostingComponentType } from \"../types/hostingComponentType.js\";\n\n/**\n * Hosting component config types.\n */\n// eslint-disable-next-line @typescript-eslint/consistent-type-definitions\nexport type HostingComponentConfig = {\n\ttype: typeof HostingComponentType.Service;\n\toptions: IHostingServiceConstructorOptions;\n};\n"]}

package/dist/es/models/types/hostingComponentType.js

@@ -0,0 +1,13 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Hosting component types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const HostingComponentType = {
+    /**
+     * Service.
+     */
+    Service: "service"
+};
+//# sourceMappingURL=hostingComponentType.js.map

package/dist/es/models/types/hostingComponentType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hostingComponentType.js","sourceRoot":"","sources":["../../../../src/models/types/hostingComponentType.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,oBAAoB,GAAG;IACnC;;OAEG;IACH,OAAO,EAAE,SAAS;CACT,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Hosting component types.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const HostingComponentType = {\n\t/**\n\t * Service.\n\t */\n\tService: \"service\"\n} as const;\n\n/**\n * Hosting component types.\n */\nexport type HostingComponentType = (typeof HostingComponentType)[keyof typeof HostingComponentType];\n"]}

package/dist/types/components/hosting.d.ts

@@ -0,0 +1,16 @@
+import { ComponentFactory, type IComponent } from "@twin.org/core";
+import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
+import type { HostingComponentConfig } from "../models/config/hostingComponentConfig.js";
+import type { IEngineServerConfig } from "../models/IEngineServerConfig.js";
+/**
+ * Initialise the hosting component.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @returns The instance created and the factory for it.
+ */
+export declare function initialiseHostingComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: HostingComponentConfig): Promise<{
+    instanceType?: string;
+    factory?: typeof ComponentFactory;
+    component?: IComponent;
+}>;

package/dist/types/index.d.ts

@@ -1,11 +1,13 @@
 export * from "./components/authentication.js";
 export * from "./components/authenticationAdmin.js";
+export * from "./components/hosting.js";
 export * from "./components/information.js";
 export * from "./components/mimeTypeProcessor.js";
 export * from "./components/restRouteProcessor.js";
 export * from "./components/socketRouteProcessor.js";
 export * from "./models/config/authenticationAdminComponentConfig.js";
 export * from "./models/config/authenticationComponentConfig.js";
+export * from "./models/config/hostingComponentConfig.js";
 export * from "./models/config/informationComponentConfig.js";
 export * from "./models/config/mimeTypeProcessorConfig.js";
 export * from "./models/config/restRouteProcessorConfig.js";
@@ -13,6 +15,7 @@ export * from "./models/config/socketRouteProcessorConfig.js";
 export * from "./models/IEngineServerConfig.js";
 export * from "./models/types/authenticationAdminComponentType.js";
 export * from "./models/types/authenticationComponentType.js";
+export * from "./models/types/hostingComponentType.js";
 export * from "./models/types/informationComponentType.js";
 export * from "./models/types/mimeTypeProcessorType.js";
 export * from "./models/types/restRouteProcessorType.js";

package/dist/types/models/IEngineServerConfig.d.ts

@@ -3,6 +3,7 @@ import type { IEngineCoreTypeConfig } from "@twin.org/engine-models";
 import type { IEngineConfig } from "@twin.org/engine-types";
 import type { AuthenticationAdminComponentConfig } from "./config/authenticationAdminComponentConfig.js";
 import type { AuthenticationComponentConfig } from "./config/authenticationComponentConfig.js";
+import type { HostingComponentConfig } from "./config/hostingComponentConfig.js";
 import type { InformationComponentConfig } from "./config/informationComponentConfig.js";
 import type { MimeTypeProcessorConfig } from "./config/mimeTypeProcessorConfig.js";
 import type { RestRouteProcessorConfig } from "./config/restRouteProcessorConfig.js";
@@ -21,27 +22,31 @@ export interface IEngineServerConfig extends IEngineConfig {
     types: IEngineConfig["types"] & {
         [type: string]: IEngineCoreTypeConfig[] | undefined;
         /**
-         * Information component options which can be overridden by individual components by specifying types other than default..
+         * Information component options which can be overridden by individual components by specifying types other than default.
          */
         informationComponent?: IEngineCoreTypeConfig<InformationComponentConfig>[];
         /**
-         * REST route processors options which can be overridden by individual components by specifying types other than default..
+         * Hosting component options which can be overridden by individual components by specifying types other than default.
+         */
+        hostingComponent?: IEngineCoreTypeConfig<HostingComponentConfig>[];
+        /**
+         * REST route processors options which can be overridden by individual components by specifying types other than default.
          */
         restRouteProcessor?: IEngineCoreTypeConfig<RestRouteProcessorConfig>[];
         /**
-         * Socket route processors options which can be overridden by individual components by specifying types other than default..
+         * Socket route processors options which can be overridden by individual components by specifying types other than default.
          */
         socketRouteProcessor?: IEngineCoreTypeConfig<SocketRouteProcessorConfig>[];
         /**
-         * Mime type processors options which can be overridden by individual components by specifying types other than default..
+         * Mime type processors options which can be overridden by individual components by specifying types other than default.
          */
         mimeTypeProcessor?: IEngineCoreTypeConfig<MimeTypeProcessorConfig>[];
         /**
-         * Authentication component options which can be overridden by individual components by specifying types other than default..
+         * Authentication component options which can be overridden by individual components by specifying types other than default.
          */
         authenticationComponent?: IEngineCoreTypeConfig<AuthenticationComponentConfig>[];
         /**
-         * Authentication admin component options which can be overridden by individual components by specifying types other than default..
+         * Authentication admin component options which can be overridden by individual components by specifying types other than default.
          */
         authenticationAdminComponent?: IEngineCoreTypeConfig<AuthenticationAdminComponentConfig>[];
     };

package/dist/types/models/config/hostingComponentConfig.d.ts

@@ -0,0 +1,9 @@
+import type { IHostingServiceConstructorOptions } from "@twin.org/api-service";
+import type { HostingComponentType } from "../types/hostingComponentType.js";
+/**
+ * Hosting component config types.
+ */
+export type HostingComponentConfig = {
+    type: typeof HostingComponentType.Service;
+    options: IHostingServiceConstructorOptions;
+};

package/dist/types/models/types/hostingComponentType.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Hosting component types.
+ */
+export declare const HostingComponentType: {
+    /**
+     * Service.
+     */
+    readonly Service: "service";
+};
+/**
+ * Hosting component types.
+ */
+export type HostingComponentType = (typeof HostingComponentType)[keyof typeof HostingComponentType];

package/docs/changelog.md

@@ -1,5 +1,35 @@
 # @twin.org/engine-server-types - Changelog
 
+## [0.0.3-next.16](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.15...engine-server-types-v0.0.3-next.16) (2026-01-28)
+
+
+### Features
+
+* remove dap and darp ([d568c4f](https://github.com/twinfoundation/engine/commit/d568c4fc58a3159378e1d65f93228ae84f34a31d))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.3-next.15 to 0.0.3-next.16
+    * @twin.org/engine-types bumped from 0.0.3-next.15 to 0.0.3-next.16
+
+## [0.0.3-next.15](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.14...engine-server-types-v0.0.3-next.15) (2026-01-26)
+
+
+### Features
+
+* add hosting component ([#70](https://github.com/twinfoundation/engine/issues/70)) ([2ab0dec](https://github.com/twinfoundation/engine/commit/2ab0dec8fdb979395c639b73f394a40a0dd7e55a))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.3-next.14 to 0.0.3-next.15
+    * @twin.org/engine-types bumped from 0.0.3-next.14 to 0.0.3-next.15
+
 ## [0.0.3-next.14](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.3-next.13...engine-server-types-v0.0.3-next.14) (2026-01-19)
 
 

package/docs/reference/functions/initialiseHostingComponent.md

@@ -0,0 +1,31 @@
+# Function: initialiseHostingComponent()
+
+> **initialiseHostingComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+
+Initialise the hosting component.
+
+## Parameters
+
+### engineCore
+
+`IEngineCore`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
+
+The engine core.
+
+### context
+
+`IEngineCoreContext`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
+
+The context for the engine.
+
+### instanceConfig
+
+[`HostingComponentConfig`](../type-aliases/HostingComponentConfig.md)
+
+The instance config.
+
+## Returns
+
+`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
+
+The instance created and the factory for it.

package/docs/reference/index.md

@@ -8,12 +8,14 @@
 
 - [AuthenticationAdminComponentConfig](type-aliases/AuthenticationAdminComponentConfig.md)
 - [AuthenticationComponentConfig](type-aliases/AuthenticationComponentConfig.md)
+- [HostingComponentConfig](type-aliases/HostingComponentConfig.md)
 - [InformationComponentConfig](type-aliases/InformationComponentConfig.md)
 - [MimeTypeProcessorConfig](type-aliases/MimeTypeProcessorConfig.md)
 - [RestRouteProcessorConfig](type-aliases/RestRouteProcessorConfig.md)
 - [SocketRouteProcessorConfig](type-aliases/SocketRouteProcessorConfig.md)
 - [AuthenticationAdminComponentType](type-aliases/AuthenticationAdminComponentType.md)
 - [AuthenticationComponentType](type-aliases/AuthenticationComponentType.md)
+- [HostingComponentType](type-aliases/HostingComponentType.md)
 - [InformationComponentType](type-aliases/InformationComponentType.md)
 - [MimeTypeProcessorType](type-aliases/MimeTypeProcessorType.md)
 - [RestRouteProcessorType](type-aliases/RestRouteProcessorType.md)
@@ -23,6 +25,7 @@
 
 - [AuthenticationAdminComponentType](variables/AuthenticationAdminComponentType.md)
 - [AuthenticationComponentType](variables/AuthenticationComponentType.md)
+- [HostingComponentType](variables/HostingComponentType.md)
 - [InformationComponentType](variables/InformationComponentType.md)
 - [MimeTypeProcessorType](variables/MimeTypeProcessorType.md)
 - [RestRouteProcessorType](variables/RestRouteProcessorType.md)
@@ -32,6 +35,7 @@
 
 - [initialiseAuthenticationComponent](functions/initialiseAuthenticationComponent.md)
 - [initialiseAuthenticationAdminComponent](functions/initialiseAuthenticationAdminComponent.md)
+- [initialiseHostingComponent](functions/initialiseHostingComponent.md)
 - [initialiseInformationComponent](functions/initialiseInformationComponent.md)
 - [initialiseMimeTypeProcessorComponent](functions/initialiseMimeTypeProcessorComponent.md)
 - [initialiseRestRouteProcessorComponent](functions/initialiseRestRouteProcessorComponent.md)

package/docs/reference/interfaces/IEngineServerConfig.md

@@ -28,37 +28,43 @@ The types to initialise in the engine.
 
 > `optional` **informationComponent**: `IEngineCoreTypeConfig`\<[`InformationComponentConfig`](../type-aliases/InformationComponentConfig.md)\>[]
 
-Information component options which can be overridden by individual components by specifying types other than default..
+Information component options which can be overridden by individual components by specifying types other than default.
+
+##### hostingComponent?
+
+> `optional` **hostingComponent**: `IEngineCoreTypeConfig`\<[`HostingComponentConfig`](../type-aliases/HostingComponentConfig.md)\>[]
+
+Hosting component options which can be overridden by individual components by specifying types other than default.
 
 ##### restRouteProcessor?
 
 > `optional` **restRouteProcessor**: `IEngineCoreTypeConfig`\<[`RestRouteProcessorConfig`](../type-aliases/RestRouteProcessorConfig.md)\>[]
 
-REST route processors options which can be overridden by individual components by specifying types other than default..
+REST route processors options which can be overridden by individual components by specifying types other than default.
 
 ##### socketRouteProcessor?
 
 > `optional` **socketRouteProcessor**: `IEngineCoreTypeConfig`\<[`SocketRouteProcessorConfig`](../type-aliases/SocketRouteProcessorConfig.md)\>[]
 
-Socket route processors options which can be overridden by individual components by specifying types other than default..
+Socket route processors options which can be overridden by individual components by specifying types other than default.
 
 ##### mimeTypeProcessor?
 
 > `optional` **mimeTypeProcessor**: `IEngineCoreTypeConfig`\<[`MimeTypeProcessorConfig`](../type-aliases/MimeTypeProcessorConfig.md)\>[]
 
-Mime type processors options which can be overridden by individual components by specifying types other than default..
+Mime type processors options which can be overridden by individual components by specifying types other than default.
 
 ##### authenticationComponent?
 
 > `optional` **authenticationComponent**: `IEngineCoreTypeConfig`\<[`AuthenticationComponentConfig`](../type-aliases/AuthenticationComponentConfig.md)\>[]
 
-Authentication component options which can be overridden by individual components by specifying types other than default..
+Authentication component options which can be overridden by individual components by specifying types other than default.
 
 ##### authenticationAdminComponent?
 
 > `optional` **authenticationAdminComponent**: `IEngineCoreTypeConfig`\<[`AuthenticationAdminComponentConfig`](../type-aliases/AuthenticationAdminComponentConfig.md)\>[]
 
-Authentication admin component options which can be overridden by individual components by specifying types other than default..
+Authentication admin component options which can be overridden by individual components by specifying types other than default.
 
 #### Overrides
 

package/docs/reference/type-aliases/HostingComponentConfig.md

@@ -0,0 +1,17 @@
+# Type Alias: HostingComponentConfig
+
+> **HostingComponentConfig** = `object`
+
+Hosting component config types.
+
+## Properties
+
+### type
+
+> **type**: *typeof* [`Service`](../variables/HostingComponentType.md#service)
+
+***
+
+### options
+
+> **options**: `IHostingServiceConstructorOptions`

package/docs/reference/type-aliases/HostingComponentType.md

@@ -0,0 +1,5 @@
+# Type Alias: HostingComponentType
+
+> **HostingComponentType** = *typeof* [`HostingComponentType`](../variables/HostingComponentType.md)\[keyof *typeof* [`HostingComponentType`](../variables/HostingComponentType.md)\]
+
+Hosting component types.

package/docs/reference/variables/HostingComponentType.md

@@ -0,0 +1,13 @@
+# Variable: HostingComponentType
+
+> `const` **HostingComponentType**: `object`
+
+Hosting component types.
+
+## Type Declaration
+
+### Service
+
+> `readonly` **Service**: `"service"` = `"service"`
+
+Service.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/engine-server-types",
-	"version": "0.0.3-next.14",
+	"version": "0.0.3-next.16",
 	"description": "Server types to use in an engine server.",
 	"repository": {
 		"type": "git",
@@ -25,8 +25,8 @@
 		"@twin.org/api-tenant-processor": "next",
 		"@twin.org/context": "next",
 		"@twin.org/core": "next",
-		"@twin.org/engine-models": "0.0.3-next.14",
-		"@twin.org/engine-types": "0.0.3-next.14",
+		"@twin.org/engine-models": "0.0.3-next.16",
+		"@twin.org/engine-types": "0.0.3-next.16",
 		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next"
 	},