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

package/es/index.js

@@ -1,26 +1,3 @@
-/*
- * 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.
- */
 export { capitalizeFirstLetter } from './capitalizeFirstLetter.js';
 export { cloneArray } from './cloneArray.js';
 export { createChainedFunction } from './createChainedFunction.js';
@@ -40,4 +17,4 @@ export { camelize } from './camelize.js';
 export { pascalize } from './pascalize.js';
 export { isBaseTheme } from './isBaseTheme.js';
 export { getBrowser, isSafari, isEdge, isIE, isFirefox, isChromium, isAndroidOrIOS, isMac } from './getBrowser.js';
-export { combineDataCid } from './combineDataCid.js';
+export { combineDataCid } from './combineDataCid.js';

package/es/isBaseTheme.js

@@ -1,44 +1,24 @@
-/*
- * 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();
-  }
+const baseThemeProps = [
+    'borders',
+    'breakpoints',
+    'colors',
+    'forms',
+    'media',
+    'shadows',
+    'spacing',
+    'stacking',
+    'transitions',
+    'typography'
+];
+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();
+    }
 };
 export default isBaseTheme;
-export { isBaseTheme };
+export { isBaseTheme };

package/es/isEmpty.js

@@ -1,33 +1,10 @@
-/*
- * 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;
+    if (typeof obj !== 'object') return true;
+    for(const key in obj){
+        if (hasOwnProperty.call(obj, key)) return false;
+    }
+    return true;
 }
 export default isEmpty;
-export { isEmpty };
+export { isEmpty };

package/es/mergeDeep.js

@@ -1,83 +1,57 @@
-/*
- * 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
- * ---
- * Deep merge N objects into a single result object.
- * Merging creates a new object, so that none of the arguments are modified.
- *
- * @module mergeDeep
- *
- * @param {Object} args objects to merge
- * @returns {Object} a new object with items from all arguments
- */
 function mergeDeep(...args) {
-  // note: This could be typed as the union of its args, but since
-  // its barely used its not worth the effort currently
-  let target = {};
-  args.forEach(arg => {
-    target = mergeSourceIntoTarget(target, arg);
-  });
-  return target;
+    let target = {};
+    args.forEach((arg)=>{
+        target = mergeSourceIntoTarget(target, arg);
+    });
+    return target;
 }
 function mergeSourceIntoTarget(target, source) {
-  if (isObject(source)) {
-    const keys = [...Object.keys(source), ...Object.getOwnPropertySymbols(source)];
-    const merged = {
-      ...target
-    };
-    keys.forEach(key => {
-      // Block prototype-pollution payloads. These keys can arrive via
-      // JSON.parse or other deserialization in consumer-supplied
-      // themeOverride props.
-      if (key === '__proto__' || key === 'prototype' || key === 'constructor') {
-        return;
-      }
-      if (isObject(target[key]) && isObject(source[key])) {
-        merged[key] = mergeSourceIntoTarget(target[key], source[key]);
-      } else if (isArray(source[key]) && isArray(target[key])) {
-        merged[key] = [...new Set([...target[key], ...source[key]])];
-      } else if (isArray(target[key])) {
-        merged[key] = [...new Set([...target[key], ...[source[key]]])];
-      } else {
-        merged[key] = source[key];
-      }
-    });
-    return merged;
-  } else {
-    return {
-      ...target
-    };
-  }
+    if (isObject(source)) {
+        const keys = [
+            ...Object.keys(source),
+            ...Object.getOwnPropertySymbols(source)
+        ];
+        const merged = {
+            ...target
+        };
+        keys.forEach((key)=>{
+            if (key === '__proto__' || key === 'prototype' || key === 'constructor') {
+                return;
+            }
+            if (isObject(target[key]) && isObject(source[key])) {
+                merged[key] = mergeSourceIntoTarget(target[key], source[key]);
+            } else if (isArray(source[key]) && isArray(target[key])) {
+                merged[key] = [
+                    ...new Set([
+                        ...target[key],
+                        ...source[key]
+                    ])
+                ];
+            } else if (isArray(target[key])) {
+                merged[key] = [
+                    ...new Set([
+                        ...target[key],
+                        ...[
+                            source[key]
+                        ]
+                    ])
+                ];
+            } else {
+                merged[key] = source[key];
+            }
+        });
+        return merged;
+    } else {
+        return {
+            ...target
+        };
+    }
 }
 function isObject(item) {
-  return item && (typeof item === 'object' || typeof item === 'function') && !Array.isArray(item);
+    return item && (typeof item === 'object' || typeof item === 'function') && !Array.isArray(item);
 }
 function isArray(item) {
-  return Array.isArray(item);
+    return Array.isArray(item);
 }
 export default mergeDeep;
-export { mergeDeep };
+export { mergeDeep };

package/es/ms.js

@@ -1,57 +1,16 @@
-/*
- * 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.
- */
-
 import { parseUnit } from './parseUnit.js';
-
-/**
- * ---
- * category: utilities/Misc
- * ---
- * Converts a unit value time combination (s, ms) to a number representing ms
- *
- * @module ms
- *
- * Example inputs:
- *  - '100s'
- *  - '20ms'
- *
- * @param {String|Number} val
- * @returns {Number} Returns numerical representation of milliseconds
- */
 function ms(val) {
-  // TODO: throw an error if val is not number or string
-  if (!val || typeof val === 'number') {
-    return val;
-  }
-  const [num, unit] = parseUnit(val);
-  if (unit === 'ms') {
-    return num;
-  } else if (unit === 's') {
-    return num * 1000;
-  } else {
-    return num;
-  }
+    if (!val || typeof val === 'number') {
+        return val;
+    }
+    const [num, unit] = parseUnit(val);
+    if (unit === 'ms') {
+        return num;
+    } else if (unit === 's') {
+        return num * 1000;
+    } else {
+        return num;
+    }
 }
 export default ms;
-export { ms };
+export { ms };

package/es/parseUnit.js

@@ -1,51 +1,10 @@
-/*
- * 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
- * ---
- * Converts a CSS unit value combination into an array of type [ value, unit ]
- *
- * @module parseUnit
- *
- * Example inputs:
- *  - '100px'
- *  - '20rem'
- *  - '10vh'
- *  - '400vmin'
- *
- * @param {string|number} str
- * @returns {Array} Returns array of shape [ value, unit ] Unit is '' if it could
- * not be parsed
- */
-
 function parseUnit(str) {
-  const value = `${str}`;
-  // eslint-disable-next-line no-useless-escape
-  const match = value.match(/[\d.\-\+]*\s*(.*)/);
-  return [parseFloat(value), match && match.length > 0 ? match[1] : ''];
+    const value = `${str}`;
+    const match = value.match(/[\d.\-\+]*\s*(.*)/);
+    return [
+        parseFloat(value),
+        match && match.length > 0 ? match[1] : ''
+    ];
 }
 export default parseUnit;
-export { parseUnit };
+export { parseUnit };

package/es/pascalize.js

@@ -1,49 +1,7 @@
-/*
- * 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.
- */
 import { capitalizeFirstLetter } from './capitalizeFirstLetter.js';
 import { camelize } from './camelize.js';
-
-/**
- * ---
- * category: utilities/Misc
- * ---
- * Converts a hyphenated or camel cased string to pascal case
- *
- * Example inputs:
- *  - 'foo-bar'
- *  - 'baz-qux'
- *
- * Example outputs:
- *  - 'FooBar'
- *  - 'BazQux'
- *
- * @module pascalize
- * @param {String} str
- * @returns {String} Returns pascal cased string
- */
 function pascalize(str) {
-  return capitalizeFirstLetter(camelize(str));
+    return capitalizeFirstLetter(camelize(str));
 }
 export default pascalize;
-export { pascalize };
+export { pascalize };

package/es/px.js

@@ -1,61 +1,19 @@
-/*
- * 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.
- */
-
 import { canUseDOM, getFontSize } from '@instructure/ui-dom-utils';
 import { parseUnit } from './parseUnit.js';
-/**
- * ---
- * category: utilities/Misc
- * ---
- * Converts a unit value size combination (em, rem, px) to a number representing px
- *
- * Example inputs:
- *  - '100rem'
- *  - '20em'
- *  - '40px'
- *
- * @module px
- *
- * @param {String|number} val The value to look up. If it's a number its just returned as is.
- * @param {Document|Window|Node|React.ReactElement |React.Component|null} el - containing element, for context measure is em (defaults to `document.body`)
- * @returns {Number} Returns numerical representation of pixels
- */
 function px(val, el) {
-  // TODO !val should not be needed
-  if (!val || typeof val === 'number') {
-    return val;
-  }
-  const [num, unit] = parseUnit(val);
-  if (unit === 'rem') {
-    return num * getFontSize();
-  } else if (unit === 'em') {
-    const doc = canUseDOM ? document.body : null;
-    const container = el || doc;
-    return num * getFontSize(container);
-  } else {
-    return num;
-  }
+    if (!val || typeof val === 'number') {
+        return val;
+    }
+    const [num, unit] = parseUnit(val);
+    if (unit === 'rem') {
+        return num * getFontSize();
+    } else if (unit === 'em') {
+        const doc = canUseDOM ? document.body : null;
+        const container = el || doc;
+        return num * getFontSize(container);
+    } else {
+        return num;
+    }
 }
 export default px;
-export { px };
+export { px };