@arcgis/api-extractor 5.2.0-next.86 → 5.2.0-next.87

package/dist/extractor/ApiExtractor.js

@@ -1,8 +1,8 @@
-import "../typeScript-BRuAWW15.js";
-import "../worker-BGV-jtQe.js";
+import "../typeScript-CCTKrw9v.js";
+import "./config.js";
 import "./processing/links.js";
 import "typescript";
-import { A as x } from "../ApiExtractor-ac92TCNa.js";
+import { A as x } from "../ApiExtractor-C8Bsb_Td.js";
 import "@arcgis/toolkit/function";
 export {
   x as ApiExtractor

package/dist/extractor/config.d.ts

@@ -271,7 +271,7 @@ export interface DeclarationFile {
  *
  * @see https://devtopia.esri.com/WebGIS/arcgis-js-api/discussions/60843
  * @see https://devtopia.esri.com/WebGIS/arcgis-js-api/issues/69911
- * @see https://devtopia.esri.com/WebGIS/arcgis-js-api/issues/73395
+ * @see https://devtopia.esri.com/WebGIS/webgis-sdk/issues/20807
  */
 export type TypeReplacements = Record<string, Record<string, readonly [modulePath: string, name: string, type: "default" | "named"] | undefined> | undefined>;
 

package/dist/extractor/config.js

@@ -1,20 +1,187 @@
-import "@arcgis/node-toolkit/file";
-import "@arcgis/node-toolkit/path";
-import "@arcgis/node-toolkit/packageJson";
-import "../typeScript-BRuAWW15.js";
-import { l as C, m as E, r as d } from "../worker-BGV-jtQe.js";
-import "./processing/links.js";
-import "typescript";
-import "fs/promises";
-import "node:util";
-import "@arcgis/toolkit/string";
-import "../utils/apiHelpers.js";
-import "@arcgis/toolkit/array";
-import "@arcgis/toolkit/function";
-import "node:fs";
-import "node:url";
+import { existsAsync as S } from "@arcgis/node-toolkit/file";
+import { path as y, getCwd as E } from "@arcgis/node-toolkit/path";
+import { retrievePackageJson as U } from "@arcgis/node-toolkit/packageJson";
+import { b, p as I } from "../typeScript-CCTKrw9v.js";
+import { identity as d } from "@arcgis/toolkit/function";
+import { pathToFileURL as J } from "node:url";
+import { getDefaultBasePath as w } from "./processing/links.js";
+const T = "developers.arcgis.com", k = "next.gha.afd.arcgis.com";
+function $(e) {
+  if (e.isResolvedConfig === !0)
+    return e;
+  const t = e.context, o = e.types, n = 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 ?? {}), l = o?.typeCheckedExtraction ?? m, p = o?.fullTypeCheck ?? !1, a = o?.typeScriptConfig ?? (l || p ? b(r, o?.typeScriptConfigPath, !0) : {
+    configPath: "",
+    config: {
+      options: {},
+      fileNames: [],
+      errors: []
+    }
+  });
+  if (o?.typeScriptConfig?.config.fileNames.length === 0)
+    throw Error(
+      `${I.name}: Provided types.typeScriptConfig has no included files. If you used loadTypeScriptConfig, make sure to set resolveIncludedFiles to true.`
+    );
+  const h = {
+    config: {
+      ...a.config,
+      options: {
+        ...a.config.options,
+        ...o?.compilerOptions
+      }
+    },
+    configPath: a.configPath
+  }, g = t?.dtsEmitPath === void 0 || t?.dtsEmitPath === "" ? "" : `${y.resolve(r, t.dtsEmitPath)}/`, x = g !== "", P = t?.environment ?? "production", u = P === "development", D = t?.emptyDtsEmitPath ?? (!u && x), v = n?.omitInternal ?? !1, C = o?.forceProduceDts ?? !1;
+  if (v && (x || C))
+    throw Error(
+      "omitInternal must be false if emitting .d.ts files in order to produce functional types for internal APIs."
+    );
+  return {
+    isResolvedConfig: !0,
+    context: {
+      dtsEmitPath: g,
+      emptyDtsEmitPath: D,
+      apiJsonEmitPath: t?.apiJsonEmitPath ?? "",
+      environment: P,
+      cwd: r,
+      basePath: c,
+      packageJson: s,
+      logger: t?.logger ?? {
+        // We namespace manually
+        // eslint-disable-next-line webgis/consistent-logging
+        info: console.log,
+        // eslint-disable-next-line webgis/consistent-logging
+        error: console.error
+      },
+      excludedDirectories: t?.excludedDirectories ?? /* @__PURE__ */ new Set(),
+      isLuminaMinimalExtraction: t?.isLuminaMinimalExtraction ?? !1,
+      includeLuminaPrivateComponents: t?.includeLuminaPrivateComponents ?? !1,
+      supportApplyMixinsSyntax: t?.supportApplyMixinsSyntax ?? !1
+    },
+    types: {
+      typeCheckedExtraction: l,
+      fullTypeCheck: p,
+      afterDiagnostic: o?.afterDiagnostic ?? d,
+      typeScriptInstanceCreated: o?.typeScriptInstanceCreated ?? d,
+      typeScriptConfigPath: a.configPath,
+      typeScriptConfig: h,
+      compilerOptions: h.config.options,
+      declarationTextTransformers: o?.declarationTextTransformers ?? [],
+      typeReplacements: o?.typeReplacements ?? {},
+      forceProduceDts: C
+    },
+    documentation: {
+      copyDocDefinitions: n?.copyDocDefinitions ?? {},
+      noInheritMembers: n?.noInheritMembers ?? {},
+      omitInternal: v,
+      publicStoryUrlPrefix: n?.publicStoryUrlPrefix ?? !1,
+      getComponentDocsUrl: n?.getComponentDocsUrl ?? !1,
+      getComponentDemoUrl: n?.getComponentDemoUrl ?? !1,
+      host: n?.host ?? (u ? k : T),
+      alternativeHost: n?.alternativeHost ?? (u ? T : k),
+      basePath: n?.basePath ?? w(s.name.split("/").at(-1))
+    },
+    verify: {
+      typeCheckTypes: e.verify?.typeCheckTypes ?? !1,
+      filterTypeCheckDiagnostic: e.verify?.filterTypeCheckDiagnostic ?? (() => !0),
+      detectBrokenLinks: e.verify?.detectBrokenLinks ?? !0
+    },
+    watch: {
+      onUpdate: e.watch?.onUpdate ?? d,
+      // Many reads can happen in a short time (on folder moves, or if prettier re-runs)
+      // Shorter than TypeScript's default of 250ms as we are blocked until this
+      // timeout is complete. Short timeout for unchecked extraction as it is fast,
+      // so doesn't need long debounce.
+      debounceTime: e.watch?.debounceTime ?? (l || p ? 50 : 20),
+      clearScreen: e.watch?.clearScreen ?? !1,
+      skipWritingUnchanged: D ? !1 : e.watch?.skipWritingUnchanged ?? !0
+    },
+    strict: e.strict ?? !m,
+    afterApiJsonCreate: e.afterApiJsonCreate ?? d
+  };
+}
+async function z(e, t) {
+  const o = t !== void 0, n = e ?? process.cwd(), i = y.resolve(n, t ?? "api-extractor.config.ts"), r = await S(i);
+  if (o && !r)
+    throw Error(`The provided config file at ${i} does not exist.`);
+  if (!r)
+    return e === void 0 ? {} : { context: { cwd: e } };
+  const s = (await import(J(i).href)).config;
+  return {
+    ...s,
+    context: {
+      ...s.context,
+      cwd: s.context?.cwd ?? y.dirname(i)
+    }
+  };
+}
+function N(e, t) {
+  const o = e.context, n = t.context, i = e.types, r = t.types, s = e.documentation, c = t.documentation, m = e.verify, l = t.verify, p = e.watch, a = t.watch;
+  return {
+    isResolvedConfig: e.isResolvedConfig || t.isResolvedConfig || void 0,
+    context: {
+      dtsEmitPath: n?.dtsEmitPath ?? o?.dtsEmitPath,
+      emptyDtsEmitPath: n?.emptyDtsEmitPath ?? o?.emptyDtsEmitPath,
+      apiJsonEmitPath: n?.apiJsonEmitPath ?? o?.apiJsonEmitPath,
+      environment: n?.environment ?? o?.environment,
+      cwd: n?.cwd ?? o?.cwd,
+      basePath: n?.basePath ?? o?.basePath,
+      packageJson: n?.packageJson ?? o?.packageJson,
+      logger: n?.logger ?? o?.logger,
+      excludedDirectories: n?.excludedDirectories ?? o?.excludedDirectories,
+      isLuminaMinimalExtraction: n?.isLuminaMinimalExtraction ?? o?.isLuminaMinimalExtraction,
+      includeLuminaPrivateComponents: n?.includeLuminaPrivateComponents ?? o?.includeLuminaPrivateComponents,
+      supportApplyMixinsSyntax: n?.supportApplyMixinsSyntax ?? o?.supportApplyMixinsSyntax ?? !1
+    },
+    types: {
+      typeCheckedExtraction: r?.typeCheckedExtraction ?? i?.typeCheckedExtraction,
+      fullTypeCheck: r?.fullTypeCheck ?? i?.fullTypeCheck,
+      afterDiagnostic: f(r?.afterDiagnostic, i?.afterDiagnostic),
+      typeScriptInstanceCreated: f(
+        t?.types?.typeScriptInstanceCreated,
+        e?.types?.typeScriptInstanceCreated
+      ),
+      typeScriptConfigPath: r?.typeScriptConfigPath ?? i?.typeScriptConfigPath,
+      typeScriptConfig: r?.typeScriptConfig ?? i?.typeScriptConfig,
+      compilerOptions: r?.compilerOptions ?? i?.compilerOptions,
+      declarationTextTransformers: r?.declarationTextTransformers !== void 0 && i?.declarationTextTransformers !== void 0 ? [...i.declarationTextTransformers, ...r.declarationTextTransformers] : r?.declarationTextTransformers ?? i?.declarationTextTransformers,
+      typeReplacements: r?.typeReplacements ?? i?.typeReplacements,
+      forceProduceDts: r?.forceProduceDts ?? i?.forceProduceDts
+    },
+    documentation: {
+      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: l?.typeCheckTypes ?? m?.typeCheckTypes,
+      filterTypeCheckDiagnostic: l?.filterTypeCheckDiagnostic ?? m?.filterTypeCheckDiagnostic,
+      detectBrokenLinks: l?.detectBrokenLinks ?? m?.detectBrokenLinks
+    },
+    watch: {
+      onUpdate: f(a?.onUpdate, p?.onUpdate),
+      debounceTime: a?.debounceTime ?? p?.debounceTime,
+      clearScreen: a?.clearScreen ?? p?.clearScreen,
+      skipWritingUnchanged: a?.skipWritingUnchanged ?? p?.skipWritingUnchanged
+    },
+    strict: t.strict ?? e.strict,
+    afterApiJsonCreate: f(t.afterApiJsonCreate, e.afterApiJsonCreate)
+  };
+}
+function f(e, t) {
+  const o = t === d ? void 0 : t, n = e === d ? void 0 : e;
+  return o !== void 0 && n !== void 0 ? ((...i) => (o(...i), n(...i))) : n ?? o;
+}
 export {
-  C as loadApiExtractorConfig,
-  E as mergeApiExtractorConfigs,
-  d as resolveApiExtractorConfig
+  z as loadApiExtractorConfig,
+  N as mergeApiExtractorConfigs,
+  $ as resolveApiExtractorConfig
 };

package/dist/extractor/processing/links.js

@@ -1,6 +1,6 @@
 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 { c as y } from "../../privateContext-CZnnBVGR.js";
 import { kebabToPascal as I } from "@arcgis/toolkit/string";
 function W(e, n) {
   if (typeof e == "string") {

package/dist/{privateContext-CB7P40up.js → privateContext-CZnnBVGR.js}

@@ -71,14 +71,14 @@ 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,
+  l as a,
+  C as b,
+  v as c,
+  u as d,
+  s as e,
+  f,
+  x as g,
+  p as h,
   c as i,
   a as j,
   d as k,

package/dist/{typeScript-BRuAWW15.js → typeScript-CCTKrw9v.js}

@@ -2,7 +2,7 @@ import { findPath as E } from "@arcgis/node-toolkit/file";
 import { path as u, toSystemPathSeparators as S } from "@arcgis/node-toolkit/path";
 import t from "typescript";
 import { styleText as l } from "util";
-const w = "@arcgis/api-extractor", P = "5.2.0-next.86", D = {
+const w = "@arcgis/api-extractor", P = "5.2.0-next.87", D = {
   name: w,
   version: P
 };

package/dist/utils/apiHelpers.js

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

package/dist/utils/partPrinter.js

@@ -1,8 +1,8 @@
-import { d as l } from "../privateContext-CB7P40up.js";
+import { f as l } from "../privateContext-CZnnBVGR.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}}`;
+  return `${`${r ? "export default " : "export "}${t ? "abstract " : ""}`}class ${i}${c(e)}${n === void 0 ? "" : ` extends ${n}`} {${o}}`;
 }
-function f(t) {
+function c(t) {
   if (t === void 0)
     return "";
   let r = "<";
@@ -17,24 +17,24 @@ function v(t, r, i, e, n) {
   let $ = "";
   if (e !== void 0) {
     $ = " extends ";
-    for (let c = 0; c < e.length; ++c)
-      $ += l(e[c]), c < e.length - 1 && ($ += ", ");
+    for (let f = 0; f < e.length; ++f)
+      $ += l(e[f]), f < e.length - 1 && ($ += ", ");
   }
-  return `${o}interface ${r}${f(i)}${$} {${n}}`;
+  return `${o}interface ${r}${c(i)}${$} {${n}}`;
 }
-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 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 d(t) {
   return u.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;
 function b(t, r, i, e, n) {
-  return `${t ? "export default " : "export "}function ${r}${f(i)}(${a(e)}): ${n};`;
+  return `${t ? "export default " : "export "}function ${r}${c(i)}(${a(e)}): ${n};`;
 }
 function A(t) {
-  return `${f(t.typeParameters)}(${a(t.parameters)}): ${t.return.type.text}`;
+  return `${c(t.typeParameters)}(${a(t.parameters)}): ${t.return.type.text}`;
 }
 function a(t) {
   if (t === void 0)
@@ -46,13 +46,13 @@ function a(t) {
   }
   return r;
 }
-function P(t, r, i, e, n, o, $, c) {
-  return `${`${t ? "protected " : ""}${r ? "abstract " : i ? "static " : ""}${e ? "readonly " : n ? "accessor " : ""}`}${d($)}${o ? "?" : ""}: ${c};`;
+function P(t, r, i, e, n, o, $, f) {
+  return `${`${t ? "protected " : ""}${r ? "abstract " : i ? "static " : ""}${e ? "readonly " : n ? "accessor " : ""}`}${d($)}${o ? "?" : ""}: ${f};`;
 }
 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}`;
+  const $ = `${t ? "protected " : ""}${r ? "abstract " : ""}${i ? "static " : ""}`, f = d(e), s = o === void 0 ? "" : `
+${$}set ${f}(value: ${o});`;
+  return `${$}get ${f}(): ${n};${s}`;
 }
 function z(t, r, i) {
   const n = `${t ? "declare " : "export "}const ${r}: ${i};`;
@@ -60,7 +60,7 @@ function z(t, r, i) {
 export default ${r};` : n;
 }
 function R(t, r, i, e) {
-  let n = `export type ${t}${f(r)} = `;
+  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 += `
@@ -78,6 +78,6 @@ export {
   P as printProperty,
   A as printSignature,
   R as printTypeAlias,
-  f as printTypeParameters,
+  c as printTypeParameters,
   z as printVariable
 };

package/dist/vite/plugin.js

@@ -1,6 +1,6 @@
-import { l as O, m as J } from "../worker-BGV-jtQe.js";
-import { A as S, w as T } from "../ApiExtractor-ac92TCNa.js";
-import { p as A, l as C } from "../typeScript-BRuAWW15.js";
+import { loadApiExtractorConfig as O, mergeApiExtractorConfigs as J } from "../extractor/config.js";
+import { A as S, w as T } from "../ApiExtractor-C8Bsb_Td.js";
+import { p as A, l as C } from "../typeScript-CCTKrw9v.js";
 import { writeFile as M } from "node:fs/promises";
 import { path as w } from "@arcgis/node-toolkit/path";
 const N = A.name;

package/dist/vite/typeScript.js

@@ -1,7 +1,7 @@
 import "@arcgis/node-toolkit/file";
 import "@arcgis/node-toolkit/path";
 import "typescript";
-import { b as m } from "../typeScript-BRuAWW15.js";
+import { b as m } from "../typeScript-CCTKrw9v.js";
 export {
   m as loadTypeScriptConfig
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcgis/api-extractor",
-  "version": "5.2.0-next.86",
+  "version": "5.2.0-next.87",
   "description": "Documentation engine for WebGIS SDK packages",
   "type": "module",
   "main": "./dist/index.js",
@@ -49,11 +49,11 @@
   ],
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
+    "@arcgis/node-toolkit": "5.2.0-next.87",
+    "@arcgis/toolkit": "5.2.0-next.87",
     "@commander-js/extra-typings": "^15.0.0",
     "commander": "^15.0.0",
-    "tslib": "^2.8.1",
-    "@arcgis/toolkit": "5.2.0-next.86",
-    "@arcgis/node-toolkit": "5.2.0-next.86"
+    "tslib": "^2.8.1"
   },
   "peerDependencies": {
     "typescript": "~6.0.3",