Merge pull request #433 from hey-api/feat/schemas-exports

feat: add form type option for schemas

.changeset/quiet-seals-pay.md

@@ -0,0 +1,5 @@
+---
+"@hey-api/openapi-ts": minor
+---
+
+feat: add form type option for schemas

docs/openapi-ts/configuration.md

@@ -174,7 +174,19 @@ if (userInput.length > maxInputLength) {
 }
 ```
 
-If you're using OpenAPI v3.1, your schemas are JSON Schema compliant and can be used with any other tools supporting JSON Schema. However, if you don't need schemas at all, you can disable them with
+If you're using OpenAPI v3.1, your schemas are JSON Schema compliant and can be used with other tools supporting JSON Schema. However, if you only want to validate form input, you don't want to include string descriptions inside your bundle. Instead, use `form` type.
+
+```js{5}
+export default {
+  input: 'path/to/openapi.json',
+  output: 'src/client',
+  schemas: {
+    type: 'form'
+  },
+}
+```
+
+If you don't need schemas at all, you can disable them with
 
 ```js{4}
 export default {

packages/openapi-ts/src/index.ts

@@ -88,6 +88,22 @@ const logMissingDependenciesWarning = (dependencies: Dependencies) => {
   }
 };
 
+const getSchemas = (userConfig: UserConfig): Config['schemas'] => {
+  let schemas: Config['schemas'] = {
+    export: true,
+    type: 'json',
+  };
+  if (typeof userConfig.schemas === 'boolean') {
+    schemas.export = userConfig.schemas;
+  } else {
+    schemas = {
+      ...schemas,
+      ...userConfig.schemas,
+    };
+  }
+  return schemas;
+};
+
 const getServices = (userConfig: UserConfig): Config['services'] => {
   let services: Config['services'] = {
     export: true,
@@ -152,7 +168,6 @@ const initConfig = async (
     name,
     operationId = true,
     request,
-    schemas = true,
     serviceResponse = 'body',
     useDateType = false,
     useOptions = true,
@@ -182,6 +197,7 @@ const initConfig = async (
 
   const client = userConfig.client || inferClient(dependencies);
   const output = path.resolve(process.cwd(), userConfig.output);
+  const schemas = getSchemas(userConfig);
   const services = getServices(userConfig);
   const types = getTypes(userConfig);
 

packages/openapi-ts/src/openApi/common/parser/__tests__/operation.spec.ts

@@ -19,7 +19,9 @@ describe('getOperationName', () => {
     lint: false,
     operationId: true,
     output: '',
-    schemas: false,
+    schemas: {
+      export: false,
+    },
     serviceResponse: 'body',
     services: {
       export: false,
@@ -42,7 +44,9 @@ describe('getOperationName', () => {
     lint: false,
     operationId: false,
     output: '',
-    schemas: false,
+    schemas: {
+      export: false,
+    },
     serviceResponse: 'body',
     services: {
       export: false,

packages/openapi-ts/src/openApi/v2/parser/__tests__/getServices.spec.ts

@@ -16,7 +16,7 @@ describe('getServices', () => {
       lint: false,
       operationId: false,
       output: '',
-      schemas: true,
+      schemas: {},
       serviceResponse: 'body',
       services: {},
       types: {},

packages/openapi-ts/src/openApi/v3/parser/__tests__/getServices.spec.ts

@@ -16,7 +16,7 @@ describe('getServices', () => {
       lint: false,
       operationId: true,
       output: '',
-      schemas: true,
+      schemas: {},
       serviceResponse: 'body',
       services: {},
       types: {},

packages/openapi-ts/src/types/config.ts

@@ -60,10 +60,25 @@ export interface UserConfig {
    */
   request?: string;
   /**
-   * Export JSON schemas?
+   * Generate JSON schemas?
    * @default true
    */
-  schemas?: boolean;
+  schemas?:
+    | boolean
+    | {
+        /**
+         * Generate JSON schemas?
+         * @default true
+         */
+        export?: boolean;
+        /**
+         * Choose schema type to generate. Select 'form' if you don't want
+         * descriptions to reduce bundle size and you plan to use schemas
+         * for form validation
+         * @default 'json'
+         */
+        type?: 'form' | 'json';
+      };
   /**
    * Define shape of returned value from service calls
    * @default 'body'
@@ -129,9 +144,10 @@ export interface UserConfig {
 
 export type Config = Omit<
   Required<UserConfig>,
-  'base' | 'name' | 'request' | 'services' | 'types'
+  'base' | 'name' | 'request' | 'schemas' | 'services' | 'types'
 > &
   Pick<UserConfig, 'base' | 'name' | 'request'> & {
+    schemas: Extract<Required<UserConfig>['schemas'], object>;
     services: Extract<Required<UserConfig>['services'], object>;
     types: Extract<Required<UserConfig>['types'], object>;
   };

packages/openapi-ts/src/utils/__tests__/handlebars.spec.ts

@@ -20,7 +20,7 @@ describe('registerHandlebarHelpers', () => {
       lint: false,
       operationId: true,
       output: '',
-      schemas: true,
+      schemas: {},
       serviceResponse: 'body',
       services: {},
       types: {},
@@ -50,7 +50,7 @@ describe('registerHandlebarTemplates', () => {
       lint: false,
       operationId: true,
       output: '',
-      schemas: true,
+      schemas: {},
       serviceResponse: 'body',
       services: {},
       types: {},

packages/openapi-ts/src/utils/write/__tests__/class.spec.ts

@@ -23,7 +23,7 @@ describe('writeClientClass', () => {
       name: 'AppClient',
       operationId: true,
       output: '',
-      schemas: true,
+      schemas: {},
       serviceResponse: 'body',
       services: {},
       types: {},

packages/openapi-ts/src/utils/write/__tests__/client.spec.ts

@@ -22,7 +22,7 @@ describe('writeClient', () => {
       lint: false,
       operationId: true,
       output: './dist',
-      schemas: true,
+      schemas: {},
       serviceResponse: 'body',
       services: {},
       types: {},

packages/openapi-ts/src/utils/write/__tests__/core.spec.ts

@@ -37,7 +37,7 @@ describe('writeCore', () => {
       name: 'AppClient',
       operationId: true,
       output: '',
-      schemas: true,
+      schemas: {},
       serviceResponse: 'body',
       services: {},
       types: {},
@@ -94,7 +94,7 @@ describe('writeCore', () => {
       name: 'AppClient',
       operationId: true,
       output: '',
-      schemas: true,
+      schemas: {},
       serviceResponse: 'body',
       services: {},
       types: {},
@@ -134,7 +134,7 @@ describe('writeCore', () => {
       name: 'AppClient',
       operationId: true,
       output: '',
-      schemas: true,
+      schemas: {},
       serviceResponse: 'body',
       services: {},
       types: {},

packages/openapi-ts/src/utils/write/__tests__/index.spec.ts

@@ -22,7 +22,7 @@ describe('processIndex', () => {
       lint: false,
       operationId: true,
       output: '',
-      schemas: true,
+      schemas: {},
       serviceResponse: 'body',
       services: {},
       types: {},

packages/openapi-ts/src/utils/write/__tests__/models.spec.ts

@@ -23,7 +23,7 @@ describe('processTypesAndEnums', () => {
       name: 'AppClient',
       operationId: true,
       output: '',
-      schemas: true,
+      schemas: {},
       serviceResponse: 'body',
       services: {},
       types: {},

packages/openapi-ts/src/utils/write/__tests__/schemas.spec.ts

@@ -24,7 +24,7 @@ describe('processSchemas', () => {
       name: 'AppClient',
       operationId: true,
       output: '',
-      schemas: true,
+      schemas: {},
       serviceResponse: 'body',
       services: {},
       types: {},

packages/openapi-ts/src/utils/write/__tests__/services.spec.ts

@@ -22,7 +22,7 @@ describe('processServices', () => {
       lint: false,
       operationId: true,
       output: '',
-      schemas: true,
+      schemas: {},
       serviceResponse: 'body',
       services: {},
       types: {},

packages/openapi-ts/src/utils/write/client.ts

@@ -56,7 +56,7 @@ export const writeClient = async (
       name: 'enums.ts',
     });
   }
-  if (config.schemas) {
+  if (config.schemas.export) {
     files.schemas = new TypeScriptFile({
       dir: config.output,
       name: 'schemas.ts',

packages/openapi-ts/src/utils/write/schemas.ts

@@ -1,6 +1,39 @@
 import { compiler, TypeScriptFile } from '../../compiler';
 import type { OpenApi } from '../../openApi';
 import { ensureValidTypeScriptJavaScriptIdentifier } from '../../openApi/common/parser/sanitize';
+import { getConfig } from '../config';
+
+const schemaToFormSchema = (schema: unknown): object => {
+  if (Array.isArray(schema)) {
+    return schema.map((item) => schemaToFormSchema(item));
+  }
+
+  if (typeof schema !== 'object' || schema === null) {
+    return schema as object;
+  }
+
+  const result = { ...schema };
+  Object.entries(result).forEach(([key, value]) => {
+    if (
+      [
+        'description',
+        'x-enum-descriptions',
+        'x-enum-varnames',
+        'x-enumNames',
+      ].includes(key)
+    ) {
+      // @ts-ignore
+      delete result[key];
+      return;
+    }
+
+    if (value && typeof value === 'object') {
+      // @ts-ignore
+      result[key] = schemaToFormSchema(value);
+    }
+  });
+  return result;
+};
 
 export const processSchemas = async ({
   file,
@@ -13,8 +46,12 @@ export const processSchemas = async ({
     return;
   }
 
-  const addSchema = (name: string, obj: any) => {
+  const config = getConfig();
+
+  const addSchema = (name: string, schema: object) => {
     const validName = `$${ensureValidTypeScriptJavaScriptIdentifier(name)}`;
+    const obj =
+      config.schemas.type === 'form' ? schemaToFormSchema(schema) : schema;
     const expression = compiler.types.object({ obj });
     const statement = compiler.export.asConst(validName, expression);
     file.add(statement);

packages/openapi-ts/test/__snapshots__/test/generated/v3_schemas_form/index.ts.snap

@@ -0,0 +1,3 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export * from './schemas.gen';