swaggie 1.5.3-beta.4 → 1.5.3-beta.6

package/dist/gen/genOperations.js

@@ -8,12 +8,11 @@ var _swagger = require('../swagger');
 
 
 
+
 var _utils = require('../utils');
 var _createBarrel = require('./createBarrel');
 
 
-
-
 var _jsDocs = require('./jsDocs');
 
 /**
@@ -34,7 +33,7 @@ var _jsDocs = require('./jsDocs');
 
   for (const name in groups) {
     const group = groups[name];
-    const clientData = prepareClient(servicePrefix + name, group, options);
+    const clientData = prepareClient(servicePrefix + name, group, spec.components, options);
 
     if (!clientData) {
       continue;
@@ -56,9 +55,10 @@ var _jsDocs = require('./jsDocs');
 function prepareClient(
   name,
   operations,
+  components,
   options
 ) {
-  const preparedOperations = prepareOperations(operations, options);
+  const preparedOperations = prepareOperations(operations, options, components);
 
   if (preparedOperations.length === 0) {
     return null;
@@ -84,7 +84,11 @@ function prepareClient(
  * @param options
  * @returns List of operations prepared for client generation
  */
- function prepareOperations(operations, options) {
+ function prepareOperations(
+  operations,
+  options,
+  components
+) {
   let ops = fixDuplicateOperations(operations);
 
   if (options.skipDeprecated) {
@@ -92,10 +96,10 @@ function prepareClient(
   }
 
   return ops.map((op) => {
-    const [respObject, responseContentType] = _utils.getBestResponse.call(void 0, op);
+    const [respObject, responseContentType] = _utils.getBestResponse.call(void 0, op, components);
     const returnType = _swagger.getParameterType.call(void 0, respObject, options);
 
-    const body = getRequestBody(op.requestBody, options);
+    const body = getRequestBody(op.requestBody, components, options);
     const queryParams = getParams(op.parameters , options, ['query']);
     const params = getParams(op.parameters , options);
 
@@ -276,23 +280,40 @@ function prepareUrl(path) {
 } exports.getParamName = getParamName;
 
 function getRequestBody(
-  reqBody,
+  rawReqBody,
+  components,
   options
 ) {
-  if (reqBody && 'content' in reqBody) {
-    const [bodyContent, contentType] = _utils.getBestContentType.call(void 0, reqBody);
-    const isFormData = contentType === 'form-data';
-
-    if (bodyContent) {
-      return {
-        originalName: _nullishCoalesce(reqBody['x-name'], () => ( 'body')),
-        name: getParamName(_nullishCoalesce(reqBody['x-name'], () => ( 'body'))),
-        type: isFormData ? 'FormData' : _swagger.getParameterType.call(void 0, bodyContent, options),
-        optional: !reqBody.required,
-        original: reqBody,
-        contentType,
-      };
+  if (!rawReqBody) {
+    return null;
+  }
+
+  let reqBody;
+  if ('$ref' in rawReqBody) {
+    const refName = rawReqBody.$ref.replace('#/components/requestBodies/', '');
+    const resolved = _optionalChain([components, 'optionalAccess', _8 => _8.requestBodies, 'optionalAccess', _9 => _9[refName]]);
+    if (!resolved || '$ref' in resolved) {
+      console.error(`RequestBody $ref '${rawReqBody.$ref}' not found in components/requestBodies`);
+      return null;
     }
+    reqBody = resolved;
+  } else {
+    reqBody = rawReqBody;
   }
+
+  const [bodyContent, contentType] = _utils.getBestContentType.call(void 0, reqBody);
+  const isFormData = contentType === 'form-data';
+
+  if (bodyContent) {
+    return {
+      originalName: _nullishCoalesce(reqBody['x-name'], () => ( 'body')),
+      name: getParamName(_nullishCoalesce(reqBody['x-name'], () => ( 'body'))),
+      type: isFormData ? 'FormData' : _swagger.getParameterType.call(void 0, bodyContent, options),
+      optional: !reqBody.required,
+      original: reqBody,
+      contentType,
+    };
+  }
+
   return null;
 }

package/dist/index.js

@@ -3,8 +3,8 @@
 
 var _gen = require('./gen'); var _gen2 = _interopRequireDefault(_gen);
 
-var _types = require('./types');
 var _utils = require('./utils');
+var _swagger = require('./swagger');
 
 /**
  * Runs the whole code generation process.
@@ -78,7 +78,7 @@ function readFile(filePath) {
  function prepareAppOptions(cliOpts) {
   const { allowDots, arrayFormat, template, queryParamsSerialization = {}, ...rest } = cliOpts;
   const mergedQueryParamsSerialization = {
-    ..._types.APP_DEFAULTS.queryParamsSerialization,
+    ..._swagger.APP_DEFAULTS.queryParamsSerialization,
     ...Object.fromEntries(
       Object.entries(queryParamsSerialization).filter(([_, v]) => v !== undefined)
     ),
@@ -88,9 +88,9 @@ function readFile(filePath) {
 
   return {
     ...rest,
-    template: _nullishCoalesce(template, () => ( _types.APP_DEFAULTS.template)),
-    servicePrefix: _nullishCoalesce(rest.servicePrefix, () => ( _types.APP_DEFAULTS.servicePrefix)),
-    nullableStrategy: _nullishCoalesce(rest.nullableStrategy, () => ( _types.APP_DEFAULTS.nullableStrategy)),
+    template: _nullishCoalesce(template, () => ( _swagger.APP_DEFAULTS.template)),
+    servicePrefix: _nullishCoalesce(rest.servicePrefix, () => ( _swagger.APP_DEFAULTS.servicePrefix)),
+    nullableStrategy: _nullishCoalesce(rest.nullableStrategy, () => ( _swagger.APP_DEFAULTS.nullableStrategy)),
     queryParamsSerialization: mergedQueryParamsSerialization,
   };
 } exports.prepareAppOptions = prepareAppOptions;

package/dist/swagger/typesExtractor.js

@@ -1,4 +1,4 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } }
 
 var _utils = require('../utils');
 
@@ -256,3 +256,32 @@ function getTypeFromComposites(schema, options) {
     .filter((v) => '$ref' in v)
     .map((s) => getSafeIdentifier(s.$ref.split('/').pop()));
 } exports.getRefCompositeTypes = getRefCompositeTypes;
+
+/** Default values applied to every field of AppOptions that has a default. */
+ const APP_DEFAULTS = {
+  template: 'axios',
+  servicePrefix: '',
+  nullableStrategy: 'ignore',
+  queryParamsSerialization: {
+    allowDots: true,
+    arrayFormat: 'repeat',
+  },
+}; exports.APP_DEFAULTS = APP_DEFAULTS;
+
+/**
+ * Fills in all AppOptions defaults for a partial ClientOptions object.
+ * Used at the boundary between public API / test helpers and the internal pipeline.
+ */
+ function resolveOptions(opts) {
+  return {
+    src: _nullishCoalesce(opts.src, () => ( '')),
+    ...opts,
+    template: _nullishCoalesce(opts.template, () => ( exports.APP_DEFAULTS.template)),
+    servicePrefix: _nullishCoalesce(opts.servicePrefix, () => ( exports.APP_DEFAULTS.servicePrefix)),
+    nullableStrategy: _nullishCoalesce(opts.nullableStrategy, () => ( exports.APP_DEFAULTS.nullableStrategy)),
+    queryParamsSerialization: {
+      ...exports.APP_DEFAULTS.queryParamsSerialization,
+      ...opts.queryParamsSerialization,
+    },
+  };
+} exports.resolveOptions = resolveOptions;

package/dist/types.d.ts

@@ -64,13 +64,6 @@ export interface AppOptions extends ClientOptions {
         arrayFormat: ArrayFormat;
     };
 }
-/** Default values applied to every field of AppOptions that has a default. */
-export declare const APP_DEFAULTS: Partial<AppOptions>;
-/**
- * Fills in all AppOptions defaults for a partial ClientOptions object.
- * Used at the boundary between public API / test helpers and the internal pipeline.
- */
-export declare function resolveOptions(opts: Partial<ClientOptions>): AppOptions;
 /**
  * Local type that represent Operation as understood by Swaggie
  **/

package/dist/utils/utils.js

@@ -1,4 +1,4 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } }var _nodefs = require('node:fs');
+"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; }var _nodefs = require('node:fs');
 var _nodepath = require('node:path');
 
 
@@ -171,11 +171,15 @@ const reservedKeywords = new Set([
  * Other media types are not supported at this time.
  * @returns Response or reference of the success response
  */
- function getBestResponse(op) {
+ function getBestResponse(
+  op,
+  components
+) {
   const NOT_FOUND = 100000;
   const lowestCode = _nullishCoalesce(Object.keys(op.responses).sort().shift(), () => ( NOT_FOUND));
 
-  const resp = lowestCode === NOT_FOUND ? op.responses[0] : op.responses[lowestCode.toString()];
+  const rawResp = lowestCode === NOT_FOUND ? op.responses[0] : op.responses[lowestCode.toString()];
+  const resp = resolveResponseRef(rawResp, components);
 
   if (resp && 'content' in resp) {
     return getBestContentType(resp);
@@ -183,6 +187,33 @@ const reservedKeywords = new Set([
   return [null, null];
 } exports.getBestResponse = getBestResponse;
 
+/**
+ * Resolves a $ref in a response object to the actual response object from components/responses.
+ * If the response is already an object (not a reference), it is returned as-is.
+ */
+function resolveResponseRef(
+  resp,
+  components
+) {
+  if (!resp) {
+    return null;
+  }
+
+  if (!('$ref' in resp)) {
+    return resp;
+  }
+
+  const refName = resp.$ref.replace('#/components/responses/', '');
+  const resolved = _optionalChain([components, 'optionalAccess', _ => _.responses, 'optionalAccess', _2 => _2[refName]]);
+
+  if (!resolved) {
+    console.error(`Response $ref '${resp.$ref}' not found in components/responses`);
+    return null;
+  }
+
+  return resolved ;
+}
+
 /** This method tries to fix potentially wrong out parameter given from commandline */
  function prepareOutputFilename(out) {
   if (!out) {
@@ -206,7 +237,7 @@ const reservedKeywords = new Set([
   return arr.concat().sort(sortByKey(key));
 } exports.orderBy = orderBy;
 
-const sortByKey = (key) => (a, b) => a[key] > b[key] ? 1 : b[key] > a[key] ? -1 : 0;
+const sortByKey = (key) => (a, b) => (a[key] > b[key] ? 1 : b[key] > a[key] ? -1 : 0);
 
 const orderedContentTypes = [
   'application/json',

package/package.json

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