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

package/dist/es/schemas/Role.json

@@ -0,0 +1,182 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/w3c-dcat/Role",
+    "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/"
+                }
+            },
+            "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": "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/LiteralType",
+            "description": "A name given to the distribution."
+        }
+    },
+    "required": [
+        "@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,15 @@
+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/ICatalog.js";
+export * from "./models/ICatalogRecord.js";
+export * from "./models/IDataService.js";
+export * from "./models/IDataset.js";
+export * from "./models/IDatasetSeries.js";
+export * from "./models/IDistribution.js";
+export * from "./models/IRelationship.js";
+export * from "./models/IResource.js";
+export * from "./models/IRole.js";
+export * from "./models/types/dcatPropertyTypes.js";

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

@@ -0,0 +1,53 @@
+import type { ObjectOrArray } from "@twin.org/core";
+import type { DcatClasses } from "./dcatClasses.js";
+import type { ICatalogRecord } from "./ICatalogRecord.js";
+import type { IDataService } from "./IDataService.js";
+import type { IDataset } from "./IDataset.js";
+import type { IResource } from "./IResource.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 ICatalog extends IDataset {
+    /**
+     * 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<IResource>;
+    /**
+     * A resource that is listed in the catalog.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:catalog_resource
+     */
+    "dcat:resource"?: ObjectOrArray<IResource>;
+    /**
+     * A dataset that is listed in the catalog.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:catalog_dataset
+     */
+    "dcat:dataset"?: ObjectOrArray<IDataset>;
+    /**
+     * A data service that is listed in the catalog.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:catalog_service
+     */
+    "dcat:service"?: ObjectOrArray<IDataService>;
+    /**
+     * A catalog that is listed in the catalog.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:catalog_catalog
+     */
+    "dcat:catalog"?: ObjectOrArray<ICatalog>;
+    /**
+     * 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<ICatalogRecord>;
+}

package/dist/types/models/ICatalogRecord.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 { IResource } from "./IResource.js";
+import type { DateTimeType, LiteralType } 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 ICatalogRecord 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"?: LiteralType;
+    /**
+     * A free-text account of the catalog record.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:record_description
+     */
+    "dcterms:description"?: LiteralType;
+    /**
+     * 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"?: DateTimeType;
+    /**
+     * 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"?: DateTimeType;
+    /**
+     * 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"?: IResource;
+}

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

@@ -0,0 +1,31 @@
+import type { ObjectOrArray } from "@twin.org/core";
+import type { DcatClasses } from "./dcatClasses.js";
+import type { IResource } from "./IResource.js";
+/**
+ * Interface for DCAT Data Service.
+ * A collection of operations that provides access to one or more datasets or data
+ * processing functions.
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Class:Data_Service
+ */
+export interface IDataService extends IResource {
+    /**
+     * The type identifier, typically "DataService".
+     */
+    "@type": typeof DcatClasses.DataService;
+    /**
+     * The root location or primary endpoint of the service (a Web-resolvable IRI).
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:data_service_endpoint_url
+     */
+    "dcat:endpointURL"?: string;
+    /**
+     * A description of the services available via the end-points, including their
+     * operations, parameters, etc.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:data_service_endpoint_description
+     */
+    "dcat:endpointDescription"?: string;
+    /**
+     * A collection of data that this data service can distribute.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:data_service_serves_dataset
+     */
+    "dcat:servesDataset"?: ObjectOrArray<string>;
+}

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

@@ -0,0 +1,60 @@
+import type { ObjectOrArray } from "@twin.org/core";
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { IPeriodOfTime } from "@twin.org/standards-dublin-core";
+import type { DcatClasses } from "./dcatClasses.js";
+import type { IDistribution } from "./IDistribution.js";
+import type { IResource } from "./IResource.js";
+import type { DecimalType, DurationType } from "./types/dcatPropertyTypes.js";
+/**
+ * Interface for DCAT Dataset.
+ * A collection of data, published or curated by a single agent, and available
+ * for access or download in one or more representations.
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Class:Dataset
+ */
+export interface IDataset extends IResource {
+    /**
+     * The type identifier, typically "Dataset".
+     * Can also be "Catalog" or "DatasetSeries" for subclasses.
+     */
+    "@type": typeof DcatClasses.Dataset | typeof DcatClasses.Catalog | typeof DcatClasses.DatasetSeries;
+    /**
+     * An available distribution of the dataset.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_distribution
+     */
+    "dcat:distribution"?: ObjectOrArray<IDistribution>;
+    /**
+     * The frequency at which the dataset is published.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_frequency
+     */
+    "dcterms:accrualPeriodicity"?: string;
+    /**
+     * A dataset series of which the dataset is part.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_in_series
+     */
+    "dcat:inSeries"?: string;
+    /**
+     * The geographical area covered by the dataset.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_spatial
+     */
+    "dcterms:spatial"?: IJsonLdNodeObject | ObjectOrArray<string>;
+    /**
+     * Minimum spatial separation resolvable in a dataset, measured in meters.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_spatial_resolution
+     */
+    "dcat:spatialResolutionInMeters"?: DecimalType;
+    /**
+     * The temporal period that the dataset covers.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_temporal
+     */
+    "dcterms:temporal"?: IPeriodOfTime;
+    /**
+     * Minimum time period resolvable in the dataset.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_temporal_resolution
+     */
+    "dcat:temporalResolution"?: DurationType;
+    /**
+     * An activity that generated, or provides the business context for, the creation of the dataset.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_was_generated_by
+     */
+    "prov:wasGeneratedBy"?: IJsonLdNodeObject | string;
+}

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

@@ -0,0 +1,30 @@
+import type { ObjectOrArray } from "@twin.org/core";
+import type { DcatClasses } from "./dcatClasses.js";
+import type { IDataset } from "./IDataset.js";
+/**
+ * Interface for DCAT Dataset Series.
+ * A collection of datasets that are published separately, but share some common
+ * characteristics that enable them to be grouped together.
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Class:Dataset_Series
+ */
+export interface IDatasetSeries extends IDataset {
+    /**
+     * The type identifier, typically "DatasetSeries".
+     */
+    "@type": typeof DcatClasses.DatasetSeries;
+    /**
+     * A dataset that is part of this dataset series.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_series_first
+     */
+    "dcat:first"?: string;
+    /**
+     * A dataset that is part of this dataset series.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_series_last
+     */
+    "dcat:last"?: string;
+    /**
+     * A dataset that is part of this dataset series.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_series_member
+     */
+    "dcat:seriesMember"?: ObjectOrArray<string>;
+}

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

@@ -0,0 +1,122 @@
+import type { ObjectOrArray } from "@twin.org/core";
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
+import type { DcatClasses } from "./dcatClasses.js";
+import type { DcatContextType } from "./dcatContextType.js";
+import type { DateTimeType, DecimalType, DurationType, LiteralType, NonNegativeIntegerType } from "./types/dcatPropertyTypes.js";
+/**
+ * Interface for DCAT Distribution.
+ * A specific representation of a dataset. A dataset might be available in multiple
+ * serializations that may differ in various ways.
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Class:Distribution
+ */
+export interface IDistribution extends IJsonLdNodeObject {
+    /**
+     * The JSON-LD context for the resource.
+     */
+    "@context"?: DcatContextType;
+    /**
+     * The type identifier, typically "Distribution".
+     */
+    "@type": typeof DcatClasses.Distribution;
+    /**
+     * A name given to the distribution.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_title
+     */
+    "dcterms:title"?: LiteralType;
+    /**
+     * A free-text account of the distribution.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_description
+     */
+    "dcterms:description"?: LiteralType;
+    /**
+     * Date of formal issuance of the distribution.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_release_date
+     */
+    "dcterms:issued"?: DateTimeType;
+    /**
+     * Most recent date on which the distribution was changed, updated or modified.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_update_date
+     */
+    "dcterms:modified"?: DateTimeType;
+    /**
+     * A legal document under which the distribution is made available.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_license
+     */
+    "dcterms:license"?: string;
+    /**
+     * Information about who can access the distribution.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_access_rights
+     */
+    "dcterms:accessRights"?: string;
+    /**
+     * Information about rights held in and over the distribution.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_rights
+     */
+    "dcterms:rights"?: string;
+    /**
+     * A URL of the resource that gives access to a distribution of the dataset.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_access_url
+     */
+    "dcat:accessURL"?: string;
+    /**
+     * A data service that gives access to the distribution.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_access_service
+     */
+    "dcat:accessService"?: string;
+    /**
+     * The URL of the downloadable file in a given format.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_download_url
+     */
+    "dcat:downloadURL"?: string;
+    /**
+     * The size of the distribution in bytes.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_byte_size
+     */
+    "dcat:byteSize"?: NonNegativeIntegerType;
+    /**
+     * The minimum spatial separation resolvable in a distribution, measured in meters.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_spatial_resolution
+     */
+    "dcat:spatialResolutionInMeters"?: DecimalType;
+    /**
+     * Minimum time period resolvable in the distribution.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_temporal_resolution
+     */
+    "dcat:temporalResolution"?: DurationType;
+    /**
+     * An established standard to which the distribution conforms.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_conforms_to
+     */
+    "dcterms:conformsTo"?: ObjectOrArray<string>;
+    /**
+     * The media type of the distribution as defined by IANA.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_media_type
+     */
+    "dcat:mediaType"?: string;
+    /**
+     * The file format of the distribution.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_format
+     */
+    "dcterms:format"?: string;
+    /**
+     * The compression format of the distribution.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_compression_format
+     */
+    "dcat:compressFormat"?: string;
+    /**
+     * The package format of the distribution.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_packaging_format
+     */
+    "dcat:packageFormat"?: string;
+    /**
+     * The checksum property provides a mechanism to verify the data integrity.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_checksum
+     */
+    "spdx:checksum"?: string;
+    /**
+     * An ODRL conformant policy expressing the rights associated with the distribution.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_has_policy
+     */
+    "odrl:hasPolicy"?: IOdrlPolicy;
+}

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

@@ -0,0 +1,30 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { DcatClasses } from "./dcatClasses.js";
+import type { DcatContextType } from "./dcatContextType.js";
+import type { IRole } from "./IRole.js";
+/**
+ * Interface for DCAT Relationship.
+ * An association class for attaching additional information to a relationship
+ * between DCAT Resources.
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Class:Relationship
+ */
+export interface IRelationship extends IJsonLdNodeObject {
+    /**
+     * The JSON-LD context for the resource.
+     */
+    "@context": DcatContextType;
+    /**
+     * The type identifier, typically "Relationship".
+     */
+    "@type": typeof DcatClasses.Relationship;
+    /**
+     * The link to a related resource.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:relationship_relation
+     */
+    "dcterms:relation"?: string;
+    /**
+     * The function of an entity or agent with respect to another resource.
+     * @see https://www.w3.org/TR/vocab-dcat-3/#Property:relationship_hadRole
+     */
+    "dcat:hadRole"?: IRole;
+}