@arcgis/api-extractor 5.2.0-next.4 → 5.2.0-next.5

package/dist/{ApiExtractor-Dgo6jr2j.js → ApiExtractor-BtYLt7dP.js}

@@ -1,5 +1,5 @@
-import { l as H, a as se, e as De, p as me } from "./typeScript-BsuvRihm.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 je, h as ze, j as He, k as Je, n as Ve, r as Xe } from "./worker-D-jUD6OL.js";
+import { l as H, a as se, e as De, p as me } from "./typeScript-C9dgub7w.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 je, h as ze, j as He, k as Je, n as Ve, r as Xe } from "./worker-Cxfdi8N7.js";
 import { getViewUrl as Ye, postProcessDeprecated as Q, postProcessDescription as R, 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/extractor/ApiExtractor.js

@@ -1,8 +1,8 @@
-import "../typeScript-BsuvRihm.js";
-import "../worker-D-jUD6OL.js";
+import "../typeScript-C9dgub7w.js";
+import "../worker-Cxfdi8N7.js";
 import "./processing/links.js";
 import "typescript";
-import { A as x } from "../ApiExtractor-Dgo6jr2j.js";
+import { A as x } from "../ApiExtractor-BtYLt7dP.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-BsuvRihm.js";
-import { l, m as n, r as A } from "../worker-D-jUD6OL.js";
+import "../typeScript-C9dgub7w.js";
+import { l, m as n, r as A } from "../worker-Cxfdi8N7.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-BsuvRihm.js → typeScript-C9dgub7w.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.4", D = {
+const w = "@arcgis/api-extractor", P = "5.2.0-next.5", D = {
   name: w,
   version: P
 };

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/vite/plugin.js

@@ -1,6 +1,6 @@
-import { l as O, m as J } from "../worker-D-jUD6OL.js";
-import { A as S, w as T } from "../ApiExtractor-Dgo6jr2j.js";
-import { p as A, l as C } from "../typeScript-BsuvRihm.js";
+import { l as O, m as J } from "../worker-Cxfdi8N7.js";
+import { A as S, w as T } from "../ApiExtractor-BtYLt7dP.js";
+import { p as A, l as C } from "../typeScript-C9dgub7w.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-BsuvRihm.js";
+import { b as t } from "../typeScript-C9dgub7w.js";
 export {
   t as loadTypeScriptConfig
 };

package/dist/{worker-D-jUD6OL.js → worker-Cxfdi8N7.js}

@@ -1,5 +1,5 @@
 import { path as $e, existsAsync as Zt, getCwd as Ri, retrievePackageJson as dt, toPosixPathSeparators as Li } from "@arcgis/components-build-utils";
-import { b as Ii, p as Ai, l as ki } from "./typeScript-BsuvRihm.js";
+import { b as Ii, p as Ai, l as ki } from "./typeScript-C9dgub7w.js";
 import { getDefaultBasePath as ei, buildViewUrl as Gi, getViewUrl as Ve } from "./extractor/processing/links.js";
 import o from "typescript";
 import "fs/promises";

package/package.json

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