ts-sensitivewords 1.0.0

package/README.md

@@ -0,0 +1,3 @@
+# TS-SensitiveWords
+
+A TypeScript rewrite of [alex-my/js-sensitivewords](https://github.com/alex-my/js-sensitivewords).

package/dist/index.d.mts

@@ -0,0 +1,51 @@
+//#region src/lib/sensitivewords.d.ts
+declare class SensitiveWords {
+  private map;
+  /**
+   * Add blocking words.
+   *
+   * @param words the blocking words.
+   */
+  addWords(...words: string[]): void;
+  /**
+   * Check whether there's a blocking word in the content.
+   * @param content the content to match.
+   * @return `true` if matched any.
+   */
+  contains(content: string): boolean;
+  /**
+   * Find the blocking words in the content.
+   *
+   * @param content the content to match.
+   * @param startIndex the starting index of the content to match.
+   * @return the length of matched sensitive word starting at the given index, or 0 if not any matched.
+   */
+  check(content: string, startIndex?: number): number;
+  /**
+   * Replace the blocking words in the content with given mask.
+   *
+   * @param content the content to match.
+   * @param mask the mask to replace the blocking words, a single character is recommended (e.g., '*').
+   * @return the content with all blocking words replaced with masks.
+   */
+  mask(content: string, mask?: string): string;
+  /**
+   * Find all blocking words in the content.
+   *
+   * @param content the content to match.
+   * @param startIndex the starting index of the content to match.
+   * @return a list of blocking words.
+   */
+  find(content: string, startIndex?: number): string[];
+}
+//#endregion
+//#region src/lib/dfa.d.ts
+interface DFANode {
+  isEnd: boolean;
+  [key: string]: any;
+}
+//#endregion
+//#region src/index.d.ts
+declare const sw: SensitiveWords;
+//#endregion
+export { DFANode, SensitiveWords, sw as default, sw as instance };

package/dist/index.mjs

@@ -0,0 +1,110 @@
+//#region src/lib/dfa.ts
+var DFAMap = class {
+	map = { isEnd: false };
+	get words() {
+		return this.map;
+	}
+	append(word) {
+		let curr = this.map;
+		for (let i = 0; i < word.length; i++) {
+			const char = word[i];
+			if (curr[char] !== void 0) curr = curr[char];
+			else curr = curr[char] = { isEnd: false };
+			if (i === word.length - 1) curr.isEnd = true;
+		}
+	}
+	appendAll(...words) {
+		words.forEach((w) => this.append(w));
+	}
+};
+
+//#endregion
+//#region src/lib/sensitivewords.ts
+var SensitiveWords = class {
+	map = new DFAMap();
+	/**
+	* Add blocking words.
+	*
+	* @param words the blocking words.
+	*/
+	addWords(...words) {
+		this.map.appendAll(...words);
+	}
+	/**
+	* Check whether there's a blocking word in the content.
+	* @param content the content to match.
+	* @return `true` if matched any.
+	*/
+	contains(content) {
+		for (let i = 0; i < content.length; i++) if (this.check(content, i) > 0) return true;
+		return false;
+	}
+	/**
+	* Find the blocking words in the content.
+	*
+	* @param content the content to match.
+	* @param startIndex the starting index of the content to match.
+	* @return the length of matched sensitive word starting at the given index, or 0 if not any matched.
+	*/
+	check(content, startIndex = 0) {
+		let matchLen = 0, tempLen = 0;
+		let curr = this.map.words;
+		for (let i = startIndex; i < content.length; i++) {
+			let char = content[i];
+			curr = curr[char];
+			if (curr === void 0) break;
+			else {
+				tempLen++;
+				if (curr.isEnd) matchLen = tempLen;
+			}
+		}
+		return matchLen;
+	}
+	/**
+	* Replace the blocking words in the content with given mask.
+	*
+	* @param content the content to match.
+	* @param mask the mask to replace the blocking words, a single character is recommended (e.g., '*').
+	* @return the content with all blocking words replaced with masks.
+	*/
+	mask(content, mask = "*") {
+		let result = content;
+		let i = 0;
+		while (i < content.length) {
+			const length = this.check(content, i);
+			if (length > 0) {
+				const replacement = mask.repeat(length);
+				result = result.substring(0, i) + replacement + result.substring(i + length);
+				i += length;
+			} else i++;
+		}
+		return result;
+	}
+	/**
+	* Find all blocking words in the content.
+	*
+	* @param content the content to match.
+	* @param startIndex the starting index of the content to match.
+	* @return a list of blocking words.
+	*/
+	find(content, startIndex = 0) {
+		const result = [];
+		let i = startIndex;
+		while (i < content.length) {
+			const length = this.check(content, i);
+			if (length > 0) {
+				result.push(content.substring(i, i + length));
+				i += length;
+			} else i++;
+		}
+		return result;
+	}
+};
+
+//#endregion
+//#region src/index.ts
+const sw = new SensitiveWords();
+var src_default = sw;
+
+//#endregion
+export { SensitiveWords, src_default as default, sw as instance };

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "ts-sensitivewords",
+  "type": "module",
+  "version": "1.0.0",
+  "description": "A DFA map implementation for sensitive words matching and blocking.",
+  "author": "Taskeren",
+  "license": "MIT",
+  "homepage": "https://github.com/Taskeren/ts-sensitivewords",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Taskeren/ts-sensitivewords.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Taskeren/ts-sensitivewords/issues"
+  },
+  "exports": {
+    ".": "./dist/index.mjs",
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "test": "vitest",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "npm run build"
+  },
+  "devDependencies": {
+    "@types/node": "^25.0.3",
+    "bumpp": "^10.3.2",
+    "tsdown": "^0.18.1",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.16"
+  }
+}