@parsrun/sms 0.2.1

package/README.md

@@ -0,0 +1,133 @@
+# @parsrun/sms
+
+Edge-compatible SMS sending for Pars applications.
+
+## Features
+
+- 🌐 **Edge Compatible** - Works in Cloudflare Workers, Vercel Edge, Deno, Bun
+- 📱 **Multiple Providers** - NetGSM (Turkey), with Twilio coming soon
+- 🔧 **TypeScript First** - Full type definitions included
+- 🧪 **Dev Mode** - Console provider for local development
+
+## Installation
+
+```bash
+npm install @parsrun/sms
+# or
+bun add @parsrun/sms
+```
+
+## Quick Start
+
+```typescript
+import { createSMSService } from '@parsrun/sms';
+
+// Create SMS service with NetGSM
+const sms = createSMSService({
+  provider: 'netgsm',
+  username: process.env.NETGSM_USERNAME,
+  password: process.env.NETGSM_PASSWORD,
+  from: 'MYSENDER', // Sender ID registered with NetGSM
+});
+
+// Send a single SMS
+await sms.send({
+  to: '905551234567',
+  message: 'Hello from Pars!',
+});
+
+// Send OTP
+await sms.sendOTP('905551234567', '123456', 10);
+
+// Send welcome message
+await sms.sendWelcome('905551234567', 'John');
+```
+
+## Providers
+
+### NetGSM (Turkey)
+
+```typescript
+import { createSMSService } from '@parsrun/sms';
+
+const sms = createSMSService({
+  provider: 'netgsm',
+  username: 'your-username',
+  password: 'your-password',
+  from: 'SENDER_ID',
+  // Optional custom API URL
+  providerUrl: 'https://api.netgsm.com.tr/sms/send/otp',
+});
+```
+
+### Console (Development)
+
+```typescript
+import { createSMSService } from '@parsrun/sms';
+
+const sms = createSMSService({
+  provider: 'console',
+  from: 'TEST',
+});
+
+// SMS will be logged to console instead of being sent
+await sms.send({
+  to: '905551234567',
+  message: 'Test message',
+});
+```
+
+## Environment Variables
+
+```bash
+# NetGSM
+NETGSM_USERNAME=your-username
+NETGSM_PASSWORD=your-password
+NETGSM_SENDER=MYSENDER
+NETGSM_URL=https://api.netgsm.com.tr/sms/send/otp
+```
+
+## API Reference
+
+### SMSService
+
+```typescript
+class SMSService {
+  // Send a single SMS
+  send(options: SMSOptions): Promise<SMSResult>;
+
+  // Send multiple SMS messages
+  sendBatch(options: BatchSMSOptions): Promise<BatchSMSResult>;
+
+  // Verify provider configuration
+  verify(): Promise<boolean>;
+
+  // Send OTP verification SMS
+  sendOTP(phone: string, code: string, expiresInMinutes?: number): Promise<SMSResult>;
+
+  // Send welcome SMS
+  sendWelcome(phone: string, name?: string): Promise<SMSResult>;
+}
+```
+
+### Types
+
+```typescript
+interface SMSOptions {
+  to: string;           // Recipient phone number
+  message: string;      // SMS content
+  from?: string;        // Sender ID override
+  tags?: Record<string, string>;
+}
+
+interface SMSResult {
+  success: boolean;
+  messageId?: string;
+  error?: string;
+  data?: unknown;
+}
+```
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,140 @@
+import { SMSServiceConfig, SMSProviderType, SMSOptions, SMSResult, BatchSMSOptions, BatchSMSResult, SMSProviderConfig, SMSProvider } from './types.js';
+export { SMSError, SMSErrorCode, SMSErrorCodes } from './types.js';
+export { NetGSMProvider, createNetGSMProvider } from './providers/netgsm.js';
+export { ConsoleProvider, createConsoleProvider } from './providers/console.js';
+
+/**
+ * @module
+ * Edge-compatible SMS sending for Pars.
+ *
+ * Supports multiple providers:
+ * - NetGSM (Turkey)
+ * - Console (development)
+ *
+ * @example
+ * ```typescript
+ * import { createSMSService } from '@parsrun/sms';
+ *
+ * const sms = createSMSService({
+ *   provider: 'netgsm',
+ *   username: process.env.NETGSM_USERNAME,
+ *   password: process.env.NETGSM_PASSWORD,
+ *   from: 'MYSENDER',
+ * });
+ *
+ * await sms.send({
+ *   to: '905551234567',
+ *   message: 'Your verification code is: 123456',
+ * });
+ * ```
+ */
+
+/**
+ * SMS Service
+ *
+ * High-level SMS service that provides a unified interface for sending SMS
+ * through various providers (NetGSM, Twilio, or Console for development).
+ *
+ * @example
+ * ```typescript
+ * const service = new SMSService({
+ *   provider: 'netgsm',
+ *   username: 'your-username',
+ *   password: 'your-password',
+ *   from: 'MYSENDER',
+ * });
+ *
+ * await service.send({
+ *   to: '905551234567',
+ *   message: 'Hello!',
+ * });
+ * ```
+ */
+declare class SMSService {
+    private provider;
+    private debug;
+    /**
+     * Creates a new SMSService instance.
+     *
+     * @param config - The SMS service configuration
+     */
+    constructor(config: SMSServiceConfig);
+    private createProvider;
+    /**
+     * Gets the type of SMS provider being used.
+     */
+    get providerType(): SMSProviderType;
+    /**
+     * Sends a single SMS message.
+     *
+     * @param options - The SMS options
+     * @returns A promise that resolves to the send result
+     */
+    send(options: SMSOptions): Promise<SMSResult>;
+    /**
+     * Sends multiple SMS messages in a batch.
+     *
+     * @param options - The batch SMS options
+     * @returns A promise that resolves to the batch result
+     */
+    sendBatch(options: BatchSMSOptions): Promise<BatchSMSResult>;
+    /**
+     * Verifies the provider configuration.
+     *
+     * @returns A promise that resolves to true if configuration is valid
+     */
+    verify(): Promise<boolean>;
+    /**
+     * Send OTP verification SMS
+     *
+     * @param phone - Recipient phone number
+     * @param code - OTP code
+     * @param expiresInMinutes - Code expiration time
+     */
+    sendOTP(phone: string, code: string, expiresInMinutes?: number): Promise<SMSResult>;
+    /**
+     * Send welcome SMS
+     *
+     * @param phone - Recipient phone number
+     * @param name - User's display name
+     */
+    sendWelcome(phone: string, name?: string): Promise<SMSResult>;
+}
+/**
+ * Create an SMS service
+ *
+ * @example
+ * ```typescript
+ * // With NetGSM
+ * const sms = createSMSService({
+ *   provider: 'netgsm',
+ *   username: process.env.NETGSM_USERNAME,
+ *   password: process.env.NETGSM_PASSWORD,
+ *   from: 'MYSENDER',
+ * });
+ *
+ * // For development
+ * const sms = createSMSService({
+ *   provider: 'console',
+ *   from: 'TEST',
+ * });
+ * ```
+ */
+declare function createSMSService(config: SMSServiceConfig): SMSService;
+/**
+ * Creates an SMS provider instance directly.
+ *
+ * @param type - The type of SMS provider to create
+ * @param config - The provider configuration
+ * @returns A new SMS provider instance
+ */
+declare function createSMSProvider(type: SMSProviderType, config: SMSProviderConfig & {
+    providerUrl?: string;
+}): SMSProvider;
+declare const _default: {
+    SMSService: typeof SMSService;
+    createSMSService: typeof createSMSService;
+    createSMSProvider: typeof createSMSProvider;
+};
+
+export { BatchSMSOptions, BatchSMSResult, SMSOptions, SMSProvider, SMSProviderConfig, SMSProviderType, SMSResult, SMSService, SMSServiceConfig, createSMSProvider, createSMSService, _default as default };