Add ref support

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kickstartds/json-schema-to-typescript",
-  "version": "13.1.7",
+  "version": "13.1.20",
   "description": "compile json schema to typescript typings",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
@@ -30,15 +30,14 @@
     "tdd": "concurrently -r -p '' -k 'npm run watch' 'npm run watch:test'",
     "test": "npm run pre-test && ava --timeout=300s --verbose",
     "stresstest": "seq 1 10 | xargs -I{} npm test",
-    "postinstall": "patch-package",
     "prepublishOnly": "npm test",
     "pre-test": "npm run clean && npm run format-check && npm run build:server && npm run build:test",
     "watch": "tsup src/index.ts src/cli.ts --watch",
     "watch:test": "ava -w"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/bcherny/json-schema-to-typescript.git"
+    "url": "git+https://github.com/kickstartds/json-schema-to-typescript.git"
   },
   "keywords": [
     "json",
@@ -71,8 +70,6 @@
     "lodash-es": "^4.17.21",
     "minimist": "^1.2.6",
     "mkdirp": "^1.0.4",
-    "patch-package": "^8.0.0",
-    "postinstall-postinstall": "^2.1.0",
     "prettier": "^2.6.2"
   },
   "devDependencies": {
@@ -93,6 +90,8 @@
     "eslint": "^8.15.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-prettier": "^4.0.0",
+    "patch-package": "^8.0.0",
+    "postinstall-postinstall": "^2.1.0",
     "rimraf": "^3.0.2",
     "shx": "^0.3.4",
     "tsify": "^5.0.4",
@@ -105,7 +104,8 @@
     ],
     "ignoredByWatcher": [
       "./src"
-    ]
+    ],
+    "snapshotDir": "./test/__snapshots__"
   },
   "browserify": {
     "transform": [

src/generator.ts

@@ -20,6 +20,7 @@ export function generate(ast: AST, options = DEFAULT_OPTIONS): string {
   return (
     [
       options.bannerComment,
+      declareReferencedTypeImports(ast, options, ast.standaloneName!),
       declareNamedTypes(ast, options, ast.standaloneName!),
       declareNamedInterfaces(ast, options, ast.standaloneName!),
       declareEnums(ast, options),
@@ -142,6 +143,8 @@ function declareNamedTypes(ast: AST, options: Options, rootASTName: string, proc
       ]
         .filter(Boolean)
         .join('\n')
+    case 'REFERENCE':
+      return ``
     default:
       if (hasStandaloneName(ast)) {
         return generateStandaloneType(ast, options)
@@ -150,6 +153,62 @@ function declareNamedTypes(ast: AST, options: Options, rootASTName: string, proc
   }
 }
 
+function declareReferencedTypeImports(
+  ast: AST,
+  options: Options,
+  rootASTName: string,
+  processed = new Set<AST>(),
+  imports = new Set<string>(),
+): string {
+  if (processed.has(ast)) {
+    return ''
+  }
+
+  processed.add(ast)
+
+  switch (ast.type) {
+    case 'ARRAY':
+      return [declareReferencedTypeImports(ast.params, options, rootASTName, processed, imports)]
+        .filter(Boolean)
+        .join('\n')
+    case 'ENUM':
+      return ''
+    case 'INTERFACE':
+      return getSuperTypesAndParams(ast)
+        .map(
+          ast =>
+            (ast.standaloneName === rootASTName || options.declareExternallyReferenced) &&
+            declareReferencedTypeImports(ast, options, rootASTName, processed, imports),
+        )
+        .filter(Boolean)
+        .join('\n')
+    case 'INTERSECTION':
+    case 'TUPLE':
+    case 'UNION':
+      return [
+        ast.params
+          .map(ast => declareReferencedTypeImports(ast, options, rootASTName, processed, imports))
+          .filter(Boolean)
+          .join('\n'),
+        'spreadParam' in ast && ast.spreadParam
+          ? declareReferencedTypeImports(ast.spreadParam, options, rootASTName, processed, imports)
+          : undefined,
+      ]
+        .filter(Boolean)
+        .join('\n')
+    case 'REFERENCE':
+      const importName = options.renderImportStatement(ast.params)
+      if (imports.has(importName)) {
+        return ''
+      } else {
+        imports.add(importName)
+        return importName
+      }
+    default:
+      return ''
+  }
+}
+
 function generateTypeUnmemoized(ast: AST, options: Options): string {
   const type = generateRawType(ast, options)
 
@@ -193,7 +252,7 @@ function generateRawType(ast: AST, options: Options): string {
     case 'OBJECT':
       return 'object'
     case 'REFERENCE':
-      return ast.params
+      return options.renderImportName(ast.params)
     case 'STRING':
       return 'string'
     case 'TUPLE':

src/index.ts

@@ -31,6 +31,14 @@ export interface Options {
    * Disclaimer comment prepended to the top of each generated file.
    */
   bannerComment: string
+  /**
+   * Rendering function for the import name added when processing a reference.
+   */
+  renderImportName: (reference: string) => string
+  /**
+   * Rendering function for the import itself when processing a reference..
+   */
+  renderImportStatement: (reference: string) => string
   /**
    * Root directory for resolving [`$ref`](https://tools.ietf.org/id/draft-pbryan-zyp-json-ref-03.html)s.
    */
@@ -87,6 +95,8 @@ export const DEFAULT_OPTIONS: Options = {
 * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
 * and run json-schema-to-typescript to regenerate this file.
 */`,
+  renderImportName: reference => reference,
+  renderImportStatement: reference => reference,
   cwd: process.cwd(),
   declareExternallyReferenced: true,
   enableConstEnums: true,

src/parser.ts

@@ -241,7 +241,15 @@ function parseNonLiteral(
         type: 'UNION',
       }
     case 'REFERENCE':
-      throw Error(format('Refs should have been resolved by the resolver!', schema))
+      if (!schema.$ref) throw Error(format('Refs should have been resolved by the resolver!', schema))
+      return {
+        comment: `Referenced component ${options.renderImportName(schema.$ref)}`,
+        deprecated: false,
+        keyName,
+        standaloneName: standaloneName(schema, keyNameFromDefinition, usedNames),
+        type: 'REFERENCE',
+        params: schema.$ref,
+      }
     case 'STRING':
       return {
         comment: schema.description,

test/e2e/refExternal.ts

@@ -0,0 +1,22 @@
+export const input = {
+  title: 'Referencing',
+  type: 'object',
+  properties: {
+    foo: {
+      $ref: 'ReferencedType.json',
+    },
+  },
+  required: ['foo'],
+  additionalProperties: false,
+}
+
+export const options = {
+  declareExternallyReferenced: true,
+  $refOptions: {
+    resolve: {
+      external: false,
+      http: false,
+      file: false,
+    },
+  },
+}

test/test.ts

@@ -5,6 +5,7 @@ import {run as runIdempotenceTests} from './testIdempotence.js'
 import {run as runLinkerTests} from './testLinker.js'
 import {run as runNormalizerTests} from './testNormalizer.js'
 import {run as runUtilsTests} from './testUtils.js'
+import {run as runExternalRefsTests} from './testExternalRefs.js'
 
 runE2ETests()
 
@@ -15,4 +16,5 @@ if (!hasOnly()) {
   runLinkerTests()
   runNormalizerTests()
   runUtilsTests()
+  runExternalRefsTests()
 }

test/testExternalRefs.ts

@@ -0,0 +1,12 @@
+import test from 'ava'
+
+import {link} from '../src/linker.js'
+import {compile} from '../src/index.js'
+import {input, options} from './e2e/refExternal.js'
+
+export function run() {
+  test('should correctly generate TypeScript typings from JSON schema with $ref, and declareExternallyReferenced false', async t => {
+    const schema = link(input) as any
+    t.snapshot(await compile(schema, schema.$id, options), 'This will not match')
+  })
+}