fix(core): refactoring FromSchema out of core (#787)

* fix(core): moving our `FromSchema` exports into the `types` file * fix(core): moving `json-schema-to-ts` back over to being an sdk dep
readmeio · Oct 25, 2023 · 41cacf3 · 41cacf3
1 parent cd9e22c
commit 41cacf3
Show file tree

Hide file tree

Showing 23 changed files with 37 additions and 24 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/api/package.json b/packages/api/package.json
@@ -51,6 +51,7 @@
     "figures": "^5.0.0",
     "httpsnippet-client-api": "file:../httpsnippet-client-api",
     "js-yaml": "^4.1.0",
+    "json-schema-to-ts": "^2.9.2",
     "license": "^1.0.3",
     "lodash.camelcase": "^4.3.0",
     "lodash.deburr": "^4.1.0",

diff --git a/packages/api/src/codegen/languages/typescript/index.ts b/packages/api/src/codegen/languages/typescript/index.ts
@@ -106,6 +106,12 @@ export default class TSGenerator extends CodeGenerator {
         url: 'https://tsup.egoist.dev/',
         version: '^7.2.0',
       },
+      'json-schema-to-ts': {
+        dependencyType: 'production',
+        reason: 'Required for TypeScript type handling.',
+        url: 'https://npm.im/json-schema-to-ts',
+        version: '^2.9.2',
+      },
       typescript: {
         dependencyType: 'development',
         reason: 'Required for `tsup`.',
@@ -753,7 +759,7 @@ Generated at ${createdAt}
     const sourceFile = sourceDirectory.createSourceFile('types.ts', '');
 
     sourceFile.addImportDeclarations([
-      { defaultImport: 'type { FromSchema }', moduleSpecifier: '@readme/api-core/lib' },
+      { defaultImport: 'type { FromSchema }', moduleSpecifier: 'json-schema-to-ts' },
       { defaultImport: '* as schemas', moduleSpecifier: './schemas' },
     ]);
 

diff --git a/packages/api/src/lockfileSchema.ts b/packages/api/src/lockfileSchema.ts
@@ -1,4 +1,4 @@
-import type { FromSchema } from '@readme/api-core/lib';
+import type { FromSchema } from 'json-schema-to-ts';
 
 import { SupportedLanguages } from './codegen/factory.js';
 

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -53,7 +53,6 @@
     "caseless": "^0.12.0",
     "datauri": "^4.1.0",
     "fetch-har": "^11.0.1",
-    "json-schema-to-ts": "^2.9.2",
     "json-schema-traverse": "^1.0.0",
     "lodash.merge": "^4.6.2",
     "oas": "^23.0.0",

diff --git a/packages/core/src/lib/index.ts b/packages/core/src/lib/index.ts
@@ -1,9 +1,7 @@
-import type { FromSchema } from 'json-schema-to-ts';
-
 import getJSONSchemaDefaults from './getJSONSchemaDefaults.js';
 import parseResponse from './parseResponse.js';
 import prepareAuth from './prepareAuth.js';
 import prepareParams from './prepareParams.js';
 import prepareServer from './prepareServer.js';
 
-export { FromSchema, getJSONSchemaDefaults, parseResponse, prepareAuth, prepareParams, prepareServer };
+export { getJSONSchemaDefaults, parseResponse, prepareAuth, prepareParams, prepareServer };
diff --git a/packages/test-utils/sdks/alby/package.json b/packages/test-utils/sdks/alby/package.json
@@ -23,7 +23,8 @@
     "prepare": "tsup"
   },
   "dependencies": {
-    "@readme/api-core": "file:../../../../../core"
+    "@readme/api-core": "file:../../../../../core",
+    "json-schema-to-ts": "^2.9.2"
   },
   "devDependencies": {
     "tsup": "^7.2.0",

diff --git a/packages/test-utils/sdks/alby/src/types.ts b/packages/test-utils/sdks/alby/src/types.ts
@@ -1,4 +1,4 @@
-import type { FromSchema } from '@readme/api-core/lib';
+import type { FromSchema } from 'json-schema-to-ts';
 import * as schemas from './schemas';
 
 export type AmqpExternalRulePatch = FromSchema<typeof schemas.AmqpExternalRulePatch>;

diff --git a/packages/test-utils/sdks/metrotransit/package.json b/packages/test-utils/sdks/metrotransit/package.json
@@ -23,7 +23,8 @@
     "prepare": "tsup"
   },
   "dependencies": {
-    "@readme/api-core": "file:../../../../../core"
+    "@readme/api-core": "file:../../../../../core",
+    "json-schema-to-ts": "^2.9.2"
   },
   "devDependencies": {
     "tsup": "^7.2.0",

diff --git a/packages/test-utils/sdks/metrotransit/src/types.ts b/packages/test-utils/sdks/metrotransit/src/types.ts
@@ -1,4 +1,4 @@
-import type { FromSchema } from '@readme/api-core/lib';
+import type { FromSchema } from 'json-schema-to-ts';
 import * as schemas from './schemas';
 
 export type Agency = FromSchema<typeof schemas.Agency>;

diff --git a/packages/test-utils/sdks/operationid-quirks/package.json b/packages/test-utils/sdks/operationid-quirks/package.json
@@ -19,7 +19,8 @@
     "prepare": "tsup"
   },
   "dependencies": {
-    "@readme/api-core": "file:../../../../../core"
+    "@readme/api-core": "file:../../../../../core",
+    "json-schema-to-ts": "^2.9.2"
   },
   "devDependencies": {
     "tsup": "^7.2.0",

diff --git a/packages/test-utils/sdks/optional-payload/package.json b/packages/test-utils/sdks/optional-payload/package.json
@@ -23,7 +23,8 @@
     "prepare": "tsup"
   },
   "dependencies": {
-    "@readme/api-core": "file:../../../../../core"
+    "@readme/api-core": "file:../../../../../core",
+    "json-schema-to-ts": "^2.9.2"
   },
   "devDependencies": {
     "tsup": "^7.2.0",

diff --git a/packages/test-utils/sdks/optional-payload/src/types.ts b/packages/test-utils/sdks/optional-payload/src/types.ts
@@ -1,4 +1,4 @@
-import type { FromSchema } from '@readme/api-core/lib';
+import type { FromSchema } from 'json-schema-to-ts';
 import * as schemas from './schemas';
 
 export type UpdatePetWithFormFormDataParam = FromSchema<typeof schemas.UpdatePetWithForm.formData>;

diff --git a/packages/test-utils/sdks/petstore/package.json b/packages/test-utils/sdks/petstore/package.json
@@ -24,7 +24,8 @@
     "prepare": "tsup"
   },
   "dependencies": {
-    "@readme/api-core": "file:../../../../../core"
+    "@readme/api-core": "file:../../../../../core",
+    "json-schema-to-ts": "^2.9.2"
   },
   "devDependencies": {
     "tsup": "^7.2.0",

diff --git a/packages/test-utils/sdks/petstore/src/types.ts b/packages/test-utils/sdks/petstore/src/types.ts
@@ -1,4 +1,4 @@
-import type { FromSchema } from '@readme/api-core/lib';
+import type { FromSchema } from 'json-schema-to-ts';
 import * as schemas from './schemas';
 
 export type ApiResponse = FromSchema<typeof schemas.ApiResponse>;

diff --git a/packages/test-utils/sdks/readme/package.json b/packages/test-utils/sdks/readme/package.json
@@ -23,7 +23,8 @@
     "prepare": "tsup"
   },
   "dependencies": {
-    "@readme/api-core": "file:../../../../../core"
+    "@readme/api-core": "file:../../../../../core",
+    "json-schema-to-ts": "^2.9.2"
   },
   "devDependencies": {
     "tsup": "^7.2.0",

diff --git a/packages/test-utils/sdks/readme/src/types.ts b/packages/test-utils/sdks/readme/src/types.ts
@@ -1,4 +1,4 @@
-import type { FromSchema } from '@readme/api-core/lib';
+import type { FromSchema } from 'json-schema-to-ts';
 import * as schemas from './schemas';
 
 export type Apply = FromSchema<typeof schemas.Apply>;

diff --git a/packages/test-utils/sdks/response-title-quirks/package.json b/packages/test-utils/sdks/response-title-quirks/package.json
@@ -23,7 +23,8 @@
     "prepare": "tsup"
   },
   "dependencies": {
-    "@readme/api-core": "file:../../../../../core"
+    "@readme/api-core": "file:../../../../../core",
+    "json-schema-to-ts": "^2.9.2"
   },
   "devDependencies": {
     "tsup": "^7.2.0",

diff --git a/packages/test-utils/sdks/response-title-quirks/src/types.ts b/packages/test-utils/sdks/response-title-quirks/src/types.ts
@@ -1,4 +1,4 @@
-import type { FromSchema } from '@readme/api-core/lib';
+import type { FromSchema } from 'json-schema-to-ts';
 import * as schemas from './schemas';
 
 export type GetAnythingMetadataParam = FromSchema<typeof schemas.GetAnything.metadata>;

diff --git a/packages/test-utils/sdks/simple/package.json b/packages/test-utils/sdks/simple/package.json
@@ -23,7 +23,8 @@
     "prepare": "tsup"
   },
   "dependencies": {
-    "@readme/api-core": "file:../../../../../core"
+    "@readme/api-core": "file:../../../../../core",
+    "json-schema-to-ts": "^2.9.2"
   },
   "devDependencies": {
     "tsup": "^7.2.0",

diff --git a/packages/test-utils/sdks/simple/src/types.ts b/packages/test-utils/sdks/simple/src/types.ts
@@ -1,4 +1,4 @@
-import type { FromSchema } from '@readme/api-core/lib';
+import type { FromSchema } from 'json-schema-to-ts';
 import * as schemas from './schemas';
 
 export type Category = FromSchema<typeof schemas.Category>;

diff --git a/packages/test-utils/sdks/star-trek/package.json b/packages/test-utils/sdks/star-trek/package.json
@@ -23,7 +23,8 @@
     "prepare": "tsup"
   },
   "dependencies": {
-    "@readme/api-core": "file:../../../../../core"
+    "@readme/api-core": "file:../../../../../core",
+    "json-schema-to-ts": "^2.9.2"
   },
   "devDependencies": {
     "tsup": "^7.2.0",

diff --git a/packages/test-utils/sdks/star-trek/src/types.ts b/packages/test-utils/sdks/star-trek/src/types.ts
@@ -1,4 +1,4 @@
-import type { FromSchema } from '@readme/api-core/lib';
+import type { FromSchema } from 'json-schema-to-ts';
 import * as schemas from './schemas';
 
 export type AnimalBase = FromSchema<typeof schemas.AnimalBase>;