@arcgis/api-extractor 5.1.0-next.81 → 5.1.0-next.82

package/dist/extractor/ApiExtractor.js

@@ -1,8 +1,8 @@
-import "../typeScript-K2y-5lid.js";
-import "../worker-CsceZ1rD.js";
+import "../typeScript-CTYzSexR.js";
+import "../worker-Bg39ooP0.js";
 import "./processing/links.js";
 import "typescript";
-import { A as x } from "../ApiExtractor-IYYCO-EG.js";
+import { A as x } from "../ApiExtractor-BFrq-vVd.js";
 import "@arcgis/toolkit/function";
 export {
   x as ApiExtractor

package/dist/extractor/config.d.ts

@@ -279,6 +279,15 @@ 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.
    *

package/dist/extractor/config.js

@@ -1,18 +1,17 @@
 import "@arcgis/components-build-utils";
-import "../typeScript-K2y-5lid.js";
-import { l as n, m as A, r as C } from "../worker-CsceZ1rD.js";
+import "../typeScript-CTYzSexR.js";
+import { l, m as n, r as A } from "../worker-Bg39ooP0.js";
 import "./processing/links.js";
 import "typescript";
 import "fs/promises";
-import "chalk";
-import "util";
+import "node:util";
 import "@arcgis/toolkit/string";
-import "../apiHelpers-dNwlX631.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/processing/links.js

@@ -1,29 +1,30 @@
-import C from "chalk";
-import { u as a, g as P, v as w } from "../../apiHelpers-dNwlX631.js";
+import { styleText as C } from "node:util";
+import { emitJsDocError as a, getApiNodeLabel as w } from "../../utils/apiHelpers.js";
+import { g as y } from "../../privateContext-CB7P40up.js";
 import { kebabToPascal as I } from "@arcgis/toolkit/string";
-function R(e, n) {
+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(y, e, n), i;
+    return e.includes("](.") && a(P, e, n), i;
   }
   return e;
 }
-function W(e, n) {
+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(y, i, n), i;
+    return i.includes("](.") && a(P, i, n), i;
   }
   return e;
 }
-function j(e, n) {
+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(y, d.text, n));
+      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 y = "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/webgis/core/core/documenting-api#link", F = /\{@link +([^}]+)\}/gu;
-function J(e, n, i) {
+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/webgis/core/core/documenting-api#link", F = /\{@link +([^}]+)\}/gu;
+function N(e, n, i) {
   let d = i.indexOf(" ");
   d === -1 && (d = i.length);
   const u = i.slice(0, d), m = i.slice(d + 1);
@@ -43,20 +44,20 @@ function J(e, n, i) {
   let k = e.moduleMap.get(f);
   if (k === void 0 && e.isComponentProject && !e.config.strict) {
     for (const r of e.moduleMap.values())
-      if (P(r).index.class?.name === f) {
+      if (y(r).index.class?.name === f) {
         k = r;
         break;
       }
   }
   if (k === void 0)
     return e.config.verify.detectBrokenLinks ? a(
-      `Failed to find referenced module: ${C.red(f)}${f.startsWith("module:") ? '. Module name in @link does not need the "module:" prefix' : f.startsWith("esri/") ? '. Module name in @link does not need to start with the "esri/" prefix.' : ""}`,
+      `Failed to find referenced module: ${C("red", f)}${f.startsWith("module:") ? '. Module name in @link does not need the "module:" prefix' : f.startsWith("esri/") ? '. Module name in @link does not need to start with the "esri/" prefix.' : ""}`,
       n,
       e
     ) : e.silencedBrokenLinkCount += 1, n;
-  const v = P(k), D = e.inheritedModuleName === void 0 ? e.apiModule : e.moduleMap.get(e.inheritedModuleName) ?? e.apiModule;
-  if (e.watchFiles !== void 0 && f !== D.path && P(D).isStale) {
-    const r = P(D).file.fileName.slice(e.config.context.cwd.length), s = v.file.fileName.slice(e.config.context.cwd.length);
+  const v = y(k), D = e.inheritedModuleName === void 0 ? e.apiModule : e.moduleMap.get(e.inheritedModuleName) ?? e.apiModule;
+  if (e.watchFiles !== void 0 && f !== D.path && y(D).isStale) {
+    const r = y(D).file.fileName.slice(e.config.context.cwd.length), s = v.file.fileName.slice(e.config.context.cwd.length);
     e.watchFiles.get(r).docLinks.push(i), e.watchFiles.get(r).dependencies.add(s);
     const b = e.watchFiles.get(s).dependents;
     b.has(r) || b.set(r, !1);
@@ -65,11 +66,11 @@ function J(e, n, i) {
   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(`${f}!${L}`)}`,
+      `Failed to find the referenced declaration inside the module: ${C("red", `${f}!${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(f)}`,
+      `Invalid reference syntax used. Class/mixin/custom element declarations must be referenced without specifying the class name. Expected ${C("green", f)}`,
       n,
       e
     ), n) : `[${m || w(r)}](${h})`;
@@ -81,7 +82,7 @@ function J(e, n, i) {
         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(`${f}!${t}`)} instead? Linking to properties in interfaces is not yet supported`,
+        `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", `${f}!${t}`)} instead? Linking to properties in interfaces is not yet supported`,
         n,
         e
       ), n;
@@ -160,13 +161,13 @@ function A(e) {
   const n = e.lastIndexOf("/");
   return n === -1 ? e : e.slice(n + 1);
 }
-const N = (e) => `/javascript/latest/references/${e}/`;
+const E = (e) => `/javascript/latest/references/${e}/`;
 export {
   U as buildViewUrl,
-  N as getDefaultBasePath,
+  E as getDefaultBasePath,
   M as getViewUrl,
-  R as postProcessDeprecated,
-  W as postProcessDescription,
-  j as postProcessDocsTags,
-  J as resolveJsDocLink
+  W as postProcessDeprecated,
+  j as postProcessDescription,
+  J as postProcessDocsTags,
+  N as resolveJsDocLink
 };

package/dist/privateContext-CB7P40up.js

@@ -0,0 +1,86 @@
+const e = /* @__PURE__ */ Symbol("privateContext");
+function s(t, o, i, n) {
+  return {
+    isStale: !0,
+    file: t,
+    dtsPath: o,
+    importsMap: i,
+    importsText: void 0,
+    constructorPropertiesInterface: void 0,
+    constructorOnlySetters: void 0,
+    constructorAutoCastType: void 0,
+    typeName: void 0,
+    inheritance: void 0,
+    index: n,
+    reExports: void 0,
+    namespaces: void 0
+  };
+}
+function a() {
+  return {
+    hasExplicitAbstract: void 0,
+    isDefaultExported: void 0,
+    eventTypesProperty: void 0,
+    isMixinBaseClass: void 0,
+    emitAsTypeAlias: void 0,
+    esriCompatibilityNames: void 0
+  };
+}
+function c() {
+  return {
+    isAbstract: void 0,
+    isAccessor: void 0,
+    hasAutoCasting: void 0,
+    autoCastingRequiresType: void 0,
+    autoCastingDefaultType: void 0,
+    isConstructorOnly: void 0,
+    isOverride: void 0,
+    dtsTypeOverride: void 0
+  };
+}
+function u() {
+  return {
+    isAbstract: void 0,
+    isDefaultExported: void 0,
+    hasQuestionToken: void 0,
+    esriCompatibilityNames: void 0
+  };
+}
+function d() {
+  return {
+    isDefaultExported: void 0,
+    esriCompatibilityNames: void 0
+  };
+}
+function v(t) {
+  return t[e];
+}
+function x(t) {
+  return t[e];
+}
+function p(t) {
+  return t[e];
+}
+function C(t) {
+  return t[e];
+}
+function l(t) {
+  return t[e];
+}
+function f(t) {
+  return t[e];
+}
+export {
+  x as a,
+  l as b,
+  C as c,
+  f as d,
+  p as e,
+  u as f,
+  v as g,
+  s as h,
+  c as i,
+  a as j,
+  d as k,
+  e as p
+};

package/dist/typeScript-CTYzSexR.js

@@ -0,0 +1,66 @@
+import { findPath as E, path as u, toSystemPathSeparators as S } from "@arcgis/components-build-utils";
+import t from "typescript";
+import { styleText as f } from "util";
+const w = "@arcgis/api-extractor", P = "5.1.0-next.82", D = {
+  name: w,
+  version: P
+};
+let x;
+function N(o) {
+  return x ??= t.createPrinter(), x.printNode(t.EmitHint.Unspecified, o, void 0);
+}
+function A(o, e) {
+  return o.pos !== -1 && o.end !== -1 && e !== void 0 ? o.getText(e) : N(o);
+}
+let h;
+const g = D.name, m = {
+  getCurrentDirectory: process.cwd,
+  getCanonicalFileName: (o) => o,
+  getNewLine: () => t.sys.newLine
+}, L = function(o, { file: e, node: n, scope: i, start: s, length: c }) {
+  this.errorCount += 1, process.exitCode = 1, s ??= n === void 0 || n.pos === -1 ? -1 : n.getStart(e, !1);
+  const a = n?.end ?? -1;
+  c ??= a === -1 ? -1 : Math.max(1, a - s);
+  const r = s >= 0 && c >= 0, d = !r && i !== void 0, l = {
+    category: t.DiagnosticCategory.Error,
+    code: r ? g : v,
+    file: d ? void 0 : e,
+    start: r ? s : 0,
+    length: r ? c : 0,
+    messageText: (d ? `${f("cyan", i, { stream: process.stderr })}: ` : "") + o + (r || n === void 0 ? "" : `
+
+${A(n, e)}`)
+  }, p = t.formatDiagnosticsWithColorAndContext([l], m);
+  h ??= process.env.CI !== void 0 || f("red", "", { stream: process.stderr }) !== "";
+  const C = h ? p : p.replaceAll(F, ""), y = r ? C : C.replace(v.toString(), g);
+  this.config.context.logger.error(y);
+}, v = 1490, F = /\x1B\[[0-9;]*m/gu, W = f("cyan", `[${g}] `);
+function k(o = process.cwd(), e, n) {
+  const i = e === void 0 ? E("tsconfig.json", o) : u.resolve(o, e);
+  if (i === void 0)
+    throw Error(
+      `Unable to find ${S(String(e))}. Please make sure the file exists, or provide types.tsconfigPath option to useLumina()`
+    );
+  const s = t.readConfigFile(i, t.sys.readFile);
+  if (s.error !== void 0)
+    throw Error(t.formatDiagnosticsWithColorAndContext([s.error], m));
+  const c = s.config, a = n ? c : {
+    ...c,
+    include: [],
+    files: [],
+    exclude: []
+  }, r = t.parseJsonConfigFileContent(a, t.sys, u.dirname(i)), d = 18002, l = n ? r.errors : r.errors.filter((p) => p.code !== d);
+  if (l.length > 0)
+    throw Error(t.formatDiagnosticsWithColorAndContext(l, m));
+  return {
+    configPath: i,
+    config: r
+  };
+}
+export {
+  m as a,
+  k as b,
+  L as e,
+  W as l,
+  D as p
+};

package/dist/utils/apiHelpers.js

@@ -1,17 +1,80 @@
-import { d as s, k as r, j as o, w as i, u as p, h as t, v as m, i as d, e as A, x as c, q as g, y as M, m as b, n as l } from "../apiHelpers-dNwlX631.js";
+import { g as f } from "../privateContext-CB7P40up.js";
+const g = (e) => e.kind === "method", v = (e) => e.kind === "field";
+function h(e, n) {
+  const o = e.sourcePath, i = n.sourcePath;
+  let t = 0;
+  for (; ; ) {
+    const c = o.indexOf("/", t), s = i.indexOf("/", t);
+    if (c === -1)
+      return s === -1 ? o.slice(t) < i.slice(t) ? -1 : 1 : -1;
+    if (s === -1)
+      return 1;
+    {
+      const r = o.slice(t, c), a = i.slice(t, s);
+      if (r !== a)
+        return r < a ? -1 : 1;
+      t = c + 1;
+    }
+  }
+}
+const p = "global:";
+function x(e, n, o) {
+  const i = f(o.apiModule).file, t = i.text.indexOf(n) ?? -1;
+  o.emitError(`${e}${t === -1 ? `. Found in: ${n}` : ""}`, {
+    file: i,
+    node: void 0,
+    scope: i === void 0 ? o.apiModule.sourcePath : void 0,
+    start: t,
+    length: n.length
+  });
+}
+const l = new Intl.Collator("en", { numeric: !0 }).compare, S = (e, n) => l(e.name, n.name), M = (e, n) => e.static !== void 0 && n.static === void 0 ? -1 : n.static !== void 0 && e.static === void 0 ? 1 : e.name === void 0 ? n.name === void 0 ? 0 : -1 : n.name === void 0 || "return" in e && !("return" in n) ? 1 : "return" in n && !("return" in e) ? -1 : l(e.name, n.name), d = (e) => e.name ?? (e.kind === "constructor" ? "constructor" : "call-signature"), P = (e) => e.static === !0 ? `static ${d(e)}` : d(e), T = (e) => ("bubbles" in e ? "@" : "") + (e.tagName ?? e.name ?? (e.kind === "constructor" ? "constructor" : "")) + ("return" in e ? "()" : "");
+function k(e, n, o = -1) {
+  "description" in n && (n.description ??= e.description), "deprecated" in n && (n.deprecated ??= e.deprecated), "return" in n && e.return !== void 0 && (n.return.description ??= e.return?.description), "readonly" in n && (n.readonly ??= e.readonly);
+  const { docsTags: i } = e, t = n;
+  if (o !== -1 && (i === void 0 && t.docsTags.length === 1 ? t.docsTags = void 0 : t.docsTags.splice(o, 1)), i !== void 0) {
+    t.docsTags ??= [];
+    const c = /* @__PURE__ */ new Set();
+    for (let s = 0; s < t.docsTags.length; ++s)
+      c.add(t.docsTags[s].name);
+    for (let s = 0; s < i.length; ++s) {
+      const r = i[s];
+      c.has(r.name) && r.name !== "example" && r.name !== "see" || t.docsTags.push(r);
+    }
+  }
+}
+function y(e, n) {
+  let o = e.text;
+  if (e.references !== void 0)
+    for (let i = e.references.length - 1; i >= 0; i--) {
+      const t = e.references[i];
+      if (t.package === p || t.module === void 0 && t.package === void 0 && t.viewUrl === void 0)
+        continue;
+      const r = t.name === "default" ? "default" : t.name, u = `import("${t.package === void 0 ? `./${t.module ?? n}.js` : t.package + (t.module === void 0 ? "" : `/${t.module}`)}").${r}`;
+      o = o.slice(0, t.start) + u + o.slice(t.end);
+    }
+  return {
+    ...e,
+    text: o,
+    references: void 0
+  };
+}
+function A(e) {
+  return e.return.type.text.startsWith("Promise<");
+}
 export {
-  s as apiTypeToImportType,
-  r as compareClassMembers,
-  o as compareNamedNodes,
-  i as compareStrings,
-  p as emitJsDocError,
-  t as getApiMemberName,
-  m as getApiNodeLabel,
-  d as getMaybeStaticApiMemberName,
-  A as globalPackageIdentifier,
-  c as isApiMethod,
-  g as isApiMethodAsync,
-  M as isApiProperty,
-  b as mergeApiNodes,
-  l as naturalSortModules
+  y as apiTypeToImportType,
+  M as compareClassMembers,
+  S as compareNamedNodes,
+  l as compareStrings,
+  x as emitJsDocError,
+  d as getApiMemberName,
+  T as getApiNodeLabel,
+  P as getMaybeStaticApiMemberName,
+  p as globalPackageIdentifier,
+  g as isApiMethod,
+  A as isApiMethodAsync,
+  v as isApiProperty,
+  k as mergeApiNodes,
+  h as naturalSortModules
 };

package/dist/utils/partPrinter.js

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

package/dist/vite/plugin.js

@@ -1,6 +1,6 @@
-import { l as O, m as J } from "../worker-CsceZ1rD.js";
-import { A as S, w as T } from "../ApiExtractor-IYYCO-EG.js";
-import { p as A, l as C } from "../typeScript-K2y-5lid.js";
+import { l as O, m as J } from "../worker-Bg39ooP0.js";
+import { A as S, w as T } from "../ApiExtractor-BFrq-vVd.js";
+import { p as A, l as C } from "../typeScript-CTYzSexR.js";
 import { writeFile as M } from "node:fs/promises";
 import { path as w } from "@arcgis/components-build-utils";
 const N = A.name;

package/dist/vite/typeScript.js

@@ -1,6 +1,6 @@
 import "@arcgis/components-build-utils";
 import "typescript";
-import { b as t } from "../typeScript-K2y-5lid.js";
+import { b as t } from "../typeScript-CTYzSexR.js";
 export {
   t as loadTypeScriptConfig
 };