@arcgis/api-extractor 5.0.0-next.14 → 5.0.0-next.141

package/dist/index.js

@@ -1,285 +1,5 @@
-import c from "typescript";
-import { path as y } from "@arcgis/components-build-utils";
-import T, { supportsColorStderr as S } from "chalk";
-import { mappedFind as D } from "@arcgis/toolkit/array";
-const m = "@arcgis/api-extractor", E = "5.0.0-next.14", H = (t) => t.kind === "method", q = (t) => t.kind === "field";
-function k(t, e) {
-  const s = t.path.split("/"), n = s.pop(), o = s.join("/"), i = e.path.split("/"), r = i.pop(), a = i.join("/");
-  return o === a ? n < r ? -1 : 1 : o.startsWith(a) ? 1 : a.startsWith(o) || o < a ? -1 : 1;
-}
-const G = "global:", C = /* @__PURE__ */ new Set([
-  "example",
-  "see",
-  "param",
-  "property",
-  "throws",
-  "slot",
-  "csspart",
-  "cssstate"
-]), $ = c.createPrinter();
-function w(t) {
-  return $.printNode(c.EmitHint.Unspecified, t, void 0);
-}
-function L(t, e) {
-  return t.pos !== -1 && t.end !== -1 && e !== void 0 ? t.getText(e) : w(t);
-}
-let A = 0;
-const I = /* @__PURE__ */ new Set();
-let g = console.error;
-function Q(t) {
-  g = t;
-}
-const M = {
-  getCurrentDirectory: process.cwd,
-  getCanonicalFileName: (t) => t,
-  getNewLine: () => c.sys.newLine
-};
-function N(t, { file: e, node: s, scope: n, start: o, length: i }) {
-  A += 1, process.exitCode = 1;
-  const r = e?.fileName;
-  r !== void 0 && I.add(r), o ??= s?.getStart(e, !1) ?? -1;
-  const a = s?.end ?? -1;
-  i ??= a === -1 ? -1 : Math.max(1, a - o);
-  const d = o >= 0 && i >= 0, l = !d && n !== void 0, f = {
-    category: c.DiagnosticCategory.Error,
-    code: d ? m : K,
-    file: l ? void 0 : e,
-    start: d ? o : 0,
-    length: d ? i : 0,
-    messageText: (l ? `${T.cyan(n)}: ` : "") + t + (d || s === void 0 ? "" : `
-
-${L(s, e)}`)
-  }, x = c.formatDiagnosticsWithColorAndContext([f], M), v = S ? x : x.replaceAll(j, "");
-  g(v);
-}
-const K = 1490, j = /\x1B\[[0-9;]*m/gu;
-class X {
-  constructor(e) {
-    this.options = e;
-  }
-  /** Given an array of TypeScript source files, generate an api.json file */
-  extract(e) {
-    return {
-      timestamp: (/* @__PURE__ */ new Date()).toISOString().split(".")[0],
-      compiler: {
-        name: m,
-        version: E,
-        typescriptVersion: c.version
-      },
-      schemaVersion: "1.0.0",
-      modules: this.extractModules(e)
-    };
-  }
-  extractModules(e) {
-    const s = [];
-    for (const n of e)
-      this.file = n, s.push(this.extractModule(n));
-    return this.options.isFullApiExtraction && s.sort(k), s;
-  }
-  extractModule(e) {
-    const s = {
-      kind: "javascript-module",
-      path: y.relative(this.options.cwd, e.fileName),
-      declarations: void 0,
-      exports: void 0
-    };
-    this.apiModule = s;
-    const n = this.extractDeclarations(e);
-    if (s.declarations = n, this.options.isFullApiExtraction) {
-      const o = this.inferExports(n);
-      o.length > 0 && (s.exports = o);
-    }
-    return s;
-  }
-  /**
-   * For a given module, extract all public declarations.
-   */
-  extractDeclarations(e) {
-    const s = [];
-    for (const n of e.statements) {
-      const o = this.extractDeclaration(n);
-      o !== void 0 && s.push(o);
-    }
-    return s;
-  }
-  /**
-   * Infer ApiModule.exports based on ApiModule.declarations.
-   */
-  inferExports(e) {
-    const s = [];
-    for (const n of e) {
-      const o = this.inferExport(n);
-      o !== void 0 && s.push(o);
-    }
-    return s;
-  }
-  copyDoc(e, s, n, o) {
-    const i = n.docsTags?.findIndex((d) => d.name === "copyDoc");
-    if (i === void 0 || i === -1)
-      return;
-    s === void 0 && N("@copyDoc tag was used, but failed to find copyDoc definition for it.", {
-      file: this.file,
-      node: e
-    });
-    const r = s?.(n, o);
-    if (r === void 0)
-      return;
-    for (const [d, l] of Object.entries(r))
-      d !== "docsTags" && (n[d] = n[d] ?? l);
-    n.docsTags.splice(i, 1);
-    const a = new Set(n.docsTags.map(({ name: d }) => d));
-    for (const d of r.docsTags ?? [])
-      a.has(d.name) && !C.has(d.name) || n.docsTags.push(d);
-    n.docsTags.length === 0 && (n.docsTags = void 0);
-  }
-}
-const Y = (t) => t.modifiers?.some?.(
-  (e) => e.kind === c.SyntaxKind.StaticKeyword || e.kind === c.SyntaxKind.PrivateKeyword || e.kind === c.SyntaxKind.ProtectedKeyword
-) ?? !1;
-function Z(t, e, s) {
-  if (!e.default && "initializer" in t && t.initializer) {
-    const n = h(t.initializer);
-    F(n) && (e.default = n.getText(s));
-  }
-}
-const F = (t) => c.isLiteralExpression(t) || t.kind === c.SyntaxKind.TrueKeyword || t.kind === c.SyntaxKind.FalseKeyword || c.isPrefixUnaryExpression(t) && c.isLiteralExpression(t.operand);
-function h(t) {
-  return c.isSatisfiesExpression(t) || c.isParenthesizedExpression(t) ? h(t.expression) : t;
-}
-function _(t) {
-  if (t !== void 0 && (c.isIdentifier(t) || c.isStringLiteralLike(t)))
-    return t.text;
-}
-const tt = ({ modifiers: t = [] }, e) => D(
-  t,
-  (s) => c.isDecorator(s) && c.isCallExpression(s.expression) && c.isIdentifier(s.expression.expression) && s.expression.expression.text === e ? s.expression : void 0
-);
-function P(t, e) {
-  const s = W(e.getJsDocTags());
-  let n = c.displayPartsToString(e.getDocumentationComment(t));
-  const o = s.at(-1), i = o?.text?.indexOf(O);
-  if (i !== void 0 && i !== -1) {
-    const r = o.text.indexOf(b);
-    r !== -1 && (n += o.text.slice(r), o.text = o.text?.slice(0, r));
-  }
-  return {
-    docsTags: s,
-    description: n || void 0
-  };
-}
-const b = `
-
-{@link `, O = "Read more...}", W = (t) => t.filter((e) => e.name !== "privateRemarks").map((e) => ({
-  name: e.name,
-  text: e.text?.map((s) => s.text).join("")
-}));
-function et(t) {
-  const e = Array.from(t.docsTags ?? []), s = t, n = t;
-  if (t.deprecated && e.push({
-    name: "deprecated",
-    text: t.deprecated === !0 ? void 0 : t.deprecated
-  }), s.default && e.push({
-    name: "default",
-    text: s.default
-  }), n.cssParts)
-    for (const i of n.cssParts)
-      e.push({
-        name: "csspart",
-        text: u(i)
-      });
-  if (n.cssStates)
-    for (const i of n.cssStates)
-      e.push({
-        name: "cssstate",
-        text: u(i)
-      });
-  if (n.slots)
-    for (const i of n.slots)
-      e.push({
-        name: "slot",
-        text: u(i)
-      });
-  n.privacy === "private" && e.push({
-    name: "private",
-    text: void 0
-  });
-  const o = t.description ?? "";
-  return e.length === 0 && o.length === 0 ? [] : [J(o, e)];
-}
-function J(t = "", e = []) {
-  return {
-    kind: c.SyntaxKind.MultiLineCommentTrivia,
-    pos: -1,
-    end: -1,
-    text: R(t, e),
-    hasTrailingNewLine: !0
-  };
-}
-function R(t = "", e = []) {
-  const s = t === "" ? [] : t.split(`
-`), o = s.length + e.length > 1 || (e.at(0)?.text?.includes(`
-`) ?? !1);
-  return `*${o ? s.map((i) => `
- * ${i}`).join("") : ` ${t}`}${s.length > 0 && e.length > 0 ? `
- *` : ""}${e.map((i) => {
-    const r = `@${i.name}`, a = i.text ?? "", d = i.text?.includes(`
-`) ?? !1;
-    return `${o ? `
- * ` : ""}${r}${d ? a.split(`
-`).map((f) => `
- * ${f}`).join("") : a.length > 0 ? ` ${a}` : ""}`;
-  }).join("")}${o ? `
-` : ""} `;
-}
-function st(t, e, s, n) {
-  const o = e.getSymbolAtLocation(t);
-  if (n ??= o === void 0 ? void 0 : P(e, o), n !== void 0) {
-    for (const i of n.docsTags) {
-      const { name: r, text: a } = i;
-      r === "deprecated" ? s.deprecated = a || !0 : r === "default" ? s.default = a : r === "readonly" ? s.readonly = !0 : r === "private" ? s.privacy = "private" : r === "csspart" ? s.cssParts.push(p(a)) : r === "cssstate" ? s.cssStates.push(p(a)) : r === "slot" ? s.slots.push(p(a)) : (s.docsTags ??= [], s.docsTags.push(i));
-    }
-    s.description = n.description;
-  }
-}
-function p(t) {
-  if (t === void 0)
-    return { name: "" };
-  const e = t.indexOf(" - ");
-  if (e === -1)
-    return t.startsWith("- ") ? { name: "", description: t.slice(2) } : { name: t };
-  let s, n = t.slice(0, e);
-  if (n.startsWith("[") && n.endsWith("]")) {
-    const i = n.slice(1, -1), r = i.indexOf("=");
-    n = i.slice(0, r), s = i.slice(r + 1);
-  }
-  const o = t.slice(e + 3);
-  return {
-    name: n,
-    default: s,
-    description: o
-  };
-}
-function u(t) {
-  const e = t.name + (t.default !== void 0 ? `=${t.default}` : ""), s = e.length > 0 ? `[${e}]` : "", n = t.description ?? "", o = n.length > 0 ? ` - ${n}` : "";
-  return `${s}${o}`;
-}
+import { printSignature as r } from "./utils/partPrinter.js";
+const i = r;
 export {
-  X as ApiExtractor,
-  N as apiExtractorError,
-  A as apiExtractorErrorCount,
-  I as apiExtractorErrorFiles,
-  et as apiMemberToSynthesizedComments,
-  L as debugPrintNode,
-  tt as findDecorator,
-  _ as getMemberName,
-  G as globalPackageIdentifier,
-  Y as hasIgnoredModifier,
-  H as isApiMethod,
-  q as isApiProperty,
-  C as multipleJsDocTags,
-  w as printNode,
-  st as setApiDocFromJsDoc,
-  Q as setApiExtractorErrorLogger,
-  Z as setDefaultFromInitializer,
-  P as symbolToDocs
+  i as printSignature
 };

package/dist/typeScript-soMJqHns.js

@@ -0,0 +1,64 @@
+import { findPath as v, path as C, toSystemPathSeparators as y } from "@arcgis/components-build-utils";
+import t from "typescript";
+import E, { supportsColorStderr as S } from "chalk";
+import { styleText as w } from "util";
+const P = "@arcgis/api-extractor", D = "5.0.0-next.141", N = {
+  name: P,
+  version: D
+};
+let u;
+function A(o) {
+  return u ??= t.createPrinter(), u.printNode(t.EmitHint.Unspecified, o, void 0);
+}
+function F(o, r) {
+  return o.pos !== -1 && o.end !== -1 && r !== void 0 ? o.getText(r) : A(o);
+}
+const p = N.name, g = {
+  getCurrentDirectory: process.cwd,
+  getCanonicalFileName: (o) => o,
+  getNewLine: () => t.sys.newLine
+}, W = function(o, { file: r, node: n, scope: s, start: i, length: c }) {
+  this.errorCount += 1, process.exitCode = 1, i ??= n === void 0 || n.pos === -1 ? -1 : n.getStart(r, !1);
+  const a = n?.end ?? -1;
+  c ??= a === -1 ? -1 : Math.max(1, a - i);
+  const e = i >= 0 && c >= 0, d = !e && s !== void 0, f = {
+    category: t.DiagnosticCategory.Error,
+    code: e ? p : x,
+    file: d ? void 0 : r,
+    start: e ? i : 0,
+    length: e ? c : 0,
+    messageText: (d ? `${E.cyan(s)}: ` : "") + o + (e || n === void 0 ? "" : `
+
+${F(n, r)}`)
+  }, l = t.formatDiagnosticsWithColorAndContext([f], g), m = S ? l : l.replaceAll($, ""), h = e ? m : m.replace(x.toString(), p);
+  this.config.context.logger.error(h);
+}, x = 1490, $ = /\x1B\[[0-9;]*m/gu, J = w("cyan", `[${p}] `);
+function U(o = process.cwd(), r, n) {
+  const s = r === void 0 ? v("tsconfig.json", o) : C.resolve(o, r);
+  if (s === void 0)
+    throw Error(
+      `Unable to find ${y(String(r))}. Please make sure the file exists, or provide types.tsconfigPath option to useLumina()`
+    );
+  const i = t.readConfigFile(s, t.sys.readFile);
+  if (i.error !== void 0)
+    throw Error(t.formatDiagnosticsWithColorAndContext([i.error], g));
+  const c = i.config, a = n ? c : {
+    ...c,
+    include: [],
+    files: [],
+    exclude: []
+  }, e = t.parseJsonConfigFileContent(a, t.sys, C.dirname(s)), d = 18002, f = n ? e.errors : e.errors.filter((l) => l.code !== d);
+  if (f.length > 0)
+    throw Error(t.formatDiagnosticsWithColorAndContext(f, g));
+  return {
+    configPath: s,
+    config: e
+  };
+}
+export {
+  g as a,
+  U as b,
+  W as e,
+  J as l,
+  N as p
+};

package/dist/uiUtils/index.d.ts

@@ -0,0 +1,12 @@
+import type { ApiType } from "../apiJson.js";
+import type { HydrateApiTypeCallback as HydrateApiTypeCallbackAlias } from "../utils/hydrateApiType.js";
+
+/**
+ * @deprecated import { hydrateApiType } from "@arcgis/api-extractor/utils/hydrateApiType" instead.
+ * @param apiType
+ * @param hydratePart
+ */
+export function hydrateApiType<T>(apiType: Pick<ApiType, "references" | "text">, hydratePart: HydrateApiTypeCallbackAlias<T>): (T | string)[];
+
+/** @deprecated import { HydrateApiTypeCallback } from "@arcgis/api-extractor/utils/hydrateApiType" instead. */
+export type HydrateApiTypeCallback<T> = HydrateApiTypeCallbackAlias<T>;

package/dist/uiUtils/index.js

@@ -0,0 +1,5 @@
+import { hydrateApiType as p } from "../utils/hydrateApiType.js";
+const r = p;
+export {
+  r as hydrateApiType
+};

package/dist/utils/apiHelpers.d.ts

@@ -1,23 +1,49 @@
-import { ApiClassMember, ApiClassMethod, ApiCustomElementField, ApiModule } from '../apiJson';
-export declare const isApiMethod: (member: ApiClassMember) => member is ApiClassMethod;
-export declare const isApiProperty: (member: ApiClassMember) => member is ApiCustomElementField;
+import type { ApiClassMember, ApiClassMethod, ApiCssCustomProperty, ApiCustomElementField, ApiCustomElementMember, ApiDeclaration, ApiEvent, ApiSlot } from "../apiJson.js";
+
+/** @param member */
+export function isApiMethod(member: ApiClassMember): member is ApiClassMethod;
+
+/** @param member */
+export function isApiProperty(member: ApiClassMember): member is ApiCustomElementField;
+
+/** This is not made up by us - defined in the custom-elements-manifest spec */
+export const globalPackageIdentifier: "global:";
+
 /**
- * Being a bit smarter than simply sorting paths alphabetically. The goal
- * is that nested components appear after their parent component. Otherwise,
- * simple alphabetical.
+ * Get a name from a class member.
  *
+ * @param member
  * @example
- * ```ts
- * [
- *  "src/components/z/z.js",
- *  "src/components/z/components/sub-a.js",
- *  "src/components/z/components/sub-z.js",
- * ]
- * ```
+ * - method named "test" => "test"
+ * - property named "test" => "test"
+ * - constructor => "constructor"
+ * - call-signature => "call-signature"
  */
-export declare function naturalSortModules(left: ApiModule, right: ApiModule): number;
+export function getApiMemberName(member: ApiClassMember | ApiCustomElementMember): string;
+
 /**
- * This is not made up by us - defined in the custom-elements-manifest spec
+ * Like `getApiMemberName`, but prefixes with `static ` if the member is static.
+ *
+ * @param member
+ */
+export function getMaybeStaticApiMemberName(member: ApiClassMember | ApiCustomElementMember): string;
+
+/**
+ * Get a UI label from a class member.
+ *
+ * @param member
+ * @example
+ * - method named "test" => "test()"
+ * - property named "test" => "test"
+ * - constructor => "constructor()"
+ * - call-signature => "()"
+ * - web component with tag name "my-component" => "my-component"
+ */
+export function getApiNodeLabel(member: ApiClassMember | ApiCssCustomProperty | ApiCustomElementMember | ApiDeclaration | ApiEvent | ApiSlot): string;
+
+/**
+ * Checks whether method's return type is a Promise.
+ *
+ * @param apiMethod
  */
-export declare const globalPackageIdentifier = "global:";
-export declare const multipleJsDocTags: Set<string>;
+export function isApiMethodAsync(apiMethod: ApiClassMethod): boolean;

package/dist/utils/apiHelpers.js

@@ -0,0 +1,80 @@
+import { getModuleContext as f } from "../extractor/privateContext.js";
+const g = (e) => e.kind === "method", v = (e) => e.kind === "field";
+function h(e, n) {
+  const o = e.sourcePath, i = n.sourcePath;
+  let t = 0;
+  for (; ; ) {
+    const c = o.indexOf("/", t), s = i.indexOf("/", t);
+    if (c === -1)
+      return s === -1 ? o.slice(t) < i.slice(t) ? -1 : 1 : -1;
+    if (s === -1)
+      return 1;
+    {
+      const r = o.slice(t, c), a = i.slice(t, s);
+      if (r !== a)
+        return r < a ? -1 : 1;
+      t = c + 1;
+    }
+  }
+}
+const p = "global:";
+function x(e, n, o) {
+  const i = f(o.apiModule).file, t = i.text.indexOf(n) ?? -1;
+  o.emitError(`${e}${t === -1 ? `. Found in: ${n}` : ""}`, {
+    file: i,
+    node: void 0,
+    scope: i === void 0 ? o.apiModule.sourcePath : void 0,
+    start: t,
+    length: n.length
+  });
+}
+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);
+  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 ??= [];
+    const c = /* @__PURE__ */ new Set();
+    for (let s = 0; s < t.docsTags.length; ++s)
+      c.add(t.docsTags[s].name);
+    for (let s = 0; s < i.length; ++s) {
+      const r = i[s];
+      c.has(r.name) && r.name !== "example" && r.name !== "see" || t.docsTags.push(r);
+    }
+  }
+}
+function y(e, n) {
+  let o = e.text;
+  if (e.references !== void 0)
+    for (let i = e.references.length - 1; i >= 0; i--) {
+      const t = e.references[i];
+      if (t.package === p || t.module === void 0 && t.package === void 0 && t.viewUrl === void 0)
+        continue;
+      const r = t.name === "default" ? "default" : t.name, u = `import("${t.package === void 0 ? `./${t.module ?? n}.js` : t.package + (t.module === void 0 ? "" : `/${t.module}`)}").${r}`;
+      o = o.slice(0, t.start) + u + o.slice(t.end);
+    }
+  return {
+    ...e,
+    text: o,
+    references: void 0
+  };
+}
+function A(e) {
+  return e.return.type.text.startsWith("Promise<");
+}
+export {
+  y as apiTypeToImportType,
+  M as compareClassMembers,
+  S as compareNamedNodes,
+  l as compareStrings,
+  x as emitJsDocError,
+  d as getApiMemberName,
+  T as getApiNodeLabel,
+  P as getMaybeStaticApiMemberName,
+  p as globalPackageIdentifier,
+  g as isApiMethod,
+  A as isApiMethodAsync,
+  v as isApiProperty,
+  k as mergeApiNodes,
+  h as naturalSortModules
+};

package/dist/utils/astHelpers.d.ts

@@ -1,15 +1,28 @@
-import { default as ts } from 'typescript';
-import { ApiPropertyLike } from '../apiJson';
+import type ts from "typescript";
+
 /**
- * Check if a member has a static, private, or protected modifier.
+ * Convert property name node into a string. Converts Identifier and
+ * StringLiteralLike nodes. Handles symbols like [Symbol.iterator]. For the
+ * rest, returns undefined.
+ *
+ * @param name
  */
-export declare const hasIgnoredModifier: (member: ts.ClassElement) => boolean;
-export declare function setDefaultFromInitializer(node: ts.AccessorDeclaration | ts.PropertyDeclaration, property: ApiPropertyLike, sourceFile: ts.SourceFile): void;
+export function getMemberName(name?: ts.PropertyName): string | undefined;
+
 /**
- * Convert property name node into a string. Converts Identifier and
- * StringLiteralLike nodes. The rest return undefined.
+ * @param specifier
+ * @example
+ * ```js
+ * getPackageNameFromExternalSpecifier("@esri/calcite-components/components/calcite-button")
+ * // "@esri/calcite-components"
+ * ```
+ */
+export function getPackageNameFromExternalSpecifier(specifier: string): string;
+
+/**
+ * Remove the extension from a file path. In most cases, removes only the last
+ * dot segment, but also removes `.d` in case of `.d.ts`
+ *
+ * @param path
  */
-export declare function getMemberName(name?: ts.PropertyName): string | undefined;
-export declare const findDecorator: ({ modifiers }: {
-    modifiers?: readonly ts.ModifierLike[];
-}, name: string) => ts.CallExpression | undefined;
+export function getBasename(path: string): string;

package/dist/utils/astHelpers.js

@@ -0,0 +1,67 @@
+import s from "typescript";
+import { mappedFind as o } from "@arcgis/toolkit/array";
+function a(e, n, t) {
+  if (!n && e !== void 0) {
+    const r = i(e);
+    if (x(r))
+      return r.getText(t);
+  }
+  return n;
+}
+const x = (e) => s.isLiteralExpression(e) || e.kind === s.SyntaxKind.TrueKeyword || e.kind === s.SyntaxKind.FalseKeyword || s.isPrefixUnaryExpression(e) && s.isLiteralExpression(e.operand);
+function i(e) {
+  return s.isSatisfiesExpression(e) || s.isParenthesizedExpression(e) || s.isAsExpression(e) || s.isTypeAssertionExpression(e) ? i(e.expression) : e;
+}
+function f(e) {
+  if (e !== void 0) {
+    if (s.isIdentifier(e))
+      return e.escapedText;
+    if (s.isStringLiteralLike(e))
+      return e.text;
+    if (s.isComputedPropertyName(e)) {
+      if (s.isStringLiteralLike(e.expression))
+        return e.expression.text;
+      if (s.isPropertyAccessExpression(e.expression) && s.isIdentifier(e.expression.expression) && e.expression.expression.text === "Symbol")
+        return `[Symbol.${e.expression.name.text}]`;
+    }
+  }
+}
+const p = (e, n) => e === void 0 ? void 0 : o(
+  e,
+  (t) => s.isDecorator(t) && s.isCallExpression(t.expression) && s.isIdentifier(t.expression.expression) && t.expression.expression.escapedText === n ? t.expression : void 0
+);
+function c(e) {
+  const n = e.indexOf("/");
+  if (n === -1)
+    return e;
+  if (e.startsWith("@")) {
+    const t = e.indexOf("/", n + 1);
+    return t === -1 ? e : e.slice(0, t);
+  } else
+    return e.slice(0, n);
+}
+function y(e, n) {
+  return e.kind === s.SyntaxKind.TrueKeyword ? !0 : (e.kind === s.SyntaxKind.FalseKeyword || n.emitError(
+    "Expected boolean literal (true or false) rather than variable/expression - the value must be statically analyzable",
+    {
+      file: n.file,
+      node: e
+    }
+  ), !1);
+}
+function E(e) {
+  const n = e.lastIndexOf(".");
+  if (n === -1 || e.length - n > l || e.includes("/", n))
+    return e;
+  const t = e.slice(n - 2, n) === ".d" ? n - 2 : n;
+  return e.slice(0, t);
+}
+const l = 4;
+export {
+  y as extractBooleanInitializer,
+  a as extractInitializer,
+  p as findDecorator,
+  E as getBasename,
+  f as getMemberName,
+  c as getPackageNameFromExternalSpecifier
+};

package/dist/utils/hydrateApiType.d.ts

@@ -0,0 +1,26 @@
+import type { ApiType, ApiTypeReference } from "../apiJson.js";
+
+/**
+ * Traverse through ApiType text string, turning type references into links.
+ *
+ * Also hydrates well-known JS "global" keywords (e.g. `string`, `number`), even
+ * if they don't appear in ApiType.references.
+ *
+ * @param apiType - The ApiType to hydrate
+ * @param hydratePart - A callback that converts a type reference into desired output
+ * @see [Type References](https://devtopia.esri.com/WebGIS/arcgis-web-components/blob/main/packages/support-packages/api-extractor/src/const/typeReferences/README.md)
+ * @example
+ * ```ts
+ * const markdownTypeString = hydrateApiType(
+ *   apiProperty.type,
+ *   (text, reference) => `[${text}](${reference.viewUrl})`
+ * ).join("");
+ * ```
+ */
+export function hydrateApiType<T>(apiType: Pick<ApiType, "references" | "text">, hydratePart: HydrateApiTypeCallback<T>): (T | string)[];
+
+/**
+ * @param referenceText - The text of the type reference
+ * @param reference - The metadata about the type reference
+ */
+export type HydrateApiTypeCallback<T> = (referenceText: string, reference: ApiTypeReference & { viewUrl: NonNullable<ApiTypeReference["viewUrl"]>; }) => T;