swaggie 1.9.0-alpha.13 → 1.9.0-alpha.14

package/dist/cli.js

@@ -20,10 +20,7 @@ const testingFrameworkOption = new (0, _commander.Option)(
 
 const packageJson = readPackageJson();
 
-const modeOption = new (0, _commander.Option)('-m, --mode <mode>', 'Generation mode').choices([
-  'full',
-  'schemas',
-]);
+const modeOption = new (0, _commander.Option)('-m, --mode <mode>', 'Generation mode').choices(['full', 'schemas']);
 const schemaStyleOption = new (0, _commander.Option)(
   '-d, --schemaStyle <style>',
   'Schema object declaration style'

package/dist/gen/genOperations.js

@@ -15,6 +15,12 @@ var _createBarrel = require('./createBarrel');
 var _header = require('./header');
 
 
+
+
+
+
+
+
 var _jsDocs = require('./jsDocs');
 
 /**
@@ -115,9 +121,13 @@ function prepareClient(
 
     try {
       const [respObject, responseContentType] = _utils.getBestResponse.call(void 0, op, components);
-      const returnType = _swagger.getParameterType.call(void 0, respObject, options);
+      const returnType = respObject
+        ? _swagger.getParameterType.call(void 0, respObject, options)
+        : options.preferAny
+          ? 'any'
+          : 'unknown';
 
-      const body = getRequestBody(op.requestBody, components, options);
+      const body = op.requestBody ? getRequestBody(op.requestBody, components, options) : null;
       const queryParams = getParams(op.parameters , options, ['query']);
       let params = getParams(op.parameters , options);
       let queryParamObject;
@@ -127,22 +137,24 @@ function prepareClient(
       }
 
       // If all parameters have 'x-position' defined, sort them by it
-      if (params.every((p) => p.original['x-position'])) {
-        params.sort((a, b) => a.original['x-position'] - b.original['x-position']);
+      if (params.every((p) => p.original && 'x-position' in p.original)) {
+        params.sort(
+          (a, b) =>
+            (a.original )['x-position'] -
+            (b.original )['x-position']
+        );
       }
 
-      if (shouldGroupQueryParams(queryParams, options.queryParamsSerialization.queryParamsAsObject)) {
+      if (
+        shouldGroupQueryParams(queryParams, options.queryParamsSerialization.queryParamsAsObject)
+      ) {
         queryParamObject = createQueryParamObject(queryParams);
         params = replaceQueryParamsWithObject(params, queryParamObject);
       }
 
       markParametersAsSkippable(params);
 
-      const headers = getParams(
-        op.parameters ,
-        options,
-        ['header']
-      );
+      const headers = getParams(op.parameters , options, ['header']);
       // Some libraries need explicit Content-Type for request bodies.
       if (_optionalChain([body, 'optionalAccess', _2 => _2.contentType]) === 'urlencoded') {
         upsertFixedHeader(headers, 'Content-Type', 'application/x-www-form-urlencoded');
@@ -155,7 +167,7 @@ function prepareClient(
         returnType,
         responseContentType,
         method: op.method.toUpperCase(),
-        name: getOperationName(op.operationId, op.group),
+        name: getOperationName(_nullishCoalesce(op.operationId, () => ( null)), op.group),
         url: prepareUrl(op.path),
         parameters: params,
         query: queryParams,
@@ -218,7 +230,8 @@ function replaceQueryParamsWithObject(
   params,
   queryParamObject
 ) {
-  const isQueryParam = (param) => !!param.original && 'in' in param.original && param.original.in === 'query';
+  const isQueryParam = (param) =>
+    !!param.original && 'in' in param.original && param.original.in === 'query';
 
   const firstQueryParamIndex = params.findIndex(isQueryParam);
   if (firstQueryParamIndex < 0) {
@@ -275,7 +288,11 @@ function prepareUrl(path) {
  * it can happen very easily and we need to handle it gracefully.
  */
  function fixDuplicateOperations(operations) {
-  if (!operations || operations.length < 2) {
+  if (!operations) {
+    return [];
+  }
+
+  if (operations.length < 2) {
     return operations;
   }
 
@@ -360,7 +377,7 @@ function prepareUrl(path) {
  */
  function getParamName(name) {
   if (!name) {
-    return name;
+    return _nullishCoalesce(name, () => ( ''));
   }
 
   return _utils.escapeIdentifier.call(void 0, 
@@ -397,13 +414,15 @@ function getRequestBody(
   const isFormData = contentType === 'form-data';
 
   if (bodyContent) {
+    const reqBodyAny = reqBody ;
+    const xName = reqBodyAny['x-name'];
     return {
-      originalName: _nullishCoalesce(reqBody['x-name'], () => ( 'body')),
-      name: getParamName(_nullishCoalesce(reqBody['x-name'], () => ( 'body'))),
+      originalName: _nullishCoalesce(xName, () => ( 'body')),
+      name: getParamName(_nullishCoalesce(xName, () => ( 'body'))),
       type: isFormData ? 'FormData' : _swagger.getParameterType.call(void 0, bodyContent, options),
       optional: !reqBody.required,
       original: reqBody,
-      contentType,
+      contentType: _nullishCoalesce(contentType, () => ( undefined)),
     };
   }
 

package/dist/gen/genTypes.js

@@ -204,8 +204,9 @@ function generateItemsType(schema, options) {
 function renderExtendedEnumType(name, def) {
   const isString = def.type === 'string';
   let res = `export enum ${name} {\n`;
-  const enumNames = _nullishCoalesce(def['x-enumNames'], () => ( def['x-enum-varnames']));
-  const enumValues = def.enum.map((el) => (isString ? `"${el}"` : el));
+  const defAny = def ;
+  const enumNames = _nullishCoalesce(_nullishCoalesce(defAny['x-enumNames'], () => ( defAny['x-enum-varnames'])), () => ( []));
+  const enumValues = (_nullishCoalesce(def.enum, () => ( []))).map((el) => (isString ? `"${el}"` : el));
 
   for (let index = 0; index < enumNames.length; index++) {
     res += `  ${_utils.escapePropName.call(void 0, enumNames[index])} = ${enumValues[index]},\n`;
@@ -221,7 +222,7 @@ function renderEnumType(name, def, options) {
     return renderStringEnumDeclaration(name, def, options);
   }
 
-  const values = def.enum.map((v) => (typeof v === 'number' ? v : `"${v}"`)).join(' | ');
+  const values = (_nullishCoalesce(def.enum, () => ( []))).map((v) => (typeof v === 'number' ? v : `"${v}"`)).join(' | ');
   return `export type ${name} = ${values};\n`;
 }
 
@@ -272,7 +273,7 @@ function toPascalCase(value) {
  */
 function renderOpenApi31Enum(name, def) {
   let res = `export enum ${name} {\n`;
-  for (const v of def.oneOf) {
+  for (const v of _nullishCoalesce(def.oneOf, () => ( []))) {
     if ('const' in v) {
       res += `  ${_utils.escapePropName.call(void 0, v.title)} = ${
         typeof v.const === 'string' ? `"${v.const}"` : v.const
@@ -383,7 +384,7 @@ function getMergedCompositeObjects(schema) {
 }
 
 function isObject(item) {
-  return item && typeof item === 'object' && !Array.isArray(item);
+  return !!item && typeof item === 'object' && !Array.isArray(item);
 }
 function deepMerge(target, ...sources) {
   if (!sources.length) return target;

package/dist/gen/index.js

@@ -24,15 +24,19 @@ var _utils = require('../utils');
 
   if (options.out) {
     const destFile = _utils.prepareOutputFilename.call(void 0, options.out);
-    await _utils.saveFile.call(void 0, destFile, fileContents);
+    if (destFile) {
+      await _utils.saveFile.call(void 0, destFile, fileContents);
+    }
   }
 
   if (options.mocks && options.testingFramework && options.out) {
     const resolvedMocksPath = _utils.prepareOutputFilename.call(void 0, options.mocks);
     const resolvedOutPath = _utils.prepareOutputFilename.call(void 0, options.out);
-    const relativeApiImport = _utils.deriveRelativeImport.call(void 0, resolvedMocksPath, resolvedOutPath);
-    const mockContents = _genMocks2.default.call(void 0, spec, options, relativeApiImport);
-    await _utils.saveFile.call(void 0, resolvedMocksPath, mockContents);
+    if (resolvedMocksPath && resolvedOutPath) {
+      const relativeApiImport = _utils.deriveRelativeImport.call(void 0, resolvedMocksPath, resolvedOutPath);
+      const mockContents = _genMocks2.default.call(void 0, spec, options, relativeApiImport);
+      await _utils.saveFile.call(void 0, resolvedMocksPath, mockContents);
+    }
   }
 
   return fileContents;

package/dist/swagger/operations.js

@@ -53,11 +53,15 @@ function inheritPathParams(op, inheritableParams) {
     return;
   }
 
+  if (!op.parameters) {
+    op.parameters = [];
+  }
+
   for (const pathParam of inheritableParams) {
     // If the operation doesn't have a parameter with the same name and in, then add it
     if (
       !op.parameters.some(
-        (p) => p.name === pathParam.name && p.in === pathParam.in
+        (p) => !('$ref' in p) && (p ).name === pathParam.name && (p ).in === pathParam.in
       )
     ) {
       op.parameters.push(Object.assign({}, pathParam));
@@ -70,9 +74,10 @@ function getPathOperation(
   pathInfo,
   spec
 ) {
+  const pathOp = pathInfo[method];
   const op = Object.assign(
-    { method, path: pathInfo.path, parameters: [], group: getOperationGroupName(pathInfo[method]) },
-    pathInfo[method]
+    { method, path: pathInfo.path, parameters: [], group: getOperationGroupName(pathOp) },
+    pathOp
   );
 
   // if there's no explicit operationId given, create one based on the method and path
@@ -83,13 +88,13 @@ function getPathOperation(
       .replace(/[\/}\-]/g, '');
   }
 
-  const pathLevelParams = _nullishCoalesce(spec.paths[pathInfo.path].parameters, () => ( []));
+  const pathLevelParams = _nullishCoalesce(_optionalChain([spec, 'access', _2 => _2.paths, 'optionalAccess', _3 => _3[pathInfo.path], 'optionalAccess', _4 => _4.parameters]), () => ( []));
 
   // Replace the path level parameters references with the actual parameters
-  replaceReferencedParams(pathLevelParams, _nullishCoalesce(_optionalChain([spec, 'access', _2 => _2.components, 'optionalAccess', _3 => _3.parameters]), () => ( {})));
+  replaceReferencedParams(pathLevelParams, _nullishCoalesce(_optionalChain([spec, 'access', _5 => _5.components, 'optionalAccess', _6 => _6.parameters]), () => ( {})));
 
   // Replace the operation parameters references with the actual parameters
-  replaceReferencedParams(op.parameters, _nullishCoalesce(_optionalChain([spec, 'access', _4 => _4.components, 'optionalAccess', _5 => _5.parameters]), () => ( {})));
+  replaceReferencedParams(op.parameters, _nullishCoalesce(_optionalChain([spec, 'access', _7 => _7.components, 'optionalAccess', _8 => _8.parameters]), () => ( {})));
 
   // At this stage path level parameters are already replaced with the actual parameters
   inheritPathParams(op, pathLevelParams );
@@ -103,7 +108,7 @@ function getPathOperation(
  * Removes invalid characters and ensures the name doesn't start with a number.
  */
 function getOperationGroupName(op) {
-  let name = _optionalChain([op, 'access', _6 => _6.tags, 'optionalAccess', _7 => _7.length]) ? op.tags[0] : 'default';
+  let name = _optionalChain([op, 'access', _9 => _9.tags, 'optionalAccess', _10 => _10.length]) ? op.tags[0] : 'default';
   name = name.replace(/[^$_a-z0-9]+/gi, '');
   return name.replace(/^[0-9]+/m, '');
 }
@@ -117,6 +122,10 @@ function replaceReferencedParams(
   parameters,
   componentParams
 ) {
+  if (!parameters || !componentParams) {
+    return;
+  }
+
   for (let index = 0; index < parameters.length; index++) {
     const param = parameters[index];
 

package/dist/swagger/typesExtractor.js

@@ -25,7 +25,7 @@ var _utils = require('../utils/utils');
     return unknownType;
   }
 
-  return getTypeFromSchemaResolved(param.schema, options, `${context}.schema`);
+  return getTypeFromSchemaResolved(param.schema , options, `${context}.schema`);
 } exports.getParameterType = getParameterType;
 
 /**
@@ -172,7 +172,7 @@ function getTypeFromSchemaInternal(
     return getTypeFromObject(schema, options, undefined, context);
   }
   if ('enum' in schema) {
-    return `${schema.enum.map((v) => JSON.stringify(v)).join(' | ')}`;
+    return `${(_nullishCoalesce(schema.enum, () => ( []))).map((v) => JSON.stringify(v)).join(' | ')}`;
   }
   if (schema.type === 'integer' || schema.type === 'number') {
     return 'number';
@@ -368,26 +368,26 @@ function isRequiredOnlyCompositeBranch(schema) {
  * It is used only for `allOf` property, as it enforces extending types.
  */
  function getRefCompositeTypes(schema) {
-  return schema.allOf
+  return (_nullishCoalesce(schema.allOf, () => ( [])))
     .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',
+  template: 'axios' ,
   servicePrefix: '',
-  nullableStrategy: 'ignore',
-  generationMode: 'full',
-  schemaDeclarationStyle: 'interface',
-  enumDeclarationStyle: 'union',
-  enumNamesStyle: 'original',
+  nullableStrategy: 'ignore' ,
+  generationMode: 'full' ,
+  schemaDeclarationStyle: 'interface' ,
+  enumDeclarationStyle: 'union' ,
+  enumNamesStyle: 'original' ,
   queryParamsSerialization: {
     allowDots: true,
-    arrayFormat: 'repeat',
-    queryParamsAsObject: false,
+    arrayFormat: 'repeat' ,
+    queryParamsAsObject: false ,
   },
-}; exports.APP_DEFAULTS = APP_DEFAULTS;
+} ; exports.APP_DEFAULTS = APP_DEFAULTS;
 
 /**
  * Fills in all AppOptions defaults for a partial ClientOptions object.

package/dist/types.d.ts

@@ -147,6 +147,6 @@ export interface AppOptions extends ClientOptions {
 export interface ApiOperation extends OA3.OperationObject {
     method: HttpMethod;
     path: string;
-    group: string;
+    group: string | null;
 }
 export {};

package/dist/utils/documentLoader.js

@@ -35,9 +35,7 @@ async function loadFromUrl(url) {
 
 async function readLocalFile(filePath) {
   const contents = await new Promise((res, rej) =>
-    _nodefs2.default.readFile(filePath, 'utf8', (err, loadedContents) =>
-      err ? rej(err) : res(loadedContents)
-    )
+    _nodefs2.default.readFile(filePath, 'utf8', (err, loadedContents) => (err ? rej(err) : res(loadedContents)))
   );
   const spec = parseFileContents(contents , filePath) ;
 

package/dist/utils/refResolver.js

@@ -5,10 +5,6 @@ var _yaml = require('yaml');
 
 
 
-
-
-
-
 const SUPPORTED_COMPONENT_SECTIONS = new Set([
   'schemas',
   'parameters',
@@ -26,8 +22,6 @@ const SUPPORTED_COMPONENT_SECTIONS = new Set([
 
 
 
-
-
 /**
  * Resolves external file refs into local component refs.
  * For now we only support local file refs (no http/https) and component targets.
@@ -109,9 +103,7 @@ async function resolveRef(
   }
 
   if (!fragment) {
-    throw new Error(
-      `External refs must include a JSON pointer fragment: '${rawRef}'`
-    );
+    throw new Error(`External refs must include a JSON pointer fragment: '${rawRef}'`);
   }
 
   if (!fragment.startsWith('/')) {
@@ -136,9 +128,7 @@ async function importRefFromFile(
 
   if (!targetInfo) {
     if (context.resolvingRefs.has(importKey)) {
-      throw new Error(
-        `Circular non-component external ref is not supported: '${rawRef}'`
-      );
+      throw new Error(`Circular non-component external ref is not supported: '${rawRef}'`);
     }
 
     const targetCopy = structuredClone(target);
@@ -172,10 +162,7 @@ async function importRefFromFile(
 }
 
 function parseImportTarget(pointer) {
-  const parts = pointer
-    .replace(/^#\//, '')
-    .split('/')
-    .map(unescapePointerSegment);
+  const parts = pointer.replace(/^#\//, '').split('/').map(unescapePointerSegment);
 
   if (parts.length === 2) {
     const [legacySection, name] = parts;
@@ -250,12 +237,13 @@ function getOrCreateComponentAlias(
   return candidate;
 }
 
-async function getValueByPointer(filePath, pointer, context) {
+async function getValueByPointer(
+  filePath,
+  pointer,
+  context
+) {
   const doc = await loadDocument(filePath, context);
-  const parts = pointer
-    .replace(/^#\//, '')
-    .split('/')
-    .map(unescapePointerSegment);
+  const parts = pointer.replace(/^#\//, '').split('/').map(unescapePointerSegment);
 
   let current = doc;
   for (const part of parts) {

package/dist/utils/templateEngine.js

@@ -34,9 +34,7 @@ let loadedFiles = null;
   }
   return (
     templateFile in loadedFiles ||
-    Object.keys(loadedFiles).some(
-      (k) => _optionalChain([k, 'access', _9 => _9.split, 'call', _10 => _10('/'), 'access', _11 => _11.pop, 'call', _12 => _12(), 'optionalAccess', _13 => _13.split, 'call', _14 => _14('\\'), 'access', _15 => _15.pop, 'call', _16 => _16()]) === templateFile
-    )
+    Object.keys(loadedFiles).some((k) => _optionalChain([k, 'access', _9 => _9.split, 'call', _10 => _10('/'), 'access', _11 => _11.pop, 'call', _12 => _12(), 'optionalAccess', _13 => _13.split, 'call', _14 => _14('\\'), 'access', _15 => _15.pop, 'call', _16 => _16()]) === templateFile)
   );
 } exports.hasTemplateFile = hasTemplateFile;
 

package/dist/utils/utils.js

@@ -74,7 +74,7 @@ const reservedKeywords = new Set([
  */
  function escapeIdentifier(name) {
   if (!name) {
-    return name;
+    return _nullishCoalesce(name, () => ( ''));
   }
 
   if (reservedKeywords.has(name) || /^[0-9]/.test(name)) {
@@ -139,10 +139,11 @@ const reservedKeywords = new Set([
   }
 
   return operations.reduce((groups, op) => {
-    if (!groups[op.group]) {
-      groups[op.group] = [];
+    const groupKey = _nullishCoalesce(op.group, () => ( 'default'));
+    if (!groups[groupKey]) {
+      groups[groupKey] = [];
     }
-    groups[op.group].push(op);
+    groups[groupKey].push(op);
     return groups;
   }, {});
 } exports.groupOperationsByGroupName = groupOperationsByGroupName;
@@ -219,11 +220,13 @@ function resolveResponseRef(
     return [];
   }
 
-  return arr.concat().sort(sortByKey(key));
+  return arr.concat().sort((a, b) => {
+    const aVal = (a )[key] ;
+    const bVal = (b )[key] ;
+    return aVal != null && bVal != null ? (aVal > bVal ? 1 : bVal > aVal ? -1 : 0) : 0;
+  });
 } exports.orderBy = orderBy;
 
-const sortByKey = (key) => (a, b) => (a[key] > b[key] ? 1 : b[key] > a[key] ? -1 : 0);
-
 const orderedContentTypes = [
   'text/plain',
   'application/x-www-form-urlencoded',
@@ -233,32 +236,35 @@ const preferredJsonContentTypes = ['application/json', 'text/json'];
  function getBestContentType(
   reqBody
 ) {
-  const contentTypes = Object.keys(reqBody.content);
+  const content = _nullishCoalesce(reqBody.content, () => ( {}));
+  const contentTypes = Object.keys(content);
   if (contentTypes.length === 0) {
     return [null, null];
   }
 
-  const preferredJsonContentType = preferredJsonContentTypes.find((ct) => contentTypes.includes(ct));
+  const preferredJsonContentType = preferredJsonContentTypes.find((ct) =>
+    contentTypes.includes(ct)
+  );
   if (preferredJsonContentType) {
-    const typeObject = reqBody.content[preferredJsonContentType];
+    const typeObject = content[preferredJsonContentType];
     const type = getContentType(preferredJsonContentType);
     return [typeObject, type];
   }
 
   const jsonLikeContentType = contentTypes.find(isJsonLikeContentType);
   if (jsonLikeContentType) {
-    const typeObject = reqBody.content[jsonLikeContentType];
+    const typeObject = content[jsonLikeContentType];
     return [typeObject, 'json'];
   }
 
   const firstContentType = orderedContentTypes.find((ct) => contentTypes.includes(ct));
   if (firstContentType) {
-    const typeObject = reqBody.content[firstContentType];
+    const typeObject = content[firstContentType];
     const type = getContentType(firstContentType);
     return [typeObject, type];
   }
 
-  const typeObject = reqBody.content[contentTypes[0]];
+  const typeObject = content[contentTypes[0]];
   const type = getContentType(contentTypes[0]);
   return [typeObject, type];
 } exports.getBestContentType = getBestContentType;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swaggie",
-  "version": "1.9.0-alpha.13",
+  "version": "1.9.0-alpha.14",
   "description": "Generate a fully typed TypeScript API client from your OpenAPI 3 spec",
   "author": {
     "name": "Piotr Dabrowski",
@@ -40,7 +40,7 @@
     "build": "bun run bundle-templates && sucrase ./src -d ./dist --transforms typescript,imports && bun run rm-tests && bun run types",
     "bundle-templates": "bun scripts/bundle-templates.ts",
     "rm-tests": "find dist/ \\( -name '*.spec.js' -o -name 'types.js' \\) -type f -delete",
-    "types": "tsc src/types.ts --outDir dist/ --declaration --emitDeclarationOnly && cp test/index.d.ts ./dist/",
+    "types": "tsc --project tsconfig.types.json && cp test/index.d.ts ./dist/",
     "docs:build": "vitepress build docs",
     "docs:dev": "vitepress dev docs",
     "docs:preview": "vitepress preview docs"
@@ -79,7 +79,7 @@
     "bun-types": "1.3.11",
     "openapi-types": "^12.1.3",
     "sucrase": "3.35.1",
-    "typescript": "5.9.3",
+    "typescript": "6.0.2",
     "vitepress": "^2.0.0-alpha.17",
     "vitepress-plugin-tabs": "0.8.0"
   }