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

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

@@ -1,11 +1,7 @@
 /**
- * Handle all the data types for Dataspace Protocol Contract Negotiation.
+ * Handle all the contract negotiation data types for Dataspace Protocol.
  */
 export declare class ContractNegotiationDataTypes {
-    /**
-     * Register the JSON-LD Redirects.
-     */
-    static registerRedirects(): void;
     /**
      * Register all the data types.
      */

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

@@ -0,0 +1,13 @@
+/**
+ * Handle all the data types for Dataspace Protocol.
+ */
+export declare class DataspaceProtocolDataTypes {
+    /**
+     * Register the JSON-LD Redirects.
+     */
+    static registerRedirects(): void;
+    /**
+     * 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,6 +1,11 @@
-export * from "./dataTypes/contractNegotiationDataTypes.js";
-export * from "./models/contractNegotiation/contractNegotiationContexts.js";
-export * from "./models/contractNegotiation/contractNegotiationContextType.js";
+export * from "./models/dataspaceProtocolContexts.js";
+export * from "./models/dataspaceProtocolContextType.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";
@@ -12,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

@@ -0,0 +1,24 @@
+import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
+import type { CatalogTypes } from "./catalogTypes.js";
+/**
+ * Interface for Dataspace Protocol Catalog Error.
+ * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#error-catalog-error
+ */
+export interface ICatalogError {
+    /**
+     * The JSON-LD context.
+     */
+    "@context": DataspaceProtocolContextType;
+    /**
+     * The type of the message.
+     */
+    "@type": typeof CatalogTypes.CatalogError;
+    /**
+     * The error code.
+     */
+    code: string;
+    /**
+     * The error reason(s).
+     */
+    reason?: any[];
+}

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

@@ -0,0 +1,20 @@
+import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
+import type { CatalogTypes } from "./catalogTypes.js";
+/**
+ * Interface for Dataspace Protocol Catalog Request Messages.
+ * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#catalog-request-message
+ */
+export interface ICatalogRequestMessage {
+    /**
+     * The JSON-LD context.
+     */
+    "@context": DataspaceProtocolContextType;
+    /**
+     * The type of the message.
+     */
+    "@type": typeof CatalogTypes.CatalogRequestMessage;
+    /**
+     * An implementation-specific query or filter expression.
+     */
+    filter?: unknown[];
+}

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

@@ -0,0 +1,20 @@
+import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
+import type { CatalogTypes } from "./catalogTypes.js";
+/**
+ * Interface for Dataspace Protocol Dataset Request Messages.
+ * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#dataset-request-message
+ */
+export interface IDatasetRequestMessage {
+    /**
+     * The JSON-LD context.
+     */
+    "@context": DataspaceProtocolContextType;
+    /**
+     * The type of the message.
+     */
+    "@type": typeof CatalogTypes.DatasetRequestMessage;
+    /**
+     * The identifier of the dataset.
+     */
+    dataset: string;
+}

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

@@ -0,0 +1,22 @@
+/**
+ * The types for Dataspace Protocol Catalog Protocol.
+ * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#catalog-protocol
+ */
+export declare const CatalogTypes: {
+    /**
+     * Catalog Request Message.
+     */
+    readonly CatalogRequestMessage: "CatalogRequestMessage";
+    /**
+     * Dataset Request Message.
+     */
+    readonly DatasetRequestMessage: "DatasetRequestMessage";
+    /**
+     * Catalog Error.
+     */
+    readonly CatalogError: "CatalogError";
+};
+/**
+ * The types for Dataspace Protocol Catalog Protocol.
+ */
+export type CatalogTypes = (typeof CatalogTypes)[keyof typeof CatalogTypes];

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

@@ -1,6 +1,6 @@
 import type { IOdrlAgreement } from "@twin.org/standards-w3c-odrl";
-import type { ContractNegotiationContextType } from "./contractNegotiationContextType.js";
 import type { ContractNegotiationTypes } from "./contractNegotiationTypes.js";
+import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
 /**
  * Interface for Dataspace Protocol Contract Agreement Messages.
  * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-agreement-message
@@ -9,7 +9,7 @@ export interface IContractAgreementMessage {
     /**
      * The JSON-LD context.
      */
-    "@context": ContractNegotiationContextType;
+    "@context": DataspaceProtocolContextType;
     /**
      * The type of the message.
      */

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

@@ -1,4 +1,4 @@
-import type { ContractNegotiationContextType } from "./contractNegotiationContextType.js";
+import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
 import type { ContractNegotiationTypes } from "./contractNegotiationTypes.js";
 /**
  * Interface for Dataspace Protocol Contract Agreement Verification Messages.
@@ -8,7 +8,7 @@ export interface IContractAgreementVerificationMessage {
     /**
      * The JSON-LD context.
      */
-    "@context": ContractNegotiationContextType;
+    "@context": DataspaceProtocolContextType;
     /**
      * The type of the message.
      */

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

@@ -1,4 +1,4 @@
-import type { ContractNegotiationContextType } from "./contractNegotiationContextType.js";
+import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
 import type { ContractNegotiationTypes } from "./contractNegotiationTypes.js";
 import type { ContractNegotiationStateType } from "./types/contractNegotiationStateType.js";
 /**
@@ -9,7 +9,7 @@ export interface IContractNegotiation {
     /**
      * The JSON-LD context.
      */
-    "@context": ContractNegotiationContextType;
+    "@context": DataspaceProtocolContextType;
     /**
      * The type of the message.
      */

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

@@ -1,4 +1,4 @@
-import type { ContractNegotiationContextType } from "./contractNegotiationContextType.js";
+import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
 import type { ContractNegotiationTypes } from "./contractNegotiationTypes.js";
 /**
  * Interface for Dataspace Protocol Contract Negotiation Error Messages.
@@ -8,7 +8,7 @@ export interface IContractNegotiationError {
     /**
      * The JSON-LD context.
      */
-    "@context": ContractNegotiationContextType;
+    "@context": DataspaceProtocolContextType;
     /**
      * The type of the message.
      */
@@ -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/contractNegotiation/IContractNegotiationEventMessage.d.ts

@@ -1,4 +1,4 @@
-import type { ContractNegotiationContextType } from "./contractNegotiationContextType.js";
+import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
 import type { ContractNegotiationTypes } from "./contractNegotiationTypes.js";
 import type { ContractNegotiationEventType } from "./types/contractNegotiationEventType.js";
 /**
@@ -9,7 +9,7 @@ export interface IContractNegotiationEventMessage {
     /**
      * The JSON-LD context.
      */
-    "@context": ContractNegotiationContextType;
+    "@context": DataspaceProtocolContextType;
     /**
      * The type of the message.
      */

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

@@ -1,4 +1,4 @@
-import type { ContractNegotiationContextType } from "./contractNegotiationContextType.js";
+import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
 import type { ContractNegotiationTypes } from "./contractNegotiationTypes.js";
 /**
  * Interface for Dataspace Protocol Contract Negotiation Termination Messages.
@@ -8,7 +8,7 @@ export interface IContractNegotiationTerminationMessage {
     /**
      * The JSON-LD context.
      */
-    "@context": ContractNegotiationContextType;
+    "@context": DataspaceProtocolContextType;
     /**
      * The type of the message.
      */

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

@@ -1,5 +1,5 @@
 import type { IOdrlOffer } from "@twin.org/standards-w3c-odrl";
-import type { ContractNegotiationContextType } from "./contractNegotiationContextType.js";
+import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
 import type { ContractNegotiationTypes } from "./contractNegotiationTypes.js";
 /**
  * Interface for Dataspace Protocol Contract Offer Messages.
@@ -9,7 +9,7 @@ export interface IContractOfferMessage {
     /**
      * The JSON-LD context.
      */
-    "@context": ContractNegotiationContextType;
+    "@context": DataspaceProtocolContextType;
     /**
      * The type of the message.
      */

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

@@ -1,5 +1,5 @@
 import type { IOdrlOffer } from "@twin.org/standards-w3c-odrl";
-import type { ContractNegotiationContextType } from "./contractNegotiationContextType.js";
+import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
 import type { ContractNegotiationTypes } from "./contractNegotiationTypes.js";
 /**
  * Interface for Dataspace Protocol Contract Request Messages.
@@ -9,7 +9,7 @@ export interface IContractRequestMessage {
     /**
      * The JSON-LD context.
      */
-    "@context": ContractNegotiationContextType;
+    "@context": DataspaceProtocolContextType;
     /**
      * The type of the message.
      */

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

@@ -0,0 +1,14 @@
+import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
+import type { DataspaceProtocolContexts } from "./dataspaceProtocolContexts.js";
+/**
+ * The Dataspace Protocol Protocol JSON-LD context type.
+ */
+export type DataspaceProtocolContextType = [typeof DataspaceProtocolContexts.ContextRoot] | [
+    ...IJsonLdContextDefinitionElement[],
+    typeof DataspaceProtocolContexts.ContextRoot,
+    IJsonLdContextDefinitionElement
+] | [
+    IJsonLdContextDefinitionElement,
+    typeof DataspaceProtocolContexts.ContextRoot,
+    ...IJsonLdContextDefinitionElement[]
+];

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

@@ -0,0 +1,17 @@
+/**
+ * The contexts for Dataspace Protocol Protocol.
+ */
+export declare const DataspaceProtocolContexts: {
+    /**
+     * The context root for Dataspace Protocol Protocol.
+     */
+    readonly ContextRoot: "https://w3id.org/dspace/2025/1/context.json";
+    /**
+     * The context redirect for Dataspace Protocol Protocol.
+     */
+    readonly ContextRedirect: "https://w3id.org/dspace/2025/1/context.jsonld";
+};
+/**
+ * The contexts for Dataspace Protocol Protocol.
+ */
+export type DataspaceProtocolContexts = (typeof DataspaceProtocolContexts)[keyof typeof DataspaceProtocolContexts];

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;
+}