@twin.org/engine-types 0.0.3-next.26 → 0.0.3-next.27

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 (96) hide show
  1. package/README.md +1 -1
  2. package/docs/changelog.md +16 -1
  3. package/docs/examples.md +74 -1
  4. package/docs/reference/classes/EngineTypeHelper.md +3 -3
  5. package/docs/reference/functions/initialiseEntityStorageConnector.md +2 -2
  6. package/docs/reference/interfaces/IEngineConfig.md +70 -70
  7. package/docs/reference/type-aliases/AttestationConnectorConfig.md +3 -3
  8. package/docs/reference/type-aliases/BackgroundTaskComponentConfig.md +3 -3
  9. package/docs/reference/type-aliases/DataExtractorConnectorConfig.md +3 -3
  10. package/docs/reference/type-aliases/DltConfig.md +4 -4
  11. package/docs/reference/type-aliases/EventBusConnectorConfig.md +3 -3
  12. package/docs/reference/type-aliases/FederatedCatalogueFilterComponentConfig.md +2 -2
  13. package/docs/reference/type-aliases/IdentityProfileConnectorConfig.md +3 -3
  14. package/docs/reference/type-aliases/MessagingAdminComponentConfig.md +3 -3
  15. package/docs/reference/type-aliases/MessagingComponentConfig.md +3 -3
  16. package/docs/reference/type-aliases/RightsManagementPdpComponentConfig.md +3 -3
  17. package/docs/reference/type-aliases/RightsManagementPepComponentConfig.md +3 -3
  18. package/docs/reference/type-aliases/RightsManagementPipComponentConfig.md +3 -3
  19. package/docs/reference/type-aliases/RightsManagementPmpComponentConfig.md +3 -3
  20. package/docs/reference/type-aliases/RightsManagementPolicyExecutionActionComponentConfig.md +3 -3
  21. package/docs/reference/type-aliases/RightsManagementPolicyNegotiatorComponentConfig.md +3 -3
  22. package/docs/reference/type-aliases/RightsManagementPolicyObligationEnforcerComponentConfig.md +3 -3
  23. package/docs/reference/type-aliases/RightsManagementPolicyRequesterComponentConfig.md +3 -3
  24. package/docs/reference/type-aliases/RightsManagementPxpComponentConfig.md +3 -3
  25. package/docs/reference/type-aliases/TaskSchedulerComponentConfig.md +3 -3
  26. package/docs/reference/type-aliases/TelemetryConnectorConfig.md +3 -3
  27. package/docs/reference/type-aliases/TenantAdminComponentConfig.md +3 -3
  28. package/docs/reference/type-aliases/TrustComponentConfig.md +3 -3
  29. package/docs/reference/type-aliases/TrustGeneratorComponentConfig.md +2 -2
  30. package/docs/reference/type-aliases/TrustVerifierComponentConfig.md +3 -3
  31. package/docs/reference/variables/AttestationComponentType.md +2 -2
  32. package/docs/reference/variables/AttestationConnectorType.md +1 -1
  33. package/docs/reference/variables/AuditableItemGraphComponentType.md +2 -2
  34. package/docs/reference/variables/AuditableItemStreamComponentType.md +2 -2
  35. package/docs/reference/variables/BackgroundTaskComponentType.md +1 -1
  36. package/docs/reference/variables/BlobStorageComponentType.md +2 -2
  37. package/docs/reference/variables/BlobStorageConnectorType.md +6 -6
  38. package/docs/reference/variables/ContextIdHandlerComponentType.md +2 -2
  39. package/docs/reference/variables/DataConverterConnectorType.md +2 -2
  40. package/docs/reference/variables/DataExtractorConnectorType.md +1 -1
  41. package/docs/reference/variables/DataProcessingComponentType.md +2 -2
  42. package/docs/reference/variables/DataspaceControlPlaneComponentType.md +2 -2
  43. package/docs/reference/variables/DataspaceDataPlaneComponentType.md +3 -3
  44. package/docs/reference/variables/DltConfigType.md +1 -1
  45. package/docs/reference/variables/DocumentManagementComponentType.md +2 -2
  46. package/docs/reference/variables/EntityStorageComponentType.md +2 -2
  47. package/docs/reference/variables/EntityStorageConnectorType.md +10 -10
  48. package/docs/reference/variables/EventBusComponentType.md +2 -2
  49. package/docs/reference/variables/EventBusConnectorType.md +1 -1
  50. package/docs/reference/variables/FaucetConnectorType.md +2 -2
  51. package/docs/reference/variables/FederatedCatalogueComponentType.md +2 -2
  52. package/docs/reference/variables/FederatedCatalogueFilterComponentType.md +1 -1
  53. package/docs/reference/variables/IdentityComponentType.md +2 -2
  54. package/docs/reference/variables/IdentityConnectorType.md +2 -2
  55. package/docs/reference/variables/IdentityProfileComponentType.md +2 -2
  56. package/docs/reference/variables/IdentityProfileConnectorType.md +1 -1
  57. package/docs/reference/variables/IdentityResolverComponentType.md +2 -2
  58. package/docs/reference/variables/IdentityResolverConnectorType.md +3 -3
  59. package/docs/reference/variables/ImmutableProofComponentType.md +2 -2
  60. package/docs/reference/variables/LoggingComponentType.md +2 -2
  61. package/docs/reference/variables/LoggingConnectorType.md +3 -3
  62. package/docs/reference/variables/MessagingAdminComponentType.md +1 -1
  63. package/docs/reference/variables/MessagingComponentType.md +1 -1
  64. package/docs/reference/variables/MessagingEmailConnectorType.md +2 -2
  65. package/docs/reference/variables/MessagingPushNotificationConnectorType.md +2 -2
  66. package/docs/reference/variables/MessagingSmsConnectorType.md +2 -2
  67. package/docs/reference/variables/NftComponentType.md +2 -2
  68. package/docs/reference/variables/NftConnectorType.md +2 -2
  69. package/docs/reference/variables/RightsManagementPapComponentType.md +2 -2
  70. package/docs/reference/variables/RightsManagementPdpComponentType.md +1 -1
  71. package/docs/reference/variables/RightsManagementPepComponentType.md +2 -2
  72. package/docs/reference/variables/RightsManagementPipComponentType.md +1 -1
  73. package/docs/reference/variables/RightsManagementPmpComponentType.md +1 -1
  74. package/docs/reference/variables/RightsManagementPnapComponentType.md +2 -2
  75. package/docs/reference/variables/RightsManagementPnpComponentType.md +2 -2
  76. package/docs/reference/variables/RightsManagementPolicyArbiterComponentType.md +2 -2
  77. package/docs/reference/variables/RightsManagementPolicyEnforcementProcessorComponentType.md +2 -2
  78. package/docs/reference/variables/RightsManagementPolicyExecutionActionComponentType.md +1 -1
  79. package/docs/reference/variables/RightsManagementPolicyInformationSourceComponentType.md +2 -2
  80. package/docs/reference/variables/RightsManagementPolicyNegotiatorComponentType.md +1 -1
  81. package/docs/reference/variables/RightsManagementPolicyObligationEnforcerComponentType.md +1 -1
  82. package/docs/reference/variables/RightsManagementPolicyRequesterComponentType.md +1 -1
  83. package/docs/reference/variables/RightsManagementPxpComponentType.md +1 -1
  84. package/docs/reference/variables/SynchronisedStorageComponentType.md +2 -2
  85. package/docs/reference/variables/TaskSchedulerComponentType.md +1 -1
  86. package/docs/reference/variables/TelemetryComponentType.md +2 -2
  87. package/docs/reference/variables/TelemetryConnectorType.md +1 -1
  88. package/docs/reference/variables/TenantAdminComponentType.md +1 -1
  89. package/docs/reference/variables/TrustComponentType.md +1 -1
  90. package/docs/reference/variables/TrustGeneratorComponentType.md +1 -1
  91. package/docs/reference/variables/TrustVerifierComponentType.md +1 -1
  92. package/docs/reference/variables/VaultConnectorType.md +2 -2
  93. package/docs/reference/variables/VerifiableStorageComponentType.md +2 -2
  94. package/docs/reference/variables/VerifiableStorageConnectorType.md +2 -2
  95. package/docs/reference/variables/WalletConnectorType.md +2 -2
  96. package/package.json +4 -4
package/docs/reference/variables/TelemetryComponentType.md CHANGED
@@ -6,13 +6,13 @@ Telemetry component types.
6
6
 
7
7
  ## Type Declaration
8
8
 
9
- ### Service
9
+ ### Service {#service}
10
10
 
11
11
  > `readonly` **Service**: `"service"` = `"service"`
12
12
 
13
13
  Service.
14
14
 
15
- ### RestClient
15
+ ### RestClient {#restclient}
16
16
 
17
17
  > `readonly` **RestClient**: `"rest-client"` = `"rest-client"`
18
18
 
package/docs/reference/variables/TelemetryConnectorType.md CHANGED
@@ -6,7 +6,7 @@ Telemetry connector types.
6
6
 
7
7
  ## Type Declaration
8
8
 
9
- ### EntityStorage
9
+ ### EntityStorage {#entitystorage}
10
10
 
11
11
  > `readonly` **EntityStorage**: `"entity-storage"` = `"entity-storage"`
12
12
 
package/docs/reference/variables/TenantAdminComponentType.md CHANGED
@@ -6,7 +6,7 @@ Tenant admin component types.
6
6
 
7
7
  ## Type Declaration
8
8
 
9
- ### Service
9
+ ### Service {#service}
10
10
 
11
11
  > `readonly` **Service**: `"service"` = `"service"`
12
12
 
package/docs/reference/variables/TrustComponentType.md CHANGED
@@ -6,7 +6,7 @@ Trust component types.
6
6
 
7
7
  ## Type Declaration
8
8
 
9
- ### Service
9
+ ### Service {#service}
10
10
 
11
11
  > `readonly` **Service**: `"service"` = `"service"`
12
12
 
package/docs/reference/variables/TrustGeneratorComponentType.md CHANGED
@@ -6,7 +6,7 @@ Trust generator component types.
6
6
 
7
7
  ## Type Declaration
8
8
 
9
- ### JwtVerifiableCredential
9
+ ### JwtVerifiableCredential {#jwtverifiablecredential}
10
10
 
11
11
  > `readonly` **JwtVerifiableCredential**: `"jwt-verifiable-credential"` = `"jwt-verifiable-credential"`
12
12
 
package/docs/reference/variables/TrustVerifierComponentType.md CHANGED
@@ -6,7 +6,7 @@ Trust verifier component types.
6
6
 
7
7
  ## Type Declaration
8
8
 
9
- ### JwtVerifiableCredential
9
+ ### JwtVerifiableCredential {#jwtverifiablecredential}
10
10
 
11
11
  > `readonly` **JwtVerifiableCredential**: `"jwt-verifiable-credential"` = `"jwt-verifiable-credential"`
12
12
 
package/docs/reference/variables/VaultConnectorType.md CHANGED
@@ -6,13 +6,13 @@ Vault connector types.
6
6
 
7
7
  ## Type Declaration
8
8
 
9
- ### EntityStorage
9
+ ### EntityStorage {#entitystorage}
10
10
 
11
11
  > `readonly` **EntityStorage**: `"entity-storage"` = `"entity-storage"`
12
12
 
13
13
  Entity storage.
14
14
 
15
- ### Hashicorp
15
+ ### Hashicorp {#hashicorp}
16
16
 
17
17
  > `readonly` **Hashicorp**: `"hashicorp"` = `"hashicorp"`
18
18
 
package/docs/reference/variables/VerifiableStorageComponentType.md CHANGED
@@ -6,13 +6,13 @@ Verifiable storage component types.
6
6
 
7
7
  ## Type Declaration
8
8
 
9
- ### Service
9
+ ### Service {#service}
10
10
 
11
11
  > `readonly` **Service**: `"service"` = `"service"`
12
12
 
13
13
  Service.
14
14
 
15
- ### RestClient
15
+ ### RestClient {#restclient}
16
16
 
17
17
  > `readonly` **RestClient**: `"rest-client"` = `"rest-client"`
18
18
 
package/docs/reference/variables/VerifiableStorageConnectorType.md CHANGED
@@ -6,13 +6,13 @@ Verifiable storage connector types.
6
6
 
7
7
  ## Type Declaration
8
8
 
9
- ### EntityStorage
9
+ ### EntityStorage {#entitystorage}
10
10
 
11
11
  > `readonly` **EntityStorage**: `"entity-storage"` = `"entity-storage"`
12
12
 
13
13
  Entity storage.
14
14
 
15
- ### Iota
15
+ ### Iota {#iota}
16
16
 
17
17
  > `readonly` **Iota**: `"iota"` = `"iota"`
18
18
 
package/docs/reference/variables/WalletConnectorType.md CHANGED
@@ -6,13 +6,13 @@ Wallet connector types.
6
6
 
7
7
  ## Type Declaration
8
8
 
9
- ### EntityStorage
9
+ ### EntityStorage {#entitystorage}
10
10
 
11
11
  > `readonly` **EntityStorage**: `"entity-storage"` = `"entity-storage"`
12
12
 
13
13
  Entity storage.
14
14
 
15
- ### Iota
15
+ ### Iota {#iota}
16
16
 
17
17
  > `readonly` **Iota**: `"iota"` = `"iota"`
18
18
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@twin.org/engine-types",
3
- "version": "0.0.3-next.26",
4
- "description": "Types to use in an engine.",
3
+ "version": "0.0.3-next.27",
4
+ "description": "Component and connector type definitions with configuration helpers for engine composition.",
5
5
  "repository": {
6
6
  "type": "git",
7
7
  "url": "git+https://github.com/twinfoundation/engine.git",
@@ -56,8 +56,8 @@
56
56
  "@twin.org/document-management-models": "next",
57
57
  "@twin.org/document-management-rest-client": "next",
58
58
  "@twin.org/document-management-service": "next",
59
- "@twin.org/engine-core": "0.0.3-next.26",
60
- "@twin.org/engine-models": "0.0.3-next.26",
59
+ "@twin.org/engine-core": "0.0.3-next.27",
60
+ "@twin.org/engine-models": "0.0.3-next.27",
61
61
  "@twin.org/entity": "next",
62
62
  "@twin.org/entity-storage-connector-cosmosdb": "next",
63
63
  "@twin.org/entity-storage-connector-dynamodb": "next",