@arcgis/toolkit 5.1.0-next.60 → 5.1.0-next.62

package/dist/dom/index.cjs

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const log_index = require("../log/index.cjs");
 function slotChangeHasContent(event) {
   return slotChangeHasAssignedElement(event) || slotChangeHasTextContent(event);
 }
@@ -29,6 +30,33 @@ function getSlotAssignedElements(slot, selector) {
   });
   return selector ? assignedElements.filter((element) => element.matches(selector)) : assignedElements;
 }
+const allowedTags = ["arcgis-map", "arcgis-scene", "arcgis-link-chart"];
+function resolveReferenceElement(component, referenceElementString) {
+  const referenceElement = referenceElementString ?? component.referenceElement;
+  if (typeof referenceElement !== "string") {
+    return referenceElement ?? void 0;
+  }
+  const isComplexSelector = referenceElement.includes("#") || referenceElement.includes(".") || referenceElement.includes("[");
+  const rootNode = component.el.getRootNode();
+  const resolved = (isComplexSelector ? void 0 : rootNode.querySelector(`#${referenceElement}`)) ?? rootNode.querySelector(referenceElement) ?? (isComplexSelector ? void 0 : getClosestElement(component.el, `#${referenceElement}`)) ?? getClosestElement(component.el, referenceElement);
+  if (resolved == null) {
+    log_index.log(
+      "error",
+      component,
+      `Expected property \`referenceElement\` to resolve to an <arcgis-map>, <arcgis-scene>, or <arcgis-link-chart> element, but no element matched \`${referenceElement}\`.`
+    );
+    return void 0;
+  }
+  if (!allowedTags.includes(resolved.localName)) {
+    log_index.log(
+      "error",
+      component,
+      `Expected property \`referenceElement\` to point to an <arcgis-map>, <arcgis-scene>, or <arcgis-link-chart> element, but instead found <${resolved?.localName}>.`,
+      { detail: { referenceElement, resolved } }
+    );
+  }
+  return resolved ?? void 0;
+}
 const classes = (...classes2) => {
   const effectiveClasses = [];
   for (let i = 0; i < classes2.length; ++i) {
@@ -186,6 +214,7 @@ exports.getClosestElement = getClosestElement;
 exports.getElementAttribute = getElementAttribute;
 exports.getSlotAssignedElements = getSlotAssignedElements;
 exports.observeAncestorsMutation = observeAncestorsMutation;
+exports.resolveReferenceElement = resolveReferenceElement;
 exports.setFocusOnElement = setFocusOnElement;
 exports.slotChangeGetAssignedElements = slotChangeGetAssignedElements;
 exports.slotChangeGetAssignedNodes = slotChangeGetAssignedNodes;

package/dist/dom/index.d.cts

@@ -1,5 +1,6 @@
 import { nil } from '../type/index.ts';
 export * from './slots.ts';
+export * from './reference-element.ts';
 /**
  * Combine multiple class names into a single string.
  *

package/dist/dom/index.d.ts

@@ -1,5 +1,6 @@
 import { nil } from '../type/index.ts';
 export * from './slots.ts';
+export * from './reference-element.ts';
 /**
  * Combine multiple class names into a single string.
  *

package/dist/dom/index.js

@@ -1,3 +1,4 @@
+import { log } from "../log/index.js";
 function slotChangeHasContent(event) {
   return slotChangeHasAssignedElement(event) || slotChangeHasTextContent(event);
 }
@@ -27,6 +28,33 @@ function getSlotAssignedElements(slot, selector) {
   });
   return selector ? assignedElements.filter((element) => element.matches(selector)) : assignedElements;
 }
+const allowedTags = ["arcgis-map", "arcgis-scene", "arcgis-link-chart"];
+function resolveReferenceElement(component, referenceElementString) {
+  const referenceElement = referenceElementString ?? component.referenceElement;
+  if (typeof referenceElement !== "string") {
+    return referenceElement ?? void 0;
+  }
+  const isComplexSelector = referenceElement.includes("#") || referenceElement.includes(".") || referenceElement.includes("[");
+  const rootNode = component.el.getRootNode();
+  const resolved = (isComplexSelector ? void 0 : rootNode.querySelector(`#${referenceElement}`)) ?? rootNode.querySelector(referenceElement) ?? (isComplexSelector ? void 0 : getClosestElement(component.el, `#${referenceElement}`)) ?? getClosestElement(component.el, referenceElement);
+  if (resolved == null) {
+    log(
+      "error",
+      component,
+      `Expected property \`referenceElement\` to resolve to an <arcgis-map>, <arcgis-scene>, or <arcgis-link-chart> element, but no element matched \`${referenceElement}\`.`
+    );
+    return void 0;
+  }
+  if (!allowedTags.includes(resolved.localName)) {
+    log(
+      "error",
+      component,
+      `Expected property \`referenceElement\` to point to an <arcgis-map>, <arcgis-scene>, or <arcgis-link-chart> element, but instead found <${resolved?.localName}>.`,
+      { detail: { referenceElement, resolved } }
+    );
+  }
+  return resolved ?? void 0;
+}
 const classes = (...classes2) => {
   const effectiveClasses = [];
   for (let i = 0; i < classes2.length; ++i) {
@@ -185,6 +213,7 @@ export {
   getElementAttribute,
   getSlotAssignedElements,
   observeAncestorsMutation,
+  resolveReferenceElement,
   setFocusOnElement,
   slotChangeGetAssignedElements,
   slotChangeGetAssignedNodes,

package/dist/dom/reference-element.d.cts

@@ -0,0 +1,6 @@
+type ArcgisComponentBase<T> = {
+    el: HTMLElement;
+    referenceElement?: T | string | null | undefined;
+};
+export declare function resolveReferenceElement<T extends Element>(component: ArcgisComponentBase<T>, referenceElementString?: ArcgisComponentBase<T>["referenceElement"] | string): T | undefined;
+export {};

package/dist/dom/reference-element.d.ts

@@ -0,0 +1,6 @@
+type ArcgisComponentBase<T> = {
+    el: HTMLElement;
+    referenceElement?: T | string | null | undefined;
+};
+export declare function resolveReferenceElement<T extends Element>(component: ArcgisComponentBase<T>, referenceElementString?: ArcgisComponentBase<T>["referenceElement"] | string): T | undefined;
+export {};

package/dist/intl/index.cjs

@@ -12,6 +12,8 @@ const supportedLocales = (
 const defaultLocale = "en";
 const localeEquivalencies = {
   //#region localeEquivalencies
+  // Locale equivalencies aligned with ArcGIS Maps SDK for JavaScript:
+  // https://developers.arcgis.com/javascript/latest/localization/#locale-support
   // We resolve to `pt-BR` as it will have the same translations as `pt`, which has no corresponding bundle
   pt: "pt-BR",
   // We support both 'nb' and 'no' (BCP 47) for Norwegian but only `no` has corresponding bundle

package/dist/intl/index.d.cts

@@ -2,7 +2,7 @@ declare const supportedLocalesArray: ["ar", "bg", "bs", "ca", "cs", "da", "de",
 /**
  * The list of supported locales for ArcGIS Maps SDK for JavaScript components.
  */
-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<"el" | "hr" | "th" | "tr" | "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">;
 /**
  * TypeScript union type for each locale supported by WebGIS SDK
  */
@@ -65,6 +65,9 @@ export declare const getElementLocale: (element: HTMLElement) => {
  * 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
+ *
  * If language includes a region code, but we don't have a bundle for it, the
  * language is normalized to the language code only.
  */

package/dist/intl/index.d.ts

@@ -2,7 +2,7 @@ declare const supportedLocalesArray: ["ar", "bg", "bs", "ca", "cs", "da", "de",
 /**
  * The list of supported locales for ArcGIS Maps SDK for JavaScript components.
  */
-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<"el" | "hr" | "th" | "tr" | "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">;
 /**
  * TypeScript union type for each locale supported by WebGIS SDK
  */
@@ -65,6 +65,9 @@ export declare const getElementLocale: (element: HTMLElement) => {
  * 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
+ *
  * If language includes a region code, but we don't have a bundle for it, the
  * language is normalized to the language code only.
  */

package/dist/intl/index.js

@@ -10,6 +10,8 @@ const supportedLocales = (
 const defaultLocale = "en";
 const localeEquivalencies = {
   //#region localeEquivalencies
+  // Locale equivalencies aligned with ArcGIS Maps SDK for JavaScript:
+  // https://developers.arcgis.com/javascript/latest/localization/#locale-support
   // We resolve to `pt-BR` as it will have the same translations as `pt`, which has no corresponding bundle
   pt: "pt-BR",
   // We support both 'nb' and 'no' (BCP 47) for Norwegian but only `no` has corresponding bundle

package/dist/string/index.d.cts

@@ -92,7 +92,7 @@ export declare const getMinorVersion: (version: string) => string;
  * The preamble text contains the version number and a link to the license.
  * The version number should normally come from package.json.
  *
- * @see https://webgis.esri.com/webgis/platform-guidelines/licensing
+ * @see https://webgis.esri.com/webgis/contributing/licensing
  * @example
  * ```ts
  * const preamble = getPreamble("5.0.1-next.456");

package/dist/string/index.d.ts

@@ -92,7 +92,7 @@ export declare const getMinorVersion: (version: string) => string;
  * The preamble text contains the version number and a link to the license.
  * The version number should normally come from package.json.
  *
- * @see https://webgis.esri.com/webgis/platform-guidelines/licensing
+ * @see https://webgis.esri.com/webgis/contributing/licensing
  * @example
  * ```ts
  * const preamble = getPreamble("5.0.1-next.456");

package/package.json

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