@acms-subir/client 0.1.17 → 0.1.19

package/README.md

@@ -44,12 +44,13 @@ language. Update the site before shipping an app build with a newer client.
 | `pages(opts)` | Page **summaries**, with pagination; use `page()` for sections |
 | `search(text, opts)` | Top matches in `posts`, `pages` and `events`, plus `more` per group; `types`, `collection`, `limit` (1–20, default 5). Blank text resolves empty without a request |
 | `events(opts)` | Occurrences with `from`, `to`, `calendar`, `tag`, `excludeTag`, `q`, pagination |
-| `event(slug, opts)` | First matching event from occurrences in the requested window |
+| `event(slug, opts)` | One event by slug, whatever its date (`GET /events/{slug}`; on sites older than core 0.3.40, the first match in the requested window) |
+| `eventDetail(slug, { on? })` | The event and its next occurrence, or the one on `on` (`YYYY-MM-DD`) |
 | `calendars()` | Public calendars |
 | `resources(opts)`, `resource(slug, opts)` | Public resources; slug lookup scans list pages |
 | `availability(opts)` | Required `resource`, `link`; optional `from`, `days`, `minutes` |
-| `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`, `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`; sends the client's `locale` (or `opts.locale`) for its emails |
+| `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 |
@@ -59,7 +60,8 @@ language. Update the site before shipping an app build with a newer client.
 | `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 |
+| `manageBooking(token)`, `cancelBooking(token)` | The booker's own booking from its `manageToken`, and cancelling it (or leaving a waitlist, or releasing a held spot); `can` says what is allowed. A waitlisted RSVP has `booking.position` (its place in line), an offered one `booking.holdUntil` |
+| `confirmBooking(token)` | Take a spot the waitlist offered (`can.confirm`): `confirmed`, or `pending` when RSVPs need approval. 410 once `holdUntil` passed. Core 0.3.40 or later |
 | `rescheduleAvailability(token, { from?, days?, minutes? })`, `rescheduleBooking(token, { start, minutes? })` | Open times for moving it (its own time counts as free), then the move |
 | `bookingIcs(token)` | The booking as an iCalendar file (string) |
 | `requestGuestCode(email)`, `guestSignIn({ email, code, deviceName? })`, `guestBookings(guestToken, { when? })`, `guestSignOut(guestToken)` | Guest sign-in for "My bookings" |
@@ -127,6 +129,14 @@ if (status.open) {
   // 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);
+} else if (status.reason === 'full' && status.waitlist.enabled) {
+  // a place in line (status 'waitlisted', no seats); when a spot opens the site emails them and holds it
+  // for 24 hours: then manageBooking shows status 'offered' and holdUntil, and confirmBooking(token) takes it
+  const result = await client.book({
+    event: date.event.slug, start: date.start, seats: 2, name: 'Example Guest', email: 'guest@example.com', waitlist: true,
+    ...(status.form ? { formVersion: status.form.version } : {}), idempotencyKey: crypto.randomUUID(),
+  });
+  console.log(result.booking.status);
 }
 
 const controller = new AbortController();
@@ -141,7 +151,7 @@ failures, 5xx and 429 responses at most twice (three attempts total), with
 250/500ms backoff and at least the server's `Retry-After` delay (seconds or HTTP
 date). A wait that would outlast `timeoutMs` throws the 429 straight away, with
 `retryAfter`. One-shot writes (guest code requests and sign-in, cancelling and
-moving a booking, guest sign-out) are never repeated automatically: on a
+moving a booking, confirming a held spot, guest sign-out) are never repeated automatically: on a
 network error, check the state before trying again. Booking retries always
 reuse the same serialized body and UUID. By default each `book()` call creates
 a key using `crypto.randomUUID`, falling back to a Math.random UUID v4 where

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 } 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, EventDetail } from './types.js';
 export { AcmsError, isAcmsError } from './errors.js';
 export type * from './types.js';
 export * from './editor.js';
@@ -125,6 +125,10 @@ export declare const endpoints: {
         readonly method: "GET";
         readonly path: "/events";
     };
+    readonly eventDetail: {
+        readonly method: "GET";
+        readonly path: "/events/{slug}";
+    };
     readonly calendars: {
         readonly method: "GET";
         readonly path: "/calendars";
@@ -197,6 +201,10 @@ export declare const endpoints: {
         readonly method: "POST";
         readonly path: "/bookings/manage/cancel";
     };
+    readonly confirmBooking: {
+        readonly method: "POST";
+        readonly path: "/bookings/manage/confirm";
+    };
     readonly rescheduleAvailability: {
         readonly method: "GET";
         readonly path: "/bookings/manage/availability";
@@ -244,7 +252,12 @@ export interface AcmsClient {
     /** Ranked matches across posts, pages and events, the top few per group. Requires `site.features.search`. */
     search(q: string, o?: SearchOptions): Promise<SearchResults>;
     events(o?: EventOptions): Promise<Events>;
+    /** One event by slug, whatever its date (older sites: searched in the window). */
     event(slug: string, o?: EventOptions): Promise<Event>;
+    /** One event by slug or id with its next occurrence, or the one on `on` (YYYY-MM-DD, like the website's ?on=). */
+    eventDetail(slug: string, o?: RequestOptions & {
+        on?: string;
+    }): Promise<EventDetail>;
     calendars(o?: RequestOptions): Promise<Calendars>;
     resources(o?: ListOptions): Promise<Resources>;
     resource(slug: string, o?: RequestOptions): Promise<Resource>;
@@ -286,7 +299,13 @@ export interface AcmsClient {
     }, o?: RequestOptions): Promise<FormReceipt>;
     /** The booker's own booking, from its private token (`manageToken`). Never cached. Requires `site.features.bookingChanges`. */
     manageBooking(token: string, o?: RequestOptions): Promise<ManagedBooking>;
+    /** Cancel it; for an RSVP on a waitlist, leave the line or release a held spot. */
     cancelBooking(token: string, o?: RequestOptions): Promise<ManagedBooking>;
+    /**
+     * Take a spot an RSVP's waitlist offered (`booking.status` `offered`, `can.confirm`): confirmed, or
+     * pending when the event approves RSVPs. A spot past its `holdUntil` was released (410). Requires core 0.3.40.
+     */
+    confirmBooking(token: string, o?: RequestOptions): Promise<ManagedBooking>;
     /** Open times for moving the booking (its own time counts as free). */
     rescheduleAvailability(token: string, q?: ManageAvailabilityQuery, o?: RequestOptions): Promise<Availability>;
     rescheduleBooking(token: string, input: RescheduleInput, o?: RequestOptions): Promise<ManagedBooking>;

package/dist/index.js

@@ -7,7 +7,7 @@ export const endpoints = {
     home: { method: 'GET', path: '/pages/home' }, page: { method: 'GET', path: '/pages/{slug}' },
     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' },
+    events: { method: 'GET', path: '/events' }, eventDetail: { method: 'GET', path: '/events/{slug}' }, 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' },
@@ -23,6 +23,8 @@ export const endpoints = {
     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' },
+    // take a spot an RSVP's waitlist offered
+    confirmBooking: { method: 'POST', path: '/bookings/manage/confirm' },
     rescheduleAvailability: { method: 'GET', path: '/bookings/manage/availability' }, rescheduleBooking: { method: 'POST', path: '/bookings/manage/reschedule' },
     bookingIcs: { method: 'GET', path: '/bookings/manage/ics' },
     // guest sign-in for "My bookings" (emailed code → guest token)
@@ -30,7 +32,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', 'rsvpStatus', 'site', 'pushTopics', 'announcements', 'announcement']);
+const localized = new Set(['home', 'page', 'content', 'contentById', 'search', 'events', 'rsvpStatus', 'site', 'pushTopics', 'announcements', 'announcement', 'eventDetail']);
 // 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() {
@@ -264,8 +266,17 @@ export function createClient(options) {
                     return request('contentById', o, { kind: 'post' }, item.id);
             throw new AcmsError(404, 'not_found', 'Post not found.');
         },
-        /** Searches occurrences in the supplied window (server default: next 30 UTC days). */
+        eventDetail: (slug, o = {}) => request('eventDetail', o, { on: o.on }, slug),
+        /** One event by slug, whatever its date. Sites older than core 0.3.40 have no such route: then it searches occurrences in the window (default: next 30 days). */
         async event(slug, o = {}) {
+            try {
+                return (await request('eventDetail', o, {}, slug)).event;
+            }
+            catch (e) {
+                // a real "not found" comes as JSON with code not_found; an older site answers its HTML 404 page
+                if (!(e instanceof AcmsError) || e.status !== 404 || e.code === 'not_found')
+                    throw e;
+            }
             for await (const item of paginate.events(o))
                 if (item.event.slug === slug)
                     return item.event;
@@ -311,6 +322,7 @@ export function createClient(options) {
         },
         manageBooking: (token, o = {}) => request('manageBooking', o, {}, undefined, undefined, undefined, bookingAuth(token)),
         cancelBooking: (token, o = {}) => request('cancelBooking', o, {}, undefined, undefined, undefined, bookingAuth(token)),
+        confirmBooking: (token, o = {}) => request('confirmBooking', o, {}, undefined, undefined, undefined, bookingAuth(token)),
         rescheduleAvailability: (token, q = {}, o = {}) => request('rescheduleAvailability', o, { from: q.from, days: q.days, minutes: q.minutes }, undefined, undefined, undefined, bookingAuth(token)),
         rescheduleBooking: (token, input, o = {}) => request('rescheduleBooking', o, {}, undefined, input, undefined, bookingAuth(token)),
         bookingIcs: (token, o = {}) => request('bookingIcs', o, {}, undefined, undefined, undefined, { ...bookingAuth(token), text: true }),

package/dist/types.d.ts

@@ -223,6 +223,7 @@ export type Event = {
         "maxSeats": number;
         "closesAt": string | null;
         "closeBefore": number;
+        "waitlist": boolean;
         "form"?: {
             "title": string;
             "intro": string;
@@ -315,6 +316,7 @@ export type Events = {
                 "maxSeats": number;
                 "closesAt": string | null;
                 "closeBefore": number;
+                "waitlist": boolean;
                 "form"?: {
                     "title": string;
                     "intro": string;
@@ -351,6 +353,93 @@ export type Events = {
         };
     }>;
 };
+export type EventDetail = {
+    "locale": string | null;
+    "occurrence": ({
+        "id": string;
+        "start": string;
+        "end": string;
+        "allDay": boolean;
+        "cancelled": boolean;
+    }) | (null);
+    "event": {
+        "id": string;
+        "slug": string;
+        "title": string;
+        "excerpt": string;
+        "status": "draft" | "scheduled" | "published" | "archived";
+        "cancelled": boolean;
+        "featured": boolean;
+        "start": string;
+        "end": string;
+        "allDay": boolean;
+        "timezone": string;
+        "rrule": string;
+        "exdates": Array<string>;
+        "cancelledDates": Array<string>;
+        "location": {
+            "name": string;
+            "address": string;
+            "url": string;
+            "lat": number | null;
+            "lng": number | null;
+            "placeId": string;
+            "showMap": boolean;
+            "mapImage": string;
+            "mapImageDark": string;
+        };
+        "cta": {
+            "label": string;
+            "href": string;
+            "style": "primary" | "outline";
+        };
+        "tags": Array<string>;
+        "fields": {
+            [key: string]: string;
+        };
+        "rsvp": {
+            "enabled": boolean;
+            "capacity": number;
+            "autoConfirm": boolean;
+            "maxSeats": number;
+            "closesAt": string | null;
+            "closeBefore": number;
+            "waitlist": boolean;
+            "form"?: {
+                "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;
+                }>;
+            };
+        };
+        "url": string;
+        "icsUrl": string;
+        "repeats": string;
+        "image": string;
+        "imageAlt": string;
+        "updatedAt": string;
+        "calendars": Array<{
+            "id": string;
+            "slug": string;
+            "name": string;
+            "color": string;
+        }>;
+        "notify": {
+            "changes": Array<string>;
+        };
+    };
+};
 export type SearchResults = {
     "locale": string | null;
     "query": string;
@@ -456,6 +545,7 @@ export type SearchResults = {
                 "maxSeats": number;
                 "closesAt": string | null;
                 "closeBefore": number;
+                "waitlist": boolean;
                 "form"?: {
                     "title": string;
                     "intro": string;
@@ -623,6 +713,12 @@ export type RsvpStatus = {
     "maxSeats": number;
     "autoConfirm": boolean;
     "closesAt": (string) | (null);
+    "waitlist": {
+        "enabled": boolean;
+        "waiting": number;
+        "seats": number;
+        "maxSeats": number;
+    };
     "form": ({
         "version": string;
         "title": string;
@@ -647,7 +743,7 @@ export type ManagedBooking = {
         "id": string;
         "reference": string;
         "kind": "booking" | "rsvp";
-        "status": "pending" | "confirmed" | "declined" | "cancelled";
+        "status": "pending" | "confirmed" | "declined" | "cancelled" | "waitlisted" | "offered" | "expired";
         "start": string;
         "end": string;
         "allDay": boolean;
@@ -660,6 +756,8 @@ export type ManagedBooking = {
             [key: string]: string;
         };
         "createdAt": string;
+        "position": (number) | (null);
+        "holdUntil": (string) | (null);
     };
     "title": string;
     "location": string;
@@ -682,6 +780,7 @@ export type ManagedBooking = {
     "can": {
         "cancel": boolean;
         "reschedule": boolean;
+        "confirm": boolean;
         "cutoffHours": number;
         "closed": boolean;
     };
@@ -708,7 +807,7 @@ export type GuestBookings = {
         "id": string;
         "reference": string;
         "kind": "booking" | "rsvp";
-        "status": "pending" | "confirmed" | "declined" | "cancelled";
+        "status": "pending" | "confirmed" | "declined" | "cancelled" | "waitlisted" | "offered" | "expired";
         "start": string;
         "end": string;
         "seats": number;
@@ -718,6 +817,7 @@ export type GuestBookings = {
         "can": {
             "cancel": boolean;
             "reschedule": boolean;
+            "confirm": boolean;
             "cutoffHours": number;
             "closed": boolean;
         };
@@ -795,7 +895,7 @@ export type BookingResult = {
     "booking": {
         "id": string;
         "kind": "booking" | "block" | "rsvp";
-        "status": "pending" | "confirmed" | "declined" | "cancelled";
+        "status": "pending" | "confirmed" | "declined" | "cancelled" | "waitlisted" | "offered" | "expired";
         "name": string;
         "email": string;
         "phone": string;
@@ -1162,6 +1262,8 @@ export type EditorDocument = {
             "maxSeats": number;
             "closesAt": string | null;
             "closeBefore": number;
+            "notifyStaff": boolean;
+            "waitlist": boolean;
             "form"?: {
                 "title": string;
                 "intro": string;
@@ -1355,7 +1457,7 @@ export type EditorMediaList = {
 export type EditorBooking = {
     "id": string;
     "kind": "booking" | "block" | "rsvp";
-    "status": "pending" | "confirmed" | "declined" | "cancelled";
+    "status": "pending" | "confirmed" | "declined" | "cancelled" | "waitlisted" | "offered" | "expired";
     "name": string;
     "email": string;
     "phone": string;
@@ -1402,7 +1504,7 @@ export type EditorBookingList = {
     "items": Array<{
         "id": string;
         "kind": "booking" | "block" | "rsvp";
-        "status": "pending" | "confirmed" | "declined" | "cancelled";
+        "status": "pending" | "confirmed" | "declined" | "cancelled" | "waitlisted" | "offered" | "expired";
         "name": string;
         "email": string;
         "phone": string;
@@ -1997,6 +2099,7 @@ export type BookingInput = ({
     "event": string;
     "seats"?: number;
     "formVersion"?: string;
+    "waitlist"?: boolean;
 });
 export type DeviceInput = {
     "token": string;
@@ -2094,6 +2197,8 @@ export type EditorSaveInput = {
             "maxSeats": number;
             "closesAt"?: (string) | (null);
             "closeBefore"?: number;
+            "notifyStaff"?: boolean;
+            "waitlist"?: boolean;
             "form"?: {
                 "title"?: string;
                 "intro"?: string;
@@ -2133,7 +2238,7 @@ export type EditorMediaQuery = {
     "limit"?: number;
 };
 export type EditorBookingsQuery = {
-    "status"?: "active" | "pending" | "confirmed" | "declined" | "cancelled" | "all";
+    "status"?: "active" | "pending" | "confirmed" | "waitlist" | "waitlisted" | "offered" | "expired" | "declined" | "cancelled" | "all";
     "from"?: (undefined) | (string);
     "page"?: number;
     "limit"?: number;

package/package.json

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