feat: resolveRef hook

Author: P0lip

src/components/JsonSchemaViewer.tsx

@@ -5,7 +5,7 @@ import { action } from 'mobx';
 import * as React from 'react';
 
 import { JSONSchema4 } from 'json-schema';
-import { SchemaTree } from '../tree/tree';
+import { SchemaTree, SchemaTreeRefDereferenceFn } from '../tree/tree';
 import { GoToRefHandler, RowRenderer } from '../types';
 import { isSchemaViewerEmpty } from '../utils/isSchemaViewerEmpty';
 import { SchemaTree as SchemaTreeComponent } from './SchemaTree';
@@ -24,6 +24,7 @@ export interface IJsonSchemaViewer {
   mergeAllOf?: boolean;
   FallbackComponent?: typeof FallbackComponent;
   rowRenderer?: RowRenderer;
+  resolveRef?: SchemaTreeRefDereferenceFn;
 }
 
 export class JsonSchemaViewerComponent extends React.PureComponent<IJsonSchemaViewer & ErrorBoundaryForwardedProps> {
@@ -38,6 +39,7 @@ export class JsonSchemaViewerComponent extends React.PureComponent<IJsonSchemaVi
     this.tree = new SchemaTree(props.schema, this.treeState, {
       expandedDepth: this.expandedDepth,
       mergeAllOf: this.mergeAllOf,
+      resolveRef: this.props.resolveRef,
     });
     this.treeStore = new TreeStore(this.tree, this.treeState, {
       defaultExpandedDepth: this.expandedDepth,

src/components/SchemaTree.tsx

@@ -10,7 +10,6 @@ export interface ISchemaTree {
   treeStore: TreeStore;
   schema: JSONSchema4;
   name?: string;
-  dereferencedSchema?: JSONSchema4;
   hideTopBar?: boolean;
   expanded?: boolean;
   maxRows?: number;

src/tree/index.ts

@@ -1,2 +1,2 @@
 export { getNodeMetadata } from './metadata';
-export { SchemaTree, SchemaTreeState } from './tree';
+export { SchemaTree, SchemaTreeState, SchemaTreeRefDereferenceFn } from './tree';

src/tree/tree.ts

@@ -1,28 +1,33 @@
 import { isLocalRef, pointerToPath } from '@stoplight/json';
 import { Tree, TreeListParentNode, TreeState } from '@stoplight/tree-list';
-import { JsonPath } from '@stoplight/types';
+import { JsonPath, Optional } from '@stoplight/types';
 import { JSONSchema4 } from 'json-schema';
-import { get as _get, isEqual as _isEqual } from 'lodash';
+import { get as _get, isEqual as _isEqual, isObject as _isObject } from 'lodash';
 import { isRefNode } from '../utils/guards';
 import { getNodeMetadata, metadataStore } from './metadata';
 import { populateTree } from './populateTree';
 
+export type SchemaTreeRefDereferenceFn = (path: JsonPath, schema: JSONSchema4) => Optional<JSONSchema4>;
+
 export type SchemaTreeOptions = {
   expandedDepth: number;
   mergeAllOf: boolean;
+  resolveRef: Optional<SchemaTreeRefDereferenceFn>;
 };
 
 export { TreeState as SchemaTreeState };
 
 export class SchemaTree extends Tree {
   public expandedDepth: number;
   public mergeAllOf: boolean;
+  protected resolveRef: Optional<SchemaTreeRefDereferenceFn>;
 
   constructor(public schema: JSONSchema4, public state: TreeState, opts: SchemaTreeOptions) {
     super();
 
     this.expandedDepth = opts.expandedDepth;
     this.mergeAllOf = opts.mergeAllOf;
+    this.resolveRef = opts.resolveRef;
   }
 
   protected readonly visited = new WeakSet();
@@ -78,7 +83,11 @@ export class SchemaTree extends Tree {
     const { path, schemaNode, schema } = metadata;
     if (isRefNode(schemaNode)) {
       const refPath = pointerToPath(schemaNode.$ref);
-      const schemaFragment = _get(this.schema, refPath);
+      const schemaFragment = this.resolveRef ? this.resolveRef(refPath, this.schema) : _get(this.schema, refPath);
+      if (!_isObject(schemaFragment)) {
+        throw new ReferenceError(`Could not dereference ${refPath.join('.')}`);
+      }
+
       this.populateTreeFragment(node, schemaFragment, path);
       metadata.schema = schemaFragment;
     } else {