@fire-spark/realtime 0.7.1 → 0.8.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { ServiceHttpOptions } from "@fire-spark/core";
-import { KioskCommandPayload, KioskCommandPayload as KioskCommandPayload$1, KioskConfigChangedPayload, KioskConfigChangedPayload as KioskConfigChangedPayload$1, KioskRealtimeToken, KioskRealtimeToken as KioskRealtimeToken$1, OrderChangedPayload, OrderChangedPayload as OrderChangedPayload$1, StorefrontAvailabilityChangedPayload, StorefrontAvailabilityChangedPayload as StorefrontAvailabilityChangedPayload$1, StorefrontCmsChangedPayload, StorefrontCmsChangedPayload as StorefrontCmsChangedPayload$1, StorefrontMenuChangedPayload, StorefrontMenuChangedPayload as StorefrontMenuChangedPayload$1, StorefrontMenuScope, StorefrontRealtimeToken, StorefrontWorkspaceChangedPayload, StorefrontWorkspaceChangedPayload as StorefrontWorkspaceChangedPayload$1 } from "@fire-spark/types";
+import { KioskCommandPayload, KioskCommandPayload as KioskCommandPayload$1, KioskConfigChangedPayload, KioskConfigChangedPayload as KioskConfigChangedPayload$1, KioskRealtimeToken, KioskRealtimeToken as KioskRealtimeToken$1, OrderChangedPayload, OrderChangedPayload as OrderChangedPayload$1, PosFloorChangedPayload, PosFloorChangedPayload as PosFloorChangedPayload$1, PosFloorRealtimeToken, PosFloorRealtimeToken as PosFloorRealtimeToken$1, StorefrontAvailabilityChangedPayload, StorefrontAvailabilityChangedPayload as StorefrontAvailabilityChangedPayload$1, StorefrontCmsChangedPayload, StorefrontCmsChangedPayload as StorefrontCmsChangedPayload$1, StorefrontMenuChangedPayload, StorefrontMenuChangedPayload as StorefrontMenuChangedPayload$1, StorefrontMenuScope, StorefrontRealtimeToken, StorefrontWorkspaceChangedPayload, StorefrontWorkspaceChangedPayload as StorefrontWorkspaceChangedPayload$1 } from "@fire-spark/types";
 //#region src/listen.types.d.ts
 declare const MENU_CHANGED_EVENT = "menu.changed";
 declare const AVAILABILITY_CHANGED_EVENT = "availability.changed";
@@ -7,6 +7,7 @@ declare const ORDER_CHANGED_EVENT = "order.changed";
 declare const KIOSK_CONFIG_CHANGED_EVENT = "kiosk.config.changed";
 declare const KIOSK_COMMAND_EVENT = "kiosk.command";
 declare const CMS_CHANGED_EVENT = "cms.changed";
+declare const FLOOR_CHANGED_EVENT = "floor.changed";
 interface RealtimeListenEvents {
   menuChanged?: (payload: StorefrontMenuChangedPayload$1) => void;
   availabilityChanged?: (payload: StorefrontAvailabilityChangedPayload$1) => void;
@@ -60,6 +61,15 @@ interface RealtimeListenKioskOptions {
   cmsBlocks?: string[];
   on: RealtimeListenKioskEvents;
 }
+interface RealtimeListenPosFloorEvents {
+  changed: (payload: PosFloorChangedPayload$1) => void;
+  /** Fires on every (re)join; refetch to catch changes missed offline. */
+  subscribed?: () => void;
+}
+interface RealtimeListenPosFloorOptions {
+  fetchToken: () => Promise<PosFloorRealtimeToken$1>;
+  on: RealtimeListenPosFloorEvents;
+}
 //#endregion
 //#region src/listen.d.ts
 declare const listen: (options: RealtimeListenOptions, deps?: RealtimeListenDeps) => () => void;
@@ -70,6 +80,10 @@ declare const listenKiosk: (options: RealtimeListenKioskOptions, deps?: Realtime
 //#region src/listenOrder.d.ts
 declare const listenOrder: (options: RealtimeListenOrderOptions, deps?: RealtimeListenDeps) => () => void;
 //#endregion
+//#region src/listenPosFloor.d.ts
+/** Listens to the register store's `floor.changed` broadcasts. */
+declare const listenPosFloor: (options: RealtimeListenPosFloorOptions, deps?: RealtimeListenDeps) => () => void;
+//#endregion
 //#region src/checkoutRelease.d.ts
 type CheckoutReleaseResult = {
   status: "released";
@@ -111,6 +125,7 @@ declare const realtime: {
   listen: typeof listen;
   listenKiosk: typeof listenKiosk;
   listenOrder: typeof listenOrder;
+  listenPosFloor: typeof listenPosFloor;
 };
 //#endregion
-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 };
+export { AVAILABILITY_CHANGED_EVENT, CMS_CHANGED_EVENT, type CheckoutReleaseResult, type CheckoutReleaseWatch, FLOOR_CHANGED_EVENT, KIOSK_COMMAND_EVENT, KIOSK_CONFIG_CHANGED_EVENT, type KioskCommandPayload, type KioskConfigChangedPayload, type KioskRealtimeToken, MENU_CHANGED_EVENT, ORDER_CHANGED_EVENT, type OrderChangedPayload, type PosFloorChangedPayload, type PosFloorRealtimeToken, type RealtimeListenEvents, type RealtimeListenKioskOptions, type RealtimeListenOptions, type RealtimeListenOrderOptions, type RealtimeListenPosFloorOptions, type StorefrontAvailabilityChangedPayload, type StorefrontCmsChangedPayload, type StorefrontMenuChangedPayload, type StorefrontRealtimeToken, type StorefrontWorkspaceChangedPayload, listen, listenKiosk, listenOrder, listenPosFloor, realtime, watchCheckoutRelease };

package/dist/index.js

@@ -3613,6 +3613,7 @@ const KIOSK_COMMAND_EVENT = "kiosk.command";
 const CMS_CHANGED_EVENT = "cms.changed";
 const PAYMENTS_CHANGED_EVENT = "payments.changed";
 const FULFILLMENTS_CHANGED_EVENT = "fulfillments.changed";
+const FLOOR_CHANGED_EVENT = "floor.changed";
 const REALTIME_REFRESH_MS = 27e4;
 //#endregion
 //#region src/scope.ts
@@ -4086,6 +4087,91 @@ const listenOrder = (options, deps = {}) => {
 	};
 };
 //#endregion
+//#region src/listenPosFloor.ts
+const isFloorPayload = (value) => {
+	if (!value || typeof value !== "object") return false;
+	const rec = value;
+	return typeof rec.kind === "string" && typeof rec.store_uid === "string";
+};
+const bindFloorEvents = (socket, topic, options) => {
+	const { changed, subscribed } = options.on;
+	const channel = socket.channel(topic, { config: { private: true } });
+	channel.on("broadcast", { event: FLOOR_CHANGED_EVENT }, (msg) => {
+		const { payload } = msg;
+		if (!isFloorPayload(payload)) return;
+		changed(payload);
+	});
+	channel.subscribe((status, err) => {
+		if (status === "SUBSCRIBED") {
+			subscribed?.();
+			return;
+		}
+		if (status !== "CHANNEL_ERROR" && status !== "TIMED_OUT") return;
+		const detail = err instanceof Error ? err.message : status;
+		console.error("[realtime] pos floor subscribe failed", detail);
+	});
+	return channel;
+};
+/** Listens to the register store's `floor.changed` broadcasts. */
+const listenPosFloor = (options, deps = {}) => {
+	const createClient = deps.createClient ?? createRealtimeSocket;
+	const setIntervalFn = deps.setIntervalFn ?? setInterval;
+	const clearIntervalFn = deps.clearIntervalFn ?? clearInterval;
+	let stopped = false;
+	let socket = null;
+	let channel = null;
+	let refreshId = null;
+	const teardown = () => {
+		if (refreshId !== null) clearIntervalFn(refreshId);
+		refreshId = null;
+		if (channel) channel.unsubscribe();
+		channel = null;
+		socket?.disconnect();
+		socket = null;
+	};
+	const applyToken = async (existing) => {
+		const token = await options.fetchToken();
+		if (stopped) return null;
+		if (existing) {
+			await existing.setAuth(token.access_token);
+			return existing;
+		}
+		const next = createClient(token.url, token.key);
+		await next.setAuth(token.access_token);
+		if (stopped) {
+			next.disconnect();
+			return null;
+		}
+		next.connect();
+		channel = bindFloorEvents(next, token.topic, options);
+		return next;
+	};
+	const start = async () => {
+		socket = await applyToken();
+		if (stopped) {
+			teardown();
+			return;
+		}
+		if (!socket) return;
+		refreshId = setIntervalFn(() => {
+			if (!socket) return;
+			applyToken(socket).catch((error) => {
+				const message = error instanceof Error ? error.message : String(error);
+				console.error("[realtime] pos floor token refresh failed", message);
+			});
+		}, REALTIME_REFRESH_MS);
+	};
+	start().catch((error) => {
+		if (stopped) return;
+		const message = error instanceof Error ? error.message : String(error);
+		console.error("[realtime] listenPosFloor failed", message);
+	});
+	return () => {
+		stopped = true;
+		teardown();
+	};
+};
+//#endregion
 //#region src/checkoutRelease.ts
 const CHECKOUT_RELEASE_TIMEOUT_MS = 6e4;
 /** `checkout_state` from `order.changed` or the fulfillment snapshot. */
@@ -4178,7 +4264,8 @@ const watchCheckoutRelease = (options) => {
 const realtime = {
 	listen,
 	listenKiosk,
-	listenOrder
+	listenOrder,
+	listenPosFloor
 };
 //#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, watchCheckoutRelease };
+export { AVAILABILITY_CHANGED_EVENT, CMS_CHANGED_EVENT, FLOOR_CHANGED_EVENT, KIOSK_COMMAND_EVENT, KIOSK_CONFIG_CHANGED_EVENT, MENU_CHANGED_EVENT, ORDER_CHANGED_EVENT, listen, listenKiosk, listenOrder, listenPosFloor, realtime, watchCheckoutRelease };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fire-spark/realtime",
-  "version": "0.7.1",
+  "version": "0.8.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.7.1",
-    "@fire-spark/types": "^0.7.1"
+    "@fire-spark/core": "^0.8.0",
+    "@fire-spark/types": "^0.8.0"
   },
   "devDependencies": {
     "tsdown": "^0.22.14",