@arcgis/api-extractor 5.1.0-next.89 → 5.1.0-next.90

package/dist/{ApiExtractor-CcUbKtCm.js → ApiExtractor-DD4ODfUV.js}

@@ -1,5 +1,5 @@
-import { l as H, a as se, e as De, p as me } from "./typeScript-C_Y_81n6.js";
-import { a as be, o as xe, t as Le, b as Oe, c as Ne, e as Be, p as We, d as Ue, f as _, i as pe, g as ze, h as je, j as He, k as Je, n as Ve, r as Xe } from "./worker-sOtqMU7v.js";
+import { l as H, a as se, e as De, p as me } from "./typeScript-Bcylmvl-.js";
+import { a as be, o as xe, t as Le, b as Oe, c as Ne, e as Be, p as We, d as Ue, f as _, i as pe, g as ze, h as je, j as He, k as Je, n as Ve, r as Xe } from "./worker-DdLxplOi.js";
 import { getViewUrl as Ye, postProcessDeprecated as Q, postProcessDescription as G, postProcessDocsTags as V, resolveJsDocLink as qe } from "./extractor/processing/links.js";
 import E from "typescript";
 import { path as N, toPosixPathSeparators as Ze } from "@arcgis/components-build-utils";

package/dist/apiJson.d.ts

@@ -658,7 +658,7 @@ export interface ApiClassDeclaration extends ApiObjectLikeDeclaration, ApiWithEv
    * matches the order of language used to describe mixin application, like
    * "S with A, B".
    *
-   * @see https://webgis.esri.com/webgis/core/core/mixins
+   * @see https://webgis.esri.com/sdk/contributing/core/core/mixins
    */
   mixins?: ApiReferenceWithTypeArguments[];
 }
@@ -803,7 +803,7 @@ export interface ApiClassCallSignature extends Omit<ApiFunctionLike, "name">, Ap
 /**
  * A description of a class mixin.
  *
- * @see [WebGIS - Mixins](https://webgis.esri.com/webgis/core/core/mixins)
+ * @see [WebGIS - Mixins](https://webgis.esri.com/sdk/contributing/core/core/mixins)
  */
 export interface ApiMixinDeclaration extends Omit<ApiFunctionLike, "return">, ApiObjectLikeDeclaration, ApiWithEvents {
   kind: "mixin";

package/dist/extractor/ApiExtractor.js

@@ -1,8 +1,8 @@
-import "../typeScript-C_Y_81n6.js";
-import "../worker-sOtqMU7v.js";
+import "../typeScript-Bcylmvl-.js";
+import "../worker-DdLxplOi.js";
 import "./processing/links.js";
 import "typescript";
-import { A as x } from "../ApiExtractor-CcUbKtCm.js";
+import { A as x } from "../ApiExtractor-DD4ODfUV.js";
 import "@arcgis/toolkit/function";
 export {
   x as ApiExtractor

package/dist/extractor/config.js

@@ -1,6 +1,6 @@
 import "@arcgis/components-build-utils";
-import "../typeScript-C_Y_81n6.js";
-import { l, m as n, r as A } from "../worker-sOtqMU7v.js";
+import "../typeScript-Bcylmvl-.js";
+import { l, m as n, r as A } from "../worker-DdLxplOi.js";
 import "./processing/links.js";
 import "typescript";
 import "fs/promises";

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>;

package/dist/extractor/processing/links.js

@@ -23,46 +23,46 @@ function J(e, 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 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;
+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/sdk/contributing/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);
   if (u.startsWith("https://"))
     return e.config.strict ? (a(
-      "Did not expect absolute URLs in a @link tag. Please use markdown links for external links. See https://webgis.esri.com/webgis/core/core/documenting-api#link",
+      "Did not expect absolute URLs in a @link tag. Please use markdown links for external links. See https://webgis.esri.com/sdk/contributing/core/core/documenting-api#link",
       n,
       e
     ), "") : `[${m || u}](${u})`;
-  const [g, t] = u.split("#"), [f, L] = g.split("!");
+  const [k, s] = u.split("#"), [f, L] = k.split("!");
   if (f === "")
     return a(
       `Expected @link reference to start with a module name (before ! or #), but got: ${u}`,
       n,
       e
     ), n;
-  let k = e.moduleMap.get(f);
-  if (k === void 0 && e.isComponentProject && !e.config.strict) {
+  let g = e.moduleMap.get(f);
+  if (g === void 0 && e.isComponentProject && !e.config.strict) {
     for (const r of e.moduleMap.values())
       if (y(r).index.class?.name === f) {
-        k = r;
+        g = r;
         break;
       }
   }
-  if (k === void 0)
+  if (g === 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.' : ""}`,
       n,
       e
     ) : e.silencedBrokenLinkCount += 1, n;
-  const v = y(k), D = e.inheritedModuleName === void 0 ? e.apiModule : e.moduleMap.get(e.inheritedModuleName) ?? e.apiModule;
+  const v = y(g), 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;
+    const r = y(D).file.fileName.slice(e.config.context.cwd.length), t = v.file.fileName.slice(e.config.context.cwd.length);
+    e.watchFiles.get(r).docLinks.push(i), e.watchFiles.get(r).dependencies.add(t);
+    const b = e.watchFiles.get(t).dependents;
     b.has(r) || b.set(r, !1);
   }
-  let h = M(k.path, L, t, e);
+  let h = M(g.path, L, s, e);
   if (L !== void 0) {
     const r = v.index.named[L];
     return r === void 0 ? (e.config.verify.detectBrokenLinks ? a(
@@ -74,73 +74,73 @@ function N(e, n, i) {
       n,
       e
     ), n) : `[${m || w(r)}](${h})`;
-  } else if (t !== void 0) {
-    const r = k.path === D.path, s = v.index.class;
-    if (s === void 0)
-      return v.index.named[t] === void 0 ? e.config.verify.detectBrokenLinks ? a(
+  } else if (s !== void 0) {
+    const r = g.path === D.path, t = v.index.class;
+    if (t === void 0)
+      return v.index.named[s] === void 0 ? e.config.verify.detectBrokenLinks ? a(
         'Failed to find the referenced member. Class member reference syntax was used, yet current module does not expose a class/mixin/custom element? Linking to properties in interfaces is not yet supported. For event links, prefix with "event-"',
         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}!${s}`)} instead? Linking to properties in interfaces is not yet supported`,
         n,
         e
       ), n;
     const b = v.inheritance, p = typeof b == "object" ? b : void 0;
     let c;
-    if (t.startsWith("event-")) {
-      const o = t.slice(6);
+    if (s.startsWith("event-")) {
+      const o = s.slice(6);
       if (p !== void 0)
         c = p.indexedEvents?.[o];
-      else if (s.events !== void 0)
-        for (let l = 0; l < s.events.length; ++l) {
-          const $ = s.events[l];
+      else if (t.events !== void 0)
+        for (let l = 0; l < t.events.length; ++l) {
+          const $ = t.events[l];
           if (o === $.name) {
             c = $;
             break;
           }
         }
-    } else if (t.startsWith("slot-")) {
-      const o = t.slice(5);
+    } else if (s.startsWith("slot-")) {
+      const o = s.slice(5);
       if (p !== void 0)
         c = p.indexedSlots?.[o];
-      else if (s.slots !== void 0)
-        for (let l = 0; l < s.slots.length; ++l) {
-          const $ = s.slots[l];
+      else if (t.slots !== void 0)
+        for (let l = 0; l < t.slots.length; ++l) {
+          const $ = t.slots[l];
           if (o === $.name) {
             c = $;
             break;
           }
         }
-    } else if (t.startsWith("--")) {
+    } else if (s.startsWith("--")) {
       if (p !== void 0)
-        c = p.indexedCssProperties?.[t];
-      else if (s.cssProperties !== void 0)
-        for (let o = 0; o < s.cssProperties.length; ++o) {
-          const l = s.cssProperties[o];
-          if (t === l.name) {
+        c = p.indexedCssProperties?.[s];
+      else if (t.cssProperties !== void 0)
+        for (let o = 0; o < t.cssProperties.length; ++o) {
+          const l = t.cssProperties[o];
+          if (s === l.name) {
             c = l;
             break;
           }
         }
-    } else if (p?.indexedMembers !== void 0 && (c = p.indexedMembers[t] ?? p.indexedMembers[`static ${t}`]), c === void 0 && s.members !== void 0) {
-      for (let o = 0; o < s.members.length; ++o) {
-        const l = s.members[o];
-        if (t === l.name) {
+    } else if (p?.indexedMembers !== void 0 && (c = p.indexedMembers[s] ?? p.indexedMembers[`static ${s}`]), c === void 0 && t.members !== void 0) {
+      for (let o = 0; o < t.members.length; ++o) {
+        const l = t.members[o];
+        if (s === l.name) {
           c = l;
           break;
         }
       }
-      if (c === void 0 && !e.config.strict && e.isComponentProject && s.events !== void 0)
-        for (let o = 0; o < s.events.length; ++o) {
-          const l = s.events[o];
-          if (t === l.name) {
+      if (c === void 0 && !e.config.strict && e.isComponentProject && t.events !== void 0)
+        for (let o = 0; o < t.events.length; ++o) {
+          const l = t.events[o];
+          if (s === l.name) {
             c = l, h = h.replace("#", "#event-");
             break;
           }
         }
     }
-    return c === void 0 ? (e.config.verify.detectBrokenLinks ? a("Failed to find the referenced class member", n, e) : e.silencedBrokenLinkCount += 1, n) : `[${m || (r ? w(c) : `${w(s)}.${w(c)}`)}](${h})`;
+    return c === void 0 ? (e.config.verify.detectBrokenLinks ? a("Failed to find the referenced class member", n, e) : e.silencedBrokenLinkCount += 1, n) : `[${m || (r ? w(c) : `${w(t)}.${w(c)}`)}](${h})`;
   } else {
     const r = v.index.class === void 0 ? A(f) : w(v.index.class);
     return `[${m || r}](${h})`;
@@ -149,8 +149,8 @@ function N(e, n, i) {
 function M(e, n, i, d) {
   let u;
   if (d.isComponentProject && typeof d.config.documentation.getComponentDocsUrl == "function" && e.startsWith("components/")) {
-    const m = e.slice(11), g = m.indexOf("/"), t = g === -1 ? m : m.slice(0, g), f = d.config.documentation.getComponentDocsUrl(t, I(t));
-    f !== void 0 && (u = f + (g === -1 ? "" : m.slice(g + 1)));
+    const m = e.slice(11), k = m.indexOf("/"), s = k === -1 ? m : m.slice(0, k), f = d.config.documentation.getComponentDocsUrl(s, I(s));
+    f !== void 0 && (u = f + (k === -1 ? "" : m.slice(k + 1)));
   }
   return u ??= `${d.normalizedApiReferencePrefix}${e}/`, U(u, n, i);
 }

package/dist/{typeScript-C_Y_81n6.js → typeScript-Bcylmvl-.js}

@@ -1,7 +1,7 @@
 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.89", D = {
+const w = "@arcgis/api-extractor", P = "5.1.0-next.90", D = {
   name: w,
   version: P
 };

package/dist/vite/plugin.js

@@ -1,6 +1,6 @@
-import { l as O, m as J } from "../worker-sOtqMU7v.js";
-import { A as S, w as T } from "../ApiExtractor-CcUbKtCm.js";
-import { p as A, l as C } from "../typeScript-C_Y_81n6.js";
+import { l as O, m as J } from "../worker-DdLxplOi.js";
+import { A as S, w as T } from "../ApiExtractor-DD4ODfUV.js";
+import { p as A, l as C } from "../typeScript-Bcylmvl-.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-C_Y_81n6.js";
+import { b as t } from "../typeScript-Bcylmvl-.js";
 export {
   t as loadTypeScriptConfig
 };

package/dist/{worker-sOtqMU7v.js → worker-DdLxplOi.js}

@@ -1,5 +1,5 @@
 import { path as He, existsAsync as Yt, getCwd as Di, retrievePackageJson as ct, toPosixPathSeparators as xi } from "@arcgis/components-build-utils";
-import { b as Ri, p as Li, l as Ii } from "./typeScript-C_Y_81n6.js";
+import { b as Ri, p as Li, l as Ii } from "./typeScript-Bcylmvl-.js";
 import { getDefaultBasePath as Zt, buildViewUrl as Ai, getViewUrl as Ue } from "./extractor/processing/links.js";
 import o from "typescript";
 import "fs/promises";
@@ -304,8 +304,8 @@ function J(e, t, n) {
     const s = n.file.text.slice(l.pos, l.end);
     s.startsWith("/**") && (a !== void 0 && n.config.strict && n.emitError(
       `Found multiple JSDoc comments for the same node. This is not allowed.
-If one of these was meant to be a file-level comment, read the documentation: https://webgis.esri.com/webgis/core/core/documenting-api#module-level-documentation
-If this is meant to be a function overload, read the documentation: https://webgis.esri.com/webgis/core/core/documenting-api#function-overloads`,
+If one of these was meant to be a file-level comment, read the documentation: https://webgis.esri.com/sdk/contributing/core/core/documenting-api#module-level-documentation
+If this is meant to be a function overload, read the documentation: https://webgis.esri.com/sdk/contributing/core/core/documenting-api#function-overloads`,
       {
         file: n.file,
         node: e
@@ -1524,7 +1524,7 @@ function Bn(e) {
 function Et(e, t, n, i) {
   const a = { file: n, node: e };
   return e.getText(n).includes("* @public") && i.emitError(
-    "@public is not permitted in nested types. See options in documentation: https://webgis.esri.com/webgis/core/core/documenting-api#describing-nested-object-types and https://webgis.esri.com/webgis/core/core/documenting-api#variables",
+    "@public is not permitted in nested types. See options in documentation: https://webgis.esri.com/sdk/contributing/core/core/documenting-api#describing-nested-object-types and https://webgis.esri.com/sdk/contributing/core/core/documenting-api#variables",
     a
   ), H(e, t, a, i);
 }
@@ -1788,7 +1788,7 @@ function Yn(e) {
 }
 function z(e, t) {
   if (b = t, _e.clear(), $ = [], Qe.clear(), e.pos !== -1 && e.getText(b.file).includes("* @public") && b.emitError(
-    "@public JSDoc tag may only appear in interfaces, top-level of type alias, or top-level intersection inside a type-alias. @public JSDoc tag inside inline object literal types or deeper aliases is not supported as such are tricky to represent in the docs UI. Refactor out the type into a separate top-level interface/type-alias. Documentation: https://webgis.esri.com/webgis/core/core/documenting-api#describing-nested-object-types",
+    "@public JSDoc tag may only appear in interfaces, top-level of type alias, or top-level intersection inside a type-alias. @public JSDoc tag inside inline object literal types or deeper aliases is not supported as such are tricky to represent in the docs UI. Refactor out the type into a separate top-level interface/type-alias. Documentation: https://webgis.esri.com/sdk/contributing/core/core/documenting-api#describing-nested-object-types",
     { file: b.file, node: e }
   ), e.kind === o.SyntaxKind.Identifier || e.kind === o.SyntaxKind.QualifiedName)
     Be(e);
@@ -1824,7 +1824,7 @@ const ge = (e, t, n) => {
         case "ToElement":
           return ge(e, i.typeArguments[0], n);
         /**
-         * @see https://webgis.esri.com/webgis/core/core/documenting-api#publicprivate-type-divergence
+         * @see https://webgis.esri.com/sdk/contributing/core/core/documenting-api#publicprivate-type-divergence
          */
         case "PublicApiNarrowType":
         case "PublicApiRelaxType":
@@ -2223,7 +2223,7 @@ function ce(e, t, n, i, a) {
   const l = i.name;
   let s = n?.[l];
   s === void 0 && e.emitError(
-    "@copyDoc tag was used, but failed to find copyDoc definition for it. Documentation: https://webgis.esri.com/webgis/core/core/documenting-api#copydoc",
+    "@copyDoc tag was used, but failed to find copyDoc definition for it. Documentation: https://webgis.esri.com/sdk/contributing/core/core/documenting-api#copydoc",
     {
       file: e.file,
       node: t
@@ -2329,7 +2329,7 @@ function Ae(e, t, n, i) {
     let G = M[E + _]?.text, O, F;
     if (!i.config.strict && (G === void 0 || A === void 0) && (G = A ?? `parameter${E}`), G === void 0) {
       i.emitError(
-        `Expected @param tag for every parameter on a public function. If you need to include a non-public parameter on a public function, see https://webgis.esri.com/webgis/core/core/documenting-api#param${v ? " and https://webgis.esri.com/webgis/core/core/documenting-api#constructor" : ""}`,
+        `Expected @param tag for every parameter on a public function. If you need to include a non-public parameter on a public function, see https://webgis.esri.com/sdk/contributing/core/core/documenting-api#param${v ? " and https://webgis.esri.com/sdk/contributing/core/core/documenting-api#constructor" : ""}`,
         { file: i.file, node: S }
       ), T = !0;
       break;
@@ -2368,7 +2368,7 @@ function Ae(e, t, n, i) {
     ie.optional = $t(S, ie), y.parameters.push(ie);
   }
   if (i.config.strict && !T && D !== y.parameters.length && i.emitError(
-    `Expected @param tags to match the number of parameters on a public function. Found ${M.length} @param tags for ${y.parameters.length} TypeScript parameters. Documentation: https://webgis.esri.com/webgis/core/core/documenting-api#param${v ? " and https://webgis.esri.com/webgis/core/core/documenting-api#constructor" : ""}`,
+    `Expected @param tags to match the number of parameters on a public function. Found ${M.length} @param tags for ${y.parameters.length} TypeScript parameters. Documentation: https://webgis.esri.com/sdk/contributing/core/core/documenting-api#param${v ? " and https://webgis.esri.com/sdk/contributing/core/core/documenting-api#constructor" : ""}`,
     { file: i.file, node: e }
   ), y.parameters.length === 0)
     y.parameters = void 0;
@@ -2915,7 +2915,7 @@ function Ze(e, t) {
     m,
     t.apiModule
   ), t.moduleHasClass && t.config.strict && t.emitError(
-    "A module may only export at most one public class/mixin/custom element. Documentation: https://webgis.esri.com/webgis/core/core/documenting-api#class",
+    "A module may only export at most one public class/mixin/custom element. Documentation: https://webgis.esri.com/sdk/contributing/core/core/documenting-api#class",
     { file: t.file, node: e }
   ), t.moduleHasClass = !0) : yi(
     t,
@@ -3214,7 +3214,7 @@ function Oo(e, t, n) {
     !0,
     n
   ) !== void 0 && n.emitError(
-    "Type parameters are not yet supported in public mixins (the first TBase type parameter is a special case). See workaround in https://webgis.esri.com/webgis/core/core/mixins#limitations-of-mixins",
+    "Type parameters are not yet supported in public mixins (the first TBase type parameter is a special case). See workaround in https://webgis.esri.com/sdk/contributing/core/core/mixins#limitations-of-mixins",
     {
       file: n.file,
       node: e
@@ -3511,7 +3511,7 @@ function Vo(e, t) {
     (y.kind === "class" || y.kind === "mixin") && (f.class = y), R === y.name && (f.default = y), f.named[y.name] = y;
   }
   return m !== void 0 && (t.moduleHasClass ? t.emitError(
-    "A module that exports a class must have JSDoc attached to the class, rather than module-top JSDoc. See https://webgis.esri.com/webgis/core/core/documenting-api#module-documentation",
+    "A module that exports a class must have JSDoc attached to the class, rather than module-top JSDoc. See https://webgis.esri.com/sdk/contributing/core/core/documenting-api#module-documentation",
     {
       file: e,
       start: 0,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcgis/api-extractor",
-  "version": "5.1.0-next.89",
+  "version": "5.1.0-next.90",
   "description": "Documentation engine for WebGIS SDK packages",
   "type": "module",
   "main": "dist/index.cjs",
@@ -53,8 +53,8 @@
     "@commander-js/extra-typings": "^14.0.0",
     "commander": "^14.0.0",
     "tslib": "^2.8.1",
-    "@arcgis/components-build-utils": "5.1.0-next.89",
-    "@arcgis/toolkit": "5.1.0-next.89"
+    "@arcgis/components-build-utils": "5.1.0-next.90",
+    "@arcgis/toolkit": "5.1.0-next.90"
   },
   "peerDependencies": {
     "typescript": "~6.0.2",