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

package/docs/reference/functions/addDefaultRestPaths.md

@@ -0,0 +1,17 @@
+# Function: addDefaultRestPaths()
+
+> **addDefaultRestPaths**(`serverConfig`): `void`
+
+Adds the rest paths to the server config.
+
+## Parameters
+
+### serverConfig
+
+`IEngineServerConfig`
+
+The server config.
+
+## Returns
+
+`void`

package/docs/reference/functions/addDefaultSocketPaths.md

@@ -0,0 +1,17 @@
+# Function: addDefaultSocketPaths()
+
+> **addDefaultSocketPaths**(`serverConfig`): `void`
+
+Adds the socket paths to the server config.
+
+## Parameters
+
+### serverConfig
+
+`IEngineServerConfig`
+
+The server config.
+
+## Returns
+
+`void`

package/docs/reference/index.md

@@ -4,10 +4,7 @@
 
 - [EngineServer](classes/EngineServer.md)
 
-## Interfaces
-
-- [IEngineServerEnvironmentVariables](interfaces/IEngineServerEnvironmentVariables.md)
-
 ## Functions
 
-- [buildEngineServerConfiguration](functions/buildEngineServerConfiguration.md)
+- [addDefaultRestPaths](functions/addDefaultRestPaths.md)
+- [addDefaultSocketPaths](functions/addDefaultSocketPaths.md)

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/engine-server",
-	"version": "0.0.1-next.9",
+	"version": "0.0.2-next.1",
 	"description": "Engine implementation for a server.",
 	"repository": {
 		"type": "git",
@@ -14,83 +14,23 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@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-server-fastify": "next",
-		"@twin.org/api-service": "next",
-		"@twin.org/attestation-connector-entity-storage": "next",
-		"@twin.org/attestation-connector-iota": "next",
-		"@twin.org/attestation-models": "next",
-		"@twin.org/attestation-service": "next",
-		"@twin.org/auditable-item-graph-models": "next",
-		"@twin.org/auditable-item-graph-service": "next",
-		"@twin.org/auditable-item-stream-models": "next",
-		"@twin.org/auditable-item-stream-service": "next",
-		"@twin.org/background-task-connector-entity-storage": "next",
-		"@twin.org/background-task-models": "next",
-		"@twin.org/blob-storage-connector-aws-s3": "next",
-		"@twin.org/blob-storage-connector-azure": "next",
-		"@twin.org/blob-storage-connector-file": "next",
-		"@twin.org/blob-storage-connector-gcp": "next",
-		"@twin.org/blob-storage-connector-ipfs": "next",
-		"@twin.org/blob-storage-connector-memory": "next",
-		"@twin.org/blob-storage-models": "next",
-		"@twin.org/blob-storage-service": "next",
-		"@twin.org/cli-core": "next",
 		"@twin.org/core": "next",
-		"@twin.org/crypto": "next",
-		"@twin.org/data-core": "next",
-		"@twin.org/data-schema-org": "next",
-		"@twin.org/engine-core": "0.0.1-next.9",
-		"@twin.org/engine-models": "0.0.1-next.9",
-		"@twin.org/entity": "next",
-		"@twin.org/entity-storage-connector-cosmosdb": "next",
-		"@twin.org/entity-storage-connector-dynamodb": "next",
-		"@twin.org/entity-storage-connector-file": "next",
-		"@twin.org/entity-storage-connector-gcp-firestore": "next",
-		"@twin.org/entity-storage-connector-memory": "next",
-		"@twin.org/entity-storage-connector-scylladb": "next",
-		"@twin.org/entity-storage-models": "next",
-		"@twin.org/entity-storage-service": "next",
-		"@twin.org/identity-connector-entity-storage": "next",
-		"@twin.org/identity-connector-iota": "next",
-		"@twin.org/identity-models": "next",
-		"@twin.org/identity-service": "next",
-		"@twin.org/immutable-proof-models": "next",
-		"@twin.org/immutable-proof-service": "next",
-		"@twin.org/immutable-storage-connector-entity-storage": "next",
-		"@twin.org/immutable-storage-connector-iota": "next",
-		"@twin.org/immutable-storage-models": "next",
-		"@twin.org/logging-connector-console": "next",
-		"@twin.org/logging-connector-entity-storage": "next",
-		"@twin.org/logging-models": "next",
-		"@twin.org/logging-service": "next",
-		"@twin.org/nameof": "next",
-		"@twin.org/nft-connector-entity-storage": "next",
-		"@twin.org/nft-connector-iota": "next",
-		"@twin.org/nft-models": "next",
-		"@twin.org/nft-service": "next",
-		"@twin.org/telemetry-connector-entity-storage": "next",
-		"@twin.org/telemetry-models": "next",
-		"@twin.org/telemetry-service": "next",
-		"@twin.org/vault-connector-entity-storage": "next",
-		"@twin.org/vault-connector-hashicorp": "next",
-		"@twin.org/vault-models": "next",
-		"@twin.org/wallet-connector-entity-storage": "next",
-		"@twin.org/wallet-connector-iota": "next",
-		"@twin.org/wallet-models": "next",
-		"@twin.org/web": "next"
+		"@twin.org/engine-core": "0.0.2-next.1",
+		"@twin.org/engine-models": "0.0.2-next.1",
+		"@twin.org/engine-server-types": "0.0.2-next.1",
+		"@twin.org/modules": "next",
+		"@twin.org/nameof": "next"
 	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
+			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs",
-			"types": "./dist/types/index.d.ts"
+			"import": "./dist/esm/index.mjs"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},

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

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

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

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

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

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

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

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

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

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

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

@@ -1,41 +0,0 @@
-/**
- * The engine server environment variables.
- */
-export interface IEngineServerEnvironmentVariables {
-    /**
-     * The name of the admin user.
-     */
-    adminUsername: string;
-    /**
-     * The port to serve the API from.
-     */
-    port: string;
-    /**
-     * The host to serve the API from.
-     */
-    host: string;
-    /**
-     * The CORS origins to allow, defaults to *.
-     */
-    corsOrigins: string;
-    /**
-     * The CORS methods to allow, defaults to GET, POST, PUT, DELETE, OPTIONS.
-     */
-    httpMethods: string;
-    /**
-     * The CORS headers to allow.
-     */
-    httpAllowedHeaders: string;
-    /**
-     * The CORS headers to expose.
-     */
-    httpExposedHeaders: string;
-    /**
-     * The type of auth processor to use on the API: entity-storage.
-     */
-    authProcessorType: string;
-    /**
-     * The id of the key in the vault to use for signing in auth operations.
-     */
-    authSigningKeyId: string;
-}

package/dist/types/utils/engineServerEnvBuilder.d.ts

@@ -1,11 +0,0 @@
-import type { IServerInfo } from "@twin.org/api-models";
-import { type IEngineCoreConfig, type IEngineServerConfig } from "@twin.org/engine-models";
-import type { IEngineServerEnvironmentVariables } from "../models/IEngineServerEnvironmentVariables";
-/**
- * Handles the configuration of the server.
- * @param envVars The environment variables.
- * @param coreEngineConfig The core engine config.
- * @param serverInfo The server information.
- * @returns The the config for the core and the server.
- */
-export declare function buildEngineServerConfiguration(envVars: IEngineServerEnvironmentVariables, coreEngineConfig: IEngineCoreConfig, serverInfo: IServerInfo): IEngineServerConfig;

package/docs/reference/functions/buildEngineServerConfiguration.md

@@ -1,25 +0,0 @@
-# Function: buildEngineServerConfiguration()
-
-> **buildEngineServerConfiguration**(`envVars`, `coreEngineConfig`, `serverInfo`): `IEngineServerConfig`
-
-Handles the configuration of the server.
-
-## Parameters
-
-• **envVars**: [`IEngineServerEnvironmentVariables`](../interfaces/IEngineServerEnvironmentVariables.md)
-
-The environment variables.
-
-• **coreEngineConfig**: `IEngineCoreConfig`
-
-The core engine config.
-
-• **serverInfo**: `IServerInfo`
-
-The server information.
-
-## Returns
-
-`IEngineServerConfig`
-
-The the config for the core and the server.

package/docs/reference/interfaces/IEngineServerEnvironmentVariables.md

@@ -1,75 +0,0 @@
-# Interface: IEngineServerEnvironmentVariables
-
-The engine server environment variables.
-
-## Properties
-
-### adminUsername
-
-> **adminUsername**: `string`
-
-The name of the admin user.
-
-***
-
-### port
-
-> **port**: `string`
-
-The port to serve the API from.
-
-***
-
-### host
-
-> **host**: `string`
-
-The host to serve the API from.
-
-***
-
-### corsOrigins
-
-> **corsOrigins**: `string`
-
-The CORS origins to allow, defaults to *.
-
-***
-
-### httpMethods
-
-> **httpMethods**: `string`
-
-The CORS methods to allow, defaults to GET, POST, PUT, DELETE, OPTIONS.
-
-***
-
-### httpAllowedHeaders
-
-> **httpAllowedHeaders**: `string`
-
-The CORS headers to allow.
-
-***
-
-### httpExposedHeaders
-
-> **httpExposedHeaders**: `string`
-
-The CORS headers to expose.
-
-***
-
-### authProcessorType
-
-> **authProcessorType**: `string`
-
-The type of auth processor to use on the API: entity-storage.
-
-***
-
-### authSigningKeyId
-
-> **authSigningKeyId**: `string`
-
-The id of the key in the vault to use for signing in auth operations.