Merge pull request #167 from vosmol/feat/add-request-cookies-definition

feat: add support for cookies in RouteConfig.request object
asteasolutions · Jul 26, 2023 · fe0c06f · fe0c06f
2 parents d916809 + 2dc9fb5
commit fe0c06f
Show file tree

Hide file tree

Showing 3 changed files with 92 additions and 2 deletions.
diff --git a/spec/routes/parameters.spec.ts b/spec/routes/parameters.spec.ts
@@ -194,6 +194,85 @@ describe('parameters', () => {
     });
   });
 
+  describe('cookies', () => {
+    it('generates a cookie parameter for route', () => {
+      const { parameters } = generateDataForRoute({
+        request: { cookies: z.object({ test: z.string() }) },
+      });
+
+      expect(parameters).toEqual([
+        {
+          in: 'cookie',
+          name: 'test',
+          required: true,
+          schema: {
+            type: 'string',
+          },
+        },
+      ]);
+    });
+
+    it('generates a reference cookie parameter for route', () => {
+      const TestParam = registerParameter(
+        'TestParam',
+        z.string().openapi({
+          param: { name: 'test', in: 'cookie' },
+        })
+      );
+
+      const { parameters, documentParameters } = generateDataForRoute(
+        { request: { cookies: z.object({ test: TestParam.schema }) } },
+        [TestParam]
+      );
+
+      expect(documentParameters).toEqual({
+        TestParam: {
+          in: 'cookie',
+          name: 'test',
+          required: true,
+          schema: {
+            $ref: '#/components/schemas/TestParam',
+          },
+        },
+      });
+
+      expect(parameters).toEqual([
+        { $ref: '#/components/parameters/TestParam' },
+      ]);
+    });
+
+    it('can automatically register request cookie parameters', () => {
+      const cookieId = z.string().openapi('cookieId').length(6);
+
+      const { documentSchemas, parameters } = generateDataForRoute({
+        request: {
+          cookies: z.object({
+            id: cookieId,
+          }),
+        },
+      });
+
+      expect(documentSchemas).toEqual({
+        cookieId: {
+          type: 'string',
+          minLength: 6,
+          maxLength: 6,
+        },
+      });
+
+      expect(parameters).toEqual([
+        {
+          in: 'cookie',
+          name: 'id',
+          required: true,
+          schema: {
+            $ref: '#/components/schemas/cookieId',
+          },
+        },
+      ]);
+    });
+  });
+
   describe('header', () => {
     it('generates a header parameter with array for route', () => {
       const { parameters } = generateDataForRoute({

diff --git a/src/openapi-generator.ts b/src/openapi-generator.ts
@@ -534,7 +534,7 @@ export class OpenAPIGenerator {
       return [];
     }
 
-    const { query, params, headers } = request;
+    const { query, params, headers, cookies } = request;
 
     const queryParameters = this.enhanceMissingParametersError(
       () => (query ? this.generateInlineParameters(query, 'query') : []),
@@ -546,6 +546,11 @@ export class OpenAPIGenerator {
       { location: 'path' }
     );
 
+    const cookieParameters = this.enhanceMissingParametersError(
+      () => (cookies ? this.generateInlineParameters(cookies, 'cookie') : []),
+      { location: 'cookie' }
+    );
+
     const headerParameters = this.enhanceMissingParametersError(
       () =>
         headers
@@ -558,7 +563,12 @@ export class OpenAPIGenerator {
       { location: 'header' }
     );
 
-    return [...pathParameters, ...queryParameters, ...headerParameters];
+    return [
+      ...pathParameters,
+      ...queryParameters,
+      ...headerParameters,
+      ...cookieParameters,
+    ];
   }
 
   generatePath(route: RouteConfig): PathItemObject {

diff --git a/src/openapi-registry.ts b/src/openapi-registry.ts
@@ -101,6 +101,7 @@ export type RouteConfig = Omit<OperationObject, 'responses'> & {
     body?: ZodRequestBody;
     params?: AnyZodObject;
     query?: AnyZodObject;
+    cookies?: AnyZodObject;
     headers?: AnyZodObject | ZodType<unknown>[];
   };
   responses: {