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

package/dist/extractor/processing/links.js

@@ -1,175 +1,14 @@
-import { styleText as C } from "node:util";
-import { emitJsDocError as a, getApiNodeLabel as h } from "../../utils/apiHelpers.js";
-import { c as y } from "../../chunks/privateContext.js";
-import { kebabToPascal as I } from "@arcgis/toolkit/string";
-function W(e, n) {
-  if (typeof e == "string") {
-    const i = e.replaceAll(F, n.resolveJsDocLink).replaceAll(n.config.documentation.alternativeHost, n.config.documentation.host);
-    return e.includes("](.") && a(P, e, n), i;
-  }
-  return e;
-}
-function j(e, n) {
-  if (e) {
-    const i = e.replaceAll(F, n.resolveJsDocLink).replaceAll(n.config.documentation.alternativeHost, n.config.documentation.host);
-    return i.includes("](.") && a(P, i, n), i;
-  }
-  return e;
-}
-function J(e, n) {
-  if (e !== void 0 && n.inheritedModuleName === void 0)
-    for (let i = 0; i < e.length; ++i) {
-      const d = e[i];
-      d.text && (d.text = d.text.replaceAll(F, n.resolveJsDocLink).replaceAll(n.config.documentation.alternativeHost, n.config.documentation.host), d.text.includes("](.") && a(P, d.text, n));
-    }
-}
-const P = "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 N(e, n, i) {
-  let d = i.indexOf(" ");
-  d === -1 && (d = i.length);
-  const m = i.slice(0, d);
-  let u = i.slice(d + 1);
-  if (m.startsWith("https://"))
-    return e.config.strict ? (a(
-      "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)",
-      n,
-      e
-    ), "") : `[${u || m}](${m})`;
-  const [k, s] = m.split("#"), [c, L] = k.split("!");
-  if (c === "")
-    return a(
-      `Expected @link reference to start with a module name (before ! or #), but got: ${m}`,
-      n,
-      e
-    ), n;
-  let g = e.moduleMap.get(c);
-  if (g === void 0 && e.isComponentProject && !e.config.strict) {
-    for (const r of e.moduleMap.values())
-      if (y(r).index.class?.name === c) {
-        g = r;
-        break;
-      }
-  }
-  if (g === void 0)
-    return e.config.verify.detectBrokenLinks ? a(
-      `Failed to find referenced module: ${C("red", c)}${c.startsWith("module:") ? '. Module name in @link does not need the "module:" prefix' : c.startsWith("esri/") ? '. Module name in @link does not need to start with the "esri/" prefix.' : ""}`,
-      n,
-      e
-    ) : e.silencedBrokenLinkCount += 1, n;
-  const v = y(g), D = e.inheritedModuleName === void 0 ? e.apiModule : e.moduleMap.get(e.inheritedModuleName) ?? e.apiModule;
-  if (e.watchFiles !== void 0 && c !== D.path && y(D).isStale) {
-    const r = y(D).file.fileName.slice(e.config.context.cwd.length), t = v.file.fileName.slice(e.config.context.cwd.length);
-    e.watchFiles.get(r).docLinks.push(i), e.watchFiles.get(r).dependencies.add(t);
-    const $ = e.watchFiles.get(t).dependents;
-    $.has(r) || $.set(r, !1);
-  }
-  let b = M(g.path, L, s, e);
-  if (L !== void 0) {
-    const r = v.index.named[L];
-    return r === void 0 ? (e.config.verify.detectBrokenLinks ? a(
-      `Failed to find the referenced declaration inside the module: ${C("red", `${c}!${L}`)}`,
-      n,
-      e
-    ) : e.silencedBrokenLinkCount += 1, n) : r === v.index.class ? (a(
-      `Invalid reference syntax used. Class/mixin/custom element declarations must be referenced without specifying the class name. Expected ${C("green", c)}`,
-      n,
-      e
-    ), n) : `[${u || h(r)}](${b})`;
-  } else if (s !== void 0) {
-    const r = g.path === D.path, t = v.index.class;
-    if (t === void 0)
-      return v.index.named[s] === void 0 ? e.config.verify.detectBrokenLinks ? a(
-        '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-"',
-        n,
-        e
-      ) : e.silencedBrokenLinkCount += 1 : a(
-        `Invalid reference syntax used. This syntax is only permitted on modules that export a class/mixin/web component. Perhaps you meant to use ${C("red", `${c}!${s}`)} instead? Linking to properties in interfaces is not yet supported`,
-        n,
-        e
-      ), n;
-    const $ = v.inheritance, p = typeof $ == "object" ? $ : void 0;
-    let f;
-    if (s.startsWith("event-")) {
-      const o = s.slice(6);
-      if (p !== void 0)
-        f = p.indexedEvents?.[o];
-      else if (t.events !== void 0)
-        for (let l = 0; l < t.events.length; ++l) {
-          const w = t.events[l];
-          if (o === w.name) {
-            f = w;
-            break;
-          }
-        }
-    } else if (s.startsWith("slot-")) {
-      const o = s.slice(5);
-      if (p !== void 0)
-        f = p.indexedSlots?.[o];
-      else if (t.slots !== void 0)
-        for (let l = 0; l < t.slots.length; ++l) {
-          const w = t.slots[l];
-          if (o === w.name) {
-            f = w;
-            break;
-          }
-        }
-      f?.name === "" && (u ||= `${h(t)}.default-slot`);
-    } else if (s.startsWith("--")) {
-      if (p !== void 0)
-        f = p.indexedCssProperties?.[s];
-      else if (t.cssProperties !== void 0)
-        for (let o = 0; o < t.cssProperties.length; ++o) {
-          const l = t.cssProperties[o];
-          if (s === l.name) {
-            f = l;
-            break;
-          }
-        }
-    } else if (p?.indexedMembers !== void 0 && (f = p.indexedMembers[s] ?? p.indexedMembers[`static ${s}`]), f === void 0 && t.members !== void 0) {
-      for (let o = 0; o < t.members.length; ++o) {
-        const l = t.members[o];
-        if (s === l.name) {
-          f = l;
-          break;
-        }
-      }
-      if (f === void 0 && !e.config.strict && e.isComponentProject && t.events !== void 0)
-        for (let o = 0; o < t.events.length; ++o) {
-          const l = t.events[o];
-          if (s === l.name) {
-            f = l, b = b.replace("#", "#event-");
-            break;
-          }
-        }
-    }
-    return f === void 0 ? (e.config.verify.detectBrokenLinks ? a("Failed to find the referenced class member", n, e) : e.silencedBrokenLinkCount += 1, n) : `[${u || (r ? h(f) : `${h(t)}.${h(f)}`)}](${b})`;
-  } else {
-    const r = v.index.class === void 0 ? U(c) : h(v.index.class);
-    return `[${u || r}](${b})`;
-  }
-}
-function M(e, n, i, d) {
-  let m;
-  if (d.isComponentProject && typeof d.config.documentation.getComponentDocsUrl == "function" && e.startsWith("components/")) {
-    const u = e.slice(11), k = u.indexOf("/"), s = k === -1 ? u : u.slice(0, k), c = d.config.documentation.getComponentDocsUrl(s, I(s));
-    c !== void 0 && (m = c + (k === -1 ? "" : u.slice(k + 1)));
-  }
-  return m ??= `${d.normalizedApiReferencePrefix}${e}/`, x(m, n, i);
-}
-function x(e, n, i) {
-  return n !== void 0 ? i === void 0 ? `${e}#${encodeURIComponent(n)}` : `${e}#${encodeURIComponent(n)}-${encodeURIComponent(i)}` : i !== void 0 ? `${e}#${encodeURIComponent(i)}` : e;
-}
-function U(e) {
-  const n = e.lastIndexOf("/");
-  return n === -1 ? e : e.slice(n + 1);
-}
-const E = (e) => `/javascript/latest/references/${e}/`;
+import "node:util";
+import "../../utils/apiHelpers.js";
+import "../../chunks/privateContext.js";
+import "@arcgis/toolkit/string";
+import { b as i, g as p, a as c, n as l, o as m, q as D, r as g } from "../../chunks/links.js";
 export {
-  x as buildViewUrl,
-  E as getDefaultBasePath,
-  M as getViewUrl,
-  W as postProcessDeprecated,
-  j as postProcessDescription,
-  J as postProcessDocsTags,
-  N as resolveJsDocLink
+  i as buildViewUrl,
+  p as getDefaultBasePath,
+  c as getViewUrl,
+  l as postProcessDeprecated,
+  m as postProcessDescription,
+  D as postProcessDocsTags,
+  g as resolveJsDocLink
 };

package/dist/utils/apiHelpers.js

@@ -1,4 +1,4 @@
-import { c as f } from "../chunks/privateContext.js";
+import { g as f } from "../chunks/privateContext.js";
 const g = (e) => e.kind === "method", v = (e) => e.kind === "field";
 function h(e, n) {
   const o = e.sourcePath, i = n.sourcePath;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcgis/api-extractor",
-  "version": "5.2.0-next.125",
+  "version": "5.2.0-next.126",
   "description": "Documentation engine for WebGIS SDK packages",
   "type": "module",
   "main": "./dist/index.js",
@@ -48,8 +48,8 @@
   ],
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
-    "@arcgis/node-toolkit": "5.2.0-next.125",
-    "@arcgis/toolkit": "5.2.0-next.125",
+    "@arcgis/node-toolkit": "5.2.0-next.126",
+    "@arcgis/toolkit": "5.2.0-next.126",
     "@commander-js/extra-typings": "^15.0.0",
     "commander": "^15.0.0",
     "tslib": "^2.8.1"