@acms-subir/client 0.1.13 → 0.1.15

package/README.md

@@ -45,14 +45,16 @@ 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` |
-| `book(opts)` | Resource booking or RSVP input, optional `idempotencyKey` |
+| `rsvpStatus(slug, { start })` | One event date's RSVP status: `open` or `reason` (`disabled`, `ended`, `cancelled`, `full`), live `going`/`left`, `maxSeats` for one RSVP right now, `autoConfirm`, 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), optional `idempotencyKey` |
 | `openapi()` | Raw OpenAPI document |
-| `registerDevice({ token, platform, locale?, topics? })` | Register or refresh an Expo push token (call on every app start); `{ created, device }` |
-| `updateDevice(token, { topics?, locale? })` | Change a device's topics or language |
+| `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) |
 | `pushTopics()` | Topics to offer as notification toggles, named in the client's language (built-in and the site's own, `kind: 'site'`) |
 | `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 |
 | `form(id)`, `submitForm(id, { answers, version?, idempotencyKey? })` | A published form's questions; send answers (checkbox groups as arrays). Each call makes one key; retries reuse it |
 | `manageBooking(token)`, `cancelBooking(token)` | The booker's own booking from its `manageToken`, and cancelling it; `can` says what is allowed |
 | `rescheduleAvailability(token, { from?, days?, minutes? })`, `rescheduleBooking(token, { start, minutes? })` | Open times for moving it (its own time counts as free), then the move |
@@ -86,6 +88,8 @@ server results or provide snapshot consistency; deduplicate IDs in your app.
 ## Bookings, errors and cancellation
 
 ```ts
+import type { RsvpInput } from '@acms-subir/client';
+
 // Persist a UUID v4 with this booking intent before submitting; reuse it until
 // the outcome is known. Use your platform's secure UUID/storage facilities.
 const idempotencyKey = crypto.randomUUID();
@@ -102,6 +106,25 @@ try {
   }
 }
 
+// RSVP to one date of an event (needs only the calendar: site.features.rsvp)
+const { occurrences } = await client.events({ q: 'supper' });
+const date = occurrences[0];
+const status = await client.rsvpStatus(date.event.slug, { start: date.start });
+if (status.open) {
+  const rsvp: RsvpInput = {
+    event: date.event.slug, start: date.start, seats: 2, name: 'Example Guest', email: 'guest@example.com',
+    // field id → answer; checkbox groups send a list
+    answers: { meal: 'Vegetarian', help: ['Setup', 'Music'] },
+    // required when the event asks questions: a changed form answers 409, so read the status again
+    ...(status.form ? { formVersion: status.form.version } : {}),
+  };
+  const result = await client.book({ ...rsvp, idempotencyKey: crypto.randomUUID() });
+  // pending when the organiser approves RSVPs; status.form?.confirmation is the thank-you text.
+  // result.manageToken changes or cancels it later (manageBooking, cancelBooking), like the email's link:
+  // keep it in secure storage only.
+  console.log(result.booking.status);
+}
+
 const controller = new AbortController();
 const pending = client.home({ signal: controller.signal });
 controller.abort();
@@ -171,7 +194,7 @@ if (current?.status === 'live') console.log(`Live: ${current.title} → ${curren
 ETag revalidation defaults to an in-memory URL-keyed cache. Each read contacts
 the server with `If-None-Match`; a 304 reuses the saved data. This is not an
 offline fallback. Treat returned cached objects as immutable. Use `cache: false`
-to disable it. Availability, live status, booking results and errors are never cached.
+to disable it. Availability, live status, RSVP status, booking results and errors are never cached.
 Responses without an ETag or with `no-store` invalidate an older entry.
 
 ```ts

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, Device, DeviceInput, DeviceUpdate, DeviceRegistration, DeviceRemoved, PushTopics, LiveStatus } 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, PushTopics, LiveStatus, Announcements, AnnouncementDetail } from './types.js';
 export { AcmsError, isAcmsError } from './errors.js';
 export type * from './types.js';
 export * from './editor.js';
@@ -44,6 +44,11 @@ export interface SearchOptions extends RequestOptions {
     /** Matches per group, 1–20; default 5. */
     limit?: number;
 }
+export interface AnnouncementOptions extends ListOptions {
+    kind?: 'event' | 'registration' | 'help' | 'info' | 'urgent';
+    /** Only the banners (pinned), urgent first. */
+    pinned?: boolean;
+}
 export interface AvailabilityOptions extends RequestOptions {
     resource: string;
     link: string;
@@ -51,6 +56,10 @@ export interface AvailabilityOptions extends RequestOptions {
     days?: number;
     minutes?: number;
 }
+/** `start`: the occurrence's start exactly as `events()` returns it, a UTC ISO string such as `'2026-10-05T14:00:00.000Z'`. */
+export interface RsvpStatusOptions extends RequestOptions {
+    start: string;
+}
 export type BookOptions = BookingInput & RequestOptions & {
     idempotencyKey?: string;
 };
@@ -120,6 +129,10 @@ export declare const endpoints: {
         readonly method: "GET";
         readonly path: "/calendars";
     };
+    readonly rsvpStatus: {
+        readonly method: "GET";
+        readonly path: "/events/{slug}/rsvp";
+    };
     readonly resources: {
         readonly method: "GET";
         readonly path: "/resources";
@@ -168,6 +181,14 @@ export declare const endpoints: {
         readonly method: "GET";
         readonly path: "/live";
     };
+    readonly announcements: {
+        readonly method: "GET";
+        readonly path: "/announcements";
+    };
+    readonly announcement: {
+        readonly method: "GET";
+        readonly path: "/announcements/{id}";
+    };
     readonly manageBooking: {
         readonly method: "GET";
         readonly path: "/bookings/manage";
@@ -228,6 +249,12 @@ export interface AcmsClient {
     resources(o?: ListOptions): Promise<Resources>;
     resource(slug: string, o?: RequestOptions): Promise<Resource>;
     availability(o: AvailabilityOptions): Promise<Availability>;
+    /**
+     * One date's RSVP status: `open` (or `reason`: disabled, ended, cancelled, full), live `going`/`left`,
+     * `maxSeats` for one RSVP right now, and `form` (questions and `version`, or null). Never cached.
+     * RSVP with `book({ event, start, seats, name, email, answers, formVersion: form.version })`.
+     */
+    rsvpStatus(slug: string, o: RsvpStatusOptions): Promise<RsvpStatus>;
     book(o: BookOptions): Promise<BookingResult>;
     openapi(o?: RequestOptions): Promise<OpenApiDocument>;
     /** Register or refresh this device's Expo push token. Call on every app start. Requires push on the site. */
@@ -246,6 +273,10 @@ export interface AcmsClient {
      * clock, even if later requests fail. Requires `site.features.live`.
      */
     live(o?: RequestOptions): Promise<LiveStatus>;
+    /** Announcements up right now, newest first (`pinned: true`: only the banners, urgent first). Requires `site.features.announcements`. */
+    announcements(o?: AnnouncementOptions): Promise<Announcements>;
+    /** One announcement that is up; 404 once it came down. */
+    announcement(id: string, o?: RequestOptions): Promise<AnnouncementDetail>;
     /** A published form's questions. 410 when it stopped accepting responses. Requires `site.features.forms`. */
     form(id: string, o?: RequestOptions): Promise<Form>;
     /** Send answers (checkbox groups as arrays). Retries reuse the same Idempotency-Key, so they never duplicate. */
@@ -278,5 +309,6 @@ export interface AcmsClient {
         pages(o?: ListOptions): AsyncGenerator<ContentList['items'][number]>;
         events(o?: EventOptions): AsyncGenerator<Events['occurrences'][number]>;
         resources(o?: ListOptions): AsyncGenerator<Resource>;
+        announcements(o?: AnnouncementOptions): AsyncGenerator<Announcements['announcements'][number]>;
     };
 }

package/dist/index.js

@@ -8,6 +8,8 @@ export const endpoints = {
     content: { method: 'GET', path: '/content' }, contentById: { method: 'GET', path: '/content/{id}' },
     search: { method: 'GET', path: '/search' },
     events: { method: 'GET', path: '/events' }, calendars: { method: 'GET', path: '/calendars' },
+    // 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' },
     book: { method: 'POST', path: '/bookings' }, openapi: { method: 'GET', path: '/openapi.json' },
     // push notifications (only when the site enables push; 404 otherwise)
@@ -17,6 +19,8 @@ export const endpoints = {
     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)
     live: { method: 'GET', path: '/live' },
+    // announcements (404 unless the site turns them on)
+    announcements: { method: 'GET', path: '/announcements' }, announcement: { method: 'GET', path: '/announcements/{id}' },
     // the booker's own booking: its private token goes in the Booking-Token header
     manageBooking: { method: 'GET', path: '/bookings/manage' }, cancelBooking: { method: 'POST', path: '/bookings/manage/cancel' },
     rescheduleAvailability: { method: 'GET', path: '/bookings/manage/availability' }, rescheduleBooking: { method: 'POST', path: '/bookings/manage/reschedule' },
@@ -26,7 +30,7 @@ export const endpoints = {
     guestBookings: { method: 'GET', path: '/guest/bookings' }, guestSignOut: { method: 'POST', path: '/guest/revoke' },
 };
 // site: its legal links; pushTopics: topic names
-const localized = new Set(['home', 'page', 'content', 'contentById', 'search', 'events', 'site', 'pushTopics']);
+const localized = new Set(['home', 'page', 'content', 'contentById', 'search', 'events', 'rsvpStatus', 'site', 'pushTopics', 'announcements', 'announcement']);
 // localized since core 0.3.32; older sites answer ?locale= with a 400, so ask them again without it
 const lateLocalized = new Set(['site', 'pushTopics']);
 function uuid() {
@@ -110,8 +114,8 @@ export function createClient(options) {
             opts.signal?.addEventListener('abort', abort, { once: true });
         const timer = setTimeout(() => controller.abort(new AcmsError(0, 'timeout', 'Request timed out.', undefined, undefined, key)), timeoutMs);
         const signal = controller.signal;
-        // availability and live status are never served from the cache
-        const cacheable = endpoint.method === 'GET' && name !== 'availability' && name !== 'live' && !extra.headers && cache;
+        // 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;
         // 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';
@@ -230,19 +234,22 @@ export function createClient(options) {
     const pages = (o = {}) => content({ ...o, kind: 'page' });
     const events = (o = {}) => request('events', o, { ...paging(o), from: o.from, to: o.to, calendar: o.calendar, tag: o.tag, excludeTag: o.excludeTag, q: o.q });
     const resources = (o = {}) => request('resources', o, paging(o));
+    const announcements = (o = {}) => request('announcements', o, { ...paging(o), kind: o.kind, pinned: o.pinned ? 'true' : undefined });
     const paginate = {
         content: (o = {}) => iterate(content, 'items', o),
         posts: (o = {}) => iterate(posts, 'items', o),
         pages: (o = {}) => iterate(pages, 'items', o),
         events: (o = {}) => iterate(events, 'occurrences', o),
         resources: (o = {}) => iterate(resources, 'resources', o),
+        announcements: (o = {}) => iterate(announcements, 'announcements', o),
     };
     return {
         site: (o = {}) => request('site', o),
         theme: (o = {}) => request('theme', o),
         home: (o = {}) => request('home', o),
         page: (slug, o = {}) => request('page', o, {}, slug),
-        content, posts, pages, events, resources, paginate,
+        content, posts, pages, events, resources, announcements, paginate,
+        announcement: (id, o = {}) => request('announcement', o, {}, id),
         async search(q, o = {}) {
             const query = q.trim();
             // blank input (an emptied search box) needs no round trip
@@ -272,6 +279,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),
         book: (o) => {
             const { locale, signal, idempotencyKey, ...body } = o;
             const key = idempotencyKey ?? defaultHeaders.get('Idempotency-Key') ?? uuid();

package/dist/types.d.ts

@@ -29,12 +29,14 @@ export type Site = {
         }>;
         "calendar": boolean;
         "bookings": boolean;
+        "rsvp": boolean;
         "search": boolean;
         "bookingChanges": boolean;
         "guestSignIn": boolean;
         "forms": boolean;
         "links": boolean;
         "live": boolean;
+        "announcements": boolean;
     };
     "legal": {
         "privacy": string | null;
@@ -590,6 +592,40 @@ export type FormReceipt = {
     "received": true;
     "confirmation": string;
 };
+export type RsvpStatus = {
+    "event": {
+        "id": string;
+        "slug": string;
+        "title": string;
+    };
+    "start": string;
+    "end": string;
+    "open": boolean;
+    "reason": ("disabled" | "ended" | "cancelled" | "full") | (null);
+    "going": number;
+    "left": (number) | (null);
+    "capacity": number;
+    "maxSeats": number;
+    "autoConfirm": boolean;
+    "form": ({
+        "version": string;
+        "title": string;
+        "intro": string;
+        "submitLabel": string;
+        "confirmation": string;
+        "fields": Array<{
+            "id": string;
+            "type": "text" | "textarea" | "email" | "phone" | "number" | "select" | "checkbox" | "date" | "radio" | "checkboxes" | "url" | "consent" | "heading";
+            "label": string;
+            "required": boolean;
+            "help": string;
+            "options": Array<string>;
+            "placeholder": string;
+            "width": "full" | "half";
+            "allowOther": boolean;
+        }>;
+    }) | (null);
+};
 export type ManagedBooking = {
     "booking": {
         "id": string;
@@ -633,6 +669,7 @@ export type ManagedBooking = {
         "cutoffHours": number;
         "closed": boolean;
     };
+    "confirmation": string | null;
 };
 export type GuestCodeSent = {
     "sent": true;
@@ -773,7 +810,7 @@ export type BookingResult = {
                 [key: string]: string;
             };
         };
-        "source": "web" | "admin" | "api" | "agent";
+        "source": "web" | "app" | "admin" | "api" | "agent";
         "start": string;
         "end": string;
         "resourceId": string | null;
@@ -787,6 +824,7 @@ export type Device = {
     "platform": "ios" | "android";
     "locale": string | null;
     "topics": Array<string>;
+    "channels": Array<string>;
     "registeredAt": string;
     "lastSeenAt": string;
 };
@@ -797,6 +835,7 @@ export type DeviceRegistration = {
         "platform": "ios" | "android";
         "locale": string | null;
         "topics": Array<string>;
+        "channels": Array<string>;
         "registeredAt": string;
         "lastSeenAt": string;
     };
@@ -814,6 +853,69 @@ export type PushTopics = {
         "description"?: string;
     }>;
 };
+export type Announcement = {
+    "id": string;
+    "kind": "event" | "registration" | "help" | "info" | "urgent";
+    "kindLabel": string;
+    "title": string;
+    "message": string;
+    "details": string;
+    "button": ({
+        "label": string;
+        "url": string;
+    }) | (null);
+    "url": string | null;
+    "pinned": boolean;
+    "urgent": boolean;
+    "publishedAt": string;
+    "showUntil": (string) | (null);
+    "translated": boolean;
+};
+export type Announcements = {
+    "locale": string | null;
+    "announcements": Array<{
+        "id": string;
+        "kind": "event" | "registration" | "help" | "info" | "urgent";
+        "kindLabel": string;
+        "title": string;
+        "message": string;
+        "details": string;
+        "button": ({
+            "label": string;
+            "url": string;
+        }) | (null);
+        "url": string | null;
+        "pinned": boolean;
+        "urgent": boolean;
+        "publishedAt": string;
+        "showUntil": (string) | (null);
+        "translated": boolean;
+    }>;
+    "pagination": {
+        "page": number;
+        "limit": number;
+        "nextPage": (number) | (null);
+    };
+};
+export type AnnouncementDetail = {
+    "id": string;
+    "kind": "event" | "registration" | "help" | "info" | "urgent";
+    "kindLabel": string;
+    "title": string;
+    "message": string;
+    "details": string;
+    "button": ({
+        "label": string;
+        "url": string;
+    }) | (null);
+    "url": string | null;
+    "pinned": boolean;
+    "urgent": boolean;
+    "publishedAt": string;
+    "showUntil": (string) | (null);
+    "translated": boolean;
+    "locale": string | null;
+};
 export type LiveSnapshot = {
     "status": "live" | "upcoming" | "offline" | "unknown";
     "source": "automatic" | "manual";
@@ -1266,7 +1368,7 @@ export type EditorBooking = {
             [key: string]: string;
         };
     };
-    "source": "web" | "admin" | "api" | "agent";
+    "source": "web" | "app" | "admin" | "api" | "agent";
     "notes": string;
     "start": string;
     "end": string;
@@ -1313,7 +1415,7 @@ export type EditorBookingList = {
                 [key: string]: string;
             };
         };
-        "source": "web" | "admin" | "api" | "agent";
+        "source": "web" | "app" | "admin" | "api" | "agent";
         "notes": string;
         "start": string;
         "end": string;
@@ -1858,22 +1960,22 @@ export type BookingInput = ({
     "name": string;
     "email": string;
     "phone"?: string;
+    "answers"?: {
+        [key: string]: (string) | (Array<string>);
+    };
     "resource": string;
     "link": string;
     "minutes"?: number;
-    "answers"?: {
-        [key: string]: string;
-    };
 }) | ({
     "start": string;
     "name": string;
     "email": string;
     "phone"?: string;
-    "event": string;
-    "seats"?: number;
     "answers"?: {
-        [key: string]: string;
+        [key: string]: (string) | (Array<string>);
     };
+    "event": string;
+    "seats"?: number;
     "formVersion"?: string;
 });
 export type DeviceInput = {
@@ -1881,10 +1983,12 @@ export type DeviceInput = {
     "platform": "ios" | "android";
     "locale"?: string;
     "topics"?: Array<string>;
+    "channels"?: Array<string>;
 };
 export type DeviceUpdate = {
     "locale"?: string;
     "topics"?: Array<string>;
+    "channels"?: Array<string>;
 };
 export type EditorCreateInput = ({
     "kind": "post";
@@ -2361,4 +2465,8 @@ export type SearchEventHit = SearchResults["events"][number];
 export type LinkItem = Links["items"][number];
 export type FormField = Form["fields"][number];
 export type GuestBooking = GuestBookings["items"][number];
+export type RsvpInput = Extract<BookingInput, {
+    "event": string;
+}>;
+export type RsvpForm = NonNullable<RsvpStatus["form"]>;
 export type LiveDisplay = LiveStatus["display"];

package/package.json

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