@fire-spark/realtime 0.5.0 → 0.6.0

package/dist/index.d.ts

@@ -70,6 +70,42 @@ declare const listenKiosk: (options: RealtimeListenKioskOptions, deps?: Realtime
 //#region src/listenOrder.d.ts
 declare const listenOrder: (options: RealtimeListenOrderOptions, deps?: RealtimeListenDeps) => () => void;
 //#endregion
+//#region src/checkoutRelease.d.ts
+type CheckoutReleaseResult = {
+  status: "released";
+  payload: OrderChangedPayload$1;
+} | {
+  status: "failed";
+  payload: OrderChangedPayload$1;
+} | {
+  status: "timeout";
+} | {
+  status: "stopped";
+};
+interface CheckoutReleaseWatch {
+  /** Resolves when the channel is joined, or when the watch settles first. */
+  subscribed: Promise<void>;
+  result: Promise<CheckoutReleaseResult>;
+  /** Starts the timeout. Call after place order is in flight or has returned. */
+  arm: () => void;
+  /** Drops the subscription. Settles `result` with `stopped` if still open. */
+  stop: () => void;
+  /** Feed a payload you already have (sale response, replay). */
+  consider: (payload: OrderChangedPayload$1 | null) => void;
+}
+type WatchCheckoutReleaseOptions = Omit<RealtimeListenOrderOptions, "on"> & {
+  timeoutMs?: number;
+  /** Known fulfillment state. A terminal value settles the watch immediately. */
+  current?: OrderChangedPayload$1 | null;
+};
+/**
+ * Subscribes to `order.changed` and settles when checkout is released or
+ * rejected. The fulfillment snapshot on subscribe covers an event that
+ * already happened. `arm` starts the timeout so a missed event cannot spin
+ * forever. `stop` on unmount.
+ */
+declare const watchCheckoutRelease: (options: WatchCheckoutReleaseOptions) => CheckoutReleaseWatch;
+//#endregion
 //#region src/index.d.ts
 declare const realtime: {
   listen: typeof listen;
@@ -77,4 +113,4 @@ declare const realtime: {
   listenOrder: typeof listenOrder;
 };
 //#endregion
-export { AVAILABILITY_CHANGED_EVENT, CMS_CHANGED_EVENT, KIOSK_COMMAND_EVENT, KIOSK_CONFIG_CHANGED_EVENT, type KioskCommandPayload, type KioskConfigChangedPayload, type KioskRealtimeToken, MENU_CHANGED_EVENT, ORDER_CHANGED_EVENT, type OrderChangedPayload, type RealtimeListenEvents, type RealtimeListenKioskOptions, type RealtimeListenOptions, type RealtimeListenOrderOptions, type StorefrontAvailabilityChangedPayload, type StorefrontCmsChangedPayload, type StorefrontMenuChangedPayload, type StorefrontRealtimeToken, type StorefrontWorkspaceChangedPayload, listen, listenKiosk, listenOrder, realtime };
+export { AVAILABILITY_CHANGED_EVENT, CMS_CHANGED_EVENT, type CheckoutReleaseResult, type CheckoutReleaseWatch, KIOSK_COMMAND_EVENT, KIOSK_CONFIG_CHANGED_EVENT, type KioskCommandPayload, type KioskConfigChangedPayload, type KioskRealtimeToken, MENU_CHANGED_EVENT, ORDER_CHANGED_EVENT, type OrderChangedPayload, type RealtimeListenEvents, type RealtimeListenKioskOptions, type RealtimeListenOptions, type RealtimeListenOrderOptions, type StorefrontAvailabilityChangedPayload, type StorefrontCmsChangedPayload, type StorefrontMenuChangedPayload, type StorefrontRealtimeToken, type StorefrontWorkspaceChangedPayload, listen, listenKiosk, listenOrder, realtime, watchCheckoutRelease };

package/dist/index.js

@@ -4086,6 +4086,94 @@ const listenOrder = (options, deps = {}) => {
 	};
 };
 //#endregion
+//#region src/checkoutRelease.ts
+const CHECKOUT_RELEASE_TIMEOUT_MS = 6e4;
+/** `checkout_state` from `order.changed` or the fulfillment snapshot. */
+const checkoutReleaseStatus = (payload) => {
+	if (payload.checkout_state === "failed") return "failed";
+	if (payload.checkout_state === "released") return "released";
+	return "pending";
+};
+/**
+* Subscribes to `order.changed` and settles when checkout is released or
+* rejected. The fulfillment snapshot on subscribe covers an event that
+* already happened. `arm` starts the timeout so a missed event cannot spin
+* forever. `stop` on unmount.
+*/
+const watchCheckoutRelease = (options) => {
+	const timeoutMs = options.timeoutMs ?? CHECKOUT_RELEASE_TIMEOUT_MS;
+	let settled = false;
+	let stopListen = () => {};
+	let timer = null;
+	let resolveResult = () => void 0;
+	let resolveSubscribed = () => void 0;
+	const result = new Promise((resolve) => {
+		resolveResult = resolve;
+	});
+	const subscribed = new Promise((resolve) => {
+		resolveSubscribed = resolve;
+	});
+	const finish = (value) => {
+		if (settled) return;
+		settled = true;
+		if (timer !== null) clearTimeout(timer);
+		timer = null;
+		stopListen();
+		resolveSubscribed();
+		resolveResult(value);
+	};
+	const take = (payload) => {
+		const status = checkoutReleaseStatus(payload);
+		if (status === "pending") return;
+		if (status === "released") {
+			finish({
+				status: "released",
+				payload
+			});
+			return;
+		}
+		finish({
+			status: "failed",
+			payload
+		});
+	};
+	if (options.current) take(options.current);
+	if (!settled) {
+		const o1 = {
+			orderId: options.orderId,
+			baseUrl: options.baseUrl
+		};
+		const o2 = { accessToken: options.accessToken };
+		const o3 = { fetchImpl: options.fetchImpl };
+		const on = {
+			changed: take,
+			subscribed: () => resolveSubscribed()
+		};
+		stopListen = listenOrder({
+			...o1,
+			...o2,
+			...o3,
+			on
+		});
+	}
+	const arm = () => {
+		if (settled || timer !== null) return;
+		timer = setTimeout(() => finish({ status: "timeout" }), timeoutMs);
+	};
+	const stop = () => finish({ status: "stopped" });
+	const consider = (payload) => {
+		if (!payload) return;
+		take(payload);
+	};
+	return {
+		subscribed,
+		result,
+		arm,
+		stop,
+		consider
+	};
+};
+//#endregion
 //#region src/index.ts
 const realtime = {
 	listen,
@@ -4093,4 +4181,4 @@ const realtime = {
 	listenOrder
 };
 //#endregion
-export { AVAILABILITY_CHANGED_EVENT, CMS_CHANGED_EVENT, KIOSK_COMMAND_EVENT, KIOSK_CONFIG_CHANGED_EVENT, MENU_CHANGED_EVENT, ORDER_CHANGED_EVENT, listen, listenKiosk, listenOrder, realtime };
+export { AVAILABILITY_CHANGED_EVENT, CMS_CHANGED_EVENT, KIOSK_COMMAND_EVENT, KIOSK_CONFIG_CHANGED_EVENT, MENU_CHANGED_EVENT, ORDER_CHANGED_EVENT, listen, listenKiosk, listenOrder, realtime, watchCheckoutRelease };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fire-spark/realtime",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Fire Spark storefront realtime SDK",
   "type": "module",
   "sideEffects": false,
@@ -18,8 +18,8 @@
   },
   "dependencies": {
     "@supabase/realtime-js": "^2.100.1",
-    "@fire-spark/core": "^0.5.0",
-    "@fire-spark/types": "^0.5.0"
+    "@fire-spark/core": "^0.6.0",
+    "@fire-spark/types": "^0.6.0"
   },
   "devDependencies": {
     "tsdown": "^0.22.14",