feat: primary type (#18)

P0lip · web-flow · commit f7df910bb111 · 2019-05-17T02:11:33.000+02:00
* feat: type inference * fix: subtype validations * revert: "fix: subtype validations" This reverts commit 25463f3. * chore: lodash imports * fix: array of
diff --git a/src/__fixtures__/array-of-refs.json b/src/__fixtures__/array-of-refs.json
@@ -0,0 +1,6 @@
+{
+  "type": "array",
+  "items": {
+    "$ref": "./models/todo-full.json"
+  }
+}
diff --git a/src/components/SchemaTree.tsx b/src/components/SchemaTree.tsx
@@ -2,7 +2,7 @@ import { TreeList, TreeListMouseEventHandler, TreeStore } from '@stoplight/tree-
 import { Omit } from '@stoplight/types';
 import { Box, IBox, ThemeZone } from '@stoplight/ui-kit';
 import { JSONSchema4 } from 'json-schema';
-import _isEmpty = require('lodash/isEmpty');
+import { isEmpty as _isEmpty } from 'lodash';
 import * as React from 'react';
 import { useMetadata } from '../hooks';
 import { useTheme } from '../theme';
diff --git a/src/components/Type.tsx b/src/components/Type.tsx
@@ -2,7 +2,7 @@ import { Box, IBoxCSS } from '@stoplight/ui-kit';
 import { JSONSchema4TypeName } from 'json-schema';
 import * as React from 'react';
 import { IJsonSchemaViewerTheme, useTheme } from '../theme';
-import { JSONSchema4CombinerName } from '../types';
+import { ITreeNodeMeta, JSONSchema4CombinerName } from '../types';
 
 export const Type: React.FunctionComponent<IType> = ({ type, subtype, children }) => {
   const theme = useTheme() as IJsonSchemaViewerTheme;
@@ -18,7 +18,7 @@ export const Type: React.FunctionComponent<IType> = ({ type, subtype, children }
 
 export interface IType {
   type: JSONSchema4TypeName | JSONSchema4CombinerName | '$ref';
-  subtype?: JSONSchema4TypeName | JSONSchema4TypeName[];
+  subtype?: ITreeNodeMeta['subtype'];
 }
 
 export const rowStyles = (theme: IJsonSchemaViewerTheme, { type }: IType): IBoxCSS => {
diff --git a/src/components/Types.tsx b/src/components/Types.tsx
@@ -1,12 +1,12 @@
 import { JSONSchema4TypeName } from 'json-schema';
 import * as React from 'react';
-import { JSONSchema4CombinerName } from '../types';
+import { ITreeNodeMeta, JSONSchema4CombinerName } from '../types';
 import { MutedText } from './common/MutedText';
 import { Type } from './Type';
 
 interface ITypes {
   type?: JSONSchema4TypeName | JSONSchema4TypeName[] | JSONSchema4CombinerName;
-  subtype?: JSONSchema4TypeName | JSONSchema4TypeName[];
+  subtype?: ITreeNodeMeta['subtype'];
 }
 
 export const Types: React.FunctionComponent<ITypes> = ({ type, subtype }) => {
diff --git a/src/types.ts b/src/types.ts
@@ -56,7 +56,7 @@ export interface ITreeNodeMeta {
   additional?: IArrayNode['additionalItems'] | IObjectNode['additionalProperties'];
   path: JsonPath;
   divider?: string;
-  subtype?: IBaseNode['type'];
+  subtype?: IBaseNode['type'] | string;
   expanded?: boolean;
   required?: boolean;
   inheritedFrom?: string;
diff --git a/src/utils/__tests__/__snapshots__/renderSchema.spec.ts.snap b/src/utils/__tests__/__snapshots__/renderSchema.spec.ts.snap
@@ -49,7 +49,9 @@ Array [
       ],
       "required": false,
       "subtype": "object",
-      "type": "array",
+      "type": Array [
+        "array",
+      ],
       "validations": Object {},
     },
     "name": "",
@@ -77,6 +79,27 @@ Array [
 ]
 `;
 
+exports[`renderSchema util should match array-of-refs.json 1`] = `
+Array [
+  Object {
+    "id": "random-id",
+    "level": 0,
+    "metadata": Object {
+      "additionalItems": undefined,
+      "annotations": Object {},
+      "enum": undefined,
+      "id": "random-id",
+      "items": undefined,
+      "path": Array [],
+      "subtype": "$ref( ./models/todo-full.json )",
+      "type": "array",
+      "validations": Object {},
+    },
+    "name": "",
+  },
+]
+`;
+
 exports[`renderSchema util should match combiner-schema.json 1`] = `
 Array [
   Object {
@@ -479,9 +502,11 @@ Array [
     "id": "random-id",
     "level": 1,
     "metadata": Object {
+      "additionalItems": undefined,
       "annotations": Object {},
       "enum": undefined,
       "id": "random-id",
+      "items": undefined,
       "name": "items",
       "path": Array [
         "properties",
diff --git a/src/utils/__tests__/renderSchema.spec.ts b/src/utils/__tests__/renderSchema.spec.ts
@@ -14,6 +14,7 @@ describe('renderSchema util', () => {
     ['ref/original.json', 'ref/resolved.json'],
     ['combiner-schema.json', ''],
     ['array-of-objects.json', ''],
+    ['array-of-refs.json', ''],
   ])('should match %s', (schema, dereferenced) => {
     expect(
       Array.from(
diff --git a/src/utils/getAnnotations.ts b/src/utils/getAnnotations.ts
@@ -1,5 +1,5 @@
 import { JSONSchema4 } from 'json-schema';
-import _pick = require('lodash/pick');
+import { pick as _pick } from 'lodash';
 import { JSONSchema4Annotations } from '../types';
 
 const ANNOTATIONS: JSONSchema4Annotations[] = ['title', 'description', 'default', 'examples'];
diff --git a/src/utils/getMetadata.ts b/src/utils/getMetadata.ts
@@ -1,5 +1,5 @@
 import { JSONSchema4 } from 'json-schema';
-import _pick = require('lodash/pick');
+import { pick as _pick } from 'lodash';
 import { JSONSchema4Metadata } from '../types';
 
 const METADATA: JSONSchema4Metadata[] = ['id', '$schema'];
diff --git a/src/utils/getPrimaryType.ts b/src/utils/getPrimaryType.ts
@@ -0,0 +1,21 @@
+import { JSONSchema4 } from 'json-schema';
+import { SchemaKind } from '../types';
+import { inferType } from './inferType';
+
+export function getPrimaryType(node: JSONSchema4) {
+  if (node.type !== undefined) {
+    if (Array.isArray(node.type)) {
+      if (node.type.includes(SchemaKind.Object)) {
+        return SchemaKind.Object;
+      }
+
+      if (node.type.includes(SchemaKind.Array)) {
+        return SchemaKind.Array;
+      }
+    }
+
+    return node.type;
+  }
+
+  return inferType(node);
+}
diff --git a/src/utils/getValidations.ts b/src/utils/getValidations.ts
@@ -1,7 +1,6 @@
 import { Dictionary } from '@stoplight/types';
 import { JSONSchema4, JSONSchema4TypeName } from 'json-schema';
-import _flatMap = require('lodash/flatMap');
-import _pick = require('lodash/pick');
+import { flatMap as _flatMap, pick as _pick } from 'lodash';
 
 export const COMMON_VALIDATION_TYPES = [
   'enum', // https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1
diff --git a/src/utils/inferType.ts b/src/utils/inferType.ts
@@ -0,0 +1,14 @@
+import { JSONSchema4, JSONSchema4TypeName } from 'json-schema';
+import { SchemaKind } from '../types';
+
+export function inferType(node: JSONSchema4): JSONSchema4TypeName | undefined {
+  if ('properties' in node) {
+    return SchemaKind.Object;
+  }
+
+  if ('items' in node) {
+    return SchemaKind.Array;
+  }
+
+  return;
+}
diff --git a/src/utils/isSchemaViewerEmpty.ts b/src/utils/isSchemaViewerEmpty.ts
@@ -1,14 +1,13 @@
 import { ISchema } from '@stoplight/types';
-import get = require('lodash/get');
-import isEmpty = require('lodash/isEmpty');
+import { get as _get, isEmpty as _isEmpty } from 'lodash';
 
 const combinerTypes = ['allOf', 'oneOf', 'anyOf'];
 
 export const isSchemaViewerEmpty = (schema: ISchema) => {
   const objectKeys = Object.keys(schema);
 
   if (objectKeys.length === 1 && combinerTypes.includes(objectKeys[0])) {
-    return isEmpty(get(schema, objectKeys[0], []));
+    return _isEmpty(_get(schema, objectKeys[0], []));
   }
 
   return false;
diff --git a/src/utils/lookupRef.ts b/src/utils/lookupRef.ts
@@ -1,6 +1,6 @@
 import { JsonPath } from '@stoplight/types';
 import { JSONSchema4 } from 'json-schema';
-import _get = require('lodash/get');
+import { get as _get } from 'lodash';
 
 export const lookupRef = (path: JsonPath, dereferencedSchema?: JSONSchema4): JSONSchema4 | null => {
   if (dereferencedSchema === undefined) {
diff --git a/src/utils/renderSchema.ts b/src/utils/renderSchema.ts
@@ -1,7 +1,8 @@
 import { JSONSchema4 } from 'json-schema';
-import _isEmpty = require('lodash/isEmpty');
+import { isEmpty as _isEmpty } from 'lodash';
 import { IArrayNode, IObjectNode, ITreeNodeMeta, SchemaKind, SchemaTreeListNode } from '../types';
 import { DIVIDERS } from './dividers';
+import { getPrimaryType } from './getPrimaryType';
 import { isCombiner } from './isCombiner';
 import { isRef } from './isRef';
 import { lookupRef } from './lookupRef';
@@ -51,7 +52,10 @@ export const renderSchema: Walker = function*(schema, dereferencedSchema, level
       metadata: {
         ...node,
         ...meta,
-        ...(schema.items !== undefined && !Array.isArray(schema.items) && { subtype: schema.items.type }),
+        ...(schema.items !== undefined &&
+          !Array.isArray(schema.items) && {
+            subtype: '$ref' in schema.items ? `$ref( ${schema.items.$ref} )` : schema.items.type,
+          }),
         path,
       },
     };
@@ -90,62 +94,69 @@ export const renderSchema: Walker = function*(schema, dereferencedSchema, level
           });
         }
       }
-    } else if (node.type === SchemaKind.Array) {
-      yield {
-        ...baseNode,
-        ...('items' in node &&
-          !_isEmpty(node.items) &&
-          !('subtype' in baseNode.metadata!) && { canHaveChildren: true }),
-        metadata: {
-          ...baseNode.metadata,
-          // https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.1.2
-          ...(!('subtype' in baseNode) &&
-            (node as IArrayNode).additionalItems && { additional: (node as IArrayNode).additionalItems }),
-        },
-      } as SchemaTreeListNode;
-      if (Array.isArray(schema.items)) {
-        for (const [i, property] of schema.items.entries()) {
-          yield* renderSchema(property, dereferencedSchema, level + 1, {
-            path: [...path, 'items', i],
+    } else {
+      switch (getPrimaryType(node)) {
+        case SchemaKind.Array:
+          yield {
+            ...baseNode,
+            ...('items' in node &&
+              !_isEmpty(node.items) &&
+              !('subtype' in baseNode.metadata!) && { canHaveChildren: true }),
+            metadata: {
+              ...baseNode.metadata,
+              // https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.1.2
+              ...(!('subtype' in baseNode) &&
+                (node as IArrayNode).additionalItems && { additional: (node as IArrayNode).additionalItems }),
+            },
+          } as SchemaTreeListNode;
+
+          if (Array.isArray(schema.items)) {
+            for (const [i, property] of schema.items.entries()) {
+              yield* renderSchema(property, dereferencedSchema, level + 1, {
+                path: [...path, 'items', i],
+              });
+            }
+          } else if (schema.items) {
+            switch (baseNode.metadata && baseNode.metadata.subtype) {
+              case SchemaKind.Object:
+                yield* getProperties(schema.items, dereferencedSchema, level + 1, {
+                  ...meta,
+                  path: [...path, 'items'],
+                });
+                break;
+              case SchemaKind.Array:
+                yield* renderSchema(schema.items, dereferencedSchema, level + 1, {
+                  path,
+                });
+                break;
+            }
+          }
+
+          break;
+        case SchemaKind.Object:
+          yield {
+            ...baseNode,
+            ...('properties' in node && !_isEmpty(node.properties) && { canHaveChildren: true }),
+            metadata: {
+              ...baseNode.metadata,
+              ...((node as IObjectNode).additionalProperties && {
+                additional: (node as IObjectNode).additionalProperties,
+              }),
+            },
+          } as SchemaTreeListNode;
+
+          yield* getProperties(schema, dereferencedSchema, level, {
+            path: [...path, 'properties'],
           });
-        }
-      } else if (schema.items) {
-        switch (baseNode.metadata && baseNode.metadata.subtype) {
-          case SchemaKind.Object:
-            yield* getProperties(schema.items, dereferencedSchema, level + 1, {
-              ...meta,
-              path: [...path, 'items'],
-            });
-            break;
-          case SchemaKind.Array:
-            yield* renderSchema(schema.items, dereferencedSchema, level + 1, {
-              path,
-            });
-            break;
-        }
-      }
-    } else if ('properties' in node) {
-      // special case :P, it's
-      yield {
-        ...baseNode,
-        ...('properties' in node && !_isEmpty(node.properties) && { canHaveChildren: true }),
-        metadata: {
-          ...baseNode.metadata,
-          ...((node as IObjectNode).additionalProperties && {
-            additional: (node as IObjectNode).additionalProperties,
-          }),
-        },
-      } as SchemaTreeListNode;
 
-      yield* getProperties(schema, dereferencedSchema, level, {
-        path: [...path, 'properties'],
-      });
+          yield* getPatternProperties(schema, dereferencedSchema, level, {
+            path: [...path, 'patternProperties'],
+          });
 
-      yield* getPatternProperties(schema, dereferencedSchema, level, {
-        path: [...path, 'patternProperties'],
-      });
-    } else {
-      yield baseNode;
+          break;
+        default:
+          yield baseNode;
+      }
     }
   }
 };
diff --git a/src/utils/walk.ts b/src/utils/walk.ts
