Merge pull request #1265 from hey-api/fix/parameters-explode-false

fix: handle non-exploded array query parameters

.changeset/eight-poets-arrive.md

@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': patch
+---
+
+fix: handle non-exploded array query parameters

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

@@ -10,14 +10,17 @@ export interface ImportExportItemObject {
   name: string;
 }
 
-const printer = ts.createPrinter({ newLine: ts.NewLineKind.LineFeed });
+const printer = ts.createPrinter({
+  newLine: ts.NewLineKind.LineFeed,
+  removeComments: false,
+});
 
 export const createSourceFile = (sourceText: string) =>
   ts.createSourceFile(
     '',
     sourceText,
-    ts.ScriptTarget.ES2015,
-    undefined,
+    ts.ScriptTarget.ESNext,
+    false,
     ts.ScriptKind.TS,
   );
 

packages/openapi-ts/src/index.ts

@@ -223,15 +223,20 @@ const getPlugins = (
       '@hey-api/schemas',
       '@hey-api/services',
     ]
-  ).map((plugin) => {
-    if (typeof plugin === 'string') {
-      return plugin;
-    }
+  )
+    .map((plugin) => {
+      if (typeof plugin === 'string') {
+        return plugin;
+      }
 
-    // @ts-expect-error
-    userPluginsConfig[plugin.name] = plugin;
-    return plugin.name;
-  });
+      if (plugin.name) {
+        // @ts-expect-error
+        userPluginsConfig[plugin.name] = plugin;
+      }
+
+      return plugin.name;
+    })
+    .filter(Boolean);
 
   const pluginOrder = getPluginOrder({
     pluginConfigs: {

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

@@ -60,6 +60,14 @@ export interface IRParametersObject {
 }
 
 export interface IRParameterObject {
+  /**
+   * Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 `:/?#[]@!$&'()*+,;=` to be included without percent-encoding. The default value is `false`. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded` or `multipart/form-data`. If a value is explicitly defined, then the value of `contentType` (implicit or explicit) SHALL be ignored.
+   */
+  allowReserved?: boolean;
+  /**
+   * When this is true, property values of type `array` or `object` generate separate parameters for each value of the array, or key-value-pair of the map. For other types of properties this property has no effect. When `style` is `form`, the default value is `true`. For all other styles, the default value is `false`. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded` or `multipart/form-data`. If a value is explicitly defined, then the value of `contentType` (implicit or explicit) SHALL be ignored.
+   */
+  explode: boolean;
   /**
    * Endpoint parameters must specify their location.
    */
@@ -72,6 +80,17 @@ export interface IRParameterObject {
   pagination?: boolean | string;
   required?: boolean;
   schema: IRSchemaObject;
+  /**
+   * Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of `in`): for `query` - `form`; for `path` - `simple`; for `header` - `simple`; for `cookie` - `form`.
+   */
+  style:
+    | 'deepObject'
+    | 'form'
+    | 'label'
+    | 'matrix'
+    | 'pipeDelimited'
+    | 'simple'
+    | 'spaceDelimited';
 }
 
 export interface IRResponsesObject {

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

@@ -9,6 +9,52 @@ import { mediaTypeObject } from './mediaType';
 import { paginationField } from './pagination';
 import { schemaToIrSchema } from './schema';
 
+/**
+ * Returns default parameter `allowReserved` based on value of `in`.
+ */
+const defaultAllowReserved = (
+  _in: ParameterObject['in'],
+): boolean | undefined => {
+  switch (_in) {
+    // this keyword only applies to parameters with an `in` value of `query`
+    case 'query':
+      return false;
+    default:
+      return;
+  }
+};
+
+/**
+ * Returns default parameter `explode` based on value of `style`.
+ */
+const defaultExplode = (style: Required<ParameterObject>['style']): boolean => {
+  switch (style) {
+    // default value for `deepObject` is `false`, but that behavior is undefined
+    // so we use `true` to make this work with the `client-fetch` package
+    case 'deepObject':
+    case 'form':
+      return true;
+    default:
+      return false;
+  }
+};
+
+/**
+ * Returns default parameter `style` based on value of `in`.
+ */
+const defaultStyle = (
+  _in: ParameterObject['in'],
+): Required<ParameterObject>['style'] => {
+  switch (_in) {
+    case 'header':
+    case 'path':
+      return 'simple';
+    case 'cookie':
+    case 'query':
+      return 'form';
+  }
+};
+
 export const parametersArrayToObject = ({
   context,
   parameters,
@@ -141,13 +187,24 @@ const parameterToIrParameter = ({
     schema: finalSchema,
   });
 
+  const style = parameter.style || defaultStyle(parameter.in);
+  const explode =
+    parameter.explode !== undefined ? parameter.explode : defaultExplode(style);
+  const allowReserved =
+    parameter.allowReserved !== undefined
+      ? parameter.allowReserved
+      : defaultAllowReserved(parameter.in);
+
   const irParameter: IRParameterObject = {
+    allowReserved,
+    explode,
     location: parameter.in,
     name: parameter.name,
     schema: schemaToIrSchema({
       context,
       schema: finalSchema,
     }),
+    style,
   };
 
   if (pagination) {

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

@@ -9,6 +9,52 @@ import { mediaTypeObject } from './mediaType';
 import { paginationField } from './pagination';
 import { schemaToIrSchema } from './schema';
 
+/**
+ * Returns default parameter `allowReserved` based on value of `in`.
+ */
+const defaultAllowReserved = (
+  _in: ParameterObject['in'],
+): boolean | undefined => {
+  switch (_in) {
+    // this keyword only applies to parameters with an `in` value of `query`
+    case 'query':
+      return false;
+    default:
+      return;
+  }
+};
+
+/**
+ * Returns default parameter `explode` based on value of `style`.
+ */
+const defaultExplode = (style: Required<ParameterObject>['style']): boolean => {
+  switch (style) {
+    // default value for `deepObject` is `false`, but that behavior is undefined
+    // so we use `true` to make this work with the `client-fetch` package
+    case 'deepObject':
+    case 'form':
+      return true;
+    default:
+      return false;
+  }
+};
+
+/**
+ * Returns default parameter `style` based on value of `in`.
+ */
+const defaultStyle = (
+  _in: ParameterObject['in'],
+): Required<ParameterObject>['style'] => {
+  switch (_in) {
+    case 'header':
+    case 'path':
+      return 'simple';
+    case 'cookie':
+    case 'query':
+      return 'form';
+  }
+};
+
 export const parametersArrayToObject = ({
   context,
   parameters,
@@ -134,13 +180,24 @@ const parameterToIrParameter = ({
     schema: finalSchema,
   });
 
+  const style = parameter.style || defaultStyle(parameter.in);
+  const explode =
+    parameter.explode !== undefined ? parameter.explode : defaultExplode(style);
+  const allowReserved =
+    parameter.allowReserved !== undefined
+      ? parameter.allowReserved
+      : defaultAllowReserved(parameter.in);
+
   const irParameter: IRParameterObject = {
+    allowReserved,
+    explode,
     location: parameter.in,
     name: parameter.name,
     schema: schemaToIrSchema({
       context,
       schema: finalSchema,
     }),
+    style,
   };
 
   if (pagination) {

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

@@ -153,6 +153,38 @@ const requestOptions = ({
     }
   }
 
+  for (const name in operation.parameters?.query) {
+    const parameter = operation.parameters.query[name];
+    if (
+      (parameter.schema.type === 'array' ||
+        parameter.schema.type === 'tuple') &&
+      (parameter.style !== 'form' || !parameter.explode)
+    ) {
+      // override the default settings for `querySerializer`
+      if (context.config.client.name === '@hey-api/client-fetch') {
+        obj.push({
+          key: 'querySerializer',
+          value: [
+            {
+              key: 'array',
+              value: [
+                {
+                  key: 'explode',
+                  value: false,
+                },
+                {
+                  key: 'style',
+                  value: 'form',
+                },
+              ],
+            },
+          ],
+        });
+      }
+      break;
+    }
+  }
+
   return compiler.objectExpression({
     identifiers: ['responseTransformer'],
     obj,

packages/openapi-ts/test/3.0.x.spec.ts

@@ -75,6 +75,14 @@ describe(`OpenAPI ${VERSION}`, () => {
       }),
       description: 'handles empty response status codes',
     },
+    {
+      config: createConfig({
+        input: 'parameter-explode-false.json',
+        output: 'parameter-explode-false',
+        plugins: ['@hey-api/services'],
+      }),
+      description: 'handles non-exploded array query parameters',
+    },
   ];
 
   it.each(scenarios)('$description', async ({ config }) => {

packages/openapi-ts/test/3.1.x.spec.ts

@@ -106,6 +106,14 @@ describe(`OpenAPI ${VERSION}`, () => {
       }),
       description: 'handles empty response status codes',
     },
+    {
+      config: createConfig({
+        input: 'parameter-explode-false.json',
+        output: 'parameter-explode-false',
+        plugins: ['@hey-api/services'],
+      }),
+      description: 'handles non-exploded array query parameters',
+    },
     {
       config: createConfig({
         input: 'required-all-of-ref.json',

packages/openapi-ts/test/__snapshots__/3.0.x/parameter-explode-false/index.ts

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

packages/openapi-ts/test/__snapshots__/3.0.x/parameter-explode-false/services.gen.ts

@@ -0,0 +1,19 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import { createClient, createConfig, type Options } from '@hey-api/client-fetch';
+import type { PostFooData } from './types.gen';
+
+export const client = createClient(createConfig());
+
+export const postFoo = <ThrowOnError extends boolean = false>(options?: Options<PostFooData, ThrowOnError>) => {
+    return (options?.client ?? client).post<unknown, unknown, ThrowOnError>({
+        ...options,
+        url: '/foo',
+        querySerializer: {
+            array: {
+                explode: false,
+                style: 'form'
+            }
+        }
+    });
+};

packages/openapi-ts/test/__snapshots__/3.0.x/parameter-explode-false/types.gen.ts

@@ -0,0 +1,9 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type PostFooData = {
+    body?: never;
+    path?: never;
+    query?: {
+        foo?: Array<string>;
+    };
+};