@vc-shell/api-client-generator 2.0.0-alpha.23 → 2.0.0-alpha.25

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+# [2.0.0-alpha.25](https://github.com/VirtoCommerce/vc-shell/compare/v2.0.0-alpha.24...v2.0.0-alpha.25) (2026-03-25)
+
+**Note:** Version bump only for package @vc-shell/api-client-generator
+
+# [2.0.0-alpha.24](https://github.com/VirtoCommerce/vc-shell/compare/v2.0.0-alpha.23...v2.0.0-alpha.24) (2026-03-25)
+
+
+### Features
+
+* **api-client, migrate:** default to Interface for new API clients, add nswag class-to-interface migration ([569a1f7](https://github.com/VirtoCommerce/vc-shell/commit/569a1f79532d5ca2e1a9968e3b249b3d3ffeed71))
 # [2.0.0-alpha.23](https://github.com/VirtoCommerce/vc-shell/compare/v2.0.0-alpha.22...v2.0.0-alpha.23) (2026-03-23)
 
 **Note:** Version bump only for package @vc-shell/api-client-generator

package/dist/api-client-generator.js

@@ -1,21 +1,21 @@
 import e from "chalk";
-import { sync as k } from "cross-spawn";
-import { resolveConfig as I } from "vite";
-import { existsSync as A, mkdirSync as B, writeFileSync as x, readFileSync as T } from "node:fs";
-import m, { dirname as R, resolve as S, join as b, relative as C } from "node:path";
-import { fileURLToPath as j } from "node:url";
-import { cwd as O } from "node:process";
-import N from "mri";
-const M = j(import.meta.url), L = R(M);
-class U {
+import { sync as v } from "cross-spawn";
+import { resolveConfig as j } from "vite";
+import { existsSync as w, mkdirSync as I, writeFileSync as T, readdirSync as O, readFileSync as x } from "node:fs";
+import m, { dirname as N, resolve as B, join as b, relative as S } from "node:path";
+import { fileURLToPath as L } from "node:url";
+import { cwd as M } from "node:process";
+import U from "mri";
+const $ = L(import.meta.url), F = N($);
+class V {
   workingDirectory;
   generatorDirectory;
   assetsDirectory;
   apiClientDirectory;
   nswagPaths;
   constructor(r) {
-    this.workingDirectory = O(), this.generatorDirectory = S(L, ".."), this.assetsDirectory = b(this.generatorDirectory, "public", "assets"), this.apiClientDirectory = S(this.workingDirectory, r), this.nswagPaths = {
-      configuration: b(C(this.workingDirectory, this.assetsDirectory), "config.nswag"),
+    this.workingDirectory = M(), this.generatorDirectory = B(F, ".."), this.assetsDirectory = b(this.generatorDirectory, "public", "assets"), this.apiClientDirectory = B(this.workingDirectory, r), this.nswagPaths = {
+      configuration: b(S(this.workingDirectory, this.assetsDirectory), "config.nswag"),
       authApiBase: "authApiBase.ts",
       templates: "templates"
     };
@@ -24,12 +24,12 @@ class U {
     const n = `${r.toLowerCase()}.ts`;
     return {
       fileName: n,
-      nswag: b(C(this.assetsDirectory, this.apiClientDirectory), n),
-      console: b(C(this.workingDirectory, this.apiClientDirectory), n)
+      nswag: b(S(this.assetsDirectory, this.apiClientDirectory), n),
+      console: b(S(this.workingDirectory, this.apiClientDirectory), n)
     };
   }
 }
-function v(o, r, n = []) {
+function D(o, r, n = []) {
   const t = { ...o };
   for (const i of n)
     i in r && (t[i] = r[i]);
@@ -39,7 +39,7 @@ function v(o, r, n = []) {
   }
   return t;
 }
-function $(o, r, n, t) {
+function G(o, r, n, t) {
   const i = {
     extends: "@vc-shell/ts-config/tsconfig.json",
     compilerOptions: {
@@ -52,12 +52,12 @@ function $(o, r, n, t) {
     include: ["*.ts"]
   };
   let s = { ...i };
-  if (A(o))
+  if (w(o))
     try {
-      const a = T(o, "utf-8");
+      const a = x(o, "utf-8");
       try {
         const l = JSON.parse(a);
-        s = v(i, l), l.compilerOptions && typeof l.compilerOptions == "object" && (s.compilerOptions = {
+        s = D(i, l), l.compilerOptions && typeof l.compilerOptions == "object" && (s.compilerOptions = {
           ...i.compilerOptions,
           ...l.compilerOptions
         }, s.compilerOptions.outDir = t, s.compilerOptions.declarationDir = m.join(t, "types"));
@@ -109,10 +109,10 @@ function _(o) {
     fullName: n
   };
 }
-function D(o) {
+function R(o) {
   return _(o).coreName;
 }
-function F(o, r) {
+function K(o, r) {
   if (!o)
     return [];
   const n = [`./${o}`];
@@ -121,19 +121,19 @@ function F(o, r) {
 function P(o) {
   return o.replace(/\\/g, "/");
 }
-function V(o, r, n, t) {
+function Y(o, r, n, t) {
   const i = {}, s = /* @__PURE__ */ new Set();
   for (const d of o) {
     const g = _(d);
     if (!g.coreName) continue;
-    const h = g.fullName, c = P(`./${m.join(r, `${h}.js`)}`), y = P(`./${m.join(r, "types", `${h}.d.ts`)}`), u = { import: c, types: y }, f = F(g.coreName, g.prefix);
-    for (const w of f)
-      i[w] = u, t && console.log(
+    const y = g.fullName, c = P(`./${m.join(r, `${y}.js`)}`), h = P(`./${m.join(r, "types", `${y}.d.ts`)}`), u = { import: c, types: h }, f = K(g.coreName, g.prefix);
+    for (const A of f)
+      i[A] = u, t && console.log(
         "api-client-generator %s Generated standard export: %s -> { import: %s, types: %s }",
         e.blue("debug"),
-        e.whiteBright(w),
+        e.whiteBright(A),
         e.whiteBright(c),
-        e.whiteBright(y)
+        e.whiteBright(h)
       );
     s.add(g.coreName);
   }
@@ -150,8 +150,8 @@ function V(o, r, n, t) {
         );
         continue;
       }
-      const h = g;
-      if (!h.import || !h.types) {
+      const y = g;
+      if (!y.import || !y.types) {
         t && console.log(
           "api-client-generator %s Skipping existing export with missing import/types for key: %s",
           e.yellow("warning"),
@@ -161,22 +161,22 @@ function V(o, r, n, t) {
       }
       const c = E(d);
       if (!(!c || c === "."))
-        if (D(c), c in i)
+        if (R(c), c in i)
           t && console.log(
             "api-client-generator %s Existing export key '%s' was handled by new generation.",
             e.blue("debug"),
             e.whiteBright(c)
           );
         else {
-          const y = E(h.import), u = E(h.types);
+          const h = E(y.import), u = E(y.types);
           a[c] = {
-            import: P(`${y}.js`),
+            import: P(`${h}.js`),
             types: P(`${u}.d.ts`)
           }, t && console.log(
             "api-client-generator %s Preserved existing export: %s -> { import: %s, types: %s }",
             e.blue("debug"),
             e.whiteBright(c),
-            e.whiteBright(`${y}.js`),
+            e.whiteBright(`${h}.js`),
             e.whiteBright(`${u}.d.ts`)
           );
         }
@@ -189,15 +189,15 @@ function V(o, r, n, t) {
   }
   const p = Array.from(l.keys());
   if (p.length === 1) {
-    const d = p[0], g = l.get(d), h = P(`./${m.join(r, `${g}.js`)}`), c = P(`./${m.join(r, "types", `${g}.d.ts`)}`);
+    const d = p[0], g = l.get(d), y = P(`./${m.join(r, `${g}.js`)}`), c = P(`./${m.join(r, "types", `${g}.d.ts`)}`);
     a["."] = {
-      import: h,
+      import: y,
       types: c
     }, t && console.log(
       "api-client-generator %s Set root export for single module '%s': { import: %s, types: %s }",
       e.blue("debug"),
       e.whiteBright(g),
-      e.whiteBright(h),
+      e.whiteBright(y),
       e.whiteBright(c)
     );
   } else if (n && "." in n) {
@@ -207,11 +207,11 @@ function V(o, r, n, t) {
       if (g.import && g.types) {
         const c = _(g.import).coreName;
         if (c && p.includes(c)) {
-          const y = l.get(c), u = P(`./${m.join(r, `${y}.js`)}`), f = P(`./${m.join(r, "types", `${y}.d.ts`)}`);
+          const h = l.get(c), u = P(`./${m.join(r, `${h}.js`)}`), f = P(`./${m.join(r, "types", `${h}.d.ts`)}`);
           a["."] = { import: u, types: f }, t && console.log(
             "api-client-generator %s Preserved and standardized existing root export pointing to module '%s'",
             e.blue("debug"),
-            e.whiteBright(y)
+            e.whiteBright(h)
           );
         } else t && console.log(
           "api-client-generator %s Removed existing root export as it pointed to an unknown or unhandled module '%s'",
@@ -223,7 +223,7 @@ function V(o, r, n, t) {
   }
   return a;
 }
-function G(o, r, n) {
+function J(o, r, n) {
   const t = n.VERBOSE ?? !1, i = n.APP_BUILD_DIR ?? "dist", s = [];
   i && s.push(i), s.push("package.json");
   const a = {
@@ -238,12 +238,12 @@ function G(o, r, n) {
     }
   };
   let l = { ...a }, p, d, g;
-  if (A(o))
+  if (w(o))
     try {
-      const u = T(o, "utf-8");
+      const u = x(o, "utf-8");
       try {
         const f = JSON.parse(u);
-        typeof f.module == "string" && (d = f.module), typeof f.types == "string" && (g = f.types), l = v(a, f, [
+        typeof f.module == "string" && (d = f.module), typeof f.types == "string" && (g = f.types), l = D(a, f, [
           "name",
           "version",
           "description",
@@ -267,11 +267,11 @@ function G(o, r, n) {
     }
   else
     console.log("api-client-generator %s Creating new package.json", e.greenBright("success"));
-  l.exports = V(r, i, p, t);
-  const h = Object.keys(l.exports), c = /* @__PURE__ */ new Set();
-  for (const u of h) {
+  l.exports = Y(r, i, p, t);
+  const y = Object.keys(l.exports), c = /* @__PURE__ */ new Set();
+  for (const u of y) {
     if (u === ".") continue;
-    const f = D(u);
+    const f = R(u);
     f && c.add(f);
   }
   if (Array.from(c).length, l.exports && "." in l.exports) {
@@ -289,18 +289,58 @@ function G(o, r, n) {
     "module" in l && (delete l.module, t && console.log("api-client-generator %s Removed 'module' field (no clear root export).", e.blue("debug"))), "types" in l && (delete l.types, t && console.log("api-client-generator %s Removed 'types' field (no clear root export).", e.blue("debug")));
   return l;
 }
-function K() {
-  const o = N(process.argv.slice(2)), r = process.env.APP_PLATFORM_URL ?? o.APP_PLATFORM_URL, n = r?.endsWith("/") ? r : r && `${r}/`, t = process.env.APP_PLATFORM_MODULES ?? o.APP_PLATFORM_MODULES, i = process.env.APP_API_CLIENT_DIRECTORY ?? o.APP_API_CLIENT_DIRECTORY, s = process.env.APP_PACKAGE_NAME ?? o.APP_PACKAGE_NAME, a = process.env.APP_PACKAGE_VERSION ?? o.APP_PACKAGE_VERSION, l = process.env.APP_OUT_DIR ?? o.APP_OUT_DIR ?? "./", p = process.env.APP_BUILD_DIR ?? o.APP_BUILD_DIR ?? "dist", d = process.env.RUNTIME ?? o.RUNTIME ?? "Net80", g = process.env.SKIP_BUILD === "true" || o.SKIP_BUILD === !0, h = process.env.VERBOSE === "true" || o.VERBOSE === !0, c = process.env.APP_TYPE_STYLE ?? o.APP_TYPE_STYLE ?? "Class", y = process.env.APP_PACKAGE_MODE === "true" || o.PACKAGE === !0, u = ["Net80", "Net90", "Net100"];
-  u.includes(d) || console.warn(
+function W(o) {
+  const r = m.resolve(process.cwd(), o);
+  if (!w(r))
+    return;
+  let n;
+  try {
+    n = O(r).filter((t) => t.endsWith(".ts") && t !== "index.ts");
+  } catch {
+    return;
+  }
+  if (n.length !== 0) {
+    for (const t of n.slice(0, 5)) {
+      const i = m.join(r, t);
+      try {
+        const s = x(i, "utf-8");
+        if (/export class \w+ implements I\w+/.test(s))
+          return "Class";
+      } catch {
+        continue;
+      }
+    }
+    return "Interface";
+  }
+}
+function q() {
+  const o = U(process.argv.slice(2)), r = process.env.APP_PLATFORM_URL ?? o.APP_PLATFORM_URL, n = r?.endsWith("/") ? r : r && `${r}/`, t = process.env.APP_PLATFORM_MODULES ?? o.APP_PLATFORM_MODULES, i = process.env.APP_API_CLIENT_DIRECTORY ?? o.APP_API_CLIENT_DIRECTORY, s = process.env.APP_PACKAGE_NAME ?? o.APP_PACKAGE_NAME, a = process.env.APP_PACKAGE_VERSION ?? o.APP_PACKAGE_VERSION, l = process.env.APP_OUT_DIR ?? o.APP_OUT_DIR ?? "./", p = process.env.APP_BUILD_DIR ?? o.APP_BUILD_DIR ?? "dist", d = process.env.RUNTIME ?? o.RUNTIME ?? "Net80", g = process.env.SKIP_BUILD === "true" || o.SKIP_BUILD === !0, y = process.env.VERBOSE === "true" || o.VERBOSE === !0, c = process.env.APP_TYPE_STYLE ?? o.APP_TYPE_STYLE;
+  let h;
+  c ? h = c : i ? h = W(i) ?? "Interface" : h = "Interface", c || console.log(
+    "api-client-generator %s APP_TYPE_STYLE not specified, using %s (set APP_TYPE_STYLE=Class to generate class-based DTOs)",
+    e.blue("info"),
+    e.whiteBright(h)
+  );
+  const u = process.env.APP_PACKAGE_MODE === "true" || o.PACKAGE === !0, f = ["Net80", "Net90", "Net100"];
+  if (f.includes(d) || console.warn(
     "api-client-generator %s Unknown RUNTIME value: %s. Known values: %s. Proceeding anyway — NSwag will report an error if the runtime is unsupported.",
     e.yellow("warning"),
     e.whiteBright(d),
-    e.whiteBright(u.join(", "))
-  ), c !== "Class" && c !== "Interface" && (console.error(
+    e.whiteBright(f.join(", "))
+  ), h !== "Class" && h !== "Interface" && (console.error(
     "api-client-generator %s Invalid APP_TYPE_STYLE value: %s. Must be either 'Class' or 'Interface'",
     e.red("error"),
-    e.whiteBright(c)
-  ), process.exit(1)), h && console.log("api-client-generator %s Using APP_TYPE_STYLE: %s", e.blue("debug"), e.whiteBright(c)), n || (console.error(
+    e.whiteBright(h)
+  ), process.exit(1)), y) {
+    const k = c ? "explicit" : i ? "auto-detected" : "default";
+    console.log(
+      "api-client-generator %s Using APP_TYPE_STYLE: %s (%s)",
+      e.blue("debug"),
+      e.whiteBright(h),
+      e.gray(k)
+    );
+  }
+  n || (console.error(
     "api-client-generator %s APP_PLATFORM_URL is required in .env config or as api-client-generator argument",
     e.red("error")
   ), process.exit(1)), t || (console.error(
@@ -310,13 +350,13 @@ function K() {
     "api-client-generator %s APP_API_CLIENT_DIRECTORY is required in .env config or as api-client-generator argument",
     e.red("error")
   ), process.exit(1));
-  const f = m.join(m.resolve(process.cwd(), i), "package.json"), w = y || A(f);
-  return h && console.log(
+  const A = m.join(m.resolve(process.cwd(), i), "package.json"), C = u || w(A);
+  return y && console.log(
     "api-client-generator %s Package mode: %s (explicit flag: %s, existing package.json: %s)",
     e.blue("debug"),
-    e.whiteBright(String(w)),
-    e.whiteBright(String(y)),
-    e.whiteBright(String(A(f)))
+    e.whiteBright(String(C)),
+    e.whiteBright(String(u)),
+    e.whiteBright(String(w(A)))
   ), {
     platformUrl: n,
     platformModules: t,
@@ -327,17 +367,17 @@ function K() {
     buildDir: p,
     runtime: d,
     skipBuild: g,
-    verbose: h,
-    typeStyle: c,
-    packageMode: w,
+    verbose: y,
+    typeStyle: h,
+    packageMode: C,
     parsedArgs: o
   };
 }
-function Y(o) {
-  const r = new U(o.apiClientDirectory);
-  if (!A(o.apiClientDirectory))
+function z(o) {
+  const r = new V(o.apiClientDirectory);
+  if (!w(o.apiClientDirectory))
     try {
-      B(o.apiClientDirectory, { recursive: !0 }), console.log(
+      I(o.apiClientDirectory, { recursive: !0 }), console.log(
         "api-client-generator %s Created directory %s",
         e.greenBright("success"),
         e.whiteBright(o.apiClientDirectory)
@@ -368,7 +408,7 @@ function Y(o) {
       `RUNTIME=${o.runtime}`
     ].join(","), l = ["run", r.nswagPaths.configuration, `/variables:${a}`];
     o.verbose && (console.log("api-client-generator %s Running command: npx nswag %s", e.blue("debug"), l.join(" ")), console.log("api-client-generator %s Variables: %s", e.blue("debug"), a));
-    const p = k("npx nswag", l, {
+    const p = v("npx nswag", l, {
       stdio: ["ignore", o.verbose ? "inherit" : "pipe", "inherit"],
       shell: !0
     });
@@ -388,11 +428,11 @@ function Y(o) {
   }
   return t;
 }
-function J(o, r) {
+function H(o, r) {
   const n = m.join(o.apiClientDirectory, o.buildDir);
-  if (!A(n))
+  if (!w(n))
     try {
-      B(n, { recursive: !0 }), console.log(
+      I(n, { recursive: !0 }), console.log(
         "api-client-generator %s Created build directory %s",
         e.greenBright("success"),
         e.whiteBright(n)
@@ -404,19 +444,19 @@ function J(o, r) {
         e.whiteBright(n)
       ), console.error(e.red("Error details:"), p), console.error("api-client-generator %s Build directory creation troubleshooting:", e.blue("info")), console.error(e.blue("  - Check if you have write permissions in the API client directory")), console.error(e.blue("  - Ensure the build directory path is valid")), console.error(e.blue("  - The TypeScript compiler will attempt to create the directory during compilation"));
     }
-  const t = m.join(o.apiClientDirectory, "tsconfig.json"), i = $(t, r, o.outDir, o.buildDir);
+  const t = m.join(o.apiClientDirectory, "tsconfig.json"), i = G(t, r, o.outDir, o.buildDir);
   try {
-    x(t, JSON.stringify(i, null, 2)), o.verbose && console.log("api-client-generator %s Updated tsconfig.json", e.greenBright("success"));
+    T(t, JSON.stringify(i, null, 2)), o.verbose && console.log("api-client-generator %s Updated tsconfig.json", e.greenBright("success"));
   } catch (p) {
     console.error("api-client-generator %s Failed to write tsconfig.json", e.red("error")), console.error(e.red("Error details:"), p), console.error("api-client-generator %s File writing troubleshooting:", e.blue("info")), console.error(e.blue("  - Check if you have write permissions in the API client directory")), console.error(e.blue("  - Ensure the file path is valid and not locked by another process")), console.error(e.blue("  - Try running with elevated permissions if needed")), process.exit(1);
   }
   console.log("api-client-generator %s Compiling TypeScript files to JavaScript", e.green("info"));
-  const s = k("npx tsc", ["--project", t], {
+  const s = v("npx tsc", ["--project", t], {
     stdio: ["ignore", "pipe", "pipe"],
     shell: !0
   });
   s.status === 0 ? console.log("api-client-generator %s Successfully compiled TypeScript files", e.greenBright("success")) : (console.error("api-client-generator %s Failed to compile TypeScript files", e.red("error")), s.stderr && s.stderr.toString().trim() && (console.error("api-client-generator %s TypeScript compilation errors:", e.red("error")), console.error(e.red(s.stderr.toString()))), s.stdout && s.stdout.toString().trim() && (console.error("api-client-generator %s TypeScript output:", e.yellow("warning")), console.error(e.yellow(s.stdout.toString()))), console.error("api-client-generator %s TypeScript compilation troubleshooting:", e.blue("info")), console.error(e.blue("  - Check if all required dependencies are installed")), console.error(e.blue("  - Verify TypeScript configuration in tsconfig.json")), console.error(e.blue("  - Ensure generated API files are valid TypeScript")), console.error(e.blue("  - Try running with --VERBOSE=true for more details")), process.exit(1));
-  const a = m.join(o.apiClientDirectory, "package.json"), l = G(a, r, {
+  const a = m.join(o.apiClientDirectory, "package.json"), l = J(a, r, {
     ...o.parsedArgs,
     APP_PACKAGE_NAME: o.packageName,
     APP_PACKAGE_VERSION: o.packageVersion,
@@ -424,16 +464,16 @@ function J(o, r) {
     VERBOSE: o.verbose
   });
   try {
-    x(a, JSON.stringify(l, null, 2)), console.log("api-client-generator %s Generated package.json", e.greenBright("success"));
+    T(a, JSON.stringify(l, null, 2)), console.log("api-client-generator %s Generated package.json", e.greenBright("success"));
   } catch (p) {
     console.error("api-client-generator %s Failed to write package.json", e.red("error")), console.error(e.red("Error details:"), p), console.error("api-client-generator %s Package.json writing troubleshooting:", e.blue("info")), console.error(e.blue("  - Check if you have write permissions in the API client directory")), console.error(e.blue("  - Ensure the file path is valid and not locked by another process")), console.error(e.blue("  - Try running with elevated permissions if needed")), process.exit(1);
   }
 }
-async function q() {
+async function Q() {
   try {
-    await I({}, "build");
-    const o = K(), r = Y(o);
-    o.packageMode && !o.skipBuild && r.length > 0 ? J(o, r) : o.packageMode || console.log(
+    await j({}, "build");
+    const o = q(), r = z(o);
+    o.packageMode && !o.skipBuild && r.length > 0 ? H(o, r) : o.packageMode || console.log(
       "api-client-generator %s Generated %d API client file(s) in simple mode (no package build)",
       e.greenBright("success"),
       r.length
@@ -442,4 +482,4 @@ async function q() {
     console.error("api-client-generator %s Unexpected error occurred during API client generation", e.red("error")), console.error(e.red("Error details:"), o), console.error("api-client-generator %s General troubleshooting:", e.blue("info")), console.error(e.blue("  - Check if all required dependencies are installed")), console.error(e.blue("  - Ensure you have proper permissions")), console.error(e.blue("  - Try running with --VERBOSE=true for more details")), console.error(e.blue("  - Check the platform URL and module names")), process.exit(1);
   }
 }
-q();
+Q();

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vc-shell/api-client-generator",
   "description": "Tool for API clients generation",
-  "version": "2.0.0-alpha.23",
+  "version": "2.0.0-alpha.25",
   "type": "module",
   "bin": "./dist/api-client-generator.js",
   "files": [
@@ -13,7 +13,7 @@
   },
   "devDependencies": {
     "@types/cross-spawn": "^6.0.6",
-    "@vc-shell/ts-config": "2.0.0-alpha.23",
+    "@vc-shell/ts-config": "2.0.0-alpha.25",
     "typescript": "^5.8.3"
   },
   "dependencies": {