@twin.org/node-core 0.0.3-next.4 → 0.0.3-next.40

package/docs/reference/interfaces/INodeOptions.md

@@ -4,31 +4,31 @@ The options when running the node.
 
 ## Properties
 
-### serverName?
+### serverName? {#servername}
 
-> `optional` **serverName**: `string`
+> `optional` **serverName?**: `string`
 
-The name of the server, defaults to "TWIN Node Server".
+The name of the server, defaults to "TWIN Node".
 
 #### Default
 
 ```ts
-"TWIN Node Server"
+"TWIN Node"
 ```
 
 ***
 
-### serverVersion?
+### serverVersion? {#serverversion}
 
-> `optional` **serverVersion**: `string`
+> `optional` **serverVersion?**: `string`
 
 The version of the server, defaults to the current version.
 
 ***
 
-### envVars?
+### envVars? {#envvars}
 
-> `optional` **envVars**: `object`
+> `optional` **envVars?**: `object`
 
 Additional environment variables to set.
 
@@ -38,25 +38,25 @@ Additional environment variables to set.
 
 ***
 
-### envFilenames?
+### envFilenames? {#envfilenames}
 
-> `optional` **envFilenames**: `string`[]
+> `optional` **envFilenames?**: `string`[]
 
 Additional environment variable filenames to load, defaults to .env.
 
 ***
 
-### envPrefix?
+### envPrefix? {#envprefix}
 
-> `optional` **envPrefix**: `string`
+> `optional` **envPrefix?**: `string`
 
 The prefix for environment variables, defaults to "TWIN_".
 
 ***
 
-### configFilenames?
+### configFilenames? {#configfilenames}
 
-> `optional` **configFilenames**: `string`[]
+> `optional` **configFilenames?**: `string`[]
 
 A list of JSON files to load as configuration files.
 The files will be loaded in the order they are provided, and the last one will
@@ -64,50 +64,58 @@ override any previous values.
 
 ***
 
-### config?
+### config? {#config}
 
-> `optional` **config**: `IEngineConfig`
+> `optional` **config?**: `IEngineConfig`
 
 Provides the ability to have some initial custom configuration for the engine.
 This will be merged with any configuration loaded from the environment variables.
 
 ***
 
-### executionDirectory?
+### scriptDirectory? {#scriptdirectory}
 
-> `optional` **executionDirectory**: `string`
+> `optional` **scriptDirectory?**: `string`
+
+The directory to override the script location, defaults to location of index.js.
+
+***
+
+### executionDirectory? {#executiondirectory}
+
+> `optional` **executionDirectory?**: `string`
 
 The directory to override the execution location, defaults to process directory.
 
 ***
 
-### localesDirectory?
+### localesDirectory? {#localesdirectory}
 
-> `optional` **localesDirectory**: `string`
+> `optional` **localesDirectory?**: `string`
 
 The directory to override the locales directory, defaults to the locales directory.
 
 ***
 
-### openApiSpecFile?
+### openApiSpecFile? {#openapispecfile}
 
-> `optional` **openApiSpecFile**: `string`
+> `optional` **openApiSpecFile?**: `string`
 
 The path to the OpenAPI spec file, defaults to docs/open-api/spec.json.
 
 ***
 
-### favIconFile?
+### favIconFile? {#faviconfile}
 
-> `optional` **favIconFile**: `string`
+> `optional` **favIconFile?**: `string`
 
 The path to the favicon, defaults to static/favicon.png.
 
 ***
 
-### extendEnvVars()?
+### extendEnvVars? {#extendenvvars}
 
-> `optional` **extendEnvVars**: (`envVars`) => `Promise`\<`void`\>
+> `optional` **extendEnvVars?**: (`envVars`) => `Promise`\<`void`\>
 
 Method to extend the engine environment variables with any additional custom configuration.
 
@@ -123,9 +131,9 @@ Method to extend the engine environment variables with any additional custom con
 
 ***
 
-### extendConfig()?
+### extendConfig? {#extendconfig}
 
-> `optional` **extendConfig**: (`envVars`, `config`) => `Promise`\<`void`\>
+> `optional` **extendConfig?**: (`envVars`, `config`) => `Promise`\<`void`\>
 
 Method to extend the engine configuration with any additional custom configuration.
 
@@ -145,9 +153,9 @@ Method to extend the engine configuration with any additional custom configurati
 
 ***
 
-### extendEngine()?
+### extendEngine? {#extendengine}
 
-> `optional` **extendEngine**: (`engine`) => `Promise`\<`void`\>
+> `optional` **extendEngine?**: (`engine`) => `Promise`\<`void`\>
 
 Method to extend the engine with any additional options.
 
@@ -163,9 +171,9 @@ Method to extend the engine with any additional options.
 
 ***
 
-### extendEngineServer()?
+### extendEngineServer? {#extendengineserver}
 
-> `optional` **extendEngineServer**: (`engineServer`) => `Promise`\<`void`\>
+> `optional` **extendEngineServer?**: (`engineServer`) => `Promise`\<`void`\>
 
 Method to extend the engine server with any additional options.
 
@@ -181,17 +189,17 @@ Method to extend the engine server with any additional options.
 
 ***
 
-### stateStorage?
+### stateStorage? {#statestorage}
 
-> `optional` **stateStorage**: `IEngineStateStorage`\<`IEngineState`\>
+> `optional` **stateStorage?**: `IEngineStateStorage`\<`IEngineState`\>
 
 The state storage to use for the engine.
 If not provided, a default file-based state storage will be used.
 
 ***
 
-### disableProcessExitOnFailure?
+### disableProcessExitOnFailure? {#disableprocessexitonfailure}
 
-> `optional` **disableProcessExitOnFailure**: `boolean`
+> `optional` **disableProcessExitOnFailure?**: `boolean`
 
 Disables process.exit calls on fatal errors and throws instead.

package/docs/reference/interfaces/IProtocolHandlerResult.md

@@ -4,7 +4,7 @@ The result from a protocol handler.
 
 ## Properties
 
-### resolvedPath
+### resolvedPath {#resolvedpath}
 
 > **resolvedPath**: `string`
 
@@ -12,7 +12,7 @@ The resolved path to the module file.
 
 ***
 
-### cached
+### cached {#cached}
 
 > **cached**: `boolean`
 

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

@@ -0,0 +1,5 @@
+# Type Alias: CliCommandParamType
+
+> **CliCommandParamType** = `string` \| `number` \| `boolean`
+
+Type for the properties in commands.

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

@@ -1,4 +1,4 @@
-# Type Alias: NodeExtensionInitialiseEngineMethod()
+# Type Alias: NodeExtensionInitialiseEngineMethod
 
 > **NodeExtensionInitialiseEngineMethod** = (`engineCore`) => `Promise`\<`void`\>
 

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

@@ -1,4 +1,4 @@
-# Type Alias: NodeExtensionInitialiseEngineServerMethod()
+# Type Alias: NodeExtensionInitialiseEngineServerMethod
 
 > **NodeExtensionInitialiseEngineServerMethod** = (`engineCore`, `engineServer`) => `Promise`\<`void`\>
 

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

@@ -1,4 +1,4 @@
-# Type Alias: NodeExtensionInitialiseMethod()
+# Type Alias: NodeExtensionInitialiseMethod
 
 > **NodeExtensionInitialiseMethod** = (`envVars`, `nodeEngineConfig`) => `Promise`\<`void`\>
 

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

@@ -1,4 +1,4 @@
-# Type Alias: NodeExtensionShutdownMethod()
+# Type Alias: NodeExtensionShutdownMethod
 
 > **NodeExtensionShutdownMethod** = () => `Promise`\<`void`\>
 

package/docs/reference/variables/ModuleProtocol.md

@@ -6,31 +6,31 @@ The protocol types for modules.
 
 ## Type Declaration
 
-### Local
+### Local {#local}
 
 > `readonly` **Local**: `"local"` = `"local"`
 
 Local module (starts with . or / or file://).
 
-### Npm
+### Npm {#npm}
 
 > `readonly` **Npm**: `"npm"` = `"npm"`
 
 NPM package (starts with npm:).
 
-### Https
+### Https {#https}
 
 > `readonly` **Https**: `"https"` = `"https"`
 
 HTTPS URL (starts with https://).
 
-### Http
+### Http {#http}
 
 > `readonly` **Http**: `"http"` = `"http"`
 
 HTTP URL (starts with http://).
 
-### Default
+### Default {#default}
 
 > `readonly` **Default**: `"default"` = `"default"`
 

package/docs/reference/variables/TRUST_VERIFICATION_METHOD_ID.md

@@ -0,0 +1,3 @@
+# Variable: TRUST\_VERIFICATION\_METHOD\_ID
+
+> `const` **TRUST\_VERIFICATION\_METHOD\_ID**: `"trust-assertion"` = `"trust-assertion"`

package/docs/reference/variables/URL_TRANSFORMER_ENCRYPTION_KEY_ID.md

@@ -0,0 +1,3 @@
+# Variable: URL\_TRANSFORMER\_ENCRYPTION\_KEY\_ID
+
+> `const` **URL\_TRANSFORMER\_ENCRYPTION\_KEY\_ID**: `"param-encryption"` = `"param-encryption"`