@twin.org/engine-types 0.0.2-next.1 → 0.0.2-next.2

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 (85) hide show
  1. package/dist/cjs/index.cjs +212 -45
  2. package/dist/esm/index.mjs +214 -47
  3. package/dist/types/components/identity.d.ts +1 -1
  4. package/dist/types/components/identityProfile.d.ts +1 -1
  5. package/dist/types/components/telemetry.d.ts +1 -1
  6. package/dist/types/components/vault.d.ts +1 -1
  7. package/dist/types/components/verifiableStorage.d.ts +1 -1
  8. package/dist/types/models/config/attestationComponentConfig.d.ts +4 -0
  9. package/dist/types/models/config/auditableItemGraphComponentConfig.d.ts +4 -0
  10. package/dist/types/models/config/auditableItemStreamComponentConfig.d.ts +4 -0
  11. package/dist/types/models/config/blobStorageComponentConfig.d.ts +4 -0
  12. package/dist/types/models/config/dataProcessingComponentConfig.d.ts +4 -0
  13. package/dist/types/models/config/documentManagementComponentConfig.d.ts +5 -1
  14. package/dist/types/models/config/entityStorageComponentConfig.d.ts +9 -0
  15. package/dist/types/models/config/eventBusComponentConfig.d.ts +4 -0
  16. package/dist/types/models/config/federatedCatalogueComponentConfig.d.ts +4 -0
  17. package/dist/types/models/config/identityComponentConfig.d.ts +4 -0
  18. package/dist/types/models/config/identityProfileComponentConfig.d.ts +4 -0
  19. package/dist/types/models/config/identityResolverComponentConfig.d.ts +6 -2
  20. package/dist/types/models/config/immutableProofComponentConfig.d.ts +4 -0
  21. package/dist/types/models/config/loggingComponentConfig.d.ts +4 -0
  22. package/dist/types/models/config/nftComponentConfig.d.ts +4 -0
  23. package/dist/types/models/config/rightsManagementComponentConfig.d.ts +4 -0
  24. package/dist/types/models/config/taskSchedulerComponentConfig.d.ts +1 -1
  25. package/dist/types/models/config/telemetryComponentConfig.d.ts +4 -0
  26. package/dist/types/models/config/verifiableStorageComponentConfig.d.ts +4 -0
  27. package/dist/types/models/types/attestationComponentType.d.ts +4 -0
  28. package/dist/types/models/types/auditableItemGraphComponentType.d.ts +4 -0
  29. package/dist/types/models/types/auditableItemStreamComponentType.d.ts +4 -0
  30. package/dist/types/models/types/blobStorageComponentType.d.ts +4 -0
  31. package/dist/types/models/types/dataProcessingComponentType.d.ts +4 -0
  32. package/dist/types/models/types/documentManagementComponentType.d.ts +4 -0
  33. package/dist/types/models/types/entityStorageComponentType.d.ts +4 -0
  34. package/dist/types/models/types/eventBusComponentType.d.ts +4 -0
  35. package/dist/types/models/types/federatedCatalogueComponentType.d.ts +4 -0
  36. package/dist/types/models/types/identityComponentType.d.ts +4 -0
  37. package/dist/types/models/types/identityProfileComponentType.d.ts +4 -0
  38. package/dist/types/models/types/identityResolverComponentType.d.ts +4 -0
  39. package/dist/types/models/types/immutableProofComponentType.d.ts +4 -0
  40. package/dist/types/models/types/loggingComponentType.d.ts +4 -0
  41. package/dist/types/models/types/nftComponentType.d.ts +4 -0
  42. package/dist/types/models/types/rightsManagementComponentType.d.ts +4 -0
  43. package/dist/types/models/types/taskSchedulerComponentType.d.ts +1 -1
  44. package/dist/types/models/types/telemetryComponentType.d.ts +4 -0
  45. package/dist/types/models/types/verifiableStorageComponentType.d.ts +4 -0
  46. package/docs/changelog.md +14 -0
  47. package/docs/reference/type-aliases/AttestationComponentConfig.md +1 -13
  48. package/docs/reference/type-aliases/AuditableItemGraphComponentConfig.md +1 -13
  49. package/docs/reference/type-aliases/AuditableItemStreamComponentConfig.md +1 -13
  50. package/docs/reference/type-aliases/BlobStorageComponentConfig.md +1 -13
  51. package/docs/reference/type-aliases/DataProcessingComponentConfig.md +1 -13
  52. package/docs/reference/type-aliases/DocumentManagementComponentConfig.md +2 -14
  53. package/docs/reference/type-aliases/EntityStorageComponentConfig.md +1 -13
  54. package/docs/reference/type-aliases/EventBusComponentConfig.md +1 -13
  55. package/docs/reference/type-aliases/FederatedCatalogueComponentConfig.md +1 -13
  56. package/docs/reference/type-aliases/IdentityComponentConfig.md +1 -13
  57. package/docs/reference/type-aliases/IdentityProfileComponentConfig.md +1 -13
  58. package/docs/reference/type-aliases/IdentityResolverComponentConfig.md +1 -13
  59. package/docs/reference/type-aliases/ImmutableProofComponentConfig.md +1 -13
  60. package/docs/reference/type-aliases/LoggingComponentConfig.md +1 -13
  61. package/docs/reference/type-aliases/NftComponentConfig.md +1 -13
  62. package/docs/reference/type-aliases/RightsManagementComponentConfig.md +1 -13
  63. package/docs/reference/type-aliases/TaskSchedulerComponentConfig.md +1 -1
  64. package/docs/reference/type-aliases/TelemetryComponentConfig.md +1 -13
  65. package/docs/reference/type-aliases/VerifiableStorageComponentConfig.md +1 -13
  66. package/docs/reference/variables/AttestationComponentType.md +6 -0
  67. package/docs/reference/variables/AuditableItemGraphComponentType.md +6 -0
  68. package/docs/reference/variables/AuditableItemStreamComponentType.md +6 -0
  69. package/docs/reference/variables/BlobStorageComponentType.md +6 -0
  70. package/docs/reference/variables/DataProcessingComponentType.md +6 -0
  71. package/docs/reference/variables/DocumentManagementComponentType.md +6 -0
  72. package/docs/reference/variables/EntityStorageComponentType.md +6 -0
  73. package/docs/reference/variables/EventBusComponentType.md +6 -0
  74. package/docs/reference/variables/FederatedCatalogueComponentType.md +6 -0
  75. package/docs/reference/variables/IdentityComponentType.md +6 -0
  76. package/docs/reference/variables/IdentityProfileComponentType.md +6 -0
  77. package/docs/reference/variables/IdentityResolverComponentType.md +6 -0
  78. package/docs/reference/variables/ImmutableProofComponentType.md +6 -0
  79. package/docs/reference/variables/LoggingComponentType.md +6 -0
  80. package/docs/reference/variables/NftComponentType.md +6 -0
  81. package/docs/reference/variables/RightsManagementComponentType.md +6 -0
  82. package/docs/reference/variables/TaskSchedulerComponentType.md +2 -2
  83. package/docs/reference/variables/TelemetryComponentType.md +6 -0
  84. package/docs/reference/variables/VerifiableStorageComponentType.md +6 -0
  85. package/package.json +18 -2
@@ -1,3 +1,4 @@
1
+ import type { IBaseRestClientConfig } from "@twin.org/api-models";
1
2
  import type { IAuditableItemGraphServiceConstructorOptions } from "@twin.org/auditable-item-graph-service";
2
3
  import type { AuditableItemGraphComponentType } from "../types/auditableItemGraphComponentType";
3
4
  /**
@@ -6,4 +7,7 @@ import type { AuditableItemGraphComponentType } from "../types/auditableItemGrap
6
7
  export type AuditableItemGraphComponentConfig = {
7
8
  type: typeof AuditableItemGraphComponentType.Service;
8
9
  options?: IAuditableItemGraphServiceConstructorOptions;
10
+ } | {
11
+ type: typeof AuditableItemGraphComponentType.RestClient;
12
+ options: IBaseRestClientConfig;
9
13
  };
@@ -1,3 +1,4 @@
1
+ import type { IBaseRestClientConfig } from "@twin.org/api-models";
1
2
  import type { IAuditableItemStreamServiceConstructorOptions } from "@twin.org/auditable-item-stream-service";
2
3
  import type { AuditableItemStreamComponentType } from "../types/auditableItemStreamComponentType";
3
4
  /**
@@ -6,4 +7,7 @@ import type { AuditableItemStreamComponentType } from "../types/auditableItemStr
6
7
  export type AuditableItemStreamComponentConfig = {
7
8
  type: typeof AuditableItemStreamComponentType.Service;
8
9
  options?: IAuditableItemStreamServiceConstructorOptions;
10
+ } | {
11
+ type: typeof AuditableItemStreamComponentType.RestClient;
12
+ options: IBaseRestClientConfig;
9
13
  };
@@ -1,3 +1,4 @@
1
+ import type { IBaseRestClientConfig } from "@twin.org/api-models";
1
2
  import type { IBlobStorageServiceConstructorOptions } from "@twin.org/blob-storage-service";
2
3
  import type { BlobStorageComponentType } from "../types/blobStorageComponentType";
3
4
  /**
@@ -6,4 +7,7 @@ import type { BlobStorageComponentType } from "../types/blobStorageComponentType
6
7
  export type BlobStorageComponentConfig = {
7
8
  type: typeof BlobStorageComponentType.Service;
8
9
  options?: IBlobStorageServiceConstructorOptions;
10
+ } | {
11
+ type: typeof BlobStorageComponentType.RestClient;
12
+ options: IBaseRestClientConfig;
9
13
  };
@@ -1,3 +1,4 @@
1
+ import type { IBaseRestClientConfig } from "@twin.org/api-models";
1
2
  import type { IDataProcessingServiceConstructorOptions } from "@twin.org/data-processing-service";
2
3
  import type { DataProcessingComponentType } from "../types/dataProcessingComponentType";
3
4
  /**
@@ -6,4 +7,7 @@ import type { DataProcessingComponentType } from "../types/dataProcessingCompone
6
7
  export type DataProcessingComponentConfig = {
7
8
  type: typeof DataProcessingComponentType.Service;
8
9
  options?: IDataProcessingServiceConstructorOptions;
10
+ } | {
11
+ type: typeof DataProcessingComponentType.RestClient;
12
+ options: IBaseRestClientConfig;
9
13
  };
@@ -1,9 +1,13 @@
1
+ import type { IBaseRestClientConfig } from "@twin.org/api-models";
1
2
  import type { IDocumentManagementServiceConstructorOptions } from "@twin.org/document-management-service";
2
3
  import type { DocumentManagementComponentType } from "../types/documentManagementComponentType";
3
4
  /**
4
- * Data processing component config types.
5
+ * Document management component config types.
5
6
  */
6
7
  export type DocumentManagementComponentConfig = {
7
8
  type: typeof DocumentManagementComponentType.Service;
8
9
  options?: IDocumentManagementServiceConstructorOptions;
10
+ } | {
11
+ type: typeof DocumentManagementComponentType.RestClient;
12
+ options: IBaseRestClientConfig;
9
13
  };
@@ -1,3 +1,4 @@
1
+ import type { IBaseRestClientConfig } from "@twin.org/api-models";
1
2
  import type { IEntityStorageServiceConstructorOptions } from "@twin.org/entity-storage-service";
2
3
  import type { EntityStorageComponentType } from "../types/entityStorageComponentType";
3
4
  /**
@@ -6,4 +7,12 @@ import type { EntityStorageComponentType } from "../types/entityStorageComponent
6
7
  export type EntityStorageComponentConfig = {
7
8
  type: typeof EntityStorageComponentType.Service;
8
9
  options: IEntityStorageServiceConstructorOptions;
10
+ } | {
11
+ type: typeof EntityStorageComponentType.RestClient;
12
+ options: IBaseRestClientConfig & {
13
+ /**
14
+ * The type of the entity storage.
15
+ */
16
+ entityStorageType: string;
17
+ };
9
18
  };
@@ -1,4 +1,5 @@
1
1
  import type { IEventBusServiceConstructorOptions } from "@twin.org/event-bus-service";
2
+ import type { IEventBusSocketClientConstructorOptions } from "@twin.org/event-bus-socket-client";
2
3
  import type { EventBusComponentType } from "../types/eventBusComponentType";
3
4
  /**
4
5
  * Event bus storage component config types.
@@ -6,4 +7,7 @@ import type { EventBusComponentType } from "../types/eventBusComponentType";
6
7
  export type EventBusComponentConfig = {
7
8
  type: typeof EventBusComponentType.Service;
8
9
  options?: IEventBusServiceConstructorOptions;
10
+ } | {
11
+ type: typeof EventBusComponentType.SocketClient;
12
+ options: IEventBusSocketClientConstructorOptions;
9
13
  };
@@ -1,3 +1,4 @@
1
+ import type { IBaseRestClientConfig } from "@twin.org/api-models";
1
2
  import type { IFederatedCatalogueServiceConstructorOptions } from "@twin.org/federated-catalogue-service";
2
3
  import type { FederatedCatalogueComponentType } from "../types/federatedCatalogueComponentType";
3
4
  /**
@@ -6,4 +7,7 @@ import type { FederatedCatalogueComponentType } from "../types/federatedCatalogu
6
7
  export type FederatedCatalogueComponentConfig = {
7
8
  type: typeof FederatedCatalogueComponentType.Service;
8
9
  options: IFederatedCatalogueServiceConstructorOptions;
10
+ } | {
11
+ type: typeof FederatedCatalogueComponentType.RestClient;
12
+ options: IBaseRestClientConfig;
9
13
  };
@@ -1,3 +1,4 @@
1
+ import type { IBaseRestClientConfig } from "@twin.org/api-models";
1
2
  import type { IIdentityServiceConstructorOptions } from "@twin.org/identity-service";
2
3
  import type { IdentityComponentType } from "../types/identityComponentType";
3
4
  /**
@@ -6,4 +7,7 @@ import type { IdentityComponentType } from "../types/identityComponentType";
6
7
  export type IdentityComponentConfig = {
7
8
  type: typeof IdentityComponentType.Service;
8
9
  options?: IIdentityServiceConstructorOptions;
10
+ } | {
11
+ type: typeof IdentityComponentType.RestClient;
12
+ options: IBaseRestClientConfig;
9
13
  };
@@ -1,3 +1,4 @@
1
+ import type { IBaseRestClientConfig } from "@twin.org/api-models";
1
2
  import type { IIdentityProfileServiceConstructorOptions } from "@twin.org/identity-service";
2
3
  import type { IdentityComponentType } from "../types/identityComponentType";
3
4
  /**
@@ -6,4 +7,7 @@ import type { IdentityComponentType } from "../types/identityComponentType";
6
7
  export type IdentityProfileComponentConfig = {
7
8
  type: typeof IdentityComponentType.Service;
8
9
  options?: IIdentityProfileServiceConstructorOptions;
10
+ } | {
11
+ type: typeof IdentityComponentType.RestClient;
12
+ options: IBaseRestClientConfig;
9
13
  };
@@ -1,9 +1,13 @@
1
+ import type { IBaseRestClientConfig } from "@twin.org/api-models";
1
2
  import type { IIdentityResolverServiceConstructorOptions } from "@twin.org/identity-service";
2
- import type { IdentityComponentType } from "../types/identityComponentType";
3
+ import type { IdentityResolverComponentType } from "../types/identityResolverComponentType";
3
4
  /**
4
5
  * Identity resolver component config types.
5
6
  */
6
7
  export type IdentityResolverComponentConfig = {
7
- type: typeof IdentityComponentType.Service;
8
+ type: typeof IdentityResolverComponentType.Service;
8
9
  options?: IIdentityResolverServiceConstructorOptions;
10
+ } | {
11
+ type: typeof IdentityResolverComponentType.RestClient;
12
+ options: IBaseRestClientConfig;
9
13
  };
@@ -1,3 +1,4 @@
1
+ import type { IBaseRestClientConfig } from "@twin.org/api-models";
1
2
  import type { IImmutableProofServiceConstructorOptions } from "@twin.org/immutable-proof-service";
2
3
  import type { ImmutableProofComponentType } from "../types/immutableProofComponentType";
3
4
  /**
@@ -6,4 +7,7 @@ import type { ImmutableProofComponentType } from "../types/immutableProofCompone
6
7
  export type ImmutableProofComponentConfig = {
7
8
  type: typeof ImmutableProofComponentType.Service;
8
9
  options?: IImmutableProofServiceConstructorOptions;
10
+ } | {
11
+ type: typeof ImmutableProofComponentType.RestClient;
12
+ options: IBaseRestClientConfig;
9
13
  };
@@ -1,3 +1,4 @@
1
+ import type { IBaseRestClientConfig } from "@twin.org/api-models";
1
2
  import type { ILoggingServiceConstructorOptions } from "@twin.org/logging-service";
2
3
  import type { LoggingComponentType } from "../types/loggingComponentType";
3
4
  /**
@@ -6,4 +7,7 @@ import type { LoggingComponentType } from "../types/loggingComponentType";
6
7
  export type LoggingComponentConfig = {
7
8
  type: typeof LoggingComponentType.Service;
8
9
  options?: ILoggingServiceConstructorOptions;
10
+ } | {
11
+ type: typeof LoggingComponentType.RestClient;
12
+ options: IBaseRestClientConfig;
9
13
  };
@@ -1,3 +1,4 @@
1
+ import type { IBaseRestClientConfig } from "@twin.org/api-models";
1
2
  import type { INftServiceConstructorOptions } from "@twin.org/nft-service";
2
3
  import type { NftComponentType } from "../types/nftComponentType";
3
4
  /**
@@ -6,4 +7,7 @@ import type { NftComponentType } from "../types/nftComponentType";
6
7
  export type NftComponentConfig = {
7
8
  type: typeof NftComponentType.Service;
8
9
  options?: INftServiceConstructorOptions;
10
+ } | {
11
+ type: typeof NftComponentType.RestClient;
12
+ options: IBaseRestClientConfig;
9
13
  };
@@ -1,3 +1,4 @@
1
+ import type { IBaseRestClientConfig } from "@twin.org/api-models";
1
2
  import type { IRightsManagementServiceConstructorOptions } from "@twin.org/rights-management-service";
2
3
  import type { RightsManagementComponentType } from "../types/rightsManagementComponentType";
3
4
  /**
@@ -6,4 +7,7 @@ import type { RightsManagementComponentType } from "../types/rightsManagementCom
6
7
  export type RightsManagementComponentConfig = {
7
8
  type: typeof RightsManagementComponentType.Service;
8
9
  options?: IRightsManagementServiceConstructorOptions;
10
+ } | {
11
+ type: typeof RightsManagementComponentType.RestClient;
12
+ options: IBaseRestClientConfig;
9
13
  };
@@ -4,6 +4,6 @@ import type { TaskSchedulerComponentType } from "../types/taskSchedulerComponent
4
4
  * Background task scheduled component config types.
5
5
  */
6
6
  export type TaskSchedulerComponentConfig = {
7
- type: typeof TaskSchedulerComponentType.Default;
7
+ type: typeof TaskSchedulerComponentType.Service;
8
8
  options?: ITaskSchedulerConstructorOptions;
9
9
  };
@@ -1,3 +1,4 @@
1
+ import type { IBaseRestClientConfig } from "@twin.org/api-models";
1
2
  import type { ITelemetryServiceConstructorOptions } from "@twin.org/telemetry-service";
2
3
  import type { TelemetryComponentType } from "../types/telemetryComponentType";
3
4
  /**
@@ -6,4 +7,7 @@ import type { TelemetryComponentType } from "../types/telemetryComponentType";
6
7
  export type TelemetryComponentConfig = {
7
8
  type: typeof TelemetryComponentType.Service;
8
9
  options?: ITelemetryServiceConstructorOptions;
10
+ } | {
11
+ type: typeof TelemetryComponentType.RestClient;
12
+ options: IBaseRestClientConfig;
9
13
  };
@@ -1,3 +1,4 @@
1
+ import type { IBaseRestClientConfig } from "@twin.org/api-models";
1
2
  import type { IVerifiableStorageServiceConstructorOptions } from "@twin.org/verifiable-storage-service";
2
3
  import type { VerifiableStorageComponentType } from "../types/verifiableStorageComponentType";
3
4
  /**
@@ -6,4 +7,7 @@ import type { VerifiableStorageComponentType } from "../types/verifiableStorageC
6
7
  export type VerifiableStorageComponentConfig = {
7
8
  type: typeof VerifiableStorageComponentType.Service;
8
9
  options?: IVerifiableStorageServiceConstructorOptions;
10
+ } | {
11
+ type: typeof VerifiableStorageComponentType.RestClient;
12
+ options: IBaseRestClientConfig;
9
13
  };
@@ -6,6 +6,10 @@ export declare const AttestationComponentType: {
6
6
  * Service.
7
7
  */
8
8
  readonly Service: "service";
9
+ /**
10
+ * REST client.
11
+ */
12
+ readonly RestClient: "rest-client";
9
13
  };
10
14
  /**
11
15
  * Attestation component types.
@@ -6,6 +6,10 @@ export declare const AuditableItemGraphComponentType: {
6
6
  * Service.
7
7
  */
8
8
  readonly Service: "service";
9
+ /**
10
+ * REST client.
11
+ */
12
+ readonly RestClient: "rest-client";
9
13
  };
10
14
  /**
11
15
  * Auditable item graph component types.
@@ -6,6 +6,10 @@ export declare const AuditableItemStreamComponentType: {
6
6
  * Service.
7
7
  */
8
8
  readonly Service: "service";
9
+ /**
10
+ * REST client.
11
+ */
12
+ readonly RestClient: "rest-client";
9
13
  };
10
14
  /**
11
15
  * Auditable item stream component types.
@@ -6,6 +6,10 @@ export declare const BlobStorageComponentType: {
6
6
  * Service.
7
7
  */
8
8
  readonly Service: "service";
9
+ /**
10
+ * REST client.
11
+ */
12
+ readonly RestClient: "rest-client";
9
13
  };
10
14
  /**
11
15
  * Blob storage component types.
@@ -6,6 +6,10 @@ export declare const DataProcessingComponentType: {
6
6
  * Service.
7
7
  */
8
8
  readonly Service: "service";
9
+ /**
10
+ * REST client.
11
+ */
12
+ readonly RestClient: "rest-client";
9
13
  };
10
14
  /**
11
15
  * Data processing component types.
@@ -6,6 +6,10 @@ export declare const DocumentManagementComponentType: {
6
6
  * Service.
7
7
  */
8
8
  readonly Service: "service";
9
+ /**
10
+ * REST client.
11
+ */
12
+ readonly RestClient: "rest-client";
9
13
  };
10
14
  /**
11
15
  * Document management component types.
@@ -6,6 +6,10 @@ export declare const EntityStorageComponentType: {
6
6
  * Service.
7
7
  */
8
8
  readonly Service: "service";
9
+ /**
10
+ * REST client.
11
+ */
12
+ readonly RestClient: "rest-client";
9
13
  };
10
14
  /**
11
15
  * Entity storage component types.
@@ -6,6 +6,10 @@ export declare const EventBusComponentType: {
6
6
  * Service.
7
7
  */
8
8
  readonly Service: "service";
9
+ /**
10
+ * Socket client.
11
+ */
12
+ readonly SocketClient: "socket-client";
9
13
  };
10
14
  /**
11
15
  * Event bus component types.
@@ -6,6 +6,10 @@ export declare const FederatedCatalogueComponentType: {
6
6
  * Service.
7
7
  */
8
8
  readonly Service: "service";
9
+ /**
10
+ * REST client.
11
+ */
12
+ readonly RestClient: "rest-client";
9
13
  };
10
14
  /**
11
15
  * Federated catalogue component types.
@@ -6,6 +6,10 @@ export declare const IdentityComponentType: {
6
6
  * Service.
7
7
  */
8
8
  readonly Service: "service";
9
+ /**
10
+ * REST client.
11
+ */
12
+ readonly RestClient: "rest-client";
9
13
  };
10
14
  /**
11
15
  * Identity component types.
@@ -6,6 +6,10 @@ export declare const IdentityProfileComponentType: {
6
6
  * Service.
7
7
  */
8
8
  readonly Service: "service";
9
+ /**
10
+ * REST client.
11
+ */
12
+ readonly RestClient: "rest-client";
9
13
  };
10
14
  /**
11
15
  * Identity profile component types.
@@ -6,6 +6,10 @@ export declare const IdentityResolverComponentType: {
6
6
  * Service.
7
7
  */
8
8
  readonly Service: "service";
9
+ /**
10
+ * REST client.
11
+ */
12
+ readonly RestClient: "rest-client";
9
13
  };
10
14
  /**
11
15
  * Identity resolver component types.
@@ -6,6 +6,10 @@ export declare const ImmutableProofComponentType: {
6
6
  * Service.
7
7
  */
8
8
  readonly Service: "service";
9
+ /**
10
+ * REST client.
11
+ */
12
+ readonly RestClient: "rest-client";
9
13
  };
10
14
  /**
11
15
  * Immutable proof component types.
@@ -6,6 +6,10 @@ export declare const LoggingComponentType: {
6
6
  * Service.
7
7
  */
8
8
  readonly Service: "service";
9
+ /**
10
+ * REST client.
11
+ */
12
+ readonly RestClient: "rest-client";
9
13
  };
10
14
  /**
11
15
  * Logging component types.
@@ -6,6 +6,10 @@ export declare const NftComponentType: {
6
6
  * Service.
7
7
  */
8
8
  readonly Service: "service";
9
+ /**
10
+ * REST client.
11
+ */
12
+ readonly RestClient: "rest-client";
9
13
  };
10
14
  /**
11
15
  * NFT component types.
@@ -6,6 +6,10 @@ export declare const RightsManagementComponentType: {
6
6
  * Service.
7
7
  */
8
8
  readonly Service: "service";
9
+ /**
10
+ * REST client.
11
+ */
12
+ readonly RestClient: "rest-client";
9
13
  };
10
14
  /**
11
15
  * Rights management component types.
@@ -5,7 +5,7 @@ export declare const TaskSchedulerComponentType: {
5
5
  /**
6
6
  * Task scheduler.
7
7
  */
8
- readonly Default: "default";
8
+ readonly Service: "service";
9
9
  };
10
10
  /**
11
11
  * Task scheduler component types.
@@ -6,6 +6,10 @@ export declare const TelemetryComponentType: {
6
6
  * Service.
7
7
  */
8
8
  readonly Service: "service";
9
+ /**
10
+ * REST client.
11
+ */
12
+ readonly RestClient: "rest-client";
9
13
  };
10
14
  /**
11
15
  * Telemetry component types.
@@ -6,6 +6,10 @@ export declare const VerifiableStorageComponentType: {
6
6
  * Service.
7
7
  */
8
8
  readonly Service: "service";
9
+ /**
10
+ * REST client.
11
+ */
12
+ readonly RestClient: "rest-client";
9
13
  };
10
14
  /**
11
15
  * Verifiable storage component types.
package/docs/changelog.md CHANGED
@@ -1,5 +1,19 @@
1
1
  # @twin.org/engine-types - Changelog
2
2
 
3
+ ## [0.0.2-next.2](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.2-next.1...engine-types-v0.0.2-next.2) (2025-07-21)
4
+
5
+
6
+ ### Features
7
+
8
+ * add rest clients as components ([c6f956a](https://github.com/twinfoundation/engine/commit/c6f956afe4fc22cd552174539c92a109448dc242))
9
+
10
+
11
+ ### Dependencies
12
+
13
+ * The following workspace dependencies were updated
14
+ * dependencies
15
+ * @twin.org/engine-models bumped from 0.0.2-next.1 to 0.0.2-next.2
16
+
3
17
  ## [0.0.2-next.1](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.2-next.0...engine-types-v0.0.2-next.1) (2025-07-11)
4
18
 
5
19
 
@@ -1,17 +1,5 @@
1
1
  # Type Alias: AttestationComponentConfig
2
2
 
3
- > **AttestationComponentConfig** = `object`
3
+ > **AttestationComponentConfig** = \{ `type`: *typeof* [`Service`](../variables/AttestationComponentType.md#service); `options?`: `IAttestationServiceConstructorOptions`; \} \| \{ `type`: *typeof* [`RestClient`](../variables/AttestationComponentType.md#restclient); `options`: `IBaseRestClientConfig`; \}
4
4
 
5
5
  Attestation component config types.
6
-
7
- ## Properties
8
-
9
- ### type
10
-
11
- > **type**: *typeof* [`Service`](../variables/AttestationComponentType.md#service)
12
-
13
- ***
14
-
15
- ### options?
16
-
17
- > `optional` **options**: `IAttestationServiceConstructorOptions`
@@ -1,17 +1,5 @@
1
1
  # Type Alias: AuditableItemGraphComponentConfig
2
2
 
3
- > **AuditableItemGraphComponentConfig** = `object`
3
+ > **AuditableItemGraphComponentConfig** = \{ `type`: *typeof* [`Service`](../variables/AuditableItemGraphComponentType.md#service); `options?`: `IAuditableItemGraphServiceConstructorOptions`; \} \| \{ `type`: *typeof* [`RestClient`](../variables/AuditableItemGraphComponentType.md#restclient); `options`: `IBaseRestClientConfig`; \}
4
4
 
5
5
  Auditable item graph component config types.
6
-
7
- ## Properties
8
-
9
- ### type
10
-
11
- > **type**: *typeof* [`Service`](../variables/AuditableItemGraphComponentType.md#service)
12
-
13
- ***
14
-
15
- ### options?
16
-
17
- > `optional` **options**: `IAuditableItemGraphServiceConstructorOptions`
@@ -1,17 +1,5 @@
1
1
  # Type Alias: AuditableItemStreamComponentConfig
2
2
 
3
- > **AuditableItemStreamComponentConfig** = `object`
3
+ > **AuditableItemStreamComponentConfig** = \{ `type`: *typeof* [`Service`](../variables/AuditableItemStreamComponentType.md#service); `options?`: `IAuditableItemStreamServiceConstructorOptions`; \} \| \{ `type`: *typeof* [`RestClient`](../variables/AuditableItemStreamComponentType.md#restclient); `options`: `IBaseRestClientConfig`; \}
4
4
 
5
5
  Auditable item stream component config types.
6
-
7
- ## Properties
8
-
9
- ### type
10
-
11
- > **type**: *typeof* [`Service`](../variables/AuditableItemStreamComponentType.md#service)
12
-
13
- ***
14
-
15
- ### options?
16
-
17
- > `optional` **options**: `IAuditableItemStreamServiceConstructorOptions`
@@ -1,17 +1,5 @@
1
1
  # Type Alias: BlobStorageComponentConfig
2
2
 
3
- > **BlobStorageComponentConfig** = `object`
3
+ > **BlobStorageComponentConfig** = \{ `type`: *typeof* [`Service`](../variables/BlobStorageComponentType.md#service); `options?`: `IBlobStorageServiceConstructorOptions`; \} \| \{ `type`: *typeof* [`RestClient`](../variables/BlobStorageComponentType.md#restclient); `options`: `IBaseRestClientConfig`; \}
4
4
 
5
5
  Blob storage component config types.
6
-
7
- ## Properties
8
-
9
- ### type
10
-
11
- > **type**: *typeof* [`Service`](../variables/BlobStorageComponentType.md#service)
12
-
13
- ***
14
-
15
- ### options?
16
-
17
- > `optional` **options**: `IBlobStorageServiceConstructorOptions`
@@ -1,17 +1,5 @@
1
1
  # Type Alias: DataProcessingComponentConfig
2
2
 
3
- > **DataProcessingComponentConfig** = `object`
3
+ > **DataProcessingComponentConfig** = \{ `type`: *typeof* [`Service`](../variables/DataProcessingComponentType.md#service); `options?`: `IDataProcessingServiceConstructorOptions`; \} \| \{ `type`: *typeof* [`RestClient`](../variables/DataProcessingComponentType.md#restclient); `options`: `IBaseRestClientConfig`; \}
4
4
 
5
5
  Data processing component config types.
6
-
7
- ## Properties
8
-
9
- ### type
10
-
11
- > **type**: *typeof* [`Service`](../variables/DataProcessingComponentType.md#service)
12
-
13
- ***
14
-
15
- ### options?
16
-
17
- > `optional` **options**: `IDataProcessingServiceConstructorOptions`
@@ -1,17 +1,5 @@
1
1
  # Type Alias: DocumentManagementComponentConfig
2
2
 
3
- > **DocumentManagementComponentConfig** = `object`
3
+ > **DocumentManagementComponentConfig** = \{ `type`: *typeof* [`Service`](../variables/DocumentManagementComponentType.md#service); `options?`: `IDocumentManagementServiceConstructorOptions`; \} \| \{ `type`: *typeof* [`RestClient`](../variables/DocumentManagementComponentType.md#restclient); `options`: `IBaseRestClientConfig`; \}
4
4
 
5
- Data processing component config types.
6
-
7
- ## Properties
8
-
9
- ### type
10
-
11
- > **type**: *typeof* [`Service`](../variables/DocumentManagementComponentType.md#service)
12
-
13
- ***
14
-
15
- ### options?
16
-
17
- > `optional` **options**: `IDocumentManagementServiceConstructorOptions`
5
+ Document management component config types.
@@ -1,17 +1,5 @@
1
1
  # Type Alias: EntityStorageComponentConfig
2
2
 
3
- > **EntityStorageComponentConfig** = `object`
3
+ > **EntityStorageComponentConfig** = \{ `type`: *typeof* [`Service`](../variables/EntityStorageComponentType.md#service); `options`: `IEntityStorageServiceConstructorOptions`; \} \| \{ `type`: *typeof* [`RestClient`](../variables/EntityStorageComponentType.md#restclient); `options`: `IBaseRestClientConfig` & `object`; \}
4
4
 
5
5
  Entity storage component config types.
6
-
7
- ## Properties
8
-
9
- ### type
10
-
11
- > **type**: *typeof* [`Service`](../variables/EntityStorageComponentType.md#service)
12
-
13
- ***
14
-
15
- ### options
16
-
17
- > **options**: `IEntityStorageServiceConstructorOptions`