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

package/dist/cjs/index.cjs

@@ -1,8 +1,10 @@
 'use strict';
 
+var apiAuthEntityStorageRestClient = require('@twin.org/api-auth-entity-storage-rest-client');
 var apiAuthEntityStorageService = require('@twin.org/api-auth-entity-storage-service');
 var core = require('@twin.org/core');
 var engineTypes = require('@twin.org/engine-types');
+var apiRestClient = require('@twin.org/api-rest-client');
 var apiService = require('@twin.org/api-service');
 var apiModels = require('@twin.org/api-models');
 var apiProcessors = require('@twin.org/api-processors');
@@ -17,7 +19,11 @@ const AuthenticationComponentType = {
     /**
      * Entity storage.
      */
-    EntityStorage: "entity-storage"
+    EntityStorage: "entity-storage",
+    /**
+     * REST client.
+     */
+    RestClient: "rest-client"
 };
 
 /**
@@ -44,7 +50,11 @@ function initialiseAuthenticationComponent(engineCore, context, instanceConfig,
             authenticationAdminServiceType: context.defaultTypes.authenticationAdminComponent,
             ...instanceConfig.options
         });
-        instanceType = apiAuthEntityStorageService.EntityStorageAuthenticationService.NAMESPACE;
+        instanceType = core.StringHelper.kebabCase("EntityStorageAuthenticationService");
+    }
+    else if (type === AuthenticationComponentType.RestClient) {
+        component = new apiAuthEntityStorageRestClient.EntityStorageAuthenticationClient(instanceConfig.options);
+        instanceType = core.StringHelper.kebabCase("EntityStorageAuthenticationClient");
     }
     else {
         throw new core.GeneralError("engineCore", "componentUnknownType", {
@@ -96,7 +106,7 @@ function initialiseAuthenticationAdminComponent(engineCore, context, instanceCon
         component = new apiAuthEntityStorageService.EntityStorageAuthenticationAdminService({
             ...instanceConfig.options
         });
-        instanceType = apiAuthEntityStorageService.EntityStorageAuthenticationAdminService.NAMESPACE;
+        instanceType = core.StringHelper.kebabCase("EntityStorageAuthenticationAdminService");
     }
     else {
         throw new core.GeneralError("engineCore", "componentUnknownType", {
@@ -123,7 +133,11 @@ const InformationComponentType = {
     /**
      * Service.
      */
-    Service: "service"
+    Service: "service",
+    /**
+     * REST client.
+     */
+    RestClient: "rest-client"
 };
 
 /**
@@ -144,7 +158,11 @@ function initialiseInformationComponent(engineCore, context, instanceConfig, ove
     let instanceType;
     if (type === InformationComponentType.Service) {
         component = new apiService.InformationService(instanceConfig.options);
-        instanceType = apiService.InformationService.NAMESPACE;
+        instanceType = core.StringHelper.kebabCase("InformationService");
+    }
+    else if (type === InformationComponentType.RestClient) {
+        component = new apiRestClient.InformationClient(instanceConfig.options);
+        instanceType = core.StringHelper.kebabCase("InformationClient");
     }
     else {
         throw new core.GeneralError("engineCore", "componentUnknownType", {
@@ -194,7 +212,7 @@ function initialiseMimeTypeProcessorComponent(engineCore, context, instanceConfi
     let instanceType;
     if (type === MimeTypeProcessorType.Jwt) {
         component = new apiProcessors.JwtMimeTypeProcessor();
-        instanceType = apiProcessors.JwtMimeTypeProcessor.NAMESPACE;
+        instanceType = core.StringHelper.kebabCase("JwtMimeTypeProcessor");
     }
     else {
         throw new core.GeneralError("engineCore", "componentUnknownType", {
@@ -265,7 +283,7 @@ function initialiseRestRouteProcessorComponent(engineCore, context, instanceConf
                 ...instanceConfig.options?.config
             }
         });
-        instanceType = apiAuthEntityStorageService.AuthHeaderProcessor.NAMESPACE;
+        instanceType = core.StringHelper.kebabCase("AuthHeaderProcessor");
     }
     else if (type === RestRouteProcessorType.Logging) {
         component = new apiProcessors.LoggingProcessor({
@@ -274,19 +292,19 @@ function initialiseRestRouteProcessorComponent(engineCore, context, instanceConf
                 ...instanceConfig.options?.config
             }
         });
-        instanceType = apiProcessors.LoggingProcessor.NAMESPACE;
+        instanceType = core.StringHelper.kebabCase("LoggingProcessor");
     }
     else if (type === RestRouteProcessorType.NodeIdentity) {
         component = new apiProcessors.NodeIdentityProcessor();
-        instanceType = apiProcessors.NodeIdentityProcessor.NAMESPACE;
+        instanceType = core.StringHelper.kebabCase("NodeIdentityProcessor");
     }
     else if (type === RestRouteProcessorType.StaticUserIdentity) {
         component = new apiProcessors.StaticUserIdentityProcessor(instanceConfig.options);
-        instanceType = apiProcessors.StaticUserIdentityProcessor.NAMESPACE;
+        instanceType = core.StringHelper.kebabCase("StaticUserIdentityProcessor");
     }
     else if (type === RestRouteProcessorType.RestRoute) {
         component = new apiProcessors.RestRouteProcessor(instanceConfig.options);
-        instanceType = apiProcessors.RestRouteProcessor.NAMESPACE;
+        instanceType = core.StringHelper.kebabCase("RestRouteProcessor");
     }
     else {
         throw new core.GeneralError("engineCore", "componentUnknownType", {
@@ -357,7 +375,7 @@ function initialiseSocketRouteProcessorComponent(engineCore, context, instanceCo
                 ...instanceConfig.options?.config
             }
         });
-        instanceType = apiAuthEntityStorageService.AuthHeaderProcessor.NAMESPACE;
+        instanceType = core.StringHelper.kebabCase("AuthHeaderProcessor");
     }
     else if (type === SocketRouteProcessorType.Logging) {
         component = new apiProcessors.LoggingProcessor({
@@ -366,19 +384,19 @@ function initialiseSocketRouteProcessorComponent(engineCore, context, instanceCo
                 ...instanceConfig.options?.config
             }
         });
-        instanceType = apiProcessors.LoggingProcessor.NAMESPACE;
+        instanceType = core.StringHelper.kebabCase("LoggingProcessor");
     }
     else if (type === SocketRouteProcessorType.NodeIdentity) {
         component = new apiProcessors.NodeIdentityProcessor();
-        instanceType = apiProcessors.NodeIdentityProcessor.NAMESPACE;
+        instanceType = core.StringHelper.kebabCase("NodeIdentityProcessor");
     }
     else if (type === SocketRouteProcessorType.StaticUserIdentity) {
         component = new apiProcessors.StaticUserIdentityProcessor(instanceConfig.options);
-        instanceType = apiProcessors.StaticUserIdentityProcessor.NAMESPACE;
+        instanceType = core.StringHelper.kebabCase("StaticUserIdentityProcessor");
     }
     else if (type === SocketRouteProcessorType.SocketRoute) {
         component = new apiProcessors.SocketRouteProcessor(instanceConfig.options);
-        instanceType = apiProcessors.SocketRouteProcessor.NAMESPACE;
+        instanceType = core.StringHelper.kebabCase("SocketRouteProcessor");
     }
     else {
         throw new core.GeneralError("engineCore", "componentUnknownType", {

package/dist/esm/index.mjs

@@ -1,6 +1,8 @@
+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, GeneralError, ComponentFactory } from '@twin.org/core';
+import { I18n, StringHelper, GeneralError, 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';
@@ -15,7 +17,11 @@ const AuthenticationComponentType = {
     /**
      * Entity storage.
      */
-    EntityStorage: "entity-storage"
+    EntityStorage: "entity-storage",
+    /**
+     * REST client.
+     */
+    RestClient: "rest-client"
 };
 
 /**
@@ -42,7 +48,11 @@ function initialiseAuthenticationComponent(engineCore, context, instanceConfig,
             authenticationAdminServiceType: context.defaultTypes.authenticationAdminComponent,
             ...instanceConfig.options
         });
-        instanceType = EntityStorageAuthenticationService.NAMESPACE;
+        instanceType = StringHelper.kebabCase("EntityStorageAuthenticationService");
+    }
+    else if (type === AuthenticationComponentType.RestClient) {
+        component = new EntityStorageAuthenticationClient(instanceConfig.options);
+        instanceType = StringHelper.kebabCase("EntityStorageAuthenticationClient");
     }
     else {
         throw new GeneralError("engineCore", "componentUnknownType", {
@@ -94,7 +104,7 @@ function initialiseAuthenticationAdminComponent(engineCore, context, instanceCon
         component = new EntityStorageAuthenticationAdminService({
             ...instanceConfig.options
         });
-        instanceType = EntityStorageAuthenticationAdminService.NAMESPACE;
+        instanceType = StringHelper.kebabCase("EntityStorageAuthenticationAdminService");
     }
     else {
         throw new GeneralError("engineCore", "componentUnknownType", {
@@ -121,7 +131,11 @@ const InformationComponentType = {
     /**
      * Service.
      */
-    Service: "service"
+    Service: "service",
+    /**
+     * REST client.
+     */
+    RestClient: "rest-client"
 };
 
 /**
@@ -142,7 +156,11 @@ function initialiseInformationComponent(engineCore, context, instanceConfig, ove
     let instanceType;
     if (type === InformationComponentType.Service) {
         component = new InformationService(instanceConfig.options);
-        instanceType = InformationService.NAMESPACE;
+        instanceType = StringHelper.kebabCase("InformationService");
+    }
+    else if (type === InformationComponentType.RestClient) {
+        component = new InformationClient(instanceConfig.options);
+        instanceType = StringHelper.kebabCase("InformationClient");
     }
     else {
         throw new GeneralError("engineCore", "componentUnknownType", {
@@ -192,7 +210,7 @@ function initialiseMimeTypeProcessorComponent(engineCore, context, instanceConfi
     let instanceType;
     if (type === MimeTypeProcessorType.Jwt) {
         component = new JwtMimeTypeProcessor();
-        instanceType = JwtMimeTypeProcessor.NAMESPACE;
+        instanceType = StringHelper.kebabCase("JwtMimeTypeProcessor");
     }
     else {
         throw new GeneralError("engineCore", "componentUnknownType", {
@@ -263,7 +281,7 @@ function initialiseRestRouteProcessorComponent(engineCore, context, instanceConf
                 ...instanceConfig.options?.config
             }
         });
-        instanceType = AuthHeaderProcessor.NAMESPACE;
+        instanceType = StringHelper.kebabCase("AuthHeaderProcessor");
     }
     else if (type === RestRouteProcessorType.Logging) {
         component = new LoggingProcessor({
@@ -272,19 +290,19 @@ function initialiseRestRouteProcessorComponent(engineCore, context, instanceConf
                 ...instanceConfig.options?.config
             }
         });
-        instanceType = LoggingProcessor.NAMESPACE;
+        instanceType = StringHelper.kebabCase("LoggingProcessor");
     }
     else if (type === RestRouteProcessorType.NodeIdentity) {
         component = new NodeIdentityProcessor();
-        instanceType = NodeIdentityProcessor.NAMESPACE;
+        instanceType = StringHelper.kebabCase("NodeIdentityProcessor");
     }
     else if (type === RestRouteProcessorType.StaticUserIdentity) {
         component = new StaticUserIdentityProcessor(instanceConfig.options);
-        instanceType = StaticUserIdentityProcessor.NAMESPACE;
+        instanceType = StringHelper.kebabCase("StaticUserIdentityProcessor");
     }
     else if (type === RestRouteProcessorType.RestRoute) {
         component = new RestRouteProcessor(instanceConfig.options);
-        instanceType = RestRouteProcessor.NAMESPACE;
+        instanceType = StringHelper.kebabCase("RestRouteProcessor");
     }
     else {
         throw new GeneralError("engineCore", "componentUnknownType", {
@@ -355,7 +373,7 @@ function initialiseSocketRouteProcessorComponent(engineCore, context, instanceCo
                 ...instanceConfig.options?.config
             }
         });
-        instanceType = AuthHeaderProcessor.NAMESPACE;
+        instanceType = StringHelper.kebabCase("AuthHeaderProcessor");
     }
     else if (type === SocketRouteProcessorType.Logging) {
         component = new LoggingProcessor({
@@ -364,19 +382,19 @@ function initialiseSocketRouteProcessorComponent(engineCore, context, instanceCo
                 ...instanceConfig.options?.config
             }
         });
-        instanceType = LoggingProcessor.NAMESPACE;
+        instanceType = StringHelper.kebabCase("LoggingProcessor");
     }
     else if (type === SocketRouteProcessorType.NodeIdentity) {
         component = new NodeIdentityProcessor();
-        instanceType = NodeIdentityProcessor.NAMESPACE;
+        instanceType = StringHelper.kebabCase("NodeIdentityProcessor");
     }
     else if (type === SocketRouteProcessorType.StaticUserIdentity) {
         component = new StaticUserIdentityProcessor(instanceConfig.options);
-        instanceType = StaticUserIdentityProcessor.NAMESPACE;
+        instanceType = StringHelper.kebabCase("StaticUserIdentityProcessor");
     }
     else if (type === SocketRouteProcessorType.SocketRoute) {
         component = new SocketRouteProcessor(instanceConfig.options);
-        instanceType = SocketRouteProcessor.NAMESPACE;
+        instanceType = StringHelper.kebabCase("SocketRouteProcessor");
     }
     else {
         throw new GeneralError("engineCore", "componentUnknownType", {

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

@@ -1,4 +1,4 @@
-import type { IEngineCoreContext, IEngineCore } from "@twin.org/engine-models";
+import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
 import type { AuthenticationComponentConfig } from "../models/config/authenticationComponentConfig";
 import type { IEngineServerConfig } from "../models/IEngineServerConfig";
 /**

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

@@ -1,4 +1,5 @@
 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";
 /**
  * Authentication component config types.
@@ -6,4 +7,7 @@ import type { AuthenticationComponentType } from "../types/authenticationCompone
 export type AuthenticationComponentConfig = {
     type: typeof AuthenticationComponentType.EntityStorage;
     options?: IEntityStorageAuthenticationServiceConstructorOptions;
+} | {
+    type: typeof AuthenticationComponentType.RestClient;
+    options: IBaseRestClientConfig;
 };

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

@@ -1,3 +1,4 @@
+import type { IBaseRestClientConfig } from "@twin.org/api-models";
 import type { IInformationServiceConstructorOptions } from "@twin.org/api-service";
 import type { InformationComponentType } from "../types/informationComponentType";
 /**
@@ -6,4 +7,7 @@ import type { InformationComponentType } from "../types/informationComponentType
 export type InformationComponentConfig = {
     type: typeof InformationComponentType.Service;
     options: IInformationServiceConstructorOptions;
+} | {
+    type: typeof InformationComponentType.RestClient;
+    options: IBaseRestClientConfig;
 };

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

@@ -6,6 +6,10 @@ export declare const AuthenticationComponentType: {
      * Entity storage.
      */
     readonly EntityStorage: "entity-storage";
+    /**
+     * REST client.
+     */
+    readonly RestClient: "rest-client";
 };
 /**
  * Authentication component types.

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

@@ -6,6 +6,10 @@ export declare const InformationComponentType: {
      * Service.
      */
     readonly Service: "service";
+    /**
+     * REST client.
+     */
+    readonly RestClient: "rest-client";
 };
 /**
  * Information component types.

package/docs/changelog.md

@@ -1,5 +1,20 @@
 # @twin.org/engine-server-types - Changelog
 
+## [0.0.2-next.2](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.2-next.1...engine-server-types-v0.0.2-next.2) (2025-07-21)
+
+
+### Features
+
+* add rest clients as components ([c6f956a](https://github.com/twinfoundation/engine/commit/c6f956afe4fc22cd552174539c92a109448dc242))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.2-next.1 to 0.0.2-next.2
+    * @twin.org/engine-types bumped from 0.0.2-next.1 to 0.0.2-next.2
+
 ## [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)
 
 

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

@@ -1,17 +1,5 @@
 # Type Alias: AuthenticationComponentConfig
 
-> **AuthenticationComponentConfig** = `object`
+> **AuthenticationComponentConfig** = \{ `type`: *typeof* [`EntityStorage`](../variables/AuthenticationComponentType.md#entitystorage); `options?`: `IEntityStorageAuthenticationServiceConstructorOptions`; \} \| \{ `type`: *typeof* [`RestClient`](../variables/AuthenticationComponentType.md#restclient); `options`: `IBaseRestClientConfig`; \}
 
 Authentication component config types.
-
-## Properties
-
-### type
-
-> **type**: *typeof* [`EntityStorage`](../variables/AuthenticationComponentType.md#entitystorage)
-
-***
-
-### options?
-
-> `optional` **options**: `IEntityStorageAuthenticationServiceConstructorOptions`

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

@@ -1,17 +1,5 @@
 # Type Alias: InformationComponentConfig
 
-> **InformationComponentConfig** = `object`
+> **InformationComponentConfig** = \{ `type`: *typeof* [`Service`](../variables/InformationComponentType.md#service); `options`: `IInformationServiceConstructorOptions`; \} \| \{ `type`: *typeof* [`RestClient`](../variables/InformationComponentType.md#restclient); `options`: `IBaseRestClientConfig`; \}
 
 Information component config types.
-
-## Properties
-
-### type
-
-> **type**: *typeof* [`Service`](../variables/InformationComponentType.md#service)
-
-***
-
-### options
-
-> **options**: `IInformationServiceConstructorOptions`

package/docs/reference/variables/AuthenticationComponentType.md

@@ -11,3 +11,9 @@ Authentication component types.
 > `readonly` **EntityStorage**: `"entity-storage"` = `"entity-storage"`
 
 Entity storage.
+
+### RestClient
+
+> `readonly` **RestClient**: `"rest-client"` = `"rest-client"`
+
+REST client.

package/docs/reference/variables/InformationComponentType.md

@@ -11,3 +11,9 @@ Information component types.
 > `readonly` **Service**: `"service"` = `"service"`
 
 Service.
+
+### RestClient
+
+> `readonly` **RestClient**: `"rest-client"` = `"rest-client"`
+
+REST client.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/engine-server-types",
-	"version": "0.0.2-next.1",
+	"version": "0.0.2-next.2",
 	"description": "Server types to use in an engine server.",
 	"repository": {
 		"type": "git",
@@ -14,15 +14,17 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
+		"@twin.org/api-auth-entity-storage-rest-client": "next",
 		"@twin.org/api-auth-entity-storage-service": "next",
 		"@twin.org/api-core": "next",
 		"@twin.org/api-models": "next",
 		"@twin.org/api-processors": "next",
+		"@twin.org/api-rest-client": "next",
 		"@twin.org/api-server-fastify": "next",
 		"@twin.org/api-service": "next",
 		"@twin.org/core": "next",
-		"@twin.org/engine-models": "0.0.2-next.1",
-		"@twin.org/engine-types": "0.0.2-next.1",
+		"@twin.org/engine-models": "0.0.2-next.2",
+		"@twin.org/engine-types": "0.0.2-next.2",
 		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next"
 	},