@instructure/ui-utils 11.7.8 → 11.7.9-pr-snapshot-1792147648392

package/lib/createChainedFunction.js

@@ -1,86 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createChainedFunction = createChainedFunction;
-exports.default = void 0;
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2015 - present Instructure, Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-/**
- * ---
- * category: utilities/react
- * ---
- * Safe chained functions
- *
- * Will only create a new function if needed,
- * otherwise will pass back existing functions or null.
- *
- * Forked from: https://github.com/react-bootstrap/react-overlays/blob/master/src/utils/createChainedFunction.js
- * @module createChainedFunction
- * @param funcs Functions to chain. It can be null/undefined
- * @returns the functions chained after each other
- */
-
-function createChainedFunction(...funcs) {
-  return funcs.filter((f, i) => {
-    if (f == null) {
-      return false;
-    }
-    // Only allow the first of identical functions
-    const indexes = getAllIndexes(funcs, f);
-    return indexes.length === 1 || i === indexes[0];
-  }).reduce((acc, f) => {
-    if (typeof f !== 'function') {
-      throw new Error('Invalid Argument Type, must only provide functions, undefined, or null.');
-    }
-    if (acc === null) {
-      return f;
-    }
-    return function chainedFunction(...args) {
-      acc.apply(this, args);
-      f.apply(this, args);
-    };
-    // TODO I think it can return null too
-  }, null);
-}
-
-/**
- * Find all indexes for a value in an Array
- *
- * @param {array} arr The Array to search for val
- * @param {*} val The value to find indexes for
- * @return {array} All the indexes of the Array matching val
- */
-function getAllIndexes(arr, val) {
-  const indexes = [];
-  arr.forEach((e, i) => {
-    if (e === val) {
-      indexes.push(i);
-    }
-  });
-  return indexes;
-}
-var _default = exports.default = createChainedFunction;

package/lib/deepEqual.js

@@ -1,38 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-Object.defineProperty(exports, "deepEqual", {
-  enumerable: true,
-  get: function () {
-    return _fastDeepEqual.default;
-  }
-});
-exports.default = void 0;
-var _fastDeepEqual = _interopRequireDefault(require("fast-deep-equal"));
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2015 - present Instructure, Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-var _default = exports.default = _fastDeepEqual.default;

package/lib/generateId.js

@@ -1,58 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.generateId = exports.default = void 0;
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2015 - present Instructure, Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-/**
- * Generates unique css safe ids for elements.
- *
- * @deprecated Use `useDeterministicId` (function components) or the
- * `withDeterministicId` decorator (class components) from
- * `@instructure/ui-react-utils` instead. Both are backed by React's `useId`, so
- * they produce the same id on the server and the client. This counter-based
- * helper depends on render order: the count advances once per render pass, so a
- * server render and the subsequent client render disagree, and the id changes on
- * every re-render. It is no longer used anywhere in InstUI and will be removed
- * in the next major version.
- *
- * @param instanceName - the name of the element/instance to keep track of
- * @param map - a Map<string, counter>, which counts how many times the given element/instance was rendered
- * @returns a string in a format `instanceName_intanceRenderedCount`: `Alert_4`
- */
-const generateId = (instanceName, map) => {
-  if (!map.has(instanceName)) {
-    map.set(instanceName, 0);
-  } else {
-    map.set(instanceName, map.get(instanceName) + 1);
-  }
-  // Do not rename '___' to '_' it will cause name clash with InstUI v10.14.0
-  // or older
-  return `${instanceName}___${map.get(instanceName)}`;
-};
-exports.generateId = generateId;
-var _default = exports.default = generateId;

package/lib/getBrowser.js

@@ -1,85 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.isSafari = exports.isMac = exports.isIE = exports.isFirefox = exports.isEdge = exports.isChromium = exports.isAndroidOrIOS = exports.getBrowser = void 0;
-var _uaParserJs = _interopRequireDefault(require("ua-parser-js"));
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2015 - present Instructure, Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-/**
- * ---
- * category: utilities/Misc
- * ---
- * A utility module using the 1.x [ua-parser-js](https://www.npmjs.com/package/ua-parser-js)
- * browser detection library.
- *
- * @module getBrowser
- */
-const getBrowser = () => {
-  const parser = new _uaParserJs.default();
-  const {
-    browser
-  } = parser.getResult();
-  return browser;
-};
-exports.getBrowser = getBrowser;
-const isSafari = () => {
-  return getBrowser().name === 'Safari';
-};
-exports.isSafari = isSafari;
-const isEdge = () => {
-  return getBrowser().name === 'Edge';
-};
-exports.isEdge = isEdge;
-const isIE = () => {
-  return getBrowser().name === 'IE';
-};
-exports.isIE = isIE;
-const isChromium = () => {
-  const chromiumBasedBrowsers = ['Chrome', 'Chromium', 'Opera', 'Edge'];
-  return chromiumBasedBrowsers.some(browser => {
-    return getBrowser().name?.includes(browser);
-  });
-};
-exports.isChromium = isChromium;
-const isFirefox = () => {
-  return getBrowser().name === 'Firefox';
-};
-exports.isFirefox = isFirefox;
-const isAndroidOrIOS = () => {
-  const parser = new _uaParserJs.default();
-  const result = parser.getResult();
-  const device = parser.getDevice();
-  return result.os.name === 'Android' || device.model === 'iPhone' || device.model === 'iPad' ? true : false;
-};
-exports.isAndroidOrIOS = isAndroidOrIOS;
-const isMac = () => {
-  const parser = new _uaParserJs.default();
-  const result = parser.getResult();
-  return result.os.name === 'Mac OS';
-};
-exports.isMac = isMac;

package/lib/hash.js

@@ -1,82 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-exports.hash = hash;
-var _jsonStableStringify = _interopRequireDefault(require("json-stable-stringify"));
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2015 - present Instructure, Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-function toBase64(input) {
-  const tab = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/';
-  let output = '';
-  const length = input.length;
-  let triplet;
-  const b64pad = '=';
-  for (let i = 0; i < length; i += 3) {
-    triplet = input.charCodeAt(i) << 16 | (i + 1 < length ? input.charCodeAt(i + 1) << 8 : 0) | (i + 2 < length ? input.charCodeAt(i + 2) : 0);
-    for (let j = 0; j < 4; j += 1) {
-      if (i * 8 + j * 6 > input.length * 8) {
-        output += b64pad;
-      } else {
-        output += tab.charAt(triplet >>> 6 * (3 - j) & 0x3f);
-      }
-    }
-  }
-  return output;
-}
-function executeHash(input) {
-  let hash = 0;
-  if (input.length === 0) return '0';
-  for (let i = 0; i < input.length; i++) {
-    const c = input.charCodeAt(i);
-    hash = (hash << 5) - hash + c;
-    hash |= 0; // Convert to 32bit integer
-  }
-  return toBase64(String(hash));
-}
-function hash(value, maxLength = 0) {
-  if (typeof value === 'undefined') {
-    throw new Error('Cannot hash a value which is undefined');
-  }
-  let hashedValue = '';
-  let valueToHash = value;
-  if (typeof value !== 'string') {
-    if (typeof value === 'object') {
-      // Ensure we are robust to things like objects that are identical, but with keys in diff orders
-      valueToHash = (0, _jsonStableStringify.default)(value);
-    } else {
-      valueToHash = value.toString();
-    }
-  }
-  hashedValue = executeHash(valueToHash);
-  if (maxLength) {
-    hashedValue = hashedValue.slice(0, maxLength);
-  }
-  return hashedValue;
-}
-var _default = exports.default = hash;

package/lib/index.js

@@ -1,187 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-Object.defineProperty(exports, "camelize", {
-  enumerable: true,
-  get: function () {
-    return _camelize.camelize;
-  }
-});
-Object.defineProperty(exports, "capitalizeFirstLetter", {
-  enumerable: true,
-  get: function () {
-    return _capitalizeFirstLetter.capitalizeFirstLetter;
-  }
-});
-Object.defineProperty(exports, "cloneArray", {
-  enumerable: true,
-  get: function () {
-    return _cloneArray.cloneArray;
-  }
-});
-Object.defineProperty(exports, "combineDataCid", {
-  enumerable: true,
-  get: function () {
-    return _combineDataCid.combineDataCid;
-  }
-});
-Object.defineProperty(exports, "createChainedFunction", {
-  enumerable: true,
-  get: function () {
-    return _createChainedFunction.createChainedFunction;
-  }
-});
-Object.defineProperty(exports, "deepEqual", {
-  enumerable: true,
-  get: function () {
-    return _deepEqual.deepEqual;
-  }
-});
-Object.defineProperty(exports, "generateId", {
-  enumerable: true,
-  get: function () {
-    return _generateId.generateId;
-  }
-});
-Object.defineProperty(exports, "getBrowser", {
-  enumerable: true,
-  get: function () {
-    return _getBrowser.getBrowser;
-  }
-});
-Object.defineProperty(exports, "hash", {
-  enumerable: true,
-  get: function () {
-    return _hash.hash;
-  }
-});
-Object.defineProperty(exports, "isAndroidOrIOS", {
-  enumerable: true,
-  get: function () {
-    return _getBrowser.isAndroidOrIOS;
-  }
-});
-Object.defineProperty(exports, "isBaseTheme", {
-  enumerable: true,
-  get: function () {
-    return _isBaseTheme.isBaseTheme;
-  }
-});
-Object.defineProperty(exports, "isChromium", {
-  enumerable: true,
-  get: function () {
-    return _getBrowser.isChromium;
-  }
-});
-Object.defineProperty(exports, "isEdge", {
-  enumerable: true,
-  get: function () {
-    return _getBrowser.isEdge;
-  }
-});
-Object.defineProperty(exports, "isEmpty", {
-  enumerable: true,
-  get: function () {
-    return _isEmpty.isEmpty;
-  }
-});
-Object.defineProperty(exports, "isFirefox", {
-  enumerable: true,
-  get: function () {
-    return _getBrowser.isFirefox;
-  }
-});
-Object.defineProperty(exports, "isIE", {
-  enumerable: true,
-  get: function () {
-    return _getBrowser.isIE;
-  }
-});
-Object.defineProperty(exports, "isMac", {
-  enumerable: true,
-  get: function () {
-    return _getBrowser.isMac;
-  }
-});
-Object.defineProperty(exports, "isSafari", {
-  enumerable: true,
-  get: function () {
-    return _getBrowser.isSafari;
-  }
-});
-Object.defineProperty(exports, "mergeDeep", {
-  enumerable: true,
-  get: function () {
-    return _mergeDeep.mergeDeep;
-  }
-});
-Object.defineProperty(exports, "ms", {
-  enumerable: true,
-  get: function () {
-    return _ms.ms;
-  }
-});
-Object.defineProperty(exports, "parseUnit", {
-  enumerable: true,
-  get: function () {
-    return _parseUnit.parseUnit;
-  }
-});
-Object.defineProperty(exports, "pascalize", {
-  enumerable: true,
-  get: function () {
-    return _pascalize.pascalize;
-  }
-});
-Object.defineProperty(exports, "px", {
-  enumerable: true,
-  get: function () {
-    return _px.px;
-  }
-});
-Object.defineProperty(exports, "safeHref", {
-  enumerable: true,
-  get: function () {
-    return _safeHref.safeHref;
-  }
-});
-Object.defineProperty(exports, "safeLinkProps", {
-  enumerable: true,
-  get: function () {
-    return _safeLinkProps.safeLinkProps;
-  }
-});
-Object.defineProperty(exports, "shallowEqual", {
-  enumerable: true,
-  get: function () {
-    return _shallowEqual.shallowEqual;
-  }
-});
-Object.defineProperty(exports, "within", {
-  enumerable: true,
-  get: function () {
-    return _within.within;
-  }
-});
-var _capitalizeFirstLetter = require("./capitalizeFirstLetter.js");
-var _cloneArray = require("./cloneArray.js");
-var _createChainedFunction = require("./createChainedFunction.js");
-var _deepEqual = require("./deepEqual.js");
-var _hash = require("./hash.js");
-var _generateId = require("./generateId.js");
-var _isEmpty = require("./isEmpty.js");
-var _mergeDeep = require("./mergeDeep.js");
-var _ms = require("./ms.js");
-var _parseUnit = require("./parseUnit.js");
-var _px = require("./px.js");
-var _safeHref = require("./safeHref.js");
-var _safeLinkProps = require("./safeLinkProps.js");
-var _shallowEqual = require("./shallowEqual.js");
-var _within = require("./within.js");
-var _camelize = require("./camelize.js");
-var _pascalize = require("./pascalize.js");
-var _isBaseTheme = require("./isBaseTheme.js");
-var _getBrowser = require("./getBrowser.js");
-var _combineDataCid = require("./combineDataCid.js");

package/lib/isBaseTheme.js

@@ -1,50 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.isBaseTheme = exports.default = void 0;
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2015 - present Instructure, Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-const baseThemeProps = ['borders', 'breakpoints', 'colors', 'forms', 'media', 'shadows', 'spacing', 'stacking', 'transitions', 'typography'];
-
-/**
- * Checks if the given param is an object with all the keys needed for an
- * Instructure theme.
- * @param theme Anything. This function will throw an error if it's not a theme
- * object.
- */
-const isBaseTheme = theme => {
-  if (Array.isArray(theme) || typeof theme === 'function') {
-    throw new Error();
-  }
-  try {
-    return 'key' in theme && baseThemeProps.every(prop => prop in theme);
-  } catch {
-    throw new Error();
-  }
-};
-exports.isBaseTheme = isBaseTheme;
-var _default = exports.default = isBaseTheme;

package/lib/isEmpty.js

@@ -1,39 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-exports.isEmpty = isEmpty;
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2015 - present Instructure, Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-const hasOwnProperty = Object.prototype.hasOwnProperty;
-function isEmpty(obj) {
-  if (typeof obj !== 'object') return true;
-  for (const key in obj) {
-    if (hasOwnProperty.call(obj, key)) return false;
-  }
-  return true;
-}
-var _default = exports.default = isEmpty;