@arcgis/api-extractor 5.2.0-next.0 → 5.2.0-next.10

package/dist/extractor/ApiExtractor.js

@@ -1,8 +1,8 @@
-import "../typeScript-Dk1Rn-2E.js";
-import "../worker-CCFrgas5.js";
+import "../typeScript-B79ma30F.js";
+import "../worker-DDand5P_.js";
 import "./processing/links.js";
 import "typescript";
-import { A as x } from "../ApiExtractor-DNNO0gUt.js";
+import { A as x } from "../ApiExtractor-CE7LmkJj.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-Dk1Rn-2E.js";
-import { l, m as n, r as A } from "../worker-CCFrgas5.js";
+import "../typeScript-B79ma30F.js";
+import { l, m as n, r as A } from "../worker-DDand5P_.js";
 import "./processing/links.js";
 import "typescript";
 import "fs/promises";

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

@@ -1,4 +1,4 @@
-import type { ApiClassDeclaration, ApiClassMethod, ApiCustomElementDeclaration, ApiCustomElementField, ApiEvent, ApiFunctionDeclaration, ApiInterfaceDeclaration, ApiModule, ApiVariableDeclaration } from "../../apiJson.js";
+import type { ApiClassDeclaration, ApiClassMethod, ApiCustomElementDeclaration, ApiCustomElementField, ApiEvent, ApiFunctionDeclaration, ApiInterfaceDeclaration, ApiModule, ApiVariableDeclaration, ApiWithDeprecated, ApiWithDescription, ApiWithDocsTags } from "../../apiJson.js";
 
 /** [Documentation](https://webgis.esri.com/references/api-extractor/tags-reference#copydoc)) */
 export interface CopyDocDefinitions {
@@ -18,8 +18,14 @@ export interface CopyDocDefinitions {
   interfaces?: CopyDocDeclarations<ApiInterfaceDeclaration>;
 }
 
-export type CopiableFields = "deprecated" | "description" | "docsTags" | "readonly" | "return";
+/**
+ * A common shape for metadata that can be included in declarative copy doc.
+ * Extra fields can be specified by imperatively mutating the API declaration.
+ */
+export interface CopyDocCommonBase extends Partial<ApiWithDescription>, Partial<ApiWithDocsTags>, Partial<ApiWithDeprecated> {
+  return?: ApiWithDescription;
+}
 
-export type CopyDocDeclarations<ApiType extends Partial<Record<CopiableFields, unknown>>> = Record<string, Partial<Pick<ApiType, CopiableFields>> | ((apiDeclaration: ApiType, module: ApiModule) => Partial<Pick<ApiType, CopiableFields>>) | undefined>;
+export type CopyDocDeclarations<ApiType extends Partial<CopyDocCommonBase>> = Record<string, Pick<CopyDocCommonBase, keyof ApiType & keyof CopyDocCommonBase> | ((apiDeclaration: ApiType, module: ApiModule) => Pick<CopyDocCommonBase, keyof ApiType & keyof CopyDocCommonBase>) | undefined>;
 
-export type CopyDocMemberDeclarations<ApiType extends Partial<Record<CopiableFields, unknown>>> = Record<string, Partial<Pick<ApiType, CopiableFields>> | ((apiDeclaration: ApiType, classOrComponent: ApiClassDeclaration | ApiCustomElementDeclaration, module: ApiModule) => Partial<Pick<ApiType, CopiableFields>>) | undefined>;
+export type CopyDocMemberDeclarations<ApiType extends Partial<CopyDocCommonBase>> = Record<string, Pick<CopyDocCommonBase, keyof ApiType & keyof CopyDocCommonBase> | ((apiDeclaration: ApiType, classOrComponent: ApiClassDeclaration | ApiCustomElementDeclaration, module: ApiModule) => Pick<CopyDocCommonBase, keyof ApiType & keyof CopyDocCommonBase> | undefined) | undefined>;

package/dist/{typeScript-Dk1Rn-2E.js → typeScript-B79ma30F.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.2.0-next.0", D = {
+const w = "@arcgis/api-extractor", P = "5.2.0-next.10", D = {
   name: w,
   version: P
 };

package/dist/utils/apiHelpers.d.ts

@@ -12,6 +12,9 @@ export const globalPackageIdentifier: "global:";
 /**
  * Get a name from a class member.
  *
+ * > We don't need a similar utility for ApiModule declarations as each
+ * > declaration has a name.
+ *
  * @param member
  * @example
  * - method named "test" => "test"

package/dist/utils/apiHelpers.js

@@ -30,7 +30,7 @@ function x(e, n, o) {
 }
 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);
+  "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);
   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 ??= [];
@@ -43,7 +43,7 @@ function k(e, n, o = -1) {
     }
   }
 }
-function y(e, n) {
+function A(e, n) {
   let o = e.text;
   if (e.references !== void 0)
     for (let i = e.references.length - 1; i >= 0; i--) {
@@ -59,11 +59,11 @@ function y(e, n) {
     references: void 0
   };
 }
-function A(e) {
+function N(e) {
   return e.return.type.text.startsWith("Promise<");
 }
 export {
-  y as apiTypeToImportType,
+  A as apiTypeToImportType,
   M as compareClassMembers,
   S as compareNamedNodes,
   l as compareStrings,
@@ -73,7 +73,7 @@ export {
   P as getMaybeStaticApiMemberName,
   p as globalPackageIdentifier,
   g as isApiMethod,
-  A as isApiMethodAsync,
+  N as isApiMethodAsync,
   v as isApiProperty,
   k as mergeApiNodes,
   h as naturalSortModules

package/dist/utils/hydrateApiType.js

@@ -1,3 +1,4 @@
+import { globalPackageIdentifier as h } from "./apiHelpers.js";
 const d = {
   // Create a null prototype object to avoid collisions with Object.prototype when doing lookups
   // eslint-disable-next-line @typescript-eslint/naming-convention
@@ -13,50 +14,50 @@ const d = {
   never: "https://www.typescriptlang.org/docs/handbook/2/functions.html#never",
   any: "https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any",
   this: "#"
-}, h = Object.keys(d).join("|"), g = new RegExp(`(?<!["'-])\\b(?:${h})\\b(?!["'-])`, "u");
-function p(e, c) {
-  const n = [];
-  let o = e.text.length;
+}, g = Object.keys(d).join("|"), p = new RegExp(`(?<!["'-])\\b(?:${g})\\b(?!["'-])`, "u");
+function v(e, l) {
+  const o = [];
+  let n = e.text.length;
   if (e.references !== void 0)
-    for (let l = e.references.length - 1; l >= 0; l--) {
-      const t = e.references[l];
+    for (let c = e.references.length - 1; c >= 0; c--) {
+      const t = e.references[c];
       if (t.start === void 0 || t.end === void 0)
         continue;
-      const r = e.text.slice(t.end, o);
-      r.length > 0 && i(r, c, n);
+      const r = e.text.slice(t.end, n);
+      r.length > 0 && i(r, l, o);
       const s = e.text.slice(t.start, t.end);
-      o = t.start, t.viewUrl === void 0 ? n.push(s) : n.push(
-        c(s, t)
+      n = t.start, t.viewUrl === void 0 ? o.push(s) : o.push(
+        l(s, t)
       );
     }
-  if (o > 0) {
-    const l = e.text.slice(0, o);
-    i(l, c, n);
+  if (n > 0) {
+    const c = e.text.slice(0, n);
+    i(c, l, o);
   }
-  return n.reverse();
+  return o.reverse();
 }
-function i(e, c, n) {
-  const o = n.length;
-  for (let l = 0; l < e.length; ) {
-    const t = e.match(g);
+function i(e, l, o) {
+  const n = o.length;
+  for (let c = 0; c < e.length; ) {
+    const t = e.match(p);
     if (t?.index === void 0)
       break;
     const r = e.slice(0, t.index);
-    r.length > 0 && n.splice(o, 0, r);
+    r.length > 0 && o.splice(n, 0, r);
     const s = t[0];
     e = e.slice(t.index + s.length);
-    const a = d[s], b = c(s, {
+    const a = d[s], b = l(s, {
       name: s,
       module: void 0,
-      package: s === "this" ? void 0 : "global:",
+      package: s === "this" ? void 0 : h,
       viewUrl: a,
       start: void 0,
       end: void 0
     });
-    n.splice(o, 0, b);
+    o.splice(n, 0, b);
   }
-  e.length > 0 && n.splice(o, 0, e);
+  e.length > 0 && o.splice(n, 0, e);
 }
 export {
-  p as hydrateApiType
+  v as hydrateApiType
 };

package/dist/vite/plugin.js

@@ -1,6 +1,6 @@
-import { l as O, m as J } from "../worker-CCFrgas5.js";
-import { A as S, w as T } from "../ApiExtractor-DNNO0gUt.js";
-import { p as A, l as C } from "../typeScript-Dk1Rn-2E.js";
+import { l as O, m as J } from "../worker-DDand5P_.js";
+import { A as S, w as T } from "../ApiExtractor-CE7LmkJj.js";
+import { p as A, l as C } from "../typeScript-B79ma30F.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-Dk1Rn-2E.js";
+import { b as t } from "../typeScript-B79ma30F.js";
 export {
   t as loadTypeScriptConfig
 };