@wireai/activation 0.14.3 → 0.16.0

package/dist/coachmarks/index.mjs

@@ -89,17 +89,31 @@ var failOpen = async (storage, key) => {
   const cached3 = await readCachedFeatures(storage, key);
   return (_a = cached3 == null ? void 0 : cached3.features) != null ? _a : defaultWireFeatures;
 };
-var fetchWithTimeout = async (url, apiKey, timeoutMs) => {
+var NO_ANSWER = /* @__PURE__ */ Symbol("wire-features-no-answer");
+var fetchFeaturesJson = async (url, apiKey, timeoutMs) => {
   const controller = typeof AbortController !== "undefined" ? new AbortController() : void 0;
-  const timer = setTimeout(() => controller == null ? void 0 : controller.abort(), timeoutMs);
-  try {
-    return await fetch(url, {
+  let timer;
+  const expired = new Promise((resolve) => {
+    timer = setTimeout(() => {
+      controller == null ? void 0 : controller.abort();
+      resolve(NO_ANSWER);
+    }, timeoutMs);
+  });
+  const exchange = (async () => {
+    const res = await fetch(url, {
       method: "GET",
       headers: { Accept: "application/json", Authorization: `Bearer ${apiKey}` },
       signal: controller == null ? void 0 : controller.signal
     });
+    if (!res || !res.ok) return NO_ANSWER;
+    return await res.json();
+  })();
+  try {
+    return await Promise.race([exchange, expired]);
   } finally {
     clearTimeout(timer);
+    void exchange.catch(() => {
+    });
   }
 };
 var fetchWireFeatures = async (config) => {
@@ -109,9 +123,8 @@ var fetchWireFeatures = async (config) => {
   const url = `${config.serverUrl.replace(/\/$/, "")}/v1/features`;
   const timeoutMs = config.timeoutMs && config.timeoutMs > 0 ? config.timeoutMs : DEFAULT_TIMEOUT_MS;
   try {
-    const res = await fetchWithTimeout(url, config.apiKey, timeoutMs);
-    if (!res || !res.ok) return failOpen(storage, key);
-    const json = await res.json();
+    const json = await fetchFeaturesJson(url, config.apiKey, timeoutMs);
+    if (json === NO_ANSWER) return failOpen(storage, key);
     const features = parseWireFeatures(json);
     if (storage) writeCachedFeatures(storage, key, features);
     return features;
@@ -127,39 +140,51 @@ var useStableValue = (value, isEqual) => {
   return ref.current;
 };
 var sameFetchKey = (a, b) => (a == null ? void 0 : a.serverUrl) === (b == null ? void 0 : b.serverUrl) && (a == null ? void 0 : a.apiKey) === (b == null ? void 0 : b.apiKey) && (a == null ? void 0 : a.appId) === (b == null ? void 0 : b.appId);
-var useWireFeatures = (config) => {
+var useWireFeaturesState = (config) => {
   const stableConfig = useStableValue(config, sameFetchKey);
   const [flags, setFlags] = useState(defaultWireFeatures);
   const canFetch = !!(stableConfig == null ? void 0 : stableConfig.serverUrl) && !!(stableConfig == null ? void 0 : stableConfig.apiKey);
+  const [settled, setSettled] = useState(!canFetch);
   useEffect(() => {
     if (!canFetch) {
       setFlags((prev) => featuresEqual(prev, defaultWireFeatures) ? prev : defaultWireFeatures);
+      setSettled(true);
       return;
     }
     let alive = true;
     void fetchWireFeatures(stableConfig).then((next) => {
       if (!alive) return;
       setFlags((prev) => featuresEqual(prev, next) ? prev : next);
+      setSettled(true);
     });
     return () => {
       alive = false;
     };
   }, [canFetch, stableConfig]);
-  return flags;
+  return useMemo(() => ({ flags, settled }), [flags, settled]);
 };
 var CONTEXT_SYMBOL = /* @__PURE__ */ Symbol.for("wireai.features.context");
-var globalObj = globalThis;
-if (!globalObj[CONTEXT_SYMBOL]) {
-  globalObj[CONTEXT_SYMBOL] = createContext(null);
+var featuresContextGlobal = globalThis;
+if (!featuresContextGlobal[CONTEXT_SYMBOL]) {
+  featuresContextGlobal[CONTEXT_SYMBOL] = createContext(null);
+}
+var WireFeaturesContext = featuresContextGlobal[CONTEXT_SYMBOL];
+var SETTLED_SYMBOL = /* @__PURE__ */ Symbol.for("wireai.features.settled.context");
+var settledContextGlobal = globalThis;
+if (!settledContextGlobal[SETTLED_SYMBOL]) {
+  settledContextGlobal[SETTLED_SYMBOL] = createContext(true);
 }
-var WireFeaturesContext = globalObj[CONTEXT_SYMBOL];
+var WireFeaturesSettledContext = settledContextGlobal[SETTLED_SYMBOL];
 var useWireFeaturesContext = () => useContext(WireFeaturesContext);
-var useResolvedFeatures = (options) => {
+var useResolvedFeaturesState = (options) => {
   var _a, _b, _c;
   const ctx = useWireFeaturesContext();
+  const ctxSettled = useContext(WireFeaturesSettledContext);
   const shouldFetch = !(options == null ? void 0 : options.flags) && ctx == null;
-  const fetched = useWireFeatures(shouldFetch ? options == null ? void 0 : options.config : void 0);
-  return (_c = (_b = (_a = options == null ? void 0 : options.flags) != null ? _a : ctx) != null ? _b : fetched) != null ? _c : defaultWireFeatures;
+  const fetched = useWireFeaturesState(shouldFetch ? options == null ? void 0 : options.config : void 0);
+  const flags = (_c = (_b = (_a = options == null ? void 0 : options.flags) != null ? _a : ctx) != null ? _b : fetched.flags) != null ? _c : defaultWireFeatures;
+  const settled = (options == null ? void 0 : options.flags) ? true : ctx != null ? ctxSettled : fetched.settled;
+  return useMemo(() => ({ flags, settled }), [flags, settled]);
 };
 
 // src/coachmarks/runtime.ts
@@ -195,6 +220,17 @@ var setCoachmarksEnabled = (value) => {
   notifyCoachmarksEnabled();
 };
 var areCoachmarksEnabled = () => coachmarkRuntime().coachmarksEnabled;
+var setCoachmarksResolved = (value) => {
+  var _a;
+  const runtime = coachmarkRuntime();
+  if (((_a = runtime.coachmarksResolved) != null ? _a : true) === value) return;
+  runtime.coachmarksResolved = value;
+  notifyCoachmarksEnabled();
+};
+var areCoachmarksResolved = () => {
+  var _a;
+  return (_a = coachmarkRuntime().coachmarksResolved) != null ? _a : true;
+};
 var subscribeCoachmarksEnabled = (listener) => {
   const listeners2 = enabledListeners();
   listeners2.add(listener);
@@ -213,9 +249,54 @@ var isCoachmarkTesting = () => coachmarkRuntime().testing;
 var coachmarkGateKey = (tourId) => `wire_coachmark_${tourId}_seen`;
 var showcaseGateKey = (showcaseId) => `wire_showcase_${showcaseId}_seen`;
 var SEEN_VALUE = "1";
+var GATE_PROBE_KEY = "wire_gate_probe";
+var ASYNC_GATE_STORAGE_WARNED_SLOT = /* @__PURE__ */ Symbol.for(
+  "@wireai/activation:asyncGateStorageWarned"
+);
+var asyncGateWarnGlobal = globalThis;
+var closedGateStorage = Object.freeze({
+  getItem: () => SEEN_VALUE,
+  setItem: () => {
+  }
+});
+var syncGateAdapters = /* @__PURE__ */ new WeakSet();
+var asyncGateAdapters = /* @__PURE__ */ new WeakSet();
+var warnAsyncGateStorage = () => {
+  if (asyncGateWarnGlobal[ASYNC_GATE_STORAGE_WARNED_SLOT]) return;
+  if (typeof __DEV__ === "undefined" || !__DEV__) return;
+  if (typeof console === "undefined" || !console.warn) return;
+  asyncGateWarnGlobal[ASYNC_GATE_STORAGE_WARNED_SLOT] = true;
+  console.warn(
+    "[wireai] the gate storage's getItem returned a Promise \u2014 an async adapter (e.g. AsyncStorage) cannot drive the once-per-user gates, so coachmark tours, showcases and the review/questionnaire gates are all DISABLED (fail closed: nothing shows, nothing fires) until a synchronous adapter is provided. Pass a sync adapter (e.g. MMKV: `{ getItem: (k) => mmkv.getString(k) ?? null, setItem: (k, v) => mmkv.set(k, v) }`) to CoachmarkProvider or the gate's `storage` prop."
+  );
+};
+var validateGateStorage = (storage) => {
+  if (!storage) return null;
+  if (syncGateAdapters.has(storage)) return storage;
+  if (asyncGateAdapters.has(storage)) return closedGateStorage;
+  let probed;
+  try {
+    probed = storage.getItem(GATE_PROBE_KEY);
+  } catch {
+    syncGateAdapters.add(storage);
+    return storage;
+  }
+  if (probed != null && typeof probed.then === "function") {
+    asyncGateAdapters.add(storage);
+    try {
+      probed.then(void 0, () => {
+      });
+    } catch {
+    }
+    warnAsyncGateStorage();
+    return closedGateStorage;
+  }
+  syncGateAdapters.add(storage);
+  return storage;
+};
 var hasSeenGate = (key, storageOverride, testingOverride) => {
   if (testingOverride != null ? testingOverride : isCoachmarkTesting()) return false;
-  const storage = storageOverride != null ? storageOverride : getCoachmarkStorage();
+  const storage = validateGateStorage(storageOverride != null ? storageOverride : getCoachmarkStorage());
   if (!storage) return false;
   try {
     return storage.getItem(key) === SEEN_VALUE;
@@ -225,7 +306,7 @@ var hasSeenGate = (key, storageOverride, testingOverride) => {
 };
 var markSeenGate = (key, storageOverride, testingOverride) => {
   if (testingOverride != null ? testingOverride : isCoachmarkTesting()) return;
-  const storage = storageOverride != null ? storageOverride : getCoachmarkStorage();
+  const storage = validateGateStorage(storageOverride != null ? storageOverride : getCoachmarkStorage());
   if (!storage) return;
   try {
     storage.setItem(key, SEEN_VALUE);
@@ -962,22 +1043,28 @@ var CoachmarkProvider = ({
   featuresConfig,
   children
 }) => {
-  const flags = useResolvedFeatures({ flags: features, config: featuresConfig });
-  const coachmarksOn = flags.coachmarks.enabled;
+  const { flags, settled } = useResolvedFeaturesState({
+    flags: features,
+    config: featuresConfig
+  });
+  const coachmarksOn = settled ? flags.coachmarks.enabled : true;
   setCoachmarkStorage(storage);
   setCoachmarkTesting(isTestingCoachmark);
+  setCoachmarksResolved(settled);
   setCoachmarksEnabled(coachmarksOn);
   useEffect(() => {
     setCoachmarkStorage(storage);
     setCoachmarkTesting(isTestingCoachmark);
+    setCoachmarksResolved(settled);
     setCoachmarksEnabled(coachmarksOn);
     return () => {
       if (getCoachmarkStorage() === storage) {
         setCoachmarkStorage(null);
       }
       setCoachmarksEnabled(true);
+      setCoachmarksResolved(true);
     };
-  }, [storage, isTestingCoachmark, coachmarksOn]);
+  }, [storage, isTestingCoachmark, coachmarksOn, settled]);
   return /* @__PURE__ */ jsxs(Fragment, { children: [
     children,
     /* @__PURE__ */ jsx(
@@ -1080,6 +1167,11 @@ var useCoachmarkTour = (steps, {
     areCoachmarksEnabled,
     areCoachmarksEnabled
   );
+  const coachmarksResolved = useSyncExternalStore(
+    subscribeCoachmarksEnabled,
+    areCoachmarksResolved,
+    areCoachmarksResolved
+  );
   const exit = useCallback(
     (writeGate) => {
       if (finishedRef.current) return;
@@ -1094,14 +1186,16 @@ var useCoachmarkTour = (steps, {
   const finish = useCallback(() => exit(true), [exit]);
   useEffect(() => {
     if (!enabled || startedRef.current) return void 0;
+    if (steps.length === 0) return void 0;
     if (!coachmarksOn) return void 0;
+    if (!coachmarksResolved) return void 0;
     if (showOnce && hasSeenGate(coachmarkGateKey(tourId))) return void 0;
     const timer = setTimeout(() => {
       startedRef.current = true;
       setActiveIndex(0);
     }, startDelayMs);
     return () => clearTimeout(timer);
-  }, [enabled, coachmarksOn, startDelayMs, showOnce, tourId]);
+  }, [enabled, coachmarksOn, coachmarksResolved, startDelayMs, showOnce, tourId, steps.length]);
   useEffect(() => {
     if (activeIndex === null) return void 0;
     if (!coachmarksOn) {
@@ -1112,6 +1206,10 @@ var useCoachmarkTour = (steps, {
       if (startedRef.current && !finishedRef.current) coachmarkOverlay.hide();
       return void 0;
     }
+    if (steps.length === 0) {
+      exit(false);
+      return void 0;
+    }
     if (activeIndex >= steps.length) {
       finish();
       return void 0;