Better date support

CHANGELOG.md

@@ -10,6 +10,11 @@
 
 ## Version History
 
+### v5.0.0
+
+- :tada: Support the `format` tag in the Schema for Dates
+- :rocket: Return Dates as ISO formatted strings to conform to schema
+
 ### v4.6.2
 
 - :bug: Fix the way headers were appended

lib/geometry.ts

@@ -2,7 +2,9 @@ import EventEmitter from 'node:events';
 import Err from '@openaddresses/batch-error';
 import rings2geojson from './rings2geojson.js';
 import Fetch from './fetch.js';
-import { Feature } from 'geojson';
+import { Feature, GeoJsonProperties } from 'geojson';
+import Schema from './schema.js'
+import { JSONSchema6, JSONSchema6Definition } from 'json-schema';
 import {
     EsriDumpConfig,
     EsriDumpConfigApproach
@@ -28,7 +30,8 @@ export default class Geometry extends EventEmitter {
     maxRecords: null | number;
     set: Set<number>;
     oidField: string;
-    paths: Path[]
+    paths: Path[];
+    schema: JSONSchema6;
 
     constructor(url: URL, metadata: any) {
         super();
@@ -40,6 +43,7 @@ export default class Geometry extends EventEmitter {
         this.maxRecords = metadata.maxRecordCount || null;
         this.set = new Set();
         this.oidField = Geometry.findOidField(metadata.fields);
+        this.schema = Schema(metadata);
     }
 
     async fetch(config: EsriDumpConfig) {
@@ -182,28 +186,35 @@ export default class Geometry extends EventEmitter {
     }
 
     toGeoJSON(esrifeature: any): Feature {
+        const id = esrifeature.attributes[this.oidField];
+        const type = 'Feature';
+        const properties: GeoJsonProperties = {}
+        for (const prop in esrifeature.attributes) {
+            const schema: JSONSchema6Definition = this.schema.properties[prop];
+
+            if (typeof schema !== 'boolean' && schema.format === 'date-time') {
+                properties[prop] = new Date(esrifeature.attributes[prop]).toISOString();
+            } else {
+                properties[prop] = esrifeature.attributes[prop];
+            }
+        }
+
         if (this.geomType === 'esriGeometryPolygon') {
             return {
-                id: esrifeature.attributes[this.oidField],
-                type: 'Feature',
-                properties: esrifeature.attributes,
+                id, type, properties,
                 geometry: rings2geojson(esrifeature.geometry.rings)
             };
         } else if (this.geomType === 'esriGeometryPolyline') {
             return {
-                id: esrifeature.attributes[this.oidField],
-                type: 'Feature',
-                properties: esrifeature.attributes,
+                id, type, properties,
                 geometry: {
                     type: 'MultiLineString',
                     coordinates: esrifeature.geometry.paths
                 }
             };
         } else if (this.geomType === 'esriGeometryPoint') {
             return {
-                id: esrifeature.attributes[this.oidField],
-                type: 'Feature',
-                properties: esrifeature.attributes,
+                id, type, properties,
                 geometry: {
                     type: 'Point',
                     coordinates: [esrifeature.geometry.x, esrifeature.geometry.y]

lib/schema.ts

@@ -1,26 +1,23 @@
-import {
-    JSONSchema6,
-    JSONSchema6TypeName
-} from 'json-schema';
+import { JSONSchema6 } from 'json-schema';
 
 // Ref: https://help.arcgis.com/en/sdk/10.0/java_ao_adf/api/arcgiswebservices/com/esri/arcgisws/EsriFieldType.html
-const Types: Map<string, JSONSchema6TypeName> = new Map([
-    ['esriFieldTypeDate', 'string'],
-    ['esriFieldTypeString', 'string'],
-    ['esriFieldTypeDouble', 'number'],
-    ['esriFieldTypeSingle', 'number'],
-    ['esriFieldTypeOID', 'number'],
-    ['esriFieldTypeInteger', 'integer'],
-    ['esriFieldTypeSmallInteger', 'integer'],
-    ['esriFieldTypeGeometry', 'object'],
-    ['esriFieldTypeBlob', 'object'],
-    ['esriFieldTypeGlobalID', 'string'],
-    ['esriFieldTypeRaster', 'object'],
-    ['esriFieldTypeGUID', 'string'],
-    ['esriFieldTypeXML', 'string'],
+const Types: Map<string, JSONSchema6> = new Map([
+    ['esriFieldTypeDate', { type: 'string', format: 'date-time' }],
+    ['esriFieldTypeString', { type: 'string' }],
+    ['esriFieldTypeDouble', { type: 'number' }],
+    ['esriFieldTypeSingle', { type: 'number' }],
+    ['esriFieldTypeOID', { type: 'number' }],
+    ['esriFieldTypeInteger', { type: 'integer' }],
+    ['esriFieldTypeSmallInteger', { type: 'integer' }],
+    ['esriFieldTypeGeometry', { type: 'object' }],
+    ['esriFieldTypeBlob', { type: 'object' }],
+    ['esriFieldTypeGlobalID', { type: 'string' }],
+    ['esriFieldTypeRaster', { type: 'object' }],
+    ['esriFieldTypeGUID', { type: 'string' }],
+    ['esriFieldTypeXML', { type: 'string' }],
 ]);
 
-export default function FieldToSchema(metadata: any) {
+export default function FieldToSchema(metadata: any): JSONSchema6 {
     const doc: JSONSchema6 = {
         type: 'object',
         required: [],
@@ -35,13 +32,13 @@ export default function FieldToSchema(metadata: any) {
     for (const field of metadata.fields) {
         const name = String(field.name);
 
-        const type: JSONSchema6TypeName = Types.has(field.type) ? Types.get(field.type) : 'string';
+        const type: JSONSchema6 = Types.has(field.type) ? Types.get(field.type) : { type: 'string' };
 
         const prop: JSONSchema6 = doc.properties[name] = {
-            type
+            ...JSON.parse(JSON.stringify(type))
         }
 
-        if (!isNaN(field.length) && type === 'string') {
+        if (!isNaN(field.length) && type.type === 'string') {
             prop.maxLength = field.length;
         }
     }