Skip to content

Specify format: 'date-time' for date properties #322

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Apr 27, 2023
Merged

Specify format: 'date-time' for date properties #322

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
0eac661
Specify format: 'date-time' for date properties
duncanmak Apr 25, 2023
a5b7b49
Remove JTD-specific option
duncanmak Apr 25, 2023
dfd65cb
Update ajv-formats to 3.0.0-rc.0 to get date-time fixes
duncanmak Apr 25, 2023
3391b46
Don't include ajv-formats and inline the date-time format regex
duncanmak Apr 26, 2023
59cc6ba
Update tests to make dateCreated validate
duncanmak Apr 26, 2023
2189fd3
Inline the date strings
duncanmak Apr 26, 2023
f425557
Use toTemporalInstant instead of hardcoding the datetime strings
duncanmak Apr 26, 2023
9c1ef77
Introduce createDateString helper function instead of modifying Date.…
duncanmak Apr 26, 2023
ff935e0
updated regex and moved it into definitions.json
thehenrytsai Apr 27, 2023
2683801
added tests
thehenrytsai Apr 27, 2023
301f22f
Merge branch 'main' into date-time-in-json-schema
thehenrytsai Apr 27, 2023
ce9ec7c
addressed review comments
thehenrytsai Apr 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions build/compile-validators.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,14 @@
* - to reduce the browser bundle size - Ajv is not included in the bundle
* - to reduce the start-up time - the validation and compilation of schemas will happen during build time.
*/
import addFormats from 'ajv-formats';

import fs from 'node:fs';
import path from 'node:path';
import url from 'node:url';

import Ajv from 'ajv';

import mkdirp from 'mkdirp';
import standaloneCode from 'ajv/dist/standalone/index.js';

Expand Down Expand Up @@ -60,6 +62,7 @@ const schemas = {
};

const ajv = new Ajv({ code: { source: true, esm: true } });
addFormats(ajv);

for (const schemaName in schemas) {
ajv.addSchema(schemas[schemaName], schemaName);
Expand Down
3 changes: 2 additions & 1 deletion json-schemas/hooks/hooks-write.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@
"type": "string"
},
"dateCreated": {
"type": "string"
"type": "string",
"format": "date-time"
},
"schema": {
"type": "string"
Expand Down
9 changes: 6 additions & 3 deletions json-schemas/records/records-query.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@
"type": "string"
},
"dateCreated": {
"type": "string"
"type": "string",
"format": "date-time"
},
"filter": {
"type": "object",
Expand Down Expand Up @@ -71,10 +72,12 @@
"additionalProperties": false,
"properties": {
"from": {
"type": "string"
"type": "string",
"format": "date-time"
},
"to": {
"type": "string"
"type": "string",
"format": "date-time"
}
}
}
Expand Down
9 changes: 6 additions & 3 deletions json-schemas/records/records-write.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,16 +121,19 @@
"type": "number"
},
"dateCreated": {
"type": "string"
"type": "string",
"format": "date-time"
},
"dateModified": {
"type": "string"
"type": "string",
"format": "date-time"
},
"published": {
"type": "boolean"
},
"datePublished": {
"type": "string"
"type": "string",
"format": "date-time"
},
"dataFormat": {
"type": "string"
Expand Down
39 changes: 32 additions & 7 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,8 @@
"@types/readable-stream": "2.3.15",
"@types/secp256k1": "4.0.3",
"abstract-level": "1.0.3",
"ajv": "8.11.0",
"ajv": "8.12.0",
"ajv-formats": "^3.0.0-rc.0",
"blockstore-core": "3.0.0",
"cross-fetch": "3.1.5",
"date-fns": "2.28.0",
Expand Down