@twin.org/dataspace-models 0.0.3-next.26 → 0.0.3-next.28
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 +76 -0
- package/dist/es/entities/dataspaceAppDataset.js.map +1 -0
- package/dist/es/index.js +11 -0
- package/dist/es/index.js.map +1 -1
- package/dist/es/models/api/controlPlane/IAppDatasetCreateRequest.js +2 -0
- package/dist/es/models/api/controlPlane/IAppDatasetCreateRequest.js.map +1 -0
- package/dist/es/models/api/controlPlane/IAppDatasetCreateResponse.js +2 -0
- package/dist/es/models/api/controlPlane/IAppDatasetCreateResponse.js.map +1 -0
- package/dist/es/models/api/controlPlane/IAppDatasetDeleteRequest.js +4 -0
- package/dist/es/models/api/controlPlane/IAppDatasetDeleteRequest.js.map +1 -0
- package/dist/es/models/api/controlPlane/IAppDatasetGetRequest.js +4 -0
- package/dist/es/models/api/controlPlane/IAppDatasetGetRequest.js.map +1 -0
- package/dist/es/models/api/controlPlane/IAppDatasetGetResponse.js +2 -0
- package/dist/es/models/api/controlPlane/IAppDatasetGetResponse.js.map +1 -0
- package/dist/es/models/api/controlPlane/IAppDatasetListRequest.js +4 -0
- package/dist/es/models/api/controlPlane/IAppDatasetListRequest.js.map +1 -0
- package/dist/es/models/api/controlPlane/IAppDatasetListResponse.js +2 -0
- package/dist/es/models/api/controlPlane/IAppDatasetListResponse.js.map +1 -0
- package/dist/es/models/api/controlPlane/IAppDatasetUpdateRequest.js +2 -0
- package/dist/es/models/api/controlPlane/IAppDatasetUpdateRequest.js.map +1 -0
- package/dist/es/models/app/IDataspaceApp.js.map +1 -1
- package/dist/es/models/controlPlane/IDataspaceAppDataset.js +2 -0
- package/dist/es/models/controlPlane/IDataspaceAppDataset.js.map +1 -0
- package/dist/es/models/controlPlane/IDataspaceControlPlaneComponent.js.map +1 -1
- package/dist/es/models/dataspaceTransferFormat.js +28 -0
- package/dist/es/models/dataspaceTransferFormat.js.map +1 -0
- package/dist/types/entities/dataspaceAppDataset.d.ts +42 -0
- package/dist/types/index.d.ts +11 -0
- package/dist/types/models/api/controlPlane/IAppDatasetCreateRequest.d.ts +31 -0
- package/dist/types/models/api/controlPlane/IAppDatasetCreateResponse.d.ts +16 -0
- package/dist/types/models/api/controlPlane/IAppDatasetDeleteRequest.d.ts +14 -0
- package/dist/types/models/api/controlPlane/IAppDatasetGetRequest.d.ts +14 -0
- package/dist/types/models/api/controlPlane/IAppDatasetGetResponse.d.ts +10 -0
- package/dist/types/models/api/controlPlane/IAppDatasetListRequest.d.ts +18 -0
- package/dist/types/models/api/controlPlane/IAppDatasetListResponse.d.ts +19 -0
- package/dist/types/models/api/controlPlane/IAppDatasetUpdateRequest.d.ts +29 -0
- package/dist/types/models/app/IDataspaceApp.d.ts +9 -3
- package/dist/types/models/controlPlane/IDataspaceAppDataset.d.ts +26 -0
- package/dist/types/models/controlPlane/IDataspaceControlPlaneComponent.d.ts +42 -1
- package/dist/types/models/dataspaceTransferFormat.d.ts +28 -0
- package/docs/changelog.md +88 -68
- package/docs/reference/classes/DataspaceAppDataset.md +80 -0
- package/docs/reference/index.md +12 -0
- package/docs/reference/interfaces/IAppDatasetCreateRequest.md +37 -0
- package/docs/reference/interfaces/IAppDatasetCreateResponse.md +23 -0
- package/docs/reference/interfaces/IAppDatasetDeleteRequest.md +17 -0
- package/docs/reference/interfaces/IAppDatasetGetRequest.md +17 -0
- package/docs/reference/interfaces/IAppDatasetGetResponse.md +11 -0
- package/docs/reference/interfaces/IAppDatasetListRequest.md +23 -0
- package/docs/reference/interfaces/IAppDatasetListResponse.md +23 -0
- package/docs/reference/interfaces/IAppDatasetUpdateRequest.md +38 -0
- package/docs/reference/interfaces/IDataspaceApp.md +22 -4
- package/docs/reference/interfaces/IDataspaceAppDataset.md +43 -0
- package/docs/reference/interfaces/IDataspaceControlPlaneComponent.md +142 -0
- package/docs/reference/type-aliases/DataspaceTransferFormat.md +5 -0
- package/docs/reference/variables/DataspaceTransferFormat.md +32 -0
- package/package.json +3 -3
|
@@ -22,10 +22,16 @@ export interface IDataspaceApp extends IComponent {
|
|
|
22
22
|
*/
|
|
23
23
|
activitiesHandled(): IActivityQuery[];
|
|
24
24
|
/**
|
|
25
|
-
*
|
|
26
|
-
*
|
|
25
|
+
* Optional override called by the Control Plane when publishing a stored dataset for this app.
|
|
26
|
+
* The Control Plane always calls `populateDefaults` (e.g. `dcterms:publisher`)
|
|
27
|
+
* on every dataset returned here, so apps don't need to populate publisher themselves.
|
|
28
|
+
* @param payload The user-stored dataset payload.
|
|
29
|
+
* @param tenantId The owning tenant for this dataset. Empty string on
|
|
30
|
+
* single-tenant nodes (no `TWIN_TENANT_ENABLED`).
|
|
31
|
+
* @returns One or more datasets to publish to the catalogue. System-stamped
|
|
32
|
+
* fields like `dcterms:publisher` may be omitted — the Control Plane fills them in.
|
|
27
33
|
*/
|
|
28
|
-
datasetsHandled(): Promise<IDataspaceProtocolDataset[]>;
|
|
34
|
+
datasetsHandled?(payload: IDataspaceProtocolDataset, tenantId: string): Promise<IDataspaceProtocolDataset[]>;
|
|
29
35
|
/**
|
|
30
36
|
* The types of queries supported.
|
|
31
37
|
* @returns The types of queries supported by the Dataspace App to retrieve data.
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import type { IDataspaceProtocolDataset } from "@twin.org/standards-dataspace-protocol";
|
|
2
|
+
/**
|
|
3
|
+
* Stored dataset record returned by the Control Plane's dataset CRUD surface.
|
|
4
|
+
*/
|
|
5
|
+
export interface IDataspaceAppDataset {
|
|
6
|
+
/**
|
|
7
|
+
* The stored dataset id (matches the dataset's JSON-LD `@id`).
|
|
8
|
+
*/
|
|
9
|
+
id: string;
|
|
10
|
+
/**
|
|
11
|
+
* The dataspace app this dataset belongs to.
|
|
12
|
+
*/
|
|
13
|
+
appId: string;
|
|
14
|
+
/**
|
|
15
|
+
* The dataset payload.
|
|
16
|
+
*/
|
|
17
|
+
dataset: IDataspaceProtocolDataset;
|
|
18
|
+
/**
|
|
19
|
+
* Creation timestamp (ISO string).
|
|
20
|
+
*/
|
|
21
|
+
dateCreated: string;
|
|
22
|
+
/**
|
|
23
|
+
* Last-modified timestamp (ISO string).
|
|
24
|
+
*/
|
|
25
|
+
dateModified: string;
|
|
26
|
+
}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type { IComponent } from "@twin.org/core";
|
|
2
|
-
import type { IDataspaceProtocolContractNegotiation, IDataspaceProtocolContractNegotiationError, IDataspaceProtocolTransferCompletionMessage, IDataspaceProtocolTransferError, IDataspaceProtocolTransferProcess, IDataspaceProtocolTransferRequestMessage, IDataspaceProtocolTransferStartMessage, IDataspaceProtocolTransferSuspensionMessage, IDataspaceProtocolTransferTerminationMessage } from "@twin.org/standards-dataspace-protocol";
|
|
2
|
+
import type { IDataspaceProtocolContractNegotiation, IDataspaceProtocolContractNegotiationError, IDataspaceProtocolDataset, IDataspaceProtocolTransferCompletionMessage, IDataspaceProtocolTransferError, IDataspaceProtocolTransferProcess, IDataspaceProtocolTransferRequestMessage, IDataspaceProtocolTransferStartMessage, IDataspaceProtocolTransferSuspensionMessage, IDataspaceProtocolTransferTerminationMessage } from "@twin.org/standards-dataspace-protocol";
|
|
3
|
+
import type { IDataspaceAppDataset } from "./IDataspaceAppDataset.js";
|
|
3
4
|
import type { INegotiationCallback } from "./INegotiationCallback.js";
|
|
4
5
|
/**
|
|
5
6
|
* Dataspace Control Plane Component interface.
|
|
@@ -177,4 +178,44 @@ export interface IDataspaceControlPlaneComponent extends IComponent {
|
|
|
177
178
|
* @returns Transfer Process (DSP compliant) with current state, or TransferError if the operation fails.
|
|
178
179
|
*/
|
|
179
180
|
getTransferProcess(pid: string, trustPayload: unknown): Promise<IDataspaceProtocolTransferProcess | IDataspaceProtocolTransferError>;
|
|
181
|
+
/**
|
|
182
|
+
* Register an app dataset for a dataspace app, owned by the calling tenant.
|
|
183
|
+
* @param id Optional explicit id. If omitted, derived from `dataset["@id"]`
|
|
184
|
+
* or generated.
|
|
185
|
+
* @param appId The dataspace app this dataset belongs to (matches
|
|
186
|
+
* `DataspaceAppFactory` registration name).
|
|
187
|
+
* @param dataset The dataset payload (may omit system-stamped fields).
|
|
188
|
+
* @returns The resolved dataset id.
|
|
189
|
+
*/
|
|
190
|
+
createAppDataset(id: string | undefined, appId: string, dataset: IDataspaceProtocolDataset): Promise<string>;
|
|
191
|
+
/**
|
|
192
|
+
* Get an app dataset record owned by the calling tenant.
|
|
193
|
+
* @param id The stored app dataset id.
|
|
194
|
+
* @returns The stored app dataset record.
|
|
195
|
+
*/
|
|
196
|
+
getAppDataset(id: string): Promise<IDataspaceAppDataset>;
|
|
197
|
+
/**
|
|
198
|
+
* List the app datasets owned by the calling tenant.
|
|
199
|
+
* @param cursor Optional pagination cursor.
|
|
200
|
+
* @param limit Optional maximum number of entries to return.
|
|
201
|
+
* @returns The stored app datasets and the next-page cursor if more exist.
|
|
202
|
+
*/
|
|
203
|
+
listAppDatasets(cursor?: string, limit?: number): Promise<{
|
|
204
|
+
entities: IDataspaceAppDataset[];
|
|
205
|
+
cursor?: string;
|
|
206
|
+
}>;
|
|
207
|
+
/**
|
|
208
|
+
* Update an app dataset record owned by the calling tenant.
|
|
209
|
+
* @param id The stored app dataset id.
|
|
210
|
+
* @param appId The dataspace app this dataset belongs to.
|
|
211
|
+
* @param dataset The dataset payload.
|
|
212
|
+
* @returns Nothing.
|
|
213
|
+
*/
|
|
214
|
+
updateAppDataset(id: string, appId: string, dataset: IDataspaceProtocolDataset): Promise<void>;
|
|
215
|
+
/**
|
|
216
|
+
* Delete an app dataset record owned by the calling tenant.
|
|
217
|
+
* @param id The stored app dataset id.
|
|
218
|
+
* @returns Nothing.
|
|
219
|
+
*/
|
|
220
|
+
deleteAppDataset(id: string): Promise<void>;
|
|
180
221
|
}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* TWIN transfer format identifiers used in TransferRequestMessage.format.
|
|
3
|
+
* Follows the Eclipse EDC canonical pattern: DestinationType-FlowType.
|
|
4
|
+
* See RFC-007 Data Transfer Profile.
|
|
5
|
+
*/
|
|
6
|
+
export declare const DataspaceTransferFormat: {
|
|
7
|
+
/**
|
|
8
|
+
* PULL mode: consumer queries data via a bearer-token-protected endpoint.
|
|
9
|
+
* Data flows: Consumer GET provider endpoint (with token).
|
|
10
|
+
*/
|
|
11
|
+
readonly HttpProxyPull: "HttpProxy-PULL";
|
|
12
|
+
/**
|
|
13
|
+
* Consumer-initiated PUSH mode: consumer supplies their /inbox endpoint in the
|
|
14
|
+
* TransferRequestMessage. Provider pushes ActivityStreams objects to that endpoint.
|
|
15
|
+
* Data flows: Provider POST to consumer's /inbox.
|
|
16
|
+
*/
|
|
17
|
+
readonly HttpProxyPush: "HttpProxy-PUSH";
|
|
18
|
+
/**
|
|
19
|
+
* Provider-initiated PUSH mode (inverted flow): consumer supplies no dataAddress.
|
|
20
|
+
* Provider returns its own /inbox URL + signed JWT. Consumer then posts data there.
|
|
21
|
+
* Data flows: Consumer POST to provider's /inbox.
|
|
22
|
+
*/
|
|
23
|
+
readonly HttpProxyPost: "HttpProxy-POST";
|
|
24
|
+
};
|
|
25
|
+
/**
|
|
26
|
+
* Type for the DataspaceTransferFormat const values.
|
|
27
|
+
*/
|
|
28
|
+
export type DataspaceTransferFormat = (typeof DataspaceTransferFormat)[keyof typeof DataspaceTransferFormat];
|
package/docs/changelog.md
CHANGED
|
@@ -1,245 +1,265 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
-
## [0.0.3-next.
|
|
3
|
+
## [0.0.3-next.28](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.0.3-next.27...dataspace-models-v0.0.3-next.28) (2026-05-12)
|
|
4
4
|
|
|
5
5
|
|
|
6
6
|
### Features
|
|
7
7
|
|
|
8
|
-
*
|
|
8
|
+
* typescript 6 update ([340f10e](https://github.com/iotaledger/twin-dataspace/commit/340f10e4767f6285c694938944f7e044474f9aaa))
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
|
|
11
|
+
### Bug Fixes
|
|
12
|
+
|
|
13
|
+
* docs ([652f4f2](https://github.com/iotaledger/twin-dataspace/commit/652f4f2fec8601bb3772e054b2c823f599ef68dc))
|
|
14
|
+
|
|
15
|
+
## [0.0.3-next.27](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.0.3-next.26...dataspace-models-v0.0.3-next.27) (2026-05-08)
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
### Features
|
|
19
|
+
|
|
20
|
+
* add dataspace transfer format ([#111](https://github.com/iotaledger/twin-dataspace/issues/111)) ([f59ff5e](https://github.com/iotaledger/twin-dataspace/commit/f59ff5ef10d261d1cebbf5c6bb0689e74a10738a))
|
|
21
|
+
* endpoint encryption + getDatasetTargets multi-target fix ([#112](https://github.com/iotaledger/twin-dataspace/issues/112)) ([3288941](https://github.com/iotaledger/twin-dataspace/commit/328894113c19c7402f7d00dfa77b6a97ae40ca91))
|
|
22
|
+
|
|
23
|
+
## [0.0.3-next.26](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.0.3-next.25...dataspace-models-v0.0.3-next.26) (2026-04-14)
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
### Features
|
|
27
|
+
|
|
28
|
+
* add inline tasks and concurrent options ([#104](https://github.com/iotaledger/twin-dataspace/issues/104)) ([2227a21](https://github.com/iotaledger/twin-dataspace/commit/2227a212d906f58ba77850c79bb20bf2cb7195a8))
|
|
29
|
+
|
|
30
|
+
## [0.0.3-next.25](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.0.3-next.24...dataspace-models-v0.0.3-next.25) (2026-04-10)
|
|
11
31
|
|
|
12
32
|
|
|
13
33
|
### Miscellaneous Chores
|
|
14
34
|
|
|
15
35
|
* **dataspace-models:** Synchronize repo versions
|
|
16
36
|
|
|
17
|
-
## [0.0.3-next.24](https://github.com/
|
|
37
|
+
## [0.0.3-next.24](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.0.3-next.23...dataspace-models-v0.0.3-next.24) (2026-03-31)
|
|
18
38
|
|
|
19
39
|
|
|
20
40
|
### Miscellaneous Chores
|
|
21
41
|
|
|
22
42
|
* **dataspace-models:** Synchronize repo versions
|
|
23
43
|
|
|
24
|
-
## [0.0.3-next.23](https://github.com/
|
|
44
|
+
## [0.0.3-next.23](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.0.3-next.22...dataspace-models-v0.0.3-next.23) (2026-03-25)
|
|
25
45
|
|
|
26
46
|
|
|
27
47
|
### Miscellaneous Chores
|
|
28
48
|
|
|
29
49
|
* **dataspace-models:** Synchronize repo versions
|
|
30
50
|
|
|
31
|
-
## [0.0.3-next.22](https://github.com/
|
|
51
|
+
## [0.0.3-next.22](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.0.3-next.21...dataspace-models-v0.0.3-next.22) (2026-03-20)
|
|
32
52
|
|
|
33
53
|
|
|
34
54
|
### Miscellaneous Chores
|
|
35
55
|
|
|
36
56
|
* **dataspace-models:** Synchronize repo versions
|
|
37
57
|
|
|
38
|
-
## [0.0.3-next.21](https://github.com/
|
|
58
|
+
## [0.0.3-next.21](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.0.3-next.20...dataspace-models-v0.0.3-next.21) (2026-03-17)
|
|
39
59
|
|
|
40
60
|
|
|
41
61
|
### Features
|
|
42
62
|
|
|
43
|
-
* improve open-api examples ([1368dbe](https://github.com/
|
|
63
|
+
* improve open-api examples ([1368dbe](https://github.com/iotaledger/twin-dataspace/commit/1368dbed5c36e074b4854942304a19b9ce51e088))
|
|
44
64
|
|
|
45
|
-
## [0.0.3-next.20](https://github.com/
|
|
65
|
+
## [0.0.3-next.20](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.0.3-next.19...dataspace-models-v0.0.3-next.20) (2026-03-17)
|
|
46
66
|
|
|
47
67
|
|
|
48
68
|
### Miscellaneous Chores
|
|
49
69
|
|
|
50
70
|
* **dataspace-models:** Synchronize repo versions
|
|
51
71
|
|
|
52
|
-
## [0.0.3-next.19](https://github.com/
|
|
72
|
+
## [0.0.3-next.19](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.0.3-next.18...dataspace-models-v0.0.3-next.19) (2026-03-12)
|
|
53
73
|
|
|
54
74
|
|
|
55
75
|
### Features
|
|
56
76
|
|
|
57
|
-
* improve validation ([#82](https://github.com/
|
|
77
|
+
* improve validation ([#82](https://github.com/iotaledger/twin-dataspace/issues/82)) ([8bfaf7b](https://github.com/iotaledger/twin-dataspace/commit/8bfaf7b830f89b63575f8a51ee96bd8ac4da02f4))
|
|
58
78
|
|
|
59
|
-
## [0.0.3-next.18](https://github.com/
|
|
79
|
+
## [0.0.3-next.18](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.0.3-next.17...dataspace-models-v0.0.3-next.18) (2026-03-09)
|
|
60
80
|
|
|
61
81
|
|
|
62
82
|
### Features
|
|
63
83
|
|
|
64
|
-
* resolve DSP transfer flow bugs for cross-node communication ([#76](https://github.com/
|
|
84
|
+
* resolve DSP transfer flow bugs for cross-node communication ([#76](https://github.com/iotaledger/twin-dataspace/issues/76)) ([506a45c](https://github.com/iotaledger/twin-dataspace/commit/506a45c94e63d5f958b1fc7131adfe452c3e2974))
|
|
65
85
|
|
|
66
|
-
## [0.0.3-next.17](https://github.com/
|
|
86
|
+
## [0.0.3-next.17](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.0.3-next.16...dataspace-models-v0.0.3-next.17) (2026-03-06)
|
|
67
87
|
|
|
68
88
|
|
|
69
89
|
### Features
|
|
70
90
|
|
|
71
|
-
* docs update ([8b44c7a](https://github.com/
|
|
72
|
-
* types update ([77c338e](https://github.com/
|
|
91
|
+
* docs update ([8b44c7a](https://github.com/iotaledger/twin-dataspace/commit/8b44c7a75afb8d377a6f606616f8a78d58439ab4))
|
|
92
|
+
* types update ([77c338e](https://github.com/iotaledger/twin-dataspace/commit/77c338e9244dcc7e3d597fdb06229513b1f13eac))
|
|
73
93
|
|
|
74
94
|
|
|
75
95
|
### Bug Fixes
|
|
76
96
|
|
|
77
|
-
* avoid compaction of incoming activities ([#77](https://github.com/
|
|
97
|
+
* avoid compaction of incoming activities ([#77](https://github.com/iotaledger/twin-dataspace/issues/77)) ([ff43d6a](https://github.com/iotaledger/twin-dataspace/commit/ff43d6a3e1563eb9cb185501134b2a53ae88787c))
|
|
78
98
|
|
|
79
|
-
## [0.0.3-next.16](https://github.com/
|
|
99
|
+
## [0.0.3-next.16](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.0.3-next.15...dataspace-models-v0.0.3-next.16) (2026-03-02)
|
|
80
100
|
|
|
81
101
|
|
|
82
102
|
### Miscellaneous Chores
|
|
83
103
|
|
|
84
104
|
* **dataspace-models:** Synchronize repo versions
|
|
85
105
|
|
|
86
|
-
## [0.0.3-next.15](https://github.com/
|
|
106
|
+
## [0.0.3-next.15](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.0.3-next.14...dataspace-models-v0.0.3-next.15) (2026-03-02)
|
|
87
107
|
|
|
88
108
|
|
|
89
109
|
### Features
|
|
90
110
|
|
|
91
|
-
* unification of the data exchange and the data space connector ([#57](https://github.com/
|
|
111
|
+
* unification of the data exchange and the data space connector ([#57](https://github.com/iotaledger/twin-dataspace/issues/57)) ([df2644d](https://github.com/iotaledger/twin-dataspace/commit/df2644d989471e07dadd83d27bef736179e31bf4))
|
|
92
112
|
|
|
93
|
-
## [0.0.3-next.12](https://github.com/
|
|
113
|
+
## [0.0.3-next.12](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.0.3-next.11...dataspace-models-v0.0.3-next.12) (2026-01-22)
|
|
94
114
|
|
|
95
115
|
|
|
96
116
|
### Features
|
|
97
117
|
|
|
98
|
-
* allow retry of failed activities instead of treating as duplicates ([#53](https://github.com/
|
|
118
|
+
* allow retry of failed activities instead of treating as duplicates ([#53](https://github.com/iotaledger/twin-dataspace/issues/53)) ([363dddc](https://github.com/iotaledger/twin-dataspace/commit/363dddc0ba14a50cf1d6f233d17f19c6110fbd47))
|
|
99
119
|
|
|
100
|
-
## [0.0.3-next.11](https://github.com/
|
|
120
|
+
## [0.0.3-next.11](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.0.3-next.10...dataspace-models-v0.0.3-next.11) (2026-01-22)
|
|
101
121
|
|
|
102
122
|
|
|
103
123
|
### Miscellaneous Chores
|
|
104
124
|
|
|
105
125
|
* **dataspace-models:** Synchronize repo versions
|
|
106
126
|
|
|
107
|
-
## [0.0.3-next.10](https://github.com/
|
|
127
|
+
## [0.0.3-next.10](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.0.3-next.9...dataspace-models-v0.0.3-next.10) (2026-01-19)
|
|
108
128
|
|
|
109
129
|
|
|
110
130
|
### Features
|
|
111
131
|
|
|
112
|
-
* replace registerApp with factory pattern ([#51](https://github.com/
|
|
132
|
+
* replace registerApp with factory pattern ([#51](https://github.com/iotaledger/twin-dataspace/issues/51)) ([a7ef328](https://github.com/iotaledger/twin-dataspace/commit/a7ef32873f5781f7b1f8aa3670f5fb612dd17018))
|
|
113
133
|
|
|
114
|
-
## [0.0.3-next.9](https://github.com/
|
|
134
|
+
## [0.0.3-next.9](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.0.3-next.8...dataspace-models-v0.0.3-next.9) (2026-01-19)
|
|
115
135
|
|
|
116
136
|
|
|
117
137
|
### Features
|
|
118
138
|
|
|
119
|
-
* update data space connector to use trust service ([#47](https://github.com/
|
|
120
|
-
* update order of trustPayload parameter ([0656ddd](https://github.com/
|
|
139
|
+
* update data space connector to use trust service ([#47](https://github.com/iotaledger/twin-dataspace/issues/47)) ([41c5113](https://github.com/iotaledger/twin-dataspace/commit/41c5113512cdc477c2f9508b27dfaff84529d841))
|
|
140
|
+
* update order of trustPayload parameter ([0656ddd](https://github.com/iotaledger/twin-dataspace/commit/0656ddd328accda0370d979a6cb5f947071e700b))
|
|
121
141
|
|
|
122
|
-
## [0.0.3-next.8](https://github.com/
|
|
142
|
+
## [0.0.3-next.8](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.0.3-next.7...dataspace-models-v0.0.3-next.8) (2026-01-16)
|
|
123
143
|
|
|
124
144
|
|
|
125
145
|
### Miscellaneous Chores
|
|
126
146
|
|
|
127
147
|
* **dataspace-models:** Synchronize repo versions
|
|
128
148
|
|
|
129
|
-
## [0.0.3-next.7](https://github.com/
|
|
149
|
+
## [0.0.3-next.7](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.0.3-next.6...dataspace-models-v0.0.3-next.7) (2026-01-16)
|
|
130
150
|
|
|
131
151
|
|
|
132
152
|
### Features
|
|
133
153
|
|
|
134
|
-
* implement Link headers for pagination ([#43](https://github.com/
|
|
154
|
+
* implement Link headers for pagination ([#43](https://github.com/iotaledger/twin-dataspace/issues/43)) ([ce2a31f](https://github.com/iotaledger/twin-dataspace/commit/ce2a31fab1b5a1338d34b8514e96a203705c68d1))
|
|
135
155
|
|
|
136
|
-
## [0.0.3-next.6](https://github.com/
|
|
156
|
+
## [0.0.3-next.6](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.0.3-next.5...dataspace-models-v0.0.3-next.6) (2026-01-15)
|
|
137
157
|
|
|
138
158
|
|
|
139
159
|
### Features
|
|
140
160
|
|
|
141
|
-
* update contexts and namespaces ([#41](https://github.com/
|
|
161
|
+
* update contexts and namespaces ([#41](https://github.com/iotaledger/twin-dataspace/issues/41)) ([cad79f9](https://github.com/iotaledger/twin-dataspace/commit/cad79f9f18c0b1bc4a4604a951c28db1d1068f5e))
|
|
142
162
|
|
|
143
|
-
## [0.0.3-next.5](https://github.com/
|
|
163
|
+
## [0.0.3-next.5](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.0.3-next.4...dataspace-models-v0.0.3-next.5) (2026-01-07)
|
|
144
164
|
|
|
145
165
|
|
|
146
166
|
### Miscellaneous Chores
|
|
147
167
|
|
|
148
168
|
* **dataspace-models:** Synchronize repo versions
|
|
149
169
|
|
|
150
|
-
## [0.0.3-next.4](https://github.com/
|
|
170
|
+
## [0.0.3-next.4](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.0.3-next.3...dataspace-models-v0.0.3-next.4) (2026-01-06)
|
|
151
171
|
|
|
152
172
|
|
|
153
173
|
### Features
|
|
154
174
|
|
|
155
|
-
* rfc 004 implementation ([#34](https://github.com/
|
|
156
|
-
* update standards dependencies ([8534ad7](https://github.com/
|
|
175
|
+
* rfc 004 implementation ([#34](https://github.com/iotaledger/twin-dataspace/issues/34)) ([3920a45](https://github.com/iotaledger/twin-dataspace/commit/3920a456f744610885c33cb0960e0448aea71a44))
|
|
176
|
+
* update standards dependencies ([8534ad7](https://github.com/iotaledger/twin-dataspace/commit/8534ad74b996610ed5994b5213c857989c2bf57a))
|
|
157
177
|
|
|
158
|
-
## [0.0.3-next.3](https://github.com/
|
|
178
|
+
## [0.0.3-next.3](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.0.3-next.2...dataspace-models-v0.0.3-next.3) (2025-12-01)
|
|
159
179
|
|
|
160
180
|
|
|
161
181
|
### Features
|
|
162
182
|
|
|
163
|
-
* update background task service ([c907578](https://github.com/
|
|
183
|
+
* update background task service ([c907578](https://github.com/iotaledger/twin-dataspace/commit/c907578c4ff5906c62b37d788a078d99fe8a59dc))
|
|
164
184
|
|
|
165
|
-
## [0.0.3-next.2](https://github.com/
|
|
185
|
+
## [0.0.3-next.2](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.0.3-next.1...dataspace-models-v0.0.3-next.2) (2025-11-28)
|
|
166
186
|
|
|
167
187
|
|
|
168
188
|
### Miscellaneous Chores
|
|
169
189
|
|
|
170
190
|
* **dataspace-models:** Synchronize repo versions
|
|
171
191
|
|
|
172
|
-
## [0.0.3-next.1](https://github.com/
|
|
192
|
+
## [0.0.3-next.1](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.0.3-next.0...dataspace-models-v0.0.3-next.1) (2025-11-12)
|
|
173
193
|
|
|
174
194
|
|
|
175
195
|
### Features
|
|
176
196
|
|
|
177
|
-
* add context id features ([#26](https://github.com/
|
|
178
|
-
* add rest and socket clients ([950bf70](https://github.com/
|
|
179
|
-
* add validate-locales ([c0b08a7](https://github.com/
|
|
180
|
-
* dataspace ([#2](https://github.com/
|
|
181
|
-
* eslint migration to flat config ([b84e875](https://github.com/
|
|
182
|
-
* first bootstrap ([2a5bab8](https://github.com/
|
|
183
|
-
* query interface data space connector ([#18](https://github.com/
|
|
184
|
-
* update framework components ([4d9ca95](https://github.com/
|
|
185
|
-
* use new engine extensions config ([80bdb5b](https://github.com/
|
|
197
|
+
* add context id features ([#26](https://github.com/iotaledger/twin-dataspace/issues/26)) ([6429a16](https://github.com/iotaledger/twin-dataspace/commit/6429a160dac9499304fdfb93a9dbdce37277ca7d))
|
|
198
|
+
* add rest and socket clients ([950bf70](https://github.com/iotaledger/twin-dataspace/commit/950bf705e6df4e709bbbe58e93968510067b9ddc))
|
|
199
|
+
* add validate-locales ([c0b08a7](https://github.com/iotaledger/twin-dataspace/commit/c0b08a73268f9fd3eb6ac3079b49d1ab0c01f118))
|
|
200
|
+
* dataspace ([#2](https://github.com/iotaledger/twin-dataspace/issues/2)) ([c2ac651](https://github.com/iotaledger/twin-dataspace/commit/c2ac651ceb6f35e46bd5eac97ac648bb1ee9dc0c))
|
|
201
|
+
* eslint migration to flat config ([b84e875](https://github.com/iotaledger/twin-dataspace/commit/b84e87530aa249891618096ab6e072b21ff9f63a))
|
|
202
|
+
* first bootstrap ([2a5bab8](https://github.com/iotaledger/twin-dataspace/commit/2a5bab8bc1e2313f0de4d201e842a9fe7c7bab49))
|
|
203
|
+
* query interface data space connector ([#18](https://github.com/iotaledger/twin-dataspace/issues/18)) ([b12eca1](https://github.com/iotaledger/twin-dataspace/commit/b12eca124a8f46d290c168e364b7ed4bf72001d8))
|
|
204
|
+
* update framework components ([4d9ca95](https://github.com/iotaledger/twin-dataspace/commit/4d9ca95879bd6cae9d031595292b6a872bf5b5fd))
|
|
205
|
+
* use new engine extensions config ([80bdb5b](https://github.com/iotaledger/twin-dataspace/commit/80bdb5b298b65b5b22fa9927a0ad031cb9a3534d))
|
|
186
206
|
|
|
187
|
-
## [0.0.1-next.8](https://github.com/
|
|
207
|
+
## [0.0.1-next.8](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.0.1-next.7...dataspace-models-v0.0.1-next.8) (2025-10-09)
|
|
188
208
|
|
|
189
209
|
|
|
190
210
|
### Features
|
|
191
211
|
|
|
192
|
-
* add validate-locales ([c0b08a7](https://github.com/
|
|
212
|
+
* add validate-locales ([c0b08a7](https://github.com/iotaledger/twin-dataspace/commit/c0b08a73268f9fd3eb6ac3079b49d1ab0c01f118))
|
|
193
213
|
|
|
194
|
-
## [0.0.1-next.7](https://github.com/
|
|
214
|
+
## [0.0.1-next.7](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.0.1-next.6...dataspace-models-v0.0.1-next.7) (2025-10-02)
|
|
195
215
|
|
|
196
216
|
|
|
197
217
|
### Features
|
|
198
218
|
|
|
199
|
-
* use new engine extensions config ([80bdb5b](https://github.com/
|
|
219
|
+
* use new engine extensions config ([80bdb5b](https://github.com/iotaledger/twin-dataspace/commit/80bdb5b298b65b5b22fa9927a0ad031cb9a3534d))
|
|
200
220
|
|
|
201
|
-
## [0.0.1-next.6](https://github.com/
|
|
221
|
+
## [0.0.1-next.6](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.0.1-next.5...dataspace-models-v0.0.1-next.6) (2025-09-29)
|
|
202
222
|
|
|
203
223
|
|
|
204
224
|
### Miscellaneous Chores
|
|
205
225
|
|
|
206
226
|
* **dataspace-models:** Synchronize repo versions
|
|
207
227
|
|
|
208
|
-
## [0.0.1-next.5](https://github.com/
|
|
228
|
+
## [0.0.1-next.5](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.0.1-next.4...dataspace-models-v0.0.1-next.5) (2025-09-29)
|
|
209
229
|
|
|
210
230
|
|
|
211
231
|
### Features
|
|
212
232
|
|
|
213
|
-
* update framework components ([4d9ca95](https://github.com/
|
|
233
|
+
* update framework components ([4d9ca95](https://github.com/iotaledger/twin-dataspace/commit/4d9ca95879bd6cae9d031595292b6a872bf5b5fd))
|
|
214
234
|
|
|
215
|
-
## [0.0.1-next.4](https://github.com/
|
|
235
|
+
## [0.0.1-next.4](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.0.1-next.3...dataspace-models-v0.0.1-next.4) (2025-08-29)
|
|
216
236
|
|
|
217
237
|
|
|
218
238
|
### Features
|
|
219
239
|
|
|
220
|
-
* eslint migration to flat config ([b84e875](https://github.com/
|
|
240
|
+
* eslint migration to flat config ([b84e875](https://github.com/iotaledger/twin-dataspace/commit/b84e87530aa249891618096ab6e072b21ff9f63a))
|
|
221
241
|
|
|
222
|
-
## [0.0.1-next.3](https://github.com/
|
|
242
|
+
## [0.0.1-next.3](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.0.1-next.2...dataspace-models-v0.0.1-next.3) (2025-08-25)
|
|
223
243
|
|
|
224
244
|
|
|
225
245
|
### Miscellaneous Chores
|
|
226
246
|
|
|
227
247
|
* **dataspace-models:** Synchronize repo versions
|
|
228
248
|
|
|
229
|
-
## [0.0.1-next.2](https://github.com/
|
|
249
|
+
## [0.0.1-next.2](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.0.1-next.1...dataspace-models-v0.0.1-next.2) (2025-08-25)
|
|
230
250
|
|
|
231
251
|
|
|
232
252
|
### Features
|
|
233
253
|
|
|
234
|
-
* add rest and socket clients ([950bf70](https://github.com/
|
|
235
|
-
* dataspace ([#2](https://github.com/
|
|
236
|
-
* first bootstrap ([2a5bab8](https://github.com/
|
|
254
|
+
* add rest and socket clients ([950bf70](https://github.com/iotaledger/twin-dataspace/commit/950bf705e6df4e709bbbe58e93968510067b9ddc))
|
|
255
|
+
* dataspace ([#2](https://github.com/iotaledger/twin-dataspace/issues/2)) ([c2ac651](https://github.com/iotaledger/twin-dataspace/commit/c2ac651ceb6f35e46bd5eac97ac648bb1ee9dc0c))
|
|
256
|
+
* first bootstrap ([2a5bab8](https://github.com/iotaledger/twin-dataspace/commit/2a5bab8bc1e2313f0de4d201e842a9fe7c7bab49))
|
|
237
257
|
|
|
238
|
-
## [0.0.1-next.1](https://github.com/
|
|
258
|
+
## [0.0.1-next.1](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.0.1-next.0...dataspace-models-v0.0.1-next.1) (2025-08-25)
|
|
239
259
|
|
|
240
260
|
|
|
241
261
|
### Features
|
|
242
262
|
|
|
243
|
-
* add rest and socket clients ([950bf70](https://github.com/
|
|
244
|
-
* dataspace ([#2](https://github.com/
|
|
245
|
-
* first bootstrap ([2a5bab8](https://github.com/
|
|
263
|
+
* add rest and socket clients ([950bf70](https://github.com/iotaledger/twin-dataspace/commit/950bf705e6df4e709bbbe58e93968510067b9ddc))
|
|
264
|
+
* dataspace ([#2](https://github.com/iotaledger/twin-dataspace/issues/2)) ([c2ac651](https://github.com/iotaledger/twin-dataspace/commit/c2ac651ceb6f35e46bd5eac97ac648bb1ee9dc0c))
|
|
265
|
+
* first bootstrap ([2a5bab8](https://github.com/iotaledger/twin-dataspace/commit/2a5bab8bc1e2313f0de4d201e842a9fe7c7bab49))
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
# Class: DataspaceAppDataset
|
|
2
|
+
|
|
3
|
+
Tenant-supplied Dataset shape persisted by the Control Plane.
|
|
4
|
+
|
|
5
|
+
## Constructors
|
|
6
|
+
|
|
7
|
+
### Constructor
|
|
8
|
+
|
|
9
|
+
> **new DataspaceAppDataset**(): `DataspaceAppDataset`
|
|
10
|
+
|
|
11
|
+
#### Returns
|
|
12
|
+
|
|
13
|
+
`DataspaceAppDataset`
|
|
14
|
+
|
|
15
|
+
## Properties
|
|
16
|
+
|
|
17
|
+
### id {#id}
|
|
18
|
+
|
|
19
|
+
> **id**: `string`
|
|
20
|
+
|
|
21
|
+
The unique identifier for the dataset.
|
|
22
|
+
|
|
23
|
+
***
|
|
24
|
+
|
|
25
|
+
### nodeIdentity {#nodeidentity}
|
|
26
|
+
|
|
27
|
+
> **nodeIdentity**: `string`
|
|
28
|
+
|
|
29
|
+
The identity of the node that owns this entity (required for sync).
|
|
30
|
+
|
|
31
|
+
***
|
|
32
|
+
|
|
33
|
+
### tenantId? {#tenantid}
|
|
34
|
+
|
|
35
|
+
> `optional` **tenantId?**: `string`
|
|
36
|
+
|
|
37
|
+
The tenant that owns this dataset, captured from the request context at
|
|
38
|
+
write time. Optional — single-tenant nodes (no `TWIN_TENANT_ENABLED`)
|
|
39
|
+
register datasets without a tenant context, in which case federated catalogue stores
|
|
40
|
+
the dataset with no `tenantId` and URL-baking is skipped.
|
|
41
|
+
|
|
42
|
+
***
|
|
43
|
+
|
|
44
|
+
### appId {#appid}
|
|
45
|
+
|
|
46
|
+
> **appId**: `string`
|
|
47
|
+
|
|
48
|
+
The dataspace app that this dataset belongs to. Matches the app's
|
|
49
|
+
registered name in `DataspaceAppFactory` (typically the app's URI).
|
|
50
|
+
Used as the join key when dispatching to an app's optional
|
|
51
|
+
`datasetsHandled` override.
|
|
52
|
+
|
|
53
|
+
***
|
|
54
|
+
|
|
55
|
+
### dataset {#dataset}
|
|
56
|
+
|
|
57
|
+
> **dataset**: `object`
|
|
58
|
+
|
|
59
|
+
The user-controlled JSON-LD dataset payload. Stored as an
|
|
60
|
+
opaque object and validated/populated at publish time.
|
|
61
|
+
|
|
62
|
+
#### Index Signature
|
|
63
|
+
|
|
64
|
+
\[`key`: `string`\]: `unknown`
|
|
65
|
+
|
|
66
|
+
***
|
|
67
|
+
|
|
68
|
+
### dateCreated {#datecreated}
|
|
69
|
+
|
|
70
|
+
> **dateCreated**: `string`
|
|
71
|
+
|
|
72
|
+
Creation timestamp (ISO string format).
|
|
73
|
+
|
|
74
|
+
***
|
|
75
|
+
|
|
76
|
+
### dateModified {#datemodified}
|
|
77
|
+
|
|
78
|
+
> **dateModified**: `string`
|
|
79
|
+
|
|
80
|
+
Last update timestamp (ISO string format).
|
package/docs/reference/index.md
CHANGED
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
## Classes
|
|
4
4
|
|
|
5
5
|
- [DataspaceDataTypes](classes/DataspaceDataTypes.md)
|
|
6
|
+
- [DataspaceAppDataset](classes/DataspaceAppDataset.md)
|
|
6
7
|
- [TransferProcess](classes/TransferProcess.md)
|
|
7
8
|
|
|
8
9
|
## Interfaces
|
|
@@ -27,6 +28,14 @@
|
|
|
27
28
|
- [IDataAssetEntitiesResponse](interfaces/IDataAssetEntitiesResponse.md)
|
|
28
29
|
- [IDataAssetGetEntitiesRequest](interfaces/IDataAssetGetEntitiesRequest.md)
|
|
29
30
|
- [IDataAssetQueryRequest](interfaces/IDataAssetQueryRequest.md)
|
|
31
|
+
- [IAppDatasetCreateRequest](interfaces/IAppDatasetCreateRequest.md)
|
|
32
|
+
- [IAppDatasetCreateResponse](interfaces/IAppDatasetCreateResponse.md)
|
|
33
|
+
- [IAppDatasetDeleteRequest](interfaces/IAppDatasetDeleteRequest.md)
|
|
34
|
+
- [IAppDatasetGetRequest](interfaces/IAppDatasetGetRequest.md)
|
|
35
|
+
- [IAppDatasetGetResponse](interfaces/IAppDatasetGetResponse.md)
|
|
36
|
+
- [IAppDatasetListRequest](interfaces/IAppDatasetListRequest.md)
|
|
37
|
+
- [IAppDatasetListResponse](interfaces/IAppDatasetListResponse.md)
|
|
38
|
+
- [IAppDatasetUpdateRequest](interfaces/IAppDatasetUpdateRequest.md)
|
|
30
39
|
- [ICompleteTransferRequest](interfaces/ICompleteTransferRequest.md)
|
|
31
40
|
- [ICompleteTransferResponse](interfaces/ICompleteTransferResponse.md)
|
|
32
41
|
- [IGetTransferProcessRequest](interfaces/IGetTransferProcessRequest.md)
|
|
@@ -45,6 +54,7 @@
|
|
|
45
54
|
- [IDataspaceApp](interfaces/IDataspaceApp.md)
|
|
46
55
|
- [IProcessingGroupOptions](interfaces/IProcessingGroupOptions.md)
|
|
47
56
|
- [IQueryDataAssetRequest](interfaces/IQueryDataAssetRequest.md)
|
|
57
|
+
- [IDataspaceAppDataset](interfaces/IDataspaceAppDataset.md)
|
|
48
58
|
- [IDataspaceControlPlaneComponent](interfaces/IDataspaceControlPlaneComponent.md)
|
|
49
59
|
- [IDataspaceControlPlaneResolverComponent](interfaces/IDataspaceControlPlaneResolverComponent.md)
|
|
50
60
|
- [INegotiationCallback](interfaces/INegotiationCallback.md)
|
|
@@ -61,6 +71,7 @@
|
|
|
61
71
|
- [DataRequestType](type-aliases/DataRequestType.md)
|
|
62
72
|
- [TransferProcessRole](type-aliases/TransferProcessRole.md)
|
|
63
73
|
- [DataspaceContexts](type-aliases/DataspaceContexts.md)
|
|
74
|
+
- [DataspaceTransferFormat](type-aliases/DataspaceTransferFormat.md)
|
|
64
75
|
- [DataspaceTypes](type-aliases/DataspaceTypes.md)
|
|
65
76
|
|
|
66
77
|
## Variables
|
|
@@ -71,4 +82,5 @@
|
|
|
71
82
|
- [DataRequestType](variables/DataRequestType.md)
|
|
72
83
|
- [TransferProcessRole](variables/TransferProcessRole.md)
|
|
73
84
|
- [DataspaceContexts](variables/DataspaceContexts.md)
|
|
85
|
+
- [DataspaceTransferFormat](variables/DataspaceTransferFormat.md)
|
|
74
86
|
- [DataspaceTypes](variables/DataspaceTypes.md)
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# Interface: IAppDatasetCreateRequest
|
|
2
|
+
|
|
3
|
+
API request to register an app dataset.
|
|
4
|
+
|
|
5
|
+
The owning `tenantId` is captured automatically from the request's tenant
|
|
6
|
+
context — callers do not supply it.
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
10
|
+
### body {#body}
|
|
11
|
+
|
|
12
|
+
> **body**: `object`
|
|
13
|
+
|
|
14
|
+
The body of the request.
|
|
15
|
+
|
|
16
|
+
#### id?
|
|
17
|
+
|
|
18
|
+
> `optional` **id?**: `string`
|
|
19
|
+
|
|
20
|
+
Optional explicit id for the stored dataset record. If omitted, the
|
|
21
|
+
Control Plane derives the id from `dataset["@id"]` if present, or
|
|
22
|
+
generates a UUID otherwise. The resolved id is returned via the
|
|
23
|
+
`Location` response header.
|
|
24
|
+
|
|
25
|
+
#### appId
|
|
26
|
+
|
|
27
|
+
> **appId**: `string`
|
|
28
|
+
|
|
29
|
+
The dataspace app this dataset belongs to. Matches the app's
|
|
30
|
+
registered name in `DataspaceAppFactory` (typically the app's URI).
|
|
31
|
+
|
|
32
|
+
#### dataset
|
|
33
|
+
|
|
34
|
+
> **dataset**: `IDataspaceProtocolDataset`
|
|
35
|
+
|
|
36
|
+
The dataset payload. System-stamped fields like `dcterms:publisher`
|
|
37
|
+
may be omitted — the Control Plane fills them in at publish time.
|