@acms-subir/client 0.1.19 → 0.1.21

package/README.md

@@ -49,13 +49,16 @@ language. Update the site before shipping an app build with a newer client.
 | `calendars()` | Public calendars |
 | `resources(opts)`, `resource(slug, opts)` | Public resources; slug lookup scans list pages |
 | `availability(opts)` | Required `resource`, `link`; optional `from`, `days`, `minutes` |
+| `roomFree({ room, start, end })` | Free or busy for a room the site lets people check, with the busy times and no names; never cached (core 0.3.45+) |
 | `rsvpStatus(slug, { start })` | One event date's RSVP status: `open` or `reason` (`disabled`, `ended`, `closed` past the event's deadline, `cancelled`, `full`), `closesAt` (when RSVPs to the date close, or `null`: open until it ends), live `going`/`left` (held waitlist spots count as taken), `maxSeats` for one RSVP right now, `autoConfirm`, `waitlist` (`enabled`: a full date takes places in line; `waiting` people for `seats` seats; `maxSeats` for one place in line), and `form` (questions and `version`, or `null`). `start` is the occurrence's start exactly as `events()` returns it (a UTC ISO string such as `2026-10-05T14:00:00.000Z`). Never cached |
 | `book(opts)` | Resource booking or RSVP input (`RsvpInput` for an RSVP; `waitlist: true` joins a full date's waitlist, status `waitlisted`), optional `idempotencyKey`; sends the client's `locale` (or `opts.locale`) for its emails |
 | `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 +184,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, RoomFree } from './types.js';
 export { AcmsError, isAcmsError } from './errors.js';
 export type * from './types.js';
 export * from './editor.js';
@@ -60,6 +60,12 @@ export interface AvailabilityOptions extends RequestOptions {
 export interface RsvpStatusOptions extends RequestOptions {
     start: string;
 }
+/** A room's slug and a span: each bound a site-local day (its midnight) or an ISO date-time with a zone; at most 31 days. */
+export interface RoomFreeOptions extends RequestOptions {
+    room: string;
+    start: EventBound | (string & {});
+    end: EventBound | (string & {});
+}
 export type BookOptions = BookingInput & RequestOptions & {
     idempotencyKey?: string;
 };
@@ -145,6 +151,10 @@ export declare const endpoints: {
         readonly method: "GET";
         readonly path: "/availability";
     };
+    readonly roomFree: {
+        readonly method: "GET";
+        readonly path: "/rooms/free";
+    };
     readonly book: {
         readonly method: "POST";
         readonly path: "/bookings";
@@ -169,6 +179,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";
@@ -268,6 +286,11 @@ export interface AcmsClient {
      * RSVP with `book({ event, start, seats, name, email, answers, formVersion: form.version })`.
      */
     rsvpStatus(slug: string, o: RsvpStatusOptions): Promise<RsvpStatus>;
+    /**
+     * Whether a room is free over a span (`free`), and its taken times (`busy`), never what or who. Only rooms the site
+     * lets people check answer; others are a 404. Never cached; 30 checks a minute. Requires bookings and core 0.3.45.
+     */
+    roomFree(o: RoomFreeOptions): Promise<RoomFree>;
     /** A room booking or an RSVP. Sends the client's `locale` (or `o.locale`), so its emails and links speak it. */
     book(o: BookOptions): Promise<BookingResult>;
     openapi(o?: RequestOptions): Promise<OpenApiDocument>;
@@ -279,6 +302,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

@@ -11,10 +11,14 @@ export const endpoints = {
     // an event date's RSVP status: live seats and questions (never cached); RSVP with book()
     rsvpStatus: { method: 'GET', path: '/events/{slug}/rsvp' },
     resources: { method: 'GET', path: '/resources' }, availability: { method: 'GET', path: '/availability' },
+    // free or busy for a room people may request (no names; never cached)
+    roomFree: { method: 'GET', path: '/rooms/free' },
     book: { method: 'POST', path: '/bookings' }, openapi: { method: 'GET', path: '/openapi.json' },
     // 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)
@@ -117,7 +121,7 @@ export function createClient(options) {
         const timer = setTimeout(() => controller.abort(new AcmsError(0, 'timeout', 'Request timed out.', undefined, undefined, key)), timeoutMs);
         const signal = controller.signal;
         // availability, live status and RSVP seats are never served from the cache
-        const cacheable = endpoint.method === 'GET' && name !== 'availability' && name !== 'live' && name !== 'rsvpStatus' && !extra.headers && cache;
+        const cacheable = endpoint.method === 'GET' && name !== 'availability' && name !== 'live' && name !== 'rsvpStatus' && name !== 'roomFree' && !extra.headers && cache;
         // only replay what the server treats as repeatable: a lost reply to a code
         // exchange or a move must not run it twice
         const replayable = endpoint.method !== 'POST' || !!key || name === 'registerDevice';
@@ -291,6 +295,7 @@ export function createClient(options) {
         calendars: (o = {}) => request('calendars', o),
         availability: (o) => request('availability', o, { resource: o.resource, link: o.link, from: o.from, days: o.days, minutes: o.minutes }),
         rsvpStatus: (slug, o) => request('rsvpStatus', o, { start: o.start }, slug),
+        roomFree: (o) => request('roomFree', o, { room: o.room, start: o.start, end: o.end }),
         async book(o) {
             const { locale = options.locale, signal, idempotencyKey, ...body } = o;
             const key = idempotencyKey ?? defaultHeaders.get('Idempotency-Key') ?? uuid();
@@ -313,6 +318,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

@@ -181,6 +181,11 @@ export type Page = {
         };
     }>;
 };
+export type EventRoom = {
+    "slug": string;
+    "name": string;
+    "color": string | null;
+};
 export type Event = {
     "id": string;
     "slug": string;
@@ -254,6 +259,11 @@ export type Event = {
         "name": string;
         "color": string;
     }>;
+    "rooms": Array<{
+        "slug": string;
+        "name": string;
+        "color": string | null;
+    }>;
     "notify": {
         "changes": Array<string>;
     };
@@ -274,6 +284,11 @@ export type Events = {
         "end": string;
         "allDay": boolean;
         "cancelled": boolean;
+        "rooms": Array<{
+            "slug": string;
+            "name": string;
+            "color": string | null;
+        }>;
         "event": {
             "id": string;
             "slug": string;
@@ -347,6 +362,11 @@ export type Events = {
                 "name": string;
                 "color": string;
             }>;
+            "rooms": Array<{
+                "slug": string;
+                "name": string;
+                "color": string | null;
+            }>;
             "notify": {
                 "changes": Array<string>;
             };
@@ -361,6 +381,11 @@ export type EventDetail = {
         "end": string;
         "allDay": boolean;
         "cancelled": boolean;
+        "rooms": Array<{
+            "slug": string;
+            "name": string;
+            "color": string | null;
+        }>;
     }) | (null);
     "event": {
         "id": string;
@@ -435,6 +460,11 @@ export type EventDetail = {
             "name": string;
             "color": string;
         }>;
+        "rooms": Array<{
+            "slug": string;
+            "name": string;
+            "color": string | null;
+        }>;
         "notify": {
             "changes": Array<string>;
         };
@@ -502,6 +532,11 @@ export type SearchResults = {
             "end": string;
             "allDay": boolean;
             "cancelled": boolean;
+            "rooms": Array<{
+                "slug": string;
+                "name": string;
+                "color": string | null;
+            }>;
         }) | (null);
         "event": {
             "id": string;
@@ -576,6 +611,11 @@ export type SearchResults = {
                 "name": string;
                 "color": string;
             }>;
+            "rooms": Array<{
+                "slug": string;
+                "name": string;
+                "color": string | null;
+            }>;
             "notify": {
                 "changes": Array<string>;
             };
@@ -876,6 +916,19 @@ export type Resources = {
         }>;
     }>;
 };
+export type RoomFree = {
+    "room": {
+        "slug": string;
+        "name": string;
+    };
+    "start": string;
+    "end": string;
+    "free": boolean;
+    "busy": Array<{
+        "start": string;
+        "end": string;
+    }>;
+};
 export type Availability = {
     "timezone": string;
     "mode": "slots" | "day" | "range";
@@ -943,6 +996,9 @@ export type Device = {
     "channels": Array<string>;
     "registeredAt": string;
     "lastSeenAt": string;
+    "staff": ({
+        "name": string;
+    }) | (null);
 };
 export type DeviceRegistration = {
     "created": boolean;
@@ -954,12 +1010,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<{
@@ -1727,6 +1792,9 @@ export type EditorResource = {
     "notifyEmails": Array<string>;
     "visibility": "public" | "unlisted";
     "showOnCalendar": boolean;
+    "color": string;
+    "showOnEvents": boolean;
+    "requestable": boolean;
     "placeId": string;
     "order": number;
     "createdAt": string;
@@ -1861,6 +1929,9 @@ export type EditorResourceList = {
         "notifyEmails": Array<string>;
         "visibility": "public" | "unlisted";
         "showOnCalendar": boolean;
+        "color": string;
+        "showOnEvents": boolean;
+        "requestable": boolean;
         "placeId": string;
         "order": number;
         "createdAt": string;
@@ -2324,6 +2395,9 @@ export type EditorResourceInput = {
     "visibility"?: "public" | "unlisted";
     "showOnCalendar"?: boolean;
     "placeId"?: string;
+    "color"?: ("") | (string);
+    "showOnEvents"?: boolean;
+    "requestable"?: boolean;
     "busyFeeds"?: Array<string>;
     "notifyEmails"?: Array<string>;
 };
@@ -2378,6 +2452,9 @@ export type EditorResourcePatch = {
     "visibility"?: "public" | "unlisted";
     "showOnCalendar"?: boolean;
     "placeId"?: string;
+    "color"?: ("") | (string);
+    "showOnEvents"?: boolean;
+    "requestable"?: boolean;
     "busyFeeds"?: Array<string>;
     "notifyEmails"?: Array<string>;
 };

package/package.json

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