@rkitwork/whatsapp-ramukjar-cloud-sdk 1.0.0

package/dist/core/WhatsAppClient.d.ts

@@ -0,0 +1,8 @@
+import { WhatsAppPayload } from './types';
+export declare class WhatsAppClient {
+    private readonly token;
+    private readonly phoneNumberId;
+    private readonly apiVersion;
+    constructor(token: string, phoneNumberId: string, apiVersion?: string);
+    sendMessage(to: string, payload: WhatsAppPayload): Promise<any>;
+}

package/dist/core/WhatsAppClient.js

@@ -0,0 +1,29 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WhatsAppClient = void 0;
+const axios_1 = __importDefault(require("axios"));
+class WhatsAppClient {
+    constructor(token, phoneNumberId, apiVersion = 'v24.0') {
+        this.token = token;
+        this.phoneNumberId = phoneNumberId;
+        this.apiVersion = apiVersion;
+    }
+    async sendMessage(to, payload) {
+        const url = `https://graph.facebook.com/${this.apiVersion}/${this.phoneNumberId}/messages`;
+        const response = await axios_1.default.post(url, {
+            messaging_product: 'whatsapp',
+            to,
+            ...payload,
+        }, {
+            headers: {
+                Authorization: `Bearer ${this.token}`,
+                'Content-Type': 'application/json',
+            },
+        });
+        return response.data;
+    }
+}
+exports.WhatsAppClient = WhatsAppClient;

package/dist/core/payloads.d.ts

@@ -0,0 +1,14 @@
+import * as T from './types';
+export declare const textMessage: (body: string, preview?: boolean) => T.TextPayload;
+export declare const imageMessage: (link: string, caption?: string) => T.ImagePayload;
+export declare const audioMessage: (link: string) => T.AudioPayload;
+export declare const videoMessage: (link: string, caption?: string) => T.VideoPayload;
+export declare const documentMessage: (link: string, filename: string, caption?: string) => T.DocumentPayload;
+export declare const locationMessage: (latitude: number, longitude: number, name?: string, address?: string) => T.LocationPayload;
+export declare const contactMessage: (firstName: string, phone: string, lastName?: string) => T.ContactPayload;
+export declare const buttonMessage: (bodyText: string, buttons: {
+    id: string;
+    title: string;
+}[]) => T.ButtonPayload;
+export declare const listMessage: (bodyText: string, buttonText: string, sections: T.ListPayload["interactive"]["action"]["sections"]) => T.ListPayload;
+export declare const templateMessage: (name: string, language?: string, components?: any[]) => T.TemplatePayload;

package/dist/core/payloads.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.templateMessage = exports.listMessage = exports.buttonMessage = exports.contactMessage = exports.locationMessage = exports.documentMessage = exports.videoMessage = exports.audioMessage = exports.imageMessage = exports.textMessage = void 0;
+const textMessage = (body, preview = false) => ({
+    type: 'text',
+    text: { body, preview_url: preview },
+});
+exports.textMessage = textMessage;
+const imageMessage = (link, caption) => ({
+    type: 'image',
+    image: { link, caption },
+});
+exports.imageMessage = imageMessage;
+const audioMessage = (link) => ({
+    type: 'audio',
+    audio: { link },
+});
+exports.audioMessage = audioMessage;
+const videoMessage = (link, caption) => ({
+    type: 'video',
+    video: { link, caption },
+});
+exports.videoMessage = videoMessage;
+const documentMessage = (link, filename, caption) => ({
+    type: 'document',
+    document: { link, filename, caption },
+});
+exports.documentMessage = documentMessage;
+const locationMessage = (latitude, longitude, name, address) => ({
+    type: 'location',
+    location: { latitude, longitude, name, address },
+});
+exports.locationMessage = locationMessage;
+const contactMessage = (firstName, phone, lastName) => ({
+    type: 'contacts',
+    contacts: [
+        {
+            name: { first_name: firstName, last_name: lastName },
+            phones: [{ phone }],
+        },
+    ],
+});
+exports.contactMessage = contactMessage;
+const buttonMessage = (bodyText, buttons) => ({
+    type: 'interactive',
+    interactive: {
+        type: 'button',
+        body: { text: bodyText },
+        action: {
+            buttons: buttons.map((b) => ({
+                type: 'reply',
+                reply: b,
+            })),
+        },
+    },
+});
+exports.buttonMessage = buttonMessage;
+const listMessage = (bodyText, buttonText, sections) => ({
+    type: 'interactive',
+    interactive: {
+        type: 'list',
+        body: { text: bodyText },
+        action: { button: buttonText, sections },
+    },
+});
+exports.listMessage = listMessage;
+const templateMessage = (name, language = 'en_US', components = []) => ({
+    type: 'template',
+    template: { name, language: { code: language }, components },
+});
+exports.templateMessage = templateMessage;

package/dist/core/types.d.ts

@@ -0,0 +1,109 @@
+export type LanguageCode = string;
+export interface BasePayload {
+    type: string;
+}
+export interface TextPayload extends BasePayload {
+    type: 'text';
+    text: {
+        body: string;
+        preview_url?: boolean;
+    };
+}
+export interface ImagePayload extends BasePayload {
+    type: 'image';
+    image: {
+        link: string;
+        caption?: string;
+    };
+}
+export interface AudioPayload extends BasePayload {
+    type: 'audio';
+    audio: {
+        link: string;
+    };
+}
+export interface VideoPayload extends BasePayload {
+    type: 'video';
+    video: {
+        link: string;
+        caption?: string;
+    };
+}
+export interface DocumentPayload extends BasePayload {
+    type: 'document';
+    document: {
+        link: string;
+        filename: string;
+        caption?: string;
+    };
+}
+export interface LocationPayload extends BasePayload {
+    type: 'location';
+    location: {
+        latitude: number;
+        longitude: number;
+        name?: string;
+        address?: string;
+    };
+}
+export interface ContactPayload extends BasePayload {
+    type: 'contacts';
+    contacts: {
+        name: {
+            first_name: string;
+            last_name?: string;
+        };
+        phones: {
+            phone: string;
+        }[];
+    }[];
+}
+export interface ButtonPayload extends BasePayload {
+    type: 'interactive';
+    interactive: {
+        type: 'button';
+        body: {
+            text: string;
+        };
+        action: {
+            buttons: {
+                type: 'reply';
+                reply: {
+                    id: string;
+                    title: string;
+                };
+            }[];
+        };
+    };
+}
+export interface ListPayload extends BasePayload {
+    type: 'interactive';
+    interactive: {
+        type: 'list';
+        body: {
+            text: string;
+        };
+        action: {
+            button: string;
+            sections: {
+                title: string;
+                rows: {
+                    id: string;
+                    title: string;
+                    description?: string;
+                }[];
+            }[];
+        };
+    };
+}
+export interface TemplatePayload extends BasePayload {
+    type: 'template';
+    template: {
+        name: string;
+        language: {
+            code: LanguageCode;
+        };
+        components?: any[];
+    };
+}
+export type WhatsAppPayload = TextPayload | ImagePayload | AudioPayload | VideoPayload | DocumentPayload | LocationPayload | ContactPayload | ButtonPayload | ListPayload | TemplatePayload;

package/dist/core/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/express/webhook.d.ts

@@ -0,0 +1,3 @@
+import { Request, Response } from 'express';
+export declare const verifyWebhook: (req: Request, res: Response) => Response<any, Record<string, any>>;
+export declare const handleWebhook: (req: Request, res: Response) => void;

package/dist/express/webhook.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleWebhook = exports.verifyWebhook = void 0;
+const verifyWebhook = (req, res) => {
+    const mode = req.query['hub.mode'];
+    const token = req.query['hub.verify_token'];
+    const challenge = req.query['hub.challenge'];
+    if (mode === 'subscribe' && token === process.env.WHATSAPP_VERIFY_TOKEN) {
+        return res.status(200).send(challenge);
+    }
+    return res.sendStatus(403);
+};
+exports.verifyWebhook = verifyWebhook;
+const handleWebhook = (req, res) => {
+    console.log('Incoming webhook:', JSON.stringify(req.body, null, 2));
+    res.sendStatus(200);
+};
+exports.handleWebhook = handleWebhook;

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export * from './core/WhatsAppClient';
+export * from './core/payloads';
+export * from './core/types';
+export * from './express/webhook';
+export * from './nest/whatsapp.module';
+export * from './nest/whatsapp.service';

package/dist/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./core/WhatsAppClient"), exports);
+__exportStar(require("./core/payloads"), exports);
+__exportStar(require("./core/types"), exports);
+__exportStar(require("./express/webhook"), exports);
+__exportStar(require("./nest/whatsapp.module"), exports);
+__exportStar(require("./nest/whatsapp.service"), exports);

package/dist/nest/webhook.controller.d.ts

@@ -0,0 +1,6 @@
+export declare class WebhookController {
+    verify(challenge: string): string;
+    handle(body: any): Promise<{
+        status: string;
+    }>;
+}

package/dist/nest/webhook.controller.js

@@ -0,0 +1,41 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhookController = void 0;
+const common_1 = require("@nestjs/common");
+let WebhookController = class WebhookController {
+    verify(challenge) {
+        return challenge;
+    }
+    handle(body) {
+        return Promise.resolve({ status: 'ok' });
+    }
+};
+exports.WebhookController = WebhookController;
+__decorate([
+    (0, common_1.Get)(),
+    __param(0, (0, common_1.Query)('hub.challenge')),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String]),
+    __metadata("design:returntype", String)
+], WebhookController.prototype, "verify", null);
+__decorate([
+    (0, common_1.Post)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], WebhookController.prototype, "handle", null);
+exports.WebhookController = WebhookController = __decorate([
+    (0, common_1.Controller)('webhook')
+], WebhookController);

package/dist/nest/whatsapp.module.d.ts

@@ -0,0 +1,2 @@
+export declare class WhatsAppModule {
+}

package/dist/nest/whatsapp.module.js

@@ -0,0 +1,22 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WhatsAppModule = void 0;
+const common_1 = require("@nestjs/common");
+const whatsapp_service_1 = require("./whatsapp.service");
+const webhook_controller_1 = require("./webhook.controller");
+let WhatsAppModule = class WhatsAppModule {
+};
+exports.WhatsAppModule = WhatsAppModule;
+exports.WhatsAppModule = WhatsAppModule = __decorate([
+    (0, common_1.Module)({
+        providers: [whatsapp_service_1.WhatsAppService],
+        exports: [whatsapp_service_1.WhatsAppService],
+        controllers: [webhook_controller_1.WebhookController],
+    })
+], WhatsAppModule);

package/dist/nest/whatsapp.service.d.ts

@@ -0,0 +1,4 @@
+export declare class WhatsAppService {
+    private client;
+    sendMessage(to: string, payload: any): Promise<any>;
+}

package/dist/nest/whatsapp.service.js

@@ -0,0 +1,23 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WhatsAppService = void 0;
+const common_1 = require("@nestjs/common");
+const WhatsAppClient_1 = require("../core/WhatsAppClient");
+let WhatsAppService = class WhatsAppService {
+    constructor() {
+        this.client = new WhatsAppClient_1.WhatsAppClient(process.env.WHATSAPP_TOKEN, process.env.WHATSAPP_PHONE_ID);
+    }
+    sendMessage(to, payload) {
+        return this.client.sendMessage(to, payload);
+    }
+};
+exports.WhatsAppService = WhatsAppService;
+exports.WhatsAppService = WhatsAppService = __decorate([
+    (0, common_1.Injectable)()
+], WhatsAppService);

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@rkitwork/whatsapp-ramukjar-cloud-sdk",
+  "version": "1.0.0",
+  "description": "A secure WhatsApp Cloud API SDK for NestJS and Express",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": ["whatsapp", "sdk", "nestjs", "express", "cloud-api"],
+  "author": "rkitwork",
+  "license": "MIT",
+  "peerDependencies": {
+    "@nestjs/common": ">=9.0.0",
+    "@nestjs/core": ">=9.0.0",
+    "express": ">=4.17.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.3.3",
+    "@types/express": "^4.17.21",
+    "@types/node": "^20.0.0"
+  },
+  "dependencies": {
+    "axios": "^1.7.0"
+  }
+}

package/src/core/WhatsAppClient.ts

@@ -0,0 +1,31 @@
+import axios from 'axios';
+import { WhatsAppPayload } from './types';
+
+export class WhatsAppClient {
+  constructor(
+    private readonly token: string,
+    private readonly phoneNumberId: string,
+    private readonly apiVersion = 'v24.0'
+  ) {}
+
+  async sendMessage(to: string, payload: WhatsAppPayload) {
+    const url = `https://graph.facebook.com/${this.apiVersion}/${this.phoneNumberId}/messages`;
+
+    const response = await axios.post(
+      url,
+      {
+        messaging_product: 'whatsapp',
+        to,
+        ...payload,
+      },
+      {
+        headers: {
+          Authorization: `Bearer ${this.token}`,
+          'Content-Type': 'application/json',
+        },
+      }
+    );
+
+    return response.data;
+  }
+}

package/src/core/payloads.ts

@@ -0,0 +1,93 @@
+import * as T from './types';
+
+export const textMessage = (body: string, preview = false): T.TextPayload => ({
+  type: 'text',
+  text: { body, preview_url: preview },
+});
+
+export const imageMessage = (link: string, caption?: string): T.ImagePayload => ({
+  type: 'image',
+  image: { link, caption },
+});
+
+export const audioMessage = (link: string): T.AudioPayload => ({
+  type: 'audio',
+  audio: { link },
+});
+
+export const videoMessage = (link: string, caption?: string): T.VideoPayload => ({
+  type: 'video',
+  video: { link, caption },
+});
+
+export const documentMessage = (
+  link: string,
+  filename: string,
+  caption?: string
+): T.DocumentPayload => ({
+  type: 'document',
+  document: { link, filename, caption },
+});
+
+export const locationMessage = (
+  latitude: number,
+  longitude: number,
+  name?: string,
+  address?: string
+): T.LocationPayload => ({
+  type: 'location',
+  location: { latitude, longitude, name, address },
+});
+
+export const contactMessage = (
+  firstName: string,
+  phone: string,
+  lastName?: string
+): T.ContactPayload => ({
+  type: 'contacts',
+  contacts: [
+    {
+      name: { first_name: firstName, last_name: lastName },
+      phones: [{ phone }],
+    },
+  ],
+});
+
+export const buttonMessage = (
+  bodyText: string,
+  buttons: { id: string; title: string }[]
+): T.ButtonPayload => ({
+  type: 'interactive',
+  interactive: {
+    type: 'button',
+    body: { text: bodyText },
+    action: {
+      buttons: buttons.map((b) => ({
+        type: 'reply',
+        reply: b,
+      })),
+    },
+  },
+});
+
+export const listMessage = (
+  bodyText: string,
+  buttonText: string,
+  sections: T.ListPayload['interactive']['action']['sections']
+): T.ListPayload => ({
+  type: 'interactive',
+  interactive: {
+    type: 'list',
+    body: { text: bodyText },
+    action: { button: buttonText, sections },
+  },
+});
+
+export const templateMessage = (
+  name: string,
+  language = 'en_US',
+  components: any[] = []
+): T.TemplatePayload => ({
+  type: 'template',
+  template: { name, language: { code: language }, components },
+});

package/src/core/types.ts

@@ -0,0 +1,102 @@
+export type LanguageCode = string;
+
+export interface BasePayload {
+  type: string;
+}
+
+export interface TextPayload extends BasePayload {
+  type: 'text';
+  text: { body: string; preview_url?: boolean };
+}
+
+export interface ImagePayload extends BasePayload {
+  type: 'image';
+  image: { link: string; caption?: string };
+}
+
+export interface AudioPayload extends BasePayload {
+  type: 'audio';
+  audio: { link: string };
+}
+
+export interface VideoPayload extends BasePayload {
+  type: 'video';
+  video: { link: string; caption?: string };
+}
+
+export interface DocumentPayload extends BasePayload {
+  type: 'document';
+  document: { link: string; filename: string; caption?: string };
+}
+
+export interface LocationPayload extends BasePayload {
+  type: 'location';
+  location: {
+    latitude: number;
+    longitude: number;
+    name?: string;
+    address?: string;
+  };
+}
+
+export interface ContactPayload extends BasePayload {
+  type: 'contacts';
+  contacts: {
+    name: { first_name: string; last_name?: string };
+    phones: { phone: string }[];
+  }[];
+}
+
+export interface ButtonPayload extends BasePayload {
+  type: 'interactive';
+  interactive: {
+    type: 'button';
+    body: { text: string };
+    action: {
+      buttons: {
+        type: 'reply';
+        reply: { id: string; title: string };
+      }[];
+    };
+  };
+}
+
+export interface ListPayload extends BasePayload {
+  type: 'interactive';
+  interactive: {
+    type: 'list';
+    body: { text: string };
+    action: {
+      button: string;
+      sections: {
+        title: string;
+        rows: {
+          id: string;
+          title: string;
+          description?: string;
+        }[];
+      }[];
+    };
+  };
+}
+
+export interface TemplatePayload extends BasePayload {
+  type: 'template';
+  template: {
+    name: string;
+    language: { code: LanguageCode };
+    components?: any[];
+  };
+}
+
+export type WhatsAppPayload =
+  | TextPayload
+  | ImagePayload
+  | AudioPayload
+  | VideoPayload
+  | DocumentPayload
+  | LocationPayload
+  | ContactPayload
+  | ButtonPayload
+  | ListPayload
+  | TemplatePayload;

package/src/express/webhook.ts

@@ -0,0 +1,18 @@
+import { Request, Response } from 'express';
+
+export const verifyWebhook = (req: Request, res: Response) => {
+  const mode = req.query['hub.mode'];
+  const token = req.query['hub.verify_token'];
+  const challenge = req.query['hub.challenge'];
+
+  if (mode === 'subscribe' && token === process.env.WHATSAPP_VERIFY_TOKEN) {
+    return res.status(200).send(challenge);
+  }
+
+  return res.sendStatus(403);
+};
+
+export const handleWebhook = (req: Request, res: Response) => {
+  console.log('Incoming webhook:', JSON.stringify(req.body, null, 2));
+  res.sendStatus(200);
+};

package/src/index.ts

@@ -0,0 +1,8 @@
+export * from './core/WhatsAppClient';
+export * from './core/payloads';
+export * from './core/types';
+
+export * from './express/webhook';
+
+export * from './nest/whatsapp.module';
+export * from './nest/whatsapp.service';

package/src/nest/webhook.controller.ts

@@ -0,0 +1,16 @@
+import { Controller, Get, Post, Query, Body } from '@nestjs/common';
+
+@Controller('webhook')
+export class WebhookController {
+
+  @Get()
+  verify(@Query('hub.challenge') challenge: string): string {
+    return challenge;
+  }
+
+ @Post()
+  handle(body: any): Promise<{ status: string }> {
+    return Promise.resolve({ status: 'ok' });
+  }
+
+}

package/src/nest/whatsapp.module.ts

@@ -0,0 +1,10 @@
+import { Module } from '@nestjs/common';
+import { WhatsAppService } from './whatsapp.service';
+import { WebhookController } from './webhook.controller';
+
+@Module({
+  providers: [WhatsAppService],
+  exports: [WhatsAppService],
+  controllers: [WebhookController],
+})
+export class WhatsAppModule {}

package/src/nest/whatsapp.service.ts

@@ -0,0 +1,14 @@
+import { Injectable } from '@nestjs/common';
+import { WhatsAppClient } from '../core/WhatsAppClient';
+
+@Injectable()
+export class WhatsAppService {
+  private client = new WhatsAppClient(
+    process.env.WHATSAPP_TOKEN!,
+    process.env.WHATSAPP_PHONE_ID!
+  );
+
+  sendMessage(to: string, payload: any) {
+    return this.client.sendMessage(to, payload);
+  }
+}

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "CommonJS",
+    "declaration": true,
+    "outDir": "dist",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true
+  },
+  "include": ["src/**/*"]
+}