@arcgis/api-extractor 6.0.0-next.2 → 6.0.0-next.21

package/dist/diff/diffApiJson.js

@@ -1,260 +1,161 @@
-function w(r, a) {
-  if (r.compiler?.name !== "@arcgis/core:manual" || r.compiler?.version !== "4.34")
-    return;
-  const o = {};
-  return r.modules.forEach((t) => {
-    o[t.path] = t;
-  }), {
-    ...a,
-    modules: a.modules.filter((t) => {
-      const e = o[t.path];
-      return t.declarations = t.declarations.filter((n) => {
-        if (n.kind === "mixin")
-          return !1;
-        if (n.kind === "interface") {
-          const s = e?.declarations.find(
-            (d) => d.name === n.name && d.kind === "interface"
-          );
-          return n.members = void 0, s !== void 0;
-        }
-        return !0;
-      }), t.declarations.length > 0;
-    })
-  };
-}
-function x(r) {
-  const a = /* @__PURE__ */ new Set([
-    // Fake class turned into a variable
-    "config",
-    // Wasn't visible directly before due to doc mismatch
-    "identity/IdentityManagerBase",
-    // Fake class turned into a variable
-    "identity/IdentityManager",
-    // Fake class turned into an interface
-    "views/layers/GeoRSSLayerView",
-    "views/layers/GraphicsLayerView",
-    "views/layers/KMLLayerView",
-    "views/layers/VectorTileLayerView",
-    "views/layers/PointCloudLayerView",
-    // ENUM-like objects turned into const variable + interfaces
-    "layers/support/rasterFunctionConstants"
-  ]), o = r.modules.filter((i) => {
-    if (a.has(i.path))
-      return !1;
-    const t = i.path.startsWith("widgets/");
-    return i.declarations = i.declarations.filter((e) => t ? e.deprecated === void 0 && e.removed === void 0 ? !1 : ((e.kind === "class" || e.kind === "interface" || e.kind === "mixin") && (e.members = void 0), !0) : e.kind === "class" ? e.members === void 0 ? !0 : (e.members = e.members.filter((n) => !(n.kind === "constructor" || n.kind === "call-signature" || A.has(n.name))), e.members.length > 0) : !0), i.declarations.length > 0;
-  });
-  return { ...r, modules: o };
-}
-const A = /* @__PURE__ */ new Set([
-  // Excluded from api.json inheritance to keep file size in check
-  "addHandles",
-  "hasHandles",
-  "removeHandles",
-  // These are coming from mixins. Exclude them from the diff to reduce noise
-  // compared to more valuable new 5.0 fields.
-  // Added 77 times
-  "emit",
-  // 77
-  "hasEventListener",
-  // 73
-  "fromJSON",
-  // 72
-  "on",
-  // 71
-  "toJSON",
-  // 63
-  "declaredClass",
-  // 63
-  "getAtOrigin",
-  // 63
-  "originOf",
-  // 63
-  "revertAllToOrigin",
-  // 63
-  "revertToOrigin",
-  // 54
-  "clone",
-  // 50
-  "fromPortalItem",
-  // 49
-  "fromArcGISServerUrl",
-  // 28
-  "isFulfilled",
-  // 28
-  "isRejected",
-  // 28
-  "isResolved",
-  // 28
-  "when",
-  // 6
-  "cancelLoad",
-  // 6
-  "loadError",
-  // 6
-  "loadStatus",
-  // 6
-  "loadWarnings"
-]);
-function I(r, a) {
-  const o = w(r, a), i = o ?? a, t = r.compiler?.version.startsWith("4.") === !0 && i.compiler?.version.startsWith("4.") !== !0, e = new Map(
-    r.modules.map((d) => [
-      b(d, t),
-      d
+function P(a, d) {
+  const i = a.compiler?.version.startsWith("4.") === !0 && d.compiler?.version.startsWith("4.") !== !0, n = new Map(
+    a.modules.map((e) => [
+      D(e, i),
+      e
     ])
-  ), n = [];
-  for (const d of i.modules) {
-    const l = e.get(d.path), m = y(l, d, !0);
-    m !== void 0 && n.push(m), e.delete(d.path);
+  ), o = [];
+  for (const e of d.modules) {
+    const s = n.get(e.path), t = b(s, e, !0);
+    t !== void 0 && o.push(t), n.delete(e.path);
   }
-  for (const d of e.values()) {
-    const l = y(
+  for (const e of n.values()) {
+    const s = b(
       void 0,
-      t ? { ...d, path: b(d, t) } : d,
+      i ? { ...e, path: D(e, i) } : e,
       !1
     );
-    l !== void 0 && n.push(l);
+    s !== void 0 && o.push(s);
   }
-  const s = { modules: n };
-  return o === void 0 ? s : x(s);
+  return { modules: o };
 }
-function b(r, a) {
-  return a ? r.declarations?.[0]?.importPath ?? r.path : r.path;
+function D(a, d) {
+  return d ? a.declarations?.[0]?.importPath ?? a.path : a.path;
 }
-function y(r, a, o) {
-  const i = [], t = h(r?.declarations ?? []), e = h(a.declarations ?? []);
-  for (const n of e.values()) {
-    const s = n.at(-1), d = s.tagName, l = d ?? s.name, m = t.get(l);
-    t.delete(l);
-    const g = m === void 0 && !o ? !0 : void 0, v = (
+function b(a, d, i) {
+  const n = [], o = u(a?.declarations ?? []), e = u(d.declarations ?? []);
+  for (const s of e.values()) {
+    const t = s.at(-1), f = t.tagName, h = f ?? t.name, p = o.get(h);
+    o.delete(h);
+    const g = p === void 0 && !i ? !0 : void 0, m = (
       // Only mark as deprecated if all overloads are deprecated
-      n.length === 1 || n.every((c) => c.deprecated !== void 0) ? s.deprecated : void 0
-    ), k = !v && m === void 0 && o ? !0 : void 0;
+      s.length === 1 || s.every((r) => r.deprecated !== void 0) ? t.deprecated : void 0
+    ), k = !m && p === void 0 && i ? !0 : void 0;
     if (g || k) {
-      i.push({
-        kind: s.kind,
-        name: s.name,
-        tagName: d,
+      n.push({
+        kind: t.kind,
+        name: t.name,
+        tagName: f,
         members: void 0,
         removed: g,
         added: k,
-        deprecated: v
+        deprecated: m
       });
       continue;
-    } else if (!o)
+    } else if (!i)
       continue;
-    if (d !== void 0) {
-      const c = s, u = m?.[0], f = {
-        kind: c.kind,
-        name: c.name,
-        tagName: c.tagName,
-        deprecated: v,
+    if (f !== void 0) {
+      const r = t, l = p?.[0], c = {
+        kind: r.kind,
+        name: r.name,
+        tagName: r.tagName,
+        deprecated: m,
         added: void 0,
         removed: void 0,
-        members: M(u?.members, c.members),
-        events: p(u?.events, c.events),
-        slots: p(u?.slots, c.slots),
-        cssParts: p(u?.cssParts, c.cssParts),
-        cssProperties: p(u?.cssProperties, c.cssProperties),
-        cssStates: p(u?.cssStates, c.cssStates)
+        members: M(l?.members, r.members),
+        events: v(l?.events, r.events),
+        slots: v(l?.slots, r.slots),
+        cssParts: v(l?.cssParts, r.cssParts),
+        cssProperties: v(l?.cssProperties, r.cssProperties),
+        cssStates: v(l?.cssStates, r.cssStates)
       };
-      (v !== void 0 || f.members !== void 0 || f.events !== void 0 || f.slots !== void 0 || f.cssParts !== void 0 || f.cssProperties !== void 0 || f.cssStates !== void 0) && i.push(f);
-    } else if (s.kind === "class" || s.kind === "interface" || s.kind === "mixin") {
-      const c = m?.[0], u = {
-        kind: s.kind,
-        name: s.name,
-        deprecated: v,
+      (m !== void 0 || c.members !== void 0 || c.events !== void 0 || c.slots !== void 0 || c.cssParts !== void 0 || c.cssProperties !== void 0 || c.cssStates !== void 0) && n.push(c);
+    } else if (t.kind === "class" || t.kind === "interface" || t.kind === "mixin") {
+      const r = p?.[0], l = m !== void 0 && (r?.kind === "class" || r?.kind === "interface") && t.kind === "interface" && t.type === void 0 && (t.supertypes?.length ?? 0) > 0 && (t.members?.length ?? 0) === 0, c = {
+        kind: t.kind,
+        name: t.name,
+        deprecated: m,
         added: void 0,
         removed: void 0,
-        members: M(c?.members, s.members),
-        events: "events" in s ? p(c?.events, s.events) : void 0
+        members: l ? void 0 : M(r?.members, t.members),
+        events: !l && "events" in t ? v(r?.events, t.events) : void 0
       };
-      (v !== void 0 || u.members !== void 0 || u.events !== void 0) && i.push(u);
-    } else v !== void 0 && i.push({
-      kind: s.kind,
-      name: s.name,
-      deprecated: v,
+      (m !== void 0 || c.members !== void 0 || c.events !== void 0) && n.push(c);
+    } else m !== void 0 && n.push({
+      kind: t.kind,
+      name: t.name,
+      deprecated: m,
       added: void 0,
       removed: void 0
     });
   }
-  if (o)
-    for (const [n] of t.values())
-      i.push({
-        kind: n.kind,
-        name: n.name,
-        tagName: n.tagName,
+  if (i)
+    for (const [s] of o.values())
+      n.push({
+        kind: s.kind,
+        name: s.name,
+        tagName: s.tagName,
         members: void 0,
         removed: !0,
         added: void 0,
-        deprecated: n.deprecated
+        deprecated: s.deprecated
       });
-  if (i.length !== 0)
+  if (n.length !== 0)
     return {
-      path: a.path,
-      declarations: i
+      path: d.path,
+      declarations: n
     };
 }
-function h(r) {
-  const a = /* @__PURE__ */ new Map();
-  for (let o = 0; o < r.length; ++o) {
-    const i = r[o], t = i.tagName ?? i.name ?? i.kind, e = a.get(t);
-    P(i.docsTags) || (e === void 0 ? a.set(t, [i]) : e.push(i));
+function u(a) {
+  const d = /* @__PURE__ */ new Map();
+  for (let i = 0; i < a.length; ++i) {
+    const n = a[i], o = n.tagName ?? n.name ?? n.kind, e = d.get(o);
+    A(n.docsTags) || (e === void 0 ? d.set(o, [n]) : e.push(n));
   }
-  return a;
+  return d;
 }
-function P(r) {
-  if (r !== void 0) {
-    for (let a = 0; a < r.length; ++a)
-      if (r[a].name === "internal")
+function A(a) {
+  if (a !== void 0) {
+    for (let d = 0; d < a.length; ++d)
+      if (a[d].name === "internal")
         return !0;
   }
   return !1;
 }
-function p(r, a) {
-  const o = h(r ?? []), i = h(a ?? []), t = [];
-  for (const [e, n] of i) {
-    const s = n.at(-1), d = o.get(e)?.at(-1);
-    o.delete(e), d === void 0 ? t.push({ name: e, added: !0 }) : s.deprecated && t.push({ name: e, deprecated: s.deprecated });
+function v(a, d) {
+  const i = u(a ?? []), n = u(d ?? []), o = [];
+  for (const [e, s] of n) {
+    const t = s.at(-1), f = i.get(e)?.at(-1);
+    i.delete(e), f === void 0 ? o.push({ name: e, added: !0 }) : t.deprecated && o.push({ name: e, deprecated: t.deprecated });
   }
-  for (const [e] of o.values())
-    t.push({
+  for (const [e] of i.values())
+    o.push({
       name: e.name,
       removed: !0,
       deprecated: e.deprecated
     });
-  return t.length ? t : void 0;
+  return o.length ? o : void 0;
 }
-function M(r, a) {
-  const o = h(r ?? []), i = h(a ?? []), t = [];
-  for (const [e, n] of i.entries()) {
-    const s = n.at(-1), d = o.get(e);
-    o.delete(e);
-    const l = (
+function M(a, d) {
+  const i = u(a ?? []), n = u(d ?? []), o = [];
+  for (const [e, s] of n.entries()) {
+    const t = s.at(-1), f = i.get(e);
+    i.delete(e);
+    const h = (
       // Only mark as deprecated if all overloads are deprecated
-      n.length === 1 || n.every((g) => g.deprecated !== void 0) ? s.deprecated : void 0
-    ), m = e === "constructor" || e === "call-signature" ? void 0 : e;
-    l ? t.push({
-      kind: s.kind,
-      name: m,
-      deprecated: l
-    }) : d === void 0 && t.push({
-      kind: s.kind,
-      name: m,
+      s.length === 1 || s.every((g) => g.deprecated !== void 0) ? t.deprecated : void 0
+    ), p = e === "constructor" || e === "call-signature" ? void 0 : e;
+    h ? o.push({
+      kind: t.kind,
+      name: p,
+      deprecated: h
+    }) : f === void 0 && o.push({
+      kind: t.kind,
+      name: p,
       added: !0
     });
   }
-  for (const [e, [n]] of o.entries()) {
-    const s = e === "constructor" || e === "call-signature" ? void 0 : e;
-    t.push({
-      kind: n.kind,
-      name: s,
+  for (const [e, [s]] of i.entries()) {
+    const t = e === "constructor" || e === "call-signature" ? void 0 : e;
+    o.push({
+      kind: s.kind,
+      name: t,
       removed: !0,
-      deprecated: n.deprecated
+      deprecated: s.deprecated
     });
   }
-  return t.length ? t : void 0;
+  return o.length ? o : void 0;
 }
 export {
-  I as diffApiJson
+  P as diffApiJson
 };

package/dist/extractor/config.d.ts

@@ -405,6 +405,12 @@ export interface ApiExtractorVerifyConfig {
 
 /**
  * Don't include these members in each subclass to keep api reference pages cleaner.
+ *
+ * For example, if all classes in a package extend the same base class, rather
+ * than inheriting members from the base class, and inflating each reference
+ * page, create a guide page for the common patterns coming from the base class
+ * and link to that guide page above the members reference table.
+ *
  * These has no types impact since their inheritance is still done by TypeScript.
  *
  * The structure maps module path to the list of class members inside that module.

package/dist/utils/partPrinter.js

@@ -1,4 +1,4 @@
-import { f as l } from "../chunks/privateContext.js";
+import { f as u } from "../chunks/privateContext.js";
 function m(t, r, i, e, n, o) {
   return `${`${r ? "export default " : "export "}${t ? "abstract " : ""}`}class ${i}${c(e)}${n === void 0 ? "" : ` extends ${n}`} {${o}}`;
 }
@@ -14,29 +14,29 @@ function c(t) {
 }
 function v(t, r, i, e, n) {
   const o = t ? "export default " : "export ";
-  let $ = "";
+  let f = "";
   if (e !== void 0) {
-    $ = " extends ";
-    for (let f = 0; f < e.length; ++f)
-      $ += l(e[f]), f < e.length - 1 && ($ += ", ");
+    f = " extends ";
+    for (let $ = 0; $ < e.length; ++$)
+      f += u(e[$]), $ < e.length - 1 && (f += ", ");
   }
-  return `${o}interface ${r}${c(i)}${$} {${n}}`;
+  return `${o}interface ${r}${c(i)}${f} {${n}}`;
 }
-function g(t, r, i, e, n, o, $, f) {
-  const s = `${t ? "protected " : ""}${r ? "abstract " : ""}${i ? "static " : ""}`, x = f === void 0 ? "" : `: ${f}`;
-  return `${s}${n === "" ? "" : d(n)}${e ? "?" : ""}${c(o)}(${a($)})${x};`;
+function g(t, r, i, e, n, o, f, $) {
+  const s = `${t ? "protected " : ""}${r ? "abstract " : ""}${i ? "static " : ""}`, d = $ === void 0 ? "" : `: ${$}`;
+  return `${s}${n === "" ? "" : a(n)}${e ? "?" : ""}${c(o)}(${l(f)})${d};`;
 }
-function d(t) {
-  return u.test(t) || t.startsWith("[") ? t : `"${t.replaceAll("\\", "\\\\").replaceAll('"', '\\"')}"`;
+function a(t) {
+  return x.test(t) || t.startsWith("[") ? t : `"${t.replaceAll("\\", "\\\\").replaceAll('"', '\\"')}"`;
 }
-const h = (t) => !u.test(t) && !t.startsWith("["), u = /^[A-Za-z_$][A-Za-z0-9_$]*$/u;
+const h = (t) => !x.test(t) && !t.startsWith("["), x = /^[A-Za-z_$][A-Za-z0-9_$]*$/u;
 function b(t, r, i, e, n) {
-  return `${t ? "export default " : "export "}function ${r}${c(i)}(${a(e)}): ${n};`;
+  return `${t ? "export default " : "export "}function ${r}${c(i)}(${l(e)}): ${n};`;
 }
 function A(t) {
-  return `${c(t.typeParameters)}(${a(t.parameters)}): ${t.return.type.text}`;
+  return `${c(t.typeParameters)}(${l(t.parameters)}): ${t.return.type.text}`;
 }
-function a(t) {
+function l(t) {
   if (t === void 0)
     return "";
   let r = "";
@@ -46,13 +46,14 @@ function a(t) {
   }
   return r;
 }
-function P(t, r, i, e, n, o, $, f) {
-  return `${`${t ? "protected " : ""}${r ? "abstract " : i ? "static " : ""}${e ? "readonly " : n ? "accessor " : ""}`}${d($)}${o ? "?" : ""}: ${f};`;
+function P(t, r, i, e, n, o, f, $) {
+  return `${`${t ? "protected " : ""}${r ? "abstract " : i ? "static " : ""}${e ? "readonly " : n ? "accessor " : ""}`}${a(f)}${o ? "?" : ""}: ${$};`;
 }
-function N(t, r, i, e, n, o) {
-  const $ = `${t ? "protected " : ""}${r ? "abstract " : ""}${i ? "static " : ""}`, f = d(e), s = o === void 0 ? "" : `
-${$}set ${f}(value: ${o});`;
-  return `${$}get ${f}(): ${n};${s}`;
+function N(t, r, i, e, n, o, f = !1) {
+  const $ = `${t ? "protected " : ""}${r ? "abstract " : ""}${i ? "static " : ""}`, s = a(e), d = o === void 0 ? "" : `
+${f ? `/** @deprecated */
+` : ""}${$}set ${s}(value: ${o});`;
+  return `${$}get ${s}(): ${n};${d}`;
 }
 function z(t, r, i) {
   const n = `${t ? "declare " : "export "}const ${r}: ${i};`;
@@ -63,13 +64,13 @@ function R(t, r, i, e) {
   let n = `export type ${t}${c(r)} = `;
   if (i !== void 0)
     for (let o = 0; o < i.length; ++o)
-      n += l(i[o]), (o < i.length - 1 || e !== void 0) && (n += `
+      n += u(i[o]), (o < i.length - 1 || e !== void 0) && (n += `
   & `);
   return e !== void 0 && (n += e), n += ";", n;
 }
 export {
   h as isPropertyEscapeNeeded,
-  d as maybeEscapePropertyName,
+  a as maybeEscapePropertyName,
   m as printClass,
   b as printFunction,
   N as printGetterSetter,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcgis/api-extractor",
-  "version": "6.0.0-next.2",
+  "version": "6.0.0-next.21",
   "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": "6.0.0-next.2",
-    "@arcgis/toolkit": "6.0.0-next.2",
+    "@arcgis/node-toolkit": "6.0.0-next.21",
+    "@arcgis/toolkit": "6.0.0-next.21",
     "@commander-js/extra-typings": "^15.0.0",
     "commander": "^15.0.0",
     "tslib": "^2.8.1"