@twin.org/standards-dataspace-protocol 0.0.3-next.4 → 0.0.3-next.5

package/dist/es/schemas/TransferStartMessage.json

@@ -0,0 +1,78 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/TransferStartMessage",
+    "description": "Interface for Dataspace Protocol Transfer Messages. https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-start-message",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "description": "The Dataspace Protocol Protocol JSON-LD context type.",
+            "anyOf": [
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "const": "https://w3id.org/dspace/2025/1/context.json"
+                    },
+                    "minItems": 1,
+                    "maxItems": 1
+                },
+                {
+                    "type": "array",
+                    "minItems": 2,
+                    "prefixItems": [
+                        {
+                            "type": "string",
+                            "const": "https://w3id.org/dspace/2025/1/context.json"
+                        },
+                        {
+                            "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                        }
+                    ],
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    }
+                },
+                {
+                    "type": "array",
+                    "minItems": 2,
+                    "prefixItems": [
+                        {
+                            "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                        },
+                        {
+                            "type": "string",
+                            "const": "https://w3id.org/dspace/2025/1/context.json"
+                        }
+                    ],
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    }
+                }
+            ]
+        },
+        "@type": {
+            "type": "string",
+            "const": "TransferStartMessage",
+            "description": "LD Type"
+        },
+        "consumerPid": {
+            "type": "string",
+            "description": "MUST refer to the transfer identifier of the Consumer side."
+        },
+        "providerPid": {
+            "type": "string",
+            "description": "MUST refer to the transfer identifier of the Provider side."
+        },
+        "dataAddress": {
+            "$ref": "https://schema.twindev.org/dataspace-protocol/DataAddress",
+            "description": "MUST be provided if the current transfer is a pull transfer and contains a transport-specific endpoint address for obtaining the data."
+        }
+    },
+    "required": [
+        "@context",
+        "@type",
+        "consumerPid",
+        "providerPid"
+    ],
+    "additionalProperties": false
+}

package/dist/es/schemas/TransferSuspensionMessage.json

@@ -0,0 +1,83 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/TransferSuspensionMessage",
+    "description": "Interface for Dataspace Protocol Transfer Messages. https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-suspension-message",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "description": "The Dataspace Protocol Protocol JSON-LD context type.",
+            "anyOf": [
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "const": "https://w3id.org/dspace/2025/1/context.json"
+                    },
+                    "minItems": 1,
+                    "maxItems": 1
+                },
+                {
+                    "type": "array",
+                    "minItems": 2,
+                    "prefixItems": [
+                        {
+                            "type": "string",
+                            "const": "https://w3id.org/dspace/2025/1/context.json"
+                        },
+                        {
+                            "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                        }
+                    ],
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    }
+                },
+                {
+                    "type": "array",
+                    "minItems": 2,
+                    "prefixItems": [
+                        {
+                            "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                        },
+                        {
+                            "type": "string",
+                            "const": "https://w3id.org/dspace/2025/1/context.json"
+                        }
+                    ],
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    }
+                }
+            ]
+        },
+        "@type": {
+            "type": "string",
+            "const": "TransferSuspensionMessage",
+            "description": "LD Type"
+        },
+        "consumerPid": {
+            "type": "string",
+            "description": "MUST refer to the transfer identifier of the Consumer side."
+        },
+        "providerPid": {
+            "type": "string",
+            "description": "MUST refer to the transfer identifier of the Provider side."
+        },
+        "code": {
+            "type": "string",
+            "description": "The suspension code."
+        },
+        "reason": {
+            "type": "array",
+            "items": {},
+            "description": "The suspension reason(s)."
+        }
+    },
+    "required": [
+        "@context",
+        "@type",
+        "consumerPid",
+        "providerPid"
+    ],
+    "additionalProperties": false
+}

package/dist/es/schemas/TransferTerminationMessage.json

@@ -0,0 +1,83 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/TransferTerminationMessage",
+    "description": "Interface for Dataspace Protocol Transfer Messages. https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-termination-message",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "description": "The Dataspace Protocol Protocol JSON-LD context type.",
+            "anyOf": [
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "const": "https://w3id.org/dspace/2025/1/context.json"
+                    },
+                    "minItems": 1,
+                    "maxItems": 1
+                },
+                {
+                    "type": "array",
+                    "minItems": 2,
+                    "prefixItems": [
+                        {
+                            "type": "string",
+                            "const": "https://w3id.org/dspace/2025/1/context.json"
+                        },
+                        {
+                            "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                        }
+                    ],
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    }
+                },
+                {
+                    "type": "array",
+                    "minItems": 2,
+                    "prefixItems": [
+                        {
+                            "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                        },
+                        {
+                            "type": "string",
+                            "const": "https://w3id.org/dspace/2025/1/context.json"
+                        }
+                    ],
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    }
+                }
+            ]
+        },
+        "@type": {
+            "type": "string",
+            "const": "TransferTerminationMessage",
+            "description": "LD Type"
+        },
+        "consumerPid": {
+            "type": "string",
+            "description": "MUST refer to the transfer identifier of the Consumer side."
+        },
+        "providerPid": {
+            "type": "string",
+            "description": "MUST refer to the transfer identifier of the Provider side."
+        },
+        "code": {
+            "type": "string",
+            "description": "The termination code."
+        },
+        "reason": {
+            "type": "array",
+            "items": {},
+            "description": "The termination reason(s)."
+        }
+    },
+    "required": [
+        "@context",
+        "@type",
+        "consumerPid",
+        "providerPid"
+    ],
+    "additionalProperties": false
+}

package/dist/types/dataTypes/catalogDataTypes.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Handle all the catalog data types for Dataspace Protocol.
+ */
+export declare class CatalogDataTypes {
+    /**
+     * Register all the data types.
+     */
+    static registerTypes(): void;
+}

package/dist/types/dataTypes/contractNegotiationDataTypes.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Handle all the contract negotiation data types for Dataspace Protocol.
+ */
+export declare class ContractNegotiationDataTypes {
+    /**
+     * Register all the data types.
+     */
+    static registerTypes(): void;
+}

package/dist/types/dataTypes/transferProcessDataTypes.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Handle all the transfer process data types for Dataspace Protocol.
+ */
+export declare class TransferProcessDataTypes {
+    /**
+     * Register all the data types.
+     */
+    static registerTypes(): void;
+}

package/dist/types/index.d.ts

@@ -1,10 +1,11 @@
 export * from "./models/dataspaceProtocolContexts.js";
 export * from "./models/dataspaceProtocolContextType.js";
-export * from "./dataTypes/dataspaceProtolDataTypes.js";
+export * from "./dataTypes/dataspaceProtocolDataTypes.js";
 export * from "./models/catalog/catalogTypes.js";
 export * from "./models/catalog/ICatalogError.js";
 export * from "./models/catalog/ICatalogRequestMessage.js";
 export * from "./models/catalog/IDatasetRequestMessage.js";
+export * from "./dataTypes/catalogDataTypes.js";
 export * from "./models/contractNegotiation/contractNegotiationTypes.js";
 export * from "./models/contractNegotiation/IContractAgreementMessage.js";
 export * from "./models/contractNegotiation/IContractAgreementVerificationMessage.js";
@@ -16,3 +17,16 @@ export * from "./models/contractNegotiation/IContractOfferMessage.js";
 export * from "./models/contractNegotiation/IContractRequestMessage.js";
 export * from "./models/contractNegotiation/types/contractNegotiationEventType.js";
 export * from "./models/contractNegotiation/types/contractNegotiationStateType.js";
+export * from "./dataTypes/contractNegotiationDataTypes.js";
+export * from "./models/transferProcess/transferProcessTypes.js";
+export * from "./models/transferProcess/IDataAddress.js";
+export * from "./models/transferProcess/IEndpointProperty.js";
+export * from "./models/transferProcess/ITransferCompletionMessage.js";
+export * from "./models/transferProcess/ITransferError.js";
+export * from "./models/transferProcess/ITransferProcess.js";
+export * from "./models/transferProcess/ITransferRequestMessage.js";
+export * from "./models/transferProcess/ITransferStartMessage.js";
+export * from "./models/transferProcess/ITransferSuspensionMessage.js";
+export * from "./models/transferProcess/ITransferTerminationMessage.js";
+export * from "./models/transferProcess/types/transferProcessStateType.js";
+export * from "./dataTypes/transferProcessDataTypes.js";

package/dist/types/models/catalog/ICatalogError.d.ts

@@ -18,7 +18,7 @@ export interface ICatalogError {
      */
     code: string;
     /**
-     * An optional array of error reasons.
+     * The error reason(s).
      */
-    reasons?: string[];
+    reason?: any[];
 }

package/dist/types/models/catalog/ICatalogRequestMessage.d.ts

@@ -16,5 +16,5 @@ export interface ICatalogRequestMessage {
     /**
      * An implementation-specific query or filter expression.
      */
-    filter?: unknown;
+    filter?: unknown[];
 }

package/dist/types/models/contractNegotiation/IContractNegotiationError.d.ts

@@ -28,15 +28,5 @@ export interface IContractNegotiationError {
     /**
      * The error reason(s).
      */
-    reason?: {
-        "@value": string;
-        "@language"?: string;
-    }[];
-    /**
-     * The error description(s).
-     */
-    description?: {
-        "@value": string;
-        "@language"?: string;
-    }[];
+    reason?: any[];
 }

package/dist/types/models/dataspaceProtocolContextType.d.ts

@@ -3,7 +3,7 @@ import type { DataspaceProtocolContexts } from "./dataspaceProtocolContexts.js";
 /**
  * The Dataspace Protocol Protocol JSON-LD context type.
  */
-export type DataspaceProtocolContextType = typeof DataspaceProtocolContexts.ContextRoot | [
+export type DataspaceProtocolContextType = [typeof DataspaceProtocolContexts.ContextRoot] | [
     ...IJsonLdContextDefinitionElement[],
     typeof DataspaceProtocolContexts.ContextRoot,
     IJsonLdContextDefinitionElement

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

@@ -0,0 +1,24 @@
+import type { IEndpointProperty } from "./IEndpointProperty.js";
+import type { TransferProcessTypes } from "./transferProcessTypes.js";
+/**
+ * Interface for Dataspace Protocol Transfer Messages.
+ * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#lower-level-types
+ */
+export interface IDataAddress {
+    /**
+     * LD Type
+     */
+    "@type": typeof TransferProcessTypes.DataAddress;
+    /**
+     * The type of endpoint of this data address.
+     */
+    endpointType: string;
+    /**
+     * The endpoint of the data address
+     */
+    endpoint?: string;
+    /**
+     * Properties associated to the endpoint which might depend on the endpoint type.
+     */
+    endpointProperties?: IEndpointProperty[];
+}

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

@@ -0,0 +1,19 @@
+import type { TransferProcessTypes } from "./transferProcessTypes.js";
+/**
+ * Interface for Dataspace Protocol Transfer Messages.
+ * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#lower-level-types
+ */
+export interface IEndpointProperty {
+    /**
+     * LD Type.
+     */
+    "@type": typeof TransferProcessTypes.EndpointProperty;
+    /**
+     * Property name.
+     */
+    name: string;
+    /**
+     * Property value.
+     */
+    value: string;
+}

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

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

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

@@ -0,0 +1,32 @@
+import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
+import type { TransferProcessTypes } from "./transferProcessTypes.js";
+/**
+ * Interface for Dataspace Protocol Transfer Messages.
+ * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol#error-transfer-error
+ */
+export interface ITransferError {
+    /**
+     * LD Context
+     */
+    "@context": DataspaceProtocolContextType;
+    /**
+     * LD Type
+     */
+    "@type": typeof TransferProcessTypes.TransferError;
+    /**
+     * MUST refer to the transfer identifier of the Consumer side.
+     */
+    consumerPid: string;
+    /**
+     * MUST refer to the transfer identifier of the Provider side.
+     */
+    providerPid: string;
+    /**
+     * The error code.
+     */
+    code?: string;
+    /**
+     * The error reason(s).
+     */
+    reason?: any[];
+}

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

@@ -0,0 +1,29 @@
+import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
+import type { TransferProcessTypes } from "./transferProcessTypes.js";
+import type { TransferProcessStateType } from "./types/transferProcessStateType.js";
+/**
+ * Interface for Dataspace Protocol Transfer Messages.
+ * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#ack-transfer-process
+ */
+export interface ITransferProcess {
+    /**
+     * LD Context
+     */
+    "@context": DataspaceProtocolContextType;
+    /**
+     * LD Type
+     */
+    "@type": typeof TransferProcessTypes.TransferProcess;
+    /**
+     * MUST refer to the transfer identifier of the Consumer side.
+     */
+    consumerPid: string;
+    /**
+     * MUST refer to the transfer identifier of the Provider side.
+     */
+    providerPid: string;
+    /**
+     * The transfer process state.
+     */
+    state: typeof TransferProcessStateType;
+}

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

@@ -0,0 +1,39 @@
+import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
+import type { IDataAddress } from "./IDataAddress.js";
+import type { TransferProcessTypes } from "./transferProcessTypes.js";
+/**
+ * Interface for Dataspace Protocol Transfer Messages.
+ * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-request-message
+ */
+export interface ITransferRequestMessage {
+    /**
+     * LD Context
+     */
+    "@context": DataspaceProtocolContextType;
+    /**
+     * LD Type
+     */
+    "@type": typeof TransferProcessTypes.TransferRequestMessage;
+    /**
+     * MUST refer to an existing Agreement between the Consumer and Provider.
+     */
+    agreementId: string;
+    /**
+     * MUST be a URI indicating where messages to the Consumer SHOULD be sent.
+     */
+    callbackAddress: string;
+    /**
+     * MUST refer to the transfer identifier of the Consumer side.
+     */
+    consumerPid: string;
+    /**
+     * The format property is a format specified by a Distribution for the Dataset associated with the Agreement.
+     * This is generally obtained from the Provider's Catalog.
+     */
+    format: string;
+    /**
+     * 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;
+}

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

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

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

@@ -0,0 +1,32 @@
+import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
+import type { TransferProcessTypes } from "./transferProcessTypes.js";
+/**
+ * Interface for Dataspace Protocol Transfer Messages.
+ * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-suspension-message
+ */
+export interface ITransferSuspensionMessage {
+    /**
+     * LD Context
+     */
+    "@context": DataspaceProtocolContextType;
+    /**
+     * LD Type
+     */
+    "@type": typeof TransferProcessTypes.TransferSuspensionMessage;
+    /**
+     * MUST refer to the transfer identifier of the Consumer side.
+     */
+    consumerPid: string;
+    /**
+     * MUST refer to the transfer identifier of the Provider side.
+     */
+    providerPid: string;
+    /**
+     * The suspension code.
+     */
+    code?: string;
+    /**
+     * The suspension reason(s).
+     */
+    reason?: any[];
+}

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

@@ -0,0 +1,32 @@
+import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
+import type { TransferProcessTypes } from "./transferProcessTypes.js";
+/**
+ * Interface for Dataspace Protocol Transfer Messages.
+ * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-termination-message
+ */
+export interface ITransferTerminationMessage {
+    /**
+     * LD Context
+     */
+    "@context": DataspaceProtocolContextType;
+    /**
+     * LD Type
+     */
+    "@type": typeof TransferProcessTypes.TransferTerminationMessage;
+    /**
+     * MUST refer to the transfer identifier of the Consumer side.
+     */
+    consumerPid: string;
+    /**
+     * MUST refer to the transfer identifier of the Provider side.
+     */
+    providerPid: string;
+    /**
+     * The termination code.
+     */
+    code?: string;
+    /**
+     * The termination reason(s).
+     */
+    reason?: any[];
+}