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

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

@@ -0,0 +1,37 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Socket route processor types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const SocketRouteProcessorType = {
+    /**
+     * Auth header.
+     */
+    AuthHeader: "auth-header",
+    /**
+     * Auth verifiable credential.
+     */
+    AuthVerifiableCredential: "auth-verifiable-credential",
+    /**
+     * Logging.
+     */
+    Logging: "logging",
+    /**
+     * Context ID.
+     */
+    ContextId: "context-id",
+    /**
+     * Static Context ID.
+     */
+    StaticContextId: "static-context-id",
+    /**
+     * Tenant.
+     */
+    Tenant: "tenant",
+    /**
+     * Socket Route.
+     */
+    SocketRoute: "socket-route"
+};
+//# sourceMappingURL=socketRouteProcessorType.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"socketRouteProcessorType.js","sourceRoot":"","sources":["../../../../src/models/types/socketRouteProcessorType.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,wBAAwB,GAAG;IACvC;;OAEG;IACH,UAAU,EAAE,aAAa;IAEzB;;OAEG;IACH,wBAAwB,EAAE,4BAA4B;IAEtD;;OAEG;IACH,OAAO,EAAE,SAAS;IAElB;;OAEG;IACH,SAAS,EAAE,YAAY;IAEvB;;OAEG;IACH,eAAe,EAAE,mBAAmB;IAEpC;;OAEG;IACH,MAAM,EAAE,QAAQ;IAEhB;;OAEG;IACH,WAAW,EAAE,cAAc;CAClB,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Socket route processor types.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const SocketRouteProcessorType = {\n\t/**\n\t * Auth header.\n\t */\n\tAuthHeader: \"auth-header\",\n\n\t/**\n\t * Auth verifiable credential.\n\t */\n\tAuthVerifiableCredential: \"auth-verifiable-credential\",\n\n\t/**\n\t * Logging.\n\t */\n\tLogging: \"logging\",\n\n\t/**\n\t * Context ID.\n\t */\n\tContextId: \"context-id\",\n\n\t/**\n\t * Static Context ID.\n\t */\n\tStaticContextId: \"static-context-id\",\n\n\t/**\n\t * Tenant.\n\t */\n\tTenant: \"tenant\",\n\n\t/**\n\t * Socket Route.\n\t */\n\tSocketRoute: \"socket-route\"\n} as const;\n\n/**\n * Socket route processor types.\n */\nexport type SocketRouteProcessorType =\n\t(typeof SocketRouteProcessorType)[keyof typeof SocketRouteProcessorType];\n"]}

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

@@ -1,13 +1,16 @@
+import { ComponentFactory, type IComponent } from "@twin.org/core";
 import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
-import type { AuthenticationComponentConfig } from "../models/config/authenticationComponentConfig";
-import type { IEngineServerConfig } from "../models/IEngineServerConfig";
+import type { AuthenticationComponentConfig } from "../models/config/authenticationComponentConfig.js";
+import type { IEngineServerConfig } from "../models/IEngineServerConfig.js";
 /**
  * Initialise the authentication.
  * @param engineCore The engine core.
  * @param context The context for the engine.
  * @param instanceConfig The instance config.
- * @param overrideInstanceType The instance type to override the default.
- * @returns The name of the instance created.
- * @throws GeneralError if the component type is unknown.
+ * @returns The instance created and the factory for it.
  */
-export declare function initialiseAuthenticationComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: AuthenticationComponentConfig, overrideInstanceType?: string): string | undefined;
+export declare function initialiseAuthenticationComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: AuthenticationComponentConfig): Promise<{
+    instanceType?: string;
+    factory?: typeof ComponentFactory;
+    component?: IComponent;
+}>;

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

@@ -1,13 +1,16 @@
+import { ComponentFactory, type IComponent } from "@twin.org/core";
 import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
-import type { AuthenticationAdminComponentConfig } from "../models/config/authenticationAdminComponentConfig";
-import type { IEngineServerConfig } from "../models/IEngineServerConfig";
+import type { AuthenticationAdminComponentConfig } from "../models/config/authenticationAdminComponentConfig.js";
+import type { IEngineServerConfig } from "../models/IEngineServerConfig.js";
 /**
  * Initialise the authentication admin.
  * @param engineCore The engine core.
  * @param context The context for the engine.
  * @param instanceConfig The instance config.
- * @param overrideInstanceType The instance type to override the default.
- * @returns The name of the instance created.
- * @throws GeneralError if the component type is unknown.
+ * @returns The instance created and the factory for it.
  */
-export declare function initialiseAuthenticationAdminComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: AuthenticationAdminComponentConfig, overrideInstanceType?: string): string | undefined;
+export declare function initialiseAuthenticationAdminComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: AuthenticationAdminComponentConfig): Promise<{
+    instanceType?: string;
+    factory?: typeof ComponentFactory;
+    component?: IComponent;
+}>;

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

@@ -1,13 +1,16 @@
+import { ComponentFactory, type IComponent } from "@twin.org/core";
 import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
-import type { InformationComponentConfig } from "../models/config/informationComponentConfig";
-import type { IEngineServerConfig } from "../models/IEngineServerConfig";
+import type { InformationComponentConfig } from "../models/config/informationComponentConfig.js";
+import type { IEngineServerConfig } from "../models/IEngineServerConfig.js";
 /**
  * Initialise the information component.
  * @param engineCore The engine core.
  * @param context The context for the engine.
  * @param instanceConfig The instance config.
- * @param overrideInstanceType The instance type to override the default.
- * @returns The name of the instance created.
- * @throws GeneralError if the component type is unknown.
+ * @returns The instance created and the factory for it.
  */
-export declare function initialiseInformationComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: InformationComponentConfig, overrideInstanceType?: string): string | undefined;
+export declare function initialiseInformationComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: InformationComponentConfig): Promise<{
+    instanceType?: string;
+    factory?: typeof ComponentFactory;
+    component?: IComponent;
+}>;

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

@@ -1,13 +1,17 @@
+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 { MimeTypeProcessorConfig } from "../models/config/mimeTypeProcessorConfig";
-import type { IEngineServerConfig } from "../models/IEngineServerConfig";
+import type { MimeTypeProcessorConfig } from "../models/config/mimeTypeProcessorConfig.js";
+import type { IEngineServerConfig } from "../models/IEngineServerConfig.js";
 /**
  * Initialise the mime type processor.
  * @param engineCore The engine core.
  * @param context The context for the engine.
  * @param instanceConfig The instance config.
- * @param overrideInstanceType The instance type to override the default.
- * @returns The name of the instance created.
- * @throws GeneralError if the component type is unknown.
+ * @returns The instance created and the factory for it.
  */
-export declare function initialiseMimeTypeProcessorComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: MimeTypeProcessorConfig, overrideInstanceType?: string): string | undefined;
+export declare function initialiseMimeTypeProcessorComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: MimeTypeProcessorConfig): Promise<{
+    instanceType?: string;
+    factory?: typeof MimeTypeProcessorFactory;
+    component?: IComponent;
+}>;

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

@@ -1,13 +1,17 @@
-import type { IEngineCoreContext, IEngineCore } from "@twin.org/engine-models";
-import type { RestRouteProcessorConfig } from "../models/config/restRouteProcessorConfig";
-import type { IEngineServerConfig } from "../models/IEngineServerConfig";
+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 { RestRouteProcessorConfig } from "../models/config/restRouteProcessorConfig.js";
+import type { IEngineServerConfig } from "../models/IEngineServerConfig.js";
 /**
  * Initialise the rest route processor.
  * @param engineCore The engine core.
  * @param context The context for the engine.
  * @param instanceConfig The instance config.
- * @param overrideInstanceType The instance type to override the default.
- * @returns The name of the instance created.
- * @throws GeneralError if the component type is unknown.
+ * @returns The instance created and the factory for it.
  */
-export declare function initialiseRestRouteProcessorComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: RestRouteProcessorConfig, overrideInstanceType?: string): string | undefined;
+export declare function initialiseRestRouteProcessorComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: RestRouteProcessorConfig): Promise<{
+    instanceType?: string;
+    factory?: typeof RestRouteProcessorFactory;
+    component?: IComponent;
+}>;

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

@@ -1,13 +1,17 @@
+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 { SocketRouteProcessorConfig } from "../models/config/socketRouteProcessorConfig";
-import type { IEngineServerConfig } from "../models/IEngineServerConfig";
+import type { SocketRouteProcessorConfig } from "../models/config/socketRouteProcessorConfig.js";
+import type { IEngineServerConfig } from "../models/IEngineServerConfig.js";
 /**
  * Initialise the socket route processor.
  * @param engineCore The engine core.
  * @param context The context for the engine.
  * @param instanceConfig The instance config.
- * @param overrideInstanceType The instance type to override the default.
- * @returns The name of the instance created.
- * @throws GeneralError if the component type is unknown.
+ * @returns The instance created and the factory for it.
  */
-export declare function initialiseSocketRouteProcessorComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: SocketRouteProcessorConfig, overrideInstanceType?: string): string | undefined;
+export declare function initialiseSocketRouteProcessorComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: SocketRouteProcessorConfig): Promise<{
+    instanceType?: string;
+    factory?: typeof SocketRouteProcessorFactory;
+    component?: IComponent;
+}>;

package/dist/types/index.d.ts

@@ -1,19 +1,19 @@
-export * from "./components/authentication";
-export * from "./components/authenticationAdmin";
-export * from "./components/information";
-export * from "./components/mimeTypeProcessor";
-export * from "./components/restRouteProcessor";
-export * from "./components/socketRouteProcessor";
-export * from "./models/config/authenticationAdminComponentConfig";
-export * from "./models/config/authenticationComponentConfig";
-export * from "./models/config/informationComponentConfig";
-export * from "./models/config/mimeTypeProcessorConfig";
-export * from "./models/config/restRouteProcessorConfig";
-export * from "./models/config/socketRouteProcessorConfig";
-export * from "./models/IEngineServerConfig";
-export * from "./models/types/authenticationAdminComponentType";
-export * from "./models/types/authenticationComponentType";
-export * from "./models/types/informationComponentType";
-export * from "./models/types/mimeTypeProcessorType";
-export * from "./models/types/restRouteProcessorType";
-export * from "./models/types/socketRouteProcessorType";
+export * from "./components/authentication.js";
+export * from "./components/authenticationAdmin.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/informationComponentConfig.js";
+export * from "./models/config/mimeTypeProcessorConfig.js";
+export * from "./models/config/restRouteProcessorConfig.js";
+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/informationComponentType.js";
+export * from "./models/types/mimeTypeProcessorType.js";
+export * from "./models/types/restRouteProcessorType.js";
+export * from "./models/types/socketRouteProcessorType.js";

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

@@ -1,12 +1,12 @@
 import type { IWebServerOptions } from "@twin.org/api-models";
 import type { IEngineCoreTypeConfig } from "@twin.org/engine-models";
 import type { IEngineConfig } from "@twin.org/engine-types";
-import type { AuthenticationAdminComponentConfig } from "./config/authenticationAdminComponentConfig";
-import type { AuthenticationComponentConfig } from "./config/authenticationComponentConfig";
-import type { InformationComponentConfig } from "./config/informationComponentConfig";
-import type { MimeTypeProcessorConfig } from "./config/mimeTypeProcessorConfig";
-import type { RestRouteProcessorConfig } from "./config/restRouteProcessorConfig";
-import type { SocketRouteProcessorConfig } from "./config/socketRouteProcessorConfig";
+import type { AuthenticationAdminComponentConfig } from "./config/authenticationAdminComponentConfig.js";
+import type { AuthenticationComponentConfig } from "./config/authenticationComponentConfig.js";
+import type { InformationComponentConfig } from "./config/informationComponentConfig.js";
+import type { MimeTypeProcessorConfig } from "./config/mimeTypeProcessorConfig.js";
+import type { RestRouteProcessorConfig } from "./config/restRouteProcessorConfig.js";
+import type { SocketRouteProcessorConfig } from "./config/socketRouteProcessorConfig.js";
 /**
  * Extended engine server config with known types.
  */

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

@@ -1,5 +1,5 @@
 import type { IEntityStorageAuthenticationAdminServiceConstructorOptions } from "@twin.org/api-auth-entity-storage-service";
-import type { AuthenticationAdminComponentType } from "../types/authenticationAdminComponentType";
+import type { AuthenticationAdminComponentType } from "../types/authenticationAdminComponentType.js";
 /**
  * Authentication admin component config types.
  */

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

@@ -1,6 +1,6 @@
 import type { IEntityStorageAuthenticationServiceConstructorOptions } from "@twin.org/api-auth-entity-storage-service";
 import type { IBaseRestClientConfig } from "@twin.org/api-models";
-import type { AuthenticationComponentType } from "../types/authenticationComponentType";
+import type { AuthenticationComponentType } from "../types/authenticationComponentType.js";
 /**
  * Authentication component config types.
  */

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

@@ -1,6 +1,6 @@
 import type { IBaseRestClientConfig } from "@twin.org/api-models";
 import type { IInformationServiceConstructorOptions } from "@twin.org/api-service";
-import type { InformationComponentType } from "../types/informationComponentType";
+import type { InformationComponentType } from "../types/informationComponentType.js";
 /**
  * Information component config types.
  */

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

@@ -1,4 +1,4 @@
-import type { MimeTypeProcessorType } from "../types/mimeTypeProcessorType";
+import type { MimeTypeProcessorType } from "../types/mimeTypeProcessorType.js";
 /**
  * Mime type processor config types.
  */

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

@@ -1,21 +1,29 @@
 import type { IAuthHeaderProcessorConstructorOptions } from "@twin.org/api-auth-entity-storage-service";
-import type { ILoggingProcessorConstructorOptions, IRestRouteProcessorConstructorOptions, IStaticUserIdentityProcessorConstructorOptions } from "@twin.org/api-processors";
-import type { RestRouteProcessorType } from "../types/restRouteProcessorType";
+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.
  */
 export type RestRouteProcessorConfig = {
     type: typeof RestRouteProcessorType.AuthHeader;
     options?: IAuthHeaderProcessorConstructorOptions;
+} | {
+    type: typeof RestRouteProcessorType.AuthVerifiableCredential;
+    options?: IVerifiableCredentialAuthenticationProcessorConstructorOptions;
 } | {
     type: typeof RestRouteProcessorType.Logging;
     options?: ILoggingProcessorConstructorOptions;
 } | {
-    type: typeof RestRouteProcessorType.NodeIdentity;
-    options?: never;
+    type: typeof RestRouteProcessorType.ContextId;
+    options: IContextIdProcessorConstructorOptions;
+} | {
+    type: typeof RestRouteProcessorType.StaticContextId;
+    options: IStaticContextIdProcessorConstructorOptions;
 } | {
-    type: typeof RestRouteProcessorType.StaticUserIdentity;
-    options: IStaticUserIdentityProcessorConstructorOptions;
+    type: typeof RestRouteProcessorType.Tenant;
+    options?: ITenantProcessorConstructorOptions;
 } | {
     type: typeof RestRouteProcessorType.RestRoute;
     options?: IRestRouteProcessorConstructorOptions;

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

@@ -1,21 +1,29 @@
 import type { IAuthHeaderProcessorConstructorOptions } from "@twin.org/api-auth-entity-storage-service";
-import type { ILoggingProcessorConstructorOptions, ISocketRouteProcessorConstructorOptions, IStaticUserIdentityProcessorConstructorOptions } from "@twin.org/api-processors";
-import type { SocketRouteProcessorType } from "../types/socketRouteProcessorType";
+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.
  */
 export type SocketRouteProcessorConfig = {
     type: typeof SocketRouteProcessorType.AuthHeader;
     options?: IAuthHeaderProcessorConstructorOptions;
+} | {
+    type: typeof SocketRouteProcessorType.AuthVerifiableCredential;
+    options?: IVerifiableCredentialAuthenticationProcessorConstructorOptions;
 } | {
     type: typeof SocketRouteProcessorType.Logging;
     options?: ILoggingProcessorConstructorOptions;
 } | {
-    type: typeof SocketRouteProcessorType.NodeIdentity;
-    options?: never;
+    type: typeof SocketRouteProcessorType.ContextId;
+    options: IContextIdProcessorConstructorOptions;
+} | {
+    type: typeof SocketRouteProcessorType.StaticContextId;
+    options: IStaticContextIdProcessorConstructorOptions;
 } | {
-    type: typeof SocketRouteProcessorType.StaticUserIdentity;
-    options: IStaticUserIdentityProcessorConstructorOptions;
+    type: typeof SocketRouteProcessorType.Tenant;
+    options?: ITenantProcessorConstructorOptions;
 } | {
     type: typeof SocketRouteProcessorType.SocketRoute;
     options?: ISocketRouteProcessorConstructorOptions;

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

@@ -6,18 +6,26 @@ export declare const RestRouteProcessorType: {
      * Auth header.
      */
     readonly AuthHeader: "auth-header";
+    /**
+     * Auth verifiable credential.
+     */
+    readonly AuthVerifiableCredential: "auth-verifiable-credential";
     /**
      * Logging.
      */
     readonly Logging: "logging";
     /**
-     * Node Identity.
+     * Context ID.
+     */
+    readonly ContextId: "context-id";
+    /**
+     * Static Context ID.
      */
-    readonly NodeIdentity: "node-identity";
+    readonly StaticContextId: "static-context-id";
     /**
-     * Static User Identity.
+     * Tenant.
      */
-    readonly StaticUserIdentity: "static-user-identity";
+    readonly Tenant: "tenant";
     /**
      * REST Route.
      */

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

@@ -6,18 +6,26 @@ export declare const SocketRouteProcessorType: {
      * Auth header.
      */
     readonly AuthHeader: "auth-header";
+    /**
+     * Auth verifiable credential.
+     */
+    readonly AuthVerifiableCredential: "auth-verifiable-credential";
     /**
      * Logging.
      */
     readonly Logging: "logging";
     /**
-     * Node Identity.
+     * Context ID.
+     */
+    readonly ContextId: "context-id";
+    /**
+     * Static Context ID.
      */
-    readonly NodeIdentity: "node-identity";
+    readonly StaticContextId: "static-context-id";
     /**
-     * Static User Identity.
+     * Tenant.
      */
-    readonly StaticUserIdentity: "static-user-identity";
+    readonly Tenant: "tenant";
     /**
      * Socket Route.
      */