@twin.org/standards-dataspace-protocol 0.0.3-next.6 → 0.0.3-next.61

package/dist/es/models/transferProcess/IDataspaceProtocolEndpointProperty.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IDataspaceProtocolEndpointProperty.js.map

package/dist/es/models/transferProcess/IDataspaceProtocolEndpointProperty.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IDataspaceProtocolEndpointProperty.js","sourceRoot":"","sources":["../../../../src/models/transferProcess/IDataspaceProtocolEndpointProperty.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { DataspaceProtocolTransferProcessTypes } from \"./dataspaceProtocolTransferProcessTypes.js\";\n\n/**\n * Interface for Dataspace Protocol Transfer Messages.\n * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#lower-level-types\n */\nexport interface IDataspaceProtocolEndpointProperty {\n\t/**\n\t * LD Type.\n\t */\n\t\"@type\": typeof DataspaceProtocolTransferProcessTypes.EndpointProperty;\n\n\t/**\n\t * Property name.\n\t */\n\tname: string;\n\n\t/**\n\t * Property value.\n\t */\n\tvalue: string;\n}\n"]}

package/dist/es/models/transferProcess/IDataspaceProtocolTransferCompletionMessage.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IDataspaceProtocolTransferCompletionMessage.js.map

package/dist/es/models/transferProcess/IDataspaceProtocolTransferCompletionMessage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IDataspaceProtocolTransferCompletionMessage.js","sourceRoot":"","sources":["../../../../src/models/transferProcess/IDataspaceProtocolTransferCompletionMessage.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { DataspaceProtocolContextType } from \"../dataspaceProtocolContextType.js\";\nimport type { DataspaceProtocolTransferProcessTypes } from \"./dataspaceProtocolTransferProcessTypes.js\";\n\n/**\n * Interface for Dataspace Protocol Transfer Messages.\n * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-completion-message\n */\nexport interface IDataspaceProtocolTransferCompletionMessage {\n\t/**\n\t * LD Context\n\t */\n\t\"@context\": DataspaceProtocolContextType;\n\n\t/**\n\t * LD Type\n\t */\n\t\"@type\": typeof DataspaceProtocolTransferProcessTypes.TransferCompletionMessage;\n\n\t/**\n\t * MUST refer to the transfer identifier of the Consumer side.\n\t */\n\tconsumerPid: string;\n\n\t/**\n\t * MUST refer to the transfer identifier of the Provider side.\n\t */\n\tproviderPid: string;\n}\n"]}

package/dist/es/models/transferProcess/IDataspaceProtocolTransferError.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IDataspaceProtocolTransferError.js.map

package/dist/es/models/transferProcess/IDataspaceProtocolTransferError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IDataspaceProtocolTransferError.js","sourceRoot":"","sources":["../../../../src/models/transferProcess/IDataspaceProtocolTransferError.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { DataspaceProtocolContextType } from \"../dataspaceProtocolContextType.js\";\nimport type { DataspaceProtocolTransferProcessTypes } from \"./dataspaceProtocolTransferProcessTypes.js\";\n\n/**\n * Interface for Dataspace Protocol Transfer Messages.\n * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol#error-transfer-error\n */\nexport interface IDataspaceProtocolTransferError {\n\t/**\n\t * LD Context\n\t */\n\t\"@context\": DataspaceProtocolContextType;\n\n\t/**\n\t * LD Type\n\t */\n\t\"@type\": typeof DataspaceProtocolTransferProcessTypes.TransferError;\n\n\t/**\n\t * MUST refer to the transfer identifier of the Consumer side.\n\t */\n\tconsumerPid: string;\n\n\t/**\n\t * MUST refer to the transfer identifier of the Provider side.\n\t */\n\tproviderPid: string;\n\n\t/**\n\t * The error code.\n\t */\n\tcode?: string;\n\n\t/**\n\t * The error reason(s).\n\t */\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\treason?: any[];\n}\n"]}

package/dist/es/models/transferProcess/IDataspaceProtocolTransferProcess.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IDataspaceProtocolTransferProcess.js.map

package/dist/es/models/transferProcess/IDataspaceProtocolTransferProcess.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IDataspaceProtocolTransferProcess.js","sourceRoot":"","sources":["../../../../src/models/transferProcess/IDataspaceProtocolTransferProcess.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { DataspaceProtocolContextType } from \"../dataspaceProtocolContextType.js\";\nimport type { DataspaceProtocolTransferProcessTypes } from \"./dataspaceProtocolTransferProcessTypes.js\";\nimport type { DataspaceProtocolTransferProcessStateType } from \"./types/dataspaceProtocolTransferProcessStateType.js\";\n\n/**\n * Interface for Dataspace Protocol Transfer Messages.\n * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#ack-transfer-process\n */\nexport interface IDataspaceProtocolTransferProcess {\n\t/**\n\t * LD Context\n\t */\n\t\"@context\": DataspaceProtocolContextType;\n\n\t/**\n\t * LD Type\n\t */\n\t\"@type\": typeof DataspaceProtocolTransferProcessTypes.TransferProcess;\n\n\t/**\n\t * MUST refer to the transfer identifier of the Consumer side.\n\t */\n\tconsumerPid: string;\n\n\t/**\n\t * MUST refer to the transfer identifier of the Provider side.\n\t */\n\tproviderPid: string;\n\n\t/**\n\t * The transfer process state.\n\t */\n\tstate: DataspaceProtocolTransferProcessStateType;\n}\n"]}

package/dist/es/models/transferProcess/IDataspaceProtocolTransferRequestMessage.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IDataspaceProtocolTransferRequestMessage.js.map

package/dist/es/models/transferProcess/IDataspaceProtocolTransferRequestMessage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IDataspaceProtocolTransferRequestMessage.js","sourceRoot":"","sources":["../../../../src/models/transferProcess/IDataspaceProtocolTransferRequestMessage.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { DataspaceProtocolContextType } from \"../dataspaceProtocolContextType.js\";\nimport type { DataspaceProtocolTransferProcessTypes } from \"./dataspaceProtocolTransferProcessTypes.js\";\nimport type { IDataspaceProtocolDataAddress } from \"./IDataspaceProtocolDataAddress.js\";\n\n/**\n * Interface for Dataspace Protocol Transfer Messages.\n * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-request-message\n */\nexport interface IDataspaceProtocolTransferRequestMessage {\n\t/**\n\t * LD Context\n\t */\n\t\"@context\": DataspaceProtocolContextType;\n\n\t/**\n\t * LD Type\n\t */\n\t\"@type\": typeof DataspaceProtocolTransferProcessTypes.TransferRequestMessage;\n\n\t/**\n\t * MUST refer to an existing Agreement between the Consumer and Provider.\n\t */\n\tagreementId: string;\n\n\t/**\n\t * MUST be a URI indicating where messages to the Consumer SHOULD be sent.\n\t */\n\tcallbackAddress: string;\n\n\t/**\n\t * MUST refer to the transfer identifier of the Consumer side.\n\t */\n\tconsumerPid: string;\n\n\t/**\n\t * The format property is a format specified by a Distribution for the Dataset associated with the Agreement.\n\t * This is generally obtained from the Provider's Catalog.\n\t */\n\tformat: string;\n\n\t/**\n\t * If defined MUST contain a transport-specific set of properties for pushing the data.\n\t * It MAY include an endpoint, a temporary authorization via the endpointProperties property - depending on the endpointType.\n\t */\n\tdataAddress?: IDataspaceProtocolDataAddress;\n}\n"]}

package/dist/es/models/transferProcess/IDataspaceProtocolTransferStartMessage.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IDataspaceProtocolTransferStartMessage.js.map

package/dist/es/models/transferProcess/IDataspaceProtocolTransferStartMessage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IDataspaceProtocolTransferStartMessage.js","sourceRoot":"","sources":["../../../../src/models/transferProcess/IDataspaceProtocolTransferStartMessage.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { DataspaceProtocolContextType } from \"../dataspaceProtocolContextType.js\";\nimport type { DataspaceProtocolTransferProcessTypes } from \"./dataspaceProtocolTransferProcessTypes.js\";\nimport type { IDataspaceProtocolDataAddress } from \"./IDataspaceProtocolDataAddress.js\";\n\n/**\n * Interface for Dataspace Protocol Transfer Messages.\n * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-start-message\n */\nexport interface IDataspaceProtocolTransferStartMessage {\n\t/**\n\t * LD Context\n\t */\n\t\"@context\": DataspaceProtocolContextType;\n\n\t/**\n\t * LD Type\n\t */\n\t\"@type\": typeof DataspaceProtocolTransferProcessTypes.TransferStartMessage;\n\n\t/**\n\t * MUST refer to the transfer identifier of the Consumer side.\n\t */\n\tconsumerPid: string;\n\n\t/**\n\t * MUST refer to the transfer identifier of the Provider side.\n\t */\n\tproviderPid: string;\n\n\t/**\n\t * MUST be provided if the current transfer is a pull transfer and\n\t * contains a transport-specific endpoint address for obtaining the data.\n\t */\n\tdataAddress?: IDataspaceProtocolDataAddress;\n}\n"]}

package/dist/es/models/transferProcess/{ITransferSuspensionMessage.js → IDataspaceProtocolTransferSuspensionMessage.js}

@@ -1,4 +1,4 @@
 // Copyright 2025 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 export {};
-//# sourceMappingURL=ITransferSuspensionMessage.js.map
+//# sourceMappingURL=IDataspaceProtocolTransferSuspensionMessage.js.map

package/dist/es/models/transferProcess/IDataspaceProtocolTransferSuspensionMessage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IDataspaceProtocolTransferSuspensionMessage.js","sourceRoot":"","sources":["../../../../src/models/transferProcess/IDataspaceProtocolTransferSuspensionMessage.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\nimport type { DataspaceProtocolContextType } from \"../dataspaceProtocolContextType.js\";\nimport type { DataspaceProtocolTransferProcessTypes } from \"./dataspaceProtocolTransferProcessTypes.js\";\n\n/**\n * Interface for Dataspace Protocol Transfer Messages.\n * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-suspension-message\n */\nexport interface IDataspaceProtocolTransferSuspensionMessage {\n\t/**\n\t * LD Context\n\t */\n\t\"@context\": DataspaceProtocolContextType;\n\n\t/**\n\t * LD Type\n\t */\n\t\"@type\": typeof DataspaceProtocolTransferProcessTypes.TransferSuspensionMessage;\n\n\t/**\n\t * MUST refer to the transfer identifier of the Consumer side.\n\t */\n\tconsumerPid: string;\n\n\t/**\n\t * MUST refer to the transfer identifier of the Provider side.\n\t */\n\tproviderPid: string;\n\n\t/**\n\t * The suspension code.\n\t */\n\tcode?: string;\n\n\t/**\n\t * The suspension reason(s).\n\t */\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\treason?: any[];\n}\n"]}

package/dist/es/models/transferProcess/IDataspaceProtocolTransferTerminationMessage.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IDataspaceProtocolTransferTerminationMessage.js.map

package/dist/es/models/transferProcess/IDataspaceProtocolTransferTerminationMessage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IDataspaceProtocolTransferTerminationMessage.js","sourceRoot":"","sources":["../../../../src/models/transferProcess/IDataspaceProtocolTransferTerminationMessage.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { DataspaceProtocolContextType } from \"../dataspaceProtocolContextType.js\";\nimport type { DataspaceProtocolTransferProcessTypes } from \"./dataspaceProtocolTransferProcessTypes.js\";\n\n/**\n * Interface for Dataspace Protocol Transfer Messages.\n * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-termination-message\n */\nexport interface IDataspaceProtocolTransferTerminationMessage {\n\t/**\n\t * LD Context\n\t */\n\t\"@context\": DataspaceProtocolContextType;\n\n\t/**\n\t * LD Type\n\t */\n\t\"@type\": typeof DataspaceProtocolTransferProcessTypes.TransferTerminationMessage;\n\n\t/**\n\t * MUST refer to the transfer identifier of the Consumer side.\n\t */\n\tconsumerPid: string;\n\n\t/**\n\t * MUST refer to the transfer identifier of the Provider side.\n\t */\n\tproviderPid: string;\n\n\t/**\n\t * The termination code.\n\t */\n\tcode?: string;\n\n\t/**\n\t * The termination reason(s).\n\t */\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\treason?: any[];\n}\n"]}

package/dist/es/models/transferProcess/{transferProcessTypes.js → dataspaceProtocolTransferProcessTypes.js}

@@ -5,7 +5,7 @@
  * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#message-types-1
  */
 // eslint-disable-next-line @typescript-eslint/naming-convention
-export const TransferProcessTypes = {
+export const DataspaceProtocolTransferProcessTypes = {
     /**
      * Transfer Request Message.
      */
@@ -43,4 +43,4 @@ export const TransferProcessTypes = {
      */
     TransferError: "TransferError"
 };
-//# sourceMappingURL=transferProcessTypes.js.map
+//# sourceMappingURL=dataspaceProtocolTransferProcessTypes.js.map

package/dist/es/models/transferProcess/dataspaceProtocolTransferProcessTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dataspaceProtocolTransferProcessTypes.js","sourceRoot":"","sources":["../../../../src/models/transferProcess/dataspaceProtocolTransferProcessTypes.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;;GAGG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,qCAAqC,GAAG;IACpD;;OAEG;IACH,sBAAsB,EAAE,wBAAwB;IAEhD;;OAEG;IACH,oBAAoB,EAAE,sBAAsB;IAE5C;;OAEG;IACH,yBAAyB,EAAE,2BAA2B;IAEtD;;OAEG;IACH,yBAAyB,EAAE,2BAA2B;IAEtD;;OAEG;IACH,0BAA0B,EAAE,4BAA4B;IAExD;;OAEG;IACH,WAAW,EAAE,aAAa;IAE1B;;OAEG;IACH,gBAAgB,EAAE,kBAAkB;IAEpC;;OAEG;IACH,eAAe,EAAE,iBAAiB;IAElC;;OAEG;IACH,aAAa,EAAE,eAAe;CACrB,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The types for Dataspace Protocol Transfer Process.\n * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#message-types-1\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const DataspaceProtocolTransferProcessTypes = {\n\t/**\n\t * Transfer Request Message.\n\t */\n\tTransferRequestMessage: \"TransferRequestMessage\",\n\n\t/**\n\t * Transfer Start Message.\n\t */\n\tTransferStartMessage: \"TransferStartMessage\",\n\n\t/**\n\t * Transfer Suspension Message.\n\t */\n\tTransferSuspensionMessage: \"TransferSuspensionMessage\",\n\n\t/**\n\t * Transfer Completion Message.\n\t */\n\tTransferCompletionMessage: \"TransferCompletionMessage\",\n\n\t/**\n\t * Transfer Termination Message.\n\t */\n\tTransferTerminationMessage: \"TransferTerminationMessage\",\n\n\t/**\n\t * Data Address\n\t */\n\tDataAddress: \"DataAddress\",\n\n\t/**\n\t * Endpoint property.\n\t */\n\tEndpointProperty: \"EndpointProperty\",\n\n\t/**\n\t * Transfer Process\n\t */\n\tTransferProcess: \"TransferProcess\",\n\n\t/**\n\t * Transfer Error.\n\t */\n\tTransferError: \"TransferError\"\n} as const;\n\n/**\n * The types for Dataspace Protocol Transfer.\n */\nexport type DataspaceProtocolTransferProcessTypes =\n\t(typeof DataspaceProtocolTransferProcessTypes)[keyof typeof DataspaceProtocolTransferProcessTypes];\n"]}

package/dist/es/models/transferProcess/types/dataspaceProtocolEndpointType.js

@@ -0,0 +1,89 @@
+// Copyright 2025 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * TWIN Data Space Protocol Profile endpoint type identifiers.
+ *
+ * This module defines endpoint types according to the TWIN Foundation's
+ * Data Space Protocol Profile (RFC 006), which extends the Eclipse Dataspace
+ * Protocol specification with TWIN-specific vocabulary.
+ *
+ * The TWIN vocabulary uses persistent identifiers under the
+ * https://schema.twindev.org namespace to provide stable, semantic
+ * identifiers for data space endpoint types.
+ *
+ * References:
+ * - TWIN RFC 006: https://github.com/iotaledger/twin-rfcs/blob/main/rfcs/data-space-protocol/006-data-space-protocol-profile.md
+ * - TWIN DS Protocol Context: https://github.com/iotaledger/twin-rfcs/blob/main/rfcs/data-space-protocol/twin-ds-protocol-profile.jsonld
+ * - Eclipse DSP Specification: https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/
+ * - RFC 001 (Query Interface): https://github.com/iotaledger/twin-rfcs/blob/main/rfcs/data-space-connector/001-data-space-connector-query.md
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const DataspaceProtocolEndpointType = {
+    // ========================================
+    // TWIN Data Space Protocol Profile (RFC 006)
+    // Namespace: https://schema.twindev.org/dspace/v1/
+    // ========================================
+    /**
+     * HTTPS Query Endpoint (TWIN DS Profile).
+     *
+     * Used for PULL transfers via the TWIN Data Space Connector Query interface.
+     * The consumer retrieves data by querying this endpoint using the data access token.
+     * Endpoint must implement the interface specified in RFC 001.
+     *
+     * Transfer Flow:
+     * 1. Consumer initiates transfer request
+     * 2. Provider returns this endpoint type with data access token
+     * 3. Consumer queries the endpoint with the token to retrieve data
+     *
+     * @see https://github.com/iotaledger/twin-rfcs/blob/main/rfcs/data-space-protocol/006-data-space-protocol-profile.md#data-transfer-profile-vocabulary
+     * @see https://github.com/iotaledger/twin-rfcs/blob/main/rfcs/data-space-connector/001-data-space-connector-query.md
+     */
+    HttpsQueryEndpoint: "https://schema.twindev.org/dspace/v1/Https-Query-Endpoint",
+    /**
+     * HTTPS Activity Stream Endpoint (TWIN DS Profile).
+     *
+     * Used for PUSH transfers via Activity Streams 2.0 protocol.
+     * The provider actively sends data to the consumer's Activity Stream inbox endpoint.
+     * Based on W3C Activity Streams 2.0 specification.
+     *
+     * Transfer Flow:
+     * 1. Consumer initiates transfer request with this endpoint type
+     * 2. Consumer provides their Activity Stream inbox URL
+     * 3. Provider pushes data to the consumer's inbox as Activity Stream objects
+     *
+     * @see https://github.com/iotaledger/twin-rfcs/blob/main/rfcs/data-space-protocol/006-data-space-protocol-profile.md#data-transfer-profile-vocabulary
+     * @see https://www.w3.org/TR/activitystreams-core/
+     * @see https://www.w3.org/TR/activitypub/
+     */
+    HttpsActivityStreamEndpoint: "https://schema.twindev.org/dspace/v1/Https-Activity-Stream-Endpoint",
+    // ========================================
+    // IDSA W3ID Namespace (Interoperability)
+    // ========================================
+    /**
+     * HTTP endpoint (IDSA W3ID v4.1).
+     *
+     * Persistent identifier for HTTP-based data access endpoints.
+     * This W3ID URL is used as a semantic identifier in JSON-LD contexts.
+     *
+     * Note: For TWIN-specific implementations, prefer using `HttpsQueryEndpoint`.
+     * This constant is provided for interoperability with IDSA-based systems.
+     *
+     * @see https://w3id.org/idsa/v4.1/HTTP
+     * @see https://github.com/International-Data-Spaces-Association/InformationModel
+     */
+    HTTP: "https://w3id.org/idsa/v4.1/HTTP",
+    /**
+     * HTTPS endpoint (IDSA W3ID v4.1).
+     *
+     * Persistent identifier for HTTPS-based secure data access endpoints.
+     * This W3ID URL is used as a semantic identifier in JSON-LD contexts.
+     *
+     * Note: For TWIN-specific implementations, prefer using `HttpsQueryEndpoint`.
+     * This constant is provided for interoperability with IDSA-based systems.
+     *
+     * @see https://w3id.org/idsa/v4.1/HTTPS
+     * @see https://github.com/International-Data-Spaces-Association/InformationModel
+     */
+    HTTPS: "https://w3id.org/idsa/v4.1/HTTPS"
+};
+//# sourceMappingURL=dataspaceProtocolEndpointType.js.map

package/dist/es/models/transferProcess/types/dataspaceProtocolEndpointType.js.map

@@ -0,0 +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/iotaledger/twin-rfcs/blob/main/rfcs/data-space-protocol/006-data-space-protocol-profile.md\n * - TWIN DS Protocol Context: https://github.com/iotaledger/twin-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/iotaledger/twin-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/iotaledger/twin-rfcs/blob/main/rfcs/data-space-protocol/006-data-space-protocol-profile.md#data-transfer-profile-vocabulary\n\t * @see https://github.com/iotaledger/twin-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/iotaledger/twin-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"]}

package/dist/es/models/transferProcess/types/{transferProcessStateType.js → dataspaceProtocolTransferProcessStateType.js}

@@ -5,7 +5,7 @@
  * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#ack-transfer-process
  */
 // eslint-disable-next-line @typescript-eslint/naming-convention
-export const TransferProcessStateType = {
+export const DataspaceProtocolTransferProcessStateType = {
     /**
      * Completed
      */
@@ -27,4 +27,4 @@ export const TransferProcessStateType = {
      */
     TERMINATED: "TERMINATED"
 };
-//# sourceMappingURL=transferProcessStateType.js.map
+//# sourceMappingURL=dataspaceProtocolTransferProcessStateType.js.map

package/dist/es/models/transferProcess/types/dataspaceProtocolTransferProcessStateType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dataspaceProtocolTransferProcessStateType.js","sourceRoot":"","sources":["../../../../../src/models/transferProcess/types/dataspaceProtocolTransferProcessStateType.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;;GAGG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,yCAAyC,GAAG;IACxD;;OAEG;IACH,SAAS,EAAE,WAAW;IAEtB;;OAEG;IACH,SAAS,EAAE,WAAW;IAEtB;;OAEG;IACH,OAAO,EAAE,SAAS;IAElB;;OAEG;IACH,SAAS,EAAE,WAAW;IAEtB;;OAEG;IACH,UAAU,EAAE,YAAY;CACf,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The states for Dataspace Protocol Transfer Process.\n * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#ack-transfer-process\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const DataspaceProtocolTransferProcessStateType = {\n\t/**\n\t * Completed\n\t */\n\tCOMPLETED: \"COMPLETED\",\n\n\t/**\n\t * Requested\n\t */\n\tREQUESTED: \"REQUESTED\",\n\n\t/**\n\t * Started\n\t */\n\tSTARTED: \"STARTED\",\n\n\t/**\n\t * Suspended\n\t */\n\tSUSPENDED: \"SUSPENDED\",\n\n\t/**\n\t * Terminated\n\t */\n\tTERMINATED: \"TERMINATED\"\n} as const;\n\n/**\n * The types for Dataspace Protocol Transfer.\n */\nexport type DataspaceProtocolTransferProcessStateType =\n\t(typeof DataspaceProtocolTransferProcessStateType)[keyof typeof DataspaceProtocolTransferProcessStateType];\n"]}

package/dist/es/schemas/DataspaceProtocolAgreement.json

@@ -0,0 +1,207 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolAgreement",
+    "title": "DataspaceProtocolAgreement",
+    "description": "Agreement interface compliant with Eclipse Data Space Protocol.\n\nExtends IOdrlAgreement with DS Protocol-specific constraints:\n- `@id` is REQUIRED (used as the primary agreement identifier in DS Protocol)\n- `@context` is omitted (inherited from the parent Dataset/Distribution)",
+    "type": "object",
+    "properties": {
+        "@id": {
+            "type": "string",
+            "description": "Unique identifier for the agreement."
+        }
+    },
+    "required": [
+        "@id"
+    ],
+    "allOf": [
+        {
+            "description": "Interface representing an ODRL Agreement.\nAn Agreement requires both an assigner and assignee (both agreeing parties).\nhttps://www.w3.org/TR/odrl-model/#policy-agreement",
+            "type": "object",
+            "properties": {
+                "@context": {
+                    "$ref": "https://schema.twindev.org/w3c-odrl/OdrlContextType",
+                    "description": "The context for the policy.\nMust include \"https://www.w3.org/ns/odrl.jsonld\"",
+                    "$comment": "Inherited from OdrlPolicy"
+                },
+                "@type": {
+                    "const": "Agreement",
+                    "description": "The type must be \"Agreement\".",
+                    "$comment": "Inherited from OdrlAgreement"
+                },
+                "profile": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        }
+                    ],
+                    "description": "The profile(s) this policy conforms to.\nIRIs identifying the ODRL Profile(s).",
+                    "$comment": "Inherited from OdrlPolicy"
+                },
+                "assigner": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "$ref": "https://schema.twindev.org/w3c-odrl/OdrlParty"
+                        }
+                    ],
+                    "description": "The assigner of the agreement.\nRequired for Agreement policies.",
+                    "$comment": "Inherited from OdrlAgreement"
+                },
+                "assignee": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "$ref": "https://schema.twindev.org/w3c-odrl/OdrlParty"
+                        }
+                    ],
+                    "description": "The assignee of the agreement.\nRequired for Agreement policies.",
+                    "$comment": "Inherited from OdrlAgreement"
+                },
+                "target": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAsset"
+                        },
+                        {
+                            "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAssetCollection"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "anyOf": [
+                                    {
+                                        "type": "string"
+                                    },
+                                    {
+                                        "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAsset"
+                                    },
+                                    {
+                                        "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAssetCollection"
+                                    }
+                                ]
+                            }
+                        }
+                    ],
+                    "description": "The target asset for the rule.",
+                    "$comment": "Inherited from OdrlPolicy"
+                },
+                "action": {
+                    "anyOf": [
+                        {
+                            "$ref": "https://schema.twindev.org/w3c-odrl/OdrlActionType"
+                        },
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAction"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "anyOf": [
+                                    {
+                                        "$ref": "https://schema.twindev.org/w3c-odrl/OdrlActionType"
+                                    },
+                                    {
+                                        "type": "string"
+                                    },
+                                    {
+                                        "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAction"
+                                    }
+                                ]
+                            }
+                        }
+                    ],
+                    "description": "The action associated with the rule.",
+                    "$comment": "Inherited from OdrlPolicy"
+                },
+                "inheritFrom": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        }
+                    ],
+                    "description": "The parent policy(ies) this policy inherits from.\nIRIs identifying the parent Policy(ies).",
+                    "$comment": "Inherited from OdrlPolicy"
+                },
+                "conflict": {
+                    "$ref": "https://schema.twindev.org/w3c-odrl/OdrlConflictStrategyType",
+                    "description": "The conflict resolution strategy.\n- perm: Permissions override Prohibitions\n- prohibit: Prohibitions override Permissions\n- invalid: Policy is void if conflicts exist (default)",
+                    "$comment": "Inherited from OdrlPolicy"
+                },
+                "permission": {
+                    "anyOf": [
+                        {
+                            "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPermission"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPermission"
+                            }
+                        }
+                    ],
+                    "description": "The permissions in the policy.\nAt least one of permission, prohibition, or obligation must be present.",
+                    "$comment": "Inherited from OdrlPolicy"
+                },
+                "prohibition": {
+                    "anyOf": [
+                        {
+                            "$ref": "https://schema.twindev.org/w3c-odrl/OdrlProhibition"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "$ref": "https://schema.twindev.org/w3c-odrl/OdrlProhibition"
+                            }
+                        }
+                    ],
+                    "description": "The prohibitions in the policy.\nAt least one of permission, prohibition, or obligation must be present.",
+                    "$comment": "Inherited from OdrlPolicy"
+                },
+                "obligation": {
+                    "anyOf": [
+                        {
+                            "$ref": "https://schema.twindev.org/w3c-odrl/OdrlDuty"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "$ref": "https://schema.twindev.org/w3c-odrl/OdrlDuty"
+                            }
+                        }
+                    ],
+                    "description": "The obligations in the policy.\nAt least one of permission, prohibition, or obligation must be present.",
+                    "$comment": "Inherited from OdrlPolicy"
+                }
+            },
+            "required": [
+                "@context",
+                "@type",
+                "assigner",
+                "assignee"
+            ],
+            "$comment": "Inlined utility base type OdrlAgreement so utility transformations can operate on concrete properties instead of a $ref."
+        }
+    ]
+}

package/dist/es/schemas/DataspaceProtocolCatalog.json

@@ -0,0 +1,21 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolCatalog",
+    "title": "DataspaceProtocolCatalog",
+    "description": "Catalog interface compliant with Eclipse Data Space Protocol.\n\nThis interface extends ICatalog and enforces DS Protocol-specific requirements\nby overriding properties with more specific types and constraints.\n\n**Requirements per DS Protocol:**\n- `@id` MUST be present for dataset identification (REQUIRED)\n- participantId MUST be present (REQUIRED)\n\n**Type System Design:**\n- Interface extension allows TypeScript to override inherited property types\n- Standards packages (@twin.org/standards-w3c-*) follow W3C specs exactly\n- DS Protocol-specific constraints are defined here",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContextType",
+            "description": "LD Context. Required per Eclipse Data Space Protocol."
+        }
+    },
+    "required": [
+        "@context"
+    ],
+    "allOf": [
+        {
+            "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolCatalogBase"
+        }
+    ]
+}