swaggie 2.1.3 → 2.2.0

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/gen/genMocks.js

@@ -67,8 +67,13 @@ const MOCK_FILE_HEADER = `\
     .map((name) => {
       const fullName = servicePrefix + name;
       const camelName = _case.camel.call(void 0, fullName);
+      // `default` is a JS reserved word and cannot be used as a standalone
+      // `export const` identifier. The hooks templates rename it to `main`
+      // (see genOperations.ts — hooksCamelCaseName). Mock code that references
+      // the hooks namespace must use the same safe name.
+      const hooksCamelName = camelName === 'default' ? 'main' : camelName;
       const ops = _genOperations.prepareOperations.call(void 0, groups[name], options, spec.components);
-      return { name, camelName, ops };
+      return { name, camelName, hooksCamelName, ops };
     })
     .filter((g) => g.ops.length > 0);
 
@@ -399,16 +404,16 @@ function buildCreateSwrHookMocks(
   const spy = spyFn(fw);
   const lines = ['export function createApiHookMocks() {', '  return {'];
 
-  for (const { camelName, ops } of groups) {
+  for (const { hooksCamelName, ops } of groups) {
     const getOps = ops.filter((o) => o.method === 'GET');
     const mutOps = ops.filter((o) => o.method !== 'GET');
 
-    lines.push(`    ${camelName}: {`);
+    lines.push(`    ${hooksCamelName}: {`);
     lines.push('      queries: {');
     for (const op of getOps) {
       const hookName = toHookName(op.name, 'use');
       lines.push(
-        `        ${hookName}: withMockSWR(${spy}(${hooksAlias}.${camelName}.queries, '${hookName}').mockReturnValue(defaultSWRReturn)),`
+        `        ${hookName}: withMockSWR(${spy}(${hooksAlias}.${hooksCamelName}.queries, '${hookName}').mockReturnValue(defaultSWRReturn)),`
       );
     }
     lines.push('      },');
@@ -416,7 +421,7 @@ function buildCreateSwrHookMocks(
     for (const op of mutOps) {
       const hookName = 'use' + _case.pascal.call(void 0, op.name);
       lines.push(
-        `        ${hookName}: withMockSWRMutation(${spy}(${hooksAlias}.${camelName}.mutations, '${hookName}').mockReturnValue(defaultSWRMutationReturn as any)),`
+        `        ${hookName}: withMockSWRMutation(${spy}(${hooksAlias}.${hooksCamelName}.mutations, '${hookName}').mockReturnValue(defaultSWRMutationReturn as any)),`
       );
     }
     lines.push('      },');
@@ -436,16 +441,16 @@ function buildCreateTsqHookMocks(
   const spy = spyFn(fw);
   const lines = ['export function createApiHookMocks() {', '  return {'];
 
-  for (const { camelName, ops } of groups) {
+  for (const { hooksCamelName, ops } of groups) {
     const getOps = ops.filter((o) => o.method === 'GET');
     const mutOps = ops.filter((o) => o.method !== 'GET');
 
-    lines.push(`    ${camelName}: {`);
+    lines.push(`    ${hooksCamelName}: {`);
     lines.push('      queries: {');
     for (const op of getOps) {
       const hookName = toHookName(op.name, 'use');
       lines.push(
-        `        ${hookName}: withMockQuery(${spy}(${hooksAlias}.${camelName}.queries, '${hookName}').mockReturnValue(defaultQueryReturn as any)),`
+        `        ${hookName}: withMockQuery(${spy}(${hooksAlias}.${hooksCamelName}.queries, '${hookName}').mockReturnValue(defaultQueryReturn as any)),`
       );
     }
     lines.push('      },');
@@ -453,7 +458,7 @@ function buildCreateTsqHookMocks(
     for (const op of mutOps) {
       const hookName = 'use' + _case.pascal.call(void 0, op.name);
       lines.push(
-        `        ${hookName}: withMockMutation(${spy}(${hooksAlias}.${camelName}.mutations, '${hookName}').mockReturnValue(defaultMutationReturn as any)),`
+        `        ${hookName}: withMockMutation(${spy}(${hooksAlias}.${hooksCamelName}.mutations, '${hookName}').mockReturnValue(defaultMutationReturn as any)),`
       );
     }
     lines.push('      },');

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.3",
+  "version": "2.2.0",
   "description": "Generate a fully typed TypeScript API client from your OpenAPI 3 spec",
   "author": {
     "name": "Piotr Dabrowski",
@@ -73,11 +73,11 @@
     "case": "^1.6.3",
     "commander": "^14.0.3",
     "eta": "^4.6.0",
-    "yaml": "^2.8.3",
+    "yaml": "^2.9.0",
     "picocolors": "^1.1.1"
   },
   "devDependencies": {
-    "bun-types": "1.3.13",
+    "bun-types": "1.3.14",
     "openapi-types": "^12.1.3",
     "sucrase": "3.35.1",
     "typescript": "6.0.3",