feat: support for dictionaries

test/transforms/components/index.test.js

@@ -847,4 +847,48 @@ describe('parseComponents method', () => {
     const result = parseComponents({}, parsedJSDocs);
     expect(result).toEqual(expected);
   });
+
+  it('Should parse jsdoc component spec dictionary', () => {
+    const jsodInput = [`
+       /**
+        * Profile
+        * @typedef {object} Profile
+        *
+        * @property {string} email
+        */
+      `,
+    `
+       /**
+        * Profiles dict
+        * @typedef {Object.<string, Profile>} Profiles
+        */
+    `];
+    const expected = {
+      components: {
+        schemas: {
+          Profile: {
+            type: 'object',
+            description: 'Profile',
+            properties: {
+              email: {
+                type: 'string',
+                description: '',
+              },
+            },
+          },
+          Profiles: {
+            type: 'object',
+            description: 'Profiles dict',
+            properties: {},
+            additionalProperties: {
+              $ref: '#/components/schemas/Profile',
+            },
+          },
+        },
+      },
+    };
+    const parsedJSDocs = jsdocInfo()(jsodInput);
+    const result = parseComponents({}, parsedJSDocs);
+    expect(result).toEqual(expected);
+  });
 });

transforms/components/index.js

@@ -64,6 +64,17 @@ const getRequiredProperties = properties => (
 
 const formatRequiredProperties = requiredProperties => requiredProperties.map(getPropertyName);
 
+const addDictionaryAdditionalProperties = typedef => {
+  if (typedef.type?.applications?.length === 2 && typedef.type.applications[0].name === 'string') {
+    return {
+      additionalProperties: {
+        $ref: `#/components/schemas/${typedef.type.applications[1].name}`,
+      },
+    };
+  }
+  return {};
+};
+
 const parseSchema = (schema, options = {}) => {
   const typedef = getTagInfo(schema.tags, 'typedef');
   const propertyValues = getTagsInfo(schema.tags, 'property');
@@ -88,6 +99,7 @@ const parseSchema = (schema, options = {}) => {
       } : {}),
       ...(format ? { format } : {}),
       ...addEnumValues(enumValues),
+      ...addDictionaryAdditionalProperties(typedef),
       ...(jsonOptions || {}),
     },
   };