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

package/dist/es/utils/dataspaceProtocolHelper.js

@@ -0,0 +1,110 @@
+// Copyright 2025 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { GeneralError, Is, ObjectHelper } from "@twin.org/core";
+import { DataTypeHelper, JsonSchemaHelper } from "@twin.org/data-core";
+import { JsonLdHelper, JsonLdProcessor } from "@twin.org/data-json-ld";
+import { DcatContexts } from "@twin.org/standards-w3c-dcat";
+import { DataspaceProtocolContexts } from "../models/dataspaceProtocolContexts.js";
+import { DataspaceProtocolTransferProcessTypes } from "../models/transferProcess/dataspaceProtocolTransferProcessTypes.js";
+/**
+ * Dataspace protocol helper.
+ */
+export class DataspaceProtocolHelper {
+    /**
+     * The class name.
+     * @internal
+     */
+    static CLASS_NAME = "DataspaceProtocolHelper";
+    /**
+     * Checks whether the object passed as parameter is conformant to the DS Protocol definitions.
+     * @param object The object to check
+     * @param validationFailures the Validation failures obtained during the conformance checking.
+     * @returns true or false depending whether the object is conformant or not
+     */
+    static async checkConformance(object, validationFailures) {
+        let result = false;
+        const dcatNamespace = DcatContexts.Namespace;
+        const objectTypes = await JsonLdHelper.getType(object);
+        for (const type of objectTypes) {
+            let dataTypeIdentifier = type;
+            // If the DCAT3 types are used, convert to the DS Protocol equivalent
+            // which have the enhancements and constraints defined by the DS Protocol
+            if (type.startsWith(dcatNamespace)) {
+                const nonQualifiedType = type.replace(dcatNamespace, "");
+                dataTypeIdentifier = `${DataspaceProtocolContexts.Namespace}${nonQualifiedType}`;
+            }
+            const schema = await DataTypeHelper.getSchemaForType(dataTypeIdentifier);
+            if (!schema) {
+                throw new GeneralError(DataspaceProtocolHelper.CLASS_NAME, "schemaNotRegistered", {
+                    schemaId: dataTypeIdentifier
+                });
+            }
+            const normalizedObject = await DataspaceProtocolHelper.normalize(object);
+            const validationResult = await JsonSchemaHelper.validate(schema, normalizedObject);
+            result = validationResult.result;
+            if (!result && Is.array(validationResult.error)) {
+                for (const aError of validationResult.error) {
+                    const validationFailure = {
+                        property: aError.instancePath,
+                        reason: aError.message
+                    };
+                    validationFailures.push(validationFailure);
+                }
+            }
+        }
+        return result;
+    }
+    /**
+     * Normalizes the input object making it compliant with the DS Protocol specifications.
+     * @param object The input object.
+     * @returns The input object normalized.
+     */
+    static async normalize(object) {
+        const annotatedObject = DataspaceProtocolHelper.annotateLDContextForFormat(object);
+        // Determine if this is a message/transfer type (which expects Context) or a catalog type (which expects JsonLdContext)
+        const objectType = ObjectHelper.propertyGet(object, "@type");
+        const isTransferProcessType = Is.string(objectType) &&
+            (objectType.includes("Message") ||
+                objectType === DataspaceProtocolTransferProcessTypes.TransferProcess ||
+                objectType === DataspaceProtocolTransferProcessTypes.TransferError);
+        const contextToUse = isTransferProcessType
+            ? DataspaceProtocolContexts.Context
+            : DataspaceProtocolContexts.JsonLdContext;
+        const compactedObject = await JsonLdProcessor.compact(annotatedObject, [contextToUse]);
+        if (!Is.array(compactedObject["@context"])) {
+            ObjectHelper.propertySet(compactedObject, "@context", [
+                ObjectHelper.propertyGet(compactedObject, "@context")
+            ]);
+        }
+        return compactedObject;
+    }
+    /**
+     * Ensures format property has a proper LD Context.
+     * @param object The object.
+     * @returns a copy of the object annotated with the proper LD Context.
+     * @internal
+     */
+    static annotateLDContextForFormat(object) {
+        const result = ObjectHelper.clone(object);
+        // This step is needed before compaction as 'dcterms:format' is not defined originally as '@vocab'
+        // but it is in the DSP LD Context
+        const EXTRA_ANNOTATION = {
+            "dcterms:format": {
+                "@id": "dcterms:format",
+                "@type": "@vocab"
+            }
+        };
+        const ldContext = ObjectHelper.propertyGet(result, "@context");
+        if (Is.array(ldContext)) {
+            ldContext.push(EXTRA_ANNOTATION);
+        }
+        else if (Is.object(ldContext)) {
+            ObjectHelper.propertySet(result, "@context", { ...ldContext, ...EXTRA_ANNOTATION });
+        }
+        else if (Is.string(ldContext)) {
+            ObjectHelper.propertySet(result, "@context", [ldContext, EXTRA_ANNOTATION]);
+        }
+        return result;
+    }
+}
+//# sourceMappingURL=dataspaceProtocolHelper.js.map

package/dist/es/utils/dataspaceProtocolHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dataspaceProtocolHelper.js","sourceRoot":"","sources":["../../../src/utils/dataspaceProtocolHelper.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC,OAAO,EAAE,YAAY,EAAE,EAAE,EAAE,YAAY,EAA2B,MAAM,gBAAgB,CAAC;AACzF,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,EACN,YAAY,EACZ,eAAe,EAGf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EAAE,yBAAyB,EAAE,MAAM,wCAAwC,CAAC;AACnF,OAAO,EAAE,qCAAqC,EAAE,MAAM,oEAAoE,CAAC;AAE3H;;GAEG;AACH,MAAM,OAAgB,uBAAuB;IAC5C;;;OAGG;IACI,MAAM,CAAU,UAAU,6BAAqC;IAEtE;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,gBAAgB,CACnC,MAAyB,EACzB,kBAAwC;QAExC,IAAI,MAAM,GAAG,KAAK,CAAC;QAEnB,MAAM,aAAa,GAAG,YAAY,CAAC,SAAS,CAAC;QAE7C,MAAM,WAAW,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAEvD,KAAK,MAAM,IAAI,IAAI,WAAW,EAAE,CAAC;YAChC,IAAI,kBAAkB,GAAG,IAAI,CAAC;YAE9B,qEAAqE;YACrE,yEAAyE;YACzE,IAAI,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;gBACpC,MAAM,gBAAgB,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;gBACzD,kBAAkB,GAAG,GAAG,yBAAyB,CAAC,SAAS,GAAG,gBAAgB,EAAE,CAAC;YAClF,CAAC;YAED,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,CAAC;YACzE,IAAI,CAAC,MAAM,EAAE,CAAC;gBACb,MAAM,IAAI,YAAY,CAAC,uBAAuB,CAAC,UAAU,EAAE,qBAAqB,EAAE;oBACjF,QAAQ,EAAE,kBAAkB;iBAC5B,CAAC,CAAC;YACJ,CAAC;YAED,MAAM,gBAAgB,GAAG,MAAM,uBAAuB,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;YAEzE,MAAM,gBAAgB,GAAG,MAAM,gBAAgB,CAAC,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;YACnF,MAAM,GAAG,gBAAgB,CAAC,MAAM,CAAC;YAEjC,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC,KAAK,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;gBACjD,KAAK,MAAM,MAAM,IAAI,gBAAgB,CAAC,KAAK,EAAE,CAAC;oBAC7C,MAAM,iBAAiB,GAAuB;wBAC7C,QAAQ,EAAE,MAAM,CAAC,YAAY;wBAC7B,MAAM,EAAE,MAAM,CAAC,OAAiB;qBAChC,CAAC;oBACF,kBAAkB,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;gBAC5C,CAAC;YACF,CAAC;QACF,CAAC;QACD,OAAO,MAAM,CAAC;IACf,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,MAAyB;QACtD,MAAM,eAAe,GAAG,uBAAuB,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAC;QAEnF,uHAAuH;QACvH,MAAM,UAAU,GAAG,YAAY,CAAC,WAAW,CAAoB,MAAM,EAAE,OAAO,CAAC,CAAC;QAChF,MAAM,qBAAqB,GAC1B,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC;YACrB,CAAC,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC;gBAC9B,UAAU,KAAK,qCAAqC,CAAC,eAAe;gBACpE,UAAU,KAAK,qCAAqC,CAAC,aAAa,CAAC,CAAC;QAEtE,MAAM,YAAY,GAAG,qBAAqB;YACzC,CAAC,CAAC,yBAAyB,CAAC,OAAO;YACnC,CAAC,CAAC,yBAAyB,CAAC,aAAa,CAAC;QAE3C,MAAM,eAAe,GAAG,MAAM,eAAe,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC;QAEvF,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC;YAC5C,YAAY,CAAC,WAAW,CAAC,eAAe,EAAE,UAAU,EAAE;gBACrD,YAAY,CAAC,WAAW,CAAC,eAAe,EAAE,UAAU,CAAC;aACrD,CAAC,CAAC;QACJ,CAAC;QAED,OAAO,eAAe,CAAC;IACxB,CAAC;IAED;;;;;OAKG;IACK,MAAM,CAAC,0BAA0B,CAAC,MAAyB;QAClE,MAAM,MAAM,GAAG,YAAY,CAAC,KAAK,CAAoB,MAAM,CAAC,CAAC;QAE7D,kGAAkG;QAClG,kCAAkC;QAClC,MAAM,gBAAgB,GAAG;YACxB,gBAAgB,EAAE;gBACjB,KAAK,EAAE,gBAAgB;gBACvB,OAAO,EAAE,QAAQ;aACjB;SACD,CAAC;QACF,MAAM,SAAS,GAAG,YAAY,CAAC,WAAW,CAA+B,MAAM,EAAE,UAAU,CAAC,CAAC;QAC7F,IAAI,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;YACzB,SAAS,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAClC,CAAC;aAAM,IAAI,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;YACjC,YAAY,CAAC,WAAW,CAAC,MAAM,EAAE,UAAU,EAAE,EAAE,GAAG,SAAS,EAAE,GAAG,gBAAgB,EAAE,CAAC,CAAC;QACrF,CAAC;aAAM,IAAI,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;YACjC,YAAY,CAAC,WAAW,CAAC,MAAM,EAAE,UAAU,EAAE,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC,CAAC;QAC7E,CAAC;QAED,OAAO,MAAM,CAAC;IACf,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\nimport { GeneralError, Is, ObjectHelper, type IValidationFailure } from \"@twin.org/core\";\nimport { DataTypeHelper, JsonSchemaHelper } from \"@twin.org/data-core\";\nimport {\n\tJsonLdHelper,\n\tJsonLdProcessor,\n\ttype IJsonLdContextDefinitionRoot,\n\ttype IJsonLdNodeObject\n} from \"@twin.org/data-json-ld\";\nimport { nameof } from \"@twin.org/nameof\";\nimport { DcatContexts } from \"@twin.org/standards-w3c-dcat\";\nimport { DataspaceProtocolContexts } from \"../models/dataspaceProtocolContexts.js\";\nimport { DataspaceProtocolTransferProcessTypes } from \"../models/transferProcess/dataspaceProtocolTransferProcessTypes.js\";\n\n/**\n * Dataspace protocol helper.\n */\nexport abstract class DataspaceProtocolHelper {\n\t/**\n\t * The class name.\n\t * @internal\n\t */\n\tpublic static readonly CLASS_NAME = nameof<DataspaceProtocolHelper>();\n\n\t/**\n\t * Checks whether the object passed as parameter is conformant to the DS Protocol definitions.\n\t * @param object The object to check\n\t * @param validationFailures the Validation failures obtained during the conformance checking.\n\t * @returns true or false depending whether the object is conformant or not\n\t */\n\tpublic static async checkConformance(\n\t\tobject: IJsonLdNodeObject,\n\t\tvalidationFailures: IValidationFailure[]\n\t): Promise<boolean> {\n\t\tlet result = false;\n\n\t\tconst dcatNamespace = DcatContexts.Namespace;\n\n\t\tconst objectTypes = await JsonLdHelper.getType(object);\n\n\t\tfor (const type of objectTypes) {\n\t\t\tlet dataTypeIdentifier = type;\n\n\t\t\t// If the DCAT3 types are used, convert to the DS Protocol equivalent\n\t\t\t// which have the enhancements and constraints defined by the DS Protocol\n\t\t\tif (type.startsWith(dcatNamespace)) {\n\t\t\t\tconst nonQualifiedType = type.replace(dcatNamespace, \"\");\n\t\t\t\tdataTypeIdentifier = `${DataspaceProtocolContexts.Namespace}${nonQualifiedType}`;\n\t\t\t}\n\n\t\t\tconst schema = await DataTypeHelper.getSchemaForType(dataTypeIdentifier);\n\t\t\tif (!schema) {\n\t\t\t\tthrow new GeneralError(DataspaceProtocolHelper.CLASS_NAME, \"schemaNotRegistered\", {\n\t\t\t\t\tschemaId: dataTypeIdentifier\n\t\t\t\t});\n\t\t\t}\n\n\t\t\tconst normalizedObject = await DataspaceProtocolHelper.normalize(object);\n\n\t\t\tconst validationResult = await JsonSchemaHelper.validate(schema, normalizedObject);\n\t\t\tresult = validationResult.result;\n\n\t\t\tif (!result && Is.array(validationResult.error)) {\n\t\t\t\tfor (const aError of validationResult.error) {\n\t\t\t\t\tconst validationFailure: IValidationFailure = {\n\t\t\t\t\t\tproperty: aError.instancePath,\n\t\t\t\t\t\treason: aError.message as string\n\t\t\t\t\t};\n\t\t\t\t\tvalidationFailures.push(validationFailure);\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn result;\n\t}\n\n\t/**\n\t * Normalizes the input object making it compliant with the DS Protocol specifications.\n\t * @param object The input object.\n\t * @returns The input object normalized.\n\t */\n\tpublic static async normalize(object: IJsonLdNodeObject): Promise<IJsonLdNodeObject> {\n\t\tconst annotatedObject = DataspaceProtocolHelper.annotateLDContextForFormat(object);\n\n\t\t// Determine if this is a message/transfer type (which expects Context) or a catalog type (which expects JsonLdContext)\n\t\tconst objectType = ObjectHelper.propertyGet<string | string[]>(object, \"@type\");\n\t\tconst isTransferProcessType =\n\t\t\tIs.string(objectType) &&\n\t\t\t(objectType.includes(\"Message\") ||\n\t\t\t\tobjectType === DataspaceProtocolTransferProcessTypes.TransferProcess ||\n\t\t\t\tobjectType === DataspaceProtocolTransferProcessTypes.TransferError);\n\n\t\tconst contextToUse = isTransferProcessType\n\t\t\t? DataspaceProtocolContexts.Context\n\t\t\t: DataspaceProtocolContexts.JsonLdContext;\n\n\t\tconst compactedObject = await JsonLdProcessor.compact(annotatedObject, [contextToUse]);\n\n\t\tif (!Is.array(compactedObject[\"@context\"])) {\n\t\t\tObjectHelper.propertySet(compactedObject, \"@context\", [\n\t\t\t\tObjectHelper.propertyGet(compactedObject, \"@context\")\n\t\t\t]);\n\t\t}\n\n\t\treturn compactedObject;\n\t}\n\n\t/**\n\t * Ensures format property has a proper LD Context.\n\t * @param object The object.\n\t * @returns a copy of the object annotated with the proper LD Context.\n\t * @internal\n\t */\n\tprivate static annotateLDContextForFormat(object: IJsonLdNodeObject): IJsonLdNodeObject {\n\t\tconst result = ObjectHelper.clone<IJsonLdNodeObject>(object);\n\n\t\t// This step is needed before compaction as 'dcterms:format' is not defined originally as '@vocab'\n\t\t// but it is in the DSP LD Context\n\t\tconst EXTRA_ANNOTATION = {\n\t\t\t\"dcterms:format\": {\n\t\t\t\t\"@id\": \"dcterms:format\",\n\t\t\t\t\"@type\": \"@vocab\"\n\t\t\t}\n\t\t};\n\t\tconst ldContext = ObjectHelper.propertyGet<IJsonLdContextDefinitionRoot>(result, \"@context\");\n\t\tif (Is.array(ldContext)) {\n\t\t\tldContext.push(EXTRA_ANNOTATION);\n\t\t} else if (Is.object(ldContext)) {\n\t\t\tObjectHelper.propertySet(result, \"@context\", { ...ldContext, ...EXTRA_ANNOTATION });\n\t\t} else if (Is.string(ldContext)) {\n\t\t\tObjectHelper.propertySet(result, \"@context\", [ldContext, EXTRA_ANNOTATION]);\n\t\t}\n\n\t\treturn result;\n\t}\n}\n"]}

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,14 +1,38 @@
+export * from "./models/dataspaceProtocolContexts.js";
+export * from "./models/dataspaceProtocolContextType.js";
+export * from "./dataTypes/dataspaceProtocolDataTypes.js";
+export * from "./models/catalog/dataspaceProtocolCatalogTypes.js";
+export * from "./models/catalog/IDataspaceProtocolCatalogError.js";
+export * from "./models/catalog/IDataspaceProtocolCatalogRequestMessage.js";
+export * from "./models/catalog/IDataspaceProtocolDatasetRequestMessage.js";
+export * from "./models/catalog/IDataspaceProtocolDataset.js";
+export * from "./models/catalog/IDataspaceProtocolCatalog.js";
+export * from "./models/catalog/IDataspaceProtocolDistribution.js";
+export * from "./models/catalog/IDataspaceProtocolDataService.js";
+export * from "./dataTypes/catalogDataTypes.js";
+export * from "./models/contractNegotiation/dataspaceProtocolContractNegotiationTypes.js";
+export * from "./models/contractNegotiation/IDataspaceProtocolContractAgreementMessage.js";
+export * from "./models/contractNegotiation/IDataspaceProtocolContractAgreementVerificationMessage.js";
+export * from "./models/contractNegotiation/IDataspaceProtocolContractNegotiation.js";
+export * from "./models/contractNegotiation/IDataspaceProtocolContractNegotiationError.js";
+export * from "./models/contractNegotiation/IDataspaceProtocolContractNegotiationEventMessage.js";
+export * from "./models/contractNegotiation/IDataspaceProtocolContractNegotiationTerminationMessage.js";
+export * from "./models/contractNegotiation/IDataspaceProtocolContractOfferMessage.js";
+export * from "./models/contractNegotiation/IDataspaceProtocolContractRequestMessage.js";
+export * from "./models/contractNegotiation/types/dataspaceProtocolContractNegotiationEventType.js";
+export * from "./models/contractNegotiation/types/dataspaceProtocolContractNegotiationStateType.js";
 export * from "./dataTypes/contractNegotiationDataTypes.js";
-export * from "./models/contractNegotiation/contractNegotiationContexts.js";
-export * from "./models/contractNegotiation/contractNegotiationContextType.js";
-export * from "./models/contractNegotiation/contractNegotiationTypes.js";
-export * from "./models/contractNegotiation/IContractAgreementMessage.js";
-export * from "./models/contractNegotiation/IContractAgreementVerificationMessage.js";
-export * from "./models/contractNegotiation/IContractNegotiation.js";
-export * from "./models/contractNegotiation/IContractNegotiationError.js";
-export * from "./models/contractNegotiation/IContractNegotiationEventMessage.js";
-export * from "./models/contractNegotiation/IContractNegotiationTerminationMessage.js";
-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 "./models/transferProcess/dataspaceProtocolTransferProcessTypes.js";
+export * from "./models/transferProcess/IDataspaceProtocolDataAddress.js";
+export * from "./models/transferProcess/IDataspaceProtocolEndpointProperty.js";
+export * from "./models/transferProcess/IDataspaceProtocolTransferCompletionMessage.js";
+export * from "./models/transferProcess/IDataspaceProtocolTransferError.js";
+export * from "./models/transferProcess/IDataspaceProtocolTransferProcess.js";
+export * from "./models/transferProcess/IDataspaceProtocolTransferRequestMessage.js";
+export * from "./models/transferProcess/IDataspaceProtocolTransferStartMessage.js";
+export * from "./models/transferProcess/IDataspaceProtocolTransferSuspensionMessage.js";
+export * from "./models/transferProcess/IDataspaceProtocolTransferTerminationMessage.js";
+export * from "./models/transferProcess/types/dataspaceProtocolTransferProcessStateType.js";
+export * from "./models/transferProcess/types/dataspaceProtocolEndpointType.js";
+export * from "./dataTypes/transferProcessDataTypes.js";
+export * from "./utils/dataspaceProtocolHelper.js";

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

@@ -0,0 +1,63 @@
+import type { ObjectOrArray } from "@twin.org/core";
+import type { IDcatCatalog } from "@twin.org/standards-w3c-dcat";
+import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
+import type { DataspaceProtocolCatalogTypes } from "./dataspaceProtocolCatalogTypes.js";
+import type { IDataspaceProtocolDataService } from "./IDataspaceProtocolDataService.js";
+import type { IDataspaceProtocolDataset } from "./IDataspaceProtocolDataset.js";
+import type { IDataspaceProtocolDistribution } from "./IDataspaceProtocolDistribution.js";
+/**
+ * Catalog interface compliant with Eclipse Data Space Protocol.
+ *
+ * This interface extends ICatalog  and enforces DS Protocol-specific requirements
+ * by overriding properties with more specific types and constraints.
+ *
+ * **Requirements per DS Protocol:**
+ * - `@id` MUST be present for dataset identification (REQUIRED)
+ * - participantId MUST be present (REQUIRED)
+ *
+ * **Type System Design:**
+ * - Interface extension allows TypeScript to override inherited property types
+ * - Standards packages (@twin.org/standards-w3c-*) follow W3C specs exactly
+ * - DS Protocol-specific constraints are defined here
+ *
+ *
+ * @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
+ * @see https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
+ *
+ */
+export interface IDataspaceProtocolCatalog extends Omit<IDcatCatalog, "@type" | "@context" | "dcat:catalog" | "dcat:dataset" | "dcat:distribution" | "dcat:service"> {
+    /**
+     * LD Context. Required per Eclipse Data Space Protocol.
+     */
+    "@context": DataspaceProtocolContextType;
+    /**
+     * The type identifier for the Catalog.
+     * REQUIRED per Eclipse Data Space Protocol.
+     */
+    "@type": typeof DataspaceProtocolCatalogTypes.Catalog;
+    /**
+     * Unique identifier for the dataset.
+     * REQUIRED per Eclipse Data Space Protocol.
+     */
+    "@id": string;
+    /**
+     * Participant Id
+     */
+    participantId: string;
+    /**
+     * Other concerned catalogs
+     */
+    catalog?: ObjectOrArray<Omit<IDataspaceProtocolCatalog, "@context">>;
+    /**
+     * Datasets registered
+     */
+    dataset?: ObjectOrArray<Omit<IDataspaceProtocolDataset, "@context">>;
+    /**
+     * Catalog's distributions
+     */
+    distribution?: ObjectOrArray<Omit<IDataspaceProtocolDistribution, "@context">>;
+    /**
+     * Data services registered-
+     */
+    service?: ObjectOrArray<Omit<IDataspaceProtocolDataService, "@context">>;
+}

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

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

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

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

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

@@ -0,0 +1,49 @@
+import type { ObjectOrArray } from "@twin.org/core";
+import type { IDcatDataService } from "@twin.org/standards-w3c-dcat";
+import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
+import type { DataspaceProtocolCatalogTypes } from "./dataspaceProtocolCatalogTypes.js";
+import type { IDataspaceProtocolDataset } from "./IDataspaceProtocolDataset.js";
+/**
+ * Data Service interface compliant with Eclipse Data Space Protocol.
+ *
+ * This interface extends IDataService  and enforces DS Protocol-specific requirements
+ * by overriding properties with more specific types and constraints.
+ *
+ * **Requirements per DS Protocol:**
+ * - `@id` MUST be present for dataset identification (REQUIRED)
+ * - endpointURL MUST be present (REQUIRED)
+ *
+ * **Type System Design:**
+ * - Interface extension allows TypeScript to override inherited property types
+ * - Standards packages (@twin.org/standards-w3c-*) follow W3C specs exactly
+ * - DS Protocol-specific constraints are defined here
+ *
+ *
+ * @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
+ * @see https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
+ *
+ */
+export interface IDataspaceProtocolDataService extends Omit<IDcatDataService, "@type" | "@context" | "dcat:servesDataset" | "dcat:endpointURL"> {
+    /**
+     * LD Context. Required per Eclipse Data Space Protocol.
+     */
+    "@context": DataspaceProtocolContextType;
+    /**
+     * The type identifier for the Data Service.
+     * REQUIRED per Eclipse Data Space Protocol.
+     */
+    "@type": typeof DataspaceProtocolCatalogTypes.DataService;
+    /**
+     * Unique identifier for the dataset.
+     * REQUIRED per Eclipse Data Space Protocol.
+     */
+    "@id": string;
+    /**
+     * Endpoint URL
+     */
+    endpointURL: string;
+    /**
+     * Datasets served.
+     */
+    servesDataset?: ObjectOrArray<Omit<IDataspaceProtocolDataset, "@context">>;
+}

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

@@ -0,0 +1,66 @@
+import type { ObjectOrArray } from "@twin.org/core";
+import type { IDcatDataset } from "@twin.org/standards-w3c-dcat";
+import type { IOdrlOffer } from "@twin.org/standards-w3c-odrl";
+import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
+import type { DataspaceProtocolCatalogTypes } from "./dataspaceProtocolCatalogTypes.js";
+import type { IDataspaceProtocolDistribution } from "./IDataspaceProtocolDistribution.js";
+/**
+ * Dataset interface compliant with Eclipse Data Space Protocol.
+ *
+ * This interface extends IDataset and enforces DS Protocol-specific requirements
+ * by overriding properties with more specific types and constraints.
+ *
+ * **Requirements per DS Protocol:**
+ * - `@id` MUST be present for dataset identification (REQUIRED)
+ * - `odrl:hasPolicy` MUST be present as an array of ODRL Offers (REQUIRED)
+ * - Array MUST contain at least one IOdrlOffer
+ * - Each Offer MUST have `@type`: "Offer"
+ * - Each Offer MUST have `@id` or `uid` for identification
+ * - `dcat:distribution` MUST be present (REQUIRED)
+ *
+ * **Type System Design:**
+ * - W3C DCAT spec defines `odrl:hasPolicy` as optional singular `IOdrlPolicy`
+ * - DS Protocol requires it as a REQUIRED array of `IOdrlOffer`
+ * - Interface extension allows TypeScript to override inherited property types
+ * - Standards packages (@twin.org/standards-w3c-*) follow W3C specs exactly
+ * - DS Protocol-specific constraints are defined here
+ *
+ * **Future Compatibility:**
+ * - Currently only one Offer per dataset is supported
+ * - Array structure allows future support for multiple offers
+ *
+ * @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
+ * @see https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
+ * @see IOdrlOffer from @twin.org/standards-w3c-odrl
+ * @see IResource.odrl:hasPolicy from @twin.org/standards-w3c-dcat
+ */
+export interface IDataspaceProtocolDataset extends Omit<IDcatDataset, "odrl:hasPolicy" | "dcat:distribution" | "@type" | "@context"> {
+    /**
+     * LD Context. Required per Eclipse Data Space Protocol.
+     */
+    "@context": DataspaceProtocolContextType;
+    /**
+     * The type identifier for the dataset.
+     * REQUIRED per Eclipse Data Space Protocol.
+     */
+    "@type": typeof DataspaceProtocolCatalogTypes.Dataset;
+    /**
+     * Unique identifier for the dataset.
+     * REQUIRED per Eclipse Data Space Protocol.
+     */
+    "@id": string;
+    /**
+     * Array of ODRL policies (Offers) as required by DS Protocol.
+     *
+     * REQUIRED per Eclipse Data Space Protocol spec.
+     * Must contain at least one IOdrlOffer.
+     * Currently only single offer is supported, but array structure
+     * allows for future multi-offer support.
+     */
+    hasPolicy: ObjectOrArray<Omit<IOdrlOffer, "@context">>;
+    /**
+     * Distribution of the dataset.
+     * REQUIRED per Eclipse Data Space Protocol.
+     */
+    distribution: ObjectOrArray<Omit<IDataspaceProtocolDistribution, "@context">>;
+}

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

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

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

@@ -0,0 +1,70 @@
+import type { ObjectOrArray } from "@twin.org/core";
+import type { IDcatDistribution } from "@twin.org/standards-w3c-dcat";
+import type { IOdrlOffer } from "@twin.org/standards-w3c-odrl";
+import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
+import type { DataspaceProtocolCatalogTypes } from "./dataspaceProtocolCatalogTypes.js";
+import type { IDataspaceProtocolDataService } from "./IDataspaceProtocolDataService.js";
+/**
+ * Distribution interface compliant with Eclipse Data Space Protocol.
+ *
+ * This interface extends IDistribution  and enforces DS Protocol-specific requirements
+ * by overriding properties with more specific types and constraints.
+ *
+ * **Requirements per DS Protocol:**
+ * - `@id` MUST be present for dataset identification (REQUIRED)
+ * - `odrl:hasPolicy` MIGHT be present as an array of ODRL Offers (OPTIONAL)
+ * - Array MUST contain at least one IOdrlOffer
+ * - Each Offer MUST have `@type`: "Offer"
+ * - `format` is REQUIRED.
+ *
+ * **Type System Design:**
+ * - W3C DCAT spec defines `odrl:hasPolicy` as optional singular `IOdrlPolicy`
+ * - DS Protocol requires it as a REQUIRED array of `IOdrlOffer`
+ * - Interface extension allows TypeScript to override inherited property types
+ * - Standards packages (@twin.org/standards-w3c-*) follow W3C specs exactly
+ * - DS Protocol-specific constraints are defined here
+ *
+ * **Future Compatibility:**
+ * - Currently only one Offer per dataset is supported
+ * - Array structure allows future support for multiple offers
+ *
+ * @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
+ * @see https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
+ * @see IOdrlOffer from @twin.org/standards-w3c-odrl
+ * @see IResource.odrl:hasPolicy from @twin.org/standards-w3c-dcat
+ */
+export interface IDataspaceProtocolDistribution extends Omit<IDcatDistribution, "odrl:hasPolicy" | "@type" | "@context" | "dcterms:format"> {
+    /**
+     * LD Context. Required per Eclipse Data Space Protocol.
+     */
+    "@context": DataspaceProtocolContextType;
+    /**
+     * The type identifier for the Distribution.
+     * REQUIRED per Eclipse Data Space Protocol.
+     */
+    "@type": typeof DataspaceProtocolCatalogTypes.Distribution;
+    /**
+     * Unique identifier for the dataset.
+     * REQUIRED per Eclipse Data Space Protocol.
+     */
+    "@id": string;
+    /**
+     * Array of ODRL policies (Offers) as required by DS Protocol.
+     *
+     * REQUIRED per Eclipse Data Space Protocol spec.
+     * Must contain at least one IOdrlOffer.
+     * Currently only single offer is supported, but array structure
+     * allows for future multi-offer support.
+     */
+    hasPolicy?: ObjectOrArray<Omit<IOdrlOffer, "@context">>;
+    /**
+     * Access service.
+     * It can be a URI pointing to an access service or inline the access service itself
+     */
+    accessService: string | Omit<IDataspaceProtocolDataService, "@context">;
+    /**
+     * Distribution format.
+     * REQUIRED per Eclipse Data Space Protocol.
+     */
+    format: string;
+}

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

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

package/dist/types/models/contractNegotiation/{IContractAgreementMessage.d.ts → IDataspaceProtocolContractAgreementMessage.d.ts}

@@ -1,19 +1,19 @@
 import type { IOdrlAgreement } from "@twin.org/standards-w3c-odrl";
-import type { ContractNegotiationContextType } from "./contractNegotiationContextType.js";
-import type { ContractNegotiationTypes } from "./contractNegotiationTypes.js";
+import type { DataspaceProtocolContractNegotiationTypes } from "./dataspaceProtocolContractNegotiationTypes.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
  */
-export interface IContractAgreementMessage {
+export interface IDataspaceProtocolContractAgreementMessage {
     /**
      * The JSON-LD context.
      */
-    "@context": ContractNegotiationContextType;
+    "@context": DataspaceProtocolContextType;
     /**
      * The type of the message.
      */
-    "@type": typeof ContractNegotiationTypes.ContractAgreementMessage;
+    "@type": typeof DataspaceProtocolContractNegotiationTypes.ContractAgreementMessage;
     /**
      * The provider id for the contract.
      */

package/dist/types/models/contractNegotiation/{IContractAgreementVerificationMessage.d.ts → IDataspaceProtocolContractAgreementVerificationMessage.d.ts}

@@ -1,18 +1,18 @@
-import type { ContractNegotiationContextType } from "./contractNegotiationContextType.js";
-import type { ContractNegotiationTypes } from "./contractNegotiationTypes.js";
+import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
+import type { DataspaceProtocolContractNegotiationTypes } from "./dataspaceProtocolContractNegotiationTypes.js";
 /**
  * Interface for Dataspace Protocol Contract Agreement Verification Messages.
  * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-agreement-verification-message
  */
-export interface IContractAgreementVerificationMessage {
+export interface IDataspaceProtocolContractAgreementVerificationMessage {
     /**
      * The JSON-LD context.
      */
-    "@context": ContractNegotiationContextType;
+    "@context": DataspaceProtocolContextType;
     /**
      * The type of the message.
      */
-    "@type": typeof ContractNegotiationTypes.ContractAgreementVerificationMessage;
+    "@type": typeof DataspaceProtocolContractNegotiationTypes.ContractAgreementVerificationMessage;
     /**
      * The provider id for the contract.
      */