@okyrychenko-dev/react-action-guard 1.0.4 → 1.0.5

package/dist/index.d.cts

@@ -204,26 +204,6 @@ interface ShallowStoreBindings<StoreState> {
     useStoreApi: StoreApi<StoreState>;
 }
 
-declare const uiBlockingStoreApi: Omit<zustand.StoreApi<UIBlockingStore>, "setState" | "devtools"> & {
-    setState(partial: UIBlockingStore | Partial<UIBlockingStore> | ((state: UIBlockingStore) => UIBlockingStore | Partial<UIBlockingStore>), replace?: false | undefined, action?: (string | {
-        [x: string]: unknown;
-        [x: number]: unknown;
-        [x: symbol]: unknown;
-        type: string;
-    }) | undefined): void;
-    setState(state: UIBlockingStore | ((state: UIBlockingStore) => UIBlockingStore), replace: true, action?: (string | {
-        [x: string]: unknown;
-        [x: number]: unknown;
-        [x: symbol]: unknown;
-        type: string;
-    }) | undefined): void;
-    devtools: {
-        cleanup: () => void;
-    };
-};
-declare function useUIBlockingStore(): UIBlockingStore;
-declare function useUIBlockingStore<T>(selector: (state: UIBlockingStore) => T, equalityFn?: (a: T, b: T) => boolean): T;
-
 type BlockingAction = "add" | "update" | "remove" | "timeout" | "clear" | "clear_scope";
 type MiddlewareBlockerConfig = BlockerConfig;
 interface MiddlewareContext {
@@ -379,7 +359,7 @@ declare function configureMiddleware(middlewares: ReadonlyArray<Middleware>): vo
  *
  * Logs every blocker action (add, remove, update, timeout, clear) with emoji
  * indicators and formatted data. Useful for debugging blocking behavior during
- * development. Automatically disabled in production builds for performance.
+ * development. Register it conditionally when production logging is not desired.
  *
  * Output format: `[UIBlocking] 🔒 blocker-id {scope: "form", reason: "..."}`
  *
@@ -798,6 +778,26 @@ interface UseAsyncActionOptions {
  */
 declare function useAsyncAction<T = unknown>(actionId: string, scope?: string | ReadonlyArray<string>, options?: UseAsyncActionOptions): (asyncFn: () => Promise<T>) => Promise<T>;
 
+declare const uiBlockingStoreApi: Omit<zustand.StoreApi<UIBlockingStore>, "setState" | "devtools"> & {
+    setState(partial: UIBlockingStore | Partial<UIBlockingStore> | ((state: UIBlockingStore) => UIBlockingStore | Partial<UIBlockingStore>), replace?: false | undefined, action?: (string | {
+        [x: string]: unknown;
+        [x: number]: unknown;
+        [x: symbol]: unknown;
+        type: string;
+    }) | undefined): void;
+    setState(state: UIBlockingStore | ((state: UIBlockingStore) => UIBlockingStore), replace: true, action?: (string | {
+        [x: string]: unknown;
+        [x: number]: unknown;
+        [x: symbol]: unknown;
+        type: string;
+    }) | undefined): void;
+    devtools: {
+        cleanup: () => void;
+    };
+};
+declare function useUIBlockingStore(): UIBlockingStore;
+declare function useUIBlockingStore<T>(selector: (state: UIBlockingStore) => T, equalityFn?: (a: T, b: T) => boolean): T;
+
 /**
  * Automatically manages a UI blocker based on component lifecycle.
  *

package/dist/index.d.ts

@@ -204,26 +204,6 @@ interface ShallowStoreBindings<StoreState> {
     useStoreApi: StoreApi<StoreState>;
 }
 
-declare const uiBlockingStoreApi: Omit<zustand.StoreApi<UIBlockingStore>, "setState" | "devtools"> & {
-    setState(partial: UIBlockingStore | Partial<UIBlockingStore> | ((state: UIBlockingStore) => UIBlockingStore | Partial<UIBlockingStore>), replace?: false | undefined, action?: (string | {
-        [x: string]: unknown;
-        [x: number]: unknown;
-        [x: symbol]: unknown;
-        type: string;
-    }) | undefined): void;
-    setState(state: UIBlockingStore | ((state: UIBlockingStore) => UIBlockingStore), replace: true, action?: (string | {
-        [x: string]: unknown;
-        [x: number]: unknown;
-        [x: symbol]: unknown;
-        type: string;
-    }) | undefined): void;
-    devtools: {
-        cleanup: () => void;
-    };
-};
-declare function useUIBlockingStore(): UIBlockingStore;
-declare function useUIBlockingStore<T>(selector: (state: UIBlockingStore) => T, equalityFn?: (a: T, b: T) => boolean): T;
-
 type BlockingAction = "add" | "update" | "remove" | "timeout" | "clear" | "clear_scope";
 type MiddlewareBlockerConfig = BlockerConfig;
 interface MiddlewareContext {
@@ -379,7 +359,7 @@ declare function configureMiddleware(middlewares: ReadonlyArray<Middleware>): vo
  *
  * Logs every blocker action (add, remove, update, timeout, clear) with emoji
  * indicators and formatted data. Useful for debugging blocking behavior during
- * development. Automatically disabled in production builds for performance.
+ * development. Register it conditionally when production logging is not desired.
  *
  * Output format: `[UIBlocking] 🔒 blocker-id {scope: "form", reason: "..."}`
  *
@@ -798,6 +778,26 @@ interface UseAsyncActionOptions {
  */
 declare function useAsyncAction<T = unknown>(actionId: string, scope?: string | ReadonlyArray<string>, options?: UseAsyncActionOptions): (asyncFn: () => Promise<T>) => Promise<T>;
 
+declare const uiBlockingStoreApi: Omit<zustand.StoreApi<UIBlockingStore>, "setState" | "devtools"> & {
+    setState(partial: UIBlockingStore | Partial<UIBlockingStore> | ((state: UIBlockingStore) => UIBlockingStore | Partial<UIBlockingStore>), replace?: false | undefined, action?: (string | {
+        [x: string]: unknown;
+        [x: number]: unknown;
+        [x: symbol]: unknown;
+        type: string;
+    }) | undefined): void;
+    setState(state: UIBlockingStore | ((state: UIBlockingStore) => UIBlockingStore), replace: true, action?: (string | {
+        [x: string]: unknown;
+        [x: number]: unknown;
+        [x: symbol]: unknown;
+        type: string;
+    }) | undefined): void;
+    devtools: {
+        cleanup: () => void;
+    };
+};
+declare function useUIBlockingStore(): UIBlockingStore;
+declare function useUIBlockingStore<T>(selector: (state: UIBlockingStore) => T, equalityFn?: (a: T, b: T) => boolean): T;
+
 /**
  * Automatically manages a UI blocker based on component lifecycle.
  *

package/dist/index.js

@@ -4,7 +4,7 @@ import 'zustand/react/shallow';
 import { jsx } from 'react/jsx-runtime';
 import { useShallow, shallow } from 'zustand/shallow';
 import { devtools } from 'zustand/middleware';
-import { useRef, useCallback, useEffect, useMemo, useState } from 'react';
+import { useCallback, useRef, useMemo, useEffect, useState } from 'react';
 
 // src/context/UIBlockingContext.tsx
 
@@ -34,6 +34,16 @@ function createMiddlewareContext(action, blockerId, config, prevState) {
     ...prevState && { prevState }
   };
 }
+function toPublicBlockerConfig(blocker) {
+  return {
+    scope: blocker.scope,
+    reason: blocker.reason,
+    priority: blocker.priority,
+    timestamp: blocker.timestamp,
+    timeout: blocker.timeout,
+    onTimeout: blocker.onTimeout
+  };
+}
 var createUIBlockingActions = (set, get) => ({
   // State
   activeBlockers: /* @__PURE__ */ new Map(),
@@ -104,14 +114,15 @@ var createUIBlockingActions = (set, get) => ({
     let timeoutId;
     if (config.timeout && config.timeout > 0) {
       timeoutId = setTimeout(() => {
-        if (get().activeBlockers.has(id)) {
-          config.onTimeout?.(id);
+        const blocker = get().activeBlockers.get(id);
+        if (blocker) {
+          blocker.onTimeout?.(id);
           void get().runMiddlewares(
             createMiddlewareContext("timeout", id, {
-              scope: config.scope,
-              reason: config.reason,
-              priority: config.priority,
-              timeout: config.timeout
+              scope: blocker.scope,
+              reason: blocker.reason,
+              priority: blocker.priority,
+              timeout: blocker.timeout
             })
           );
           get().removeBlocker(id);
@@ -182,16 +193,16 @@ var createUIBlockingActions = (set, get) => ({
       }
       if (config.timeout && config.timeout > 0) {
         const newTimeout = config.timeout;
-        const newOnTimeout = config.onTimeout ?? existingBlocker.onTimeout;
         timeoutId = setTimeout(() => {
-          if (get().activeBlockers.has(id)) {
-            newOnTimeout?.(id);
+          const blocker = get().activeBlockers.get(id);
+          if (blocker) {
+            blocker.onTimeout?.(id);
             void get().runMiddlewares(
               createMiddlewareContext("timeout", id, {
-                scope: config.scope ?? existingBlocker.scope,
-                reason: config.reason ?? existingBlocker.reason,
-                priority: config.priority ?? existingBlocker.priority,
-                timeout: newTimeout
+                scope: blocker.scope,
+                reason: blocker.reason,
+                priority: blocker.priority,
+                timeout: blocker.timeout
               })
             );
             get().removeBlocker(id);
@@ -269,7 +280,8 @@ var createUIBlockingActions = (set, get) => ({
       return { activeBlockers: newBlockers };
     });
     if (prevBlocker) {
-      void get().runMiddlewares(createMiddlewareContext("remove", id, prevBlocker, prevBlocker));
+      const publicConfig = toPublicBlockerConfig(prevBlocker);
+      void get().runMiddlewares(createMiddlewareContext("remove", id, publicConfig, publicConfig));
     }
   },
   /**
@@ -501,16 +513,36 @@ function useResolvedValue(selector) {
   const store = useResolvedStoreApi();
   return useStore(store, useShallow(selector));
 }
+
+// src/store/blockerId.utils.ts
+var storeSequences = /* @__PURE__ */ new WeakMap();
+function allocateBlockerId(store, prefix) {
+  let sequence = storeSequences.get(store) ?? 0;
+  let blockerId;
+  do {
+    sequence += 1;
+    blockerId = `${prefix}-${String(sequence)}`;
+  } while (store.getState().activeBlockers.has(blockerId));
+  storeSequences.set(store, sequence);
+  return blockerId;
+}
+
+// src/hooks/useBlockerIdAllocator/useBlockerIdAllocator.ts
+function useBlockerIdAllocator() {
+  const store = useResolvedStoreApi();
+  return useCallback((prefix) => allocateBlockerId(store, prefix), [store]);
+}
+
+// src/hooks/useAsyncAction/useAsyncAction.ts
 function useAsyncAction(actionId, scope, options) {
+  const allocateBlockerId2 = useBlockerIdAllocator();
   const { addBlocker, removeBlocker } = useResolvedValue((state) => ({
     addBlocker: state.addBlocker,
     removeBlocker: state.removeBlocker
   }));
-  const counterRef = useRef(0);
   const executeWithBlocking = useCallback(
     async (asyncFn) => {
-      counterRef.current += 1;
-      const blockerId = `${actionId}-${String(counterRef.current)}`;
+      const blockerId = allocateBlockerId2(actionId);
       try {
         addBlocker(blockerId, {
           scope,
@@ -524,7 +556,15 @@ function useAsyncAction(actionId, scope, options) {
         removeBlocker(blockerId);
       }
     },
-    [actionId, scope, options?.timeout, options?.onTimeout, addBlocker, removeBlocker]
+    [
+      actionId,
+      scope,
+      options?.timeout,
+      options?.onTimeout,
+      allocateBlockerId2,
+      addBlocker,
+      removeBlocker
+    ]
   );
   return executeWithBlocking;
 }
@@ -569,12 +609,24 @@ function useBlocker(blockerId, config, isActive = true) {
     updateBlocker: state.updateBlocker
   }));
   const lastConfigRef = useRef(null);
+  const onTimeoutRef = useRef(config.onTimeout);
+  onTimeoutRef.current = config.onTimeout;
+  const handleTimeout = useCallback((id) => {
+    onTimeoutRef.current?.(id);
+  }, []);
+  const storeConfig = useMemo(
+    () => ({
+      ...config,
+      onTimeout: config.onTimeout ? handleTimeout : void 0
+    }),
+    [config, handleTimeout]
+  );
   useEffect(() => {
     if (!isActive || !blockerId) {
       return;
     }
-    addBlocker(blockerId, config);
-    lastConfigRef.current = config;
+    addBlocker(blockerId, storeConfig);
+    lastConfigRef.current = storeConfig;
     return () => {
       lastConfigRef.current = null;
       removeBlocker(blockerId);
@@ -584,12 +636,12 @@ function useBlocker(blockerId, config, isActive = true) {
     if (!isActive || !blockerId) {
       return;
     }
-    if (lastConfigRef.current !== null && areBlockerConfigsEqual(lastConfigRef.current, config)) {
+    if (lastConfigRef.current !== null && areBlockerConfigsEqual(lastConfigRef.current, storeConfig)) {
       return;
     }
-    updateBlocker(blockerId, config);
-    lastConfigRef.current = config;
-  }, [blockerId, config, isActive, updateBlocker]);
+    updateBlocker(blockerId, storeConfig);
+    lastConfigRef.current = storeConfig;
+  }, [blockerId, storeConfig, isActive, updateBlocker]);
 }
 function useBlockingInfo(scope = DEFAULT_SCOPE) {
   const store = useResolvedStoreApi();
@@ -607,6 +659,7 @@ function useConfigRef(config) {
 }
 
 // src/hooks/useConditionalBlocker/useConditionalBlocker.ts
+var DEFAULT_CHECK_INTERVAL = 1e3;
 function useConditionalBlocker(blockerId, config) {
   const { addBlocker, removeBlocker } = useResolvedValue((state) => ({
     addBlocker: state.addBlocker,
@@ -615,6 +668,7 @@ function useConditionalBlocker(blockerId, config) {
   const intervalRef = useRef(null);
   const isBlockedRef = useRef(false);
   const configRef = useConfigRef(config);
+  const checkInterval = config.checkInterval !== void 0 && config.checkInterval > 0 ? config.checkInterval : DEFAULT_CHECK_INTERVAL;
   const checkCondition = useCallback(() => {
     const currentConfig = configRef.current;
     const shouldBlock = currentConfig.condition(currentConfig.state);
@@ -630,8 +684,7 @@ function useConditionalBlocker(blockerId, config) {
   }, [blockerId, addBlocker, removeBlocker, configRef]);
   useEffect(() => {
     checkCondition();
-    const interval = configRef.current.checkInterval ?? 1e3;
-    intervalRef.current = setInterval(checkCondition, interval);
+    intervalRef.current = setInterval(checkCondition, checkInterval);
     return () => {
       if (intervalRef.current) {
         clearInterval(intervalRef.current);
@@ -642,7 +695,7 @@ function useConditionalBlocker(blockerId, config) {
         isBlockedRef.current = false;
       }
     };
-  }, [checkCondition, blockerId, removeBlocker]);
+  }, [checkCondition, blockerId, removeBlocker, checkInterval]);
 }
 function useConfirmableBlocker(blockerId, config) {
   const [isDialogOpen, setIsDialogOpen] = useState(false);
@@ -736,6 +789,9 @@ function useScheduledBlocker(blockerId, config) {
   }));
   const timeoutsRef = useRef({});
   const configRef = useConfigRef(config);
+  const scheduleStart = parseDate(config.schedule.start);
+  const scheduleEnd = config.schedule.end === void 0 ? void 0 : parseDate(config.schedule.end);
+  const scheduleDuration = config.schedule.duration;
   const cleanup = useCallback(() => {
     if (timeoutsRef.current.start) {
       clearTimeout(timeoutsRef.current.start);
@@ -753,7 +809,7 @@ function useScheduledBlocker(blockerId, config) {
     if (!isValidTimestamp(startTime)) {
       return;
     }
-    const scheduleEnd = () => {
+    const scheduleEnd2 = () => {
       const endTime = calculateEndTime(currentConfig.schedule, startTime);
       if (!endTime) {
         return;
@@ -770,7 +826,7 @@ function useScheduledBlocker(blockerId, config) {
       const cfg = configRef.current;
       addBlocker(blockerId, createBlockerConfig(cfg));
       cfg.onScheduleStart?.();
-      scheduleEnd();
+      scheduleEnd2();
     };
     if (startTime > now) {
       const delay = startTime - now;
@@ -790,7 +846,16 @@ function useScheduledBlocker(blockerId, config) {
       cleanup();
       removeBlocker(blockerId);
     };
-  }, [blockerId, addBlocker, removeBlocker, cleanup]);
+  }, [
+    blockerId,
+    addBlocker,
+    removeBlocker,
+    cleanup,
+    scheduleStart,
+    scheduleEnd,
+    scheduleDuration,
+    configRef
+  ]);
 }
 
 // src/middleware/analyticsMiddleware.utils.ts