@twin.org/standards-dataspace-protocol 0.0.3-next.6 → 0.0.3-next.60

package/dist/es/schemas/DataspaceProtocolCatalogBase.json

@@ -0,0 +1,428 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolCatalogBase",
+    "title": "DataspaceProtocolCatalogBase",
+    "description": "Catalog interface compliant with Eclipse Data Space Protocol.\n\nThis interface extends ICatalog and enforces DS Protocol-specific requirements\nby 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",
+    "type": "object",
+    "properties": {
+        "@type": {
+            "const": "Catalog",
+            "description": "The type identifier for the Catalog.\nREQUIRED per Eclipse Data Space Protocol."
+        },
+        "@id": {
+            "type": "string",
+            "description": "Unique identifier for the dataset.\nREQUIRED per Eclipse Data Space Protocol."
+        },
+        "participantId": {
+            "type": "string",
+            "description": "Participant Id"
+        },
+        "catalog": {
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolCatalogBase"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolCatalogBase"
+                    }
+                }
+            ],
+            "description": "Other concerned catalogs"
+        },
+        "dataset": {
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolDatasetBase"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolDatasetBase"
+                    }
+                }
+            ],
+            "description": "Datasets registered"
+        },
+        "distribution": {
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolDistributionBase"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolDistributionBase"
+                    }
+                }
+            ],
+            "description": "Catalog's distributions"
+        },
+        "service": {
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolDataServiceBase"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolDataServiceBase"
+                    }
+                }
+            ],
+            "description": "Data services registered-"
+        }
+    },
+    "required": [
+        "@type",
+        "@id",
+        "participantId"
+    ],
+    "allOf": [
+        {
+            "description": "Base interface for DCAT Catalog without JSON-LD context.\nThis is the context-free variant of IDcatCatalog, intended for embedding\ncatalogs inline within other objects where the context is provided by the enclosing document.\nNote: dcat:Catalog is a sub-class of dcat:Dataset per the W3C spec.",
+            "type": "object",
+            "properties": {
+                "@id": {
+                    "type": "string",
+                    "description": "The unique identifier for the resource.",
+                    "$comment": "Inherited from DcatResourceBase"
+                },
+                "dcterms:title": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        }
+                    ],
+                    "description": "A name given to the resource.",
+                    "$comment": "Inherited from DcatResourceBase"
+                },
+                "dcterms:description": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        }
+                    ],
+                    "description": "A free-text account of the resource.",
+                    "$comment": "Inherited from DcatResourceBase"
+                },
+                "dcterms:identifier": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        }
+                    ],
+                    "description": "A unique identifier of the resource.",
+                    "$comment": "Inherited from DcatResourceBase"
+                },
+                "dcterms:issued": {
+                    "type": "string",
+                    "description": "Date of formal issuance (publication) of the resource.",
+                    "format": "date-time",
+                    "$comment": "Inherited from DcatResourceBase"
+                },
+                "dcterms:modified": {
+                    "type": "string",
+                    "description": "Most recent date on which the resource was changed, updated or modified.",
+                    "format": "date-time",
+                    "$comment": "Inherited from DcatResourceBase"
+                },
+                "dcterms:language": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        }
+                    ],
+                    "description": "A language of the resource.",
+                    "$comment": "Inherited from DcatResourceBase"
+                },
+                "dcterms:publisher": {
+                    "anyOf": [
+                        {
+                            "$ref": "https://schema.twindev.org/dataspace-protocol/FoafAgentWithAliases"
+                        },
+                        {
+                            "type": "string"
+                        }
+                    ],
+                    "description": "An entity responsible for making the resource available.",
+                    "$comment": "Inherited from DcatResourceBase"
+                },
+                "dcterms:creator": {
+                    "anyOf": [
+                        {
+                            "$ref": "https://schema.twindev.org/dataspace-protocol/FoafAgentWithAliases"
+                        },
+                        {
+                            "type": "string"
+                        }
+                    ],
+                    "description": "An entity responsible for producing the resource.",
+                    "$comment": "Inherited from DcatResourceBase"
+                },
+                "dcterms:accessRights": {
+                    "anyOf": [
+                        {
+                            "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                        },
+                        {
+                            "type": "string"
+                        }
+                    ],
+                    "description": "Information about who can access the resource or an indication of its security status.",
+                    "$comment": "Inherited from DcatResourceBase"
+                },
+                "dcterms:license": {
+                    "anyOf": [
+                        {
+                            "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                        },
+                        {
+                            "type": "string"
+                        }
+                    ],
+                    "description": "A legal document under which the resource is made available.",
+                    "$comment": "Inherited from DcatResourceBase"
+                },
+                "dcterms:rights": {
+                    "anyOf": [
+                        {
+                            "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                        },
+                        {
+                            "type": "string"
+                        }
+                    ],
+                    "description": "Information about rights held in and over the resource.",
+                    "$comment": "Inherited from DcatResourceBase"
+                },
+                "dcterms:conformsTo": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        }
+                    ],
+                    "description": "An established standard to which the resource conforms.",
+                    "$comment": "Inherited from DcatResourceBase"
+                },
+                "dcterms:type": {
+                    "type": "string",
+                    "description": "The nature or genre of the resource.",
+                    "$comment": "Inherited from DcatResourceBase"
+                },
+                "dcat:contactPoint": {
+                    "anyOf": [
+                        {
+                            "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                        },
+                        {
+                            "type": "string"
+                        }
+                    ],
+                    "description": "Relevant contact information for the catalogued resource.",
+                    "$comment": "Inherited from DcatResourceBase"
+                },
+                "dcat:keyword": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        }
+                    ],
+                    "description": "A keyword or tag describing the resource.",
+                    "$comment": "Inherited from DcatResourceBase"
+                },
+                "dcat:theme": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        }
+                    ],
+                    "description": "A main category of the resource. A resource can have multiple themes.",
+                    "$comment": "Inherited from DcatResourceBase"
+                },
+                "dcat:landingPage": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        }
+                    ],
+                    "description": "A Web page that can be navigated to gain access to the resource.",
+                    "$comment": "Inherited from DcatResourceBase"
+                },
+                "dcat:qualifiedRelation": {
+                    "anyOf": [
+                        {
+                            "$ref": "https://schema.twindev.org/dataspace-protocol/DcatRelationship"
+                        },
+                        {
+                            "type": "string"
+                        }
+                    ],
+                    "description": "Link to a description of a relationship with another resource.",
+                    "$comment": "Inherited from DcatResourceBase"
+                },
+                "odrl:hasPolicy": {
+                    "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPolicy",
+                    "description": "An ODRL conformant policy expressing the rights associated with the resource.",
+                    "$comment": "Inherited from DcatResourceBase"
+                },
+                "dcterms:accrualPeriodicity": {
+                    "type": "string",
+                    "description": "The frequency at which the dataset is published.",
+                    "$comment": "Inherited from DcatDatasetBase"
+                },
+                "dcat:inSeries": {
+                    "type": "string",
+                    "description": "A dataset series of which the dataset is part.",
+                    "$comment": "Inherited from DcatDatasetBase"
+                },
+                "dcterms:spatial": {
+                    "anyOf": [
+                        {
+                            "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                        },
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        }
+                    ],
+                    "description": "The geographical area covered by the dataset.",
+                    "$comment": "Inherited from DcatDatasetBase"
+                },
+                "dcat:spatialResolutionInMeters": {
+                    "type": "number",
+                    "description": "Minimum spatial separation resolvable in a dataset, measured in meters.",
+                    "$comment": "Inherited from DcatDatasetBase"
+                },
+                "dcterms:temporal": {
+                    "$ref": "https://schema.twindev.org/dataspace-protocol/DublinCorePeriodOfTime",
+                    "description": "The temporal period that the dataset covers.",
+                    "$comment": "Inherited from DcatDatasetBase"
+                },
+                "dcat:temporalResolution": {
+                    "type": "string",
+                    "description": "Minimum time period resolvable in the dataset.",
+                    "format": "duration",
+                    "$comment": "Inherited from DcatDatasetBase"
+                },
+                "prov:wasGeneratedBy": {
+                    "anyOf": [
+                        {
+                            "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                        },
+                        {
+                            "type": "string"
+                        }
+                    ],
+                    "description": "An activity that generated, or provides the business context for, the creation of the dataset.",
+                    "$comment": "Inherited from DcatDatasetBase"
+                },
+                "foaf:homepage": {
+                    "type": "string",
+                    "description": "A homepage of the catalog (a public Web document usually available in HTML).",
+                    "$comment": "Inherited from DcatCatalogBase"
+                },
+                "dcat:themeTaxonomy": {
+                    "anyOf": [
+                        {
+                            "$ref": "https://schema.twindev.org/dataspace-protocol/DcatResource"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "$ref": "https://schema.twindev.org/dataspace-protocol/DcatResource"
+                            }
+                        }
+                    ],
+                    "description": "A knowledge organization system (KOS) used to classify the resources in the catalog.",
+                    "$comment": "Inherited from DcatCatalogBase"
+                },
+                "dcat:resource": {
+                    "anyOf": [
+                        {
+                            "$ref": "https://schema.twindev.org/dataspace-protocol/DcatResource"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "$ref": "https://schema.twindev.org/dataspace-protocol/DcatResource"
+                            }
+                        }
+                    ],
+                    "description": "A resource that is listed in the catalog.",
+                    "$comment": "Inherited from DcatCatalogBase"
+                },
+                "dcat:record": {
+                    "anyOf": [
+                        {
+                            "$ref": "https://schema.twindev.org/dataspace-protocol/DcatCatalogRecordBase"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "$ref": "https://schema.twindev.org/dataspace-protocol/DcatCatalogRecordBase"
+                            }
+                        }
+                    ],
+                    "description": "A record describing the registration of a single resource in the catalog.",
+                    "$comment": "Inherited from DcatCatalogBase"
+                }
+            },
+            "$comment": "Inlined utility base type DcatCatalogBase so utility transformations can operate on concrete properties instead of a $ref."
+        }
+    ]
+}

package/dist/es/schemas/DataspaceProtocolCatalogError.json

@@ -0,0 +1,31 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolCatalogError",
+    "title": "DataspaceProtocolCatalogError",
+    "description": "Interface for Dataspace Protocol Catalog Error.\nhttps://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#error-catalog-error",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContextType",
+            "description": "The JSON-LD context."
+        },
+        "@type": {
+            "const": "CatalogError",
+            "description": "The type of the message."
+        },
+        "code": {
+            "type": "string",
+            "description": "The error code."
+        },
+        "reason": {
+            "type": "array",
+            "items": {},
+            "description": "The error reason(s)."
+        }
+    },
+    "required": [
+        "@context",
+        "@type",
+        "code"
+    ]
+}

package/dist/es/schemas/DataspaceProtocolCatalogRequestMessage.json

@@ -0,0 +1,26 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolCatalogRequestMessage",
+    "title": "DataspaceProtocolCatalogRequestMessage",
+    "description": "Interface for Dataspace Protocol Catalog Request Messages.\nhttps://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#catalog-request-message",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContextType",
+            "description": "The JSON-LD context."
+        },
+        "@type": {
+            "const": "CatalogRequestMessage",
+            "description": "The type of the message."
+        },
+        "filter": {
+            "type": "array",
+            "items": {},
+            "description": "An implementation-specific query or filter expression."
+        }
+    },
+    "required": [
+        "@context",
+        "@type"
+    ]
+}

package/dist/es/schemas/DataspaceProtocolContextType.json

@@ -0,0 +1,30 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContextType",
+    "title": "DataspaceProtocolContextType",
+    "description": "The Dataspace Protocol JSON-LD context type.",
+    "anyOf": [
+        {
+            "const": "https://w3id.org/dspace/2025/1/context.jsonld"
+        },
+        {
+            "type": "array",
+            "items": {
+                "anyOf": [
+                    {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    },
+                    {
+                        "const": "https://w3id.org/dspace/2025/1/context.jsonld"
+                    }
+                ]
+            },
+            "contains": {
+                "const": "https://w3id.org/dspace/2025/1/context.jsonld"
+            },
+            "minContains": 1,
+            "maxContains": 1,
+            "minItems": 1
+        }
+    ]
+}