Merge pull request #356 from danilvalov/master

Add support for simple object pattern in schema
mrjono1 · Dec 5, 2024 · 70c3b6e · 70c3b6e
2 parents 92a1ecc + 6f3e9f2
commit 70c3b6e
Show file tree

Hide file tree

Showing 5 changed files with 100 additions and 47 deletions.
diff --git a/src/__tests__/description/index.ts b/src/__tests__/description/index.ts
@@ -93,13 +93,16 @@ export interface DisableDescriptionObject {
     /**
      * A simple description
      */
-    [x: string]: Example;
+    [pattern: string]: Example;
   };
   /**
    * withoutDescription
    */
   withoutDescription?: {
-    [x: string]: Example;
+    /**
+     * A simple description
+     */
+    [pattern: string]: Example;
   };
 }
 

diff --git a/src/__tests__/patterns.ts b/src/__tests__/patterns.ts
@@ -0,0 +1,74 @@
+import Joi from 'joi';
+
+import { convertSchema } from '../index';
+
+describe('test `Joi.object().pattern()`', () => {
+  test('`pattern(Joi.string(), Joi.AnySchema())`', () => {
+    const schema = Joi.object()
+      .pattern(Joi.string(), Joi.array().items(Joi.object({
+        id: Joi.string().required(),
+        propertyName1: Joi.boolean().required()
+      })))
+      .description('a test pattern schema definition');
+
+    const result = convertSchema({}, schema, 'TestSchema');
+    expect(result).not.toBeUndefined;
+    expect(result?.content).toBe(`/**
+ * a test pattern schema definition
+ */
+export interface TestSchema {
+  [pattern: string]: {
+    id: string;
+    propertyName1: boolean;
+  }[];
+}`);
+  });
+
+  test('`pattern(Joi.string(), Joi.number())`', () => {
+    const schema = Joi.object()
+      .description('a test deep pattern schema definition')
+      .pattern(Joi.string(), Joi.number().description('Number Property'));
+
+    const result = convertSchema({}, schema, 'TestSchema');
+    expect(result).not.toBeUndefined;
+    expect(result?.content).toBe(`/**
+ * a test deep pattern schema definition
+ */
+export interface TestSchema {
+  /**
+   * Number Property
+   */
+  [pattern: string]: number;
+}`);
+  });
+
+  test('`pattern(/^test$/, Joi.AnySchema())`', () => {
+    const schema = Joi.object({
+      name: Joi.string(),
+    })
+      .description('a test regex pattern schema definition')
+      .pattern(Joi.string(), {
+        name: Joi.string().optional(),
+        propertyName1: Joi.object().pattern(/^test$/, Joi.object({
+          propertyName2: Joi.boolean()
+        })).required()
+      });
+
+    const result = convertSchema({ sortPropertiesByName: false }, schema, 'TestSchema');
+    expect(result).not.toBeUndefined;
+    expect(result?.content).toBe(`/**
+ * a test regex pattern schema definition
+ */
+export interface TestSchema {
+  name?: string;
+  [pattern: string]: {
+    name?: string;
+    propertyName1: {
+      [pattern: string]: {
+        propertyName2?: boolean;
+      };
+    };
+  };
+}`);
+  });
+});
diff --git a/src/__tests__/unknown.ts b/src/__tests__/unknown.ts
@@ -65,28 +65,6 @@ export interface TestSchema {
 }`);
   });
 
-  test('`pattern(Joi.string(), Joi.number())`', () => {
-    const schema = Joi.object({
-      name: Joi.string()
-    })
-      .meta({ className: 'TestSchema', unknownType: 'number' })
-      .description('a test schema definition')
-      .pattern(Joi.string(), Joi.number());
-
-    const result = convertSchema({ sortPropertiesByName: false }, schema);
-    expect(result).not.toBeUndefined;
-    expect(result?.content).toBe(`/**
- * a test schema definition
- */
-export interface TestSchema {
-  name?: string;
-  /**
-   * Number Property
-   */
-  [x: string]: number;
-}`);
-  });
-
   test('`unknown(true).meta({ unknownType: Joi.AnySchema() })`', () => {
     const schema = Joi.object({})
       .unknown(true)
@@ -109,26 +87,6 @@ export interface TestSchema {
   [x: string]: {
     id: string;
   }[];
-}`);
-  });
-
-  test('`pattern(Joi.string(), Joi.AnySchema())`', () => {
-    const unknownTypeSchema = Joi.array().items(Joi.object({ id: Joi.string().required() }));
-
-    const schema = Joi.object({})
-      .pattern(Joi.string(), unknownTypeSchema)
-      .meta({ className: 'TestSchema', unknownType: unknownTypeSchema })
-      .description('a test schema definition');
-
-    const result = convertSchema({}, schema);
-    expect(result).not.toBeUndefined;
-    expect(result?.content).toBe(`/**
- * a test schema definition
- */
-export interface TestSchema {
-  [x: string]: {
-    id: string;
-  }[];
 }`);
   });
 });
diff --git a/src/joiDescribeTypes.ts b/src/joiDescribeTypes.ts
@@ -50,7 +50,8 @@ export interface BaseDescribe extends Joi.Description {
    * https://joi.dev/api/#objectpatternpattern-schema-options
    */
   patterns?: {
-    schema: Describe;
+    schema?: Describe;
+    regex?: string;
     rule: Describe;
   }[];
   metas?: Meta[];

diff --git a/src/parse.ts b/src/parse.ts
@@ -723,6 +723,19 @@ function parseUnknown(details: ObjectDescribe, settings: Settings): TypeContent
   return buildUnknownTypeContent();
 }
 
+function parsePatterns(details: ObjectDescribe, settings: Settings): TypeContent {
+  const parsedSchema = details.patterns ? parseSchema(details.patterns[0].rule, settings) : null;
+
+  if (!parsedSchema) {
+    return parseUnknown(details, settings);
+  }
+
+  parsedSchema.required = true;
+  parsedSchema.interfaceOrTypeName = '[pattern: string]';
+
+  return parsedSchema;
+}
+
 function parseObjects(details: ObjectDescribe, settings: Settings): TypeContent | undefined {
   const joinOperation: TypeContentRoot['joinOperation'] =
     details.keys === undefined
@@ -740,8 +753,12 @@ function parseObjects(details: ObjectDescribe, settings: Settings): TypeContent
     parsedSchema.interfaceOrTypeName = /^[$A-Z_][0-9A-Z_$]*$/i.test(key || '') ? key : `'${key}'`;
     return parsedSchema;
   });
-  const isMap = details.patterns?.length === 1 && details.patterns[0].schema.type === 'string';
-  if (details?.flags?.unknown === true || isMap) {
+
+  if (details.patterns?.length === 1 && (details.patterns[0].schema?.type === 'string' || details.patterns[0].regex)) {
+    children.push(parsePatterns(details, settings));
+  }
+
+  if (details?.flags?.unknown === true) {
     children.push(parseUnknown(details, settings));
   }