Merge pull request #1319 from hey-api/fix/zod-plugin-constraints

fix: Zod plugin handles value constraints and defaults

.changeset/chilly-hats-cover.md

@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': patch
+---
+
+fix: Zod plugin handles value constraints and defaults

eslint.config.js

@@ -1,6 +1,7 @@
 import eslint from '@eslint/js';
 import configPrettier from 'eslint-config-prettier';
 import pluginSimpleImportSort from 'eslint-plugin-simple-import-sort';
+import pluginSortDestructureKeys from 'eslint-plugin-sort-destructure-keys';
 import pluginSortKeysFix from 'eslint-plugin-sort-keys-fix';
 import pluginTypeScriptSortKeys from 'eslint-plugin-typescript-sort-keys';
 // import pluginVue from 'eslint-plugin-vue'
@@ -19,6 +20,7 @@ export default tseslint.config(
     },
     plugins: {
       'simple-import-sort': pluginSimpleImportSort,
+      'sort-destructure-keys': pluginSortDestructureKeys,
       'sort-keys-fix': pluginSortKeysFix,
       'typescript-sort-keys': pluginTypeScriptSortKeys,
     },
@@ -38,6 +40,7 @@ export default tseslint.config(
       'object-shorthand': 'error',
       'simple-import-sort/exports': 'error',
       'simple-import-sort/imports': 'error',
+      'sort-destructure-keys/sort-destructure-keys': 'warn',
       'sort-imports': 'off',
       'sort-keys-fix/sort-keys-fix': 'warn',
       'typescript-sort-keys/interface': 'warn',

examples/openapi-ts-tanstack-angular-query-experimental/src/app/pet-store/pet-store.component.ts

@@ -90,7 +90,7 @@ export class PetStoreComponent {
       return;
     }
 
-    const { name, category } = form.value as {
+    const { category, name } = form.value as {
       category: string;
       name: string;
     };

examples/openapi-ts-tanstack-svelte-query/src/routes/sverdle/+page.server.ts

@@ -30,7 +30,7 @@ export const actions = {
    * Modify game state in reaction to a guessed word. This logic always runs on
    * the server, so that people can't cheat by peeking at the JavaScript
    */
-  enter: async ({ request, cookies }) => {
+  enter: async ({ cookies, request }) => {
     const game = new Game(cookies.get('sverdle'));
 
     const data = await request.formData();
@@ -51,7 +51,7 @@ export const actions = {
    * Modify game state in reaction to a keypress. If client-side JavaScript
    * is available, this will happen in the browser instead of here
    */
-  update: async ({ request, cookies }) => {
+  update: async ({ cookies, request }) => {
     const game = new Game(cookies.get('sverdle'));
 
     const data = await request.formData();

package.json

@@ -49,6 +49,7 @@
     "eslint": "9.6.0",
     "eslint-config-prettier": "9.1.0",
     "eslint-plugin-simple-import-sort": "12.1.1",
+    "eslint-plugin-sort-destructure-keys": "2.0.0",
     "eslint-plugin-sort-keys-fix": "1.1.2",
     "eslint-plugin-typescript-sort-keys": "3.2.0",
     "eslint-plugin-vue": "9.23.0",

packages/openapi-ts/src/compiler/index.ts

@@ -71,4 +71,5 @@ export const compiler = {
   typeReferenceNode: types.createTypeReferenceNode,
   typeTupleNode: typedef.createTypeTupleNode,
   typeUnionNode: typedef.createTypeUnionNode,
+  valueToExpression: types.toExpression,
 };

packages/openapi-ts/src/compiler/module.ts

@@ -31,8 +31,8 @@ export const createExportAllDeclaration = ({
 export type ImportExportItem = ImportExportItemObject | string;
 
 export const createCallExpression = ({
-  parameters = [],
   functionName,
+  parameters = [],
   types,
 }: {
   functionName:
@@ -108,8 +108,8 @@ export const createNamedExportDeclarations = ({
  * @returns ts.VariableStatement
  */
 export const createConstVariable = ({
-  comment,
   assertion,
+  comment,
   destructure,
   exportConst,
   expression,

packages/openapi-ts/src/compiler/transform.ts

@@ -84,9 +84,9 @@ export const createBinaryExpression = ({
 };
 
 export const createIfStatement = ({
+  elseStatement,
   expression,
   thenStatement,
-  elseStatement,
 }: {
   elseStatement?: ts.Statement;
   expression: ts.Expression;

packages/openapi-ts/src/index.ts

@@ -314,8 +314,8 @@ const initConfigs = async (userConfig: UserConfig): Promise<Config[]> => {
       configFile = '',
       debug = false,
       dryRun = false,
-      exportCore = true,
       experimentalParser = false,
+      exportCore = true,
       name,
       request,
       useOptions = true,

packages/openapi-ts/src/ir/__tests__/mediaType.test.ts

@@ -63,7 +63,7 @@ describe('isMediaTypeFileLike', () => {
 
   it.each(scenarios)(
     'detects $mediaType as file-like? $fileLike',
-    async ({ mediaType, fileLike }) => {
+    async ({ fileLike, mediaType }) => {
       expect(isMediaTypeFileLike({ mediaType })).toEqual(fileLike);
     },
   );

packages/openapi-ts/src/ir/ir.d.ts

@@ -113,7 +113,21 @@ export interface IRResponseObject {
 export interface IRSchemaObject
   extends Pick<
     JsonSchemaDraft2020_12,
-    '$ref' | 'const' | 'deprecated' | 'description' | 'required' | 'title'
+    | '$ref'
+    | 'const'
+    | 'default'
+    | 'deprecated'
+    | 'description'
+    | 'exclusiveMaximum'
+    | 'exclusiveMinimum'
+    | 'maximum'
+    | 'maxItems'
+    | 'maxLength'
+    | 'minimum'
+    | 'minItems'
+    | 'minLength'
+    | 'required'
+    | 'title'
   > {
   /**
    * If the schema is intended to be used as an object property, it can be

packages/openapi-ts/src/legacy/handlebars/handlebars.cjs

@@ -1,12 +1,12 @@
 const Handlebars = require('handlebars');
 const {
+  existsSync,
+  mkdirSync,
   readFileSync,
   readdirSync,
+  rmdirSync,
   statSync,
-  existsSync,
-  mkdirSync,
   writeFileSync,
-  rmdirSync,
 } = require('node:fs');
 const path = require('node:path');
 

packages/openapi-ts/src/openApi/3.0.x/parser/schema.ts

@@ -44,10 +44,46 @@ const parseSchemaMeta = ({
   irSchema: IRSchemaObject;
   schema: SchemaObject;
 }) => {
+  if (schema.default !== undefined) {
+    irSchema.default = schema.default;
+  }
+
+  if (schema.exclusiveMaximum) {
+    if (schema.maximum !== undefined) {
+      irSchema.exclusiveMaximum = schema.maximum;
+    }
+  } else if (schema.maximum !== undefined) {
+    irSchema.maximum = schema.maximum;
+  }
+
+  if (schema.exclusiveMinimum) {
+    if (schema.minimum !== undefined) {
+      irSchema.exclusiveMinimum = schema.minimum;
+    }
+  } else if (schema.minimum !== undefined) {
+    irSchema.minimum = schema.minimum;
+  }
+
   if (schema.format) {
     irSchema.format = schema.format;
   }
 
+  if (schema.maxItems !== undefined) {
+    irSchema.maxItems = schema.maxItems;
+  }
+
+  if (schema.maxLength !== undefined) {
+    irSchema.maxLength = schema.maxLength;
+  }
+
+  if (schema.minItems !== undefined) {
+    irSchema.minItems = schema.minItems;
+  }
+
+  if (schema.minLength !== undefined) {
+    irSchema.minLength = schema.minLength;
+  }
+
   if (schema.readOnly) {
     irSchema.accessScope = 'read';
   } else if (schema.writeOnly) {

packages/openapi-ts/src/openApi/3.1.x/parser/schema.ts

@@ -74,10 +74,46 @@ const parseSchemaMeta = ({
     }
   }
 
+  if (schema.default !== undefined) {
+    irSchema.default = schema.default;
+  }
+
+  if (schema.exclusiveMaximum) {
+    irSchema.exclusiveMaximum = schema.exclusiveMaximum;
+  }
+
+  if (schema.exclusiveMinimum) {
+    irSchema.exclusiveMinimum = schema.exclusiveMinimum;
+  }
+
   if (schema.format) {
     irSchema.format = schema.format;
   }
 
+  if (schema.maximum !== undefined) {
+    irSchema.maximum = schema.maximum;
+  }
+
+  if (schema.maxItems !== undefined) {
+    irSchema.maxItems = schema.maxItems;
+  }
+
+  if (schema.maxLength !== undefined) {
+    irSchema.maxLength = schema.maxLength;
+  }
+
+  if (schema.minimum !== undefined) {
+    irSchema.minimum = schema.minimum;
+  }
+
+  if (schema.minItems !== undefined) {
+    irSchema.minItems = schema.minItems;
+  }
+
+  if (schema.minLength !== undefined) {
+    irSchema.minLength = schema.minLength;
+  }
+
   if (schema.readOnly) {
     irSchema.accessScope = 'read';
   } else if (schema.writeOnly) {

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

@@ -16,7 +16,7 @@ describe('getPattern', () => {
     { expected: '\\\\/', pattern: '\\/' },
     { expected: '\\\\/\\\\/', pattern: '\\/\\/' },
     { expected: "\\'", pattern: "'" },
-  ])('getPattern($pattern) -> $expected', ({ pattern, expected }) => {
+  ])('getPattern($pattern) -> $expected', ({ expected, pattern }) => {
     expect(getPattern(pattern)).toEqual(expected);
   });
 });

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

@@ -12,7 +12,7 @@ describe('parseResponseStatusCode', () => {
     { expected: '4XX', input: '4XX' },
     { expected: null, input: 'abc' },
     { expected: null, input: '-100' },
-  ])('parseResponseStatusCode($input) -> $expected', ({ input, expected }) => {
+  ])('parseResponseStatusCode($input) -> $expected', ({ expected, input }) => {
     expect(parseResponseStatusCode(input)).toBe(expected);
   });
 });

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

@@ -15,7 +15,7 @@ describe('sanitizeOperationParameterName', () => {
     { expected: 'unknownArray', input: 'unknown[]' },
   ])(
     'sanitizeOperationParameterName($input) -> $expected',
-    ({ input, expected }) => {
+    ({ expected, input }) => {
       expect(sanitizeOperationParameterName(input)).toEqual(expected);
     },
   );
@@ -30,7 +30,7 @@ describe('sanitizeNamespaceIdentifier', () => {
     { expected: 'a-b-c--d--e', input: 'a/b{c}/d/$e' },
   ])(
     'sanitizeNamespaceIdentifier($input) -> $expected',
-    ({ input, expected }) => {
+    ({ expected, input }) => {
       expect(sanitizeNamespaceIdentifier(input)).toEqual(expected);
     },
   );
@@ -45,7 +45,7 @@ describe('ensureValidTypeScriptJavaScriptIdentifier', () => {
     { expected: '_400', input: '400' },
   ])(
     'ensureValidTypeScriptJavaScriptIdentifier($input) -> $expected',
-    ({ input, expected }) => {
+    ({ expected, input }) => {
       expect(ensureValidTypeScriptJavaScriptIdentifier(input)).toEqual(
         expected,
       );

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

@@ -7,7 +7,7 @@ describe('getServiceVersion', () => {
     { expected: '1.0', input: '1.0' },
     { expected: '1.2', input: 'v1.2' },
     { expected: '2.4', input: 'V2.4' },
-  ])('should get $expected when version is $input', ({ input, expected }) => {
+  ])('should get $expected when version is $input', ({ expected, input }) => {
     expect(getServiceVersion(input)).toEqual(expected);
   });
 });

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

@@ -30,7 +30,7 @@ describe('sort', () => {
     },
   ])(
     'should sort $input by required to produce $expected',
-    ({ input, expected }) => {
+    ({ expected, input }) => {
       expect(toSortedByRequired(input)).toEqual(expected);
     },
   );

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

@@ -17,7 +17,7 @@ describe('stripNamespace', () => {
     { expected: 'Item', input: '#/components/securitySchemes/Item' },
     { expected: 'Item', input: '#/components/links/Item' },
     { expected: 'Item', input: '#/components/callbacks/Item' },
-  ])('stripNamespace($input) -> $expected', ({ input, expected }) => {
+  ])('stripNamespace($input) -> $expected', ({ expected, input }) => {
     expect(stripNamespace(input)).toEqual(expected);
   });
 });

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

@@ -43,7 +43,7 @@ describe('getMappedType', () => {
     { expected: 'unknown[]', type: 'array' },
     { expected: 'void', type: 'void' },
     { expected: undefined, type: '' },
-  ])('should map type $type to $expected', ({ type, expected }) => {
+  ])('should map type $type to $expected', ({ expected, type }) => {
     expect(getMappedType(type)).toEqual(expected);
   });
 });

packages/openapi-ts/src/openApi/shared/utils/operation.ts

@@ -9,8 +9,8 @@ import { sanitizeNamespaceIdentifier } from '../../common/parser/sanitize';
  */
 export const operationToId = ({
   context,
-  method,
   id,
+  method,
   path,
 }: {
   context: IRContext;

packages/openapi-ts/src/openApi/v2/parser/operation.ts

@@ -18,8 +18,8 @@ export const getOperation = ({
   method,
   op,
   openApi,
-  types,
   pathParams,
+  types,
   url,
 }: {
   method: Lowercase<Operation['method']>;

packages/openapi-ts/src/plugins/@hey-api/services/plugin-legacy.ts

@@ -487,9 +487,9 @@ const toRequestOptions = (
 
 export const serviceFunctionIdentifier = ({
   config,
+  handleIllegal,
   id,
   operation,
-  handleIllegal,
 }: {
   config: Config;
   handleIllegal?: boolean;

packages/openapi-ts/src/plugins/@hey-api/services/plugin.ts

@@ -194,7 +194,7 @@ const generateClassServices = ({ context }: { context: IRContext }) => {
 
   const services = new Map<string, Array<ts.MethodDeclaration>>();
 
-  context.subscribe('operation', ({ operation, method, path }) => {
+  context.subscribe('operation', ({ method, operation, path }) => {
     const identifierData = context.file({ id: 'types' })!.identifier({
       $ref: operationIrRef({ id: operation.id, type: 'data' }),
       namespace: 'type',
@@ -314,7 +314,7 @@ const generateFlatServices = ({ context }: { context: IRContext }) => {
   const file = context.file({ id: servicesId })!;
   const typesModule = file.relativePathToFile({ context, id: 'types' });
 
-  context.subscribe('operation', ({ operation, method, path }) => {
+  context.subscribe('operation', ({ method, operation, path }) => {
     const identifierData = context.file({ id: 'types' })!.identifier({
       $ref: operationIrRef({ id: operation.id, type: 'data' }),
       namespace: 'type',

packages/openapi-ts/src/plugins/@hey-api/types/plugin-legacy.ts

@@ -56,8 +56,8 @@ export const emptyModel: Model = {
 };
 
 const generateEnum = ({
-  leadingComment,
   comments,
+  leadingComment,
   meta,
   obj,
   onNode,