@twin.org/engine-server-types 0.0.3-next.2 → 0.0.3-next.21

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/config/restRouteProcessorConfig.js.map

@@ -1 +1 @@
-{"version":3,"file":"restRouteProcessorConfig.js","sourceRoot":"","sources":["../../../../src/models/config/restRouteProcessorConfig.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IAuthHeaderProcessorConstructorOptions } from \"@twin.org/api-auth-entity-storage-service\";\nimport type {\n\tIContextIdProcessorConstructorOptions,\n\tILoggingProcessorConstructorOptions,\n\tIRestRouteProcessorConstructorOptions,\n\tIStaticContextIdProcessorConstructorOptions\n} from \"@twin.org/api-processors\";\nimport type { ITenantProcessorConstructorOptions } from \"@twin.org/api-tenant-processor\";\nimport type { IVerifiableCredentialAuthenticationProcessorConstructorOptions } from \"@twin.org/identity-authentication\";\nimport type { RestRouteProcessorType } from \"../types/restRouteProcessorType.js\";\n\n/**\n * REST route processor config types.\n */\nexport type RestRouteProcessorConfig =\n\t| {\n\t\t\ttype: typeof RestRouteProcessorType.AuthHeader;\n\t\t\toptions?: IAuthHeaderProcessorConstructorOptions;\n\t  }\n\t| {\n\t\t\ttype: typeof RestRouteProcessorType.AuthVerifiableCredential;\n\t\t\toptions?: IVerifiableCredentialAuthenticationProcessorConstructorOptions;\n\t  }\n\t| {\n\t\t\ttype: typeof RestRouteProcessorType.Logging;\n\t\t\toptions?: ILoggingProcessorConstructorOptions;\n\t  }\n\t| {\n\t\t\ttype: typeof RestRouteProcessorType.ContextId;\n\t\t\toptions: IContextIdProcessorConstructorOptions;\n\t  }\n\t| {\n\t\t\ttype: typeof RestRouteProcessorType.StaticContextId;\n\t\t\toptions: IStaticContextIdProcessorConstructorOptions;\n\t  }\n\t| {\n\t\t\ttype: typeof RestRouteProcessorType.Tenant;\n\t\t\toptions?: ITenantProcessorConstructorOptions;\n\t  }\n\t| {\n\t\t\ttype: typeof RestRouteProcessorType.RestRoute;\n\t\t\toptions?: IRestRouteProcessorConstructorOptions;\n\t  };\n"]}
+{"version":3,"file":"restRouteProcessorConfig.js","sourceRoot":"","sources":["../../../../src/models/config/restRouteProcessorConfig.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IAuthHeaderProcessorConstructorOptions } from \"@twin.org/api-auth-entity-storage-service\";\nimport type {\n\tIContextIdProcessorConstructorOptions,\n\tILoggingProcessorConstructorOptions,\n\tIRestRouteProcessorConstructorOptions,\n\tIStaticContextIdProcessorConstructorOptions\n} from \"@twin.org/api-processors\";\nimport type { ITenantProcessorConstructorOptions } from \"@twin.org/api-tenant-processor\";\nimport type { RestRouteProcessorType } from \"../types/restRouteProcessorType.js\";\n\n/**\n * REST route processor config types.\n */\nexport type RestRouteProcessorConfig =\n\t| {\n\t\t\ttype: typeof RestRouteProcessorType.AuthHeader;\n\t\t\toptions?: IAuthHeaderProcessorConstructorOptions;\n\t  }\n\t| {\n\t\t\ttype: typeof RestRouteProcessorType.Logging;\n\t\t\toptions?: ILoggingProcessorConstructorOptions;\n\t  }\n\t| {\n\t\t\ttype: typeof RestRouteProcessorType.ContextId;\n\t\t\toptions: IContextIdProcessorConstructorOptions;\n\t  }\n\t| {\n\t\t\ttype: typeof RestRouteProcessorType.StaticContextId;\n\t\t\toptions: IStaticContextIdProcessorConstructorOptions;\n\t  }\n\t| {\n\t\t\ttype: typeof RestRouteProcessorType.Tenant;\n\t\t\toptions?: ITenantProcessorConstructorOptions;\n\t  }\n\t| {\n\t\t\ttype: typeof RestRouteProcessorType.RestRoute;\n\t\t\toptions?: IRestRouteProcessorConstructorOptions;\n\t  };\n"]}

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

@@ -1 +1 @@
-{"version":3,"file":"socketRouteProcessorConfig.js","sourceRoot":"","sources":["../../../../src/models/config/socketRouteProcessorConfig.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IAuthHeaderProcessorConstructorOptions } from \"@twin.org/api-auth-entity-storage-service\";\nimport type {\n\tIContextIdProcessorConstructorOptions,\n\tILoggingProcessorConstructorOptions,\n\tISocketRouteProcessorConstructorOptions,\n\tIStaticContextIdProcessorConstructorOptions\n} from \"@twin.org/api-processors\";\nimport type { ITenantProcessorConstructorOptions } from \"@twin.org/api-tenant-processor\";\nimport type { IVerifiableCredentialAuthenticationProcessorConstructorOptions } from \"@twin.org/identity-authentication\";\nimport type { SocketRouteProcessorType } from \"../types/socketRouteProcessorType.js\";\n\n/**\n * Socket route processor config types.\n */\nexport type SocketRouteProcessorConfig =\n\t| {\n\t\t\ttype: typeof SocketRouteProcessorType.AuthHeader;\n\t\t\toptions?: IAuthHeaderProcessorConstructorOptions;\n\t  }\n\t| {\n\t\t\ttype: typeof SocketRouteProcessorType.AuthVerifiableCredential;\n\t\t\toptions?: IVerifiableCredentialAuthenticationProcessorConstructorOptions;\n\t  }\n\t| {\n\t\t\ttype: typeof SocketRouteProcessorType.Logging;\n\t\t\toptions?: ILoggingProcessorConstructorOptions;\n\t  }\n\t| {\n\t\t\ttype: typeof SocketRouteProcessorType.ContextId;\n\t\t\toptions: IContextIdProcessorConstructorOptions;\n\t  }\n\t| {\n\t\t\ttype: typeof SocketRouteProcessorType.StaticContextId;\n\t\t\toptions: IStaticContextIdProcessorConstructorOptions;\n\t  }\n\t| {\n\t\t\ttype: typeof SocketRouteProcessorType.Tenant;\n\t\t\toptions?: ITenantProcessorConstructorOptions;\n\t  }\n\t| {\n\t\t\ttype: typeof SocketRouteProcessorType.SocketRoute;\n\t\t\toptions?: ISocketRouteProcessorConstructorOptions;\n\t  };\n"]}
+{"version":3,"file":"socketRouteProcessorConfig.js","sourceRoot":"","sources":["../../../../src/models/config/socketRouteProcessorConfig.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IAuthHeaderProcessorConstructorOptions } from \"@twin.org/api-auth-entity-storage-service\";\nimport type {\n\tIContextIdProcessorConstructorOptions,\n\tILoggingProcessorConstructorOptions,\n\tISocketRouteProcessorConstructorOptions,\n\tIStaticContextIdProcessorConstructorOptions\n} from \"@twin.org/api-processors\";\nimport type { ITenantProcessorConstructorOptions } from \"@twin.org/api-tenant-processor\";\nimport type { SocketRouteProcessorType } from \"../types/socketRouteProcessorType.js\";\n\n/**\n * Socket route processor config types.\n */\nexport type SocketRouteProcessorConfig =\n\t| {\n\t\t\ttype: typeof SocketRouteProcessorType.AuthHeader;\n\t\t\toptions?: IAuthHeaderProcessorConstructorOptions;\n\t  }\n\t| {\n\t\t\ttype: typeof SocketRouteProcessorType.Logging;\n\t\t\toptions?: ILoggingProcessorConstructorOptions;\n\t  }\n\t| {\n\t\t\ttype: typeof SocketRouteProcessorType.ContextId;\n\t\t\toptions: IContextIdProcessorConstructorOptions;\n\t  }\n\t| {\n\t\t\ttype: typeof SocketRouteProcessorType.StaticContextId;\n\t\t\toptions: IStaticContextIdProcessorConstructorOptions;\n\t  }\n\t| {\n\t\t\ttype: typeof SocketRouteProcessorType.Tenant;\n\t\t\toptions?: ITenantProcessorConstructorOptions;\n\t  }\n\t| {\n\t\t\ttype: typeof SocketRouteProcessorType.SocketRoute;\n\t\t\toptions?: ISocketRouteProcessorConstructorOptions;\n\t  };\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/authentication.d.ts

@@ -1,5 +1,5 @@
-import { ComponentFactory, type IComponent } from "@twin.org/core";
-import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
+import { ComponentFactory } from "@twin.org/core";
+import type { EngineTypeInitialiserReturn, IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
 import type { AuthenticationComponentConfig } from "../models/config/authenticationComponentConfig.js";
 import type { IEngineServerConfig } from "../models/IEngineServerConfig.js";
 /**
@@ -9,8 +9,4 @@ import type { IEngineServerConfig } from "../models/IEngineServerConfig.js";
  * @param instanceConfig The instance config.
  * @returns The instance created and the factory for it.
  */
-export declare function initialiseAuthenticationComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: AuthenticationComponentConfig): Promise<{
-    instanceType?: string;
-    factory?: typeof ComponentFactory;
-    component?: IComponent;
-}>;
+export declare function initialiseAuthenticationComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: AuthenticationComponentConfig): EngineTypeInitialiserReturn<AuthenticationComponentConfig, typeof ComponentFactory>;

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

@@ -1,5 +1,5 @@
-import { ComponentFactory, type IComponent } from "@twin.org/core";
-import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
+import { ComponentFactory } from "@twin.org/core";
+import type { EngineTypeInitialiserReturn, IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
 import type { AuthenticationAdminComponentConfig } from "../models/config/authenticationAdminComponentConfig.js";
 import type { IEngineServerConfig } from "../models/IEngineServerConfig.js";
 /**
@@ -9,8 +9,4 @@ import type { IEngineServerConfig } from "../models/IEngineServerConfig.js";
  * @param instanceConfig The instance config.
  * @returns The instance created and the factory for it.
  */
-export declare function initialiseAuthenticationAdminComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: AuthenticationAdminComponentConfig): Promise<{
-    instanceType?: string;
-    factory?: typeof ComponentFactory;
-    component?: IComponent;
-}>;
+export declare function initialiseAuthenticationAdminComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: AuthenticationAdminComponentConfig): EngineTypeInitialiserReturn<AuthenticationAdminComponentConfig, typeof ComponentFactory>;

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

@@ -0,0 +1,12 @@
+import { ComponentFactory } from "@twin.org/core";
+import type { EngineTypeInitialiserReturn, 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): EngineTypeInitialiserReturn<HostingComponentConfig, typeof ComponentFactory>;

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

@@ -1,5 +1,5 @@
-import { ComponentFactory, type IComponent } from "@twin.org/core";
-import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
+import { ComponentFactory } from "@twin.org/core";
+import type { EngineTypeInitialiserReturn, IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
 import type { InformationComponentConfig } from "../models/config/informationComponentConfig.js";
 import type { IEngineServerConfig } from "../models/IEngineServerConfig.js";
 /**
@@ -9,8 +9,4 @@ import type { IEngineServerConfig } from "../models/IEngineServerConfig.js";
  * @param instanceConfig The instance config.
  * @returns The instance created and the factory for it.
  */
-export declare function initialiseInformationComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: InformationComponentConfig): Promise<{
-    instanceType?: string;
-    factory?: typeof ComponentFactory;
-    component?: IComponent;
-}>;
+export declare function initialiseInformationComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: InformationComponentConfig): EngineTypeInitialiserReturn<InformationComponentConfig, typeof ComponentFactory>;

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

@@ -1,6 +1,5 @@
 import { MimeTypeProcessorFactory } from "@twin.org/api-models";
-import type { IComponent } from "@twin.org/core";
-import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
+import type { EngineTypeInitialiserReturn, IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
 import type { MimeTypeProcessorConfig } from "../models/config/mimeTypeProcessorConfig.js";
 import type { IEngineServerConfig } from "../models/IEngineServerConfig.js";
 /**
@@ -10,8 +9,4 @@ import type { IEngineServerConfig } from "../models/IEngineServerConfig.js";
  * @param instanceConfig The instance config.
  * @returns The instance created and the factory for it.
  */
-export declare function initialiseMimeTypeProcessorComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: MimeTypeProcessorConfig): Promise<{
-    instanceType?: string;
-    factory?: typeof MimeTypeProcessorFactory;
-    component?: IComponent;
-}>;
+export declare function initialiseMimeTypeProcessorComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: MimeTypeProcessorConfig): EngineTypeInitialiserReturn<MimeTypeProcessorConfig, typeof MimeTypeProcessorFactory>;

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

@@ -1,6 +1,5 @@
 import { RestRouteProcessorFactory } from "@twin.org/api-models";
-import type { IComponent } from "@twin.org/core";
-import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
+import type { EngineTypeInitialiserReturn, IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
 import type { RestRouteProcessorConfig } from "../models/config/restRouteProcessorConfig.js";
 import type { IEngineServerConfig } from "../models/IEngineServerConfig.js";
 /**
@@ -10,8 +9,4 @@ import type { IEngineServerConfig } from "../models/IEngineServerConfig.js";
  * @param instanceConfig The instance config.
  * @returns The instance created and the factory for it.
  */
-export declare function initialiseRestRouteProcessorComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: RestRouteProcessorConfig): Promise<{
-    instanceType?: string;
-    factory?: typeof RestRouteProcessorFactory;
-    component?: IComponent;
-}>;
+export declare function initialiseRestRouteProcessorComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: RestRouteProcessorConfig): EngineTypeInitialiserReturn<RestRouteProcessorConfig, typeof RestRouteProcessorFactory>;

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

@@ -1,6 +1,5 @@
 import { SocketRouteProcessorFactory } from "@twin.org/api-models";
-import type { IComponent } from "@twin.org/core";
-import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
+import type { EngineTypeInitialiserReturn, IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
 import type { SocketRouteProcessorConfig } from "../models/config/socketRouteProcessorConfig.js";
 import type { IEngineServerConfig } from "../models/IEngineServerConfig.js";
 /**
@@ -10,8 +9,4 @@ import type { IEngineServerConfig } from "../models/IEngineServerConfig.js";
  * @param instanceConfig The instance config.
  * @returns The instance created and the factory for it.
  */
-export declare function initialiseSocketRouteProcessorComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: SocketRouteProcessorConfig): Promise<{
-    instanceType?: string;
-    factory?: typeof SocketRouteProcessorFactory;
-    component?: IComponent;
-}>;
+export declare function initialiseSocketRouteProcessorComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: SocketRouteProcessorConfig): EngineTypeInitialiserReturn<SocketRouteProcessorConfig, typeof SocketRouteProcessorFactory>;

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/config/restRouteProcessorConfig.d.ts

@@ -1,7 +1,6 @@
 import type { IAuthHeaderProcessorConstructorOptions } from "@twin.org/api-auth-entity-storage-service";
 import type { IContextIdProcessorConstructorOptions, ILoggingProcessorConstructorOptions, IRestRouteProcessorConstructorOptions, IStaticContextIdProcessorConstructorOptions } from "@twin.org/api-processors";
 import type { ITenantProcessorConstructorOptions } from "@twin.org/api-tenant-processor";
-import type { IVerifiableCredentialAuthenticationProcessorConstructorOptions } from "@twin.org/identity-authentication";
 import type { RestRouteProcessorType } from "../types/restRouteProcessorType.js";
 /**
  * REST route processor config types.
@@ -9,9 +8,6 @@ import type { RestRouteProcessorType } from "../types/restRouteProcessorType.js"
 export type RestRouteProcessorConfig = {
     type: typeof RestRouteProcessorType.AuthHeader;
     options?: IAuthHeaderProcessorConstructorOptions;
-} | {
-    type: typeof RestRouteProcessorType.AuthVerifiableCredential;
-    options?: IVerifiableCredentialAuthenticationProcessorConstructorOptions;
 } | {
     type: typeof RestRouteProcessorType.Logging;
     options?: ILoggingProcessorConstructorOptions;

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

@@ -1,7 +1,6 @@
 import type { IAuthHeaderProcessorConstructorOptions } from "@twin.org/api-auth-entity-storage-service";
 import type { IContextIdProcessorConstructorOptions, ILoggingProcessorConstructorOptions, ISocketRouteProcessorConstructorOptions, IStaticContextIdProcessorConstructorOptions } from "@twin.org/api-processors";
 import type { ITenantProcessorConstructorOptions } from "@twin.org/api-tenant-processor";
-import type { IVerifiableCredentialAuthenticationProcessorConstructorOptions } from "@twin.org/identity-authentication";
 import type { SocketRouteProcessorType } from "../types/socketRouteProcessorType.js";
 /**
  * Socket route processor config types.
@@ -9,9 +8,6 @@ import type { SocketRouteProcessorType } from "../types/socketRouteProcessorType
 export type SocketRouteProcessorConfig = {
     type: typeof SocketRouteProcessorType.AuthHeader;
     options?: IAuthHeaderProcessorConstructorOptions;
-} | {
-    type: typeof SocketRouteProcessorType.AuthVerifiableCredential;
-    options?: IVerifiableCredentialAuthenticationProcessorConstructorOptions;
 } | {
     type: typeof SocketRouteProcessorType.Logging;
     options?: ILoggingProcessorConstructorOptions;

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];