@twin.org/engine-server-types 0.0.1-next.14 → 0.0.1-next.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (16) hide show
  1. package/dist/types/components/authentication.d.ts +2 -2
  2. package/dist/types/components/information.d.ts +2 -2
  3. package/dist/types/components/mimeTypeProcessor.d.ts +2 -2
  4. package/dist/types/components/restRouteProcessor.d.ts +2 -2
  5. package/dist/types/components/socketRouteProcessor.d.ts +2 -2
  6. package/dist/types/index.d.ts +1 -1
  7. package/dist/types/models/{IEngineServerTypesConfig.d.ts → IEngineServerConfig.d.ts} +3 -3
  8. package/docs/changelog.md +1 -1
  9. package/docs/reference/functions/initialiseAuthenticationComponent.md +2 -2
  10. package/docs/reference/functions/initialiseInformationComponent.md +2 -2
  11. package/docs/reference/functions/initialiseMimeTypeProcessorComponent.md +2 -2
  12. package/docs/reference/functions/initialiseRestRouteProcessorComponent.md +2 -2
  13. package/docs/reference/functions/initialiseSocketRouteProcessorComponent.md +2 -2
  14. package/docs/reference/index.md +1 -1
  15. package/docs/reference/interfaces/{IEngineServerTypesConfig.md → IEngineServerConfig.md} +3 -3
  16. package/package.json +3 -3
package/dist/types/components/authentication.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import type { IEngineCoreContext, IEngineCore } from "@twin.org/engine-models";
2
2
  import type { AuthenticationComponentConfig } from "../models/config/authenticationComponentConfig";
3
- import type { IEngineServerTypesConfig } from "../models/IEngineServerTypesConfig";
3
+ import type { IEngineServerConfig } from "../models/IEngineServerConfig";
4
4
  /**
5
5
  * Initialise the authentication.
6
6
  * @param engineCore The engine core.
@@ -10,4 +10,4 @@ import type { IEngineServerTypesConfig } from "../models/IEngineServerTypesConfi
10
10
  * @returns The name of the instance created.
11
11
  * @throws GeneralError if the component type is unknown.
12
12
  */
13
- export declare function initialiseAuthenticationComponent(engineCore: IEngineCore<IEngineServerTypesConfig>, context: IEngineCoreContext<IEngineServerTypesConfig>, instanceConfig: AuthenticationComponentConfig, overrideInstanceType?: string): string | undefined;
13
+ export declare function initialiseAuthenticationComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: AuthenticationComponentConfig, overrideInstanceType?: string): string | undefined;
package/dist/types/components/information.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
2
2
  import type { InformationComponentConfig } from "../models/config/informationComponentConfig";
3
- import type { IEngineServerTypesConfig } from "../models/IEngineServerTypesConfig";
3
+ import type { IEngineServerConfig } from "../models/IEngineServerConfig";
4
4
  /**
5
5
  * Initialise the information component.
6
6
  * @param engineCore The engine core.
@@ -10,4 +10,4 @@ import type { IEngineServerTypesConfig } from "../models/IEngineServerTypesConfi
10
10
  * @returns The name of the instance created.
11
11
  * @throws GeneralError if the component type is unknown.
12
12
  */
13
- export declare function initialiseInformationComponent(engineCore: IEngineCore<IEngineServerTypesConfig>, context: IEngineCoreContext<IEngineServerTypesConfig>, instanceConfig: InformationComponentConfig, overrideInstanceType?: string): string | undefined;
13
+ export declare function initialiseInformationComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: InformationComponentConfig, overrideInstanceType?: string): string | undefined;
package/dist/types/components/mimeTypeProcessor.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
2
2
  import type { MimeTypeProcessorConfig } from "../models/config/mimeTypeProcessorConfig";
3
- import type { IEngineServerTypesConfig } from "../models/IEngineServerTypesConfig";
3
+ import type { IEngineServerConfig } from "../models/IEngineServerConfig";
4
4
  /**
5
5
  * Initialise the mime type processor.
6
6
  * @param engineCore The engine core.
@@ -10,4 +10,4 @@ import type { IEngineServerTypesConfig } from "../models/IEngineServerTypesConfi
10
10
  * @returns The name of the instance created.
11
11
  * @throws GeneralError if the component type is unknown.
12
12
  */
13
- export declare function initialiseMimeTypeProcessorComponent(engineCore: IEngineCore<IEngineServerTypesConfig>, context: IEngineCoreContext<IEngineServerTypesConfig>, instanceConfig: MimeTypeProcessorConfig, overrideInstanceType?: string): string | undefined;
13
+ export declare function initialiseMimeTypeProcessorComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: MimeTypeProcessorConfig, overrideInstanceType?: string): string | undefined;
package/dist/types/components/restRouteProcessor.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import type { IEngineCoreContext, IEngineCore } from "@twin.org/engine-models";
2
2
  import type { RestRouteProcessorConfig } from "../models/config/restRouteProcessorConfig";
3
- import type { IEngineServerTypesConfig } from "../models/IEngineServerTypesConfig";
3
+ import type { IEngineServerConfig } from "../models/IEngineServerConfig";
4
4
  /**
5
5
  * Initialise the rest route processor.
6
6
  * @param engineCore The engine core.
@@ -10,4 +10,4 @@ import type { IEngineServerTypesConfig } from "../models/IEngineServerTypesConfi
10
10
  * @returns The name of the instance created.
11
11
  * @throws GeneralError if the component type is unknown.
12
12
  */
13
- export declare function initialiseRestRouteProcessorComponent(engineCore: IEngineCore<IEngineServerTypesConfig>, context: IEngineCoreContext<IEngineServerTypesConfig>, instanceConfig: RestRouteProcessorConfig, overrideInstanceType?: string): string | undefined;
13
+ export declare function initialiseRestRouteProcessorComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: RestRouteProcessorConfig, overrideInstanceType?: string): string | undefined;
package/dist/types/components/socketRouteProcessor.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
2
2
  import type { SocketRouteProcessorConfig } from "../models/config/socketRouteProcessorConfig";
3
- import type { IEngineServerTypesConfig } from "../models/IEngineServerTypesConfig";
3
+ import type { IEngineServerConfig } from "../models/IEngineServerConfig";
4
4
  /**
5
5
  * Initialise the socket route processor.
6
6
  * @param engineCore The engine core.
@@ -10,4 +10,4 @@ import type { IEngineServerTypesConfig } from "../models/IEngineServerTypesConfi
10
10
  * @returns The name of the instance created.
11
11
  * @throws GeneralError if the component type is unknown.
12
12
  */
13
- export declare function initialiseSocketRouteProcessorComponent(engineCore: IEngineCore<IEngineServerTypesConfig>, context: IEngineCoreContext<IEngineServerTypesConfig>, instanceConfig: SocketRouteProcessorConfig, overrideInstanceType?: string): string | undefined;
13
+ export declare function initialiseSocketRouteProcessorComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: SocketRouteProcessorConfig, overrideInstanceType?: string): string | undefined;
package/dist/types/index.d.ts CHANGED
@@ -8,7 +8,7 @@ export * from "./models/config/informationComponentConfig";
8
8
  export * from "./models/config/mimeTypeProcessorConfig";
9
9
  export * from "./models/config/restRouteProcessorConfig";
10
10
  export * from "./models/config/socketRouteProcessorConfig";
11
- export * from "./models/IEngineServerTypesConfig";
11
+ export * from "./models/IEngineServerConfig";
12
12
  export * from "./models/types/authenticationComponentType";
13
13
  export * from "./models/types/informationComponentType";
14
14
  export * from "./models/types/mimeTypeProcessorType";
package/dist/types/models/{IEngineServerTypesConfig.d.ts → IEngineServerConfig.d.ts} RENAMED
@@ -1,6 +1,6 @@
1
1
  import type { IWebServerOptions } from "@twin.org/api-models";
2
2
  import type { IEngineCoreTypeConfig } from "@twin.org/engine-models";
3
- import type { IEngineCoreTypesConfig } from "@twin.org/engine-types";
3
+ import type { IEngineConfig } from "@twin.org/engine-types";
4
4
  import type { AuthenticationComponentConfig } from "./config/authenticationComponentConfig";
5
5
  import type { InformationComponentConfig } from "./config/informationComponentConfig";
6
6
  import type { MimeTypeProcessorConfig } from "./config/mimeTypeProcessorConfig";
@@ -9,7 +9,7 @@ import type { SocketRouteProcessorConfig } from "./config/socketRouteProcessorCo
9
9
  /**
10
10
  * Extended engine server config with known types.
11
11
  */
12
- export interface IEngineServerTypesConfig extends IEngineCoreTypesConfig {
12
+ export interface IEngineServerConfig extends IEngineConfig {
13
13
  /**
14
14
  * Configuration for the web server.
15
15
  */
@@ -17,7 +17,7 @@ export interface IEngineServerTypesConfig extends IEngineCoreTypesConfig {
17
17
  /**
18
18
  * The types to initialise in the engine.
19
19
  */
20
- types: IEngineCoreTypesConfig["types"] & {
20
+ types: IEngineConfig["types"] & {
21
21
  [type: string]: IEngineCoreTypeConfig[] | undefined;
22
22
  /**
23
23
  * Information component options which can be overridden by individual components by specifying types other than default..
package/docs/changelog.md CHANGED
@@ -1,5 +1,5 @@
1
1
  # @twin.org/engine-server-types - Changelog
2
2
 
3
- ## v0.0.1-next.14
3
+ ## v0.0.1-next.15
4
4
 
5
5
  - Initial Release
package/docs/reference/functions/initialiseAuthenticationComponent.md CHANGED
@@ -6,11 +6,11 @@ Initialise the authentication.
6
6
 
7
7
  ## Parameters
8
8
 
9
- • **engineCore**: `IEngineCore`\<[`IEngineServerTypesConfig`](../interfaces/IEngineServerTypesConfig.md), `IEngineState`\>
9
+ • **engineCore**: `IEngineCore`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md), `IEngineState`\>
10
10
 
11
11
  The engine core.
12
12
 
13
- • **context**: `IEngineCoreContext`\<[`IEngineServerTypesConfig`](../interfaces/IEngineServerTypesConfig.md), `IEngineState`\>
13
+ • **context**: `IEngineCoreContext`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md), `IEngineState`\>
14
14
 
15
15
  The context for the engine.
16
16
 
package/docs/reference/functions/initialiseInformationComponent.md CHANGED
@@ -6,11 +6,11 @@ Initialise the information component.
6
6
 
7
7
  ## Parameters
8
8
 
9
- • **engineCore**: `IEngineCore`\<[`IEngineServerTypesConfig`](../interfaces/IEngineServerTypesConfig.md), `IEngineState`\>
9
+ • **engineCore**: `IEngineCore`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md), `IEngineState`\>
10
10
 
11
11
  The engine core.
12
12
 
13
- • **context**: `IEngineCoreContext`\<[`IEngineServerTypesConfig`](../interfaces/IEngineServerTypesConfig.md), `IEngineState`\>
13
+ • **context**: `IEngineCoreContext`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md), `IEngineState`\>
14
14
 
15
15
  The context for the engine.
16
16
 
package/docs/reference/functions/initialiseMimeTypeProcessorComponent.md CHANGED
@@ -6,11 +6,11 @@ Initialise the mime type processor.
6
6
 
7
7
  ## Parameters
8
8
 
9
- • **engineCore**: `IEngineCore`\<[`IEngineServerTypesConfig`](../interfaces/IEngineServerTypesConfig.md), `IEngineState`\>
9
+ • **engineCore**: `IEngineCore`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md), `IEngineState`\>
10
10
 
11
11
  The engine core.
12
12
 
13
- • **context**: `IEngineCoreContext`\<[`IEngineServerTypesConfig`](../interfaces/IEngineServerTypesConfig.md), `IEngineState`\>
13
+ • **context**: `IEngineCoreContext`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md), `IEngineState`\>
14
14
 
15
15
  The context for the engine.
16
16
 
package/docs/reference/functions/initialiseRestRouteProcessorComponent.md CHANGED
@@ -6,11 +6,11 @@ Initialise the rest route processor.
6
6
 
7
7
  ## Parameters
8
8
 
9
- • **engineCore**: `IEngineCore`\<[`IEngineServerTypesConfig`](../interfaces/IEngineServerTypesConfig.md), `IEngineState`\>
9
+ • **engineCore**: `IEngineCore`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md), `IEngineState`\>
10
10
 
11
11
  The engine core.
12
12
 
13
- • **context**: `IEngineCoreContext`\<[`IEngineServerTypesConfig`](../interfaces/IEngineServerTypesConfig.md), `IEngineState`\>
13
+ • **context**: `IEngineCoreContext`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md), `IEngineState`\>
14
14
 
15
15
  The context for the engine.
16
16
 
package/docs/reference/functions/initialiseSocketRouteProcessorComponent.md CHANGED
@@ -6,11 +6,11 @@ Initialise the socket route processor.
6
6
 
7
7
  ## Parameters
8
8
 
9
- • **engineCore**: `IEngineCore`\<[`IEngineServerTypesConfig`](../interfaces/IEngineServerTypesConfig.md), `IEngineState`\>
9
+ • **engineCore**: `IEngineCore`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md), `IEngineState`\>
10
10
 
11
11
  The engine core.
12
12
 
13
- • **context**: `IEngineCoreContext`\<[`IEngineServerTypesConfig`](../interfaces/IEngineServerTypesConfig.md), `IEngineState`\>
13
+ • **context**: `IEngineCoreContext`\<[`IEngineServerConfig`](../interfaces/IEngineServerConfig.md), `IEngineState`\>
14
14
 
15
15
  The context for the engine.
16
16
 
package/docs/reference/index.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  ## Interfaces
4
4
 
5
- - [IEngineServerTypesConfig](interfaces/IEngineServerTypesConfig.md)
5
+ - [IEngineServerConfig](interfaces/IEngineServerConfig.md)
6
6
 
7
7
  ## Type Aliases
8
8
 
package/docs/reference/interfaces/{IEngineServerTypesConfig.md → IEngineServerConfig.md} RENAMED
@@ -1,10 +1,10 @@
1
- # Interface: IEngineServerTypesConfig
1
+ # Interface: IEngineServerConfig
2
2
 
3
3
  Extended engine server config with known types.
4
4
 
5
5
  ## Extends
6
6
 
7
- - `IEngineCoreTypesConfig`
7
+ - `IEngineConfig`
8
8
 
9
9
  ## Properties
10
10
 
@@ -56,4 +56,4 @@ Authentication component options which can be overridden by individual component
56
56
 
57
57
  #### Overrides
58
58
 
59
- `IEngineCoreTypesConfig.types`
59
+ `IEngineConfig.types`
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/engine-server-types",
3
- "version": "0.0.1-next.14",
3
+ "version": "0.0.1-next.15",
4
4
  "description": "Server types to use in an engine server.",
5
5
  "repository": {
6
6
  "type": "git",
@@ -19,8 +19,8 @@
19
19
  "@twin.org/api-processors": "next",
20
20
  "@twin.org/api-service": "next",
21
21
  "@twin.org/core": "next",
22
- "@twin.org/engine-models": "0.0.1-next.14",
23
- "@twin.org/engine-types": "0.0.1-next.14",
22
+ "@twin.org/engine-models": "0.0.1-next.15",
23
+ "@twin.org/engine-types": "0.0.1-next.15",
24
24
  "@twin.org/entity": "next",
25
25
  "@twin.org/nameof": "next"
26
26
  },