swaggie 1.5.3-beta.3 → 1.5.3-beta.5

package/dist/gen/createBarrel.js

@@ -15,13 +15,13 @@ var _utils = require('../utils');
   }
 
   const viewData = {
-    servicePrefix: clientOptions.servicePrefix || '',
+    servicePrefix: clientOptions.servicePrefix,
     clients: files
       .filter((c) => c)
       .map((c) => ({
-        fileName: (clientOptions.servicePrefix || '') + c,
-        className: `${(clientOptions.servicePrefix || '') + c}Client`,
-        camelCaseName: _case.camel.call(void 0, `${(clientOptions.servicePrefix || '') + c}Client`),
+        fileName: clientOptions.servicePrefix + c,
+        className: `${clientOptions.servicePrefix + c}Client`,
+        camelCaseName: _case.camel.call(void 0, `${clientOptions.servicePrefix + c}Client`),
       })),
   };
 

package/dist/gen/genOperations.js

@@ -25,7 +25,7 @@ var _jsDocs = require('./jsDocs');
 ) {
   const operations = _swagger.getOperations.call(void 0, spec);
   const groups = _utils.groupOperationsByGroupName.call(void 0, operations);
-  const servicePrefix = _nullishCoalesce(options.servicePrefix, () => ( ''));
+  const servicePrefix = options.servicePrefix;
   let result = _utils.renderFile.call(void 0, 'baseClient.ejs', {
     servicePrefix,
     baseUrl: options.baseUrl,
@@ -34,7 +34,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 +56,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;
@@ -86,7 +87,8 @@ function prepareClient(
  */
  function prepareOperations(
   operations,
-  options
+  options,
+  components
 ) {
   let ops = fixDuplicateOperations(operations);
 
@@ -95,10 +97,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);
 
@@ -279,23 +281,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,6 +3,7 @@
 
 var _gen = require('./gen'); var _gen2 = _interopRequireDefault(_gen);
 
+var _types = require('./types');
 var _utils = require('./utils');
 
 /**
@@ -33,7 +34,7 @@ function verifyOptions(options) {
 }
 
 function gen(spec, options) {
-  _utils.loadAllTemplateFiles.call(void 0, options.template || 'axios');
+  _utils.loadAllTemplateFiles.call(void 0, options.template);
 
   return _gen2.default.call(void 0, spec, options);
 }
@@ -68,20 +69,16 @@ function readFile(filePath) {
 
 
 
-const defaultQueryParamsConfig = {
-  allowDots: true,
-  arrayFormat: 'repeat' ,
-};
-
 /**
  * CLI options are flat, but within the app we use nested objects.
  * This function converts flat options structure to the nested one and
- * merges it with the default values.
- * */
-function prepareAppOptions(cliOpts) {
+ * merges it with the default values, producing a fully-initialized AppOptions
+ * object where every defaultable field is guaranteed to be present.
+ */
+ function prepareAppOptions(cliOpts) {
   const { allowDots, arrayFormat, template, queryParamsSerialization = {}, ...rest } = cliOpts;
   const mergedQueryParamsSerialization = {
-    ...defaultQueryParamsConfig,
+    ..._types.APP_DEFAULTS.queryParamsSerialization,
     ...Object.fromEntries(
       Object.entries(queryParamsSerialization).filter(([_, v]) => v !== undefined)
     ),
@@ -91,7 +88,9 @@ function prepareAppOptions(cliOpts) {
 
   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)),
     queryParamsSerialization: mergedQueryParamsSerialization,
-    template: _nullishCoalesce(template, () => ( 'axios')),
   };
-}
+} exports.prepareAppOptions = prepareAppOptions;

package/dist/swagger/typesExtractor.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(); } }
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
 var _utils = require('../utils');
 
@@ -24,7 +24,7 @@ var _utils = require('../utils');
     return unknownType;
   }
 
-  return getTypeFromSchema(param.schema, options);
+  return getTypeFromSchemaResolved(param.schema, options);
 } exports.getParameterType = getParameterType;
 
 /**
@@ -36,6 +36,17 @@ var _utils = require('../utils');
  function getTypeFromSchema(
   schema,
   options
+) {
+  return getTypeFromSchemaResolved(schema, options);
+} exports.getTypeFromSchema = getTypeFromSchema;
+
+/**
+ * Internal implementation of getTypeFromSchema that operates on fully-resolved AppOptions.
+ * All private functions in this module call this version directly to avoid redundant resolution.
+ */
+function getTypeFromSchemaResolved(
+  schema,
+  options
 ) {
   const unknownType = options.preferAny ? 'any' : 'unknown';
 
@@ -59,25 +70,21 @@ var _utils = require('../utils');
 
   // OpenAPI 3.0 nullable: nullable: true
   const isNullable = 'nullable' in schema && schema.nullable === true;
-  const strategy = _nullishCoalesce(options.nullableStrategy, () => ( 'ignore'));
-  const isNullableSuffix = isNullable && strategy === 'include' ? ' | null' : '';
+  const isNullableSuffix = isNullable && options.nullableStrategy === 'include' ? ' | null' : '';
   const type = getTypeFromSchemaInternal(schema, options);
 
   if (isNullableSuffix && type.endsWith('| null')) {
     return type;
   }
   return type + isNullableSuffix;
-} exports.getTypeFromSchema = getTypeFromSchema;
+}
 
 /**
  * Handles OpenAPI 3.1 schemas where `type` is an array (e.g. `["string", "null"]`).
  * The presence of `"null"` in the array is the OA3.1 way of marking a field as nullable.
  * Respects `nullableStrategy` the same way as OA3.0 `nullable: true`.
  */
-function getTypeFromOA31ArrayType(
-  schema,
-  options
-) {
+function getTypeFromOA31ArrayType(schema, options) {
   const unknownType = options.preferAny ? 'any' : 'unknown';
   const types = schema.type ;
   const isNullable = types.includes('null');
@@ -107,8 +114,7 @@ function getTypeFromOA31ArrayType(
     return 'null';
   }
 
-  const strategy = _nullishCoalesce(options.nullableStrategy, () => ( 'ignore'));
-  if (strategy === 'include') {
+  if (options.nullableStrategy === 'include') {
     // We don't want multiple nulls in the type string
     if (baseType.endsWith('| null')) {
       return baseType;
@@ -162,24 +168,22 @@ function getNestedTypeFromSchema(
   schema,
   options
 ) {
-  const strategy = _nullishCoalesce(options.nullableStrategy, () => ( 'ignore'));
-
   // OA3.0 nullable: true
   const isOA30NullableAndActive =
-    'nullable' in schema && schema.nullable === true && strategy === 'include';
+    'nullable' in schema && schema.nullable === true && options.nullableStrategy === 'include';
 
   // OA3.1 nullable: type array containing 'null'
   const isOA31NullableAndActive =
     'type' in schema &&
     Array.isArray(schema.type) &&
     schema.type.includes('null') &&
-    strategy === 'include';
+    options.nullableStrategy === 'include';
 
   if (isOA30NullableAndActive || isOA31NullableAndActive || ('enum' in schema && schema.enum)) {
-    return `(${getTypeFromSchema(schema, options)})`;
+    return `(${getTypeFromSchemaResolved(schema, options)})`;
   }
 
-  return getTypeFromSchema(schema, options);
+  return getTypeFromSchemaResolved(schema, options);
 }
 
 /**
@@ -195,7 +199,7 @@ function getTypeFromObject(
   if (schema.additionalProperties) {
     const extraProps = schema.additionalProperties;
     return `{ [key: string]: ${
-      extraProps === true ? 'any' : getTypeFromSchema(extraProps, options)
+      extraProps === true ? 'any' : getTypeFromSchemaResolved(extraProps, options)
     } }`;
   }
 
@@ -209,7 +213,7 @@ function getTypeFromObject(
       const isRequired = required.includes(prop);
       const safePropName = _utils.escapePropName.call(void 0, prop);
       result.push(
-        `${safePropName}${isRequired ? '' : '?'}: ${getTypeFromSchema(propDefinition, options)};`
+        `${safePropName}${isRequired ? '' : '?'}: ${getTypeFromSchemaResolved(propDefinition, options)};`
       );
     }
 
@@ -225,7 +229,9 @@ function getTypeFromObject(
 function getTypeFromComposites(schema, options) {
   const composite = schema.allOf || schema.oneOf || schema.anyOf;
 
-  return composite.map((s) => getTypeFromSchema(s, options)).join(schema.allOf ? ' & ' : ' | ');
+  return composite
+    .map((s) => getTypeFromSchemaResolved(s, options))
+    .join(schema.allOf ? ' & ' : ' | ');
 }
 
 /**

package/dist/types.d.ts

@@ -50,6 +50,27 @@ export type HttpMethod = 'get' | 'put' | 'post' | 'delete' | 'options' | 'head'
 export type DateSupport = 'string' | 'Date';
 export type ArrayFormat = 'indices' | 'repeat' | 'brackets';
 export type NullableStrategy = 'include' | 'nullableAsOptional' | 'ignore';
+/**
+ * Internal options type used throughout the app after `prepareAppOptions` has run.
+ * All fields that have defaults are required here so the rest of the codebase never
+ * needs to perform its own `?? fallback` logic.
+ */
+export interface AppOptions extends ClientOptions {
+    template: Template;
+    servicePrefix: string;
+    nullableStrategy: NullableStrategy;
+    queryParamsSerialization: {
+        allowDots: boolean;
+        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.3",
+  "version": "1.5.3-beta.5",
   "description": "Generate TypeScript REST client code from an OpenAPI spec",
   "author": {
     "name": "Piotr Dabrowski",