swaggie 1.5.3-beta.2 → 1.5.3-beta.4

package/README.md

@@ -313,14 +313,14 @@ function error(e) {
 
 | Supported                                                                      | Not supported                                   |
 | ------------------------------------------------------------------------------ | ----------------------------------------------- |
-| OpenAPI 3                                                                      | Swagger, Open API 2.0                           |
+| OpenAPI 3, OpenAPI 3.1, OpenAPI 3.2                                            | Swagger, Open API 2.0                           |
 | `allOf`, `oneOf`, `anyOf`, `$ref` to schemas                                   | `not`                                           |
-| Spec formats: `JSON`, `YAML`                                                   | Very complex query params                       |
+| Spec formats: `JSON`, `YAML`                                                   | VERY complex query params                       |
 | Extensions: `x-position`, `x-name`, `x-enumNames`, `x-enum-varnames`           | Multiple response types (only one will be used) |
 | Content types: `JSON`, `text`, `multipart/form-data`                           | Multiple request types (only one will be used)  |
-| Content types: `application/x-www-form-urlencoded`, `application/octet-stream` | References to other spec files                  |
-| Different types of enum definitions (+ OpenAPI 3.1 support for enums)          | OpenAPI callbacks                               |
-| Paths inheritance, comments (descriptions), nullable                           | OpenAPI webhooks                                |
+| Content types: `application/x-www-form-urlencoded`, `application/octet-stream` | References to external spec files               |
+| Different types of enum definitions                                            | OpenAPI callbacks                               |
+| Paths inheritance, comments (descriptions), nullable, `["<TYPE>", null]`       | OpenAPI webhooks                                |
 | Getting documents from remote locations or as path reference (local file)      |                                                 |
 | Grouping endpoints by tags + handle gracefully duplicate operation ids         |                                                 |
 

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,
@@ -84,10 +84,7 @@ function prepareClient(
  * @param options
  * @returns List of operations prepared for client generation
  */
- function prepareOperations(
-  operations,
-  options
-) {
+ function prepareOperations(operations, options) {
   let ops = fixDuplicateOperations(operations);
 
   if (options.skipDeprecated) {

package/dist/gen/genTypes.js

@@ -201,12 +201,7 @@ function renderTypeProp(
     lines.push(_jsDocs.renderComment.call(void 0, _nullishCoalesce(definition.description, () => ( definition.title))));
   }
 
-  // When nullableAsOptional strategy is set, nullable properties are treated as optional
-  const isNullableAsOptional =
-    options.nullableStrategy === 'nullableAsOptional' &&
-    !('$ref' in definition) &&
-    (definition ).nullable === true;
-  const isOptional = !required || isNullableAsOptional;
+  const isOptional = !required || isNullableAsOptional(definition, options);
   const optionalMark = isOptional ? '?' : '';
   // If prop name is not a valid identifier, we need to wrap it in quotes.
   // We can't use getSafeIdentifier here because it will affect the data model.
@@ -216,6 +211,26 @@ function renderTypeProp(
   return lines.join('\n');
 }
 
+/**
+ * When nullableAsOptional strategy is set, nullable properties are treated as optional.
+ * Supports both OA3.0 (nullable: true) and OA3.1 (type: ["string", "null"]).
+ * @returns True if the property should be treated as optional, false otherwise.
+ */
+function isNullableAsOptional(
+  definition,
+  options
+) {
+  if ('$ref' in definition) {
+    return false;
+  }
+
+  return (
+    options.nullableStrategy === 'nullableAsOptional' &&
+    (definition.nullable === true ||
+      (Array.isArray(definition.type) && definition.type.includes('null')))
+  );
+}
+
 function getMergedCompositeObjects(schema) {
   const { allOf, oneOf, anyOf, ...safeSchema } = schema;
   const composite = allOf || oneOf || anyOf || [];

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';
 
@@ -52,16 +63,69 @@ var _utils = require('../utils');
     return 'null';
   }
 
+  // OpenAPI 3.1 nullable: type is an array containing 'null', e.g. ["string", "null"]
+  if (Array.isArray(schema.type)) {
+    return getTypeFromOA31ArrayType(schema , options);
+  }
+
+  // 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) {
+  const unknownType = options.preferAny ? 'any' : 'unknown';
+  const types = schema.type ;
+  const isNullable = types.includes('null');
+  const nonNullTypes = types.filter((t) => t !== 'null');
+
+  // Build the base type from the non-null types
+  let baseType;
+  if (nonNullTypes.length === 0) {
+    baseType = 'null';
+  } else if (nonNullTypes.length === 1) {
+    // Synthesize a single-type schema to reuse existing resolution logic
+    const singleTypeSchema = { ...schema, type: nonNullTypes[0] } ;
+    baseType = getTypeFromSchemaInternal(singleTypeSchema, options);
+  } else {
+    // Multiple non-null types — resolve each independently and join as a union
+    baseType = nonNullTypes
+      .map((t) => getTypeFromSchemaInternal({ ...schema, type: t } , options))
+      .join(' | ');
+  }
+
+  if (!isNullable) {
+    return baseType || unknownType;
+  }
+
+  // All types were 'null' — just return 'null' regardless of strategy
+  if (nonNullTypes.length === 0) {
+    return 'null';
+  }
+
+  if (options.nullableStrategy === 'include') {
+    // We don't want multiple nulls in the type string
+    if (baseType.endsWith('| null')) {
+      return baseType;
+    }
+    return `${baseType} | null`;
+  }
+
+  // 'ignore' and 'nullableAsOptional' — null is stripped from the type itself
+  // (for nullableAsOptional, the optionality is applied at the property level in genTypes.ts)
+  return baseType || unknownType;
+}
 
 function getTypeFromSchemaInternal(
   schema,
@@ -104,13 +168,22 @@ function getNestedTypeFromSchema(
   schema,
   options
 ) {
-  const strategy = _nullishCoalesce(options.nullableStrategy, () => ( 'ignore'));
-  const isNullableAndActive =
-    'nullable' in schema && schema.nullable === true && strategy === 'include';
-  if (isNullableAndActive || ('enum' in schema && schema.enum)) {
-    return `(${getTypeFromSchema(schema, options)})`;
+  // OA3.0 nullable: true
+  const isOA30NullableAndActive =
+    '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') &&
+    options.nullableStrategy === 'include';
+
+  if (isOA30NullableAndActive || isOA31NullableAndActive || ('enum' in schema && schema.enum)) {
+    return `(${getTypeFromSchemaResolved(schema, options)})`;
   }
-  return getTypeFromSchema(schema, options);
+
+  return getTypeFromSchemaResolved(schema, options);
 }
 
 /**
@@ -126,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)
     } }`;
   }
 
@@ -140,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)};`
       );
     }
 
@@ -156,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/package.json

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