@joliegg/moderation 0.3.0 → 0.3.2

package/README.md

@@ -32,6 +32,7 @@ const client = new ModerationClient({
     apiKey: GOOGLE_API_KEY
   },
   banlist: ['some word'],
+  urlBlackList: ['someurl.example'],
 });
 ```
 
@@ -54,7 +55,7 @@ Currently only OGG files are supported
 
 ```js
 
-const audioModeration = await client.moderateAudio('https://example.example/image.ogg');
+const audioModeration = await client.moderateAudio('https://example.example/image.ogg', 'en-US');
 ```
 
 ### Moderating Links

package/dist/index.d.ts

@@ -2,7 +2,7 @@ import { ModerationConfiguration, ModerationResult } from './types';
 /**
  * Moderation Client
  *
- * @name ModerationClient
+ * @class ModerationClient
  */
 declare class ModerationClient {
     private rekognitionClient?;
@@ -10,6 +10,7 @@ declare class ModerationClient {
     private googleSpeechClient?;
     private googleAPIKey?;
     private banList?;
+    private urlBlackList?;
     /**
      *
      * @param {ModerationConfiguration} configuration
@@ -35,6 +36,6 @@ declare class ModerationClient {
      */
     moderateImage(url: string, minimumConfidence?: number): Promise<ModerationResult>;
     moderateLink(url: string): Promise<ModerationResult>;
-    moderateAudio(url: string, minimumConfidence?: number): Promise<ModerationResult>;
+    moderateAudio(url: string, language?: string, minimumConfidence?: number): Promise<ModerationResult>;
 }
 export default ModerationClient;

package/dist/index.js

@@ -12,14 +12,15 @@ const url_blacklist_json_1 = __importDefault(require("./url-blacklist.json"));
 /**
  * Moderation Client
  *
- * @name ModerationClient
+ * @class ModerationClient
  */
 class ModerationClient {
     rekognitionClient;
     googleLanguageClient;
     googleSpeechClient;
     googleAPIKey;
-    banList;
+    banList = [];
+    urlBlackList = [];
     /**
      *
      * @param {ModerationConfiguration} configuration
@@ -38,6 +39,9 @@ class ModerationClient {
         if (Array.isArray(configuration.banList)) {
             this.banList = configuration.banList;
         }
+        if (Array.isArray(configuration.urlBlackList)) {
+            this.urlBlackList = configuration.urlBlackList;
+        }
     }
     /**
      * Returns a list of moderation categories detected on a text
@@ -53,9 +57,10 @@ class ModerationClient {
             const normalizedText = text.toLowerCase();
             const matches = this.banList.filter(w => normalizedText.indexOf(w) > -1);
             if (matches.length > 0) {
+                const words = normalizedText.split(' ');
                 categories.push({
-                    category: 'Ban List',
-                    confidence: matches.length,
+                    category: 'BAN_LIST',
+                    confidence: (matches.length / words.length) * 100,
                 });
             }
         }
@@ -121,8 +126,12 @@ class ModerationClient {
         return { source: url, moderation: [] };
     }
     async moderateLink(url) {
-        const blacklisted = url_blacklist_json_1.default.some(b => url.indexOf(b) > -1);
+        const blacklisted = this.urlBlackList?.some(b => url.indexOf(b) > -1);
         if (blacklisted) {
+            return { source: url, moderation: [{ category: 'CUSTOM_BLACK_LIST', confidence: 100 }] };
+        }
+        const globallyBlacklisted = url_blacklist_json_1.default.some(b => url.indexOf(b) > -1);
+        if (globallyBlacklisted) {
             return { source: url, moderation: [{ category: 'BLACK_LIST', confidence: 100 }] };
         }
         if (typeof this.googleAPIKey !== 'string') {
@@ -147,7 +156,7 @@ class ModerationClient {
         }
         return { source: url, moderation: [] };
     }
-    async moderateAudio(url, minimumConfidence = 50) {
+    async moderateAudio(url, language = 'en-US', minimumConfidence = 50) {
         if (typeof this.googleSpeechClient === 'undefined') {
             return { source: url, moderation: [] };
         }
@@ -155,7 +164,7 @@ class ModerationClient {
         const options = {
             encoding: 'OGG_OPUS',
             sampleRateHertz: 48000,
-            languageCode: 'es-US'
+            languageCode: language,
         };
         const [response] = await this.googleSpeechClient.recognize({
             audio: { content: Buffer.from(data, 'binary').toString('base64') },

package/dist/types/index.d.ts

@@ -6,6 +6,7 @@ export interface ModerationConfiguration {
         keyFile?: string;
     };
     banList?: string[];
+    urlBlackList?: string[];
 }
 export interface ModerationCategory {
     category: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@joliegg/moderation",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "description": "A set of tools for chat moderation",
   "author": "Diana Islas Ocampo",
   "main": "dist/index.js",
@@ -12,7 +12,7 @@
     "test": "node test/index.js"
   },
   "engines": {
-    "node": "20.x"
+    "node": ">=20.x"
   },
   "devDependencies": {
     "@babel/eslint-parser": "^7.24.8",

package/src/index.ts

@@ -19,7 +19,7 @@ type ISpeechRecognitionResult = protos.google.cloud.speech.v1.ISpeechRecognition
 /**
  * Moderation Client
  *
- * @name ModerationClient
+ * @class ModerationClient
  */
 class ModerationClient {
 
@@ -27,7 +27,8 @@ class ModerationClient {
   private googleLanguageClient?: LanguageServiceClient;
   private googleSpeechClient?: SpeechClient;
   private googleAPIKey?: string;
-  private banList?: string[];
+  private banList?: string[] = [];
+  private urlBlackList?: string[] = [];
 
   /**
    *
@@ -50,6 +51,10 @@ class ModerationClient {
     if (Array.isArray(configuration.banList)) {
       this.banList = configuration.banList;
     }
+
+    if (Array.isArray(configuration.urlBlackList)) {
+      this.urlBlackList = configuration.urlBlackList;
+    }
   }
 
   /**
@@ -68,9 +73,11 @@ class ModerationClient {
       const matches = this.banList.filter(w => normalizedText.indexOf(w) > -1);
 
       if (matches.length > 0) {
+        const words = normalizedText.split(' ');
+
         categories.push({
-          category: 'Ban List',
-          confidence: matches.length,
+          category: 'BAN_LIST',
+          confidence: (matches.length / words.length) * 100,
         });
       }
     }
@@ -148,9 +155,15 @@ class ModerationClient {
   }
 
   async moderateLink (url: string): Promise<ModerationResult> {
-    const blacklisted = URLBlackList.some(b => url.indexOf(b) > -1);
+    const blacklisted = this.urlBlackList?.some(b => url.indexOf(b) > -1);
 
     if (blacklisted) {
+      return { source: url, moderation: [{ category: 'CUSTOM_BLACK_LIST', confidence: 100 }] };
+    }
+
+    const globallyBlacklisted = URLBlackList.some(b => url.indexOf(b) > -1);
+
+    if (globallyBlacklisted) {
       return { source: url, moderation: [{ category: 'BLACK_LIST', confidence: 100 }] };
     }
 
@@ -185,7 +198,7 @@ class ModerationClient {
     return { source: url, moderation: [] };
   }
 
-  async moderateAudio (url: string, minimumConfidence: number = 50): Promise<ModerationResult> {
+  async moderateAudio (url: string, language: string = 'en-US', minimumConfidence: number = 50): Promise<ModerationResult> {
     if (typeof this.googleSpeechClient === 'undefined') {
       return { source: url, moderation: [] };
     }
@@ -196,7 +209,7 @@ class ModerationClient {
     const options: IRecognitionConfig = {
       encoding: 'OGG_OPUS',
       sampleRateHertz: 48000,
-      languageCode: 'es-US'
+      languageCode: language,
     };
 
     const [ response ] = await this.googleSpeechClient.recognize ({

package/src/types/index.ts

@@ -7,6 +7,7 @@ export interface ModerationConfiguration {
     keyFile?: string;
   };
   banList?: string[];
+  urlBlackList?: string[];
 }
 
 export interface ModerationCategory {