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

package/docs/examples.md

@@ -1 +1,46 @@
-# @twin.org/standards-dataspace-protocol - Examples
+# Standards Dataspace Protocol Examples
+
+These snippets show how to prepare payloads for conformance checks and register protocol data types for processing flows.
+
+## DataspaceProtocolHelper
+
+```typescript
+import type { IValidationFailure } from '@twin.org/core';
+import type { IJsonLdNodeObject } from '@twin.org/data-json-ld';
+import {
+  DataspaceProtocolHelper,
+  DataspaceProtocolTransferProcessTypes
+} from '@twin.org/standards-dataspace-protocol';
+
+const payload: IJsonLdNodeObject = {
+  '@context': 'https://w3id.org/dspace/2025/1/context.json',
+  '@type': DataspaceProtocolTransferProcessTypes.TransferProcess,
+  state: 'STARTED'
+};
+
+const failures: IValidationFailure[] = [];
+const normalised = await DataspaceProtocolHelper.normalize(payload);
+const isConformant = await DataspaceProtocolHelper.checkConformance(normalised, failures);
+
+console.log(isConformant); // true
+console.log(failures.length); // 0
+```
+
+## Data Types
+
+```typescript
+import {
+  CatalogDataTypes,
+  ContractNegotiationDataTypes,
+  DataspaceProtocolDataTypes,
+  TransferProcessDataTypes
+} from '@twin.org/standards-dataspace-protocol';
+
+DataspaceProtocolDataTypes.registerRedirects();
+DataspaceProtocolDataTypes.registerTypes();
+CatalogDataTypes.registerTypes();
+ContractNegotiationDataTypes.registerTypes();
+TransferProcessDataTypes.registerTypes();
+
+console.log(typeof DataspaceProtocolDataTypes.registerTypes === 'function'); // true
+```

package/docs/reference/classes/DataspaceProtocolHelper.md

@@ -0,0 +1,63 @@
+# Abstract Class: DataspaceProtocolHelper
+
+Dataspace protocol helper.
+
+## Constructors
+
+### Constructor
+
+> **new DataspaceProtocolHelper**(): `DataspaceProtocolHelper`
+
+#### Returns
+
+`DataspaceProtocolHelper`
+
+## Methods
+
+### checkConformance()
+
+> `static` **checkConformance**(`object`, `validationFailures`): `Promise`\<`boolean`\>
+
+Checks whether the object passed as parameter is conformant to the DS Protocol definitions.
+
+#### Parameters
+
+##### object
+
+`IJsonLdNodeObject`
+
+The object to check
+
+##### validationFailures
+
+`IValidationFailure`[]
+
+the Validation failures obtained during the conformance checking.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+true or false depending whether the object is conformant or not
+
+***
+
+### normalize()
+
+> `static` **normalize**(`object`): `Promise`\<`IJsonLdNodeObject`\>
+
+Normalizes the input object making it compliant with the DS Protocol specifications.
+
+#### Parameters
+
+##### object
+
+`IJsonLdNodeObject`
+
+The input object.
+
+#### Returns
+
+`Promise`\<`IJsonLdNodeObject`\>
+
+The input object normalized.

package/docs/reference/index.md

@@ -6,47 +6,66 @@
 - [ContractNegotiationDataTypes](classes/ContractNegotiationDataTypes.md)
 - [DataspaceProtocolDataTypes](classes/DataspaceProtocolDataTypes.md)
 - [TransferProcessDataTypes](classes/TransferProcessDataTypes.md)
+- [DataspaceProtocolHelper](classes/DataspaceProtocolHelper.md)
 
 ## Interfaces
 
-- [ICatalogError](interfaces/ICatalogError.md)
-- [ICatalogRequestMessage](interfaces/ICatalogRequestMessage.md)
-- [IDatasetRequestMessage](interfaces/IDatasetRequestMessage.md)
-- [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)
-- [IDataAddress](interfaces/IDataAddress.md)
-- [IEndpointProperty](interfaces/IEndpointProperty.md)
-- [ITransferCompletionMessage](interfaces/ITransferCompletionMessage.md)
-- [ITransferError](interfaces/ITransferError.md)
-- [ITransferProcess](interfaces/ITransferProcess.md)
-- [ITransferRequestMessage](interfaces/ITransferRequestMessage.md)
-- [ITransferStartMessage](interfaces/ITransferStartMessage.md)
-- [ITransferSuspensionMessage](interfaces/ITransferSuspensionMessage.md)
-- [ITransferTerminationMessage](interfaces/ITransferTerminationMessage.md)
+- [IDataspaceProtocolCatalogError](interfaces/IDataspaceProtocolCatalogError.md)
+- [IDataspaceProtocolCatalogRequestMessage](interfaces/IDataspaceProtocolCatalogRequestMessage.md)
+- [IDataspaceProtocolDatasetRequestMessage](interfaces/IDataspaceProtocolDatasetRequestMessage.md)
+- [IDataspaceProtocolContractAgreementMessage](interfaces/IDataspaceProtocolContractAgreementMessage.md)
+- [IDataspaceProtocolContractAgreementVerificationMessage](interfaces/IDataspaceProtocolContractAgreementVerificationMessage.md)
+- [IDataspaceProtocolContractNegotiation](interfaces/IDataspaceProtocolContractNegotiation.md)
+- [IDataspaceProtocolContractNegotiationError](interfaces/IDataspaceProtocolContractNegotiationError.md)
+- [IDataspaceProtocolContractNegotiationEventMessage](interfaces/IDataspaceProtocolContractNegotiationEventMessage.md)
+- [IDataspaceProtocolContractNegotiationTerminationMessage](interfaces/IDataspaceProtocolContractNegotiationTerminationMessage.md)
+- [IDataspaceProtocolContractOfferMessage](interfaces/IDataspaceProtocolContractOfferMessage.md)
+- [IDataspaceProtocolContractRequestMessage](interfaces/IDataspaceProtocolContractRequestMessage.md)
+- [IDataspaceProtocolCatalog](interfaces/IDataspaceProtocolCatalog.md)
+- [IDataspaceProtocolDataService](interfaces/IDataspaceProtocolDataService.md)
+- [IDataspaceProtocolDataset](interfaces/IDataspaceProtocolDataset.md)
+- [IDataspaceProtocolDistribution](interfaces/IDataspaceProtocolDistribution.md)
+- [IDataspaceProtocolAgreement](interfaces/IDataspaceProtocolAgreement.md)
+- [IDataspaceProtocolOffer](interfaces/IDataspaceProtocolOffer.md)
+- [IDataspaceProtocolPolicy](interfaces/IDataspaceProtocolPolicy.md)
+- [IDataspaceProtocolSet](interfaces/IDataspaceProtocolSet.md)
+- [IDataspaceProtocolDataAddress](interfaces/IDataspaceProtocolDataAddress.md)
+- [IDataspaceProtocolEndpointProperty](interfaces/IDataspaceProtocolEndpointProperty.md)
+- [IDataspaceProtocolTransferCompletionMessage](interfaces/IDataspaceProtocolTransferCompletionMessage.md)
+- [IDataspaceProtocolTransferError](interfaces/IDataspaceProtocolTransferError.md)
+- [IDataspaceProtocolTransferProcess](interfaces/IDataspaceProtocolTransferProcess.md)
+- [IDataspaceProtocolTransferRequestMessage](interfaces/IDataspaceProtocolTransferRequestMessage.md)
+- [IDataspaceProtocolTransferStartMessage](interfaces/IDataspaceProtocolTransferStartMessage.md)
+- [IDataspaceProtocolTransferSuspensionMessage](interfaces/IDataspaceProtocolTransferSuspensionMessage.md)
+- [IDataspaceProtocolTransferTerminationMessage](interfaces/IDataspaceProtocolTransferTerminationMessage.md)
 
 ## Type Aliases
 
-- [CatalogTypes](type-aliases/CatalogTypes.md)
-- [ContractNegotiationTypes](type-aliases/ContractNegotiationTypes.md)
-- [ContractNegotiationEventType](type-aliases/ContractNegotiationEventType.md)
-- [ContractNegotiationStateType](type-aliases/ContractNegotiationStateType.md)
+- [DataspaceProtocolCatalogTypes](type-aliases/DataspaceProtocolCatalogTypes.md)
+- [DataspaceProtocolContractNegotiationTypes](type-aliases/DataspaceProtocolContractNegotiationTypes.md)
+- [DataspaceProtocolContractNegotiationEventType](type-aliases/DataspaceProtocolContractNegotiationEventType.md)
+- [DataspaceProtocolContractNegotiationStateType](type-aliases/DataspaceProtocolContractNegotiationStateType.md)
 - [DataspaceProtocolContextType](type-aliases/DataspaceProtocolContextType.md)
 - [DataspaceProtocolContexts](type-aliases/DataspaceProtocolContexts.md)
-- [TransferProcessTypes](type-aliases/TransferProcessTypes.md)
-- [TransferProcessStateType](type-aliases/TransferProcessStateType.md)
+- [IDataspaceProtocolCatalogNoContext](type-aliases/IDataspaceProtocolCatalogNoContext.md)
+- [IDataspaceProtocolDataServiceNoContext](type-aliases/IDataspaceProtocolDataServiceNoContext.md)
+- [IDataspaceProtocolDatasetNoContext](type-aliases/IDataspaceProtocolDatasetNoContext.md)
+- [IDataspaceProtocolDistributionNoContext](type-aliases/IDataspaceProtocolDistributionNoContext.md)
+- [IDataspaceProtocolAgreementNoContext](type-aliases/IDataspaceProtocolAgreementNoContext.md)
+- [IDataspaceProtocolOfferNoContext](type-aliases/IDataspaceProtocolOfferNoContext.md)
+- [IDataspaceProtocolPolicyNoContext](type-aliases/IDataspaceProtocolPolicyNoContext.md)
+- [IDataspaceProtocolSetNoContext](type-aliases/IDataspaceProtocolSetNoContext.md)
+- [DataspaceProtocolTransferProcessTypes](type-aliases/DataspaceProtocolTransferProcessTypes.md)
+- [DataspaceProtocolEndpointType](type-aliases/DataspaceProtocolEndpointType.md)
+- [DataspaceProtocolTransferProcessStateType](type-aliases/DataspaceProtocolTransferProcessStateType.md)
 
 ## Variables
 
-- [CatalogTypes](variables/CatalogTypes.md)
-- [ContractNegotiationTypes](variables/ContractNegotiationTypes.md)
-- [ContractNegotiationEventType](variables/ContractNegotiationEventType.md)
-- [ContractNegotiationStateType](variables/ContractNegotiationStateType.md)
+- [DataspaceProtocolCatalogTypes](variables/DataspaceProtocolCatalogTypes.md)
+- [DataspaceProtocolContractNegotiationTypes](variables/DataspaceProtocolContractNegotiationTypes.md)
+- [DataspaceProtocolContractNegotiationEventType](variables/DataspaceProtocolContractNegotiationEventType.md)
+- [DataspaceProtocolContractNegotiationStateType](variables/DataspaceProtocolContractNegotiationStateType.md)
 - [DataspaceProtocolContexts](variables/DataspaceProtocolContexts.md)
-- [TransferProcessTypes](variables/TransferProcessTypes.md)
-- [TransferProcessStateType](variables/TransferProcessStateType.md)
+- [DataspaceProtocolTransferProcessTypes](variables/DataspaceProtocolTransferProcessTypes.md)
+- [DataspaceProtocolEndpointType](variables/DataspaceProtocolEndpointType.md)
+- [DataspaceProtocolTransferProcessStateType](variables/DataspaceProtocolTransferProcessStateType.md)

package/docs/reference/interfaces/IDataspaceProtocolAgreement.md

@@ -0,0 +1,179 @@
+# Interface: IDataspaceProtocolAgreement
+
+Agreement interface compliant with Eclipse Data Space Protocol.
+
+Extends IOdrlAgreement with DS Protocol-specific constraints:
+- `@id` is REQUIRED (used as the primary agreement identifier in DS Protocol)
+- `@context` is omitted (inherited from the parent Dataset/Distribution)
+
+## See
+
+ - https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
+ - IOdrlAgreement from @twin.org/standards-w3c-odrl
+
+## Extends
+
+- `Omit`\<`IOdrlAgreement`, `"uid"`\>
+
+## Properties
+
+### @id
+
+> **@id**: `string`
+
+Unique identifier for the agreement.
+
+***
+
+### @type
+
+> **@type**: `"Agreement"`
+
+The type must be "Agreement".
+
+#### Inherited from
+
+`Omit.@type`
+
+***
+
+### assigner
+
+> **assigner**: `string` \| `IOdrlParty`
+
+The assigner of the agreement.
+Required for Agreement policies.
+
+#### Inherited from
+
+`Omit.assigner`
+
+***
+
+### assignee
+
+> **assignee**: `string` \| `IOdrlParty`
+
+The assignee of the agreement.
+Required for Agreement policies.
+
+#### Inherited from
+
+`Omit.assignee`
+
+***
+
+### @context
+
+> **@context**: `OdrlContextType`
+
+The context for the policy.
+Must include "https://www.w3.org/ns/odrl.jsonld"
+
+#### Inherited from
+
+`Omit.@context`
+
+***
+
+### profile?
+
+> `optional` **profile**: `string` \| `string`[]
+
+The profile(s) this policy conforms to.
+IRIs identifying the ODRL Profile(s).
+
+#### Inherited from
+
+`Omit.profile`
+
+***
+
+### target?
+
+> `optional` **target**: `string` \| `IOdrlAsset` \| `IOdrlAssetCollection` \| (`string` \| `IOdrlAsset` \| `IOdrlAssetCollection`)[]
+
+The target asset for the rule.
+
+#### Inherited from
+
+`Omit.target`
+
+***
+
+### action?
+
+> `optional` **action**: `string` \| `IOdrlAction` \| (`string` \| `IOdrlAction`)[]
+
+The action associated with the rule.
+
+#### Inherited from
+
+`Omit.action`
+
+***
+
+### inheritFrom?
+
+> `optional` **inheritFrom**: `string` \| `string`[]
+
+The parent policy(ies) this policy inherits from.
+IRIs identifying the parent Policy(ies).
+
+#### Inherited from
+
+`Omit.inheritFrom`
+
+***
+
+### conflict?
+
+> `optional` **conflict**: `ConflictStrategyType`
+
+The conflict resolution strategy.
+- perm: Permissions override Prohibitions
+- prohibit: Prohibitions override Permissions
+- invalid: Policy is void if conflicts exist (default)
+
+#### Inherited from
+
+`Omit.conflict`
+
+***
+
+### permission?
+
+> `optional` **permission**: `IOdrlPermission` \| `IOdrlPermission`[]
+
+The permissions in the policy.
+At least one of permission, prohibition, or obligation must be present.
+
+#### Inherited from
+
+`Omit.permission`
+
+***
+
+### prohibition?
+
+> `optional` **prohibition**: `IOdrlProhibition` \| `IOdrlProhibition`[]
+
+The prohibitions in the policy.
+At least one of permission, prohibition, or obligation must be present.
+
+#### Inherited from
+
+`Omit.prohibition`
+
+***
+
+### obligation?
+
+> `optional` **obligation**: `IOdrlDuty` \| `IOdrlDuty`[]
+
+The obligations in the policy.
+At least one of permission, prohibition, or obligation must be present.
+
+#### Inherited from
+
+`Omit.obligation`