@modelnex/sdk 0.5.17 → 0.5.19

package/dist/index.js

@@ -2718,6 +2718,51 @@ function createTourSocketPool({
 }
 var tourSocketPool = createTourSocketPool();
 
+// src/utils/tour-playback-guards.ts
+var playbackOwners = /* @__PURE__ */ new Map();
+function shouldExecuteTourCommandBatch(isPlaybackActive) {
+  return isPlaybackActive;
+}
+function shouldAcceptTourStart(state) {
+  return !state.isPlaybackActive && !state.startRequested;
+}
+function shouldRunTourAutoDiscovery(state) {
+  return state.enableAutoDiscovery && !state.disabled && !state.isPlaybackActive && !state.startRequested && !state.hasPendingTour;
+}
+function shouldLogTourDebugEntry(state) {
+  if (!state.isPlaybackActive) {
+    if (state.entryType !== "tour_start") {
+      return false;
+    }
+    if (state.entryTourType && state.entryTourType !== state.experienceType) {
+      return false;
+    }
+  }
+  if (state.entryTourType && state.entryTourType !== state.experienceType) {
+    return false;
+  }
+  return true;
+}
+function createTourPlaybackOwnerKey(serverUrl, websiteId, experienceType) {
+  return `${serverUrl}::${websiteId || "__default__"}::${experienceType}`;
+}
+function claimTourPlaybackOwnership(key, ownerId) {
+  const currentOwner = playbackOwners.get(key);
+  if (currentOwner && currentOwner !== ownerId) {
+    return false;
+  }
+  playbackOwners.set(key, ownerId);
+  return true;
+}
+function hasTourPlaybackOwnership(key, ownerId) {
+  return playbackOwners.get(key) === ownerId;
+}
+function releaseTourPlaybackOwnership(key, ownerId) {
+  if (playbackOwners.get(key) === ownerId) {
+    playbackOwners.delete(key);
+  }
+}
+
 // src/hooks/useTourPlayback.ts
 function resolveElement(step) {
   const el = step.element;
@@ -3251,6 +3296,9 @@ function useTourPlayback({
   const showCaptionsRef = (0, import_react12.useRef)(showCaptions);
   const runIdRef = (0, import_react12.useRef)(null);
   const turnIdRef = (0, import_react12.useRef)(null);
+  const startRequestedRef = (0, import_react12.useRef)(false);
+  const playbackOwnerIdRef = (0, import_react12.useRef)(`playback-owner-${Math.random().toString(36).slice(2, 10)}`);
+  const claimedPlaybackOwnerKeyRef = (0, import_react12.useRef)(null);
   const socketRef = (0, import_react12.useRef)(null);
   const socketIdRef = (0, import_react12.useRef)(socketId);
   const commandUrlRef = (0, import_react12.useRef)(commandUrl);
@@ -3268,6 +3316,12 @@ function useTourPlayback({
   toursApiBaseRef.current = toursApiBase;
   pendingTourRef.current = pendingTour;
   showCaptionsRef.current = showCaptions;
+  const releasePlaybackOwnership = (0, import_react12.useCallback)(() => {
+    const claimedKey = claimedPlaybackOwnerKeyRef.current;
+    if (!claimedKey) return;
+    releaseTourPlaybackOwnership(claimedKey, playbackOwnerIdRef.current);
+    claimedPlaybackOwnerKeyRef.current = null;
+  }, []);
   (0, import_react12.useEffect)(() => {
     if (disabled) return;
     if (typeof window === "undefined") return;
@@ -3303,6 +3357,12 @@ function useTourPlayback({
       }
     };
     const handleCommand = async (payload) => {
+      const ownerKey = createTourPlaybackOwnerKey(serverUrl, websiteIdRef.current, experienceTypeRef.current);
+      if (!shouldExecuteTourCommandBatch(isActiveRef.current) || !hasTourPlaybackOwnership(ownerKey, playbackOwnerIdRef.current)) {
+        const activeType = experienceTypeRef.current;
+        console.log("[TourClient] Ignoring command batch for inactive playback hook:", activeType, payload.stepIndex);
+        return;
+      }
       const emitIfOpen = (ev, data) => {
         if (socketRef.current !== socket) return;
         emitSocketEvent(socket, ev, data);
@@ -3808,7 +3868,14 @@ function useTourPlayback({
         console.log(`[TourClient] Ignoring ${tour.type} start (this hook is for ${expType})`);
         return;
       }
+      const ownerKey = createTourPlaybackOwnerKey(serverUrl, websiteIdRef.current, expType);
+      if (!claimTourPlaybackOwnership(ownerKey, playbackOwnerIdRef.current)) {
+        console.log(`[TourClient] Ignoring ${expType} start because another hook already owns playback`);
+        return;
+      }
+      claimedPlaybackOwnerKeyRef.current = ownerKey;
       skipRequestedRef.current = false;
+      startRequestedRef.current = false;
       const total = tourData.totalSteps ?? tour?.steps?.length ?? 0;
       isActiveRef.current = true;
       setIsActive(true);
@@ -3867,6 +3934,16 @@ function useTourPlayback({
     };
     const handleDebugLog = (entry) => {
       const isDev = devModeRef.current || process.env.NODE_ENV === "development" || typeof window !== "undefined" && window.MODELNEX_DEBUG;
+      const entryTourType = entry?.data?.tourContext?.type ?? tourRef.current?.type ?? null;
+      const ownerKey = createTourPlaybackOwnerKey(serverUrl, websiteIdRef.current, experienceTypeRef.current);
+      if (!shouldLogTourDebugEntry({
+        isPlaybackActive: isActiveRef.current,
+        entryType: entry?.type,
+        entryTourType,
+        experienceType: experienceTypeRef.current
+      }) || isActiveRef.current && !hasTourPlaybackOwnership(ownerKey, playbackOwnerIdRef.current)) {
+        return;
+      }
       if (isDev) {
         console.log(`%c[ModelNex Tour] ${entry.type}`, "color: #3b82f6; font-weight: bold", entry);
         if (typeof window !== "undefined") {
@@ -3899,9 +3976,10 @@ function useTourPlayback({
       setServerState(null);
       runIdRef.current = null;
       turnIdRef.current = null;
+      releasePlaybackOwnership();
       tourSocketPool.release(serverUrl, toClose);
     };
-  }, [serverUrl, disabled]);
+  }, [serverUrl, disabled, releasePlaybackOwnership]);
   (0, import_react12.useEffect)(() => {
     if (disabled) return;
     const s = socketRef.current;
@@ -3972,6 +4050,8 @@ function useTourPlayback({
   const stopTour = (0, import_react12.useCallback)(() => {
     skipRequestedRef.current = true;
     isActiveRef.current = false;
+    startRequestedRef.current = false;
+    releasePlaybackOwnership();
     activeExecutionTokenRef.current += 1;
     commandInFlightRef.current = false;
     activeCommandBatchIdRef.current = null;
@@ -4007,12 +4087,14 @@ function useTourPlayback({
     setIsReviewMode(false);
     pendingInputBufRef.current = null;
     onTourEnd?.();
-  }, [voice, onTourEnd, serverUrl, websiteId]);
+  }, [voice, onTourEnd, serverUrl, websiteId, releasePlaybackOwnership]);
   const handleTourEnd = (0, import_react12.useCallback)(() => {
     const endingTourId = tourRef.current?.id;
     const endingPreviewRunId = previewRunIdRef.current;
     const endingStepOrder = stepIndexRef.current;
     isActiveRef.current = false;
+    startRequestedRef.current = false;
+    releasePlaybackOwnership();
     setPlaybackState("complete");
     removeHighlight();
     removeCaption();
@@ -4044,8 +4126,15 @@ function useTourPlayback({
       clearActiveDraftPreview(experienceType);
     }
     onTourEnd?.();
-  }, [experienceType, userProfile, serverUrl, voice, onTourEnd, websiteId]);
+  }, [experienceType, userProfile, serverUrl, voice, onTourEnd, websiteId, releasePlaybackOwnership]);
   const runTour = (0, import_react12.useCallback)(async (tour, options) => {
+    if (!shouldAcceptTourStart({
+      isPlaybackActive: isActiveRef.current,
+      startRequested: startRequestedRef.current
+    })) {
+      console.log("[TourClient] Ignoring duplicate start request while playback is already active or starting:", tour.id);
+      return;
+    }
     setPendingTour(null);
     pendingTourRef.current = null;
     let retries = 0;
@@ -4057,6 +4146,13 @@ function useTourPlayback({
       console.warn("[TourClient] Cannot run tour, socket not connected.");
       return;
     }
+    const ownerKey = createTourPlaybackOwnerKey(serverUrl, websiteIdRef.current, tour.type ?? experienceTypeRef.current);
+    if (!claimTourPlaybackOwnership(ownerKey, playbackOwnerIdRef.current)) {
+      console.log("[TourClient] Ignoring duplicate start request because another hook already owns this experience:", tour.id);
+      return;
+    }
+    claimedPlaybackOwnerKeyRef.current = ownerKey;
+    startRequestedRef.current = true;
     const shouldReview = Boolean(options?.reviewMode);
     resetCaptionSuppression();
     setReviewStatusMessage(null);
@@ -4088,8 +4184,13 @@ function useTourPlayback({
     });
   }, [serverUrl, websiteId]);
   (0, import_react12.useEffect)(() => {
-    if (!enableAutoDiscovery) return;
-    if (disabled) return;
+    if (!shouldRunTourAutoDiscovery({
+      enableAutoDiscovery,
+      disabled,
+      isPlaybackActive: isActiveRef.current,
+      startRequested: startRequestedRef.current,
+      hasPendingTour: Boolean(pendingTourRef.current)
+    })) return;
     if (typeof window === "undefined") return;
     const params = new URLSearchParams(window.location.search);
     const queryParam = experienceType === "onboarding" ? "modelnex_test_workflow" : "modelnex_test_tour";
@@ -4137,8 +4238,13 @@ function useTourPlayback({
     };
   }, [serverUrl, toursApiBase, disabled, websiteId, experienceType, enableAutoDiscovery]);
   (0, import_react12.useEffect)(() => {
-    if (!enableAutoDiscovery) return;
-    if (disabled) return;
+    if (!shouldRunTourAutoDiscovery({
+      enableAutoDiscovery,
+      disabled,
+      isPlaybackActive: isActiveRef.current,
+      startRequested: startRequestedRef.current,
+      hasPendingTour: Boolean(pendingTourRef.current)
+    })) return;
     if (!websiteId || !userProfile) return;
     if (typeof window !== "undefined") {
       const params = new URLSearchParams(window.location.search);
@@ -4177,7 +4283,7 @@ function useTourPlayback({
       cancelled = true;
       clearTimeout(timer);
     };
-  }, [websiteId, serverUrl, toursApiBase, disabled, experienceType, userProfile, enableAutoDiscovery]);
+  }, [websiteId, serverUrl, toursApiBase, disabled, experienceType, userProfile?.userId, userProfile?.type, userProfile?.isNewUser, enableAutoDiscovery]);
   (0, import_react12.useEffect)(() => {
     if (!disabled || !isActiveRef.current) return;
     stopTour();

package/dist/index.mjs

@@ -2508,6 +2508,51 @@ function createTourSocketPool({
 }
 var tourSocketPool = createTourSocketPool();
 
+// src/utils/tour-playback-guards.ts
+var playbackOwners = /* @__PURE__ */ new Map();
+function shouldExecuteTourCommandBatch(isPlaybackActive) {
+  return isPlaybackActive;
+}
+function shouldAcceptTourStart(state) {
+  return !state.isPlaybackActive && !state.startRequested;
+}
+function shouldRunTourAutoDiscovery(state) {
+  return state.enableAutoDiscovery && !state.disabled && !state.isPlaybackActive && !state.startRequested && !state.hasPendingTour;
+}
+function shouldLogTourDebugEntry(state) {
+  if (!state.isPlaybackActive) {
+    if (state.entryType !== "tour_start") {
+      return false;
+    }
+    if (state.entryTourType && state.entryTourType !== state.experienceType) {
+      return false;
+    }
+  }
+  if (state.entryTourType && state.entryTourType !== state.experienceType) {
+    return false;
+  }
+  return true;
+}
+function createTourPlaybackOwnerKey(serverUrl, websiteId, experienceType) {
+  return `${serverUrl}::${websiteId || "__default__"}::${experienceType}`;
+}
+function claimTourPlaybackOwnership(key, ownerId) {
+  const currentOwner = playbackOwners.get(key);
+  if (currentOwner && currentOwner !== ownerId) {
+    return false;
+  }
+  playbackOwners.set(key, ownerId);
+  return true;
+}
+function hasTourPlaybackOwnership(key, ownerId) {
+  return playbackOwners.get(key) === ownerId;
+}
+function releaseTourPlaybackOwnership(key, ownerId) {
+  if (playbackOwners.get(key) === ownerId) {
+    playbackOwners.delete(key);
+  }
+}
+
 // src/hooks/useTourPlayback.ts
 function resolveElement(step) {
   const el = step.element;
@@ -3041,6 +3086,9 @@ function useTourPlayback({
   const showCaptionsRef = useRef8(showCaptions);
   const runIdRef = useRef8(null);
   const turnIdRef = useRef8(null);
+  const startRequestedRef = useRef8(false);
+  const playbackOwnerIdRef = useRef8(`playback-owner-${Math.random().toString(36).slice(2, 10)}`);
+  const claimedPlaybackOwnerKeyRef = useRef8(null);
   const socketRef = useRef8(null);
   const socketIdRef = useRef8(socketId);
   const commandUrlRef = useRef8(commandUrl);
@@ -3058,6 +3106,12 @@ function useTourPlayback({
   toursApiBaseRef.current = toursApiBase;
   pendingTourRef.current = pendingTour;
   showCaptionsRef.current = showCaptions;
+  const releasePlaybackOwnership = useCallback7(() => {
+    const claimedKey = claimedPlaybackOwnerKeyRef.current;
+    if (!claimedKey) return;
+    releaseTourPlaybackOwnership(claimedKey, playbackOwnerIdRef.current);
+    claimedPlaybackOwnerKeyRef.current = null;
+  }, []);
   useEffect11(() => {
     if (disabled) return;
     if (typeof window === "undefined") return;
@@ -3093,6 +3147,12 @@ function useTourPlayback({
       }
     };
     const handleCommand = async (payload) => {
+      const ownerKey = createTourPlaybackOwnerKey(serverUrl, websiteIdRef.current, experienceTypeRef.current);
+      if (!shouldExecuteTourCommandBatch(isActiveRef.current) || !hasTourPlaybackOwnership(ownerKey, playbackOwnerIdRef.current)) {
+        const activeType = experienceTypeRef.current;
+        console.log("[TourClient] Ignoring command batch for inactive playback hook:", activeType, payload.stepIndex);
+        return;
+      }
       const emitIfOpen = (ev, data) => {
         if (socketRef.current !== socket) return;
         emitSocketEvent(socket, ev, data);
@@ -3598,7 +3658,14 @@ function useTourPlayback({
         console.log(`[TourClient] Ignoring ${tour.type} start (this hook is for ${expType})`);
         return;
       }
+      const ownerKey = createTourPlaybackOwnerKey(serverUrl, websiteIdRef.current, expType);
+      if (!claimTourPlaybackOwnership(ownerKey, playbackOwnerIdRef.current)) {
+        console.log(`[TourClient] Ignoring ${expType} start because another hook already owns playback`);
+        return;
+      }
+      claimedPlaybackOwnerKeyRef.current = ownerKey;
       skipRequestedRef.current = false;
+      startRequestedRef.current = false;
       const total = tourData.totalSteps ?? tour?.steps?.length ?? 0;
       isActiveRef.current = true;
       setIsActive(true);
@@ -3657,6 +3724,16 @@ function useTourPlayback({
     };
     const handleDebugLog = (entry) => {
       const isDev = devModeRef.current || process.env.NODE_ENV === "development" || typeof window !== "undefined" && window.MODELNEX_DEBUG;
+      const entryTourType = entry?.data?.tourContext?.type ?? tourRef.current?.type ?? null;
+      const ownerKey = createTourPlaybackOwnerKey(serverUrl, websiteIdRef.current, experienceTypeRef.current);
+      if (!shouldLogTourDebugEntry({
+        isPlaybackActive: isActiveRef.current,
+        entryType: entry?.type,
+        entryTourType,
+        experienceType: experienceTypeRef.current
+      }) || isActiveRef.current && !hasTourPlaybackOwnership(ownerKey, playbackOwnerIdRef.current)) {
+        return;
+      }
       if (isDev) {
         console.log(`%c[ModelNex Tour] ${entry.type}`, "color: #3b82f6; font-weight: bold", entry);
         if (typeof window !== "undefined") {
@@ -3689,9 +3766,10 @@ function useTourPlayback({
       setServerState(null);
       runIdRef.current = null;
       turnIdRef.current = null;
+      releasePlaybackOwnership();
       tourSocketPool.release(serverUrl, toClose);
     };
-  }, [serverUrl, disabled]);
+  }, [serverUrl, disabled, releasePlaybackOwnership]);
   useEffect11(() => {
     if (disabled) return;
     const s = socketRef.current;
@@ -3762,6 +3840,8 @@ function useTourPlayback({
   const stopTour = useCallback7(() => {
     skipRequestedRef.current = true;
     isActiveRef.current = false;
+    startRequestedRef.current = false;
+    releasePlaybackOwnership();
     activeExecutionTokenRef.current += 1;
     commandInFlightRef.current = false;
     activeCommandBatchIdRef.current = null;
@@ -3797,12 +3877,14 @@ function useTourPlayback({
     setIsReviewMode(false);
     pendingInputBufRef.current = null;
     onTourEnd?.();
-  }, [voice, onTourEnd, serverUrl, websiteId]);
+  }, [voice, onTourEnd, serverUrl, websiteId, releasePlaybackOwnership]);
   const handleTourEnd = useCallback7(() => {
     const endingTourId = tourRef.current?.id;
     const endingPreviewRunId = previewRunIdRef.current;
     const endingStepOrder = stepIndexRef.current;
     isActiveRef.current = false;
+    startRequestedRef.current = false;
+    releasePlaybackOwnership();
     setPlaybackState("complete");
     removeHighlight();
     removeCaption();
@@ -3834,8 +3916,15 @@ function useTourPlayback({
       clearActiveDraftPreview(experienceType);
     }
     onTourEnd?.();
-  }, [experienceType, userProfile, serverUrl, voice, onTourEnd, websiteId]);
+  }, [experienceType, userProfile, serverUrl, voice, onTourEnd, websiteId, releasePlaybackOwnership]);
   const runTour = useCallback7(async (tour, options) => {
+    if (!shouldAcceptTourStart({
+      isPlaybackActive: isActiveRef.current,
+      startRequested: startRequestedRef.current
+    })) {
+      console.log("[TourClient] Ignoring duplicate start request while playback is already active or starting:", tour.id);
+      return;
+    }
     setPendingTour(null);
     pendingTourRef.current = null;
     let retries = 0;
@@ -3847,6 +3936,13 @@ function useTourPlayback({
       console.warn("[TourClient] Cannot run tour, socket not connected.");
       return;
     }
+    const ownerKey = createTourPlaybackOwnerKey(serverUrl, websiteIdRef.current, tour.type ?? experienceTypeRef.current);
+    if (!claimTourPlaybackOwnership(ownerKey, playbackOwnerIdRef.current)) {
+      console.log("[TourClient] Ignoring duplicate start request because another hook already owns this experience:", tour.id);
+      return;
+    }
+    claimedPlaybackOwnerKeyRef.current = ownerKey;
+    startRequestedRef.current = true;
     const shouldReview = Boolean(options?.reviewMode);
     resetCaptionSuppression();
     setReviewStatusMessage(null);
@@ -3878,8 +3974,13 @@ function useTourPlayback({
     });
   }, [serverUrl, websiteId]);
   useEffect11(() => {
-    if (!enableAutoDiscovery) return;
-    if (disabled) return;
+    if (!shouldRunTourAutoDiscovery({
+      enableAutoDiscovery,
+      disabled,
+      isPlaybackActive: isActiveRef.current,
+      startRequested: startRequestedRef.current,
+      hasPendingTour: Boolean(pendingTourRef.current)
+    })) return;
     if (typeof window === "undefined") return;
     const params = new URLSearchParams(window.location.search);
     const queryParam = experienceType === "onboarding" ? "modelnex_test_workflow" : "modelnex_test_tour";
@@ -3927,8 +4028,13 @@ function useTourPlayback({
     };
   }, [serverUrl, toursApiBase, disabled, websiteId, experienceType, enableAutoDiscovery]);
   useEffect11(() => {
-    if (!enableAutoDiscovery) return;
-    if (disabled) return;
+    if (!shouldRunTourAutoDiscovery({
+      enableAutoDiscovery,
+      disabled,
+      isPlaybackActive: isActiveRef.current,
+      startRequested: startRequestedRef.current,
+      hasPendingTour: Boolean(pendingTourRef.current)
+    })) return;
     if (!websiteId || !userProfile) return;
     if (typeof window !== "undefined") {
       const params = new URLSearchParams(window.location.search);
@@ -3967,7 +4073,7 @@ function useTourPlayback({
       cancelled = true;
       clearTimeout(timer);
     };
-  }, [websiteId, serverUrl, toursApiBase, disabled, experienceType, userProfile, enableAutoDiscovery]);
+  }, [websiteId, serverUrl, toursApiBase, disabled, experienceType, userProfile?.userId, userProfile?.type, userProfile?.isNewUser, enableAutoDiscovery]);
   useEffect11(() => {
     if (!disabled || !isActiveRef.current) return;
     stopTour();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@modelnex/sdk",
-  "version": "0.5.17",
+  "version": "0.5.19",
   "description": "React SDK for natural language control of web apps via AI agents",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",