Types Shipping

.gitignore

@@ -9,7 +9,7 @@ build/
 
 # TypeScript compiled output
 *.tsbuildinfo
-
+!src/index.d.ts
 # Logs
 logs/
 *.log

package.json

@@ -2,8 +2,8 @@
   "name": "glin-profanity",
   "version": "1.1.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.",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "dist/index.js", 
+  "types": "lib/index.d.ts",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "start": "webpack serve --mode development",

src/index.d.ts

@@ -0,0 +1,36 @@
+declare module 'glin-profanity' {
+    export type Language = 'english' | 'french' | 'spanish' | 'german' | 'italian' | 'portuguese' | 'russian' | 'japanese' | 'chinese' | 'korean';
+
+    export interface CheckProfanityResult {
+      containsProfanity: boolean;
+      profaneWords: string[];
+      processedText?: string;
+      severityMap?: { [word: string]: number };
+    }
+
+    export interface ProfanityCheckerConfig {
+      languages?: Language[];
+      allLanguages?: boolean;
+      caseSensitive?: boolean;
+      wordBoundaries?: boolean;
+      customWords?: string[];
+      replaceWith?: string;
+      severityLevels?: boolean;
+      ignoreWords?: string[];
+      logProfanity?: boolean;
+      customActions?: (result: CheckProfanityResult) => void;
+    }
+
+    export class Filter {
+      constructor(config?: ProfanityCheckerConfig);
+      isProfane(value: string): boolean;
+      checkProfanity(text: string): CheckProfanityResult;
+    }
+
+    export function useProfanityChecker(config?: ProfanityCheckerConfig): {
+      result: CheckProfanityResult | null;
+      checkText: (text: string) => void;
+      checkTextAsync: (text: string) => Promise<CheckProfanityResult>;
+    };
+  }
+