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

package/dist/{cli-7PX_wNxb.js → chunks/cli.js}

@@ -1,5 +1,5 @@
 import { writeFile as r, readFile as d } from "node:fs/promises";
-import { diffApiJson as m } from "./diff/diffApiJson.js";
+import { diffApiJson as m } from "../diff/diffApiJson.js";
 async function k({
   oldPath: t,
   newPath: i,
@@ -9,12 +9,12 @@ async function k({
   const c = f(t), w = f(i), p = await c, l = await w, n = m(p, l);
   if (typeof o == "string")
     if (o.endsWith(".md")) {
-      const { apiDiffToMarkdown: s } = await import("./diff/apiDiffToMarkdown.js"), a = s(n, e);
+      const { apiDiffToMarkdown: s } = await import("../diff/apiDiffToMarkdown.js"), a = s(n, e);
       await r(o, a, "utf-8");
     } else
       await r(o, JSON.stringify(n, null, 2), "utf-8");
   else {
-    const { apiDiffToMarkdown: s } = await import("./diff/apiDiffToMarkdown.js"), a = s(n, e);
+    const { apiDiffToMarkdown: s } = await import("../diff/apiDiffToMarkdown.js"), a = s(n, e);
     console.log(a);
   }
 }

package/dist/{config-C9uAPo7G.js → chunks/config.js}

@@ -4,18 +4,18 @@ import { retrievePackageJson as U } from "@arcgis/node-toolkit/packageJson";
 import { loadTypeScriptConfig as b } from "@arcgis/node-toolkit/vite/typeScript";
 import { identity as d } from "@arcgis/toolkit/function";
 import { pathToFileURL as I } from "node:url";
-import { getDefaultBasePath as J } from "./extractor/processing/links.js";
-const w = "@arcgis/api-extractor", L = "1.0.0-0", A = {
-  name: w,
-  version: L
-}, T = "developers.arcgis.com", k = "next.gha.afd.arcgis.com";
+import { getDefaultBasePath as J } from "../extractor/processing/links.js";
+const L = "@arcgis/api-extractor", w = "1.0.0-0", A = {
+  name: L,
+  version: w
+}, C = "developers.arcgis.com", k = "next.gha.afd.arcgis.com";
 function N(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) : {
+  const t = e.context, n = e.types, o = e.documentation, r = `${t?.cwd === void 0 ? E() : y.resolve(t?.cwd)}/`, c = t?.packageJson ?? U(r);
+  let s = t?.basePath ?? "src/";
+  s.endsWith("/") || (s += "/");
+  const m = "customElements" in c && "@arcgis/lumina" in (c.dependencies ?? {}), p = n?.typeCheckedExtraction ?? m, l = n?.fullTypeCheck ?? !1, a = n?.typeScriptConfig ?? (p || l ? b(r, n?.typeScriptConfigPath, !0) : {
     configPath: "",
     config: {
       options: {},
@@ -23,7 +23,7 @@ function N(e) {
       errors: []
     }
   });
-  if (o?.typeScriptConfig?.config.fileNames.length === 0)
+  if (n?.typeScriptConfig?.config.fileNames.length === 0)
     throw Error(
       `${A.name}: Provided types.typeScriptConfig has no included files. If you used loadTypeScriptConfig, make sure to set resolveIncludedFiles to true.`
     );
@@ -32,12 +32,12 @@ function N(e) {
       ...a.config,
       options: {
         ...a.config.options,
-        ...o?.compilerOptions
+        ...n?.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", v = t?.emptyDtsEmitPath ?? (!u && x), D = n?.omitInternal ?? !1, C = o?.forceProduceDts ?? !1;
-  if (D && (x || C))
+  }, g = t?.dtsEmitPath === void 0 || t?.dtsEmitPath === "" ? "" : `${y.resolve(r, t.dtsEmitPath)}/`, x = g !== "", P = t?.environment ?? "production", u = P === "development", v = t?.emptyDtsEmitPath ?? (!u && x), D = o?.omitInternal ?? !1, T = n?.forceProduceDts ?? !1;
+  if (D && (x || T))
     throw Error(
       "omitInternal must be false if emitting .d.ts files in order to produce functional types for internal APIs."
     );
@@ -49,8 +49,8 @@ function N(e) {
       apiJsonEmitPath: t?.apiJsonEmitPath ?? "",
       environment: P,
       cwd: r,
-      basePath: c,
-      packageJson: s,
+      basePath: s,
+      packageJson: c,
       logger: t?.logger ?? {
         // We namespace manually
         // eslint-disable-next-line webgis/consistent-logging
@@ -64,31 +64,32 @@ function N(e) {
       supportApplyMixinsSyntax: t?.supportApplyMixinsSyntax ?? !1
     },
     types: {
-      typeCheckedExtraction: l,
-      fullTypeCheck: p,
-      afterDiagnostic: o?.afterDiagnostic ?? d,
-      typeScriptInstanceCreated: o?.typeScriptInstanceCreated ?? d,
+      typeCheckedExtraction: p,
+      fullTypeCheck: l,
+      afterDiagnostic: n?.afterDiagnostic ?? d,
+      typeScriptInstanceCreated: n?.typeScriptInstanceCreated ?? d,
       typeScriptConfigPath: a.configPath,
       typeScriptConfig: h,
       compilerOptions: h.config.options,
-      declarationTextTransformers: o?.declarationTextTransformers ?? [],
-      typeReplacements: o?.typeReplacements ?? {},
-      forceProduceDts: C
+      declarationTextTransformers: n?.declarationTextTransformers ?? [],
+      typeReplacements: n?.typeReplacements ?? {},
+      forceProduceDts: T
     },
     documentation: {
-      copyDocDefinitions: n?.copyDocDefinitions ?? {},
-      noInheritMembers: n?.noInheritMembers ?? {},
+      copyDocDefinitions: o?.copyDocDefinitions ?? {},
+      noInheritMembers: o?.noInheritMembers ?? {},
       omitInternal: D,
-      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 ?? J(s.name.split("/").at(-1))
+      publicStoryUrlPrefix: o?.publicStoryUrlPrefix ?? !1,
+      getComponentDocsUrl: o?.getComponentDocsUrl ?? !1,
+      getComponentDemoUrl: o?.getComponentDemoUrl ?? !1,
+      host: o?.host ?? (u ? k : C),
+      alternativeHost: o?.alternativeHost ?? (u ? C : k),
+      basePath: o?.basePath ?? J(c.name.split("/").at(-1))
     },
     verify: {
       typeCheckTypes: e.verify?.typeCheckTypes ?? !1,
       filterTypeCheckDiagnostic: e.verify?.filterTypeCheckDiagnostic ?? (() => !0),
+      filterUnreferencedType: e.verify?.filterUnreferencedType ?? (() => !0),
       detectBrokenLinks: e.verify?.detectBrokenLinks ?? !0
     },
     watch: {
@@ -97,7 +98,7 @@ function N(e) {
       // 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),
+      debounceTime: e.watch?.debounceTime ?? (p || l ? 50 : 20),
       clearScreen: e.watch?.clearScreen ?? !1,
       skipWritingUnchanged: v ? !1 : e.watch?.skipWritingUnchanged ?? !0
     },
@@ -106,37 +107,37 @@ function N(e) {
   };
 }
 async function V(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)
+  const n = t !== void 0, o = e ?? process.cwd(), i = y.resolve(o, t ?? "api-extractor.config.ts"), r = await S(i);
+  if (n && !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(I(i).href)).config;
+  const c = (await import(I(i).href)).config;
   return {
-    ...s,
+    ...c,
     context: {
-      ...s.context,
-      cwd: s.context?.cwd ?? y.dirname(i)
+      ...c.context,
+      cwd: c.context?.cwd ?? y.dirname(i)
     }
   };
 }
 function j(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;
+  const n = e.context, o = t.context, i = e.types, r = t.types, c = e.documentation, s = t.documentation, m = e.verify, p = t.verify, l = 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
+      dtsEmitPath: o?.dtsEmitPath ?? n?.dtsEmitPath,
+      emptyDtsEmitPath: o?.emptyDtsEmitPath ?? n?.emptyDtsEmitPath,
+      apiJsonEmitPath: o?.apiJsonEmitPath ?? n?.apiJsonEmitPath,
+      environment: o?.environment ?? n?.environment,
+      cwd: o?.cwd ?? n?.cwd,
+      basePath: o?.basePath ?? n?.basePath,
+      packageJson: o?.packageJson ?? n?.packageJson,
+      logger: o?.logger ?? n?.logger,
+      excludedDirectories: o?.excludedDirectories ?? n?.excludedDirectories,
+      isLuminaMinimalExtraction: o?.isLuminaMinimalExtraction ?? n?.isLuminaMinimalExtraction,
+      includeLuminaPrivateComponents: o?.includeLuminaPrivateComponents ?? n?.includeLuminaPrivateComponents,
+      supportApplyMixinsSyntax: o?.supportApplyMixinsSyntax ?? n?.supportApplyMixinsSyntax ?? !1
     },
     types: {
       typeCheckedExtraction: r?.typeCheckedExtraction ?? i?.typeCheckedExtraction,
@@ -154,34 +155,35 @@ function j(e, t) {
       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
+      copyDocDefinitions: s?.copyDocDefinitions ?? c?.copyDocDefinitions,
+      noInheritMembers: s?.noInheritMembers ?? c?.noInheritMembers,
+      omitInternal: s?.omitInternal ?? c?.omitInternal,
+      publicStoryUrlPrefix: s?.publicStoryUrlPrefix ?? c?.publicStoryUrlPrefix,
+      getComponentDocsUrl: s?.getComponentDocsUrl ?? c?.getComponentDocsUrl,
+      getComponentDemoUrl: s?.getComponentDemoUrl ?? c?.getComponentDemoUrl,
+      host: s?.host ?? c?.host,
+      alternativeHost: s?.alternativeHost ?? c?.alternativeHost,
+      basePath: s?.basePath ?? c?.basePath
     },
     verify: {
-      typeCheckTypes: l?.typeCheckTypes ?? m?.typeCheckTypes,
-      filterTypeCheckDiagnostic: l?.filterTypeCheckDiagnostic ?? m?.filterTypeCheckDiagnostic,
-      detectBrokenLinks: l?.detectBrokenLinks ?? m?.detectBrokenLinks
+      typeCheckTypes: p?.typeCheckTypes ?? m?.typeCheckTypes,
+      filterTypeCheckDiagnostic: p?.filterTypeCheckDiagnostic ?? m?.filterTypeCheckDiagnostic,
+      filterUnreferencedType: p?.filterUnreferencedType ?? m?.filterUnreferencedType,
+      detectBrokenLinks: p?.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
+      onUpdate: f(a?.onUpdate, l?.onUpdate),
+      debounceTime: a?.debounceTime ?? l?.debounceTime,
+      clearScreen: a?.clearScreen ?? l?.clearScreen,
+      skipWritingUnchanged: a?.skipWritingUnchanged ?? l?.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;
+  const n = t === d ? void 0 : t, o = e === d ? void 0 : e;
+  return n !== void 0 && o !== void 0 ? ((...i) => (n(...i), o(...i))) : o ?? n;
 }
 export {
   V as l,

package/dist/cli.js

@@ -36,7 +36,7 @@ o.command("diff").description("Produce a diff of two api.json files").requiredOp
   "Base URL for documentation links. Used only if output format is Markdown",
   "https://developers.arcgis.com/javascript/latest/references/core/"
 ).action(async (t) => {
-  const { diffApiCli: e } = await import("./cli-7PX_wNxb.js");
+  const { diffApiCli: e } = await import("./chunks/cli.js");
   await e({
     oldPath: t.old,
     newPath: t.new,

package/dist/extractor/ApiExtractor.js

@@ -1,7 +1,7 @@
-import "../config-C9uAPo7G.js";
+import "../chunks/config.js";
 import "./processing/links.js";
 import "typescript";
-import { A as x } from "../ApiExtractor-CvENLVIq.js";
+import { A as x } from "../chunks/ApiExtractor.js";
 import "@arcgis/toolkit/function";
 import "@arcgis/node-toolkit/workspace";
 export {

package/dist/extractor/config.d.ts

@@ -3,7 +3,7 @@ import type { PackageJson } from "@arcgis/node-toolkit/packageJson";
 import type { CopyDocDefinitions } from "./extractors/copyDoc.js";
 import type { ApiExtractor } from "./ApiExtractor.js";
 import type { TypeScriptConfigResult } from "@arcgis/node-toolkit/vite/typeScript";
-import type { ApiModule } from "../apiJson.js";
+import type { ApiInterfaceDeclaration, ApiModule } from "../apiJson.js";
 import type { ApiExtractorResult } from "./types.js";
 
 export interface ApiExtractorConfig {
@@ -379,6 +379,23 @@ export interface ApiExtractorVerifyConfig {
    * ```
    */
   filterTypeCheckDiagnostic?(diagnostic: ts.Diagnostic): boolean;
+  /**
+   * Return false to suppress an unreferenced exported type error when
+   * [ApiExtractorVerifyConfig](https://developers.arcgis.com/javascript/latest/references/api-extractor/extractor/config/#ApiExtractorVerifyConfig-typeCheckTypes) is enabled.
+   *
+   * Usually, types that are not referenced by any runtime API are a mistake.
+   * Use this option to suppress intentional cases or backwards compatibility
+   * cases.
+   *
+   * @param declaration - The unreferenced interface or type alias.
+   * @param module - The module containing the declaration.
+   * @example
+   * ```ts
+   * filterUnreferencedType: (declaration, module) =>
+   *   !(module.path === "types" && declaration.name === "StandaloneType"),
+   * ```
+   */
+  filterUnreferencedType?(declaration: ApiInterfaceDeclaration, module: ApiModule): boolean;
   /**
    * @deprecated REFACTOR: Drop this flag in 5.1
    * @default false

package/dist/extractor/config.js

@@ -3,7 +3,7 @@ import "@arcgis/node-toolkit/path";
 import "@arcgis/node-toolkit/packageJson";
 import "@arcgis/node-toolkit/vite/typeScript";
 import "@arcgis/toolkit/function";
-import { l as f, m as g, r as x } from "../config-C9uAPo7G.js";
+import { l as f, m as g, r as x } from "../chunks/config.js";
 import "node:url";
 import "./processing/links.js";
 export {

package/dist/extractor/processing/links.js

@@ -1,6 +1,6 @@
 import { styleText as C } from "node:util";
 import { emitJsDocError as a, getApiNodeLabel as h } from "../../utils/apiHelpers.js";
-import { c as y } from "../../privateContext-DR6YTcm2.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") {

package/dist/utils/apiHelpers.js

@@ -1,4 +1,4 @@
-import { c as f } from "../privateContext-DR6YTcm2.js";
+import { c 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/dist/utils/partPrinter.js

@@ -1,4 +1,4 @@
-import { f as l } from "../privateContext-DR6YTcm2.js";
+import { f as l } 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}}`;
 }

package/dist/vite/plugin.js

@@ -1,5 +1,5 @@
-import { p as O, l as S, m as J } from "../config-C9uAPo7G.js";
-import { A as T, l as A, w as C } from "../ApiExtractor-CvENLVIq.js";
+import { p as O, l as S, m as J } from "../chunks/config.js";
+import { A as T, l as A, w as C } from "../chunks/ApiExtractor.js";
 import { writeFile as M } from "node:fs/promises";
 import { path as w } from "@arcgis/node-toolkit/path";
 const N = O.name;

package/package.json

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