@arcgis/api-extractor 5.2.0-next.125 → 5.2.0-next.126

package/dist/chunks/config.js

@@ -4,7 +4,7 @@ import { retrievePackageJson as U } from "@arcgis/node-toolkit/packageJson";
 import { loadTypeScriptConfig as b } from "@arcgis/node-toolkit/vite/typeScript";
 import { identity as d } from "@arcgis/toolkit/function";
 import { pathToFileURL as I } from "node:url";
-import { getDefaultBasePath as J } from "../extractor/processing/links.js";
+import { g as J } from "./links.js";
 const L = "@arcgis/api-extractor", w = "1.0.0-0", A = {
   name: L,
   version: w
@@ -12,10 +12,10 @@ const L = "@arcgis/api-extractor", w = "1.0.0-0", A = {
 function N(e) {
   if (e.isResolvedConfig === !0)
     return e;
-  const t = e.context, n = e.types, o = e.documentation, r = `${t?.cwd === void 0 ? E() : y.resolve(t?.cwd)}/`, c = t?.packageJson ?? U(r);
-  let s = t?.basePath ?? "src/";
-  s.endsWith("/") || (s += "/");
-  const m = "customElements" in c && "@arcgis/lumina" in (c.dependencies ?? {}), p = n?.typeCheckedExtraction ?? m, l = n?.fullTypeCheck ?? !1, a = n?.typeScriptConfig ?? (p || l ? b(r, n?.typeScriptConfigPath, !0) : {
+  const t = e.context, n = e.types, o = e.documentation, r = `${t?.cwd === void 0 ? E() : y.resolve(t?.cwd)}/`, s = t?.packageJson ?? U(r);
+  let c = t?.basePath ?? "src/";
+  c.endsWith("/") || (c += "/");
+  const m = "customElements" in s && "@arcgis/lumina" in (s.dependencies ?? {}), p = n?.typeCheckedExtraction ?? m, l = n?.fullTypeCheck ?? !1, a = n?.typeScriptConfig ?? (p || l ? b(r, n?.typeScriptConfigPath, !0) : {
     configPath: "",
     config: {
       options: {},
@@ -49,8 +49,8 @@ function N(e) {
       apiJsonEmitPath: t?.apiJsonEmitPath ?? "",
       environment: P,
       cwd: r,
-      basePath: s,
-      packageJson: c,
+      basePath: c,
+      packageJson: s,
       logger: t?.logger ?? {
         // We namespace manually
         // eslint-disable-next-line webgis/consistent-logging
@@ -84,7 +84,7 @@ function N(e) {
       getComponentDemoUrl: o?.getComponentDemoUrl ?? !1,
       host: o?.host ?? (u ? k : C),
       alternativeHost: o?.alternativeHost ?? (u ? C : k),
-      basePath: o?.basePath ?? J(c.name.split("/").at(-1))
+      basePath: o?.basePath ?? J(s.name.split("/").at(-1))
     },
     verify: {
       typeCheckTypes: e.verify?.typeCheckTypes ?? !1,
@@ -112,17 +112,17 @@ async function V(e, t) {
     throw Error(`The provided config file at ${i} does not exist.`);
   if (!r)
     return e === void 0 ? {} : { context: { cwd: e } };
-  const c = (await import(I(i).href)).config;
+  const s = (await import(I(i).href)).config;
   return {
-    ...c,
+    ...s,
     context: {
-      ...c.context,
-      cwd: c.context?.cwd ?? y.dirname(i)
+      ...s.context,
+      cwd: s.context?.cwd ?? y.dirname(i)
     }
   };
 }
 function j(e, t) {
-  const n = e.context, o = t.context, i = e.types, r = t.types, c = e.documentation, s = t.documentation, m = e.verify, p = t.verify, l = e.watch, a = t.watch;
+  const n = e.context, o = t.context, i = e.types, r = t.types, s = e.documentation, c = t.documentation, m = e.verify, p = t.verify, l = e.watch, a = t.watch;
   return {
     isResolvedConfig: e.isResolvedConfig || t.isResolvedConfig || void 0,
     context: {
@@ -155,15 +155,15 @@ function j(e, t) {
       forceProduceDts: r?.forceProduceDts ?? i?.forceProduceDts
     },
     documentation: {
-      copyDocDefinitions: s?.copyDocDefinitions ?? c?.copyDocDefinitions,
-      noInheritMembers: s?.noInheritMembers ?? c?.noInheritMembers,
-      omitInternal: s?.omitInternal ?? c?.omitInternal,
-      publicStoryUrlPrefix: s?.publicStoryUrlPrefix ?? c?.publicStoryUrlPrefix,
-      getComponentDocsUrl: s?.getComponentDocsUrl ?? c?.getComponentDocsUrl,
-      getComponentDemoUrl: s?.getComponentDemoUrl ?? c?.getComponentDemoUrl,
-      host: s?.host ?? c?.host,
-      alternativeHost: s?.alternativeHost ?? c?.alternativeHost,
-      basePath: s?.basePath ?? c?.basePath
+      copyDocDefinitions: c?.copyDocDefinitions ?? s?.copyDocDefinitions,
+      noInheritMembers: c?.noInheritMembers ?? s?.noInheritMembers,
+      omitInternal: c?.omitInternal ?? s?.omitInternal,
+      publicStoryUrlPrefix: c?.publicStoryUrlPrefix ?? s?.publicStoryUrlPrefix,
+      getComponentDocsUrl: c?.getComponentDocsUrl ?? s?.getComponentDocsUrl,
+      getComponentDemoUrl: c?.getComponentDemoUrl ?? s?.getComponentDemoUrl,
+      host: c?.host ?? s?.host,
+      alternativeHost: c?.alternativeHost ?? s?.alternativeHost,
+      basePath: c?.basePath ?? s?.basePath
     },
     verify: {
       typeCheckTypes: p?.typeCheckTypes ?? m?.typeCheckTypes,

package/dist/chunks/links.js

@@ -0,0 +1,412 @@
+import { styleText as D } from "node:util";
+import { emitJsDocError as g, getApiNodeLabel as T } from "../utils/apiHelpers.js";
+import { b as A, e as W, d as S, g as L } from "./privateContext.js";
+import { kebabToPascal as M } from "@arcgis/toolkit/string";
+import R from "typescript";
+function q(e, i, n) {
+  return N(e, i, n) ?? void 0;
+}
+function z(e, i, n, t) {
+  const s = N(e, i, n);
+  return s === void 0 ? t : s ?? void 0;
+}
+function N(e, i, n) {
+  const t = R.getLeadingCommentRanges(n.file.text, e.pos);
+  if (t === void 0)
+    return;
+  let s;
+  for (const l of t) {
+    const d = n.file.text.slice(l.pos, l.end);
+    d.startsWith("/**") && (s !== void 0 && n.config.strict && n.emitError(
+      `Found multiple JSDoc comments for the same node. This is not allowed.
+If one of these was meant to be a file-level comment, read the documentation: https://webgis.esri.com/references/api-extractor/api-node-kinds#module-level-documentation
+If this is meant to be a function overload, read the documentation: https://webgis.esri.com/references/api-extractor/api-node-kinds#function-overloads`,
+      {
+        file: n.file,
+        node: e
+      }
+    ), s = d);
+  }
+  if (s === void 0)
+    return;
+  const o = n.config.documentation.omitInternal;
+  return J(s, i, o, n);
+}
+function J(e, i, n, t) {
+  if (i && !e.includes("* @public") && (n || !e.includes("* @internal")))
+    return null;
+  const s = e.length - 2;
+  let o = 3, l = "";
+  const d = [];
+  let r, k, h = !1;
+  for (; o < s; ) {
+    let v = e.indexOf(`
+`, o);
+    v === -1 && (v = s);
+    let f = e.slice(o, v).trim();
+    if (o = v + 1, f === "*" ? f = "" : f.startsWith("*") && (f[1] === " " ? f = f.slice(2) : t.config.strict ? t.emitError(
+      `For consistency, include a space character after '*' in JSDoc. Did not find it in "${e}"`,
+      {
+        file: t.file,
+        node: void 0
+      }
+    ) : f = f.slice(1)), f.startsWith("@")) {
+      r !== void 0 && !h && d.push(
+        y[r] ?? {
+          name: r,
+          text: k.trim().replaceAll("\\@", "@") || void 0
+        }
+      );
+      const b = f.indexOf(" "), c = b === -1 ? f.slice(1) : f.slice(1, b);
+      if (c === "internal") {
+        if (n)
+          return null;
+        i = !1;
+      } else c === "public" ? (i = !1, h = !0) : h = c === "privateRemarks";
+      const a = b === -1 ? "" : f.slice(b + 1);
+      r = c, k = a;
+    } else r !== void 0 ? k = `${k}
+${f}` : l += `${f}
+`;
+  }
+  return i ? null : (r !== void 0 && !h && d.push(
+    y[r] ?? {
+      name: r,
+      text: k.trim().replaceAll("\\@", "@") || void 0
+    }
+  ), {
+    description: l.trim().replaceAll("\\@", "@") || void 0,
+    docsTags: d
+  });
+}
+function G(e, i) {
+  for (let n = 0; n < i.docsTags.length; ++n) {
+    const t = i.docsTags[n], { name: s, text: o } = t;
+    s === "deprecated" ? e.deprecated = o || !0 : (e.docsTags ??= [], e.docsTags.push(t));
+  }
+  e.description = i.description;
+}
+function K(e, i) {
+  for (let n = 0; n < i.docsTags.length; ++n) {
+    const t = i.docsTags[n], { name: s, text: o } = t;
+    if (s === "deprecated")
+      e.deprecated = o || !0;
+    else if (t === y.private)
+      e.privacy = "private";
+    else if (s === "csspart")
+      e.cssParts ??= [], e.cssParts.push(w(o));
+    else if (s === "cssstate")
+      e.cssStates ??= [], e.cssStates.push(w(o));
+    else if (s === "slot")
+      e.slots ??= [], e.slots.push(w(o));
+    else if (s === "esriCompatibilityName") {
+      const l = A(e);
+      l.esriCompatibilityNames ??= [], l.esriCompatibilityNames.push(o ?? "");
+    } else s === "readonly" || (e.docsTags ??= [], e.docsTags.push(t));
+  }
+  e.description = i.description;
+}
+function Q(e, i) {
+  const n = e, t = [];
+  for (let s = 0; s < i.docsTags.length; ++s) {
+    const o = i.docsTags[s], { name: l, text: d } = o;
+    if (l === "deprecated")
+      e.deprecated = d || !0;
+    else if (o === y.private)
+      e.privacy = "private";
+    else if (l === "param")
+      t.push(o);
+    else if (l === "returns")
+      n.return.description = o.text;
+    else if (l === "esriCompatibilityName") {
+      const r = S(e);
+      r.esriCompatibilityNames ??= [], r.esriCompatibilityNames.push(d ?? "");
+    } else
+      e.docsTags ??= [], e.docsTags.push(o);
+  }
+  return e.description = i.description, t;
+}
+function X(e, i) {
+  for (let n = 0; n < i.docsTags.length; ++n) {
+    const t = i.docsTags[n], { name: s, text: o } = t;
+    s === "deprecated" ? e.deprecated = o || !0 : s === "default" ? e.default = o : t === y.readonly ? e.readonly = !0 : t === y.private ? e.privacy = "private" : (e.docsTags ??= [], e.docsTags.push(t));
+  }
+  e.description = i.description;
+}
+function Y(e, i) {
+  for (let n = 0; n < i.docsTags.length; ++n) {
+    const t = i.docsTags[n], { name: s, text: o } = t;
+    if (s === "deprecated")
+      e.deprecated = o || !0;
+    else if (s === "default")
+      e.default = o;
+    else if (s !== "readonly") if (s === "esriCompatibilityName") {
+      const l = W(e);
+      l.esriCompatibilityNames ??= [], l.esriCompatibilityNames.push(o ?? "");
+    } else
+      e.docsTags ??= [], e.docsTags.push(t);
+  }
+  e.description = i.description;
+}
+function Z(e, i) {
+  for (let n = 0; n < i.docsTags.length; ++n) {
+    const t = i.docsTags[n], { name: s, text: o } = t;
+    s === "deprecated" ? e.deprecated = o || !0 : t === y.private ? e.privacy = "private" : (e.docsTags ??= [], e.docsTags.push(t));
+  }
+  e.description = i.description;
+}
+function w(e) {
+  if (e === void 0)
+    return {
+      name: "",
+      deprecated: void 0,
+      summary: void 0,
+      description: void 0,
+      docsTags: void 0,
+      type: void 0,
+      syntax: void 0,
+      default: void 0
+    };
+  const i = e.indexOf(" - ");
+  if (i === -1)
+    return e.startsWith("- ") ? {
+      name: "",
+      deprecated: void 0,
+      summary: void 0,
+      description: e.slice(2),
+      docsTags: void 0,
+      type: void 0,
+      syntax: void 0,
+      default: void 0
+    } : {
+      name: e,
+      deprecated: void 0,
+      summary: void 0,
+      description: void 0,
+      docsTags: void 0,
+      type: void 0,
+      syntax: void 0,
+      default: void 0
+    };
+  let n, t = e.slice(0, i);
+  if (t.startsWith("[") && t.endsWith("]")) {
+    const o = t.slice(1, -1), l = o.indexOf("=");
+    t = o.slice(0, l), n = o.slice(l + 1);
+  }
+  const s = e.slice(i + 3);
+  return {
+    name: t,
+    deprecated: void 0,
+    summary: void 0,
+    description: s,
+    docsTags: void 0,
+    type: void 0,
+    syntax: void 0,
+    default: n
+  };
+}
+const y = {
+  // Create a null prototype object to avoid collisions with Object.prototype when doing lookups
+  // eslint-disable-next-line @typescript-eslint/naming-convention
+  __proto__: null,
+  internal: { name: "internal", text: void 0 },
+  private: { name: "private", text: void 0 },
+  copyDoc: { name: "copyDoc", text: void 0 },
+  beta: { name: "beta", text: void 0 },
+  experimental: { name: "experimental", text: void 0 },
+  readonly: { name: "readonly", text: void 0 },
+  required: { name: "required", text: void 0 }
+}, ee = {
+  description: void 0,
+  docsTags: []
+}, ie = {
+  description: void 0,
+  docsTags: [y.private]
+};
+function ne(e, i) {
+  if (typeof e == "string") {
+    const n = e.replaceAll(F, i.resolveJsDocLink).replaceAll(i.config.documentation.alternativeHost, i.config.documentation.host);
+    return e.includes("](.") && g(I, e, i), n;
+  }
+  return e;
+}
+function te(e, i) {
+  if (e) {
+    const n = e.replaceAll(F, i.resolveJsDocLink).replaceAll(i.config.documentation.alternativeHost, i.config.documentation.host);
+    return n.includes("](.") && g(I, n, i), n;
+  }
+  return e;
+}
+function se(e, i) {
+  if (e !== void 0 && i.inheritedModuleName === void 0)
+    for (let n = 0; n < e.length; ++n) {
+      const t = e[n];
+      t.text && (t.text = t.text.replaceAll(F, i.resolveJsDocLink).replaceAll(i.config.documentation.alternativeHost, i.config.documentation.host), t.text.includes("](.") && g(I, t.text, i));
+    }
+}
+const I = "Unexpected relative markdown link. For links to API within the package use {@link}. For all other links, use absolute markdown. Documentation: https://webgis.esri.com/references/api-extractor/tags-reference#link)", F = /\{@link +([^}]+)\}/gu;
+function oe(e, i, n) {
+  let t = n.indexOf(" ");
+  t === -1 && (t = n.length);
+  const s = n.slice(0, t);
+  let o = n.slice(t + 1);
+  if (s.startsWith("https://"))
+    return e.config.strict ? (g(
+      "Did not expect absolute URLs in a @link tag. Please use markdown links for external links. See https://webgis.esri.com/references/api-extractor/tags-reference#link)",
+      i,
+      e
+    ), "") : `[${o || s}](${s})`;
+  const [l, d] = s.split("#"), [r, k] = l.split("!");
+  if (r === "")
+    return g(
+      `Expected @link reference to start with a module name (before ! or #), but got: ${s}`,
+      i,
+      e
+    ), i;
+  let h = e.moduleMap.get(r);
+  if (h === void 0 && e.isComponentProject && !e.config.strict) {
+    for (const c of e.moduleMap.values())
+      if (L(c).index.class?.name === r) {
+        h = c;
+        break;
+      }
+  }
+  if (h === void 0)
+    return e.config.verify.detectBrokenLinks ? g(
+      `Failed to find referenced module: ${D("red", r)}${r.startsWith("module:") ? '. Module name in @link does not need the "module:" prefix' : r.startsWith("esri/") ? '. Module name in @link does not need to start with the "esri/" prefix.' : ""}`,
+      i,
+      e
+    ) : e.silencedBrokenLinkCount += 1, i;
+  const v = L(h), f = e.inheritedModuleName === void 0 ? e.apiModule : e.moduleMap.get(e.inheritedModuleName) ?? e.apiModule;
+  if (e.watchFiles !== void 0 && r !== f.path && L(f).isStale) {
+    const c = L(f).file.fileName.slice(e.config.context.cwd.length), a = v.file.fileName.slice(e.config.context.cwd.length);
+    e.watchFiles.get(c).docLinks.push(n), e.watchFiles.get(c).dependencies.add(a);
+    const $ = e.watchFiles.get(a).dependents;
+    $.has(c) || $.set(c, !1);
+  }
+  let b = O(h.path, k, d, e);
+  if (k !== void 0) {
+    const c = v.index.named[k];
+    return c === void 0 ? (e.config.verify.detectBrokenLinks ? g(
+      `Failed to find the referenced declaration inside the module: ${D("red", `${r}!${k}`)}`,
+      i,
+      e
+    ) : e.silencedBrokenLinkCount += 1, i) : c === v.index.class ? (g(
+      `Invalid reference syntax used. Class/mixin/custom element declarations must be referenced without specifying the class name. Expected ${D("green", r)}`,
+      i,
+      e
+    ), i) : (P(e, i, c), `[${o || T(c)}](${b})`);
+  } else if (d !== void 0) {
+    const c = h.path === f.path, a = v.index.class;
+    if (a === void 0)
+      return v.index.named[d] === void 0 ? e.config.verify.detectBrokenLinks ? g(
+        'Failed to find the referenced member. Class member reference syntax was used, yet current module does not expose a class/mixin/custom element? Linking to properties in interfaces is not yet supported. For event links, prefix with "event-"',
+        i,
+        e
+      ) : e.silencedBrokenLinkCount += 1 : g(
+        `Invalid reference syntax used. This syntax is only permitted on modules that export a class/mixin/web component. Perhaps you meant to use ${D("red", `${r}!${d}`)} instead? Linking to properties in interfaces is not yet supported`,
+        i,
+        e
+      ), i;
+    const $ = v.inheritance, x = typeof $ == "object" ? $ : void 0;
+    let m;
+    if (d.startsWith("event-")) {
+      const u = d.slice(6);
+      if (x !== void 0)
+        m = x.indexedEvents?.[u];
+      else if (a.events !== void 0)
+        for (let p = 0; p < a.events.length; ++p) {
+          const C = a.events[p];
+          if (u === C.name) {
+            m = C;
+            break;
+          }
+        }
+    } else if (d.startsWith("slot-")) {
+      const u = d.slice(5);
+      if (x !== void 0)
+        m = x.indexedSlots?.[u];
+      else if (a.slots !== void 0)
+        for (let p = 0; p < a.slots.length; ++p) {
+          const C = a.slots[p];
+          if (u === C.name) {
+            m = C;
+            break;
+          }
+        }
+      m?.name === "" && (o ||= `${T(a)}.default-slot`);
+    } else if (d.startsWith("--")) {
+      if (x !== void 0)
+        m = x.indexedCssProperties?.[d];
+      else if (a.cssProperties !== void 0)
+        for (let u = 0; u < a.cssProperties.length; ++u) {
+          const p = a.cssProperties[u];
+          if (d === p.name) {
+            m = p;
+            break;
+          }
+        }
+    } else if (x?.indexedMembers !== void 0 && (m = x.indexedMembers[d] ?? x.indexedMembers[`static ${d}`]), m === void 0 && a.members !== void 0) {
+      for (let u = 0; u < a.members.length; ++u) {
+        const p = a.members[u];
+        if (d === p.name) {
+          m = p;
+          break;
+        }
+      }
+      if (m === void 0 && !e.config.strict && e.isComponentProject && a.events !== void 0)
+        for (let u = 0; u < a.events.length; ++u) {
+          const p = a.events[u];
+          if (d === p.name) {
+            m = p, b = b.replace("#", "#event-");
+            break;
+          }
+        }
+    }
+    return m === void 0 ? (e.config.verify.detectBrokenLinks ? g("Failed to find the referenced class member", i, e) : e.silencedBrokenLinkCount += 1, i) : (P(e, i, m), `[${o || (c ? T(m) : `${T(a)}.${T(m)}`)}](${b})`);
+  } else {
+    P(e, i, v.index.class);
+    const c = v.index.class === void 0 ? B(r) : T(v.index.class);
+    return `[${o || c}](${b})`;
+  }
+}
+function O(e, i, n, t) {
+  let s;
+  if (t.isComponentProject && typeof t.config.documentation.getComponentDocsUrl == "function" && e.startsWith("components/")) {
+    const o = e.slice(11), l = o.indexOf("/"), d = l === -1 ? o : o.slice(0, l), r = t.config.documentation.getComponentDocsUrl(d, M(d));
+    r !== void 0 && (s = r + (l === -1 ? "" : o.slice(l + 1)));
+  }
+  return s ??= `${t.normalizedApiReferencePrefix}${e}/`, U(s, i, n);
+}
+function U(e, i, n) {
+  return i !== void 0 ? n === void 0 ? `${e}#${encodeURIComponent(i)}` : `${e}#${encodeURIComponent(i)}-${encodeURIComponent(n)}` : n !== void 0 ? `${e}#${encodeURIComponent(n)}` : e;
+}
+function B(e) {
+  const i = e.lastIndexOf("/");
+  return i === -1 ? e : e.slice(i + 1);
+}
+const de = (e) => `/javascript/latest/references/${e}/`;
+function P(e, i, n) {
+  const t = e.typeVerifier?.linkSource;
+  t === void 0 || n?.docsTags?.includes(y.internal) !== !0 || t.docsTags?.includes(y.internal) !== !0 && g("@public API must not link to @internal API - leads to 404 in public doc", i, e);
+}
+export {
+  O as a,
+  U as b,
+  q as c,
+  Z as d,
+  Q as e,
+  X as f,
+  de as g,
+  K as h,
+  z as i,
+  ee as j,
+  Y as k,
+  y as l,
+  G as m,
+  ne as n,
+  te as o,
+  ie as p,
+  se as q,
+  oe as r
+};

package/dist/chunks/privateContext.js

@@ -73,13 +73,13 @@ function l(t) {
   return t[e];
 }
 export {
-  f as a,
-  C as b,
-  v as c,
-  u as d,
-  s as e,
+  s as a,
+  x as b,
+  u as c,
+  C as d,
+  f as e,
   l as f,
-  x as g,
+  v as g,
   p as h,
   c as i,
   a as j,

package/dist/diff/apiDiffToMarkdown.js

@@ -1,4 +1,4 @@
-import { buildViewUrl as T } from "../extractor/processing/links.js";
+import { b as T } from "../chunks/links.js";
 function K({ modules: e }, t) {
   const o = {
     children: /* @__PURE__ */ new Map(),

package/dist/extractor/ApiExtractor.js

@@ -1,5 +1,5 @@
 import "../chunks/config.js";
-import "./processing/links.js";
+import "../chunks/links.js";
 import "typescript";
 import { A as x } from "../chunks/ApiExtractor.js";
 import "@arcgis/toolkit/function";

package/dist/extractor/config.js

@@ -5,7 +5,7 @@ import "@arcgis/node-toolkit/vite/typeScript";
 import "@arcgis/toolkit/function";
 import { l as f, m as g, r as x } from "../chunks/config.js";
 import "node:url";
-import "./processing/links.js";
+import "../chunks/links.js";
 export {
   f as loadApiExtractorConfig,
   g as mergeApiExtractorConfigs,