glin-profanity 1.1.9 → 2.1.0

package/README.md

@@ -1,6 +1,100 @@
-
-# Glin Profanity
-Glin-Profanity is a lightweight and efficient npm package designed to detect and filter profane language in text inputs across multiple languages. Whether you’re building a chat application, a comment section, or any platform where user-generated content is involved, Glin-Profanity helps you maintain a clean and respectful environment.
+<p align="center">
+  <a href="https://www.glincker.com/tools/glin-profanity" target="_blank">
+    <img src="../../assets/glinr-logo.png" alt="Glin Profanity" width="40" /> 
+  </a>
+</p>
+
+<h1 align="center">GLIN PROFANITY</h1>
+
+<p align="center">
+  <strong>A multilingual profanity detection and filtering engine for modern applications — by <a href="https://glincker.com">GLINCKER</a></strong>
+</p>
+<p align="center">
+  <a href="https://www.glincker.com/tools/glin-profanity">
+    <img src="https://img.shields.io/badge/🚀%20Try%20Live%20Demo-online-blue" alt="Try Live Demo" />
+  </a>
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/glin-profanity">
+    <img src="https://img.shields.io/npm/v/glin-profanity" alt="NPM Version" />
+  </a>
+  <a href="https://github.com/GLINCKER/glin-profanity/blob/main/LICENSE">
+    <img src="https://img.shields.io/badge/license-MIT-green" alt="MIT License" />
+  </a>
+  <a href="https://github.com/GLINCKER/glin-profanity/actions">
+    <img src="https://img.shields.io/github/actions/workflow/status/GLINCKER/glin-profanity/ci.yml" alt="CI Status" />
+  </a>
+  <a href="https://www.npmjs.com/package/glin-profanity">
+    <img src="https://img.shields.io/npm/dw/glin-profanity" alt="Weekly Downloads" />
+  </a>
+  <a href="https://github.com/GLINCKER/glin-profanity/issues">
+    <img src="https://img.shields.io/github/issues/GLINCKER/glin-profanity" alt="Open Issues" />
+  </a>
+  <a href="https://github.com/GLINCKER/glin-profanity/pulls">
+    <img src="https://img.shields.io/github/issues-pr/GLINCKER/glin-profanity" alt="Open PRs" />
+  </a>
+  <a href="https://github.com/GLINCKER/glin-profanity/commits/main">
+    <img src="https://img.shields.io/github/last-commit/GLINCKER/glin-profanity" alt="Last Commit" />
+  </a>
+  <a href="https://github.com/GLINCKER/glin-profanity/stargazers">
+    <img src="https://img.shields.io/github/stars/GLINCKER/glin-profanity" alt="GitHub Stars" />
+  </a>
+  <a href="https://github.com/GLINCKER/glin-profanity/network/members">
+    <img src="https://img.shields.io/github/forks/GLINCKER/glin-profanity" alt="GitHub Forks" />
+  </a>
+  <a href="https://github.com/GLINCKER/glin-profanity/graphs/contributors">
+    <img src="https://img.shields.io/github/contributors/GLINCKER/glin-profanity" alt="Contributors" />
+  </a>
+  <a href="#-table-of-contents">
+    <img src="https://img.shields.io/badge/-Table%20of%20Contents-blue" alt="Table Of Contents" />
+  </a>
+</p>
+
+---
+
+
+> A multilingual profanity detection and filtering engine for modern applications — by [GLINCKER](https://glincker.com)
+ 
+[![Glin Profanity Preview](../../assets/glin-profanity-preview.png)](https://www.glincker.com/tools/glin-profanity)
+
+---
+
+## ✨ Overview
+
+**Glin-Profanity** is a high-performance JavaScript/TypeScript library built to detect, filter, and sanitize profane or harmful language in user-generated content. With support for over 20+ languages, configurable severity levels, obfuscation detection, and real-time React integration, it’s designed for developers who care about building safe, inclusive platforms.
+
+Whether you're moderating chat messages, community forums, or content input forms, Glin-Profanity empowers you to:
+
+- 🧼 Filter text with real-time or batch processing
+- 🗣️ Detect offensive terms in **20+ human languages**
+- 💬 Catch obfuscated profanity like `sh1t`, `f*ck`, `a$$hole`
+- 🎚️ Adjust severity thresholds (`Exact`, `Fuzzy`, `Merged`)
+- 🔁 Replace bad words with symbols or emojis
+- 🧩 Seamlessly integrate into **React apps** via `useProfanityChecker`
+- 🛡️ Add custom word lists or ignore specific terms
+
+## 📚 Table of Contents
+
+- [🚀 Features](#-features)
+- [📦 Installation](#installation)
+- [🌍 Supported Languages](#supported-languages)
+- [⚙️ Usage](#usage)
+  - [Basic Usage](#basic-usage)
+- [🧠 API](#api)
+  - [Filter Class](#filter-class)
+    - [Constructor](#constructor)
+    - [FilterConfig Options](#filterconfig-options)
+    - [Methods](#methods)
+      - [isProfane](#isprofane)
+      - [checkProfanity](#checkprofanity)
+  - [useProfanityChecker Hook](#useprofanitychecker-hook)
+    - [Parameters](#parameters)
+    - [Return Value](#return-value)
+- [⚠️ Note](#note)
+- [🛠 Use Cases](#-use-cases)
+- [📄 License](#license)
+  - [MIT License](#mit-license)
 
 ## Installation
 
@@ -14,61 +108,60 @@ OR
 ```bash
 yarn add glin-profanity
 ```
+ 
+### Supported Languages
+
+Arabic, Chinese, Czech, Danish, English, Esperanto, Finnish, French, German, Hindi, Hungarian, Italian, Japanese, Korean, Norwegian, Persian, Polish, Portuguese, Russian, Turkish, Swedish, Thai
+
 ## Usage
 
 ### Basic Usage
 
 Here's a simple example of how to use Glin-Profanity in a React application:
 
-```typescript
+```tsx
 import React, { useState } from 'react';
-import { useProfanityChecker, Language } from 'glin-profanity';
+import { useProfanityChecker, SeverityLevel, Language } from 'glin-profanity';
 
-const App: React.FC = () => {
+const App = () => {
   const [text, setText] = useState('');
-  const [checkAllLanguages, setCheckAllLanguages] = useState(false);
-  const { result, checkText } = useProfanityChecker(
-    checkAllLanguages ? { allLanguages: true } : { languages: ['english', 'french'] }
-  );
-
-  const handleChange = (e: React.ChangeEvent<HTMLInputElement>) => {
-    setText(e.target.value);
-  };
-
-  const handleCheck = () => {
-    checkText(text);
-  };
+  const [autoReplace, setAutoReplace] = useState(true);
+  const [replaceWith, setReplaceWith] = useState('***');
+  const [minSeverity, setMinSeverity] = useState(SeverityLevel.Exact);
+
+  const { result, checkText } = useProfanityChecker({
+    allLanguages: true,
+    severityLevels: true,
+    autoReplace,
+    replaceWith,
+    minSeverity,
+    customActions: (res) => {
+      console.log('[Detected]', res.profaneWords);
+    },
+  });
 
   return (
     <div>
-      <h1>Welcome to Glin-Profanity</h1>
-      <input type="text" value={text} onChange={handleChange} />
-      <button onClick={handleCheck}>Check Profanity</button>
-      <div>
-        <label>
-          <input
-            type="checkbox"
-            checked={checkAllLanguages}
-            onChange={(e) => setCheckAllLanguages(e.target.checked)}
-          />
-          Check All Languages
-        </label>
-      </div>
+      <input value={text} onChange={(e) => setText(e.target.value)} />
+      <button onClick={() => checkText(text)}>Scan</button>
+
       {result && (
-        <div>
+        <>
           <p>Contains Profanity: {result.containsProfanity ? 'Yes' : 'No'}</p>
           {result.containsProfanity && (
-            <p>Profane Words: {result.profaneWords.join(', ')}</p>
+            <>
+              <p>Detected: {result.profaneWords.join(', ')}</p>
+              <p>Replaced: {result.processedText}</p>
+            </>
           )}
-        </div>
+        </>
       )}
     </div>
   );
 };
-
-export default App;
 ```
 
+
 ## API
 
 ### `Filter` Class
@@ -89,16 +182,26 @@ new Filter(config?: {
 });
 ```
 
-- `config`: An optional configuration object.
-  - `languages`: An array of languages to check for profanities.
-  - `allLanguages`: A boolean indicating whether to check for all languages.
-  - `caseSensitive`: A boolean indicating whether the profanity check should be case-sensitive.
-  - `wordBoundaries`: A boolean indicating whether to consider word boundaries when checking for profanities.
-  - `customWords`: An array of custom words to include in the profanity check.
-  - `replaceWith`: A string to replace profane words with.
-  - `severityLevels`: A boolean indicating whether to include severity levels for profane words. 
-  - `ignoreWords`: An array of words to ignore in the profanity check.
-  - `logProfanity`: A boolean indicating whether to log detected profane words. 
+#### FilterConfig Options:
+
+| Option                  | Type               | Description |
+|-------------------------|--------------------|-------------|
+| `languages`             | `Language[]`       | Languages to include |
+| `allLanguages`          | `boolean`          | If true, scan all available languages |
+| `caseSensitive`         | `boolean`          | Match case exactly |
+| `wordBoundaries`        | `boolean`          | Only match full words (turn off for substring matching) |
+| `customWords`           | `string[]`         | Add your own words |
+| `replaceWith`           | `string`           | Replace matched words with this string |
+| `severityLevels`        | `boolean`          | Enable severity mapping (Exact, Fuzzy, Merged) |
+| `ignoreWords`           | `string[]`         | Words to skip even if found |
+| `logProfanity`          | `boolean`          | Log results via console |
+| `allowObfuscatedMatch`  | `boolean`          | Enable fuzzy pattern matching like `f*ck` |
+| `fuzzyToleranceLevel`   | `number (0–1)`     | Adjust how tolerant fuzzy matching is |
+| `autoReplace`           | `boolean`          | Whether to auto-replace flagged words |
+| `minSeverity`           | `SeverityLevel`    | Minimum severity to include in final list |
+| `customActions`         | `(result) => void` | Custom logging/callback support |
+
+---
 
 #### Methods
 
@@ -156,6 +259,17 @@ A custom React hook for using the profanity checker.
 const { result, checkText, checkTextAsync } = useProfanityChecker(config);
 ```
 
+## Note 
+⚠️ Glin-Profanity is a best-effort tool. Language evolves, and no filter is perfect. Always supplement with human moderation for high-risk platforms.
+
+## 🛠 Use Cases
+
+- 🔐 Chat moderation in messaging apps
+- 🧼 Comment sanitization for blogs or forums
+- 🕹️ Game lobbies & multiplayer chats
+- 🤖 AI content filters before processing input
+
+
 ## License
 
 This software is also available under the GLINCKER LLC proprietary license. The proprietary license allows for use, modification, and distribution of the software with certain restrictions and conditions as set forth by GLINCKER LLC.

package/lib/cjs/data/english.json

@@ -1,8 +1,8 @@
 {
     "words": [
-        "testbad01",
-        "2g1c",
         "2 girls 1 cup",
+        "2g1c",
+        "a$$",
         "acrotomophilia",
         "alabama hot pocket",
         "alaskan pipeline",
@@ -12,10 +12,13 @@
         "apeshit",
         "arsehole",
         "ass",
+        "asshat",
         "asshole",
         "assmunch",
+        "asswipe",
         "auto erotic",
         "autoerotic",
+        "b!tch",
         "babeland",
         "baby batter",
         "baby juice",
@@ -30,6 +33,7 @@
         "barely legal",
         "barenaked",
         "bastard",
+        "bastardized",
         "bastardo",
         "bastinado",
         "bbw",
@@ -50,9 +54,9 @@
         "black cock",
         "blonde action",
         "blonde on blonde action",
-        "blowjob",
         "blow job",
         "blow your load",
+        "blowjob",
         "blue waffle",
         "blumpkin",
         "bollocks",
@@ -63,6 +67,7 @@
         "booty call",
         "brown showers",
         "brunette action",
+        "bs",
         "bukkake",
         "bulldyke",
         "bullet vibe",
@@ -88,11 +93,12 @@
         "clusterfuck",
         "cock",
         "cocks",
+        "cocksucker",
+        "coon",
+        "coons",
         "coprolagnia",
         "coprophilia",
         "cornhole",
-        "coon",
-        "coons",
         "creampie",
         "cum",
         "cumming",
@@ -106,15 +112,16 @@
         "dendrophilia",
         "dick",
         "dildo",
-        "dingleberry",
         "dingleberries",
+        "dingleberry",
+        "dipshit",
         "dirty pillows",
         "dirty sanchez",
+        "dog style",
         "doggie style",
         "doggiestyle",
         "doggy style",
         "doggystyle",
-        "dog style",
         "dolcett",
         "domination",
         "dominatrix",
@@ -124,6 +131,7 @@
         "double penetration",
         "dp action",
         "dry hump",
+        "dumbass",
         "dvda",
         "eat my ass",
         "ecchi",
@@ -132,6 +140,8 @@
         "erotism",
         "escort",
         "eunuch",
+        "f*ck",
+        "f@ck",
         "faggot",
         "fecal",
         "felch",
@@ -148,12 +158,16 @@
         "frotting",
         "fuck",
         "fuck buttons",
+        "fucker",
+        "fuckface",
         "fuckin",
         "fucking",
         "fucktards",
         "fudge packer",
         "fudgepacker",
+        "fuq",
         "futanari",
+        "g-spot",
         "gang bang",
         "gay sex",
         "genitals",
@@ -166,18 +180,18 @@
         "god damn",
         "gokkun",
         "golden shower",
-        "goodpoop",
         "goo girl",
+        "goodpoop",
         "goregasm",
         "grope",
         "group sex",
-        "g-spot",
         "guro",
         "hand job",
         "handjob",
         "hard core",
         "hardcore",
         "hentai",
+        "hoe",
         "homoerotic",
         "honkey",
         "hooker",
@@ -190,6 +204,7 @@
         "incest",
         "intercourse",
         "jack off",
+        "jackass",
         "jail bait",
         "jailbait",
         "jelly donut",
@@ -207,12 +222,14 @@
         "leather restraint",
         "leather straight jacket",
         "lemon party",
+        "lmfao",
         "lolita",
         "lovemaking",
         "make me come",
         "male squirting",
         "masturbate",
         "menage a trois",
+        "mf",
         "milf",
         "missionary position",
         "motherfucker",
@@ -224,9 +241,9 @@
         "nawashi",
         "negro",
         "neonazi",
+        "nig nog",
         "nigga",
         "nigger",
-        "nig nog",
         "nimphomania",
         "nipple",
         "nipples",
@@ -236,6 +253,7 @@
         "nympho",
         "nymphomania",
         "octopussy",
+        "omfg",
         "omorashi",
         "one cup two girls",
         "one guy one jar",
@@ -251,8 +269,9 @@
         "penis",
         "phone sex",
         "piece of shit",
-        "pissing",
         "piss pig",
+        "pissed",
+        "pissing",
         "pisspig",
         "playboy",
         "pleasure chest",
@@ -261,7 +280,6 @@
         "poof",
         "poon",
         "poontang",
-        "punany",
         "poop chute",
         "poopchute",
         "porn",
@@ -270,6 +288,7 @@
         "prince albert piercing",
         "pthc",
         "pubes",
+        "punany",
         "pussy",
         "queaf",
         "queef",
@@ -280,12 +299,15 @@
         "raping",
         "rapist",
         "rectum",
+        "retard",
+        "retarded",
         "reverse cowgirl",
         "rimjob",
         "rimming",
         "rosy palm",
         "rosy palm and her 5 sisters",
         "rusty trombone",
+        "s&m",
         "sadism",
         "santorum",
         "scat",
@@ -295,19 +317,22 @@
         "sex",
         "sexo",
         "sexy",
+        "sh!t",
         "shaved beaver",
         "shaved pussy",
         "shemale",
         "shibari",
         "shit",
         "shitblimp",
+        "shithead",
+        "shitshow",
         "shitty",
         "shota",
         "shrimping",
+        "simp",
         "skeet",
         "slanteye",
         "slut",
-        "s&m",
         "smut",
         "snatch",
         "snowballing",
@@ -319,6 +344,7 @@
         "spooge",
         "spread legs",
         "spunk",
+        "stfu",
         "strap on",
         "strapon",
         "strappado",
@@ -333,6 +359,7 @@
         "tainted love",
         "taste my",
         "tea bagging",
+        "testbad01",
         "threesome",
         "throating",
         "tied up",
@@ -366,17 +393,18 @@
         "voyeur",
         "vulva",
         "wank",
-        "wetback",
         "wet dream",
+        "wetback",
         "white power",
         "wrapping men",
         "wrinkled starfish",
+        "wtf",
         "xx",
         "xxx",
         "yaoi",
         "yellow showers",
         "yiffy",
         "zoophilia",
-        "🖕"
+        "\ud83d\udd95"
     ]
 }

package/lib/cjs/filters/Filter.d.ts

@@ -1,5 +1,5 @@
-import { Language, CheckProfanityResult } from '../types/types';
-interface FilterConfig {
+import { Language, CheckProfanityResult, SeverityLevel } from '../types/types';
+export interface FilterConfig {
     languages?: Language[];
     allLanguages?: boolean;
     caseSensitive?: boolean;
@@ -9,7 +9,8 @@ interface FilterConfig {
     severityLevels?: boolean;
     ignoreWords?: string[];
     logProfanity?: boolean;
-    globalWhitelist?: string[];
+    allowObfuscatedMatch?: boolean;
+    fuzzyToleranceLevel?: number;
 }
 declare class Filter {
     private words;
@@ -19,14 +20,20 @@ declare class Filter {
     private severityLevels;
     private ignoreWords;
     private logProfanity;
-    private globalWhitelist;
+    private allowObfuscatedMatch;
+    private fuzzyToleranceLevel;
     constructor(config?: FilterConfig);
+    private debugLog;
+    private normalizeObfuscated;
     private getRegex;
-    private isFuzzyMatch;
-    private isMergedMatch;
+    private isFuzzyToleranceMatch;
     private evaluateSeverity;
     isProfane(value: string): boolean;
-    checkProfanityInSentence(text: string): CheckProfanityResult;
+    matches(word: string): boolean;
     checkProfanity(text: string): CheckProfanityResult;
+    checkProfanityWithMinSeverity(text: string, minSeverity?: SeverityLevel): {
+        filteredWords: string[];
+        result: CheckProfanityResult;
+    };
 }
 export { Filter };