OutrunSimpleSMS

React components and utilities for composing and sending SMS with templates and merge fields.

Install

npm install outrun-simple-sms
# or link locally:
# "outrun-simple-sms": "file:../OutrunSimpleSMS"

Peer dependencies: react, react-dom (18+).

Usage

import {
  createRestAdapter,
  DealSmsComposer,
  TemplateManager,
} from "outrun-simple-sms";
import "outrun-simple-sms/styles.css";

const adapter = createRestAdapter("/api/sms");

<DealSmsComposer
  adapter={adapter}
  mobile="0410 581 780"
  mergeData={{ customerName: "Acme", quoteId: "Q-123" }}
  suggestedTemplateName="Late Payment"
  quoteId="Q-123"
  onCancel={() => setOpen(false)}
/>

Adapter contract

Implement SimpleSmsAdapter or use createRestAdapter against these routes:

| Method | Route | |--------|-------| | listTemplates | GET /templates → { templates: SmsTemplate[] } | | saveTemplate | POST /templates | | deleteTemplate | DELETE /templates/:id | | getCredits | GET /credits → { remaining: number } | | send | POST /send → { ok: true, creditsRemaining?: number } |

Merge fields

Use {fieldName} placeholders in template bodies. Built-in: {today} (dd/MM/yy).

Build

npm install
npm run build

Server-safe imports

API routes should import utilities from outrun-simple-sms/core (no React):

import { isValidAuMobile, applyMergeFields } from "outrun-simple-sms/core";