feat: support for dictionaries (#218)

* feat: support for dictionaries

* fix: node 10 compatibility

* feat: implemented dictionaries with dictionary type name

Co-authored-by: Kevin Julián Martínez Escobar <kevinccbsg@gmail.com>

Author: joelabrahamsson

test/transforms/components/index.test.js

@@ -865,4 +865,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 {Dictionary<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,18 @@ const getRequiredProperties = properties => (
 
 const formatRequiredProperties = requiredProperties => requiredProperties.map(getPropertyName);
 
+const addDictionaryAdditionalProperties = typedef => {
+  if (!typedef.type.expression || typedef.type.expression.name !== 'Dictionary') {
+    return {};
+  }
+
+  return {
+    additionalProperties: {
+      $ref: `#/components/schemas/${typedef.type.applications[0].name}`,
+    },
+  };
+};
+
 const parseSchema = (schema, options = {}) => {
   const typedef = getTagInfo(schema.tags, 'typedef');
   const propertyValues = getTagsInfo(schema.tags, 'property');
@@ -88,6 +100,7 @@ const parseSchema = (schema, options = {}) => {
       } : {}),
       ...(format ? { format } : {}),
       ...addEnumValues(enumValues),
+      ...addDictionaryAdditionalProperties(typedef),
       ...(jsonOptions || {}),
     },
   };