@zindua/sdk 1.2.6 → 1.2.7

package/README.md

@@ -369,6 +369,32 @@ Do **not** embed `@zindua/sdk` or `znd_live_…` in the app. Call your backend r
 
 ---
 
+## WordPress site binding & `connect()`
+
+Each API key can be linked to **one site URL** (used by the [WordPress plugin](https://zindua.run/wordpress)). Pass `siteUrl` on the client so every request includes `X-Zindua-Site-Url`:
+
+```typescript
+const zindua = new Zindua({
+  apiKey: process.env.ZINDUA_API_KEY!,
+  siteUrl: "https://shop.example.com",
+});
+
+// First connect binds the key to this URL
+const status = await zindua.connect();
+console.log(status.project.name, status.templates);
+
+// Later: list templates with langs (fr, en, …)
+const { templates } = await zindua.getTemplates();
+```
+
+| Error code | Meaning |
+|------------|---------|
+| `SITE_ALREADY_BOUND` | Key already used on another site — create a new project or regenerate the key |
+| `SITE_MISMATCH` | `siteUrl` does not match the registered site |
+| `SITE_URL_REQUIRED` | Key is bound; update the SDK and set `siteUrl` |
+
+---
+
 ## Configuration options
 
 | Option | Default | Description |
@@ -376,10 +402,12 @@ Do **not** embed `@zindua/sdk` or `znd_live_…` in the app. Call your backend r
 | `apiKey` | — | **Required.** `znd_live_…` or `znd_test_…` from the dashboard. |
 | `baseUrl` | `https://zindua.run/api/v1` | Override only for local testing (`http://localhost:3000/api/v1`). |
 | `timeoutMs` | `30000` | Request timeout (max `120000`). |
+| `siteUrl` | — | Your app origin (`https://example.com`). Required once the key is site-bound. |
 
 ```typescript
 const zindua = new Zindua({
   apiKey: process.env.ZINDUA_API_KEY!,
+  siteUrl: process.env.APP_URL,
   baseUrl: process.env.ZINDUA_API_BASE_URL, // optional
   timeoutMs: 45_000,
 });

package/dist/client.d.ts

@@ -16,6 +16,41 @@ export type ZinduaClientOptions = {
     baseUrl?: string;
     /** Request timeout (default 30s, max 120s). */
     timeoutMs?: number;
+    /**
+     * Your app or WordPress site origin (e.g. https://shop.example.com).
+     * Sent as X-Zindua-Site-Url — required once the API key is bound to a site.
+     */
+    siteUrl?: string;
+};
+export type ZinduaProjectInfo = {
+    name: string;
+    slug: string;
+    defaultLang: string;
+    dashboardUrl: string;
+};
+export type ZinduaTemplateInfo = {
+    slug: string;
+    langs: string[];
+    defaultLang: string;
+    variables: string[];
+};
+export type ZinduaConnectResult = {
+    ok: true;
+    connected: true;
+    siteUrl: string;
+    newlyBound: boolean;
+    project: ZinduaProjectInfo;
+    templates: ZinduaTemplateInfo[];
+    plan: ZinduaSendContext["plan"];
+    channels: {
+        email: {
+            ready: boolean;
+        };
+        whatsapp: {
+            ready: boolean;
+            status?: string;
+        };
+    };
 };
 export type ZinduaSendContext = {
     project: {
@@ -58,10 +93,25 @@ export type ZinduaSendResult = {
 };
 export declare class Zindua {
     private readonly apiKey;
-    private readonly sendUrl;
+    private readonly apiBase;
     private readonly timeoutMs;
+    private readonly siteUrl?;
     constructor(options: ZinduaClientOptions);
     /** Returns true when using a znd_test_ key (sandbox / no real delivery). */
     isTestMode(): boolean;
+    /**
+     * Bind this API key to your site (WordPress connect flow).
+     * First call wins — the same key cannot be used on another site URL.
+     */
+    connect(siteUrl?: string): Promise<ZinduaConnectResult>;
+    /** Project status, channels, and plan (GET /project). */
+    getProject(): Promise<Record<string, unknown>>;
+    /** Synced templates with langs and variables (GET /templates). */
+    getTemplates(): Promise<{
+        templates: ZinduaTemplateInfo[];
+        limits?: Record<string, unknown>;
+    }>;
     send(options: ZinduaSendOptions): Promise<ZinduaSendResult>;
+    private buildHeaders;
+    private request;
 }

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.6";
+const SDK_VERSION = "1.2.7";
 const USER_AGENT = `Zindua-JS/${SDK_VERSION}`;
 function buildPayload(options, channel) {
     const to = (0, validate_1.validateRecipient)(options.to, channel);
@@ -50,6 +50,8 @@ function parseApiError(status, body) {
         details.hint = body.hint;
     if (typeof body.retryAfterSec === "number")
         details.retryAfterSec = body.retryAfterSec;
+    if (typeof body.boundSite === "string")
+        details.boundSite = body.boundSite;
     if (Array.isArray(body.availableTemplateSlugs)) {
         details.availableTemplateSlugs = body.availableTemplateSlugs;
     }
@@ -69,34 +71,109 @@ function parseApiError(status, body) {
 }
 class Zindua {
     apiKey;
-    sendUrl;
+    apiBase;
     timeoutMs;
+    siteUrl;
     constructor(options) {
         (0, validate_1.assertServerRuntime)();
         this.apiKey = (0, validate_1.validateApiKey)(options.apiKey);
-        const base = (0, validate_1.resolveBaseUrl)(options.baseUrl);
-        this.sendUrl = `${base}/send`;
+        this.apiBase = (0, validate_1.resolveBaseUrl)(options.baseUrl);
         this.timeoutMs = (0, validate_1.validateTimeoutMs)(options.timeoutMs);
+        this.siteUrl = (0, validate_1.validateSiteUrl)(options.siteUrl);
     }
     /** Returns true when using a znd_test_ key (sandbox / no real delivery). */
     isTestMode() {
         return this.apiKey.startsWith("znd_test_");
     }
+    /**
+     * Bind this API key to your site (WordPress connect flow).
+     * First call wins — the same key cannot be used on another site URL.
+     */
+    async connect(siteUrl) {
+        const url = (0, validate_1.validateSiteUrl)(siteUrl) ?? this.siteUrl;
+        const data = await this.request("POST", "connect", {
+            siteUrl: url,
+        });
+        if (data.ok !== true || !data.project || !Array.isArray(data.templates)) {
+            throw new errors_1.ZinduaError("API response missing connect payload.", {
+                status: 200,
+                code: "INVALID_RESPONSE",
+            });
+        }
+        return {
+            ok: true,
+            connected: true,
+            siteUrl: typeof data.siteUrl === "string" ? data.siteUrl : url ?? "",
+            newlyBound: Boolean(data.newlyBound),
+            project: data.project,
+            templates: data.templates,
+            plan: data.plan ?? null,
+            channels: data.channels ?? {
+                email: { ready: false },
+                whatsapp: { ready: false },
+            },
+        };
+    }
+    /** Project status, channels, and plan (GET /project). */
+    async getProject() {
+        return this.request("GET", "project");
+    }
+    /** Synced templates with langs and variables (GET /templates). */
+    async getTemplates() {
+        const data = await this.request("GET", "templates");
+        return {
+            templates: Array.isArray(data.templates) ? data.templates : [],
+            limits: data.limits,
+        };
+    }
     async send(options) {
         const channel = (0, validate_1.validateChannel)(options.channel);
         const payload = buildPayload(options, channel);
+        const data = await this.request("POST", "send", payload);
+        if (data.success !== true || typeof data.logId !== "string") {
+            throw new errors_1.ZinduaError("API response missing success or logId.", {
+                status: 200,
+                code: "INVALID_RESPONSE",
+            });
+        }
+        return {
+            success: true,
+            channel: (data.channel === "whatsapp" ? "whatsapp" : "email"),
+            status: typeof data.status === "string" ? data.status : "queued",
+            logId: data.logId,
+            langUsed: typeof data.langUsed === "string" ? data.langUsed : undefined,
+            langFallback: typeof data.langFallback === "boolean" ? data.langFallback : undefined,
+            testMode: typeof data.testMode === "boolean" ? data.testMode : undefined,
+            project: typeof data.project === "string" ? data.project : undefined,
+            context: data.context && typeof data.context === "object"
+                ? data.context
+                : undefined,
+        };
+    }
+    buildHeaders() {
+        const headers = {
+            Authorization: `Bearer ${this.apiKey}`,
+            "User-Agent": USER_AGENT,
+            Accept: "application/json",
+        };
+        if (this.siteUrl) {
+            headers["X-Zindua-Site-Url"] = this.siteUrl;
+        }
+        return headers;
+    }
+    async request(method, path, body) {
+        const url = `${this.apiBase}/${path.replace(/^\//, "")}`;
         const controller = new AbortController();
         const timer = setTimeout(() => controller.abort(), this.timeoutMs);
         try {
-            const response = await fetch(this.sendUrl, {
-                method: "POST",
-                headers: {
-                    "Content-Type": "application/json",
-                    Authorization: `Bearer ${this.apiKey}`,
-                    "User-Agent": USER_AGENT,
-                    Accept: "application/json",
-                },
-                body: JSON.stringify(payload),
+            const headers = this.buildHeaders();
+            if (body) {
+                headers["Content-Type"] = "application/json";
+            }
+            const response = await fetch(url, {
+                method,
+                headers,
+                body: body ? JSON.stringify(body) : undefined,
                 signal: controller.signal,
                 redirect: "error",
             });
@@ -114,25 +191,7 @@ class Zindua {
             if (!response.ok) {
                 throw parseApiError(response.status, data);
             }
-            if (data.success !== true || typeof data.logId !== "string") {
-                throw new errors_1.ZinduaError("API response missing success or logId.", {
-                    status: response.status,
-                    code: "INVALID_RESPONSE",
-                });
-            }
-            return {
-                success: true,
-                channel: (data.channel === "whatsapp" ? "whatsapp" : "email"),
-                status: typeof data.status === "string" ? data.status : "queued",
-                logId: data.logId,
-                langUsed: typeof data.langUsed === "string" ? data.langUsed : undefined,
-                langFallback: typeof data.langFallback === "boolean" ? data.langFallback : undefined,
-                testMode: typeof data.testMode === "boolean" ? data.testMode : undefined,
-                project: typeof data.project === "string" ? data.project : undefined,
-                context: data.context && typeof data.context === "object"
-                    ? data.context
-                    : undefined,
-            };
+            return data;
         }
         catch (err) {
             if (err instanceof errors_1.ZinduaError)

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export { Zindua } from "./client";
-export type { ZinduaClientOptions, ZinduaSendContext, ZinduaSendOptions, ZinduaSendResult, SendChannel, } from "./client";
+export type { ZinduaClientOptions, ZinduaConnectResult, ZinduaProjectInfo, ZinduaSendContext, ZinduaSendOptions, ZinduaSendResult, ZinduaTemplateInfo, SendChannel, } from "./client";
 export { ZinduaError } from "./errors";
 export type { ZinduaErrorCode } from "./errors";
 export { DEFAULT_API_BASE, LIMITS } from "./validate";

package/dist/validate.d.ts

@@ -23,3 +23,5 @@ export declare function sanitizeVariables(variables?: Record<string, string>): R
 export declare function validateOptionalEmailField(field: "cc" | "bcc" | "replyTo", value?: string): string | undefined;
 export declare function validateAttachments(attachments?: unknown[]): unknown[] | undefined;
 export declare function validateTimeoutMs(timeoutMs?: number): number;
+/** Normalize site URL for WordPress one-key-one-site binding (protocol + host). */
+export declare function validateSiteUrl(siteUrl?: string): string | undefined;

package/dist/validate.js

@@ -13,6 +13,7 @@ exports.sanitizeVariables = sanitizeVariables;
 exports.validateOptionalEmailField = validateOptionalEmailField;
 exports.validateAttachments = validateAttachments;
 exports.validateTimeoutMs = validateTimeoutMs;
+exports.validateSiteUrl = validateSiteUrl;
 const errors_1 = require("./errors");
 /** Matches platform `isValidE164Phone` in zindua.run API. */
 const E164_RE = /^\+[1-9]\d{6,14}$/;
@@ -214,3 +215,21 @@ function validateTimeoutMs(timeoutMs) {
     }
     return Math.floor(timeoutMs);
 }
+/** Normalize site URL for WordPress one-key-one-site binding (protocol + host). */
+function validateSiteUrl(siteUrl) {
+    if (siteUrl === undefined || siteUrl === null)
+        return undefined;
+    const trimmed = String(siteUrl).trim();
+    if (!trimmed)
+        return undefined;
+    try {
+        const url = new URL(trimmed.includes("://") ? trimmed : `https://${trimmed}`);
+        return `${url.protocol}//${url.host}`;
+    }
+    catch {
+        throw new errors_1.ZinduaError("siteUrl must be a valid URL (e.g. https://example.com).", {
+            status: 0,
+            code: "INVALID_OPTIONS",
+        });
+    }
+}

package/package.json

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