@rei-standard/amsg-client
v2.0.1
Published
ReiStandard Active Messaging browser client SDK
Downloads
566
Readme
@rei-standard/amsg-client
@rei-standard/amsg-client 是 ReiStandard 主动消息标准的浏览器端 SDK 包，负责加密请求、解密响应和 Push 订阅。
安装
npm install @rei-standard/amsg-client快速使用
import { ReiClient } from '@rei-standard/amsg-client';
const client = new ReiClient({
baseUrl: '/api/v1',
userId: '550e8400-e29b-41d4-a716-446655440000'
});
await client.init();
await navigator.serviceWorker.register('/service-worker.js');
const registration = await navigator.serviceWorker.ready;
const subscription = await client.subscribePush(
window.__VAPID_PUBLIC_KEY__,
registration
);
await client.scheduleMessage({
contactName: 'Rei',
messageType: 'fixed',
userMessage: '下班记得带伞～',
firstSendTime: new Date(Date.now() + 60 * 1000).toISOString(),
recurrenceType: 'none',
pushSubscription: subscription.toJSON()
});导出 API（Exports）
ReiClient
ReiClient 主要方法：
init()scheduleMessage(payload)updateMessage(uuid, updates)cancelMessage(uuid)listMessages(opts)subscribePush(vapidPublicKey, registration)
模块格式与类型（ESM/CJS/Types）
- ESM：
import { ReiClient } from '@rei-standard/amsg-client' - CJS：
const { ReiClient } = require('@rei-standard/amsg-client') - 类型：包内提供
types入口（dist/index.d.ts）
运行环境与要求
- 浏览器环境（需
fetch、crypto.subtle） - Push 订阅需可用 Service Worker 与 Push API
- 需要可用的
baseUrl（示例：/api/v1） userId必须是 UUID v4