@arcgis/api-extractor 5.1.0-next.1 → 5.1.0-next.100

package/dist/diff/diffApiJson.js

@@ -1,142 +1,265 @@
-function M(r, a) {
-  const n = new Map(r.modules.map((e) => [e.path, e])), t = [];
-  for (const e of a.modules) {
-    const s = n.get(e.path), i = k(s, e, !0);
-    i !== void 0 && t.push(i), n.delete(e.path);
+function w(i, o) {
+  if (i.compiler?.name !== "@arcgis/core:manual" || i.compiler?.version !== "4.34")
+    return;
+  const a = {};
+  return i.modules.forEach((e) => {
+    a[e.path] = e;
+  }), {
+    ...o,
+    modules: o.modules.filter((e) => {
+      const t = a[e.path];
+      return e.declarations = e.declarations.filter((s) => {
+        if (s.kind === "mixin")
+          return !1;
+        if (s.kind === "interface") {
+          const r = t?.declarations.find(
+            (d) => d.name === s.name && d.kind === "interface"
+          );
+          return s.members = void 0, r !== void 0;
+        }
+        return !0;
+      }), e.declarations.length > 0;
+    })
+  };
+}
+function x(i) {
+  const o = /* @__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"
+  ]), a = i.modules.filter((n) => {
+    if (o.has(n.path))
+      return !1;
+    const e = n.path.startsWith("widgets/");
+    return n.declarations = n.declarations.filter((t) => e ? t.deprecated === void 0 && t.removed === void 0 ? !1 : ((t.kind === "class" || t.kind === "interface" || t.kind === "mixin") && (t.members = void 0), !0) : t.kind === "class" ? t.members === void 0 ? !0 : (t.members = t.members.filter((s) => !(s.kind === "constructor" || s.kind === "call-signature" || A.has(s.name))), t.members.length > 0) : !0), n.declarations.length > 0;
+  });
+  return { ...i, modules: a };
+}
+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 N(i, o) {
+  const a = w(i, o), n = a ?? o, e = i.compiler?.version.startsWith("4.") === !0 && n.compiler?.version.startsWith("4.") !== !0, t = new Map(
+    i.modules.map((d) => [
+      b(d, e),
+      d
+    ])
+  ), s = [];
+  for (const d of n.modules) {
+    const l = t.get(d.path), m = y(l, d, !0);
+    m !== void 0 && s.push(m), t.delete(d.path);
   }
-  for (const e of n.values()) {
-    const s = k(void 0, e, !1);
-    s !== void 0 && t.push(s);
+  for (const d of t.values()) {
+    const l = y(
+      void 0,
+      e ? { ...d, path: b(d, e) } : d,
+      !1
+    );
+    l !== void 0 && s.push(l);
   }
-  return { modules: t };
+  const r = { modules: s };
+  return a === void 0 ? r : x(r);
+}
+function b(i, o) {
+  return o ? i.declarations?.[0]?.importPath ?? i.path : i.path;
 }
-function k(r, a, n) {
-  const t = [], e = h(r?.declarations ?? []), s = h(a.declarations ?? []);
-  for (const i of s.values()) {
-    const o = i.at(-1), p = o.tagName, u = p ?? o.name, f = e.get(u);
-    e.delete(u);
-    const g = f === void 0 && !n ? !0 : void 0, m = n && // Only mark as deprecated if all overloads are deprecated
-    (i.length === 1 || i.every((d) => d.deprecated !== void 0)) ? o.deprecated : void 0, D = !m && f === void 0 && n ? !0 : void 0;
-    if (g || D) {
-      t.push({
-        kind: o.kind,
-        name: o.name,
-        tagName: p,
+function y(i, o, a) {
+  const n = [], e = h(i?.declarations ?? []), t = h(o.declarations ?? []);
+  for (const s of t.values()) {
+    const r = s.at(-1), d = r.tagName, l = d ?? r.name, m = e.get(l);
+    e.delete(l);
+    const g = m === void 0 && !a ? !0 : void 0, v = (
+      // Only mark as deprecated if all overloads are deprecated
+      s.length === 1 || s.every((c) => c.deprecated !== void 0) ? r.deprecated : void 0
+    ), k = !v && m === void 0 && a ? !0 : void 0;
+    if (g || k) {
+      n.push({
+        kind: r.kind,
+        name: r.name,
+        tagName: d,
         members: void 0,
         removed: g,
-        added: D,
-        deprecated: m
+        added: k,
+        deprecated: v
       });
       continue;
-    } else if (!n)
+    } else if (!a)
       continue;
-    if (p !== void 0) {
-      const d = o, c = f?.[0], l = {
-        kind: d.kind,
-        name: d.name,
-        tagName: d.tagName,
-        deprecated: m,
+    if (d !== void 0) {
+      const c = r, u = m?.[0], f = {
+        kind: c.kind,
+        name: c.name,
+        tagName: c.tagName,
+        deprecated: v,
         added: void 0,
         removed: void 0,
-        members: b(c?.members, d.members),
-        events: v(c?.events, d.events),
-        slots: v(c?.slots, d.slots),
-        cssParts: v(c?.cssParts, d.cssParts),
-        cssProperties: v(c?.cssProperties, d.cssProperties),
-        cssStates: v(c?.cssStates, d.cssStates)
+        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)
       };
-      (m !== void 0 || l.members !== void 0 || l.events !== void 0 || l.slots !== void 0 || l.cssParts !== void 0 || l.cssProperties !== void 0 || l.cssStates !== void 0) && t.push(l);
-    } else if (o.kind === "class" || o.kind === "interface" || o.kind === "mixin") {
-      const d = f?.[0], c = {
-        kind: o.kind,
-        name: o.name,
-        deprecated: m,
+      (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) && n.push(f);
+    } else if (r.kind === "class" || r.kind === "interface" || r.kind === "mixin") {
+      const c = m?.[0], u = {
+        kind: r.kind,
+        name: r.name,
+        deprecated: v,
         added: void 0,
         removed: void 0,
-        members: b(d?.members, o.members),
-        events: "events" in o ? v(d?.events, o.events) : void 0
+        members: M(c?.members, r.members),
+        events: "events" in r ? p(c?.events, r.events) : void 0
       };
-      (m !== void 0 || c.members !== void 0 || c.events !== void 0) && t.push(c);
-    } else m !== void 0 && t.push({
-      kind: o.kind,
-      name: o.name,
-      deprecated: m,
+      (v !== void 0 || u.members !== void 0 || u.events !== void 0) && n.push(u);
+    } else v !== void 0 && n.push({
+      kind: r.kind,
+      name: r.name,
+      deprecated: v,
       added: void 0,
       removed: void 0
     });
   }
-  if (n)
-    for (const [i] of e.values())
-      t.push({
-        kind: i.kind,
-        name: i.name,
-        tagName: i.tagName,
+  if (a)
+    for (const [s] of e.values())
+      n.push({
+        kind: s.kind,
+        name: s.name,
+        tagName: s.tagName,
         members: void 0,
         removed: !0,
         added: void 0,
-        deprecated: void 0
+        deprecated: s.deprecated
       });
-  if (t.length !== 0)
+  if (n.length !== 0)
     return {
-      path: a.path,
-      declarations: t
+      path: o.path,
+      declarations: n
     };
 }
-function h(r) {
-  const a = /* @__PURE__ */ new Map();
-  for (let n = 0; n < r.length; ++n) {
-    const t = r[n], e = t.tagName ?? t.name ?? t.kind, s = a.get(e);
-    s === void 0 ? a.set(e, [t]) : s.push(t);
+function h(i) {
+  const o = /* @__PURE__ */ new Map();
+  for (let a = 0; a < i.length; ++a) {
+    const n = i[a], e = n.tagName ?? n.name ?? n.kind, t = o.get(e);
+    P(n.docsTags) || (t === void 0 ? o.set(e, [n]) : t.push(n));
+  }
+  return o;
+}
+function P(i) {
+  if (i !== void 0) {
+    for (let o = 0; o < i.length; ++o)
+      if (i[o].name === "internal")
+        return !0;
   }
-  return a;
+  return !1;
 }
-function v(r, a) {
-  const n = h(r ?? []), t = [];
-  if (a !== void 0)
-    for (const e of a)
-      n.get(e.name) === void 0 ? t.push({
+function p(i, o) {
+  const a = h(i ?? []), n = [];
+  if (o !== void 0)
+    for (const e of o)
+      a.get(e.name) === void 0 ? n.push({
         name: e.name,
         added: !0
-      }) : e.deprecated && t.push({
+      }) : e.deprecated && n.push({
         name: e.name,
         deprecated: e.deprecated
-      }), n.delete(e.name);
-  for (const [e] of n.values())
-    t.push({
+      }), a.delete(e.name);
+  for (const [e] of a.values())
+    n.push({
       name: e.name,
-      removed: !0
+      removed: !0,
+      deprecated: e.deprecated
     });
-  return t.length ? t : void 0;
+  return n.length ? n : void 0;
 }
-function b(r, a) {
-  const n = h(r ?? []), t = h(a ?? []), e = [];
-  for (const [s, i] of t.entries()) {
-    const o = i.at(-1), p = n.get(s);
-    n.delete(s);
-    const u = (
+function M(i, o) {
+  const a = h(i ?? []), n = h(o ?? []), e = [];
+  for (const [t, s] of n.entries()) {
+    const r = s.at(-1), d = a.get(t);
+    a.delete(t);
+    const l = (
       // Only mark as deprecated if all overloads are deprecated
-      i.length === 1 || i.every((g) => g.deprecated !== void 0) ? o.deprecated : void 0
-    ), f = s === "constructor" || s === "call-signature" ? void 0 : s;
-    u ? e.push({
-      kind: o.kind,
-      name: f,
-      deprecated: u
-    }) : p === void 0 && e.push({
-      kind: o.kind,
-      name: f,
+      s.length === 1 || s.every((g) => g.deprecated !== void 0) ? r.deprecated : void 0
+    ), m = t === "constructor" || t === "call-signature" ? void 0 : t;
+    l ? e.push({
+      kind: r.kind,
+      name: m,
+      deprecated: l
+    }) : d === void 0 && e.push({
+      kind: r.kind,
+      name: m,
       added: !0
     });
   }
-  for (const [s, [i]] of n.entries()) {
-    const o = s === "constructor" || s === "call-signature" ? void 0 : s;
+  for (const [t, [s]] of a.entries()) {
+    const r = t === "constructor" || t === "call-signature" ? void 0 : t;
     e.push({
-      kind: i.kind,
-      name: o,
-      removed: !0
+      kind: s.kind,
+      name: r,
+      removed: !0,
+      deprecated: s.deprecated
     });
   }
   return e.length ? e : void 0;
 }
 export {
-  M as diffApiJson
+  N as diffApiJson
 };

package/dist/diff/types.d.ts

@@ -26,8 +26,9 @@ export interface ApiDiffBase {
    */
   added?: true;
   /**
-   * Whether this declaration is deprecated in the new api.json, regardless of
-   * whether it was deprecated in the old api.json.
+   * Whether this declaration is deprecated in the new api.json. If declaration
+   * was removed, but was deprecated in the old api.json, this will show the old
+   * deprecation message as it points at the replacement API.
    * If the value is a string, it's the reason for the deprecation.
    * Deprecated takes precedence over added.
    *

package/dist/extractor/ApiExtractor.js

@@ -1,8 +1,8 @@
-import "../typeScript-D4_nAmBW.js";
-import "../worker-Btg0KdqM.js";
+import "../typeScript-CjWB1rJ_.js";
+import "../worker-OTZkb-ju.js";
 import "./processing/links.js";
 import "typescript";
-import { A as x } from "../ApiExtractor-DByayOhi.js";
+import { A as x } from "../ApiExtractor-KGzi9B02.js";
 import "@arcgis/toolkit/function";
 export {
   x as ApiExtractor

package/dist/extractor/config.d.ts

@@ -186,7 +186,7 @@ export interface ApiExtractorTypesConfig {
    * anyway, this option deduplicates work by removing the need for you to run
    * type checking separately.
    *
-   * @default // false if running standalone. true if running in Vite.
+   * @default // false if running standalone or in storybook. true if running in Vite.
    */
   readonly fullTypeCheck?: boolean;
   /**
@@ -279,14 +279,23 @@ export type TypeReplacements = Record<string, Record<string, readonly [modulePat
 export interface ApiExtractorDocumentationConfig {
   readonly copyDocDefinitions?: CopyDocDefinitions;
   readonly noInheritMembers?: NoInheritMembers;
+  /**
+   * Whether to omit \@internal APIs from api.json.
+   * This can only be disabled if not emitting .d.ts files.
+   * Otherwise, you can manually filter out nodes that have
+   * .docsTags[].name==="internal" in the api.json.
+   *
+   * @default false
+   */
+  readonly omitInternal?: boolean;
   /**
    * Get a prefix for a public-facing URL for each component story.
    *
    * @see https://webgis.esri.com/references/support-packages/storybook
    * @example
-   * Set this to "https://developers.arcgis.com/javascript/latest/storybook/map-components/".
+   * Set this to "https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html".
    * This will produce URLs like
-   * "https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-area-measurement-2d--demo&singleStory=true"
+   * "https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-area-measurement-2d--demo&singleStory=true"
    */
   readonly publicStoryUrlPrefix?: string | false;
   /**

package/dist/extractor/config.js

@@ -1,18 +1,17 @@
 import "@arcgis/components-build-utils";
-import "../typeScript-D4_nAmBW.js";
-import { l as n, m as A, r as C } from "../worker-Btg0KdqM.js";
+import "../typeScript-CjWB1rJ_.js";
+import { l, m as n, r as A } from "../worker-OTZkb-ju.js";
 import "./processing/links.js";
 import "typescript";
 import "fs/promises";
-import "chalk";
-import "util";
+import "node:util";
 import "@arcgis/toolkit/string";
-import "../apiHelpers-BYzO767m.js";
+import "../utils/apiHelpers.js";
 import "@arcgis/toolkit/function";
 import "node:fs";
 import "node:url";
 export {
-  n as loadApiExtractorConfig,
-  A as mergeApiExtractorConfigs,
-  C as resolveApiExtractorConfig
+  l as loadApiExtractorConfig,
+  n as mergeApiExtractorConfigs,
+  A as resolveApiExtractorConfig
 };

package/dist/extractor/extractors/copyDoc.d.ts

@@ -1,6 +1,6 @@
 import type { ApiClassDeclaration, ApiClassMethod, ApiCustomElementDeclaration, ApiCustomElementField, ApiEvent, ApiFunctionDeclaration, ApiInterfaceDeclaration, ApiModule, ApiVariableDeclaration } from "../../apiJson.js";
 
-/** [Documentation](https://webgis.esri.com/webgis/core/core/documenting-api#copydoc) */
+/** [Documentation](https://webgis.esri.com/sdk/contributing/core/core/documenting-api#copydoc) */
 export interface CopyDocDefinitions {
   properties?: CopyDocMemberDeclarations<ApiCustomElementField>;
   methods?: CopyDocMemberDeclarations<ApiClassMethod>;