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

package/dist/esm/index.mjs

@@ -1,11 +1,12 @@
 import { EntityStorageAuthenticationClient } from '@twin.org/api-auth-entity-storage-rest-client';
 import { initSchema, EntityStorageAuthenticationService, EntityStorageAuthenticationAdminService, AuthHeaderProcessor } from '@twin.org/api-auth-entity-storage-service';
-import { I18n, StringHelper, GeneralError, ComponentFactory } from '@twin.org/core';
+import { ComponentFactory } from '@twin.org/core';
 import { initialiseEntityStorageConnector } from '@twin.org/engine-types';
 import { InformationClient } from '@twin.org/api-rest-client';
 import { InformationService } from '@twin.org/api-service';
 import { MimeTypeProcessorFactory, RestRouteProcessorFactory, SocketRouteProcessorFactory } from '@twin.org/api-models';
 import { JwtMimeTypeProcessor, LoggingProcessor, NodeIdentityProcessor, StaticUserIdentityProcessor, RestRouteProcessor, SocketRouteProcessor } from '@twin.org/api-processors';
+import { VerifiableCredentialAuthenticationProcessor } from '@twin.org/identity-authentication';
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
@@ -29,44 +30,30 @@ const AuthenticationComponentType = {
  * @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.
  */
-function initialiseAuthenticationComponent(engineCore, context, instanceConfig, overrideInstanceType) {
-    engineCore.logInfo(I18n.formatMessage("engineCore.configuring", {
-        element: `Authentication Component: ${instanceConfig.type}`
-    }));
-    const type = instanceConfig.type;
+async function initialiseAuthenticationComponent(engineCore, context, instanceConfig) {
     let component;
     let instanceType;
-    if (type === AuthenticationComponentType.EntityStorage) {
+    if (instanceConfig.type === AuthenticationComponentType.EntityStorage) {
         initSchema();
         initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.userEntityStorageType, "AuthenticationUser");
         component = new EntityStorageAuthenticationService({
-            vaultConnectorType: context.defaultTypes.vaultConnector,
-            authenticationAdminServiceType: context.defaultTypes.authenticationAdminComponent,
+            vaultConnectorType: engineCore.getRegisteredInstanceType("vaultConnector"),
+            authenticationAdminServiceType: engineCore.getRegisteredInstanceType("authenticationAdminComponent"),
             ...instanceConfig.options
         });
-        instanceType = StringHelper.kebabCase("EntityStorageAuthenticationService");
+        instanceType = "entity-storage-authentication-service";
     }
-    else if (type === AuthenticationComponentType.RestClient) {
+    else if (instanceConfig.type === AuthenticationComponentType.RestClient) {
         component = new EntityStorageAuthenticationClient(instanceConfig.options);
-        instanceType = StringHelper.kebabCase("EntityStorageAuthenticationClient");
+        instanceType = "entity-storage-authentication-client";
     }
-    else {
-        throw new GeneralError("engineCore", "componentUnknownType", {
-            type,
-            componentType: "authenticationComponent"
-        });
-    }
-    const finalInstanceType = overrideInstanceType ?? instanceType;
-    context.componentInstances.push({
-        instanceType: finalInstanceType,
-        component
-    });
-    ComponentFactory.register(finalInstanceType, () => component);
-    return finalInstanceType;
+    return {
+        component,
+        instanceType,
+        factory: ComponentFactory
+    };
 }
 
 // Copyright 2024 IOTA Stiftung.
@@ -87,38 +74,24 @@ const AuthenticationAdminComponentType = {
  * @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.
  */
-function initialiseAuthenticationAdminComponent(engineCore, context, instanceConfig, overrideInstanceType) {
-    engineCore.logInfo(I18n.formatMessage("engineCore.configuring", {
-        element: `Authentication Admin Component: ${instanceConfig.type}`
-    }));
-    const type = instanceConfig.type;
+async function initialiseAuthenticationAdminComponent(engineCore, context, instanceConfig) {
     let component;
     let instanceType;
-    if (type === AuthenticationAdminComponentType.EntityStorage) {
+    if (instanceConfig.type === AuthenticationAdminComponentType.EntityStorage) {
         initSchema();
         initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.userEntityStorageType, "AuthenticationUser");
         component = new EntityStorageAuthenticationAdminService({
             ...instanceConfig.options
         });
-        instanceType = StringHelper.kebabCase("EntityStorageAuthenticationAdminService");
-    }
-    else {
-        throw new GeneralError("engineCore", "componentUnknownType", {
-            type,
-            componentType: "authenticationAdminComponent"
-        });
+        instanceType = "entity-storage-authentication-admin-service";
     }
-    const finalInstanceType = overrideInstanceType ?? instanceType;
-    context.componentInstances.push({
-        instanceType: finalInstanceType,
-        component
-    });
-    ComponentFactory.register(finalInstanceType, () => component);
-    return finalInstanceType;
+    return {
+        component,
+        instanceType,
+        factory: ComponentFactory
+    };
 }
 
 // Copyright 2024 IOTA Stiftung.
@@ -143,38 +116,24 @@ const InformationComponentType = {
  * @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.
  */
-function initialiseInformationComponent(engineCore, context, instanceConfig, overrideInstanceType) {
-    engineCore.logInfo(I18n.formatMessage("engineCore.configuring", {
-        element: `Information Component: ${instanceConfig.type}`
-    }));
-    const type = instanceConfig.type;
+async function initialiseInformationComponent(engineCore, context, instanceConfig) {
     let component;
     let instanceType;
-    if (type === InformationComponentType.Service) {
+    if (instanceConfig.type === InformationComponentType.Service) {
         component = new InformationService(instanceConfig.options);
-        instanceType = StringHelper.kebabCase("InformationService");
+        instanceType = "information-service";
     }
-    else if (type === InformationComponentType.RestClient) {
+    else if (instanceConfig.type === InformationComponentType.RestClient) {
         component = new InformationClient(instanceConfig.options);
-        instanceType = StringHelper.kebabCase("InformationClient");
+        instanceType = "information-client";
     }
-    else {
-        throw new GeneralError("engineCore", "componentUnknownType", {
-            type,
-            componentType: "informationComponent"
-        });
-    }
-    const finalInstanceType = overrideInstanceType ?? instanceType;
-    context.componentInstances.push({
-        instanceType: finalInstanceType,
-        component
-    });
-    ComponentFactory.register(finalInstanceType, () => component);
-    return finalInstanceType;
+    return {
+        component,
+        instanceType,
+        factory: ComponentFactory
+    };
 }
 
 // Copyright 2024 IOTA Stiftung.
@@ -197,34 +156,20 @@ const MimeTypeProcessorType = {
  * @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.
  */
-function initialiseMimeTypeProcessorComponent(engineCore, context, instanceConfig, overrideInstanceType) {
-    engineCore.logInfo(I18n.formatMessage("engineCore.configuring", {
-        element: `Mime Type Processor: ${instanceConfig.type}`
-    }));
-    const type = instanceConfig.type;
+async function initialiseMimeTypeProcessorComponent(engineCore, context, instanceConfig) {
     let component;
     let instanceType;
-    if (type === MimeTypeProcessorType.Jwt) {
+    if (instanceConfig.type === MimeTypeProcessorType.Jwt) {
         component = new JwtMimeTypeProcessor();
-        instanceType = StringHelper.kebabCase("JwtMimeTypeProcessor");
+        instanceType = "jwt-mime-type-processor";
     }
-    else {
-        throw new GeneralError("engineCore", "componentUnknownType", {
-            type,
-            componentType: "mimeTypeProcessorComponent"
-        });
-    }
-    const finalInstanceType = overrideInstanceType ?? instanceType;
-    context.componentInstances.push({
-        instanceType: finalInstanceType,
-        component
-    });
-    MimeTypeProcessorFactory.register(finalInstanceType, () => component);
-    return finalInstanceType;
+    return {
+        component,
+        instanceType,
+        factory: MimeTypeProcessorFactory
+    };
 }
 
 // Copyright 2024 IOTA Stiftung.
@@ -238,6 +183,10 @@ const RestRouteProcessorType = {
      * Auth header.
      */
     AuthHeader: "auth-header",
+    /**
+     * Auth verifiable credential.
+     */
+    AuthVerifiableCredential: "auth-verifiable-credential",
     /**
      * Logging.
      */
@@ -263,60 +212,56 @@ const RestRouteProcessorType = {
  * @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.
  */
-function initialiseRestRouteProcessorComponent(engineCore, context, instanceConfig, overrideInstanceType) {
-    engineCore.logInfo(I18n.formatMessage("engineCore.configuring", {
-        element: `REST Route Processor: ${instanceConfig.type}`
-    }));
-    const type = instanceConfig.type;
+async function initialiseRestRouteProcessorComponent(engineCore, context, instanceConfig) {
     let component;
     let instanceType;
-    if (type === RestRouteProcessorType.AuthHeader) {
+    if (instanceConfig.type === RestRouteProcessorType.AuthHeader) {
         component = new AuthHeaderProcessor({
-            vaultConnectorType: context.defaultTypes.vaultConnector,
+            vaultConnectorType: engineCore.getRegisteredInstanceType("vaultConnector"),
+            config: {
+                ...instanceConfig.options?.config
+            }
+        });
+        instanceType = "auth-header-processor";
+    }
+    else if (instanceConfig.type === RestRouteProcessorType.AuthVerifiableCredential) {
+        component = new VerifiableCredentialAuthenticationProcessor({
+            identityConnectorType: engineCore.getRegisteredInstanceType("identityConnector"),
+            loggingComponentType: engineCore.getRegisteredInstanceType("loggingComponent"),
             config: {
                 ...instanceConfig.options?.config
             }
         });
-        instanceType = StringHelper.kebabCase("AuthHeaderProcessor");
+        instanceType = "verifiable-credential-authentication-processor";
     }
-    else if (type === RestRouteProcessorType.Logging) {
+    else if (instanceConfig.type === RestRouteProcessorType.Logging) {
         component = new LoggingProcessor({
-            loggingConnectorType: context.defaultTypes.loggingConnector,
+            loggingComponentType: engineCore.getRegisteredInstanceType("loggingComponent"),
             config: {
                 ...instanceConfig.options?.config
             }
         });
-        instanceType = StringHelper.kebabCase("LoggingProcessor");
+        instanceType = "logging-processor";
     }
-    else if (type === RestRouteProcessorType.NodeIdentity) {
+    else if (instanceConfig.type === RestRouteProcessorType.NodeIdentity) {
         component = new NodeIdentityProcessor();
-        instanceType = StringHelper.kebabCase("NodeIdentityProcessor");
+        instanceType = "node-identity-processor";
     }
-    else if (type === RestRouteProcessorType.StaticUserIdentity) {
+    else if (instanceConfig.type === RestRouteProcessorType.StaticUserIdentity) {
         component = new StaticUserIdentityProcessor(instanceConfig.options);
-        instanceType = StringHelper.kebabCase("StaticUserIdentityProcessor");
+        instanceType = "static-user-identity-processor";
     }
-    else if (type === RestRouteProcessorType.RestRoute) {
+    else if (instanceConfig.type === RestRouteProcessorType.RestRoute) {
         component = new RestRouteProcessor(instanceConfig.options);
-        instanceType = StringHelper.kebabCase("RestRouteProcessor");
-    }
-    else {
-        throw new GeneralError("engineCore", "componentUnknownType", {
-            type,
-            componentType: "restRouteProcessorComponent"
-        });
+        instanceType = "rest-route-processor";
     }
-    const finalInstanceType = overrideInstanceType ?? instanceType;
-    context.componentInstances.push({
-        instanceType: finalInstanceType,
-        component
-    });
-    RestRouteProcessorFactory.register(finalInstanceType, () => component);
-    return finalInstanceType;
+    return {
+        component,
+        instanceType,
+        factory: RestRouteProcessorFactory
+    };
 }
 
 // Copyright 2024 IOTA Stiftung.
@@ -330,6 +275,10 @@ const SocketRouteProcessorType = {
      * Auth header.
      */
     AuthHeader: "auth-header",
+    /**
+     * Auth verifiable credential.
+     */
+    AuthVerifiableCredential: "auth-verifiable-credential",
     /**
      * Logging.
      */
@@ -355,60 +304,56 @@ const SocketRouteProcessorType = {
  * @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.
  */
-function initialiseSocketRouteProcessorComponent(engineCore, context, instanceConfig, overrideInstanceType) {
-    engineCore.logInfo(I18n.formatMessage("engineCore.configuring", {
-        element: `Socket Route Processor: ${instanceConfig.type}`
-    }));
-    const type = instanceConfig.type;
+async function initialiseSocketRouteProcessorComponent(engineCore, context, instanceConfig) {
     let component;
     let instanceType;
-    if (type === SocketRouteProcessorType.AuthHeader) {
+    if (instanceConfig.type === SocketRouteProcessorType.AuthHeader) {
         component = new AuthHeaderProcessor({
-            vaultConnectorType: context.defaultTypes.vaultConnector,
+            vaultConnectorType: engineCore.getRegisteredInstanceType("vaultConnector"),
             config: {
                 ...instanceConfig.options?.config
             }
         });
-        instanceType = StringHelper.kebabCase("AuthHeaderProcessor");
+        instanceType = "auth-header-processor";
     }
-    else if (type === SocketRouteProcessorType.Logging) {
+    else if (instanceConfig.type === SocketRouteProcessorType.AuthVerifiableCredential) {
+        component = new VerifiableCredentialAuthenticationProcessor({
+            identityConnectorType: engineCore.getRegisteredInstanceType("identityConnector"),
+            loggingComponentType: engineCore.getRegisteredInstanceType("loggingComponent"),
+            config: {
+                ...instanceConfig.options?.config
+            }
+        });
+        instanceType = "verifiable-credential-authentication-processor";
+    }
+    else if (instanceConfig.type === SocketRouteProcessorType.Logging) {
         component = new LoggingProcessor({
-            loggingConnectorType: context.defaultTypes.loggingConnector,
+            loggingComponentType: engineCore.getRegisteredInstanceType("loggingComponent"),
             config: {
                 ...instanceConfig.options?.config
             }
         });
-        instanceType = StringHelper.kebabCase("LoggingProcessor");
+        instanceType = "logging-processor";
     }
-    else if (type === SocketRouteProcessorType.NodeIdentity) {
+    else if (instanceConfig.type === SocketRouteProcessorType.NodeIdentity) {
         component = new NodeIdentityProcessor();
-        instanceType = StringHelper.kebabCase("NodeIdentityProcessor");
+        instanceType = "node-identity-processor";
     }
-    else if (type === SocketRouteProcessorType.StaticUserIdentity) {
+    else if (instanceConfig.type === SocketRouteProcessorType.StaticUserIdentity) {
         component = new StaticUserIdentityProcessor(instanceConfig.options);
-        instanceType = StringHelper.kebabCase("StaticUserIdentityProcessor");
+        instanceType = "static-user-identity-processor";
     }
-    else if (type === SocketRouteProcessorType.SocketRoute) {
+    else if (instanceConfig.type === SocketRouteProcessorType.SocketRoute) {
         component = new SocketRouteProcessor(instanceConfig.options);
-        instanceType = StringHelper.kebabCase("SocketRouteProcessor");
-    }
-    else {
-        throw new GeneralError("engineCore", "componentUnknownType", {
-            type,
-            componentType: "socketRouteProcessorComponent"
-        });
+        instanceType = "socket-route-processor";
     }
-    const finalInstanceType = overrideInstanceType ?? instanceType;
-    context.componentInstances.push({
-        instanceType: finalInstanceType,
-        component
-    });
-    SocketRouteProcessorFactory.register(finalInstanceType, () => component);
-    return finalInstanceType;
+    return {
+        component,
+        instanceType,
+        factory: SocketRouteProcessorFactory
+    };
 }
 
 export { AuthenticationAdminComponentType, AuthenticationComponentType, InformationComponentType, MimeTypeProcessorType, RestRouteProcessorType, SocketRouteProcessorType, initialiseAuthenticationAdminComponent, initialiseAuthenticationComponent, initialiseInformationComponent, initialiseMimeTypeProcessorComponent, initialiseRestRouteProcessorComponent, initialiseSocketRouteProcessorComponent };

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

@@ -1,3 +1,4 @@
+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";
@@ -6,8 +7,10 @@ import type { IEngineServerConfig } from "../models/IEngineServerConfig";
  * @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,3 +1,4 @@
+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";
@@ -6,8 +7,10 @@ import type { IEngineServerConfig } from "../models/IEngineServerConfig";
  * @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,3 +1,4 @@
+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";
@@ -6,8 +7,10 @@ import type { IEngineServerConfig } from "../models/IEngineServerConfig";
  * @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,3 +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 { MimeTypeProcessorConfig } from "../models/config/mimeTypeProcessorConfig";
 import type { IEngineServerConfig } from "../models/IEngineServerConfig";
@@ -6,8 +8,10 @@ import type { IEngineServerConfig } from "../models/IEngineServerConfig";
  * @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,4 +1,6 @@
-import type { IEngineCoreContext, IEngineCore } from "@twin.org/engine-models";
+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";
 import type { IEngineServerConfig } from "../models/IEngineServerConfig";
 /**
@@ -6,8 +8,10 @@ import type { IEngineServerConfig } from "../models/IEngineServerConfig";
  * @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,3 +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 { SocketRouteProcessorConfig } from "../models/config/socketRouteProcessorConfig";
 import type { IEngineServerConfig } from "../models/IEngineServerConfig";
@@ -6,8 +8,10 @@ import type { IEngineServerConfig } from "../models/IEngineServerConfig";
  * @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/models/config/restRouteProcessorConfig.d.ts

@@ -1,5 +1,6 @@
 import type { IAuthHeaderProcessorConstructorOptions } from "@twin.org/api-auth-entity-storage-service";
 import type { ILoggingProcessorConstructorOptions, IRestRouteProcessorConstructorOptions, IStaticUserIdentityProcessorConstructorOptions } from "@twin.org/api-processors";
+import type { IVerifiableCredentialAuthenticationProcessorConstructorOptions } from "@twin.org/identity-authentication";
 import type { RestRouteProcessorType } from "../types/restRouteProcessorType";
 /**
  * REST route processor config types.
@@ -7,6 +8,9 @@ import type { RestRouteProcessorType } from "../types/restRouteProcessorType";
 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,5 +1,6 @@
 import type { IAuthHeaderProcessorConstructorOptions } from "@twin.org/api-auth-entity-storage-service";
 import type { ILoggingProcessorConstructorOptions, ISocketRouteProcessorConstructorOptions, IStaticUserIdentityProcessorConstructorOptions } from "@twin.org/api-processors";
+import type { IVerifiableCredentialAuthenticationProcessorConstructorOptions } from "@twin.org/identity-authentication";
 import type { SocketRouteProcessorType } from "../types/socketRouteProcessorType";
 /**
  * Socket route processor config types.
@@ -7,6 +8,9 @@ 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/restRouteProcessorType.d.ts

@@ -6,6 +6,10 @@ export declare const RestRouteProcessorType: {
      * Auth header.
      */
     readonly AuthHeader: "auth-header";
+    /**
+     * Auth verifiable credential.
+     */
+    readonly AuthVerifiableCredential: "auth-verifiable-credential";
     /**
      * Logging.
      */

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

@@ -6,6 +6,10 @@ export declare const SocketRouteProcessorType: {
      * Auth header.
      */
     readonly AuthHeader: "auth-header";
+    /**
+     * Auth verifiable credential.
+     */
+    readonly AuthVerifiableCredential: "auth-verifiable-credential";
     /**
      * Logging.
      */