glin-profanity 1.1.9 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -7,34 +7,55 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
7
7
  step((generator = generator.apply(thisArg, _arguments || [])).next());
8
8
  });
9
9
  };
10
- import { useState } from 'react';
10
+ import { useMemo, useState } from 'react';
11
11
  import { Filter } from '../filters/Filter';
12
12
  import globalWhitelistData from '../data/globalWhitelist.json';
13
13
  export const useProfanityChecker = (config) => {
14
+ var _a;
14
15
  const [result, setResult] = useState(null);
15
- const filterConfig = Object.assign(Object.assign({}, config), { globalWhitelist: globalWhitelistData.whitelist });
16
- const filter = new Filter(filterConfig);
16
+ const filterConfig = useMemo(() => {
17
+ var _a;
18
+ const effective = Object.assign(Object.assign({}, (config !== null && config !== void 0 ? config : {})), { ignoreWords: globalWhitelistData.whitelist, fuzzyToleranceLevel: (_a = config === null || config === void 0 ? void 0 : config.fuzzyToleranceLevel) !== null && _a !== void 0 ? _a : 0.8 });
19
+ if (effective.allowObfuscatedMatch && effective.wordBoundaries) {
20
+ console.warn('[Glin-Profanity] Obfuscated match enabled → wordBoundaries will be ignored internally.');
21
+ }
22
+ return effective;
23
+ }, [config]);
24
+ const filter = useMemo(() => new Filter(filterConfig), [filterConfig]);
17
25
  const checkText = (text) => {
26
+ var _a;
18
27
  const checkResult = filter.checkProfanity(text);
28
+ // Filter based on minSeverity (if provided)
29
+ const filteredWords = (config === null || config === void 0 ? void 0 : config.minSeverity) && checkResult.severityMap
30
+ ? checkResult.profaneWords.filter((word) => checkResult.severityMap &&
31
+ checkResult.severityMap[word] >= config.minSeverity)
32
+ : checkResult.profaneWords;
33
+ // Optional auto-replace
34
+ const autoReplaced = (config === null || config === void 0 ? void 0 : config.autoReplace) && checkResult.processedText
35
+ ? checkResult.processedText
36
+ : text;
19
37
  setResult(checkResult);
20
- if (config === null || config === void 0 ? void 0 : config.customActions) {
21
- config.customActions(checkResult);
22
- }
38
+ (_a = config === null || config === void 0 ? void 0 : config.customActions) === null || _a === void 0 ? void 0 : _a.call(config, checkResult);
39
+ return Object.assign(Object.assign({}, checkResult), { filteredWords,
40
+ autoReplaced });
23
41
  };
24
42
  const checkTextAsync = (text) => __awaiter(void 0, void 0, void 0, function* () {
25
43
  return new Promise((resolve) => {
26
- const checkResult = filter.checkProfanity(text);
27
- setResult(checkResult);
28
- if (config === null || config === void 0 ? void 0 : config.customActions) {
29
- config.customActions(checkResult);
30
- }
44
+ const checkResult = checkText(text); // sync call
31
45
  resolve(checkResult);
32
46
  });
33
47
  });
48
+ const isWordProfane = (word) => {
49
+ return filter.checkProfanity(word).containsProfanity;
50
+ };
51
+ const reset = () => setResult(null);
34
52
  return {
35
53
  result,
36
54
  checkText,
37
55
  checkTextAsync,
56
+ reset,
57
+ isDirty: (_a = result === null || result === void 0 ? void 0 : result.containsProfanity) !== null && _a !== void 0 ? _a : false,
58
+ isWordProfane,
38
59
  };
39
60
  };
40
61
  //# sourceMappingURL=useProfanityChecker.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"useProfanityChecker.js","sourceRoot":"","sources":["../../../src/hooks/useProfanityChecker.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACjC,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAE3C,OAAO,mBAAmB,MAAM,8BAA8B,CAAC;AAa/D,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,MAA+B,EAAE,EAAE;IACrE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,QAAQ,CAA8B,IAAI,CAAC,CAAC;IACxE,MAAM,YAAY,mCACb,MAAM,KACT,eAAe,EAAE,mBAAmB,CAAC,SAAS,GAC/C,CAAC;IAEF,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,YAAY,CAAC,CAAC;IAExC,MAAM,SAAS,GAAG,CAAC,IAAY,EAAE,EAAE;QACjC,MAAM,WAAW,GAAG,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QAChD,SAAS,CAAC,WAAW,CAAC,CAAC;QACvB,IAAI,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,aAAa,EAAE,CAAC;YAC1B,MAAM,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;QACpC,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,cAAc,GAAG,CAAO,IAAY,EAAE,EAAE;QAC5C,OAAO,IAAI,OAAO,CAAuB,CAAC,OAAO,EAAE,EAAE;YACnD,MAAM,WAAW,GAAG,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;YAChD,SAAS,CAAC,WAAW,CAAC,CAAC;YACvB,IAAI,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,aAAa,EAAE,CAAC;gBAC1B,MAAM,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;YACpC,CAAC;YACD,OAAO,CAAC,WAAW,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC,CAAA,CAAC;IAEF,OAAO;QACL,MAAM;QACN,SAAS;QACT,cAAc;KACf,CAAC;AACJ,CAAC,CAAC"}
1
+ {"version":3,"file":"useProfanityChecker.js","sourceRoot":"","sources":["../../../src/hooks/useProfanityChecker.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAC1C,OAAO,EAAE,MAAM,EAAgB,MAAM,mBAAmB,CAAC;AAEzD,OAAO,mBAAmB,MAAM,8BAA8B,CAAC;AAiB/D,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,MAA+B,EAAE,EAAE;;IACrE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,QAAQ,CAA8B,IAAI,CAAC,CAAC;IAExE,MAAM,YAAY,GAAiB,OAAO,CAAC,GAAG,EAAE;;QAC9C,MAAM,SAAS,mCACV,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,KACjB,WAAW,EAAE,mBAAmB,CAAC,SAAS,EAC1C,mBAAmB,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,mBAAmB,mCAAI,GAAG,GACxD,CAAC;QAEF,IAAI,SAAS,CAAC,oBAAoB,IAAI,SAAS,CAAC,cAAc,EAAE,CAAC;YAC/D,OAAO,CAAC,IAAI,CACV,wFAAwF,CACzF,CAAC;QACJ,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAEb,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC;IAEvE,MAAM,SAAS,GAAG,CAAC,IAAY,EAAE,EAAE;;QACjC,MAAM,WAAW,GAAG,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QAEhD,4CAA4C;QAC5C,MAAM,aAAa,GACjB,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,WAAW,KAAI,WAAW,CAAC,WAAW;YAC5C,CAAC,CAAC,WAAW,CAAC,YAAY,CAAC,MAAM,CAC7B,CAAC,IAAI,EAAE,EAAE,CACP,WAAW,CAAC,WAAW;gBACvB,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,WAAY,CACvD;YACH,CAAC,CAAC,WAAW,CAAC,YAAY,CAAC;QAE/B,wBAAwB;QACxB,MAAM,YAAY,GAChB,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,WAAW,KAAI,WAAW,CAAC,aAAa;YAC9C,CAAC,CAAC,WAAW,CAAC,aAAa;YAC3B,CAAC,CAAC,IAAI,CAAC;QAEX,SAAS,CAAC,WAAW,CAAC,CAAC;QACvB,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,aAAa,uDAAG,WAAW,CAAC,CAAC;QAErC,uCACK,WAAW,KACd,aAAa;YACb,YAAY,IACZ;IACJ,CAAC,CAAC;IAEF,MAAM,cAAc,GAAG,CAAO,IAAY,EAAE,EAAE;QAC5C,OAAO,IAAI,OAAO,CAAuB,CAAC,OAAO,EAAE,EAAE;YACnD,MAAM,WAAW,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY;YACjD,OAAO,CAAC,WAAW,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC,CAAA,CAAC;IAEF,MAAM,aAAa,GAAG,CAAC,IAAY,EAAE,EAAE;QACrC,OAAO,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,iBAAiB,CAAC;IACvD,CAAC,CAAC;IAEF,MAAM,KAAK,GAAG,GAAG,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAEpC,OAAO;QACL,MAAM;QACN,SAAS;QACT,cAAc;QACd,KAAK;QACL,OAAO,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,iBAAiB,mCAAI,KAAK;QAC3C,aAAa;KACd,CAAC;AACJ,CAAC,CAAC"}
@@ -1,3 +1,4 @@
1
1
  export { Filter } from './filters/Filter';
2
2
  export { useProfanityChecker } from './hooks/useProfanityChecker';
3
+ export { SeverityLevel } from './types/types';
3
4
  export type { Language, CheckProfanityResult } from './types/types';
package/lib/esm/index.js CHANGED
@@ -1,3 +1,4 @@
1
1
  export { Filter } from './filters/Filter';
2
2
  export { useProfanityChecker } from './hooks/useProfanityChecker';
3
+ export { SeverityLevel } from './types/types';
3
4
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC"}
@@ -1,9 +1,21 @@
1
+ export declare enum SeverityLevel {
2
+ Exact = 1,
3
+ Fuzzy = 2,
4
+ Merged = 3
5
+ }
6
+ export type SeverityLabel = keyof typeof SeverityLevel;
7
+ export interface FilteredProfanityResult {
8
+ result: CheckProfanityResult;
9
+ filteredWords: string[];
10
+ }
1
11
  export interface CheckProfanityResult {
2
12
  containsProfanity: boolean;
3
13
  profaneWords: string[];
4
14
  processedText?: string;
5
- severityMap?: {
6
- [word: string]: number;
7
- };
15
+ severityMap?: Record<string, SeverityLevel>;
16
+ matchContexts?: {
17
+ word: string;
18
+ context: string;
19
+ }[];
8
20
  }
9
21
  export type Language = 'arabic' | 'chinese' | 'czech' | 'danish' | 'english' | 'esperanto' | 'finnish' | 'french' | 'german' | 'hindi' | 'hungarian' | 'italian' | 'japanese' | 'korean' | 'norwegian' | 'persian' | 'polish' | 'portuguese' | 'russian' | 'turkish' | 'swedish' | 'thai';
@@ -1,2 +1,8 @@
1
- export {};
1
+ // src/types/types.ts
2
+ export var SeverityLevel;
3
+ (function (SeverityLevel) {
4
+ SeverityLevel[SeverityLevel["Exact"] = 1] = "Exact";
5
+ SeverityLevel[SeverityLevel["Fuzzy"] = 2] = "Fuzzy";
6
+ SeverityLevel[SeverityLevel["Merged"] = 3] = "Merged";
7
+ })(SeverityLevel || (SeverityLevel = {}));
2
8
  //# sourceMappingURL=types.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/types/types.ts"],"names":[],"mappings":""}
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/types/types.ts"],"names":[],"mappings":"AAAA,qBAAqB;AACrB,MAAM,CAAN,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,mDAAS,CAAA;IACT,mDAAS,CAAA;IACT,qDAAU,CAAA;AACZ,CAAC,EAJW,aAAa,KAAb,aAAa,QAIxB"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "glin-profanity",
3
- "version": "1.1.9",
3
+ "version": "2.1.0",
4
4
  "description": "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.",
5
5
  "main": "lib/cjs/index.js",
6
6
  "module": "lib/esm/index.js",
@@ -56,8 +56,21 @@
56
56
  "profane-word-filter",
57
57
  "profane-word-detection",
58
58
  "moderation",
59
- "moderate"
59
+ "moderate",
60
+ "glinr",
61
+ "profanity-checker",
62
+ "profanity-filter",
63
+ "profanity-check",
64
+ "profanity-moderation",
65
+ "profanity-moderation-tool",
66
+ "profanity-moderation-library",
67
+ "profanity-moderation-service",
68
+ "profanity-moderation-api",
69
+ "profanity-moderation-toolkit",
70
+ "profanity-moderation-framework",
71
+ "profanity-moderation-plugin",
72
+ "profanity-moderation-module"
60
73
  ],
61
- "author": "gdsks",
74
+ "author": "glinr",
62
75
  "license": "ISC"
63
- }
76
+ }