btechworks-sdk 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 BatchWorks
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,181 @@
+# BTechWorks SDK
+
+Official BTechWorks WhatsApp CRM SDK for Node.js. Send messages, photos, videos, documents, templates, and broadcasts via the BTechWorks API.
+
+## Installation
+
+```bash
+npm install btechworks-sdk
+```
+
+## Quick Start
+
+```typescript
+import { BTechWorksClient } from 'btechworks-sdk';
+
+const client = new BTechWorksClient({
+  apiKey: 'wk_your_api_key_here',
+  secretKey: 'ws_your_secret_key_here',
+});
+
+// Send a text message - bas phone aur message do, baaki SDK sambhalega
+const result = await client.sendMessage({
+  phone: '+1234567890',
+  message: 'Hello from BTechWorks SDK!',
+});
+
+console.log(result);
+// { success: true, messageId: '...', whatsappMessageId: '...' }
+```
+
+## Configuration
+
+```typescript
+const client = new BTechWorksClient({
+  apiKey: 'wk_...',        // Required: Your API key
+  secretKey: 'ws_...',     // Required: Your secret key
+  baseUrl: 'https://api.btechworks.io', // Optional: Custom API URL
+  timeout: 30000,          // Optional: Request timeout in ms (default: 30000)
+});
+```
+
+## Methods
+
+### sendMessage
+
+Send a text message to a phone number. Contact and conversation are auto-created if they don't exist.
+
+```typescript
+const result = await client.sendMessage({
+  phone: '+1234567890',
+  message: 'Hello World!',
+});
+```
+
+### sendPhoto
+
+Send an image with an optional caption.
+
+```typescript
+const result = await client.sendPhoto({
+  phone: '+1234567890',
+  imageUrl: 'https://example.com/photo.jpg',
+  caption: 'Check out this photo!',
+});
+```
+
+### sendVideo
+
+Send a video with an optional caption.
+
+```typescript
+const result = await client.sendVideo({
+  phone: '+1234567890',
+  videoUrl: 'https://example.com/video.mp4',
+  caption: 'Watch this video!',
+});
+```
+
+### sendDocument
+
+Send a document (PDF, DOC, etc.) with an optional caption.
+
+```typescript
+const result = await client.sendDocument({
+  phone: '+1234567890',
+  documentUrl: 'https://example.com/invoice.pdf',
+  filename: 'invoice.pdf',
+  caption: 'Your invoice for this month',
+});
+```
+
+### sendTemplate
+
+Send a WhatsApp template message with variables.
+
+```typescript
+// Simple template with body variables
+const result = await client.sendTemplate({
+  phone: '+1234567890',
+  templateName: 'order_confirmation',
+  templateLanguage: 'en_US',
+  templateParams: ['John', 'Order #12345'],
+});
+
+// Template with header media and button params
+const result2 = await client.sendTemplate({
+  phone: '+1234567890',
+  templateName: 'promo_template',
+  templateLanguage: 'en_US',
+  templateMessageParams: {
+    header: {
+      type: 'image',
+      url: 'https://example.com/promo.jpg',
+    },
+    body: ['John', '50%'],
+    buttons: [
+      { type: 'url', suffix: 'promo50' },
+    ],
+  },
+});
+```
+
+### broadcast
+
+Send a template message to multiple recipients.
+
+```typescript
+const result = await client.broadcast({
+  name: 'Summer Sale Campaign',
+  templateName: 'summer_sale',
+  templateLanguage: 'en_US',
+  templateVariables: { code: 'SUMMER50' },
+  recipients: ['+1234567890', '+0987654321', '+1122334455'],
+});
+
+// Or use audience filter by tags
+const result2 = await client.broadcast({
+  name: 'VIP Customers',
+  templateName: 'vip_offer',
+  recipients: [],
+  audienceFilter: { tags: ['vip', 'premium'] },
+});
+```
+
+## Error Handling
+
+All methods throw `BTechWorksError` on failure:
+
+```typescript
+import { BTechWorksClient, BTechWorksError } from 'btechworks-sdk';
+
+try {
+  await client.sendMessage({
+    phone: '+1234567890',
+    message: 'Hello!',
+  });
+} catch (error) {
+  if (error instanceof BTechWorksError) {
+    console.log(error.message);      // Error message
+    console.log(error.statusCode);   // HTTP status code
+    console.log(error.details);      // Additional error details
+  }
+}
+```
+
+## How It Works
+
+1. **Phone number se sab kuch hota hai** - Contact aur conversation automatically create ho jaate hain
+2. **API key + Secret key se auth hota hai** - Dashboard se API key banao, SDK mein daalo, kaam shuru
+3. **Server sab handle karta hai** - Contact lookup, conversation creation, Meta API calls, message storage
+
+## Getting API Keys
+
+1. Login to your BTechWorks dashboard
+2. Go to Settings > API Keys
+3. Click "Create API Key"
+4. Copy both the API Key and Secret Key (secret is shown only once)
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,94 @@
+interface BTechWorksConfig {
+    apiKey: string;
+    secretKey: string;
+    baseUrl?: string;
+    timeout?: number;
+}
+interface SendMessageOptions {
+    phone: string;
+    message: string;
+}
+interface SendPhotoOptions {
+    phone: string;
+    imageUrl: string;
+    caption?: string;
+}
+interface SendVideoOptions {
+    phone: string;
+    videoUrl: string;
+    caption?: string;
+}
+interface SendDocumentOptions {
+    phone: string;
+    documentUrl: string;
+    filename?: string;
+    caption?: string;
+}
+interface SendTemplateOptions {
+    phone: string;
+    templateName: string;
+    templateLanguage?: string;
+    templateParams?: string[];
+    templateMessageParams?: {
+        header?: {
+            type: 'image' | 'video' | 'document';
+            url: string;
+            filename?: string;
+        };
+        body?: string[];
+        buttons?: Array<{
+            type: string;
+            suffix?: string;
+        }>;
+    };
+}
+interface BroadcastOptions {
+    name: string;
+    templateName: string;
+    templateLanguage?: string;
+    templateVariables?: Record<string, string>;
+    recipients?: string[];
+    audienceFilter?: {
+        tags?: string[];
+    };
+}
+interface ApiResponse {
+    success: boolean;
+    message_id?: string;
+    whatsapp_message_id?: string;
+    error?: string;
+}
+interface BroadcastResponse {
+    success: boolean;
+    broadcast_id?: string;
+    total_recipients?: number;
+    status?: string;
+    error?: string;
+}
+interface ApiError {
+    error: string;
+    statusCode: number;
+    details?: Record<string, unknown>;
+}
+
+declare class BTechWorksError extends Error {
+    statusCode: number;
+    details?: Record<string, unknown>;
+    constructor(message: string, statusCode: number, details?: Record<string, unknown>);
+}
+declare class BTechWorksClient {
+    private apiKey;
+    private secretKey;
+    private baseUrl;
+    private timeout;
+    constructor(config: BTechWorksConfig);
+    private request;
+    sendMessage(options: SendMessageOptions): Promise<ApiResponse>;
+    sendPhoto(options: SendPhotoOptions): Promise<ApiResponse>;
+    sendVideo(options: SendVideoOptions): Promise<ApiResponse>;
+    sendDocument(options: SendDocumentOptions): Promise<ApiResponse>;
+    sendTemplate(options: SendTemplateOptions): Promise<ApiResponse>;
+    broadcast(options: BroadcastOptions): Promise<BroadcastResponse>;
+}
+
+export { type ApiError, type ApiResponse, BTechWorksClient, type BTechWorksConfig, BTechWorksError, type BroadcastOptions, type BroadcastResponse, type SendDocumentOptions, type SendMessageOptions, type SendPhotoOptions, type SendTemplateOptions, type SendVideoOptions };

package/dist/index.d.ts

@@ -0,0 +1,94 @@
+interface BTechWorksConfig {
+    apiKey: string;
+    secretKey: string;
+    baseUrl?: string;
+    timeout?: number;
+}
+interface SendMessageOptions {
+    phone: string;
+    message: string;
+}
+interface SendPhotoOptions {
+    phone: string;
+    imageUrl: string;
+    caption?: string;
+}
+interface SendVideoOptions {
+    phone: string;
+    videoUrl: string;
+    caption?: string;
+}
+interface SendDocumentOptions {
+    phone: string;
+    documentUrl: string;
+    filename?: string;
+    caption?: string;
+}
+interface SendTemplateOptions {
+    phone: string;
+    templateName: string;
+    templateLanguage?: string;
+    templateParams?: string[];
+    templateMessageParams?: {
+        header?: {
+            type: 'image' | 'video' | 'document';
+            url: string;
+            filename?: string;
+        };
+        body?: string[];
+        buttons?: Array<{
+            type: string;
+            suffix?: string;
+        }>;
+    };
+}
+interface BroadcastOptions {
+    name: string;
+    templateName: string;
+    templateLanguage?: string;
+    templateVariables?: Record<string, string>;
+    recipients?: string[];
+    audienceFilter?: {
+        tags?: string[];
+    };
+}
+interface ApiResponse {
+    success: boolean;
+    message_id?: string;
+    whatsapp_message_id?: string;
+    error?: string;
+}
+interface BroadcastResponse {
+    success: boolean;
+    broadcast_id?: string;
+    total_recipients?: number;
+    status?: string;
+    error?: string;
+}
+interface ApiError {
+    error: string;
+    statusCode: number;
+    details?: Record<string, unknown>;
+}
+
+declare class BTechWorksError extends Error {
+    statusCode: number;
+    details?: Record<string, unknown>;
+    constructor(message: string, statusCode: number, details?: Record<string, unknown>);
+}
+declare class BTechWorksClient {
+    private apiKey;
+    private secretKey;
+    private baseUrl;
+    private timeout;
+    constructor(config: BTechWorksConfig);
+    private request;
+    sendMessage(options: SendMessageOptions): Promise<ApiResponse>;
+    sendPhoto(options: SendPhotoOptions): Promise<ApiResponse>;
+    sendVideo(options: SendVideoOptions): Promise<ApiResponse>;
+    sendDocument(options: SendDocumentOptions): Promise<ApiResponse>;
+    sendTemplate(options: SendTemplateOptions): Promise<ApiResponse>;
+    broadcast(options: BroadcastOptions): Promise<BroadcastResponse>;
+}
+
+export { type ApiError, type ApiResponse, BTechWorksClient, type BTechWorksConfig, BTechWorksError, type BroadcastOptions, type BroadcastResponse, type SendDocumentOptions, type SendMessageOptions, type SendPhotoOptions, type SendTemplateOptions, type SendVideoOptions };

package/dist/index.js

@@ -0,0 +1,190 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  BTechWorksClient: () => BTechWorksClient,
+  BTechWorksError: () => BTechWorksError
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/client.ts
+var BTechWorksError = class extends Error {
+  constructor(message, statusCode, details) {
+    super(message);
+    this.name = "BTechWorksError";
+    this.statusCode = statusCode;
+    this.details = details;
+  }
+};
+var BTechWorksClient = class {
+  constructor(config) {
+    if (!config.apiKey) {
+      throw new Error("apiKey is required");
+    }
+    if (!config.secretKey) {
+      throw new Error("secretKey is required");
+    }
+    this.apiKey = config.apiKey;
+    this.secretKey = config.secretKey;
+    this.baseUrl = (config.baseUrl || "https://api.btechworks.io").replace(/\/+$/, "");
+    this.timeout = config.timeout || 3e4;
+  }
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  async request(path, options = {}) {
+    const url = `${this.baseUrl}${path}`;
+    const headers = {
+      "x-api-key": this.apiKey,
+      "x-secret-key": this.secretKey,
+      "Content-Type": "application/json",
+      ...options.headers
+    };
+    const controller = new AbortController();
+    const timeoutId = setTimeout(() => controller.abort(), this.timeout);
+    try {
+      const response = await globalThis.fetch(url, {
+        ...options,
+        headers,
+        signal: controller.signal
+      });
+      const data = await response.json();
+      if (!response.ok) {
+        throw new BTechWorksError(
+          data.error || `Request failed with status ${response.status}`,
+          response.status,
+          data
+        );
+      }
+      return data;
+    } catch (error) {
+      if (error instanceof BTechWorksError) throw error;
+      if (error instanceof DOMException && error.name === "AbortError") {
+        throw new BTechWorksError("Request timeout", 408);
+      }
+      throw new BTechWorksError(
+        error instanceof Error ? error.message : "Unknown error",
+        500
+      );
+    } finally {
+      clearTimeout(timeoutId);
+    }
+  }
+  async sendMessage(options) {
+    const data = await this.request("/api/sdk/send-message", {
+      method: "POST",
+      body: JSON.stringify({
+        phone: options.phone,
+        message: options.message
+      })
+    });
+    return {
+      success: data.success,
+      message_id: data.message_id,
+      whatsapp_message_id: data.whatsapp_message_id
+    };
+  }
+  async sendPhoto(options) {
+    const data = await this.request("/api/sdk/send-photo", {
+      method: "POST",
+      body: JSON.stringify({
+        phone: options.phone,
+        image_url: options.imageUrl,
+        caption: options.caption
+      })
+    });
+    return {
+      success: data.success,
+      message_id: data.message_id,
+      whatsapp_message_id: data.whatsapp_message_id
+    };
+  }
+  async sendVideo(options) {
+    const data = await this.request("/api/sdk/send-video", {
+      method: "POST",
+      body: JSON.stringify({
+        phone: options.phone,
+        video_url: options.videoUrl,
+        caption: options.caption
+      })
+    });
+    return {
+      success: data.success,
+      message_id: data.message_id,
+      whatsapp_message_id: data.whatsapp_message_id
+    };
+  }
+  async sendDocument(options) {
+    const data = await this.request("/api/sdk/send-document", {
+      method: "POST",
+      body: JSON.stringify({
+        phone: options.phone,
+        document_url: options.documentUrl,
+        filename: options.filename,
+        caption: options.caption
+      })
+    });
+    return {
+      success: data.success,
+      message_id: data.message_id,
+      whatsapp_message_id: data.whatsapp_message_id
+    };
+  }
+  async sendTemplate(options) {
+    const data = await this.request("/api/sdk/send-template", {
+      method: "POST",
+      body: JSON.stringify({
+        phone: options.phone,
+        template_name: options.templateName,
+        template_language: options.templateLanguage,
+        template_params: options.templateParams,
+        template_message_params: options.templateMessageParams
+      })
+    });
+    return {
+      success: data.success,
+      message_id: data.message_id,
+      whatsapp_message_id: data.whatsapp_message_id
+    };
+  }
+  async broadcast(options) {
+    const data = await this.request("/api/sdk/broadcast", {
+      method: "POST",
+      body: JSON.stringify({
+        name: options.name,
+        template_name: options.templateName,
+        template_language: options.templateLanguage,
+        template_variables: options.templateVariables,
+        recipients: options.recipients,
+        audience_filter: options.audienceFilter
+      })
+    });
+    return {
+      success: data.success,
+      broadcast_id: data.broadcast_id,
+      total_recipients: data.total_recipients,
+      status: data.status
+    };
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  BTechWorksClient,
+  BTechWorksError
+});

package/dist/index.mjs

@@ -0,0 +1,162 @@
+// src/client.ts
+var BTechWorksError = class extends Error {
+  constructor(message, statusCode, details) {
+    super(message);
+    this.name = "BTechWorksError";
+    this.statusCode = statusCode;
+    this.details = details;
+  }
+};
+var BTechWorksClient = class {
+  constructor(config) {
+    if (!config.apiKey) {
+      throw new Error("apiKey is required");
+    }
+    if (!config.secretKey) {
+      throw new Error("secretKey is required");
+    }
+    this.apiKey = config.apiKey;
+    this.secretKey = config.secretKey;
+    this.baseUrl = (config.baseUrl || "https://api.btechworks.io").replace(/\/+$/, "");
+    this.timeout = config.timeout || 3e4;
+  }
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  async request(path, options = {}) {
+    const url = `${this.baseUrl}${path}`;
+    const headers = {
+      "x-api-key": this.apiKey,
+      "x-secret-key": this.secretKey,
+      "Content-Type": "application/json",
+      ...options.headers
+    };
+    const controller = new AbortController();
+    const timeoutId = setTimeout(() => controller.abort(), this.timeout);
+    try {
+      const response = await globalThis.fetch(url, {
+        ...options,
+        headers,
+        signal: controller.signal
+      });
+      const data = await response.json();
+      if (!response.ok) {
+        throw new BTechWorksError(
+          data.error || `Request failed with status ${response.status}`,
+          response.status,
+          data
+        );
+      }
+      return data;
+    } catch (error) {
+      if (error instanceof BTechWorksError) throw error;
+      if (error instanceof DOMException && error.name === "AbortError") {
+        throw new BTechWorksError("Request timeout", 408);
+      }
+      throw new BTechWorksError(
+        error instanceof Error ? error.message : "Unknown error",
+        500
+      );
+    } finally {
+      clearTimeout(timeoutId);
+    }
+  }
+  async sendMessage(options) {
+    const data = await this.request("/api/sdk/send-message", {
+      method: "POST",
+      body: JSON.stringify({
+        phone: options.phone,
+        message: options.message
+      })
+    });
+    return {
+      success: data.success,
+      message_id: data.message_id,
+      whatsapp_message_id: data.whatsapp_message_id
+    };
+  }
+  async sendPhoto(options) {
+    const data = await this.request("/api/sdk/send-photo", {
+      method: "POST",
+      body: JSON.stringify({
+        phone: options.phone,
+        image_url: options.imageUrl,
+        caption: options.caption
+      })
+    });
+    return {
+      success: data.success,
+      message_id: data.message_id,
+      whatsapp_message_id: data.whatsapp_message_id
+    };
+  }
+  async sendVideo(options) {
+    const data = await this.request("/api/sdk/send-video", {
+      method: "POST",
+      body: JSON.stringify({
+        phone: options.phone,
+        video_url: options.videoUrl,
+        caption: options.caption
+      })
+    });
+    return {
+      success: data.success,
+      message_id: data.message_id,
+      whatsapp_message_id: data.whatsapp_message_id
+    };
+  }
+  async sendDocument(options) {
+    const data = await this.request("/api/sdk/send-document", {
+      method: "POST",
+      body: JSON.stringify({
+        phone: options.phone,
+        document_url: options.documentUrl,
+        filename: options.filename,
+        caption: options.caption
+      })
+    });
+    return {
+      success: data.success,
+      message_id: data.message_id,
+      whatsapp_message_id: data.whatsapp_message_id
+    };
+  }
+  async sendTemplate(options) {
+    const data = await this.request("/api/sdk/send-template", {
+      method: "POST",
+      body: JSON.stringify({
+        phone: options.phone,
+        template_name: options.templateName,
+        template_language: options.templateLanguage,
+        template_params: options.templateParams,
+        template_message_params: options.templateMessageParams
+      })
+    });
+    return {
+      success: data.success,
+      message_id: data.message_id,
+      whatsapp_message_id: data.whatsapp_message_id
+    };
+  }
+  async broadcast(options) {
+    const data = await this.request("/api/sdk/broadcast", {
+      method: "POST",
+      body: JSON.stringify({
+        name: options.name,
+        template_name: options.templateName,
+        template_language: options.templateLanguage,
+        template_variables: options.templateVariables,
+        recipients: options.recipients,
+        audience_filter: options.audienceFilter
+      })
+    });
+    return {
+      success: data.success,
+      broadcast_id: data.broadcast_id,
+      total_recipients: data.total_recipients,
+      status: data.status
+    };
+  }
+};
+export {
+  BTechWorksClient,
+  BTechWorksError
+};

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "btechworks-sdk",
+  "version": "1.0.0",
+  "description": "Official BatchWorks WhatsApp CRM SDK - Send messages, photos, videos, documents, templates, and broadcasts via API",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "dev": "tsup src/index.ts --format cjs,esm --dts --watch"
+  },
+  "keywords": [
+    "whatsapp",
+    "crm",
+    "api",
+    "sdk",
+    "messaging",
+    "broadcast",
+    "template",
+    "batchworks"
+  ],
+  "author": "BatchWorks",
+  "license": "MIT",
+  "devDependencies": {
+    "tsup": "^8.0.0",
+    "typescript": "^5.3.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}