@notik-app/node 0.1.0

package/README.md

@@ -0,0 +1,106 @@
+# @notik-app/node
+
+Official Node.js SDK for [Notik](https://notik.app) — notification workflow platform.
+
+## Installation
+
+```bash
+npm install @notik-app/node
+```
+
+## Quick Start
+
+```typescript
+import Notik from "@notik-app/node";
+
+const notik = new Notik({ apiKey: "nk_live_..." });
+
+// Trigger a workflow
+const { executionId } = await notik.trigger({
+  workflow: "YOUR_WORKFLOW_ID",
+  data: {
+    driver_name: "Juan Garcia",
+    driver_phone: "+528331889752",
+    pickup_address: "Av. Constitución 500, Monterrey",
+  },
+});
+
+console.log(`Workflow triggered: ${executionId}`);
+```
+
+## Usage
+
+### API Key Trigger
+
+The primary way to trigger workflows. Requires an API key from **Settings → API Keys** in the Notik dashboard.
+
+```typescript
+const notik = new Notik({ apiKey: "nk_live_..." });
+
+await notik.trigger({
+  workflow: "WORKFLOW_ID",
+  data: {
+    customer_name: "María López",
+    order_id: "ORD-5678",
+    delivery_eta: "2:30 PM",
+  },
+});
+```
+
+### Webhook Trigger
+
+Trigger webhook-type workflows directly. Supports optional HMAC-SHA256 signing.
+
+```typescript
+await notik.triggerWebhook("WORKFLOW_ID", {
+  data: {
+    event: "order.shipped",
+    order_id: "ORD-1234",
+    tracking_url: "https://tracking.example.com/1234",
+  },
+  secret: "whsec_...", // optional, from workflow trigger config
+});
+```
+
+## Configuration
+
+```typescript
+const notik = new Notik({
+  apiKey: "nk_live_...",        // Required
+  baseUrl: "https://notik.app", // Optional, defaults to https://notik.app
+  timeout: 30000,               // Optional, request timeout in ms
+});
+```
+
+## Error Handling
+
+```typescript
+import Notik, { NotikAPIError } from "@notik-app/node";
+
+try {
+  await notik.trigger({ workflow: "wf-123", data: {} });
+} catch (err) {
+  if (err instanceof NotikAPIError) {
+    console.error(err.message); // "Rate limit exceeded"
+    console.error(err.status);  // 429
+    console.error(err.code);    // "RATE_LIMITED"
+  }
+}
+```
+
+### Error Codes
+
+| Code | Status | Description |
+|------|--------|-------------|
+| `UNAUTHORIZED` | 401 | Invalid or missing API key |
+| `RATE_LIMITED` | 429 | Too many requests |
+| `API_ERROR` | 4xx/5xx | Other API errors |
+
+## Requirements
+
+- Node.js 18+ (uses native `fetch`)
+- No external dependencies
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,74 @@
+export interface NotikConfig {
+    /** API key from Notik dashboard (Settings → API Keys) */
+    apiKey: string;
+    /** Base URL of your Notik instance. Defaults to https://notik.app */
+    baseUrl?: string;
+    /** Request timeout in milliseconds. Defaults to 30000 */
+    timeout?: number;
+}
+export interface TriggerOptions {
+    /** Workflow ID to trigger */
+    workflow: string;
+    /** Data payload — available as {{triggerData.fieldName}} in templates */
+    data: Record<string, unknown>;
+}
+export interface WebhookTriggerOptions {
+    /** Data payload */
+    data: Record<string, unknown>;
+    /** Webhook secret for HMAC signing (from workflow trigger config) */
+    secret?: string;
+}
+export interface TriggerResponse {
+    executionId: string;
+}
+export interface NotikError {
+    error: string;
+    status: number;
+}
+export declare class NotikAPIError extends Error {
+    status: number;
+    code: string;
+    constructor(message: string, status: number);
+}
+export declare class Notik {
+    private apiKey;
+    private baseUrl;
+    private timeout;
+    constructor(config: NotikConfig);
+    /**
+     * Trigger a workflow via API key authentication.
+     *
+     * @example
+     * ```typescript
+     * const notik = new Notik({ apiKey: "nk_live_..." });
+     *
+     * const { executionId } = await notik.trigger({
+     *   workflow: "682abc123def456",
+     *   data: {
+     *     driver_name: "Juan Garcia",
+     *     driver_phone: "+528331889752",
+     *     pickup_address: "Av. Constitución 500, Monterrey"
+     *   }
+     * });
+     * ```
+     */
+    trigger(options: TriggerOptions): Promise<TriggerResponse>;
+    /**
+     * Trigger a webhook workflow directly by workflow ID.
+     * Optionally signs the request with HMAC-SHA256.
+     *
+     * @example
+     * ```typescript
+     * const notik = new Notik({ apiKey: "nk_live_..." });
+     *
+     * const { executionId } = await notik.triggerWebhook("682abc123def456", {
+     *   data: { order_id: "ORD-1234", status: "shipped" },
+     *   secret: "whsec_..." // optional
+     * });
+     * ```
+     */
+    triggerWebhook(workflowId: string, options: WebhookTriggerOptions): Promise<TriggerResponse>;
+    private request;
+}
+export default Notik;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,WAAW;IAC1B,yDAAyD;IACzD,MAAM,EAAE,MAAM,CAAC;IACf,qEAAqE;IACrE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,yDAAyD;IACzD,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,6BAA6B;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,yEAAyE;IACzE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC/B;AAED,MAAM,WAAW,qBAAqB;IACpC,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B,qEAAqE;IACrE,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,eAAe;IAC9B,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,qBAAa,aAAc,SAAQ,KAAK;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;gBAED,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;CAM5C;AAED,qBAAa,KAAK;IAChB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,OAAO,CAAS;gBAEZ,MAAM,EAAE,WAAW;IAU/B;;;;;;;;;;;;;;;;OAgBG;IACG,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IAgBhE;;;;;;;;;;;;;OAaG;IACG,cAAc,CAClB,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,qBAAqB,GAC7B,OAAO,CAAC,eAAe,CAAC;YAuBb,OAAO;CA0CtB;AAED,eAAe,KAAK,CAAC"}

package/dist/index.js

@@ -0,0 +1,129 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Notik = exports.NotikAPIError = void 0;
+const crypto_1 = __importDefault(require("crypto"));
+class NotikAPIError extends Error {
+    status;
+    code;
+    constructor(message, status) {
+        super(message);
+        this.name = "NotikAPIError";
+        this.status = status;
+        this.code = status === 429 ? "RATE_LIMITED" : status === 401 ? "UNAUTHORIZED" : "API_ERROR";
+    }
+}
+exports.NotikAPIError = NotikAPIError;
+class Notik {
+    apiKey;
+    baseUrl;
+    timeout;
+    constructor(config) {
+        if (!config.apiKey) {
+            throw new Error("Notik: apiKey is required");
+        }
+        this.apiKey = config.apiKey;
+        this.baseUrl = (config.baseUrl || "https://notik.app").replace(/\/$/, "");
+        this.timeout = config.timeout || 30_000;
+    }
+    /**
+     * Trigger a workflow via API key authentication.
+     *
+     * @example
+     * ```typescript
+     * const notik = new Notik({ apiKey: "nk_live_..." });
+     *
+     * const { executionId } = await notik.trigger({
+     *   workflow: "682abc123def456",
+     *   data: {
+     *     driver_name: "Juan Garcia",
+     *     driver_phone: "+528331889752",
+     *     pickup_address: "Av. Constitución 500, Monterrey"
+     *   }
+     * });
+     * ```
+     */
+    async trigger(options) {
+        const res = await this.request("/api/v1/trigger", {
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json",
+                Authorization: `Bearer ${this.apiKey}`,
+            },
+            body: JSON.stringify({
+                workflow: options.workflow,
+                payload: options.data,
+            }),
+        });
+        return res;
+    }
+    /**
+     * Trigger a webhook workflow directly by workflow ID.
+     * Optionally signs the request with HMAC-SHA256.
+     *
+     * @example
+     * ```typescript
+     * const notik = new Notik({ apiKey: "nk_live_..." });
+     *
+     * const { executionId } = await notik.triggerWebhook("682abc123def456", {
+     *   data: { order_id: "ORD-1234", status: "shipped" },
+     *   secret: "whsec_..." // optional
+     * });
+     * ```
+     */
+    async triggerWebhook(workflowId, options) {
+        const body = JSON.stringify(options.data);
+        const headers = {
+            "Content-Type": "application/json",
+        };
+        if (options.secret) {
+            const signature = crypto_1.default
+                .createHmac("sha256", options.secret)
+                .update(body)
+                .digest("hex");
+            headers["x-notik-signature"] = signature;
+        }
+        const res = await this.request(`/api/webhooks/${workflowId}`, {
+            method: "POST",
+            headers,
+            body,
+        });
+        return res;
+    }
+    async request(path, init) {
+        const url = `${this.baseUrl}${path}`;
+        const controller = new AbortController();
+        const timeoutId = setTimeout(() => controller.abort(), this.timeout);
+        try {
+            const res = await fetch(url, {
+                ...init,
+                signal: controller.signal,
+                headers: {
+                    "User-Agent": "notik-node/0.1.0",
+                    ...init.headers,
+                },
+            });
+            const data = (await res.json());
+            if (!res.ok) {
+                throw new NotikAPIError(data.error || `Request failed with status ${res.status}`, res.status);
+            }
+            return data;
+        }
+        catch (err) {
+            if (err instanceof NotikAPIError)
+                throw err;
+            if (err instanceof Error && err.name === "AbortError") {
+                throw new NotikAPIError("Request timed out", 408);
+            }
+            throw new NotikAPIError(err instanceof Error ? err.message : "Unknown error", 500);
+        }
+        finally {
+            clearTimeout(timeoutId);
+        }
+    }
+}
+exports.Notik = Notik;
+exports.default = Notik;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,oDAA4B;AAkC5B,MAAa,aAAc,SAAQ,KAAK;IACtC,MAAM,CAAS;IACf,IAAI,CAAS;IAEb,YAAY,OAAe,EAAE,MAAc;QACzC,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,WAAW,CAAC;IAC9F,CAAC;CACF;AAVD,sCAUC;AAED,MAAa,KAAK;IACR,MAAM,CAAS;IACf,OAAO,CAAS;IAChB,OAAO,CAAS;IAExB,YAAY,MAAmB;QAC7B,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAC/C,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,OAAO,GAAG,CAAC,MAAM,CAAC,OAAO,IAAI,mBAAmB,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAC1E,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC;IAC1C,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,OAAO,CAAC,OAAuB;QACnC,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,iBAAiB,EAAE;YAChD,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;gBAClC,aAAa,EAAE,UAAU,IAAI,CAAC,MAAM,EAAE;aACvC;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,QAAQ,EAAE,OAAO,CAAC,QAAQ;gBAC1B,OAAO,EAAE,OAAO,CAAC,IAAI;aACtB,CAAC;SACH,CAAC,CAAC;QAEH,OAAO,GAAsB,CAAC;IAChC,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,cAAc,CAClB,UAAkB,EAClB,OAA8B;QAE9B,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC1C,MAAM,OAAO,GAA2B;YACtC,cAAc,EAAE,kBAAkB;SACnC,CAAC;QAEF,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;YACnB,MAAM,SAAS,GAAG,gBAAM;iBACrB,UAAU,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC;iBACpC,MAAM,CAAC,IAAI,CAAC;iBACZ,MAAM,CAAC,KAAK,CAAC,CAAC;YACjB,OAAO,CAAC,mBAAmB,CAAC,GAAG,SAAS,CAAC;QAC3C,CAAC;QAED,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,iBAAiB,UAAU,EAAE,EAAE;YAC5D,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;SACL,CAAC,CAAC;QAEH,OAAO,GAAsB,CAAC;IAChC,CAAC;IAEO,KAAK,CAAC,OAAO,CACnB,IAAY,EACZ,IAAiB;QAEjB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,GAAG,IAAI,EAAE,CAAC;QAErC,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;QACzC,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAErE,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;gBAC3B,GAAG,IAAI;gBACP,MAAM,EAAE,UAAU,CAAC,MAAM;gBACzB,OAAO,EAAE;oBACP,YAAY,EAAE,kBAAkB;oBAChC,GAAG,IAAI,CAAC,OAAO;iBAChB;aACF,CAAC,CAAC;YAEH,MAAM,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAA4B,CAAC;YAE3D,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;gBACZ,MAAM,IAAI,aAAa,CACpB,IAAI,CAAC,KAAgB,IAAI,8BAA8B,GAAG,CAAC,MAAM,EAAE,EACpE,GAAG,CAAC,MAAM,CACX,CAAC;YACJ,CAAC;YAED,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,GAAG,YAAY,aAAa;gBAAE,MAAM,GAAG,CAAC;YAC5C,IAAI,GAAG,YAAY,KAAK,IAAI,GAAG,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;gBACtD,MAAM,IAAI,aAAa,CAAC,mBAAmB,EAAE,GAAG,CAAC,CAAC;YACpD,CAAC;YACD,MAAM,IAAI,aAAa,CACrB,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,EACpD,GAAG,CACJ,CAAC;QACJ,CAAC;gBAAS,CAAC;YACT,YAAY,CAAC,SAAS,CAAC,CAAC;QAC1B,CAAC;IACH,CAAC;CACF;AAlID,sBAkIC;AAED,kBAAe,KAAK,CAAC"}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@notik-app/node",
+  "version": "0.1.0",
+  "description": "Official Node.js SDK for Notik — notification workflow platform",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build",
+    "test": "vitest run"
+  },
+  "keywords": [
+    "notik",
+    "notifications",
+    "whatsapp",
+    "email",
+    "push",
+    "workflows"
+  ],
+  "author": "Notik <hello@notik.app>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/notik-app/notik-node.git"
+  },
+  "homepage": "https://notik.app",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^25.3.3",
+    "typescript": "^5.7.0",
+    "vitest": "^3.0.0"
+  }
+}