task: fix typos (#542)

Author: Gustavo Bazan

tools/transformer/src/atlasTransformations.js

@@ -4,7 +4,7 @@ const {
   applyModelNameTransformations,
   applyDiscriminatorTransformations,
   applyRemoveEnumsTransformations,
-  applyRemoveObjectAdditonalProperties,
+  applyRemoveObjectAdditionalProperties,
   applyAnyOfTransformations,
   applyRemoveNullableTransformations,
   removeRefsFromParameters,
@@ -27,7 +27,7 @@ module.exports = function runTransformations(openapi) {
   openapi = applyAllOfTransformations(openapi);
   openapi = applyRemoveEnumsTransformations(openapi);
   openapi = applyRemoveNullableTransformations(openapi);
-  openapi = applyRemoveObjectAdditonalProperties(openapi);
+  openapi = applyRemoveObjectAdditionalProperties(openapi);
   openapi = reorderResponseBodies(openapi);
 
   openapi = applyModelNameTransformations(

tools/transformer/src/engine/readers.js

@@ -52,7 +52,7 @@ function getAllObjects(object, filter = (_obj) => true) {
         }
       }
     }
-    // Add all properties of the object to the recurssion stack
+    // Add all properties of the object to the recursion stack
     else {
       for (let key of Object.keys(currentObj)) {
         if (typeof currentObj[key] === "object" && currentObj[key]) {
@@ -69,14 +69,12 @@ function getAllObjects(object, filter = (_obj) => true) {
 }
 
 function filterObjectProperties(object, filter = (_k, _v) => true) {
-  const filteredObj = Object.keys(object)
+  return Object.keys(object)
     .filter((key) => filter(key, object[key]))
     .reduce((aggregationObj, key) => {
       aggregationObj[key] = object[key];
       return aggregationObj;
     }, {});
-
-  return filteredObj;
 }
 
 function getObjectProperties(obj) {
@@ -149,11 +147,11 @@ function isSchema(path) {
   const pathStack = path.split(".").reverse();
   pathStack.pop();
 
-  if (pathStack.length != 3) {
+  if (pathStack.length !== 3) {
     return false;
   }
 
-  return pathStack.pop() == "components" && pathStack.pop() == "schemas";
+  return pathStack.pop() === "components" && pathStack.pop() === "schemas";
 }
 
 module.exports = {

tools/transformer/src/engine/transformers.js

@@ -4,14 +4,12 @@ const {
 } = require("../engine/readers");
 
 function filterObjectProperties(object, filter = (_k, _v) => true) {
-  const filteredObj = Object.keys(object)
+  return Object.keys(object)
     .filter((key) => filter(key, object[key]))
     .reduce((aggregationObj, key) => {
       aggregationObj[key] = object[key];
       return aggregationObj;
     }, {});
-
-  return filteredObj;
 }
 
 // Detects duplicates in array of object properties
@@ -120,11 +118,7 @@ function removeParentFromAllOf(child, parentName) {
     return objName !== parentName;
   });
 
-  if (initialLength === child.allOf.length) {
-    return false;
-  }
-
-  return true;
+  return initialLength !== child.allOf.length;
 }
 
 // For string reference fetch object from openapi

tools/transformer/src/transformations/additionalPropertiesObject.js

@@ -1,5 +1,5 @@
 /**
- * Remove all AdditonalProperties object section
+ * Remove all AdditionalProperties object section
  * That generates an map[string]map[string]string objects for SDK
  * but for our API much safer is to rely on the map[string]any
  * This is due to the fact that dynamic field can be array which would
@@ -8,20 +8,20 @@
  * @param modelNames
  * @returns OpenAPI JSON File
  */
-function applyRemoveObjectAdditonalProperties(api) {
+function applyRemoveObjectAdditionalProperties(api) {
   const hasSchemas = api && api.components && api.components.schemas;
   if (!hasSchemas) {
     throw new Error("Missing schemas in openapi");
   }
   // Recursive function to traverse the OpenAPI object
-  function removeObjectAdditonalProperties(obj) {
+  function removeObjectAdditionalProperties(obj) {
     if (typeof obj !== "object" || obj === null) {
       return;
     }
 
     if (Array.isArray(obj)) {
       for (let i = 0; i < obj.length; i++) {
-        removeObjectAdditonalProperties(obj[i]);
+        removeObjectAdditionalProperties(obj[i]);
       }
     } else {
       // Remove enum field if present
@@ -34,17 +34,17 @@ function applyRemoveObjectAdditonalProperties(api) {
       // Traverse nested properties
       for (const prop in obj) {
         if (obj.hasOwnProperty(prop)) {
-          removeObjectAdditonalProperties(obj[prop]);
+          removeObjectAdditionalProperties(obj[prop]);
         }
       }
     }
   }
 
   // Start removing enum fields from the OpenAPI object
-  removeObjectAdditonalProperties(api);
+  removeObjectAdditionalProperties(api);
   return api;
 }
 
 module.exports = {
-  applyRemoveObjectAdditonalProperties,
+  applyRemoveObjectAdditionalProperties: applyRemoveObjectAdditionalProperties,
 };

tools/transformer/src/transformations/anyOf.js

@@ -10,15 +10,14 @@ const { detectDuplicates } = require("../engine/transformers");
  * Transforms provided API JSON file using anyOf transformation
  *
  * @param {*} api OpenAPI JSON File
- * @param {*} anyOfTransformations array of transformations to apply
  * @returns OpenAPI JSON File
  */
 function applyAnyOfTransformations(api) {
   const anyOfTransformations = getAllObjects(api, (obj) => {
     return canApplyAnyOfTransformation(obj, api);
   });
 
-  transformationPaths = anyOfTransformations.map((e) => e.path);
+  const transformationPaths = anyOfTransformations.map((e) => e.path);
 
   console.info(
     "# AnyOf transformations: " +
@@ -81,7 +80,7 @@ function transformAnyOfEnum(parentObject, api) {
   delete parentObject.anyOf;
 }
 
-// Moves all the propertis of the children into the parent
+// Moves all the properties of the children into the parent
 function transformAnyOfProperties(parentObject, api) {
   const childObjects = parentObject.anyOf.map((childRef) =>
     getObjectFromReference(childRef, api),
@@ -129,11 +128,8 @@ function transformAnyOfProperties(parentObject, api) {
   delete parentObject.anyOf;
 }
 
-function canApplyAnyOfTransformation(obj, api) {
-  if (obj.anyOf) {
-    return true;
-  }
-  return false;
+function canApplyAnyOfTransformation(obj, _) {
+  return !!obj.anyOf;
 }
 
 module.exports = {

tools/transformer/src/transformations/discriminator.js

@@ -47,12 +47,12 @@ function transformDiscriminatorOneOf(objectPath, api) {
       `Setting oneOf based on discriminator for allOf transformation in ${parentName}`,
     );
     // Ignore objects that point to themselves
-    oneOfReferences = Object.values(parentObject.discriminator.mapping);
-    // Remove duplicates in referneces
+    let oneOfReferences = Object.values(parentObject.discriminator.mapping);
+    // Remove duplicates in references
     oneOfReferences = [...new Set(oneOfReferences)];
 
     for (referenceObj of oneOfReferences) {
-      if (getObjectNameFromReferenceString(referenceObj) == parentName) {
+      if (getObjectNameFromReferenceString(referenceObj) === parentName) {
         if (isModelIgnored(parentName, ignoreModels)) {
           console.warn("Ignored discriminator reference for: " + parentName);
           return;

tools/transformer/src/transformations/index.js

@@ -9,7 +9,7 @@ const { applyDiscriminatorTransformations } = require("./discriminator");
 const { applyArrayTransformations } = require("./swapArray");
 const { applyRemoveEnumsTransformations } = require("./removeEnums");
 const {
-  applyRemoveObjectAdditonalProperties,
+  applyRemoveObjectAdditionalProperties,
 } = require("./additionalPropertiesObject");
 const { applyAnyOfTransformations } = require("./anyOf");
 const { applyRemoveNullableTransformations } = require("./removeNullable");
@@ -26,7 +26,7 @@ module.exports = {
   applyDiscriminatorTransformations,
   applyArrayTransformations,
   applyRemoveEnumsTransformations,
-  applyRemoveObjectAdditonalProperties,
+  applyRemoveObjectAdditionalProperties,
   applyAnyOfTransformations,
   applyRemoveNullableTransformations,
   removeRefsFromParameters,

tools/transformer/src/transformations/oneOf.js

@@ -13,15 +13,14 @@ const { detectDuplicates } = require("../engine/transformers");
  * Transforms provided API JSON file using oneOf transformation
  *
  * @param {*} api OpenAPI JSON File
- * @param {*} oneOfTransformations array of transformations to apply
  * @returns OpenAPI JSON File
  */
 function applyOneOfTransformations(api) {
   const oneOfTransformations = getAllObjects(api, (obj) => {
     return canApplyOneOfTransformation(obj, api);
   }).filter((e) => !ignoreModels.includes(e.path));
 
-  transformationPaths = oneOfTransformations.map((e) => e.path);
+  const transformationPaths = oneOfTransformations.map((e) => e.path);
   console.info(
     "# OneOf transformations: " +
       JSON.stringify(transformationPaths, undefined, 2),
@@ -83,7 +82,7 @@ function transformOneOfEnum(parentObject, api) {
   delete parentObject.oneOf;
 }
 
-// Moves all the propertis of the children into the parent
+// Moves all the properties of the children into the parent
 function transformOneOfProperties(parentObject, api) {
   const childObjects = parentObject.oneOf.map((childRef) =>
     getObjectFromReference(childRef, api),
@@ -153,7 +152,7 @@ function handleDuplicates(parentObject, childObject) {
   }
 }
 
-// Uses ignore list for known missmatches and removes them
+// Uses ignore list for known mismatches and removes them
 function filterReferenceOrTypeMissmatch(mismatches) {
   return mismatches.filter((mismatch) => {
     for (const ignoredProperty of ignoredProperties) {
@@ -183,8 +182,8 @@ function mergeDuplicates(
     )}\n`,
   );
   for (duplicate of duplicates) {
-    childProperty = childObject.properties[duplicate.key];
-    parentProperty = parentObject.properties[duplicate.key];
+    const childProperty = childObject.properties[duplicate.key];
+    const parentProperty = parentObject.properties[duplicate.key];
 
     if (
       parentProperty.description &&
@@ -195,10 +194,7 @@ function mergeDuplicates(
 }
 
 function canApplyOneOfTransformation(obj, api) {
-  if (obj.oneOf) {
-    return true;
-  }
-  return false;
+  return !!obj.oneOf;
 }
 
 module.exports = {