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

package/dist/types/models/transferProcess/{ITransferCompletionMessage.d.ts → IDataspaceProtocolTransferCompletionMessage.d.ts}

@@ -1,10 +1,10 @@
 import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
-import type { TransferProcessTypes } from "./transferProcessTypes.js";
+import type { DataspaceProtocolTransferProcessTypes } from "./dataspaceProtocolTransferProcessTypes.js";
 /**
  * Interface for Dataspace Protocol Transfer Messages.
  * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-completion-message
  */
-export interface ITransferCompletionMessage {
+export interface IDataspaceProtocolTransferCompletionMessage {
     /**
      * LD Context
      */
@@ -12,7 +12,7 @@ export interface ITransferCompletionMessage {
     /**
      * LD Type
      */
-    "@type": typeof TransferProcessTypes.TransferCompletionMessage;
+    "@type": typeof DataspaceProtocolTransferProcessTypes.TransferCompletionMessage;
     /**
      * MUST refer to the transfer identifier of the Consumer side.
      */

package/dist/types/models/transferProcess/{ITransferError.d.ts → IDataspaceProtocolTransferError.d.ts}

@@ -1,10 +1,10 @@
 import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
-import type { TransferProcessTypes } from "./transferProcessTypes.js";
+import type { DataspaceProtocolTransferProcessTypes } from "./dataspaceProtocolTransferProcessTypes.js";
 /**
  * Interface for Dataspace Protocol Transfer Messages.
  * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol#error-transfer-error
  */
-export interface ITransferError {
+export interface IDataspaceProtocolTransferError {
     /**
      * LD Context
      */
@@ -12,7 +12,7 @@ export interface ITransferError {
     /**
      * LD Type
      */
-    "@type": typeof TransferProcessTypes.TransferError;
+    "@type": typeof DataspaceProtocolTransferProcessTypes.TransferError;
     /**
      * MUST refer to the transfer identifier of the Consumer side.
      */

package/dist/types/models/transferProcess/{ITransferProcess.d.ts → IDataspaceProtocolTransferProcess.d.ts}

@@ -1,11 +1,11 @@
 import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
-import type { TransferProcessTypes } from "./transferProcessTypes.js";
-import type { TransferProcessStateType } from "./types/transferProcessStateType.js";
+import type { DataspaceProtocolTransferProcessTypes } from "./dataspaceProtocolTransferProcessTypes.js";
+import type { DataspaceProtocolTransferProcessStateType } from "./types/dataspaceProtocolTransferProcessStateType.js";
 /**
  * Interface for Dataspace Protocol Transfer Messages.
  * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#ack-transfer-process
  */
-export interface ITransferProcess {
+export interface IDataspaceProtocolTransferProcess {
     /**
      * LD Context
      */
@@ -13,7 +13,7 @@ export interface ITransferProcess {
     /**
      * LD Type
      */
-    "@type": typeof TransferProcessTypes.TransferProcess;
+    "@type": typeof DataspaceProtocolTransferProcessTypes.TransferProcess;
     /**
      * MUST refer to the transfer identifier of the Consumer side.
      */
@@ -25,5 +25,5 @@ export interface ITransferProcess {
     /**
      * The transfer process state.
      */
-    state: typeof TransferProcessStateType;
+    state: DataspaceProtocolTransferProcessStateType;
 }

package/dist/types/models/transferProcess/{ITransferRequestMessage.d.ts → IDataspaceProtocolTransferRequestMessage.d.ts}

@@ -1,11 +1,11 @@
 import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
-import type { IDataAddress } from "./IDataAddress.js";
-import type { TransferProcessTypes } from "./transferProcessTypes.js";
+import type { DataspaceProtocolTransferProcessTypes } from "./dataspaceProtocolTransferProcessTypes.js";
+import type { IDataspaceProtocolDataAddress } from "./IDataspaceProtocolDataAddress.js";
 /**
  * Interface for Dataspace Protocol Transfer Messages.
  * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-request-message
  */
-export interface ITransferRequestMessage {
+export interface IDataspaceProtocolTransferRequestMessage {
     /**
      * LD Context
      */
@@ -13,7 +13,7 @@ export interface ITransferRequestMessage {
     /**
      * LD Type
      */
-    "@type": typeof TransferProcessTypes.TransferRequestMessage;
+    "@type": typeof DataspaceProtocolTransferProcessTypes.TransferRequestMessage;
     /**
      * MUST refer to an existing Agreement between the Consumer and Provider.
      */
@@ -35,5 +35,5 @@ export interface ITransferRequestMessage {
      * If defined MUST contain a transport-specific set of properties for pushing the data.
      * It MAY include an endpoint, a temporary authorization via the endpointProperties property - depending on the endpointType.
      */
-    dataAddress?: IDataAddress;
+    dataAddress?: IDataspaceProtocolDataAddress;
 }

package/dist/types/models/transferProcess/{ITransferStartMessage.d.ts → IDataspaceProtocolTransferStartMessage.d.ts}

@@ -1,11 +1,11 @@
 import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
-import type { IDataAddress } from "./IDataAddress.js";
-import type { TransferProcessTypes } from "./transferProcessTypes.js";
+import type { DataspaceProtocolTransferProcessTypes } from "./dataspaceProtocolTransferProcessTypes.js";
+import type { IDataspaceProtocolDataAddress } from "./IDataspaceProtocolDataAddress.js";
 /**
  * Interface for Dataspace Protocol Transfer Messages.
  * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-start-message
  */
-export interface ITransferStartMessage {
+export interface IDataspaceProtocolTransferStartMessage {
     /**
      * LD Context
      */
@@ -13,7 +13,7 @@ export interface ITransferStartMessage {
     /**
      * LD Type
      */
-    "@type": typeof TransferProcessTypes.TransferStartMessage;
+    "@type": typeof DataspaceProtocolTransferProcessTypes.TransferStartMessage;
     /**
      * MUST refer to the transfer identifier of the Consumer side.
      */
@@ -26,5 +26,5 @@ export interface ITransferStartMessage {
      * MUST be provided if the current transfer is a pull transfer and
      * contains a transport-specific endpoint address for obtaining the data.
      */
-    dataAddress?: IDataAddress;
+    dataAddress?: IDataspaceProtocolDataAddress;
 }

package/dist/types/models/transferProcess/{ITransferSuspensionMessage.d.ts → IDataspaceProtocolTransferSuspensionMessage.d.ts}

@@ -1,10 +1,10 @@
 import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
-import type { TransferProcessTypes } from "./transferProcessTypes.js";
+import type { DataspaceProtocolTransferProcessTypes } from "./dataspaceProtocolTransferProcessTypes.js";
 /**
  * Interface for Dataspace Protocol Transfer Messages.
  * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-suspension-message
  */
-export interface ITransferSuspensionMessage {
+export interface IDataspaceProtocolTransferSuspensionMessage {
     /**
      * LD Context
      */
@@ -12,7 +12,7 @@ export interface ITransferSuspensionMessage {
     /**
      * LD Type
      */
-    "@type": typeof TransferProcessTypes.TransferSuspensionMessage;
+    "@type": typeof DataspaceProtocolTransferProcessTypes.TransferSuspensionMessage;
     /**
      * MUST refer to the transfer identifier of the Consumer side.
      */

package/dist/types/models/transferProcess/{ITransferTerminationMessage.d.ts → IDataspaceProtocolTransferTerminationMessage.d.ts}

@@ -1,10 +1,10 @@
 import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
-import type { TransferProcessTypes } from "./transferProcessTypes.js";
+import type { DataspaceProtocolTransferProcessTypes } from "./dataspaceProtocolTransferProcessTypes.js";
 /**
  * Interface for Dataspace Protocol Transfer Messages.
  * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-termination-message
  */
-export interface ITransferTerminationMessage {
+export interface IDataspaceProtocolTransferTerminationMessage {
     /**
      * LD Context
      */
@@ -12,7 +12,7 @@ export interface ITransferTerminationMessage {
     /**
      * LD Type
      */
-    "@type": typeof TransferProcessTypes.TransferTerminationMessage;
+    "@type": typeof DataspaceProtocolTransferProcessTypes.TransferTerminationMessage;
     /**
      * MUST refer to the transfer identifier of the Consumer side.
      */

package/dist/types/models/transferProcess/dataspaceProtocolTransferProcessTypes.d.ts

@@ -0,0 +1,46 @@
+/**
+ * The types for Dataspace Protocol Transfer Process.
+ * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#message-types-1
+ */
+export declare const DataspaceProtocolTransferProcessTypes: {
+    /**
+     * Transfer Request Message.
+     */
+    readonly TransferRequestMessage: "TransferRequestMessage";
+    /**
+     * Transfer Start Message.
+     */
+    readonly TransferStartMessage: "TransferStartMessage";
+    /**
+     * Transfer Suspension Message.
+     */
+    readonly TransferSuspensionMessage: "TransferSuspensionMessage";
+    /**
+     * Transfer Completion Message.
+     */
+    readonly TransferCompletionMessage: "TransferCompletionMessage";
+    /**
+     * Transfer Termination Message.
+     */
+    readonly TransferTerminationMessage: "TransferTerminationMessage";
+    /**
+     * Data Address
+     */
+    readonly DataAddress: "DataAddress";
+    /**
+     * Endpoint property.
+     */
+    readonly EndpointProperty: "EndpointProperty";
+    /**
+     * Transfer Process
+     */
+    readonly TransferProcess: "TransferProcess";
+    /**
+     * Transfer Error.
+     */
+    readonly TransferError: "TransferError";
+};
+/**
+ * The types for Dataspace Protocol Transfer.
+ */
+export type DataspaceProtocolTransferProcessTypes = (typeof DataspaceProtocolTransferProcessTypes)[keyof typeof DataspaceProtocolTransferProcessTypes];

package/dist/types/models/transferProcess/types/dataspaceProtocolEndpointType.d.ts

@@ -0,0 +1,89 @@
+/**
+ * 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/twinfoundation/rfcs/blob/main/rfcs/data-space-protocol/006-data-space-protocol-profile.md
+ * - TWIN DS Protocol Context: https://github.com/twinfoundation/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/twinfoundation/rfcs/blob/main/rfcs/data-space-connector/001-data-space-connector-query.md
+ */
+export declare const DataspaceProtocolEndpointType: {
+    /**
+     * 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/twinfoundation/rfcs/blob/main/rfcs/data-space-protocol/006-data-space-protocol-profile.md#data-transfer-profile-vocabulary
+     * @see https://github.com/twinfoundation/rfcs/blob/main/rfcs/data-space-connector/001-data-space-connector-query.md
+     */
+    readonly 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/twinfoundation/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/
+     */
+    readonly HttpsActivityStreamEndpoint: "https://schema.twindev.org/dspace/v1/Https-Activity-Stream-Endpoint";
+    /**
+     * 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
+     */
+    readonly 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
+     */
+    readonly HTTPS: "https://w3id.org/idsa/v4.1/HTTPS";
+};
+/**
+ * Type representing all valid Dataspace Protocol endpoint types.
+ *
+ * All values are valid URIs as required by the DS Protocol JSON-LD context
+ * which defines endpointType as @type:@vocab.
+ *
+ * Includes:
+ * - TWIN RFC 006 types: HttpsQueryEndpoint, HttpsActivityStreamEndpoint
+ * - IDSA W3ID types: HTTP, HTTPS
+ */
+export type DataspaceProtocolEndpointType = (typeof DataspaceProtocolEndpointType)[keyof typeof DataspaceProtocolEndpointType];

package/dist/types/models/transferProcess/types/dataspaceProtocolTransferFormat.d.ts

@@ -0,0 +1,22 @@
+/**
+ * DSP transfer format identifiers used in TransferRequestMessage.format.
+ * See RFC-006 Data Transfer Profile Vocabulary.
+ */
+export declare const DataspaceProtocolTransferFormat: {
+    /**
+     * PULL mode: consumer queries data via a bearer-token-protected endpoint.
+     */
+    readonly HttpPullQueryFormat: "Http-Pull-Query-Format";
+    /**
+     * Consumer-initiated PUSH mode: consumer provides an /inbox endpoint; provider posts ActivityStreams objects there.
+     */
+    readonly HttpPushActivityStreamFormat: "Http-Push-Activity-Stream-Format";
+    /**
+     * Provider-initiated PUSH mode: provider returns an /inbox URL and JWT token in endpointProperties.
+     */
+    readonly HttpPostActivityStreamFormat: "Http-Post-Activity-Stream-Format";
+};
+/**
+ * Type for the DataspaceProtocolTransferFormat const values.
+ */
+export type DataspaceProtocolTransferFormat = (typeof DataspaceProtocolTransferFormat)[keyof typeof DataspaceProtocolTransferFormat];

package/dist/types/models/transferProcess/types/dataspaceProtocolTransferProcessStateType.d.ts

@@ -0,0 +1,30 @@
+/**
+ * The states for Dataspace Protocol Transfer Process.
+ * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#ack-transfer-process
+ */
+export declare const DataspaceProtocolTransferProcessStateType: {
+    /**
+     * Completed
+     */
+    readonly COMPLETED: "COMPLETED";
+    /**
+     * Requested
+     */
+    readonly REQUESTED: "REQUESTED";
+    /**
+     * Started
+     */
+    readonly STARTED: "STARTED";
+    /**
+     * Suspended
+     */
+    readonly SUSPENDED: "SUSPENDED";
+    /**
+     * Terminated
+     */
+    readonly TERMINATED: "TERMINATED";
+};
+/**
+ * The types for Dataspace Protocol Transfer.
+ */
+export type DataspaceProtocolTransferProcessStateType = (typeof DataspaceProtocolTransferProcessStateType)[keyof typeof DataspaceProtocolTransferProcessStateType];

package/dist/types/utils/dataspaceProtocolHelper.d.ts

@@ -0,0 +1,19 @@
+import { type IValidationFailure } from "@twin.org/core";
+import { type IJsonLdNodeObject } from "@twin.org/data-json-ld";
+/**
+ * Dataspace protocol helper.
+ */
+export declare abstract class DataspaceProtocolHelper {
+    /**
+     * Checks whether the object passed as parameter is conformant to the DS Protocol definitions.
+     * @param object The object to check
+     * @returns An array of validation failures, empty if the object is conformant
+     */
+    static validate(object: IJsonLdNodeObject): Promise<IValidationFailure[]>;
+    /**
+     * Normalizes the input object making it compliant with the DS Protocol specifications.
+     * @param object The input object.
+     * @returns The input object normalized.
+     */
+    static normalize(object: IJsonLdNodeObject): Promise<IJsonLdNodeObject>;
+}