@twin.org/dataspace-models 0.0.3-next.25 → 0.0.3-next.26
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.
- package/dist/es/index.js +13 -11
- package/dist/es/index.js.map +1 -1
- package/dist/es/models/IActivityLogDetails.js.map +1 -1
- package/dist/es/models/IActivityLogEntry.js.map +1 -1
- package/dist/es/models/IActivityTask.js.map +1 -1
- package/dist/es/models/{IActivityLogDates.js → IActivityTaskEntry.js} +1 -1
- package/dist/es/models/IActivityTaskEntry.js.map +1 -0
- package/dist/es/models/IExecutionPayload.js.map +1 -1
- package/dist/es/models/activityTaskStatus.js +25 -0
- package/dist/es/models/activityTaskStatus.js.map +1 -0
- package/dist/es/models/api/IActivityStreamNotifyResponse.js +2 -0
- package/dist/es/models/api/IActivityStreamNotifyResponse.js.map +1 -0
- package/dist/es/models/app/IActivityQuery.js.map +1 -1
- package/dist/es/models/app/IDataspaceApp.js.map +1 -1
- package/dist/es/models/app/IProcessingGroupOptions.js +4 -0
- package/dist/es/models/app/IProcessingGroupOptions.js.map +1 -0
- package/dist/es/models/dataPlane/IDataspaceDataPlaneComponent.js.map +1 -1
- package/dist/es/models/dataspaceTypes.js +3 -0
- package/dist/es/models/dataspaceTypes.js.map +1 -1
- package/dist/types/index.d.ts +13 -11
- package/dist/types/models/IActivityLogDetails.d.ts +0 -4
- package/dist/types/models/IActivityLogEntry.d.ts +3 -27
- package/dist/types/models/IActivityTask.d.ts +2 -2
- package/dist/types/models/IActivityTaskEntry.d.ts +39 -0
- package/dist/types/models/IExecutionPayload.d.ts +2 -2
- package/dist/types/models/activityTaskStatus.d.ts +25 -0
- package/dist/types/models/api/IActivityStreamNotifyResponse.d.ts +23 -0
- package/dist/types/models/app/IActivityQuery.d.ts +4 -0
- package/dist/types/models/app/IDataspaceApp.d.ts +8 -0
- package/dist/types/models/app/IProcessingGroupOptions.d.ts +18 -0
- package/dist/types/models/dataPlane/IDataspaceDataPlaneComponent.d.ts +2 -2
- package/dist/types/models/dataspaceTypes.d.ts +3 -0
- package/docs/changelog.md +7 -0
- package/docs/reference/index.md +5 -2
- package/docs/reference/interfaces/IActivityLogDetails.md +0 -8
- package/docs/reference/interfaces/IActivityLogEntry.md +3 -39
- package/docs/reference/interfaces/IActivityQuery.md +8 -0
- package/docs/reference/interfaces/IActivityStreamNotifyResponse.md +33 -0
- package/docs/reference/interfaces/IActivityTask.md +1 -1
- package/docs/reference/interfaces/IActivityTaskEntry.md +67 -0
- package/docs/reference/interfaces/IDataspaceApp.md +14 -0
- package/docs/reference/interfaces/IDataspaceDataPlaneComponent.md +3 -3
- package/docs/reference/interfaces/IExecutionPayload.md +3 -3
- package/docs/reference/interfaces/IProcessingGroupOptions.md +28 -0
- package/docs/reference/type-aliases/ActivityTaskStatus.md +5 -0
- package/docs/reference/variables/ActivityTaskStatus.md +31 -0
- package/docs/reference/variables/DataspaceTypes.md +2 -0
- package/package.json +1 -1
- package/dist/es/models/IActivityLogDates.js.map +0 -1
- package/dist/es/models/ITaskApp.js +0 -4
- package/dist/es/models/ITaskApp.js.map +0 -1
- package/dist/types/models/IActivityLogDates.d.ts +0 -13
- package/dist/types/models/ITaskApp.d.ts +0 -13
- package/docs/reference/interfaces/IActivityLogDates.md +0 -19
- package/docs/reference/interfaces/ITaskApp.md +0 -19
package/dist/es/index.js
CHANGED
|
@@ -3,22 +3,23 @@
|
|
|
3
3
|
// Entity exports
|
|
4
4
|
export * from "./entities/transferProcess.js";
|
|
5
5
|
// Control Plane exports
|
|
6
|
+
export * from "./models/controlPlane/api/ITransferContextResponse.js";
|
|
6
7
|
export * from "./models/controlPlane/IDataspaceControlPlaneComponent.js";
|
|
7
8
|
export * from "./models/controlPlane/IDataspaceControlPlaneResolverComponent.js";
|
|
8
9
|
export * from "./models/controlPlane/INegotiationCallback.js";
|
|
10
|
+
export * from "./models/controlPlane/ITransferContext.js";
|
|
9
11
|
export * from "./models/controlPlane/ITransferProcess.js";
|
|
10
12
|
export * from "./models/controlPlane/transferProcessRole.js";
|
|
11
|
-
export * from "./models/controlPlane/ITransferContext.js";
|
|
12
|
-
export * from "./models/controlPlane/api/ITransferContextResponse.js";
|
|
13
13
|
// Data Plane exports
|
|
14
14
|
export * from "./models/dataPlane/IDataspaceDataPlaneComponent.js";
|
|
15
|
-
export * from "./models/IDataspaceActivity.js";
|
|
16
|
-
export * from "./models/dataspaceTypes.js";
|
|
17
15
|
export * from "./models/dataspaceContexts.js";
|
|
16
|
+
export * from "./models/dataspaceTypes.js";
|
|
17
|
+
export * from "./models/IDataspaceActivity.js";
|
|
18
18
|
export * from "./dataTypes/dataspaceDataTypes.js";
|
|
19
19
|
// App exports
|
|
20
20
|
export * from "./factories/dataspaceAppFactory.js";
|
|
21
21
|
export * from "./models/app/IDataspaceApp.js";
|
|
22
|
+
export * from "./models/app/IProcessingGroupOptions.js";
|
|
22
23
|
// Other exports
|
|
23
24
|
export * from "./models/activityProcessingStatus.js";
|
|
24
25
|
export * from "./models/api/IActivityLogEntryGetRequest.js";
|
|
@@ -26,37 +27,38 @@ export * from "./models/api/IActivityLogEntryGetResponse.js";
|
|
|
26
27
|
export * from "./models/api/IActivityLogStatusNotificationPayload.js";
|
|
27
28
|
export * from "./models/api/IActivityLogStatusRequest.js";
|
|
28
29
|
export * from "./models/api/IActivityStreamNotifyRequest.js";
|
|
30
|
+
export * from "./models/api/IActivityStreamNotifyResponse.js";
|
|
29
31
|
export * from "./models/api/IDataAssetEntitiesResponse.js";
|
|
30
32
|
export * from "./models/api/IDataAssetGetEntitiesRequest.js";
|
|
31
33
|
export * from "./models/api/IDataAssetQueryRequest.js";
|
|
32
34
|
// Control Plane API exports - Transfer Process Protocol
|
|
35
|
+
export * from "./models/api/controlPlane/ICompleteTransferRequest.js";
|
|
36
|
+
export * from "./models/api/controlPlane/ICompleteTransferResponse.js";
|
|
37
|
+
export * from "./models/api/controlPlane/IGetTransferProcessRequest.js";
|
|
38
|
+
export * from "./models/api/controlPlane/IGetTransferProcessResponse.js";
|
|
33
39
|
export * from "./models/api/controlPlane/IRequestTransferRequest.js";
|
|
34
40
|
export * from "./models/api/controlPlane/IRequestTransferResponse.js";
|
|
35
41
|
export * from "./models/api/controlPlane/IStartTransferRequest.js";
|
|
36
42
|
export * from "./models/api/controlPlane/IStartTransferResponse.js";
|
|
37
|
-
export * from "./models/api/controlPlane/ICompleteTransferRequest.js";
|
|
38
|
-
export * from "./models/api/controlPlane/ICompleteTransferResponse.js";
|
|
39
43
|
export * from "./models/api/controlPlane/ISuspendTransferRequest.js";
|
|
40
44
|
export * from "./models/api/controlPlane/ISuspendTransferResponse.js";
|
|
41
45
|
export * from "./models/api/controlPlane/ITerminateTransferRequest.js";
|
|
42
46
|
export * from "./models/api/controlPlane/ITerminateTransferResponse.js";
|
|
43
|
-
export * from "./models/
|
|
44
|
-
export * from "./models/api/controlPlane/IGetTransferProcessResponse.js";
|
|
47
|
+
export * from "./models/activityTaskStatus.js";
|
|
45
48
|
export * from "./models/app/dataRequestType.js";
|
|
46
49
|
export * from "./models/app/IActivityQuery.js";
|
|
47
50
|
export * from "./models/app/IDataAssetEntitiesRequest.js";
|
|
48
51
|
export * from "./models/app/IDataAssetQuery.js";
|
|
49
|
-
export * from "./models/app/IQueryDataAssetRequest.js";
|
|
50
52
|
export * from "./models/app/IDataRequest.js";
|
|
51
|
-
export * from "./models/
|
|
53
|
+
export * from "./models/app/IQueryDataAssetRequest.js";
|
|
52
54
|
export * from "./models/IActivityLogDetails.js";
|
|
53
55
|
export * from "./models/IActivityLogEntry.js";
|
|
54
56
|
export * from "./models/IActivityLogStatusNotification.js";
|
|
55
57
|
export * from "./models/IActivityTask.js";
|
|
58
|
+
export * from "./models/IActivityTaskEntry.js";
|
|
56
59
|
export * from "./models/IDataAssetItemList.js";
|
|
57
60
|
export * from "./models/IDataAssetItemListResult.js";
|
|
58
61
|
export * from "./models/IEntitySet.js";
|
|
59
62
|
export * from "./models/IExecutionPayload.js";
|
|
60
63
|
export * from "./models/IFilteringQuery.js";
|
|
61
|
-
export * from "./models/ITaskApp.js";
|
|
62
64
|
//# sourceMappingURL=index.js.map
|
package/dist/es/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC,iBAAiB;AACjB,cAAc,+BAA+B,CAAC;AAE9C,wBAAwB;AACxB,cAAc,0DAA0D,CAAC;AACzE,cAAc,kEAAkE,CAAC;AACjF,cAAc,+CAA+C,CAAC;AAC9D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC,iBAAiB;AACjB,cAAc,+BAA+B,CAAC;AAE9C,wBAAwB;AACxB,cAAc,uDAAuD,CAAC;AACtE,cAAc,0DAA0D,CAAC;AACzE,cAAc,kEAAkE,CAAC;AACjF,cAAc,+CAA+C,CAAC;AAC9D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,8CAA8C,CAAC;AAE7D,qBAAqB;AACrB,cAAc,oDAAoD,CAAC;AAEnE,cAAc,+BAA+B,CAAC;AAC9C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,gCAAgC,CAAC;AAE/C,cAAc,mCAAmC,CAAC;AAElD,cAAc;AACd,cAAc,oCAAoC,CAAC;AACnD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,yCAAyC,CAAC;AAExD,gBAAgB;AAChB,cAAc,sCAAsC,CAAC;AACrD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,uDAAuD,CAAC;AACtE,cAAc,2CAA2C,CAAC;AAC1D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,+CAA+C,CAAC;AAC9D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,wCAAwC,CAAC;AAEvD,wDAAwD;AACxD,cAAc,uDAAuD,CAAC;AACtE,cAAc,wDAAwD,CAAC;AACvE,cAAc,yDAAyD,CAAC;AACxE,cAAc,0DAA0D,CAAC;AACzE,cAAc,sDAAsD,CAAC;AACrE,cAAc,uDAAuD,CAAC;AACtE,cAAc,oDAAoD,CAAC;AACnE,cAAc,qDAAqD,CAAC;AACpE,cAAc,sDAAsD,CAAC;AACrE,cAAc,uDAAuD,CAAC;AACtE,cAAc,wDAAwD,CAAC;AACvE,cAAc,yDAAyD,CAAC;AAExE,cAAc,gCAAgC,CAAC;AAC/C,cAAc,iCAAiC,CAAC;AAChD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,2CAA2C,CAAC;AAC1D,cAAc,iCAAiC,CAAC;AAChD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,wCAAwC,CAAC;AACvD,cAAc,iCAAiC,CAAC;AAChD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,4CAA4C,CAAC;AAC3D,cAAc,2BAA2B,CAAC;AAC1C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,sCAAsC,CAAC;AACrD,cAAc,wBAAwB,CAAC;AACvC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,6BAA6B,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n// Entity exports\nexport * from \"./entities/transferProcess.js\";\n\n// Control Plane exports\nexport * from \"./models/controlPlane/api/ITransferContextResponse.js\";\nexport * from \"./models/controlPlane/IDataspaceControlPlaneComponent.js\";\nexport * from \"./models/controlPlane/IDataspaceControlPlaneResolverComponent.js\";\nexport * from \"./models/controlPlane/INegotiationCallback.js\";\nexport * from \"./models/controlPlane/ITransferContext.js\";\nexport * from \"./models/controlPlane/ITransferProcess.js\";\nexport * from \"./models/controlPlane/transferProcessRole.js\";\n\n// Data Plane exports\nexport * from \"./models/dataPlane/IDataspaceDataPlaneComponent.js\";\n\nexport * from \"./models/dataspaceContexts.js\";\nexport * from \"./models/dataspaceTypes.js\";\nexport * from \"./models/IDataspaceActivity.js\";\n\nexport * from \"./dataTypes/dataspaceDataTypes.js\";\n\n// App exports\nexport * from \"./factories/dataspaceAppFactory.js\";\nexport * from \"./models/app/IDataspaceApp.js\";\nexport * from \"./models/app/IProcessingGroupOptions.js\";\n\n// Other exports\nexport * from \"./models/activityProcessingStatus.js\";\nexport * from \"./models/api/IActivityLogEntryGetRequest.js\";\nexport * from \"./models/api/IActivityLogEntryGetResponse.js\";\nexport * from \"./models/api/IActivityLogStatusNotificationPayload.js\";\nexport * from \"./models/api/IActivityLogStatusRequest.js\";\nexport * from \"./models/api/IActivityStreamNotifyRequest.js\";\nexport * from \"./models/api/IActivityStreamNotifyResponse.js\";\nexport * from \"./models/api/IDataAssetEntitiesResponse.js\";\nexport * from \"./models/api/IDataAssetGetEntitiesRequest.js\";\nexport * from \"./models/api/IDataAssetQueryRequest.js\";\n\n// Control Plane API exports - Transfer Process Protocol\nexport * from \"./models/api/controlPlane/ICompleteTransferRequest.js\";\nexport * from \"./models/api/controlPlane/ICompleteTransferResponse.js\";\nexport * from \"./models/api/controlPlane/IGetTransferProcessRequest.js\";\nexport * from \"./models/api/controlPlane/IGetTransferProcessResponse.js\";\nexport * from \"./models/api/controlPlane/IRequestTransferRequest.js\";\nexport * from \"./models/api/controlPlane/IRequestTransferResponse.js\";\nexport * from \"./models/api/controlPlane/IStartTransferRequest.js\";\nexport * from \"./models/api/controlPlane/IStartTransferResponse.js\";\nexport * from \"./models/api/controlPlane/ISuspendTransferRequest.js\";\nexport * from \"./models/api/controlPlane/ISuspendTransferResponse.js\";\nexport * from \"./models/api/controlPlane/ITerminateTransferRequest.js\";\nexport * from \"./models/api/controlPlane/ITerminateTransferResponse.js\";\n\nexport * from \"./models/activityTaskStatus.js\";\nexport * from \"./models/app/dataRequestType.js\";\nexport * from \"./models/app/IActivityQuery.js\";\nexport * from \"./models/app/IDataAssetEntitiesRequest.js\";\nexport * from \"./models/app/IDataAssetQuery.js\";\nexport * from \"./models/app/IDataRequest.js\";\nexport * from \"./models/app/IQueryDataAssetRequest.js\";\nexport * from \"./models/IActivityLogDetails.js\";\nexport * from \"./models/IActivityLogEntry.js\";\nexport * from \"./models/IActivityLogStatusNotification.js\";\nexport * from \"./models/IActivityTask.js\";\nexport * from \"./models/IActivityTaskEntry.js\";\nexport * from \"./models/IDataAssetItemList.js\";\nexport * from \"./models/IDataAssetItemListResult.js\";\nexport * from \"./models/IEntitySet.js\";\nexport * from \"./models/IExecutionPayload.js\";\nexport * from \"./models/IFilteringQuery.js\";\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IActivityLogDetails.js","sourceRoot":"","sources":["../../../src/models/IActivityLogDetails.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The details related to the processing of an Activity\n */\nexport interface IActivityLogDetails {\n\t/**\n\t * The Id of the Activity Log entry.\n\t */\n\tid: string;\n\n\t/**\n\t * The activity Id that this entry refers to.\n\t */\n\tactivityId?: string;\n\n\t/**\n\t * The identity of the Activity's generator.\n\t */\n\tgenerator: string;\n\n\t/**\n\t * The creation date of this object.\n\t */\n\tdateCreated: string;\n\n\t/**\n\t * The last update date of this object.\n\t */\n\tdateModified: string;\n
|
|
1
|
+
{"version":3,"file":"IActivityLogDetails.js","sourceRoot":"","sources":["../../../src/models/IActivityLogDetails.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The details related to the processing of an Activity\n */\nexport interface IActivityLogDetails {\n\t/**\n\t * The Id of the Activity Log entry.\n\t */\n\tid: string;\n\n\t/**\n\t * The activity Id that this entry refers to.\n\t */\n\tactivityId?: string;\n\n\t/**\n\t * The identity of the Activity's generator.\n\t */\n\tgenerator: string;\n\n\t/**\n\t * The creation date of this object.\n\t */\n\tdateCreated: string;\n\n\t/**\n\t * The last update date of this object.\n\t */\n\tdateModified: string;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IActivityLogEntry.js","sourceRoot":"","sources":["../../../src/models/IActivityLogEntry.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {
|
|
1
|
+
{"version":3,"file":"IActivityLogEntry.js","sourceRoot":"","sources":["../../../src/models/IActivityLogEntry.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ActivityProcessingStatus } from \"./activityProcessingStatus.js\";\nimport type { IActivityLogDetails } from \"./IActivityLogDetails.js\";\nimport type { IActivityTaskEntry } from \"./IActivityTaskEntry.js\";\n\n/**\n * The details related to the processing of an Activity\n */\nexport interface IActivityLogEntry extends IActivityLogDetails {\n\t/**\n\t * Status of the Activity Processing.\n\t */\n\tstatus: ActivityProcessingStatus;\n\n\t/**\n\t * The tasks that have to be run to process the Activity.\n\t */\n\ttasks?: IActivityTaskEntry[];\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IActivityTask.js","sourceRoot":"","sources":["../../../src/models/IActivityTask.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {
|
|
1
|
+
{"version":3,"file":"IActivityTask.js","sourceRoot":"","sources":["../../../src/models/IActivityTask.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IActivityTaskEntry } from \"./IActivityTaskEntry.js\";\n\n/**\n * Denotes a task associated with an Activity\n */\nexport interface IActivityTask {\n\t/**\n\t * The activity log entry.\n\t */\n\tactivityLogEntryId: string;\n\n\t/**\n\t * The associated tasks\n\t */\n\tassociatedTasks: IActivityTaskEntry[];\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IActivityTaskEntry.js","sourceRoot":"","sources":["../../../src/models/IActivityTaskEntry.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\nimport type { IError } from \"@twin.org/core\";\nimport type { ActivityTaskStatus } from \"./activityTaskStatus.js\";\n\n/**\n * Denotes a task associated with a Dataspace App\n */\nexport interface IActivityTaskEntry {\n\t/**\n\t * Task Id.\n\t */\n\ttaskId: string;\n\n\t/**\n\t * Dataspace App Id.\n\t */\n\tdataspaceAppId: string;\n\n\t/**\n\t * Task status.\n\t */\n\tstatus: ActivityTaskStatus;\n\n\t/**\n\t * Processing Group Id.\n\t */\n\tprocessingGroupId?: string;\n\n\t/**\n\t * Task processing start timestamp\n\t */\n\tstartDate?: string;\n\n\t/**\n\t * Task processing end timestamp\n\t */\n\tendDate?: string;\n\n\t/**\n\t * The result of the task processing, if completed.\n\t */\n\tresult?: unknown;\n\n\t/**\n\t * The error occurred during task processing, if any.\n\t */\n\terror?: IError;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IExecutionPayload.js","sourceRoot":"","sources":["../../../src/models/IExecutionPayload.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDataspaceActivity } from \"./IDataspaceActivity.js\";\n\n/**\n * Execution payload.\n */\nexport interface IExecutionPayload {\n\t/**\n\t * The Activity Log Entry Id.\n\t */\n\tactivityLogEntryId: string;\n\n\t/**\n\t * The activity\n\t */\n\tactivity: IDataspaceActivity;\n\n\t/**\n\t * The
|
|
1
|
+
{"version":3,"file":"IExecutionPayload.js","sourceRoot":"","sources":["../../../src/models/IExecutionPayload.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDataspaceActivity } from \"./IDataspaceActivity.js\";\n\n/**\n * Execution payload.\n */\nexport interface IExecutionPayload {\n\t/**\n\t * The Activity Log Entry Id.\n\t */\n\tactivityLogEntryId: string;\n\n\t/**\n\t * The activity\n\t */\n\tactivity: IDataspaceActivity;\n\n\t/**\n\t * The dataspace App ID.\n\t */\n\tdataspaceAppId: string;\n}\n"]}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
// Copyright 2026 IOTA Stiftung.
|
|
2
|
+
// SPDX-License-Identifier: Apache-2.0.
|
|
3
|
+
/**
|
|
4
|
+
* Activity task statuses.
|
|
5
|
+
*/
|
|
6
|
+
// eslint-disable-next-line @typescript-eslint/naming-convention
|
|
7
|
+
export const ActivityTaskStatus = {
|
|
8
|
+
/**
|
|
9
|
+
* Pending.
|
|
10
|
+
*/
|
|
11
|
+
Pending: "pending",
|
|
12
|
+
/**
|
|
13
|
+
* Processing.
|
|
14
|
+
*/
|
|
15
|
+
Processing: "processing",
|
|
16
|
+
/**
|
|
17
|
+
* Success.
|
|
18
|
+
*/
|
|
19
|
+
Success: "success",
|
|
20
|
+
/**
|
|
21
|
+
* Failed.
|
|
22
|
+
*/
|
|
23
|
+
Failed: "failed"
|
|
24
|
+
};
|
|
25
|
+
//# sourceMappingURL=activityTaskStatus.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"activityTaskStatus.js","sourceRoot":"","sources":["../../../src/models/activityTaskStatus.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,kBAAkB,GAAG;IACjC;;OAEG;IACH,OAAO,EAAE,SAAS;IAElB;;OAEG;IACH,UAAU,EAAE,YAAY;IAExB;;OAEG;IACH,OAAO,EAAE,SAAS;IAElB;;OAEG;IACH,MAAM,EAAE,QAAQ;CACP,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Activity task statuses.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const ActivityTaskStatus = {\n\t/**\n\t * Pending.\n\t */\n\tPending: \"pending\",\n\n\t/**\n\t * Processing.\n\t */\n\tProcessing: \"processing\",\n\n\t/**\n\t * Success.\n\t */\n\tSuccess: \"success\",\n\n\t/**\n\t * Failed.\n\t */\n\tFailed: \"failed\"\n} as const;\n\n/**\n * Activity task statuses.\n */\nexport type ActivityTaskStatus = (typeof ActivityTaskStatus)[keyof typeof ActivityTaskStatus];\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IActivityStreamNotifyResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IActivityStreamNotifyResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes, HttpStatusCode } from \"@twin.org/web\";\nimport type { IActivityLogEntry } from \"../IActivityLogEntry.js\";\n\n/**\n * Activity Stream Notify Response.\n */\nexport interface IActivityStreamNotifyResponse {\n\t/**\n\t * The status code indicating the result of the notification processing. It can be either:\n\t * - `201 Created` if the notification was processed inline and a new activity log entry was created.\n\t * - `102 Processing` if the notification was accepted for processing but has not been completed yet.\n\t */\n\tstatusCode: typeof HttpStatusCode.created | typeof HttpStatusCode.processing;\n\n\t/**\n\t * Optional headers.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.Location]?: string;\n\t};\n\n\t/**\n\t * The Activity log entry if the notification was processed inline.\n\t */\n\tbody?: IActivityLogEntry;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IActivityQuery.js","sourceRoot":"","sources":["../../../../src/models/app/IActivityQuery.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * (Activity,Object,Target) query for denoting combinations to be handled by a Dataspace App.\n */\nexport interface IActivityQuery {\n\t/**\n\t * FQN of the Activity type.\n\t */\n\tactivityType?: string;\n\n\t/**\n\t * FQN of the Object Type.\n\t */\n\tobjectType: string;\n\n\t/**\n\t * FQN of the target type.\n\t */\n\ttargetType?: string;\n}\n"]}
|
|
1
|
+
{"version":3,"file":"IActivityQuery.js","sourceRoot":"","sources":["../../../../src/models/app/IActivityQuery.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * (Activity,Object,Target) query for denoting combinations to be handled by a Dataspace App.\n */\nexport interface IActivityQuery {\n\t/**\n\t * FQN of the Activity type.\n\t */\n\tactivityType?: string;\n\n\t/**\n\t * FQN of the Object Type.\n\t */\n\tobjectType: string;\n\n\t/**\n\t * FQN of the target type.\n\t */\n\ttargetType?: string;\n\n\t/**\n\t * The processing group id for this query, used to determine which tasks can be processed in parallel.\n\t */\n\tprocessingGroupId?: string;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IDataspaceApp.js","sourceRoot":"","sources":["../../../../src/models/app/IDataspaceApp.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IJsonLdDocument } from \"@twin.org/data-json-ld\";\nimport type { IDataspaceProtocolDataset } from \"@twin.org/standards-dataspace-protocol\";\nimport type { IActivityQuery } from \"./IActivityQuery.js\";\nimport type { IDataRequest } from \"./IDataRequest.js\";\nimport type { IDataspaceActivity } from \"../IDataspaceActivity.js\";\n\n/**\n * Interface describes a Dataspace App.\n */\nexport interface IDataspaceApp extends IComponent {\n\t/**\n\t * The activities handled by the App.\n\t * @returns A query that describes the set of activities handled by the App.\n\t */\n\tactivitiesHandled(): IActivityQuery[];\n\n\t/**\n\t * The datasets handled by the App.\n\t * @returns The Dataspace Protocol compliant datasets handled by the App.\n\t */\n\tdatasetsHandled(): Promise<IDataspaceProtocolDataset[]>;\n\n\t/**\n\t * The types of queries supported.\n\t * @returns The types of queries supported by the Dataspace App to retrieve data.\n\t */\n\tsupportedQueryTypes(): string[];\n\n\t/**\n\t * Handles an Activity and report about results through the Dataspace Data Plane Callback\n\t * @param activity The Activity to be handled\n\t * @returns The result of executing the Activity.\n\t */\n\thandleActivity?<T>(activity: IDataspaceActivity): Promise<T>;\n\n\t/**\n\t * Handles a Data Request.\n\t * @param dataRequest The data request.\n\t * @param cursor Cursor that points to the next item in the result set.\n\t * @param limit Maximum number of entries retrieved or to be retrieved.\n\t * @returns Data as JSON-Ld.\n\t */\n\thandleDataRequest?(\n\t\tdataRequest: IDataRequest,\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{ data: IJsonLdDocument; cursor?: string }>;\n}\n"]}
|
|
1
|
+
{"version":3,"file":"IDataspaceApp.js","sourceRoot":"","sources":["../../../../src/models/app/IDataspaceApp.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IJsonLdDocument } from \"@twin.org/data-json-ld\";\nimport type { IDataspaceProtocolDataset } from \"@twin.org/standards-dataspace-protocol\";\nimport type { IActivityQuery } from \"./IActivityQuery.js\";\nimport type { IDataRequest } from \"./IDataRequest.js\";\nimport type { IDataspaceActivity } from \"../IDataspaceActivity.js\";\nimport type { IProcessingGroupOptions } from \"./IProcessingGroupOptions.js\";\n\n/**\n * Interface describes a Dataspace App.\n */\nexport interface IDataspaceApp extends IComponent {\n\t/**\n\t * The settings for the processing groups for tasks.\n\t * @returns The options for each process group.\n\t */\n\tprocessingGroups?(): { [id: string]: IProcessingGroupOptions };\n\n\t/**\n\t * The activities handled by the App.\n\t * @returns A query that describes the set of activities handled by the App.\n\t */\n\tactivitiesHandled(): IActivityQuery[];\n\n\t/**\n\t * The datasets handled by the App.\n\t * @returns The Dataspace Protocol compliant datasets handled by the App.\n\t */\n\tdatasetsHandled(): Promise<IDataspaceProtocolDataset[]>;\n\n\t/**\n\t * The types of queries supported.\n\t * @returns The types of queries supported by the Dataspace App to retrieve data.\n\t */\n\tsupportedQueryTypes(): string[];\n\n\t/**\n\t * Handles an Activity and report about results through the Dataspace Data Plane Callback\n\t * @param activity The Activity to be handled\n\t * @returns The result of executing the Activity.\n\t */\n\thandleActivity?<T>(activity: IDataspaceActivity): Promise<T>;\n\n\t/**\n\t * Handles a Data Request.\n\t * @param dataRequest The data request.\n\t * @param cursor Cursor that points to the next item in the result set.\n\t * @param limit Maximum number of entries retrieved or to be retrieved.\n\t * @returns Data as JSON-Ld.\n\t */\n\thandleDataRequest?(\n\t\tdataRequest: IDataRequest,\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{ data: IJsonLdDocument; cursor?: string }>;\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IProcessingGroupOptions.js","sourceRoot":"","sources":["../../../../src/models/app/IProcessingGroupOptions.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Interface describes the options for a processing group, which determines how many tasks can be processed in parallel for a given group of activities.\n */\nexport interface IProcessingGroupOptions {\n\t/**\n\t * The number of concurrent tasks that can be processed for this processing group.\n\t */\n\tconcurrentTasks?: number;\n\n\t/**\n\t * Terminate the worker after it has been idle for the specified timeout in milliseconds,\n\t * defaults to 0 for immediate shutdown, set to -1 to keep workers alive.\n\t */\n\tidleShutdownTimeout?: number;\n\n\t/**\n\t * The number of times a task in this processing group should be retried in case of failure.\n\t */\n\tretryCount?: number;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IDataspaceDataPlaneComponent.js","sourceRoot":"","sources":["../../../../src/models/dataPlane/IDataspaceDataPlaneComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IJsonLdContextDefinitionElement } from \"@twin.org/data-json-ld\";\nimport type { IActivityStreamsActivity } from \"@twin.org/standards-w3c-activity-streams\";\nimport type { IActivityLogEntry } from \"../IActivityLogEntry.js\";\nimport type { IActivityLogStatusNotification } from \"../IActivityLogStatusNotification.js\";\nimport type { IDataAssetItemListResult } from \"../IDataAssetItemListResult.js\";\nimport type { IEntitySet } from \"../IEntitySet.js\";\nimport type { IFilteringQuery } from \"../IFilteringQuery.js\";\n\n/**\n * Dataspace Data Plane component interface.\n * Implements the Data Plane functionality for the Eclipse Dataspace Protocol.\n */\nexport interface IDataspaceDataPlaneComponent extends IComponent {\n\t/**\n\t * Notify an Activity to the Dataspace Data Plane Activity Stream.\n\t * @param activity The Activity notified.\n\t * @returns The
|
|
1
|
+
{"version":3,"file":"IDataspaceDataPlaneComponent.js","sourceRoot":"","sources":["../../../../src/models/dataPlane/IDataspaceDataPlaneComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IJsonLdContextDefinitionElement } from \"@twin.org/data-json-ld\";\nimport type { IActivityStreamsActivity } from \"@twin.org/standards-w3c-activity-streams\";\nimport type { IActivityLogEntry } from \"../IActivityLogEntry.js\";\nimport type { IActivityLogStatusNotification } from \"../IActivityLogStatusNotification.js\";\nimport type { IDataAssetItemListResult } from \"../IDataAssetItemListResult.js\";\nimport type { IEntitySet } from \"../IEntitySet.js\";\nimport type { IFilteringQuery } from \"../IFilteringQuery.js\";\n\n/**\n * Dataspace Data Plane component interface.\n * Implements the Data Plane functionality for the Eclipse Dataspace Protocol.\n */\nexport interface IDataspaceDataPlaneComponent extends IComponent {\n\t/**\n\t * Notify an Activity to the Dataspace Data Plane Activity Stream.\n\t * @param activity The Activity notified.\n\t * @returns The activity's entry.\n\t */\n\tnotifyActivity(activity: IActivityStreamsActivity): Promise<string | IActivityLogEntry>;\n\n\t/**\n\t * Subscribes to the activity log.\n\t * @param callback The callback to be called when Activity Log is called.\n\t * @param subscriptionId The subscription Id.\n\t * @returns The subscription Id.\n\t */\n\tsubscribeToActivityLog(\n\t\tcallback: (notification: IActivityLogStatusNotification) => Promise<void>,\n\t\tsubscriptionId?: string\n\t): Promise<string>;\n\n\t/**\n\t * Unsubscribes to the activity log.\n\t * @param subscriptionId The subscription Id.\n\t * @returns The subscription Id.\n\t */\n\tunSubscribeToActivityLog(subscriptionId: string): Promise<void>;\n\n\t/**\n\t * Returns Activity Log Entry which contains the Activity processing details.\n\t * @param logEntryId The Id of the Activity Log Entry (a URI).\n\t * @returns the Activity Log Entry with the processing details.\n\t * @throws NotFoundError if activity log entry is not known.\n\t */\n\tgetActivityLogEntry(logEntryId: string): Promise<IActivityLogEntry>;\n\n\t/**\n\t * Get Data Asset entities. Allows to retrieve entities by their type or id.\n\t * @param entitySet The set of entities to be retrieved.\n\t * @param entitySet.jsonLdContext The JSON-LD Context to be used to expand the referred entityType.\n\t * @param consumerPid The consumer Process ID from the DSP Transfer Process.\n\t * Used to resolve datasetId from the Transfer Process.\n\t * @param cursor Pagination details - cursor.\n\t * @param limit Pagination details - max number of entities.\n\t * @param trustPayload Trust payload to verify the requesters identity.\n\t * @returns The item list and optional cursor for pagination via Link headers.\n\t */\n\tgetDataAssetEntities(\n\t\tentitySet: IEntitySet & {\n\t\t\tjsonLdContext?: IJsonLdContextDefinitionElement[];\n\t\t},\n\t\tconsumerPid: string,\n\t\tcursor?: string,\n\t\tlimit?: number,\n\t\ttrustPayload?: unknown\n\t): Promise<IDataAssetItemListResult>;\n\n\t/**\n\t * Queries a data asset controlled by this Dataspace App.\n\t * @param consumerPid The consumer Process ID from the DSP Transfer Process.\n\t * Used to resolve datasetId from the Transfer Process.\n\t * @param query The filtering query.\n\t * @param cursor Pagination details - cursor.\n\t * @param limit Pagination details - max number of entities.\n\t * @param trustPayload Trust payload to verify the requesters identity.\n\t * @returns The item list and optional cursor for pagination via Link headers.\n\t */\n\tqueryDataAsset(\n\t\tconsumerPid: string,\n\t\tquery: IFilteringQuery,\n\t\tcursor?: string,\n\t\tlimit?: number,\n\t\ttrustPayload?: unknown\n\t): Promise<IDataAssetItemListResult>;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"dataspaceTypes.js","sourceRoot":"","sources":["../../../src/models/dataspaceTypes.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,cAAc,GAAG;IAC7B,QAAQ,EAAE,UAAU;CACX,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The types concerning dataspace\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const DataspaceTypes = {\n\tActivity: \"Activity\"\n} as const;\n\n/**\n * The types concerning dataspace.\n */\nexport type DataspaceTypes = (typeof DataspaceTypes)[keyof typeof DataspaceTypes];\n"]}
|
|
1
|
+
{"version":3,"file":"dataspaceTypes.js","sourceRoot":"","sources":["../../../src/models/dataspaceTypes.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,cAAc,GAAG;IAC7B;;OAEG;IACH,QAAQ,EAAE,UAAU;CACX,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The types concerning dataspace\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const DataspaceTypes = {\n\t/**\n\t * Activity type.\n\t */\n\tActivity: \"Activity\"\n} as const;\n\n/**\n * The types concerning dataspace.\n */\nexport type DataspaceTypes = (typeof DataspaceTypes)[keyof typeof DataspaceTypes];\n"]}
|
package/dist/types/index.d.ts
CHANGED
|
@@ -1,53 +1,55 @@
|
|
|
1
1
|
export * from "./entities/transferProcess.js";
|
|
2
|
+
export * from "./models/controlPlane/api/ITransferContextResponse.js";
|
|
2
3
|
export * from "./models/controlPlane/IDataspaceControlPlaneComponent.js";
|
|
3
4
|
export * from "./models/controlPlane/IDataspaceControlPlaneResolverComponent.js";
|
|
4
5
|
export * from "./models/controlPlane/INegotiationCallback.js";
|
|
6
|
+
export * from "./models/controlPlane/ITransferContext.js";
|
|
5
7
|
export * from "./models/controlPlane/ITransferProcess.js";
|
|
6
8
|
export * from "./models/controlPlane/transferProcessRole.js";
|
|
7
|
-
export * from "./models/controlPlane/ITransferContext.js";
|
|
8
|
-
export * from "./models/controlPlane/api/ITransferContextResponse.js";
|
|
9
9
|
export * from "./models/dataPlane/IDataspaceDataPlaneComponent.js";
|
|
10
|
-
export * from "./models/IDataspaceActivity.js";
|
|
11
|
-
export * from "./models/dataspaceTypes.js";
|
|
12
10
|
export * from "./models/dataspaceContexts.js";
|
|
11
|
+
export * from "./models/dataspaceTypes.js";
|
|
12
|
+
export * from "./models/IDataspaceActivity.js";
|
|
13
13
|
export * from "./dataTypes/dataspaceDataTypes.js";
|
|
14
14
|
export * from "./factories/dataspaceAppFactory.js";
|
|
15
15
|
export * from "./models/app/IDataspaceApp.js";
|
|
16
|
+
export * from "./models/app/IProcessingGroupOptions.js";
|
|
16
17
|
export * from "./models/activityProcessingStatus.js";
|
|
17
18
|
export * from "./models/api/IActivityLogEntryGetRequest.js";
|
|
18
19
|
export * from "./models/api/IActivityLogEntryGetResponse.js";
|
|
19
20
|
export * from "./models/api/IActivityLogStatusNotificationPayload.js";
|
|
20
21
|
export * from "./models/api/IActivityLogStatusRequest.js";
|
|
21
22
|
export * from "./models/api/IActivityStreamNotifyRequest.js";
|
|
23
|
+
export * from "./models/api/IActivityStreamNotifyResponse.js";
|
|
22
24
|
export * from "./models/api/IDataAssetEntitiesResponse.js";
|
|
23
25
|
export * from "./models/api/IDataAssetGetEntitiesRequest.js";
|
|
24
26
|
export * from "./models/api/IDataAssetQueryRequest.js";
|
|
27
|
+
export * from "./models/api/controlPlane/ICompleteTransferRequest.js";
|
|
28
|
+
export * from "./models/api/controlPlane/ICompleteTransferResponse.js";
|
|
29
|
+
export * from "./models/api/controlPlane/IGetTransferProcessRequest.js";
|
|
30
|
+
export * from "./models/api/controlPlane/IGetTransferProcessResponse.js";
|
|
25
31
|
export * from "./models/api/controlPlane/IRequestTransferRequest.js";
|
|
26
32
|
export * from "./models/api/controlPlane/IRequestTransferResponse.js";
|
|
27
33
|
export * from "./models/api/controlPlane/IStartTransferRequest.js";
|
|
28
34
|
export * from "./models/api/controlPlane/IStartTransferResponse.js";
|
|
29
|
-
export * from "./models/api/controlPlane/ICompleteTransferRequest.js";
|
|
30
|
-
export * from "./models/api/controlPlane/ICompleteTransferResponse.js";
|
|
31
35
|
export * from "./models/api/controlPlane/ISuspendTransferRequest.js";
|
|
32
36
|
export * from "./models/api/controlPlane/ISuspendTransferResponse.js";
|
|
33
37
|
export * from "./models/api/controlPlane/ITerminateTransferRequest.js";
|
|
34
38
|
export * from "./models/api/controlPlane/ITerminateTransferResponse.js";
|
|
35
|
-
export * from "./models/
|
|
36
|
-
export * from "./models/api/controlPlane/IGetTransferProcessResponse.js";
|
|
39
|
+
export * from "./models/activityTaskStatus.js";
|
|
37
40
|
export * from "./models/app/dataRequestType.js";
|
|
38
41
|
export * from "./models/app/IActivityQuery.js";
|
|
39
42
|
export * from "./models/app/IDataAssetEntitiesRequest.js";
|
|
40
43
|
export * from "./models/app/IDataAssetQuery.js";
|
|
41
|
-
export * from "./models/app/IQueryDataAssetRequest.js";
|
|
42
44
|
export * from "./models/app/IDataRequest.js";
|
|
43
|
-
export * from "./models/
|
|
45
|
+
export * from "./models/app/IQueryDataAssetRequest.js";
|
|
44
46
|
export * from "./models/IActivityLogDetails.js";
|
|
45
47
|
export * from "./models/IActivityLogEntry.js";
|
|
46
48
|
export * from "./models/IActivityLogStatusNotification.js";
|
|
47
49
|
export * from "./models/IActivityTask.js";
|
|
50
|
+
export * from "./models/IActivityTaskEntry.js";
|
|
48
51
|
export * from "./models/IDataAssetItemList.js";
|
|
49
52
|
export * from "./models/IDataAssetItemListResult.js";
|
|
50
53
|
export * from "./models/IEntitySet.js";
|
|
51
54
|
export * from "./models/IExecutionPayload.js";
|
|
52
55
|
export * from "./models/IFilteringQuery.js";
|
|
53
|
-
export * from "./models/ITaskApp.js";
|
|
@@ -1,8 +1,6 @@
|
|
|
1
|
-
import type { IError } from "@twin.org/core";
|
|
2
1
|
import type { ActivityProcessingStatus } from "./activityProcessingStatus.js";
|
|
3
|
-
import type { IActivityLogDates } from "./IActivityLogDates.js";
|
|
4
2
|
import type { IActivityLogDetails } from "./IActivityLogDetails.js";
|
|
5
|
-
import type {
|
|
3
|
+
import type { IActivityTaskEntry } from "./IActivityTaskEntry.js";
|
|
6
4
|
/**
|
|
7
5
|
* The details related to the processing of an Activity
|
|
8
6
|
*/
|
|
@@ -12,29 +10,7 @@ export interface IActivityLogEntry extends IActivityLogDetails {
|
|
|
12
10
|
*/
|
|
13
11
|
status: ActivityProcessingStatus;
|
|
14
12
|
/**
|
|
15
|
-
* The
|
|
13
|
+
* The tasks that have to be run to process the Activity.
|
|
16
14
|
*/
|
|
17
|
-
|
|
18
|
-
/**
|
|
19
|
-
* The running tasks that are processing the Activity.
|
|
20
|
-
*/
|
|
21
|
-
runningTasks?: (ITaskApp & IActivityLogDates)[];
|
|
22
|
-
/**
|
|
23
|
-
* The tasks that have already finalized.
|
|
24
|
-
*/
|
|
25
|
-
finalizedTasks?: (ITaskApp & IActivityLogDates & {
|
|
26
|
-
/**
|
|
27
|
-
* The task result.
|
|
28
|
-
*/
|
|
29
|
-
result: string;
|
|
30
|
-
})[];
|
|
31
|
-
/**
|
|
32
|
-
* The tasks that are in error.
|
|
33
|
-
*/
|
|
34
|
-
inErrorTasks?: (ITaskApp & {
|
|
35
|
-
/**
|
|
36
|
-
* The error that happened
|
|
37
|
-
*/
|
|
38
|
-
error: IError;
|
|
39
|
-
})[];
|
|
15
|
+
tasks?: IActivityTaskEntry[];
|
|
40
16
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { IActivityTaskEntry } from "./IActivityTaskEntry.js";
|
|
2
2
|
/**
|
|
3
3
|
* Denotes a task associated with an Activity
|
|
4
4
|
*/
|
|
@@ -10,5 +10,5 @@ export interface IActivityTask {
|
|
|
10
10
|
/**
|
|
11
11
|
* The associated tasks
|
|
12
12
|
*/
|
|
13
|
-
associatedTasks:
|
|
13
|
+
associatedTasks: IActivityTaskEntry[];
|
|
14
14
|
}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import type { IError } from "@twin.org/core";
|
|
2
|
+
import type { ActivityTaskStatus } from "./activityTaskStatus.js";
|
|
3
|
+
/**
|
|
4
|
+
* Denotes a task associated with a Dataspace App
|
|
5
|
+
*/
|
|
6
|
+
export interface IActivityTaskEntry {
|
|
7
|
+
/**
|
|
8
|
+
* Task Id.
|
|
9
|
+
*/
|
|
10
|
+
taskId: string;
|
|
11
|
+
/**
|
|
12
|
+
* Dataspace App Id.
|
|
13
|
+
*/
|
|
14
|
+
dataspaceAppId: string;
|
|
15
|
+
/**
|
|
16
|
+
* Task status.
|
|
17
|
+
*/
|
|
18
|
+
status: ActivityTaskStatus;
|
|
19
|
+
/**
|
|
20
|
+
* Processing Group Id.
|
|
21
|
+
*/
|
|
22
|
+
processingGroupId?: string;
|
|
23
|
+
/**
|
|
24
|
+
* Task processing start timestamp
|
|
25
|
+
*/
|
|
26
|
+
startDate?: string;
|
|
27
|
+
/**
|
|
28
|
+
* Task processing end timestamp
|
|
29
|
+
*/
|
|
30
|
+
endDate?: string;
|
|
31
|
+
/**
|
|
32
|
+
* The result of the task processing, if completed.
|
|
33
|
+
*/
|
|
34
|
+
result?: unknown;
|
|
35
|
+
/**
|
|
36
|
+
* The error occurred during task processing, if any.
|
|
37
|
+
*/
|
|
38
|
+
error?: IError;
|
|
39
|
+
}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Activity task statuses.
|
|
3
|
+
*/
|
|
4
|
+
export declare const ActivityTaskStatus: {
|
|
5
|
+
/**
|
|
6
|
+
* Pending.
|
|
7
|
+
*/
|
|
8
|
+
readonly Pending: "pending";
|
|
9
|
+
/**
|
|
10
|
+
* Processing.
|
|
11
|
+
*/
|
|
12
|
+
readonly Processing: "processing";
|
|
13
|
+
/**
|
|
14
|
+
* Success.
|
|
15
|
+
*/
|
|
16
|
+
readonly Success: "success";
|
|
17
|
+
/**
|
|
18
|
+
* Failed.
|
|
19
|
+
*/
|
|
20
|
+
readonly Failed: "failed";
|
|
21
|
+
};
|
|
22
|
+
/**
|
|
23
|
+
* Activity task statuses.
|
|
24
|
+
*/
|
|
25
|
+
export type ActivityTaskStatus = (typeof ActivityTaskStatus)[keyof typeof ActivityTaskStatus];
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import type { HeaderTypes, HttpStatusCode } from "@twin.org/web";
|
|
2
|
+
import type { IActivityLogEntry } from "../IActivityLogEntry.js";
|
|
3
|
+
/**
|
|
4
|
+
* Activity Stream Notify Response.
|
|
5
|
+
*/
|
|
6
|
+
export interface IActivityStreamNotifyResponse {
|
|
7
|
+
/**
|
|
8
|
+
* The status code indicating the result of the notification processing. It can be either:
|
|
9
|
+
* - `201 Created` if the notification was processed inline and a new activity log entry was created.
|
|
10
|
+
* - `102 Processing` if the notification was accepted for processing but has not been completed yet.
|
|
11
|
+
*/
|
|
12
|
+
statusCode: typeof HttpStatusCode.created | typeof HttpStatusCode.processing;
|
|
13
|
+
/**
|
|
14
|
+
* Optional headers.
|
|
15
|
+
*/
|
|
16
|
+
headers?: {
|
|
17
|
+
[HeaderTypes.Location]?: string;
|
|
18
|
+
};
|
|
19
|
+
/**
|
|
20
|
+
* The Activity log entry if the notification was processed inline.
|
|
21
|
+
*/
|
|
22
|
+
body?: IActivityLogEntry;
|
|
23
|
+
}
|
|
@@ -4,10 +4,18 @@ import type { IDataspaceProtocolDataset } from "@twin.org/standards-dataspace-pr
|
|
|
4
4
|
import type { IActivityQuery } from "./IActivityQuery.js";
|
|
5
5
|
import type { IDataRequest } from "./IDataRequest.js";
|
|
6
6
|
import type { IDataspaceActivity } from "../IDataspaceActivity.js";
|
|
7
|
+
import type { IProcessingGroupOptions } from "./IProcessingGroupOptions.js";
|
|
7
8
|
/**
|
|
8
9
|
* Interface describes a Dataspace App.
|
|
9
10
|
*/
|
|
10
11
|
export interface IDataspaceApp extends IComponent {
|
|
12
|
+
/**
|
|
13
|
+
* The settings for the processing groups for tasks.
|
|
14
|
+
* @returns The options for each process group.
|
|
15
|
+
*/
|
|
16
|
+
processingGroups?(): {
|
|
17
|
+
[id: string]: IProcessingGroupOptions;
|
|
18
|
+
};
|
|
11
19
|
/**
|
|
12
20
|
* The activities handled by the App.
|
|
13
21
|
* @returns A query that describes the set of activities handled by the App.
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Interface describes the options for a processing group, which determines how many tasks can be processed in parallel for a given group of activities.
|
|
3
|
+
*/
|
|
4
|
+
export interface IProcessingGroupOptions {
|
|
5
|
+
/**
|
|
6
|
+
* The number of concurrent tasks that can be processed for this processing group.
|
|
7
|
+
*/
|
|
8
|
+
concurrentTasks?: number;
|
|
9
|
+
/**
|
|
10
|
+
* Terminate the worker after it has been idle for the specified timeout in milliseconds,
|
|
11
|
+
* defaults to 0 for immediate shutdown, set to -1 to keep workers alive.
|
|
12
|
+
*/
|
|
13
|
+
idleShutdownTimeout?: number;
|
|
14
|
+
/**
|
|
15
|
+
* The number of times a task in this processing group should be retried in case of failure.
|
|
16
|
+
*/
|
|
17
|
+
retryCount?: number;
|
|
18
|
+
}
|
|
@@ -14,9 +14,9 @@ export interface IDataspaceDataPlaneComponent extends IComponent {
|
|
|
14
14
|
/**
|
|
15
15
|
* Notify an Activity to the Dataspace Data Plane Activity Stream.
|
|
16
16
|
* @param activity The Activity notified.
|
|
17
|
-
* @returns The
|
|
17
|
+
* @returns The activity's entry.
|
|
18
18
|
*/
|
|
19
|
-
notifyActivity(activity: IActivityStreamsActivity): Promise<string>;
|
|
19
|
+
notifyActivity(activity: IActivityStreamsActivity): Promise<string | IActivityLogEntry>;
|
|
20
20
|
/**
|
|
21
21
|
* Subscribes to the activity log.
|
|
22
22
|
* @param callback The callback to be called when Activity Log is called.
|
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,12 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.0.3-next.26](https://github.com/twinfoundation/dataspace/compare/dataspace-models-v0.0.3-next.25...dataspace-models-v0.0.3-next.26) (2026-04-14)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* add inline tasks and concurrent options ([#104](https://github.com/twinfoundation/dataspace/issues/104)) ([2227a21](https://github.com/twinfoundation/dataspace/commit/2227a212d906f58ba77850c79bb20bf2cb7195a8))
|
|
9
|
+
|
|
3
10
|
## [0.0.3-next.25](https://github.com/twinfoundation/dataspace/compare/dataspace-models-v0.0.3-next.24...dataspace-models-v0.0.3-next.25) (2026-04-10)
|
|
4
11
|
|
|
5
12
|
|
package/docs/reference/index.md
CHANGED
|
@@ -7,23 +7,23 @@
|
|
|
7
7
|
|
|
8
8
|
## Interfaces
|
|
9
9
|
|
|
10
|
-
- [IActivityLogDates](interfaces/IActivityLogDates.md)
|
|
11
10
|
- [IActivityLogDetails](interfaces/IActivityLogDetails.md)
|
|
12
11
|
- [IActivityLogEntry](interfaces/IActivityLogEntry.md)
|
|
13
12
|
- [IActivityLogStatusNotification](interfaces/IActivityLogStatusNotification.md)
|
|
14
13
|
- [IActivityTask](interfaces/IActivityTask.md)
|
|
14
|
+
- [IActivityTaskEntry](interfaces/IActivityTaskEntry.md)
|
|
15
15
|
- [IDataAssetItemList](interfaces/IDataAssetItemList.md)
|
|
16
16
|
- [IDataAssetItemListResult](interfaces/IDataAssetItemListResult.md)
|
|
17
17
|
- [IDataspaceActivity](interfaces/IDataspaceActivity.md)
|
|
18
18
|
- [IEntitySet](interfaces/IEntitySet.md)
|
|
19
19
|
- [IExecutionPayload](interfaces/IExecutionPayload.md)
|
|
20
20
|
- [IFilteringQuery](interfaces/IFilteringQuery.md)
|
|
21
|
-
- [ITaskApp](interfaces/ITaskApp.md)
|
|
22
21
|
- [IActivityLogEntryGetRequest](interfaces/IActivityLogEntryGetRequest.md)
|
|
23
22
|
- [IActivityLogEntryGetResponse](interfaces/IActivityLogEntryGetResponse.md)
|
|
24
23
|
- [IActivityLogStatusNotificationPayload](interfaces/IActivityLogStatusNotificationPayload.md)
|
|
25
24
|
- [IActivityLogStatusRequest](interfaces/IActivityLogStatusRequest.md)
|
|
26
25
|
- [IActivityStreamNotifyRequest](interfaces/IActivityStreamNotifyRequest.md)
|
|
26
|
+
- [IActivityStreamNotifyResponse](interfaces/IActivityStreamNotifyResponse.md)
|
|
27
27
|
- [IDataAssetEntitiesResponse](interfaces/IDataAssetEntitiesResponse.md)
|
|
28
28
|
- [IDataAssetGetEntitiesRequest](interfaces/IDataAssetGetEntitiesRequest.md)
|
|
29
29
|
- [IDataAssetQueryRequest](interfaces/IDataAssetQueryRequest.md)
|
|
@@ -43,6 +43,7 @@
|
|
|
43
43
|
- [IDataAssetEntitiesRequest](interfaces/IDataAssetEntitiesRequest.md)
|
|
44
44
|
- [IDataAssetQuery](interfaces/IDataAssetQuery.md)
|
|
45
45
|
- [IDataspaceApp](interfaces/IDataspaceApp.md)
|
|
46
|
+
- [IProcessingGroupOptions](interfaces/IProcessingGroupOptions.md)
|
|
46
47
|
- [IQueryDataAssetRequest](interfaces/IQueryDataAssetRequest.md)
|
|
47
48
|
- [IDataspaceControlPlaneComponent](interfaces/IDataspaceControlPlaneComponent.md)
|
|
48
49
|
- [IDataspaceControlPlaneResolverComponent](interfaces/IDataspaceControlPlaneResolverComponent.md)
|
|
@@ -55,6 +56,7 @@
|
|
|
55
56
|
## Type Aliases
|
|
56
57
|
|
|
57
58
|
- [ActivityProcessingStatus](type-aliases/ActivityProcessingStatus.md)
|
|
59
|
+
- [ActivityTaskStatus](type-aliases/ActivityTaskStatus.md)
|
|
58
60
|
- [IDataRequest](type-aliases/IDataRequest.md)
|
|
59
61
|
- [DataRequestType](type-aliases/DataRequestType.md)
|
|
60
62
|
- [TransferProcessRole](type-aliases/TransferProcessRole.md)
|
|
@@ -65,6 +67,7 @@
|
|
|
65
67
|
|
|
66
68
|
- [DataspaceAppFactory](variables/DataspaceAppFactory.md)
|
|
67
69
|
- [ActivityProcessingStatus](variables/ActivityProcessingStatus.md)
|
|
70
|
+
- [ActivityTaskStatus](variables/ActivityTaskStatus.md)
|
|
68
71
|
- [DataRequestType](variables/DataRequestType.md)
|
|
69
72
|
- [TransferProcessRole](variables/TransferProcessRole.md)
|
|
70
73
|
- [DataspaceContexts](variables/DataspaceContexts.md)
|
|
@@ -68,18 +68,6 @@ The last update date of this object.
|
|
|
68
68
|
|
|
69
69
|
***
|
|
70
70
|
|
|
71
|
-
### retryCount? {#retrycount}
|
|
72
|
-
|
|
73
|
-
> `optional` **retryCount?**: `number`
|
|
74
|
-
|
|
75
|
-
Number of times this activity has been retried.
|
|
76
|
-
|
|
77
|
-
#### Inherited from
|
|
78
|
-
|
|
79
|
-
[`IActivityLogDetails`](IActivityLogDetails.md).[`retryCount`](IActivityLogDetails.md#retrycount)
|
|
80
|
-
|
|
81
|
-
***
|
|
82
|
-
|
|
83
71
|
### status {#status}
|
|
84
72
|
|
|
85
73
|
> **status**: [`ActivityProcessingStatus`](../type-aliases/ActivityProcessingStatus.md)
|
|
@@ -88,32 +76,8 @@ Status of the Activity Processing.
|
|
|
88
76
|
|
|
89
77
|
***
|
|
90
78
|
|
|
91
|
-
###
|
|
92
|
-
|
|
93
|
-
> `optional` **pendingTasks?**: [`ITaskApp`](ITaskApp.md)[]
|
|
94
|
-
|
|
95
|
-
The pending tasks that have to be run to process the Activity.
|
|
96
|
-
|
|
97
|
-
***
|
|
98
|
-
|
|
99
|
-
### runningTasks? {#runningtasks}
|
|
100
|
-
|
|
101
|
-
> `optional` **runningTasks?**: [`ITaskApp`](ITaskApp.md) & [`IActivityLogDates`](IActivityLogDates.md)[]
|
|
102
|
-
|
|
103
|
-
The running tasks that are processing the Activity.
|
|
104
|
-
|
|
105
|
-
***
|
|
106
|
-
|
|
107
|
-
### finalizedTasks? {#finalizedtasks}
|
|
108
|
-
|
|
109
|
-
> `optional` **finalizedTasks?**: [`ITaskApp`](ITaskApp.md) & [`IActivityLogDates`](IActivityLogDates.md) & `object`[]
|
|
110
|
-
|
|
111
|
-
The tasks that have already finalized.
|
|
112
|
-
|
|
113
|
-
***
|
|
114
|
-
|
|
115
|
-
### inErrorTasks? {#inerrortasks}
|
|
79
|
+
### tasks? {#tasks}
|
|
116
80
|
|
|
117
|
-
> `optional` **
|
|
81
|
+
> `optional` **tasks?**: [`IActivityTaskEntry`](IActivityTaskEntry.md)[]
|
|
118
82
|
|
|
119
|
-
The tasks that
|
|
83
|
+
The tasks that have to be run to process the Activity.
|
|
@@ -25,3 +25,11 @@ FQN of the Object Type.
|
|
|
25
25
|
> `optional` **targetType?**: `string`
|
|
26
26
|
|
|
27
27
|
FQN of the target type.
|
|
28
|
+
|
|
29
|
+
***
|
|
30
|
+
|
|
31
|
+
### processingGroupId? {#processinggroupid}
|
|
32
|
+
|
|
33
|
+
> `optional` **processingGroupId?**: `string`
|
|
34
|
+
|
|
35
|
+
The processing group id for this query, used to determine which tasks can be processed in parallel.
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# Interface: IActivityStreamNotifyResponse
|
|
2
|
+
|
|
3
|
+
Activity Stream Notify Response.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
### statusCode {#statuscode}
|
|
8
|
+
|
|
9
|
+
> **statusCode**: `102` \| `201`
|
|
10
|
+
|
|
11
|
+
The status code indicating the result of the notification processing. It can be either:
|
|
12
|
+
- `201 Created` if the notification was processed inline and a new activity log entry was created.
|
|
13
|
+
- `102 Processing` if the notification was accepted for processing but has not been completed yet.
|
|
14
|
+
|
|
15
|
+
***
|
|
16
|
+
|
|
17
|
+
### headers? {#headers}
|
|
18
|
+
|
|
19
|
+
> `optional` **headers?**: `object`
|
|
20
|
+
|
|
21
|
+
Optional headers.
|
|
22
|
+
|
|
23
|
+
#### location?
|
|
24
|
+
|
|
25
|
+
> `optional` **location?**: `string`
|
|
26
|
+
|
|
27
|
+
***
|
|
28
|
+
|
|
29
|
+
### body? {#body}
|
|
30
|
+
|
|
31
|
+
> `optional` **body?**: [`IActivityLogEntry`](IActivityLogEntry.md)
|
|
32
|
+
|
|
33
|
+
The Activity log entry if the notification was processed inline.
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# Interface: IActivityTaskEntry
|
|
2
|
+
|
|
3
|
+
Denotes a task associated with a Dataspace App
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
### taskId {#taskid}
|
|
8
|
+
|
|
9
|
+
> **taskId**: `string`
|
|
10
|
+
|
|
11
|
+
Task Id.
|
|
12
|
+
|
|
13
|
+
***
|
|
14
|
+
|
|
15
|
+
### dataspaceAppId {#dataspaceappid}
|
|
16
|
+
|
|
17
|
+
> **dataspaceAppId**: `string`
|
|
18
|
+
|
|
19
|
+
Dataspace App Id.
|
|
20
|
+
|
|
21
|
+
***
|
|
22
|
+
|
|
23
|
+
### status {#status}
|
|
24
|
+
|
|
25
|
+
> **status**: [`ActivityTaskStatus`](../type-aliases/ActivityTaskStatus.md)
|
|
26
|
+
|
|
27
|
+
Task status.
|
|
28
|
+
|
|
29
|
+
***
|
|
30
|
+
|
|
31
|
+
### processingGroupId? {#processinggroupid}
|
|
32
|
+
|
|
33
|
+
> `optional` **processingGroupId?**: `string`
|
|
34
|
+
|
|
35
|
+
Processing Group Id.
|
|
36
|
+
|
|
37
|
+
***
|
|
38
|
+
|
|
39
|
+
### startDate? {#startdate}
|
|
40
|
+
|
|
41
|
+
> `optional` **startDate?**: `string`
|
|
42
|
+
|
|
43
|
+
Task processing start timestamp
|
|
44
|
+
|
|
45
|
+
***
|
|
46
|
+
|
|
47
|
+
### endDate? {#enddate}
|
|
48
|
+
|
|
49
|
+
> `optional` **endDate?**: `string`
|
|
50
|
+
|
|
51
|
+
Task processing end timestamp
|
|
52
|
+
|
|
53
|
+
***
|
|
54
|
+
|
|
55
|
+
### result? {#result}
|
|
56
|
+
|
|
57
|
+
> `optional` **result?**: `unknown`
|
|
58
|
+
|
|
59
|
+
The result of the task processing, if completed.
|
|
60
|
+
|
|
61
|
+
***
|
|
62
|
+
|
|
63
|
+
### error? {#error}
|
|
64
|
+
|
|
65
|
+
> `optional` **error?**: `IError`
|
|
66
|
+
|
|
67
|
+
The error occurred during task processing, if any.
|
|
@@ -8,6 +8,20 @@ Interface describes a Dataspace App.
|
|
|
8
8
|
|
|
9
9
|
## Methods
|
|
10
10
|
|
|
11
|
+
### processingGroups()? {#processinggroups}
|
|
12
|
+
|
|
13
|
+
> `optional` **processingGroups**(): `object`
|
|
14
|
+
|
|
15
|
+
The settings for the processing groups for tasks.
|
|
16
|
+
|
|
17
|
+
#### Returns
|
|
18
|
+
|
|
19
|
+
`object`
|
|
20
|
+
|
|
21
|
+
The options for each process group.
|
|
22
|
+
|
|
23
|
+
***
|
|
24
|
+
|
|
11
25
|
### activitiesHandled() {#activitieshandled}
|
|
12
26
|
|
|
13
27
|
> **activitiesHandled**(): [`IActivityQuery`](IActivityQuery.md)[]
|
|
@@ -11,7 +11,7 @@ Implements the Data Plane functionality for the Eclipse Dataspace Protocol.
|
|
|
11
11
|
|
|
12
12
|
### notifyActivity() {#notifyactivity}
|
|
13
13
|
|
|
14
|
-
> **notifyActivity**(`activity`): `Promise`\<`string
|
|
14
|
+
> **notifyActivity**(`activity`): `Promise`\<`string` \| [`IActivityLogEntry`](IActivityLogEntry.md)\>
|
|
15
15
|
|
|
16
16
|
Notify an Activity to the Dataspace Data Plane Activity Stream.
|
|
17
17
|
|
|
@@ -25,9 +25,9 @@ The Activity notified.
|
|
|
25
25
|
|
|
26
26
|
#### Returns
|
|
27
27
|
|
|
28
|
-
`Promise`\<`string
|
|
28
|
+
`Promise`\<`string` \| [`IActivityLogEntry`](IActivityLogEntry.md)\>
|
|
29
29
|
|
|
30
|
-
The
|
|
30
|
+
The activity's entry.
|
|
31
31
|
|
|
32
32
|
***
|
|
33
33
|
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Interface: IProcessingGroupOptions
|
|
2
|
+
|
|
3
|
+
Interface describes the options for a processing group, which determines how many tasks can be processed in parallel for a given group of activities.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
### concurrentTasks? {#concurrenttasks}
|
|
8
|
+
|
|
9
|
+
> `optional` **concurrentTasks?**: `number`
|
|
10
|
+
|
|
11
|
+
The number of concurrent tasks that can be processed for this processing group.
|
|
12
|
+
|
|
13
|
+
***
|
|
14
|
+
|
|
15
|
+
### idleShutdownTimeout? {#idleshutdowntimeout}
|
|
16
|
+
|
|
17
|
+
> `optional` **idleShutdownTimeout?**: `number`
|
|
18
|
+
|
|
19
|
+
Terminate the worker after it has been idle for the specified timeout in milliseconds,
|
|
20
|
+
defaults to 0 for immediate shutdown, set to -1 to keep workers alive.
|
|
21
|
+
|
|
22
|
+
***
|
|
23
|
+
|
|
24
|
+
### retryCount? {#retrycount}
|
|
25
|
+
|
|
26
|
+
> `optional` **retryCount?**: `number`
|
|
27
|
+
|
|
28
|
+
The number of times a task in this processing group should be retried in case of failure.
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# Variable: ActivityTaskStatus
|
|
2
|
+
|
|
3
|
+
> `const` **ActivityTaskStatus**: `object`
|
|
4
|
+
|
|
5
|
+
Activity task statuses.
|
|
6
|
+
|
|
7
|
+
## Type Declaration
|
|
8
|
+
|
|
9
|
+
### Pending {#pending}
|
|
10
|
+
|
|
11
|
+
> `readonly` **Pending**: `"pending"` = `"pending"`
|
|
12
|
+
|
|
13
|
+
Pending.
|
|
14
|
+
|
|
15
|
+
### Processing {#processing}
|
|
16
|
+
|
|
17
|
+
> `readonly` **Processing**: `"processing"` = `"processing"`
|
|
18
|
+
|
|
19
|
+
Processing.
|
|
20
|
+
|
|
21
|
+
### Success {#success}
|
|
22
|
+
|
|
23
|
+
> `readonly` **Success**: `"success"` = `"success"`
|
|
24
|
+
|
|
25
|
+
Success.
|
|
26
|
+
|
|
27
|
+
### Failed {#failed}
|
|
28
|
+
|
|
29
|
+
> `readonly` **Failed**: `"failed"` = `"failed"`
|
|
30
|
+
|
|
31
|
+
Failed.
|
package/package.json
CHANGED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"IActivityLogDates.js","sourceRoot":"","sources":["../../../src/models/IActivityLogDates.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Activity log dates.\n */\nexport interface IActivityLogDates {\n\t/**\n\t * Task processing start timestamp\n\t */\n\tstartDate: string;\n\n\t/**\n\t * Task processing end timestamp\n\t */\n\tendDate?: string;\n}\n"]}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"ITaskApp.js","sourceRoot":"","sources":["../../../src/models/ITaskApp.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Denotes a task associated with a Dataspace App\n */\nexport interface ITaskApp {\n\t/**\n\t * Task Id.\n\t */\n\ttaskId: string;\n\n\t/**\n\t * Dataspace App Id.\n\t */\n\tdataspaceAppId: string;\n}\n"]}
|
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
# Interface: IActivityLogDates
|
|
2
|
-
|
|
3
|
-
Activity log dates.
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
### startDate {#startdate}
|
|
8
|
-
|
|
9
|
-
> **startDate**: `string`
|
|
10
|
-
|
|
11
|
-
Task processing start timestamp
|
|
12
|
-
|
|
13
|
-
***
|
|
14
|
-
|
|
15
|
-
### endDate? {#enddate}
|
|
16
|
-
|
|
17
|
-
> `optional` **endDate?**: `string`
|
|
18
|
-
|
|
19
|
-
Task processing end timestamp
|
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
# Interface: ITaskApp
|
|
2
|
-
|
|
3
|
-
Denotes a task associated with a Dataspace App
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
### taskId {#taskid}
|
|
8
|
-
|
|
9
|
-
> **taskId**: `string`
|
|
10
|
-
|
|
11
|
-
Task Id.
|
|
12
|
-
|
|
13
|
-
***
|
|
14
|
-
|
|
15
|
-
### dataspaceAppId {#dataspaceappid}
|
|
16
|
-
|
|
17
|
-
> **dataspaceAppId**: `string`
|
|
18
|
-
|
|
19
|
-
Dataspace App Id.
|