@arcgis/toolkit 5.1.0-next.98 → 5.1.0

package/README.md

@@ -8,5 +8,5 @@ It is not intended to be used directly, but rather used as a dependency by other
 
 ## License
 
-This package is licensed under the terms described in the `LICENSE.md` file, located in the root of the package, and at https://js.arcgis.com/5.0/LICENSE.txt.
-For third party notices, see https://js.arcgis.com/5.0/third-party-notices.txt.
+This package is licensed under the terms described in the `LICENSE.md` file, located in the root of the package, and at https://js.arcgis.com/5.1/LICENSE.txt.
+For third party notices, see https://js.arcgis.com/5.1/third-party-notices.txt.

package/dist/dom/index.d.cts

@@ -38,7 +38,7 @@ export declare const observeAncestorsMutation: (element: Node, attributeFilter:
  * @returns The closest element that matches the selector or null if not found.
  *
  * @remarks
- * This is similar to [Element.closest()](https://developer.mozilla.org/en-US/docs/Web/API/Element/closest),
+ * 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

package/dist/dom/index.d.ts

@@ -38,7 +38,7 @@ export declare const observeAncestorsMutation: (element: Node, attributeFilter:
  * @returns The closest element that matches the selector or null if not found.
  *
  * @remarks
- * This is similar to [Element.closest()](https://developer.mozilla.org/en-US/docs/Web/API/Element/closest),
+ * 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

package/dist/promise/index.d.cts

@@ -11,7 +11,7 @@
  *
  * @deprecated
  * If browser support permits, prefer using
- * [Promise.withResolvers()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/withResolvers)
+ * [Promise.withResolvers()](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise/withResolvers)
  */
 export declare class Deferred<T> {
     /**

package/dist/promise/index.d.ts

@@ -11,7 +11,7 @@
  *
  * @deprecated
  * If browser support permits, prefer using
- * [Promise.withResolvers()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/withResolvers)
+ * [Promise.withResolvers()](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise/withResolvers)
  */
 export declare class Deferred<T> {
     /**

package/dist/string/index.cjs

@@ -75,11 +75,39 @@ const getPreamble = (version) => (
   `COPYRIGHT Esri - https://js.arcgis.com/${getMinorVersion(version)}/LICENSE.txt`
 );
 const setValuesInString = (message, values = {}) => (message ?? "").replace(/\{(?<valueName>.*?)\}/gu, (match, valueName) => values[valueName] ?? match);
+const regionStartPattern = /^\s*\/\/\s*#region(?::)?\s*(?<regionName>.*?)\s*$/u;
+const regionAnyStartPattern = /^\s*\/\/\s*#region(?::)?\s*.*$/u;
+const regionEndPattern = /^\s*\/\/\s*#endregion(?::)?(?:\s+.*)?\s*$/u;
+const extractRegion = (source, regionName) => {
+  const lines = source.split(/\r?\n/gu);
+  const startLineIndex = lines.findIndex((line) => regionStartPattern.exec(line)?.groups?.regionName === regionName);
+  if (startLineIndex === -1) {
+    throw new Error(`Unable to locate source region "${regionName}".`);
+  }
+  let nestedRegionDepth = 0;
+  for (let lineIndex = startLineIndex + 1; lineIndex < lines.length; lineIndex++) {
+    const line = lines[lineIndex];
+    if (regionAnyStartPattern.test(line)) {
+      nestedRegionDepth++;
+      continue;
+    }
+    if (!regionEndPattern.test(line)) {
+      continue;
+    }
+    if (nestedRegionDepth > 0) {
+      nestedRegionDepth--;
+      continue;
+    }
+    return lines.slice(startLineIndex + 1, lineIndex).join("\n").trim();
+  }
+  throw new Error(`Unable to locate source region end for "${regionName}".`);
+};
 exports.addLtrMark = addLtrMark;
 exports.camelToHuman = camelToHuman;
 exports.camelToKebab = camelToKebab;
 exports.capitalize = capitalize;
 exports.createFilterExpression = createFilterExpression;
+exports.extractRegion = extractRegion;
 exports.generateGuid = generateGuid;
 exports.getMinorVersion = getMinorVersion;
 exports.getPreamble = getPreamble;

package/dist/string/index.d.cts

@@ -107,3 +107,24 @@ export declare const getPreamble: (version: string) => string;
  * @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;
+/**
+ * Use `extractRegion` when you need to read a named `#region` block from a JavaScript/TypeScript source string,
+ * such as docs or MDX snippets that should stay in sync with the real implementation.
+ *
+ * Throws when the named region cannot be found or is missing its closing marker.
+ *
+ * @example
+ * ```ts
+ * import code from "my-code-file.ts?raw";
+ * const snippet = extractRegion(code, "myRegion");
+ *
+ * // where code is:
+ * `
+ * //#region myRegion
+ * const value = 1;
+ * //#endregion
+ * `
+ * // const value = 1;
+ * ```
+ */
+export declare const extractRegion: (source: string, regionName: string) => string;

package/dist/string/index.d.ts

@@ -107,3 +107,24 @@ export declare const getPreamble: (version: string) => string;
  * @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;
+/**
+ * Use `extractRegion` when you need to read a named `#region` block from a JavaScript/TypeScript source string,
+ * such as docs or MDX snippets that should stay in sync with the real implementation.
+ *
+ * Throws when the named region cannot be found or is missing its closing marker.
+ *
+ * @example
+ * ```ts
+ * import code from "my-code-file.ts?raw";
+ * const snippet = extractRegion(code, "myRegion");
+ *
+ * // where code is:
+ * `
+ * //#region myRegion
+ * const value = 1;
+ * //#endregion
+ * `
+ * // const value = 1;
+ * ```
+ */
+export declare const extractRegion: (source: string, regionName: string) => string;

package/dist/string/index.js

@@ -73,12 +73,40 @@ const getPreamble = (version) => (
   `COPYRIGHT Esri - https://js.arcgis.com/${getMinorVersion(version)}/LICENSE.txt`
 );
 const setValuesInString = (message, values = {}) => (message ?? "").replace(/\{(?<valueName>.*?)\}/gu, (match, valueName) => values[valueName] ?? match);
+const regionStartPattern = /^\s*\/\/\s*#region(?::)?\s*(?<regionName>.*?)\s*$/u;
+const regionAnyStartPattern = /^\s*\/\/\s*#region(?::)?\s*.*$/u;
+const regionEndPattern = /^\s*\/\/\s*#endregion(?::)?(?:\s+.*)?\s*$/u;
+const extractRegion = (source, regionName) => {
+  const lines = source.split(/\r?\n/gu);
+  const startLineIndex = lines.findIndex((line) => regionStartPattern.exec(line)?.groups?.regionName === regionName);
+  if (startLineIndex === -1) {
+    throw new Error(`Unable to locate source region "${regionName}".`);
+  }
+  let nestedRegionDepth = 0;
+  for (let lineIndex = startLineIndex + 1; lineIndex < lines.length; lineIndex++) {
+    const line = lines[lineIndex];
+    if (regionAnyStartPattern.test(line)) {
+      nestedRegionDepth++;
+      continue;
+    }
+    if (!regionEndPattern.test(line)) {
+      continue;
+    }
+    if (nestedRegionDepth > 0) {
+      nestedRegionDepth--;
+      continue;
+    }
+    return lines.slice(startLineIndex + 1, lineIndex).join("\n").trim();
+  }
+  throw new Error(`Unable to locate source region end for "${regionName}".`);
+};
 export {
   addLtrMark,
   camelToHuman,
   camelToKebab,
   capitalize,
   createFilterExpression,
+  extractRegion,
   generateGuid,
   getMinorVersion,
   getPreamble,

package/dist/url/index.d.cts

@@ -12,7 +12,7 @@ export declare const hasSameOrigin: (url1: string | null | undefined, url2: stri
  * @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/en-US/docs/Web/API/URL/parse_static instead
+ * @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/dist/url/index.d.ts

@@ -12,7 +12,7 @@ export declare const hasSameOrigin: (url1: string | null | undefined, url2: stri
  * @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/en-US/docs/Web/API/URL/parse_static instead
+ * @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.1.0-next.98",
+  "version": "5.1.0",
   "description": "Collection of common internal patterns and utilities for ArcGIS Maps SDK for JavaScript components.",
   "homepage": "https://developers.arcgis.com/javascript/latest/",
   "sideEffects": false,