swaggie 2.1.1 → 2.1.3

package/README.md

@@ -124,7 +124,7 @@ swaggie -c swaggie.config.json
 
 ```json
 {
-  "$schema": "https://raw.githubusercontent.com/yhnavein/swaggie/master/schema.json",
+  "$schema": "https://yhnavein.github.io/swaggie/schema.json",
   "src": "https://petstore3.swagger.io/api/v3/openapi.json",
   "out": "./src/client/petstore.ts",
   "template": "axios",

package/dist/gen/genOperations.js

@@ -216,9 +216,17 @@ function prepareClient(
     return null;
   }
 
+  const camelCaseName = _case.camel.call(void 0, name);
+  // `default` is a JS reserved word — it is valid in `defaultClient` (HTTP
+  // client export) but not as a standalone `export const default = {}` used by
+  // the reactive hooks templates. When the camel-cased name would be `default`,
+  // we use `main` for the hooks namespace instead.
+  const hooksCamelCaseName = camelCaseName === 'default' ? 'main' : camelCaseName;
+
   return {
     clientName: name,
-    camelCaseName: _case.camel.call(void 0, name),
+    camelCaseName,
+    hooksCamelCaseName,
     operations: preparedOperations,
     baseUrl: options.baseUrl,
   };
@@ -615,23 +623,36 @@ const PRIMITIVES =
  * and inline object types (including PascalCase names used as property value types
  * inside `{ key: SomeType }` shapes).
  *
- * @example prefixApiType('Pet')                          → 'API.Pet'
- * @example prefixApiType('Pet[]')                        → 'API.Pet[]'
- * @example prefixApiType('Pet | null')                   → 'API.Pet | null'
- * @example prefixApiType('unknown')                      → 'unknown'
- * @example prefixApiType('{ id: number }')               → '{ id: number }'
- * @example prefixApiType('{ profile: MyEnum; }')         → '{ profile: API.MyEnum; }'
- * @example prefixApiType('API.Pet')                      → 'API.Pet' (API itself is in the exclude list)
+ * Quoted string literals (single or double) are left entirely untouched so that
+ * enum-derived types like `"AZURE" | "AWS"` are never incorrectly rewritten to
+ * `"API.AZURE" | "API.AWS"`.
+ *
+ * @example prefixApiType('Pet')                             → 'API.Pet'
+ * @example prefixApiType('Pet[]')                           → 'API.Pet[]'
+ * @example prefixApiType('Pet | null')                      → 'API.Pet | null'
+ * @example prefixApiType('unknown')                         → 'unknown'
+ * @example prefixApiType('{ id: number }')                  → '{ id: number }'
+ * @example prefixApiType('{ profile: MyEnum; }')            → '{ profile: API.MyEnum; }'
+ * @example prefixApiType('API.Pet')                         → 'API.Pet'
+ * @example prefixApiType('"AZURE" | "AWS"')                 → '"AZURE" | "AWS"'
+ * @example prefixApiType('"available" | Pet')               → '"available" | API.Pet'
  */
  function prefixApiType(typeStr) {
   if (!typeStr) {
     return typeStr;
   }
-  // The negative lookbehind `(?<!\.)` skips identifiers that are already part
-  // of a namespace reference (e.g. `API.Pet` — when the regex reaches `Pet` it
-  // is preceded by `.`, so we leave it alone).
-  return typeStr.replace(/(?<!\.)\b([A-Z][A-Za-z0-9_]*)\b/g, (match) =>
-    PRIMITIVES.test(match) ? match : `API.${match}`
+  // The alternation has two branches:
+  //   Group 1: a full quoted string literal ("..." or '...') — returned as-is so
+  //            that enum-derived values like "AZURE" are never prefixed.
+  //   Group 2: an uppercase-starting identifier that is NOT already preceded by a
+  //            dot (negative lookbehind) — prefixed with API. unless it is a known
+  //            primitive / built-in.
+  return typeStr.replace(
+    /("(?:[^"\\]|\\.)*"|'(?:[^'\\]|\\.)*')|(?<!\.)\b([A-Z][A-Za-z0-9_]*)\b/g,
+    (match, quotedLiteral, ident) => {
+      if (quotedLiteral !== undefined) return quotedLiteral;
+      return PRIMITIVES.test(ident) ? ident : `API.${ident}`;
+    },
   );
 } exports.prefixApiType = prefixApiType;
 

package/dist/generated/bundledTemplates.js

@@ -38,15 +38,15 @@
   },
   "swr": {
     "baseClient.ejs": "import useSWR, { type SWRConfiguration, type Key } from 'swr';\nimport useSWRMutation, { type SWRMutationConfiguration } from 'swr/mutation';\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",
-    "client.ejs": "export const <%= it.camelCaseName -%>Client = {\n  <% it.operations.forEach((operation) => { %>\n<%~ include('operation.ejs', operation); %>\n\n  <% }); %>\n};\n\n<% if (!it.splitMode) { %>\n<%\nvar getOperations = it.operations.filter((o) => o.method === 'GET');\nvar mutationOperations = it.operations.filter((o) => o.method !== 'GET');\n%>\n\nexport const <%= it.camelCaseName %> = {\n  queries: {\n<% getOperations.forEach((operation) => {\n  var opName = it.toOpName(operation.name);\n  var swrOperation = Object.assign({\n    swrOpName: 'use' + opName,\n    clientName: it.camelCaseName,\n    httpConfigType: it.httpConfigType,\n    responseMapper: it.responseMapper,\n  }, it.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    httpConfigType: it.httpConfigType,\n    responseMapper: it.responseMapper,\n  }, it.safeOperation(operation, it.camelCaseName));\n%>\n<%~ include('swrMutationOperation.ejs', swrMutationOperation); %>\n\n<% }); %>\n  },\n\n  queryKeys: {\n<% getOperations.forEach((operation) => {\n  var opName = it.toOpName(operation.name);\n  var keyName = opName.charAt(0).toLowerCase() + opName.slice(1);\n  var safeOp = it.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 %>': <%= safeOp.queryParamObject ? `${safeOp.queryParamObject.name}?.${parameter.name}` : parameter.name %>, <% }); %>})}<% } %>`,\n<% }); %>\n  },\n};\n<% } /* end !splitMode */ %>\n",
-    "hooksClient.ejs": "<%\nvar getOperations = it.operations.filter((o) => o.method === 'GET');\nvar mutationOperations = it.operations.filter((o) => o.method !== 'GET');\nvar httpClientPrefix = 'API.' + it.camelCaseName;\n%>\n\nexport const <%= it.camelCaseName %> = {\n  queries: {\n<% getOperations.forEach((operation) => {\n  var opName = it.toOpName(operation.name);\n  var safe = it.safeOperation(operation, it.camelCaseName);\n  var swrOperation = Object.assign({}, safe, {\n    swrOpName: 'use' + opName,\n    clientName: it.camelCaseName,\n    httpClientName: httpClientPrefix,\n    httpConfigType: it.httpConfigType,\n    responseMapper: it.responseMapper,\n    returnType: it.prefixApiType(safe.returnType),\n    parameters: safe.parameters.map(function(p) {\n      return Object.assign({}, p, { type: it.prefixApiType(p.type) });\n    }),\n  });\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 safe = it.safeOperation(operation, it.camelCaseName);\n  var swrMutationOperation = Object.assign({}, safe, {\n    mutOpName: 'use' + opName,\n    clientName: it.camelCaseName,\n    httpClientName: httpClientPrefix,\n    httpConfigType: it.httpConfigType,\n    responseMapper: it.responseMapper,\n    returnType: it.prefixApiType(safe.returnType),\n    parameters: safe.parameters.map(function(p) {\n      return Object.assign({}, p, { type: it.prefixApiType(p.type) });\n    }),\n  });\n%>\n<%~ include('swrMutationOperation.ejs', swrMutationOperation); %>\n\n<% }); %>\n  },\n\n  queryKeys: {\n<% getOperations.forEach((operation) => {\n  var opName = it.toOpName(operation.name);\n  var keyName = opName.charAt(0).toLowerCase() + opName.slice(1);\n  var safeOp = it.safeOperation(operation, it.camelCaseName);\n  var prefixedParams = safeOp.parameters.map(function(p) {\n    return Object.assign({}, p, { type: it.prefixApiType(p.type) });\n  });\n%>\n    <%= keyName %>: (<% prefixedParams.forEach((parameter) => { %><%= parameter.name %><%= parameter.skippable ? '?' : '' %>: <%~ parameter.type %><%= parameter.optional ? (parameter.skippable ? ' | null' : ' | null | undefined') : '' %>, <% }); %>) => `<%= operation.url %><% if(safeOp.query && safeOp.query.length > 0) { %>?${API.encodeParams({<% safeOp.query.forEach((parameter) => { %>'<%= parameter.originalName %>': <%= safeOp.queryParamObject ? `${safeOp.queryParamObject.name}?.${parameter.name}` : parameter.name %>, <% }); %>})}<% } %>`,\n<% }); %>\n  },\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' : '';\nvar httpClientName = it.httpClientName || it.clientName;\n%>\n<%~ docs %>\n    <%= it.mutOpName %>(\n      $config?: SWRMutationConfiguration<<%~ it.returnType %>, Error, string, <%~ variablesType %>>,\n      $httpConfig?: <%= it.httpConfigType %>\n    ) {\n      return useSWRMutation<<%~ it.returnType %>, Error, string, <%~ variablesType %>>(\n        '<%= swrKey %>',\n        (_key: string, { arg }<%= hasParams ? ': { arg: ' + variablesType + ' }' : '' %>) =>\n          <%= httpClientName %>Client.<%= it.name %>(<%= callArgs.join(', ') %><%= callArgs.length > 0 ? ', ' : '' %>$httpConfig)<%~ it.responseMapper %>,\n        $config\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<% if (!it.splitMode) { %>\n<%\nvar getOperations = it.operations.filter((o) => o.method === 'GET');\nvar mutationOperations = it.operations.filter((o) => o.method !== 'GET');\n%>\n\nexport const <%= it.hooksCamelCaseName %> = {\n  queries: {\n<% getOperations.forEach((operation) => {\n  var opName = it.toOpName(operation.name);\n  var swrOperation = Object.assign({\n    swrOpName: 'use' + opName,\n    clientName: it.hooksCamelCaseName,\n    httpClientName: it.camelCaseName,\n    httpConfigType: it.httpConfigType,\n    responseMapper: it.responseMapper,\n  }, it.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.hooksCamelCaseName,\n    httpClientName: it.camelCaseName,\n    httpConfigType: it.httpConfigType,\n    responseMapper: it.responseMapper,\n  }, it.safeOperation(operation, it.camelCaseName));\n%>\n<%~ include('swrMutationOperation.ejs', swrMutationOperation); %>\n\n<% }); %>\n  },\n\n  queryKeys: {\n<% getOperations.forEach((operation) => {\n  var opName = it.toOpName(operation.name);\n  var keyName = opName.charAt(0).toLowerCase() + opName.slice(1);\n  var safeOp = it.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 %>': <%= safeOp.queryParamObject ? `${safeOp.queryParamObject.name}?.${parameter.name}` : parameter.name %>, <% }); %>})}<% } %>`,\n<% }); %>\n  },\n};\n<% } /* end !splitMode */ %>\n",
+    "hooksClient.ejs": "<%\nvar getOperations = it.operations.filter((o) => o.method === 'GET');\nvar mutationOperations = it.operations.filter((o) => o.method !== 'GET');\nvar httpClientPrefix = 'API.' + it.camelCaseName;\n%>\n\nexport const <%= it.hooksCamelCaseName %> = {\n  queries: {\n<% getOperations.forEach((operation) => {\n  var opName = it.toOpName(operation.name);\n  var safe = it.safeOperation(operation, it.camelCaseName);\n  var swrOperation = Object.assign({}, safe, {\n    swrOpName: 'use' + opName,\n    clientName: it.hooksCamelCaseName,\n    httpClientName: httpClientPrefix,\n    httpConfigType: it.httpConfigType,\n    responseMapper: it.responseMapper,\n    returnType: it.prefixApiType(safe.returnType),\n    parameters: safe.parameters.map(function(p) {\n      return Object.assign({}, p, { type: it.prefixApiType(p.type) });\n    }),\n  });\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 safe = it.safeOperation(operation, it.camelCaseName);\n  var swrMutationOperation = Object.assign({}, safe, {\n    mutOpName: 'use' + opName,\n    clientName: it.hooksCamelCaseName,\n    httpClientName: httpClientPrefix,\n    httpConfigType: it.httpConfigType,\n    responseMapper: it.responseMapper,\n    returnType: it.prefixApiType(safe.returnType),\n    parameters: safe.parameters.map(function(p) {\n      return Object.assign({}, p, { type: it.prefixApiType(p.type) });\n    }),\n  });\n%>\n<%~ include('swrMutationOperation.ejs', swrMutationOperation); %>\n\n<% }); %>\n  },\n\n  queryKeys: {\n<% getOperations.forEach((operation) => {\n  var opName = it.toOpName(operation.name);\n  var keyName = opName.charAt(0).toLowerCase() + opName.slice(1);\n  var safeOp = it.safeOperation(operation, it.camelCaseName);\n  var prefixedParams = safeOp.parameters.map(function(p) {\n    return Object.assign({}, p, { type: it.prefixApiType(p.type) });\n  });\n%>\n    <%= keyName %>: (<% prefixedParams.forEach((parameter) => { %><%= parameter.name %><%= parameter.skippable ? '?' : '' %>: <%~ parameter.type %><%= parameter.optional ? (parameter.skippable ? ' | null' : ' | null | undefined') : '' %>, <% }); %>) => `<%= operation.url %><% if(safeOp.query && safeOp.query.length > 0) { %>?${API.encodeParams({<% safeOp.query.forEach((parameter) => { %>'<%= parameter.originalName %>': <%= safeOp.queryParamObject ? `${safeOp.queryParamObject.name}?.${parameter.name}` : parameter.name %>, <% }); %>})}<% } %>`,\n<% }); %>\n  },\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' : '';\nvar httpClientName = it.httpClientName || it.clientName;\n%>\n<%~ docs %>\n    <%= it.mutOpName %>(\n      $config?: SWRMutationConfiguration<<%~ it.returnType %>, Error, string, <%~ variablesType %>>,\n      $httpConfig?: <%= it.httpConfigType %>\n    ) {\n      return useSWRMutation<<%~ it.returnType %>, Error, string, <%~ variablesType %>>(\n        '<%= swrKey %>',\n        (_key: string, { arg }<%~ hasParams ? ': { arg: ' + variablesType + ' }' : '' %>) =>\n          <%= httpClientName %>Client.<%= it.name %>(<%= callArgs.join(', ') %><%= callArgs.length > 0 ? ', ' : '' %>$httpConfig)<%~ it.responseMapper %>,\n        $config\n      );\n    },\n",
     "swrOperation.ejs": "<% var docs = it.jsDocs ? it.jsDocs.replace(/^/gm, '  ') + '\\n' : ''; %>\n<% var httpClientName = it.httpClientName || it.clientName; %>\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?: <%= it.httpConfigType %>\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        () => <%= httpClientName %>Client.<%= it.name %>(<% it.parameters.forEach((parameter) => { %><%= parameter.name %>, <% }); %>$httpConfig)<%~ it.responseMapper %>,\n        config\n      );\n\n      return { data, isLoading, error, mutate };\n    },\n"
   },
   "tsq": {
     "baseClient.ejs": "import { type UseQueryOptions, type UseMutationOptions, useQuery, useMutation } from '@tanstack/react-query';\n",
-    "client.ejs": "export const <%= it.camelCaseName %>Client = {\n  <% it.operations.forEach((operation) => { %>\n<%~ include('operation.ejs', operation); %>\n\n<% }); %>\n};\n\n<% if (!it.splitMode) { %>\n<%\nvar getOperations = it.operations.filter((o) => o.method === 'GET');\nvar mutationOperations = it.operations.filter((o) => o.method !== 'GET');\n%>\n\nexport const <%= it.camelCaseName %> = {\n  queries: {\n<% getOperations.forEach((operation) => {\n  var opName = it.toOpName(operation.name);\n  var queryOperation = Object.assign({\n    rqOpName: 'use' + opName,\n    opKey: it.camelCaseName + opName,\n    clientName: it.camelCaseName,\n    httpConfigType: it.httpConfigType,\n    responseMapper: it.responseMapper,\n  }, it.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    httpConfigType: it.httpConfigType,\n    responseMapper: it.responseMapper,\n  }, it.safeOperation(operation, it.camelCaseName));\n%>\n<%~ include('mutationOperation.ejs', mutationOperation); %>\n\n<% }); %>\n  },\n\n  queryKeys: {\n<% getOperations.forEach((operation) => {\n  var opName = it.toOpName(operation.name);\n  var keyName = opName.charAt(0).toLowerCase() + opName.slice(1);\n  var safeOp = it.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<% } /* end !splitMode */ %>\n",
-    "hooksClient.ejs": "<%\nvar getOperations = it.operations.filter((o) => o.method === 'GET');\nvar mutationOperations = it.operations.filter((o) => o.method !== 'GET');\nvar httpClientPrefix = 'API.' + it.camelCaseName;\n%>\n\nexport const <%= it.camelCaseName %> = {\n  queries: {\n<% getOperations.forEach((operation) => {\n  var opName = it.toOpName(operation.name);\n  var safe = it.safeOperation(operation, it.camelCaseName);\n  var queryOperation = Object.assign({}, safe, {\n    rqOpName: 'use' + opName,\n    opKey: it.camelCaseName + opName,\n    clientName: it.camelCaseName,\n    httpClientName: httpClientPrefix,\n    httpConfigType: it.httpConfigType,\n    responseMapper: it.responseMapper,\n    returnType: it.prefixApiType(safe.returnType),\n    parameters: safe.parameters.map(function(p) {\n      return Object.assign({}, p, { type: it.prefixApiType(p.type) });\n    }),\n  });\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 safe = it.safeOperation(operation, it.camelCaseName);\n  var mutationOperation = Object.assign({}, safe, {\n    mutOpName: 'use' + opName,\n    clientName: it.camelCaseName,\n    httpClientName: httpClientPrefix,\n    httpConfigType: it.httpConfigType,\n    responseMapper: it.responseMapper,\n    returnType: it.prefixApiType(safe.returnType),\n    parameters: safe.parameters.map(function(p) {\n      return Object.assign({}, p, { type: it.prefixApiType(p.type) });\n    }),\n  });\n%>\n<%~ include('mutationOperation.ejs', mutationOperation); %>\n\n<% }); %>\n  },\n\n  queryKeys: {\n<% getOperations.forEach((operation) => {\n  var opName = it.toOpName(operation.name);\n  var keyName = opName.charAt(0).toLowerCase() + opName.slice(1);\n  var safeOp = it.safeOperation(operation, it.camelCaseName);\n  var prefixedParams = safeOp.parameters.map(function(p) {\n    return Object.assign({}, p, { type: it.prefixApiType(p.type) });\n  });\n%>\n    <%= keyName %>: (<% prefixedParams.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",
+    "client.ejs": "export const <%= it.camelCaseName %>Client = {\n  <% it.operations.forEach((operation) => { %>\n<%~ include('operation.ejs', operation); %>\n\n<% }); %>\n};\n\n<% if (!it.splitMode) { %>\n<%\nvar getOperations = it.operations.filter((o) => o.method === 'GET');\nvar mutationOperations = it.operations.filter((o) => o.method !== 'GET');\n%>\n\nexport const <%= it.hooksCamelCaseName %> = {\n  queries: {\n<% getOperations.forEach((operation) => {\n  var opName = it.toOpName(operation.name);\n  var queryOperation = Object.assign({\n    rqOpName: 'use' + opName,\n    opKey: it.hooksCamelCaseName + opName,\n    clientName: it.hooksCamelCaseName,\n    httpClientName: it.camelCaseName,\n    httpConfigType: it.httpConfigType,\n    responseMapper: it.responseMapper,\n  }, it.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.hooksCamelCaseName,\n    httpClientName: it.camelCaseName,\n    httpConfigType: it.httpConfigType,\n    responseMapper: it.responseMapper,\n  }, it.safeOperation(operation, it.camelCaseName));\n%>\n<%~ include('mutationOperation.ejs', mutationOperation); %>\n\n<% }); %>\n  },\n\n  queryKeys: {\n<% getOperations.forEach((operation) => {\n  var opName = it.toOpName(operation.name);\n  var keyName = opName.charAt(0).toLowerCase() + opName.slice(1);\n  var safeOp = it.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.hooksCamelCaseName %>', '<%= it.hooksCamelCaseName + opName %>'<% safeOp.parameters.forEach((parameter) => { %>, <%= parameter.name %><% }); %>] as const,\n<% }); %>\n  },\n};\n<% } /* end !splitMode */ %>\n",
+    "hooksClient.ejs": "<%\nvar getOperations = it.operations.filter((o) => o.method === 'GET');\nvar mutationOperations = it.operations.filter((o) => o.method !== 'GET');\nvar httpClientPrefix = 'API.' + it.camelCaseName;\n%>\n\nexport const <%= it.hooksCamelCaseName %> = {\n  queries: {\n<% getOperations.forEach((operation) => {\n  var opName = it.toOpName(operation.name);\n  var safe = it.safeOperation(operation, it.camelCaseName);\n  var queryOperation = Object.assign({}, safe, {\n    rqOpName: 'use' + opName,\n    opKey: it.hooksCamelCaseName + opName,\n    clientName: it.hooksCamelCaseName,\n    httpClientName: httpClientPrefix,\n    httpConfigType: it.httpConfigType,\n    responseMapper: it.responseMapper,\n    returnType: it.prefixApiType(safe.returnType),\n    parameters: safe.parameters.map(function(p) {\n      return Object.assign({}, p, { type: it.prefixApiType(p.type) });\n    }),\n  });\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 safe = it.safeOperation(operation, it.camelCaseName);\n  var mutationOperation = Object.assign({}, safe, {\n    mutOpName: 'use' + opName,\n    clientName: it.hooksCamelCaseName,\n    httpClientName: httpClientPrefix,\n    httpConfigType: it.httpConfigType,\n    responseMapper: it.responseMapper,\n    returnType: it.prefixApiType(safe.returnType),\n    parameters: safe.parameters.map(function(p) {\n      return Object.assign({}, p, { type: it.prefixApiType(p.type) });\n    }),\n  });\n%>\n<%~ include('mutationOperation.ejs', mutationOperation); %>\n\n<% }); %>\n  },\n\n  queryKeys: {\n<% getOperations.forEach((operation) => {\n  var opName = it.toOpName(operation.name);\n  var keyName = opName.charAt(0).toLowerCase() + opName.slice(1);\n  var safeOp = it.safeOperation(operation, it.camelCaseName);\n  var prefixedParams = safeOp.parameters.map(function(p) {\n    return Object.assign({}, p, { type: it.prefixApiType(p.type) });\n  });\n%>\n    <%= keyName %>: (<% prefixedParams.forEach((parameter) => { %><%= parameter.name %><%= parameter.skippable ? '?' : '' %>: <%~ parameter.type %><%= parameter.optional ? (parameter.skippable ? ' | null' : ' | null | undefined') : '' %>, <% }); %>) => ['<%= it.hooksCamelCaseName %>', '<%= it.hooksCamelCaseName + 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 HTTP client configuration (passed to the underlying ' + it.httpConfigType + ')';\nvar rawDocs = it.jsDocs\n  ? it.jsDocs.replace(/(\\s*)\\*\\/\\s*$/, '\\n' + baseAdditionalParams + '\\n */')\n  : '';\nvar docs = rawDocs ? rawDocs.replace(/^/gm, '  ') + '\\n' : '';\nvar httpClientName = it.httpClientName || it.clientName;\n%>\n<%~ docs %>\n    <%= it.mutOpName %><TData = <%~ it.returnType %>, TError = Error>(\n      $config?: UseMutationOptions<<%~ it.returnType %>, TError, <%~ variablesType %>>,\n      $httpConfig?: <%= it.httpConfigType %>\n    ) {\n      return useMutation<<%~ it.returnType %>, TError, <%~ variablesType %>>({\n        mutationFn: (<%= hasParams ? 'vars' : '' %>) => <%= httpClientName %>Client.<%= it.name %>(<%= callArgs.join(', ') %><%= callArgs.length > 0 ? ', ' : '' %>$httpConfig)<%~ it.responseMapper %>,\n        ...$config\n      });\n    },\n",
     "queryOperation.ejs": "<%\nvar baseAdditionalParams = '  * @param $config (optional) Additional configuration for TanStack Query\\n  * @param $httpConfig (optional) Additional HTTP client configuration (passed to the underlying ' + it.httpConfigType + ')';\nvar rawDocs = it.jsDocs\n  ? it.jsDocs.replace(/(\\s*)\\*\\/\\s*$/, '\\n' + baseAdditionalParams + '\\n */')\n  : '';\nvar docs = rawDocs ? rawDocs.replace(/^/gm, '  ') + '\\n' : '';\nvar httpClientName = it.httpClientName || it.clientName;\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?: <%= it.httpConfigType %>\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: () => <%= httpClientName %>Client.<%= it.name %>(<% it.parameters.forEach((parameter) => { %><%= parameter.name %>, <% }); %>$httpConfig)<%~ it.responseMapper %>,\n        ...$config\n      });\n    },\n"
   },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swaggie",
-  "version": "2.1.1",
+  "version": "2.1.3",
   "description": "Generate a fully typed TypeScript API client from your OpenAPI 3 spec",
   "author": {
     "name": "Piotr Dabrowski",
@@ -41,7 +41,7 @@
     "bundle-templates": "bun scripts/bundle-templates.ts",
     "rm-tests": "find dist/ \\( -name '*.spec.js' -o -name 'types.js' \\) -type f -delete",
     "types": "tsc --project tsconfig.types.json && cp test/index.d.ts ./dist/",
-    "docs:build": "vitepress build docs",
+    "docs:build": "cp schema.json docs/public/schema.json && vitepress build docs",
     "docs:dev": "vitepress dev docs",
     "docs:preview": "vitepress preview docs"
   },
@@ -72,16 +72,16 @@
   "dependencies": {
     "case": "^1.6.3",
     "commander": "^14.0.3",
-    "eta": "^4.5.1",
+    "eta": "^4.6.0",
     "yaml": "^2.8.3",
     "picocolors": "^1.1.1"
   },
   "devDependencies": {
-    "bun-types": "1.3.11",
+    "bun-types": "1.3.13",
     "openapi-types": "^12.1.3",
     "sucrase": "3.35.1",
-    "typescript": "6.0.2",
+    "typescript": "6.0.3",
     "vitepress": "^2.0.0-alpha.17",
-    "vitepress-plugin-tabs": "0.8.0"
+    "vitepress-plugin-tabs": "0.9.0"
   }
 }

package/templates/swr/client.ejs

@@ -11,13 +11,14 @@ var getOperations = it.operations.filter((o) => o.method === 'GET');
 var mutationOperations = it.operations.filter((o) => o.method !== 'GET');
 %>
 
-export const <%= it.camelCaseName %> = {
+export const <%= it.hooksCamelCaseName %> = {
   queries: {
 <% getOperations.forEach((operation) => {
   var opName = it.toOpName(operation.name);
   var swrOperation = Object.assign({
     swrOpName: 'use' + opName,
-    clientName: it.camelCaseName,
+    clientName: it.hooksCamelCaseName,
+    httpClientName: it.camelCaseName,
     httpConfigType: it.httpConfigType,
     responseMapper: it.responseMapper,
   }, it.safeOperation(operation, it.camelCaseName));
@@ -32,7 +33,8 @@ export const <%= it.camelCaseName %> = {
   var opName = operation.name.charAt(0).toUpperCase() + operation.name.slice(1);
   var swrMutationOperation = Object.assign({
     mutOpName: 'use' + opName,
-    clientName: it.camelCaseName,
+    clientName: it.hooksCamelCaseName,
+    httpClientName: it.camelCaseName,
     httpConfigType: it.httpConfigType,
     responseMapper: it.responseMapper,
   }, it.safeOperation(operation, it.camelCaseName));

package/templates/swr/hooksClient.ejs

@@ -4,14 +4,14 @@ var mutationOperations = it.operations.filter((o) => o.method !== 'GET');
 var httpClientPrefix = 'API.' + it.camelCaseName;
 %>
 
-export const <%= it.camelCaseName %> = {
+export const <%= it.hooksCamelCaseName %> = {
   queries: {
 <% getOperations.forEach((operation) => {
   var opName = it.toOpName(operation.name);
   var safe = it.safeOperation(operation, it.camelCaseName);
   var swrOperation = Object.assign({}, safe, {
     swrOpName: 'use' + opName,
-    clientName: it.camelCaseName,
+    clientName: it.hooksCamelCaseName,
     httpClientName: httpClientPrefix,
     httpConfigType: it.httpConfigType,
     responseMapper: it.responseMapper,
@@ -32,7 +32,7 @@ export const <%= it.camelCaseName %> = {
   var safe = it.safeOperation(operation, it.camelCaseName);
   var swrMutationOperation = Object.assign({}, safe, {
     mutOpName: 'use' + opName,
-    clientName: it.camelCaseName,
+    clientName: it.hooksCamelCaseName,
     httpClientName: httpClientPrefix,
     httpConfigType: it.httpConfigType,
     responseMapper: it.responseMapper,

package/templates/swr/swrMutationOperation.ejs

@@ -26,7 +26,7 @@ var httpClientName = it.httpClientName || it.clientName;
     ) {
       return useSWRMutation<<%~ it.returnType %>, Error, string, <%~ variablesType %>>(
         '<%= swrKey %>',
-        (_key: string, { arg }<%= hasParams ? ': { arg: ' + variablesType + ' }' : '' %>) =>
+        (_key: string, { arg }<%~ hasParams ? ': { arg: ' + variablesType + ' }' : '' %>) =>
           <%= httpClientName %>Client.<%= it.name %>(<%= callArgs.join(', ') %><%= callArgs.length > 0 ? ', ' : '' %>$httpConfig)<%~ it.responseMapper %>,
         $config
       );

package/templates/tsq/client.ejs

@@ -11,14 +11,15 @@ var getOperations = it.operations.filter((o) => o.method === 'GET');
 var mutationOperations = it.operations.filter((o) => o.method !== 'GET');
 %>
 
-export const <%= it.camelCaseName %> = {
+export const <%= it.hooksCamelCaseName %> = {
   queries: {
 <% getOperations.forEach((operation) => {
   var opName = it.toOpName(operation.name);
   var queryOperation = Object.assign({
     rqOpName: 'use' + opName,
-    opKey: it.camelCaseName + opName,
-    clientName: it.camelCaseName,
+    opKey: it.hooksCamelCaseName + opName,
+    clientName: it.hooksCamelCaseName,
+    httpClientName: it.camelCaseName,
     httpConfigType: it.httpConfigType,
     responseMapper: it.responseMapper,
   }, it.safeOperation(operation, it.camelCaseName));
@@ -33,7 +34,8 @@ export const <%= it.camelCaseName %> = {
   var opName = operation.name.charAt(0).toUpperCase() + operation.name.slice(1);
   var mutationOperation = Object.assign({
     mutOpName: 'use' + opName,
-    clientName: it.camelCaseName,
+    clientName: it.hooksCamelCaseName,
+    httpClientName: it.camelCaseName,
     httpConfigType: it.httpConfigType,
     responseMapper: it.responseMapper,
   }, it.safeOperation(operation, it.camelCaseName));
@@ -49,7 +51,7 @@ export const <%= it.camelCaseName %> = {
   var keyName = opName.charAt(0).toLowerCase() + opName.slice(1);
   var safeOp = it.safeOperation(operation, it.camelCaseName);
 %>
-    <%= 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,
+    <%= keyName %>: (<% safeOp.parameters.forEach((parameter) => { %><%= parameter.name %><%= parameter.skippable ? '?' : '' %>: <%~ parameter.type %><%= parameter.optional ? (parameter.skippable ? ' | null' : ' | null | undefined') : '' %>, <% }); %>) => ['<%= it.hooksCamelCaseName %>', '<%= it.hooksCamelCaseName + opName %>'<% safeOp.parameters.forEach((parameter) => { %>, <%= parameter.name %><% }); %>] as const,
 <% }); %>
   },
 };

package/templates/tsq/hooksClient.ejs

@@ -4,15 +4,15 @@ var mutationOperations = it.operations.filter((o) => o.method !== 'GET');
 var httpClientPrefix = 'API.' + it.camelCaseName;
 %>
 
-export const <%= it.camelCaseName %> = {
+export const <%= it.hooksCamelCaseName %> = {
   queries: {
 <% getOperations.forEach((operation) => {
   var opName = it.toOpName(operation.name);
   var safe = it.safeOperation(operation, it.camelCaseName);
   var queryOperation = Object.assign({}, safe, {
     rqOpName: 'use' + opName,
-    opKey: it.camelCaseName + opName,
-    clientName: it.camelCaseName,
+    opKey: it.hooksCamelCaseName + opName,
+    clientName: it.hooksCamelCaseName,
     httpClientName: httpClientPrefix,
     httpConfigType: it.httpConfigType,
     responseMapper: it.responseMapper,
@@ -33,7 +33,7 @@ export const <%= it.camelCaseName %> = {
   var safe = it.safeOperation(operation, it.camelCaseName);
   var mutationOperation = Object.assign({}, safe, {
     mutOpName: 'use' + opName,
-    clientName: it.camelCaseName,
+    clientName: it.hooksCamelCaseName,
     httpClientName: httpClientPrefix,
     httpConfigType: it.httpConfigType,
     responseMapper: it.responseMapper,
@@ -57,7 +57,7 @@ export const <%= it.camelCaseName %> = {
     return Object.assign({}, p, { type: it.prefixApiType(p.type) });
   });
 %>
-    <%= keyName %>: (<% prefixedParams.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,
+    <%= keyName %>: (<% prefixedParams.forEach((parameter) => { %><%= parameter.name %><%= parameter.skippable ? '?' : '' %>: <%~ parameter.type %><%= parameter.optional ? (parameter.skippable ? ' | null' : ' | null | undefined') : '' %>, <% }); %>) => ['<%= it.hooksCamelCaseName %>', '<%= it.hooksCamelCaseName + opName %>'<% safeOp.parameters.forEach((parameter) => { %>, <%= parameter.name %><% }); %>] as const,
 <% }); %>
   },
 };