@twin.org/dataspace-models 0.9.1 → 0.9.2-next.10
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/entities/dataspaceAppDataset.js +11 -2
- package/dist/es/entities/dataspaceAppDataset.js.map +1 -1
- package/dist/es/entities/dataspaceAppDatasetV0.js +73 -0
- package/dist/es/entities/dataspaceAppDatasetV0.js.map +1 -0
- package/dist/es/entities/transferProcess.js +14 -20
- package/dist/es/entities/transferProcess.js.map +1 -1
- package/dist/es/entities/transferProcessV0.js +156 -0
- package/dist/es/entities/transferProcessV0.js.map +1 -0
- package/dist/es/entities/transferRetrieval.js +38 -0
- package/dist/es/entities/transferRetrieval.js.map +1 -0
- package/dist/es/index.js +5 -0
- package/dist/es/index.js.map +1 -1
- package/dist/es/models/IPushDeliveryPayload.js.map +1 -1
- package/dist/es/models/api/controlPlane/IAppDatasetCreateRequest.js.map +1 -1
- package/dist/es/models/api/controlPlane/IAppDatasetUpdateRequest.js.map +1 -1
- package/dist/es/models/controlPlane/IDataspaceAppDataset.js.map +1 -1
- package/dist/es/models/controlPlane/IDataspaceControlPlaneComponent.js.map +1 -1
- package/dist/es/models/controlPlane/ITransferCallback.js.map +1 -1
- package/dist/es/models/controlPlane/ITransferProcess.js.map +1 -1
- package/dist/es/models/controlPlane/ITransferQueryResult.js +2 -0
- package/dist/es/models/controlPlane/ITransferQueryResult.js.map +1 -0
- package/dist/es/models/controlPlane/dataspaceControlPlaneMetricIds.js +5 -1
- package/dist/es/models/controlPlane/dataspaceControlPlaneMetricIds.js.map +1 -1
- package/dist/es/models/controlPlane/dataspaceControlPlaneMetrics.js +5 -0
- package/dist/es/models/controlPlane/dataspaceControlPlaneMetrics.js.map +1 -1
- package/dist/es/models/controlPlane/transferTerminationCode.js +14 -0
- package/dist/es/models/controlPlane/transferTerminationCode.js.map +1 -0
- package/dist/es/models/dataPlane/IDataspaceDataPlaneComponent.js.map +1 -1
- package/dist/types/entities/dataspaceAppDataset.d.ts +6 -1
- package/dist/types/entities/dataspaceAppDatasetV0.d.ts +39 -0
- package/dist/types/entities/transferProcess.d.ts +10 -13
- package/dist/types/entities/transferProcessV0.d.ts +83 -0
- package/dist/types/entities/transferRetrieval.d.ts +18 -0
- package/dist/types/index.d.ts +5 -0
- package/dist/types/models/IPushDeliveryPayload.d.ts +1 -1
- package/dist/types/models/api/controlPlane/IAppDatasetCreateRequest.d.ts +7 -2
- package/dist/types/models/api/controlPlane/IAppDatasetUpdateRequest.d.ts +5 -0
- package/dist/types/models/controlPlane/IDataspaceAppDataset.d.ts +5 -0
- package/dist/types/models/controlPlane/IDataspaceControlPlaneComponent.d.ts +36 -6
- package/dist/types/models/controlPlane/ITransferCallback.d.ts +3 -3
- package/dist/types/models/controlPlane/ITransferProcess.d.ts +2 -11
- package/dist/types/models/controlPlane/ITransferQueryResult.d.ts +14 -0
- package/dist/types/models/controlPlane/dataspaceControlPlaneMetricIds.d.ts +4 -0
- package/dist/types/models/controlPlane/transferTerminationCode.d.ts +14 -0
- package/dist/types/models/dataPlane/IDataspaceDataPlaneComponent.d.ts +1 -1
- package/docs/changelog.md +110 -0
- package/docs/reference/classes/DataspaceAppDataset.md +10 -1
- package/docs/reference/classes/DataspaceAppDatasetV0.md +77 -0
- package/docs/reference/classes/TransferProcess.md +12 -18
- package/docs/reference/classes/TransferProcessV0.md +156 -0
- package/docs/reference/classes/TransferRetrieval.md +38 -0
- package/docs/reference/index.md +6 -0
- package/docs/reference/interfaces/IAppDatasetCreateRequest.md +9 -2
- package/docs/reference/interfaces/IAppDatasetUpdateRequest.md +7 -0
- package/docs/reference/interfaces/IDataspaceAppDataset.md +9 -0
- package/docs/reference/interfaces/IDataspaceControlPlaneComponent.md +77 -5
- package/docs/reference/interfaces/IDataspaceDataPlaneComponent.md +1 -1
- package/docs/reference/interfaces/IPushDeliveryPayload.md +1 -1
- package/docs/reference/interfaces/ITransferCallback.md +3 -3
- package/docs/reference/interfaces/ITransferProcess.md +2 -14
- package/docs/reference/interfaces/ITransferQueryResult.md +19 -0
- package/docs/reference/type-aliases/TransferTerminationCode.md +5 -0
- package/docs/reference/variables/DataspaceControlPlaneMetricIds.md +6 -0
- package/docs/reference/variables/TransferTerminationCode.md +14 -0
- package/package.json +15 -14
|
@@ -15,7 +15,7 @@ let DataspaceAppDataset = class DataspaceAppDataset {
|
|
|
15
15
|
organizationIdentity;
|
|
16
16
|
/**
|
|
17
17
|
* The tenant that owns this dataset, captured from the request context at
|
|
18
|
-
* write time. Optional
|
|
18
|
+
* write time. Optional - single-tenant nodes (no `TWIN_TENANT_ENABLED`)
|
|
19
19
|
* register datasets without a tenant context.
|
|
20
20
|
*/
|
|
21
21
|
tenantId;
|
|
@@ -29,6 +29,11 @@ let DataspaceAppDataset = class DataspaceAppDataset {
|
|
|
29
29
|
* opaque object and validated/populated at publish time.
|
|
30
30
|
*/
|
|
31
31
|
dataset;
|
|
32
|
+
/**
|
|
33
|
+
* Idle window (ms) for this dataset's PULL transfers, overriding the node-level
|
|
34
|
+
* providerTransferIdleTimeoutMs; 0 disables the idle policy for this dataset.
|
|
35
|
+
*/
|
|
36
|
+
transferIdleTimeoutMs;
|
|
32
37
|
/**
|
|
33
38
|
* Creation timestamp (ISO string format).
|
|
34
39
|
*/
|
|
@@ -58,6 +63,10 @@ __decorate([
|
|
|
58
63
|
property({ type: "object", format: "json" }),
|
|
59
64
|
__metadata("design:type", Object)
|
|
60
65
|
], DataspaceAppDataset.prototype, "dataset", void 0);
|
|
66
|
+
__decorate([
|
|
67
|
+
property({ type: "number", optional: true }),
|
|
68
|
+
__metadata("design:type", Number)
|
|
69
|
+
], DataspaceAppDataset.prototype, "transferIdleTimeoutMs", void 0);
|
|
61
70
|
__decorate([
|
|
62
71
|
property({ type: "string", format: "date-time", sortDirection: SortDirection.Descending }),
|
|
63
72
|
__metadata("design:type", String)
|
|
@@ -67,7 +76,7 @@ __decorate([
|
|
|
67
76
|
__metadata("design:type", String)
|
|
68
77
|
], DataspaceAppDataset.prototype, "dateModified", void 0);
|
|
69
78
|
DataspaceAppDataset = __decorate([
|
|
70
|
-
entity()
|
|
79
|
+
entity({ version: 1 })
|
|
71
80
|
], DataspaceAppDataset);
|
|
72
81
|
export { DataspaceAppDataset };
|
|
73
82
|
//# sourceMappingURL=dataspaceAppDataset.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"dataspaceAppDataset.js","sourceRoot":"","sources":["../../../src/entities/dataspaceAppDataset.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEnE;;GAEG;AAEI,IAAM,mBAAmB,GAAzB,MAAM,mBAAmB;IAC/B;;OAEG;IAEI,EAAE,CAAU;IAEnB;;OAEG;IAEI,oBAAoB,CAAU;IAErC;;;;OAIG;IAEI,QAAQ,CAAU;IAEzB;;;OAGG;IAEI,KAAK,CAAU;IAEtB;;;OAGG;IAEI,OAAO,CAA8B;IAE5C;;OAEG;IAEI,WAAW,CAAU;IAE5B;;OAEG;IAEI,YAAY,CAAU;CAC7B,CAAA;
|
|
1
|
+
{"version":3,"file":"dataspaceAppDataset.js","sourceRoot":"","sources":["../../../src/entities/dataspaceAppDataset.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEnE;;GAEG;AAEI,IAAM,mBAAmB,GAAzB,MAAM,mBAAmB;IAC/B;;OAEG;IAEI,EAAE,CAAU;IAEnB;;OAEG;IAEI,oBAAoB,CAAU;IAErC;;;;OAIG;IAEI,QAAQ,CAAU;IAEzB;;;OAGG;IAEI,KAAK,CAAU;IAEtB;;;OAGG;IAEI,OAAO,CAA8B;IAE5C;;;OAGG;IAEI,qBAAqB,CAAU;IAEtC;;OAEG;IAEI,WAAW,CAAU;IAE5B;;OAEG;IAEI,YAAY,CAAU;CAC7B,CAAA;AAhDO;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;;+CAC3B;AAMZ;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;;iEACX;AAQ9B;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;qDACpB;AAOlB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;kDACP;AAOf;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;;oDACD;AAOrC;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;kEACP;AAM/B;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,aAAa,EAAE,aAAa,CAAC,UAAU,EAAE,CAAC;;wDAC/D;AAMrB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC;;yDACrB;AApDjB,mBAAmB;IAD/B,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;GACV,mBAAmB,CAqD/B","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { entity, property, SortDirection } from \"@twin.org/entity\";\n\n/**\n * Tenant-supplied Dataset shape persisted by the Control Plane.\n */\n@entity({ version: 1 })\nexport class DataspaceAppDataset {\n\t/**\n\t * The unique identifier for the dataset.\n\t */\n\t@property({ type: \"string\", isPrimary: true })\n\tpublic id!: string;\n\n\t/**\n\t * The identity of the organization that owns this entity.\n\t */\n\t@property({ type: \"string\", isSecondary: true })\n\tpublic organizationIdentity!: string;\n\n\t/**\n\t * The tenant that owns this dataset, captured from the request context at\n\t * write time. Optional - single-tenant nodes (no `TWIN_TENANT_ENABLED`)\n\t * register datasets without a tenant context.\n\t */\n\t@property({ type: \"string\", optional: true })\n\tpublic tenantId?: string;\n\n\t/**\n\t * The dataspace app that this dataset belongs to. Matches the app's\n\t * registered name in `DataspaceAppFactory` (typically the app's URI).\n\t */\n\t@property({ type: \"string\" })\n\tpublic appId!: string;\n\n\t/**\n\t * The user-controlled JSON-LD dataset payload. Stored as an\n\t * opaque object and validated/populated at publish time.\n\t */\n\t@property({ type: \"object\", format: \"json\" })\n\tpublic dataset!: { [key: string]: unknown };\n\n\t/**\n\t * Idle window (ms) for this dataset's PULL transfers, overriding the node-level\n\t * providerTransferIdleTimeoutMs; 0 disables the idle policy for this dataset.\n\t */\n\t@property({ type: \"number\", optional: true })\n\tpublic transferIdleTimeoutMs?: number;\n\n\t/**\n\t * Creation timestamp (ISO string format).\n\t */\n\t@property({ type: \"string\", format: \"date-time\", sortDirection: SortDirection.Descending })\n\tpublic dateCreated!: string;\n\n\t/**\n\t * Last update timestamp (ISO string format).\n\t */\n\t@property({ type: \"string\", format: \"date-time\" })\n\tpublic dateModified!: string;\n}\n"]}
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
// Copyright 2025 IOTA Stiftung.
|
|
2
|
+
// SPDX-License-Identifier: Apache-2.0.
|
|
3
|
+
import { entity, property, SortDirection } from "@twin.org/entity";
|
|
4
|
+
/**
|
|
5
|
+
* Tenant-supplied Dataset shape persisted by the Control Plane, version 0.
|
|
6
|
+
*/
|
|
7
|
+
let DataspaceAppDatasetV0 = class DataspaceAppDatasetV0 {
|
|
8
|
+
/**
|
|
9
|
+
* The unique identifier for the dataset.
|
|
10
|
+
*/
|
|
11
|
+
id;
|
|
12
|
+
/**
|
|
13
|
+
* The identity of the organization that owns this entity.
|
|
14
|
+
*/
|
|
15
|
+
organizationIdentity;
|
|
16
|
+
/**
|
|
17
|
+
* The tenant that owns this dataset, captured from the request context at
|
|
18
|
+
* write time. Optional - single-tenant nodes (no `TWIN_TENANT_ENABLED`)
|
|
19
|
+
* register datasets without a tenant context.
|
|
20
|
+
*/
|
|
21
|
+
tenantId;
|
|
22
|
+
/**
|
|
23
|
+
* The dataspace app that this dataset belongs to. Matches the app's
|
|
24
|
+
* registered name in `DataspaceAppFactory` (typically the app's URI).
|
|
25
|
+
*/
|
|
26
|
+
appId;
|
|
27
|
+
/**
|
|
28
|
+
* The user-controlled JSON-LD dataset payload. Stored as an
|
|
29
|
+
* opaque object and validated/populated at publish time.
|
|
30
|
+
*/
|
|
31
|
+
dataset;
|
|
32
|
+
/**
|
|
33
|
+
* Creation timestamp (ISO string format).
|
|
34
|
+
*/
|
|
35
|
+
dateCreated;
|
|
36
|
+
/**
|
|
37
|
+
* Last update timestamp (ISO string format).
|
|
38
|
+
*/
|
|
39
|
+
dateModified;
|
|
40
|
+
};
|
|
41
|
+
__decorate([
|
|
42
|
+
property({ type: "string", isPrimary: true }),
|
|
43
|
+
__metadata("design:type", String)
|
|
44
|
+
], DataspaceAppDatasetV0.prototype, "id", void 0);
|
|
45
|
+
__decorate([
|
|
46
|
+
property({ type: "string", isSecondary: true }),
|
|
47
|
+
__metadata("design:type", String)
|
|
48
|
+
], DataspaceAppDatasetV0.prototype, "organizationIdentity", void 0);
|
|
49
|
+
__decorate([
|
|
50
|
+
property({ type: "string", optional: true }),
|
|
51
|
+
__metadata("design:type", String)
|
|
52
|
+
], DataspaceAppDatasetV0.prototype, "tenantId", void 0);
|
|
53
|
+
__decorate([
|
|
54
|
+
property({ type: "string" }),
|
|
55
|
+
__metadata("design:type", String)
|
|
56
|
+
], DataspaceAppDatasetV0.prototype, "appId", void 0);
|
|
57
|
+
__decorate([
|
|
58
|
+
property({ type: "object", format: "json" }),
|
|
59
|
+
__metadata("design:type", Object)
|
|
60
|
+
], DataspaceAppDatasetV0.prototype, "dataset", void 0);
|
|
61
|
+
__decorate([
|
|
62
|
+
property({ type: "string", format: "date-time", sortDirection: SortDirection.Descending }),
|
|
63
|
+
__metadata("design:type", String)
|
|
64
|
+
], DataspaceAppDatasetV0.prototype, "dateCreated", void 0);
|
|
65
|
+
__decorate([
|
|
66
|
+
property({ type: "string", format: "date-time" }),
|
|
67
|
+
__metadata("design:type", String)
|
|
68
|
+
], DataspaceAppDatasetV0.prototype, "dateModified", void 0);
|
|
69
|
+
DataspaceAppDatasetV0 = __decorate([
|
|
70
|
+
entity({ version: 0 })
|
|
71
|
+
], DataspaceAppDatasetV0);
|
|
72
|
+
export { DataspaceAppDatasetV0 };
|
|
73
|
+
//# sourceMappingURL=dataspaceAppDatasetV0.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"dataspaceAppDatasetV0.js","sourceRoot":"","sources":["../../../src/entities/dataspaceAppDatasetV0.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEnE;;GAEG;AAEI,IAAM,qBAAqB,GAA3B,MAAM,qBAAqB;IACjC;;OAEG;IAEI,EAAE,CAAU;IAEnB;;OAEG;IAEI,oBAAoB,CAAU;IAErC;;;;OAIG;IAEI,QAAQ,CAAU;IAEzB;;;OAGG;IAEI,KAAK,CAAU;IAEtB;;;OAGG;IAEI,OAAO,CAA8B;IAE5C;;OAEG;IAEI,WAAW,CAAU;IAE5B;;OAEG;IAEI,YAAY,CAAU;CAC7B,CAAA;AAzCO;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;;iDAC3B;AAMZ;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;;mEACX;AAQ9B;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;uDACpB;AAOlB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;oDACP;AAOf;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;;sDACD;AAMrC;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,aAAa,EAAE,aAAa,CAAC,UAAU,EAAE,CAAC;;0DAC/D;AAMrB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC;;2DACrB;AA7CjB,qBAAqB;IADjC,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;GACV,qBAAqB,CA8CjC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { entity, property, SortDirection } from \"@twin.org/entity\";\n\n/**\n * Tenant-supplied Dataset shape persisted by the Control Plane, version 0.\n */\n@entity({ version: 0 })\nexport class DataspaceAppDatasetV0 {\n\t/**\n\t * The unique identifier for the dataset.\n\t */\n\t@property({ type: \"string\", isPrimary: true })\n\tpublic id!: string;\n\n\t/**\n\t * The identity of the organization that owns this entity.\n\t */\n\t@property({ type: \"string\", isSecondary: true })\n\tpublic organizationIdentity!: string;\n\n\t/**\n\t * The tenant that owns this dataset, captured from the request context at\n\t * write time. Optional - single-tenant nodes (no `TWIN_TENANT_ENABLED`)\n\t * register datasets without a tenant context.\n\t */\n\t@property({ type: \"string\", optional: true })\n\tpublic tenantId?: string;\n\n\t/**\n\t * The dataspace app that this dataset belongs to. Matches the app's\n\t * registered name in `DataspaceAppFactory` (typically the app's URI).\n\t */\n\t@property({ type: \"string\" })\n\tpublic appId!: string;\n\n\t/**\n\t * The user-controlled JSON-LD dataset payload. Stored as an\n\t * opaque object and validated/populated at publish time.\n\t */\n\t@property({ type: \"object\", format: \"json\" })\n\tpublic dataset!: { [key: string]: unknown };\n\n\t/**\n\t * Creation timestamp (ISO string format).\n\t */\n\t@property({ type: \"string\", format: \"date-time\", sortDirection: SortDirection.Descending })\n\tpublic dateCreated!: string;\n\n\t/**\n\t * Last update timestamp (ISO string format).\n\t */\n\t@property({ type: \"string\", format: \"date-time\" })\n\tpublic dateModified!: string;\n}\n"]}
|
|
@@ -7,14 +7,15 @@ import { entity, property, SortDirection } from "@twin.org/entity";
|
|
|
7
7
|
*/
|
|
8
8
|
let TransferProcess = class TransferProcess {
|
|
9
9
|
/**
|
|
10
|
-
*
|
|
11
|
-
*
|
|
10
|
+
* Internal id, the primary key. Both role records of a self transfer share consumerPid and
|
|
11
|
+
* providerPid, so only the internal id is collision-free within one partition.
|
|
12
12
|
*/
|
|
13
|
-
|
|
13
|
+
id;
|
|
14
14
|
/**
|
|
15
|
-
*
|
|
15
|
+
* Consumer Process ID from the DSP protocol.
|
|
16
|
+
* Indexed for lookup by consumerPid.
|
|
16
17
|
*/
|
|
17
|
-
|
|
18
|
+
consumerPid;
|
|
18
19
|
/**
|
|
19
20
|
* Provider Process ID from the DSP protocol.
|
|
20
21
|
* Indexed for lookup by providerPid.
|
|
@@ -47,8 +48,8 @@ let TransferProcess = class TransferProcess {
|
|
|
47
48
|
providerIdentity;
|
|
48
49
|
/**
|
|
49
50
|
* This node's role in the transfer, captured at write time so state transitions and async delivery
|
|
50
|
-
* can tell which party we are without inferring it from the matched PID (
|
|
51
|
-
*
|
|
51
|
+
* can tell which party we are without inferring it from the matched PID (a self transfer stores two
|
|
52
|
+
* records sharing both pids). Optional for back-compat with records written before this field existed.
|
|
52
53
|
*/
|
|
53
54
|
localRole;
|
|
54
55
|
/**
|
|
@@ -72,22 +73,19 @@ let TransferProcess = class TransferProcess {
|
|
|
72
73
|
*/
|
|
73
74
|
dateModified;
|
|
74
75
|
/**
|
|
75
|
-
*
|
|
76
|
-
|
|
77
|
-
policies;
|
|
78
|
-
/**
|
|
79
|
-
* Data address for push mode transfers (stored as JSON).
|
|
76
|
+
* Data address for the transfer (stored as JSON): the consumer's inbox for PUSH, or the
|
|
77
|
+
* provider-built address persisted at start for PULL/POST; may expire while STARTED.
|
|
80
78
|
*/
|
|
81
79
|
dataAddress;
|
|
82
80
|
};
|
|
83
81
|
__decorate([
|
|
84
82
|
property({ type: "string", isPrimary: true }),
|
|
85
83
|
__metadata("design:type", String)
|
|
86
|
-
], TransferProcess.prototype, "
|
|
84
|
+
], TransferProcess.prototype, "id", void 0);
|
|
87
85
|
__decorate([
|
|
88
|
-
property({ type: "string" }),
|
|
86
|
+
property({ type: "string", isSecondary: true }),
|
|
89
87
|
__metadata("design:type", String)
|
|
90
|
-
], TransferProcess.prototype, "
|
|
88
|
+
], TransferProcess.prototype, "consumerPid", void 0);
|
|
91
89
|
__decorate([
|
|
92
90
|
property({ type: "string", isSecondary: true }),
|
|
93
91
|
__metadata("design:type", String)
|
|
@@ -140,16 +138,12 @@ __decorate([
|
|
|
140
138
|
property({ type: "string", format: "date-time" }),
|
|
141
139
|
__metadata("design:type", String)
|
|
142
140
|
], TransferProcess.prototype, "dateModified", void 0);
|
|
143
|
-
__decorate([
|
|
144
|
-
property({ type: "array", format: "json", optional: true }),
|
|
145
|
-
__metadata("design:type", Array)
|
|
146
|
-
], TransferProcess.prototype, "policies", void 0);
|
|
147
141
|
__decorate([
|
|
148
142
|
property({ type: "object", format: "json", optional: true }),
|
|
149
143
|
__metadata("design:type", Object)
|
|
150
144
|
], TransferProcess.prototype, "dataAddress", void 0);
|
|
151
145
|
TransferProcess = __decorate([
|
|
152
|
-
entity()
|
|
146
|
+
entity({ version: 1 })
|
|
153
147
|
], TransferProcess);
|
|
154
148
|
export { TransferProcess };
|
|
155
149
|
//# sourceMappingURL=transferProcess.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"transferProcess.js","sourceRoot":"","sources":["../../../src/entities/transferProcess.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;
|
|
1
|
+
{"version":3,"file":"transferProcess.js","sourceRoot":"","sources":["../../../src/entities/transferProcess.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAOnE;;;GAGG;AAEI,IAAM,eAAe,GAArB,MAAM,eAAe;IAC3B;;;OAGG;IAEI,EAAE,CAAU;IAEnB;;;OAGG;IAEI,WAAW,CAAU;IAE5B;;;OAGG;IAEI,WAAW,CAAU;IAE5B;;OAEG;IAEI,WAAW,CAAU;IAE5B;;;OAGG;IAEI,KAAK,CAA6C;IAEzD;;OAEG;IAEI,SAAS,CAAU;IAE1B;;OAEG;IAEI,OAAO,CAAU;IAExB;;OAEG;IAEI,gBAAgB,CAAU;IAEjC;;OAEG;IAEI,gBAAgB,CAAU;IAEjC;;;;OAIG;IAEI,SAAS,CAAuB;IAEvC;;OAEG;IAEI,MAAM,CAAU;IAEvB;;OAEG;IAEI,eAAe,CAAU;IAEhC;;OAEG;IAEI,oBAAoB,CAAU;IAErC;;OAEG;IAEI,WAAW,CAAU;IAE5B;;OAEG;IAEI,YAAY,CAAU;IAE7B;;;OAGG;IAEI,WAAW,CAAiC;CACnD,CAAA;AAjGO;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;;2CAC3B;AAOZ;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;;oDACpB;AAOrB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;;oDACpB;AAMrB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;oDACD;AAOrB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;8CAC4B;AAMlD;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;kDACH;AAMnB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;gDACL;AAMjB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;yDACZ;AAM1B;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;yDACZ;AAQ1B;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;kDACN;AAMhC;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;+CACtB;AAMhB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;wDACb;AAMzB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;6DACQ;AAM9B;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,aAAa,EAAE,aAAa,CAAC,UAAU,EAAE,CAAC;;oDAC/D;AAMrB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC;;qDACrB;AAOtB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;oDACV;AAtGvC,eAAe;IAD3B,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;GACV,eAAe,CAuG3B","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { entity, property, SortDirection } from \"@twin.org/entity\";\nimport type {\n\tDataspaceProtocolTransferProcessStateType,\n\tIDataspaceProtocolDataAddress\n} from \"@twin.org/standards-dataspace-protocol\";\nimport type { TransferProcessRole } from \"../models/controlPlane/transferProcessRole.js\";\n\n/**\n * Transfer Process for shared storage between Control Plane and Data Plane.\n * This entity is the persistent representation of ITransferProcess.\n */\n@entity({ version: 1 })\nexport class TransferProcess {\n\t/**\n\t * Internal id, the primary key. Both role records of a self transfer share consumerPid and\n\t * providerPid, so only the internal id is collision-free within one partition.\n\t */\n\t@property({ type: \"string\", isPrimary: true })\n\tpublic id!: string;\n\n\t/**\n\t * Consumer Process ID from the DSP protocol.\n\t * Indexed for lookup by consumerPid.\n\t */\n\t@property({ type: \"string\", isSecondary: true })\n\tpublic consumerPid!: string;\n\n\t/**\n\t * Provider Process ID from the DSP protocol.\n\t * Indexed for lookup by providerPid.\n\t */\n\t@property({ type: \"string\", isSecondary: true })\n\tpublic providerPid!: string;\n\n\t/**\n\t * Agreement ID linking to the rights-management Agreement.\n\t */\n\t@property({ type: \"string\" })\n\tpublic agreementId!: string;\n\n\t/**\n\t * Transfer Process state from the DSP protocol.\n\t * One of: REQUESTED, STARTED, COMPLETED, SUSPENDED, TERMINATED.\n\t */\n\t@property({ type: \"string\" })\n\tpublic state!: DataspaceProtocolTransferProcessStateType;\n\n\t/**\n\t * Dataset ID for DSC resolution.\n\t */\n\t@property({ type: \"string\" })\n\tpublic datasetId!: string;\n\n\t/**\n\t * Offer ID from the original Catalog offer.\n\t */\n\t@property({ type: \"string\" })\n\tpublic offerId!: string;\n\n\t/**\n\t * Consumer identity (DID or URI).\n\t */\n\t@property({ type: \"string\", optional: true })\n\tpublic consumerIdentity?: string;\n\n\t/**\n\t * Provider identity (DID or URI).\n\t */\n\t@property({ type: \"string\", optional: true })\n\tpublic providerIdentity?: string;\n\n\t/**\n\t * This node's role in the transfer, captured at write time so state transitions and async delivery\n\t * can tell which party we are without inferring it from the matched PID (a self transfer stores two\n\t * records sharing both pids). Optional for back-compat with records written before this field existed.\n\t */\n\t@property({ type: \"string\", optional: true })\n\tpublic localRole?: TransferProcessRole;\n\n\t/**\n\t * Data format from the Dataset Distribution.\n\t */\n\t@property({ type: \"string\", optional: true })\n\tpublic format?: string;\n\n\t/**\n\t * Callback address for Consumer notifications.\n\t */\n\t@property({ type: \"string\", optional: true })\n\tpublic callbackAddress?: string;\n\n\t/**\n\t * The organization that owns this transfer process, captured from the request context at write time.\n\t */\n\t@property({ type: \"string\" })\n\tpublic organizationIdentity!: string;\n\n\t/**\n\t * Creation timestamp (ISO string format).\n\t */\n\t@property({ type: \"string\", format: \"date-time\", sortDirection: SortDirection.Descending })\n\tpublic dateCreated!: string;\n\n\t/**\n\t * Last update timestamp (ISO string format).\n\t */\n\t@property({ type: \"string\", format: \"date-time\" })\n\tpublic dateModified!: string;\n\n\t/**\n\t * Data address for the transfer (stored as JSON): the consumer's inbox for PUSH, or the\n\t * provider-built address persisted at start for PULL/POST; may expire while STARTED.\n\t */\n\t@property({ type: \"object\", format: \"json\", optional: true })\n\tpublic dataAddress?: IDataspaceProtocolDataAddress;\n}\n"]}
|
|
@@ -0,0 +1,156 @@
|
|
|
1
|
+
// Copyright 2025 IOTA Stiftung.
|
|
2
|
+
// SPDX-License-Identifier: Apache-2.0.
|
|
3
|
+
import { entity, property, SortDirection } from "@twin.org/entity";
|
|
4
|
+
/**
|
|
5
|
+
* Transfer Process for shared storage between Control Plane and Data Plane, version 0.
|
|
6
|
+
* Keyed on consumerPid; superseded by the version keyed on the internal id.
|
|
7
|
+
*/
|
|
8
|
+
let TransferProcessV0 = class TransferProcessV0 {
|
|
9
|
+
/**
|
|
10
|
+
* The consumer PID is the primary key.
|
|
11
|
+
* Used for direct lookup by consumerPid.
|
|
12
|
+
*/
|
|
13
|
+
consumerPid;
|
|
14
|
+
/**
|
|
15
|
+
* Internal UUID for storage (secondary key for providerPid lookup).
|
|
16
|
+
*/
|
|
17
|
+
id;
|
|
18
|
+
/**
|
|
19
|
+
* Provider Process ID from the DSP protocol.
|
|
20
|
+
* Indexed for lookup by providerPid.
|
|
21
|
+
*/
|
|
22
|
+
providerPid;
|
|
23
|
+
/**
|
|
24
|
+
* Agreement ID linking to the rights-management Agreement.
|
|
25
|
+
*/
|
|
26
|
+
agreementId;
|
|
27
|
+
/**
|
|
28
|
+
* Transfer Process state from the DSP protocol.
|
|
29
|
+
* One of: REQUESTED, STARTED, COMPLETED, SUSPENDED, TERMINATED.
|
|
30
|
+
*/
|
|
31
|
+
state;
|
|
32
|
+
/**
|
|
33
|
+
* Dataset ID for DSC resolution.
|
|
34
|
+
*/
|
|
35
|
+
datasetId;
|
|
36
|
+
/**
|
|
37
|
+
* Offer ID from the original Catalog offer.
|
|
38
|
+
*/
|
|
39
|
+
offerId;
|
|
40
|
+
/**
|
|
41
|
+
* Consumer identity (DID or URI).
|
|
42
|
+
*/
|
|
43
|
+
consumerIdentity;
|
|
44
|
+
/**
|
|
45
|
+
* Provider identity (DID or URI).
|
|
46
|
+
*/
|
|
47
|
+
providerIdentity;
|
|
48
|
+
/**
|
|
49
|
+
* This node's role in the transfer, captured at write time so state transitions and async delivery
|
|
50
|
+
* can tell which party we are without inferring it from the matched PID (consumerPid is the primary
|
|
51
|
+
* key on both nodes). Optional for back-compat with records written before this field existed.
|
|
52
|
+
*/
|
|
53
|
+
localRole;
|
|
54
|
+
/**
|
|
55
|
+
* Data format from the Dataset Distribution.
|
|
56
|
+
*/
|
|
57
|
+
format;
|
|
58
|
+
/**
|
|
59
|
+
* Callback address for Consumer notifications.
|
|
60
|
+
*/
|
|
61
|
+
callbackAddress;
|
|
62
|
+
/**
|
|
63
|
+
* The organization that owns this transfer process, captured from the request context at write time.
|
|
64
|
+
*/
|
|
65
|
+
organizationIdentity;
|
|
66
|
+
/**
|
|
67
|
+
* Creation timestamp (ISO string format).
|
|
68
|
+
*/
|
|
69
|
+
dateCreated;
|
|
70
|
+
/**
|
|
71
|
+
* Last update timestamp (ISO string format).
|
|
72
|
+
*/
|
|
73
|
+
dateModified;
|
|
74
|
+
/**
|
|
75
|
+
* Policies from the Agreement (stored as JSON).
|
|
76
|
+
*/
|
|
77
|
+
policies;
|
|
78
|
+
/**
|
|
79
|
+
* Data address for the transfer (stored as JSON): the consumer's inbox for PUSH, or the
|
|
80
|
+
* provider-built address persisted at start for PULL/POST; may expire while STARTED.
|
|
81
|
+
*/
|
|
82
|
+
dataAddress;
|
|
83
|
+
};
|
|
84
|
+
__decorate([
|
|
85
|
+
property({ type: "string", isPrimary: true }),
|
|
86
|
+
__metadata("design:type", String)
|
|
87
|
+
], TransferProcessV0.prototype, "consumerPid", void 0);
|
|
88
|
+
__decorate([
|
|
89
|
+
property({ type: "string" }),
|
|
90
|
+
__metadata("design:type", String)
|
|
91
|
+
], TransferProcessV0.prototype, "id", void 0);
|
|
92
|
+
__decorate([
|
|
93
|
+
property({ type: "string", isSecondary: true }),
|
|
94
|
+
__metadata("design:type", String)
|
|
95
|
+
], TransferProcessV0.prototype, "providerPid", void 0);
|
|
96
|
+
__decorate([
|
|
97
|
+
property({ type: "string" }),
|
|
98
|
+
__metadata("design:type", String)
|
|
99
|
+
], TransferProcessV0.prototype, "agreementId", void 0);
|
|
100
|
+
__decorate([
|
|
101
|
+
property({ type: "string" }),
|
|
102
|
+
__metadata("design:type", String)
|
|
103
|
+
], TransferProcessV0.prototype, "state", void 0);
|
|
104
|
+
__decorate([
|
|
105
|
+
property({ type: "string" }),
|
|
106
|
+
__metadata("design:type", String)
|
|
107
|
+
], TransferProcessV0.prototype, "datasetId", void 0);
|
|
108
|
+
__decorate([
|
|
109
|
+
property({ type: "string" }),
|
|
110
|
+
__metadata("design:type", String)
|
|
111
|
+
], TransferProcessV0.prototype, "offerId", void 0);
|
|
112
|
+
__decorate([
|
|
113
|
+
property({ type: "string", optional: true }),
|
|
114
|
+
__metadata("design:type", String)
|
|
115
|
+
], TransferProcessV0.prototype, "consumerIdentity", void 0);
|
|
116
|
+
__decorate([
|
|
117
|
+
property({ type: "string", optional: true }),
|
|
118
|
+
__metadata("design:type", String)
|
|
119
|
+
], TransferProcessV0.prototype, "providerIdentity", void 0);
|
|
120
|
+
__decorate([
|
|
121
|
+
property({ type: "string", optional: true }),
|
|
122
|
+
__metadata("design:type", String)
|
|
123
|
+
], TransferProcessV0.prototype, "localRole", void 0);
|
|
124
|
+
__decorate([
|
|
125
|
+
property({ type: "string", optional: true }),
|
|
126
|
+
__metadata("design:type", String)
|
|
127
|
+
], TransferProcessV0.prototype, "format", void 0);
|
|
128
|
+
__decorate([
|
|
129
|
+
property({ type: "string", optional: true }),
|
|
130
|
+
__metadata("design:type", String)
|
|
131
|
+
], TransferProcessV0.prototype, "callbackAddress", void 0);
|
|
132
|
+
__decorate([
|
|
133
|
+
property({ type: "string" }),
|
|
134
|
+
__metadata("design:type", String)
|
|
135
|
+
], TransferProcessV0.prototype, "organizationIdentity", void 0);
|
|
136
|
+
__decorate([
|
|
137
|
+
property({ type: "string", format: "date-time", sortDirection: SortDirection.Descending }),
|
|
138
|
+
__metadata("design:type", String)
|
|
139
|
+
], TransferProcessV0.prototype, "dateCreated", void 0);
|
|
140
|
+
__decorate([
|
|
141
|
+
property({ type: "string", format: "date-time" }),
|
|
142
|
+
__metadata("design:type", String)
|
|
143
|
+
], TransferProcessV0.prototype, "dateModified", void 0);
|
|
144
|
+
__decorate([
|
|
145
|
+
property({ type: "array", format: "json", optional: true }),
|
|
146
|
+
__metadata("design:type", Array)
|
|
147
|
+
], TransferProcessV0.prototype, "policies", void 0);
|
|
148
|
+
__decorate([
|
|
149
|
+
property({ type: "object", format: "json", optional: true }),
|
|
150
|
+
__metadata("design:type", Object)
|
|
151
|
+
], TransferProcessV0.prototype, "dataAddress", void 0);
|
|
152
|
+
TransferProcessV0 = __decorate([
|
|
153
|
+
entity({ version: 0 })
|
|
154
|
+
], TransferProcessV0);
|
|
155
|
+
export { TransferProcessV0 };
|
|
156
|
+
//# sourceMappingURL=transferProcessV0.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"transferProcessV0.js","sourceRoot":"","sources":["../../../src/entities/transferProcessV0.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAQnE;;;GAGG;AAEI,IAAM,iBAAiB,GAAvB,MAAM,iBAAiB;IAC7B;;;OAGG;IAEI,WAAW,CAAU;IAE5B;;OAEG;IAEI,EAAE,CAAU;IAEnB;;;OAGG;IAEI,WAAW,CAAU;IAE5B;;OAEG;IAEI,WAAW,CAAU;IAE5B;;;OAGG;IAEI,KAAK,CAA6C;IAEzD;;OAEG;IAEI,SAAS,CAAU;IAE1B;;OAEG;IAEI,OAAO,CAAU;IAExB;;OAEG;IAEI,gBAAgB,CAAU;IAEjC;;OAEG;IAEI,gBAAgB,CAAU;IAEjC;;;;OAIG;IAEI,SAAS,CAAuB;IAEvC;;OAEG;IAEI,MAAM,CAAU;IAEvB;;OAEG;IAEI,eAAe,CAAU;IAEhC;;OAEG;IAEI,oBAAoB,CAAU;IAErC;;OAEG;IAEI,WAAW,CAAU;IAE5B;;OAEG;IAEI,YAAY,CAAU;IAE7B;;OAEG;IAEI,QAAQ,CAA6B;IAE5C;;;OAGG;IAEI,WAAW,CAAiC;CACnD,CAAA;AAtGO;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;;sDAClB;AAMrB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;6CACV;AAOZ;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;;sDACpB;AAMrB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;sDACD;AAOrB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;gDAC4B;AAMlD;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;oDACH;AAMnB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;kDACL;AAMjB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;2DACZ;AAM1B;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;2DACZ;AAQ1B;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;oDACN;AAMhC;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;iDACtB;AAMhB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;0DACb;AAMzB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;+DACQ;AAM9B;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,aAAa,EAAE,aAAa,CAAC,UAAU,EAAE,CAAC;;sDAC/D;AAMrB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC;;uDACrB;AAMtB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;mDAChB;AAOrC;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;sDACV;AA3GvC,iBAAiB;IAD7B,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;GACV,iBAAiB,CA4G7B","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { entity, property, SortDirection } from \"@twin.org/entity\";\nimport type { IRightsManagementPolicy } from \"@twin.org/rights-management-models\";\nimport type {\n\tDataspaceProtocolTransferProcessStateType,\n\tIDataspaceProtocolDataAddress\n} from \"@twin.org/standards-dataspace-protocol\";\nimport type { TransferProcessRole } from \"../models/controlPlane/transferProcessRole.js\";\n\n/**\n * Transfer Process for shared storage between Control Plane and Data Plane, version 0.\n * Keyed on consumerPid; superseded by the version keyed on the internal id.\n */\n@entity({ version: 0 })\nexport class TransferProcessV0 {\n\t/**\n\t * The consumer PID is the primary key.\n\t * Used for direct lookup by consumerPid.\n\t */\n\t@property({ type: \"string\", isPrimary: true })\n\tpublic consumerPid!: string;\n\n\t/**\n\t * Internal UUID for storage (secondary key for providerPid lookup).\n\t */\n\t@property({ type: \"string\" })\n\tpublic id!: string;\n\n\t/**\n\t * Provider Process ID from the DSP protocol.\n\t * Indexed for lookup by providerPid.\n\t */\n\t@property({ type: \"string\", isSecondary: true })\n\tpublic providerPid!: string;\n\n\t/**\n\t * Agreement ID linking to the rights-management Agreement.\n\t */\n\t@property({ type: \"string\" })\n\tpublic agreementId!: string;\n\n\t/**\n\t * Transfer Process state from the DSP protocol.\n\t * One of: REQUESTED, STARTED, COMPLETED, SUSPENDED, TERMINATED.\n\t */\n\t@property({ type: \"string\" })\n\tpublic state!: DataspaceProtocolTransferProcessStateType;\n\n\t/**\n\t * Dataset ID for DSC resolution.\n\t */\n\t@property({ type: \"string\" })\n\tpublic datasetId!: string;\n\n\t/**\n\t * Offer ID from the original Catalog offer.\n\t */\n\t@property({ type: \"string\" })\n\tpublic offerId!: string;\n\n\t/**\n\t * Consumer identity (DID or URI).\n\t */\n\t@property({ type: \"string\", optional: true })\n\tpublic consumerIdentity?: string;\n\n\t/**\n\t * Provider identity (DID or URI).\n\t */\n\t@property({ type: \"string\", optional: true })\n\tpublic providerIdentity?: string;\n\n\t/**\n\t * This node's role in the transfer, captured at write time so state transitions and async delivery\n\t * can tell which party we are without inferring it from the matched PID (consumerPid is the primary\n\t * key on both nodes). Optional for back-compat with records written before this field existed.\n\t */\n\t@property({ type: \"string\", optional: true })\n\tpublic localRole?: TransferProcessRole;\n\n\t/**\n\t * Data format from the Dataset Distribution.\n\t */\n\t@property({ type: \"string\", optional: true })\n\tpublic format?: string;\n\n\t/**\n\t * Callback address for Consumer notifications.\n\t */\n\t@property({ type: \"string\", optional: true })\n\tpublic callbackAddress?: string;\n\n\t/**\n\t * The organization that owns this transfer process, captured from the request context at write time.\n\t */\n\t@property({ type: \"string\" })\n\tpublic organizationIdentity!: string;\n\n\t/**\n\t * Creation timestamp (ISO string format).\n\t */\n\t@property({ type: \"string\", format: \"date-time\", sortDirection: SortDirection.Descending })\n\tpublic dateCreated!: string;\n\n\t/**\n\t * Last update timestamp (ISO string format).\n\t */\n\t@property({ type: \"string\", format: \"date-time\" })\n\tpublic dateModified!: string;\n\n\t/**\n\t * Policies from the Agreement (stored as JSON).\n\t */\n\t@property({ type: \"array\", format: \"json\", optional: true })\n\tpublic policies?: IRightsManagementPolicy[];\n\n\t/**\n\t * Data address for the transfer (stored as JSON): the consumer's inbox for PUSH, or the\n\t * provider-built address persisted at start for PULL/POST; may expire while STARTED.\n\t */\n\t@property({ type: \"object\", format: \"json\", optional: true })\n\tpublic dataAddress?: IDataspaceProtocolDataAddress;\n}\n"]}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
// Copyright 2026 IOTA Stiftung.
|
|
2
|
+
// SPDX-License-Identifier: Apache-2.0.
|
|
3
|
+
import { entity, property } from "@twin.org/entity";
|
|
4
|
+
/**
|
|
5
|
+
* Records the consumer's first successful retrieval for a transfer.
|
|
6
|
+
* Written by the Data Plane, read by the Control Plane's one-shot policy sweep.
|
|
7
|
+
*/
|
|
8
|
+
let TransferRetrieval = class TransferRetrieval {
|
|
9
|
+
/**
|
|
10
|
+
* The consumer PID of the transfer, primary key.
|
|
11
|
+
*/
|
|
12
|
+
consumerPid;
|
|
13
|
+
/**
|
|
14
|
+
* When the first successful retrieval happened (ISO string format).
|
|
15
|
+
*/
|
|
16
|
+
dateFirstRetrieved;
|
|
17
|
+
/**
|
|
18
|
+
* When the most recent successful retrieval happened (ISO string format).
|
|
19
|
+
*/
|
|
20
|
+
dateLastRetrieved;
|
|
21
|
+
};
|
|
22
|
+
__decorate([
|
|
23
|
+
property({ type: "string", isPrimary: true }),
|
|
24
|
+
__metadata("design:type", String)
|
|
25
|
+
], TransferRetrieval.prototype, "consumerPid", void 0);
|
|
26
|
+
__decorate([
|
|
27
|
+
property({ type: "string", format: "date-time" }),
|
|
28
|
+
__metadata("design:type", String)
|
|
29
|
+
], TransferRetrieval.prototype, "dateFirstRetrieved", void 0);
|
|
30
|
+
__decorate([
|
|
31
|
+
property({ type: "string", format: "date-time" }),
|
|
32
|
+
__metadata("design:type", String)
|
|
33
|
+
], TransferRetrieval.prototype, "dateLastRetrieved", void 0);
|
|
34
|
+
TransferRetrieval = __decorate([
|
|
35
|
+
entity()
|
|
36
|
+
], TransferRetrieval);
|
|
37
|
+
export { TransferRetrieval };
|
|
38
|
+
//# sourceMappingURL=transferRetrieval.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"transferRetrieval.js","sourceRoot":"","sources":["../../../src/entities/transferRetrieval.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAEpD;;;GAGG;AAEI,IAAM,iBAAiB,GAAvB,MAAM,iBAAiB;IAC7B;;OAEG;IAEI,WAAW,CAAU;IAE5B;;OAEG;IAEI,kBAAkB,CAAU;IAEnC;;OAEG;IAEI,iBAAiB,CAAU;CAClC,CAAA;AAbO;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;;sDAClB;AAMrB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC;;6DACf;AAM5B;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC;;4DAChB;AAjBtB,iBAAiB;IAD7B,MAAM,EAAE;GACI,iBAAiB,CAkB7B","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { entity, property } from \"@twin.org/entity\";\n\n/**\n * Records the consumer's first successful retrieval for a transfer.\n * Written by the Data Plane, read by the Control Plane's one-shot policy sweep.\n */\n@entity()\nexport class TransferRetrieval {\n\t/**\n\t * The consumer PID of the transfer, primary key.\n\t */\n\t@property({ type: \"string\", isPrimary: true })\n\tpublic consumerPid!: string;\n\n\t/**\n\t * When the first successful retrieval happened (ISO string format).\n\t */\n\t@property({ type: \"string\", format: \"date-time\" })\n\tpublic dateFirstRetrieved!: string;\n\n\t/**\n\t * When the most recent successful retrieval happened (ISO string format).\n\t */\n\t@property({ type: \"string\", format: \"date-time\" })\n\tpublic dateLastRetrieved!: string;\n}\n"]}
|
package/dist/es/index.js
CHANGED
|
@@ -2,7 +2,10 @@
|
|
|
2
2
|
// SPDX-License-Identifier: Apache-2.0.
|
|
3
3
|
// Entity exports
|
|
4
4
|
export * from "./entities/dataspaceAppDataset.js";
|
|
5
|
+
export * from "./entities/dataspaceAppDatasetV0.js";
|
|
5
6
|
export * from "./entities/transferProcess.js";
|
|
7
|
+
export * from "./entities/transferProcessV0.js";
|
|
8
|
+
export * from "./entities/transferRetrieval.js";
|
|
6
9
|
// Control Plane exports
|
|
7
10
|
export * from "./models/controlPlane/api/ITransferContextResponse.js";
|
|
8
11
|
export * from "./models/controlPlane/dataspaceControlPlaneMetricIds.js";
|
|
@@ -14,7 +17,9 @@ export * from "./models/controlPlane/INegotiationCallback.js";
|
|
|
14
17
|
export * from "./models/controlPlane/ITransferCallback.js";
|
|
15
18
|
export * from "./models/controlPlane/ITransferContext.js";
|
|
16
19
|
export * from "./models/controlPlane/ITransferProcess.js";
|
|
20
|
+
export * from "./models/controlPlane/ITransferQueryResult.js";
|
|
17
21
|
export * from "./models/controlPlane/transferProcessRole.js";
|
|
22
|
+
export * from "./models/controlPlane/transferTerminationCode.js";
|
|
18
23
|
// Data Plane exports
|
|
19
24
|
export * from "./models/dataPlane/dataspaceDataPlaneMetricIds.js";
|
|
20
25
|
export * from "./models/dataPlane/dataspaceDataPlaneMetrics.js";
|
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,mCAAmC,CAAC;AAClD,cAAc,+BAA+B,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC,iBAAiB;AACjB,cAAc,mCAAmC,CAAC;AAClD,cAAc,qCAAqC,CAAC;AACpD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iCAAiC,CAAC;AAChD,cAAc,iCAAiC,CAAC;AAEhD,wBAAwB;AACxB,cAAc,uDAAuD,CAAC;AACtE,cAAc,yDAAyD,CAAC;AACxE,cAAc,uDAAuD,CAAC;AACtE,cAAc,+CAA+C,CAAC;AAC9D,cAAc,0DAA0D,CAAC;AACzE,cAAc,kEAAkE,CAAC;AACjF,cAAc,+CAA+C,CAAC;AAC9D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,+CAA+C,CAAC;AAC9D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,kDAAkD,CAAC;AAEjE,qBAAqB;AACrB,cAAc,mDAAmD,CAAC;AAClE,cAAc,iDAAiD,CAAC;AAChE,cAAc,oDAAoD,CAAC;AAEnE,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qCAAqC,CAAC;AACpD,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,iCAAiC,CAAC;AAChD,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,2DAA2D,CAAC;AAC1E,cAAc,uDAAuD,CAAC;AACtE,cAAc,wDAAwD,CAAC;AACvE,cAAc,uDAAuD,CAAC;AACtE,cAAc,oDAAoD,CAAC;AACnE,cAAc,qDAAqD,CAAC;AACpE,cAAc,qDAAqD,CAAC;AACpE,cAAc,sDAAsD,CAAC;AACrE,cAAc,uDAAuD,CAAC;AACtE,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;AAC5C,cAAc,kCAAkC,CAAC;AAEjD,kBAAkB;AAClB,cAAc,wBAAwB,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n// Entity exports\nexport * from \"./entities/dataspaceAppDataset.js\";\nexport * from \"./entities/dataspaceAppDatasetV0.js\";\nexport * from \"./entities/transferProcess.js\";\nexport * from \"./entities/transferProcessV0.js\";\nexport * from \"./entities/transferRetrieval.js\";\n\n// Control Plane exports\nexport * from \"./models/controlPlane/api/ITransferContextResponse.js\";\nexport * from \"./models/controlPlane/dataspaceControlPlaneMetricIds.js\";\nexport * from \"./models/controlPlane/dataspaceControlPlaneMetrics.js\";\nexport * from \"./models/controlPlane/IDataspaceAppDataset.js\";\nexport * from \"./models/controlPlane/IDataspaceControlPlaneComponent.js\";\nexport * from \"./models/controlPlane/IDataspaceControlPlaneResolverComponent.js\";\nexport * from \"./models/controlPlane/INegotiationCallback.js\";\nexport * from \"./models/controlPlane/ITransferCallback.js\";\nexport * from \"./models/controlPlane/ITransferContext.js\";\nexport * from \"./models/controlPlane/ITransferProcess.js\";\nexport * from \"./models/controlPlane/ITransferQueryResult.js\";\nexport * from \"./models/controlPlane/transferProcessRole.js\";\nexport * from \"./models/controlPlane/transferTerminationCode.js\";\n\n// Data Plane exports\nexport * from \"./models/dataPlane/dataspaceDataPlaneMetricIds.js\";\nexport * from \"./models/dataPlane/dataspaceDataPlaneMetrics.js\";\nexport * from \"./models/dataPlane/IDataspaceDataPlaneComponent.js\";\n\nexport * from \"./models/dataspaceContexts.js\";\nexport * from \"./models/dataspaceTransferFormat.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/IFollowActivity.js\";\nexport * from \"./models/app/IUndoActivity.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/IGetProtocolVersionsResponse.js\";\nexport * from \"./models/api/controlPlane/IAppDatasetCreateRequest.js\";\nexport * from \"./models/api/controlPlane/IAppDatasetCreateResponse.js\";\nexport * from \"./models/api/controlPlane/IAppDatasetDeleteRequest.js\";\nexport * from \"./models/api/controlPlane/IAppDatasetGetRequest.js\";\nexport * from \"./models/api/controlPlane/IAppDatasetGetResponse.js\";\nexport * from \"./models/api/controlPlane/IAppDatasetListRequest.js\";\nexport * from \"./models/api/controlPlane/IAppDatasetListResponse.js\";\nexport * from \"./models/api/controlPlane/IAppDatasetUpdateRequest.js\";\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\";\nexport * from \"./models/IPushDeliveryPayload.js\";\n\n// Utility exports\nexport * from \"./utils/jsonLdUtils.js\";\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IPushDeliveryPayload.js","sourceRoot":"","sources":["../../../src/models/IPushDeliveryPayload.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { IRightsManagementAgreement } from \"@twin.org/rights-management-models\";\n\n/**\n * Payload handed to pushDeliveryRunner via a Background Task.\n * Contains everything the runner needs to POST one Activity Streams\n * object to a consumer's /inbox without touching entity storage.\n */\nexport interface IPushDeliveryPayload {\n\t/**\n\t * The consumer process ID identifying the transfer.\n\t */\n\tconsumerPid: string;\n\n\t/**\n\t * The provider process ID identifying the transfer.\n\t */\n\tproviderPid: string;\n\n\t/**\n\t * PID to set as Activity.generator. Always equals providerPid since\n\t * processOutboxActivity is only invoked for consumer-initiated push,\n\t * where the provider is the data sender.\n\t */\n\tgeneratorPid: string;\n\n\t/**\n\t * The consumer's inbox endpoint URL to POST the activity to.\n\t */\n\tconsumerEndpoint: string;\n\n\t/**\n\t * Optional Bearer token for authenticating the push request.\n\t */\n\tconsumerAuthToken?: string;\n\n\t/**\n\t * The ODRL agreement governing the data transfer.\n\t */\n\tagreement: IRightsManagementAgreement;\n\n\t/**\n\t * The JSON-LD data payload to deliver to the consumer.\n\t */\n\tdata: IJsonLdNodeObject;\n\n\t/**\n\t * The JSON-LD @type of the data entity being delivered.\n\t */\n\tentityType: string;\n\n\t/**\n\t * The tenant that owns this push delivery, captured at schedule time from the active\n\t * `ContextIdStore` context (typically from the subscription's `tenantId` field).\n\t * The runner re-establishes this tenant context via `ContextIdStore.run` before invoking\n\t * tenant-scoped operations (PEP, trust signing, vault lookups). Optional
|
|
1
|
+
{"version":3,"file":"IPushDeliveryPayload.js","sourceRoot":"","sources":["../../../src/models/IPushDeliveryPayload.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { IRightsManagementAgreement } from \"@twin.org/rights-management-models\";\n\n/**\n * Payload handed to pushDeliveryRunner via a Background Task.\n * Contains everything the runner needs to POST one Activity Streams\n * object to a consumer's /inbox without touching entity storage.\n */\nexport interface IPushDeliveryPayload {\n\t/**\n\t * The consumer process ID identifying the transfer.\n\t */\n\tconsumerPid: string;\n\n\t/**\n\t * The provider process ID identifying the transfer.\n\t */\n\tproviderPid: string;\n\n\t/**\n\t * PID to set as Activity.generator. Always equals providerPid since\n\t * processOutboxActivity is only invoked for consumer-initiated push,\n\t * where the provider is the data sender.\n\t */\n\tgeneratorPid: string;\n\n\t/**\n\t * The consumer's inbox endpoint URL to POST the activity to.\n\t */\n\tconsumerEndpoint: string;\n\n\t/**\n\t * Optional Bearer token for authenticating the push request.\n\t */\n\tconsumerAuthToken?: string;\n\n\t/**\n\t * The ODRL agreement governing the data transfer.\n\t */\n\tagreement: IRightsManagementAgreement;\n\n\t/**\n\t * The JSON-LD data payload to deliver to the consumer.\n\t */\n\tdata: IJsonLdNodeObject;\n\n\t/**\n\t * The JSON-LD @type of the data entity being delivered.\n\t */\n\tentityType: string;\n\n\t/**\n\t * The tenant that owns this push delivery, captured at schedule time from the active\n\t * `ContextIdStore` context (typically from the subscription's `tenantId` field).\n\t * The runner re-establishes this tenant context via `ContextIdStore.run` before invoking\n\t * tenant-scoped operations (PEP, trust signing, vault lookups). Optional - single-tenant\n\t * nodes operate without a tenant context.\n\t */\n\ttenantId?: string;\n\n\t/**\n\t * Timeout (ms) for the push delivery HTTP POST. Packaged at schedule time from service config.\n\t * @default 30000\n\t */\n\tpushTimeoutMs?: number;\n\n\t/**\n\t * Max HTTP retry attempts for this delivery. Packaged at schedule time from service config.\n\t * @default 3\n\t */\n\tpushRetryCount?: number;\n\t/**\n\t * Base retry delay (ms) for this delivery. Packaged at schedule time from service config.\n\t * @default 1000\n\t */\n\tpushRetryBaseDelayMs?: number;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IAppDatasetCreateRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/controlPlane/IAppDatasetCreateRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDataspaceProtocolDataset } from \"@twin.org/standards-dataspace-protocol\";\n\n/**\n * API request to register an app dataset.\n *\n * The owning `tenantId` is captured automatically from the request's tenant\n * context
|
|
1
|
+
{"version":3,"file":"IAppDatasetCreateRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/controlPlane/IAppDatasetCreateRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDataspaceProtocolDataset } from \"@twin.org/standards-dataspace-protocol\";\n\n/**\n * API request to register an app dataset.\n *\n * The owning `tenantId` is captured automatically from the request's tenant\n * context - callers do not supply it.\n */\nexport interface IAppDatasetCreateRequest {\n\t/**\n\t * The body of the request.\n\t */\n\tbody: {\n\t\t/**\n\t\t * Optional explicit id for the stored dataset record. If omitted, the\n\t\t * Control Plane derives the id from `dataset[\"@id\"]` if present, or\n\t\t * generates a UUID otherwise. The resolved id is returned via the\n\t\t * `Location` response header.\n\t\t */\n\t\tid?: string;\n\n\t\t/**\n\t\t * The dataspace app this dataset belongs to. Matches the app's\n\t\t * registered name in `DataspaceAppFactory` (typically the app's URI).\n\t\t */\n\t\tappId: string;\n\n\t\t/**\n\t\t * The dataset payload. System-stamped fields like `dcterms:publisher`\n\t\t * may be omitted - the Control Plane fills them in at publish time.\n\t\t */\n\t\tdataset: IDataspaceProtocolDataset;\n\n\t\t/**\n\t\t * Optional idle window (ms) overriding the node-level idle policy for this\n\t\t * dataset's PULL transfers; 0 disables it for this dataset.\n\t\t */\n\t\ttransferIdleTimeoutMs?: number;\n\t};\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IAppDatasetUpdateRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/controlPlane/IAppDatasetUpdateRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDataspaceProtocolDataset } from \"@twin.org/standards-dataspace-protocol\";\n\n/**\n * API request to update an existing app dataset record.\n */\nexport interface IAppDatasetUpdateRequest {\n\t/**\n\t * Path parameters containing the stored app dataset id.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The stored app dataset id.\n\t\t */\n\t\tid: string;\n\t};\n\n\t/**\n\t * The body of the request.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The dataspace app this dataset belongs to. May change appId on\n\t\t * update if the tenant wants to retarget the dataset.\n\t\t */\n\t\tappId: string;\n\n\t\t/**\n\t\t * The dataset payload.\n\t\t */\n\t\tdataset: IDataspaceProtocolDataset;\n\t};\n}\n"]}
|
|
1
|
+
{"version":3,"file":"IAppDatasetUpdateRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/controlPlane/IAppDatasetUpdateRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDataspaceProtocolDataset } from \"@twin.org/standards-dataspace-protocol\";\n\n/**\n * API request to update an existing app dataset record.\n */\nexport interface IAppDatasetUpdateRequest {\n\t/**\n\t * Path parameters containing the stored app dataset id.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The stored app dataset id.\n\t\t */\n\t\tid: string;\n\t};\n\n\t/**\n\t * The body of the request.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The dataspace app this dataset belongs to. May change appId on\n\t\t * update if the tenant wants to retarget the dataset.\n\t\t */\n\t\tappId: string;\n\n\t\t/**\n\t\t * The dataset payload.\n\t\t */\n\t\tdataset: IDataspaceProtocolDataset;\n\n\t\t/**\n\t\t * Optional idle window (ms) overriding the node-level idle policy for this\n\t\t * dataset's PULL transfers; 0 disables it for this dataset.\n\t\t */\n\t\ttransferIdleTimeoutMs?: number;\n\t};\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IDataspaceAppDataset.js","sourceRoot":"","sources":["../../../../src/models/controlPlane/IDataspaceAppDataset.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDataspaceProtocolDataset } from \"@twin.org/standards-dataspace-protocol\";\n\n/**\n * Stored dataset record returned by the Control Plane's dataset CRUD surface.\n */\nexport interface IDataspaceAppDataset {\n\t/**\n\t * The stored dataset id (matches the dataset's JSON-LD `@id`).\n\t */\n\tid: string;\n\n\t/**\n\t * The dataspace app this dataset belongs to.\n\t */\n\tappId: string;\n\n\t/**\n\t * The dataset payload.\n\t */\n\tdataset: IDataspaceProtocolDataset;\n\n\t/**\n\t * Creation timestamp (ISO string).\n\t */\n\tdateCreated: string;\n\n\t/**\n\t * Last-modified timestamp (ISO string).\n\t */\n\tdateModified: string;\n}\n"]}
|
|
1
|
+
{"version":3,"file":"IDataspaceAppDataset.js","sourceRoot":"","sources":["../../../../src/models/controlPlane/IDataspaceAppDataset.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDataspaceProtocolDataset } from \"@twin.org/standards-dataspace-protocol\";\n\n/**\n * Stored dataset record returned by the Control Plane's dataset CRUD surface.\n */\nexport interface IDataspaceAppDataset {\n\t/**\n\t * The stored dataset id (matches the dataset's JSON-LD `@id`).\n\t */\n\tid: string;\n\n\t/**\n\t * The dataspace app this dataset belongs to.\n\t */\n\tappId: string;\n\n\t/**\n\t * The dataset payload.\n\t */\n\tdataset: IDataspaceProtocolDataset;\n\n\t/**\n\t * Idle window (ms) for this dataset's PULL transfers, overriding the node-level\n\t * providerTransferIdleTimeoutMs; 0 disables the idle policy for this dataset.\n\t */\n\ttransferIdleTimeoutMs?: number;\n\n\t/**\n\t * Creation timestamp (ISO string).\n\t */\n\tdateCreated: string;\n\n\t/**\n\t * Last-modified timestamp (ISO string).\n\t */\n\tdateModified: string;\n}\n"]}
|