swaggie 2.2.0 → 2.2.2

package/dist/gen/genMocks.js

@@ -48,10 +48,7 @@ const MOCK_FILE_HEADER = `\
   const template = options.template;
 
   if (template === 'ng1') {
-    throw new Error(
-      'Mock generation is not supported for the "ng1" template. ' +
-        'Use "ng2", "axios", "fetch", "xior", "swr", or "tsq" instead.'
-    );
+    throw new Error('Mock generation is not supported for the "ng1" template');
   }
 
   const isNg2 = template === 'ng2';
@@ -254,28 +251,34 @@ interface MockSWRReturn {
   data: unknown;
   /** Whether to return a loading state (default: false) */
   isLoading?: boolean;
+  /** Whether to return a validating state (default: false) */
+  isValidating?: boolean;
   /** Whether to return an error (default: undefined) */
   error?: Error | undefined | null;
+  /** The mutate function to return (default: empty mock) */
+  mutate?: KeyedMutator<any>;
 }
 
 interface MockSWRMutationReturn {
   /** The data to return from the mock */
-  data: unknown;
+  data?: unknown;
   /** Whether to return a mutating state (default: false) */
   isMutating?: boolean;
   /** Whether to return an error (default: undefined) */
   error?: Error | undefined | null;
+  /** The trigger function to return (default: empty mock) */
+  trigger?: (...args: unknown[]) => Promise<unknown>;
+  /** The reset function to return (default: empty mock) */
+  reset?: () => void;
 }
 
 /** Augments a spy with a \`mockSWR\` shorthand for useSWR query hooks. */
 function withMockSWR<Fn extends (...args: never[]) => unknown>(spy: ${ref}.SpiedFunction<Fn>) {
   return Object.assign(spy, {
-    mockSWR({ data, isLoading, error }: MockSWRReturn) {
+    mockSWR({ ...rest }: MockSWRReturn) {
       spy.mockReturnValue({
         ...defaultSWRReturn,
-        data,
-        isLoading: isLoading ?? false,
-        error: error ?? undefined,
+        ...rest,
       } as ReturnType<Fn>);
     },
   });
@@ -286,15 +289,13 @@ function withMockSWRMutation<Fn extends (...args: never[]) => unknown>(spy: ${re
   return Object.assign(spy, {
     mockSWRMutation({
       data,
-      isMutating,
-      error,
+      ...rest
     }: MockSWRMutationReturn) {
       spy.mockReturnValue({
         ...defaultSWRMutationReturn,
         trigger: ${ref}.fn(() => Promise.resolve(undefined)),
-        isMutating: isMutating ?? false,
-        error: error ?? undefined,
         data,
+        ...rest,
       } as ReturnType<Fn>);
     },
   });

package/dist/generated/bundledTemplates.js

@@ -41,7 +41,7 @@
     "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"
+    "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, isValidating, 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, isValidating, error, mutate };\n    },\n"
   },
   "tsq": {
     "baseClient.ejs": "import { type UseQueryOptions, type UseMutationOptions, useQuery, useMutation } from '@tanstack/react-query';\n",

package/package.json

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

package/templates/swr/swrOperation.ejs

@@ -9,11 +9,11 @@
       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 %>>(
+      const { data, error, isLoading, isValidating, mutate } = useSWR<<%~ it.returnType %>>(
         cacheUrl,
         () => <%= httpClientName %>Client.<%= it.name %>(<% it.parameters.forEach((parameter) => { %><%= parameter.name %>, <% }); %>$httpConfig)<%~ it.responseMapper %>,
         config
       );
 
-      return { data, isLoading, error, mutate };
+      return { data, isLoading, isValidating, error, mutate };
     },