@acms-subir/client 0.1.16 → 0.1.18

package/README.md

@@ -44,11 +44,12 @@ 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`, `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 |
+| `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 |
 | `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']`) |
@@ -121,6 +122,7 @@ if (status.open) {
     // required when the event asks questions: a changed form answers 409, so read the status again
     ...(status.form ? { formVersion: status.form.version } : {}),
   };
+  // an email that already has an RSVP for this date: AcmsError 409 with code 'duplicate' (its link is emailed again)
   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:

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";
@@ -244,7 +248,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>;

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' },
@@ -30,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', '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 +264,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;

package/dist/types.d.ts

@@ -221,6 +221,8 @@ export type Event = {
         "capacity": number;
         "autoConfirm": boolean;
         "maxSeats": number;
+        "closesAt": string | null;
+        "closeBefore": number;
         "form"?: {
             "title": string;
             "intro": string;
@@ -311,6 +313,8 @@ export type Events = {
                 "capacity": number;
                 "autoConfirm": boolean;
                 "maxSeats": number;
+                "closesAt": string | null;
+                "closeBefore": number;
                 "form"?: {
                     "title": string;
                     "intro": string;
@@ -347,6 +351,92 @@ 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;
+            "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;
@@ -450,6 +540,8 @@ export type SearchResults = {
                 "capacity": number;
                 "autoConfirm": boolean;
                 "maxSeats": number;
+                "closesAt": string | null;
+                "closeBefore": number;
                 "form"?: {
                     "title": string;
                     "intro": string;
@@ -610,12 +702,13 @@ export type RsvpStatus = {
     "start": string;
     "end": string;
     "open": boolean;
-    "reason": ("disabled" | "ended" | "cancelled" | "full") | (null);
+    "reason": ("disabled" | "ended" | "closed" | "cancelled" | "full") | (null);
     "going": number;
     "left": (number) | (null);
     "capacity": number;
     "maxSeats": number;
     "autoConfirm": boolean;
+    "closesAt": (string) | (null);
     "form": ({
         "version": string;
         "title": string;
@@ -967,7 +1060,7 @@ export type LiveStatus = {
 export type ApiErrorResponse = {
     "version": 1;
     "error": {
-        "code": "invalid_request" | "unauthorized" | "forbidden" | "not_found" | "method_not_allowed" | "conflict" | "gone" | "payload_too_large" | "unsupported_media_type" | "rate_limited" | "upstream_error" | "internal_error";
+        "code": "invalid_request" | "unauthorized" | "forbidden" | "not_found" | "method_not_allowed" | "conflict" | "duplicate" | "gone" | "payload_too_large" | "unsupported_media_type" | "rate_limited" | "upstream_error" | "internal_error";
         "message": string;
         "issues"?: Array<{
             "path": Array<string | number>;
@@ -1153,6 +1246,9 @@ export type EditorDocument = {
             "capacity": number;
             "autoConfirm": boolean;
             "maxSeats": number;
+            "closesAt": string | null;
+            "closeBefore": number;
+            "notifyStaff": boolean;
             "form"?: {
                 "title": string;
                 "intro": string;
@@ -2083,6 +2179,9 @@ export type EditorSaveInput = {
             "capacity": number;
             "autoConfirm": boolean;
             "maxSeats": number;
+            "closesAt"?: (string) | (null);
+            "closeBefore"?: number;
+            "notifyStaff"?: boolean;
             "form"?: {
                 "title"?: string;
                 "intro"?: string;

package/package.json

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