update to dcat US 3.0

sansth1010 · sansth1010 · commit 4aef6c367f9a · 2024-11-18T15:59:25.000-06:00
diff --git a/src/dcat-us/compile-dcat-feed.test.ts b/src/dcat-us/compile-dcat-feed.test.ts
@@ -2,7 +2,7 @@ import { compileDcatFeedEntry } from './compile-dcat-feed';
 import * as datasetFromApi from '../test-helpers/mock-dataset.json';
 import { DcatUsError } from './dcat-us-error';
 
-describe('generating DCAT-US 1.1 feed', () => {
+describe('generating DCAT-US 3.0 feed', () => {
   it('should throw 400 DcatUs error if template contains transformer that is not defined', async function () {
     const dcatTemplate = {
       title: '{{name}}',
@@ -24,41 +24,27 @@ describe('generating DCAT-US 1.1 feed', () => {
       title: '{{name}}',
       description: '{{description}}',
       keyword: '{{tags}}',
-      distribution: [
+      'dcat:distribution': [
         'distro1',
         'distro2',
         ['distro3', 'distro4']
       ]
     }
 
     const dcatDataset = JSON.parse(compileDcatFeedEntry(datasetFromApi, dcatTemplate, {}));
-    expect(dcatDataset.distribution).toBeDefined();
-    expect(dcatDataset.distribution).toStrictEqual(['distro1', 'distro2', 'distro3', 'distro4']);
+    expect(dcatDataset['dcat:distribution']).toBeDefined();
+    expect(dcatDataset['dcat:distribution']).toStrictEqual(['distro1', 'distro2', 'distro3', 'distro4']);
   });
 
   it('show not return uninterpolated distribution in dataset', async function () {
     const dcatTemplate = {
       title: '{{name}}',
       description: '{{description}}',
       keyword: '{{tags}}',
-      distribution: ['distro1', '{{distroname}}']
+      'dcat:distribution': ['distro1', '{{distroname}}']
     }
     const dcatDataset = JSON.parse(compileDcatFeedEntry(datasetFromApi, dcatTemplate, {}));
-    expect(dcatDataset.distribution).toStrictEqual(['distro1']);
-  });
-
-  it('should contain default theme if spatial key exists in dataset', async function () {
-    const distribution = ['distro1', '{{distroname}}'];
-    const dcatTemplate = {
-      title: '{{name}}',
-      description: '{{description}}',
-      keyword: '{{tags}}',
-      distribution,
-      spatial: '{{extent}}'
-    }
-    const dcatDataset = JSON.parse(compileDcatFeedEntry(datasetFromApi, dcatTemplate, {}));
-    expect(dcatDataset.theme).toBeDefined();
-    expect(dcatDataset.theme).toStrictEqual(['geospatial']);
+    expect(dcatDataset['dcat:distribution']).toStrictEqual(['distro1']);
   });
 
   it('should throw error if geojson from provider is missing', async function () {
diff --git a/src/dcat-us/compile-dcat-feed.ts b/src/dcat-us/compile-dcat-feed.ts
@@ -14,8 +14,9 @@ export function compileDcatFeedEntry(geojsonFeature: Feature | undefined, feedTe
     const dcatFeedItem = generateDcatItem(feedTemplate, feedTemplateTransforms, geojsonFeature);
     return indent(JSON.stringify({
       ...dcatFeedItem,
-      distribution: Array.isArray(dcatFeedItem.distribution) && removeUninterpolatedDistributions(_.flatten(dcatFeedItem.distribution)),
-      theme: dcatFeedItem.spatial && ['geospatial']
+      'dcat:distribution': 
+        Array.isArray(dcatFeedItem['dcat:distribution']) && 
+        removeUninterpolatedDistributions(_.flatten(dcatFeedItem['dcat:distribution'])),
     }, null, '\t'), 2);
   } catch (err) {
     throw new DcatUsError(err.message, 400);
diff --git a/src/dcat-us/constants/contexts.ts b/src/dcat-us/constants/contexts.ts
@@ -0,0 +1,48 @@
+export const HEADER_V3 = {
+    '@context': {
+        '@version': 1.1,
+        '@protected': true,
+        'adms': 'http://www.w3.org/ns/adms#',
+        'cnt': 'http://www.w3.org/2011/content#',
+        'dash': 'http://datashapes.org/dash#',
+        'dcat': 'http://www.w3.org/ns/dcat#',
+        'dcatap': 'http://data.europa.eu/r5r/',
+        'dcat-us': 'http://data.resources.gov/ontology/dcat-us#',
+        'dcat-us-shp': 'http://data.resources.gov/shapes/dcat-us#',
+        'dcterms': 'http://purl.org/dc/terms/',
+        'dqv': 'http://www.w3.org/ns/dqv#',
+        'foaf': 'http://xmlns.com/foaf/0.1/',
+        'gsp': 'http://www.opengis.net/ont/geosparql#',
+        'locn': 'http://www.w3.org/ns/locn#',
+        'odrs': 'http://schema.theodi.org/odrs#',
+        'org': 'http://www.w3c.org/ns/org#',
+        'owl': 'http://www.w3.org/2002/07/owl#',
+        'prov': 'http://www.w3.org/ns/prov#',
+        'rdf': 'http://www.w3.org/1999/02/22-rdf-syntax-ns#',
+        'rdfs': 'http://www.w3.org/2000/01/rdf-schema#',
+        'schema': 'http://schema.org/',
+        'sh': 'http://www.w3.org/ns/shacl#',
+        'skos': 'http://www.w3.org/2004/02/skos/core#',
+        'sdmx-attribute': 'http://purl.org/linked-data/sdmx/2009/attribute#',
+        'spdx': 'http://spdx.org/rdf/terms#',
+        'vcard': 'http://www.w3.org/2006/vcard/ns#',
+        "xsd": "http://www.w3.org/2001/XMLSchema#",
+        'adms:Identifier': {
+            '@id': 'adms:Identifier',
+            '@context': {
+                'schemaAgency': 'http://www.w3.org/ns/adms#schemaAgency',
+                'creator': {
+                    '@id': 'dcterms:creator',
+                    '@type': '@id'
+                },
+                'issued': {
+                    '@id': 'dcterms:issued'
+                },
+                'version': 'http://purl.org/dc/terms/version',
+                'notation': 'http://www.w3.org/2004/02/skos/core#notation'
+            }
+        },
+    },
+    '@type': 'dcat:Catalog',
+    conformsTo: 'https://resource.data.gov/profile/dcat-us#',
+};
diff --git a/src/dcat-us/index.test.ts b/src/dcat-us/index.test.ts
@@ -1,6 +1,7 @@
 import { readableFromArray, streamToString } from '../test-helpers/stream-utils';
 import { getDataStreamDcatUs11 } from './';
 import * as datasetFromApi from '../test-helpers/mock-dataset.json';
+import { HEADER_V3 } from './constants/contexts';
 
 async function generateDcatFeed(dataset, template, templateTransforms) {
   const { stream: dcatStream } = getDataStreamDcatUs11(template, templateTransforms);
@@ -10,15 +11,14 @@ async function generateDcatFeed(dataset, template, templateTransforms) {
   return { feed: JSON.parse(feedString) };
 }
 
-describe('generating DCAT-US 1.1 feed', () => {
+describe('generating DCAT-US 3.0 feed', () => {
   it('formats catalog correctly', async function () {
     const { feed } = await generateDcatFeed([], {}, {});
 
-    expect(feed['@context']).toBe('https://project-open-data.cio.gov/v1.1/schema/catalog.jsonld');
+    expect(feed['@context']).toStrictEqual(HEADER_V3['@context']);
+    expect(feed['conformsTo']).toBe('https://resource.data.gov/profile/dcat-us#');
     expect(feed['@type']).toBe('dcat:Catalog');
-    expect(feed['conformsTo']).toBe('https://project-open-data.cio.gov/v1.1/schema');
-    expect(feed['describedBy']).toBe('https://project-open-data.cio.gov/v1.1/schema/catalog.json');
-    expect(Array.isArray(feed['dataset'])).toBeTruthy();
+    expect(Array.isArray(feed['dcat:dataset'])).toBeTruthy();
   });
 
   it('should interprolate dataset stream to feed based upon template', async function () {
@@ -35,20 +35,23 @@ describe('generating DCAT-US 1.1 feed', () => {
         '@type': 'vcard:Contact',
         fn: '{{owner}}',
         hasEmail: '{{orgContactEmail:optional}}'
+      },
+      header: {
+        '@id': 'hub.arcgis.com'
       }
     }, {
       toISO: (_key, val) => {
         return new Date(val).toISOString();
       }
     });
 
-    expect(feed['@context']).toBe('https://project-open-data.cio.gov/v1.1/schema/catalog.jsonld');
+    expect(feed['@context']).toStrictEqual(HEADER_V3['@context']);
     expect(feed['@type']).toBe('dcat:Catalog');
-    expect(feed['conformsTo']).toBe('https://project-open-data.cio.gov/v1.1/schema');
-    expect(feed['describedBy']).toBe('https://project-open-data.cio.gov/v1.1/schema/catalog.json');
-    expect(Array.isArray(feed['dataset'])).toBeTruthy();
-    expect(feed['dataset'].length).toBe(1);
-    const feedResponse = feed['dataset'][0];
+    expect(feed['@id']).toBe('hub.arcgis.com');
+    expect(feed['conformsTo']).toBe('https://resource.data.gov/profile/dcat-us#');
+    expect(Array.isArray(feed['dcat:dataset'])).toBeTruthy();
+    expect(feed['dcat:dataset'].length).toBe(1);
+    const feedResponse = feed['dcat:dataset'][0];
     expect(feedResponse.title).toBe('Tahoe places of interest');
     expect(feedResponse.description).toBe('Description. Here be Tahoe things. You can do a lot here. Here are some more words. And a few more.<div><br /></div><div>with more words</div><div><br /></div><div>adding a few more to test how long it takes for our jobs to execute.</div><div><br /></div><div>Tom was here!</div>');
     expect(feedResponse.issued).toBe('2021-01-29T15:34:38.000Z');
diff --git a/src/dcat-us/index.ts b/src/dcat-us/index.ts
@@ -1,28 +1,20 @@
 import { compileDcatFeedEntry } from './compile-dcat-feed';
 import { FeedFormatterStream } from './feed-formatter-stream';
 import { TransformsList } from 'adlib';
+import { HEADER_V3 } from './constants/contexts';
 
 export function getDataStreamDcatUs11(feedTemplate: any, feedTemplateTransforms: TransformsList) {
-  const catalogStr = JSON.stringify({
-    '@context':
-      'https://project-open-data.cio.gov/v1.1/schema/catalog.jsonld',
-    '@type': 'dcat:Catalog',
-    conformsTo: 'https://project-open-data.cio.gov/v1.1/schema',
-    describedBy: 'https://project-open-data.cio.gov/v1.1/schema/catalog.json',
-  }, null, '\t');
-
-  const header = `${catalogStr.substr(
-    0,
-    catalogStr.length - 2,
-  )},\n\t"dataset": [\n`;
-
   const footer = '\n\t]\n}';
+  const { header: templateHeader, ...restFeedTemplate } = feedTemplate;
+
+  const catalogStr = JSON.stringify({ ...HEADER_V3, ...templateHeader }, null, '\t');
+  const header = `${catalogStr.substring(0, catalogStr.length - 2)},\n\t"dcat:dataset": [\n`;
 
   const formatFn = (chunk) => {
-    return compileDcatFeedEntry(chunk, feedTemplate, feedTemplateTransforms);
+    return compileDcatFeedEntry(chunk, restFeedTemplate, feedTemplateTransforms);
   };
 
   return {
     stream: new FeedFormatterStream(header, footer, ',\n', formatFn)
   };
-}
+}
diff --git a/src/index.test.ts b/src/index.test.ts
@@ -60,7 +60,7 @@ describe('Output Plugin', () => {
       title: '{{name}}',
       description: '{{description}}',
       keyword: '{{tags}}',
-      issued: '{{created}}'
+      issued: '{{created}}',
     }
 
     mockConfigModule = mocked(require('config'), true);
@@ -82,7 +82,7 @@ describe('Output Plugin', () => {
     expect(plugin.constructor.version).toBeDefined();
     expect(plugin.constructor.routes).toEqual([
       {
-        path: '/dcat-us/1.1',
+        path: '/dcat-us/3.0',
         methods: ['get'],
         handler: 'serve',
       },
@@ -124,8 +124,8 @@ describe('Output Plugin', () => {
         const dcatStream = res.body;
         expect(dcatStream['@context']).toBeDefined();
         expect(dcatStream['@type']).toBe('dcat:Catalog');
-        expect(dcatStream['dataset']).toBeInstanceOf(Array);
-        expect(dcatStream['dataset'].length).toBe(1);
+        expect(dcatStream['dcat:dataset']).toBeInstanceOf(Array);
+        expect(dcatStream['dcat:dataset'].length).toBe(1);
       });
   });
 
diff --git a/src/index.ts b/src/index.ts
@@ -10,7 +10,7 @@ export = class OutputDcatUs11 {
   static version = version;
   static routes = [
     {
-      path: '/dcat-us/1.1',
+      path: '/dcat-us/3.0',
       methods: ['get'],
       handler: 'serve',
     },

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ export = class OutputDcatUs11 {`
`10`	`10`	`static version = version;`
`11`	`11`	`static routes = [`
`12`	`12`	`{`
`13`		`- path: '/dcat-us/1.1',`
	`13`	`+ path: '/dcat-us/3.0',`
`14`	`14`	`methods: ['get'],`
`15`	`15`	`handler: 'serve',`
`16`	`16`	`},`