@parsrun/sms 0.2.1

package/dist/types.d.ts

@@ -0,0 +1,116 @@
+/**
+ * @parsrun/sms - Type definitions
+ */
+/**
+ * Supported SMS provider types
+ */
+type SMSProviderType = "netgsm" | "twilio" | "console";
+/**
+ * SMS send options
+ */
+interface SMSOptions {
+    /** Recipient phone number (international format recommended, e.g., 905xxxxxxxxx) */
+    to: string;
+    /** SMS message content */
+    message: string;
+    /** Optional sender ID override */
+    from?: string;
+    /** Optional metadata/tags */
+    tags?: Record<string, string>;
+}
+/**
+ * SMS send result
+ */
+interface SMSResult {
+    /** Whether the SMS was sent successfully */
+    success: boolean;
+    /** Provider-specific message ID */
+    messageId?: string;
+    /** Error message if send failed */
+    error?: string;
+    /** Raw provider response data */
+    data?: unknown;
+}
+/**
+ * Batch SMS options
+ */
+interface BatchSMSOptions {
+    /** Array of SMS messages to send */
+    messages: SMSOptions[];
+    /** Stop sending if an error occurs */
+    stopOnError?: boolean;
+}
+/**
+ * Batch SMS result
+ */
+interface BatchSMSResult {
+    /** Total number of messages attempted */
+    total: number;
+    /** Number of successfully sent messages */
+    successful: number;
+    /** Number of failed messages */
+    failed: number;
+    /** Individual results for each message */
+    results: SMSResult[];
+}
+/**
+ * SMS provider configuration
+ */
+interface SMSProviderConfig {
+    /** API key or authentication token */
+    apiKey?: string;
+    /** Provider username (for providers like NetGSM) */
+    username?: string;
+    /** Provider password (for providers like NetGSM) */
+    password?: string;
+    /** Default sender ID/header */
+    from?: string;
+    /** Provider-specific options */
+    options?: Record<string, unknown>;
+}
+/**
+ * SMS service configuration
+ */
+interface SMSServiceConfig extends SMSProviderConfig {
+    /** SMS provider type */
+    provider: SMSProviderType;
+    /** Provider API URL (for custom endpoints) */
+    providerUrl?: string;
+    /** Enable debug logging */
+    debug?: boolean;
+}
+/**
+ * SMS provider interface
+ */
+interface SMSProvider {
+    /** Provider type identifier */
+    readonly type: SMSProviderType;
+    /** Send a single SMS */
+    send(options: SMSOptions): Promise<SMSResult>;
+    /** Send multiple SMS messages (optional) */
+    sendBatch?(options: BatchSMSOptions): Promise<BatchSMSResult>;
+    /** Verify provider configuration (optional) */
+    verify?(): Promise<boolean>;
+}
+/**
+ * SMS error codes
+ */
+declare const SMSErrorCodes: {
+    readonly INVALID_CONFIG: "SMS_INVALID_CONFIG";
+    readonly SEND_FAILED: "SMS_SEND_FAILED";
+    readonly INVALID_PHONE: "SMS_INVALID_PHONE";
+    readonly RATE_LIMITED: "SMS_RATE_LIMITED";
+    readonly INSUFFICIENT_BALANCE: "SMS_INSUFFICIENT_BALANCE";
+    readonly PROVIDER_ERROR: "SMS_PROVIDER_ERROR";
+};
+type SMSErrorCode = (typeof SMSErrorCodes)[keyof typeof SMSErrorCodes];
+/**
+ * SMS error class
+ */
+declare class SMSError extends Error {
+    code: SMSErrorCode;
+    cause?: unknown;
+    constructor(message: string, code: SMSErrorCode, cause?: unknown);
+}
+
+export { type BatchSMSOptions, type BatchSMSResult, SMSError, type SMSErrorCode, SMSErrorCodes, type SMSOptions, type SMSProvider, type SMSProviderConfig, type SMSProviderType, type SMSResult, type SMSServiceConfig };

package/dist/types.js

@@ -0,0 +1,23 @@
+// src/types.ts
+var SMSErrorCodes = {
+  INVALID_CONFIG: "SMS_INVALID_CONFIG",
+  SEND_FAILED: "SMS_SEND_FAILED",
+  INVALID_PHONE: "SMS_INVALID_PHONE",
+  RATE_LIMITED: "SMS_RATE_LIMITED",
+  INSUFFICIENT_BALANCE: "SMS_INSUFFICIENT_BALANCE",
+  PROVIDER_ERROR: "SMS_PROVIDER_ERROR"
+};
+var SMSError = class extends Error {
+  code;
+  cause;
+  constructor(message, code, cause) {
+    super(message);
+    this.name = "SMSError";
+    this.code = code;
+    this.cause = cause;
+  }
+};
+
+export { SMSError, SMSErrorCodes };
+//# sourceMappingURL=types.js.map
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/types.ts"],"names":[],"mappings":";AA6GO,IAAM,aAAA,GAAgB;AAAA,EAC3B,cAAA,EAAgB,oBAAA;AAAA,EAChB,WAAA,EAAa,iBAAA;AAAA,EACb,aAAA,EAAe,mBAAA;AAAA,EACf,YAAA,EAAc,kBAAA;AAAA,EACd,oBAAA,EAAsB,0BAAA;AAAA,EACtB,cAAA,EAAgB;AAClB;AAOO,IAAM,QAAA,GAAN,cAAuB,KAAA,CAAM;AAAA,EAClC,IAAA;AAAA,EACA,KAAA;AAAA,EAEA,WAAA,CAAY,OAAA,EAAiB,IAAA,EAAoB,KAAA,EAAiB;AAChE,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAO,UAAA;AACZ,IAAA,IAAA,CAAK,IAAA,GAAO,IAAA;AACZ,IAAA,IAAA,CAAK,KAAA,GAAQ,KAAA;AAAA,EACf;AACF","file":"types.js","sourcesContent":["/**\n * @parsrun/sms - Type definitions\n */\n\n/**\n * Supported SMS provider types\n */\nexport type SMSProviderType = \"netgsm\" | \"twilio\" | \"console\";\n\n/**\n * SMS send options\n */\nexport interface SMSOptions {\n  /** Recipient phone number (international format recommended, e.g., 905xxxxxxxxx) */\n  to: string;\n  /** SMS message content */\n  message: string;\n  /** Optional sender ID override */\n  from?: string;\n  /** Optional metadata/tags */\n  tags?: Record<string, string>;\n}\n\n/**\n * SMS send result\n */\nexport interface SMSResult {\n  /** Whether the SMS was sent successfully */\n  success: boolean;\n  /** Provider-specific message ID */\n  messageId?: string;\n  /** Error message if send failed */\n  error?: string;\n  /** Raw provider response data */\n  data?: unknown;\n}\n\n/**\n * Batch SMS options\n */\nexport interface BatchSMSOptions {\n  /** Array of SMS messages to send */\n  messages: SMSOptions[];\n  /** Stop sending if an error occurs */\n  stopOnError?: boolean;\n}\n\n/**\n * Batch SMS result\n */\nexport interface BatchSMSResult {\n  /** Total number of messages attempted */\n  total: number;\n  /** Number of successfully sent messages */\n  successful: number;\n  /** Number of failed messages */\n  failed: number;\n  /** Individual results for each message */\n  results: SMSResult[];\n}\n\n/**\n * SMS provider configuration\n */\nexport interface SMSProviderConfig {\n  /** API key or authentication token */\n  apiKey?: string;\n  /** Provider username (for providers like NetGSM) */\n  username?: string;\n  /** Provider password (for providers like NetGSM) */\n  password?: string;\n  /** Default sender ID/header */\n  from?: string;\n  /** Provider-specific options */\n  options?: Record<string, unknown>;\n}\n\n/**\n * SMS service configuration\n */\nexport interface SMSServiceConfig extends SMSProviderConfig {\n  /** SMS provider type */\n  provider: SMSProviderType;\n  /** Provider API URL (for custom endpoints) */\n  providerUrl?: string;\n  /** Enable debug logging */\n  debug?: boolean;\n}\n\n/**\n * SMS provider interface\n */\nexport interface SMSProvider {\n  /** Provider type identifier */\n  readonly type: SMSProviderType;\n\n  /** Send a single SMS */\n  send(options: SMSOptions): Promise<SMSResult>;\n\n  /** Send multiple SMS messages (optional) */\n  sendBatch?(options: BatchSMSOptions): Promise<BatchSMSResult>;\n\n  /** Verify provider configuration (optional) */\n  verify?(): Promise<boolean>;\n}\n\n/**\n * SMS error codes\n */\nexport const SMSErrorCodes = {\n  INVALID_CONFIG: \"SMS_INVALID_CONFIG\",\n  SEND_FAILED: \"SMS_SEND_FAILED\",\n  INVALID_PHONE: \"SMS_INVALID_PHONE\",\n  RATE_LIMITED: \"SMS_RATE_LIMITED\",\n  INSUFFICIENT_BALANCE: \"SMS_INSUFFICIENT_BALANCE\",\n  PROVIDER_ERROR: \"SMS_PROVIDER_ERROR\",\n} as const;\n\nexport type SMSErrorCode = (typeof SMSErrorCodes)[keyof typeof SMSErrorCodes];\n\n/**\n * SMS error class\n */\nexport class SMSError extends Error {\n  code: SMSErrorCode;\n  cause?: unknown;\n\n  constructor(message: string, code: SMSErrorCode, cause?: unknown) {\n    super(message);\n    this.name = \"SMSError\";\n    this.code = code;\n    this.cause = cause;\n  }\n}\n"]}

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@parsrun/sms",
+  "version": "0.2.1",
+  "description": "Edge-compatible SMS sending for Pars - NetGSM, Twilio, and more",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./types": {
+      "types": "./dist/types.d.ts",
+      "import": "./dist/types.js"
+    },
+    "./providers": {
+      "types": "./dist/providers/index.d.ts",
+      "import": "./dist/providers/index.js"
+    },
+    "./providers/netgsm": {
+      "types": "./dist/providers/netgsm.d.ts",
+      "import": "./dist/providers/netgsm.js"
+    },
+    "./providers/console": {
+      "types": "./dist/providers/console.d.ts",
+      "import": "./dist/providers/console.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit"
+  },
+  "keywords": [
+    "sms",
+    "netgsm",
+    "twilio",
+    "edge",
+    "pars"
+  ],
+  "author": "EMS Tech Solutions",
+  "license": "MIT",
+  "homepage": "https://pars.run",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/parsrun/pars",
+    "directory": "packages/sms"
+  },
+  "dependencies": {
+    "@parsrun/core": "workspace:*",
+    "@parsrun/types": "workspace:*"
+  },
+  "devDependencies": {
+    "tsup": "^8.3.5",
+    "typescript": "^5.7.2",
+    "vitest": "^2.1.8"
+  }
+}