@ocavue/utils 0.3.0 → 0.4.0

package/dist/_tsup-dts-rollup.d.ts

@@ -1,3 +1,43 @@
+/**
+ * Gets the document for the given target or the global document if no target is
+ * provided.
+ */
+declare function getDocument(target?: Element | Window | Node | Document | null | undefined): Document;
+export { getDocument }
+export { getDocument as getDocument_alias_1 }
+
+/**
+ * Gets a reference to the root node of the document based on the given target.
+ */
+declare function getDocumentElement(target?: Element | Node | Window | Document | null | undefined): HTMLElement;
+export { getDocumentElement }
+export { getDocumentElement as getDocumentElement_alias_1 }
+
+/**
+ * Gets the window object for the given target or the global window object if no
+ * target is provided.
+ */
+declare function getWindow(target?: Node | ShadowRoot | Document | null | undefined): Window & typeof globalThis;
+export { getWindow }
+export { getWindow as getWindow_alias_1 }
+
+/**
+ * Checks if the given DOM node is a Document.
+ */
+declare function isDocument(node: Node): node is Document;
+export { isDocument }
+export { isDocument as isDocument_alias_1 }
+
+/**
+ * Checks if the given DOM node is a DocumentFragment.
+ */
+declare function isDocumentFragment(node: Node): node is DocumentFragment;
+export { isDocumentFragment }
+export { isDocumentFragment as isDocumentFragment_alias_1 }
+
+/**
+ * Checks if the given DOM node is an Element.
+ */
 declare function isElement(node: Node): node is Element;
 export { isElement }
 export { isElement as isElement_alias_1 }
@@ -9,24 +49,57 @@ declare function isElementLike(value: unknown): value is Element;
 export { isElementLike }
 export { isElementLike as isElementLike_alias_1 }
 
+/**
+ * Checks if the given DOM node is an HTMLElement.
+ */
 declare function isHTMLElement(node: Node): node is HTMLElement;
 export { isHTMLElement }
 export { isHTMLElement as isHTMLElement_alias_1 }
 
+/**
+ * Checks if the given DOM node is an MathMLElement.
+ */
 declare function isMathMLElement(node: Node): node is MathMLElement;
 export { isMathMLElement }
 export { isMathMLElement as isMathMLElement_alias_1 }
 
+/**
+ * Checks if an unknown value is likely a DOM node.
+ */
+declare function isNodeLike(value: unknown): value is Node;
+export { isNodeLike }
+export { isNodeLike as isNodeLike_alias_1 }
+
 declare function isObject(value: unknown): value is Record<string | symbol | number, unknown>;
 export { isObject }
 export { isObject as isObject_alias_1 }
 
+/**
+ * Checks if the given DOM node is a ShadowRoot.
+ */
+declare function isShadowRoot(node: Node): node is ShadowRoot;
+export { isShadowRoot }
+export { isShadowRoot as isShadowRoot_alias_1 }
+
+/**
+ * Checks if the given DOM node is an SVGElement.
+ */
 declare function isSVGElement(node: Node): node is SVGElement;
 export { isSVGElement }
 export { isSVGElement as isSVGElement_alias_1 }
 
+/**
+ * Checks if the given DOM node is a Text node.
+ */
 declare function isTextNode(node: Node): node is Text;
 export { isTextNode }
 export { isTextNode as isTextNode_alias_1 }
 
+/**
+ * Checks if the given value is likely a Window object.
+ */
+declare function isWindowLike(value: unknown): value is Window;
+export { isWindowLike }
+export { isWindowLike as isWindowLike_alias_1 }
+
 export { }

package/dist/index.d.ts

@@ -4,4 +4,12 @@ export { isTextNode_alias_1 as isTextNode } from './_tsup-dts-rollup.js';
 export { isHTMLElement_alias_1 as isHTMLElement } from './_tsup-dts-rollup.js';
 export { isSVGElement_alias_1 as isSVGElement } from './_tsup-dts-rollup.js';
 export { isMathMLElement_alias_1 as isMathMLElement } from './_tsup-dts-rollup.js';
+export { isDocument_alias_1 as isDocument } from './_tsup-dts-rollup.js';
+export { isDocumentFragment_alias_1 as isDocumentFragment } from './_tsup-dts-rollup.js';
+export { isShadowRoot_alias_1 as isShadowRoot } from './_tsup-dts-rollup.js';
+export { isNodeLike_alias_1 as isNodeLike } from './_tsup-dts-rollup.js';
 export { isElementLike_alias_1 as isElementLike } from './_tsup-dts-rollup.js';
+export { isWindowLike_alias_1 as isWindowLike } from './_tsup-dts-rollup.js';
+export { getWindow_alias_1 as getWindow } from './_tsup-dts-rollup.js';
+export { getDocument_alias_1 as getDocument } from './_tsup-dts-rollup.js';
+export { getDocumentElement_alias_1 as getDocumentElement } from './_tsup-dts-rollup.js';

package/dist/index.js

@@ -19,15 +19,67 @@ function isSVGElement(node) {
 function isMathMLElement(node) {
   return isElement(node) && node.namespaceURI === "http://www.w3.org/1998/Math/MathML";
 }
+function isDocument(node) {
+  return node.nodeType === 9 /* DOCUMENT_NODE */;
+}
+function isDocumentFragment(node) {
+  return node.nodeType === 11 /* DOCUMENT_FRAGMENT_NODE */;
+}
+function isShadowRoot(node) {
+  return isDocumentFragment(node) && "host" in node && isElementLike(node.host);
+}
+function isNodeLike(value) {
+  return isObject(value) && value.nodeType !== void 0;
+}
 function isElementLike(value) {
   return isObject(value) && value.nodeType === 1 /* ELEMENT_NODE */ && typeof value.nodeName === "string";
 }
+function isWindowLike(value) {
+  return isObject(value) && value.window === value;
+}
+function getWindow(target) {
+  if (target) {
+    if (isShadowRoot(target)) {
+      return getWindow(target.host);
+    }
+    if (isDocument(target)) {
+      return target.defaultView || window;
+    }
+    if (isElement(target)) {
+      return target.ownerDocument?.defaultView || window;
+    }
+  }
+  return window;
+}
+function getDocument(target) {
+  if (target) {
+    if (isWindowLike(target)) {
+      return target.document;
+    }
+    if (isDocument(target)) {
+      return target;
+    }
+    return target.ownerDocument || document;
+  }
+  return document;
+}
+function getDocumentElement(target) {
+  return getDocument(target).documentElement;
+}
 export {
+  getDocument,
+  getDocumentElement,
+  getWindow,
+  isDocument,
+  isDocumentFragment,
   isElement,
   isElementLike,
   isHTMLElement,
   isMathMLElement,
+  isNodeLike,
   isObject,
   isSVGElement,
-  isTextNode
+  isShadowRoot,
+  isTextNode,
+  isWindowLike
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ocavue/utils",
   "type": "module",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "",
   "author": "ocavue <ocavue@gmail.com>",
   "license": "MIT",