@vc-shell/api-client-generator 1.0.321 → 1.0.323

package/CHANGELOG.md

@@ -1,3 +1,16 @@
+## [1.0.323](https://github.com/VirtoCommerce/vc-shell/compare/v1.0.322...v1.0.323) (2024-11-05)
+
+
+
+## [1.0.322](https://github.com/VirtoCommerce/vc-shell/compare/v1.0.321...v1.0.322) (2024-11-05)
+
+
+### Features
+
+* **api-client:** skip build arg ([f67a69f](https://github.com/VirtoCommerce/vc-shell/commit/f67a69fc0b09129a5b2e7ec51039bcc2ba435ea1))
+
+
+
 ## [1.0.321](https://github.com/VirtoCommerce/vc-shell/compare/v1.0.320...v1.0.321) (2024-10-23)
 
 

package/README.md

@@ -60,6 +60,10 @@ Add the dependencies to your project's **package.json**:
     | `--APP_PLATFORM_MODULES`     	| Platform modules to generate API client.<br>{==string[]==} <br> Customize the `--APP_PLATFORM_MODULES` list<br>to match your project's requirements.	| `--APP_PLATFORM_MODULES='[MarketplaceVendor,Orders,Catalog]'` 	|
     | `--APP_API_CLIENT_DIRECTORY` 	| Output directory for generated API clients. <br>{==string==} 	| `--APP_API_CLIENT_DIRECTORY=./src/api_client/`                	|
     | `--APP_PLATFORM_URL`         	| Platform URL to obtain client API configs. <br>{==string==} 	    | `--APP_PLATFORM_URL=https://vcmp-dev.govirto.com/`       	|
+    | `--APP_PACKAGE_NAME`         	| Package name for generated API clients. <br>{==string==} 	    | `--APP_PACKAGE_NAME=vc-app-extend`       	|
+    | `--APP_PACKAGE_VERSION`         	| Package version for generated API clients. <br>{==string==} 	    | `--APP_PACKAGE_VERSION=1.0.0`       	|
+    | `--APP_OUT_DIR`         	| Output directory for generated API clients. <br>{==string==} 	    | `--APP_OUT_DIR=./src/api_client/`       	|
+    | `--SKIP_BUILD`         	| Skip build step. <br>{==boolean==} 	    | `--SKIP_BUILD=true`       	|
 
 3. Configure Platform URL to ensure your project can access the platform's API configurations. Add the platform URL to your project's **.env** file:
 

package/dist/api-client-generator.js

@@ -1,20 +1,20 @@
 import g from "chalk";
-import { sync as C } from "cross-spawn";
-import { resolveConfig as L } from "vite";
-import { existsSync as D, readFileSync as T, writeFileSync as x } from "node:fs";
-import m, { dirname as R, resolve as b, join as _, relative as w } from "node:path";
-import { fileURLToPath as k } from "node:url";
-import { cwd as j } from "node:process";
-const E = k(import.meta.url), S = R(E);
-class I {
+import { sync as O } from "cross-spawn";
+import { resolveConfig as I } from "vite";
+import { existsSync as D, readFileSync as C, writeFileSync as T } from "node:fs";
+import A, { dirname as b, resolve as L, join as m, relative as _ } from "node:path";
+import { fileURLToPath as R } from "node:url";
+import { cwd as S } from "node:process";
+const k = R(import.meta.url), j = b(k);
+class E {
   workingDirectory;
   generatorDirectory;
   assetsDirectory;
   apiClientDirectory;
   nswagPaths;
   constructor(e) {
-    this.workingDirectory = j(), this.generatorDirectory = b(S, ".."), this.assetsDirectory = _(this.generatorDirectory, "public", "assets"), this.apiClientDirectory = b(this.workingDirectory, e), this.nswagPaths = {
-      configuration: _(w(this.workingDirectory, this.assetsDirectory), "config.nswag"),
+    this.workingDirectory = S(), this.generatorDirectory = L(j, ".."), this.assetsDirectory = m(this.generatorDirectory, "public", "assets"), this.apiClientDirectory = L(this.workingDirectory, e), this.nswagPaths = {
+      configuration: m(_(this.workingDirectory, this.assetsDirectory), "config.nswag"),
       authApiBase: "authApiBase.ts",
       templates: "templates"
     };
@@ -23,111 +23,110 @@ class I {
     const i = `${e.toLowerCase()}.ts`;
     return {
       fileName: i,
-      nswag: _(w(this.assetsDirectory, this.apiClientDirectory), i),
-      console: _(w(this.workingDirectory, this.apiClientDirectory), i)
+      nswag: m(_(this.assetsDirectory, this.apiClientDirectory), i),
+      console: m(_(this.workingDirectory, this.apiClientDirectory), i)
     };
   }
 }
-function O(r) {
-  return r == null ? [] : Array.isArray(r) ? r : [r];
+function y(n) {
+  return n == null ? [] : Array.isArray(n) ? n : [n];
 }
-function $(r, e, i, n) {
-  var c, t = r[e], h = ~n.string.indexOf(e) ? i == null || i === !0 ? "" : String(i) : typeof i == "boolean" ? i : ~n.boolean.indexOf(e) ? i === "false" ? !1 : i === "true" || (r._.push((c = +i, c * 0 === 0 ? c : i)), !!i) : (c = +i, c * 0 === 0 ? c : i);
-  r[e] = t == null ? h : Array.isArray(t) ? t.concat(h) : [t, h];
+function $(n, e, i, t) {
+  var c, s = n[e], u = ~t.string.indexOf(e) ? i == null || i === !0 ? "" : String(i) : typeof i == "boolean" ? i : ~t.boolean.indexOf(e) ? i === "false" ? !1 : i === "true" || (n._.push((c = +i, c * 0 === 0 ? c : i)), !!i) : (c = +i, c * 0 === 0 ? c : i);
+  n[e] = s == null ? u : Array.isArray(s) ? s.concat(u) : [s, u];
 }
-function M(r, e) {
-  r = r || [], e = e || {};
-  var i, n, c, t, h, s = { _: [] }, o = 0, l = 0, a = 0, f = r.length;
-  const P = e.alias !== void 0, p = e.unknown !== void 0, u = e.default !== void 0;
-  if (e.alias = e.alias || {}, e.string = O(e.string), e.boolean = O(e.boolean), P)
+function B(n, e) {
+  n = n || [], e = e || {};
+  var i, t, c, s, u, o = { _: [] }, r = 0, a = 0, l = 0, f = n.length;
+  const P = e.alias !== void 0, h = e.unknown !== void 0, p = e.default !== void 0;
+  if (e.alias = e.alias || {}, e.string = y(e.string), e.boolean = y(e.boolean), P)
     for (i in e.alias)
-      for (n = e.alias[i] = O(e.alias[i]), o = 0; o < n.length; o++)
-        (e.alias[n[o]] = n.concat(i)).splice(o, 1);
-  for (o = e.boolean.length; o-- > 0; )
-    for (n = e.alias[e.boolean[o]] || [], l = n.length; l-- > 0; ) e.boolean.push(n[l]);
-  for (o = e.string.length; o-- > 0; )
-    for (n = e.alias[e.string[o]] || [], l = n.length; l-- > 0; ) e.string.push(n[l]);
-  if (u) {
+      for (t = e.alias[i] = y(e.alias[i]), r = 0; r < t.length; r++)
+        (e.alias[t[r]] = t.concat(i)).splice(r, 1);
+  for (r = e.boolean.length; r-- > 0; )
+    for (t = e.alias[e.boolean[r]] || [], a = t.length; a-- > 0; ) e.boolean.push(t[a]);
+  for (r = e.string.length; r-- > 0; )
+    for (t = e.alias[e.string[r]] || [], a = t.length; a-- > 0; ) e.string.push(t[a]);
+  if (p) {
     for (i in e.default)
-      if (t = typeof e.default[i], n = e.alias[i] = e.alias[i] || [], e[t] !== void 0)
-        for (e[t].push(i), o = 0; o < n.length; o++)
-          e[t].push(n[o]);
+      if (s = typeof e.default[i], t = e.alias[i] = e.alias[i] || [], e[s] !== void 0)
+        for (e[s].push(i), r = 0; r < t.length; r++)
+          e[s].push(t[r]);
   }
-  const d = p ? Object.keys(e.alias) : [];
-  for (o = 0; o < f; o++) {
-    if (c = r[o], c === "--") {
-      s._ = s._.concat(r.slice(++o));
+  const d = h ? Object.keys(e.alias) : [];
+  for (r = 0; r < f; r++) {
+    if (c = n[r], c === "--") {
+      o._ = o._.concat(n.slice(++r));
       break;
     }
-    for (l = 0; l < c.length && c.charCodeAt(l) === 45; l++)
+    for (a = 0; a < c.length && c.charCodeAt(a) === 45; a++)
       ;
-    if (l === 0)
-      s._.push(c);
-    else if (c.substring(l, l + 3) === "no-") {
-      if (t = c.substring(l + 3), p && !~d.indexOf(t))
+    if (a === 0)
+      o._.push(c);
+    else if (c.substring(a, a + 3) === "no-") {
+      if (s = c.substring(a + 3), h && !~d.indexOf(s))
         return e.unknown(c);
-      s[t] = !1;
+      o[s] = !1;
     } else {
-      for (a = l + 1; a < c.length && c.charCodeAt(a) !== 61; a++)
+      for (l = a + 1; l < c.length && c.charCodeAt(l) !== 61; l++)
         ;
-      for (t = c.substring(l, a), h = c.substring(++a) || o + 1 === f || ("" + r[o + 1]).charCodeAt(0) === 45 || r[++o], n = l === 2 ? [t] : t, a = 0; a < n.length; a++) {
-        if (t = n[a], p && !~d.indexOf(t)) return e.unknown("-".repeat(l) + t);
-        $(s, t, a + 1 < n.length || h, e);
+      for (s = c.substring(a, l), u = c.substring(++l) || r + 1 === f || ("" + n[r + 1]).charCodeAt(0) === 45 || n[++r], t = a === 2 ? [s] : s, l = 0; l < t.length; l++) {
+        if (s = t[l], h && !~d.indexOf(s)) return e.unknown("-".repeat(a) + s);
+        $(o, s, l + 1 < t.length || u, e);
       }
     }
   }
-  if (u)
+  if (p)
     for (i in e.default)
-      s[i] === void 0 && (s[i] = e.default[i]);
+      o[i] === void 0 && (o[i] = e.default[i]);
   if (P)
-    for (i in s)
-      for (n = e.alias[i] || []; n.length > 0; )
-        s[n.shift()] = s[i];
-  return s;
+    for (i in o)
+      for (t = e.alias[i] || []; t.length > 0; )
+        o[t.shift()] = o[i];
+  return o;
 }
-async function N() {
-  await L({}, "build");
-  const r = M(process.argv.slice(2)), e = process.env.APP_PLATFORM_URL ?? r.APP_PLATFORM_URL;
+async function M() {
+  await I({}, "build");
+  const n = B(process.argv.slice(2)), e = process.env.APP_PLATFORM_URL ?? n.APP_PLATFORM_URL;
   if (!e)
     return console.log(
       g.red("error"),
       "api-client-generator APP_PLATFORM_URL is required in .env config or as api-client-generator argument"
     );
-  if (!r.APP_PLATFORM_MODULES)
+  if (!n.APP_PLATFORM_MODULES)
     return console.log(g.red("error"), "api-client-generator modules command is required");
-  if (!r.APP_API_CLIENT_DIRECTORY)
+  if (!n.APP_API_CLIENT_DIRECTORY)
     return console.log(g.red("error"), "api-client-generator outDir command is required");
-  const i = r.APP_OUT_DIR ?? "./", n = new I(r.APP_API_CLIENT_DIRECTORY), c = r.APP_PLATFORM_MODULES.replace(/[[\]]/g, "").split(","), t = {}, h = m.join(r.APP_API_CLIENT_DIRECTORY, "tsconfig.json");
-  let s = {
+  const i = n.APP_OUT_DIR ?? "./", t = new E(n.APP_API_CLIENT_DIRECTORY), c = n.APP_PLATFORM_MODULES.replace(/[[\]]/g, "").split(","), s = {};
+  let u, o;
+  if (!n.SKIP_BUILD && (u = A.join(n.APP_API_CLIENT_DIRECTORY, "tsconfig.json"), o = {
     extends: "@vc-shell/ts-config/tsconfig.json",
     compilerOptions: {
       baseUrl: ".",
-      declarationDir: m.join(i, "types"),
+      declarationDir: A.join(i, "types"),
       outDir: i,
       rootDir: "./"
     },
     files: [],
     include: ["*.ts"]
-  };
-  if (D(h)) {
-    const f = JSON.parse(T(h, "utf-8"));
-    s = { ...s, ...f }, s.compilerOptions = { ...s.compilerOptions, ...f.compilerOptions }, s.files = Array.from(new Set(s.files.concat(f.files || []))), s.include = Array.from(new Set(s.include.concat(f.include || [])));
+  }, D(u))) {
+    const r = JSON.parse(C(u, "utf-8"));
+    o = { ...o, ...r }, o && (o.compilerOptions = { ...o.compilerOptions, ...r.compilerOptions }, o.files = Array.from(new Set(o.files.concat(r.files || []))), o.include = Array.from(new Set(o.include.concat(r.include || [])))), console.log("api-client-generator %s Generated tsconfig.json", g.greenBright("success"));
   }
-  console.log("api-client-generator %s Generated tsconfig.json", g.greenBright("success"));
-  for (const f of c) {
-    const P = n.resolveApiClientPaths(f);
+  for (const r of c) {
+    const a = t.resolveApiClientPaths(r);
     console.log(
       "api-client-generator %s Generating API client for %s module on %s environment",
       g.green("info"),
-      g.whiteBright(f),
+      g.whiteBright(r),
       g.whiteBright(e)
     );
-    const p = C(
+    const l = O(
       "npx nswag",
       [
         "run",
-        n.nswagPaths.configuration,
-        `/variables:APP_PLATFORM_URL=${e},APP_PLATFORM_MODULE=${f},APP_AUTH_API_BASE_PATH=${n.nswagPaths.authApiBase},APP_TEMPLATE_DIRECTORY=${n.nswagPaths.templates},APP_API_CLIENT_PATH=${P.nswag}`,
+        t.nswagPaths.configuration,
+        `/variables:APP_PLATFORM_URL=${e},APP_PLATFORM_MODULE=${r},APP_AUTH_API_BASE_PATH=${t.nswagPaths.authApiBase},APP_TEMPLATE_DIRECTORY=${t.nswagPaths.templates},APP_API_CLIENT_PATH=${a.nswag}`,
         "/runtime:Net60"
       ],
       {
@@ -135,50 +134,53 @@ async function N() {
         shell: !0
       }
     );
-    if (p.status === 0) {
-      console.log(
+    if (l.status === 0) {
+      if (console.log(
         "api-client-generator %s Successfully generated %s",
         g.greenBright("success"),
-        g.whiteBright(P.console)
-      );
-      const u = f.toLowerCase();
-      s.files.includes(`${u}.ts`) || s.files.push(`${u}.ts`);
-      const d = {
-        import: i !== "./" ? `./${i}/${u}.js` : `./${u}.js`,
-        types: i !== "./" ? `./${i}/types/${u}.d.ts` : `./types/${u}.js`
-      }, A = Object.keys(t).find(
-        (y) => t[y].import.includes(`${u}.js`)
-      );
-      A ? t[A] = d : t[`./${u}`] = d;
+        g.whiteBright(a.console)
+      ), !n.SKIP_BUILD && o) {
+        const f = r.toLowerCase();
+        o.files.includes(`${f}.ts`) || o.files.push(`${f}.ts`);
+        const P = {
+          import: i !== "./" ? `./${i}/${f}.js` : `./${f}.js`,
+          types: i !== "./" ? `./${i}/types/${f}.d.ts` : `./types/${f}.js`
+        }, h = Object.keys(s).find(
+          (p) => s[p].import.includes(`${f}.js`)
+        );
+        h ? s[h] = P : s[`./${f}`] = P;
+      }
     } else
       console.error(
         "api-client-generator %s Failed to generate %s",
         g.red("error"),
-        g.whiteBright(P.console),
-        p
+        g.whiteBright(a.console),
+        l
       );
   }
-  x(h, JSON.stringify(s, null, 2)), console.log("api-client-generator %s Compiling TypeScript files to JavaScript", g.green("info")), C("npx tsc", ["--project", h], {
-    stdio: ["ignore", "inherit", "ignore"],
-    shell: !0
-  }).status === 0 ? console.log("api-client-generator %s Successfully compiled TypeScript files", g.greenBright("success")) : console.error("api-client-generator %s Failed to compile TypeScript files", g.red("error"));
-  const l = m.join(r.APP_API_CLIENT_DIRECTORY, "package.json");
-  let a = {
-    name: r.APP_PACKAGE_NAME || "api-client",
-    version: r.APP_PACKAGE_VERSION || "1.0.0",
-    files: i !== "./" ? [i, "package.json"] : ["package.json"],
-    exports: t
-  };
-  if (D(l)) {
-    const f = JSON.parse(T(l, "utf-8"));
-    a = { ...a, ...f }, a.files = Array.from(new Set(a.files.concat(f.files || []))), a.exports = { ...f.exports, ...a.exports };
-    for (const [P, p] of Object.entries(t)) {
-      const u = p.import, d = m.basename(u), A = Object.keys(a.exports).find(
-        (y) => a.exports[y].import.includes(d)
-      );
-      A ? a.exports[A] = p : a.exports[P] = p;
+  if (!n.SKIP_BUILD && u && o) {
+    T(u, JSON.stringify(o, null, 2)), console.log("api-client-generator %s Compiling TypeScript files to JavaScript", g.green("info")), O("npx tsc", ["--project", u], {
+      stdio: ["ignore", "inherit", "ignore"],
+      shell: !0
+    }).status === 0 ? console.log("api-client-generator %s Successfully compiled TypeScript files", g.greenBright("success")) : console.error("api-client-generator %s Failed to compile TypeScript files", g.red("error"));
+    const a = A.join(n.APP_API_CLIENT_DIRECTORY, "package.json");
+    let l = {
+      name: n.APP_PACKAGE_NAME || "api-client",
+      version: n.APP_PACKAGE_VERSION || "1.0.0",
+      files: i !== "./" ? [i, "package.json"] : ["package.json"],
+      exports: s
+    };
+    if (D(a)) {
+      const f = JSON.parse(C(a, "utf-8"));
+      l = { ...l, ...f }, l.files = Array.from(new Set(l.files.concat(f.files || []))), l.exports = { ...f.exports, ...l.exports };
+      for (const [P, h] of Object.entries(s)) {
+        const p = h.import, d = A.basename(p), w = Object.keys(l.exports).find(
+          (x) => l.exports[x].import.includes(d)
+        );
+        w ? l.exports[w] = h : l.exports[P] = h;
+      }
     }
+    T(a, JSON.stringify(l, null, 2)), console.log("api-client-generator %s Generated package.json", g.greenBright("success"));
   }
-  x(l, JSON.stringify(a, null, 2)), console.log("api-client-generator %s Generated package.json", g.greenBright("success"));
 }
-N();
+M();

package/package.json

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