glin-profanity 3.1.5 → 3.2.2

package/dist/types-B9c_ik4k.d.cts

@@ -0,0 +1,88 @@
+/**
+ * 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' | 'dutch' | '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[]>;
+}
+/** Leetspeak detection intensity levels */
+type LeetspeakLevel = 'basic' | 'moderate' | 'aggressive';
+/** 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;
+    /**
+     * Enable leetspeak detection (e.g., "f4ck" → "fuck").
+     * @default false
+     */
+    detectLeetspeak?: boolean;
+    /**
+     * Leetspeak detection intensity level.
+     * - `basic`: Numbers only (0→o, 1→i, 3→e, 4→a, 5→s)
+     * - `moderate`: Basic + symbols (@→a, $→s, !→i)
+     * - `aggressive`: All known substitutions
+     * @default 'moderate'
+     */
+    leetspeakLevel?: LeetspeakLevel;
+    /**
+     * Enable Unicode normalization to detect homoglyphs and obfuscation.
+     * @default true
+     */
+    normalizeUnicode?: boolean;
+    /**
+     * Cache profanity check results for repeated strings.
+     * @default false
+     */
+    cacheResults?: boolean;
+    /**
+     * Maximum cache size when caching is enabled.
+     * @default 1000
+     */
+    maxCacheSize?: number;
+}
+/** Result with minimum severity filtering */
+interface FilteredProfanityResult {
+    result: CheckProfanityResult;
+    filteredWords: string[];
+}
+
+export { type CheckProfanityResult as C, type FilterConfig as F, type Language as L, type Match as M, SeverityLevel as S, type FilteredProfanityResult as a, type ContextAwareConfig as b };

package/dist/types-B9c_ik4k.d.ts

@@ -0,0 +1,88 @@
+/**
+ * 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' | 'dutch' | '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[]>;
+}
+/** Leetspeak detection intensity levels */
+type LeetspeakLevel = 'basic' | 'moderate' | 'aggressive';
+/** 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;
+    /**
+     * Enable leetspeak detection (e.g., "f4ck" → "fuck").
+     * @default false
+     */
+    detectLeetspeak?: boolean;
+    /**
+     * Leetspeak detection intensity level.
+     * - `basic`: Numbers only (0→o, 1→i, 3→e, 4→a, 5→s)
+     * - `moderate`: Basic + symbols (@→a, $→s, !→i)
+     * - `aggressive`: All known substitutions
+     * @default 'moderate'
+     */
+    leetspeakLevel?: LeetspeakLevel;
+    /**
+     * Enable Unicode normalization to detect homoglyphs and obfuscation.
+     * @default true
+     */
+    normalizeUnicode?: boolean;
+    /**
+     * Cache profanity check results for repeated strings.
+     * @default false
+     */
+    cacheResults?: boolean;
+    /**
+     * Maximum cache size when caching is enabled.
+     * @default 1000
+     */
+    maxCacheSize?: number;
+}
+/** Result with minimum severity filtering */
+interface FilteredProfanityResult {
+    result: CheckProfanityResult;
+    filteredWords: string[];
+}
+
+export { type CheckProfanityResult as C, type FilterConfig as F, type Language as L, type Match as M, SeverityLevel as S, type FilteredProfanityResult as a, type ContextAwareConfig as b };

package/dist/types-BuKh9tvV.d.ts

@@ -0,0 +1,20 @@
+import { F as FilterConfig, S as SeverityLevel, C as CheckProfanityResult } from './types-B9c_ik4k.js';
+
+/**
+ * Configuration options for the profanity checker hook and functions.
+ * Extends FilterConfig with additional convenience options for V3 features.
+ */
+interface ProfanityCheckerConfig extends Omit<FilterConfig, 'logProfanity'> {
+    /** Minimum severity level to include in results */
+    minSeverity?: SeverityLevel;
+    /** Auto-replace profanity with replaceWith string */
+    autoReplace?: boolean;
+    /** Custom callback when profanity is detected */
+    customActions?: (result: CheckProfanityResult) => void;
+}
+interface ProfanityCheckResult extends CheckProfanityResult {
+    filteredWords: string[];
+    autoReplaced: string;
+}
+
+export type { ProfanityCheckerConfig as P, ProfanityCheckResult as a };

package/dist/types-Ct_ueYqw.d.cts

@@ -0,0 +1,76 @@
+/**
+ * Type definitions for ML-based profanity detection.
+ */
+/**
+ * Toxicity categories detected by the TensorFlow.js model.
+ * These map to the civil comments dataset labels.
+ */
+type ToxicityLabel = 'identity_attack' | 'insult' | 'obscene' | 'severe_toxicity' | 'sexual_explicit' | 'threat' | 'toxicity';
+/**
+ * Result from a single toxicity prediction.
+ */
+interface ToxicityPrediction {
+    /** The toxicity category */
+    label: ToxicityLabel;
+    /** Whether the text matches this category (null if below threshold) */
+    match: boolean | null;
+    /** Probability scores [non-toxic, toxic] */
+    probabilities: [number, number];
+}
+/**
+ * Result from ML-based toxicity analysis.
+ */
+interface MLAnalysisResult {
+    /** Whether any toxicity was detected */
+    isToxic: boolean;
+    /** Overall toxicity score (0-1) */
+    overallScore: number;
+    /** Predictions for each category */
+    predictions: ToxicityPrediction[];
+    /** Categories that matched */
+    matchedCategories: ToxicityLabel[];
+    /** Processing time in milliseconds */
+    processingTimeMs: number;
+}
+/**
+ * Configuration for the ML toxicity detector.
+ */
+interface MLDetectorConfig {
+    /**
+     * Minimum confidence threshold for predictions.
+     * Values below this threshold will return null for match.
+     * @default 0.85
+     */
+    threshold?: number;
+    /**
+     * Specific toxicity categories to check.
+     * If not specified, all categories are checked.
+     */
+    labels?: ToxicityLabel[];
+    /**
+     * Whether to load the model immediately on instantiation.
+     * If false, model will be loaded on first use.
+     * @default false
+     */
+    preloadModel?: boolean;
+}
+/**
+ * Combined result from both rule-based and ML detection.
+ */
+interface HybridAnalysisResult {
+    /** Rule-based detection result */
+    ruleBasedResult: {
+        containsProfanity: boolean;
+        profaneWords: string[];
+    };
+    /** ML-based detection result (null if ML not enabled) */
+    mlResult: MLAnalysisResult | null;
+    /** Combined decision */
+    isToxic: boolean;
+    /** Confidence score for the decision */
+    confidence: number;
+    /** Reason for the decision */
+    reason: string;
+}
+
+export type { HybridAnalysisResult as H, MLDetectorConfig as M, ToxicityLabel as T, MLAnalysisResult as a, ToxicityPrediction as b };

package/dist/types-Ct_ueYqw.d.ts

@@ -0,0 +1,76 @@
+/**
+ * Type definitions for ML-based profanity detection.
+ */
+/**
+ * Toxicity categories detected by the TensorFlow.js model.
+ * These map to the civil comments dataset labels.
+ */
+type ToxicityLabel = 'identity_attack' | 'insult' | 'obscene' | 'severe_toxicity' | 'sexual_explicit' | 'threat' | 'toxicity';
+/**
+ * Result from a single toxicity prediction.
+ */
+interface ToxicityPrediction {
+    /** The toxicity category */
+    label: ToxicityLabel;
+    /** Whether the text matches this category (null if below threshold) */
+    match: boolean | null;
+    /** Probability scores [non-toxic, toxic] */
+    probabilities: [number, number];
+}
+/**
+ * Result from ML-based toxicity analysis.
+ */
+interface MLAnalysisResult {
+    /** Whether any toxicity was detected */
+    isToxic: boolean;
+    /** Overall toxicity score (0-1) */
+    overallScore: number;
+    /** Predictions for each category */
+    predictions: ToxicityPrediction[];
+    /** Categories that matched */
+    matchedCategories: ToxicityLabel[];
+    /** Processing time in milliseconds */
+    processingTimeMs: number;
+}
+/**
+ * Configuration for the ML toxicity detector.
+ */
+interface MLDetectorConfig {
+    /**
+     * Minimum confidence threshold for predictions.
+     * Values below this threshold will return null for match.
+     * @default 0.85
+     */
+    threshold?: number;
+    /**
+     * Specific toxicity categories to check.
+     * If not specified, all categories are checked.
+     */
+    labels?: ToxicityLabel[];
+    /**
+     * Whether to load the model immediately on instantiation.
+     * If false, model will be loaded on first use.
+     * @default false
+     */
+    preloadModel?: boolean;
+}
+/**
+ * Combined result from both rule-based and ML detection.
+ */
+interface HybridAnalysisResult {
+    /** Rule-based detection result */
+    ruleBasedResult: {
+        containsProfanity: boolean;
+        profaneWords: string[];
+    };
+    /** ML-based detection result (null if ML not enabled) */
+    mlResult: MLAnalysisResult | null;
+    /** Combined decision */
+    isToxic: boolean;
+    /** Confidence score for the decision */
+    confidence: number;
+    /** Reason for the decision */
+    reason: string;
+}
+
+export type { HybridAnalysisResult as H, MLDetectorConfig as M, ToxicityLabel as T, MLAnalysisResult as a, ToxicityPrediction as b };

package/dist/types-DI8nzwWc.d.cts

@@ -0,0 +1,20 @@
+import { F as FilterConfig, S as SeverityLevel, C as CheckProfanityResult } from './types-B9c_ik4k.cjs';
+
+/**
+ * Configuration options for the profanity checker hook and functions.
+ * Extends FilterConfig with additional convenience options for V3 features.
+ */
+interface ProfanityCheckerConfig extends Omit<FilterConfig, 'logProfanity'> {
+    /** Minimum severity level to include in results */
+    minSeverity?: SeverityLevel;
+    /** Auto-replace profanity with replaceWith string */
+    autoReplace?: boolean;
+    /** Custom callback when profanity is detected */
+    customActions?: (result: CheckProfanityResult) => void;
+}
+interface ProfanityCheckResult extends CheckProfanityResult {
+    filteredWords: string[];
+    autoReplaced: string;
+}
+
+export type { ProfanityCheckerConfig as P, ProfanityCheckResult as a };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "glin-profanity",
-  "version": "3.1.5",
+  "version": "3.2.2",
   "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.",
   "type": "module",
   "main": "dist/index.js",
@@ -17,6 +17,16 @@
         "default": "./dist/index.js"
       }
     },
+    "./react": {
+      "require": {
+        "types": "./dist/react.d.cts",
+        "default": "./dist/react.cjs"
+      },
+      "import": {
+        "types": "./dist/react.d.ts",
+        "default": "./dist/react.js"
+      }
+    },
     "./ml": {
       "require": {
         "types": "./dist/ml/index.d.cts",
@@ -26,12 +36,128 @@
         "types": "./dist/ml/index.d.ts",
         "default": "./dist/ml/index.js"
       }
+    },
+    "./ai": {
+      "require": {
+        "types": "./dist/integrations/index.d.cts",
+        "default": "./dist/integrations/index.cjs"
+      },
+      "import": {
+        "types": "./dist/integrations/index.d.ts",
+        "default": "./dist/integrations/index.js"
+      }
+    },
+    "./ai/openai": {
+      "require": {
+        "types": "./dist/integrations/openai.d.cts",
+        "default": "./dist/integrations/openai.cjs"
+      },
+      "import": {
+        "types": "./dist/integrations/openai.d.ts",
+        "default": "./dist/integrations/openai.js"
+      }
+    },
+    "./ai/langchain": {
+      "require": {
+        "types": "./dist/integrations/langchain.d.cts",
+        "default": "./dist/integrations/langchain.cjs"
+      },
+      "import": {
+        "types": "./dist/integrations/langchain.d.ts",
+        "default": "./dist/integrations/langchain.js"
+      }
+    },
+    "./ai/vercel": {
+      "require": {
+        "types": "./dist/integrations/vercel-ai.d.cts",
+        "default": "./dist/integrations/vercel-ai.cjs"
+      },
+      "import": {
+        "types": "./dist/integrations/vercel-ai.d.ts",
+        "default": "./dist/integrations/vercel-ai.js"
+      }
+    },
+    "./ai/semantic": {
+      "require": {
+        "types": "./dist/integrations/semantic.d.cts",
+        "default": "./dist/integrations/semantic.cjs"
+      },
+      "import": {
+        "types": "./dist/integrations/semantic.d.ts",
+        "default": "./dist/integrations/semantic.js"
+      }
+    },
+    "./ml/transformers": {
+      "require": {
+        "types": "./dist/ml/transformers.d.cts",
+        "default": "./dist/ml/transformers.cjs"
+      },
+      "import": {
+        "types": "./dist/ml/transformers.d.ts",
+        "default": "./dist/ml/transformers.js"
+      }
+    },
+    "./multimodal": {
+      "require": {
+        "types": "./dist/multimodal/index.d.cts",
+        "default": "./dist/multimodal/index.cjs"
+      },
+      "import": {
+        "types": "./dist/multimodal/index.d.ts",
+        "default": "./dist/multimodal/index.js"
+      }
+    },
+    "./ocr": {
+      "require": {
+        "types": "./dist/multimodal/ocr.d.cts",
+        "default": "./dist/multimodal/ocr.cjs"
+      },
+      "import": {
+        "types": "./dist/multimodal/ocr.d.ts",
+        "default": "./dist/multimodal/ocr.js"
+      }
+    },
+    "./audio": {
+      "require": {
+        "types": "./dist/multimodal/audio.d.cts",
+        "default": "./dist/multimodal/audio.cjs"
+      },
+      "import": {
+        "types": "./dist/multimodal/audio.d.ts",
+        "default": "./dist/multimodal/audio.js"
+      }
+    },
+    "./frameworks": {
+      "require": {
+        "types": "./dist/frameworks/index.d.cts",
+        "default": "./dist/frameworks/index.cjs"
+      },
+      "import": {
+        "types": "./dist/frameworks/index.d.ts",
+        "default": "./dist/frameworks/index.js"
+      }
+    },
+    "./nextjs": {
+      "require": {
+        "types": "./dist/frameworks/nextjs.d.cts",
+        "default": "./dist/frameworks/nextjs.cjs"
+      },
+      "import": {
+        "types": "./dist/frameworks/nextjs.d.ts",
+        "default": "./dist/frameworks/nextjs.js"
+      }
     }
   },
   "peerDependencies": {
     "react": ">=16.8.0",
     "@tensorflow-models/toxicity": ">=1.2.0",
-    "@tensorflow/tfjs": ">=4.0.0"
+    "@tensorflow/tfjs": ">=4.0.0",
+    "zod": ">=3.0.0",
+    "openai": ">=4.0.0",
+    "@langchain/core": ">=0.1.0",
+    "ai": ">=3.0.0",
+    "@xenova/transformers": ">=2.0.0",
+    "tesseract.js": ">=5.0.0"
   },
   "peerDependenciesMeta": {
     "react": {
@@ -42,6 +168,24 @@
     },
     "@tensorflow-models/toxicity": {
       "optional": true
+    },
+    "zod": {
+      "optional": true
+    },
+    "openai": {
+      "optional": true
+    },
+    "@langchain/core": {
+      "optional": true
+    },
+    "ai": {
+      "optional": true
+    },
+    "@xenova/transformers": {
+      "optional": true
+    },
+    "tesseract.js": {
+      "optional": true
     }
   },
   "files": [
@@ -105,6 +249,14 @@
     "profanity-moderation-framework",
     "profanity-moderation-plugin",
     "profanity-moderation-module",
+    "openai",
+    "openai-function-calling",
+    "langchain",
+    "langchain-tool",
+    "vercel-ai",
+    "ai-sdk",
+    "semantic-analysis",
+    "embeddings",
     "tensorflow",
     "tensorflowjs",
     "ml",
@@ -115,7 +267,22 @@
     "neural-network",
     "leetspeak",
     "unicode",
-    "homoglyph"
+    "homoglyph",
+    "transformers",
+    "transformers-js",
+    "huggingface",
+    "onnx",
+    "ocr",
+    "tesseract",
+    "image-moderation",
+    "audio-moderation",
+    "speech-to-text",
+    "whisper",
+    "nextjs",
+    "nextjs-middleware",
+    "server-actions",
+    "content-moderation",
+    "multimodal"
   ],
   "author": "glinr",
   "license": "ISC",