nest-whatsapp 1.0.1

package/LICENSE

@@ -0,0 +1,74 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+   (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!)  The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

package/README.md

@@ -0,0 +1,382 @@
+# nest-whatsapp
+
+[![npm version](https://img.shields.io/npm/v/nest-whatsapp)](https://www.npmjs.com/package/nest-whatsapp)
+[![Build Status](https://github.com/SoftZenIT/nest-whatsapp/actions/workflows/ci.yml/badge.svg)](https://github.com/SoftZenIT/nest-whatsapp/actions)
+[![Coverage Status](https://coveralls.io/repos/github/SoftZenIT/nest-whatsapp/badge.svg?branch=main)](https://coveralls.io/github/SoftZenIT/nest-whatsapp?branch=main)
+[![Docs](https://img.shields.io/badge/docs-pages-blue)](https://SoftZenIT.github.io/nest-whatsapp/)
+
+NestJS module for seamless integration with the WhatsApp Cloud API, supporting sandbox & live modes, multi-clients, webhooks, microservice transport, metrics, and health checks.
+
+## Features
+
+- Send 10 message types: text, image, audio, document, location, template, video, sticker, reaction, and interactive — all returning the message ID (`Promise<string>`) with optional reply threading via `replyToMessageId`
+- Session management helpers (`startSession`, `endSession`)
+- Sandbox mode for rapid testing
+- Live mode for production with template enforcement and rate limits
+- Webhook verification & event emitting
+- Nest microservice transport (TCP)
+- Prometheus metrics and Nest Terminus health indicator
+- Full TypeScript support (CJS & ESM)
+- Easy configuration via `forRoot` / `forRootAsync`
+- CLI schematic: `nest generate whatsapp`
+
+## Quickstart
+
+```bash
+npm install nest-whatsapp
+```
+
+**Step 1:** Create the config file `src/config/whatsapp.config.ts`:
+
+```ts
+import { registerAs } from '@nestjs/config';
+import * as Joi from 'joi';
+
+export default registerAs('whatsapp', () => ({
+  mode: process.env.WHATSAPP_MODE,
+  sandbox: {
+    testPhoneNumberId: process.env.WHATSAPP_SANDBOX_PHONE_NUMBER_ID,
+    temporaryAccessToken: process.env.WHATSAPP_SANDBOX_ACCESS_TOKEN,
+    testRecipients: process.env.WHATSAPP_SANDBOX_TEST_RECIPIENTS?.split(',') || [],
+  },
+  live: {
+    businessAccountId: process.env.WHATSAPP_LIVE_BUSINESS_ACCOUNT_ID,
+    phoneNumberId: process.env.WHATSAPP_LIVE_PHONE_NUMBER_ID,
+    accessToken: process.env.WHATSAPP_LIVE_ACCESS_TOKEN,
+  },
+}));
+
+export const WhatsappConfigSchema = Joi.object({
+  WHATSAPP_MODE: Joi.string().valid('sandbox', 'live').required(),
+  WHATSAPP_SANDBOX_PHONE_NUMBER_ID: Joi.string().when('WHATSAPP_MODE', {
+    is: 'sandbox',
+    then: Joi.required(),
+  }),
+  WHATSAPP_SANDBOX_ACCESS_TOKEN: Joi.string().when('WHATSAPP_MODE', {
+    is: 'sandbox',
+    then: Joi.required(),
+  }),
+  WHATSAPP_SANDBOX_TEST_RECIPIENTS: Joi.string().when('WHATSAPP_MODE', {
+    is: 'sandbox',
+    then: Joi.required(),
+  }),
+  WHATSAPP_LIVE_BUSINESS_ACCOUNT_ID: Joi.string().when('WHATSAPP_MODE', {
+    is: 'live',
+    then: Joi.required(),
+  }),
+  WHATSAPP_LIVE_PHONE_NUMBER_ID: Joi.string().when('WHATSAPP_MODE', {
+    is: 'live',
+    then: Joi.required(),
+  }),
+  WHATSAPP_LIVE_ACCESS_TOKEN: Joi.string().when('WHATSAPP_MODE', {
+    is: 'live',
+    then: Joi.required(),
+  }),
+  WHATSAPP_WEBHOOK_VERIFY_TOKEN: Joi.string().required(),
+  WHATSAPP_APP_SECRET: Joi.string().required(),
+});
+```
+
+**Step 2:** Set up your module `src/app.module.ts`:
+
+```ts
+import { Module } from '@nestjs/common';
+import { ConfigModule, ConfigService } from '@nestjs/config';
+import whatsappConfig, { WhatsappConfigSchema } from './config/whatsapp.config';
+import { WhatsAppModule } from 'nest-whatsapp';
+
+@Module({
+  imports: [
+    ConfigModule.forRoot({
+      isGlobal: true,
+      load: [whatsappConfig],
+      validationSchema: WhatsappConfigSchema,
+    }),
+    WhatsAppModule.forRootAsync({
+      imports: [ConfigModule],
+      inject: [ConfigService],
+      useFactory: (cs: ConfigService) => {
+        const cfg = cs.get('whatsapp');
+        return cfg.mode === 'sandbox'
+          ? {
+              mode: 'sandbox',
+              testPhoneNumberId: cfg.sandbox.testPhoneNumberId,
+              temporaryAccessToken: cfg.sandbox.temporaryAccessToken,
+              testRecipients: cfg.sandbox.testRecipients,
+            }
+          : {
+              mode: 'live',
+              businessAccountId: cfg.live.businessAccountId,
+              phoneNumberId: cfg.live.phoneNumberId,
+              accessToken: cfg.live.accessToken,
+            };
+      },
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+## Configuration
+
+Use environment variables or secret manager via `forRootAsync`:
+
+| Variable                            | Description                               | Required             |
+| ----------------------------------- | ----------------------------------------- | -------------------- |
+| `WHATSAPP_MODE`                     | `sandbox` or `live`                       | yes                  |
+| `WHATSAPP_SANDBOX_PHONE_NUMBER_ID`  | Sandbox phone number ID                   | if `sandbox`         |
+| `WHATSAPP_SANDBOX_ACCESS_TOKEN`     | Sandbox temporary access token            | if `sandbox`         |
+| `WHATSAPP_SANDBOX_TEST_RECIPIENTS`  | Comma-separated test recipient numbers    | if `sandbox`         |
+| `WHATSAPP_LIVE_BUSINESS_ACCOUNT_ID` | Live business account ID                  | if `live`            |
+| `WHATSAPP_LIVE_PHONE_NUMBER_ID`     | Live phone number ID                      | if `live`            |
+| `WHATSAPP_LIVE_ACCESS_TOKEN`        | Live long-lived access token              | if `live`            |
+| `WHATSAPP_WEBHOOK_VERIFY_TOKEN`     | Webhook verification token                | yes                  |
+| `WHATSAPP_APP_SECRET`               | App secret for HMAC verification          | yes                  |
+| `WHATSAPP_WEBHOOK_MAX_BODY_BYTES`   | Maximum raw webhook payload size          | no (default 2 MB)    |
+| `WHATSAPP_MASK_PHONE_LOGS`          | Mask phone numbers in logs (`true/false`) | no (default `true`)  |
+| `WHATSAPP_LOG_MESSAGE_BODIES`       | Log outbound payload bodies (dangerous)   | no (default `false`) |
+| `WHATSAPP_HEALTH_TIMEOUT_MS`        | Graph API health probe timeout (ms)       | no (default `3000`)  |
+| `WHATSAPP_HEALTH_SKIP_EXTERNAL`     | Skip outbound health probe (`true/false`) | no (default `false`) |
+
+### Advanced HTTP settings (optional)
+
+- `WHATSAPP_GRAPH_API_VERSION` — Graph API version used for outbound requests. Default: `v17.0`.
+- `WHATSAPP_HTTP_TIMEOUT_MS` — Axios request timeout in milliseconds. Default: `10000`.
+- `WHATSAPP_HTTP_RETRIES` — Number of retry attempts for retryable errors (network/5xx/429). Default: `2`.
+- `WHATSAPP_HTTP_MAX_RETRY_DELAY_MS` — Cap for exponential backoff with jitter. Default: `5000`.
+- Per-client overrides: set `httpConfig` on each `WhatsAppClientOptions` entry to merge in custom Axios settings (proxies, params, etc.). Authorization headers are managed automatically.
+
+### Runtime tuning
+
+To override the global HTTP/retry/logging defaults via DI instead of environment variables, provide `WHATSAPP_RUNTIME_OPTIONS`:
+
+```ts
+import { Module } from '@nestjs/common';
+import { WhatsAppModule, WHATSAPP_RUNTIME_OPTIONS } from 'nest-whatsapp';
+
+@Module({
+  imports: [WhatsAppModule.forRoot(/* ... */)],
+  providers: [
+    {
+      provide: WHATSAPP_RUNTIME_OPTIONS,
+      useValue: { httpTimeoutMs: 5000, maskPhoneLogs: false },
+    },
+  ],
+})
+export class MessagingModule {}
+```
+
+When this provider is absent, the module falls back to the environment variables listed above.
+
+## Usage Examples
+
+### Handling Incoming Messages
+
+The webhook endpoint (`GET/POST /whatsapp/webhook`) is **automatically registered** when you import `WhatsAppModule`. You do not need to write a controller for it. To react to incoming messages, inject `WhatsAppEvents` into your own service and subscribe in `onModuleInit`:
+
+```ts
+import { Injectable, OnModuleInit } from ‘@nestjs/common’;
+import { WhatsAppEvents } from ‘nest-whatsapp’;
+
+@Injectable()
+export class MessageHandlerService implements OnModuleInit {
+  constructor(private readonly events: WhatsAppEvents) {}
+
+  onModuleInit(): void {
+    this.events.onTextReceived(({ message, contact }) => {
+      console.log(‘Text:’, message.text.body, ‘from’, contact?.wa_id);
+    });
+  }
+}
+```
+
+> Tip: install `eventemitter2` or `@nestjs/event-emitter` if you want wildcard listeners. Without them the module falls back to Node’s `events` emitter, which supports the same API used here but without the extra helpers.
+
+### Microservice Transport
+
+```ts
+@Module({
+  imports: [WhatsAppModule.forMicroservice({ host: 'localhost', port: 4000 })],
+})
+export class MicroAppModule {}
+```
+
+### Metrics & Health
+
+```ts
+@Controller('metrics')
+export class MetricsController {
+  constructor(private readonly metrics: WhatsAppMetricsService) {}
+  @Get() public metrics() {
+    return this.metrics.getMetrics();
+  }
+}
+```
+
+Exposed Prometheus metrics:
+
+- `whatsapp_messages_sent_total` — counter, increments on successful message sends. Labels: `type`, `mode`.
+- `whatsapp_errors_total` — counter, increments on send errors. Labels: `type`, `mode`, `status`.
+- `whatsapp_webhook_events_total` — counter, increments on webhook receive.
+- `whatsapp_request_duration_seconds` — histogram, outbound request latency. Labels: `type`, `mode`, `status`.
+- `whatsapp_build_info` — gauge with labels `version`, `node_version`, `environment`, always `1` for scrape-friendly metadata.
+
+Tip: use relabeling to add instance labels; see the example app for the `/metrics` endpoint.
+
+### Webhook Security & CSRF
+
+- Signature verification: the controller validates `x-hub-signature-256` with an HMAC‐SHA256 using your `WHATSAPP_APP_SECRET`, using constant‑time comparison.
+- Raw body is required and size-limited: set `WHATSAPP_WEBHOOK_MAX_BODY_BYTES` (default `2_000_000`) and ensure your Nest bootstrap captures the raw buffer with the same `bodyParser.json` limit:
+
+```ts
+app.use(
+  bodyParser.json({
+    limit: '2mb',
+    verify: (req, _res, buf) => ((req as any).rawBody = buf),
+  })
+);
+```
+
+- CSRF: not required for the WhatsApp webhook route because requests are authenticated by HMAC and originate from Meta. For your own browser‑facing endpoints, configure CSRF as appropriate for your app.
+
+### Sandbox Safety
+
+- Sandbox sends are restricted to the `testRecipients` allow‑list supplied in `WhatsAppSandboxOptions`. Calls to `send*` will fail fast if the list is empty or the recipient is not whitelisted.
+- Logs mask phone numbers by default; opt out via `WHATSAPP_MASK_PHONE_LOGS=false`.
+- Payload bodies are **not** logged unless you explicitly enable `WHATSAPP_LOG_MESSAGE_BODIES=true`.
+
+## Typed Events & Helpers
+
+- Facade `WhatsAppEvents` exposes typed events:
+  - Raw: `message_received`
+  - Sub-events: `text_received`, `image_received`, `audio_received`, `document_received`, `location_received`, `template_received`, `interactive_received`, `contacts_received`, `system_received`, `order_received`, `product_received`, `reaction_received`.
+  - Delivery receipts: `status_received` — carries `WhatsAppStatusEvent` with delivery and read receipt data; subscribe via `onStatusReceived()` / `offStatusReceived()`.
+- Subscribe (inside `onModuleInit` or a constructor-safe lifecycle hook):
+
+```ts
+import { Injectable, OnModuleInit } from '@nestjs/common';
+import { WhatsAppEvents } from 'nest-whatsapp';
+
+@Injectable()
+export class MessageHandlerService implements OnModuleInit {
+  constructor(private readonly events: WhatsAppEvents) {}
+
+  onModuleInit(): void {
+    this.events.onTextReceived(({ message, contact }) => {
+      console.log('Text:', message.text.body, 'from', contact?.wa_id);
+    });
+  }
+}
+```
+
+- Helpers in `utils/webhook`:
+  - `getFirstMessage`, `getFirstContact`, `getAllMessages`, `getAllStatuses`
+  - Type guards: `isTextMessage`, `isImageMessage`, `isInteractiveMessage`, etc.
+
+## Health & Microservice (optional)
+
+### Health Indicator
+
+- Install peer: `npm i -S @nestjs/terminus`
+- Import health providers only when needed:
+- `WHATSAPP_HEALTH_TIMEOUT_MS` controls the outbound probe timeout; use `WHATSAPP_HEALTH_SKIP_EXTERNAL=true` for environments without egress.
+
+```ts
+import { Module } from '@nestjs/common';
+import { WhatsAppModule } from 'nest-whatsapp';
+
+@Module({
+  imports: [WhatsAppModule.forHealth()],
+})
+export class HealthModule {}
+```
+
+### Microservice Client
+
+- Install peer if using microservices: `npm i -S @nestjs/microservices`
+- Register a TCP client with lazy-loaded microservices support:
+
+```ts
+import { Module } from '@nestjs/common';
+import { WhatsAppModule } from 'nest-whatsapp';
+
+@Module({
+  imports: [
+    WhatsAppModule.forMicroservice({ host: '127.0.0.1', port: 4000, clientName: 'WA_CLIENT' }),
+  ],
+})
+export class MessagingModule {}
+```
+
+- `clientName` must be non-empty when provided; defaults to `WHATSAPP_MICROSERVICE`.
+- Use DTOs + `class-validator` to validate inbound TCP payloads (see `examples/microservice` for ready-made `wa.sendText`, `wa.sendTemplate`, `wa.sendMedia`, `wa.sendDocument`, and `wa.sendLocation` patterns).
+
+## CLI Schematic
+
+```bash
+nest generate whatsapp
+```
+
+### Schematic Usage (standalone)
+
+- Build first: `npm run build`
+- Sandbox with health + micro:
+  - `npx schematics nest-whatsapp:whatsapp --module=src/app.module.ts --mode=sandbox --add-health --add-micro --host=127.0.0.1 --port=4000`
+- Sandbox with explicit creds:
+  - `npx schematics nest-whatsapp:whatsapp --module=src/app.module.ts --mode=sandbox --test-phone-number-id=123 --temporary-access-token=TOKEN --test-recipients=+15551234567,+15557654321`
+- Live configuration:
+  - `npx schematics nest-whatsapp:whatsapp --module=src/app.module.ts --mode=live --business-account-id=BA_ID --phone-number-id=PN_ID --access-token=ACCESS_TOKEN`
+
+#### Notes
+
+- Options use dashed names (e.g., `--add-health`, not `--addHealth`).
+- The schematic now wires `WhatsAppModule.forRootAsync(...)` + `ConfigModule` by default; adjust the generated factory to map your configuration layer if needed.
+
+## Documentation
+
+```bash
+npx typedoc --out docs src
+```
+
+## Migration Notes
+
+- Webhook payloads are now capped by `WHATSAPP_WEBHOOK_MAX_BODY_BYTES` (default 2 MB). Increase the limit explicitly if you previously accepted larger requests.
+- Sandbox sends strictly enforce `testRecipients`; provide at least one recipient or use live mode.
+- Phone numbers are masked in logs by default and payload bodies remain hidden unless `WHATSAPP_LOG_MESSAGE_BODIES=true`.
+- The schematic and examples now default to `WhatsAppModule.forRootAsync` with `@nestjs/config`. Update custom templates accordingly.
+
+## Run Examples
+
+- Install example deps: `npm run examples:install`
+- Option A (recommended): use the published package (no extra steps).
+- Option B (local development): build and install locally
+  - `npm run build && npm pack` (note the generated `.tgz` file)
+  - In each example folder: `npm install ../../nest-whatsapp-*.tgz`
+
+### Basic HTTP example
+
+- Env (sandbox mode):
+  - `WHATSAPP_MODE=sandbox`
+  - `WHATSAPP_SANDBOX_PHONE_NUMBER_ID=...`
+  - `WHATSAPP_SANDBOX_ACCESS_TOKEN=...`
+  - `WHATSAPP_SANDBOX_TEST_RECIPIENTS=+15551234567`
+- Env (live mode):
+  - `WHATSAPP_MODE=live`
+  - `WHATSAPP_LIVE_BUSINESS_ACCOUNT_ID=...`
+  - `WHATSAPP_LIVE_PHONE_NUMBER_ID=...`
+  - `WHATSAPP_LIVE_ACCESS_TOKEN=...`
+- Run: `npm run example:basic`
+- Send a message:
+  - `curl -X POST localhost:3000/messages/text -H 'Content-Type: application/json' -d '{"to":"+15551234567","message":"Hello"}'`
+
+### Microservice example
+
+- Env:
+  - `WHATSAPP_MICROSERVICE_HOST=127.0.0.1`
+  - `WHATSAPP_MICROSERVICE_PORT=4000`
+- Run: `npm run example:micro`
+- Run demo client: `npm --prefix examples/microservice run demo`
+
+## License
+
+Apache-2.0

package/dist/cjs/controllers/whatsapp.controller.js

@@ -0,0 +1,139 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+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 __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+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.WhatsAppController = void 0;
+const common_1 = require("@nestjs/common");
+const whatsapp_events_1 = require("../services/whatsapp.events");
+const config_1 = require("@nestjs/config");
+const crypto = __importStar(require("crypto"));
+const whatsapp_metrics_1 = require("../services/whatsapp.metrics");
+let WhatsAppController = class WhatsAppController {
+    events;
+    configService;
+    metrics;
+    constructor(events, configService, metrics) {
+        this.events = events;
+        this.configService = configService;
+        this.metrics = metrics;
+    }
+    verify(req) {
+        const mode = req.query['hub.mode'];
+        const token = req.query['hub.verify_token'];
+        const rawChallenge = req.query['hub.challenge'];
+        if (mode === 'subscribe' &&
+            token ===
+                (this.configService?.get('WHATSAPP_WEBHOOK_VERIFY_TOKEN') ??
+                    process.env['WHATSAPP_WEBHOOK_VERIFY_TOKEN'])) {
+            const challenge = typeof rawChallenge === 'string' ? rawChallenge : '';
+            const MAX_CHALLENGE_LENGTH = 256;
+            if (challenge.length === 0 ||
+                challenge.length > MAX_CHALLENGE_LENGTH ||
+                !/^[A-Za-z0-9._-]+$/.test(challenge)) {
+                throw new common_1.UnauthorizedException();
+            }
+            return challenge;
+        }
+        throw new common_1.UnauthorizedException();
+    }
+    receive(req, signature) {
+        const rawBody = req.rawBody;
+        const appSecret = this.configService?.get('WHATSAPP_APP_SECRET') ?? process.env['WHATSAPP_APP_SECRET'];
+        const maxBodyBytes = this.resolveMaxBodyBytes();
+        if (!appSecret || !rawBody || !signature) {
+            throw new common_1.UnauthorizedException();
+        }
+        if (rawBody.length > maxBodyBytes) {
+            throw new common_1.PayloadTooLargeException(`Webhook payload exceeds ${maxBodyBytes} bytes, request rejected`);
+        }
+        // Enforce prefix and perform a timing-safe comparison of the HMAC
+        const prefix = 'sha256=';
+        if (!signature.startsWith(prefix)) {
+            throw new common_1.UnauthorizedException();
+        }
+        const providedHex = signature.slice(prefix.length);
+        const expectedHex = crypto.createHmac('sha256', appSecret).update(rawBody).digest('hex');
+        const provided = Buffer.from(providedHex, 'hex');
+        const expected = Buffer.from(expectedHex, 'hex');
+        if (provided.length !== expected.length || !crypto.timingSafeEqual(provided, expected)) {
+            throw new common_1.UnauthorizedException();
+        }
+        this.events.emitMessageReceived(req.body);
+        this.metrics?.incrementWebhookEvents();
+        return 'EVENT_RECEIVED';
+    }
+    resolveMaxBodyBytes() {
+        const fromConfig = this.configService?.get('WHATSAPP_WEBHOOK_MAX_BODY_BYTES') ??
+            process.env['WHATSAPP_WEBHOOK_MAX_BODY_BYTES'];
+        const parsed = Number(fromConfig ?? 2_000_000);
+        return Number.isFinite(parsed) && parsed > 0 ? parsed : 2_000_000;
+    }
+};
+exports.WhatsAppController = WhatsAppController;
+__decorate([
+    (0, common_1.Get)(),
+    __param(0, (0, common_1.Req)()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", String)
+], WhatsAppController.prototype, "verify", null);
+__decorate([
+    (0, common_1.Post)(),
+    __param(0, (0, common_1.Req)()),
+    __param(1, (0, common_1.Headers)('x-hub-signature-256')),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object, String]),
+    __metadata("design:returntype", String)
+], WhatsAppController.prototype, "receive", null);
+exports.WhatsAppController = WhatsAppController = __decorate([
+    (0, common_1.Controller)('whatsapp/webhook'),
+    __param(1, (0, common_1.Optional)()),
+    __param(2, (0, common_1.Optional)()),
+    __metadata("design:paramtypes", [whatsapp_events_1.WhatsAppEvents,
+        config_1.ConfigService,
+        whatsapp_metrics_1.WhatsAppMetricsService])
+], WhatsAppController);
+//# sourceMappingURL=whatsapp.controller.js.map

package/dist/cjs/exceptions/whatsapp.exceptions.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WhatsAppSandboxRecipientException = exports.WhatsAppRateLimitException = exports.WhatsAppAuthException = void 0;
+const common_1 = require("@nestjs/common");
+class WhatsAppAuthException extends common_1.HttpException {
+    constructor() {
+        super('WhatsApp authentication failed', common_1.HttpStatus.UNAUTHORIZED);
+    }
+}
+exports.WhatsAppAuthException = WhatsAppAuthException;
+class WhatsAppRateLimitException extends common_1.HttpException {
+    constructor() {
+        super('WhatsApp rate limit exceeded', common_1.HttpStatus.TOO_MANY_REQUESTS);
+    }
+}
+exports.WhatsAppRateLimitException = WhatsAppRateLimitException;
+class WhatsAppSandboxRecipientException extends common_1.HttpException {
+    constructor(message = 'Recipient not allowed in WhatsApp sandbox mode') {
+        super(message, common_1.HttpStatus.BAD_REQUEST);
+    }
+}
+exports.WhatsAppSandboxRecipientException = WhatsAppSandboxRecipientException;
+//# sourceMappingURL=whatsapp.exceptions.js.map