Merge pull request #30 from apideck-libraries/fix/null-enum-tostring

fix: handle null values in enum allowedValues

Author: Gdewilde

src/index.test.ts

@@ -278,6 +278,36 @@ describe('betterAjvErrors', () => {
       ]);
     });
 
+    it('should not crash when allowedValues contains null', () => {
+      data = {
+        str: 'str',
+        enum: 'invalid',
+      };
+      schema = {
+        type: 'object',
+        properties: {
+          str: { type: 'string' },
+          enum: {
+            type: ['string', 'null'],
+            enum: ['one', 'two', null],
+          },
+        },
+      };
+      ajv.validate(schema, data);
+      const errors = betterAjvErrors({ data, schema, errors: ajv.errors });
+      expect(errors).toEqual([
+        {
+          context: {
+            errorType: 'enum',
+            allowedValues: ['one', 'two', null],
+          },
+          message: "'enum' property must be equal to one of the allowed values",
+          path: '{base}.enum',
+          suggestion: "Did you mean 'one'?",
+        },
+      ]);
+    });
+
     it('should not crash on null value', () => {
       data = {
         type: null,

src/index.ts

@@ -55,7 +55,7 @@ export const betterAjvErrors = <S = any>({
         break;
       }
       case 'enum': {
-        const suggestions = error.params.allowedValues.map((value) => value.toString());
+        const suggestions = error.params.allowedValues.map((value) => String(value ?? ''));
         const prop = getLastSegment(error.instancePath);
         const value = safeJsonPointer({ object: data, pnter: error.instancePath, fallback: '' });
         validationError = {