Feature/whatsapp

[y-aithnini]

Summary

• What does this PR change?

Why

• Why is this change needed?

Checklist

• Added/updated tests (if behavior changed)
• npm run lint passes
• npm run typecheck passes
• npm test passes
• npm run build passes
• Added a changeset (npx changeset) if this affects consumers

Notes

• Anything reviewers should pay attention to?

[Copilot]

Pull request overview

Adds WhatsApp as a first-class notification channel and introduces Twilio + mock WhatsApp sender implementations, alongside extensive documentation/comment updates across the core, Nest integration, and public docs.

Changes:

• Added WHATSAPP channel plus new WhatsApp sender implementations (TwilioWhatsAppSender, MockWhatsAppSender) and exports.
• Expanded Nest module/provider factory documentation and updated README/docs with WhatsApp + template guidance.
• Added/expanded core documentation blocks across types/ports/service/errors/dtos.

Reviewed changes

Copilot reviewed 17 out of 17 changed files in this pull request and generated 15 comments.

Show a summary per file

File	Description
src/nest/providers.ts	Adds extensive documentation around provider factory behavior.
src/nest/module.ts	Updates module docs and modifies async registration flow.
src/nest/index.ts	Adds public API documentation for Nest integration exports.
src/infra/senders/whatsapp/twilio-whatsapp.sender.ts	New Twilio-based WhatsApp sender implementation.
src/infra/senders/whatsapp/mock-whatsapp.sender.ts	New mock WhatsApp sender for dev/testing.
src/infra/senders/whatsapp/index.ts	Barrel export for WhatsApp senders.
src/infra/senders/index.ts	Exposes WhatsApp senders from infra senders index.
src/infra/senders/email/nodemailer.sender.ts	Adds extensive docs/comments to Nodemailer sender.
src/index.ts	Adds package entry-point documentation.
src/core/types.ts	Adds WHATSAPP to NotificationChannel and expands docs.
src/core/ports.ts	Expands docs for ports and query criteria examples.
src/core/notification.service.ts	Adds extensive documentation/comments to core send flow.
src/core/index.ts	Adds documentation for core export index.
src/core/errors.ts	Adds extensive documentation for error hierarchy/usage.
src/core/dtos.ts	Adds extensive docs/comments for Zod DTO schemas.
docs/TEMPLATE_CONFIGURATION.md	New template configuration guide (provider vs global templates).
README.md	Updates positioning, adds WhatsApp section, and revises template guidance.

Comments suppressed due to low confidence (1)

src/core/dtos.ts:159

• CreateNotificationDtoSchema cross-field validation doesn’t include NotificationChannel.WHATSAPP. As a result, WhatsApp notifications can pass DTO validation without recipient.phone, even though senders (and the WhatsApp channel semantics) require it. Extend the .refine() logic to require recipient.phone for WHATSAPP (and add/adjust DTO tests accordingly).

  .refine(
    (data) => {
      // Cross-field validation: Ensure recipient has required contact info for channel
      // Email channel requires email address
      if (data.channel === NotificationChannel.EMAIL && !data.recipient.email) {
        return false;
      }
      // SMS channel requires phone number
      if (data.channel === NotificationChannel.SMS && !data.recipient.phone) {
        return false;
      }
      // Push channel requires device token
      if (data.channel === NotificationChannel.PUSH && !data.recipient.deviceToken) {
        return false;
      }
      return true;

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
1.9% Duplication on New Code

See analysis details on SonarQube Cloud