@arcgis/toolkit 5.2.0-next.90 → 5.2.0-next.91

package/dist/array.d.ts

@@ -1,8 +1,11 @@
-import { nil } from './type.ts';
+import type { nil } from "./type.ts";
 /**
  * A combination of map and find.
  * Find a value in an array, and return its mapped variant.
  *
+ * @public
+ * @param array
+ * @param callback
  * @example
  * ```ts
  * // Given array of url strings, return the first valid URL object.

package/dist/dom/referenceElement.d.ts

@@ -1,10 +1,17 @@
-type ArcgisComponentBase<T> = {
+/** @public */
+interface ArcgisComponentBase<T> {
+    /** @public */
     el: HTMLElement;
+    /** @public */
     referenceElement?: T | string | null | undefined;
-};
+}
 /**
  * Resolves a reference element (arcgis-map, arcgis-scene, arcgis-link-chart)
  * from a component's `referenceElement` property or attribute.
+ *
+ * @public
+ * @param component
+ * @param referenceElementString
  */
 export declare function resolveReferenceElement<T extends Element>(component: ArcgisComponentBase<T>, referenceElementString?: ArcgisComponentBase<T>["referenceElement"] | string): T | undefined;
 export {};

package/dist/dom/slots.d.ts

@@ -1,6 +1,7 @@
 /**
  * Returns `true` if the target `slot` element from the `onSlotchange` event has any content (text or elements).
  *
+ * @public
  * @param event The event.
  * @returns Whether the slot has any content.
  *
@@ -13,6 +14,7 @@ export declare function slotChangeHasContent(event: Event): boolean;
 /**
  * Returns a string of textContent if the target `slot` element from the `onSlotchange` event has any text content.
  *
+ * @public
  * @param event The event.
  * @returns The slots text.
  *
@@ -25,6 +27,7 @@ export declare function slotChangeGetTextContent(event: Event): string;
 /**
  * Returns `true` if the target `slot` element from the `onSlotchange` event has any text content.
  *
+ * @public
  * @param event The event.
  * @returns Whether the slot has any text content.
  *
@@ -37,6 +40,7 @@ export declare function slotChangeHasTextContent(event: Event): boolean;
 /**
  * Returns `true` if the target `slot` element from the `onSlotchange` event has an assigned node.
  *
+ * @public
  * @param event The event.
  * @returns Whether the slot has any assigned nodes.
  *
@@ -49,6 +53,7 @@ export declare function slotChangeHasAssignedNode(event: Event): boolean;
 /**
  * Returns the assigned nodes on a `slot` element from the `onSlotchange` event.
  *
+ * @public
  * @param event The event.
  * @returns Whether the slot has any assigned nodes.
  *
@@ -61,6 +66,7 @@ export declare function slotChangeGetAssignedNodes(event: Event): Node[];
 /**
  * Returns `true` if the target `slot` element from the `onSlotchange` event has an assigned element.
  *
+ * @public
  * @param event The event.
  * @returns Whether the slot has any assigned elements.
  *
@@ -73,6 +79,7 @@ export declare function slotChangeHasAssignedElement(event: Event): boolean;
 /**
  * Returns the assigned elements on a `slot` element from the `onSlotchange` event.
  *
+ * @public
  * @param event The event.
  * @param selector The CSS selector string to filter the returned elements by.
  * @returns An array of elements.
@@ -86,6 +93,7 @@ export declare function slotChangeGetAssignedElements<T extends Element>(event:
 /**
  * Returns the assigned elements on a `slot` element, filtered by an optional css selector.
  *
+ * @public
  * @param slot The slot element.
  * @param selector CSS selector string to filter the returned elements by.
  * @returns An array of elements.

package/dist/dom.d.ts

@@ -1,30 +1,59 @@
-import { nil } from './type.ts';
-import { slotChangeHasContent as slotChangeHasContentAlias, slotChangeGetTextContent as slotChangeGetTextContentAlias, slotChangeHasTextContent as slotChangeHasTextContentAlias, slotChangeHasAssignedNode as slotChangeHasAssignedNodeAlias, slotChangeGetAssignedNodes as slotChangeGetAssignedNodesAlias, slotChangeHasAssignedElement as slotChangeHasAssignedElementAlias, slotChangeGetAssignedElements as slotChangeGetAssignedElementsAlias, getSlotAssignedElements as getSlotAssignedElementsAlias } from './dom/slots.ts';
-import { resolveReferenceElement as resolveReferenceElementAlias } from './dom/referenceElement.ts';
-/** @deprecated import { slotChangeHasContent } from "@arcgis/toolkit/dom/slots"; instead */
+import type { nil } from "./type.ts";
+import { slotChangeHasContent as slotChangeHasContentAlias, slotChangeGetTextContent as slotChangeGetTextContentAlias, slotChangeHasTextContent as slotChangeHasTextContentAlias, slotChangeHasAssignedNode as slotChangeHasAssignedNodeAlias, slotChangeGetAssignedNodes as slotChangeGetAssignedNodesAlias, slotChangeHasAssignedElement as slotChangeHasAssignedElementAlias, slotChangeGetAssignedElements as slotChangeGetAssignedElementsAlias, getSlotAssignedElements as getSlotAssignedElementsAlias } from "./dom/slots.ts";
+/**
+ * @public
+ * @deprecated import { slotChangeHasContent } from "@arcgis/toolkit/dom/slots"; instead
+ * */
 export declare const slotChangeHasContent: typeof slotChangeHasContentAlias;
-/** @deprecated import { slotChangeGetTextContent } from "@arcgis/toolkit/dom/slots"; instead */
+/**
+ * @public
+ * @deprecated import { slotChangeGetTextContent } from "@arcgis/toolkit/dom/slots"; instead
+ */
 export declare const slotChangeGetTextContent: typeof slotChangeGetTextContentAlias;
-/** @deprecated import { slotChangeHasTextContent } from "@arcgis/toolkit/dom/slots"; instead */
+/**
+ * @public
+ * @deprecated import { slotChangeHasTextContent } from "@arcgis/toolkit/dom/slots"; instead
+ */
 export declare const slotChangeHasTextContent: typeof slotChangeHasTextContentAlias;
-/** @deprecated import { slotChangeHasAssignedNode } from "@arcgis/toolkit/dom/slots"; instead */
+/**
+ * @public
+ * @deprecated import { slotChangeHasAssignedNode } from "@arcgis/toolkit/dom/slots"; instead
+ */
 export declare const slotChangeHasAssignedNode: typeof slotChangeHasAssignedNodeAlias;
-/** @deprecated import { slotChangeGetAssignedNodes } from "@arcgis/toolkit/dom/slots"; instead */
+/**
+ * @public
+ * @deprecated import { slotChangeGetAssignedNodes } from "@arcgis/toolkit/dom/slots"; instead
+ */
 export declare const slotChangeGetAssignedNodes: typeof slotChangeGetAssignedNodesAlias;
-/** @deprecated import { slotChangeHasAssignedElement } from "@arcgis/toolkit/dom/slots"; instead */
+/**
+ * @public
+ * @deprecated import { slotChangeHasAssignedElement } from "@arcgis/toolkit/dom/slots"; instead
+ */
 export declare const slotChangeHasAssignedElement: typeof slotChangeHasAssignedElementAlias;
-/** @deprecated import { slotChangeGetAssignedElements } from "@arcgis/toolkit/dom/slots"; instead */
+/**
+ * @public
+ * @deprecated import { slotChangeGetAssignedElements } from "@arcgis/toolkit/dom/slots"; instead
+ */
 export declare const slotChangeGetAssignedElements: typeof slotChangeGetAssignedElementsAlias;
-/** @deprecated import { getSlotAssignedElements } from "@arcgis/toolkit/dom/slots"; instead */
+/**
+ * @public
+ * @deprecated import { getSlotAssignedElements } from "@arcgis/toolkit/dom/slots"; instead
+ */
 export declare const getSlotAssignedElements: typeof getSlotAssignedElementsAlias;
-/** @deprecated import { resolveReferenceElement } from "@arcgis/toolkit/dom/reference-element"; instead */
+import { resolveReferenceElement as resolveReferenceElementAlias } from "./dom/referenceElement.ts";
+/**
+ * @public
+ * @deprecated import { resolveReferenceElement } from "@arcgis/toolkit/dom/reference-element"; instead
+ */
 export declare const resolveReferenceElement: typeof resolveReferenceElementAlias;
 /**
  * Combine multiple class names into a single string.
  *
- * @remarks
- * This function is less necessary in Lumina packages as the `class` JSX prop
- * accepts `Record<string, boolean>` objects.
+ * > This function is less necessary in Lumina packages as the `class` JSX prop
+ * > accepts `Record<string, boolean>` objects.
+ *
+ * @public
+ * @param classes
  */
 export declare const classes: (...classes: (nil | Record<string, boolean> | string[] | string | false)[]) => string;
 /**
@@ -32,6 +61,7 @@ export declare const classes: (...classes: (nil | Record<string, boolean> | stri
  * If the attributes have been changed in the ancestor tree then the callback
  * will be invoked.
  *
+ * @public
  * @param element The element on which to observe the attribute mutations.
  * @param attributeFilter The list of attributes to observe.
  * @param callback The callback to invoke when the attributes have been changed.
@@ -51,14 +81,15 @@ export declare const observeAncestorsMutation: (element: Node, attributeFilter:
  * Find the closest element that matches the selector.
  * It will traverse the element's ancestors to find the target element.
  * Shadow DOM boundaries are also taken into account.
+ *
+ * > This is similar to [Element.closest()](https://developer.mozilla.org/docs/Web/API/Element/closest),
+ * > but the DOM's utility only looks up until the first shadow boundary.
+ *
+ * @public
  * @param base The element to start the search from.
  * @param selector The selector to match.
  * @returns The closest element that matches the selector or null if not found.
  *
- * @remarks
- * This is similar to [Element.closest()](https://developer.mozilla.org/docs/Web/API/Element/closest),
- * but the DOM's utility only looks up until the first shadow boundary.
- *
  * @example
  * ```ts
  * const hostElement = getClosestElement(element, "arcgis-map, arcgis-scene");
@@ -71,32 +102,32 @@ export declare const getClosestElement: <T = Element>(base: Element, selector: s
  * ancestors to find the theme. Shadow DOM boundaries are also
  * taken into account.
  *
- * @param base The element to start the search from.
+ * > It is advised to consider alternative solutions before using this utility:
+ * > - Calcite CSS variables. Benefits: makes styles more consistent,
+ * >   and variables are updated automatically to match dark/light theme.
+ * > - Detect dark mode using CSS selectors and apply styles in CSS.
+ * >   Benefit: styles update automatically when the theme changes.
+ *
+ * @public
+ * @param el The element to start the search from.
  * @returns The theme of the element ("light" or "dark"). "light" is the default.
  *
- * @remarks
- * It is advised to consider alternative solutions before using this utility:
- * - Calcite CSS variables. Benefits: makes styles more consistent,
- *   and variables are updated automatically to match dark/light theme.
- * - Detect dark mode using CSS selectors and apply styles in CSS.
- *   Benefit: styles update automatically when the theme changes.
  */
 export declare function unsafeGetCalciteModeName(el: HTMLElement): "dark" | "light";
 /**
  * Get direction property of the closest element.
  *
- * @param el The element to start the search from.
- * @returns The direction of the element ("ltr" | "rtl"). "ltr" is the default.
+ * > Do not set the `dir` property on the element itself. Do not set the `dir`
+ * > attribute on the components you are rendering. The `dir` attribute is only
+ * > meant to be set by the consumers of your component. Your component is
+ * > expected to respect what was set by the consumer.
  *
- * @remarks
- * Do not set the `dir` property on the element itself. Do not set the `dir`
- * attribute on the components you are rendering. The `dir` attribute is only
- * meant to be set by the consumers of your component. Your component is
- * expected to respect what was set by the consumer.
+ * > Prefer [useDirection()](https://webgis.esri.com/references/lumina/controllers/useDirection)
+ * > to ensure your component is responsive to direction changes.
  *
- * @remarks
- * Prefer [useDirection()](https://webgis.esri.com/references/lumina/controllers/useDirection)
- * to ensure your component is responsive to direction changes.
+ * @public
+ * @param el The element to start the search from.
+ * @returns The direction of the element ("ltr" | "rtl"). "ltr" is the default.
  */
 export declare const unsafeGetElementDirection: (el: HTMLElement) => "ltr" | "rtl";
 /**
@@ -104,6 +135,10 @@ export declare const unsafeGetElementDirection: (el: HTMLElement) => "ltr" | "rt
  * Shadow DOM boundaries are also taken into account.
  * If the attribute is not found then the fallback value is returned.
  *
+ * @public
+ * @param el
+ * @param attributeName
+ * @param fallbackValue
  * @example
  * ```ts
  * const dir = getElementAttribute(element, "dir", "ltr");
@@ -112,10 +147,15 @@ export declare const unsafeGetElementDirection: (el: HTMLElement) => "ltr" | "rt
 export declare const getElementAttribute: (el: Element, attributeName: string, fallbackValue: string) => string;
 /**
  * Focus the element if it is focusable.
+ *
+ * @public
+ * @param el
  * @returns A promise that resolves once the focus is set.
  */
 export declare const focusElement: (el: FocusableElement | undefined) => Promise<void>;
+/** @public */
 export interface FocusableElement extends HTMLElement {
+    /** @public */
     setFocus?: () => Promise<void>;
 }
 /**
@@ -124,6 +164,8 @@ export interface FocusableElement extends HTMLElement {
  * Shadow DOM boundaries are also taken into account.
  * If the element is not found then the focus is not set.
  * Example: `setFocusOnElement(element, "[role='menuitem']");`
+ *
+ * @public
  * @param ref The element to start the search from.
  * @param selector The selector to match.
  * @returns Returns true if the focus is set on the element.

package/dist/error.d.ts

@@ -10,23 +10,34 @@
  * - `process.env.NODE_ENV === "development"`
  * - `process.env.NODE_ENV === "test"`
  *
+ * > This function is primary for usage in support packages. In Lumina component
+ * > packages, simpler alternatives are provided:
+ * > https://webgis.esri.com/references/lumina/publishing#bundling-code-conditionally
+ *
  * [Documentation](https://webgis.esri.com/references/lumina/publishing#internal-esri-environment)
  *
- * @remarks
- * This function is primary for usage in support packages. In Lumina component
- * packages, simpler alternatives are provided:
- * https://webgis.esri.com/references/lumina/publishing#bundling-code-conditionally
+ * @public
  */
 export declare const isEsriInternalEnv: () => boolean;
 /**
  * Calls a sync method and catch any errors. Returns undefined if error occurred.
  *
  * Can also provide a thisContext and rest arguments
+ *
+ * @public
+ * @param callback
+ * @param thisContext
+ * @param rest
  */
 export declare const safeCall: <Callback extends (...args: never[]) => unknown>(callback?: Callback, thisContext?: ThisParameterType<Callback>, ...rest: Parameters<Callback>) => ReturnType<Callback> | void;
 /**
  * Calls an async method and catch any errors. Returns undefined if error occurred.
  *
  * Can also provide a thisContext and rest arguments
+ *
+ * @public
+ * @param callback
+ * @param thisContext
+ * @param rest
  */
 export declare const safeAsyncCall: <Callback extends (...args: never[]) => unknown>(callback?: Callback, thisContext?: ThisParameterType<Callback>, ...rest: Parameters<Callback>) => Promise<Awaited<ReturnType<Callback>> | void>;

package/dist/function.d.ts

@@ -4,6 +4,8 @@
  * Useful when providing a "mapping function" is required, but you have no need
  * to change the value
  *
+ * @public
+ * @param value
  * @privateRemarks
  * This is a trivial function, but it helps workaround a TypeScript bug:
  * https://devtopia.esri.com/WebGIS/webgis-sdk/issues/2047
@@ -12,6 +14,7 @@ export declare const identity: <T>(value: T) => T;
 /**
  * Allows to debounce a function.
  *
+ * @public
  * @param func Function to be debounced
  * @param waitFor Debounce time in milliseconds
  * @returns Returns a function that can be called to debounce the original function

package/dist/intl/dom.d.ts

@@ -1,9 +1,11 @@
-import { GenericT9nStrings, SupportedLocale } from '../intl.ts';
+import { type GenericT9nStrings, type SupportedLocale } from "../intl.ts";
 /**
  * Get the locale of the given element.
  * It will look for the lang attribute on the element and its ancestors.
  * If not lang is found, it will default to 'en'.
  *
+ * @public
+ * @param element
  * @returns an object with the `lang` and `t9nLocale` properties.
  *
  * @see [lang vs t9nLocale](https://webgis.esri.com/references/lumina/controllers/useT9n#difference-between-lang-and-t9nlocale).
@@ -18,6 +20,11 @@ export declare const getElementLocale: (element: HTMLElement) => {
  * It will observe the lang attribute on the component and its ancestors.
  * The callback is called once at the beginning.
  *
+ * > Rather than using this function directly, prefer the
+ * > [useT9n()](https://webgis.esri.com/references/lumina/controllers/useT9n)
+ * > controller.
+ *
+ * @public
  * @param element The HTML element that is doing the fetching
  *   This is used to determine the locale to fetch, observe the `lang` attribute
  *   changes, and is used as the default value for the `assetName` parameter.
@@ -31,11 +38,6 @@ export declare const getElementLocale: (element: HTMLElement) => {
  *   Set to null if the component has no localization strings, but you still
  *   wish to use `startLocaleObserver` to get the locale information.
  *
- * @remarks
- * Rather than using this function directly, prefer the
- * [useT9n()](https://webgis.esri.com/references/lumina/controllers/useT9n)
- * controller.
- *
  * @example
  * ```ts
  * const observer = startLocaleObserver(
@@ -48,16 +50,25 @@ export declare const getElementLocale: (element: HTMLElement) => {
  * ```
  */
 export declare const startLocaleObserver: <Strings extends GenericT9nStrings = GenericT9nStrings>(element: HTMLElement, getAssetsPath: () => string, onUpdated: (payload: LocaleObserverResult<Strings>) => void, assetName?: string | null) => (() => void);
+/** @public */
 export interface LocaleObserverResult<Strings extends GenericT9nStrings = GenericT9nStrings> {
-    /** The T9N strings of the component */
+    /**
+     * The T9N strings of the component
+     *
+     * @public
+     */
     t9nStrings: Strings;
     /**
      * The locale of the component set by the `lang` attribute on the component host element or one of its ancestors.
+     *
+     * @public
      */
     lang: string;
     /**
      * The locale used by the component to load the T9N strings.
      * It may be different than the locale of the component host element that was set by the `lang` attribute.
+     *
+     * @public
      */
     t9nLocale: SupportedLocale;
 }

package/dist/intl.d.ts

@@ -1,24 +1,38 @@
-import { LocaleObserverResult as LocaleObserverResultAlias } from './intl/dom.ts';
-/** @deprecated import { getElementLocale } from "./intl/dom.ts" instead */
+import { type LocaleObserverResult as LocaleObserverResultAlias } from "./intl/dom.ts";
+/**
+ * @public
+ * @deprecated import { getElementLocale } from "./intl/dom.ts" instead
+ */
 export declare const getElementLocale: (element: HTMLElement) => {
     readonly lang: string;
     readonly t9nLocale: SupportedLocale;
 };
-/** @deprecated import { startLocaleObserver } from "./intl/dom.ts" instead */
+/**
+ * @public
+ * @deprecated import { startLocaleObserver } from "./intl/dom.ts" instead
+ */
 export declare const startLocaleObserver: <Strings extends GenericT9nStrings = GenericT9nStrings>(element: HTMLElement, getAssetsPath: () => string, onUpdated: (payload: LocaleObserverResultAlias<Strings>) => void, assetName?: string | null) => (() => void);
-/** @deprecated import type { LocaleObserverResult } from "./intl/dom.ts" instead */
+/**
+ * @public
+ * @deprecated import type { LocaleObserverResult } from "./intl/dom.ts" instead
+ */
 export type LocaleObserverResult = LocaleObserverResultAlias;
-declare const supportedLocalesArray: ["ar", "bg", "bs", "ca", "cs", "da", "de", "el", "en", "es", "et", "fi", "fr", "he", "hr", "hu", "id", "it", "ja", "ko", "lt", "lv", "nl", "nb", "no", "pl", "pt-BR", "pt-PT", "ro", "ru", "sk", "sl", "sr", "sv", "th", "tr", "uk", "vi", "zh-CN", "zh-HK", "zh-TW"];
 /**
  * The list of supported locales for ArcGIS Maps SDK for JavaScript components.
+ *
+ * @public
  */
-export declare const supportedLocales: Set<"hr" | "th" | "tr" | "el" | "ar" | "bg" | "bs" | "ca" | "cs" | "da" | "de" | "en" | "es" | "et" | "fi" | "fr" | "he" | "hu" | "id" | "it" | "ja" | "ko" | "lt" | "lv" | "nl" | "nb" | "no" | "pl" | "pt-BR" | "pt-PT" | "ro" | "ru" | "sk" | "sl" | "sr" | "sv" | "uk" | "vi" | "zh-CN" | "zh-HK" | "zh-TW">;
+export declare const supportedLocales: Set<SupportedLocale>;
 /**
  * TypeScript union type for each locale supported by WebGIS SDK
+ *
+ * @public
  */
-export type SupportedLocale = (typeof supportedLocalesArray)[number];
+export type SupportedLocale = "ar" | "bg" | "bs" | "ca" | "cs" | "da" | "de" | "el" | "en" | "es" | "et" | "fi" | "fr" | "he" | "hr" | "hu" | "id" | "it" | "ja" | "ko" | "lt" | "lv" | "nb" | "nl" | "no" | "pl" | "pt-BR" | "pt-PT" | "ro" | "ru" | "sk" | "sl" | "sr" | "sv" | "th" | "tr" | "uk" | "vi" | "zh-CN" | "zh-HK" | "zh-TW";
 /**
  * The default locale for WebGIS SDK.
+ *
+ * @public
  */
 export declare const defaultLocale = "en";
 /**
@@ -27,18 +41,17 @@ export declare const defaultLocale = "en";
  * If the locale is not supported, it will default to 'en'.
  * If the T9N strings bundle cannot be found, it will default to 'en'.
  *
+ * > Rather than using this function directly, prefer the
+ * > [useT9n()](https://webgis.esri.com/references/lumina/controllers/useT9n)
+ * > controller.
+ *
+ * > The function implements cache. Frequent calls are safe.
+ *
+ * @public
  * @param locale The locale for which to fetch the T9N strings
  * @param assetsPath The path to the assets folder where the T9N strings are located
  * @param prefix The prefix to use for the T9N strings file name.
  *
- * @remarks
- * Rather than using this function directly, prefer the
- * [useT9n()](https://webgis.esri.com/references/lumina/controllers/useT9n)
- * controller.
- *
- * @remarks
- * The function implements cache. Frequent calls are safe.
- *
  * @example
  * ```ts
  * // Will make a request for ./assets/coding-editor/t9n/messages.en.json
@@ -54,19 +67,23 @@ export declare const defaultLocale = "en";
 export declare const fetchT9nStringsBundle: <Strings extends GenericT9nStrings>(locale: string, assetsPath: string, prefix?: string) => Promise<Strings>;
 /**
  * The interface for translated strings.
+ *
+ * @public
  */
 export interface GenericT9nStrings {
+    /** @public */
     [key: string]: GenericT9nStrings | string;
 }
 /**
  * Try to parse any language string into one of the locales supported by WebGIS SDK.
  *
- * @remarks
- * Follows the ArcGIS Maps SDK for JavaScript locale support:
- * https://developers.arcgis.com/javascript/latest/localization/#locale-support
+ * > Follows the ArcGIS Maps SDK for JavaScript locale support:
+ * > https://developers.arcgis.com/javascript/latest/localization/#locale-support
+ *
+ * > If language includes a region code, but we don't have a bundle for it, the
+ * > language is normalized to the language code only.
  *
- * If language includes a region code, but we don't have a bundle for it, the
- * language is normalized to the language code only.
+ * @public
+ * @param lang
  */
 export declare const normalizeLocale: (lang: string) => SupportedLocale;
-export {};

package/dist/log.d.ts

@@ -1,4 +1,6 @@
+/** @public */
 export type LogLevel = "error" | "info" | "warn";
+/** @public */
 type CustomElementLike = {
     el: {
         localName: string;
@@ -6,17 +8,30 @@ type CustomElementLike = {
 } | {
     localName: string;
 };
+/** @public */
 type AccessorLike = {
     declaredClass: string;
 };
+/** @public */
 export type LogContext = AccessorLike | CustomElementLike | string;
+/** @public */
 type LogOptions = {
-    /** Whether the message should only be logged once. */
+    /**
+     * Whether the message should only be logged once.
+     *
+     * @public
+     */
     once?: boolean;
-    /** Additional objects to log after `message`. Use this to avoid memory leaks when logging objects to the console. Each object value will be automatically wrapped in a `WeakRef` before logging so it can be garbage-collected. */
+    /**
+     * Additional objects to log after `message`. Use this to avoid memory leaks when logging objects to the console. Each object value will be automatically wrapped in a `WeakRef` before logging so it can be garbage-collected.
+     *
+     * @public
+     */
     detail?: Record<string, unknown>;
 };
+/** @public */
 type EsriConfig = {
+    /** @public */
     log: {
         /**
          * @link {https://developers.arcgis.com/javascript/latest/references/core/config/#LogInterceptor}
@@ -25,9 +40,11 @@ type EsriConfig = {
     };
 };
 /**
- * Workaround for setting {@link https://developers.arcgis.com/javascript/latest/references/core/config/#log log interceptors} and maintaining compatibility with {@link https://devtopia.esri.com/WebGIS/arcgis-websceneviewer-app/blob/8f0a1bbcf12d1193134d94589d9e187f0afa72fa/src/js/support/ApiLoggerInstrumentation.ts#L17 js-api's interceptor usage}.
- * @see {@link https://devtopia.esri.com/WebGIS/arcgis-js-api/discussions/74935}
- * @param config {@link https://developers.arcgis.com/javascript/latest/references/core/config/}
+ * Workaround for setting [log interceptors](https://developers.arcgis.com/javascript/latest/references/core/config/#log) and maintaining compatibility with [js-api's interceptor usage](https://devtopia.esri.com/WebGIS/arcgis-websceneviewer-app/blob/8f0a1bbcf12d1193134d94589d9e187f0afa72fa/src/js/support/ApiLoggerInstrumentation.ts#L17).
+ * @see https://devtopia.esri.com/WebGIS/arcgis-js-api/discussions/74935
+ *
+ * @public
+ * @param config https://developers.arcgis.com/javascript/latest/references/core/config/
  * @example
  * ```ts
  * // IMPORTANT: do this only in config.ts or another early-loaded module
@@ -45,12 +62,13 @@ export declare const setEsriConfig: (config: EsriConfig) => void;
 /**
  * Helper utility for logging messages in a consistent manner.
  *
+ * @public
  * @param level The log level
  * @param context The context of the log message (e.g., `this` inside a Lit-like component, or just a custom string)
  * @param message A custom message to log
  * @param options Additional options for logging, such as to provide a context object
  *
- * @see [setEsriConfig](#setEsriConfig)
+ * @see {@link log!setEsriConfig}
  *
  * @example
  * ```ts
@@ -71,6 +89,7 @@ export declare const log: (level: LogLevel, context: LogContext, message: string
  * Rethrows an error and prepends context information to the error message. The error is
  * thrown asynchronously to avoid interrupting the current execution stack, so it cannot be caught
  * with `try/catch` and will bubble to the global object.
+ * @public
  * @param context From where the error is being thrown (e.g., `this` inside a Lit-like component, or just a custom string)
  * @returns A function that can be used in `try-catch`/`.catch` to rethrow an error
  *
@@ -89,10 +108,17 @@ export declare const log: (level: LogLevel, context: LogContext, message: string
  * ```
  */
 export declare const rethrowError: (context: LogContext) => ((error: unknown) => void);
+/** @public */
 type LogContextOrObject = Exclude<LogContext, string> | object;
+/**
+ * @public
+ * @privateRemarks
+ * https://www.typescriptlang.org/docs/handbook/2/conditional-types.html#distributive-conditional-types
+ */
 type InferPropertyType<T extends LogContextOrObject> = [object] extends [T] ? string : keyof T;
 /**
  * Returns a string that can be used in log messages for missing required properties.
+ * @public
  * @param property The name of the required property
  * @example
  * ```ts
@@ -105,6 +131,7 @@ type InferPropertyType<T extends LogContextOrObject> = [object] extends [T] ? st
 export declare const composeMissingPropertyMessage: <T extends LogContextOrObject = object>(property: InferPropertyType<T>) => string;
 /**
  * Returns a string that can be used in log messages for empty required arrays.
+ * @public
  * @param property The name of the required property
  * @example
  * ```ts
@@ -117,6 +144,11 @@ export declare const composeMissingPropertyMessage: <T extends LogContextOrObjec
 export declare const composeEmptyPropertyMessage: <T extends LogContextOrObject = object>(property: InferPropertyType<T>) => string;
 /**
  * Logs a warning message for deprecated object properties.
+ * @public
+ * @param context
+ * @param oldName
+ * @param newName
+ * @param options
  * @example
  * ```ts
  * logDeprecatedProperty(this, "oldName", "newName", {

package/dist/number.d.ts

@@ -1,16 +1,17 @@
 /**
  * Clamps a value between a minimum and maximum value.
  *
+ * @public
  * @param value The number to clamp.
  * @param min The minimum value.
  * @param max The maximum value.
- *
  * @returns The clamped value.
  */
 export declare function clamp(value: number, min: number, max: number): number;
 /**
  * Linearly interpolates between two numbers.
  *
+ * @public
  * @param min - The start value.
  * @param max - The end value.
  * @param t - The interpolation factor, typically between 0 and 1.

package/dist/predicate.d.ts

@@ -1,24 +1,27 @@
-import { nil } from './type.ts';
+import type { nil } from "./type.ts";
 /**
- * Safeguard to ensure that an item is not undefined.
- * @param item The item to check.
- * @returns Returns true if the item is not undefined.
+ * Safeguard to ensure that an value is not undefined.
+ * @public
+ * @param value The value to check.
+ * @returns Returns true if the value is not undefined.
  * @example
  * ```ts
  * const arr = [1, undefined, 3];
  * const result = arr.filter(isNotUndefined);
  * ```
  */
-export declare const isNotUndefined: <T>(item: T | undefined) => item is T;
+export declare const isNotUndefined: <T>(value: T | undefined) => value is T;
 /**
- * Safeguard to ensure that an item is not null.
- * @param item The item to check.
- * @returns Returns true if the item is not null.
+ * Safeguard to ensure that an value is not null.
+ * @public
+ * @param value The value to check.
+ * @returns Returns true if the value is not null.
  */
-export declare const isNotNull: <T>(item: T | null) => item is T;
+export declare const isNotNull: <T>(value: T | null) => value is T;
 /**
- * Safeguard to ensure that an item is not null.
- * @param item The item to check.
- * @returns Returns true if the item is not and not undefined and not null.
+ * Safeguard to ensure that an value is not null or undefined.
+ * @public
+ * @param value The value to check.
+ * @returns Returns true if the value is not undefined and not null.
  */
-export declare const isNotNil: <T>(x: nil | T) => x is T;
+export declare const isNotNil: <T>(value: nil | T) => value is T;

package/dist/predicate.js

@@ -1,6 +1,6 @@
-const isNotUndefined = (item) => item !== void 0;
-const isNotNull = (item) => item !== null;
-const isNotNil = (x) => x != null;
+const isNotUndefined = (value) => value !== void 0;
+const isNotNull = (value) => value !== null;
+const isNotNil = (value) => value != null;
 export {
   isNotNil,
   isNotNull,

package/dist/promise.d.ts

@@ -2,6 +2,7 @@
  * A deferred promise.
  * Useful for when you want to return a promise but don't have the value yet.
  *
+ * @public
  * @example
  * ```ts
  * const deferred = new Deferred<string>();
@@ -16,24 +17,31 @@
 export declare class Deferred<T> {
     /**
      * The promise that can be awaited.
+     * @public
      */
     promise: Promise<T>;
     /**
      * Creates a new deferred promise.
+     *
+     * @public
      */
     constructor();
 }
+/** @public */
 export interface Deferred<T> {
     /**
      * Resolves the promise.
+     * @public
      * @param value The value to resolve the promise with.
-     *
      * @privateRemarks
      * Defined as a method to disable covariance checks. Overridden in constructor.
      */
     resolve(_value: PromiseLike<T> | T): void;
     /**
      * Rejects the promise.
+     *
+     * @public
+     * @param error
      */
     reject(_error: unknown): void;
 }
@@ -42,6 +50,10 @@ export interface Deferred<T> {
  * operations.
  * Useful for rate-limiting or to avoid overwhelming resources with too many concurrent operations.
  *
+ * @public
+ * @param items
+ * @param concurrency
+ * @param callback
  * @example
  * ```ts
  * const items = [...lotsOfItems];
@@ -55,6 +67,9 @@ export declare function forEachWithConcurrency<T>(items: readonly T[], concurren
  * Like setTimeout(), but does not advance the clock if the program is
  * stopped on a debugger breakpoint.
  *
+ * @public
+ * @param callback
+ * @param timeout
  * @see https://devtopia.esri.com/WebGIS/arcgis-js-api/discussions/60405
  */
 export declare const devToolsAwareTimeout: (callback: () => void, timeout: number) => ReturnType<typeof setInterval>;

package/dist/promise.js

@@ -1,6 +1,8 @@
 class Deferred {
   /**
    * Creates a new deferred promise.
+   *
+   * @public
    */
   constructor() {
     this.promise = new Promise((resolve, reject) => {

package/dist/string.d.ts

@@ -1,6 +1,8 @@
 /**
  * Convert kebab-case string to PascalCase
  *
+ * @public
+ * @param string
  * @example
  * ```ts
  * const pascal = kebabToPascal("my-component-name");
@@ -10,6 +12,8 @@ export declare const kebabToPascal: (string: string) => string;
 /**
  * Convert camelCase string to kebab-case
  *
+ * @public
+ * @param string
  * @example
  * ```ts
  * const kebab = camelToKebab("myComponentName");
@@ -20,6 +24,8 @@ export declare const camelToKebab: (string: string) => string;
 /**
  * Convert camelCase string to Sentence case.
  *
+ * @public
+ * @param string
  * @example
  * ```ts
  * const human = camelToHuman("myComponentName");
@@ -27,26 +33,44 @@ export declare const camelToKebab: (string: string) => string;
  * ```
  */
 export declare const camelToHuman: (string: string) => string;
-/** Capitalize the first letter of a string. */
+/**
+ * Capitalize the first letter of a string.
+ *
+ * @public
+ * @param string
+ */
 export declare const capitalize: <T extends string>(string: T) => Capitalize<T>;
-/** Uncapitalize the first letter of a string. */
+/**
+ * Uncapitalize the first letter of a string.
+ *
+ * @public
+ * @param string
+ */
 export declare const uncapitalize: <T extends string>(string: T) => Uncapitalize<T>;
 /**
  * Add quotes to a string for display purposes.
  * If the string contains a double quote, then single quotes will be used.
  * If the string contains a single quote, then double quotes will be used.
  * If the string contains both, then double quotes will be used and the single quotes will be escaped.
+ *
+ * @public
+ * @param value
  */
 export declare const quoteString: (value: string) => string;
 /**
  * Create a filter expression from a filter word.
  *
- * @remarks Once browser support permits, use `RegExp.escape()` instead.
+ * > Once browser support permits, use `RegExp.escape()` instead.
+ *
+ * @public
+ * @param filterWord
  * @privateRemarks TODO: DEPRECATE
  */
 export declare const createFilterExpression: (filterWord: string) => RegExp;
 /**
  * Add LTR marks to a string to ensure it is displayed as LTR even in RTL contexts.
+ *
+ * @public
  * @param value The string to add LTR marks to.
  * @returns The string with LTR marks.
  *
@@ -58,6 +82,8 @@ export declare const createFilterExpression: (filterWord: string) => RegExp;
 export declare const addLtrMark: (value: string | undefined) => string;
 /**
  * A string containing a randomly generated, 36 character long v4 UUID.
+ *
+ * @public
  */
 export type UUID = ReturnType<typeof crypto.randomUUID>;
 /**
@@ -69,6 +95,7 @@ export type UUID = ReturnType<typeof crypto.randomUUID>;
  * Avoid using GUID and other non-deterministic output in render() as they
  * cause SSR hydration issues and snapshot test instability.
  *
+ * @public
  * @example
  * ```ts
  * const id = generateGuid();
@@ -79,6 +106,8 @@ export declare const generateGuid: () => UUID;
 /**
  * Extract the major and minor version from a full version string.
  *
+ * @public
+ * @param version
  * @example
  * ```ts
  * const minorVersion = getMinorVersion("4.34.0-next.123");
@@ -93,6 +122,8 @@ export declare const getMinorVersion: (version: string) => string;
  * The version number should normally come from package.json.
  *
  * @see https://webgis.esri.com/sdk/contributing/licensing
+ * @public
+ * @param version
  * @example
  * ```ts
  * const preamble = getPreamble("5.0.1-next.456");
@@ -104,6 +135,9 @@ export declare const getPreamble: (version: string) => string;
  * Replace values in a string using the format {valueName} with the value from the values object.
  * If the value is not found in the values object, then the value is not replaced.
  *
+ * @public
+ * @param message
+ * @param values
  * @deprecated Import from https://next.gha.afd.arcgis.com/javascript/latest/references/core/intl/#substitute instead
  */
 export declare const setValuesInString: (message: string | null | undefined, values?: Record<string, string>) => string;
@@ -113,6 +147,9 @@ export declare const setValuesInString: (message: string | null | undefined, val
  *
  * Throws when the named region cannot be found or is missing its closing marker.
  *
+ * @public
+ * @param source
+ * @param regionName
  * @example
  * ```ts
  * import code from "my-code-file.ts?raw";

package/dist/type.d.ts

@@ -1,15 +1,24 @@
 /**
  * A convenient alias for `null | undefined`.
- * @remarks Named `nil` over `Nil` as per https://devtopia.esri.com/WebGIS/arcgis-js-api/pull/66920
+ *
+ * > Named `nil` over `Nil` as per https://devtopia.esri.com/WebGIS/arcgis-js-api/pull/66920
+ *
+ * @public
  */
 export type nil = null | undefined;
 /**
+ * @public
  * @deprecated import type { ResourceHandle } from "@arcgis/core/core/Handles.js";
  */
 export type IHandle = {
+    /**
+     * @public
+     * @deprecated import type { ResourceHandle } from "@arcgis/core/core/Handles.js";
+     */
     remove: () => void;
 };
 /**
+ * @public
  * @deprecated Import type { nil } from `@arcgis/toolkit/type` instead
  */
 export type Nil = nil;
@@ -23,6 +32,7 @@ export type Nil = nil;
  * During production end-application build, such type tests will be removed as
  * they have no runtime impact.
  *
+ * @public
  * @privateRemarks
  * Using `0` over `undefined` to take fewer bytes if minifier is disabled.
  */

package/dist/url.d.ts

@@ -1,6 +1,7 @@
 /**
  * Compares two url strings for their origin and returns true if they have the same origin.
  *
+ * @public
  * @param url1 First url string
  * @param url2 Second url string
  * @param ignoreProtocol Indicates if protocol comparison should be ignored
@@ -9,10 +10,10 @@
 export declare const hasSameOrigin: (url1: string | null | undefined, url2: string | null | undefined, ignoreProtocol?: boolean) => boolean;
 /**
  * Tests if a url string is a URL or not.
+ *
+ * @public
+ * @deprecated Use https://developer.mozilla.org/docs/Web/API/URL/parse_static instead
  * @param url The url string to test
  * @returns True if the string is a URL.
- *
- * @remarks If browser support permits, use https://developer.mozilla.org/docs/Web/API/URL/parse_static instead
- * @privateRemarks TODO: DEPRECATE
  */
 export declare const isURL: (url: string) => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcgis/toolkit",
-  "version": "5.2.0-next.90",
+  "version": "5.2.0-next.91",
   "description": "Collection of common internal patterns and utilities for ArcGIS Maps SDK for JavaScript components.",
   "homepage": "https://developers.arcgis.com/javascript/latest/",
   "sideEffects": false,