swaggie 2.1.4 → 2.2.1

package/README.md

@@ -543,4 +543,5 @@ function error(e) {
 <a href="https://www.britishcouncil.org"><img alt="British Council" src="./docs/public/used-in/bc-logo.png" /></a>
 <a href="https://kpmg.com/"><img alt="KPMG" src="./docs/public/used-in/kpmg-logo.png" /></a>
 <a href="https://klarna.com/"><img alt="Klarna" src="./docs/public/used-in/klarna-logo.png" /></a>
+<a href="https://cribl.io/"><img alt="Cribl" src="./docs/public/used-in/cribl-logo.png" /></a>
 </div>

package/dist/cli.js

@@ -131,12 +131,18 @@ const options = program.opts();
 
 _index.runCodeGenerator.call(void 0, options ).then(complete, error);
 
-function complete([code, opts]) {
-  if (opts.out) {
-    const from = typeof opts.src === 'string' ? `from ${_picocolors.bold.call(void 0, opts.src)} ` : '';
-    console.info(_picocolors.cyan.call(void 0, `Api ${from}code generated into ${_picocolors.bold.call(void 0, opts.out)}`));
-  } else {
-    console.log(code);
+function complete(result) {
+  const results = Array.isArray(result[0])
+    ? (result )
+    : [result ];
+
+  for (const [code, opts] of results) {
+    if (opts.out) {
+      const from = typeof opts.src === 'string' ? `from ${_picocolors.bold.call(void 0, opts.src)} ` : '';
+      console.info(_picocolors.cyan.call(void 0, `Api ${from}code generated into ${_picocolors.bold.call(void 0, opts.out)}`));
+    } else {
+      console.log(code);
+    }
   }
 
   process.exit(0);

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/dist/index.js

@@ -3,23 +3,47 @@
 
 var _gen = require('./gen'); var _gen2 = _interopRequireDefault(_gen);
 
+
+
+
+
+
+
+
 var _utils = require('./utils');
 var _templateValidator = require('./utils/templateValidator');
 var _swagger = require('./swagger');
 
 /**
  * Runs the whole code generation process.
- * @returns `CodeGenResult`
+ * When the config file contains an array of configs, returns `BatchCodeGenResult`
+ * (an array of results, one per entry, fail-fast on first error).
+ * Otherwise returns a single `CodeGenResult`.
  **/
- async function runCodeGenerator(options) {
+ async function runCodeGenerator(
+  options
+) {
   try {
     verifyOptions(options);
-    const opts = await applyConfigFile(options);
-    const spec = await _utils.loadSpecDocument.call(void 0, opts.src);
+    const optsOrArray = await applyConfigFile(options);
+
+    if (Array.isArray(optsOrArray)) {
+      const results = [];
+      for (const opts of optsOrArray) {
+        verifyEntryOptions(opts);
+        const spec = await _utils.loadSpecDocument.call(void 0, opts.src);
+        const verifiedSpec = _utils.verifyDocumentSpec.call(void 0, spec);
+        const code = await gen(verifiedSpec, opts);
+        results.push([code, opts]);
+      }
+      return results;
+    }
+
+    const spec = await _utils.loadSpecDocument.call(void 0, optsOrArray.src);
     const verifiedSpec = _utils.verifyDocumentSpec.call(void 0, spec);
-    const code = await gen(verifiedSpec, opts);
+    const code = await gen(verifiedSpec, optsOrArray);
 
-    return [code, opts];
+    return [code, optsOrArray];
   } catch (e) {
     return Promise.reject(e);
   }
@@ -64,6 +88,82 @@ function verifyOptions(options) {
   }
 }
 
+/**
+ * Validates options that apply to each individual entry in an array config.
+ * Covers the same constraints as `verifyOptions` but scoped to a single
+ * fully-resolved `AppOptions` entry (after config merging and defaults).
+ */
+function verifyEntryOptions(opts) {
+  if (!opts.src) {
+    throw new Error('Each config entry must have "src" set');
+  }
+  if (!!opts.mocks !== !!opts.testingFramework) {
+    throw new Error('--mocks and --testingFramework must be used together');
+  }
+  if (opts.mocks && !opts.out) {
+    throw new Error(
+      '"mocks" requires "out" to be set, since the mock file needs to import the generated client'
+    );
+  }
+  if (opts.hooksOut && !opts.out) {
+    throw new Error('"hooksOut" requires "out" to be set');
+  }
+  if (opts.clientSetup && !opts.out) {
+    throw new Error('"clientSetup" requires "out" to be set');
+  }
+  if (opts.forceSetup && !opts.clientSetup) {
+    throw new Error('"forceSetup" requires "clientSetup" to be set');
+  }
+  if (opts.hooksOut) {
+    const tpl = opts.template;
+    const isL2 =
+      (typeof tpl === 'string' && _templateValidator.isL2Template.call(void 0, tpl)) ||
+      (Array.isArray(tpl) && typeof tpl[0] === 'string' && _templateValidator.isL2Template.call(void 0, tpl[0]));
+    if (!isL2) {
+      throw new Error(
+        '"hooksOut" requires an L2 template (swr, tsq). ' +
+          'Reactive hooks are only generated for L2 template pairs.'
+      );
+    }
+  }
+}
+
+/**
+ * Throws if any per-entry-only keys are present as top-level defaults in a
+ * multi-config file. These keys must live inside each entry under "configs".
+ */
+function verifyTopLevelDefaults(configUrl, defaults) {
+  const blocked = ['src', 'out', 'hooksOut', 'mocks', 'clientSetup'];
+  for (const key of blocked) {
+    if (key in defaults) {
+      throw new Error(
+        `"${key}" cannot be a top-level default in multi-config file "${configUrl}". ` +
+          `Set it inside each entry under "configs" instead.`
+      );
+    }
+  }
+}
+
+/**
+ * Throws if any file-path CLI flags are combined with a multi-config file.
+ * Each entry in "configs" must define its own output paths.
+ */
+function verifyOptionsForArrayConfig(options) {
+  const blocked = [
+    ['out', '--out'],
+    ['hooksOut', '--hooksOut'],
+    ['mocks', '--mocks'],
+    ['clientSetup', '--clientSetup'],
+  ];
+  for (const [key, flag] of blocked) {
+    if (options[key]) {
+      throw new Error(
+        `${flag} cannot be used with a multi-config file. Set "${key}" in each entry under "configs" instead.`
+      );
+    }
+  }
+}
+
 function gen(spec, options) {
   if (options.generationMode === 'full') {
     _templateValidator.validateTemplate.call(void 0, options.template);
@@ -76,25 +176,49 @@ function gen(spec, options) {
  async function applyConfigFile(
   options
 ) {
+  if (!options.config) {
+    return prepareAppOptions(options );
+  }
+
+  const configUrl = options.config;
+  let configContents;
+  let parsedConfig;
+
   try {
-    if (!options.config) {
-      return prepareAppOptions(options );
-    }
+    configContents = await readFile(configUrl);
+    parsedConfig = JSON.parse(configContents);
+  } catch (_e) {
+    return Promise.reject(
+      new Error('Could not correctly load config file. It does not exist or you cannot access it')
+    );
+  }
 
-    const configUrl = options.config;
-    const configContents = await readFile(configUrl);
-    const parsedConfig = JSON.parse(configContents);
-    if (!parsedConfig || parsedConfig.length < 1) {
-      throw new Error(
-        `Could not correctly parse config file from "${configUrl}". Is it a valid JSON file?`
-      );
-    }
-    return prepareAppOptions({ ...parsedConfig, ...options });
-  } catch (e) {
+  if (!parsedConfig || typeof parsedConfig !== 'object') {
     return Promise.reject(
       new Error('Could not correctly load config file. It does not exist or you cannot access it')
     );
   }
+
+  if ('configs' in (parsedConfig )) {
+    const { configs: entries, ...topLevelDefaults } = parsedConfig 
+
+
+;
+    if (!Array.isArray(entries) || entries.length < 1) {
+      return Promise.reject(
+        new Error(
+          `Config file "${configUrl}" has a "configs" key but it is not a non-empty array. Provide at least one config entry.`
+        )
+      );
+    }
+    verifyTopLevelDefaults(configUrl, topLevelDefaults);
+    verifyOptionsForArrayConfig(options);
+    return entries.map((entry) =>
+      prepareAppOptions({ ...topLevelDefaults, ...entry, ...options })
+    );
+  }
+
+  return prepareAppOptions({ ...parsedConfig, ...options } );
 } exports.applyConfigFile = applyConfigFile;
 
 function readFile(filePath) {
@@ -103,7 +227,7 @@ function readFile(filePath) {
   });
 }
 
-
+;
 
 /**
  * CLI options are flat, but within the app we use nested objects.

package/dist/types.d.ts

@@ -171,6 +171,11 @@ export interface AppOptions extends ClientOptions {
     mocks?: string;
     testingFramework?: TestingFramework;
 }
+export type CodeGenResult = [string, AppOptions];
+/**
+ * Result of a batch run — one entry per config in the array.
+ */
+export type BatchCodeGenResult = CodeGenResult[];
 /**
  * Local type that represent Operation as understood by Swaggie
  **/

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swaggie",
-  "version": "2.1.4",
+  "version": "2.2.1",
   "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 };
     },