@acms-subir/client 0.1.21 → 0.1.23

package/README.md

@@ -43,7 +43,7 @@ language. Update the site before shipping an app build with a newer client.
 | `post(slug, opts)` | Scans post summaries, then loads detail by ID; pass `collection` for ambiguous slugs |
 | `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 |
+| `events(opts)` | Occurrences with `from`, `to`, `calendar`, `tag`, `excludeTag`, `room`, `q`, pagination. The filters take one value or an array (any of them matches) |
 | `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 |

package/dist/index.d.ts

@@ -29,12 +29,15 @@ export type EventBound = `${number}-${number}-${number}` | `${number}-${number}-
 export interface EventOptions extends ListOptions {
     from?: EventBound | (string & {});
     to?: EventBound | (string & {});
-    calendar?: string;
     q?: string;
-    /** only events with this public tag (its name or slug, any case) */
-    tag?: string;
-    /** leave out events with this public tag (its name or slug, any case) */
-    excludeTag?: string;
+    /** only events in these calendars (slugs) */
+    calendar?: string | string[];
+    /** only events with one of these public tags (a name in any case, or a slug) */
+    tag?: string | string[];
+    /** leave out events with any of these public tags (a name in any case, or a slug) */
+    excludeTag?: string | string[];
+    /** only events held in one of these rooms (slugs of rooms the site shows on public events) */
+    room?: string | string[];
 }
 export interface SearchOptions extends RequestOptions {
     /** Which groups to search; default all three. */

package/dist/index.js

@@ -238,7 +238,9 @@ export function createClient(options) {
         return { ...result, items: result.items.filter(p => !o.tag || p.tags.includes(o.tag)) };
     };
     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 });
+    // several values travel comma-separated: tag=Class,Youth
+    const list = (v) => (Array.isArray(v) ? (v.length ? v.join(',') : undefined) : v);
+    const events = (o = {}) => request('events', o, { ...paging(o), from: o.from, to: o.to, calendar: list(o.calendar), tag: list(o.tag), excludeTag: list(o.excludeTag), room: list(o.room), 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 = {

package/dist/types.d.ts

@@ -186,6 +186,18 @@ export type EventRoom = {
     "name": string;
     "color": string | null;
 };
+export type OccurrenceMoved = ({
+    "from": {
+        "start": string;
+        "end": string;
+    };
+    "note": string;
+    "location": ({
+        "name": string;
+        "address": string;
+        "url": string;
+    }) | (null);
+}) | (null);
 export type Event = {
     "id": string;
     "slug": string;
@@ -264,6 +276,13 @@ export type Event = {
         "name": string;
         "color": string | null;
     }>;
+    "movedDates": {
+        [key: string]: {
+            "start": string;
+            "end": string;
+            "note": string;
+        };
+    };
     "notify": {
         "changes": Array<string>;
     };
@@ -284,6 +303,18 @@ export type Events = {
         "end": string;
         "allDay": boolean;
         "cancelled": boolean;
+        "moved": ({
+            "from": {
+                "start": string;
+                "end": string;
+            };
+            "note": string;
+            "location": ({
+                "name": string;
+                "address": string;
+                "url": string;
+            }) | (null);
+        }) | (null);
         "rooms": Array<{
             "slug": string;
             "name": string;
@@ -367,6 +398,13 @@ export type Events = {
                 "name": string;
                 "color": string | null;
             }>;
+            "movedDates": {
+                [key: string]: {
+                    "start": string;
+                    "end": string;
+                    "note": string;
+                };
+            };
             "notify": {
                 "changes": Array<string>;
             };
@@ -381,6 +419,18 @@ export type EventDetail = {
         "end": string;
         "allDay": boolean;
         "cancelled": boolean;
+        "moved": ({
+            "from": {
+                "start": string;
+                "end": string;
+            };
+            "note": string;
+            "location": ({
+                "name": string;
+                "address": string;
+                "url": string;
+            }) | (null);
+        }) | (null);
         "rooms": Array<{
             "slug": string;
             "name": string;
@@ -465,6 +515,13 @@ export type EventDetail = {
             "name": string;
             "color": string | null;
         }>;
+        "movedDates": {
+            [key: string]: {
+                "start": string;
+                "end": string;
+                "note": string;
+            };
+        };
         "notify": {
             "changes": Array<string>;
         };
@@ -532,6 +589,18 @@ export type SearchResults = {
             "end": string;
             "allDay": boolean;
             "cancelled": boolean;
+            "moved": ({
+                "from": {
+                    "start": string;
+                    "end": string;
+                };
+                "note": string;
+                "location": ({
+                    "name": string;
+                    "address": string;
+                    "url": string;
+                }) | (null);
+            }) | (null);
             "rooms": Array<{
                 "slug": string;
                 "name": string;
@@ -616,6 +685,13 @@ export type SearchResults = {
                 "name": string;
                 "color": string | null;
             }>;
+            "movedDates": {
+                [key: string]: {
+                    "start": string;
+                    "end": string;
+                    "note": string;
+                };
+            };
             "notify": {
                 "changes": Array<string>;
             };

package/package.json

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