swaggie 1.1.2 → 1.1.3-test.1

package/dist/gen/genOperations.js

@@ -25,12 +25,11 @@ var _createBarrel = require('./createBarrel');
   const operations = _swagger.getOperations.call(void 0, spec);
   const groups = _utils.groupOperationsByGroupName.call(void 0, operations);
   const servicePrefix = _nullishCoalesce(options.servicePrefix, () => ( ''));
-  let result =
-    _utils.renderFile.call(void 0, 'baseClient.ejs', {
-      servicePrefix,
-      baseUrl: options.baseUrl,
-      ...options.queryParamsSerialization,
-    }) || '';
+  let result = _utils.renderFile.call(void 0, 'baseClient.ejs', {
+    servicePrefix,
+    baseUrl: options.baseUrl,
+    ...options.queryParamsSerialization,
+  });
 
   for (const name in groups) {
     const group = groups[name];
@@ -41,7 +40,7 @@ var _createBarrel = require('./createBarrel');
       servicePrefix,
     });
 
-    result += renderedFile || '';
+    result += renderedFile;
   }
 
   result += _createBarrel.generateBarrelFile.call(void 0, groups, options);
@@ -64,6 +63,18 @@ function prepareClient(
   };
 }
 
+/**
+ * Prepares operations for client generation. A lot of things will be done here:
+ * - Fix duplicate operation names
+ * - Determine the best response object and content type
+ * - Get the parameter type for the response object
+ * - Get the request body, query parameters, and other parameters
+ * - Sort parameters by their 'x-position' if defined
+ *
+ * @param operations Flat list of operations from the spec
+ * @param options
+ * @returns List of operations prepared for client generation
+ */
  function prepareOperations(
   operations,
   options
@@ -87,6 +98,8 @@ function prepareClient(
       params.sort((a, b) => a.original['x-position'] - b.original['x-position']);
     }
 
+    markParametersAsSkippable(params);
+
     const headers = getParams(op.parameters , options, ['header']);
     // Some libraries need to know the content type of the request body in case of urlencoded body
     if (_optionalChain([body, 'optionalAccess', _2 => _2.contentType]) === 'urlencoded') {
@@ -110,6 +123,17 @@ function prepareClient(
   });
 } exports.prepareOperations = prepareOperations;
 
+function markParametersAsSkippable(params) {
+  const lastRequiredParamIndex = params.map((p) => !p.optional).lastIndexOf(true);
+  if (lastRequiredParamIndex === params.length - 1) {
+    return;
+  }
+
+  for (let i = lastRequiredParamIndex + 1; i < params.length; i++) {
+    params[i].skippable = true;
+  }
+}
+
 /**
  * This function will replace path template expressions with ${encodeURIComponent('paramName')} placeholders
  * The end result will be a string that is effectively a template (i.e. you should wrap end result with backticks)
@@ -166,7 +190,7 @@ function prepareUrl(path) {
   return _case.camel.call(void 0, opId.replace(`${group}_`, ''));
 } exports.getOperationName = getOperationName;
 
-function getParams(
+ function getParams(
   params,
   options,
   where
@@ -175,7 +199,7 @@ function getParams(
     return [];
   }
 
-  return params
+  const result = params
     .filter((p) => !where || where.includes(p.in))
     .map((p) => ({
       originalName: p.name,
@@ -184,7 +208,29 @@ function getParams(
       optional: p.required === undefined || p.required === null ? true : !p.required,
       original: p,
     }));
-}
+
+  if (_optionalChain([options, 'access', _3 => _3.modifiers, 'optionalAccess', _4 => _4.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)
+      );
+      if (paramIndex === -1) {
+        continue;
+      }
+      const param = result[paramIndex];
+
+      if (modifier === 'optional') {
+        param.optional = true;
+      } else if (modifier === 'required') {
+        param.optional = false;
+      } else if (modifier === 'ignore') {
+        result.splice(paramIndex, 1);
+      }
+    }
+  }
+
+  return result;
+} exports.getParams = getParams;
 
 /**
  * Escapes param names to more safe form
@@ -244,6 +290,9 @@ function getRequestBody(reqBody) {
 
 
 
+
+
+
 
 
 

package/dist/types.d.ts

@@ -20,6 +20,13 @@ export interface ClientOptions {
     dateFormat?: DateSupport;
     /** Options for query parameters serialization */
     queryParamsSerialization: QueryParamsSerializationOptions;
+    /** Offers ability to adjust the OpenAPI spec before it is processed */
+    modifiers?: {
+        /** Global-level modifiers for parameter with a given name */
+        parameters?: {
+            [key: string]: 'optional' | 'required' | 'ignore';
+        };
+    };
 }
 export interface CliOptions extends FullAppOptions {
     allowDots?: boolean;

package/dist/utils/documentLoader.js

@@ -37,5 +37,5 @@ function readLocalFile(filePath) {
 }
 
 function parseFileContents(contents, path) {
-  return /.ya?ml$/i.test(path) ? _jsyaml2.default.load(contents) : JSON.parse(contents);
+  return /.ya?ml$/i.test(path) ? (_jsyaml2.default.load(contents) ) : JSON.parse(contents);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swaggie",
-  "version": "1.1.2",
+  "version": "1.1.3-test.1",
   "description": "Generate TypeScript REST client code from an OpenAPI spec",
   "author": {
     "name": "Piotr Dabrowski",
@@ -61,11 +61,11 @@
     "@types/chai": "5.2.2",
     "@types/js-yaml": "4.0.9",
     "@types/mocha": "10.0.10",
-    "@types/node": "24.0.14",
+    "@types/node": "24.2.0",
     "chai": "5.2.1",
     "mocha": "11.7.1",
     "openapi-types": "^12.1.3",
     "sucrase": "3.35.0",
-    "typescript": "5.8.3"
+    "typescript": "5.9.2"
   }
 }

package/templates/axios/operation.ejs

@@ -5,7 +5,7 @@
 <% }); -%>
    */
   <%= it.name %>(<% it.parameters.forEach((parameter) => { %>
-<%= parameter.name %>: <%~ parameter.type %> <%= parameter.optional ? '| null | undefined' : '' %>,
+<%= parameter.name %><%= parameter.skippable ? '?' : '' %>: <%~ parameter.type %> <%= parameter.optional ? (parameter.skippable ? '| null' : '| null | undefined') : '' %>,
     <% }); %>
 $config?: AxiosRequestConfig
   ): AxiosPromise<<%~ it.returnType %>> {

package/templates/fetch/operation.ejs

@@ -5,7 +5,7 @@
 <% }); -%>
    */
   <%= it.name %>(<% it.parameters.forEach((parameter) => { %>
-<%= parameter.name %>: <%~ parameter.type %> <%= parameter.optional ? '| null | undefined' : '' %>,
+<%= parameter.name %><%= parameter.skippable ? '?' : '' %>: <%~ parameter.type %> <%= parameter.optional ? (parameter.skippable ? '| null' : '| null | undefined') : '' %>,
     <% }); %>
 $config?: RequestInit
   ): Promise<<%~ it.returnType %>> {

package/templates/ng1/operation.ejs

@@ -6,7 +6,7 @@
    * @return Success
    */
   <%= it.name %>(<% it.parameters.forEach((parameter) => { %>
-<%= parameter.name %>: <%~ parameter.type %> <%= parameter.optional ? ' | null | undefined' : '' %>,
+<%= parameter.name %><%= parameter.skippable ? '?' : '' %>: <%~ parameter.type %> <%= parameter.optional ? (parameter.skippable ? '| null' : '| null | undefined') : '' %>,
     <% }); %>
     config?: IRequestShortcutConfig
   ): IPromise<<%~ it.returnType %>> {

package/templates/ng2/operation.ejs

@@ -7,7 +7,7 @@
    */
   <%= it.name %>(
     <% it.parameters.forEach((parameter) => { %>
-<%= parameter.name %>: <%~ parameter.type %><%= parameter.optional ? ' | null | undefined' : '' %>,
+<%= parameter.name %><%= parameter.skippable ? '?' : '' %>: <%~ parameter.type %> <%= parameter.optional ? (parameter.skippable ? '| null' : '| null | undefined') : '' %>,
     <% }); %>
 config?: any
   ): Observable<<%~ it.returnType %>> {

package/templates/swr-axios/operation.ejs

@@ -5,7 +5,7 @@
 <% }); -%>
    */
   <%= it.name %>(<% it.parameters.forEach((parameter) => { %>
-  <%= parameter.name %>: <%~ parameter.type %> <%= parameter.optional ? ' | null | undefined' : '' %>,
+<%= parameter.name %><%= parameter.skippable ? '?' : '' %>: <%~ parameter.type %> <%= parameter.optional ? (parameter.skippable ? '| null' : '| null | undefined') : '' %>,
     <% }); %>
   $config?: AxiosRequestConfig
   ): AxiosPromise<<%~ it.returnType %>> {

package/templates/swr-axios/swrOperation.ejs

@@ -5,7 +5,7 @@
 <% }); -%>
    */
 export function <%= it.swrOpName %>(<% it.parameters.forEach((parameter) => { %>
-  <%= parameter.name %>: <%~ parameter.type %> <%= parameter.optional ? ' | null | undefined' : '' %>,
+  <%= parameter.name %><%= parameter.skippable ? '?' : '' %>: <%~ parameter.type %> <%= parameter.optional ? (parameter.skippable ? '| null' : '| null | undefined') : '' %>,
     <% }); %>
   $config?: SwrConfig
   ) {

package/templates/tsq-xior/operation.ejs

@@ -5,7 +5,7 @@
 <% }); -%>
    */
   <%= it.name %>(<% it.parameters.forEach((parameter) => { %>
-<%= parameter.name %>: <%~ parameter.type %> <%= parameter.optional ? '| null | undefined' : '' %>,
+<%= parameter.name %><%= parameter.skippable ? '?' : '' %>: <%~ parameter.type %> <%= parameter.optional ? (parameter.skippable ? '| null' : '| null | undefined') : '' %>,
     <% }); %>
 $config?: XiorRequestConfig
   ): Promise<XiorResponse<<%~ it.returnType %>>> {

package/templates/tsq-xior/queryOperation.ejs

@@ -7,7 +7,7 @@
    * @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.type %> <%= parameter.optional ? ' | null | undefined' : '' %>,
+  <%= parameter.name %><%= parameter.skippable ? '?' : '' %>: <%~ parameter.type %> <%= parameter.optional ? (parameter.skippable ? '| null' : '| null | undefined') : '' %>,
     <% }); %>
 $config?: Omit<
   UseQueryOptions<<%~ it.returnType %>, TError, TData>,

package/templates/xior/operation.ejs

@@ -5,7 +5,7 @@
 <% }); -%>
    */
   <%= it.name %>(<% it.parameters.forEach((parameter) => { %>
-<%= parameter.name %>: <%~ parameter.type %> <%= parameter.optional ? '| null | undefined' : '' %>,
+<%= parameter.name %><%= parameter.skippable ? '?' : '' %>: <%~ parameter.type %> <%= parameter.optional ? (parameter.skippable ? '| null' : '| null | undefined') : '' %>,
     <% }); %>
 $config?: XiorRequestConfig
   ): Promise<XiorResponse<<%~ it.returnType %>>> {