@wix/himalaya-cli 0.903.0 → 0.905.0

package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/stdlib/wix-sdk/events/src/index.d.ts

@@ -35,11 +35,14 @@ export interface WixEventLocation {
 export interface WixEvent {
     id: string;
     title?: string;
-    /** Normally one of `WixEventStatus`, but deliberately NOT narrowed to it: `decodeEvent`
-     *  fills this from the server's `status` and passes a value it does not recognise straight
-     *  through, because dropping or rewriting one would lose a real event. A union here would
-     *  be a claim this SDK cannot enforce. Compare against `WixEventStatus` when you need the
-     *  stored set; the narrowing that IS enforced is on the `statuses` filter below. */
+    /** Normally one of `WixEventStatus` — `UPCOMING` (published and scheduled to start),
+     *  `STARTED`, `ENDED`, `CANCELED`, `DRAFT`. Events v1 called the first of those `SCHEDULED`,
+     *  and this SDK reads v3, so a row here never carries `SCHEDULED`.
+     *
+     *  Deliberately NOT narrowed to that union: `decodeEvent` fills this from the server's
+     *  `status` and passes a value it does not recognise straight through, because dropping or
+     *  rewriting one would lose a real event. A union here would be a claim this SDK cannot
+     *  enforce. Compare against `WixEventStatus` when you need the set it knows. */
     eventStatus?: string;
     /** EventType: RSVP | TICKETS | EXTERNAL | NO_REGISTRATION */
     eventType?: string;
@@ -59,9 +62,15 @@ export interface WixGetEventResponse {
 }
 export interface WixDeleteEventResponse {
 }
-/** The stored event statuses — what this SDK knows the server stores, and so the only values
- *  the `statuses` filter can match. The one source for both the runtime guard and the type
- *  below, so a status added here cannot be missed by either.
+/** The event statuses this SDK knows the server stores — the Events **v3** set, because that
+ *  is the API `queryEvents` and `getEvent` call. `UPCOMING` is a published event that has not
+ *  started; v1 called that one `SCHEDULED`, and v3 does not use that spelling at all, so a
+ *  filter copied from v1 docs matches nothing. The one source for `WixEventStatus` below, so
+ *  the two cannot drift.
+ *
+ *  Known, not exhaustive. The server owns this list and versions it — it has already been
+ *  renamed once, and v3 declares an `UNKNOWN_EVENT_STATUS` of its own — so nothing here
+ *  refuses a value that is absent from it. Use it to recognise a status, never to reject one.
  *
  *  Exported because `WixEventStatus` is declared in terms of it: the generated SDK reference
  *  ships each exported declaration verbatim, and a reader copying a type that names a symbol
@@ -69,12 +78,11 @@ export interface WixDeleteEventResponse {
  *
  *  Frozen because `as const` is erased: it makes the TYPE readonly and leaves an ordinary
  *  mutable array behind. Unexported that was academic; exported it is not — module bindings
- *  share one array object, so a `push` from any untyped caller would edit the very set
- *  `queryEvents` validates against, for every caller in that realm. The freeze makes the
- *  runtime keep the promise the type already makes. */
-export declare const EVENT_STATUSES: readonly ["SCHEDULED", "STARTED", "ENDED", "CANCELED", "DRAFT"];
-/** One of the stored event statuses. `WixQueryEventsOptions.statuses` takes these, so a value
- *  outside the set is refused while the call is being written rather than when it is made. */
+ *  share one array object, so a `push` from any untyped caller would edit the set every
+ *  caller in that realm reads. The freeze makes the runtime keep the promise the type makes. */
+export declare const EVENT_STATUSES: readonly ["UPCOMING", "STARTED", "ENDED", "CANCELED", "DRAFT"];
+/** One of the event statuses this SDK knows about. `WixQueryEventsOptions.statuses` accepts
+ *  these and suggests them as you type, but does not require them — see that field. */
 export type WixEventStatus = (typeof EVENT_STATUSES)[number];
 export interface WixQueryEventsOptions {
     /** Server-side WQL filter/sort for Events v3. Unlike the legacy convenience
@@ -94,13 +102,23 @@ export interface WixQueryEventsOptions {
     limit?: number;
     /** Page offset. */
     offset?: number;
-    /** Status filter (e.g. `["SCHEDULED"]`). Every entry must be a `WixEventStatus`; anything
-     * else is refused rather than quietly matching nothing — by the compiler for a typed caller,
-     * and at runtime for one that is not. Omitted → all statuses returned.
-     * There is no stored "upcoming" status; select future events by their start date.
-     * For a value the server accepts that `WixEventStatus` does not name, use `query.filter`,
-     * which is passed through to the server unchanged. */
-    statuses?: WixEventStatus[];
+    /** Status filter (e.g. `["UPCOMING"]`), matched exactly against each row's `eventStatus`.
+     * Omitted → all statuses returned; a value no row carries selects nothing.
+     *
+     * This route is Events **v3**, whose statuses are `UPCOMING` (published and scheduled to
+     * start), `STARTED`, `ENDED`, `CANCELED` and `DRAFT`. Events v1 named the first of those
+     * `SCHEDULED`, so a filter copied from v1 docs matches no row a v3 site returns — reach
+     * for `UPCOMING` instead.
+     *
+     * The type suggests `EVENT_STATUSES` without closing on them: the server owns that list and
+     * versions it, so a value it adds later must reach the match rather than be refused on the
+     * strength of a copy that has fallen behind. A status this SDK does not know is filtered on
+     * like any other and selects the rows that carry it — or none, which is the honest answer
+     * and one a caller can read.
+     *
+     * Applied to the fetched page, after paging. To filter server-side instead, use
+     * `query.filter`, which is passed through unchanged. */
+    statuses?: Array<WixEventStatus | (string & {})>;
     /** Sort property (the Owner list orders by "start"). */
     order?: string;
     /** Free-text title search. */

package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/wix-events.mjs

@@ -242,7 +242,7 @@ function wixCall(method, path, body) {
   return globalThis.himalaya.wixApi.call(method, path, body);
 }
 var BASE = "https://manage.wix.com/_api/wix-one-events-server/events-in-clubs";
-var EVENT_STATUSES = Object.freeze(["SCHEDULED", "STARTED", "ENDED", "CANCELED", "DRAFT"]);
+var EVENT_STATUSES = Object.freeze(["UPCOMING", "STARTED", "ENDED", "CANCELED", "DRAFT"]);
 function decodeEvent(raw) {
   if (raw == null) return raw;
   const r = raw;
@@ -265,14 +265,6 @@ function eventStartMs(e) {
   return Number.isNaN(ms) ? Number.POSITIVE_INFINITY : ms;
 }
 async function queryEvents(opts = {}) {
-  const unknown = (opts.statuses ?? []).filter((s) => !EVENT_STATUSES.includes(s));
-  if (unknown.length > 0) {
-    throw new Error(
-      // Quoted, so that a value whose defect is invisible unquoted — a stray space, an empty
-      // string — reads as the defect it is rather than as a name the reader has to doubt.
-      `queryEvents: unknown status ${unknown.map((s) => JSON.stringify(s)).join(", ")} \u2014 statuses must be one of ${EVENT_STATUSES.join(", ")}`
-    );
-  }
   const limit = opts.limit ?? opts.query?.paging?.limit ?? 50;
   const offset = opts.offset ?? opts.query?.paging?.offset ?? 0;
   const res = await wixCall("POST", "/events/v3/events/query", { query: { ...opts.query, paging: { limit, offset } } });