@arcgis/codemod 5.2.0-next.2 → 5.2.0-next.21

package/dist/codemod-CcxqQd8R.js

@@ -0,0 +1,436 @@
+var S = (n, e) => (e = Symbol[n]) ? e : /* @__PURE__ */ Symbol.for("Symbol." + n), L = (n) => {
+  throw TypeError(n);
+};
+var D = (n, e, i) => {
+  if (e != null) {
+    typeof e != "object" && typeof e != "function" && L("Object expected");
+    var d, r;
+    i && (d = e[S("asyncDispose")]), d === void 0 && (d = e[S("dispose")], i && (r = d)), typeof d != "function" && L("Object not disposable"), r && (d = function() {
+      try {
+        r.call(this);
+      } catch (s) {
+        return Promise.reject(s);
+      }
+    }), n.push([i, d, e]);
+  } else i && n.push([i]);
+  return e;
+}, E = (n, e, i) => {
+  var d = typeof SuppressedError == "function" ? SuppressedError : function(t, c, o, a) {
+    return a = Error(o), a.name = "SuppressedError", a.error = t, a.suppressed = c, a;
+  }, r = (t) => e = i ? new d(t, e, "An error was suppressed during disposal") : (i = !0, t), s = (t) => {
+    for (; t = n.pop(); )
+      try {
+        var c = t[1] && t[1].call(t[2]);
+        if (t[0]) return Promise.resolve(c).then(s, (o) => (r(o), s()));
+      } catch (o) {
+        r(o);
+      }
+    if (i) throw e;
+  };
+  return s();
+};
+import { log as y } from "@arcgis/toolkit/log";
+import { c as V } from "./useProjectInstance-C9i4ViQD.js";
+import { mergeApiExtractorConfigs as O, loadApiExtractorConfig as _ } from "@arcgis/api-extractor/extractor/config";
+import { g as F } from "./cli-CqB-08tZ.js";
+import { writeFile as I, readFile as j } from "node:fs/promises";
+import { join as W, relative as Q } from "node:path";
+import { existsAsync as U } from "@arcgis/components-build-utils";
+import { ApiExtractor as Y } from "@arcgis/api-extractor/extractor/ApiExtractor";
+import { SyntaxKind as f } from "ts-morph";
+import { getApiMemberName as q } from "@arcgis/api-extractor/utils/apiHelpers";
+import { identity as B } from "@arcgis/toolkit/function";
+import { styleText as $ } from "node:util";
+function G(n) {
+  const e = {};
+  for (const i of n.modules) {
+    const d = {};
+    for (const r of i.declarations) {
+      const s = {}, t = A(r);
+      if (d[r.name + t] = s, "members" in r)
+        for (const c of r.members ?? []) {
+          const o = q(c);
+          s[o + (t || A(c))] = {};
+        }
+      if ("events" in r)
+        for (const c of r.events ?? [])
+          s[`@${c.name}${t || A(c)}`] = {};
+    }
+    e[i.path] = d;
+  }
+  return e;
+}
+function A(n) {
+  if (n.docsTags === void 0)
+    return "";
+  for (let e = 0; e < n.docsTags.length; ++e)
+    if (n.docsTags[e].name === "internal")
+      return " (internal)";
+  return "";
+}
+function X(n, e) {
+  return H(n, e, "").join(`
+`);
+}
+const J = {};
+function H(n, e, i) {
+  const r = [.../* @__PURE__ */ new Set([...Object.keys(n), ...Object.keys(e)])].sort(), s = [];
+  for (let t = 0; t < r.length; ++t) {
+    const c = r[t], o = n[c], a = e[c];
+    if (o === void 0 && s.push(`${i}+ ${c}`), a === void 0) {
+      if (c.endsWith(" (internal)") && (c.toLowerCase().includes("message") || c.toLowerCase().includes("string") || c.toLowerCase().includes("t9n")))
+        continue;
+      s.push(`${i}- ${c}`);
+    }
+    const l = H(o ?? J, a ?? J, `${i}  `);
+    l.length > 0 && (o !== void 0 && a !== void 0 && s.push(`${i}${c}`), s.push(...l));
+  }
+  return s;
+}
+function x(n, e, i, d) {
+  const r = n.getJsDocs().at(-1);
+  let s = !1;
+  const t = r?.getStructure() ?? { description: void 0, tags: [] }, c = t.tags.findIndex((a) => a.tagName === "private");
+  if (c !== -1) {
+    if (s = !0, t.tags.splice(c, 1), t.tags.length === 0 && (t.description ?? "").trim() === "") {
+      r.remove();
+      return;
+    }
+  } else if (e !== void 0) {
+    const a = t.tags.some((u) => u.tagName === "internal");
+    !t.tags.some((u) => u.tagName === "public") && !a && (s = !0, t.tags.unshift({ tagName: d ? "internal" : "public" }));
+  }
+  for (const a of t.tags) {
+    const l = M(a.text ?? "", i);
+    l !== a.text && (s = !0, a.text = l);
+  }
+  const o = Z(e);
+  if (o !== void 0)
+    for (const a of o)
+      t.tags.some(
+        (u) => u.tagName === "param" && (u.text?.includes(`${a.name} `) || u.text === a.name)
+      ) || (s = !0, t.tags.push({
+        tagName: "param",
+        text: a.name.startsWith("_") ? a.name.slice(1) : a.name
+      }));
+  if (t.description !== void 0) {
+    const a = M(t.description, i);
+    a !== t.description && (s = !0, t.description = a);
+  }
+  s && (r === void 0 ? n.addJsDoc(t) : r.set(t));
+}
+function Z(n) {
+  if (n !== void 0)
+    return "parameters" in n ? n.parameters : "kind" in n && n.kind === "interface" && n.supertypes === void 0 && n.type === void 0 && n.members?.length === 1 && (n.members[0].kind === "call-signature" || n.members[0].kind === "constructor") ? n.members[0].parameters : void 0;
+}
+function M(n, e) {
+  return n.replace(/\{@link +([^}]+)\}/gu, (i, d) => {
+    const r = d.trim(), s = r.indexOf(" "), t = s === -1 ? r : r.slice(0, s), c = s === -1 ? "" : r.slice(s + 1).trim();
+    if (t.startsWith("https://"))
+      return c ? `[${c}](${t})]` : t;
+    if (t.includes("!"))
+      return i;
+    const o = t.indexOf("#"), a = o === -1 ? t : t.slice(0, o), l = o === -1 ? void 0 : t.slice(o + 1), u = e[a] ?? Object.values(e).find(({ modulePath: N }) => N === a);
+    if (u === void 0)
+      return i;
+    const { component: h, modulePath: T } = u;
+    let v = l;
+    if (l !== void 0) {
+      if (h.members?.find((w) => w.name === l) !== void 0)
+        v = l;
+      else if (l !== void 0) {
+        const w = h.slots?.find((b) => b.name === l);
+        if (w !== void 0)
+          v = `slot-${w.name}`;
+        else {
+          const b = h.events?.find((m) => m.name === l);
+          b !== void 0 && (v = `event-${b.name}`);
+        }
+      }
+    }
+    return `{@link ${T}${v === void 0 ? "" : `#${v}`}${c === "" ? "" : ` ${c}`}}`;
+  });
+}
+async function ee(n, e, i, d) {
+  const r = [], s = O(e, {
+    strict: !0,
+    context: {
+      logger: {
+        info: B,
+        error(l) {
+          r.push(l);
+        }
+      }
+    }
+  }), t = new Y(s), { apiJson: c } = await t.run();
+  r.length > 0 && y(
+    "error",
+    n.logName,
+    // Since we remove @private tags, re-running the codemod is not entirely safe
+    `The migration is complete, but API Extractor reported errors:
+${r.join(`
+`)}
+You don't need to run the codemod again - run \`${d}\` from inside ${n.logName} to verify the fixes.`
+  );
+  const o = G(c), a = X(i, o);
+  a.length > 0 && y(
+    "error",
+    n.logName,
+    `The migration is complete, but it looks like the public API surface has changed a bit:
+${a}
+
+For each added declaration, remove @public from it if it is not supposed to be public. For each removed declaration, add @public JSDoc tag if it needs to remain public.`
+  );
+}
+const te = "5.2.0-next.21", ne = {
+  version: te
+};
+async function oe(n) {
+  const e = n.contents.dependencies ?? {}, i = n.contents.devDependencies ?? {};
+  if (i["@arcgis/api-extractor"] !== void 0)
+    return;
+  const d = i["@arcgis/lumina-compiler"] ?? e["@arcgis/typescript-config"] ?? e["@arcgis/toolkit"] ?? `^${ne.version}`;
+  n.contents.devDependencies = {
+    ...i,
+    "@arcgis/api-extractor": d
+  }, await I(n.filePath, `${JSON.stringify(n.contents, null, 2)}
+`), y(
+    "warn",
+    $("blue", n.contents.name),
+    `Added @arcgis/api-extractor dev dependency. Please run ${$("blue", "npm install or equivalent")}.
+`
+  );
+}
+const we = {
+  meta: {
+    needsTypeInformation: !1
+  },
+  async run() {
+    y(
+      "warn",
+      F.codemodName,
+      `This codemod automates most of the changes. It may print warnings or errors for manual follow-up work - ${$(["bold", "magenta"], "Carefully review the following log messages.")}
+`
+    );
+    const n = /* @__PURE__ */ new Set();
+    for (const e of F.projectsData) {
+      if (e.packageJson === void 0 || n.has(e.packageJson.filePath))
+        continue;
+      n.add(e.packageJson.filePath);
+      const i = e.packageJson?.contents.devDependencies ?? {}, d = i["@arcgis/lumina-compiler"] !== void 0;
+      if (!(d || i["@arcgis/api-extractor"] !== void 0)) {
+        y(
+          "warn",
+          e.logName,
+          "This project doesn't look like a Lumina package, nor is it directly using API Extractor. This codemod only works for projects that already use API Extractor."
+        );
+        continue;
+      }
+      await re(e);
+      const s = W(e.cwd, "api-extractor.config.ts");
+      let t;
+      const c = d ? "npm run build" : "npx api-extractor run";
+      if (await U(s) && (t = await _(e.cwd, "api-extractor.config.ts"), t.strict === !0)) {
+        y(
+          "info",
+          e.logName,
+          $(
+            "green",
+            `This package is already in strict mode. You likely do not need to run the codemod again. Instead, run \`${c}\` to verify API Extractor emits no errors in strict mode.`
+          )
+        );
+        continue;
+      }
+      const o = O(t ?? {}, {
+        context: {
+          cwd: e.cwd,
+          // Explicitly don't write to disk, just in case config says otherwise
+          apiJsonEmitPath: "",
+          dtsEmitPath: "",
+          logger: {
+            info: B,
+            // eslint-disable-next-line webgis/consistent-logging
+            error: console.error
+          }
+        }
+      }), a = await ie(o, d, e);
+      if (a !== void 0) {
+        if (t === void 0)
+          await I(
+            s,
+            `import type { ApiExtractorConfig } from "@arcgis/api-extractor/extractor/config";
+
+export const config: ApiExtractorConfig = {
+  strict: true,
+};
+`
+          );
+        else {
+          const l = await j(s, "utf-8"), u = l.replace(
+            /ApiExtractorConfig\s*=\s*\{\r?\n/u,
+            `ApiExtractorConfig = {
+  strict: true,
+`
+          );
+          u === l ? y(
+            "warn",
+            e.logName,
+            `Could not automatically add "strict: true" option to ${s}.`
+          ) : await I(s, u);
+        }
+        await oe(e.packageJson), await ee(e, o, a, c);
+      }
+    }
+  }
+};
+async function ie(n, e, i) {
+  var o = [];
+  try {
+    const d = new Y(n);
+    const { apiJson: r } = await d.run();
+    if (d.errorCount > 0) {
+      y("error", i.logName, "API Extractor reported errors. Please resolve them and re-run the codemod.");
+      return;
+    }
+    const s = new Map(r.modules.map((h) => [h.sourcePath, h]));
+    const t = {};
+    if (e)
+      for (const h of r.modules) {
+        const T = h.declarations.find(
+          (v) => v.kind === "class" && v.customElement === !0
+        );
+        T !== void 0 && (t[T.name] = { component: T, modulePath: h.path });
+      }
+    const c = D(o, V(i));
+    for (const h of c.getCodemodFiles()) {
+      const T = Q(i.cwd, h.getFilePath());
+      se(h);
+      const v = s.get(T), N = v?.declarations.find(
+        (m) => m.kind === "class" && m.customElement === !0
+      )?.docsTags?.some((m) => m.name === "internal") ?? !1, w = v?.declarations.find((m) => m.kind === "class"), b = v === void 0 ? void 0 : new Map(v.declarations.map((m) => [m.name, m]));
+      for (const m of h.getStatements())
+        if (m.isKind(f.VariableStatement)) {
+          const g = m.getDeclarations().at(0)?.getName(), P = g === void 0 ? void 0 : b?.get(g);
+          x(m, P, t, N);
+        } else if (m.isKind(f.TypeAliasDeclaration)) {
+          const p = m.getName(), g = b?.get(p) ?? (p.endsWith("Properties") && w?.name === p.slice(0, -10) ? w : void 0);
+          if (x(m, g, t, N), g !== void 0) {
+            const P = m.getTypeNode();
+            (P === void 0 ? [] : P.isKind(f.IntersectionType) ? P.getTypeNodes() : [P]).forEach((K) => {
+              if (K.isKind(f.TypeLiteral)) {
+                let k = K;
+                if (!k.getText().includes(`
+`) && k.getMembers().length > 0) {
+                  const R = k.getMembers().map((z) => `  ${z.getFullText()}`).join(`
+`);
+                  k = k.replaceWithText(`{
+${R}
+}`);
+                }
+                C(
+                  k,
+                  g,
+                  t,
+                  i
+                );
+              }
+            });
+          }
+        } else if (m.isKind(f.FunctionDeclaration)) {
+          const p = m.getName(), g = p === void 0 ? void 0 : b?.get(p);
+          x(m, g, t, N);
+        } else if (m.isKind(f.InterfaceDeclaration)) {
+          const p = m.getName(), g = b?.get(p) ?? (p.endsWith("Properties") && w?.name === p.slice(0, -10) ? w : void 0);
+          x(m, g, t, N), g !== void 0 && C(m, g, t, i);
+        } else if (m.isKind(f.ClassDeclaration)) {
+          const p = m.getName(), g = p === void 0 ? void 0 : b?.get(p);
+          x(m, g, t, N), g !== void 0 && C(m, g, t, i);
+        }
+    }
+    return G(r);
+  } catch (a) {
+    var l = a, u = !0;
+  } finally {
+    E(o, l, u);
+  }
+}
+async function re(n) {
+  const e = W(n.cwd, "vite.config.ts");
+  if (!await U(e))
+    return;
+  const i = await j(e, "utf-8");
+  if (!i.includes("useLumina"))
+    return;
+  const r = [
+    "copyDefinitions",
+    "apiJsonFileName",
+    "publicStoryUrlPrefix",
+    "getComponentDocsUrl",
+    "getComponentDemoUrl",
+    "compilerOptions",
+    "tsconfigPath",
+    "afterDiagnostic",
+    "typeScriptInstanceCreated",
+    "declarationTextTransformers",
+    "DeclarationTextTransformer",
+    "DeclarationFile",
+    "ApiJsonOptions",
+    "afterCreate"
+  ].filter(
+    (s) => i.match(new RegExp(`\\b${s}\\b`, "u"))
+  );
+  r.length > 0 && y(
+    "warn",
+    n.logName,
+    `Found deprecated options in ${e}: ${r.join(", ")}. Please refactor these out to equivalents specific in their deprecation messages (see vscode tooltips). See https://webgis.esri.com/references/api-extractor/running-standalone for an example api-extractor.config.ts. You do not need to re-run the codemod.
+`
+  );
+}
+function se(n) {
+  const e = n.getFullText(), i = e.indexOf("identity<typeof");
+  if (i === -1)
+    return;
+  const d = e.indexOf(`
+`, i), r = e.slice(i, d === -1 ? 20 : d).trim();
+  y(
+    "error",
+    n.getFilePath(),
+    `Found a t9n type workaround: ${r}. This is no longer necessary - you can directly use the t9n json type like \`typeof T9nStrings>\``
+  );
+}
+function C(n, e, i, d) {
+  const r = e.docsTags?.some((o) => o.name === "internal") ?? !1, s = new Map(e.members?.map((o) => [q(o), o]) ?? []);
+  let t, c = !1;
+  for (const o of n.getMembers())
+    if (o.isKind(f.Constructor) || o.isKind(f.ConstructSignature))
+      x(o, s.get("constructor"), i, r), c = !0;
+    else if (o.isKind(f.CallSignature))
+      x(o, s.get("call-signature"), i, r);
+    else if (o.isKind(f.MethodDeclaration) || o.isKind(f.MethodSignature) || o.isKind(f.PropertySignature)) {
+      const a = o.getNameNode().asKind(f.StringLiteral)?.getLiteralText() ?? o.getName();
+      x(o, s.get(a), i, r);
+    } else if (o.isKind(f.GetAccessor) || o.isKind(f.SetAccessor)) {
+      const a = o.getNameNode().asKind(f.StringLiteral)?.getLiteralText() ?? o.getName(), l = o.getNextSibling();
+      !(o.getJsDocs().length === 0 && l !== void 0 && (l.isKind(f.GetAccessor) || l.isKind(f.SetAccessor)) && l.getName() === o.getName()) && // Don't attach the JSDoc if we already attached to the previous node
+      t !== a && (x(o, s.get(a), i, r), t = a);
+    } else if (o.isKind(f.PropertyDeclaration)) {
+      if (o.getInitializer()?.asKind(f.CallExpression)?.getExpression().asKind(f.Identifier)?.getText() === "useT9n")
+        continue;
+      const l = o.getNameNode().asKind(f.StringLiteral)?.getLiteralText() ?? o.getName();
+      x(
+        o,
+        s.get(l) ?? ("events" in e ? e.events?.find((u) => u.name === l) : void 0),
+        i,
+        r
+      );
+    } else o.isKind(f.IndexSignature) && x(o, e, i, r);
+  !c && e.kind === "class" && e.customElement !== !0 && y(
+    "warn",
+    d.logName,
+    `${e.name} doesn't have a @public constructor, so it will appear as abstract class in the docs and public types. If you wish to expose the ability for users to construct instances of this class, add a @public constructor to it. Documentation: https://webgis.esri.com/references/api-extractor/api-node-kinds#constructor
+`
+  );
+}
+export {
+  we as codemod
+};

package/dist/{codemod-wiEaN6_r.js → codemod-DdyO0alZ.js}

@@ -29,10 +29,11 @@ var p = (o, i, r) => {
   };
   return s();
 };
-import { f as k, c as u, p as E } from "./useProjectInstance-BeTuT4eH.js";
+import { f as k, p as u } from "./actions-TqvlTKWR.js";
 import { log as g } from "@arcgis/toolkit/log";
-import { writeFile as b } from "node:fs/promises";
-import { p as h, g as y } from "./cli-mQ3ZNyiH.js";
+import { writeFile as E } from "node:fs/promises";
+import { c as b } from "./useProjectInstance-C9i4ViQD.js";
+import { p as h, g as y } from "./cli-CqB-08tZ.js";
 async function L(o, i) {
   const r = /* @__PURE__ */ new Set();
   for (const a of o) {
@@ -43,7 +44,7 @@ async function L(o, i) {
     const s = t.contents;
     try {
       const e = await i(s, t.filePath);
-      s !== e && await b(t.filePath, `${JSON.stringify(e, null, 2)}
+      s !== e && await E(t.filePath, `${JSON.stringify(e, null, 2)}
 `, "utf8");
     } catch (e) {
       process.exitCode = 1, g(
@@ -65,7 +66,7 @@ function P(o, i) {
   }
   return o;
 }
-const C = {
+const F = {
   meta: {
     needsTypeInformation: !1
   },
@@ -84,9 +85,9 @@ const C = {
     for (const s of o) {
       var i = [];
       try {
-        const e = p(i, u(s));
+        const e = p(i, b(s));
         for (const n of e.getCodemodFiles())
-          E(n, {
+          u(n, {
             "@arcgis/components-utils": {
               // Deprecated
               setFocusOnElement: [{ do: "deprecate" }, { do: "rename", specifier: "@arcgis/toolkit/dom" }],
@@ -152,5 +153,5 @@ const C = {
   }
 };
 export {
-  C as codemod
+  F as codemod
 };