plexisms 1.0.0 → 1.0.1

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2024 PlexiSMS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT
+LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -1,9 +1,14 @@
 {
     "name": "plexisms",
-    "version": "1.0.0",
+    "version": "1.0.1",
     "description": "Official Node.js SDK for PlexiSMS API",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
+    "files": [
+        "dist",
+        "README.md",
+        "LICENSE"
+    ],
     "scripts": {
         "build": "tsc",
         "lint": "eslint 'src/**/*.ts'",
@@ -44,4 +49,4 @@
     "dependencies": {
         "axios": "^1.6.0"
     }
-}
+}

package/eslint.config.js

@@ -1,12 +0,0 @@
-const tseslint = require('typescript-eslint');
-
-module.exports = tseslint.config(
-  {
-    files: ['**/*.ts'],
-    extends: [
-      ...tseslint.configs.recommended,
-    ],
-    rules: {
-    },
-  },
-);

package/jest.config.js

@@ -1,4 +0,0 @@
-module.exports = {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-};

package/src/client.ts

@@ -1,159 +0,0 @@
-import axios, { AxiosInstance } from 'axios';
-import {
-    AuthenticationError,
-    BalanceError,
-    APIError,
-    PlexismsError
-} from './exceptions';
-import {
-    SendSMSOptions,
-    SMSResponse,
-    SendBulkSMSOptions,
-    BulkSMSResponse,
-    OTPRequestResponse,
-    OTPVerifyResponse,
-    BalanceResponse,
-    MessageStatusResponse
-} from './types';
-
-export class Client {
-    private client: AxiosInstance;
-    private readonly DEFAULT_BASE_URL = "https://server.plexisms.com";
-
-    public messages: Messages;
-    public otp: OTP;
-    public account: Account;
-
-    /**
-     * @param apiKey Your PlexiSMS API Key.
-     * @param baseUrl Optional override for API URL.
-     */
-    constructor(apiKey?: string, baseUrl?: string) {
-        const token = apiKey || process.env.PLEXISMS_API_KEY;
-
-        if (!token) {
-            throw new AuthenticationError("API Key is required. Pass it to the constructor or set PLEXISMS_API_KEY environment variable.");
-        }
-
-        this.client = axios.create({
-            baseURL: (baseUrl || process.env.PLEXISMS_BASE_URL || this.DEFAULT_BASE_URL).replace(/\/$/, ""),
-            headers: {
-                'Authorization': `Token ${token}`,
-                'Content-Type': 'application/json',
-                'User-Agent': 'plexisms-node/1.0.0'
-            }
-        });
-
-        this.messages = new Messages(this.client);
-        this.otp = new OTP(this.client);
-        this.account = new Account(this.client);
-    }
-}
-
-class Resource {
-    protected client: AxiosInstance;
-
-    constructor(client: AxiosInstance) {
-        this.client = client;
-    }
-
-    protected async request<T>(method: 'get' | 'post', endpoint: string, data?: Record<string, unknown>, params?: Record<string, unknown>): Promise<T> {
-        try {
-            const response = await this.client.request<T>({
-                method,
-                url: endpoint,
-                data,
-                params
-            });
-            return response.data;
-        } catch (error: unknown) {
-            this.handleError(error);
-            throw error; // Should be unreachable given handleError throws
-        }
-    }
-
-    protected handleError(error: unknown): void {
-        if (axios.isAxiosError(error)) {
-            const status = error.response?.status;
-            const data = error.response?.data as Record<string, unknown>;
-            const message = (data?.error || data?.detail || error.message) as string;
-
-            if (status === 401 || status === 403) {
-                throw new AuthenticationError(`Unauthorized: ${message}`);
-            } else if (status === 402) {
-                throw new BalanceError(`Insufficient funds: ${message}`);
-            } else if (status && status >= 500) {
-                throw new APIError(`Server Error (${status}): ${message}`, status, data);
-            } else if (status) {
-                throw new APIError(`API Error (${status}): ${message}`, status, data);
-            } else {
-                throw new PlexismsError(`Network Error: ${error.message}`);
-            }
-        }
-        throw new PlexismsError(`Unexpected Error: ${error}`);
-    }
-}
-
-export class Messages extends Resource {
-    /**
-     * Send a single SMS
-     */
-    async create(options: SendSMSOptions): Promise<SMSResponse> {
-        return this.request<SMSResponse>('post', '/api/sms/send/', {
-            phone_number: options.to,
-            message: options.body,
-            sender_id: options.senderId,
-            sms_type: options.smsType || 'transactional'
-        });
-    }
-
-    /**
-     * Send bulk SMS
-     */
-    async createBulk(options: SendBulkSMSOptions): Promise<BulkSMSResponse> {
-        return this.request<BulkSMSResponse>('post', '/api/sms/send-bulk/', {
-            phone_numbers: options.phoneNumbers,
-            message: options.body,
-            sender_id: options.senderId,
-            sms_type: options.smsType || 'transactional'
-        });
-    }
-
-    /**
-     * Get SMS status
-     */
-    async get(messageId: string | number): Promise<MessageStatusResponse> {
-        return this.request('get', `/api/sms/${messageId}/status/`);
-    }
-}
-
-export class OTP extends Resource {
-    /**
-     * Send an OTP code
-     */
-    async send(to: string, brand: string = "PlexiSMS"): Promise<OTPRequestResponse> {
-        return this.request<OTPRequestResponse>('post', '/api/sms/send-otp/', {
-            phone_number: to,
-            brand
-        });
-    }
-
-    /**
-     * Verify an OTP code
-     */
-    async verify(verificationId: string, code: string): Promise<OTPVerifyResponse> {
-        return this.request<OTPVerifyResponse>('post', '/api/sms/verify-otp/', {
-            verification_id: verificationId,
-            otp_code: code
-        });
-    }
-}
-
-export class Account extends Resource {
-    /**
-     * Check account balance
-     */
-    async balance(): Promise<BalanceResponse> {
-        return this.request<BalanceResponse>('get', '/api/sms/balance/');
-    }
-}

package/src/exceptions.ts

@@ -1,32 +0,0 @@
-export class PlexismsError extends Error {
-    constructor(message: string) {
-        super(message);
-        this.name = 'PlexismsError';
-    }
-}
-
-export class AuthenticationError extends PlexismsError {
-    constructor(message: string) {
-        super(message);
-        this.name = 'AuthenticationError';
-    }
-}
-
-export class BalanceError extends PlexismsError {
-    constructor(message: string) {
-        super(message);
-        this.name = 'BalanceError';
-    }
-}
-
-export class APIError extends PlexismsError {
-    statusCode?: number;
-    responseBody?: Record<string, unknown>;
-
-    constructor(message: string, statusCode?: number, responseBody?: Record<string, unknown>) {
-        super(message);
-        this.name = 'APIError';
-        this.statusCode = statusCode;
-        this.responseBody = responseBody;
-    }
-}

package/src/index.ts

@@ -1,3 +0,0 @@
-export * from './client';
-export * from './exceptions';
-export * from './types';

package/src/types.ts

@@ -1,63 +0,0 @@
-export interface SMSResponse {
-    id: number;
-    message_id: string;
-    status: 'pending' | 'sent' | 'delivered' | 'failed';
-    phone_number: string;
-    parts: number;
-    cost_usd: string;
-    balance: {
-        remaining_usd: string;
-        remaining_sms: number;
-    };
-}
-
-export interface BulkSMSResponse {
-    total: number;
-    queued: number;
-    task_id: string;
-    message: string;
-}
-
-export interface OTPRequestResponse {
-    verification_id: string;
-    status: string;
-    phone_number: string;
-    expires_in: number;
-}
-
-export interface OTPVerifyResponse {
-    verified: boolean;
-    phone_number?: string;
-    error?: string;
-}
-
-export interface BalanceResponse {
-    amount: string;
-    currency: string;
-    provider: string;
-}
-
-export interface SendSMSOptions {
-    to: string;
-    body: string;
-    senderId?: string;
-    smsType?: 'transactional' | 'promotional';
-}
-
-export interface SendBulkSMSOptions {
-    phoneNumbers: string[];
-    body: string;
-    senderId?: string;
-    smsType?: 'transactional' | 'promotional';
-}
-
-export interface MessageStatusResponse {
-    id: number;
-    message_id: string;
-    status: 'pending' | 'sent' | 'delivered' | 'failed';
-    phone_number: string;
-    parts: number;
-    cost_usd: string;
-    created_at: string;
-    updated_at: string;
-}

package/tests/client.test.ts

@@ -1,5 +0,0 @@
-describe('PlexiSMS Client', () => {
-  it('should be true', () => {
-    expect(true).toBe(true);
-  });
-});

package/tsconfig.json

@@ -1,24 +0,0 @@
-{
-    "compilerOptions": {
-        "target": "es2018",
-        "module": "commonjs",
-        "lib": [
-            "es2018",
-            "dom"
-        ],
-        "declaration": true,
-        "strict": true,
-        "esModuleInterop": true,
-        "skipLibCheck": true,
-        "forceConsistentCasingInFileNames": true,
-        "outDir": "./dist",
-        "rootDir": "./src"
-    },
-    "include": [
-        "src/**/*"
-    ],
-    "exclude": [
-        "node_modules",
-        "**/*.spec.ts"
-    ]
-}