Merge pull request #10 from mimamch/dev-error-class

v3.2.0 + add error class WhatsappError

Author: mimamch

package.json

@@ -1,6 +1,6 @@
 {
   "name": "wa-multi-session",
-  "version": "3.1.2",
+  "version": "3.2.0",
   "description": "Multi Session Whatsapp Library",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

readme.md

@@ -211,7 +211,11 @@ whatsapp.setCredentialsDir("my_custom_dir");
 
 ## Change Log
 
-v3.1.2 July 2023 (LATEST)
+v3.2.0 July 2023 (LATEST)
+
+- Add error class named: WhatsappError
+
+v3.1.2 July 2023
 
 - Add send document message
 

src/Error/index.ts

@@ -0,0 +1,5 @@
+export class WhatsappError extends Error {
+  constructor(message: string) {
+    super(message);
+  }
+}

src/Messaging/index.ts

@@ -11,6 +11,7 @@ import { phoneToJid } from "../Utils";
 import { createDelay } from "../Utils/create-delay";
 import { isExist } from "../Utils/is-exist";
 import mime from "mime";
+import { WhatsappError } from "../Error";
 
 export const sendTextMessage = async ({
   sessionId,
@@ -20,7 +21,7 @@ export const sendTextMessage = async ({
   ...props
 }: SendMessageTypes): Promise<proto.WebMessageInfo | undefined> => {
   const session = getSession(sessionId);
-  if (!session) throw new Error(Messages.sessionNotFound(sessionId));
+  if (!session) throw new WhatsappError(Messages.sessionNotFound(sessionId));
   const oldPhone = to;
   to = phoneToJid({ to, isGroup });
   const isRegistered = await isExist({
@@ -29,7 +30,7 @@ export const sendTextMessage = async ({
     isGroup,
   });
   if (!isRegistered) {
-    throw new Error(`${oldPhone} is not registered on Whatsapp`);
+    throw new WhatsappError(`${oldPhone} is not registered on Whatsapp`);
   }
   return await session.sendMessage(
     to,
@@ -50,7 +51,7 @@ export const sendImage = async ({
   ...props
 }: SendMediaTypes): Promise<proto.WebMessageInfo | undefined> => {
   const session = getSession(sessionId);
-  if (!session) throw new Error(Messages.sessionNotFound(sessionId));
+  if (!session) throw new WhatsappError(Messages.sessionNotFound(sessionId));
   const oldPhone = to;
   to = phoneToJid({ to, isGroup });
   const isRegistered = await isExist({
@@ -59,9 +60,10 @@ export const sendImage = async ({
     isGroup,
   });
   if (!isRegistered) {
-    throw new Error(`${oldPhone} is not registered on Whatsapp`);
+    throw new WhatsappError(`${oldPhone} is not registered on Whatsapp`);
   }
-  if (!media) throw new Error("parameter media must be Buffer or String URL");
+  if (!media)
+    throw new WhatsappError("parameter media must be Buffer or String URL");
   return await session.sendMessage(
     to,
     {
@@ -87,7 +89,7 @@ export const sendVideo = async ({
   ...props
 }: SendMediaTypes): Promise<proto.WebMessageInfo | undefined> => {
   const session = getSession(sessionId);
-  if (!session) throw new Error(Messages.sessionNotFound(sessionId));
+  if (!session) throw new WhatsappError(Messages.sessionNotFound(sessionId));
   const oldPhone = to;
   to = phoneToJid({ to, isGroup });
   const isRegistered = await isExist({
@@ -96,9 +98,10 @@ export const sendVideo = async ({
     isGroup,
   });
   if (!isRegistered) {
-    throw new Error(`${oldPhone} is not registered on Whatsapp`);
+    throw new WhatsappError(`${oldPhone} is not registered on Whatsapp`);
   }
-  if (!media) throw new Error("parameter media must be Buffer or String URL");
+  if (!media)
+    throw new WhatsappError("parameter media must be Buffer or String URL");
   return await session.sendMessage(
     to,
     {
@@ -128,7 +131,7 @@ export const sendDocument = async ({
   filename: string;
 }): Promise<proto.WebMessageInfo | undefined> => {
   const session = getSession(sessionId);
-  if (!session) throw new Error(Messages.sessionNotFound(sessionId));
+  if (!session) throw new WhatsappError(Messages.sessionNotFound(sessionId));
   const oldPhone = to;
   to = phoneToJid({ to, isGroup });
   const isRegistered = await isExist({
@@ -137,15 +140,15 @@ export const sendDocument = async ({
     isGroup,
   });
   if (!isRegistered) {
-    throw new Error(`${oldPhone} is not registered on Whatsapp`);
+    throw new WhatsappError(`${oldPhone} is not registered on Whatsapp`);
   }
   if (!media || !Buffer.isBuffer(media)) {
-    throw new Error(`Media File must be Buffer`);
+    throw new WhatsappError(`Media File must be Buffer`);
   }
 
   const mimetype = mime.getType(filename);
   if (!mimetype) {
-    throw new Error(`Filename must include valid extension`);
+    throw new WhatsappError(`Filename must include valid extension`);
   }
 
   return await session.sendMessage(
@@ -181,14 +184,14 @@ export const sendTyping = async ({
   const oldPhone = to;
   to = phoneToJid({ to, isGroup });
   const session = getSession(sessionId);
-  if (!session) throw new Error(Messages.sessionNotFound(sessionId));
+  if (!session) throw new WhatsappError(Messages.sessionNotFound(sessionId));
   const isRegistered = await isExist({
     sessionId,
     to,
     isGroup,
   });
   if (!isRegistered) {
-    throw new Error(`${oldPhone} is not registered on Whatsapp`);
+    throw new WhatsappError(`${oldPhone} is not registered on Whatsapp`);
   }
   await session.sendPresenceUpdate("composing", to);
   await createDelay(duration);
@@ -207,7 +210,7 @@ export const sendTyping = async ({
  */
 export const readMessage = async ({ sessionId, key }: SendReadTypes) => {
   const session = getSession(sessionId);
-  if (!session) throw new Error(Messages.sessionNotFound(sessionId));
+  if (!session) throw new WhatsappError(Messages.sessionNotFound(sessionId));
 
   await session.readMessages([key]);
 };

src/Socket/index.ts

@@ -16,6 +16,7 @@ import {
   saveImageHandler,
   saveVideoHandler,
 } from "../Utils/save-media";
+import { WhatsappError } from "../Error";
 
 const sessions: Map<string, WASocket> = new Map();
 
@@ -28,7 +29,7 @@ export const startSession = async (
   options: StartSessionParams = { printQR: true }
 ): Promise<WASocket> => {
   if (isSessionExistAndRunning(sessionId))
-    throw new Error(Messages.sessionAlreadyExist(sessionId));
+    throw new WhatsappError(Messages.sessionAlreadyExist(sessionId));
   const logger = pino({ level: "silent" });
 
   const { version } = await fetchLatestBaileysVersion();

src/Utils/is-exist.ts

@@ -1,3 +1,4 @@
+import { WhatsappError } from "../Error";
 import { getSession } from "../Socket";
 import { SendMessageTypes } from "../Types";
 import { phoneToJid } from "./phone-to-jid";
@@ -9,7 +10,7 @@ export const isExist = async ({
 }: SendMessageTypes): Promise<boolean> => {
   try {
     const session = getSession(sessionId);
-    if (!session) throw new Error("Session ID Not Found!");
+    if (!session) throw new WhatsappError("Session ID Not Found!");
     const receiver = phoneToJid({
       to: to,
       isGroup: isGroup,

src/Utils/phone-to-jid.ts

@@ -1,3 +1,4 @@
+import { WhatsappError } from "../Error";
 import { SendMessageTypes } from "../Types";
 
 export const phoneToJid = ({
@@ -7,7 +8,7 @@ export const phoneToJid = ({
   to: string | number;
   isGroup?: boolean;
 }): string => {
-  if (!to) throw new Error('parameter "to" is required');
+  if (!to) throw new WhatsappError('parameter "to" is required');
   let number = to.toString();
   if (isGroup) {
     number = number.replace(/\s|[+]|[-]/gim, "");

src/index.ts

@@ -2,3 +2,4 @@ export * from "./Socket";
 export * from "./Messaging";
 export * from "./Utils";
 export * from "./Types";
+export * from "./Error";