@arcgis/toolkit 4.34.0-next.100

package/dist/string/index.cjs

@@ -0,0 +1,91 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const kebabToPascal = (string) => (
+  //#endregion kebabToPascal
+  string.split("-").map(capitalize).join("")
+);
+const camelToKebab = (string) => (
+  //#endregion camelToKebab
+  string.replace(upperBeforeLower, (upper, remainder) => `${remainder === 0 ? "" : "-"}${upper.toLowerCase()}`)
+);
+const upperBeforeLower = /[A-Z]+(?![a-z])|[A-Z]/gu;
+const camelToHuman = (string) => (
+  //#endregion camelToHuman
+  capitalize(string.replace(upperBeforeLower, (upper, remainder) => `${remainder === 0 ? "" : " "}${upper}`))
+);
+const capitalize = (string) => (
+  //#endregion capitalize
+  string.charAt(0).toUpperCase() + string.slice(1)
+);
+const uncapitalize = (string) => (
+  //#endregion uncapitalize
+  string.charAt(0).toLowerCase() + string.slice(1)
+);
+const doubleQuote = '"';
+const singleQuote = "'";
+const repeatString = (value, n) => new Array(n + 1).join(value);
+const quoteString = (value) => {
+  let quote = doubleQuote;
+  let alternateQuote = singleQuote;
+  const avoidEscape = value.includes(quote) && !value.includes(alternateQuote);
+  if (avoidEscape) {
+    alternateQuote = doubleQuote;
+    quote = singleQuote;
+  }
+  const alternateEscape = new RegExp(`(^|[^\\\\])((?:\\\\{2})*)((?:\\\\${alternateQuote})+)`, "gu");
+  value = value.replace(
+    alternateEscape,
+    (_, boundaryChar, leadingEscapedSlashes, escapedQuoteChars) => (
+      // We divide the escapedQuoteChars by 2 since there are 2 characters in each escaped part ('\\"'.length === 2)
+      boundaryChar + leadingEscapedSlashes + repeatString(alternateQuote, escapedQuoteChars.length / 2)
+    )
+  );
+  const quoteEscape = new RegExp(`(^|[^\\\\])((?:\\\\{2})*)(${quote}+)`, "gu");
+  value = value.replace(
+    quoteEscape,
+    (_, boundaryChar, leadingEscapedSlashes, quoteChars) => boundaryChar + leadingEscapedSlashes + repeatString(`\\${quote}`, quoteChars.length)
+  );
+  return quote + value + quote;
+};
+const createFilterExpression = (filterWord) => {
+  const sanitizedWord = filterWord ? filterWord.replaceAll(/[-[\]/{}()*+?.\\^$|]/gu, "\\$&") : "^.*$";
+  return new RegExp(sanitizedWord, "i");
+};
+const addLtrMark = (value) => (
+  // Make sure the string value is LTR. This prevent issues with RTL language used in LTR containers.
+  `‎${value ?? ""}‎`
+);
+const hasRandomUUID = "randomUUID" in crypto;
+const generateGuid = () => {
+  if (hasRandomUUID) {
+    return crypto.randomUUID();
+  }
+  const values = crypto.getRandomValues(new Uint16Array(8));
+  values[3] = values[3] & 4095 | 16384;
+  values[4] = values[4] & 16383 | 32768;
+  const p = (i) => values[i].toString(16).padStart(4, "0");
+  return `${p(0) + p(1)}-${p(2)}-${p(3)}-${p(4)}-${p(5)}${p(6)}${p(7)}`;
+};
+const getMinorVersion = (version) => {
+  const [major, minor] = version.split(".");
+  return `${major}.${minor}`;
+};
+const getPreamble = (version) => (
+  //#endregion getPreamble
+  `All material copyright Esri, All Rights Reserved, unless otherwise specified.
+See https://js.arcgis.com/${getMinorVersion(version)}/esri/copyright.txt for details.
+v${version}`
+);
+const setValuesInString = (message, values = {}) => (message ?? "").replace(/\{(?<valueName>.*?)\}/gu, (match, valueName) => values[valueName] ?? match);
+exports.addLtrMark = addLtrMark;
+exports.camelToHuman = camelToHuman;
+exports.camelToKebab = camelToKebab;
+exports.capitalize = capitalize;
+exports.createFilterExpression = createFilterExpression;
+exports.generateGuid = generateGuid;
+exports.getMinorVersion = getMinorVersion;
+exports.getPreamble = getPreamble;
+exports.kebabToPascal = kebabToPascal;
+exports.quoteString = quoteString;
+exports.setValuesInString = setValuesInString;
+exports.uncapitalize = uncapitalize;

package/dist/string/index.d.cts

@@ -0,0 +1,106 @@
+/**
+ * Convert kebab-case string to PascalCase
+ *
+ * @example
+ * ```ts
+ * const pascal = kebabToPascal("my-component-name");
+ * // MyComponentName
+ */
+export declare const kebabToPascal: (string: string) => string;
+/**
+ * Convert camelCase string to kebab-case
+ *
+ * @example
+ * ```ts
+ * const kebab = camelToKebab("myComponentName");
+ * // my-component-name
+ * ```
+ */
+export declare const camelToKebab: (string: string) => string;
+/**
+ * Convert camelCase string to Sentence case.
+ *
+ * @example
+ * ```ts
+ * const human = camelToHuman("myComponentName");
+ * // My component name
+ * ```
+ */
+export declare const camelToHuman: (string: string) => string;
+/** Capitalize the first letter of a string. */
+export declare const capitalize: <T extends string>(string: T) => Capitalize<T>;
+/** Uncapitalize the first letter of a 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.
+ */
+export declare const quoteString: (value: string) => string;
+/**
+ * Create a filter expression from a filter word.
+ *
+ * @remarks Once browser support permits, use `RegExp.escape()` instead.
+ * @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.
+ * @param value The string to add LTR marks to.
+ * @returns The string with LTR marks.
+ *
+ * @example
+ * ```ts
+ * // Without addLtrMark, this will render as arcadeVariable$ in RTL languages.
+ * return <div>{addLtrMark("$arcadeVariable")}</div>;
+ */
+export declare const addLtrMark: (value: string | undefined) => string;
+/**
+ * A string containing a randomly generated, 36 character long v4 UUID.
+ */
+export type UUID = ReturnType<typeof crypto.randomUUID>;
+/**
+ * Generate a GUID string.
+ * @example
+ * ```ts
+ * const id = generateGuid();
+ * // 00000000-0000-0000-0000-000000000000.
+ * ```
+ *
+ * @remarks
+ * If your component is using shadow root, the DOM element IDs do not need
+ * to be globally unique.
+ */
+export declare const generateGuid: () => UUID;
+/**
+ * Extract the major and minor version from a full version string.
+ *
+ * @example
+ * ```ts
+ * const minorVersion = getMinorVersion("4.34.0-next.123");
+ * // "4.34"
+ * ```
+ */
+export declare const getMinorVersion: (version: string) => string;
+/**
+ * Create a preamble text from a version number. Preamble text is used as legal
+ * notice at the top of a file.
+ * The preamble text contains the version number and a link to the license.
+ * The version number should normally come from package.json.
+ * @example
+ * ```ts
+ * const preamble = getPreamble("4.34.0-next.123");
+ * // All material copyright Esri, All Rights Reserved, unless otherwise specified.
+ * // See https://js.arcgis.com/4.34/esri/copyright.txt for details.
+ * // v4.34.0-next.123
+ * ```
+ */
+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.
+ *
+ * @deprecated Import from https://next.gha.afd.arcgis.com/javascript/latest/api-reference/esri-intl.html#substitute instead
+ */
+export declare const setValuesInString: (message: string | null | undefined, values?: Record<string, string>) => string;

package/dist/string/index.d.ts

@@ -0,0 +1,106 @@
+/**
+ * Convert kebab-case string to PascalCase
+ *
+ * @example
+ * ```ts
+ * const pascal = kebabToPascal("my-component-name");
+ * // MyComponentName
+ */
+export declare const kebabToPascal: (string: string) => string;
+/**
+ * Convert camelCase string to kebab-case
+ *
+ * @example
+ * ```ts
+ * const kebab = camelToKebab("myComponentName");
+ * // my-component-name
+ * ```
+ */
+export declare const camelToKebab: (string: string) => string;
+/**
+ * Convert camelCase string to Sentence case.
+ *
+ * @example
+ * ```ts
+ * const human = camelToHuman("myComponentName");
+ * // My component name
+ * ```
+ */
+export declare const camelToHuman: (string: string) => string;
+/** Capitalize the first letter of a string. */
+export declare const capitalize: <T extends string>(string: T) => Capitalize<T>;
+/** Uncapitalize the first letter of a 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.
+ */
+export declare const quoteString: (value: string) => string;
+/**
+ * Create a filter expression from a filter word.
+ *
+ * @remarks Once browser support permits, use `RegExp.escape()` instead.
+ * @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.
+ * @param value The string to add LTR marks to.
+ * @returns The string with LTR marks.
+ *
+ * @example
+ * ```ts
+ * // Without addLtrMark, this will render as arcadeVariable$ in RTL languages.
+ * return <div>{addLtrMark("$arcadeVariable")}</div>;
+ */
+export declare const addLtrMark: (value: string | undefined) => string;
+/**
+ * A string containing a randomly generated, 36 character long v4 UUID.
+ */
+export type UUID = ReturnType<typeof crypto.randomUUID>;
+/**
+ * Generate a GUID string.
+ * @example
+ * ```ts
+ * const id = generateGuid();
+ * // 00000000-0000-0000-0000-000000000000.
+ * ```
+ *
+ * @remarks
+ * If your component is using shadow root, the DOM element IDs do not need
+ * to be globally unique.
+ */
+export declare const generateGuid: () => UUID;
+/**
+ * Extract the major and minor version from a full version string.
+ *
+ * @example
+ * ```ts
+ * const minorVersion = getMinorVersion("4.34.0-next.123");
+ * // "4.34"
+ * ```
+ */
+export declare const getMinorVersion: (version: string) => string;
+/**
+ * Create a preamble text from a version number. Preamble text is used as legal
+ * notice at the top of a file.
+ * The preamble text contains the version number and a link to the license.
+ * The version number should normally come from package.json.
+ * @example
+ * ```ts
+ * const preamble = getPreamble("4.34.0-next.123");
+ * // All material copyright Esri, All Rights Reserved, unless otherwise specified.
+ * // See https://js.arcgis.com/4.34/esri/copyright.txt for details.
+ * // v4.34.0-next.123
+ * ```
+ */
+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.
+ *
+ * @deprecated Import from https://next.gha.afd.arcgis.com/javascript/latest/api-reference/esri-intl.html#substitute instead
+ */
+export declare const setValuesInString: (message: string | null | undefined, values?: Record<string, string>) => string;

package/dist/string/index.js

@@ -0,0 +1,91 @@
+const kebabToPascal = (string) => (
+  //#endregion kebabToPascal
+  string.split("-").map(capitalize).join("")
+);
+const camelToKebab = (string) => (
+  //#endregion camelToKebab
+  string.replace(upperBeforeLower, (upper, remainder) => `${remainder === 0 ? "" : "-"}${upper.toLowerCase()}`)
+);
+const upperBeforeLower = /[A-Z]+(?![a-z])|[A-Z]/gu;
+const camelToHuman = (string) => (
+  //#endregion camelToHuman
+  capitalize(string.replace(upperBeforeLower, (upper, remainder) => `${remainder === 0 ? "" : " "}${upper}`))
+);
+const capitalize = (string) => (
+  //#endregion capitalize
+  string.charAt(0).toUpperCase() + string.slice(1)
+);
+const uncapitalize = (string) => (
+  //#endregion uncapitalize
+  string.charAt(0).toLowerCase() + string.slice(1)
+);
+const doubleQuote = '"';
+const singleQuote = "'";
+const repeatString = (value, n) => new Array(n + 1).join(value);
+const quoteString = (value) => {
+  let quote = doubleQuote;
+  let alternateQuote = singleQuote;
+  const avoidEscape = value.includes(quote) && !value.includes(alternateQuote);
+  if (avoidEscape) {
+    alternateQuote = doubleQuote;
+    quote = singleQuote;
+  }
+  const alternateEscape = new RegExp(`(^|[^\\\\])((?:\\\\{2})*)((?:\\\\${alternateQuote})+)`, "gu");
+  value = value.replace(
+    alternateEscape,
+    (_, boundaryChar, leadingEscapedSlashes, escapedQuoteChars) => (
+      // We divide the escapedQuoteChars by 2 since there are 2 characters in each escaped part ('\\"'.length === 2)
+      boundaryChar + leadingEscapedSlashes + repeatString(alternateQuote, escapedQuoteChars.length / 2)
+    )
+  );
+  const quoteEscape = new RegExp(`(^|[^\\\\])((?:\\\\{2})*)(${quote}+)`, "gu");
+  value = value.replace(
+    quoteEscape,
+    (_, boundaryChar, leadingEscapedSlashes, quoteChars) => boundaryChar + leadingEscapedSlashes + repeatString(`\\${quote}`, quoteChars.length)
+  );
+  return quote + value + quote;
+};
+const createFilterExpression = (filterWord) => {
+  const sanitizedWord = filterWord ? filterWord.replaceAll(/[-[\]/{}()*+?.\\^$|]/gu, "\\$&") : "^.*$";
+  return new RegExp(sanitizedWord, "i");
+};
+const addLtrMark = (value) => (
+  // Make sure the string value is LTR. This prevent issues with RTL language used in LTR containers.
+  `‎${value ?? ""}‎`
+);
+const hasRandomUUID = "randomUUID" in crypto;
+const generateGuid = () => {
+  if (hasRandomUUID) {
+    return crypto.randomUUID();
+  }
+  const values = crypto.getRandomValues(new Uint16Array(8));
+  values[3] = values[3] & 4095 | 16384;
+  values[4] = values[4] & 16383 | 32768;
+  const p = (i) => values[i].toString(16).padStart(4, "0");
+  return `${p(0) + p(1)}-${p(2)}-${p(3)}-${p(4)}-${p(5)}${p(6)}${p(7)}`;
+};
+const getMinorVersion = (version) => {
+  const [major, minor] = version.split(".");
+  return `${major}.${minor}`;
+};
+const getPreamble = (version) => (
+  //#endregion getPreamble
+  `All material copyright Esri, All Rights Reserved, unless otherwise specified.
+See https://js.arcgis.com/${getMinorVersion(version)}/esri/copyright.txt for details.
+v${version}`
+);
+const setValuesInString = (message, values = {}) => (message ?? "").replace(/\{(?<valueName>.*?)\}/gu, (match, valueName) => values[valueName] ?? match);
+export {
+  addLtrMark,
+  camelToHuman,
+  camelToKebab,
+  capitalize,
+  createFilterExpression,
+  generateGuid,
+  getMinorVersion,
+  getPreamble,
+  kebabToPascal,
+  quoteString,
+  setValuesInString,
+  uncapitalize
+};

package/dist/tests/utils.d.cts

@@ -0,0 +1 @@
+export declare function captureConsoleErrors(): unknown[][];

package/dist/tests/utils.d.ts

@@ -0,0 +1 @@
+export declare function captureConsoleErrors(): unknown[][];

package/dist/type/index.d.cts

@@ -0,0 +1,15 @@
+/**
+ * A convenient alias for `null | undefined`.
+ * @remarks Named `nil` over `Nil` as per https://devtopia.esri.com/WebGIS/arcgis-js-api/pull/66920
+ */
+export type nil = null | undefined;
+/**
+ * @deprecated Import from `__esri.IHandle` instead
+ */
+export type IHandle = {
+    remove: () => void;
+};
+/**
+ * @deprecated Import type { nil } from `@arcgis/toolkit/type` instead
+ */
+export type Nil = nil;

package/dist/type/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * A convenient alias for `null | undefined`.
+ * @remarks Named `nil` over `Nil` as per https://devtopia.esri.com/WebGIS/arcgis-js-api/pull/66920
+ */
+export type nil = null | undefined;
+/**
+ * @deprecated Import from `__esri.IHandle` instead
+ */
+export type IHandle = {
+    remove: () => void;
+};
+/**
+ * @deprecated Import type { nil } from `@arcgis/toolkit/type` instead
+ */
+export type Nil = nil;

package/dist/url/index.cjs

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const hasSameOrigin = (url1, url2, ignoreProtocol = false) => {
+  if (!url1 || !url2) {
+    return false;
+  }
+  const url1Obj = new URL(url1);
+  const url2Obj = new URL(url2);
+  if (!ignoreProtocol && url1Obj.protocol !== url2Obj.protocol) {
+    return false;
+  }
+  if (url1Obj.host == null || url2Obj.host == null) {
+    return false;
+  }
+  return url1Obj.host.toLowerCase() === url2Obj.host.toLowerCase() && url1Obj.port === url2Obj.port;
+};
+const isURL = (url) => {
+  try {
+    new URL(url);
+    return true;
+  } catch (e) {
+    return false;
+  }
+};
+exports.hasSameOrigin = hasSameOrigin;
+exports.isURL = isURL;

package/dist/url/index.d.cts

@@ -0,0 +1,18 @@
+/**
+ * Compares two url strings for their origin and returns true if they have the same origin.
+ *
+ * @param url1 First url string
+ * @param url2 Second url string
+ * @param ignoreProtocol Indicates if protocol comparison should be ignored
+ * @returns True if the two url strings have the same origin
+ */
+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.
+ * @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
+ * @todo DEPRECATE
+ */
+export declare const isURL: (url: string) => boolean;

package/dist/url/index.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Compares two url strings for their origin and returns true if they have the same origin.
+ *
+ * @param url1 First url string
+ * @param url2 Second url string
+ * @param ignoreProtocol Indicates if protocol comparison should be ignored
+ * @returns True if the two url strings have the same origin
+ */
+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.
+ * @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
+ * @todo DEPRECATE
+ */
+export declare const isURL: (url: string) => boolean;

package/dist/url/index.js

@@ -0,0 +1,26 @@
+const hasSameOrigin = (url1, url2, ignoreProtocol = false) => {
+  if (!url1 || !url2) {
+    return false;
+  }
+  const url1Obj = new URL(url1);
+  const url2Obj = new URL(url2);
+  if (!ignoreProtocol && url1Obj.protocol !== url2Obj.protocol) {
+    return false;
+  }
+  if (url1Obj.host == null || url2Obj.host == null) {
+    return false;
+  }
+  return url1Obj.host.toLowerCase() === url2Obj.host.toLowerCase() && url1Obj.port === url2Obj.port;
+};
+const isURL = (url) => {
+  try {
+    new URL(url);
+    return true;
+  } catch (e) {
+    return false;
+  }
+};
+export {
+  hasSameOrigin,
+  isURL
+};

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@arcgis/toolkit",
+  "version": "4.34.0-next.100",
+  "description": "Collection of common internal patterns and utilities for ArcGIS Maps SDK for JavaScript components.",
+  "homepage": "https://developers.arcgis.com/javascript/latest/",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    "./array": {
+      "types": "./dist/array/index.d.ts",
+      "import": "./dist/array/index.js",
+      "require": "./dist/array/index.cjs"
+    },
+    "./dom": {
+      "types": "./dist/dom/index.d.ts",
+      "import": "./dist/dom/index.js",
+      "require": "./dist/dom/index.cjs"
+    },
+    "./error": {
+      "types": "./dist/error/index.d.ts",
+      "import": "./dist/error/index.js",
+      "require": "./dist/error/index.cjs"
+    },
+    "./function": {
+      "types": "./dist/function/index.d.ts",
+      "import": "./dist/function/index.js",
+      "require": "./dist/function/index.cjs"
+    },
+    "./intl": {
+      "types": "./dist/intl/index.d.ts",
+      "import": "./dist/intl/index.js",
+      "require": "./dist/intl/index.cjs"
+    },
+    "./predicate": {
+      "types": "./dist/predicate/index.d.ts",
+      "import": "./dist/predicate/index.js",
+      "require": "./dist/predicate/index.cjs"
+    },
+    "./promise": {
+      "types": "./dist/promise/index.d.ts",
+      "import": "./dist/promise/index.js",
+      "require": "./dist/promise/index.cjs"
+    },
+    "./string": {
+      "types": "./dist/string/index.d.ts",
+      "import": "./dist/string/index.js",
+      "require": "./dist/string/index.cjs"
+    },
+    "./type": {
+      "types": "./dist/type/index.d.ts"
+    },
+    "./url": {
+      "types": "./dist/url/index.d.ts",
+      "import": "./dist/url/index.js",
+      "require": "./dist/url/index.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist/"
+  ],
+  "license": "SEE LICENSE IN LICENSE.md",
+  "dependencies": {
+    "tslib": "^2.8.1"
+  }
+}