@twin.org/node-core 0.0.3-next.54 → 0.0.3-next.55

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 (100) hide show
  1. package/dist/es/builders/engineEnvBuilder.js +51 -9
  2. package/dist/es/builders/engineEnvBuilder.js.map +1 -1
  3. package/dist/es/builders/extensionsBuilder.js +3 -3
  4. package/dist/es/builders/extensionsBuilder.js.map +1 -1
  5. package/dist/es/cli.js +6 -3
  6. package/dist/es/cli.js.map +1 -1
  7. package/dist/es/commands/bootstrapLegacy.js +1 -0
  8. package/dist/es/commands/bootstrapLegacy.js.map +1 -1
  9. package/dist/es/commands/help.js +1 -0
  10. package/dist/es/commands/help.js.map +1 -1
  11. package/dist/es/commands/identityCreate.js +15 -13
  12. package/dist/es/commands/identityCreate.js.map +1 -1
  13. package/dist/es/commands/identityImports.js +1 -0
  14. package/dist/es/commands/identityImports.js.map +1 -1
  15. package/dist/es/commands/identityVerificationMethodImport.js +2 -1
  16. package/dist/es/commands/identityVerificationMethodImport.js.map +1 -1
  17. package/dist/es/commands/nodeSetIdentity.js +1 -0
  18. package/dist/es/commands/nodeSetIdentity.js.map +1 -1
  19. package/dist/es/commands/removeTenantOrgAlias.js +3 -1
  20. package/dist/es/commands/removeTenantOrgAlias.js.map +1 -1
  21. package/dist/es/commands/setNodeOrgId.js +2 -0
  22. package/dist/es/commands/setNodeOrgId.js.map +1 -1
  23. package/dist/es/commands/setTenantOrgId.js +7 -66
  24. package/dist/es/commands/setTenantOrgId.js.map +1 -1
  25. package/dist/es/commands/tenantCreate.js +1 -7
  26. package/dist/es/commands/tenantCreate.js.map +1 -1
  27. package/dist/es/commands/tenantImport.js +17 -4
  28. package/dist/es/commands/tenantImport.js.map +1 -1
  29. package/dist/es/commands/tenantUpdate.js +21 -6
  30. package/dist/es/commands/tenantUpdate.js.map +1 -1
  31. package/dist/es/commands/vaultKeyImport.js +4 -3
  32. package/dist/es/commands/vaultKeyImport.js.map +1 -1
  33. package/dist/es/defaults.js +21 -0
  34. package/dist/es/defaults.js.map +1 -1
  35. package/dist/es/models/ICliArgs.js.map +1 -1
  36. package/dist/es/models/ICliCommand.js.map +1 -1
  37. package/dist/es/models/ICliCommandDefinition.js.map +1 -1
  38. package/dist/es/models/ICliCommandDefinitionParam.js.map +1 -1
  39. package/dist/es/models/nodeExtensionInitialiseEngineMethod.js.map +1 -1
  40. package/dist/es/models/nodeExtensionInitialiseEngineServerMethod.js.map +1 -1
  41. package/dist/es/models/nodeExtensionInitialiseMethod.js.map +1 -1
  42. package/dist/es/models/nodeExtensionShutdownMethod.js.map +1 -1
  43. package/dist/es/node.js +1 -1
  44. package/dist/es/node.js.map +1 -1
  45. package/dist/es/start.js +5 -4
  46. package/dist/es/start.js.map +1 -1
  47. package/dist/es/utils.js +4 -3
  48. package/dist/es/utils.js.map +1 -1
  49. package/dist/types/builders/engineEnvBuilder.d.ts +3 -3
  50. package/dist/types/builders/extensionsBuilder.d.ts +3 -3
  51. package/dist/types/cli.d.ts +2 -2
  52. package/dist/types/commands/bootstrapLegacy.d.ts +1 -0
  53. package/dist/types/commands/help.d.ts +1 -0
  54. package/dist/types/commands/identityImports.d.ts +1 -0
  55. package/dist/types/commands/identityVerificationMethodImport.d.ts +2 -1
  56. package/dist/types/commands/nodeSetIdentity.d.ts +1 -0
  57. package/dist/types/commands/removeTenantOrgAlias.d.ts +2 -0
  58. package/dist/types/commands/setNodeOrgId.d.ts +2 -0
  59. package/dist/types/commands/setTenantOrgId.d.ts +5 -22
  60. package/dist/types/commands/tenantImport.d.ts +7 -4
  61. package/dist/types/commands/tenantUpdate.d.ts +5 -2
  62. package/dist/types/commands/vaultKeyImport.d.ts +4 -3
  63. package/dist/types/defaults.d.ts +21 -0
  64. package/dist/types/models/ICliArgs.d.ts +1 -1
  65. package/dist/types/models/ICliCommand.d.ts +1 -1
  66. package/dist/types/models/ICliCommandDefinition.d.ts +2 -2
  67. package/dist/types/models/ICliCommandDefinitionParam.d.ts +1 -1
  68. package/dist/types/models/nodeExtensionInitialiseEngineMethod.d.ts +1 -0
  69. package/dist/types/models/nodeExtensionInitialiseEngineServerMethod.d.ts +1 -0
  70. package/dist/types/models/nodeExtensionInitialiseMethod.d.ts +1 -0
  71. package/dist/types/models/nodeExtensionShutdownMethod.d.ts +1 -0
  72. package/dist/types/utils.d.ts +4 -3
  73. package/docs/changelog.md +8 -0
  74. package/docs/reference/functions/extensionsInitialiseEngine.md +1 -1
  75. package/docs/reference/functions/extensionsInitialiseEngineServer.md +1 -1
  76. package/docs/reference/functions/getScriptDirectory.md +1 -1
  77. package/docs/reference/functions/initialiseLocales.md +2 -0
  78. package/docs/reference/functions/isFederatedCatalogueRequired.md +3 -3
  79. package/docs/reference/functions/loadJsonFile.md +1 -1
  80. package/docs/reference/functions/loadTextFile.md +1 -1
  81. package/docs/reference/functions/processEnvOptions.md +1 -1
  82. package/docs/reference/functions/registerCommands.md +1 -1
  83. package/docs/reference/functions/shutdownExtensions.md +1 -1
  84. package/docs/reference/interfaces/ICliArgs.md +1 -1
  85. package/docs/reference/interfaces/ICliCommand.md +1 -1
  86. package/docs/reference/interfaces/ICliCommandDefinition.md +2 -2
  87. package/docs/reference/interfaces/ICliCommandDefinitionParam.md +1 -1
  88. package/docs/reference/type-aliases/NodeExtensionInitialiseEngineMethod.md +2 -0
  89. package/docs/reference/type-aliases/NodeExtensionInitialiseEngineServerMethod.md +2 -0
  90. package/docs/reference/type-aliases/NodeExtensionInitialiseMethod.md +2 -0
  91. package/docs/reference/type-aliases/NodeExtensionShutdownMethod.md +2 -0
  92. package/docs/reference/variables/ATTESTATION_VERIFICATION_METHOD_ID.md +2 -0
  93. package/docs/reference/variables/AUTH_SIGNING_KEY_ID.md +2 -0
  94. package/docs/reference/variables/BLOB_STORAGE_ENCRYPTION_KEY_ID.md +2 -0
  95. package/docs/reference/variables/CONTEXT_ID_HANDLER_FEATURE_DID.md +2 -0
  96. package/docs/reference/variables/CONTEXT_ID_HANDLER_FEATURE_TENANT.md +2 -0
  97. package/docs/reference/variables/IMMUTABLE_PROOF_VERIFICATION_METHOD_ID.md +2 -0
  98. package/docs/reference/variables/TRUST_VERIFICATION_METHOD_ID.md +2 -0
  99. package/locales/en.json +8 -3
  100. package/package.json +1 -1
@@ -22,4 +22,4 @@ The engine core instance.
22
22
 
23
23
  `Promise`\<`void`\>
24
24
 
25
- Nothing.
25
+ A promise that resolves when all extension shutdown methods have completed.
@@ -1,6 +1,6 @@
1
1
  # Interface: ICliArgs
2
2
 
3
- Command to execute in the CLI.
3
+ Parsed command line arguments passed to the CLI.
4
4
 
5
5
  ## Properties
6
6
 
@@ -1,6 +1,6 @@
1
1
  # Interface: ICliCommand
2
2
 
3
- Command to execute in the CLI.
3
+ A resolved CLI command ready for execution, pairing a definition with its populated parameters.
4
4
 
5
5
  ## Properties
6
6
 
@@ -1,6 +1,6 @@
1
1
  # Interface: ICliCommandDefinition
2
2
 
3
- Command to execute in the CLI.
3
+ Static definition of a CLI command including its name, parameters, and execution action.
4
4
 
5
5
  ## Properties
6
6
 
@@ -24,7 +24,7 @@ The command description.
24
24
 
25
25
  > **example**: `string`
26
26
 
27
- The example.
27
+ An example invocation string shown in help output.
28
28
 
29
29
  ***
30
30
 
@@ -1,6 +1,6 @@
1
1
  # Interface: ICliCommandDefinitionParam
2
2
 
3
- Command param to execute in the CLI.
3
+ Definition of a single parameter accepted by a CLI command.
4
4
 
5
5
  ## Properties
6
6
 
@@ -16,3 +16,5 @@ The engine core instance.
16
16
  ## Returns
17
17
 
18
18
  `Promise`\<`void`\>
19
+
20
+ A promise that resolves when the extension engine initialisation is complete.
@@ -22,3 +22,5 @@ The engine server instance.
22
22
  ## Returns
23
23
 
24
24
  `Promise`\<`void`\>
25
+
26
+ A promise that resolves when the extension engine-server initialisation is complete.
@@ -21,3 +21,5 @@ The node engine config.
21
21
  ## Returns
22
22
 
23
23
  `Promise`\<`void`\>
24
+
25
+ A promise that resolves when the extension configuration initialisation is complete.
@@ -8,3 +8,5 @@ This is called when the engine is shutting down.
8
8
  ## Returns
9
9
 
10
10
  `Promise`\<`void`\>
11
+
12
+ A promise that resolves when the extension shutdown is complete.
@@ -1,3 +1,5 @@
1
1
  # Variable: ATTESTATION\_VERIFICATION\_METHOD\_ID
2
2
 
3
3
  > `const` **ATTESTATION\_VERIFICATION\_METHOD\_ID**: `"attestation-assertion"` = `"attestation-assertion"`
4
+
5
+ Default verification method fragment ID for attestation.
@@ -1,3 +1,5 @@
1
1
  # Variable: AUTH\_SIGNING\_KEY\_ID
2
2
 
3
3
  > `const` **AUTH\_SIGNING\_KEY\_ID**: `"auth-signing"` = `"auth-signing"`
4
+
5
+ Default vault key ID used for signing authentication tokens.
@@ -1,3 +1,5 @@
1
1
  # Variable: BLOB\_STORAGE\_ENCRYPTION\_KEY\_ID
2
2
 
3
3
  > `const` **BLOB\_STORAGE\_ENCRYPTION\_KEY\_ID**: `"blob-encryption"` = `"blob-encryption"`
4
+
5
+ Default vault key ID for blob storage encryption.
@@ -1,3 +1,5 @@
1
1
  # Variable: CONTEXT\_ID\_HANDLER\_FEATURE\_DID
2
2
 
3
3
  > `const` **CONTEXT\_ID\_HANDLER\_FEATURE\_DID**: `"did"` = `"did"`
4
+
5
+ Feature tag identifying the DID context ID handler.
@@ -1,3 +1,5 @@
1
1
  # Variable: CONTEXT\_ID\_HANDLER\_FEATURE\_TENANT
2
2
 
3
3
  > `const` **CONTEXT\_ID\_HANDLER\_FEATURE\_TENANT**: `"tenant"` = `"tenant"`
4
+
5
+ Feature tag identifying the tenant context ID handler.
@@ -1,3 +1,5 @@
1
1
  # Variable: IMMUTABLE\_PROOF\_VERIFICATION\_METHOD\_ID
2
2
 
3
3
  > `const` **IMMUTABLE\_PROOF\_VERIFICATION\_METHOD\_ID**: `"immutable-proof-assertion"` = `"immutable-proof-assertion"`
4
+
5
+ Default verification method fragment ID for immutable proofs.
@@ -1,3 +1,5 @@
1
1
  # Variable: TRUST\_VERIFICATION\_METHOD\_ID
2
2
 
3
3
  > `const` **TRUST\_VERIFICATION\_METHOD\_ID**: `"trust-assertion"` = `"trust-assertion"`
4
+
5
+ Default verification method fragment ID for trust assertions.
package/locales/en.json CHANGED
@@ -62,8 +62,7 @@
62
62
  "notAvailableInMultiTenantMode": "The set-node-org-id command is not available in multi-tenant mode, use set-tenant-org-id instead."
63
63
  },
64
64
  "applyOrganizationIdToTenant": {
65
- "tenantAdminComponentNotRegistered": "Multi-tenant support must be enabled to use this command.",
66
- "organizationIdAlreadyInUse": "The organization ID \"{organizationId}\" is already assigned to tenant \"{conflictingTenantId}\"."
65
+ "tenantAdminComponentNotRegistered": "Multi-tenant support must be enabled to use this command."
67
66
  },
68
67
  "removeTenantOrgAlias": {
69
68
  "tenantAdminComponentNotRegistered": "Multi-tenant support must be enabled to use this command.",
@@ -401,7 +400,7 @@
401
400
  },
402
401
  "tenant-import": {
403
402
  "description": "Import a tenant with associated api key",
404
- "example": "tenant-import --tenant-id=\"0011..aabb\" --api-key=\"aabb..0099\" --label=\"My Tenant\" --public-origin=\"https://example.com:1234\"",
403
+ "example": "tenant-import --tenant-id=\"0011..aabb\" --api-key=\"aabb..0099\" --organization-id=\"did:iota:...\" --label=\"My Tenant\" --public-origin=\"https://example.com:1234\"",
405
404
  "params": {
406
405
  "env-prefix": {
407
406
  "description": "Prefix to use for standard .env files e.g. TWIN_."
@@ -412,6 +411,9 @@
412
411
  "api-key": {
413
412
  "description": "The API key to associate with the tenant id."
414
413
  },
414
+ "organization-id": {
415
+ "description": "The organization DID to associate with the tenant."
416
+ },
415
417
  "label": {
416
418
  "description": "A descriptive label for the tenant."
417
419
  },
@@ -440,6 +442,9 @@
440
442
  "api-key": {
441
443
  "description": "The API key to associate with the tenant id."
442
444
  },
445
+ "organization-id": {
446
+ "description": "The organization DID to associate with the tenant."
447
+ },
443
448
  "label": {
444
449
  "description": "A descriptive label for the tenant."
445
450
  },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/node-core",
3
- "version": "0.0.3-next.54",
3
+ "version": "0.0.3-next.55",
4
4
  "description": "TWIN Node Core for serving APIs using the specified configuration",
5
5
  "repository": {
6
6
  "type": "git",