janus-parse 1.1.1 → 1.2.1

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2026
+
+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.

package/README.md

@@ -49,9 +49,7 @@ const rawHtml = `
   </main>
 `;
 
-const cleanText = await janusServer(rawHtml);
-console.log(cleanText);
-// Output: "Hello Universe This is a highly spaced sentence."
+const cleanText = await janusServer(rawHtml); // Output: "Hello Universe This is a highly spaced sentence."
 ```
 
 ### 2. Client-Side Execution (Browser)
@@ -64,9 +62,7 @@ import { janusClient } from "janus-parse";
 const webMarkup =
   "<div> Dynamic Web App <style>body { display: none; }</style></div>";
 
-const textOnly = janusClient(webMarkup);
-console.log(textOnly);
-// Output: " Dynamic Web App"
+const textOnly = janusClient(webMarkup); // Output: " Dynamic Web App"
 ```
 
 ### 3. Custom Configurations
@@ -75,8 +71,8 @@ You can modify which HTML tags are targeted for destruction by passing an option
 
 ```typescript
 const structuralConfig = {
-  addBlacklistTags: ["span", "section"], // Purge extra elements
-  removeBlacklistTags: ["script"], // Keep scripts if you are building an isolated sandbox
+  tagsToRemove: ["span", "section"] // Adds additonal blacklist candidates,
+  tagsToPreserve: ["script"] // Preserves script tag in output,
 };
 ```
 
@@ -87,9 +83,9 @@ const processedTextServer = await janusServer(htmlSource, structuralConfig);
 ```
 
 ```typescript
-import { janusClient } from 'janus-parse';
+import { janusClient } from "janus-parse";
 
-const processedTextClient = janusClienthtmlSource, structuralConfig);
+const processedTextClient = janusClient(htmlSource, structuralConfig);
 ```
 
 ---
@@ -101,26 +97,22 @@ const processedTextClient = janusClienthtmlSource, structuralConfig);
 TypeScript interface passed to fine-tune tag removal behaviors.
 
 ```typescript
-interface Config {
-  addBlacklistTags?: string[];
-  removeBlacklistTags?: string[];
+type Config {
+  tagsToRemove?: string[];
+  tagsToPreserve?: string[];
 }
 ```
 
-### `janusServer(text: string, config?: Config): Promise<string>`
+#### `janusServer(text: string, config?: Config): Promise<string>`
 
 - **`text`**: The input raw HTML string.
 - **`config`**: Optional rule blocks to override standard cleaning lists.
 - **Returns**: A promise that resolves to a stripped, whitespace-normalized single-line string.
 
-### `janusClient(text: string, config?: Config): string`
+---
+
+#### `janusClient(text: string, config?: Config): string`
 
 - **`text`**: The input raw HTML string.
 - **`config`**: Optional rule blocks to override standard cleaning lists.
 - **Returns**: A clean string containing target inner-text nodes parsed from the browser context.
-
----
-
-## License
-
-Distributed under the MIT License. See [LICENSE](LICENSE) for more information.

package/dist/janus-parse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"janus-parse.d.ts","sourceRoot":"","sources":["../lib/janus-parse.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAOtC,wBAAsB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,GAAE,MAAoB,mBAS3E;AAED,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,GAAE,MAAoB,UAUrE"}
+{"version":3,"file":"janus-parse.d.ts","sourceRoot":"","sources":["../lib/janus-parse.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAOtC,wBAAsB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,GAAE,MAAoB,mBAS3E;AAED,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,GAAE,MAAoB,UASrE"}

package/dist/janus-parse.js

@@ -1,23 +1,19 @@
-import { validateText, removeNodes, getTags, normalizeWhitespace, } from "./utils";
+import { validateText, getTags, normalizeWhitespace, serialize } from "./utils";
 const janusConfig = {
-    addBlacklistTags: [],
-    removeBlacklistTags: [],
+    tagsToRemove: [],
+    tagsToPreserve: [],
 };
 export async function janusServer(text, config = janusConfig) {
     validateText(text);
-    const tags = getTags(config);
     const parser = await import("node-html-parser");
     const root = parser.parse(text);
-    const nodesToRemove = root.querySelectorAll(tags);
-    removeNodes(nodesToRemove);
-    return normalizeWhitespace(root.textContent);
+    const { removedTags, preservedTags } = getTags(config);
+    return normalizeWhitespace(serialize({ node: root, removedTags, preservedTags }));
 }
 export function janusClient(text, config = janusConfig) {
     validateText(text);
-    const tags = getTags(config);
     const parser = new DOMParser();
-    const virtualDocument = parser.parseFromString(text, "text/html");
-    const nodesToRemove = virtualDocument.querySelectorAll(tags);
-    removeNodes(nodesToRemove);
-    return normalizeWhitespace(virtualDocument.body.textContent);
+    const { removedTags, preservedTags } = getTags(config);
+    const root = parser.parseFromString(text, "text/html").body;
+    return normalizeWhitespace(serialize({ node: root, removedTags, preservedTags }));
 }

package/dist/utils/index.d.ts

@@ -1,10 +1,19 @@
 import type { HTMLElement as NodeHTMLElement } from "node-html-parser";
 export type Config = {
-    addBlacklistTags?: string[];
-    removeBlacklistTags?: string[];
+    tagsToRemove?: string[];
+    tagsToPreserve?: string[];
 };
 export declare function validateText(text: string): void;
 export declare function normalizeWhitespace(text?: string): string;
-export declare function getTags(config: Config): string;
-export declare function removeNodes(nodesToRemove: NodeHTMLElement[] | NodeListOf<Element>): NodeListOf<Element> | NodeHTMLElement[];
+export declare function getTags(config: Config): {
+    removedTags: Set<string>;
+    preservedTags: Set<string>;
+};
+export declare function serialize({ node, removedTags, preservedTags, }: {
+    node: Node;
+    removedTags: Set<string>;
+    preservedTags: Set<string>;
+}): string;
+type Node = NodeHTMLElement | ChildNode;
+export {};
 //# sourceMappingURL=index.d.ts.map

package/dist/utils/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,IAAI,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAEvE,MAAM,MAAM,MAAM,GAAG;IACnB,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;CAChC,CAAC;AAIF,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,QAUxC;AAED,wBAAgB,mBAAmB,CAAC,IAAI,SAAK,UAE5C;AAED,wBAAgB,OAAO,CAAC,MAAM,EAAE,MAAM,UAWrC;AAED,wBAAgB,WAAW,CACzB,aAAa,EAAE,eAAe,EAAE,GAAG,UAAU,CAAC,OAAO,CAAC,2CAOvD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,IAAI,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAEvE,MAAM,MAAM,MAAM,GAAG;IACnB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;CAC3B,CAAC;AAIF,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,QAOxC;AAED,wBAAgB,mBAAmB,CAAC,IAAI,SAAK,UAE5C;AAED,wBAAgB,OAAO,CAAC,MAAM,EAAE,MAAM;;;EAiBrC;AAED,wBAAgB,SAAS,CAAC,EACxB,IAAI,EACJ,WAAW,EACX,aAAa,GACd,EAAE;IACD,IAAI,EAAE,IAAI,CAAC;IACX,WAAW,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IACzB,aAAa,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;CAC5B,GAAG,MAAM,CAgCT;AAwBD,KAAK,IAAI,GAAG,eAAe,GAAG,SAAS,CAAC"}

package/dist/utils/index.js

@@ -1,40 +1,67 @@
 const defaultBlacklistTags = new Set(["script", "style"]);
 export function validateText(text) {
-    if (typeof text !== "string" ||
-        (typeof text === "string" && text === "undefined")) {
-        throw new Error("The text is not a valid string. Please provide a valid string to parse.", { cause: text });
+    if (typeof text !== "string") {
+        throw new TypeError(`\n======================================================\n=> ${text} recieved. String expected.\n======================================================`, { cause: `${text} is not of type string.` });
     }
 }
 export function normalizeWhitespace(text = "") {
     return text.replace(new RegExp(String.raw `\s+`, "g"), " ").trim();
 }
 export function getTags(config) {
-    let tags = new Set();
-    if (config.addBlacklistTags) {
-        tags = addBlackListTags(config.addBlacklistTags);
+    const removedTags = new Set(defaultBlacklistTags);
+    const preservedTags = new Set();
+    if (config.tagsToRemove) {
+        addBlackListTags(removedTags, config.tagsToRemove);
     }
-    if (config.removeBlacklistTags) {
-        tags = removeBlackListTags(config.removeBlacklistTags);
+    if (config.tagsToPreserve) {
+        removeBlackListTags({
+            removedTags,
+            preservedTags,
+            tagsToPreserve: config.tagsToPreserve,
+        });
     }
-    return [...tags].join(",");
+    return { removedTags, preservedTags };
 }
-export function removeNodes(nodesToRemove) {
-    for (const node of nodesToRemove) {
-        node.remove();
+export function serialize({ node, removedTags, preservedTags, }) {
+    if (!node)
+        return "";
+    if (node.nodeType === 3) {
+        // DOM Text node => 3
+        const rawText = getNodeProperty(node, "rawText");
+        const text = getNodeProperty(node, "text");
+        return rawText ?? text ?? node.textContent ?? "";
     }
-    return nodesToRemove;
+    const tagName = getNodeProperty(node, "tagName") ?? "";
+    const tag = tagName.toLowerCase();
+    //  Completely ignore blacklisted tags
+    if (removedTags.has(tag))
+        return "";
+    //  Keep preserved tags intact along with their outer HTML structure
+    if (preservedTags.has(tag)) {
+        const outerHTML = getNodeProperty(node, "outerHTML");
+        return (outerHTML ??
+            (typeof node.toString === "function" ? node.toString() : undefined) ??
+            "");
+    }
+    const children = [...node.childNodes];
+    return children
+        .map((child) => serialize({ node: child, removedTags, preservedTags }))
+        .join("");
 }
-function removeBlackListTags(removeBlacklistTags) {
-    const blacklistTags = new Set(defaultBlacklistTags);
-    for (const tag of removeBlacklistTags) {
-        blacklistTags.delete(tag);
+function removeBlackListTags({ removedTags, preservedTags, tagsToPreserve, }) {
+    for (const tag of tagsToPreserve) {
+        const normalized = tag.toLowerCase();
+        removedTags.delete(normalized);
+        preservedTags.add(normalized);
     }
-    return blacklistTags;
 }
-function addBlackListTags(addBlacklistTags) {
-    const blacklistTags = new Set(defaultBlacklistTags);
-    for (const tag of addBlacklistTags) {
-        blacklistTags.add(tag);
+function addBlackListTags(preserveTags, tagsToRemove) {
+    for (const tag of tagsToRemove) {
+        preserveTags.add(tag.toLowerCase());
     }
-    return blacklistTags;
+}
+function getNodeProperty(node, lookup = "outerHTML") {
+    const targetNode = node;
+    const value = targetNode[lookup];
+    return value ?? undefined;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "janus-parse",
   "license": "MIT",
-  "version": "1.1.1",
+  "version": "1.2.1",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "packageManager": "pnpm@11.15.1",
@@ -67,8 +67,8 @@
     "eslint-import-resolver-typescript": "^4.4.5",
     "eslint-plugin-import-x": "^4.17.1",
     "eslint-plugin-unicorn": "^72.0.0",
-    "happy-dom": "^20.11.0",
-    "prettier": "^3.9.5",
+    "happy-dom": "^20.11.1",
+    "prettier": "^3.9.6",
     "semantic-release": "^25.0.8",
     "tsx": "4.23.1",
     "typescript": "6.0.3",