@narcisbodea/smstunnel-sdk 1.0.0

package/dist/index.d.mts

@@ -0,0 +1,241 @@
+interface SmsTunnelConfig {
+    serverUrl: string;
+    apiKey: string;
+    siteToken: string;
+    deviceName: string;
+}
+interface SmsTunnelStorageAdapter {
+    getConfig(): Promise<Partial<SmsTunnelConfig>>;
+    updateConfig(partial: Partial<SmsTunnelConfig>): Promise<void>;
+    clearConfig(): Promise<void>;
+}
+interface SmsTunnelStatus {
+    paired: boolean;
+    serverUrl?: string;
+    deviceName?: string;
+}
+interface SendSmsResult {
+    success: boolean;
+    messageId?: string;
+    error?: string;
+}
+interface CreateTokenResult {
+    success: boolean;
+    token?: string;
+    qrData?: string;
+    expiresAt?: string;
+    pollUrl?: string;
+    error?: string;
+}
+interface PairingStatusResult {
+    status: string;
+    displayName?: string;
+    error?: string;
+}
+interface PairingCallbackBody {
+    event: string;
+    token: string;
+    apiKey: string;
+    deviceId?: string;
+    deviceName?: string;
+    userId?: string;
+}
+
+interface SmsTunnelLabels {
+    title: string;
+    description: string;
+    serverUrlLabel: string;
+    serverUrlPlaceholder: string;
+    saveButton: string;
+    pairedStatus: string;
+    deviceLabel: string;
+    unpairButton: string;
+    unpairConfirm: string;
+    notPairedStatus: string;
+    notPairedDescription: string;
+    connectButton: string;
+    scanQrPrompt: string;
+    waitingForPairing: string;
+    cancelButton: string;
+    qrExpired: string;
+    testSmsTitle: string;
+    testPhonePlaceholder: string;
+    testMessagePlaceholder: string;
+    sendTestButton: string;
+    smsSentSuccess: string;
+    smsError: string;
+}
+declare const EN_LABELS: SmsTunnelLabels;
+declare const RO_LABELS: SmsTunnelLabels;
+
+/**
+ * Framework-agnostic SMSTunnel client.
+ *
+ * Works with Angular, Svelte, Astro, Solid, Vanilla JS, or any framework.
+ * For React use `smstunnel-sdk/react`, for Vue use `smstunnel-sdk/vue`.
+ */
+interface SmsTunnelClientOptions {
+    apiBaseUrl: string;
+    getAuthHeaders?: () => Record<string, string>;
+    routePrefix?: string;
+    pollInterval?: number;
+}
+interface SmsTunnelStatusResponse {
+    paired: boolean;
+    serverUrl?: string;
+    deviceName?: string;
+}
+interface CreateTokenResponse {
+    success: boolean;
+    token?: string;
+    qrData?: string;
+    expiresAt?: string;
+    pollUrl?: string;
+    error?: string;
+}
+interface PairingStatusResponse {
+    status: 'pending' | 'completed' | 'expired' | 'error';
+    source?: string;
+    displayName?: string;
+    pairedDeviceId?: string;
+    pairingId?: string;
+    error?: string;
+}
+interface SendSmsResponse {
+    success: boolean;
+    messageId?: string;
+    queued?: boolean;
+    data?: {
+        messageId: string;
+        branded: boolean;
+        queued: boolean;
+        remaining: number;
+    };
+    error?: string;
+}
+interface SmsStatusResponse {
+    success: boolean;
+    data?: {
+        messageId: string;
+        status: 'sent' | 'pending' | 'failed' | 'delivered';
+        recipient: string;
+        sentAt?: string;
+    };
+    error?: string;
+}
+interface SendBulkSmsRequest {
+    messages: Array<{
+        to: string;
+        message: string;
+    }>;
+}
+interface SendBulkSmsResponse {
+    success: boolean;
+    results?: Array<{
+        to: string;
+        messageId?: string;
+        error?: string;
+    }>;
+    error?: string;
+}
+interface Send2faRequest {
+    to: string;
+    code: string;
+    template?: string;
+}
+interface ReceivedSmsResponse {
+    success: boolean;
+    data?: Array<{
+        from: string;
+        message: string;
+        receivedAt: string;
+    }>;
+    error?: string;
+}
+interface DevicesResponse {
+    success: boolean;
+    data?: Array<{
+        id: string;
+        clientId: string;
+        name: string;
+        brand?: string;
+        model?: string;
+        connected?: boolean;
+    }>;
+    error?: string;
+}
+interface AccountUsageResponse {
+    success: boolean;
+    data?: {
+        messagesSent: number;
+        messagesReceived: number;
+        messagesSentToday: number;
+        messagesSentMonth: number;
+        dailyLimit?: number;
+        monthlyLimit?: number;
+    };
+    error?: string;
+}
+interface PairingInfo {
+    _id: string;
+    deviceId: string;
+    type: string;
+    name: string;
+    status: 'active' | 'paused' | 'revoked';
+    messagesSent: number;
+    createdAt: string;
+    source: string;
+}
+type PairingEventCallback = (event: 'completed' | 'expired' | 'error', data?: any) => void;
+declare class SmsTunnelClient {
+    private readonly baseUrl;
+    private readonly prefix;
+    private readonly pollInterval;
+    private readonly getAuthHeaders;
+    private pollTimer;
+    constructor(options: SmsTunnelClientOptions);
+    /** Get current pairing status */
+    getStatus(): Promise<SmsTunnelStatusResponse>;
+    /** Create a pairing token (generates QR data) */
+    createToken(): Promise<CreateTokenResponse>;
+    /** Check pairing status for a token (no auth needed) */
+    getPairingStatus(token: string): Promise<PairingStatusResponse>;
+    /**
+     * Start polling for pairing completion.
+     * Returns a cleanup function to stop polling.
+     */
+    startPolling(token: string, callback: PairingEventCallback): () => void;
+    /** Stop polling */
+    stopPolling(): void;
+    /** Unpair the connected device */
+    unpair(): Promise<{
+        success: boolean;
+    }>;
+    /** List active pairings (proxied through backend) */
+    getPairings(): Promise<PairingInfo[]>;
+    /** Send a single SMS */
+    sendSms(to: string, message: string): Promise<SendSmsResponse>;
+    /** Send a 2FA SMS */
+    send2fa(to: string, code: string, template?: string): Promise<SendSmsResponse>;
+    /** Send bulk SMS */
+    sendBulk(messages: Array<{
+        to: string;
+        message: string;
+    }>): Promise<SendBulkSmsResponse>;
+    /** Get SMS delivery status */
+    getSmsStatus(messageId: string): Promise<SmsStatusResponse>;
+    /** Get received SMS (inbox) */
+    getReceivedSms(): Promise<ReceivedSmsResponse>;
+    /** List paired devices */
+    getDevices(): Promise<DevicesResponse>;
+    /** Get account usage stats */
+    getUsage(): Promise<AccountUsageResponse>;
+    /** Update server URL configuration */
+    updateServerUrl(serverUrl: string): Promise<{
+        success: boolean;
+    }>;
+    /** Destroy - cleanup polling */
+    destroy(): void;
+}
+
+export { type AccountUsageResponse, type CreateTokenResponse, type CreateTokenResult, type DevicesResponse, EN_LABELS, type PairingCallbackBody, type PairingEventCallback, type PairingInfo, type PairingStatusResponse, type PairingStatusResult, RO_LABELS, type ReceivedSmsResponse, type Send2faRequest, type SendBulkSmsRequest, type SendBulkSmsResponse, type SendSmsResponse, type SendSmsResult, type SmsStatusResponse, SmsTunnelClient, type SmsTunnelClientOptions, type SmsTunnelConfig, type SmsTunnelLabels, type SmsTunnelStatus, type SmsTunnelStatusResponse, type SmsTunnelStorageAdapter };

package/dist/index.d.ts

@@ -0,0 +1,241 @@
+interface SmsTunnelConfig {
+    serverUrl: string;
+    apiKey: string;
+    siteToken: string;
+    deviceName: string;
+}
+interface SmsTunnelStorageAdapter {
+    getConfig(): Promise<Partial<SmsTunnelConfig>>;
+    updateConfig(partial: Partial<SmsTunnelConfig>): Promise<void>;
+    clearConfig(): Promise<void>;
+}
+interface SmsTunnelStatus {
+    paired: boolean;
+    serverUrl?: string;
+    deviceName?: string;
+}
+interface SendSmsResult {
+    success: boolean;
+    messageId?: string;
+    error?: string;
+}
+interface CreateTokenResult {
+    success: boolean;
+    token?: string;
+    qrData?: string;
+    expiresAt?: string;
+    pollUrl?: string;
+    error?: string;
+}
+interface PairingStatusResult {
+    status: string;
+    displayName?: string;
+    error?: string;
+}
+interface PairingCallbackBody {
+    event: string;
+    token: string;
+    apiKey: string;
+    deviceId?: string;
+    deviceName?: string;
+    userId?: string;
+}
+
+interface SmsTunnelLabels {
+    title: string;
+    description: string;
+    serverUrlLabel: string;
+    serverUrlPlaceholder: string;
+    saveButton: string;
+    pairedStatus: string;
+    deviceLabel: string;
+    unpairButton: string;
+    unpairConfirm: string;
+    notPairedStatus: string;
+    notPairedDescription: string;
+    connectButton: string;
+    scanQrPrompt: string;
+    waitingForPairing: string;
+    cancelButton: string;
+    qrExpired: string;
+    testSmsTitle: string;
+    testPhonePlaceholder: string;
+    testMessagePlaceholder: string;
+    sendTestButton: string;
+    smsSentSuccess: string;
+    smsError: string;
+}
+declare const EN_LABELS: SmsTunnelLabels;
+declare const RO_LABELS: SmsTunnelLabels;
+
+/**
+ * Framework-agnostic SMSTunnel client.
+ *
+ * Works with Angular, Svelte, Astro, Solid, Vanilla JS, or any framework.
+ * For React use `smstunnel-sdk/react`, for Vue use `smstunnel-sdk/vue`.
+ */
+interface SmsTunnelClientOptions {
+    apiBaseUrl: string;
+    getAuthHeaders?: () => Record<string, string>;
+    routePrefix?: string;
+    pollInterval?: number;
+}
+interface SmsTunnelStatusResponse {
+    paired: boolean;
+    serverUrl?: string;
+    deviceName?: string;
+}
+interface CreateTokenResponse {
+    success: boolean;
+    token?: string;
+    qrData?: string;
+    expiresAt?: string;
+    pollUrl?: string;
+    error?: string;
+}
+interface PairingStatusResponse {
+    status: 'pending' | 'completed' | 'expired' | 'error';
+    source?: string;
+    displayName?: string;
+    pairedDeviceId?: string;
+    pairingId?: string;
+    error?: string;
+}
+interface SendSmsResponse {
+    success: boolean;
+    messageId?: string;
+    queued?: boolean;
+    data?: {
+        messageId: string;
+        branded: boolean;
+        queued: boolean;
+        remaining: number;
+    };
+    error?: string;
+}
+interface SmsStatusResponse {
+    success: boolean;
+    data?: {
+        messageId: string;
+        status: 'sent' | 'pending' | 'failed' | 'delivered';
+        recipient: string;
+        sentAt?: string;
+    };
+    error?: string;
+}
+interface SendBulkSmsRequest {
+    messages: Array<{
+        to: string;
+        message: string;
+    }>;
+}
+interface SendBulkSmsResponse {
+    success: boolean;
+    results?: Array<{
+        to: string;
+        messageId?: string;
+        error?: string;
+    }>;
+    error?: string;
+}
+interface Send2faRequest {
+    to: string;
+    code: string;
+    template?: string;
+}
+interface ReceivedSmsResponse {
+    success: boolean;
+    data?: Array<{
+        from: string;
+        message: string;
+        receivedAt: string;
+    }>;
+    error?: string;
+}
+interface DevicesResponse {
+    success: boolean;
+    data?: Array<{
+        id: string;
+        clientId: string;
+        name: string;
+        brand?: string;
+        model?: string;
+        connected?: boolean;
+    }>;
+    error?: string;
+}
+interface AccountUsageResponse {
+    success: boolean;
+    data?: {
+        messagesSent: number;
+        messagesReceived: number;
+        messagesSentToday: number;
+        messagesSentMonth: number;
+        dailyLimit?: number;
+        monthlyLimit?: number;
+    };
+    error?: string;
+}
+interface PairingInfo {
+    _id: string;
+    deviceId: string;
+    type: string;
+    name: string;
+    status: 'active' | 'paused' | 'revoked';
+    messagesSent: number;
+    createdAt: string;
+    source: string;
+}
+type PairingEventCallback = (event: 'completed' | 'expired' | 'error', data?: any) => void;
+declare class SmsTunnelClient {
+    private readonly baseUrl;
+    private readonly prefix;
+    private readonly pollInterval;
+    private readonly getAuthHeaders;
+    private pollTimer;
+    constructor(options: SmsTunnelClientOptions);
+    /** Get current pairing status */
+    getStatus(): Promise<SmsTunnelStatusResponse>;
+    /** Create a pairing token (generates QR data) */
+    createToken(): Promise<CreateTokenResponse>;
+    /** Check pairing status for a token (no auth needed) */
+    getPairingStatus(token: string): Promise<PairingStatusResponse>;
+    /**
+     * Start polling for pairing completion.
+     * Returns a cleanup function to stop polling.
+     */
+    startPolling(token: string, callback: PairingEventCallback): () => void;
+    /** Stop polling */
+    stopPolling(): void;
+    /** Unpair the connected device */
+    unpair(): Promise<{
+        success: boolean;
+    }>;
+    /** List active pairings (proxied through backend) */
+    getPairings(): Promise<PairingInfo[]>;
+    /** Send a single SMS */
+    sendSms(to: string, message: string): Promise<SendSmsResponse>;
+    /** Send a 2FA SMS */
+    send2fa(to: string, code: string, template?: string): Promise<SendSmsResponse>;
+    /** Send bulk SMS */
+    sendBulk(messages: Array<{
+        to: string;
+        message: string;
+    }>): Promise<SendBulkSmsResponse>;
+    /** Get SMS delivery status */
+    getSmsStatus(messageId: string): Promise<SmsStatusResponse>;
+    /** Get received SMS (inbox) */
+    getReceivedSms(): Promise<ReceivedSmsResponse>;
+    /** List paired devices */
+    getDevices(): Promise<DevicesResponse>;
+    /** Get account usage stats */
+    getUsage(): Promise<AccountUsageResponse>;
+    /** Update server URL configuration */
+    updateServerUrl(serverUrl: string): Promise<{
+        success: boolean;
+    }>;
+    /** Destroy - cleanup polling */
+    destroy(): void;
+}
+
+export { type AccountUsageResponse, type CreateTokenResponse, type CreateTokenResult, type DevicesResponse, EN_LABELS, type PairingCallbackBody, type PairingEventCallback, type PairingInfo, type PairingStatusResponse, type PairingStatusResult, RO_LABELS, type ReceivedSmsResponse, type Send2faRequest, type SendBulkSmsRequest, type SendBulkSmsResponse, type SendSmsResponse, type SendSmsResult, type SmsStatusResponse, SmsTunnelClient, type SmsTunnelClientOptions, type SmsTunnelConfig, type SmsTunnelLabels, type SmsTunnelStatus, type SmsTunnelStatusResponse, type SmsTunnelStorageAdapter };