swaggie 1.3.0-test.2 → 1.3.0

package/dist/gen/genOperations.js

@@ -121,8 +121,10 @@ function prepareClient(
       });
     }
 
+    const docs = getOperationDocs(op);
     return {
-      docs: getOperationDocs(op),
+      docs,
+      hasJSDocs: docs && docs.length > 0 && params.length > 0,
       returnType,
       responseContentType,
       method: op.method.toUpperCase(),
@@ -143,11 +145,13 @@ function prepareClient(
  */
 function getOperationDocs(op) {
   const result = [];
-  if (op.description) {
-    result.push(op.description);
+  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 (op.summary) {
-    result.push(op.summary);
+  if (description && description !== summary) {
+    result.push(description);
   }
   if (op.deprecated) {
     result.push('@deprecated');
@@ -256,7 +260,7 @@ function prepareUrl(path) {
       original: p,
     }));
 
-  if (_optionalChain([options, 'access', _3 => _3.modifiers, 'optionalAccess', _4 => _4.parameters])) {
+  if (_optionalChain([options, 'access', _9 => _9.modifiers, 'optionalAccess', _10 => _10.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)

package/dist/gen/genTypes.js

@@ -46,11 +46,16 @@ function renderSchema(
   options
 ) {
   const safeName = _swagger.getSafeIdentifier.call(void 0, name);
+  if (!safeName) {
+    console.warn(`Skipping schema ${name} because it is not a valid identifier`);
+    return '';
+  }
 
   // This is an interesting case, because it is allowed but not likely to be used
   // as it is just a reference to another schema object
   if ('$ref' in schema) {
-    return `export type ${safeName} = ${_swagger.getSafeIdentifier.call(void 0, schema.$ref.split('/').pop())};`;
+    const refName = _swagger.getSafeIdentifier.call(void 0, schema.$ref.split('/').pop());
+    return `export type ${safeName} = ${refName || 'unknown'};`;
   }
 
   const result = [];

package/dist/gen/refsHelper.js

@@ -55,7 +55,7 @@ function findDirectRefs(obj, options, refs) {
 
   // If the object is deprecated and we want to skip deprecated objects,
   // we won't process it and anything below it
-  if (options.skipDeprecated && 'deprecated' in obj && obj.deprecated) {
+  if (options.skipDeprecated && obj.deprecated) {
     return;
   }
 

package/dist/utils/utils.js

@@ -61,6 +61,10 @@ const reservedKeywords = new Set([
  * Escaping is done by adding an underscore prefix.
  */
  function escapeIdentifier(name) {
+  if (!name) {
+    return name;
+  }
+
   if (reservedKeywords.has(name) || /^[0-9]/.test(name)) {
     return `_${name}`;
   }

package/package.json

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

package/templates/axios/operation.ejs

@@ -1,3 +1,4 @@
+<% if(it.hasJSDocs) { %>
   /**
 <% if(it.docs && it.docs.length > 0) { %>
    * <%~ it.docs.join('\n   * ') %>
@@ -8,6 +9,7 @@
 
 <% }); -%>
    */
+<% } %>
   <%= it.name %>(<% it.parameters.forEach((parameter) => { %>
 <%= parameter.name %><%= parameter.skippable ? '?' : '' %>: <%~ parameter.type %> <%= parameter.optional ? (parameter.skippable ? '| null' : '| null | undefined') : '' %>,
     <% }); %>

package/templates/fetch/operation.ejs

@@ -1,3 +1,4 @@
+<% if(it.hasJSDocs) { %>
   /**
 <% if(it.docs && it.docs.length > 0) { %>
    * <%~ it.docs.join('\n   * ') %>
@@ -8,6 +9,7 @@
 
 <% }); -%>
    */
+<% } %>
   <%= it.name %>(<% it.parameters.forEach((parameter) => { %>
 <%= parameter.name %><%= parameter.skippable ? '?' : '' %>: <%~ parameter.type %> <%= parameter.optional ? (parameter.skippable ? '| null' : '| null | undefined') : '' %>,
     <% }); %>

package/templates/ng1/operation.ejs

@@ -1,3 +1,4 @@
+<% if(it.hasJSDocs) { %>
   /**
 <% if(it.docs && it.docs.length > 0) { %>
    * <%~ it.docs.join('\n   * ') %>
@@ -9,6 +10,7 @@
 <% }); -%>
    * @return Success
    */
+<% } %>
   <%= it.name %>(<% it.parameters.forEach((parameter) => { %>
 <%= parameter.name %><%= parameter.skippable ? '?' : '' %>: <%~ parameter.type %> <%= parameter.optional ? (parameter.skippable ? '| null' : '| null | undefined') : '' %>,
     <% }); %>

package/templates/ng2/operation.ejs

@@ -1,6 +1,7 @@
-/**
+<% if(it.hasJSDocs) { %>
+  /**
 <% if(it.docs && it.docs.length > 0) { %>
-  * <%~ it.docs.join('\n   * ') %>
+   * <%~ it.docs.join('\n   * ') %>
 <% } %>
 
 <% it.parameters.forEach((parameter) => { %>
@@ -9,6 +10,7 @@
 <% }); -%>
    * @return Success
    */
+<% } %>
   <%= it.name %>(
     <% it.parameters.forEach((parameter) => { %>
 <%= parameter.name %><%= parameter.skippable ? '?' : '' %>: <%~ parameter.type %> <%= parameter.optional ? (parameter.skippable ? '| null' : '| null | undefined') : '' %>,

package/templates/swr-axios/operation.ejs

@@ -1,3 +1,4 @@
+<% if(it.hasJSDocs) { %>
   /**
 <% if(it.docs && it.docs.length > 0) { %>
    * <%~ it.docs.join('\n   * ') %>
@@ -8,6 +9,7 @@
 
 <% }); -%>
    */
+<% } %>
   <%= it.name %>(<% it.parameters.forEach((parameter) => { %>
 <%= parameter.name %><%= parameter.skippable ? '?' : '' %>: <%~ parameter.type %> <%= parameter.optional ? (parameter.skippable ? '| null' : '| null | undefined') : '' %>,
     <% }); %>

package/templates/swr-axios/swrOperation.ejs

@@ -1,6 +1,7 @@
-/**
+<% if(it.hasJSDocs) { %>
+  /**
 <% if(it.docs && it.docs.length > 0) { %>
-  * <%~ it.docs.join('\n   * ') %>
+   * <%~ it.docs.join('\n   * ') %>
 <% } %>
 
 <% it.parameters.forEach((parameter) => { %>
@@ -8,6 +9,7 @@
 
 <% }); -%>
    */
+<% } %>
 export function <%= it.swrOpName %>(<% it.parameters.forEach((parameter) => { %>
   <%= parameter.name %><%= parameter.skippable ? '?' : '' %>: <%~ parameter.type %> <%= parameter.optional ? (parameter.skippable ? '| null' : '| null | undefined') : '' %>,
     <% }); %>

package/templates/tsq-xior/operation.ejs

@@ -1,3 +1,4 @@
+<% if(it.hasJSDocs) { %>
   /**
 <% if(it.docs && it.docs.length > 0) { %>
    * <%~ it.docs.join('\n   * ') %>
@@ -8,6 +9,7 @@
 
 <% }); -%>
    */
+<% } %>
   <%= it.name %>(<% it.parameters.forEach((parameter) => { %>
 <%= parameter.name %><%= parameter.skippable ? '?' : '' %>: <%~ parameter.type %> <%= parameter.optional ? (parameter.skippable ? '| null' : '| null | undefined') : '' %>,
     <% }); %>

package/templates/tsq-xior/queryOperation.ejs

@@ -1,6 +1,7 @@
+<% if(it.hasJSDocs) { %>
 /**
 <% if(it.docs && it.docs.length > 0) { %>
-  * <%~ it.docs.join('\n   * ') %>
+   * <%~ it.docs.join('\n   * ') %>
 <% } %>
 
 <% it.parameters.forEach((parameter) => { %>
@@ -10,6 +11,7 @@
    * @param $config (optional) Additional configuration for TanStack Query
    * @param $httpConfig (optional) Additional configuration for xior request (actually executes the request)
    */
+<% } %>
 export function <%= it.rqOpName %><TData = <%~ it.returnType %>, TError = Error>(<% it.parameters.forEach((parameter) => { %>
   <%= parameter.name %><%= parameter.skippable ? '?' : '' %>: <%~ parameter.type %> <%= parameter.optional ? (parameter.skippable ? '| null' : '| null | undefined') : '' %>,
     <% }); %>

package/templates/xior/operation.ejs

@@ -1,3 +1,4 @@
+<% if(it.hasJSDocs) { %>
   /**
 <% if(it.docs && it.docs.length > 0) { %>
    * <%~ it.docs.join('\n   * ') %>
@@ -8,6 +9,7 @@
 
 <% }); -%>
    */
+<% } %>
   <%= it.name %>(<% it.parameters.forEach((parameter) => { %>
 <%= parameter.name %><%= parameter.skippable ? '?' : '' %>: <%~ parameter.type %> <%= parameter.optional ? (parameter.skippable ? '| null' : '| null | undefined') : '' %>,
     <% }); %>