vintasend-twilio 0.6.2

package/README.md

@@ -0,0 +1,125 @@
+# VintaSend Twilio Adapter
+
+A VintaSend notification adapter using [Twilio](https://www.twilio.com/) for reliable SMS and phone call delivery.
+
+## Installation
+
+```bash
+npm install vintasend-twilio twilio
+```
+
+## Configuration
+
+```typescript
+import { TwilioNotificationAdapterFactory } from 'vintasend-twilio';
+
+const adapter = new TwilioNotificationAdapterFactory().create(
+   templateRenderer,
+   false, // enqueueNotifications
+   {
+      accountSid: process.env.TWILIO_ACCOUNT_SID,
+      authToken: process.env.TWILIO_AUTH_TOKEN,
+      fromNumber: '+1234567890',
+   }
+);
+```
+
+### Configuration Options
+
+```typescript
+interface TwilioConfig {
+   accountSid: string;    // Twilio Account SID
+   authToken: string;     // Twilio Auth Token
+   fromNumber: string;    // Default sender phone number
+}
+```
+
+## Usage
+
+### Basic SMS
+
+```typescript
+await notificationService.createNotification({
+   userId: '123',
+   notificationType: 'SMS',
+   contextName: 'verification',
+   contextParameters: { code: '123456' },
+   title: 'Verification Code',
+   bodyTemplate: '/templates/verification.pug',
+   sendAfter: new Date(),
+});
+```
+
+### One-Off SMS
+
+Send SMS without a user account:
+
+```typescript
+await notificationService.createOneOffNotification({
+   emailOrPhone: '+1987654321',
+   firstName: 'Jane',
+   lastName: 'Smith',
+   notificationType: 'SMS',
+   contextName: 'order-status',
+   contextParameters: { status: 'shipped' },
+   title: 'Order Status Update',
+   bodyTemplate: '/templates/order-status.pug',
+   sendAfter: new Date(),
+});
+```
+
+### Scheduled Notifications
+
+```typescript
+await notificationService.createNotification({
+   userId: '123',
+   notificationType: 'SMS',
+   contextName: 'reminder',
+   contextParameters: { appointmentTime: '2pm' },
+   title: 'Appointment Reminder',
+   bodyTemplate: '/templates/reminder.pug',
+   sendAfter: new Date('2024-01-15T14:00:00Z'),
+});
+```
+
+## Features
+
+- ✅ SMS delivery via Twilio API
+- ✅ One-off notifications
+- ✅ Scheduled notifications
+- ✅ Custom sender phone number
+- ✅ Text message templates
+- ✅ Global reach (190+ countries)
+
+## API Reference
+
+### TwilioNotificationAdapterFactory
+
+```typescript
+class TwilioNotificationAdapterFactory<Config extends BaseNotificationTypeConfig>
+```
+
+**Methods:**
+- `create<TemplateRenderer>(templateRenderer, enqueueNotifications, config)` - Create adapter instance
+
+### TwilioNotificationAdapter
+
+**Properties:**
+- `key: string` - Returns `'twilio'`
+- `notificationType: NotificationType` - Returns `'SMS'`
+- `supportsAttachments: boolean` - Returns `false`
+
+**Methods:**
+- `send(notification, context)` - Send an SMS message
+
+## Environment Variables
+
+```bash
+TWILIO_ACCOUNT_SID=ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+TWILIO_AUTH_TOKEN=your-auth-token-here
+TWILIO_FROM_NUMBER=+1234567890
+```
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { TwilioSmsAdapter, TwilioSmsAdapterFactory } from './twilio-sms-adapter';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAC"}

package/dist/index.js

@@ -0,0 +1 @@
+export { TwilioSmsAdapter, TwilioSmsAdapterFactory } from './twilio-sms-adapter';

package/dist/twilio-sms-adapter.d.ts

@@ -0,0 +1,29 @@
+import { BaseNotificationAdapter } from 'vintasend';
+import type { BaseEmailTemplateRenderer } from 'vintasend';
+import type { JsonObject } from 'vintasend/dist/types/json-values';
+import type { AnyDatabaseNotification } from 'vintasend/dist/types/notification';
+import type { BaseNotificationTypeConfig } from 'vintasend/dist/types/notification-type-config';
+export interface TwilioConfig {
+    accountSid: string;
+    authToken: string;
+    fromNumber: string;
+}
+/**
+ * SMS adapter using Twilio REST API directly via fetch.
+ * Avoids the twilio npm package to keep Medplum bot bundles small.
+ *
+ * SMS notifications should be created via createOneOffNotification() with
+ * the phone number passed as emailOrPhone. The calling service resolves
+ * the phone number from the FHIR resource.
+ */
+export declare class TwilioSmsAdapter<TemplateRenderer extends BaseEmailTemplateRenderer<Config>, Config extends BaseNotificationTypeConfig> extends BaseNotificationAdapter<TemplateRenderer, Config> {
+    key: string | null;
+    private config;
+    constructor(templateRenderer: TemplateRenderer, enqueueNotifications: boolean, config: TwilioConfig);
+    get supportsAttachments(): boolean;
+    send(notification: AnyDatabaseNotification<Config>, context: JsonObject): Promise<void>;
+}
+export declare class TwilioSmsAdapterFactory<Config extends BaseNotificationTypeConfig> {
+    create<TemplateRenderer extends BaseEmailTemplateRenderer<Config>>(templateRenderer: TemplateRenderer, enqueueNotifications: boolean, config: TwilioConfig): TwilioSmsAdapter<TemplateRenderer, Config>;
+}
+//# sourceMappingURL=twilio-sms-adapter.d.ts.map

package/dist/twilio-sms-adapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"twilio-sms-adapter.d.ts","sourceRoot":"","sources":["../src/twilio-sms-adapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,WAAW,CAAC;AACpD,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,WAAW,CAAC;AAC3D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAC;AACnE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,mCAAmC,CAAC;AACjF,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,+CAA+C,CAAC;AAEhG,MAAM,WAAW,YAAY;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;GAOG;AACH,qBAAa,gBAAgB,CAC3B,gBAAgB,SAAS,yBAAyB,CAAC,MAAM,CAAC,EAC1D,MAAM,SAAS,0BAA0B,CACzC,SAAQ,uBAAuB,CAAC,gBAAgB,EAAE,MAAM,CAAC;IACzD,GAAG,EAAE,MAAM,GAAG,IAAI,CAAgB;IAClC,OAAO,CAAC,MAAM,CAAe;gBAEjB,gBAAgB,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY;IAKnG,IAAI,mBAAmB,IAAI,OAAO,CAEjC;IAEK,IAAI,CAAC,YAAY,EAAE,uBAAuB,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;CA2B9F;AAED,qBAAa,uBAAuB,CAAC,MAAM,SAAS,0BAA0B;IAC5E,MAAM,CAAC,gBAAgB,SAAS,yBAAyB,CAAC,MAAM,CAAC,EAC/D,gBAAgB,EAAE,gBAAgB,EAClC,oBAAoB,EAAE,OAAO,EAC7B,MAAM,EAAE,YAAY,GACnB,gBAAgB,CAAC,gBAAgB,EAAE,MAAM,CAAC;CAG9C"}

package/dist/twilio-sms-adapter.js

@@ -0,0 +1,47 @@
+import { BaseNotificationAdapter } from 'vintasend';
+/**
+ * SMS adapter using Twilio REST API directly via fetch.
+ * Avoids the twilio npm package to keep Medplum bot bundles small.
+ *
+ * SMS notifications should be created via createOneOffNotification() with
+ * the phone number passed as emailOrPhone. The calling service resolves
+ * the phone number from the FHIR resource.
+ */
+export class TwilioSmsAdapter extends BaseNotificationAdapter {
+    constructor(templateRenderer, enqueueNotifications, config) {
+        super(templateRenderer, 'SMS', enqueueNotifications);
+        this.key = 'twilio-sms';
+        this.config = config;
+    }
+    get supportsAttachments() {
+        return false;
+    }
+    async send(notification, context) {
+        const template = await this.templateRenderer.render(notification, context);
+        const recipientPhone = await this.getRecipientEmail(notification);
+        const url = `https://api.twilio.com/2010-04-01/Accounts/${this.config.accountSid}/Messages.json`;
+        const credentials = btoa(`${this.config.accountSid}:${this.config.authToken}`);
+        const body = new URLSearchParams({
+            To: recipientPhone,
+            From: this.config.fromNumber,
+            Body: template.body,
+        });
+        const response = await fetch(url, {
+            method: 'POST',
+            headers: {
+                Authorization: `Basic ${credentials}`,
+                'Content-Type': 'application/x-www-form-urlencoded',
+            },
+            body: body.toString(),
+        });
+        if (!response.ok) {
+            const errorBody = await response.text();
+            throw new Error(`Twilio SMS send failed (${response.status}): ${errorBody}`);
+        }
+    }
+}
+export class TwilioSmsAdapterFactory {
+    create(templateRenderer, enqueueNotifications, config) {
+        return new TwilioSmsAdapter(templateRenderer, enqueueNotifications, config);
+    }
+}

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "vintasend-twilio",
+  "version": "0.6.2",
+  "description": "",
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage"
+  },
+  "files": [
+    "dist"
+  ],
+  "author": "Gustavo Carvalho",
+  "license": "MIT",
+  "dependencies": {
+    "vintasend": "^0.6.2"
+  },
+  "devDependencies": {
+    "@types/jest": "^30.0.0",
+    "jest": "^30.2.0",
+    "ts-jest": "^29.4.6",
+    "typescript": "^5.9.3"
+  }
+}