@twin.org/standards-w3c-dcat 0.0.3-next.10

package/dist/es/schemas/DcatResource.json

@@ -0,0 +1,351 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/w3c-dcat/DcatResource",
+    "description": "Base interface for DCAT catalogued resources. This is the parent class of dcat:Dataset, dcat:DataService, and dcat:Catalog.",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "description": "The DCAT JSON-LD context type. Supports the DCAT context URL or arrays with additional context definitions.",
+            "type": "object",
+            "additionalProperties": {
+                "anyOf": [
+                    {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdExpandedTermDefinition"
+                    },
+                    {
+                        "type": [
+                            "null",
+                            "string"
+                        ]
+                    }
+                ]
+            },
+            "properties": {
+                "@base": {
+                    "type": [
+                        "string",
+                        "null"
+                    ]
+                },
+                "@direction": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "enum": [
+                        "ltr",
+                        "rtl",
+                        null
+                    ]
+                },
+                "@import": {
+                    "type": "string"
+                },
+                "@language": {
+                    "type": "string"
+                },
+                "@propagate": {
+                    "type": "boolean"
+                },
+                "@protected": {
+                    "type": "boolean"
+                },
+                "@type": {
+                    "type": "object",
+                    "properties": {
+                        "@container": {
+                            "type": "string",
+                            "const": "@set"
+                        },
+                        "@protected": {
+                            "type": "boolean"
+                        }
+                    },
+                    "required": [
+                        "@container"
+                    ],
+                    "additionalProperties": false
+                },
+                "@version": {
+                    "type": "string",
+                    "const": "1.1"
+                },
+                "@vocab": {
+                    "type": [
+                        "string",
+                        "null"
+                    ]
+                },
+                "dcat": {
+                    "type": "string",
+                    "const": "http://www.w3.org/ns/dcat#"
+                },
+                "dcterms": {
+                    "type": "string",
+                    "const": "http://purl.org/dc/terms/"
+                },
+                "odrl": {
+                    "type": "string",
+                    "const": "http://www.w3.org/ns/odrl/2/"
+                },
+                "foaf": {
+                    "type": "string",
+                    "const": "https://xmlns.com/foaf/0.1/"
+                }
+            },
+            "required": [
+                "dcat",
+                "dcterms"
+            ]
+        },
+        "@id": {
+            "anyOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            ]
+        },
+        "@included": {
+            "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
+        },
+        "@graph": {
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                    }
+                }
+            ]
+        },
+        "@nest": {
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/json-ld/JsonLdJsonObject"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdJsonObject"
+                    }
+                }
+            ]
+        },
+        "@type": {
+            "type": "string",
+            "enum": [
+                "dcat:Resource",
+                "dcat:Dataset",
+                "dcat:DataService",
+                "dcat:Catalog",
+                "dcat:DatasetSeries"
+            ],
+            "description": "The type of the resource. Typically \"Catalog\", \"Dataset\", \"DataService\", \"DatasetSeries\", or the base \"Resource\"."
+        },
+        "@reverse": {
+            "type": "object",
+            "additionalProperties": {
+                "type": "string"
+            }
+        },
+        "@index": {
+            "type": "string"
+        },
+        "dcterms:title": {
+            "$ref": "https://schema.twindev.org/w3c-dcat/DcatLiteralType",
+            "description": "A name given to the resource."
+        },
+        "dcterms:description": {
+            "$ref": "https://schema.twindev.org/w3c-dcat/DcatLiteralType",
+            "description": "A free-text account of the resource."
+        },
+        "dcterms:identifier": {
+            "$ref": "https://schema.twindev.org/w3c-dcat/DcatLiteralType",
+            "description": "A unique identifier of the resource."
+        },
+        "dcterms:issued": {
+            "$ref": "https://schema.twindev.org/w3c-dcat/DcatDateTimeType",
+            "description": "Date of formal issuance (publication) of the resource."
+        },
+        "dcterms:modified": {
+            "$ref": "https://schema.twindev.org/w3c-dcat/DcatDateTimeType",
+            "description": "Most recent date on which the resource was changed, updated or modified."
+        },
+        "dcterms:language": {
+            "description": "Object or array data type",
+            "anyOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            ]
+        },
+        "dcterms:publisher": {
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/w3c-dcat/FoafAgent"
+                },
+                {
+                    "type": "string"
+                }
+            ],
+            "description": "An entity responsible for making the resource available."
+        },
+        "dcterms:creator": {
+            "$ref": "https://schema.twindev.org/w3c-dcat/FoafAgent",
+            "description": "An entity responsible for producing the resource."
+        },
+        "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."
+        },
+        "dcterms:license": {
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                },
+                {
+                    "type": "string"
+                }
+            ],
+            "description": "A legal document under which the resource is made available."
+        },
+        "dcterms:rights": {
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                },
+                {
+                    "type": "string"
+                }
+            ],
+            "description": "Information about rights held in and over the resource."
+        },
+        "dcterms:conformsTo": {
+            "description": "Object or array data type",
+            "anyOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            ]
+        },
+        "dcterms:type": {
+            "type": "string",
+            "description": "The nature or genre of the resource."
+        },
+        "dcat:contactPoint": {
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                },
+                {
+                    "type": "string"
+                }
+            ],
+            "description": "Relevant contact information for the catalogued resource."
+        },
+        "dcat:keyword": {
+            "$ref": "https://schema.twindev.org/w3c-dcat/DcatLiteralType",
+            "description": "A keyword or tag describing the resource."
+        },
+        "dcat:theme": {
+            "description": "Object or array data type",
+            "anyOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            ]
+        },
+        "dcat:landingPage": {
+            "description": "Object or array data type",
+            "anyOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            ]
+        },
+        "dcat:qualifiedRelation": {
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/w3c-dcat/DcatRelationship"
+                },
+                {
+                    "type": "string"
+                }
+            ],
+            "description": "Link to a description of a relationship with another resource."
+        },
+        "odrl:hasPolicy": {
+            "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPolicy",
+            "description": "An ODRL conformant policy expressing the rights associated with the resource."
+        }
+    },
+    "required": [
+        "@context",
+        "@type"
+    ],
+    "additionalProperties": {
+        "anyOf": [
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdIndexMap"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdIdMap"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdTypeMap"
+            },
+            {
+                "type": "array"
+            }
+        ]
+    }
+}

package/dist/es/schemas/DcatRole.json

@@ -0,0 +1,191 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/w3c-dcat/DcatRole",
+    "description": "Interface for DCAT Role. A role is the function of a resource or agent with respect to another resource, in the context of resource attribution or resource relationships.",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "description": "The DCAT JSON-LD context type. Supports the DCAT context URL or arrays with additional context definitions.",
+            "type": "object",
+            "additionalProperties": {
+                "anyOf": [
+                    {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdExpandedTermDefinition"
+                    },
+                    {
+                        "type": [
+                            "null",
+                            "string"
+                        ]
+                    }
+                ]
+            },
+            "properties": {
+                "@base": {
+                    "type": [
+                        "string",
+                        "null"
+                    ]
+                },
+                "@direction": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "enum": [
+                        "ltr",
+                        "rtl",
+                        null
+                    ]
+                },
+                "@import": {
+                    "type": "string"
+                },
+                "@language": {
+                    "type": "string"
+                },
+                "@propagate": {
+                    "type": "boolean"
+                },
+                "@protected": {
+                    "type": "boolean"
+                },
+                "@type": {
+                    "type": "object",
+                    "properties": {
+                        "@container": {
+                            "type": "string",
+                            "const": "@set"
+                        },
+                        "@protected": {
+                            "type": "boolean"
+                        }
+                    },
+                    "required": [
+                        "@container"
+                    ],
+                    "additionalProperties": false
+                },
+                "@version": {
+                    "type": "string",
+                    "const": "1.1"
+                },
+                "@vocab": {
+                    "type": [
+                        "string",
+                        "null"
+                    ]
+                },
+                "dcat": {
+                    "type": "string",
+                    "const": "http://www.w3.org/ns/dcat#"
+                },
+                "dcterms": {
+                    "type": "string",
+                    "const": "http://purl.org/dc/terms/"
+                },
+                "odrl": {
+                    "type": "string",
+                    "const": "http://www.w3.org/ns/odrl/2/"
+                },
+                "foaf": {
+                    "type": "string",
+                    "const": "https://xmlns.com/foaf/0.1/"
+                }
+            },
+            "required": [
+                "dcat",
+                "dcterms"
+            ]
+        },
+        "@id": {
+            "anyOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            ]
+        },
+        "@included": {
+            "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
+        },
+        "@graph": {
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                    }
+                }
+            ]
+        },
+        "@nest": {
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/json-ld/JsonLdJsonObject"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdJsonObject"
+                    }
+                }
+            ]
+        },
+        "@type": {
+            "type": "string",
+            "const": "dcat:Role",
+            "description": "The type identifier, typically \"Role\"."
+        },
+        "@reverse": {
+            "type": "object",
+            "additionalProperties": {
+                "type": "string"
+            }
+        },
+        "@index": {
+            "type": "string"
+        },
+        "dcterms:title": {
+            "$ref": "https://schema.twindev.org/w3c-dcat/DcatLiteralType",
+            "description": "A name given to the distribution."
+        }
+    },
+    "required": [
+        "@context",
+        "@type"
+    ],
+    "additionalProperties": {
+        "anyOf": [
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdIndexMap"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdIdMap"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdTypeMap"
+            },
+            {
+                "type": "array"
+            }
+        ]
+    }
+}

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

@@ -0,0 +1,14 @@
+/**
+ * Class providing DCAT data type utilities and JSON-LD redirect registration.
+ */
+export declare class DcatDataTypes {
+    /**
+     * Register redirects for DCAT namespace to enable offline JSON-LD processing.
+     * This maps the W3C DCAT namespace to a local redirect URL for faster resolution.
+     */
+    static registerRedirects(): void;
+    /**
+     * Register all the DCAT data types with their JSON schemas.
+     */
+    static registerTypes(): void;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,16 @@
+export * from "./dataTypes/dcatDataTypes.js";
+export * from "./models/dcatClasses.js";
+export * from "./models/dcatContexts.js";
+export * from "./models/dcatContextType.js";
+export * from "./models/dcatRelationshipTypes.js";
+export * from "./models/IDcatCatalog.js";
+export * from "./models/IDcatCatalogRecord.js";
+export * from "./models/IDcatDataService.js";
+export * from "./models/IDcatDataset.js";
+export * from "./models/IDcatDatasetSeries.js";
+export * from "./models/IDcatDistribution.js";
+export * from "./models/IDcatRelationship.js";
+export * from "./models/IDcatResource.js";
+export * from "./models/IDcatRole.js";
+export * from "./models/types/dcatPropertyTypes.js";
+export * from "./models/types/dcatContextFreeTypes.js";

package/dist/types/models/IDcatCatalog.d.ts

@@ -0,0 +1,52 @@
+import type { ObjectOrArray } from "@twin.org/core";
+import type { DcatClasses } from "./dcatClasses.js";
+import type { IDcatDataset } from "./IDcatDataset.js";
+import type { IDcatResource } from "./IDcatResource.js";
+import type { CatalogOptionalContext, CatalogRecordOptionalContext, DataServiceOptionalContext, DatasetOptionalContext } from "./types/dcatContextFreeTypes.js";
+/**
+ * Interface for DCAT Catalog.
+ * A curated collection of metadata about resources (datasets and data services).
+ * Note: dcat:Catalog is a sub-class of dcat:Dataset per the W3C spec.
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Class:Catalog
+ */
+export interface IDcatCatalog extends IDcatDataset {
+    /**
+     * The type identifier, typically "Catalog".
+     */
+    "@type": typeof DcatClasses.Catalog;
+    /**
+     * A homepage of the catalog (a public Web document usually available in HTML).
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:catalog_homepage
+     */
+    "foaf:homepage"?: string;
+    /**
+     * A knowledge organization system (KOS) used to classify the resources in the catalog.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:catalog_themes
+     */
+    "dcat:themeTaxonomy"?: ObjectOrArray<IDcatResource>;
+    /**
+     * A resource that is listed in the catalog.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:catalog_resource
+     */
+    "dcat:resource"?: ObjectOrArray<IDcatResource>;
+    /**
+     * A dataset that is listed in the catalog.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:catalog_dataset
+     */
+    "dcat:dataset"?: ObjectOrArray<DatasetOptionalContext>;
+    /**
+     * A data service that is listed in the catalog.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:catalog_service
+     */
+    "dcat:service"?: ObjectOrArray<DataServiceOptionalContext>;
+    /**
+     * A catalog that is listed in the catalog.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:catalog_catalog
+     */
+    "dcat:catalog"?: ObjectOrArray<CatalogOptionalContext>;
+    /**
+     * A record describing the registration of a single resource in the catalog.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:catalog_catalog_record
+     */
+    "dcat:record"?: ObjectOrArray<CatalogRecordOptionalContext>;
+}

package/dist/types/models/IDcatCatalogRecord.d.ts

@@ -0,0 +1,52 @@
+import type { ObjectOrArray } from "@twin.org/core";
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { DcatClasses } from "./dcatClasses.js";
+import type { DcatContextType } from "./dcatContextType.js";
+import type { IDcatResource } from "./IDcatResource.js";
+import type { DcatDateTimeType, DcatLiteralType } from "./types/dcatPropertyTypes.js";
+/**
+ * Interface for DCAT Catalog Record.
+ * A record in a catalog, describing the registration of a single dataset or data
+ * service.
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Class:Catalog_Record
+ */
+export interface IDcatCatalogRecord extends IJsonLdNodeObject {
+    /**
+     * The JSON-LD context for the resource.
+     */
+    "@context": DcatContextType;
+    /**
+     * The type identifier, typically "CatalogRecord".
+     */
+    "@type": typeof DcatClasses.CatalogRecord;
+    /**
+     * A name given to the catalog record.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:record_title
+     */
+    "dcterms:title"?: DcatLiteralType;
+    /**
+     * A free-text account of the catalog record.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:record_description
+     */
+    "dcterms:description"?: DcatLiteralType;
+    /**
+     * The date of listing of the catalog record in the catalog.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:record_listing_date
+     */
+    "dcterms:issued"?: DcatDateTimeType;
+    /**
+     * Most recent date on which the catalog record entry was changed or modified.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:record_update_date
+     */
+    "dcterms:modified"?: DcatDateTimeType;
+    /**
+     * An established standard to which the catalog record conforms.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:record_conforms_to
+     */
+    "dcterms:conformsTo"?: ObjectOrArray<string>;
+    /**
+     * The dataset or data service described in the catalog record.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:record_primary_topic
+     */
+    "foaf:primaryTopic"?: IDcatResource;
+}