@skrybe/sdk 1.0.0

package/README.md

@@ -0,0 +1,140 @@
+# Skrybe TypeScript/JavaScript SDK
+
+Official TypeScript/JavaScript SDK for the Skrybe API.
+
+## Installation
+
+```bash
+npm install @skrybe/sdk
+```
+
+## Usage
+
+### Initialize the SDK
+
+```typescript
+import { SkrybeSDK } from '@skrybe/sdk';
+
+const skrybe = new SkrybeSDK({
+  apiKey: 'your-api-key'
+});
+```
+
+### Send an Email
+
+```typescript
+const response = await skrybe.sendEmail({
+  fromName: 'John Doe',
+  fromEmail: 'john@example.com',
+  replyTo: 'support@example.com',
+  subject: 'Welcome!',
+  htmlText: '<html><body>Hello [recipient.first]!</body></html>',
+  to: ['user@example.com'],
+  recipientVariables: {
+    'user@example.com': {
+      first: 'John'
+    }
+  },
+  trackOpens: 1,
+  trackClicks: 1
+});
+```
+
+### Create a Campaign
+
+```typescript
+const response = await skrybe.createCampaign({
+  fromName: 'John Doe',
+  fromEmail: 'john@example.com',
+  replyTo: 'support@example.com',
+  title: 'Monthly Newsletter',
+  subject: 'Your Monthly Update',
+  htmlText: '<html><body>Newsletter content here</body></html>',
+  listIds: 'list-id-1,list-id-2',
+  trackOpens: 1,
+  trackClicks: 1,
+  sendCampaign: 1
+});
+```
+
+### Get Lists
+
+```typescript
+const lists = await skrybe.getLists();
+// To include hidden lists
+const allLists = await skrybe.getLists(true);
+```
+
+## API Reference
+
+### SkrybeSDK Configuration
+
+```typescript
+interface SkrybeConfig {
+  apiKey: string;
+  baseURL?: string; // Defaults to https://dashboard.skry.be
+}
+```
+
+### SendEmailOptions
+
+```typescript
+interface SendEmailOptions {
+  fromName: string;
+  fromEmail: string;
+  replyTo: string;
+  subject: string;
+  htmlText: string;
+  plainText?: string;
+  to?: string[];
+  recipientVariables?: Record<string, Record<string, any>>;
+  listIds?: string[];
+  queryString?: string;
+  trackOpens?: 0 | 1 | 2;
+  trackClicks?: 0 | 1 | 2;
+  scheduleDateTime?: string;
+  scheduleTimezone?: string;
+}
+```
+
+### CreateCampaignOptions
+
+```typescript
+interface CreateCampaignOptions {
+  fromName: string;
+  fromEmail: string;
+  replyTo: string;
+  title: string;
+  subject: string;
+  htmlText: string;
+  plainText?: string;
+  listIds?: string;
+  segmentIds?: string;
+  excludeListIds?: string;
+  excludeSegmentIds?: string;
+  queryString?: string;
+  trackOpens?: 0 | 1 | 2;
+  trackClicks?: 0 | 1 | 2;
+  sendCampaign?: 0 | 1;
+  scheduleDateTime?: string;
+  scheduleTimezone?: string;
+}
+```
+
+## Error Handling
+
+The SDK throws errors for invalid API keys, missing required parameters, and other API errors. Make sure to wrap your API calls in try-catch blocks:
+
+```typescript
+try {
+  const response = await skrybe.sendEmail({
+    // ... options
+  });
+} catch (error) {
+  console.error('Error sending email:', error.message);
+}
+```
+
+## License
+
+MIT 

package/dist/index.d.ts

@@ -0,0 +1,52 @@
+export interface SkrybeConfig {
+    apiKey: string;
+    baseURL?: string;
+}
+export interface SendEmailOptions {
+    fromName: string;
+    fromEmail: string;
+    replyTo: string;
+    subject: string;
+    htmlText: string;
+    plainText?: string;
+    to?: string[];
+    recipientVariables?: Record<string, Record<string, any>>;
+    listIds?: string[];
+    queryString?: string;
+    trackOpens?: 0 | 1 | 2;
+    trackClicks?: 0 | 1 | 2;
+    scheduleDateTime?: string;
+    scheduleTimezone?: string;
+}
+export interface CreateCampaignOptions {
+    fromName: string;
+    fromEmail: string;
+    replyTo: string;
+    title: string;
+    subject: string;
+    htmlText: string;
+    plainText?: string;
+    listIds?: string;
+    segmentIds?: string;
+    excludeListIds?: string;
+    excludeSegmentIds?: string;
+    queryString?: string;
+    trackOpens?: 0 | 1 | 2;
+    trackClicks?: 0 | 1 | 2;
+    sendCampaign?: 0 | 1;
+    scheduleDateTime?: string;
+    scheduleTimezone?: string;
+}
+export interface List {
+    id: string;
+    name: string;
+}
+export declare class SkrybeSDK {
+    private client;
+    private apiKey;
+    constructor(config: SkrybeConfig);
+    private createFormData;
+    sendEmail(options: SendEmailOptions): Promise<string>;
+    createCampaign(options: CreateCampaignOptions): Promise<string>;
+    getLists(includeHidden?: boolean): Promise<List[]>;
+}

package/dist/index.js

@@ -0,0 +1,88 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SkrybeSDK = void 0;
+const axios_1 = __importDefault(require("axios"));
+class SkrybeSDK {
+    constructor(config) {
+        this.apiKey = config.apiKey;
+        this.client = axios_1.default.create({
+            baseURL: config.baseURL || 'https://dashboard.skry.be',
+            headers: {
+                'Content-Type': 'application/x-www-form-urlencoded'
+            }
+        });
+    }
+    createFormData(data) {
+        const formData = new URLSearchParams();
+        formData.append('api_key', this.apiKey);
+        Object.entries(data).forEach(([key, value]) => {
+            if (value !== undefined) {
+                if (Array.isArray(value)) {
+                    formData.append(key, JSON.stringify(value));
+                }
+                else if (typeof value === 'object') {
+                    formData.append(key, JSON.stringify(value));
+                }
+                else {
+                    formData.append(key, String(value));
+                }
+            }
+        });
+        return formData;
+    }
+    async sendEmail(options) {
+        var _a;
+        const formData = this.createFormData({
+            from_name: options.fromName,
+            from_email: options.fromEmail,
+            reply_to: options.replyTo,
+            subject: options.subject,
+            html_text: options.htmlText,
+            plain_text: options.plainText,
+            to: options.to,
+            'recipient-variables': options.recipientVariables,
+            list_ids: (_a = options.listIds) === null || _a === void 0 ? void 0 : _a.join(','),
+            query_string: options.queryString,
+            track_opens: options.trackOpens,
+            track_clicks: options.trackClicks,
+            schedule_date_time: options.scheduleDateTime,
+            schedule_timezone: options.scheduleTimezone
+        });
+        const response = await this.client.post('/api/emails/send.php', formData);
+        return response.data;
+    }
+    async createCampaign(options) {
+        const formData = this.createFormData({
+            from_name: options.fromName,
+            from_email: options.fromEmail,
+            reply_to: options.replyTo,
+            title: options.title,
+            subject: options.subject,
+            html_text: options.htmlText,
+            plain_text: options.plainText,
+            list_ids: options.listIds,
+            segment_ids: options.segmentIds,
+            exclude_list_ids: options.excludeListIds,
+            exclude_segments_ids: options.excludeSegmentIds,
+            query_string: options.queryString,
+            track_opens: options.trackOpens,
+            track_clicks: options.trackClicks,
+            send_campaign: options.sendCampaign,
+            schedule_date_time: options.scheduleDateTime,
+            schedule_timezone: options.scheduleTimezone
+        });
+        const response = await this.client.post('/api/campaigns/create.php', formData);
+        return response.data;
+    }
+    async getLists(includeHidden = false) {
+        const formData = this.createFormData({
+            include_hidden: includeHidden ? 'yes' : 'no'
+        });
+        const response = await this.client.post('/api/lists/get-lists.php', formData);
+        return response.data;
+    }
+}
+exports.SkrybeSDK = SkrybeSDK;

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@skrybe/sdk",
+  "version": "1.0.0",
+  "description": "Official TypeScript/JavaScript SDK for Skrybe API",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "prepare": "npm run build",
+    "test": "jest",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "skrybe",
+    "email",
+    "marketing",
+    "api",
+    "sdk"
+  ],
+  "author": "Skrybe",
+  "license": "MIT",
+  "dependencies": {
+    "axios": "^1.6.7"
+  },
+  "devDependencies": {
+    "typescript": "^5.3.3",
+    "@types/node": "^20.11.16"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/skrybe/sdk"
+  }
+}