@talkey/sdk 1.0.0

package/README.md

@@ -0,0 +1,160 @@
+# 🚀 Talkey SDK (JavaScript / TypeScript)
+
+Send SMS and WhatsApp messages easily with Talkey.
+
+---
+
+## 📦 Installation
+
+```bash
+npm install talkey
+```
+
+---
+
+## ⚡ Quick Start
+
+```ts
+import { Talkey } from "talkey"
+
+const talkey = new Talkey("YOUR_API_KEY")
+
+const { data, error } = await talkey.sms.send({
+  to: ["+237655377730"],
+  message: "Hello 👋"
+})
+
+console.log(data,error)
+```
+
+---
+
+## ✉️ Send SMS
+
+### Simple SMS
+
+```ts
+await talkey.sms.send({
+  to: ["+2376XXXXXXX"],
+  message: "Hello 👋"
+})
+```
+
+### SMS with template
+
+```ts
+await talkey.sms.send({
+  to: ["+2376XXXXXXX"],
+  template: "otp",
+  variables: {
+    code: "1234"
+  }
+})
+```
+
+---
+
+## 💬 Send WhatsApp Message
+
+```ts
+await talkey.whatsapp.send({
+  to: ["+2376XXXXXXX"],
+  template: "welcome",
+  variables: {
+    name: "Yannick"
+  }
+})
+```
+
+---
+
+## 📥 Response Format
+
+### Success
+
+```json
+{
+  "messageid": "uuid",
+  "data": [
+    {
+      "success": true,
+      "mobile": "+2376XXXXXXX"
+    }
+  ],
+  "cost": 20
+}
+```
+
+---
+
+### Error
+
+```json
+{
+  "messageid": "uuid",
+  "code": "INSUFFICIENT_CREDITS",
+  "message": "You do not have enough credits to send this SMS."
+}
+```
+
+---
+
+## 🧠 Error Handling
+
+Talkey does not throw errors.
+All responses follow this pattern:
+
+```ts
+const { data, error } = await talkey.sms.send(...)
+
+if (error) {
+  // handle error
+} else {
+  // use data
+}
+```
+
+---
+
+## 📚 Types
+
+The SDK includes built-in TypeScript types for better autocomplete and developer experience.
+
+---
+
+## 🔐 API Key
+
+You can get your API key from your Talkey dashboard.
+
+---
+
+## 🌍 Supported Channels
+
+* SMS (text & template)
+* WhatsApp (template)
+
+---
+
+## 🚀 Example
+
+```ts
+const { data, error } = await talkey.sms.send({
+  to: ["+237655377730"],
+  template: "otp",
+  variables: {
+    code: "1234"
+  }
+})
+
+if (error) {
+  console.error(error)
+} else {
+  console.log("Message sent:", data.messageid)
+}
+```
+
+---
+
+## 📄 License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,61 @@
+type sms = {
+    to: string[];
+    message?: string;
+    template?: string;
+    variables?: Record<string, string | number>;
+};
+type whatsapp = {
+    to: string[];
+    template: string;
+    variables?: Record<string, string | number>;
+};
+type data = {
+    success: boolean;
+    mobile: string;
+};
+type result = {
+    messageid: string;
+    data: data[];
+    cost: number;
+};
+type APIerror = {
+    messageid: string;
+    code: string;
+    message: string;
+};
+
+declare class Client {
+    private apiKey;
+    private baseUrl;
+    constructor(apiKey: string);
+    request<T>(method: string, endpoint: string, data?: any): Promise<{
+        data?: T;
+        error?: APIerror;
+    }>;
+}
+
+declare class SMS {
+    private client;
+    constructor(client: Client);
+    send(data: sms): Promise<{
+        data?: result;
+        error?: APIerror;
+    }>;
+}
+
+declare class WhatsApp {
+    private client;
+    constructor(client: Client);
+    send(data: whatsapp): Promise<{
+        data?: result;
+        error?: APIerror;
+    }>;
+}
+
+declare class Talkey {
+    sms: SMS;
+    whatsapp: WhatsApp;
+    constructor(apiKey: string);
+}
+
+export { type APIerror, Talkey, type data, type result, type sms, type whatsapp };

package/dist/index.js

@@ -0,0 +1,68 @@
+// src/client.ts
+var Client = class {
+  apiKey;
+  baseUrl = "https://api.talkey.dev";
+  constructor(apiKey) {
+    this.apiKey = apiKey;
+  }
+  async request(method, endpoint, data) {
+    const res = await fetch(`${this.baseUrl}${endpoint}`, {
+      method,
+      headers: {
+        "Content-Type": "application/json",
+        "Authorization": `Bearer ${this.apiKey}`
+      },
+      body: data ? JSON.stringify(data) : null
+    });
+    const json = await res.json();
+    if (json.error) {
+      return { error: json.error };
+    }
+    return { data: json };
+  }
+};
+
+// src/resources/sms.ts
+var SMS = class {
+  constructor(client) {
+    this.client = client;
+  }
+  async send(data) {
+    return this.client.request(
+      "POST",
+      "/v1/sms",
+      {
+        ...data,
+        type: data.template ? "template" : "text"
+      }
+    );
+  }
+};
+
+// src/resources/whatsapp.ts
+var WhatsApp = class {
+  constructor(client) {
+    this.client = client;
+  }
+  async send(data) {
+    return this.client.request(
+      "POST",
+      "/v1/whatsapp",
+      data
+    );
+  }
+};
+
+// src/index.ts
+var Talkey = class {
+  sms;
+  whatsapp;
+  constructor(apiKey) {
+    const client = new Client(apiKey);
+    this.sms = new SMS(client);
+    this.whatsapp = new WhatsApp(client);
+  }
+};
+export {
+  Talkey
+};

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@talkey/sdk",
+  "version": "1.0.0",
+  "description": "Talkey SDK",
+  "license": "ISC",
+  "author": "Nitcheu Yannick",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files":["/dist", "README.md"],
+  "scripts": {
+    "build": "tsup src/index.ts --format esm --dts"
+  },
+  "dependencies": {
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3"
+  }
+}