@sideid/id-profanity-filter 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,71 @@
+type ProfanityCategory = 'sexual' | 'insult' | 'profanity' | 'slur' | 'drugs' | 'disgusting' | 'blasphemy';
+type Region = 'general' | 'jawa' | 'sunda' | 'betawi' | 'batak' | 'minang' | 'bali' | 'madura' | 'bugis' | 'aceh' | 'ambon' | 'papua' | 'manado' | 'banjar' | 'palembang' | 'lampung' | 'ntt' | 'ntb';
+/**
+ * Definisi kata kotor
+ */
+interface ProfanityWord {
+    word: string;
+    category: ProfanityCategory;
+    region: Region;
+    severity: number;
+    aliases?: string[];
+    description?: string;
+    context?: string;
+}
+/**
+ * Opsi untuk konfigurasi filter
+ */
+interface FilterOptions {
+    /** List kata yang ingin difilter */
+    wordList?: string[];
+    /** Karakter pengganti untuk kata yang disensor */
+    replaceWith?: string;
+    /** Apakah harus menyensor seluruh kata atau hanya sebagian */
+    fullWordCensor?: boolean;
+    /** Apakah harus mendeteksi kata dengan variasi penulisan */
+    detectLeetSpeak?: boolean;
+    /** Mengabaikan kata-kata dalam konteks tertentu (misalnya nama) */
+    whitelist?: string[];
+    /** Apakah harus memeriksa substring (lebih ketat) */
+    checkSubstring?: boolean;
+    /** Kategori kata yang ingin difilter */
+    categories?: ProfanityCategory[];
+    /** Daerah yang ingin difilter katanya */
+    regions?: Region[];
+    /** Tingkat keparahan minimum yang akan difilter (0-1) */
+    severityThreshold?: number;
+}
+/**
+ * Hasil analisis dari teks
+ */
+interface AnalysisResult {
+    /** Apakah teks mengandung kata kotor */
+    hasProfanity: boolean;
+    /** Daftar kata kotor yang ditemukan */
+    matches: string[];
+    /** Daftar kata kotor lengkap dengan metadata */
+    matchDetails: ProfanityWord[];
+    /** Daftar kategori kata kotor yang ditemukan */
+    categories: ProfanityCategory[];
+    /** Daftar daerah asal kata kotor yang ditemukan */
+    regions: Region[];
+    /** Tingkat keparahan (0-1) berdasarkan jumlah dan jenis kata */
+    severityScore: number;
+}
+/**
+ * Hasil filter dari teks
+ */
+interface FilterResult {
+    /** Teks hasil filter */
+    filtered: string;
+    /** Jumlah kata yang disensor */
+    censored: number;
+    /** Kata asli yang disensor dan penggantinya */
+    replacements: Array<{
+        original: string;
+        censored: string;
+        metadata?: ProfanityWord;
+    }>;
+}
+
+export type { AnalysisResult, FilterOptions, FilterResult, ProfanityCategory, ProfanityWord, Region };