Merge pull request #3 from GitbookIO/validate-value-as-string

Accept string value as array
GitbookIO · Sep 19, 2024 · 13b1bef · 13b1bef
2 parents 4bead5c + abc3ed6
commit 13b1bef
Show file tree

Hide file tree

Showing 7 changed files with 23,612 additions and 19,935 deletions.
diff --git a/bun.lockb b/bun.lockb
diff --git a/src/compileOperation.ts b/src/compileOperation.ts
@@ -140,11 +140,14 @@ export function compileOperation(
             const parameter = compiler.resolveMaybeRef(refParameter);
             const paramValueIdentifier = builders.identifier(`queryParam${index}`);
             const resultIdentifier = builders.identifier(`queryParamResult${index}`);
+
             const schemaFn = compileValueSchema(compiler, parameter.schema);
 
+            const isArrayType = 'type' in parameter.schema && parameter.schema.type === 'array';
+
             // Assign the query parameter to a variable
             nodes.push(
-                builders.variableDeclaration('const', [
+                builders.variableDeclaration('let', [
                     builders.variableDeclarator(
                         paramValueIdentifier,
                         builders.memberExpression(
@@ -179,6 +182,29 @@ export function compileOperation(
                             : [],
                     ),
                     builders.blockStatement([
+                        // If expected type is array, convert to array if it's a string
+                        ...(isArrayType
+                            ? [
+                                  builders.ifStatement(
+                                      // typeof paramValue === 'string'
+                                      builders.binaryExpression(
+                                          '===',
+                                          builders.unaryExpression('typeof', paramValueIdentifier),
+                                          builders.literal('string'),
+                                      ),
+                                      builders.blockStatement([
+                                          // paramValue = [paramValue]
+                                          builders.expressionStatement(
+                                              builders.assignmentExpression(
+                                                  '=',
+                                                  paramValueIdentifier,
+                                                  builders.arrayExpression([paramValueIdentifier]),
+                                              ),
+                                          ),
+                                      ]),
+                                  ),
+                              ]
+                            : []),
                         // Validate the value
                         builders.variableDeclaration('const', [
                             builders.variableDeclarator(

diff --git a/src/compileValidateRequest.ts b/src/compileValidateRequest.ts
@@ -9,9 +9,9 @@ import { annotateWithJSDocComment } from './comments';
 
 const COMMENT = `
 Validate a request against the OpenAPI spec
-@param {{ method: string; path: string; body?: any; query: Record<string, string>; headers: Record<string, string>; }} request - Input request to validate
+@param {{ method: string; path: string; body?: any; query: Record<string, string | string[]>; headers: Record<string, string>; }} request - Input request to validate
 @param {{ stringFormats?: { [format: string]: (value: string, path: string[]) => ValidationError | null } }} [context] - Context object to pass to validation functions
-@returns {{ operationId?: string; params: Record<string, string>; query: Record<string, string>; body?: any; headers: Record<string, string>; }}
+@returns {{ operationId?: string; params: Record<string, string>; query: Record<string, string | string[]>; body?: any; headers: Record<string, string>; }}
 `;
 
 /**