glin-profanity 2.1.0 → 2.3.5

package/dist/index.d.cts

@@ -0,0 +1,120 @@
+/**
+ * Type definitions for glin-profanity JavaScript/TypeScript package.
+ * Unified API that mirrors the Python package structure.
+ */
+/** Severity levels for profanity matches - unified with Python */
+declare enum SeverityLevel {
+    EXACT = 1,
+    FUZZY = 2
+}
+/** Supported languages - unified list with Python */
+type Language = 'arabic' | 'chinese' | 'czech' | 'danish' | 'english' | 'esperanto' | 'finnish' | 'french' | 'german' | 'hindi' | 'hungarian' | 'italian' | 'japanese' | 'korean' | 'norwegian' | 'persian' | 'polish' | 'portuguese' | 'russian' | 'spanish' | 'swedish' | 'thai' | 'turkish';
+/** Represents a profanity match in text - unified with Python */
+interface Match {
+    word: string;
+    index: number;
+    severity: SeverityLevel;
+    contextScore?: number;
+    reason?: string;
+    isWhitelisted?: boolean;
+}
+/** Result of profanity check operation - unified field names */
+interface CheckProfanityResult {
+    containsProfanity: boolean;
+    profaneWords: string[];
+    processedText?: string;
+    severityMap?: Record<string, SeverityLevel>;
+    matches?: Match[];
+    contextScore?: number;
+    reason?: string;
+}
+/** Configuration for context-aware filtering - unified with Python */
+interface ContextAwareConfig {
+    enableContextAware?: boolean;
+    contextWindow?: number;
+    confidenceThreshold?: number;
+    domainWhitelists?: Record<string, string[]>;
+}
+/** Main filter configuration options - unified with Python */
+interface FilterConfig extends ContextAwareConfig {
+    languages?: Language[];
+    allLanguages?: boolean;
+    caseSensitive?: boolean;
+    wordBoundaries?: boolean;
+    customWords?: string[];
+    replaceWith?: string;
+    severityLevels?: boolean;
+    ignoreWords?: string[];
+    logProfanity?: boolean;
+    allowObfuscatedMatch?: boolean;
+    fuzzyToleranceLevel?: number;
+}
+/** Result with minimum severity filtering */
+interface FilteredProfanityResult {
+    result: CheckProfanityResult;
+    filteredWords: string[];
+}
+
+interface ProfanityCheckerConfig {
+    languages?: Language[];
+    allLanguages?: boolean;
+    caseSensitive?: boolean;
+    wordBoundaries?: boolean;
+    customWords?: string[];
+    replaceWith?: string;
+    severityLevels?: boolean;
+    allowObfuscatedMatch?: boolean;
+    fuzzyToleranceLevel?: number;
+    minSeverity?: SeverityLevel;
+    autoReplace?: boolean;
+    customActions?: (result: CheckProfanityResult) => void;
+}
+interface ProfanityCheckResult extends CheckProfanityResult {
+    filteredWords: string[];
+    autoReplaced: string;
+}
+
+declare function checkProfanity(text: string, config?: ProfanityCheckerConfig): ProfanityCheckResult;
+declare function checkProfanityAsync(text: string, config?: ProfanityCheckerConfig): Promise<ProfanityCheckResult>;
+declare function isWordProfane(word: string, config?: ProfanityCheckerConfig): boolean;
+
+declare const useProfanityChecker: (config?: ProfanityCheckerConfig) => {
+    result: CheckProfanityResult;
+    checkText: (text: string) => ProfanityCheckResult;
+    checkTextAsync: (text: string) => Promise<ProfanityCheckResult>;
+    reset: () => void;
+    isDirty: boolean;
+    isWordProfane: (word: string) => boolean;
+};
+
+declare class Filter {
+    private words;
+    private caseSensitive;
+    private wordBoundaries;
+    private replaceWith?;
+    private severityLevels;
+    private ignoreWords;
+    private logProfanity;
+    private allowObfuscatedMatch;
+    private fuzzyToleranceLevel;
+    private enableContextAware;
+    private contextWindow;
+    private confidenceThreshold;
+    private contextAnalyzer?;
+    private primaryLanguage;
+    constructor(config?: FilterConfig);
+    private debugLog;
+    private normalizeObfuscated;
+    private getRegex;
+    private isFuzzyToleranceMatch;
+    private evaluateSeverity;
+    isProfane(value: string): boolean;
+    matches(word: string): boolean;
+    checkProfanity(text: string): CheckProfanityResult;
+    checkProfanityWithMinSeverity(text: string, minSeverity?: SeverityLevel): {
+        filteredWords: string[];
+        result: CheckProfanityResult;
+    };
+}
+
+export { type CheckProfanityResult, type ContextAwareConfig, Filter, type FilterConfig, type FilteredProfanityResult, type Language, type Match, type ProfanityCheckResult, type ProfanityCheckerConfig, SeverityLevel, checkProfanity, checkProfanityAsync, isWordProfane, useProfanityChecker };

package/dist/index.d.ts

@@ -0,0 +1,120 @@
+/**
+ * Type definitions for glin-profanity JavaScript/TypeScript package.
+ * Unified API that mirrors the Python package structure.
+ */
+/** Severity levels for profanity matches - unified with Python */
+declare enum SeverityLevel {
+    EXACT = 1,
+    FUZZY = 2
+}
+/** Supported languages - unified list with Python */
+type Language = 'arabic' | 'chinese' | 'czech' | 'danish' | 'english' | 'esperanto' | 'finnish' | 'french' | 'german' | 'hindi' | 'hungarian' | 'italian' | 'japanese' | 'korean' | 'norwegian' | 'persian' | 'polish' | 'portuguese' | 'russian' | 'spanish' | 'swedish' | 'thai' | 'turkish';
+/** Represents a profanity match in text - unified with Python */
+interface Match {
+    word: string;
+    index: number;
+    severity: SeverityLevel;
+    contextScore?: number;
+    reason?: string;
+    isWhitelisted?: boolean;
+}
+/** Result of profanity check operation - unified field names */
+interface CheckProfanityResult {
+    containsProfanity: boolean;
+    profaneWords: string[];
+    processedText?: string;
+    severityMap?: Record<string, SeverityLevel>;
+    matches?: Match[];
+    contextScore?: number;
+    reason?: string;
+}
+/** Configuration for context-aware filtering - unified with Python */
+interface ContextAwareConfig {
+    enableContextAware?: boolean;
+    contextWindow?: number;
+    confidenceThreshold?: number;
+    domainWhitelists?: Record<string, string[]>;
+}
+/** Main filter configuration options - unified with Python */
+interface FilterConfig extends ContextAwareConfig {
+    languages?: Language[];
+    allLanguages?: boolean;
+    caseSensitive?: boolean;
+    wordBoundaries?: boolean;
+    customWords?: string[];
+    replaceWith?: string;
+    severityLevels?: boolean;
+    ignoreWords?: string[];
+    logProfanity?: boolean;
+    allowObfuscatedMatch?: boolean;
+    fuzzyToleranceLevel?: number;
+}
+/** Result with minimum severity filtering */
+interface FilteredProfanityResult {
+    result: CheckProfanityResult;
+    filteredWords: string[];
+}
+
+interface ProfanityCheckerConfig {
+    languages?: Language[];
+    allLanguages?: boolean;
+    caseSensitive?: boolean;
+    wordBoundaries?: boolean;
+    customWords?: string[];
+    replaceWith?: string;
+    severityLevels?: boolean;
+    allowObfuscatedMatch?: boolean;
+    fuzzyToleranceLevel?: number;
+    minSeverity?: SeverityLevel;
+    autoReplace?: boolean;
+    customActions?: (result: CheckProfanityResult) => void;
+}
+interface ProfanityCheckResult extends CheckProfanityResult {
+    filteredWords: string[];
+    autoReplaced: string;
+}
+
+declare function checkProfanity(text: string, config?: ProfanityCheckerConfig): ProfanityCheckResult;
+declare function checkProfanityAsync(text: string, config?: ProfanityCheckerConfig): Promise<ProfanityCheckResult>;
+declare function isWordProfane(word: string, config?: ProfanityCheckerConfig): boolean;
+
+declare const useProfanityChecker: (config?: ProfanityCheckerConfig) => {
+    result: CheckProfanityResult;
+    checkText: (text: string) => ProfanityCheckResult;
+    checkTextAsync: (text: string) => Promise<ProfanityCheckResult>;
+    reset: () => void;
+    isDirty: boolean;
+    isWordProfane: (word: string) => boolean;
+};
+
+declare class Filter {
+    private words;
+    private caseSensitive;
+    private wordBoundaries;
+    private replaceWith?;
+    private severityLevels;
+    private ignoreWords;
+    private logProfanity;
+    private allowObfuscatedMatch;
+    private fuzzyToleranceLevel;
+    private enableContextAware;
+    private contextWindow;
+    private confidenceThreshold;
+    private contextAnalyzer?;
+    private primaryLanguage;
+    constructor(config?: FilterConfig);
+    private debugLog;
+    private normalizeObfuscated;
+    private getRegex;
+    private isFuzzyToleranceMatch;
+    private evaluateSeverity;
+    isProfane(value: string): boolean;
+    matches(word: string): boolean;
+    checkProfanity(text: string): CheckProfanityResult;
+    checkProfanityWithMinSeverity(text: string, minSeverity?: SeverityLevel): {
+        filteredWords: string[];
+        result: CheckProfanityResult;
+    };
+}
+
+export { type CheckProfanityResult, type ContextAwareConfig, Filter, type FilterConfig, type FilteredProfanityResult, type Language, type Match, type ProfanityCheckResult, type ProfanityCheckerConfig, SeverityLevel, checkProfanity, checkProfanityAsync, isWordProfane, useProfanityChecker };