swaggie 1.9.0-alpha.2 → 1.9.0-alpha.5

package/dist/gen/genTypes.js

@@ -58,8 +58,9 @@ function renderSchema(
   if ('x-ts-type' in schema) {
     const result = [];
     const s = schema ;
-    if (_nullishCoalesce(s.description, () => ( s.title))) {
-      result.push(_jsDocs.renderComment.call(void 0, _nullishCoalesce(s.description, () => ( s.title))));
+    const xTsComment = _jsDocs.buildSchemaComment.call(void 0, s);
+    if (xTsComment) {
+      result.push(xTsComment);
     }
     result.push(`export type ${safeName} = ${schema['x-ts-type']};`);
     return result.join('\n');
@@ -74,8 +75,9 @@ function renderSchema(
 
   const result = [];
   const schemaContext = `components.schemas.${safeName}`;
-  if (_nullishCoalesce(schema.description, () => ( schema.title))) {
-    result.push(_jsDocs.renderComment.call(void 0, _nullishCoalesce(schema.description, () => ( schema.title))));
+  const schemaComment = _jsDocs.buildSchemaComment.call(void 0, schema);
+  if (schemaComment) {
+    result.push(schemaComment);
   }
 
   if ('x-enumNames' in schema || 'x-enum-varnames' in schema) {
@@ -138,7 +140,10 @@ function renderSchema(
     return result.join('\n');
   } else {
     const objectType = _swagger.getTypeFromSchema.call(void 0, schema, options, schemaContext);
-    const hasAdditionalProperties = !!schema.additionalProperties;
+    // A bare `type: object` with no properties is a free-form object per the OpenAPI spec
+    const isFreeFormObject =
+      schema.type === 'object' && !schema.properties && !schema.additionalProperties;
+    const hasAdditionalProperties = !!schema.additionalProperties || isFreeFormObject;
 
     const objectContents = generateObjectTypeContents(schema, options, schemaContext);
     if (hasAdditionalProperties) {
@@ -288,8 +293,13 @@ function renderTypeProp(
   const lines = [];
   const type = _swagger.getTypeFromSchema.call(void 0, definition, options, `${schemaContext}.properties.${propName}`);
 
-  if ('description' in definition || 'title' in definition) {
-    const renderedComment = _jsDocs.renderComment.call(void 0, _nullishCoalesce(definition.description, () => ( definition.title)));
+  if (
+    'description' in definition ||
+    'title' in definition ||
+    'format' in definition ||
+    'default' in definition
+  ) {
+    const renderedComment = _jsDocs.buildSchemaComment.call(void 0, definition );
     if (renderedComment) {
       lines.push(indentComment(renderedComment, '  '));
     }

package/dist/gen/header.js

@@ -3,6 +3,7 @@
  * regardless of generation mode.
  */
  const FILE_HEADER =
+  '/* istanbul ignore file -- auto-generated code */\n' +
   '/* tslint:disable */\n' +
   '/* eslint-disable */\n' +
   '//----------------------\n' +
@@ -12,5 +13,5 @@
   '// </auto-generated>\n' +
   '//----------------------\n' +
   '// ReSharper disable InconsistentNaming\n' +
-  '// deno-lint-ignore-file\n' +
-  '// biome-ignore-all lint: auto-generated code\n\n'; exports.FILE_HEADER = FILE_HEADER;
+  '// biome-ignore-all lint: auto-generated code\n' +
+  '// deno-lint-ignore-file\n\n'; exports.FILE_HEADER = FILE_HEADER;

package/dist/gen/jsDocs.js

@@ -1,4 +1,4 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true}); 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; }
+"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; }
 
 
 /**
@@ -80,6 +80,40 @@ function stripSpecificHtmlTags(str) {
   return renderComment(result.join('\n'));
 } exports.prepareJsDocsForOperation = prepareJsDocsForOperation;
 
+/**
+ * Builds a JSDoc comment string from schema metadata, including optional
+ * `@default` and `@format` tags when those fields are present on the schema.
+ */
+ function buildSchemaComment(schema
+
+
+
+
+) {
+  const lines = [];
+
+  const text = _nullishCoalesce(schema.description, () => ( schema.title));
+  if (text) {
+    lines.push(text);
+  }
+
+  if (schema.default !== undefined) {
+    const val =
+      typeof schema.default === 'string'
+        ? `"${schema.default}"`
+        : typeof schema.default === 'object'
+          ? JSON.stringify(schema.default)
+          : String(schema.default);
+    lines.push(`@default ${val}`);
+  }
+
+  if (schema.format !== undefined) {
+    lines.push(`@format ${schema.format}`);
+  }
+
+  return renderComment(lines.join('\n'));
+} exports.buildSchemaComment = buildSchemaComment;
+
  function renderComment(comment) {
   if (!comment) {
     return '';

package/dist/generated/bundledTemplates.js

@@ -28,15 +28,16 @@
   },
   "swr-axios": {
     "barrel.ejs": "\n/**\n * Serializes a params object into a query string that is compatible with different REST APIs.\n * Implementation from: https://github.com/suhaotian/xior/blob/main/src/utils.ts\n * Kudos to @suhaotian for the original implementation\n */\nfunction encodeParams<T = any>(\n  params: T,\n  parentKey: string | null = null,\n  options?: {\n    allowDots?: boolean;\n    serializeDate?: (value: Date) => string;\n    arrayFormat?: 'indices' | 'repeat' | 'brackets';\n  }\n): string {\n  if (params === undefined || params === null) return '';\n  const encodedParams: string[] = [];\n  const paramsIsArray = Array.isArray(params);\n  const { arrayFormat, allowDots, serializeDate } = options || {};\n\n  const getKey = (key: string) => {\n    if (allowDots && !paramsIsArray) return `.${key}`;\n    if (paramsIsArray) {\n      if (arrayFormat === 'brackets') {\n        return '[]';\n      }\n      if (arrayFormat === 'repeat') {\n        return '';\n      }\n    }\n    return `[${key}]`;\n  };\n\n  for (const key in params) {\n    if (Object.prototype.hasOwnProperty.call(params, key)) {\n      let value = (params as any)[key];\n      if (value !== undefined) {\n        const encodedKey = parentKey ? `${parentKey}${getKey(key)}` : (key as string);\n\n        // biome-ignore lint/suspicious/noGlobalIsNan: <explanation>\n        if (!isNaN(value) && value instanceof Date) {\n          value = serializeDate ? serializeDate(value) : value.toISOString();\n        }\n        if (typeof value === 'object') {\n          // If the value is an object or array, recursively encode its contents\n          const result = encodeParams(value, encodedKey, options);\n          if (result !== '') encodedParams.push(result);\n        } else {\n          // Otherwise, encode the key-value pair\n          encodedParams.push(`${encodeURIComponent(encodedKey)}=${encodeURIComponent(value)}`);\n        }\n      }\n    }\n  }\n\n  return encodedParams.join('&');\n}\n\n",
-    "baseClient.ejs": "import Axios, { type AxiosPromise, type AxiosRequestConfig } from \"axios\";\nimport useSWR, { type SWRConfiguration, type Key } from 'swr';\n\nexport const axios = Axios.create({\n  baseURL: '<%= it.baseUrl || '' -%>',\n  paramsSerializer: (params: any) =>\n    encodeParams(params, null, {\n      allowDots: <%= it.allowDots %>,\n      arrayFormat: '<%= it.arrayFormat %>',\n    }),\n});\n\ninterface SwrConfig extends SWRConfiguration {\n  /* Custom key for SWR. You don't have to worry about this as by default it's the URL. You can use standard SWR Key here if you need more flexibility. */\n  key?: Key;\n\n  /* Configuration for axios fetcher */\n  axios?: AxiosRequestConfig;\n}\n\n",
-    "client.ejs": "export const <%= it.camelCaseName -%>Client = {\n  <% it.operations.forEach((operation) => { %>\n<%~ include('operation.ejs', operation); %>\n\n  <% }); %>\n};\n\n<%\nvar getOperations = it.operations.filter((o) => o.method === 'GET');\n\nfunction toOpName(name) {\n  var n = name.toLowerCase().startsWith('get') ? name.substring(3) : name;\n  return n.charAt(0).toUpperCase() + n.slice(1);\n}\n%>\n\nexport const <%= it.camelCaseName %> = {\n  queries: {\n<% getOperations.forEach((operation) => {\n  var opName = toOpName(operation.name);\n  var swrOperation = Object.assign({\n    swrOpName: 'use' + opName,\n    clientName: it.camelCaseName,\n  }, operation);\n%>\n<%~ include('swrOperation.ejs', swrOperation); %>\n\n<% }); %>\n  },\n\n  queryKeys: {\n<% getOperations.forEach((operation) => {\n  var opName = toOpName(operation.name);\n  var keyName = opName.charAt(0).toLowerCase() + opName.slice(1);\n%>\n    <%= keyName %>: (<% operation.parameters.forEach((parameter) => { %><%= parameter.name %><%= parameter.skippable ? '?' : '' %>: <%~ parameter.type %><%= parameter.optional ? ' | null' : '' %>, <% }); %>) => `<%= operation.url %><% if(operation.query && operation.query.length > 0) { %>?${encodeParams({<% operation.query.forEach((parameter) => { %>'<%= parameter.originalName %>': <%= parameter.name %>, <% }); %>})}<% } %>`,\n<% }); %>\n  },\n};\n",
+    "baseClient.ejs": "import Axios, { type AxiosPromise, type AxiosRequestConfig } from \"axios\";\nimport useSWR, { type SWRConfiguration, type Key } from 'swr';\nimport useSWRMutation, { type SWRMutationConfiguration } from 'swr/mutation';\n\nexport const axios = Axios.create({\n  baseURL: '<%= it.baseUrl || '' -%>',\n  paramsSerializer: (params: any) =>\n    encodeParams(params, null, {\n      allowDots: <%= it.allowDots %>,\n      arrayFormat: '<%= it.arrayFormat %>',\n    }),\n});\n\ninterface SwrConfig extends SWRConfiguration {\n  /* Custom key for SWR. You don't have to worry about this as by default it's the URL. You can use standard SWR Key here if you need more flexibility. */\n  key?: Key;\n}\n\n",
+    "client.ejs": "export const <%= it.camelCaseName -%>Client = {\n  <% it.operations.forEach((operation) => { %>\n<%~ include('operation.ejs', operation); %>\n\n  <% }); %>\n};\n\n<%\nvar getOperations = it.operations.filter((o) => o.method === 'GET');\nvar mutationOperations = it.operations.filter((o) => o.method !== 'GET');\n\nfunction toOpName(name) {\n  var n = name.toLowerCase().startsWith('get') ? name.substring(3) : name;\n  return n.charAt(0).toUpperCase() + n.slice(1);\n}\n\nfunction safeOperation(operation, clientName) {\n  var safeParams = operation.parameters.map(function(p) {\n    return p.name === clientName ? Object.assign({}, p, { name: '_' + p.name }) : p;\n  });\n  return Object.assign({}, operation, { parameters: safeParams });\n}\n%>\n\nexport const <%= it.camelCaseName %> = {\n  queries: {\n<% getOperations.forEach((operation) => {\n  var opName = toOpName(operation.name);\n  var swrOperation = Object.assign({\n    swrOpName: 'use' + opName,\n    clientName: it.camelCaseName,\n  }, safeOperation(operation, it.camelCaseName));\n%>\n<%~ include('swrOperation.ejs', swrOperation); %>\n\n<% }); %>\n  },\n\n  mutations: {\n<% mutationOperations.forEach((operation) => {\n  var opName = operation.name.charAt(0).toUpperCase() + operation.name.slice(1);\n  var swrMutationOperation = Object.assign({\n    mutOpName: 'use' + opName,\n    clientName: it.camelCaseName,\n  }, safeOperation(operation, it.camelCaseName));\n%>\n<%~ include('swrMutationOperation.ejs', swrMutationOperation); %>\n\n<% }); %>\n  },\n\n  queryKeys: {\n<% getOperations.forEach((operation) => {\n  var opName = toOpName(operation.name);\n  var keyName = opName.charAt(0).toLowerCase() + opName.slice(1);\n  var safeOp = safeOperation(operation, it.camelCaseName);\n%>\n    <%= keyName %>: (<% safeOp.parameters.forEach((parameter) => { %><%= parameter.name %><%= parameter.skippable ? '?' : '' %>: <%~ parameter.type %><%= parameter.optional ? (parameter.skippable ? ' | null' : ' | null | undefined') : '' %>, <% }); %>) => `<%= operation.url %><% if(safeOp.query && safeOp.query.length > 0) { %>?${encodeParams({<% safeOp.query.forEach((parameter) => { %>'<%= parameter.originalName %>': <%= parameter.name %>, <% }); %>})}<% } %>`,\n<% }); %>\n  },\n};\n",
     "operation.ejs": "<%~ it.jsDocs %>\n\n  <%= it.name %>(<% it.parameters.forEach((parameter) => { %>\n<%= parameter.name %><%= parameter.skippable ? '?' : '' %>: <%~ parameter.type %> <%= parameter.optional ? (parameter.skippable ? '| null' : '| null | undefined') : '' %>,\n    <% }); %>\n  $config?: AxiosRequestConfig\n  ): AxiosPromise<<%~ it.returnType %>> {\n    const url = `<%= it.url %>`;\n\n    return axios.request<<%~ it.returnType %>>({\n      url: url,\n      method: '<%= it.method %>',\n<% if(it.body) { %>\n<% if(it.body.contentType === 'urlencoded') { %>\n      data: new URLSearchParams(<%= it.body.name %> as any),\n<% } else { %>\n      data: <%= it.body.name %>,\n<% } %>\n<% } %>\n<% if(it.query && it.query.length > 0) { %>\n      params: {\n    <% it.query.forEach((parameter) => { %>\n    '<%= parameter.originalName %>': <%= parameter.name %>,\n    <% }); %>\n  },\n<% } %>\n<% if(it.headers && it.headers.length > 0) { %>\n      headers: {\n  <% it.headers.forEach((parameter) => { %>\n    <% if (parameter.value) { %>\n  '<%= parameter.originalName %>': '<%= parameter.value %>',\n    <% } else { %>\n  '<%= parameter.originalName %>': <%= parameter.name %>,\n    <% } %>\n  <% }); %>\n},\n<% } %>\n      ...$config,\n    });\n  },\n",
-    "swrOperation.ejs": "<% var docs = it.jsDocs ? it.jsDocs.replace(/^/gm, '  ') + '\\n' : ''; %>\n<%~ docs %>\n    <%= it.swrOpName %>(\n<% it.parameters.forEach((parameter) => { %>      <%= parameter.name %><%= parameter.skippable ? '?' : '' %>: <%~ parameter.type %><%= parameter.optional ? (parameter.skippable ? ' | null' : ' | null | undefined') : '' %>,\n<% }); %>      $config?: SwrConfig\n    ) {\n      const url = `<%= it.url %>`;\n      const { axios: $axiosConf, key, ...config } = $config || {};\n\n<% if(it.query && it.query.length > 0) { %>\n      const cacheKey = encodeParams({<% it.query.forEach((parameter) => { %>\n        '<%= parameter.originalName %>': <%= parameter.name %>,<% }); %>\n      });\n      const cacheUrl = cacheKey ? `${url}?${cacheKey}` : url;\n<% } else { %>\n      const cacheUrl = url;\n<% } %>\n\n      const { data, error, isLoading, mutate } = useSWR<<%~ it.returnType %>>(\n        key ?? cacheUrl,\n        () => axios.request({\n          url: url,\n          method: '<%= it.method %>',\n<% if(it.query && it.query.length > 0) { %>\n          params: {\n<% it.query.forEach((parameter) => { %>\n            '<%= parameter.originalName %>': <%= parameter.name %>,\n<% }); %>\n          },\n<% } %>\n<% if(it.headers && it.headers.length > 0) { %>\n          headers: {\n<% it.headers.forEach((parameter) => { %>\n<% if (parameter.value) { %>\n            '<%= parameter.originalName %>': '<%= parameter.value %>',\n<% } else { %>\n            '<%= parameter.originalName %>': <%= parameter.name %>,\n<% } %>\n<% }); %>\n          },\n<% } %>\n          ...$axiosConf,\n        }).then((resp) => resp.data),\n        config\n      );\n\n      return { data, isLoading, error, mutate };\n    },\n"
+    "swrMutationOperation.ejs": "<%\nvar hasParams = it.parameters.length > 0;\n\nvar variablesType;\nif (!hasParams) {\n  variablesType = 'void';\n} else {\n  var parts = it.parameters.map(function(p) {\n    return p.name + (p.skippable ? '?' : '') + ': ' + p.type + (p.optional ? ' | null' : '');\n  });\n  variablesType = '{ ' + parts.join('; ') + ' }';\n}\n\nvar callArgs = it.parameters.map(function(p) { return 'arg.' + p.name; });\n\n// Stable SWR key: replace all ${...} path expressions with *\nvar swrKey = it.url.replace(/\\$\\{(?:[^{}]|\\{[^{}]*\\})*\\}/g, '*');\n\nvar docs = it.jsDocs ? it.jsDocs.replace(/^/gm, '  ') + '\\n' : '';\n%>\n<%~ docs %>\n    <%= it.mutOpName %>(\n      $config?: SWRMutationConfiguration<<%~ it.returnType %>, Error, string, <%~ variablesType %>>,\n      $httpConfig?: AxiosRequestConfig\n    ) {\n      return useSWRMutation<<%~ it.returnType %>, Error, string, <%~ variablesType %>>(\n        '<%= swrKey %>',\n        (_key: string, { arg }<%= hasParams ? ': { arg: ' + variablesType + ' }' : '' %>) =>\n          <%= it.clientName %>Client.<%= it.name %>(<%= callArgs.join(', ') %><%= callArgs.length > 0 ? ', ' : '' %>$httpConfig).then((resp) => resp.data),\n        $config\n      );\n    },\n",
+    "swrOperation.ejs": "<% var docs = it.jsDocs ? it.jsDocs.replace(/^/gm, '  ') + '\\n' : ''; %>\n<%~ docs %>\n    <%= it.swrOpName %>(\n<% it.parameters.forEach((parameter) => { %>      <%= parameter.name %><%= parameter.skippable ? '?' : '' %>: <%~ parameter.type %><%= parameter.optional ? (parameter.skippable ? ' | null' : ' | null | undefined') : '' %>,\n<% }); %>      $config?: Omit<SwrConfig, 'key'> & { key?: Key },\n      $httpConfig?: AxiosRequestConfig\n    ) {\n      const { key, ...config } = $config || {};\n      const cacheUrl = key ?? <%= it.clientName %>.queryKeys.<%= it.swrOpName.charAt(3).toLowerCase() + it.swrOpName.slice(4) %>(<% it.parameters.forEach((parameter) => { %><%= parameter.name %>, <% }); %>);\n\n      const { data, error, isLoading, mutate } = useSWR<<%~ it.returnType %>>(\n        cacheUrl,\n        () => <%= it.clientName %>Client.<%= it.name %>(<% it.parameters.forEach((parameter) => { %><%= parameter.name %>, <% }); %>$httpConfig).then((resp) => resp.data),\n        config\n      );\n\n      return { data, isLoading, error, mutate };\n    },\n"
   },
   "tsq-xior": {
     "barrel.ejs": "",
     "baseClient.ejs": "import xior, { type XiorResponse, type XiorRequestConfig, encodeParams } from \"xior\";\nimport { type UseQueryOptions, type UseMutationOptions, useQuery, useMutation } from '@tanstack/react-query';\n\nexport const http = xior.create({\n  baseURL: '<%= it.baseUrl || '' %>',\n  paramsSerializer: (params: any) =>\n    encodeParams(params, true, null, {\n      allowDots: <%= it.allowDots %>,\n      arrayFormat: '<%= it.arrayFormat %>',\n    }),\n});\n\n",
-    "client.ejs": "export const <%= it.camelCaseName %>Client = {\n  <% it.operations.forEach((operation) => { %>\n<%~ include('operation.ejs', operation); %>\n\n<% }); %>\n};\n\n<%\nvar getOperations = it.operations.filter((o) => o.method === 'GET');\nvar mutationOperations = it.operations.filter((o) => o.method !== 'GET');\n\n// Helper: strip leading \"get\" and capitalise\nfunction toOpName(name) {\n  var n = name.toLowerCase().startsWith('get') ? name.substring(3) : name;\n  return n.charAt(0).toUpperCase() + n.slice(1);\n}\n%>\n\nexport const <%= it.camelCaseName %> = {\n  queries: {\n<% getOperations.forEach((operation) => {\n  var opName = toOpName(operation.name);\n  var queryOperation = Object.assign({\n    rqOpName: 'use' + opName,\n    opKey: it.camelCaseName + opName,\n    clientName: it.camelCaseName,\n  }, operation);\n%>\n<%~ include('queryOperation.ejs', queryOperation); %>\n\n<% }); %>\n  },\n\n  mutations: {\n<% mutationOperations.forEach((operation) => {\n  var opName = operation.name.charAt(0).toUpperCase() + operation.name.slice(1);\n  var mutationOperation = Object.assign({\n    mutOpName: 'use' + opName,\n    clientName: it.camelCaseName,\n  }, operation);\n%>\n<%~ include('mutationOperation.ejs', mutationOperation); %>\n\n<% }); %>\n  },\n\n  queryKeys: {\n<% getOperations.forEach((operation) => {\n  var opName = toOpName(operation.name);\n  var keyName = opName.charAt(0).toLowerCase() + opName.slice(1);\n%>\n    <%= keyName %>: (<% operation.parameters.forEach((parameter) => { %><%= parameter.name %><%= parameter.skippable ? '?' : '' %>: <%~ parameter.type %><%= parameter.optional ? ' | null' : '' %>, <% }); %>) => ['<%= it.camelCaseName %>', '<%= it.camelCaseName + opName %>'<% operation.parameters.forEach((parameter) => { %>, <%= parameter.name %><% }); %>] as const,\n<% }); %>\n  },\n};\n",
+    "client.ejs": "export const <%= it.camelCaseName %>Client = {\n  <% it.operations.forEach((operation) => { %>\n<%~ include('operation.ejs', operation); %>\n\n<% }); %>\n};\n\n<%\nvar getOperations = it.operations.filter((o) => o.method === 'GET');\nvar mutationOperations = it.operations.filter((o) => o.method !== 'GET');\n\n// Helper: strip leading \"get\" and capitalise\nfunction toOpName(name) {\n  var n = name.toLowerCase().startsWith('get') ? name.substring(3) : name;\n  return n.charAt(0).toUpperCase() + n.slice(1);\n}\n\n// Returns a deep copy of operation with any parameter whose name collides with\n// the group object name (clientName) renamed to _<name> to avoid TS shadowing.\nfunction safeOperation(operation, clientName) {\n  var safeParams = operation.parameters.map(function(p) {\n    return p.name === clientName ? Object.assign({}, p, { name: '_' + p.name }) : p;\n  });\n  return Object.assign({}, operation, { parameters: safeParams });\n}\n%>\n\nexport const <%= it.camelCaseName %> = {\n  queries: {\n<% getOperations.forEach((operation) => {\n  var opName = toOpName(operation.name);\n  var queryOperation = Object.assign({\n    rqOpName: 'use' + opName,\n    opKey: it.camelCaseName + opName,\n    clientName: it.camelCaseName,\n  }, safeOperation(operation, it.camelCaseName));\n%>\n<%~ include('queryOperation.ejs', queryOperation); %>\n\n<% }); %>\n  },\n\n  mutations: {\n<% mutationOperations.forEach((operation) => {\n  var opName = operation.name.charAt(0).toUpperCase() + operation.name.slice(1);\n  var mutationOperation = Object.assign({\n    mutOpName: 'use' + opName,\n    clientName: it.camelCaseName,\n  }, safeOperation(operation, it.camelCaseName));\n%>\n<%~ include('mutationOperation.ejs', mutationOperation); %>\n\n<% }); %>\n  },\n\n  queryKeys: {\n<% getOperations.forEach((operation) => {\n  var opName = toOpName(operation.name);\n  var keyName = opName.charAt(0).toLowerCase() + opName.slice(1);\n  var safeOp = safeOperation(operation, it.camelCaseName);\n%>\n    <%= keyName %>: (<% safeOp.parameters.forEach((parameter) => { %><%= parameter.name %><%= parameter.skippable ? '?' : '' %>: <%~ parameter.type %><%= parameter.optional ? (parameter.skippable ? ' | null' : ' | null | undefined') : '' %>, <% }); %>) => ['<%= it.camelCaseName %>', '<%= it.camelCaseName + opName %>'<% safeOp.parameters.forEach((parameter) => { %>, <%= parameter.name %><% }); %>] as const,\n<% }); %>\n  },\n};\n",
     "mutationOperation.ejs": "<%\nvar hasParams = it.parameters.length > 0;\n\nvar variablesType;\nif (!hasParams) {\n  variablesType = 'void';\n} else {\n  var parts = it.parameters.map(function(p) {\n    return p.name + (p.skippable ? '?' : '') + ': ' + p.type + (p.optional ? ' | null' : '');\n  });\n  variablesType = '{ ' + parts.join('; ') + ' }';\n}\n\nvar callArgs = it.parameters.map(function(p) { return 'vars.' + p.name; });\n\nvar baseAdditionalParams = '  * @param $config (optional) Additional configuration for TanStack Query\\n  * @param $httpConfig (optional) Additional configuration for xior request (actually executes the request)';\nvar rawDocs = it.jsDocs\n  ? it.jsDocs.replace(/(\\s*)\\*\\/\\s*$/, '\\n' + baseAdditionalParams + '\\n */')\n  : '';\nvar docs = rawDocs ? rawDocs.replace(/^/gm, '  ') + '\\n' : '';\n%>\n<%~ docs %>\n    <%= it.mutOpName %><TData = <%~ it.returnType %>, TError = Error>(\n      $config?: UseMutationOptions<<%~ it.returnType %>, TError, <%~ variablesType %>>,\n      $httpConfig?: XiorRequestConfig\n    ) {\n      return useMutation<<%~ it.returnType %>, TError, <%~ variablesType %>>({\n        mutationFn: (<%= hasParams ? 'vars' : '' %>) => <%= it.clientName %>Client.<%= it.name %>(<%= callArgs.join(', ') %><%= callArgs.length > 0 ? ', ' : '' %>$httpConfig).then(res => res.data),\n        ...$config\n      });\n    },\n",
     "operation.ejs": "<%~ it.jsDocs %>\n\n  <%= it.name %>(<% it.parameters.forEach((parameter) => { %>\n<%= parameter.name %><%= parameter.skippable ? '?' : '' %>: <%~ parameter.type %> <%= parameter.optional ? (parameter.skippable ? '| null' : '| null | undefined') : '' %>,\n    <% }); %>\n$config?: XiorRequestConfig\n  ): Promise<XiorResponse<<%~ it.returnType %>>> {\n    const url = `<%= it.url %>`;\n\n    return http.request<<%~ it.returnType %>>({\n      url: url,\n      method: '<%= it.method %>',\n<% if(it.body) { %>\n<% if(it.body.contentType === 'urlencoded') { %>\n      data: new URLSearchParams(<%= it.body.name %> as any),\n<% } else { %>\n      data: <%= it.body.name %>,\n<% } %>\n<% } %>\n<% if(it.query && it.query.length > 0) { %>\n      params: {\n    <% it.query.forEach((parameter) => { %>\n    '<%= parameter.originalName %>': <%= parameter.name %>,\n    <% }); %>\n  },\n<% } %>\n<% if(it.headers && it.headers.length > 0) { %>\n      headers: {\n  <% it.headers.forEach((parameter) => { %>\n    <% if (parameter.value) { %>\n  '<%= parameter.originalName %>': '<%= parameter.value %>',\n    <% } else { %>\n  '<%= parameter.originalName %>': <%= parameter.name %>,\n    <% } %>\n  <% }); %>\n},\n<% } %>\n      ...$config,\n    });\n  },\n",
     "queryOperation.ejs": "<%\nvar baseAdditionalParams = '  * @param $config (optional) Additional configuration for TanStack Query\\n  * @param $httpConfig (optional) Additional configuration for xior request (actually executes the request)';\nvar rawDocs = it.jsDocs\n  ? it.jsDocs.replace(/(\\s*)\\*\\/\\s*$/, '\\n' + baseAdditionalParams + '\\n */')\n  : '';\nvar docs = rawDocs ? rawDocs.replace(/^/gm, '  ') + '\\n' : '';\n%>\n<%~ docs %>\n    <%= it.rqOpName %><TData = <%~ it.returnType %>, TError = Error>(\n<% it.parameters.forEach((parameter) => { %>      <%= parameter.name %><%= parameter.skippable ? '?' : '' %>: <%~ parameter.type %><%= parameter.optional ? (parameter.skippable ? ' | null' : ' | null | undefined') : '' %>,\n<% }); %>      $config?: Omit<UseQueryOptions<<%~ it.returnType %>, TError, TData>, 'queryKey' | 'queryFn'>,\n      $httpConfig?: XiorRequestConfig\n    ) {\n      return useQuery<<%~ it.returnType %>, TError, TData>({\n        queryKey: <%= it.clientName %>.queryKeys.<%= it.rqOpName.charAt(3).toLowerCase() + it.rqOpName.slice(4) %>(<% it.parameters.forEach((parameter) => { %><%= parameter.name %>, <% }); %>),\n        queryFn: () => <%= it.clientName %>Client.<%= it.name %>(<% it.parameters.forEach((parameter) => { %><%= parameter.name %>, <% }); %>$httpConfig).then(res => res.data),\n        ...$config\n      });\n    },\n"

package/dist/swagger/typesExtractor.js

@@ -249,11 +249,11 @@ function getTypeFromObject(
 
   if (schema.additionalProperties) {
     const extraProps = schema.additionalProperties;
-    objectWithIndexSignatureType = `{ [key: string]: ${
+    objectWithIndexSignatureType = `Record<string, ${
       extraProps === true
-        ? 'any'
+        ? unknownType
         : getTypeFromSchemaResolved(extraProps, options, `${context}.additionalProperties`)
-    } }`;
+    }>`;
   }
 
   if (objectWithNamedPropsType && objectWithIndexSignatureType) {
@@ -268,6 +268,12 @@ function getTypeFromObject(
     return objectWithIndexSignatureType;
   }
 
+  // A bare `type: object` with no properties and no additionalProperties is a
+  // free-form object per the OpenAPI spec (equivalent to additionalProperties: true).
+  if (schema.type === 'object') {
+    return `Record<string, ${unknownType}>`;
+  }
+
   return unknownType;
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swaggie",
-  "version": "1.9.0-alpha.2",
+  "version": "1.9.0-alpha.5",
   "description": "Generate a fully typed TypeScript API client from your OpenAPI 3 spec",
   "author": {
     "name": "Piotr Dabrowski",

package/templates/swr-axios/baseClient.ejs

@@ -1,5 +1,6 @@
 import Axios, { type AxiosPromise, type AxiosRequestConfig } from "axios";
 import useSWR, { type SWRConfiguration, type Key } from 'swr';
+import useSWRMutation, { type SWRMutationConfiguration } from 'swr/mutation';
 
 export const axios = Axios.create({
   baseURL: '<%= it.baseUrl || '' -%>',
@@ -13,8 +14,5 @@ export const axios = Axios.create({
 interface SwrConfig extends SWRConfiguration {
   /* Custom key for SWR. You don't have to worry about this as by default it's the URL. You can use standard SWR Key here if you need more flexibility. */
   key?: Key;
-
-  /* Configuration for axios fetcher */
-  axios?: AxiosRequestConfig;
 }
 

package/templates/swr-axios/client.ejs

@@ -7,11 +7,19 @@ export const <%= it.camelCaseName -%>Client = {
 
 <%
 var getOperations = it.operations.filter((o) => o.method === 'GET');
+var mutationOperations = it.operations.filter((o) => o.method !== 'GET');
 
 function toOpName(name) {
   var n = name.toLowerCase().startsWith('get') ? name.substring(3) : name;
   return n.charAt(0).toUpperCase() + n.slice(1);
 }
+
+function safeOperation(operation, clientName) {
+  var safeParams = operation.parameters.map(function(p) {
+    return p.name === clientName ? Object.assign({}, p, { name: '_' + p.name }) : p;
+  });
+  return Object.assign({}, operation, { parameters: safeParams });
+}
 %>
 
 export const <%= it.camelCaseName %> = {
@@ -21,10 +29,23 @@ export const <%= it.camelCaseName %> = {
   var swrOperation = Object.assign({
     swrOpName: 'use' + opName,
     clientName: it.camelCaseName,
-  }, operation);
+  }, safeOperation(operation, it.camelCaseName));
 %>
 <%~ include('swrOperation.ejs', swrOperation); %>
 
+<% }); %>
+  },
+
+  mutations: {
+<% mutationOperations.forEach((operation) => {
+  var opName = operation.name.charAt(0).toUpperCase() + operation.name.slice(1);
+  var swrMutationOperation = Object.assign({
+    mutOpName: 'use' + opName,
+    clientName: it.camelCaseName,
+  }, safeOperation(operation, it.camelCaseName));
+%>
+<%~ include('swrMutationOperation.ejs', swrMutationOperation); %>
+
 <% }); %>
   },
 
@@ -32,8 +53,9 @@ export const <%= it.camelCaseName %> = {
 <% getOperations.forEach((operation) => {
   var opName = toOpName(operation.name);
   var keyName = opName.charAt(0).toLowerCase() + opName.slice(1);
+  var safeOp = safeOperation(operation, it.camelCaseName);
 %>
-    <%= keyName %>: (<% operation.parameters.forEach((parameter) => { %><%= parameter.name %><%= parameter.skippable ? '?' : '' %>: <%~ parameter.type %><%= parameter.optional ? ' | null' : '' %>, <% }); %>) => `<%= operation.url %><% if(operation.query && operation.query.length > 0) { %>?${encodeParams({<% operation.query.forEach((parameter) => { %>'<%= parameter.originalName %>': <%= parameter.name %>, <% }); %>})}<% } %>`,
+    <%= keyName %>: (<% safeOp.parameters.forEach((parameter) => { %><%= parameter.name %><%= parameter.skippable ? '?' : '' %>: <%~ parameter.type %><%= parameter.optional ? (parameter.skippable ? ' | null' : ' | null | undefined') : '' %>, <% }); %>) => `<%= operation.url %><% if(safeOp.query && safeOp.query.length > 0) { %>?${encodeParams({<% safeOp.query.forEach((parameter) => { %>'<%= parameter.originalName %>': <%= parameter.name %>, <% }); %>})}<% } %>`,
 <% }); %>
   },
 };

package/templates/swr-axios/swrMutationOperation.ejs

@@ -0,0 +1,32 @@
+<%
+var hasParams = it.parameters.length > 0;
+
+var variablesType;
+if (!hasParams) {
+  variablesType = 'void';
+} else {
+  var parts = it.parameters.map(function(p) {
+    return p.name + (p.skippable ? '?' : '') + ': ' + p.type + (p.optional ? ' | null' : '');
+  });
+  variablesType = '{ ' + parts.join('; ') + ' }';
+}
+
+var callArgs = it.parameters.map(function(p) { return 'arg.' + p.name; });
+
+// Stable SWR key: replace all ${...} path expressions with *
+var swrKey = it.url.replace(/\$\{(?:[^{}]|\{[^{}]*\})*\}/g, '*');
+
+var docs = it.jsDocs ? it.jsDocs.replace(/^/gm, '  ') + '\n' : '';
+%>
+<%~ docs %>
+    <%= it.mutOpName %>(
+      $config?: SWRMutationConfiguration<<%~ it.returnType %>, Error, string, <%~ variablesType %>>,
+      $httpConfig?: AxiosRequestConfig
+    ) {
+      return useSWRMutation<<%~ it.returnType %>, Error, string, <%~ variablesType %>>(
+        '<%= swrKey %>',
+        (_key: string, { arg }<%= hasParams ? ': { arg: ' + variablesType + ' }' : '' %>) =>
+          <%= it.clientName %>Client.<%= it.name %>(<%= callArgs.join(', ') %><%= callArgs.length > 0 ? ', ' : '' %>$httpConfig).then((resp) => resp.data),
+        $config
+      );
+    },

package/templates/swr-axios/swrOperation.ejs

@@ -2,45 +2,15 @@
 <%~ docs %>
     <%= it.swrOpName %>(
 <% it.parameters.forEach((parameter) => { %>      <%= parameter.name %><%= parameter.skippable ? '?' : '' %>: <%~ parameter.type %><%= parameter.optional ? (parameter.skippable ? ' | null' : ' | null | undefined') : '' %>,
-<% }); %>      $config?: SwrConfig
+<% }); %>      $config?: Omit<SwrConfig, 'key'> & { key?: Key },
+      $httpConfig?: AxiosRequestConfig
     ) {
-      const url = `<%= it.url %>`;
-      const { axios: $axiosConf, key, ...config } = $config || {};
-
-<% if(it.query && it.query.length > 0) { %>
-      const cacheKey = encodeParams({<% it.query.forEach((parameter) => { %>
-        '<%= parameter.originalName %>': <%= parameter.name %>,<% }); %>
-      });
-      const cacheUrl = cacheKey ? `${url}?${cacheKey}` : url;
-<% } else { %>
-      const cacheUrl = url;
-<% } %>
+      const { key, ...config } = $config || {};
+      const cacheUrl = key ?? <%= it.clientName %>.queryKeys.<%= it.swrOpName.charAt(3).toLowerCase() + it.swrOpName.slice(4) %>(<% it.parameters.forEach((parameter) => { %><%= parameter.name %>, <% }); %>);
 
       const { data, error, isLoading, mutate } = useSWR<<%~ it.returnType %>>(
-        key ?? cacheUrl,
-        () => axios.request({
-          url: url,
-          method: '<%= it.method %>',
-<% if(it.query && it.query.length > 0) { %>
-          params: {
-<% it.query.forEach((parameter) => { %>
-            '<%= parameter.originalName %>': <%= parameter.name %>,
-<% }); %>
-          },
-<% } %>
-<% if(it.headers && it.headers.length > 0) { %>
-          headers: {
-<% it.headers.forEach((parameter) => { %>
-<% if (parameter.value) { %>
-            '<%= parameter.originalName %>': '<%= parameter.value %>',
-<% } else { %>
-            '<%= parameter.originalName %>': <%= parameter.name %>,
-<% } %>
-<% }); %>
-          },
-<% } %>
-          ...$axiosConf,
-        }).then((resp) => resp.data),
+        cacheUrl,
+        () => <%= it.clientName %>Client.<%= it.name %>(<% it.parameters.forEach((parameter) => { %><%= parameter.name %>, <% }); %>$httpConfig).then((resp) => resp.data),
         config
       );
 

package/templates/tsq-xior/client.ejs

@@ -14,6 +14,15 @@ function toOpName(name) {
   var n = name.toLowerCase().startsWith('get') ? name.substring(3) : name;
   return n.charAt(0).toUpperCase() + n.slice(1);
 }
+
+// Returns a deep copy of operation with any parameter whose name collides with
+// the group object name (clientName) renamed to _<name> to avoid TS shadowing.
+function safeOperation(operation, clientName) {
+  var safeParams = operation.parameters.map(function(p) {
+    return p.name === clientName ? Object.assign({}, p, { name: '_' + p.name }) : p;
+  });
+  return Object.assign({}, operation, { parameters: safeParams });
+}
 %>
 
 export const <%= it.camelCaseName %> = {
@@ -24,7 +33,7 @@ export const <%= it.camelCaseName %> = {
     rqOpName: 'use' + opName,
     opKey: it.camelCaseName + opName,
     clientName: it.camelCaseName,
-  }, operation);
+  }, safeOperation(operation, it.camelCaseName));
 %>
 <%~ include('queryOperation.ejs', queryOperation); %>
 
@@ -37,7 +46,7 @@ export const <%= it.camelCaseName %> = {
   var mutationOperation = Object.assign({
     mutOpName: 'use' + opName,
     clientName: it.camelCaseName,
-  }, operation);
+  }, safeOperation(operation, it.camelCaseName));
 %>
 <%~ include('mutationOperation.ejs', mutationOperation); %>
 
@@ -48,8 +57,9 @@ export const <%= it.camelCaseName %> = {
 <% getOperations.forEach((operation) => {
   var opName = toOpName(operation.name);
   var keyName = opName.charAt(0).toLowerCase() + opName.slice(1);
+  var safeOp = safeOperation(operation, it.camelCaseName);
 %>
-    <%= keyName %>: (<% operation.parameters.forEach((parameter) => { %><%= parameter.name %><%= parameter.skippable ? '?' : '' %>: <%~ parameter.type %><%= parameter.optional ? ' | null' : '' %>, <% }); %>) => ['<%= it.camelCaseName %>', '<%= it.camelCaseName + opName %>'<% operation.parameters.forEach((parameter) => { %>, <%= parameter.name %><% }); %>] as const,
+    <%= keyName %>: (<% safeOp.parameters.forEach((parameter) => { %><%= parameter.name %><%= parameter.skippable ? '?' : '' %>: <%~ parameter.type %><%= parameter.optional ? (parameter.skippable ? ' | null' : ' | null | undefined') : '' %>, <% }); %>) => ['<%= it.camelCaseName %>', '<%= it.camelCaseName + opName %>'<% safeOp.parameters.forEach((parameter) => { %>, <%= parameter.name %><% }); %>] as const,
 <% }); %>
   },
 };