feat(build): extract all constraints to OAS3

Author: oscar60310

packages/build/src/lib/spec-generator/oas3/oas3SpecGenerator.ts

@@ -2,10 +2,15 @@ import { SpecGenerator } from '../specGenerator';
 import * as oas3 from 'openapi3-ts';
 import {
   APISchema,
+  EnumConstraint,
   ErrorInfo,
   FieldDataType,
   FieldInType,
+  MaxLengthConstraint,
+  MaxValueConstraint,
+  MinLengthConstraint,
   MinValueConstraint,
+  RegexConstraint,
   RequestParameter,
   RequiredConstraint,
   ResponseProperty,
@@ -105,10 +110,22 @@ export class OAS3SpecGenerator extends SpecGenerator<oas3.OpenAPIObject> {
     const schema: oas3.SchemaObject = {
       type: this.convertFieldDataTypeToOASType(parameter.type),
     };
-    const minValueConstraint = parameter.constraints.find(
-      (constraint) => constraint instanceof MinValueConstraint
-    ) as MinValueConstraint;
-    if (minValueConstraint) schema.minimum = minValueConstraint.getMinValue();
+
+    for (const constraint of parameter.constraints) {
+      if (constraint instanceof MinValueConstraint) {
+        schema.minimum = constraint.getMinValue();
+      } else if (constraint instanceof MaxValueConstraint) {
+        schema.maximum = constraint.getMaxValue();
+      } else if (constraint instanceof MinLengthConstraint) {
+        schema.minLength = constraint.getMinLength();
+      } else if (constraint instanceof MaxLengthConstraint) {
+        schema.maxLength = constraint.getMaxLength();
+      } else if (constraint instanceof RegexConstraint) {
+        schema.pattern = constraint.getRegex();
+      } else if (constraint instanceof EnumConstraint) {
+        schema.enum = constraint.getList();
+      }
+    }
 
     return schema;
   }

packages/build/test/spec-generator/oas3.spec.ts

@@ -46,6 +46,9 @@ it('Should extract the correct parameters', async () => {
       in: 'path',
       schema: expect.objectContaining({
         type: 'string',
+        minLength: 3,
+        maxLength: 10,
+        pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}',
       }),
       required: true,
     })
@@ -57,6 +60,7 @@ it('Should extract the correct parameters', async () => {
       schema: expect.objectContaining({
         type: 'number',
         minimum: 10,
+        maximum: 15,
       }),
       required: false,
     })
@@ -71,6 +75,17 @@ it('Should extract the correct parameters', async () => {
       required: false,
     })
   );
+  expect(spec.paths['/user/{id}']?.get.parameters[3]).toEqual(
+    expect.objectContaining({
+      name: 'username',
+      in: 'query',
+      schema: expect.objectContaining({
+        type: 'string',
+        enum: ['ivan', 'eason', 'freda'],
+      }),
+      required: false,
+    })
+  );
 });
 
 it('Should extract the correct response', async () => {

packages/build/test/spec-generator/schema.ts

@@ -50,6 +50,41 @@ const getStubLoader = () => {
           validateData: () => true,
           getConstraints: (args) => [Constraint.MinValue(args.value)],
         };
+      case 'maxValue':
+        return {
+          name: 'maxValue',
+          validateSchema: () => true,
+          validateData: () => true,
+          getConstraints: (args) => [Constraint.MaxValue(args.value)],
+        };
+      case 'minLength':
+        return {
+          name: 'minLength',
+          validateSchema: () => true,
+          validateData: () => true,
+          getConstraints: (args) => [Constraint.MinLength(args.value)],
+        };
+      case 'maxLength':
+        return {
+          name: 'maxLength',
+          validateSchema: () => true,
+          validateData: () => true,
+          getConstraints: (args) => [Constraint.MaxLength(args.value)],
+        };
+      case 'regex':
+        return {
+          name: 'regex',
+          validateSchema: () => true,
+          validateData: () => true,
+          getConstraints: (args) => [Constraint.Regex(args.value)],
+        };
+      case 'enum':
+        return {
+          name: 'enum',
+          validateSchema: () => true,
+          validateData: () => true,
+          getConstraints: (args) => [Constraint.Enum(args.value)],
+        };
       default:
         throw new Error(`Validator ${name} is not implemented in test bed.`);
     }

packages/build/test/spec-generator/schemas/0-user.yaml

@@ -5,16 +5,38 @@ request:
     fieldIn: path
     validators:
       - required
+      - name: minLength
+        args:
+          value: 3
+      - name: maxLength
+        args:
+          value: 10
+      - name: regex
+        args:
+          value: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'
   - fieldName: agent
     fieldIn: header
     type: number
     validators:
       - name: minValue
         args:
           value: 10
+      - name: maxValue
+        args:
+          value: 15
   - fieldName: force
     fieldIn: query
     type: boolean
+  - fieldName: username
+    fieldIn: query
+    type: string
+    validators:
+      - name: enum
+        args:
+          value:
+            - ivan
+            - eason
+            - freda
 description: Get user information
 response:
   - name: id