@maxnate/plugin-sms
v0.1.1
Published
SMS plugin for @system-core — admin UI + backend module wiring an @maxnate/sms-core registry into a host application.
Maintainers
Readme
@maxnate/plugin-sms
Admin capability + plugin install for @maxnate/sms-core. Owns the
smsModule extension that other plugins consume via ctx.get('smsModule')
to send SMS notifications, OTP codes, marketing campaigns, etc.
npm install @maxnate/plugin-sms @maxnate/sms-coreWhat it provides
| Surface | Value |
|---|---|
| Extension key | smsModule |
| Admin pages | /admin/sms, /admin/sms/:provider |
| Admin API | /admin/sms/providers, /admin/sms/providers/:id, /admin/sms/providers/:id/test |
| Install order | 120 |
Install
import { smsPlugin } from '@maxnate/plugin-sms'
import { TwilioProvider, twilioSchema } from '@maxnate/sms-provider-twilio'
system.use(smsPlugin({
providers: [{ id: 'twilio', adapter: new TwilioProvider(), schema: twilioSchema }],
secretsCodec: mySecretsCodec
}))Peer dependencies
| Peer | Required | Notes |
|---|---|---|
| @maxnate/sms-core | yes (^0.1.0) | Registry, types |
| @system-core/core | optional (^0.12.0) | Required when used as a system-core plugin |
