@zindua/sdk 1.2.4 → 1.2.6

package/README.md

@@ -14,6 +14,8 @@ npm install @zindua/sdk
 
 **Requirements:** Node.js 18+, run only on your **backend** (not in the browser).
 
+**Dependencies:** `@zindua/sdk` has **no runtime npm dependencies**. After `npm install`, you are done — no second package to add. The client uses Node’s built-in `fetch` (Node 18+).
+
 ---
 
 ## Quick start
@@ -24,7 +26,7 @@ npm install @zindua/sdk
 2. Open **Projects** → create a project (or use an existing one).
 3. Copy the API key (`znd_live_…` for production, `znd_test_…` for sandbox).
 4. In the project: connect **Service** (Gmail, SMTP, …) for email, and/or link **WhatsApp** for OTP.
-5. Create at least one **template** (e.g. slug `otp`, `welcome`).
+5. Create at least one **template** (e.g. slug `otp`, `welcome`). For several languages, add one version per language in Dashboard → Templates (and set the project **default language** in project settings).
 
 ### 2. Install and configure
 
@@ -55,7 +57,45 @@ await zindua.send({
   variables: { name: "Alex" },
 });
 
-// WhatsApp — phone in E.164 with +
+// WhatsApp — E.164 phone with + (channel is required for WhatsApp)
+await zindua.send({
+  to: "+243812345678",
+  channel: "whatsapp",
+  template: "otp",
+  variables: { code: "482910" },
+});
+```
+
+### Channel and `to` must match
+
+The SDK checks **before** calling the API (same rules as [zindua.run](https://zindua.run)). A phone number cannot be sent as email, and an email cannot be sent on WhatsApp.
+
+| `channel` | Valid `to` | Rejected (not sent) |
+|-----------|------------|---------------------|
+| `email` (default) | `user@example.com` | `+243812345678` |
+| `whatsapp` | `+243812345678` | `user@example.com` |
+
+```typescript
+// ❌ Phone with default channel email — rejected locally (INVALID_EMAIL)
+await zindua.send({ to: "+243812345678", template: "otp", variables: { code: "1" } });
+
+// ❌ Email with WhatsApp channel — rejected locally (INVALID_PHONE)
+await zindua.send({
+  to: "user@example.com",
+  channel: "whatsapp",
+  template: "otp",
+  variables: { code: "1" },
+});
+
+// ✅ User chose email for OTP
+await zindua.send({
+  to: "user@example.com",
+  channel: "email",
+  template: "otp",
+  variables: { code: "482910" },
+});
+
+// ✅ User chose WhatsApp for OTP
 await zindua.send({
   to: "+243812345678",
   channel: "whatsapp",
@@ -66,6 +106,55 @@ await zindua.send({
 
 ---
 
+## Languages (multilingual projects)
+
+When you create a project, you choose a **default language** (Dashboard → project settings). Each template can have **several language versions** (French, English, Swahili, …) with its own subject and body.
+
+When you call `send()`, pass **`lang` only if you want a specific version**. If you omit it, Zindua uses the **project default**. If the language you ask for does not exist on that template, Zindua uses the template’s **default language** and sets `langFallback: true` in the response.
+
+| What you send | What Zindua uses |
+|---------------|------------------|
+| No `lang` | Project default (e.g. `fr`) |
+| `lang: "en"` and English exists on the template | English version |
+| `lang: "de"` but only `fr` / `en` exist | Default language for that template + `langFallback: true` |
+
+```typescript
+// Default language of the project
+await zindua.send({
+  to: "user@example.com",
+  template: "otp",
+  variables: { code: "482910" },
+});
+
+// Explicit language (email or WhatsApp — same `lang` for both channels)
+const result = await zindua.send({
+  to: "+243812345678",
+  channel: "whatsapp",
+  template: "otp",
+  lang: "fr",
+  variables: { code: "482910" },
+});
+
+console.log(result.langUsed); // e.g. "fr" — language actually rendered
+console.log(result.langFallback); // true if `lang` was missing and fallback was used
+```
+
+OTP with the user’s locale (optional):
+
+```typescript
+await zindua.send({
+  to: contact,
+  channel,
+  template: "otp",
+  lang: userLocale, // e.g. "fr", "en" — omit if you want project default
+  variables: { code },
+});
+```
+
+Allowed codes: short ISO 639-1 style (`fr`, `en`, `sw`, `en-us`). Invalid format is rejected by the SDK before the HTTP call.
+
+---
+
 ## Plans and channels
 
 | Plan | Email API | WhatsApp | Email / month | WhatsApp OTP / month |
@@ -118,6 +207,46 @@ Each key only accesses **its** Zindua project (templates, service, usage).
 
 ---
 
+## Several templates in one application
+
+You do **not** need a separate SDK client per template. One `Zindua` instance, change the **`template` slug** and **`variables`** per send:
+
+```typescript
+// OTP
+await zindua.send({
+  to: "user@example.com",
+  template: "otp",
+  variables: { code: "482910" },
+});
+
+// Welcome email — different slug, different variables
+await zindua.send({
+  to: "user@example.com",
+  template: "user-welcome",
+  variables: { name: "Alex" },
+});
+```
+
+Keep slugs in one place so your code stays clear:
+
+```typescript
+const Template = {
+  otp: "otp",
+  welcome: "user-welcome",
+  resetPassword: "password-reset",
+} as const;
+
+await zindua.send({
+  to: email,
+  template: Template.welcome,
+  variables: { name },
+});
+```
+
+Each template defines its own `{{variables}}` in the dashboard. The SDK does not merge templates: one `send()` call = one template slug.
+
+---
+
 ## Framework examples
 
 Use the same pattern everywhere: **your server** holds the API key; the client app calls **your** API.
@@ -137,10 +266,16 @@ import { zindua } from "@/lib/zindua";
 import { NextResponse } from "next/server";
 
 export async function POST(req: Request) {
-  const { email, code } = await req.json();
+  const { channel, contact, code, lang } = await req.json();
+  if (channel !== "email" && channel !== "whatsapp") {
+    return NextResponse.json({ error: "channel must be email or whatsapp" }, { status: 400 });
+  }
+  // contact = email string OR +243… phone, depending on channel
   const result = await zindua.send({
-    to: email,
+    to: contact,
+    channel,
     template: "otp",
+    ...(lang ? { lang } : {}),
     variables: { code },
   });
   return NextResponse.json(result, { status: 202 });
@@ -159,11 +294,16 @@ app.use(express.json());
 const zindua = new Zindua({ apiKey: process.env.ZINDUA_API_KEY! });
 
 app.post("/api/notify", async (req, res) => {
+  const { channel, contact, code } = req.body;
+  if (channel !== "email" && channel !== "whatsapp") {
+    return res.status(400).json({ error: "channel must be email or whatsapp" });
+  }
   try {
     const result = await zindua.send({
-      to: req.body.email,
-      template: req.body.template ?? "otp",
-      variables: req.body.variables ?? {},
+      to: contact,
+      channel,
+      template: "otp",
+      variables: { code },
     });
     res.status(202).json(result);
   } catch (err) {
@@ -181,14 +321,22 @@ import { Zindua } from "@zindua/sdk";
 const zindua = new Zindua({ apiKey: process.env.ZINDUA_API_KEY! });
 const app = Fastify();
 
-app.post<{ Body: { email: string; code: string } }>("/notify", async (req, reply) => {
-  const result = await zindua.send({
-    to: req.body.email,
-    template: "otp",
-    variables: { code: req.body.code },
-  });
-  return reply.status(202).send(result);
-});
+app.post<{ Body: { channel: "email" | "whatsapp"; contact: string; code: string } }>(
+  "/notify",
+  async (req, reply) => {
+    const { channel, contact, code } = req.body;
+    if (channel !== "email" && channel !== "whatsapp") {
+      return reply.status(400).send({ error: "channel must be email or whatsapp" });
+    }
+    const result = await zindua.send({
+      to: contact,
+      channel,
+      template: "otp",
+      variables: { code },
+    });
+    return reply.status(202).send(result);
+  }
+);
 ```
 
 ### Hono
@@ -201,9 +349,13 @@ const zindua = new Zindua({ apiKey: process.env.ZINDUA_API_KEY! });
 const app = new Hono();
 
 app.post("/notify", async (c) => {
-  const { email, code } = await c.req.json();
+  const { channel, contact, code } = await c.req.json();
+  if (channel !== "email" && channel !== "whatsapp") {
+    return c.json({ error: "channel must be email or whatsapp" }, 400);
+  }
   const result = await zindua.send({
-    to: email,
+    to: contact,
+    channel,
     template: "otp",
     variables: { code },
   });
@@ -239,15 +391,45 @@ const zindua = new Zindua({
 
 | Field | Required | Description |
 |-------|----------|-------------|
-| `to` | Yes | Email address, or E.164 phone (`+243…`) for WhatsApp. |
+| `to` | Yes | **Email** if `channel` is `email` (default). **E.164 phone** (`+243…`) if `channel` is `whatsapp`. Mismatches are rejected by the SDK and by the API. |
 | `template` | Yes | Template slug from your dashboard. |
-| `channel` | No | `"email"` (default) or `"whatsapp"`. |
-| `lang` | No | `fr`, `en`, … — falls back to project default. |
+| `channel` | No | `"email"` (default) or `"whatsapp"`. Must match the format of `to`. |
+| `lang` | No | Optional. `fr`, `en`, `sw`, … — if omitted, project default; if missing on template, fallback + `langFallback: true`. |
 | `variables` | No | `{{placeholders}}` in the template. |
 | `cc`, `bcc`, `replyTo` | No | Email only. |
 
 ---
 
+## API key, recipient, and delivery — what is checked when
+
+| Situation | When you know | What to do |
+|-----------|---------------|------------|
+| Wrong or missing API key | Immediately (`401`, `INVALID_API_KEY` / `API_KEY_NOT_FOUND`) | Copy key from Dashboard → Projects |
+| Phone sent as email (or the opposite) | Immediately in the SDK (`INVALID_EMAIL` / `INVALID_PHONE`, HTTP status `0`) | Match `channel` and `to` (see above) |
+| Malformed email or phone | Immediately (SDK + API `400`) | Fix format: `user@domain.com`, `+243812345678` |
+| Typo in email (`user@gmial.com`) | **Not** blocked at send time | Request may succeed (`202`); provider may bounce later |
+| Email inbox does not exist | **Not** verified upfront | Check **Dashboard → Logs** with `logId`; configure **webhooks** (`email.delivered` / `email.failed`) |
+| Phone valid in E.164 but **no WhatsApp** on that number | **Not** verified upfront | WhatsApp send can fail after accept; status `failed` in logs |
+| Template slug wrong | API `404` `TEMPLATE_NOT_FOUND` | Create template or fix slug |
+| No Gmail/SMTP / WhatsApp not linked | API `422` | Connect **Service** or **WhatsApp** on the project |
+
+**Important:** a successful `send()` returns `logId` and often `status: "queued"`. That means Zindua accepted the message and will deliver through **your** connected email service or WhatsApp session. It does not guarantee the address exists or that WhatsApp is installed on that number.
+
+```typescript
+const result = await zindua.send({
+  to: "user@example.com",
+  template: "otp",
+  variables: { code: "123456" },
+});
+
+// Save logId — check delivery in the dashboard or via webhooks
+console.log(result.logId, result.status, result.langUsed);
+```
+
+Optional in **your** app (before calling Zindua): stricter email regex, confirmation field, or a phone library — the SDK already enforces platform format and channel rules.
+
+---
+
 ## Successful response
 
 ```typescript
@@ -260,6 +442,8 @@ const result = await zindua.send({ /* … */ });
 | `status` | `queued`, `processing`, or `sent` (test keys often return `sent` immediately). |
 | `logId` | Id for support / logs in the dashboard. |
 | `channel` | `email` or `whatsapp` |
+| `langUsed` | Language version used for this send |
+| `langFallback` | `true` if requested `lang` was missing and a fallback version was used |
 | `context` | Workspace snapshot (see below). |
 
 ### `context` object
@@ -311,9 +495,9 @@ try {
 | `INVALID_API_KEY` | 401 | Missing or malformed key. | Use `Authorization: Bearer znd_live_…` (24 chars after prefix). |
 | `API_KEY_NOT_FOUND` | 401 | Key not linked to a project. | Copy the key from Dashboard → your project. |
 | `ORIGIN_NOT_ALLOWED` | 403 | Browser origin blocked. | Prefer server-side SDK; or add origin in Dashboard → Settings → Integrations. |
-| `MISSING_FIELDS` | 400 | `to` or `template` missing. | Send both in the request body. |
-| `INVALID_EMAIL` | 400 | Bad email format. | Use `user@domain.com`. |
-| `INVALID_PHONE` | 400 | Bad WhatsApp number. | Use E.164 with `+`, e.g. `+243812345678`. |
+| `MISSING_FIELDS` | 400 / 0 | `to` or `template` missing. | Send both. Status `0` = caught by the SDK before HTTP. |
+| `INVALID_EMAIL` | 400 / 0 | Bad email, or **phone used with channel email**. | Use `user@domain.com`, or set `channel: "whatsapp"` for `+243…`. |
+| `INVALID_PHONE` | 400 / 0 | Bad WhatsApp number, or **email used with channel whatsapp**. | Use `+243812345678`, or set `channel: "email"` for an address. |
 | `NO_SUBSCRIPTION` | 403 | Workspace has no active plan. | Open Dashboard → Billing or contact support. |
 | `EMAIL_NOT_AVAILABLE` | 403 | Email not allowed on current plan setup. | Connect a Service on the project (Free), or upgrade plan. |
 | `EMAIL_SERVICE_NOT_CONFIGURED` | 422 | No Gmail/SMTP connected. | Dashboard → project → **Service**. |
@@ -339,7 +523,7 @@ Many errors include a **`context`** field (same shape as success) with `plan` an
 1. Store the API key in environment variables or a secrets manager.
 2. Call Zindua from your **API routes** only, not from React/Vue/mobile bundles.
 3. Use **`znd_test_…`** in staging; **`znd_live_…`** in production.
-4. Pin the SDK version in `package.json`, e.g. `"@zindua/sdk": "1.2.4"`.
+4. Pin the SDK version in `package.json`, e.g. `"@zindua/sdk": "1.2.6"`.
 5. One Zindua project per client when quotas, senders, or templates must stay isolated.
 
 ---

package/dist/client.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Zindua = void 0;
 const errors_1 = require("./errors");
 const validate_1 = require("./validate");
-const SDK_VERSION = "1.2.4";
+const SDK_VERSION = "1.2.6";
 const USER_AGENT = `Zindua-JS/${SDK_VERSION}`;
 function buildPayload(options, channel) {
     const to = (0, validate_1.validateRecipient)(options.to, channel);

package/dist/errors.d.ts

@@ -1,4 +1,4 @@
-export type ZinduaErrorCode = "INVALID_API_KEY" | "INVALID_BASE_URL" | "BROWSER_FORBIDDEN" | "INVALID_OPTIONS" | "INVALID_RECIPIENT" | "INVALID_TEMPLATE" | "INVALID_CHANNEL" | "INVALID_LANG" | "INVALID_VARIABLES" | "REQUEST_TIMEOUT" | "INVALID_RESPONSE" | "API_ERROR";
+export type ZinduaErrorCode = "INVALID_API_KEY" | "INVALID_BASE_URL" | "BROWSER_FORBIDDEN" | "INVALID_OPTIONS" | "INVALID_EMAIL" | "INVALID_PHONE" | "MISSING_FIELDS" | "INVALID_TEMPLATE" | "INVALID_CHANNEL" | "INVALID_LANG" | "INVALID_VARIABLES" | "REQUEST_TIMEOUT" | "INVALID_RESPONSE" | "API_ERROR";
 /** Structured error — never includes the API key in the message. */
 export declare class ZinduaError extends Error {
     readonly status: number;

package/dist/validate.js

@@ -107,20 +107,26 @@ function validateRecipient(to, channel) {
     if (!recipient || recipient.length > exports.LIMITS.maxToLength) {
         throw new errors_1.ZinduaError("to is required and must be under 320 characters.", {
             status: 0,
-            code: "INVALID_RECIPIENT",
+            code: "MISSING_FIELDS",
         });
     }
     if (channel === "email") {
+        if (E164_RE.test(recipient)) {
+            throw new errors_1.ZinduaError('A phone number cannot be sent on channel "email". Use an email address (e.g. user@example.com) or set channel to "whatsapp".', { status: 0, code: "INVALID_EMAIL" });
+        }
         if (!EMAIL_RE.test(recipient)) {
             throw new errors_1.ZinduaError("Invalid email address for channel email.", {
                 status: 0,
-                code: "INVALID_RECIPIENT",
+                code: "INVALID_EMAIL",
             });
         }
         return recipient;
     }
+    if (EMAIL_RE.test(recipient)) {
+        throw new errors_1.ZinduaError('An email address cannot be sent on channel "whatsapp". Use E.164 with + (e.g. +243812345678) or set channel to "email".', { status: 0, code: "INVALID_PHONE" });
+    }
     if (!E164_RE.test(recipient)) {
-        throw new errors_1.ZinduaError("WhatsApp to must be E.164 with leading + (e.g. +243812345678).", { status: 0, code: "INVALID_RECIPIENT" });
+        throw new errors_1.ZinduaError("WhatsApp to must be E.164 with leading + (e.g. +243812345678).", { status: 0, code: "INVALID_PHONE" });
     }
     return recipient;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zindua/sdk",
-  "version": "1.2.4",
+  "version": "1.2.6",
   "description": "Official Zindua SDK for Node.js — transactional email and WhatsApp via POST /api/v1/send.",
   "author": "Zindua",
   "license": "MIT",