https://github.com/koopjs/koop-output-dcat-ap-201
A Koop output plugin for generating DCAT-AP 2.0.1 feeds from the ArcGIS Hub Search API.
https://github.com/koopjs/koop-output-dcat-ap-201
Last synced: 11 months ago
JSON representation
A Koop output plugin for generating DCAT-AP 2.0.1 feeds from the ArcGIS Hub Search API.
- Host: GitHub
- URL: https://github.com/koopjs/koop-output-dcat-ap-201
- Owner: koopjs
- License: other
- Created: 2021-07-28T12:21:28.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-07-02T19:52:53.000Z (12 months ago)
- Last Synced: 2025-07-02T20:38:49.343Z (12 months ago)
- Language: TypeScript
- Size: 1.05 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Koop Provider DCAT-AP 2.1.1
[![TypeScript version][ts-badge]][typescript-4-3]
[![Node.js version][nodejs-badge]][nodejs]
[![APLv2][license-badge]][license]
[![Build Status - GitHub Actions][gha-badge]][gha-ci]
This is a Koop output plugin that transforms datasets from the ArcGIS Hub Search API into a DCAT-AP 2.1.1 feed encoded in RDF/JSON-LD. It currently only supports exporting a search catalog from an entire Hub Site.
Here is an example feed:
```json
{
"@context": {
"dcat": "http://www.w3.org/ns/dcat#",
"dct": "http://purl.org/dc/terms/",
"foaf": "http://xmlns.com/foaf/0.1/",
"vcard": "http://www.w3.org/2006/vcard/ns#",
"ftype": "http://publications.europa.eu/resource/authority/file-type/",
"lang": "http://publications.europa.eu/resource/authority/language/"
},
"@id": "https://download-test-qa-pre-a-hub.hubqa.arcgis.com",
"@type": "dcat:Catalog",
"dct:description": "Create your own initiative by combining existing applications with a custom site. Use this initiative to form teams around a problem and invite your community to participate.",
"dct:title": "download test",
"dct:publisher": "QA Premium Alpha Hub",
"foaf:homepage": {
"foaf:Document": "https://download-test-qa-pre-a-hub.hubqa.arcgis.com/search"
},
"dct:language": {
"@id": "lang:ENG"
},
"dct:creator": {
"@id": "https://qa-pre-a-hub.maps.arcgis.com",
"@type": "foaf:Agent",
"foaf:name": "QA Premium Alpha Hub"
},
"dcat:dataset": [
{
"@type": "dcat:Dataset",
"@id": "https://download-test-qa-pre-a-hub.hubqa.arcgis.com/datasets/f4bcc1035b7d46cba95e977f4affb6be_0",
"dct:title": "Tahoe places of interest",
"dct:description": "Description. Here be Tahoe things. You can do a lot here. Here are some more words. And a few more.",
"dcat:contactPoint": {
"@id": "https://qa-pre-a-hub.maps.arcgis.com/sharing/rest/community/users/thervey_qa_pre_a_hub?f=json",
"@type": "Contact",
"vcard:fn": "thervey_qa_pre_a_hub",
"vcard:hasEmail": null
},
"dct:publisher": "QA Premium Alpha Hub",
"dcat:theme": "geospatial",
"dct:accessRights": "public",
"dct:identifier": "https://download-test-qa-pre-a-hub.hubqa.arcgis.com/datasets/f4bcc1035b7d46cba95e977f4affb6be_0",
"dct:language": {
"@id": "lang:GER"
},
"dcat:keyword": [
"some",
"keywords",
"from",
"metadata"
],
"dct:provenance": "Myndigheten för samhällsskydd och beredskap ( https://www.msb.se/ ); con terra ( https://www.conterra.de/); Esri (https://www.esri.com/en-us/arcgis/products/arcgis-for-inspire)",
"dct:issued": "2021-04-19T13:30:24.055-04:00",
"dcat:distribution": [
{
"@type": "dcat:Distribution",
"dcat:accessUrl": "https://download-test-qa-pre-a-hub.hubqa.arcgis.com/datasets/f4bcc1035b7d46cba95e977f4affb6be_0",
"dct:format": {
"@id": "ftype:HTML"
},
"dct:description": "Web Page",
"dct:title": "ArcGIS Hub Dataset"
}
]
}
]
}
```
See the [DCAT-AP specification](https://joinup.ec.europa.eu/collection/semantic-interoperability-community-semic/solution/dcat-application-profile-data-portals-europe/release/201-0) for more information.
## Use
Visit the [KoopJS docs](https://github.com/koopjs/koop-output-dcat-ap-201) for instructions on building and deploying a Koop app.
This package relies on the [config](https://www.npmjs.com/package/config) package for specifying configurations. Configure your ArcGIS Online environment by adding a file at `your-project/config/default.json`:
```js
{
"arcgisPortal": "https://www.arcgis.com" // or qaext or devext depending on which env you want
}
```
**Important!** This plugin requires the [`@koopjs/koop-provider-hub-search`](https://github.com/koopjs/koop-provider-hub-search) provider to function.
## Develop
```sh
# clone and install dependencies
git clone https://github.com/koopjs/koop-output-dcat-ap-201
cd koop-output-dcat-ap-201
npm i
# starts the example Koop app found in ./example-app.
npm run dev
```
## Test
Run the `npm t` commmand to spin up the automated tests.
[ts-badge]: https://img.shields.io/badge/TypeScript-4.3-blue.svg
[nodejs-badge]: https://img.shields.io/badge/Node.js->=%2014.16-blue.svg
[nodejs]: https://nodejs.org/dist/latest-v14.x/docs/api/
[gha-badge]: https://github.com/koopjs/koop-output-dcat-ap-201/actions/workflows/nodejs.yml/badge.svg
[gha-ci]: https://github.com/koopjs/koop-output-dcat-ap-201/actions/workflows/nodejs.yml
[typescript]: https://www.typescriptlang.org/
[typescript-4-3]: https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-3.html
[license-badge]: https://img.shields.io/badge/license-APLv2-blue.svg
[license]: https://github.com/koopjs/koop-output-dcat-ap-201/blob/main/LICENSE