@twin.org/dataspace-models 0.0.3-next.19 → 0.0.3-next.21

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 (53) hide show
  1. package/docs/changelog.md +14 -0
  2. package/docs/reference/classes/DataspaceDataTypes.md +1 -1
  3. package/docs/reference/classes/TransferProcess.md +15 -15
  4. package/docs/reference/interfaces/IActivityLogDates.md +2 -2
  5. package/docs/reference/interfaces/IActivityLogDetails.md +6 -6
  6. package/docs/reference/interfaces/IActivityLogEntry.md +11 -11
  7. package/docs/reference/interfaces/IActivityLogEntryGetRequest.md +1 -1
  8. package/docs/reference/interfaces/IActivityLogEntryGetResponse.md +1 -1
  9. package/docs/reference/interfaces/IActivityLogStatusNotification.md +3 -3
  10. package/docs/reference/interfaces/IActivityLogStatusNotificationPayload.md +1 -1
  11. package/docs/reference/interfaces/IActivityLogStatusRequest.md +1 -1
  12. package/docs/reference/interfaces/IActivityQuery.md +3 -3
  13. package/docs/reference/interfaces/IActivityStreamNotifyRequest.md +1 -1
  14. package/docs/reference/interfaces/IActivityTask.md +2 -2
  15. package/docs/reference/interfaces/ICompleteTransferRequest.md +3 -3
  16. package/docs/reference/interfaces/ICompleteTransferResponse.md +2 -2
  17. package/docs/reference/interfaces/IDataAssetEntitiesRequest.md +3 -3
  18. package/docs/reference/interfaces/IDataAssetEntitiesResponse.md +2 -2
  19. package/docs/reference/interfaces/IDataAssetGetEntitiesRequest.md +2 -2
  20. package/docs/reference/interfaces/IDataAssetItemList.md +3 -3
  21. package/docs/reference/interfaces/IDataAssetItemListResult.md +2 -2
  22. package/docs/reference/interfaces/IDataAssetQuery.md +1 -1
  23. package/docs/reference/interfaces/IDataAssetQueryRequest.md +3 -3
  24. package/docs/reference/interfaces/IDataspaceActivity.md +2 -2
  25. package/docs/reference/interfaces/IDataspaceApp.md +5 -5
  26. package/docs/reference/interfaces/IDataspaceControlPlaneComponent.md +11 -11
  27. package/docs/reference/interfaces/IDataspaceControlPlaneResolverComponent.md +2 -2
  28. package/docs/reference/interfaces/IDataspaceDataPlaneComponent.md +6 -6
  29. package/docs/reference/interfaces/IEntitySet.md +2 -2
  30. package/docs/reference/interfaces/IExecutionPayload.md +3 -3
  31. package/docs/reference/interfaces/IFilteringQuery.md +3 -3
  32. package/docs/reference/interfaces/IGetTransferProcessRequest.md +2 -2
  33. package/docs/reference/interfaces/IGetTransferProcessResponse.md +2 -2
  34. package/docs/reference/interfaces/INegotiationCallback.md +3 -3
  35. package/docs/reference/interfaces/IQueryDataAssetRequest.md +3 -3
  36. package/docs/reference/interfaces/IRequestTransferRequest.md +2 -2
  37. package/docs/reference/interfaces/IRequestTransferResponse.md +2 -2
  38. package/docs/reference/interfaces/IStartTransferRequest.md +3 -3
  39. package/docs/reference/interfaces/IStartTransferResponse.md +2 -2
  40. package/docs/reference/interfaces/ISuspendTransferRequest.md +3 -3
  41. package/docs/reference/interfaces/ISuspendTransferResponse.md +2 -2
  42. package/docs/reference/interfaces/ITaskApp.md +2 -2
  43. package/docs/reference/interfaces/ITerminateTransferRequest.md +3 -3
  44. package/docs/reference/interfaces/ITerminateTransferResponse.md +2 -2
  45. package/docs/reference/interfaces/ITransferContext.md +9 -9
  46. package/docs/reference/interfaces/ITransferContextResponse.md +1 -1
  47. package/docs/reference/interfaces/ITransferProcess.md +15 -15
  48. package/docs/reference/variables/ActivityProcessingStatus.md +5 -5
  49. package/docs/reference/variables/DataRequestType.md +2 -2
  50. package/docs/reference/variables/DataspaceContexts.md +1 -1
  51. package/docs/reference/variables/DataspaceTypes.md +1 -1
  52. package/docs/reference/variables/TransferProcessRole.md +2 -2
  53. package/package.json +1 -1
@@ -6,7 +6,7 @@ This is NOT the DSP wire format (use ITransferProcess from standards for that).
6
6
 
7
7
  ## Properties
8
8
 
9
- ### id
9
+ ### id {#id}
10
10
 
11
11
  > **id**: `string`
12
12
 
@@ -14,7 +14,7 @@ Internal UUID (primary key for entity storage).
14
14
 
15
15
  ***
16
16
 
17
- ### consumerPid
17
+ ### consumerPid {#consumerpid}
18
18
 
19
19
  > **consumerPid**: `string`
20
20
 
@@ -23,7 +23,7 @@ Refers to the transfer identifier on the Consumer side.
23
23
 
24
24
  ***
25
25
 
26
- ### providerPid
26
+ ### providerPid {#providerpid}
27
27
 
28
28
  > **providerPid**: `string`
29
29
 
@@ -32,7 +32,7 @@ Refers to the transfer identifier on the Provider side.
32
32
 
33
33
  ***
34
34
 
35
- ### state
35
+ ### state {#state}
36
36
 
37
37
  > **state**: `DataspaceProtocolTransferProcessStateType`
38
38
 
@@ -41,7 +41,7 @@ One of: REQUESTED, STARTED, COMPLETED, SUSPENDED, TERMINATED.
41
41
 
42
42
  ***
43
43
 
44
- ### agreementId
44
+ ### agreementId {#agreementid}
45
45
 
46
46
  > **agreementId**: `string`
47
47
 
@@ -50,7 +50,7 @@ Used to resolve policies and permissions.
50
50
 
51
51
  ***
52
52
 
53
- ### datasetId
53
+ ### datasetId {#datasetid}
54
54
 
55
55
  > **datasetId**: `string`
56
56
 
@@ -59,7 +59,7 @@ Identifies the dataset being transferred.
59
59
 
60
60
  ***
61
61
 
62
- ### offerId
62
+ ### offerId {#offerid}
63
63
 
64
64
  > **offerId**: `string`
65
65
 
@@ -67,7 +67,7 @@ Offer ID from the original Catalog offer.
67
67
 
68
68
  ***
69
69
 
70
- ### policies?
70
+ ### policies? {#policies}
71
71
 
72
72
  > `optional` **policies**: `IDataspaceProtocolPolicy`[]
73
73
 
@@ -76,7 +76,7 @@ Used by DSC for runtime policy enforcement.
76
76
 
77
77
  ***
78
78
 
79
- ### consumerIdentity?
79
+ ### consumerIdentity? {#consumeridentity}
80
80
 
81
81
  > `optional` **consumerIdentity**: `string`
82
82
 
@@ -85,7 +85,7 @@ Used for auditing and access control.
85
85
 
86
86
  ***
87
87
 
88
- ### providerIdentity?
88
+ ### providerIdentity? {#provideridentity}
89
89
 
90
90
  > `optional` **providerIdentity**: `string`
91
91
 
@@ -94,7 +94,7 @@ Used for auditing.
94
94
 
95
95
  ***
96
96
 
97
- ### callbackAddress?
97
+ ### callbackAddress? {#callbackaddress}
98
98
 
99
99
  > `optional` **callbackAddress**: `string`
100
100
 
@@ -103,7 +103,7 @@ URI where messages to the Consumer should be sent.
103
103
 
104
104
  ***
105
105
 
106
- ### format?
106
+ ### format? {#format}
107
107
 
108
108
  > `optional` **format**: `string`
109
109
 
@@ -112,7 +112,7 @@ Specified by a Distribution for the Dataset associated with the Agreement.
112
112
 
113
113
  ***
114
114
 
115
- ### dataAddress?
115
+ ### dataAddress? {#dataaddress}
116
116
 
117
117
  > `optional` **dataAddress**: `IDataspaceProtocolDataAddress`
118
118
 
@@ -122,7 +122,7 @@ Only present when format is Http-Push-Activity-Stream-Format or Http-Post-Activi
122
122
 
123
123
  ***
124
124
 
125
- ### dateCreated
125
+ ### dateCreated {#datecreated}
126
126
 
127
127
  > **dateCreated**: `Date`
128
128
 
@@ -130,7 +130,7 @@ Creation timestamp.
130
130
 
131
131
  ***
132
132
 
133
- ### dateModified
133
+ ### dateModified {#datemodified}
134
134
 
135
135
  > **dateModified**: `Date`
136
136
 
@@ -6,31 +6,31 @@ Activity processing statuses.
6
6
 
7
7
  ## Type Declaration
8
8
 
9
- ### Pending
9
+ ### Pending {#pending}
10
10
 
11
11
  > `readonly` **Pending**: `"pending"` = `"pending"`
12
12
 
13
13
  Pending: Activity Processing has not started yet.
14
14
 
15
- ### Running
15
+ ### Running {#running}
16
16
 
17
17
  > `readonly` **Running**: `"running"` = `"running"`
18
18
 
19
19
  Running Activity processing is running.
20
20
 
21
- ### Completed
21
+ ### Completed {#completed}
22
22
 
23
23
  > `readonly` **Completed**: `"completed"` = `"completed"`
24
24
 
25
25
  Completed: Activity processing completed without error.
26
26
 
27
- ### Error
27
+ ### Error {#error}
28
28
 
29
29
  > `readonly` **Error**: `"error"` = `"error"`
30
30
 
31
31
  Error: Activity processing cannot be performed and marked as in error. (Depends on application).
32
32
 
33
- ### Registering
33
+ ### Registering {#registering}
34
34
 
35
35
  > `readonly` **Registering**: `"registering"` = `"registering"`
36
36
 
@@ -6,13 +6,13 @@ Data Request Types.
6
6
 
7
7
  ## Type Declaration
8
8
 
9
- ### DataAssetEntities
9
+ ### DataAssetEntities {#dataassetentities}
10
10
 
11
11
  > `readonly` **DataAssetEntities**: `"DataAssetEntities"` = `"DataAssetEntities"`
12
12
 
13
13
  Data Asset Entities
14
14
 
15
- ### QueryDataAsset
15
+ ### QueryDataAsset {#querydataasset}
16
16
 
17
17
  > `readonly` **QueryDataAsset**: `"QueryDataAsset"` = `"QueryDataAsset"`
18
18
 
@@ -6,7 +6,7 @@ The contexts related to Dataspace
6
6
 
7
7
  ## Type Declaration
8
8
 
9
- ### JsonSchemaNamespace
9
+ ### JsonSchemaNamespace {#jsonschemanamespace}
10
10
 
11
11
  > `readonly` **JsonSchemaNamespace**: `"https://schema.twindev.org/dataspace/"` = `"https://schema.twindev.org/dataspace/"`
12
12
 
@@ -6,6 +6,6 @@ The types concerning dataspace
6
6
 
7
7
  ## Type Declaration
8
8
 
9
- ### Activity
9
+ ### Activity {#activity}
10
10
 
11
11
  > `readonly` **Activity**: `"Activity"` = `"Activity"`
@@ -7,13 +7,13 @@ Determines whether the party is acting as Consumer or Provider.
7
7
 
8
8
  ## Type Declaration
9
9
 
10
- ### Consumer
10
+ ### Consumer {#consumer}
11
11
 
12
12
  > `readonly` **Consumer**: `"consumer"` = `"consumer"`
13
13
 
14
14
  Consumer role - the party requesting data.
15
15
 
16
- ### Provider
16
+ ### Provider {#provider}
17
17
 
18
18
  > `readonly` **Provider**: `"provider"` = `"provider"`
19
19
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/dataspace-models",
3
- "version": "0.0.3-next.19",
3
+ "version": "0.0.3-next.21",
4
4
  "description": "Defines shared entities, interfaces, and data types used by control plane and data plane components.",
5
5
  "repository": {
6
6
  "type": "git",