swaggie 1.4.1-test.1 → 1.4.2

package/dist/gen/genOperations.js

@@ -137,27 +137,6 @@ function prepareClient(
   });
 } exports.prepareOperations = prepareOperations;
 
-/**
- * Prepares content for the operation docs. We will use description and summary if they are defined
- * in the spec. Additionally we will add deprecation tag if the operation is deprecated.
- * This function should include JSDocs asterisks to make comments look nice.
- */
-function getOperationDocs(op) {
-  const result = [];
-  const summary = _optionalChain([op, 'access', _3 => _3.summary, 'optionalAccess', _4 => _4.trim, 'call', _5 => _5()]);
-  const description = _optionalChain([op, 'access', _6 => _6.description, 'optionalAccess', _7 => _7.trim, 'call', _8 => _8()]);
-  if (summary) {
-    result.push(summary);
-  }
-  if (description && description !== summary) {
-    result.push(description);
-  }
-  if (op.deprecated) {
-    result.push('@deprecated');
-  }
-  return result;
-}
-
 /**
  * Marks parameters as skippable based on their position relative to the last required parameter.
  *
@@ -250,16 +229,17 @@ function prepareUrl(path) {
   }
 
   const result = params
-    .filter((p) => !where || where.includes(p.in))
+    .filter((p) => p.name && (!where || where.includes(p.in)))
     .map((p) => ({
       originalName: p.name,
       name: getParamName(p.name),
       type: _swagger.getParameterType.call(void 0, p, options),
       optional: p.required === undefined || p.required === null ? true : !p.required,
       original: p,
+      jsDoc: _optionalChain([p, 'access', _3 => _3.description, 'optionalAccess', _4 => _4.trim, 'call', _5 => _5()]),
     }));
 
-  if (_optionalChain([options, 'access', _9 => _9.modifiers, 'optionalAccess', _10 => _10.parameters])) {
+  if (_optionalChain([options, 'access', _6 => _6.modifiers, 'optionalAccess', _7 => _7.parameters])) {
     for (const [name, modifier] of Object.entries(options.modifiers.parameters)) {
       const paramIndex = result.findIndex(
         (p) => p.original.in !== 'path' && (p.originalName === name || p.name === name)
@@ -286,6 +266,10 @@ function prepareUrl(path) {
  * Escapes param name so it can be used as a valid identifier in the generated code
  */
  function getParamName(name) {
+  if (!name) {
+    return name;
+  }
+
   return _utils.escapeIdentifier.call(void 0, 
     name
       .split('.')

package/dist/gen/jsDocs.js

@@ -72,9 +72,9 @@ function stripSpecificHtmlTags(str) {
 
   const result = docs;
   for (const param of params) {
-    const paramLine = `@param ${param.name} ${param.optional ? '(optional)' : ''} ${
-      param.name !== param.originalName ? `(API name: ${param.originalName})` : ''
-    }`;
+    const paramLine = `@param ${param.name}${param.optional ? ' (optional)' : ''}${
+      param.name !== param.originalName ? ` (API name: ${param.originalName})` : ''
+    }${param.jsDoc ? ` - ${param.jsDoc}` : ''}`;
     result.push(paramLine);
   }
   return renderComment(result.join('\n'));

package/dist/swagger/operations.js

@@ -1,4 +1,4 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _optionalChain(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; }
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } } function _optionalChain(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; }
 
 
 const SUPPORTED_METHODS = ['get', 'put', 'post', 'delete', 'options', 'head', 'patch'];
@@ -45,29 +45,22 @@ function getPathOperations(pathInfo, spec) {
 
 /**
  * Parameters can be defined on the path level and should be inherited by all operations
- * contained in the path.
+ * contained in the path. If the operation has a parameter with the same name and in,
+ * then it won't be added to the operation parameters.
  */
-function inheritPathParams(op, spec, pathInfo) {
-  const pathParams = spec.paths[pathInfo.path].parameters;
-  if (pathParams) {
-    for (const pathParam of pathParams) {
-      if ('$ref' in pathParam) {
-        if (
-          !op.parameters
-            .filter((p) => '$ref' in p)
-            .some((p) => p.$ref === pathParam.$ref)
-        ) {
-          op.parameters.push(Object.assign({}, pathParam));
-        }
-      } else {
-        if (
-          !op.parameters
-            .filter((p) => 'name' in p)
-            .some((p) => p.name === pathParam.name && p.in === pathParam.in)
-        ) {
-          op.parameters.push(Object.assign({}, pathParam));
-        }
-      }
+function inheritPathParams(op, inheritableParams) {
+  if (inheritableParams.length === 0) {
+    return;
+  }
+
+  for (const pathParam of inheritableParams) {
+    // If the operation doesn't have a parameter with the same name and in, then add it
+    if (
+      !op.parameters.some(
+        (p) => p.name === pathParam.name && p.in === pathParam.in
+      )
+    ) {
+      op.parameters.push(Object.assign({}, pathParam));
     }
   }
 }
@@ -90,7 +83,16 @@ function getPathOperation(
       .replace(/[\/}\-]/g, '');
   }
 
-  inheritPathParams(op, spec, pathInfo);
+  const pathLevelParams = _nullishCoalesce(spec.paths[pathInfo.path].parameters, () => ( []));
+
+  // Replace the path level parameters references with the actual parameters
+  replaceReferencedParams(pathLevelParams, _nullishCoalesce(_optionalChain([spec, 'access', _2 => _2.components, 'optionalAccess', _3 => _3.parameters]), () => ( {})));
+
+  // Replace the operation parameters references with the actual parameters
+  replaceReferencedParams(op.parameters, _nullishCoalesce(_optionalChain([spec, 'access', _4 => _4.components, 'optionalAccess', _5 => _5.parameters]), () => ( {})));
+
+  // At this stage path level parameters are already replaced with the actual parameters
+  inheritPathParams(op, pathLevelParams );
 
   return op;
 }
@@ -101,11 +103,35 @@ function getPathOperation(
  * Removes invalid characters and ensures the name doesn't start with a number.
  */
 function getOperationGroupName(op) {
-  let name = _optionalChain([op, 'access', _2 => _2.tags, 'optionalAccess', _3 => _3.length]) ? op.tags[0] : 'default';
+  let name = _optionalChain([op, 'access', _6 => _6.tags, 'optionalAccess', _7 => _7.length]) ? op.tags[0] : 'default';
   name = name.replace(/[^$_a-z0-9]+/gi, '');
   return name.replace(/^[0-9]+/m, '');
 }
 
+/**
+ * Replaces referenced parameters with the actual parameters from the components/parameters.
+ * It does replace them in place, because for parameters we only care about the actual parameter
+ * and not the reference object.
+ */
+function replaceReferencedParams(
+  parameters,
+  componentParams
+) {
+  for (let index = 0; index < parameters.length; index++) {
+    const param = parameters[index];
+
+    if ('$ref' in param) {
+      const paramName = param.$ref.replace('#/components/parameters/', '');
+      const referencedParam = componentParams[paramName];
+      if (referencedParam) {
+        parameters[index] = Object.assign({}, referencedParam);
+      } else {
+        console.error(`Parameter ${paramName} reference not found in components parameters`);
+      }
+    }
+  }
+}
+
 
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swaggie",
-  "version": "1.4.1-test.1",
+  "version": "1.4.2",
   "description": "Generate TypeScript REST client code from an OpenAPI spec",
   "author": {
     "name": "Piotr Dabrowski",