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

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 (186) hide show
  1. package/README.md +3 -1
  2. package/dist/es/builders/engineEnvBuilder.js +443 -126
  3. package/dist/es/builders/engineEnvBuilder.js.map +1 -1
  4. package/dist/es/builders/engineServerEnvBuilder.js +89 -32
  5. package/dist/es/builders/engineServerEnvBuilder.js.map +1 -1
  6. package/dist/es/builders/extensionsBuilder.js.map +1 -1
  7. package/dist/es/cli.js +247 -0
  8. package/dist/es/cli.js.map +1 -0
  9. package/dist/es/commands/bootstrapLegacy.js +199 -0
  10. package/dist/es/commands/bootstrapLegacy.js.map +1 -0
  11. package/dist/es/commands/help.js +85 -0
  12. package/dist/es/commands/help.js.map +1 -0
  13. package/dist/es/commands/identityCreate.js +327 -0
  14. package/dist/es/commands/identityCreate.js.map +1 -0
  15. package/dist/es/commands/identityImports.js +82 -0
  16. package/dist/es/commands/identityImports.js.map +1 -0
  17. package/dist/es/commands/identityVerifiableCredentialCreate.js +146 -0
  18. package/dist/es/commands/identityVerifiableCredentialCreate.js.map +1 -0
  19. package/dist/es/commands/identityVerificationMethodCreate.js +228 -0
  20. package/dist/es/commands/identityVerificationMethodCreate.js.map +1 -0
  21. package/dist/es/commands/identityVerificationMethodImport.js +126 -0
  22. package/dist/es/commands/identityVerificationMethodImport.js.map +1 -0
  23. package/dist/es/commands/nodeSetIdentity.js +64 -0
  24. package/dist/es/commands/nodeSetIdentity.js.map +1 -0
  25. package/dist/es/commands/nodeSetTenant.js +68 -0
  26. package/dist/es/commands/nodeSetTenant.js.map +1 -0
  27. package/dist/es/commands/tenantCreate.js +139 -0
  28. package/dist/es/commands/tenantCreate.js.map +1 -0
  29. package/dist/es/commands/tenantImport.js +97 -0
  30. package/dist/es/commands/tenantImport.js.map +1 -0
  31. package/dist/es/commands/tenantUpdate.js +94 -0
  32. package/dist/es/commands/tenantUpdate.js.map +1 -0
  33. package/dist/es/commands/userCreate.js +239 -0
  34. package/dist/es/commands/userCreate.js.map +1 -0
  35. package/dist/es/commands/userUpdate.js +154 -0
  36. package/dist/es/commands/userUpdate.js.map +1 -0
  37. package/dist/es/commands/vaultKeyCreate.js +191 -0
  38. package/dist/es/commands/vaultKeyCreate.js.map +1 -0
  39. package/dist/es/commands/vaultKeyImport.js +104 -0
  40. package/dist/es/commands/vaultKeyImport.js.map +1 -0
  41. package/dist/es/defaults.js +19 -1
  42. package/dist/es/defaults.js.map +1 -1
  43. package/dist/es/index.js +11 -4
  44. package/dist/es/index.js.map +1 -1
  45. package/dist/es/models/ICliArgs.js +4 -0
  46. package/dist/es/models/ICliArgs.js.map +1 -0
  47. package/dist/es/models/ICliCommand.js +2 -0
  48. package/dist/es/models/ICliCommand.js.map +1 -0
  49. package/dist/es/models/ICliCommandDefinition.js +2 -0
  50. package/dist/es/models/ICliCommandDefinition.js.map +1 -0
  51. package/dist/es/models/ICliCommandDefinitionParam.js +2 -0
  52. package/dist/es/models/ICliCommandDefinitionParam.js.map +1 -0
  53. package/dist/es/models/IEngineEnvironmentVariables.js.map +1 -1
  54. package/dist/es/models/IEngineServerEnvironmentVariables.js.map +1 -1
  55. package/dist/es/models/INodeEngineState.js.map +1 -1
  56. package/dist/es/models/INodeEnvironmentVariables.js.map +1 -1
  57. package/dist/es/models/INodeOptions.js.map +1 -1
  58. package/dist/es/models/cliCommandParamType.js +4 -0
  59. package/dist/es/models/cliCommandParamType.js.map +1 -0
  60. package/dist/es/models/nodeExtensionInitialiseEngineMethod.js +2 -0
  61. package/dist/es/models/nodeExtensionInitialiseEngineMethod.js.map +1 -0
  62. package/dist/es/models/nodeExtensionInitialiseEngineServerMethod.js +2 -0
  63. package/dist/es/models/nodeExtensionInitialiseEngineServerMethod.js.map +1 -0
  64. package/dist/es/models/nodeExtensionInitialiseMethod.js +2 -0
  65. package/dist/es/models/nodeExtensionInitialiseMethod.js.map +1 -0
  66. package/dist/es/models/nodeExtensionShutdownMethod.js +4 -0
  67. package/dist/es/models/nodeExtensionShutdownMethod.js.map +1 -0
  68. package/dist/es/node.js +86 -39
  69. package/dist/es/node.js.map +1 -1
  70. package/dist/es/start.js +139 -0
  71. package/dist/es/start.js.map +1 -0
  72. package/dist/es/utils.js +12 -22
  73. package/dist/es/utils.js.map +1 -1
  74. package/dist/types/builders/engineEnvBuilder.d.ts +64 -1
  75. package/dist/types/builders/engineServerEnvBuilder.d.ts +11 -2
  76. package/dist/types/cli.d.ts +56 -0
  77. package/dist/types/commands/bootstrapLegacy.d.ts +66 -0
  78. package/dist/types/commands/help.d.ts +23 -0
  79. package/dist/types/commands/identityCreate.d.ts +39 -0
  80. package/dist/types/commands/identityImports.d.ts +24 -0
  81. package/dist/types/commands/identityVerifiableCredentialCreate.d.ts +43 -0
  82. package/dist/types/commands/identityVerificationMethodCreate.d.ts +47 -0
  83. package/dist/types/commands/identityVerificationMethodImport.d.ts +31 -0
  84. package/dist/types/commands/nodeSetIdentity.d.ts +22 -0
  85. package/dist/types/commands/nodeSetTenant.d.ts +22 -0
  86. package/dist/types/commands/tenantCreate.d.ts +38 -0
  87. package/dist/types/commands/tenantImport.d.ts +26 -0
  88. package/dist/types/commands/tenantUpdate.d.ts +26 -0
  89. package/dist/types/commands/userCreate.d.ts +51 -0
  90. package/dist/types/commands/userUpdate.d.ts +40 -0
  91. package/dist/types/commands/vaultKeyCreate.d.ts +43 -0
  92. package/dist/types/commands/vaultKeyImport.d.ts +28 -0
  93. package/dist/types/defaults.d.ts +10 -1
  94. package/dist/types/index.d.ts +11 -4
  95. package/dist/types/models/ICliArgs.d.ts +20 -0
  96. package/dist/types/models/ICliCommand.d.ts +17 -0
  97. package/dist/types/models/ICliCommandDefinition.d.ts +46 -0
  98. package/dist/types/models/ICliCommandDefinitionParam.d.ts +35 -0
  99. package/dist/types/models/IEngineEnvironmentVariables.d.ts +117 -60
  100. package/dist/types/models/IEngineServerEnvironmentVariables.d.ts +8 -0
  101. package/dist/types/models/INodeEngineState.d.ts +0 -8
  102. package/dist/types/models/INodeEnvironmentVariables.d.ts +0 -38
  103. package/dist/types/models/INodeOptions.d.ts +6 -2
  104. package/dist/types/models/cliCommandParamType.d.ts +4 -0
  105. package/dist/types/models/nodeExtensionInitialiseEngineMethod.d.ts +7 -0
  106. package/dist/types/models/nodeExtensionInitialiseEngineServerMethod.d.ts +8 -0
  107. package/dist/types/models/nodeExtensionInitialiseMethod.d.ts +8 -0
  108. package/dist/types/models/nodeExtensionShutdownMethod.d.ts +5 -0
  109. package/dist/types/node.d.ts +5 -4
  110. package/dist/types/{server.d.ts → start.d.ts} +4 -2
  111. package/dist/types/utils.d.ts +6 -8
  112. package/docs/changelog.md +532 -176
  113. package/docs/examples.md +99 -1
  114. package/docs/reference/functions/buildConfiguration.md +1 -1
  115. package/docs/reference/functions/buildEngineServerConfiguration.md +1 -1
  116. package/docs/reference/functions/constructCliCommand.md +27 -0
  117. package/docs/reference/functions/executeCommand.md +29 -0
  118. package/docs/reference/functions/getEnvDefaults.md +19 -0
  119. package/docs/reference/functions/getScriptDirectory.md +19 -0
  120. package/docs/reference/functions/isAuthEntityStorageRequired.md +20 -0
  121. package/docs/reference/functions/isAutomationRequired.md +20 -0
  122. package/docs/reference/functions/isBackgroundTasksRequired.md +20 -0
  123. package/docs/reference/functions/isFederatedCatalogueRequired.md +20 -0
  124. package/docs/reference/functions/isImmutableProofRequired.md +20 -0
  125. package/docs/reference/functions/isRightsManagementRequired.md +20 -0
  126. package/docs/reference/functions/isTaskSchedulerRequired.md +20 -0
  127. package/docs/reference/functions/isTelemetryRequired.md +20 -0
  128. package/docs/reference/functions/isTrustRequired.md +20 -0
  129. package/docs/reference/functions/isUrlTransformerRequired.md +20 -0
  130. package/docs/reference/functions/parseCommandLineArgs.md +19 -0
  131. package/docs/reference/functions/processEnvOptions.md +27 -0
  132. package/docs/reference/functions/registerCommands.md +9 -0
  133. package/docs/reference/functions/resolvePackageEntryPoint.md +2 -2
  134. package/docs/reference/functions/run.md +8 -2
  135. package/docs/reference/functions/start.md +9 -3
  136. package/docs/reference/functions/substituteEnvOptions.md +25 -0
  137. package/docs/reference/index.md +26 -13
  138. package/docs/reference/interfaces/ICacheMetadata.md +3 -3
  139. package/docs/reference/interfaces/ICliArgs.md +35 -0
  140. package/docs/reference/interfaces/ICliCommand.md +23 -0
  141. package/docs/reference/interfaces/ICliCommandDefinition.md +101 -0
  142. package/docs/reference/interfaces/ICliCommandDefinitionParam.md +65 -0
  143. package/docs/reference/interfaces/IEngineEnvironmentVariables.md +420 -311
  144. package/docs/reference/interfaces/IEngineServerEnvironmentVariables.md +545 -368
  145. package/docs/reference/interfaces/IModuleProtocol.md +3 -3
  146. package/docs/reference/interfaces/INodeEngineState.md +4 -20
  147. package/docs/reference/interfaces/INodeEnvironmentVariables.md +551 -450
  148. package/docs/reference/interfaces/INodeOptions.md +44 -36
  149. package/docs/reference/interfaces/IProtocolHandlerResult.md +2 -2
  150. package/docs/reference/type-aliases/CliCommandParamType.md +5 -0
  151. package/docs/reference/type-aliases/NodeExtensionInitialiseEngineMethod.md +1 -1
  152. package/docs/reference/type-aliases/NodeExtensionInitialiseEngineServerMethod.md +1 -1
  153. package/docs/reference/type-aliases/NodeExtensionInitialiseMethod.md +1 -1
  154. package/docs/reference/type-aliases/NodeExtensionShutdownMethod.md +1 -1
  155. package/docs/reference/variables/ModuleProtocol.md +5 -5
  156. package/docs/reference/variables/TRUST_VERIFICATION_METHOD_ID.md +3 -0
  157. package/docs/reference/variables/URL_TRANSFORMER_ENCRYPTION_KEY_ID.md +3 -0
  158. package/locales/en.json +600 -30
  159. package/package.json +10 -6
  160. package/dist/es/bootstrap.js +0 -366
  161. package/dist/es/bootstrap.js.map +0 -1
  162. package/dist/es/identity.js +0 -182
  163. package/dist/es/identity.js.map +0 -1
  164. package/dist/es/models/nodeExtensionMethods.js +0 -2
  165. package/dist/es/models/nodeExtensionMethods.js.map +0 -1
  166. package/dist/es/models/nodeFeatures.js +0 -21
  167. package/dist/es/models/nodeFeatures.js.map +0 -1
  168. package/dist/es/server.js +0 -81
  169. package/dist/es/server.js.map +0 -1
  170. package/dist/types/bootstrap.d.ts +0 -68
  171. package/dist/types/identity.d.ts +0 -14
  172. package/dist/types/models/nodeExtensionMethods.d.ts +0 -27
  173. package/dist/types/models/nodeFeatures.d.ts +0 -21
  174. package/docs/detailed-guide.md +0 -129
  175. package/docs/reference/functions/bootstrap.md +0 -29
  176. package/docs/reference/functions/bootstrapAuth.md +0 -35
  177. package/docs/reference/functions/bootstrapBlobEncryption.md +0 -35
  178. package/docs/reference/functions/bootstrapImmutableProofMethod.md +0 -35
  179. package/docs/reference/functions/bootstrapNodeAdminUser.md +0 -35
  180. package/docs/reference/functions/bootstrapNodeId.md +0 -35
  181. package/docs/reference/functions/bootstrapSynchronisedStorage.md +0 -35
  182. package/docs/reference/functions/bootstrapTenantId.md +0 -35
  183. package/docs/reference/functions/getFeatures.md +0 -19
  184. package/docs/reference/type-aliases/NodeFeatures.md +0 -5
  185. package/docs/reference/variables/NodeFeatures.md +0 -25
  186. package/docs/reference/variables/VC_AUTHENTICATION_VERIFICATION_METHOD_ID.md +0 -3
package/docs/reference/functions/bootstrapAuth.md DELETED
@@ -1,35 +0,0 @@
1
- # Function: bootstrapAuth()
2
-
3
- > **bootstrapAuth**(`engineCore`, `context`, `envVars`, `features`): `Promise`\<`void`\>
4
-
5
- Bootstrap the JWT signing key.
6
-
7
- ## Parameters
8
-
9
- ### engineCore
10
-
11
- `IEngineCore`
12
-
13
- The engine core for the node.
14
-
15
- ### context
16
-
17
- `IEngineCoreContext`\<`IEngineServerConfig`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>
18
-
19
- The context for the node.
20
-
21
- ### envVars
22
-
23
- [`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
24
-
25
- The environment variables for the node.
26
-
27
- ### features
28
-
29
- [`NodeFeatures`](../type-aliases/NodeFeatures.md)[]
30
-
31
- The features that are enabled on the node.
32
-
33
- ## Returns
34
-
35
- `Promise`\<`void`\>
package/docs/reference/functions/bootstrapBlobEncryption.md DELETED
@@ -1,35 +0,0 @@
1
- # Function: bootstrapBlobEncryption()
2
-
3
- > **bootstrapBlobEncryption**(`engineCore`, `context`, `envVars`, `features`): `Promise`\<`void`\>
4
-
5
- Bootstrap the keys for blob encryption.
6
-
7
- ## Parameters
8
-
9
- ### engineCore
10
-
11
- `IEngineCore`
12
-
13
- The engine core for the node.
14
-
15
- ### context
16
-
17
- `IEngineCoreContext`\<`IEngineServerConfig`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>
18
-
19
- The context for the node.
20
-
21
- ### envVars
22
-
23
- [`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
24
-
25
- The environment variables for the node.
26
-
27
- ### features
28
-
29
- [`NodeFeatures`](../type-aliases/NodeFeatures.md)[]
30
-
31
- The features that are enabled on the node.
32
-
33
- ## Returns
34
-
35
- `Promise`\<`void`\>
package/docs/reference/functions/bootstrapImmutableProofMethod.md DELETED
@@ -1,35 +0,0 @@
1
- # Function: bootstrapImmutableProofMethod()
2
-
3
- > **bootstrapImmutableProofMethod**(`engineCore`, `context`, `envVars`, `features`): `Promise`\<`void`\>
4
-
5
- Bootstrap the immutable proof verification methods.
6
-
7
- ## Parameters
8
-
9
- ### engineCore
10
-
11
- `IEngineCore`
12
-
13
- The engine core for the node.
14
-
15
- ### context
16
-
17
- `IEngineCoreContext`\<`IEngineServerConfig`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>
18
-
19
- The context for the node.
20
-
21
- ### envVars
22
-
23
- [`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
24
-
25
- The environment variables for the node.
26
-
27
- ### features
28
-
29
- [`NodeFeatures`](../type-aliases/NodeFeatures.md)[]
30
-
31
- The features that are enabled on the node.
32
-
33
- ## Returns
34
-
35
- `Promise`\<`void`\>
package/docs/reference/functions/bootstrapNodeAdminUser.md DELETED
@@ -1,35 +0,0 @@
1
- # Function: bootstrapNodeAdminUser()
2
-
3
- > **bootstrapNodeAdminUser**(`engineCore`, `context`, `envVars`, `features`): `Promise`\<`void`\>
4
-
5
- Bootstrap the user.
6
-
7
- ## Parameters
8
-
9
- ### engineCore
10
-
11
- `IEngineCore`
12
-
13
- The engine core for the node.
14
-
15
- ### context
16
-
17
- `IEngineCoreContext`\<`IEngineServerConfig`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>
18
-
19
- The context for the node.
20
-
21
- ### envVars
22
-
23
- [`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
24
-
25
- The environment variables for the node.
26
-
27
- ### features
28
-
29
- [`NodeFeatures`](../type-aliases/NodeFeatures.md)[]
30
-
31
- The features that are enabled on the node.
32
-
33
- ## Returns
34
-
35
- `Promise`\<`void`\>
package/docs/reference/functions/bootstrapNodeId.md DELETED
@@ -1,35 +0,0 @@
1
- # Function: bootstrapNodeId()
2
-
3
- > **bootstrapNodeId**(`engineCore`, `context`, `envVars`, `features`): `Promise`\<`void`\>
4
-
5
- Bootstrap the node creating any necessary resources.
6
-
7
- ## Parameters
8
-
9
- ### engineCore
10
-
11
- `IEngineCore`
12
-
13
- The engine core for the node.
14
-
15
- ### context
16
-
17
- `IEngineCoreContext`\<`IEngineServerConfig`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>
18
-
19
- The context for the node.
20
-
21
- ### envVars
22
-
23
- [`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
24
-
25
- The environment variables for the node.
26
-
27
- ### features
28
-
29
- [`NodeFeatures`](../type-aliases/NodeFeatures.md)[]
30
-
31
- The features that are enabled on the node. The features that are enabled on the node.
32
-
33
- ## Returns
34
-
35
- `Promise`\<`void`\>
package/docs/reference/functions/bootstrapSynchronisedStorage.md DELETED
@@ -1,35 +0,0 @@
1
- # Function: bootstrapSynchronisedStorage()
2
-
3
- > **bootstrapSynchronisedStorage**(`engineCore`, `context`, `envVars`, `features`): `Promise`\<`void`\>
4
-
5
- Bootstrap the synchronised storage blob encryption and verification methods.
6
-
7
- ## Parameters
8
-
9
- ### engineCore
10
-
11
- `IEngineCore`
12
-
13
- The engine core for the node.
14
-
15
- ### context
16
-
17
- `IEngineCoreContext`\<`IEngineServerConfig`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>
18
-
19
- The context for the node.
20
-
21
- ### envVars
22
-
23
- [`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
24
-
25
- The environment variables for the node.
26
-
27
- ### features
28
-
29
- [`NodeFeatures`](../type-aliases/NodeFeatures.md)[]
30
-
31
- The features that are enabled on the node.
32
-
33
- ## Returns
34
-
35
- `Promise`\<`void`\>
package/docs/reference/functions/bootstrapTenantId.md DELETED
@@ -1,35 +0,0 @@
1
- # Function: bootstrapTenantId()
2
-
3
- > **bootstrapTenantId**(`engineCore`, `context`, `envVars`, `features`): `Promise`\<`void`\>
4
-
5
- Bootstrap the node creating any necessary resources.
6
-
7
- ## Parameters
8
-
9
- ### engineCore
10
-
11
- `IEngineCore`
12
-
13
- The engine core for the node.
14
-
15
- ### context
16
-
17
- `IEngineCoreContext`\<`IEngineServerConfig`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>
18
-
19
- The context for the node.
20
-
21
- ### envVars
22
-
23
- [`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
24
-
25
- The environment variables for the node.
26
-
27
- ### features
28
-
29
- [`NodeFeatures`](../type-aliases/NodeFeatures.md)[]
30
-
31
- The features that are enabled on the node. The features that are enabled on the node.
32
-
33
- ## Returns
34
-
35
- `Promise`\<`void`\>
package/docs/reference/functions/getFeatures.md DELETED
@@ -1,19 +0,0 @@
1
- # Function: getFeatures()
2
-
3
- > **getFeatures**(`env`): [`NodeFeatures`](../type-aliases/NodeFeatures.md)[]
4
-
5
- Get the features that are enabled on the node.
6
-
7
- ## Parameters
8
-
9
- ### env
10
-
11
- [`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
12
-
13
- The environment variables for the node.
14
-
15
- ## Returns
16
-
17
- [`NodeFeatures`](../type-aliases/NodeFeatures.md)[]
18
-
19
- The features that are enabled on the node.
package/docs/reference/type-aliases/NodeFeatures.md DELETED
@@ -1,5 +0,0 @@
1
- # Type Alias: NodeFeatures
2
-
3
- > **NodeFeatures** = *typeof* [`NodeFeatures`](../variables/NodeFeatures.md)\[keyof *typeof* [`NodeFeatures`](../variables/NodeFeatures.md)\]
4
-
5
- The features that can be enabled on the node.
package/docs/reference/variables/NodeFeatures.md DELETED
@@ -1,25 +0,0 @@
1
- # Variable: NodeFeatures
2
-
3
- > `const` **NodeFeatures**: `object`
4
-
5
- The features that can be enabled on the node.
6
-
7
- ## Type Declaration
8
-
9
- ### NodeId
10
-
11
- > `readonly` **NodeId**: `"node-identity"` = `"node-identity"`
12
-
13
- NodeId - generates an identity for the node if not provided in config.
14
-
15
- ### NodeAdminUser
16
-
17
- > `readonly` **NodeAdminUser**: `"node-admin-user"` = `"node-admin-user"`
18
-
19
- NodeAdminUser - generates an admin user for the node if not provided in config.
20
-
21
- ### NodeWallet
22
-
23
- > `readonly` **NodeWallet**: `"node-wallet"` = `"node-wallet"`
24
-
25
- NodeWallet - generates wallets for any identities that need them.
package/docs/reference/variables/VC_AUTHENTICATION_VERIFICATION_METHOD_ID.md DELETED
@@ -1,3 +0,0 @@
1
- # Variable: VC\_AUTHENTICATION\_VERIFICATION\_METHOD\_ID
2
-
3
- > `const` **VC\_AUTHENTICATION\_VERIFICATION\_METHOD\_ID**: `"node-authentication-assertion"` = `"node-authentication-assertion"`