From 58b6a0eecb522b61e6a18047c3d7468bcb2b4466 Mon Sep 17 00:00:00 2001 From: ritz078 Date: Fri, 5 Jun 2020 00:14:36 +0530 Subject: [PATCH] fix(ts-schema): typescript to JSON Schema now working fix #182 --- constants/data.ts | 7 +++ package.json | 4 +- pages/api/typescript-to-json-schema.ts | 28 +++-------- pages/typescript-to-json-schema.tsx | 1 + yarn.lock | 65 +++++++++++++++----------- 5 files changed, 55 insertions(+), 50 deletions(-) diff --git a/constants/data.ts b/constants/data.ts index 4d30291..b4e005a 100644 --- a/constants/data.ts +++ b/constants/data.ts @@ -349,3 +349,10 @@ export const CounterExample = () => { ); }`; + +export const typeScriptInterface = `export interface Root { + userId: number; + id: number; + title: string; + completed: boolean; +}`; diff --git a/package.json b/package.json index c69540a..f195174 100644 --- a/package.json +++ b/package.json @@ -81,10 +81,10 @@ "stringify-object": "^3.3.0", "svg-to-dataurl": "^1.0.0", "svgo": "^1.3.2", - "tempy": "^0.3.0", + "tempy": "^0.5.0", "text-encoding-utf-8": "^1.0.2", "transform-json-types": "^0.7.0", - "ts-json-schema-generator": "^0.58.1", + "ts-json-schema-generator": "^0.69.0", "typescript": "3.9.2", "xml-js": "^1.6.11", "yaml": "^1.7.2" diff --git a/pages/api/typescript-to-json-schema.ts b/pages/api/typescript-to-json-schema.ts index 3cc4fed..58fd2f6 100644 --- a/pages/api/typescript-to-json-schema.ts +++ b/pages/api/typescript-to-json-schema.ts @@ -1,37 +1,21 @@ import { NextApiRequest, NextApiResponse } from "next"; -import { SchemaGenerator } from "ts-json-schema-generator"; import * as ts from "typescript"; -import { createFormatter } from "ts-json-schema-generator/dist/factory/formatter"; -import { createParser } from "ts-json-schema-generator/dist/factory/parser"; -import { createProgram } from "ts-json-schema-generator/dist/factory/program"; import { Config } from "ts-json-schema-generator/dist/src/Config"; import tempy from "tempy"; -import fs from "fs"; -import path from "path"; +import * as tsj from "ts-json-schema-generator"; export default (req: NextApiRequest, res: NextApiResponse) => { try { - const filePath = tempy.file({ extension: "ts" }); - fs.writeFileSync(filePath, req.body); + const filePath = tempy.writeSync(req.body, { extension: "ts" }); const config: Config = { - path: path.resolve(filePath), - expose: "all", - topRef: true, + path: filePath, + expose: "none", jsDoc: "extended", type: "*" }; - const program = createProgram(config); - const generator: SchemaGenerator = new SchemaGenerator( - program, - createParser(program, config), - // @ts-ignore - createFormatter(config) - ); - const schema = generator.createSchema("*"); - - fs.unlink(filePath, () => {}); - res.status(200).send(schema); + const schema = tsj.createGenerator(config).createSchema(config.type); + res.status(200).send(JSON.stringify(schema, null, 2)); } catch (e) { res.status(500).send(e.message); } diff --git a/pages/typescript-to-json-schema.tsx b/pages/typescript-to-json-schema.tsx index eb56ced..c692239 100644 --- a/pages/typescript-to-json-schema.tsx +++ b/pages/typescript-to-json-schema.tsx @@ -15,6 +15,7 @@ export default function() { transformer={transformer} editorTitle="TypeScript" editorLanguage="typescript" + editorDefaultValue="typeScriptInterface" resultTitle="JSON Schema" resultLanguage={"json"} resultEditorProps={{ diff --git a/yarn.lock b/yarn.lock index 43428ab..ef29b19 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1392,6 +1392,10 @@ version "7.0.3" resolved "https://registry.yarnpkg.com/@types/json-schema/-/json-schema-7.0.3.tgz#bdfd69d61e464dcc81b25159c270d75a73c1a636" +"@types/json-schema@^7.0.4": + version "7.0.4" + resolved "https://registry.yarnpkg.com/@types/json-schema/-/json-schema-7.0.4.tgz#38fd73ddfd9b55abb1e1b2ed578cb55bd7b7d339" + "@types/jsonld@^1.5.0": version "1.5.0" resolved "https://registry.yarnpkg.com/@types/jsonld/-/jsonld-1.5.0.tgz#cd5cb660dcbeffd391290f820efebab571af65d9" @@ -2845,9 +2849,9 @@ commander@~2.8.1: dependencies: graceful-readlink ">= 1.0.0" -commander@~4.0.1: - version "4.0.1" - resolved "https://registry.yarnpkg.com/commander/-/commander-4.0.1.tgz#b67622721785993182e807f4883633e6401ba53c" +commander@~5.1.0: + version "5.1.0" + resolved "https://registry.yarnpkg.com/commander/-/commander-5.1.0.tgz#46abbd1652f8e059bddaef99bbdcb2ad9cf179ae" common-tags@1.8.0: version "1.8.0" @@ -3098,9 +3102,9 @@ crypto-browserify@^3.11.0: randombytes "^2.0.0" randomfill "^1.0.3" -crypto-random-string@^1.0.0: - version "1.0.0" - resolved "https://registry.yarnpkg.com/crypto-random-string/-/crypto-random-string-1.0.0.tgz#a230f64f568310e1498009940790ec99545bca7e" +crypto-random-string@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/crypto-random-string/-/crypto-random-string-2.0.0.tgz#ef2a7a966ec11083388369baa02ebead229b30d5" css-blank-pseudo@^0.1.4: version "0.1.4" @@ -9066,6 +9070,10 @@ temp-dir@^1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/temp-dir/-/temp-dir-1.0.0.tgz#0a7c0ea26d3a39afa7e0ebea9c1fc0bc4daa011d" +temp-dir@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/temp-dir/-/temp-dir-2.0.0.tgz#bde92b05bdfeb1516e804c9c00ad45177f31321e" + tempfile@^2.0.0: version "2.0.0" resolved "https://registry.yarnpkg.com/tempfile/-/tempfile-2.0.0.tgz#6b0446856a9b1114d1856ffcbe509cccb0977265" @@ -9073,13 +9081,14 @@ tempfile@^2.0.0: temp-dir "^1.0.0" uuid "^3.0.1" -tempy@^0.3.0: - version "0.3.0" - resolved "https://registry.yarnpkg.com/tempy/-/tempy-0.3.0.tgz#6f6c5b295695a16130996ad5ab01a8bd726e8bf8" +tempy@^0.5.0: + version "0.5.0" + resolved "https://registry.yarnpkg.com/tempy/-/tempy-0.5.0.tgz#2785c89df39fcc4d1714fc554813225e1581d70b" dependencies: - temp-dir "^1.0.0" - type-fest "^0.3.1" - unique-string "^1.0.0" + is-stream "^2.0.0" + temp-dir "^2.0.0" + type-fest "^0.12.0" + unique-string "^2.0.0" terser-webpack-plugin@^1.4.1: version "1.4.1" @@ -9289,15 +9298,15 @@ ts-invariant@^0.4.0: dependencies: tslib "^1.9.3" -ts-json-schema-generator@^0.58.1: - version "0.58.1" - resolved "https://registry.yarnpkg.com/ts-json-schema-generator/-/ts-json-schema-generator-0.58.1.tgz#41bce930e53422723646f0b037f33b1b4c8a42d5" +ts-json-schema-generator@^0.69.0: + version "0.69.0" + resolved "https://registry.yarnpkg.com/ts-json-schema-generator/-/ts-json-schema-generator-0.69.0.tgz#0b3d93dda4d401a5c691170e8d25b1b9c1673ddf" dependencies: - "@types/json-schema" "^7.0.3" - commander "~4.0.1" + "@types/json-schema" "^7.0.4" + commander "~5.1.0" glob "~7.1.6" json-stable-stringify "^1.0.1" - typescript "~3.7.3" + typescript "~3.9.3" ts-pnp@^1.1.2: version "1.1.4" @@ -9327,9 +9336,9 @@ type-check@~0.3.2: dependencies: prelude-ls "~1.1.2" -type-fest@^0.3.1: - version "0.3.1" - resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-0.3.1.tgz#63d00d204e059474fe5e1b7c011112bbd1dc29e1" +type-fest@^0.12.0: + version "0.12.0" + resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-0.12.0.tgz#f57a27ab81c68d136a51fd71467eff94157fa1ee" type-fest@^0.4.1: version "0.4.1" @@ -9372,10 +9381,14 @@ typescript@^2.3.2: version "2.9.2" resolved "https://registry.yarnpkg.com/typescript/-/typescript-2.9.2.tgz#1cbf61d05d6b96269244eb6a3bce4bd914e0f00c" -typescript@^3.4, typescript@~3.7.3: +typescript@^3.4: version "3.7.4" resolved "https://registry.yarnpkg.com/typescript/-/typescript-3.7.4.tgz#1743a5ec5fef6a1fa9f3e4708e33c81c73876c19" +typescript@~3.9.3: + version "3.9.5" + resolved "https://registry.yarnpkg.com/typescript/-/typescript-3.9.5.tgz#586f0dba300cde8be52dd1ac4f7e1009c1b13f36" + ua-parser-js@^0.7.18: version "0.7.20" resolved "https://registry.yarnpkg.com/ua-parser-js/-/ua-parser-js-0.7.20.tgz#7527178b82f6a62a0f243d1f94fd30e3e3c21098" @@ -9459,11 +9472,11 @@ unique-slug@^2.0.0: dependencies: imurmurhash "^0.1.4" -unique-string@^1.0.0: - version "1.0.0" - resolved "https://registry.yarnpkg.com/unique-string/-/unique-string-1.0.0.tgz#9e1057cca851abb93398f8b33ae187b99caec11a" +unique-string@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/unique-string/-/unique-string-2.0.0.tgz#39c6451f81afb2749de2b233e3f7c5e8843bd89d" dependencies: - crypto-random-string "^1.0.0" + crypto-random-string "^2.0.0" universalify@^0.1.0: version "0.1.2"