@twin.org/standards-dataspace-protocol 0.0.3-next.7 → 0.0.3-next.9

package/docs/reference/interfaces/IDataspaceProtocolDataService.md

@@ -0,0 +1,72 @@
+# Interface: IDataspaceProtocolDataService
+
+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
+ - https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
+
+## Extends
+
+- `Omit`\<`IDcatDataService`, `"@type"` \| `"@context"` \| `"dcat:servesDataset"` \| `"dcat:endpointURL"`\>
+
+## Indexable
+
+\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `IJsonLdContextDefinition` \| `string`[] \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
+
+\[`key`: `number`\]: `string` \| `number` \| `boolean` \| `IJsonLdContextDefinition` \| `string`[] \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
+
+## Properties
+
+### @context
+
+> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
+
+LD Context. Required per Eclipse Data Space Protocol.
+
+***
+
+### @type
+
+> **@type**: `"DataService"`
+
+The type identifier for the Data Service.
+REQUIRED per Eclipse Data Space Protocol.
+
+***
+
+### @id
+
+> **@id**: `string`
+
+Unique identifier for the dataset.
+REQUIRED per Eclipse Data Space Protocol.
+
+***
+
+### endpointURL
+
+> **endpointURL**: `string`
+
+Endpoint URL
+
+***
+
+### servesDataset?
+
+> `optional` **servesDataset**: `ObjectOrArray`\<[`IDataspaceProtocolDataset`](IDataspaceProtocolDataset.md)\>
+
+Datasets served.

package/docs/reference/interfaces/IDataspaceProtocolDataset.md

@@ -0,0 +1,90 @@
+# Interface: IDataspaceProtocolDataset
+
+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
+ - https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
+ - IOdrlOffer from @twin.org/standards-w3c-odrl
+ - IResource.odrl:hasPolicy from @twin.org/standards-w3c-dcat
+
+## Extends
+
+- `Omit`\<`IDcatDataset`, `"odrl:hasPolicy"` \| `"dcat:distribution"` \| `"@type"` \| `"@context"`\>
+
+## Indexable
+
+\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `IJsonLdContextDefinition` \| `string`[] \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
+
+\[`key`: `number`\]: `string` \| `number` \| `boolean` \| `IJsonLdContextDefinition` \| `string`[] \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
+
+## Properties
+
+### @context
+
+> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
+
+LD Context. Required per Eclipse Data Space Protocol.
+
+***
+
+### @type
+
+> **@type**: `"Dataset"`
+
+The type identifier for the dataset.
+REQUIRED per Eclipse Data Space Protocol.
+
+***
+
+### @id
+
+> **@id**: `string`
+
+Unique identifier for the dataset.
+REQUIRED per Eclipse Data Space Protocol.
+
+***
+
+### hasPolicy
+
+> **hasPolicy**: `ObjectOrArray`\<`IOdrlOffer`\>
+
+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.
+
+***
+
+### distribution
+
+> **distribution**: `ObjectOrArray`\<[`IDataspaceProtocolDistribution`](IDataspaceProtocolDistribution.md)\>
+
+Distribution of the dataset.
+REQUIRED per Eclipse Data Space Protocol.

package/docs/reference/interfaces/IDataspaceProtocolDistribution.md

@@ -0,0 +1,98 @@
+# Interface: IDataspaceProtocolDistribution
+
+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
+ - https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
+ - IOdrlOffer from @twin.org/standards-w3c-odrl
+ - IResource.odrl:hasPolicy from @twin.org/standards-w3c-dcat
+
+## Extends
+
+- `Omit`\<`IDcatDistribution`, `"odrl:hasPolicy"` \| `"@type"` \| `"@context"` \| `"dcterms:format"`\>
+
+## Indexable
+
+\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `IJsonLdContextDefinition` \| `string`[] \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
+
+\[`key`: `number`\]: `string` \| `number` \| `boolean` \| `IJsonLdContextDefinition` \| `string`[] \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
+
+## Properties
+
+### @context
+
+> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
+
+LD Context. Required per Eclipse Data Space Protocol.
+
+***
+
+### @type
+
+> **@type**: `"Distribution"`
+
+The type identifier for the Distribution.
+REQUIRED per Eclipse Data Space Protocol.
+
+***
+
+### @id
+
+> **@id**: `string`
+
+Unique identifier for the dataset.
+REQUIRED per Eclipse Data Space Protocol.
+
+***
+
+### hasPolicy?
+
+> `optional` **hasPolicy**: `ObjectOrArray`\<`IOdrlOffer`\>
+
+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.
+
+***
+
+### accessService
+
+> **accessService**: `string` \| [`IDataspaceProtocolDataService`](IDataspaceProtocolDataService.md)
+
+Access service.
+It can be a URI pointing to an access service or inline the access service itself
+
+***
+
+### format
+
+> **format**: `string`
+
+Distribution format.
+REQUIRED per Eclipse Data Space Protocol.

package/docs/reference/interfaces/IDataspaceProtocolTransferProcess.md

@@ -39,36 +39,6 @@ MUST refer to the transfer identifier of the Provider side.
 
 ### state
 
-> **state**: `object`
+> **state**: `string`
 
 The transfer process state.
-
-#### COMPLETED
-
-> **COMPLETED**: `string` = `"COMPLETED"`
-
-Completed
-
-#### REQUESTED
-
-> **REQUESTED**: `string` = `"REQUESTED"`
-
-Requested
-
-#### STARTED
-
-> **STARTED**: `string` = `"STARTED"`
-
-Started
-
-#### SUSPENDED
-
-> **SUSPENDED**: `string` = `"SUSPENDED"`
-
-Suspended
-
-#### TERMINATED
-
-> **TERMINATED**: `string` = `"TERMINATED"`
-
-Terminated

package/docs/reference/variables/DataspaceProtocolContexts.md

@@ -12,6 +12,12 @@ The contexts for Dataspace Protocol Protocol.
 
 The context root for Dataspace Protocol Protocol.
 
+### DspNamespace
+
+> `readonly` **DspNamespace**: `"https://w3id.org/dspace/2025/1/"` = `"https://w3id.org/dspace/2025/1/"`
+
+The namespace.
+
 ### ContextRedirect
 
 > `readonly` **ContextRedirect**: `"https://w3id.org/dspace/2025/1/context.jsonld"` = `"https://w3id.org/dspace/2025/1/context.jsonld"`

package/locales/en.json

@@ -1 +1,7 @@
-{}
+{
+	"error": {
+		"dataspaceProtocolHelper": {
+			"schemaNotRegistered": "JSON Schema \"{schemaId}\" is not registered in DataTypeHandlerFactory"
+		}
+	}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/standards-dataspace-protocol",
-	"version": "0.0.3-next.7",
+	"version": "0.0.3-next.9",
 	"description": "Models which define the structure of Dataspace Protocol",
 	"repository": {
 		"type": "git",
@@ -17,8 +17,8 @@
 		"@twin.org/core": "next",
 		"@twin.org/data-core": "next",
 		"@twin.org/data-json-ld": "next",
-		"@twin.org/standards-w3c-dcat": "0.0.3-next.7",
-		"@twin.org/standards-w3c-odrl": "0.0.3-next.7",
+		"@twin.org/standards-w3c-dcat": "0.0.3-next.9",
+		"@twin.org/standards-w3c-odrl": "0.0.3-next.9",
 		"@twin.org/web": "next"
 	},
 	"main": "./dist/es/index.js",