wanhose/cookie-dialog-monster
wanhose/cookie-dialog-monster
2
5
Fork 0
Code Issues 304 Pull Requests Releases 18 Wiki Activity

feat(browser-extension): improve documentation and naming

Browse Source
This commit is contained in:
wanhose 2023-06-11 12:45:47 +02:00
parent 4970841c8e
commit 8bcc5f92a5
1 changed files with 92 additions and 66 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

156
packages/browser-extension/src/scripts/content.js
View File

@ -40,37 +40,30 @@ let state = { enabled: true };
/** /**
* @description Cleans DOM * @description Cleans DOM
* @param {Element[]} nodes * @param {Element[]} elements
* @param {boolean?} skipMatch * @param {boolean?} skipMatch
*/ */
function clean(nodes, skipMatch) { function clean(elements, skipMatch) {
for (let i = 0; i < nodes.length; i++) { for (const element of elements) {
const node = nodes[i]; if (match(element, skipMatch)) {
const observer = new MutationObserver(() => forceElementStyles(element));
if (match(node, skipMatch)) { element.setAttribute('data-cookie-dialog-monster', 'true');
const observer = new MutationObserver(() => { element.style.setProperty('display', 'none', 'important');
node.style.setProperty('display', 'none', 'important'); observer.observe(element, { attributes: true, attributeFilter: ['class', 'style'] });
});
if (!node.hasAttribute('data-cookie-dialog-monster')) {
node.setAttribute('data-cookie-dialog-monster', 'true');
node.style.setProperty('display', 'none', 'important');
observer.observe(node, { attributes: true, attributeFilter: ['style'] });
}
} }
} }
} }
/** /**
* @description Flat child nodes * @description Flat child nodes for a given element
* @param {HTMLElement} node * @param {HTMLElement} element
* @param {HTMLElement[] | undefined} children
* @returns {number[]} * @returns {number[]}
*/ */
function flatNode(node) { function flatElement(element) {
return [...node.childNodes].flatMap((childNode) => return [...element.childNodes].flatMap((childNode) =>
childNode.nodeType === Node.TEXT_NODE childNode.nodeType === Node.TEXT_NODE
? [childNode.nodeType] ? [childNode.nodeType]
: [...[...childNode.childNodes].map((x) => x.nodeType)] : [...[...childNode.childNodes].map((x) => x.nodeType)]
@ -78,30 +71,39 @@ function flatNode(node) {
} }
/** /**
* @description Forces a DOM clean in the specific node * @description Forces a DOM clean in the specific element
* @param {HTMLElement} node * @param {HTMLElement} element
*/ */
function forceClean(node) { function forceClean(element) {
if (data?.elements.length && state.enabled && !preview) { if (data?.elements.length && state.enabled && !preview) {
const nodes = [...node.querySelectorAll(data.elements)]; const elements = [...element.querySelectorAll(data.elements)];
if (nodes.length) { if (elements.length) {
fix(); fix();
clean(nodes, true); clean(elements, true);
} }
} }
} }
/**
* @description Forces element to have these styles
* @param {HTMLElement} element
*/
function forceElementStyles(element) {
element.style.setProperty('display', 'none', 'important');
}
/** /**
* @description Checks if an element is visible in the viewport * @description Checks if an element is visible in the viewport
* @param {HTMLElement} node * @param {HTMLElement} element
* @returns {boolean} * @returns {boolean}
*/ */
function isInViewport(node) { function isInViewport(element) {
const height = window.innerHeight || document.documentElement.clientHeight; const height = window.innerHeight || document.documentElement.clientHeight;
const position = node.getBoundingClientRect(); const position = element.getBoundingClientRect();
const scroll = window.scrollY; const scroll = window.scrollY;
return ( return (
@ -111,38 +113,41 @@ function isInViewport(node) {
} }
/** /**
* @description Checks if node element is removable * @description Checks if element element is removable
* @param {Element} node * @param {Element} element
* @param {boolean?} skipMatch * @param {boolean?} skipMatch
* @returns {boolean} * @returns {boolean}
*/ */
function match(node, skipMatch) { function match(element, skipMatch) {
if (!node instanceof HTMLElement || !node.tagName) { if (!element instanceof HTMLElement || !element.tagName) {
return false; return false;
} }
if (data?.tags.includes(node.tagName?.toUpperCase?.())) { if (element.getAttribute('data-cookie-dialog-monster')) {
return false; return false;
} }
if (node.childNodes.length && flatNode(node).every((x) => x === Node.TEXT_NODE)) { if (data?.tags.includes(element.tagName?.toUpperCase?.())) {
return false; return false;
} }
if (node.hasAttributes()) { if (element.childNodes.length && flatElement(element).every((x) => x === Node.TEXT_NODE)) {
return false;
}
if (element.hasAttributes()) {
return ( return (
// 2023-06-10: twitch.tv temporary fix // 2023-06-10: twitch.tv temporary fix
!node.classList.contains('chat-line__message') && !element.classList.contains('chat-line__message') &&
// ... // ...
!node.getAttribute('data-cookie-dialog-monster') && isInViewport(element) &&
isInViewport(node) && (skipMatch || element.matches(data?.elements ?? []))
(skipMatch || node.matches(data?.elements ?? []))
); );
} else { } else {
// 2023-06-10: fix edge case force cleaning on children if no attributes // 2023-06-10: fix edge case force cleaning on children if no attributes
if (data?.commonWords && node.outerHTML.match(new RegExp(data.commonWords.join('|')))) { if (data?.commonWords && element.outerHTML.match(new RegExp(data.commonWords.join('|')))) {
forceClean(node); forceClean(element);
} }
} }
@ -170,26 +175,20 @@ function fix() {
if (hostname.includes(match)) { if (hostname.includes(match)) {
switch (action) { switch (action) {
case 'click': { case 'click':
const node = document.querySelector(selector); document.querySelector(selector)?.click();
node?.click();
break; break;
} case 'remove':
case 'remove': { document.querySelector(selector)?.style?.removeProperty(property);
const node = document.querySelector(selector);
node?.style?.removeProperty(property);
break; break;
} case 'reset':
case 'reset': { document.querySelector(selector)?.style?.setProperty(property, 'initial', 'important');
const node = document.querySelector(selector);
node?.style?.setProperty(property, 'initial', 'important');
break; break;
} case 'resetAll':
case 'resetAll': { document.querySelectorAll(selector).forEach((element) => {
const nodes = document.querySelectorAll(selector); element?.style?.setProperty(property, 'initial', 'important');
nodes.forEach((node) => node?.style?.setProperty(property, 'initial', 'important')); });
break; break;
}
default: default:
break; break;
} }
@ -197,24 +196,51 @@ function fix() {
} }
if (skips.indexOf(hostname) === -1) { if (skips.indexOf(hostname) === -1) {
for (const item of [document.body, document.documentElement]) { for (const element of [document.body, document.documentElement]) {
item?.classList.remove(...(data?.classes ?? [])); element?.classList.remove(...(data?.classes ?? []));
item?.style.setProperty('position', 'initial', 'important'); element?.style.setProperty('position', 'initial', 'important');
item?.style.setProperty('overflow-y', 'initial', 'important'); element?.style.setProperty('overflow-y', 'initial', 'important');
} }
} }
} }
/**
* @description Calculates reading time for the current page to avoid lags in large pages
* @returns {number}
*/
function readingTime() {
const text = document.body.innerText;
const wpm = 225;
const words = text.trim().split(/\s+/).length;
const time = Math.ceil(words / wpm);
return time;
}
/** /**
* @description Mutation Observer instance * @description Mutation Observer instance
* @type {MutationObserver} * @type {MutationObserver}
*/ */
const observer = new MutationObserver((mutations) => { const observer = new MutationObserver((mutations) => {
const nodes = mutations.map((mutation) => Array.from(mutation.addedNodes)).flat(); const elements = mutations.map((mutation) => Array.from(mutation.addedNodes)).flat();
if (data?.elements.length && !preview) {
fix(); fix();
if (data?.elements.length && !preview) clean(nodes); clean(elements);
}
});
/**
* @description Fixes already existing element when page load issues
* @listens window#DOMContentLoaded
*/
window.addEventListener('DOMContentLoaded', () => {
if (readingTime() < 4) {
forceClean(document.body);
}
}); });
/** /**
@ -224,7 +250,7 @@ const observer = new MutationObserver((mutations) => {
window.addEventListener('pageshow', (event) => { window.addEventListener('pageshow', (event) => {
if (event.persisted) { if (event.persisted) {
forceClean(document.documentElement); forceClean(document.body);
} }
}); });
@ -240,6 +266,6 @@ window.addEventListener('pageshow', (event) => {
if (state.enabled) { if (state.enabled) {
data = await dispatch({ hostname, type: 'GET_DATA' }); data = await dispatch({ hostname, type: 'GET_DATA' });
dispatch({ type: 'ENABLE_ICON' }); dispatch({ type: 'ENABLE_ICON' });
observer.observe(document.documentElement, options); observer.observe(document.body ?? document.documentElement, options);
} }
})(); })();