@instructure/ui-dom-utils 8.11.2-snapshot.70 → 8.12.1-snapshot.15

package/CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [8.12.0](https://github.com/instructure/instructure-ui/compare/v8.11.1...v8.12.0) (2021-11-17)
+
+**Note:** Version bump only for package @instructure/ui-dom-utils
+
 ## [8.11.1](https://github.com/instructure/instructure-ui/compare/v8.11.0...v8.11.1) (2021-10-19)
 
 **Note:** Version bump only for package @instructure/ui-dom-utils

package/es/index.js

@@ -39,7 +39,6 @@ export { getBoundingClientRect } from './getBoundingClientRect';
 export { getClassList } from './getClassList';
 export { getComputedStyle } from './getComputedStyle';
 export { getFontSize } from './getFontSize';
-export { getFrameDocumentSafe } from './getFrameDocumentSafe';
 export { getOffsetParents } from './getOffsetParents';
 export { getScrollParents } from './getScrollParents';
 export { handleMouseOverOut } from './handleMouseOverOut';

package/lib/index.js

@@ -99,12 +99,6 @@ Object.defineProperty(exports, "getFontSize", {
     return _getFontSize.getFontSize;
   }
 });
-Object.defineProperty(exports, "getFrameDocumentSafe", {
-  enumerable: true,
-  get: function () {
-    return _getFrameDocumentSafe.getFrameDocumentSafe;
-  }
-});
 Object.defineProperty(exports, "getOffsetParents", {
   enumerable: true,
   get: function () {
@@ -198,8 +192,6 @@ var _getComputedStyle = require("./getComputedStyle");
 
 var _getFontSize = require("./getFontSize");
 
-var _getFrameDocumentSafe = require("./getFrameDocumentSafe");
-
 var _getOffsetParents = require("./getOffsetParents");
 
 var _getScrollParents = require("./getScrollParents");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/ui-dom-utils",
-  "version": "8.11.2-snapshot.70+9653a896e",
+  "version": "8.12.1-snapshot.15+c50fd66e4",
   "description": "A DOM utility library made by Instructure Inc.",
   "author": "Instructure, Inc. Engineering and Product Design",
   "type": "commonjs",
@@ -23,13 +23,13 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "@instructure/ui-babel-preset": "8.11.2-snapshot.70+9653a896e",
-    "@instructure/ui-test-utils": "8.11.2-snapshot.70+9653a896e"
+    "@instructure/ui-babel-preset": "8.12.1-snapshot.15+c50fd66e4",
+    "@instructure/ui-test-utils": "8.12.1-snapshot.15+c50fd66e4"
   },
   "dependencies": {
     "@babel/runtime": "^7.13.10",
-    "@instructure/console": "8.11.2-snapshot.70+9653a896e",
-    "@instructure/shared-types": "8.11.2-snapshot.70+9653a896e"
+    "@instructure/console": "8.12.1-snapshot.15+c50fd66e4",
+    "@instructure/shared-types": "8.12.1-snapshot.15+c50fd66e4"
   },
   "peerDependencies": {
     "react": ">=16.8 <=17",
@@ -39,5 +39,5 @@
     "access": "public"
   },
   "sideEffects": false,
-  "gitHead": "9653a896e80ba4d73335225e80807746a232d96d"
+  "gitHead": "c50fd66e4ba9e5d4b814659f8ee4e1cc2f929cc2"
 }

package/src/addEventListener.ts

@@ -38,7 +38,7 @@ import { findDOMNode } from './findDOMNode'
  */
 function addEventListener(
   el: Node | Window,
-  event: string,
+  event: keyof WindowEventMap,
   handler: EventListenerOrEventListenerObject,
   capture?: boolean
 ) {

package/src/contains.ts

@@ -24,7 +24,6 @@
 
 import { findDOMNode } from './findDOMNode'
 import { canUseDOM } from './canUseDOM'
-import React from 'react'
 import { UIElement } from '@instructure/shared-types'
 
 /**
@@ -41,7 +40,6 @@ import { UIElement } from '@instructure/shared-types'
 function containsWithDOM(context: UIElement, el: UIElement) {
   const container = context && findDOMNode(context)
   const node = el && findDOMNode(el)
-
   if (!container || !node) {
     return false
   } else if (!(container instanceof Window) && !(node instanceof Window)) {
@@ -52,15 +50,7 @@ function containsWithDOM(context: UIElement, el: UIElement) {
 }
 
 /* istanbul ignore next  */
-function containsFallback(
-  context:
-    | Node
-    | Window
-    | React.ReactElement
-    | ((...args: any[]) => any)
-    | null,
-  el: Node | Window | React.ReactElement | ((...args: any[]) => any) | null
-) {
+function containsFallback(context: UIElement, el: UIElement) {
   let node = el
 
   while (node) {
@@ -69,7 +59,6 @@ function containsFallback(
     }
     node = (node as Node).parentNode
   }
-
   return false
 }
 

package/src/index.ts

@@ -41,7 +41,6 @@ export type { RectType } from './getBoundingClientRect'
 export { getClassList } from './getClassList'
 export { getComputedStyle } from './getComputedStyle'
 export { getFontSize } from './getFontSize'
-export { getFrameDocumentSafe } from './getFrameDocumentSafe'
 export { getOffsetParents } from './getOffsetParents'
 export { getScrollParents } from './getScrollParents'
 export { handleMouseOverOut } from './handleMouseOverOut'

package/types/addEventListener.d.ts

@@ -10,7 +10,7 @@
  * @param { boolean } capture - should the event be executed in the capturing or bubbling phase
  * @returns {{ remove(): void }} a method to remove the event listener
  */
-declare function addEventListener(el: Node | Window, event: string, handler: EventListenerOrEventListenerObject, capture?: boolean): {
+declare function addEventListener(el: Node | Window, event: keyof WindowEventMap, handler: EventListenerOrEventListenerObject, capture?: boolean): {
     remove(): void;
 };
 export default addEventListener;

package/types/addEventListener.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"addEventListener.d.ts","sourceRoot":"","sources":["../src/addEventListener.ts"],"names":[],"mappings":"AA0BA;;;;;;;;;;;GAWG;AACH,iBAAS,gBAAgB,CACvB,EAAE,EAAE,IAAI,GAAG,MAAM,EACjB,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,kCAAkC,EAC3C,OAAO,CAAC,EAAE,OAAO;;EAUlB;AAED,eAAe,gBAAgB,CAAA;AAC/B,OAAO,EAAE,gBAAgB,EAAE,CAAA"}
+{"version":3,"file":"addEventListener.d.ts","sourceRoot":"","sources":["../src/addEventListener.ts"],"names":[],"mappings":"AA0BA;;;;;;;;;;;GAWG;AACH,iBAAS,gBAAgB,CACvB,EAAE,EAAE,IAAI,GAAG,MAAM,EACjB,KAAK,EAAE,MAAM,cAAc,EAC3B,OAAO,EAAE,kCAAkC,EAC3C,OAAO,CAAC,EAAE,OAAO;;EAUlB;AAED,eAAe,gBAAgB,CAAA;AAC/B,OAAO,EAAE,gBAAgB,EAAE,CAAA"}

package/types/contains.d.ts

@@ -1,19 +1,6 @@
-import React from 'react';
 import { UIElement } from '@instructure/shared-types';
-/**
- * ---
- * category: utilities/DOM
- * ---
- *
- * Determine if an element contains another DOM node
- * @module containsWithDOM
- * @param { Node | Window | React.ReactElement | function | null } context - component or DOM node
- * @param { Node | Window | React.ReactElement | function | null } el - component or DOM node which we want to determine if contained within the context
- * @returns { boolean } if the element is contained within the context
- */
-declare function containsWithDOM(context: UIElement, el: UIElement): boolean;
-declare function containsFallback(context: Node | Window | React.ReactElement | ((...args: any[]) => any) | null, el: Node | Window | React.ReactElement | ((...args: any[]) => any) | null): boolean;
-declare const contains: typeof containsFallback | typeof containsWithDOM;
+declare function containsFallback(context: UIElement, el: UIElement): boolean;
+declare const contains: typeof containsFallback;
 export default contains;
 export { contains };
 //# sourceMappingURL=contains.d.ts.map

package/types/contains.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"contains.d.ts","sourceRoot":"","sources":["../src/contains.ts"],"names":[],"mappings":"AA0BA,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAA;AAErD;;;;;;;;;;GAUG;AACH,iBAAS,eAAe,CAAC,OAAO,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,WAWzD;AAGD,iBAAS,gBAAgB,CACvB,OAAO,EACH,IAAI,GACJ,MAAM,GACN,KAAK,CAAC,YAAY,GAClB,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,GACzB,IAAI,EACR,EAAE,EAAE,IAAI,GAAG,MAAM,GAAG,KAAK,CAAC,YAAY,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,GAAG,IAAI,WAY1E;AAED,QAAA,MAAM,QAAQ,kDAAiD,CAAA;AAC/D,eAAe,QAAQ,CAAA;AACvB,OAAO,EAAE,QAAQ,EAAE,CAAA"}
+{"version":3,"file":"contains.d.ts","sourceRoot":"","sources":["../src/contains.ts"],"names":[],"mappings":"AA0BA,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAA;AA0BrD,iBAAS,gBAAgB,CAAC,OAAO,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,WAU1D;AAED,QAAA,MAAM,QAAQ,yBAAiD,CAAA;AAC/D,eAAe,QAAQ,CAAA;AACvB,OAAO,EAAE,QAAQ,EAAE,CAAA"}

package/types/index.d.ts

@@ -16,7 +16,6 @@ export type { RectType } from './getBoundingClientRect';
 export { getClassList } from './getClassList';
 export { getComputedStyle } from './getComputedStyle';
 export { getFontSize } from './getFontSize';
-export { getFrameDocumentSafe } from './getFrameDocumentSafe';
 export { getOffsetParents } from './getOffsetParents';
 export { getScrollParents } from './getScrollParents';
 export { handleMouseOverOut } from './handleMouseOverOut';

package/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAyBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAC7D,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAA;AACvE,YAAY,EAAE,0BAA0B,EAAE,MAAM,6BAA6B,CAAA;AAC7E,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AACrC,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAC/D,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAC/D,YAAY,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAA;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAC/D,YAAY,EAAE,yBAAyB,EAAE,MAAM,yBAAyB,CAAA;AACxE,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAyBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAC7D,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAA;AACvE,YAAY,EAAE,0BAA0B,EAAE,MAAM,6BAA6B,CAAA;AAC7E,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AACrC,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAC/D,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAC/D,YAAY,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAA;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAC/D,YAAY,EAAE,yBAAyB,EAAE,MAAM,yBAAyB,CAAA;AACxE,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA"}

package/es/getFrameDocumentSafe.js

@@ -1,29 +0,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.
- */
-function getFrameDocumentSafe(el) {
-  return el.contentDocument || null;
-}
-
-export default getFrameDocumentSafe;
-export { getFrameDocumentSafe };

package/lib/getFrameDocumentSafe.js

@@ -1,37 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getFrameDocumentSafe = getFrameDocumentSafe;
-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.
- */
-function getFrameDocumentSafe(el) {
-  return el.contentDocument || null;
-}
-
-var _default = getFrameDocumentSafe;
-exports.default = _default;

package/src/getFrameDocumentSafe.ts

@@ -1,30 +0,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.
- */
-
-function getFrameDocumentSafe(el: HTMLIFrameElement) {
-  return el.contentDocument || null
-}
-
-export default getFrameDocumentSafe
-export { getFrameDocumentSafe }

package/types/getFrameDocumentSafe.d.ts

@@ -1,4 +0,0 @@
-declare function getFrameDocumentSafe(el: HTMLIFrameElement): Document | null;
-export default getFrameDocumentSafe;
-export { getFrameDocumentSafe };
-//# sourceMappingURL=getFrameDocumentSafe.d.ts.map

package/types/getFrameDocumentSafe.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"getFrameDocumentSafe.d.ts","sourceRoot":"","sources":["../src/getFrameDocumentSafe.ts"],"names":[],"mappings":"AAwBA,iBAAS,oBAAoB,CAAC,EAAE,EAAE,iBAAiB,mBAElD;AAED,eAAe,oBAAoB,CAAA;AACnC,OAAO,EAAE,oBAAoB,EAAE,CAAA"}