@twin.org/standards-dataspace-protocol 0.0.3-next.1

package/dist/es/schemas/ContractRequestMessage.json

@@ -0,0 +1,81 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/ContractRequestMessage",
+    "description": "Interface for Dataspace Protocol Contract Request Messages. https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-request-message",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "description": "The Dataspace Protocol Contract Negotiation JSON-LD context type.",
+            "anyOf": [
+                {
+                    "type": "string",
+                    "const": "https://w3id.org/dspace/2024/1/context.json"
+                },
+                {
+                    "type": "array",
+                    "minItems": 2,
+                    "items": {
+                        "anyOf": [
+                            {
+                                "type": "string",
+                                "const": "https://w3id.org/dspace/2024/1/context.json"
+                            },
+                            {
+                                "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                            }
+                        ]
+                    },
+                    "additionalItems": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    }
+                },
+                {
+                    "type": "array",
+                    "minItems": 2,
+                    "items": {
+                        "anyOf": [
+                            {
+                                "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                            },
+                            {
+                                "type": "string",
+                                "const": "https://w3id.org/dspace/2024/1/context.json"
+                            }
+                        ]
+                    },
+                    "additionalItems": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    }
+                }
+            ]
+        },
+        "@type": {
+            "type": "string",
+            "const": "ContractRequestMessage",
+            "description": "The type of the message."
+        },
+        "providerPid": {
+            "type": "string",
+            "description": "The provider id for the contract."
+        },
+        "consumerPid": {
+            "type": "string",
+            "description": "The consumer id for the contract."
+        },
+        "offer": {
+            "$ref": "https://schema.twindev.org/dataspace-protocol/OdrlOffer",
+            "description": "The offer being requested."
+        },
+        "callbackAddress": {
+            "type": "string",
+            "description": "The base callback address for the provider to update the consumer on the state of the negotiation."
+        }
+    },
+    "required": [
+        "@context",
+        "@type",
+        "consumerPid",
+        "offer"
+    ],
+    "additionalProperties": false
+}

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

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

package/dist/types/index.d.ts

@@ -0,0 +1,14 @@
+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";

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

@@ -0,0 +1,33 @@
+import type { IOdrlAgreement } from "@twin.org/standards-w3c-odrl";
+import type { ContractNegotiationContextType } from "./contractNegotiationContextType.js";
+import type { ContractNegotiationTypes } from "./contractNegotiationTypes.js";
+/**
+ * Interface for Dataspace Protocol Contract Agreement Messages.
+ * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-agreement-message
+ */
+export interface IContractAgreementMessage {
+    /**
+     * The JSON-LD context.
+     */
+    "@context": ContractNegotiationContextType;
+    /**
+     * The type of the message.
+     */
+    "@type": typeof ContractNegotiationTypes.ContractAgreementMessage;
+    /**
+     * The provider id for the contract.
+     */
+    providerPid: string;
+    /**
+     * The consumer id for the contract.
+     */
+    consumerPid: string;
+    /**
+     * The agreement being sent.
+     */
+    agreement: IOdrlAgreement;
+    /**
+     * The base callback address for the provider to update the consumer on the state of the negotiation.
+     */
+    callbackAddress?: string;
+}

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

@@ -0,0 +1,24 @@
+import type { ContractNegotiationContextType } from "./contractNegotiationContextType.js";
+import type { ContractNegotiationTypes } from "./contractNegotiationTypes.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 {
+    /**
+     * The JSON-LD context.
+     */
+    "@context": ContractNegotiationContextType;
+    /**
+     * The type of the message.
+     */
+    "@type": typeof ContractNegotiationTypes.ContractAgreementVerificationMessage;
+    /**
+     * The provider id for the contract.
+     */
+    providerPid: string;
+    /**
+     * The consumer id for the contract.
+     */
+    consumerPid: string;
+}

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

@@ -0,0 +1,29 @@
+import type { ContractNegotiationContextType } from "./contractNegotiationContextType.js";
+import type { ContractNegotiationTypes } from "./contractNegotiationTypes.js";
+import type { ContractNegotiationStateType } from "./types/contractNegotiationStateType.js";
+/**
+ * Interface for Dataspace Protocol Contract Agreement Messages.
+ * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#ack-contract-negotiation
+ */
+export interface IContractNegotiation {
+    /**
+     * The JSON-LD context.
+     */
+    "@context": ContractNegotiationContextType;
+    /**
+     * The type of the message.
+     */
+    "@type": typeof ContractNegotiationTypes.ContractNegotiation;
+    /**
+     * The provider id for the contract.
+     */
+    providerPid: string;
+    /**
+     * The consumer id for the contract.
+     */
+    consumerPid: string;
+    /**
+     * The offer being requested.
+     */
+    state: ContractNegotiationStateType;
+}

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

@@ -0,0 +1,42 @@
+import type { ContractNegotiationContextType } from "./contractNegotiationContextType.js";
+import type { ContractNegotiationTypes } from "./contractNegotiationTypes.js";
+/**
+ * Interface for Dataspace Protocol Contract Negotiation Error Messages.
+ * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#error-contract-negotiation-error
+ */
+export interface IContractNegotiationError {
+    /**
+     * The JSON-LD context.
+     */
+    "@context": ContractNegotiationContextType;
+    /**
+     * The type of the message.
+     */
+    "@type": typeof ContractNegotiationTypes.ContractNegotiationError;
+    /**
+     * The provider id for the contract.
+     */
+    providerPid: string;
+    /**
+     * The consumer id for the contract.
+     */
+    consumerPid: string;
+    /**
+     * The error code.
+     */
+    code?: string;
+    /**
+     * The error reason(s).
+     */
+    reason?: {
+        "@value": string;
+        "@language"?: string;
+    }[];
+    /**
+     * The error description(s).
+     */
+    description?: {
+        "@value": string;
+        "@language"?: string;
+    }[];
+}

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

@@ -0,0 +1,29 @@
+import type { ContractNegotiationContextType } from "./contractNegotiationContextType.js";
+import type { ContractNegotiationTypes } from "./contractNegotiationTypes.js";
+import type { ContractNegotiationEventType } from "./types/contractNegotiationEventType.js";
+/**
+ * Interface for Dataspace Protocol Contract Negotiation Event Messages.
+ * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-negotiation-event-message
+ */
+export interface IContractNegotiationEventMessage {
+    /**
+     * The JSON-LD context.
+     */
+    "@context": ContractNegotiationContextType;
+    /**
+     * The type of the message.
+     */
+    "@type": typeof ContractNegotiationTypes.ContractNegotiationEventMessage;
+    /**
+     * The provider id for the contract.
+     */
+    providerPid: string;
+    /**
+     * The consumer id for the contract.
+     */
+    consumerPid: string;
+    /**
+     * The event type.
+     */
+    event: ContractNegotiationEventType;
+}

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

@@ -0,0 +1,32 @@
+import type { ContractNegotiationContextType } from "./contractNegotiationContextType.js";
+import type { ContractNegotiationTypes } from "./contractNegotiationTypes.js";
+/**
+ * Interface for Dataspace Protocol Contract Negotiation Termination Messages.
+ * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-negotiation-termination-message
+ */
+export interface IContractNegotiationTerminationMessage {
+    /**
+     * The JSON-LD context.
+     */
+    "@context": ContractNegotiationContextType;
+    /**
+     * The type of the message.
+     */
+    "@type": typeof ContractNegotiationTypes.ContractNegotiationTerminationMessage;
+    /**
+     * The provider id for the contract.
+     */
+    providerPid: string;
+    /**
+     * The consumer id for the contract.
+     */
+    consumerPid: string;
+    /**
+     * The termination code.
+     */
+    code?: string;
+    /**
+     * The termination reason(s).
+     */
+    reason?: any[];
+}

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

@@ -0,0 +1,33 @@
+import type { IOdrlOffer } from "@twin.org/standards-w3c-odrl";
+import type { ContractNegotiationContextType } from "./contractNegotiationContextType.js";
+import type { ContractNegotiationTypes } from "./contractNegotiationTypes.js";
+/**
+ * Interface for Dataspace Protocol Contract Offer Messages.
+ * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-offer-message
+ */
+export interface IContractOfferMessage {
+    /**
+     * The JSON-LD context.
+     */
+    "@context": ContractNegotiationContextType;
+    /**
+     * The type of the message.
+     */
+    "@type": typeof ContractNegotiationTypes.ContractOfferMessage;
+    /**
+     * The provider id for the contract.
+     */
+    providerPid: string;
+    /**
+     * The consumer id for the contract.
+     */
+    consumerPid?: string;
+    /**
+     * The offer being requested.
+     */
+    offer: IOdrlOffer;
+    /**
+     * The base callback address for the provider to update the consumer on the state of the negotiation.
+     */
+    callbackAddress?: string;
+}

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

@@ -0,0 +1,33 @@
+import type { IOdrlOffer } from "@twin.org/standards-w3c-odrl";
+import type { ContractNegotiationContextType } from "./contractNegotiationContextType.js";
+import type { ContractNegotiationTypes } from "./contractNegotiationTypes.js";
+/**
+ * Interface for Dataspace Protocol Contract Request Messages.
+ * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-request-message
+ */
+export interface IContractRequestMessage {
+    /**
+     * The JSON-LD context.
+     */
+    "@context": ContractNegotiationContextType;
+    /**
+     * The type of the message.
+     */
+    "@type": typeof ContractNegotiationTypes.ContractRequestMessage;
+    /**
+     * The provider id for the contract.
+     */
+    providerPid?: string;
+    /**
+     * The consumer id for the contract.
+     */
+    consumerPid: string;
+    /**
+     * The offer being requested.
+     */
+    offer: IOdrlOffer;
+    /**
+     * The base callback address for the provider to update the consumer on the state of the negotiation.
+     */
+    callbackAddress?: string;
+}

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

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

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

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

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

@@ -0,0 +1,50 @@
+/**
+ * The types for Dataspace Protocol Contract Negotiation.
+ * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#message-types-0
+ */
+export declare const ContractNegotiationTypes: {
+    /**
+     * Contract Negotiation.
+     */
+    ContractNegotiation: string;
+    /**
+     * Contract Request Message.
+     */
+    ContractRequestMessage: string;
+    /**
+     * Contract Offer Message.
+     */
+    ContractOfferMessage: string;
+    /**
+     * Contract Agreement Message.
+     */
+    ContractAgreementMessage: string;
+    /**
+     * Contract Agreement Verification Message.
+     */
+    ContractAgreementVerificationMessage: string;
+    /**
+     * Contract Negotiation Event Message.
+     */
+    ContractNegotiationEventMessage: string;
+    /**
+     * Contract Negotiation Termination Message.
+     */
+    ContractNegotiationTerminationMessage: string;
+    /**
+     * Contract Negotiation Error.
+     */
+    ContractNegotiationError: string;
+    /**
+     * Contract Negotiation Event Type.
+     */
+    ContractNegotiationEventType: string;
+    /**
+     * Contract Negotiation State Type.
+     */
+    ContractNegotiationStateType: string;
+};
+/**
+ * The types for Dataspace Protocol Contract Negotiation.
+ */
+export type ContractNegotiationTypes = (typeof ContractNegotiationTypes)[keyof typeof ContractNegotiationTypes];

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

@@ -0,0 +1,18 @@
+/**
+ * The types for Dataspace Protocol Contract Negotiation Events.
+ * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-negotiation-event-message
+ */
+export declare const ContractNegotiationEventType: {
+    /**
+     * Accepted.
+     */
+    readonly ACCEPTED: "ACCEPTED";
+    /**
+     * Finalized.
+     */
+    readonly FINALIZED: "FINALIZED";
+};
+/**
+ * The types for Dataspace Protocol Contract Negotiation Events.
+ */
+export type ContractNegotiationEventType = (typeof ContractNegotiationEventType)[keyof typeof ContractNegotiationEventType];

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

@@ -0,0 +1,38 @@
+/**
+ * The types for Dataspace Protocol Contract Negotiation States.
+ * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-negotiation-states
+ */
+export declare const ContractNegotiationStateType: {
+    /**
+     * Requested.
+     */
+    readonly REQUESTED: "REQUESTED";
+    /**
+     * Offered.
+     */
+    readonly OFFERED: "OFFERED";
+    /**
+     * Accepted.
+     */
+    readonly ACCEPTED: "ACCEPTED";
+    /**
+     * Agreed.
+     */
+    readonly AGREED: "AGREED";
+    /**
+     * Verified.
+     */
+    readonly VERIFIED: "VERIFIED";
+    /**
+     * Finalized.
+     */
+    readonly FINALIZED: "FINALIZED";
+    /**
+     * Terminated.
+     */
+    readonly TERMINATED: "TERMINATED";
+};
+/**
+ * The types for Dataspace Protocol Contract Negotiation States.
+ */
+export type ContractNegotiationStateType = (typeof ContractNegotiationStateType)[keyof typeof ContractNegotiationStateType];

package/docs/changelog.md

@@ -0,0 +1,17 @@
+# Changelog
+
+## [0.0.3-next.1](https://github.com/twinfoundation/standards/compare/standards-dataspace-protocol-v0.0.3-next.0...standards-dataspace-protocol-v0.0.3-next.1) (2025-11-10)
+
+
+### Features
+
+* add context id features ([#64](https://github.com/twinfoundation/standards/issues/64)) ([e68bb87](https://github.com/twinfoundation/standards/commit/e68bb87a215f3c3956cfd6400a5e1e2a16256085))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/standards-w3c-odrl bumped from 0.0.3-next.0 to 0.0.3-next.1
+
+## Changelog

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/standards-dataspace-protocol - Examples

package/docs/reference/classes/ContractNegotiationDataTypes.md

@@ -0,0 +1,37 @@
+# Class: ContractNegotiationDataTypes
+
+Handle all the data types for Dataspace Protocol Contract Negotiation.
+
+## Constructors
+
+### Constructor
+
+> **new ContractNegotiationDataTypes**(): `ContractNegotiationDataTypes`
+
+#### Returns
+
+`ContractNegotiationDataTypes`
+
+## Methods
+
+### registerRedirects()
+
+> `static` **registerRedirects**(): `void`
+
+Register the JSON-LD Redirects.
+
+#### Returns
+
+`void`
+
+***
+
+### registerTypes()
+
+> `static` **registerTypes**(): `void`
+
+Register all the data types.
+
+#### Returns
+
+`void`

package/docs/reference/index.md

@@ -0,0 +1,31 @@
+# @twin.org/standards-dataspace-protocol
+
+## Classes
+
+- [ContractNegotiationDataTypes](classes/ContractNegotiationDataTypes.md)
+
+## Interfaces
+
+- [IContractAgreementMessage](interfaces/IContractAgreementMessage.md)
+- [IContractAgreementVerificationMessage](interfaces/IContractAgreementVerificationMessage.md)
+- [IContractNegotiation](interfaces/IContractNegotiation.md)
+- [IContractNegotiationError](interfaces/IContractNegotiationError.md)
+- [IContractNegotiationEventMessage](interfaces/IContractNegotiationEventMessage.md)
+- [IContractNegotiationTerminationMessage](interfaces/IContractNegotiationTerminationMessage.md)
+- [IContractOfferMessage](interfaces/IContractOfferMessage.md)
+- [IContractRequestMessage](interfaces/IContractRequestMessage.md)
+
+## Type Aliases
+
+- [ContractNegotiationContextType](type-aliases/ContractNegotiationContextType.md)
+- [ContractNegotiationContexts](type-aliases/ContractNegotiationContexts.md)
+- [ContractNegotiationTypes](type-aliases/ContractNegotiationTypes.md)
+- [ContractNegotiationEventType](type-aliases/ContractNegotiationEventType.md)
+- [ContractNegotiationStateType](type-aliases/ContractNegotiationStateType.md)
+
+## Variables
+
+- [ContractNegotiationContexts](variables/ContractNegotiationContexts.md)
+- [ContractNegotiationTypes](variables/ContractNegotiationTypes.md)
+- [ContractNegotiationEventType](variables/ContractNegotiationEventType.md)
+- [ContractNegotiationStateType](variables/ContractNegotiationStateType.md)

package/docs/reference/interfaces/IContractAgreementMessage.md

@@ -0,0 +1,52 @@
+# Interface: IContractAgreementMessage
+
+Interface for Dataspace Protocol Contract Agreement Messages.
+https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-agreement-message
+
+## Properties
+
+### @context
+
+> **@context**: [`ContractNegotiationContextType`](../type-aliases/ContractNegotiationContextType.md)
+
+The JSON-LD context.
+
+***
+
+### @type
+
+> **@type**: `string`
+
+The type of the message.
+
+***
+
+### providerPid
+
+> **providerPid**: `string`
+
+The provider id for the contract.
+
+***
+
+### consumerPid
+
+> **consumerPid**: `string`
+
+The consumer id for the contract.
+
+***
+
+### agreement
+
+> **agreement**: `IOdrlAgreement`
+
+The agreement being sent.
+
+***
+
+### callbackAddress?
+
+> `optional` **callbackAddress**: `string`
+
+The base callback address for the provider to update the consumer on the state of the negotiation.