@oscarpalmer/toretto 0.8.0 → 0.9.0

package/dist/index.js

@@ -437,6 +437,34 @@ var tabbableFilters = [
   isNotTabbableRadio,
   ...focusableFilters
 ];
+// src/sanitise.ts
+function sanitise(value2, options) {
+  return sanitiseNodes(Array.isArray(value2) ? value2 : [value2], {
+    sanitiseBooleanAttributes: options?.sanitiseBooleanAttributes ?? true
+  });
+}
+function sanitiseAttributes(element, attributes, options) {
+  const { length } = attributes;
+  for (let index = 0;index < length; index += 1) {
+    const attribute2 = attributes[index];
+    if (isBadAttribute(attribute2) || isEmptyNonBooleanAttribute(attribute2)) {
+      element.removeAttribute(attribute2.name);
+    } else if (options.sanitiseBooleanAttributes && isInvalidBooleanAttribute(attribute2)) {
+      element.setAttribute(attribute2.name, "");
+    }
+  }
+}
+function sanitiseNodes(nodes, options) {
+  const { length } = nodes;
+  for (let index = 0;index < length; index += 1) {
+    const node = nodes[index];
+    if (node instanceof Element) {
+      sanitiseAttributes(node, [...node.attributes], options);
+    }
+    sanitiseNodes([...node.childNodes], options);
+  }
+  return nodes;
+}
 // src/style.ts
 function getStyle(element, property) {
   return element.style[property];
@@ -476,6 +504,7 @@ export {
   setData,
   setAttributes,
   setAttribute,
+  sanitise,
   isTabbable,
   isInvalidBooleanAttribute,
   isFocusable,

package/dist/index.mjs

@@ -4,4 +4,5 @@ export * from "./data";
 export * from "./find";
 export * from "./focusable";
 export * from "./models";
+export * from "./sanitise";
 export * from "./style";

package/dist/sanitise.js

@@ -0,0 +1,75 @@
+// src/attribute.ts
+function isBadAttribute(attribute) {
+  return onPrefix.test(attribute.name) || sourcePrefix.test(attribute.name) && valuePrefix.test(attribute.value);
+}
+function isEmptyNonBooleanAttribute(attribute) {
+  return !booleanAttributes.includes(attribute.name) && attribute.value.trim().length === 0;
+}
+function isInvalidBooleanAttribute(attribute) {
+  if (!booleanAttributes.includes(attribute.name)) {
+    return true;
+  }
+  const normalised = attribute.value.toLowerCase().trim();
+  return !(normalised.length === 0 || normalised === attribute.name || attribute.name === "hidden" && normalised === "until-found");
+}
+var booleanAttributes = Object.freeze([
+  "async",
+  "autofocus",
+  "autoplay",
+  "checked",
+  "controls",
+  "default",
+  "defer",
+  "disabled",
+  "formnovalidate",
+  "hidden",
+  "inert",
+  "ismap",
+  "itemscope",
+  "loop",
+  "multiple",
+  "muted",
+  "nomodule",
+  "novalidate",
+  "open",
+  "playsinline",
+  "readonly",
+  "required",
+  "reversed",
+  "selected"
+]);
+var onPrefix = /^on/i;
+var sourcePrefix = /^(href|src|xlink:href)$/i;
+var valuePrefix = /(data:text\/html|javascript:)/i;
+
+// src/sanitise.ts
+function sanitise(value2, options) {
+  return sanitiseNodes(Array.isArray(value2) ? value2 : [value2], {
+    sanitiseBooleanAttributes: options?.sanitiseBooleanAttributes ?? true
+  });
+}
+function sanitiseAttributes(element, attributes, options) {
+  const { length } = attributes;
+  for (let index = 0;index < length; index += 1) {
+    const attribute2 = attributes[index];
+    if (isBadAttribute(attribute2) || isEmptyNonBooleanAttribute(attribute2)) {
+      element.removeAttribute(attribute2.name);
+    } else if (options.sanitiseBooleanAttributes && isInvalidBooleanAttribute(attribute2)) {
+      element.setAttribute(attribute2.name, "");
+    }
+  }
+}
+function sanitiseNodes(nodes, options) {
+  const { length } = nodes;
+  for (let index = 0;index < length; index += 1) {
+    const node = nodes[index];
+    if (node instanceof Element) {
+      sanitiseAttributes(node, [...node.attributes], options);
+    }
+    sanitiseNodes([...node.childNodes], options);
+  }
+  return nodes;
+}
+export {
+  sanitise
+};

package/dist/sanitise.mjs

@@ -0,0 +1,36 @@
+// src/sanitise.ts
+import {
+isBadAttribute,
+isEmptyNonBooleanAttribute,
+isInvalidBooleanAttribute
+} from "./attribute";
+function sanitise(value, options) {
+  return sanitiseNodes(Array.isArray(value) ? value : [value], {
+    sanitiseBooleanAttributes: options?.sanitiseBooleanAttributes ?? true
+  });
+}
+function sanitiseAttributes(element, attributes, options) {
+  const { length } = attributes;
+  for (let index = 0;index < length; index += 1) {
+    const attribute2 = attributes[index];
+    if (isBadAttribute(attribute2) || isEmptyNonBooleanAttribute(attribute2)) {
+      element.removeAttribute(attribute2.name);
+    } else if (options.sanitiseBooleanAttributes && isInvalidBooleanAttribute(attribute2)) {
+      element.setAttribute(attribute2.name, "");
+    }
+  }
+}
+function sanitiseNodes(nodes, options) {
+  const { length } = nodes;
+  for (let index = 0;index < length; index += 1) {
+    const node = nodes[index];
+    if (node instanceof Element) {
+      sanitiseAttributes(node, [...node.attributes], options);
+    }
+    sanitiseNodes([...node.childNodes], options);
+  }
+  return nodes;
+}
+export {
+  sanitise
+};

package/package.json

@@ -55,6 +55,12 @@
 			"types": "./types/models.d.ts",
 			"bun": "./src/models.ts"
 		},
+		"./sanitise": {
+			"types": "./types/sanitise.d.ts",
+			"bun": "./src/sanitise.ts",
+			"import": "./dist/sanitise.mjs",
+			"require": "./dist/sanitise.js"
+		},
 		"./style": {
 			"types": "./types/style.d.ts",
 			"bun": "./src/style.ts",
@@ -91,5 +97,5 @@
 	},
 	"type": "module",
 	"types": "types/index.d.cts",
-	"version": "0.8.0"
+	"version": "0.9.0"
 }

package/src/index.ts

@@ -3,4 +3,5 @@ export * from './data';
 export * from './find';
 export * from './focusable';
 export * from './models';
+export * from './sanitise';
 export * from './style';

package/src/sanitise.ts

@@ -0,0 +1,63 @@
+import {
+	isBadAttribute,
+	isEmptyNonBooleanAttribute,
+	isInvalidBooleanAttribute,
+} from './attribute';
+
+export type SanitiseOptions = {
+	/**
+	 * - Sanitise boolean attributes? _(Defaults to `true`)_
+	 * - E.g. `checked="abc"` => `checked=""`
+	 */
+	sanitiseBooleanAttributes?: boolean;
+};
+
+/**
+ * - Sanitise one or more nodes _(as well as all their children)_:
+ * - Removes or sanitises bad attributes
+ */
+export function sanitise(
+	value: Node | Node[],
+	options?: Partial<SanitiseOptions>,
+): Node[] {
+	return sanitiseNodes(Array.isArray(value) ? value : [value], {
+		sanitiseBooleanAttributes: options?.sanitiseBooleanAttributes ?? true,
+	});
+}
+
+function sanitiseAttributes(
+	element: Element,
+	attributes: Attr[],
+	options: SanitiseOptions,
+): void {
+	const {length} = attributes;
+
+	for (let index = 0; index < length; index += 1) {
+		const attribute = attributes[index];
+
+		if (isBadAttribute(attribute) || isEmptyNonBooleanAttribute(attribute)) {
+			element.removeAttribute(attribute.name);
+		} else if (
+			options.sanitiseBooleanAttributes &&
+			isInvalidBooleanAttribute(attribute)
+		) {
+			element.setAttribute(attribute.name, '');
+		}
+	}
+}
+
+function sanitiseNodes(nodes: Node[], options: SanitiseOptions): Node[] {
+	const {length} = nodes;
+
+	for (let index = 0; index < length; index += 1) {
+		const node = nodes[index];
+
+		if (node instanceof Element) {
+			sanitiseAttributes(node, [...node.attributes], options);
+		}
+
+		sanitiseNodes([...node.childNodes], options);
+	}
+
+	return nodes;
+}

package/types/index.d.cts

@@ -137,6 +137,18 @@ export declare function isFocusable(element: Element): boolean;
  * Is the element tabbable?
  */
 export declare function isTabbable(element: Element): boolean;
+export type SanitiseOptions = {
+	/**
+	 * - Sanitise boolean attributes? _(Defaults to `true`)_
+	 * - E.g. `checked="abc"` => `checked=""`
+	 */
+	sanitiseBooleanAttributes?: boolean;
+};
+/**
+ * - Sanitise one or more nodes _(as well as all their children)_:
+ * - Removes or sanitises bad attributes
+ */
+export declare function sanitise(value: Node | Node[], options?: Partial<SanitiseOptions>): Node[];
 /**
  * Get a style from an element
  */

package/types/index.d.ts

@@ -3,4 +3,5 @@ export * from './data';
 export * from './find';
 export * from './focusable';
 export * from './models';
+export * from './sanitise';
 export * from './style';

package/types/sanitise.d.ts

@@ -0,0 +1,12 @@
+export type SanitiseOptions = {
+    /**
+     * - Sanitise boolean attributes? _(Defaults to `true`)_
+     * - E.g. `checked="abc"` => `checked=""`
+     */
+    sanitiseBooleanAttributes?: boolean;
+};
+/**
+ * - Sanitise one or more nodes _(as well as all their children)_:
+ * - Removes or sanitises bad attributes
+ */
+export declare function sanitise(value: Node | Node[], options?: Partial<SanitiseOptions>): Node[];