@acms-subir/client 0.1.19 → 0.1.20

package/README.md

@@ -54,8 +54,10 @@ language. Update the site before shipping an app build with a newer client.
 | `openapi()` | Raw OpenAPI document |
 | `registerDevice({ token, platform, locale?, topics?, channels? })` | Register or refresh an Expo push token (call on every app start); `{ created, device }`. `channels`: Android channels the app created (e.g. `['urgent']`) |
 | `updateDevice(token, { topics?, locale?, channels? })` | Change a device's topics, language or channels |
-| `unregisterDevice(token)` | Opt out (idempotent) |
+| `unregisterDevice(token)` | Opt out (idempotent); also unlinks a staff test phone |
 | `pushTopics()` | Topics to offer as notification toggles, named in the client's language (built-in and the site's own, `kind: 'site'`) |
+| `linkStaffPhone(token, code)` | Staff only: link this registered device with the 6-digit code from the admin's Test phones, so it gets that person's test notifications; `{ linked, staff: { name } }`. A wrong, used or expired code is a 400, too many tries a 429; never retried |
+| `unlinkStaffPhone(token)` | Unlink it (idempotent); `{ linked: false, staff: null }` |
 | `links()` | The links page: profile, socials and visible blocks (`link`, `email`, `phone`, `contact`, `heading`, `text`, `spacer`, `live`, `embed`) |
 | `live()` | Live video: the current broadcast (`snapshot` or `null`), `serverNow` and the owner's `display` choices. Never cached; 404 while `site.features.live` is false |
 | `announcements({ kind?, pinned?, page?, limit? })`, `announcement(id)`, `paginate.announcements()` | Announcements up right now in the client's language, newest first (`pinned: true`: the banners, urgent first); 404 while `site.features.announcements` is false |
@@ -181,6 +183,18 @@ await client.updateDevice(token, { topics: ['events'] });
 await client.unregisterDevice(token);
 ```
 
+Staff can link their own phone for test notifications ("Send test to my
+phone" in the admin): the admin's Test phones panel shows a one-time 6-digit
+code (10 minutes, single use) that the app sends with this phone's token.
+`device.staff` (from `registerDevice` and `updateDevice`) and the link
+response name who it's linked to (their name only), or `null`. Test pushes
+carry `data.test: true`.
+
+```ts
+const { staff } = await client.linkStaffPhone(token, '123456');  // { name: 'Ana López' }; 400 for a wrong, used or expired code
+await client.unlinkStaffPhone(token);                             // turning notifications off unlinks it too
+```
+
 ## Live video
 
 `site.features.live` is true while the site's live video (Integrations → Live

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import type { Site, Theme, Page, Content, Post, ContentList, SearchResults, Links, Form, FormReceipt, FormResponseInput, ManagedBooking, RescheduleInput, ManageAvailabilityQuery, GuestCodeSent, GuestToken, GuestBookings, GuestBookingsQuery, GuestSignedOut, Events, Event, Calendars, Resources, Resource, Availability, BookingInput, BookingResult, RsvpStatus, Device, DeviceInput, DeviceUpdate, DeviceRegistration, DeviceRemoved, PushTopics, LiveStatus, Announcements, AnnouncementDetail, EventDetail } from './types.js';
+import type { Site, Theme, Page, Content, Post, ContentList, SearchResults, Links, Form, FormReceipt, FormResponseInput, ManagedBooking, RescheduleInput, ManageAvailabilityQuery, GuestCodeSent, GuestToken, GuestBookings, GuestBookingsQuery, GuestSignedOut, Events, Event, Calendars, Resources, Resource, Availability, BookingInput, BookingResult, RsvpStatus, Device, DeviceInput, DeviceUpdate, DeviceRegistration, DeviceRemoved, StaffLink, PushTopics, LiveStatus, Announcements, AnnouncementDetail, EventDetail } from './types.js';
 export { AcmsError, isAcmsError } from './errors.js';
 export type * from './types.js';
 export * from './editor.js';
@@ -169,6 +169,14 @@ export declare const endpoints: {
         readonly method: "GET";
         readonly path: "/push/topics";
     };
+    readonly linkStaffPhone: {
+        readonly method: "POST";
+        readonly path: "/devices/{token}/staff-link";
+    };
+    readonly unlinkStaffPhone: {
+        readonly method: "DELETE";
+        readonly path: "/devices/{token}/staff-link";
+    };
     readonly links: {
         readonly method: "GET";
         readonly path: "/links";
@@ -279,6 +287,14 @@ export interface AcmsClient {
     unregisterDevice(token: string, o?: RequestOptions): Promise<DeviceRemoved>;
     /** Topics the app can offer as notification toggles. */
     pushTopics(o?: RequestOptions): Promise<PushTopics>;
+    /**
+     * Staff only: link this registered device to the staff member whose one-time code (Admin → Test phones) it sends,
+     * so it gets their test notifications. `{ linked: true, staff: { name } }`. A wrong, used or expired code is a 400;
+     * too many tries a 429 (never retried). Sites without it (or with push off) answer 404.
+     */
+    linkStaffPhone(token: string, code: string, o?: RequestOptions): Promise<StaffLink>;
+    /** Unlink it (idempotent). Turning notifications off (`unregisterDevice`) unlinks it too. */
+    unlinkStaffPhone(token: string, o?: RequestOptions): Promise<StaffLink>;
     /** The links page: profile, socials and visible blocks. Requires `site.features.links`. */
     links(o?: RequestOptions): Promise<Links>;
     /**

package/dist/index.js

@@ -15,6 +15,8 @@ export const endpoints = {
     // push notifications (only when the site enables push; 404 otherwise)
     registerDevice: { method: 'POST', path: '/devices' }, updateDevice: { method: 'PUT', path: '/devices/{token}' },
     unregisterDevice: { method: 'DELETE', path: '/devices/{token}' }, pushTopics: { method: 'GET', path: '/push/topics' },
+    // a staff member's own test phone (a one-time code from the admin's Test phones)
+    linkStaffPhone: { method: 'POST', path: '/devices/{token}/staff-link' }, unlinkStaffPhone: { method: 'DELETE', path: '/devices/{token}/staff-link' },
     // links page and forms (owner switches in Admin → Mobile app)
     links: { method: 'GET', path: '/links' }, form: { method: 'GET', path: '/forms/{id}' }, submitForm: { method: 'POST', path: '/forms/{id}/responses' },
     // live video status (404 while the site's live video is off)
@@ -313,6 +315,8 @@ export function createClient(options) {
         updateDevice: (token, input, o = {}) => request('updateDevice', o, {}, token, input),
         unregisterDevice: (token, o = {}) => request('unregisterDevice', o, {}, token),
         pushTopics: (o = {}) => request('pushTopics', o),
+        linkStaffPhone: (token, code, o = {}) => request('linkStaffPhone', o, {}, token, { code }),
+        unlinkStaffPhone: (token, o = {}) => request('unlinkStaffPhone', o, {}, token),
         links: (o = {}) => request('links', o),
         live: (o = {}) => request('live', o),
         form: (id, o = {}) => request('form', o, {}, id),

package/dist/types.d.ts

@@ -943,6 +943,9 @@ export type Device = {
     "channels": Array<string>;
     "registeredAt": string;
     "lastSeenAt": string;
+    "staff": ({
+        "name": string;
+    }) | (null);
 };
 export type DeviceRegistration = {
     "created": boolean;
@@ -954,12 +957,21 @@ export type DeviceRegistration = {
         "channels": Array<string>;
         "registeredAt": string;
         "lastSeenAt": string;
+        "staff": ({
+            "name": string;
+        }) | (null);
     };
 };
 export type DeviceRemoved = {
     "token": string;
     "deleted": true;
 };
+export type StaffLink = {
+    "linked": boolean;
+    "staff": ({
+        "name": string;
+    }) | (null);
+};
 export type PushTopics = {
     "locale": string | null;
     "topics": Array<{

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@acms-subir/client",
-  "version": "0.1.19",
+  "version": "0.1.20",
   "description": "Typed, dependency-free client for the ACMS public mobile API.",
   "type": "module",
   "license": "MIT",