feat: accept newer JSON Schema drafts

P0lip · P0lip · commit dd45b48f5c9b · 2021-04-27T22:26:18.000+02:00
diff --git a/package.json b/package.json
@@ -36,18 +36,18 @@
   },
   "peerDependencies": {},
   "dependencies": {
-    "@stoplight/json": "^3.10.0",
+    "@stoplight/json": "^3.12.0",
     "@stoplight/json-schema-merge-allof": "^0.7.5",
     "@stoplight/lifecycle": "^2.3.2",
+    "@types/json-schema": "^7.0.7",
     "magic-error": "^0.0.0"
   },
   "devDependencies": {
     "@rollup/plugin-typescript": "3",
     "@stoplight/eslint-config": "^2.0.0",
     "@stoplight/scripts": "8.2.1",
-    "@stoplight/types": "^11.9.0",
+    "@stoplight/types": "^12.0.0",
     "@types/jest": "^26.0.19",
-    "@types/json-schema": "^7.0.6",
     "@types/node": "^14.14.14",
     "@types/treeify": "^1.0.0",
     "@typescript-eslint/eslint-plugin": "^4.11.0",
diff --git a/src/accessors/getValidations.ts b/src/accessors/getValidations.ts
@@ -1,22 +1,12 @@
 import type { Dictionary } from '@stoplight/types';
-import type { JSONSchema4 } from 'json-schema';
 
 import type { SchemaNodeKind } from '../nodes/types';
 import type { SchemaFragment } from '../types';
 import { pick } from '../utils/pick';
 
-export const COMMON_VALIDATION_TYPES: (keyof JSONSchema4)[] = [
-  'default',
-  'example',
-  'nullable',
-  'discriminator',
-  'readOnly',
-  'writeOnly',
-  'xml',
-  'externalDocs',
-];
-
-const VALIDATION_TYPES: Partial<Dictionary<(keyof JSONSchema4)[], SchemaNodeKind>> = {
+export const COMMON_VALIDATION_TYPES: string[] = ['readOnly', 'writeOnly'];
+
+const VALIDATION_TYPES: Partial<Dictionary<(keyof SchemaFragment)[], SchemaNodeKind>> = {
   string: ['minLength', 'maxLength', 'pattern'],
   number: ['multipleOf', 'minimum', 'exclusiveMinimum', 'maximum', 'exclusiveMaximum'],
   get integer() {
@@ -26,8 +16,8 @@ const VALIDATION_TYPES: Partial<Dictionary<(keyof JSONSchema4)[], SchemaNodeKind
   array: ['additionalItems', 'minItems', 'maxItems', 'uniqueItems'],
 };
 
-function getTypeValidations(types: SchemaNodeKind[]): (keyof JSONSchema4)[] | null {
-  let extraValidations: (keyof JSONSchema4)[] | null = null;
+function getTypeValidations(types: SchemaNodeKind[]): (keyof SchemaFragment)[] | null {
+  let extraValidations: (keyof SchemaFragment)[] | null = null;
 
   for (const type of types) {
     const value = VALIDATION_TYPES[type];
diff --git a/src/nodes/types.ts b/src/nodes/types.ts
@@ -25,6 +25,6 @@ export enum SchemaCombinerName {
   OneOf = 'oneOf',
 }
 
-export type SchemaAnnotations = 'description' | 'default' | 'examples' | 'const' | 'x-example';
+export type SchemaAnnotations = 'description' | 'default' | 'examples' | 'const' | 'example' | 'x-example';
 
 export type SchemaMeta = 'id' | '$schema';
diff --git a/src/tree/tree.ts b/src/tree/tree.ts
@@ -62,13 +62,15 @@ export class SchemaTree {
       throw new ResolvingError('Cannot dereference external references');
     } else if (pointer === null) {
       throw new ResolvingError('The pointer is empty');
-    } else {
+    } else if (isObjectLiteral(this.schema)) {
       const value = resolveInlineRef(this.schema, pointer);
       if (!isObjectLiteral(value)) {
         throw new ResolvingError('Invalid value');
       }
 
       return value;
+    } else {
+      throw new ResolvingError('Unexpected input');
     }
   };
 }
diff --git a/src/types.ts b/src/types.ts
@@ -1,6 +1,5 @@
-import type { Dictionary } from '@stoplight/types';
-import type { JSONSchema4 } from 'json-schema';
+import type { JSONSchema4, JSONSchema6, JSONSchema7 } from 'json-schema';
 
 export type ViewMode = 'read' | 'write' | 'standalone';
 
-export type SchemaFragment = Dictionary<unknown, keyof JSONSchema4>;
+export type SchemaFragment = Record<string, unknown> | JSONSchema4 | JSONSchema6 | JSONSchema7;
diff --git a/src/utils/pick.ts b/src/utils/pick.ts
@@ -1,6 +1,6 @@
 import type { Dictionary } from '@stoplight/types';
 
-export function pick(target: Dictionary<unknown>, keys: (string | number)[]) {
+export function pick(target: object, keys: (string | number)[]) {
   const source: Dictionary<unknown, string | number> = {};
 
   for (const key of keys) {
diff --git a/yarn.lock b/yarn.lock
@@ -945,10 +945,10 @@
     json-schema-compare "^0.2.2"
     lodash "^4.17.4"
 
-"@stoplight/json@^3.10.0":
-  version "3.10.0"
-  resolved "https://registry.yarnpkg.com/@stoplight/json/-/json-3.10.0.tgz#bd1af55081e1a47e0d01552d2a7e756931f46a4b"
-  integrity sha512-Xb1kVQ0t5eqRDF24Y0a2A1o/CEaHjLeVehkBmphqEBkUo6X9L4z5oOUYBMzlAoR/ejhjVgWLzrDBxNOuzBFVDA==
+"@stoplight/json@^3.12.0":
+  version "3.12.0"
+  resolved "https://registry.yarnpkg.com/@stoplight/json/-/json-3.12.0.tgz#26c8d32da78eac6a760ba2c9cca6ae717dc417b4"
+  integrity sha512-c0bvFOGICk8QWIat72Td2GG6Bdvq/6O2jQcDZ8rEjh56YOdC/YPn1S8ihKu3AntJCtvqC9eTfadWBqkNK9HAjw==
   dependencies:
     "@stoplight/ordered-object-literal" "^1.0.1"
     "@stoplight/types" "^11.9.0"
@@ -1006,6 +1006,14 @@
     "@types/json-schema" "^7.0.4"
     utility-types "^3.10.0"
 
+"@stoplight/types@^12.0.0":
+  version "12.0.0"
+  resolved "https://registry.yarnpkg.com/@stoplight/types/-/types-12.0.0.tgz#3fc68ffa954e7c0a0e6261a982d5c0cb52d5d969"
+  integrity sha512-BbL0MIbcCwrU4RidcVyMKnRwACnhr7WAEgPH8d6rwhg/j2DegdLadnXCnq8UJXUWW9Apbntgvic3yVGvLtVmxA==
+  dependencies:
+    "@types/json-schema" "^7.0.4"
+    utility-types "^3.10.0"
+
 "@tootallnate/once@1":
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/@tootallnate/once/-/once-1.0.0.tgz#9c13c2574c92d4503b005feca8f2e16cc1611506"
@@ -1088,10 +1096,10 @@
     jest-diff "^26.0.0"
     pretty-format "^26.0.0"
 
-"@types/json-schema@^7.0.3", "@types/json-schema@^7.0.4", "@types/json-schema@^7.0.6":
-  version "7.0.6"
-  resolved "https://registry.yarnpkg.com/@types/json-schema/-/json-schema-7.0.6.tgz#f4c7ec43e81b319a9815115031709f26987891f0"
-  integrity sha512-3c+yGKvVP5Y9TYBEibGNR+kLtijnj7mYrXRg+WpFb2X9xm04g/DXYkfg4hmzJQosc9snFNUPkbYIhu+KAm6jJw==
+"@types/json-schema@^7.0.3", "@types/json-schema@^7.0.4", "@types/json-schema@^7.0.7":
+  version "7.0.7"
+  resolved "https://registry.yarnpkg.com/@types/json-schema/-/json-schema-7.0.7.tgz#98a993516c859eb0d5c4c8f098317a9ea68db9ad"
+  integrity sha512-cxWFQVseBm6O9Gbw1IWb8r6OS4OhSt3hPZLkFApLjM8TEXROBuQGLAH2i2gZpcXdLBIrpXuTDhH7Vbm1iXmNGA==
 
 "@types/json5@^0.0.29":
   version "0.0.29"
@@ -1922,9 +1930,9 @@ chalk@^3.0.0:
     supports-color "^7.1.0"
 
 chalk@^4.0.0:
-  version "4.1.0"
-  resolved "https://registry.yarnpkg.com/chalk/-/chalk-4.1.0.tgz#4e14870a618d9e2edd97dd8345fd9d9dc315646a"
-  integrity sha512-qwx12AxXe2Q5xQ43Ac//I6v5aXTipYrSESdOgzrN+9XjgEpyjpKuvSGaN4qE93f7TQTlerQQ8S+EQ0EyDoVL1A==
+  version "4.1.1"
+  resolved "https://registry.yarnpkg.com/chalk/-/chalk-4.1.1.tgz#c80b3fab28bf6371e6863325eee67e618b77e6ad"
+  integrity sha512-diHzdDKxcU+bAsUboHLPEDQiw0qEe0qd7SYUn3HgcFlWgbDcfLGswOHYeGrHKzG9z6UYf01d9VFMfZxPM1xZSg==
   dependencies:
     ansi-styles "^4.1.0"
     supports-color "^7.1.0"
@@ -4079,9 +4087,9 @@ iferr@^1.0.2:
   integrity sha512-9AfeLfji44r5TKInjhz3W9DyZI1zR1JAf2hVBMGhddAKPqBsupb89jGfbCTHIGZd6fGZl9WlHdn4AObygyMKwg==
 
 ignore-walk@^3.0.1:
-  version "3.0.1"
-  resolved "https://registry.yarnpkg.com/ignore-walk/-/ignore-walk-3.0.1.tgz#a83e62e7d272ac0e3b551aaa82831a19b69f82f8"
-  integrity sha512-DTVlMx3IYPe0/JJcYP7Gxg7ttZZu3IInhuEhbchuqneY9wWe5Ojy2mXLBaQFUQmo0AW2r3qG7m1mg86js+gnlQ==
+  version "3.0.3"
+  resolved "https://registry.yarnpkg.com/ignore-walk/-/ignore-walk-3.0.3.tgz#017e2447184bfeade7c238e4aefdd1e8f95b1e37"
+  integrity sha512-m7o6xuOaT1aqheYHKf8W6J5pYH85ZI9w077erOzLje3JsB1gkafkAhHHY19dqjulgIZHFm32Cp5uNZgcQqdJKw==
   dependencies:
     minimatch "^3.0.4"
 
@@ -4091,9 +4099,9 @@ ignore@^4.0.6:
   integrity sha512-cyFDKrqc/YdcWFniJhzI42+AzS+gNwmUzOSFcRCQYwySuBBBy/KjuxWLZ/FHEH6Moq1NizMOBWyTcv8O4OZIMg==
 
 ignore@^5.1.4:
-  version "5.1.4"
-  resolved "https://registry.yarnpkg.com/ignore/-/ignore-5.1.4.tgz#84b7b3dbe64552b6ef0eca99f6743dbec6d97adf"
-  integrity sha512-MzbUSahkTW1u7JpKKjY7LCARd1fU5W2rLdxlM4kdkayuCwZImjkpluF9CM1aLewYJguPDqewLam18Y6AU69A8A==
+  version "5.1.8"
+  resolved "https://registry.yarnpkg.com/ignore/-/ignore-5.1.8.tgz#f150a8b50a34289b33e22f5889abd4d8016f0e57"
+  integrity sha512-BMpfD7PpiETpBl/A6S498BaIJ6Y/ABT93ETbby2fP00v4EbvPBXWEoaR1UBPKs3iR53pJY7EtZk5KACI57i1Uw==
 
 import-fresh@^2.0.0:
   version "2.0.0"
@@ -6186,9 +6194,11 @@ npm-audit-report@^1.3.2:
     console-control-strings "^1.1.0"
 
 npm-bundled@^1.0.1:
-  version "1.0.6"
-  resolved "https://registry.yarnpkg.com/npm-bundled/-/npm-bundled-1.0.6.tgz#e7ba9aadcef962bb61248f91721cd932b3fe6bdd"
-  integrity sha512-8/JCaftHwbd//k6y2rEWp6k1wxVfpFzB6t1p825+cUb7Ym2XQfhwIC5KwhrvzZRJu+LtDE585zVaS32+CGtf0g==
+  version "1.1.2"
+  resolved "https://registry.yarnpkg.com/npm-bundled/-/npm-bundled-1.1.2.tgz#944c78789bd739035b70baa2ca5cc32b8d860bc1"
+  integrity sha512-x5DHup0SuyQcmL3s7Rx/YQ8sbw/Hzg0rj48eN0dV7hf5cmQq5PXIeioroH3raV1QC1yh3uTYuMThvEQF3iKgGQ==
+  dependencies:
+    npm-normalize-package-bin "^1.0.1"
 
 npm-cache-filename@~1.0.2:
   version "1.0.2"
@@ -6221,6 +6231,11 @@ npm-logical-tree@^1.2.1:
   resolved "https://registry.yarnpkg.com/npm-logical-tree/-/npm-logical-tree-1.2.1.tgz#44610141ca24664cad35d1e607176193fd8f5b88"
   integrity sha512-AJI/qxDB2PWI4LG1CYN579AY1vCiNyWfkiquCsJWqntRu/WwimVrC8yXeILBFHDwxfOejxewlmnvW9XXjMlYIg==
 
+npm-normalize-package-bin@^1.0.1:
+  version "1.0.1"
+  resolved "https://registry.yarnpkg.com/npm-normalize-package-bin/-/npm-normalize-package-bin-1.0.1.tgz#6e79a41f23fd235c0623218228da7d9c23b8f6e2"
+  integrity sha512-EPfafl6JL5/rU+ot6P3gRSCpPDW5VmIzX959Ob1+ySFUuuYHWHekXpwdUZcKP5C+DS4GEtdJluwBjnsNDl+fSA==
+
 "npm-package-arg@^4.0.0 || ^5.0.0 || ^6.0.0", npm-package-arg@^6.0.0, npm-package-arg@^6.1.0, npm-package-arg@^6.1.1:
   version "6.1.1"
   resolved "https://registry.yarnpkg.com/npm-package-arg/-/npm-package-arg-6.1.1.tgz#02168cb0a49a2b75bf988a28698de7b529df5cb7"
@@ -9120,9 +9135,9 @@ yaml@^1.7.2:
     "@babel/runtime" "^7.6.3"
 
 yargs-parser@20.x:
-  version "20.2.3"
-  resolved "https://registry.yarnpkg.com/yargs-parser/-/yargs-parser-20.2.3.tgz#92419ba867b858c868acf8bae9bf74af0dd0ce26"
-  integrity sha512-emOFRT9WVHw03QSvN5qor9QQT9+sw5vwxfYweivSMHTcAXPefwVae2FjO7JJjj8hCE4CzPOPeFM83VwT29HCww==
+  version "20.2.7"
+  resolved "https://registry.yarnpkg.com/yargs-parser/-/yargs-parser-20.2.7.tgz#61df85c113edfb5a7a4e36eb8aa60ef423cbc90a"
+  integrity sha512-FiNkvbeHzB/syOjIUxFDCnhSfzAL8R5vs40MgLFBorXACCOAEaWu0gRZl14vG8MR9AOJIZbmkjhusqBYZ3HTHw==
 
 yargs-parser@^10.0.0:
   version "10.1.0"

Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,6 @@ export enum SchemaCombinerName {`
`25`	`25`	`OneOf = 'oneOf',`
`26`	`26`	`}`
`27`	`27`
`28`		`-export type SchemaAnnotations = 'description' \| 'default' \| 'examples' \| 'const' \| 'x-example';`
	`28`	`+export type SchemaAnnotations = 'description' \| 'default' \| 'examples' \| 'const' \| 'example' \| 'x-example';`
`29`	`29`
`30`	`30`	`export type SchemaMeta = 'id' \| '$schema';`
Original file line number	Diff line number	Diff line change
`@@ -62,13 +62,15 @@ export class SchemaTree {`
`62`	`62`	`throw new ResolvingError('Cannot dereference external references');`
`63`	`63`	`} else if (pointer === null) {`
`64`	`64`	`throw new ResolvingError('The pointer is empty');`
`65`		`- } else {`
	`65`	`+ } else if (isObjectLiteral(this.schema)) {`
`66`	`66`	`const value = resolveInlineRef(this.schema, pointer);`
`67`	`67`	`if (!isObjectLiteral(value)) {`
`68`	`68`	`throw new ResolvingError('Invalid value');`
`69`	`69`	`}`
`70`	`70`
`71`	`71`	`return value;`
	`72`	`+ } else {`
	`73`	`+ throw new ResolvingError('Unexpected input');`
`72`	`74`	`}`
`73`	`75`	`};`
`74`	`76`	`}`