@twin.org/standards-dataspace-protocol 0.0.3-next.27 → 0.0.3-next.29
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/models/transferProcess/types/dataspaceProtocolEndpointType.js +54 -61
- package/dist/es/models/transferProcess/types/dataspaceProtocolEndpointType.js.map +1 -1
- package/dist/types/models/transferProcess/types/dataspaceProtocolEndpointType.d.ts +56 -57
- package/docs/changelog.md +34 -0
- package/docs/reference/type-aliases/DataspaceProtocolEndpointType.md +7 -0
- package/docs/reference/variables/DataspaceProtocolEndpointType.md +53 -73
- package/package.json +3 -3
|
@@ -1,96 +1,89 @@
|
|
|
1
1
|
// Copyright 2025 IOTA Stiftung.
|
|
2
2
|
// SPDX-License-Identifier: Apache-2.0.
|
|
3
3
|
/**
|
|
4
|
-
*
|
|
4
|
+
* TWIN Data Space Protocol Profile endpoint type identifiers.
|
|
5
5
|
*
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
*
|
|
6
|
+
* This module defines endpoint types according to the TWIN Foundation's
|
|
7
|
+
* Data Space Protocol Profile (RFC 006), which extends the Eclipse Dataspace
|
|
8
|
+
* Protocol specification with TWIN-specific vocabulary.
|
|
9
9
|
*
|
|
10
|
-
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
* - Semantic (provide meaning through linked data)
|
|
10
|
+
* The TWIN vocabulary uses persistent identifiers under the
|
|
11
|
+
* https://schema.twindev.org namespace to provide stable, semantic
|
|
12
|
+
* identifiers for data space endpoint types.
|
|
14
13
|
*
|
|
15
14
|
* References:
|
|
16
|
-
* -
|
|
17
|
-
* -
|
|
18
|
-
* - DSP Specification: https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/
|
|
15
|
+
* - TWIN RFC 006: https://github.com/twinfoundation/rfcs/blob/main/rfcs/data-space-protocol/006-data-space-protocol-profile.md
|
|
16
|
+
* - TWIN DS Protocol Context: https://github.com/twinfoundation/rfcs/blob/main/rfcs/data-space-protocol/twin-ds-protocol-profile.jsonld
|
|
17
|
+
* - Eclipse DSP Specification: https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/
|
|
18
|
+
* - RFC 001 (Query Interface): https://github.com/twinfoundation/rfcs/blob/main/rfcs/data-space-connector/001-data-space-connector-query.md
|
|
19
19
|
*/
|
|
20
20
|
// eslint-disable-next-line @typescript-eslint/naming-convention
|
|
21
21
|
export const DataspaceProtocolEndpointType = {
|
|
22
22
|
// ========================================
|
|
23
|
-
//
|
|
23
|
+
// TWIN Data Space Protocol Profile (RFC 006)
|
|
24
|
+
// Namespace: https://schema.twindev.org/dspace/v1/
|
|
24
25
|
// ========================================
|
|
25
26
|
/**
|
|
26
|
-
*
|
|
27
|
+
* HTTPS Query Endpoint (TWIN DS Profile).
|
|
27
28
|
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
* @see https://w3id.org/idsa/v4.1/HTTP
|
|
32
|
-
* @see https://github.com/International-Data-Spaces-Association/InformationModel
|
|
33
|
-
*/
|
|
34
|
-
HTTP: "https://w3id.org/idsa/v4.1/HTTP",
|
|
35
|
-
/**
|
|
36
|
-
* HTTPS endpoint (IDSA W3ID v4.1).
|
|
29
|
+
* Used for PULL transfers via the TWIN Data Space Connector Query interface.
|
|
30
|
+
* The consumer retrieves data by querying this endpoint using the data access token.
|
|
31
|
+
* Endpoint must implement the interface specified in RFC 001.
|
|
37
32
|
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
33
|
+
* Transfer Flow:
|
|
34
|
+
* 1. Consumer initiates transfer request
|
|
35
|
+
* 2. Provider returns this endpoint type with data access token
|
|
36
|
+
* 3. Consumer queries the endpoint with the token to retrieve data
|
|
40
37
|
*
|
|
41
|
-
* @see https://
|
|
42
|
-
* @see https://github.com/
|
|
38
|
+
* @see https://github.com/twinfoundation/rfcs/blob/main/rfcs/data-space-protocol/006-data-space-protocol-profile.md#data-transfer-profile-vocabulary
|
|
39
|
+
* @see https://github.com/twinfoundation/rfcs/blob/main/rfcs/data-space-connector/001-data-space-connector-query.md
|
|
43
40
|
*/
|
|
44
|
-
|
|
45
|
-
// ========================================
|
|
46
|
-
// Non-W3ID Endpoint Types (De facto standards)
|
|
47
|
-
// ========================================
|
|
41
|
+
HttpsQueryEndpoint: "https://schema.twindev.org/dspace/v1/Https-Query-Endpoint",
|
|
48
42
|
/**
|
|
49
|
-
* HTTPS Activity Stream
|
|
43
|
+
* HTTPS Activity Stream Endpoint (TWIN DS Profile).
|
|
50
44
|
*
|
|
51
|
-
* Used for
|
|
52
|
-
*
|
|
53
|
-
*
|
|
45
|
+
* Used for PUSH transfers via Activity Streams 2.0 protocol.
|
|
46
|
+
* The provider actively sends data to the consumer's Activity Stream inbox endpoint.
|
|
47
|
+
* Based on W3C Activity Streams 2.0 specification.
|
|
54
48
|
*
|
|
49
|
+
* Transfer Flow:
|
|
50
|
+
* 1. Consumer initiates transfer request with this endpoint type
|
|
51
|
+
* 2. Consumer provides their Activity Stream inbox URL
|
|
52
|
+
* 3. Provider pushes data to the consumer's inbox as Activity Stream objects
|
|
53
|
+
*
|
|
54
|
+
* @see https://github.com/twinfoundation/rfcs/blob/main/rfcs/data-space-protocol/006-data-space-protocol-profile.md#data-transfer-profile-vocabulary
|
|
55
55
|
* @see https://www.w3.org/TR/activitystreams-core/
|
|
56
56
|
* @see https://www.w3.org/TR/activitypub/
|
|
57
57
|
*/
|
|
58
|
-
|
|
58
|
+
HttpsActivityStreamEndpoint: "https://schema.twindev.org/dspace/v1/Https-Activity-Stream-Endpoint",
|
|
59
|
+
// ========================================
|
|
60
|
+
// IDSA W3ID Namespace (Interoperability)
|
|
61
|
+
// ========================================
|
|
59
62
|
/**
|
|
60
|
-
*
|
|
61
|
-
*
|
|
62
|
-
* Used for S3-based data transfer (both PULL and PUSH).
|
|
63
|
-
* Note: Not currently part of IDSA W3ID namespace.
|
|
63
|
+
* HTTP endpoint (IDSA W3ID v4.1).
|
|
64
64
|
*
|
|
65
|
-
*
|
|
66
|
-
|
|
67
|
-
S3: "S3",
|
|
68
|
-
/**
|
|
69
|
-
* Azure Blob Storage endpoint.
|
|
65
|
+
* Persistent identifier for HTTP-based data access endpoints.
|
|
66
|
+
* This W3ID URL is used as a semantic identifier in JSON-LD contexts.
|
|
70
67
|
*
|
|
71
|
-
*
|
|
72
|
-
*
|
|
68
|
+
* Note: For TWIN-specific implementations, prefer using `HttpsQueryEndpoint`.
|
|
69
|
+
* This constant is provided for interoperability with IDSA-based systems.
|
|
73
70
|
*
|
|
74
|
-
* @see https://
|
|
71
|
+
* @see https://w3id.org/idsa/v4.1/HTTP
|
|
72
|
+
* @see https://github.com/International-Data-Spaces-Association/InformationModel
|
|
75
73
|
*/
|
|
76
|
-
|
|
74
|
+
HTTP: "https://w3id.org/idsa/v4.1/HTTP",
|
|
77
75
|
/**
|
|
78
|
-
*
|
|
79
|
-
*
|
|
80
|
-
* Used for streaming data via Kafka message broker.
|
|
81
|
-
* Note: Not currently part of IDSA W3ID namespace.
|
|
76
|
+
* HTTPS endpoint (IDSA W3ID v4.1).
|
|
82
77
|
*
|
|
83
|
-
*
|
|
84
|
-
|
|
85
|
-
Kafka: "Kafka",
|
|
86
|
-
/**
|
|
87
|
-
* SFTP (SSH File Transfer Protocol) endpoint.
|
|
78
|
+
* Persistent identifier for HTTPS-based secure data access endpoints.
|
|
79
|
+
* This W3ID URL is used as a semantic identifier in JSON-LD contexts.
|
|
88
80
|
*
|
|
89
|
-
*
|
|
90
|
-
*
|
|
81
|
+
* Note: For TWIN-specific implementations, prefer using `HttpsQueryEndpoint`.
|
|
82
|
+
* This constant is provided for interoperability with IDSA-based systems.
|
|
91
83
|
*
|
|
92
|
-
* @see https://
|
|
84
|
+
* @see https://w3id.org/idsa/v4.1/HTTPS
|
|
85
|
+
* @see https://github.com/International-Data-Spaces-Association/InformationModel
|
|
93
86
|
*/
|
|
94
|
-
|
|
87
|
+
HTTPS: "https://w3id.org/idsa/v4.1/HTTPS"
|
|
95
88
|
};
|
|
96
89
|
//# sourceMappingURL=dataspaceProtocolEndpointType.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"dataspaceProtocolEndpointType.js","sourceRoot":"","sources":["../../../../../src/models/transferProcess/types/dataspaceProtocolEndpointType.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;;;;;;;;;;;;;;;GAgBG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,6BAA6B,GAAG;IAC5C,2CAA2C;IAC3C,
|
|
1
|
+
{"version":3,"file":"dataspaceProtocolEndpointType.js","sourceRoot":"","sources":["../../../../../src/models/transferProcess/types/dataspaceProtocolEndpointType.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;;;;;;;;;;;;;;;GAgBG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,6BAA6B,GAAG;IAC5C,2CAA2C;IAC3C,6CAA6C;IAC7C,mDAAmD;IACnD,2CAA2C;IAE3C;;;;;;;;;;;;;;OAcG;IACH,kBAAkB,EAAE,2DAA2D;IAE/E;;;;;;;;;;;;;;;OAeG;IACH,2BAA2B,EAC1B,qEAAqE;IAEtE,2CAA2C;IAC3C,yCAAyC;IACzC,2CAA2C;IAE3C;;;;;;;;;;;OAWG;IACH,IAAI,EAAE,iCAAiC;IAEvC;;;;;;;;;;;OAWG;IACH,KAAK,EAAE,kCAAkC;CAChC,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * TWIN Data Space Protocol Profile endpoint type identifiers.\n *\n * This module defines endpoint types according to the TWIN Foundation's\n * Data Space Protocol Profile (RFC 006), which extends the Eclipse Dataspace\n * Protocol specification with TWIN-specific vocabulary.\n *\n * The TWIN vocabulary uses persistent identifiers under the\n * https://schema.twindev.org namespace to provide stable, semantic\n * identifiers for data space endpoint types.\n *\n * References:\n * - TWIN RFC 006: https://github.com/twinfoundation/rfcs/blob/main/rfcs/data-space-protocol/006-data-space-protocol-profile.md\n * - TWIN DS Protocol Context: https://github.com/twinfoundation/rfcs/blob/main/rfcs/data-space-protocol/twin-ds-protocol-profile.jsonld\n * - Eclipse DSP Specification: https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/\n * - RFC 001 (Query Interface): https://github.com/twinfoundation/rfcs/blob/main/rfcs/data-space-connector/001-data-space-connector-query.md\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const DataspaceProtocolEndpointType = {\n\t// ========================================\n\t// TWIN Data Space Protocol Profile (RFC 006)\n\t// Namespace: https://schema.twindev.org/dspace/v1/\n\t// ========================================\n\n\t/**\n\t * HTTPS Query Endpoint (TWIN DS Profile).\n\t *\n\t * Used for PULL transfers via the TWIN Data Space Connector Query interface.\n\t * The consumer retrieves data by querying this endpoint using the data access token.\n\t * Endpoint must implement the interface specified in RFC 001.\n\t *\n\t * Transfer Flow:\n\t * 1. Consumer initiates transfer request\n\t * 2. Provider returns this endpoint type with data access token\n\t * 3. Consumer queries the endpoint with the token to retrieve data\n\t *\n\t * @see https://github.com/twinfoundation/rfcs/blob/main/rfcs/data-space-protocol/006-data-space-protocol-profile.md#data-transfer-profile-vocabulary\n\t * @see https://github.com/twinfoundation/rfcs/blob/main/rfcs/data-space-connector/001-data-space-connector-query.md\n\t */\n\tHttpsQueryEndpoint: \"https://schema.twindev.org/dspace/v1/Https-Query-Endpoint\",\n\n\t/**\n\t * HTTPS Activity Stream Endpoint (TWIN DS Profile).\n\t *\n\t * Used for PUSH transfers via Activity Streams 2.0 protocol.\n\t * The provider actively sends data to the consumer's Activity Stream inbox endpoint.\n\t * Based on W3C Activity Streams 2.0 specification.\n\t *\n\t * Transfer Flow:\n\t * 1. Consumer initiates transfer request with this endpoint type\n\t * 2. Consumer provides their Activity Stream inbox URL\n\t * 3. Provider pushes data to the consumer's inbox as Activity Stream objects\n\t *\n\t * @see https://github.com/twinfoundation/rfcs/blob/main/rfcs/data-space-protocol/006-data-space-protocol-profile.md#data-transfer-profile-vocabulary\n\t * @see https://www.w3.org/TR/activitystreams-core/\n\t * @see https://www.w3.org/TR/activitypub/\n\t */\n\tHttpsActivityStreamEndpoint:\n\t\t\"https://schema.twindev.org/dspace/v1/Https-Activity-Stream-Endpoint\",\n\n\t// ========================================\n\t// IDSA W3ID Namespace (Interoperability)\n\t// ========================================\n\n\t/**\n\t * HTTP endpoint (IDSA W3ID v4.1).\n\t *\n\t * Persistent identifier for HTTP-based data access endpoints.\n\t * This W3ID URL is used as a semantic identifier in JSON-LD contexts.\n\t *\n\t * Note: For TWIN-specific implementations, prefer using `HttpsQueryEndpoint`.\n\t * This constant is provided for interoperability with IDSA-based systems.\n\t *\n\t * @see https://w3id.org/idsa/v4.1/HTTP\n\t * @see https://github.com/International-Data-Spaces-Association/InformationModel\n\t */\n\tHTTP: \"https://w3id.org/idsa/v4.1/HTTP\",\n\n\t/**\n\t * HTTPS endpoint (IDSA W3ID v4.1).\n\t *\n\t * Persistent identifier for HTTPS-based secure data access endpoints.\n\t * This W3ID URL is used as a semantic identifier in JSON-LD contexts.\n\t *\n\t * Note: For TWIN-specific implementations, prefer using `HttpsQueryEndpoint`.\n\t * This constant is provided for interoperability with IDSA-based systems.\n\t *\n\t * @see https://w3id.org/idsa/v4.1/HTTPS\n\t * @see https://github.com/International-Data-Spaces-Association/InformationModel\n\t */\n\tHTTPS: \"https://w3id.org/idsa/v4.1/HTTPS\"\n} as const;\n\n/**\n * Type representing all valid Dataspace Protocol endpoint types.\n *\n * All values are valid URIs as required by the DS Protocol JSON-LD context\n * which defines endpointType as @type:@vocab.\n *\n * Includes:\n * - TWIN RFC 006 types: HttpsQueryEndpoint, HttpsActivityStreamEndpoint\n * - IDSA W3ID types: HTTP, HTTPS\n */\nexport type DataspaceProtocolEndpointType =\n\t(typeof DataspaceProtocolEndpointType)[keyof typeof DataspaceProtocolEndpointType];\n"]}
|
|
@@ -1,90 +1,89 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
2
|
+
* TWIN Data Space Protocol Profile endpoint type identifiers.
|
|
3
3
|
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
*
|
|
4
|
+
* This module defines endpoint types according to the TWIN Foundation's
|
|
5
|
+
* Data Space Protocol Profile (RFC 006), which extends the Eclipse Dataspace
|
|
6
|
+
* Protocol specification with TWIN-specific vocabulary.
|
|
7
7
|
*
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
*
|
|
11
|
-
* - Semantic (provide meaning through linked data)
|
|
8
|
+
* The TWIN vocabulary uses persistent identifiers under the
|
|
9
|
+
* https://schema.twindev.org namespace to provide stable, semantic
|
|
10
|
+
* identifiers for data space endpoint types.
|
|
12
11
|
*
|
|
13
12
|
* References:
|
|
14
|
-
* -
|
|
15
|
-
* -
|
|
16
|
-
* - DSP Specification: https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/
|
|
13
|
+
* - TWIN RFC 006: https://github.com/twinfoundation/rfcs/blob/main/rfcs/data-space-protocol/006-data-space-protocol-profile.md
|
|
14
|
+
* - TWIN DS Protocol Context: https://github.com/twinfoundation/rfcs/blob/main/rfcs/data-space-protocol/twin-ds-protocol-profile.jsonld
|
|
15
|
+
* - Eclipse DSP Specification: https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/
|
|
16
|
+
* - RFC 001 (Query Interface): https://github.com/twinfoundation/rfcs/blob/main/rfcs/data-space-connector/001-data-space-connector-query.md
|
|
17
17
|
*/
|
|
18
18
|
export declare const DataspaceProtocolEndpointType: {
|
|
19
19
|
/**
|
|
20
|
-
*
|
|
20
|
+
* HTTPS Query Endpoint (TWIN DS Profile).
|
|
21
21
|
*
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
* @see https://w3id.org/idsa/v4.1/HTTP
|
|
26
|
-
* @see https://github.com/International-Data-Spaces-Association/InformationModel
|
|
27
|
-
*/
|
|
28
|
-
readonly HTTP: "https://w3id.org/idsa/v4.1/HTTP";
|
|
29
|
-
/**
|
|
30
|
-
* HTTPS endpoint (IDSA W3ID v4.1).
|
|
22
|
+
* Used for PULL transfers via the TWIN Data Space Connector Query interface.
|
|
23
|
+
* The consumer retrieves data by querying this endpoint using the data access token.
|
|
24
|
+
* Endpoint must implement the interface specified in RFC 001.
|
|
31
25
|
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
26
|
+
* Transfer Flow:
|
|
27
|
+
* 1. Consumer initiates transfer request
|
|
28
|
+
* 2. Provider returns this endpoint type with data access token
|
|
29
|
+
* 3. Consumer queries the endpoint with the token to retrieve data
|
|
34
30
|
*
|
|
35
|
-
* @see https://
|
|
36
|
-
* @see https://github.com/
|
|
31
|
+
* @see https://github.com/twinfoundation/rfcs/blob/main/rfcs/data-space-protocol/006-data-space-protocol-profile.md#data-transfer-profile-vocabulary
|
|
32
|
+
* @see https://github.com/twinfoundation/rfcs/blob/main/rfcs/data-space-connector/001-data-space-connector-query.md
|
|
37
33
|
*/
|
|
38
|
-
readonly
|
|
34
|
+
readonly HttpsQueryEndpoint: "https://schema.twindev.org/dspace/v1/Https-Query-Endpoint";
|
|
39
35
|
/**
|
|
40
|
-
* HTTPS Activity Stream
|
|
36
|
+
* HTTPS Activity Stream Endpoint (TWIN DS Profile).
|
|
37
|
+
*
|
|
38
|
+
* Used for PUSH transfers via Activity Streams 2.0 protocol.
|
|
39
|
+
* The provider actively sends data to the consumer's Activity Stream inbox endpoint.
|
|
40
|
+
* Based on W3C Activity Streams 2.0 specification.
|
|
41
41
|
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
42
|
+
* Transfer Flow:
|
|
43
|
+
* 1. Consumer initiates transfer request with this endpoint type
|
|
44
|
+
* 2. Consumer provides their Activity Stream inbox URL
|
|
45
|
+
* 3. Provider pushes data to the consumer's inbox as Activity Stream objects
|
|
45
46
|
*
|
|
47
|
+
* @see https://github.com/twinfoundation/rfcs/blob/main/rfcs/data-space-protocol/006-data-space-protocol-profile.md#data-transfer-profile-vocabulary
|
|
46
48
|
* @see https://www.w3.org/TR/activitystreams-core/
|
|
47
49
|
* @see https://www.w3.org/TR/activitypub/
|
|
48
50
|
*/
|
|
49
|
-
readonly
|
|
51
|
+
readonly HttpsActivityStreamEndpoint: "https://schema.twindev.org/dspace/v1/Https-Activity-Stream-Endpoint";
|
|
50
52
|
/**
|
|
51
|
-
*
|
|
52
|
-
*
|
|
53
|
-
* Used for S3-based data transfer (both PULL and PUSH).
|
|
54
|
-
* Note: Not currently part of IDSA W3ID namespace.
|
|
53
|
+
* HTTP endpoint (IDSA W3ID v4.1).
|
|
55
54
|
*
|
|
56
|
-
*
|
|
57
|
-
|
|
58
|
-
readonly S3: "S3";
|
|
59
|
-
/**
|
|
60
|
-
* Azure Blob Storage endpoint.
|
|
55
|
+
* Persistent identifier for HTTP-based data access endpoints.
|
|
56
|
+
* This W3ID URL is used as a semantic identifier in JSON-LD contexts.
|
|
61
57
|
*
|
|
62
|
-
*
|
|
63
|
-
*
|
|
58
|
+
* Note: For TWIN-specific implementations, prefer using `HttpsQueryEndpoint`.
|
|
59
|
+
* This constant is provided for interoperability with IDSA-based systems.
|
|
64
60
|
*
|
|
65
|
-
* @see https://
|
|
61
|
+
* @see https://w3id.org/idsa/v4.1/HTTP
|
|
62
|
+
* @see https://github.com/International-Data-Spaces-Association/InformationModel
|
|
66
63
|
*/
|
|
67
|
-
readonly
|
|
64
|
+
readonly HTTP: "https://w3id.org/idsa/v4.1/HTTP";
|
|
68
65
|
/**
|
|
69
|
-
*
|
|
70
|
-
*
|
|
71
|
-
* Used for streaming data via Kafka message broker.
|
|
72
|
-
* Note: Not currently part of IDSA W3ID namespace.
|
|
66
|
+
* HTTPS endpoint (IDSA W3ID v4.1).
|
|
73
67
|
*
|
|
74
|
-
*
|
|
75
|
-
|
|
76
|
-
readonly Kafka: "Kafka";
|
|
77
|
-
/**
|
|
78
|
-
* SFTP (SSH File Transfer Protocol) endpoint.
|
|
68
|
+
* Persistent identifier for HTTPS-based secure data access endpoints.
|
|
69
|
+
* This W3ID URL is used as a semantic identifier in JSON-LD contexts.
|
|
79
70
|
*
|
|
80
|
-
*
|
|
81
|
-
*
|
|
71
|
+
* Note: For TWIN-specific implementations, prefer using `HttpsQueryEndpoint`.
|
|
72
|
+
* This constant is provided for interoperability with IDSA-based systems.
|
|
82
73
|
*
|
|
83
|
-
* @see https://
|
|
74
|
+
* @see https://w3id.org/idsa/v4.1/HTTPS
|
|
75
|
+
* @see https://github.com/International-Data-Spaces-Association/InformationModel
|
|
84
76
|
*/
|
|
85
|
-
readonly
|
|
77
|
+
readonly HTTPS: "https://w3id.org/idsa/v4.1/HTTPS";
|
|
86
78
|
};
|
|
87
79
|
/**
|
|
88
80
|
* Type representing all valid Dataspace Protocol endpoint types.
|
|
81
|
+
*
|
|
82
|
+
* All values are valid URIs as required by the DS Protocol JSON-LD context
|
|
83
|
+
* which defines endpointType as @type:@vocab.
|
|
84
|
+
*
|
|
85
|
+
* Includes:
|
|
86
|
+
* - TWIN RFC 006 types: HttpsQueryEndpoint, HttpsActivityStreamEndpoint
|
|
87
|
+
* - IDSA W3ID types: HTTP, HTTPS
|
|
89
88
|
*/
|
|
90
89
|
export type DataspaceProtocolEndpointType = (typeof DataspaceProtocolEndpointType)[keyof typeof DataspaceProtocolEndpointType];
|
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,39 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.0.3-next.29](https://github.com/twinfoundation/standards/compare/standards-dataspace-protocol-v0.0.3-next.28...standards-dataspace-protocol-v0.0.3-next.29) (2026-02-03)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* adding twin protocol endpoins constants ([#133](https://github.com/twinfoundation/standards/issues/133)) ([3592c81](https://github.com/twinfoundation/standards/commit/3592c811c368b23046ef8b60f6cca0eb8356ad87))
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Dependencies
|
|
12
|
+
|
|
13
|
+
* The following workspace dependencies were updated
|
|
14
|
+
* dependencies
|
|
15
|
+
* @twin.org/standards-w3c-dcat bumped from 0.0.3-next.28 to 0.0.3-next.29
|
|
16
|
+
* @twin.org/standards-w3c-odrl bumped from 0.0.3-next.28 to 0.0.3-next.29
|
|
17
|
+
* devDependencies
|
|
18
|
+
* @twin.org/standards-ld-contexts bumped from 0.0.3-next.28 to 0.0.3-next.29
|
|
19
|
+
|
|
20
|
+
## [0.0.3-next.28](https://github.com/twinfoundation/standards/compare/standards-dataspace-protocol-v0.0.3-next.27...standards-dataspace-protocol-v0.0.3-next.28) (2026-02-03)
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
### Miscellaneous Chores
|
|
24
|
+
|
|
25
|
+
* **standards-dataspace-protocol:** Synchronize repo versions
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
### Dependencies
|
|
29
|
+
|
|
30
|
+
* The following workspace dependencies were updated
|
|
31
|
+
* dependencies
|
|
32
|
+
* @twin.org/standards-w3c-dcat bumped from 0.0.3-next.27 to 0.0.3-next.28
|
|
33
|
+
* @twin.org/standards-w3c-odrl bumped from 0.0.3-next.27 to 0.0.3-next.28
|
|
34
|
+
* devDependencies
|
|
35
|
+
* @twin.org/standards-ld-contexts bumped from 0.0.3-next.27 to 0.0.3-next.28
|
|
36
|
+
|
|
3
37
|
## [0.0.3-next.27](https://github.com/twinfoundation/standards/compare/standards-dataspace-protocol-v0.0.3-next.26...standards-dataspace-protocol-v0.0.3-next.27) (2026-02-03)
|
|
4
38
|
|
|
5
39
|
|
|
@@ -3,3 +3,10 @@
|
|
|
3
3
|
> **DataspaceProtocolEndpointType** = *typeof* [`DataspaceProtocolEndpointType`](../variables/DataspaceProtocolEndpointType.md)\[keyof *typeof* [`DataspaceProtocolEndpointType`](../variables/DataspaceProtocolEndpointType.md)\]
|
|
4
4
|
|
|
5
5
|
Type representing all valid Dataspace Protocol endpoint types.
|
|
6
|
+
|
|
7
|
+
All values are valid URIs as required by the DS Protocol JSON-LD context
|
|
8
|
+
which defines endpointType as @type:@vocab.
|
|
9
|
+
|
|
10
|
+
Includes:
|
|
11
|
+
- TWIN RFC 006 types: HttpsQueryEndpoint, HttpsActivityStreamEndpoint
|
|
12
|
+
- IDSA W3ID types: HTTP, HTTPS
|
|
@@ -2,115 +2,95 @@
|
|
|
2
2
|
|
|
3
3
|
> `const` **DataspaceProtocolEndpointType**: `object`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
TWIN Data Space Protocol Profile endpoint type identifiers.
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
7
|
+
This module defines endpoint types according to the TWIN Foundation's
|
|
8
|
+
Data Space Protocol Profile (RFC 006), which extends the Eclipse Dataspace
|
|
9
|
+
Protocol specification with TWIN-specific vocabulary.
|
|
10
10
|
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
- Semantic (provide meaning through linked data)
|
|
11
|
+
The TWIN vocabulary uses persistent identifiers under the
|
|
12
|
+
https://schema.twindev.org namespace to provide stable, semantic
|
|
13
|
+
identifiers for data space endpoint types.
|
|
15
14
|
|
|
16
15
|
References:
|
|
17
|
-
-
|
|
18
|
-
-
|
|
19
|
-
- DSP Specification: https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/
|
|
16
|
+
- TWIN RFC 006: https://github.com/twinfoundation/rfcs/blob/main/rfcs/data-space-protocol/006-data-space-protocol-profile.md
|
|
17
|
+
- TWIN DS Protocol Context: https://github.com/twinfoundation/rfcs/blob/main/rfcs/data-space-protocol/twin-ds-protocol-profile.jsonld
|
|
18
|
+
- Eclipse DSP Specification: https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/
|
|
19
|
+
- RFC 001 (Query Interface): https://github.com/twinfoundation/rfcs/blob/main/rfcs/data-space-connector/001-data-space-connector-query.md
|
|
20
20
|
|
|
21
21
|
## Type Declaration
|
|
22
22
|
|
|
23
|
-
###
|
|
24
|
-
|
|
25
|
-
> `readonly` **HTTP**: `"https://w3id.org/idsa/v4.1/HTTP"` = `"https://w3id.org/idsa/v4.1/HTTP"`
|
|
26
|
-
|
|
27
|
-
HTTP endpoint (IDSA W3ID v4.1).
|
|
28
|
-
|
|
29
|
-
Persistent identifier for HTTP-based data access endpoints.
|
|
30
|
-
This W3ID URL is used as a semantic identifier in JSON-LD contexts.
|
|
31
|
-
|
|
32
|
-
#### See
|
|
33
|
-
|
|
34
|
-
- https://w3id.org/idsa/v4.1/HTTP
|
|
35
|
-
- https://github.com/International-Data-Spaces-Association/InformationModel
|
|
23
|
+
### HttpsQueryEndpoint
|
|
36
24
|
|
|
37
|
-
|
|
25
|
+
> `readonly` **HttpsQueryEndpoint**: `"https://schema.twindev.org/dspace/v1/Https-Query-Endpoint"` = `"https://schema.twindev.org/dspace/v1/Https-Query-Endpoint"`
|
|
38
26
|
|
|
39
|
-
|
|
27
|
+
HTTPS Query Endpoint (TWIN DS Profile).
|
|
40
28
|
|
|
41
|
-
|
|
29
|
+
Used for PULL transfers via the TWIN Data Space Connector Query interface.
|
|
30
|
+
The consumer retrieves data by querying this endpoint using the data access token.
|
|
31
|
+
Endpoint must implement the interface specified in RFC 001.
|
|
42
32
|
|
|
43
|
-
|
|
44
|
-
|
|
33
|
+
Transfer Flow:
|
|
34
|
+
1. Consumer initiates transfer request
|
|
35
|
+
2. Provider returns this endpoint type with data access token
|
|
36
|
+
3. Consumer queries the endpoint with the token to retrieve data
|
|
45
37
|
|
|
46
38
|
#### See
|
|
47
39
|
|
|
48
|
-
- https://
|
|
49
|
-
- https://github.com/
|
|
40
|
+
- https://github.com/twinfoundation/rfcs/blob/main/rfcs/data-space-protocol/006-data-space-protocol-profile.md#data-transfer-profile-vocabulary
|
|
41
|
+
- https://github.com/twinfoundation/rfcs/blob/main/rfcs/data-space-connector/001-data-space-connector-query.md
|
|
42
|
+
|
|
43
|
+
### HttpsActivityStreamEndpoint
|
|
50
44
|
|
|
51
|
-
|
|
45
|
+
> `readonly` **HttpsActivityStreamEndpoint**: `"https://schema.twindev.org/dspace/v1/Https-Activity-Stream-Endpoint"` = `"https://schema.twindev.org/dspace/v1/Https-Activity-Stream-Endpoint"`
|
|
52
46
|
|
|
53
|
-
|
|
47
|
+
HTTPS Activity Stream Endpoint (TWIN DS Profile).
|
|
54
48
|
|
|
55
|
-
|
|
49
|
+
Used for PUSH transfers via Activity Streams 2.0 protocol.
|
|
50
|
+
The provider actively sends data to the consumer's Activity Stream inbox endpoint.
|
|
51
|
+
Based on W3C Activity Streams 2.0 specification.
|
|
56
52
|
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
53
|
+
Transfer Flow:
|
|
54
|
+
1. Consumer initiates transfer request with this endpoint type
|
|
55
|
+
2. Consumer provides their Activity Stream inbox URL
|
|
56
|
+
3. Provider pushes data to the consumer's inbox as Activity Stream objects
|
|
60
57
|
|
|
61
58
|
#### See
|
|
62
59
|
|
|
60
|
+
- https://github.com/twinfoundation/rfcs/blob/main/rfcs/data-space-protocol/006-data-space-protocol-profile.md#data-transfer-profile-vocabulary
|
|
63
61
|
- https://www.w3.org/TR/activitystreams-core/
|
|
64
62
|
- https://www.w3.org/TR/activitypub/
|
|
65
63
|
|
|
66
|
-
###
|
|
67
|
-
|
|
68
|
-
> `readonly` **S3**: `"S3"` = `"S3"`
|
|
69
|
-
|
|
70
|
-
Amazon S3 bucket endpoint.
|
|
71
|
-
|
|
72
|
-
Used for S3-based data transfer (both PULL and PUSH).
|
|
73
|
-
Note: Not currently part of IDSA W3ID namespace.
|
|
74
|
-
|
|
75
|
-
#### See
|
|
76
|
-
|
|
77
|
-
https://aws.amazon.com/s3/
|
|
64
|
+
### HTTP
|
|
78
65
|
|
|
79
|
-
|
|
66
|
+
> `readonly` **HTTP**: `"https://w3id.org/idsa/v4.1/HTTP"` = `"https://w3id.org/idsa/v4.1/HTTP"`
|
|
80
67
|
|
|
81
|
-
|
|
68
|
+
HTTP endpoint (IDSA W3ID v4.1).
|
|
82
69
|
|
|
83
|
-
|
|
70
|
+
Persistent identifier for HTTP-based data access endpoints.
|
|
71
|
+
This W3ID URL is used as a semantic identifier in JSON-LD contexts.
|
|
84
72
|
|
|
85
|
-
|
|
86
|
-
|
|
73
|
+
Note: For TWIN-specific implementations, prefer using `HttpsQueryEndpoint`.
|
|
74
|
+
This constant is provided for interoperability with IDSA-based systems.
|
|
87
75
|
|
|
88
76
|
#### See
|
|
89
77
|
|
|
90
|
-
https://
|
|
91
|
-
|
|
92
|
-
### Kafka
|
|
93
|
-
|
|
94
|
-
> `readonly` **Kafka**: `"Kafka"` = `"Kafka"`
|
|
95
|
-
|
|
96
|
-
Apache Kafka topic endpoint.
|
|
97
|
-
|
|
98
|
-
Used for streaming data via Kafka message broker.
|
|
99
|
-
Note: Not currently part of IDSA W3ID namespace.
|
|
100
|
-
|
|
101
|
-
#### See
|
|
78
|
+
- https://w3id.org/idsa/v4.1/HTTP
|
|
79
|
+
- https://github.com/International-Data-Spaces-Association/InformationModel
|
|
102
80
|
|
|
103
|
-
|
|
81
|
+
### HTTPS
|
|
104
82
|
|
|
105
|
-
|
|
83
|
+
> `readonly` **HTTPS**: `"https://w3id.org/idsa/v4.1/HTTPS"` = `"https://w3id.org/idsa/v4.1/HTTPS"`
|
|
106
84
|
|
|
107
|
-
|
|
85
|
+
HTTPS endpoint (IDSA W3ID v4.1).
|
|
108
86
|
|
|
109
|
-
|
|
87
|
+
Persistent identifier for HTTPS-based secure data access endpoints.
|
|
88
|
+
This W3ID URL is used as a semantic identifier in JSON-LD contexts.
|
|
110
89
|
|
|
111
|
-
|
|
112
|
-
|
|
90
|
+
Note: For TWIN-specific implementations, prefer using `HttpsQueryEndpoint`.
|
|
91
|
+
This constant is provided for interoperability with IDSA-based systems.
|
|
113
92
|
|
|
114
93
|
#### See
|
|
115
94
|
|
|
116
|
-
https://
|
|
95
|
+
- https://w3id.org/idsa/v4.1/HTTPS
|
|
96
|
+
- https://github.com/International-Data-Spaces-Association/InformationModel
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@twin.org/standards-dataspace-protocol",
|
|
3
|
-
"version": "0.0.3-next.
|
|
3
|
+
"version": "0.0.3-next.29",
|
|
4
4
|
"description": "Models which define the structure of Dataspace Protocol",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -17,8 +17,8 @@
|
|
|
17
17
|
"@twin.org/core": "next",
|
|
18
18
|
"@twin.org/data-core": "next",
|
|
19
19
|
"@twin.org/data-json-ld": "next",
|
|
20
|
-
"@twin.org/standards-w3c-dcat": "0.0.3-next.
|
|
21
|
-
"@twin.org/standards-w3c-odrl": "0.0.3-next.
|
|
20
|
+
"@twin.org/standards-w3c-dcat": "0.0.3-next.29",
|
|
21
|
+
"@twin.org/standards-w3c-odrl": "0.0.3-next.29",
|
|
22
22
|
"@twin.org/web": "next"
|
|
23
23
|
},
|
|
24
24
|
"main": "./dist/es/index.js",
|