@twin.org/engine-server-types 0.0.1 → 0.0.2-next.1

package/dist/cjs/index.cjs

@@ -41,6 +41,7 @@ function initialiseAuthenticationComponent(engineCore, context, instanceConfig,
         engineTypes.initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.userEntityStorageType, "AuthenticationUser");
         component = new apiAuthEntityStorageService.EntityStorageAuthenticationService({
             vaultConnectorType: context.defaultTypes.vaultConnector,
+            authenticationAdminServiceType: context.defaultTypes.authenticationAdminComponent,
             ...instanceConfig.options
         });
         instanceType = apiAuthEntityStorageService.EntityStorageAuthenticationService.NAMESPACE;
@@ -60,6 +61,58 @@ function initialiseAuthenticationComponent(engineCore, context, instanceConfig,
     return finalInstanceType;
 }
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Authentication admin component types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const AuthenticationAdminComponentType = {
+    /**
+     * Entity storage.
+     */
+    EntityStorage: "entity-storage"
+};
+
+/**
+ * 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.
+ */
+function initialiseAuthenticationAdminComponent(engineCore, context, instanceConfig, overrideInstanceType) {
+    engineCore.logInfo(core.I18n.formatMessage("engineCore.configuring", {
+        element: `Authentication Admin Component: ${instanceConfig.type}`
+    }));
+    const type = instanceConfig.type;
+    let component;
+    let instanceType;
+    if (type === AuthenticationAdminComponentType.EntityStorage) {
+        apiAuthEntityStorageService.initSchema();
+        engineTypes.initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.userEntityStorageType, "AuthenticationUser");
+        component = new apiAuthEntityStorageService.EntityStorageAuthenticationAdminService({
+            ...instanceConfig.options
+        });
+        instanceType = apiAuthEntityStorageService.EntityStorageAuthenticationAdminService.NAMESPACE;
+    }
+    else {
+        throw new core.GeneralError("engineCore", "componentUnknownType", {
+            type,
+            componentType: "authenticationAdminComponent"
+        });
+    }
+    const finalInstanceType = overrideInstanceType ?? instanceType;
+    context.componentInstances.push({
+        instanceType: finalInstanceType,
+        component
+    });
+    core.ComponentFactory.register(finalInstanceType, () => component);
+    return finalInstanceType;
+}
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -342,11 +395,13 @@ function initialiseSocketRouteProcessorComponent(engineCore, context, instanceCo
     return finalInstanceType;
 }
 
+exports.AuthenticationAdminComponentType = AuthenticationAdminComponentType;
 exports.AuthenticationComponentType = AuthenticationComponentType;
 exports.InformationComponentType = InformationComponentType;
 exports.MimeTypeProcessorType = MimeTypeProcessorType;
 exports.RestRouteProcessorType = RestRouteProcessorType;
 exports.SocketRouteProcessorType = SocketRouteProcessorType;
+exports.initialiseAuthenticationAdminComponent = initialiseAuthenticationAdminComponent;
 exports.initialiseAuthenticationComponent = initialiseAuthenticationComponent;
 exports.initialiseInformationComponent = initialiseInformationComponent;
 exports.initialiseMimeTypeProcessorComponent = initialiseMimeTypeProcessorComponent;

package/dist/esm/index.mjs

@@ -1,4 +1,4 @@
-import { initSchema, EntityStorageAuthenticationService, AuthHeaderProcessor } from '@twin.org/api-auth-entity-storage-service';
+import { initSchema, EntityStorageAuthenticationService, EntityStorageAuthenticationAdminService, AuthHeaderProcessor } from '@twin.org/api-auth-entity-storage-service';
 import { I18n, GeneralError, ComponentFactory } from '@twin.org/core';
 import { initialiseEntityStorageConnector } from '@twin.org/engine-types';
 import { InformationService } from '@twin.org/api-service';
@@ -39,6 +39,7 @@ function initialiseAuthenticationComponent(engineCore, context, instanceConfig,
         initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.userEntityStorageType, "AuthenticationUser");
         component = new EntityStorageAuthenticationService({
             vaultConnectorType: context.defaultTypes.vaultConnector,
+            authenticationAdminServiceType: context.defaultTypes.authenticationAdminComponent,
             ...instanceConfig.options
         });
         instanceType = EntityStorageAuthenticationService.NAMESPACE;
@@ -58,6 +59,58 @@ function initialiseAuthenticationComponent(engineCore, context, instanceConfig,
     return finalInstanceType;
 }
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Authentication admin component types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const AuthenticationAdminComponentType = {
+    /**
+     * Entity storage.
+     */
+    EntityStorage: "entity-storage"
+};
+
+/**
+ * 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.
+ */
+function initialiseAuthenticationAdminComponent(engineCore, context, instanceConfig, overrideInstanceType) {
+    engineCore.logInfo(I18n.formatMessage("engineCore.configuring", {
+        element: `Authentication Admin Component: ${instanceConfig.type}`
+    }));
+    const type = instanceConfig.type;
+    let component;
+    let instanceType;
+    if (type === AuthenticationAdminComponentType.EntityStorage) {
+        initSchema();
+        initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.userEntityStorageType, "AuthenticationUser");
+        component = new EntityStorageAuthenticationAdminService({
+            ...instanceConfig.options
+        });
+        instanceType = EntityStorageAuthenticationAdminService.NAMESPACE;
+    }
+    else {
+        throw new GeneralError("engineCore", "componentUnknownType", {
+            type,
+            componentType: "authenticationAdminComponent"
+        });
+    }
+    const finalInstanceType = overrideInstanceType ?? instanceType;
+    context.componentInstances.push({
+        instanceType: finalInstanceType,
+        component
+    });
+    ComponentFactory.register(finalInstanceType, () => component);
+    return finalInstanceType;
+}
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -340,4 +393,4 @@ function initialiseSocketRouteProcessorComponent(engineCore, context, instanceCo
     return finalInstanceType;
 }
 
-export { AuthenticationComponentType, InformationComponentType, MimeTypeProcessorType, RestRouteProcessorType, SocketRouteProcessorType, initialiseAuthenticationComponent, initialiseInformationComponent, initialiseMimeTypeProcessorComponent, initialiseRestRouteProcessorComponent, initialiseSocketRouteProcessorComponent };
+export { AuthenticationAdminComponentType, AuthenticationComponentType, InformationComponentType, MimeTypeProcessorType, RestRouteProcessorType, SocketRouteProcessorType, initialiseAuthenticationAdminComponent, initialiseAuthenticationComponent, initialiseInformationComponent, initialiseMimeTypeProcessorComponent, initialiseRestRouteProcessorComponent, initialiseSocketRouteProcessorComponent };

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

@@ -0,0 +1,13 @@
+import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
+import type { AuthenticationAdminComponentConfig } from "../models/config/authenticationAdminComponentConfig";
+import type { IEngineServerConfig } from "../models/IEngineServerConfig";
+/**
+ * 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.
+ */
+export declare function initialiseAuthenticationAdminComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: AuthenticationAdminComponentConfig, overrideInstanceType?: string): string | undefined;

package/dist/types/index.d.ts

@@ -1,14 +1,17 @@
 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";

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

@@ -1,6 +1,7 @@
 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";
@@ -39,5 +40,9 @@ export interface IEngineServerConfig extends IEngineConfig {
          * 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..
+         */
+        authenticationAdminComponent?: IEngineCoreTypeConfig<AuthenticationAdminComponentConfig>[];
     };
 }

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

@@ -0,0 +1,9 @@
+import type { IEntityStorageAuthenticationAdminServiceConstructorOptions } from "@twin.org/api-auth-entity-storage-service";
+import type { AuthenticationAdminComponentType } from "../types/authenticationAdminComponentType";
+/**
+ * Authentication admin component config types.
+ */
+export type AuthenticationAdminComponentConfig = {
+    type: typeof AuthenticationAdminComponentType.EntityStorage;
+    options?: IEntityStorageAuthenticationAdminServiceConstructorOptions;
+};

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

@@ -0,0 +1,13 @@
+/**
+ * Authentication admin component types.
+ */
+export declare const AuthenticationAdminComponentType: {
+    /**
+     * Entity storage.
+     */
+    readonly EntityStorage: "entity-storage";
+};
+/**
+ * Authentication admin component types.
+ */
+export type AuthenticationAdminComponentType = (typeof AuthenticationAdminComponentType)[keyof typeof AuthenticationAdminComponentType];

package/docs/changelog.md

@@ -1,5 +1,27 @@
 # @twin.org/engine-server-types - Changelog
 
+## [0.0.2-next.1](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.2-next.0...engine-server-types-v0.0.2-next.1) (2025-07-11)
+
+
+### Features
+
+* add auth admin component ([201cd06](https://github.com/twinfoundation/engine/commit/201cd061be83afccb5a6b06856ffe7cf8db7d6b3))
+* add federated catalogue ([1b15dd0](https://github.com/twinfoundation/engine/commit/1b15dd059a11446457651c411a73145fab37f025))
+* add mimeTypeProcessors and disableNodeIdentity ([bb7e81e](https://github.com/twinfoundation/engine/commit/bb7e81e2036fe042068a5645ec59b22e20d33aad))
+* add task scheduler ([0951107](https://github.com/twinfoundation/engine/commit/09511073ad042194a45206303f0ef31d8d6af5db))
+* modifying the engine to run the new services ([#10](https://github.com/twinfoundation/engine/issues/10)) ([6f7141f](https://github.com/twinfoundation/engine/commit/6f7141fe0a6d05c725066b274bcc18b5490e580b))
+* switch to devDeps ([32832ac](https://github.com/twinfoundation/engine/commit/32832acd934e1e5569474281a527c9b118d30732))
+* update dependencies ([97c9f64](https://github.com/twinfoundation/engine/commit/97c9f64b6ef096963bcc5de338a2a9e99bdc1a11))
+* use shared store mechanism ([#2](https://github.com/twinfoundation/engine/issues/2)) ([9eed8d7](https://github.com/twinfoundation/engine/commit/9eed8d7766388479b42f03e2542fe761f2156408))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.2-next.0 to 0.0.2-next.1
+    * @twin.org/engine-types bumped from 0.0.2-next.0 to 0.0.2-next.1
+
 ## 0.0.1 (2025-07-11)
 
 

package/docs/reference/functions/initialiseAuthenticationAdminComponent.md

@@ -0,0 +1,41 @@
+# Function: initialiseAuthenticationAdminComponent()
+
+> **initialiseAuthenticationAdminComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
+
+Initialise the authentication admin.
+
+## Parameters
+
+### engineCore
+
+`IEngineCore`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
+
+The engine core.
+
+### context
+
+`IEngineCoreContext`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md)\>
+
+The context for the engine.
+
+### instanceConfig
+
+[`AuthenticationAdminComponentConfig`](../type-aliases/AuthenticationAdminComponentConfig.md)
+
+The instance config.
+
+### overrideInstanceType?
+
+`string`
+
+The instance type to override the default.
+
+## Returns
+
+`undefined` \| `string`
+
+The name of the instance created.
+
+## Throws
+
+GeneralError if the component type is unknown.

package/docs/reference/index.md

@@ -6,11 +6,13 @@
 
 ## Type Aliases
 
+- [AuthenticationAdminComponentConfig](type-aliases/AuthenticationAdminComponentConfig.md)
 - [AuthenticationComponentConfig](type-aliases/AuthenticationComponentConfig.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)
 - [InformationComponentType](type-aliases/InformationComponentType.md)
 - [MimeTypeProcessorType](type-aliases/MimeTypeProcessorType.md)
@@ -19,6 +21,7 @@
 
 ## Variables
 
+- [AuthenticationAdminComponentType](variables/AuthenticationAdminComponentType.md)
 - [AuthenticationComponentType](variables/AuthenticationComponentType.md)
 - [InformationComponentType](variables/InformationComponentType.md)
 - [MimeTypeProcessorType](variables/MimeTypeProcessorType.md)
@@ -28,6 +31,7 @@
 ## Functions
 
 - [initialiseAuthenticationComponent](functions/initialiseAuthenticationComponent.md)
+- [initialiseAuthenticationAdminComponent](functions/initialiseAuthenticationAdminComponent.md)
 - [initialiseInformationComponent](functions/initialiseInformationComponent.md)
 - [initialiseMimeTypeProcessorComponent](functions/initialiseMimeTypeProcessorComponent.md)
 - [initialiseRestRouteProcessorComponent](functions/initialiseRestRouteProcessorComponent.md)

package/docs/reference/interfaces/IEngineServerConfig.md

@@ -54,6 +54,12 @@ Mime type processors options which can be overridden by individual components by
 
 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..
+
 #### Overrides
 
 `IEngineConfig.types`

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

@@ -0,0 +1,17 @@
+# Type Alias: AuthenticationAdminComponentConfig
+
+> **AuthenticationAdminComponentConfig** = `object`
+
+Authentication admin component config types.
+
+## Properties
+
+### type
+
+> **type**: *typeof* [`EntityStorage`](../variables/AuthenticationAdminComponentType.md#entitystorage)
+
+***
+
+### options?
+
+> `optional` **options**: `IEntityStorageAuthenticationAdminServiceConstructorOptions`

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

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

package/docs/reference/variables/AuthenticationAdminComponentType.md

@@ -0,0 +1,13 @@
+# Variable: AuthenticationAdminComponentType
+
+> `const` **AuthenticationAdminComponentType**: `object`
+
+Authentication admin component types.
+
+## Type declaration
+
+### EntityStorage
+
+> `readonly` **EntityStorage**: `"entity-storage"` = `"entity-storage"`
+
+Entity storage.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/engine-server-types",
-	"version": "0.0.1",
+	"version": "0.0.2-next.1",
 	"description": "Server types to use in an engine server.",
 	"repository": {
 		"type": "git",
@@ -21,8 +21,8 @@
 		"@twin.org/api-server-fastify": "next",
 		"@twin.org/api-service": "next",
 		"@twin.org/core": "next",
-		"@twin.org/engine-models": "0.0.1",
-		"@twin.org/engine-types": "0.0.1",
+		"@twin.org/engine-models": "0.0.2-next.1",
+		"@twin.org/engine-types": "0.0.2-next.1",
 		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next"
 	},