@twin.org/standards-dataspace-protocol 0.0.3-next.46 → 0.0.3-next.48

package/docs/reference/interfaces/IDataspaceProtocolCatalog.md

@@ -65,7 +65,7 @@ Participant Id
 
 ### catalog?
 
-> `optional` **catalog**: `ObjectOrArray`\<`Omit`\<`IDataspaceProtocolCatalog`, `"@context"`\>\>
+> `optional` **catalog**: `ObjectOrArray`\<`JsonLdObjectWithNoContext`\<`IDataspaceProtocolCatalog`\>\>
 
 Other concerned catalogs
 
@@ -73,7 +73,7 @@ Other concerned catalogs
 
 ### dataset?
 
-> `optional` **dataset**: `ObjectOrArray`\<`Omit`\<[`IDataspaceProtocolDataset`](IDataspaceProtocolDataset.md), `"@context"`\>\>
+> `optional` **dataset**: `ObjectOrArray`\<`JsonLdObjectWithNoContext`\<[`IDataspaceProtocolDataset`](IDataspaceProtocolDataset.md)\>\>
 
 Datasets registered
 
@@ -81,7 +81,7 @@ Datasets registered
 
 ### distribution?
 
-> `optional` **distribution**: `ObjectOrArray`\<`Omit`\<[`IDataspaceProtocolDistribution`](IDataspaceProtocolDistribution.md), `"@context"`\>\>
+> `optional` **distribution**: `ObjectOrArray`\<`JsonLdObjectWithNoContext`\<[`IDataspaceProtocolDistribution`](IDataspaceProtocolDistribution.md)\>\>
 
 Catalog's distributions
 
@@ -89,7 +89,7 @@ Catalog's distributions
 
 ### service?
 
-> `optional` **service**: `ObjectOrArray`\<`Omit`\<[`IDataspaceProtocolDataService`](IDataspaceProtocolDataService.md), `"@context"`\>\>
+> `optional` **service**: `ObjectOrArray`\<`JsonLdObjectWithNoContext`\<[`IDataspaceProtocolDataService`](IDataspaceProtocolDataService.md)\>\>
 
 Data services registered-
 

package/docs/reference/interfaces/IDataspaceProtocolContractAgreementMessage.md

@@ -39,7 +39,7 @@ The consumer id for the contract.
 
 ### agreement
 
-> **agreement**: `IOdrlAgreement`
+> **agreement**: [`IDataspaceProtocolAgreement`](IDataspaceProtocolAgreement.md)
 
 The agreement being sent.
 

package/docs/reference/interfaces/IDataspaceProtocolContractOfferMessage.md

@@ -39,7 +39,7 @@ The consumer id for the contract.
 
 ### offer
 
-> **offer**: `IOdrlOffer`
+> **offer**: [`IDataspaceProtocolOffer`](IDataspaceProtocolOffer.md)
 
 The offer being requested.
 

package/docs/reference/interfaces/IDataspaceProtocolContractRequestMessage.md

@@ -39,7 +39,7 @@ The consumer id for the contract.
 
 ### offer
 
-> **offer**: `IOdrlOffer`
+> **offer**: [`IDataspaceProtocolOffer`](IDataspaceProtocolOffer.md)
 
 The offer being requested.
 

package/docs/reference/interfaces/IDataspaceProtocolDataService.md

@@ -65,7 +65,7 @@ Endpoint URL
 
 ### servesDataset?
 
-> `optional` **servesDataset**: `ObjectOrArray`\<`Omit`\<[`IDataspaceProtocolDataset`](IDataspaceProtocolDataset.md), `"@context"`\>\>
+> `optional` **servesDataset**: `ObjectOrArray`\<`JsonLdObjectWithNoContext`\<[`IDataspaceProtocolDataset`](IDataspaceProtocolDataset.md)\>\>
 
 Datasets served.
 

package/docs/reference/interfaces/IDataspaceProtocolDataset.md

@@ -82,7 +82,7 @@ allows for future multi-offer support.
 
 ### distribution
 
-> **distribution**: `ObjectOrArray`\<`Omit`\<[`IDataspaceProtocolDistribution`](IDataspaceProtocolDistribution.md), `"@context"`\>\>
+> **distribution**: `ObjectOrArray`\<`JsonLdObjectWithNoContext`\<[`IDataspaceProtocolDistribution`](IDataspaceProtocolDistribution.md)\>\>
 
 Distribution of the dataset.
 REQUIRED per Eclipse Data Space Protocol.

package/docs/reference/interfaces/IDataspaceProtocolDistribution.md

@@ -81,7 +81,7 @@ allows for future multi-offer support.
 
 ### accessService
 
-> **accessService**: `string` \| `Omit`\<[`IDataspaceProtocolDataService`](IDataspaceProtocolDataService.md), `"@context"`\>
+> **accessService**: `string` \| `JsonLdObjectWithNoContext`\<[`IDataspaceProtocolDataService`](IDataspaceProtocolDataService.md)\>
 
 Access service.
 It can be a URI pointing to an access service or inline the access service itself

package/docs/reference/interfaces/IDataspaceProtocolOffer.md

@@ -5,7 +5,6 @@ Offer interface compliant with Eclipse Data Space Protocol.
 Extends IOdrlOffer with DS Protocol-specific constraints:
 - `@id` is REQUIRED (used as the primary offer identifier in DS Protocol)
 - `@context` is omitted (inherited from the parent Dataset/Distribution)
-- `uid` is optional (DS Protocol uses `@id` instead of ODRL `uid`)
 
 ## See
 
@@ -26,14 +25,6 @@ Unique identifier for the offer.
 
 ***
 
-### uid?
-
-> `optional` **uid**: `string`
-
-Unique identifier for the offer.
-
-***
-
 ### @type
 
 > **@type**: `"Offer"`

package/docs/reference/variables/DataspaceProtocolCatalogTypes.md

@@ -48,3 +48,15 @@ Distribution.
 > `readonly` **Catalog**: `"Catalog"` = `"Catalog"`
 
 Catalog.
+
+### Offer
+
+> `readonly` **Offer**: `"Offer"` = `"Offer"`
+
+Offer.
+
+### Agreement
+
+> `readonly` **Agreement**: `"Agreement"` = `"Agreement"`
+
+Agreement.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/standards-dataspace-protocol",
-	"version": "0.0.3-next.46",
+	"version": "0.0.3-next.48",
 	"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.46",
-		"@twin.org/standards-w3c-odrl": "0.0.3-next.46",
+		"@twin.org/standards-w3c-dcat": "0.0.3-next.48",
+		"@twin.org/standards-w3c-odrl": "0.0.3-next.48",
 		"@twin.org/web": "next"
 	},
 	"main": "./dist/es/index.js",

package/dist/es/models/catalog/IDataspaceProtocolCatalog.js.map

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

package/dist/es/models/catalog/IDataspaceProtocolDataService.js.map

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

package/dist/es/models/catalog/IDataspaceProtocolDataset.js.map

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

package/dist/es/models/catalog/IDataspaceProtocolDistribution.js.map

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

package/dist/es/models/catalog/IDataspaceProtocolOffer.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"IDataspaceProtocolOffer.js","sourceRoot":"","sources":["../../../../src/models/catalog/IDataspaceProtocolOffer.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IOdrlOffer } from \"@twin.org/standards-w3c-odrl\";\n\n/**\n * Offer interface compliant with Eclipse Data Space Protocol.\n *\n * Extends IOdrlOffer with DS Protocol-specific constraints:\n * - `@id` is REQUIRED (used as the primary offer identifier in DS Protocol)\n * - `@context` is omitted (inherited from the parent Dataset/Distribution)\n * - `uid` is optional (DS Protocol uses `@id` instead of ODRL `uid`)\n *\n * @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types\n * @see IOdrlOffer from @twin.org/standards-w3c-odrl\n */\nexport interface IDataspaceProtocolOffer extends Omit<IOdrlOffer, \"@context\" | \"uid\"> {\n\t/**\n\t * Unique identifier for the offer.\n\t */\n\t\"@id\": string;\n\n\t/**\n\t * Unique identifier for the offer.\n\t */\n\tuid?: string;\n}\n"]}