@applicaster/zapp-react-native-utils 15.0.0-alpha.5485312433 → 15.0.0-alpha.5531846549

package/time/__tests__/Timer.test.ts

@@ -0,0 +1,236 @@
+import { Timer } from "../Timer";
+import BackgroundTimer from "../BackgroundTimer";
+
+// Mock BackgroundTimer
+jest.mock("../BackgroundTimer", () => ({
+  __esModule: true,
+  default: {
+    setTimeout: jest.fn((callback, delay) => {
+      return setTimeout(callback, delay);
+    }),
+    clearTimeout: jest.fn((id) => {
+      clearTimeout(id as NodeJS.Timeout);
+    }),
+  },
+}));
+
+describe("Timer", () => {
+  let mockCallback: jest.Mock;
+
+  beforeEach(() => {
+    jest.clearAllMocks();
+    jest.useFakeTimers();
+    mockCallback = jest.fn();
+  });
+
+  afterEach(() => {
+    jest.useRealTimers();
+  });
+
+  describe("constructor", () => {
+    it("should create timer with callback and remaining time", () => {
+      const timer = new Timer(mockCallback, 1000);
+
+      expect(timer).toBeInstanceOf(Timer);
+    });
+
+    it("should create timer with callback only (optional remaining param)", () => {
+      const timer = new Timer(mockCallback);
+
+      expect(timer).toBeInstanceOf(Timer);
+    });
+
+    it("should not start automatically", () => {
+      // eslint-disable-next-line no-new
+      new Timer(mockCallback, 1000);
+
+      expect(BackgroundTimer.setTimeout).not.toHaveBeenCalled();
+    });
+  });
+
+  describe("start", () => {
+    it("should call setTimeout with callback and remaining time", () => {
+      const timer = new Timer(mockCallback, 1000);
+
+      timer.start();
+
+      expect(BackgroundTimer.setTimeout).toHaveBeenCalledWith(
+        mockCallback,
+        1000
+      );
+    });
+
+    it("should reset remaining time to 0 after starting", () => {
+      const timer = new Timer(mockCallback, 5000);
+
+      timer.start();
+      timer.clear();
+      timer.start();
+
+      expect(BackgroundTimer.setTimeout).toHaveBeenCalledTimes(2);
+    });
+  });
+
+  describe("pause", () => {
+    it("should clear timeout and calculate remaining time correctly", () => {
+      const startTime = 1000;
+      const pauseTime = 1500;
+
+      jest
+        .spyOn(Date, "now")
+        .mockReturnValueOnce(startTime) // start
+        .mockReturnValueOnce(pauseTime); // pause
+
+      const timer = new Timer(mockCallback, 2000);
+
+      timer.start();
+      timer.pause();
+
+      expect(BackgroundTimer.clearTimeout).toHaveBeenCalled();
+    });
+
+    it("should be safe to call pause multiple times", () => {
+      const timer = new Timer(mockCallback, 1000);
+
+      timer.start();
+      timer.pause();
+      timer.pause();
+
+      expect(BackgroundTimer.clearTimeout).toHaveBeenCalledTimes(2);
+    });
+  });
+
+  describe("resume", () => {
+    it("should restart timer with remaining time after pause", () => {
+      const startTime = 1000;
+      const pauseTime = 1500;
+
+      jest
+        .spyOn(Date, "now")
+        .mockReturnValueOnce(startTime)
+        .mockReturnValueOnce(pauseTime);
+
+      const timer = new Timer(mockCallback, 2000);
+
+      timer.start();
+      timer.pause();
+      timer.resume();
+
+      expect(BackgroundTimer.setTimeout).toHaveBeenCalledTimes(2);
+    });
+
+    it("should be callable without prior pause", () => {
+      const timer = new Timer(mockCallback, 1000);
+
+      timer.resume();
+
+      expect(BackgroundTimer.setTimeout).toHaveBeenCalled();
+    });
+  });
+
+  describe("clear", () => {
+    it("should clear timeout and be safe to call without starting timer", () => {
+      const timer = new Timer(mockCallback, 1000);
+
+      expect(() => {
+        timer.clear();
+      }).not.toThrow();
+
+      expect(BackgroundTimer.clearTimeout).toHaveBeenCalled();
+    });
+
+    it("should be callable multiple times", () => {
+      const timer = new Timer(mockCallback, 1000);
+
+      timer.start();
+      timer.clear();
+      timer.clear();
+
+      expect(BackgroundTimer.clearTimeout).toHaveBeenCalledTimes(2);
+    });
+  });
+
+  describe("timer lifecycle", () => {
+    it("should support complete lifecycle: start -> pause -> resume -> clear", () => {
+      const timer = new Timer(mockCallback, 1000);
+
+      timer.start();
+      expect(BackgroundTimer.setTimeout).toHaveBeenCalledTimes(1);
+
+      timer.pause();
+      expect(BackgroundTimer.clearTimeout).toHaveBeenCalledTimes(1);
+
+      timer.resume();
+      expect(BackgroundTimer.setTimeout).toHaveBeenCalledTimes(2);
+
+      timer.clear();
+      expect(BackgroundTimer.clearTimeout).toHaveBeenCalledTimes(2);
+    });
+  });
+
+  describe("edge cases", () => {
+    it("should handle zero delay", () => {
+      const timer = new Timer(mockCallback, 0);
+
+      timer.start();
+
+      expect(BackgroundTimer.setTimeout).toHaveBeenCalledWith(mockCallback, 0);
+    });
+
+    it("should handle very long delays", () => {
+      const longDelay = Number.MAX_SAFE_INTEGER;
+      const timer = new Timer(mockCallback, longDelay);
+
+      timer.start();
+
+      expect(BackgroundTimer.setTimeout).toHaveBeenCalledWith(
+        mockCallback,
+        longDelay
+      );
+    });
+
+    it("should handle negative delays gracefully", () => {
+      const timer = new Timer(mockCallback, -1000);
+
+      expect(() => {
+        timer.start();
+      }).not.toThrow();
+    });
+
+    it("should maintain callback reference through lifecycle", () => {
+      const specificCallback = jest.fn();
+      const timer = new Timer(specificCallback, 1000);
+
+      timer.start();
+
+      expect(BackgroundTimer.setTimeout).toHaveBeenCalledWith(
+        specificCallback,
+        1000
+      );
+    });
+  });
+
+  describe("callback execution safety", () => {
+    it("should not execute callback immediately on start", () => {
+      const timer = new Timer(mockCallback, 1000);
+
+      timer.start();
+
+      expect(mockCallback).not.toHaveBeenCalled();
+    });
+
+    it("should not execute callback when paused or cleared", () => {
+      const timer1 = new Timer(mockCallback, 100);
+      const timer2 = new Timer(mockCallback, 100);
+
+      timer1.start();
+      timer1.pause();
+      timer2.start();
+      timer2.clear();
+
+      jest.advanceTimersByTime(200);
+
+      expect(mockCallback).not.toHaveBeenCalled();
+    });
+  });
+});

package/typeGuards/__tests__/isString.test.ts

@@ -0,0 +1,21 @@
+import { isString } from "../index";
+
+describe("isString", () => {
+  it("should return true for string primitives", () => {
+    expect(isString("hello")).toBe(true);
+    expect(isString("")).toBe(true);
+  });
+
+  it("should return true for String object instances", () => {
+    // eslint-disable-next-line no-new-wrappers
+    expect(isString(new String("test"))).toBe(true);
+  });
+
+  it("should return false for non-string values", () => {
+    expect(isString(123)).toBe(false);
+    expect(isString(null)).toBe(false);
+    expect(isString(undefined)).toBe(false);
+    expect(isString({})).toBe(false);
+    expect(isString([])).toBe(false);
+  });
+});

package/typeGuards/index.ts

@@ -1,3 +1,7 @@
 export const isString = (value: unknown) => {
+  if (typeof value === "object" && value instanceof String) {
+    return true;
+  }
+
   return typeof value === "string";
 };

package/utils/__tests__/clone.test.ts

@@ -0,0 +1,158 @@
+import { clone } from "../clone";
+
+describe("clone", () => {
+  const originalStructuredClone = global.structuredClone;
+
+  afterEach(() => {
+    // Restore the original structuredClone after each test
+    global.structuredClone = originalStructuredClone;
+  });
+
+  describe("when structuredClone is available", () => {
+    beforeEach(() => {
+      // Mock structuredClone if it's not available
+      if (typeof global.structuredClone === "undefined") {
+        global.structuredClone = jest.fn((value) =>
+          JSON.parse(JSON.stringify(value))
+        );
+      }
+    });
+
+    test("clones primitive values", () => {
+      expect(clone(42)).toBe(42);
+      expect(clone("test")).toBe("test");
+      expect(clone(true)).toBe(true);
+      expect(clone(null)).toBe(null);
+    });
+
+    test("clones simple objects", () => {
+      const original = { a: 1, b: 2 };
+      const cloned = clone(original);
+
+      expect(cloned).toEqual(original);
+      expect(cloned).not.toBe(original);
+    });
+
+    test("clones nested objects", () => {
+      const original = { a: { b: { c: 1 } } };
+      const cloned = clone(original);
+
+      expect(cloned).toEqual(original);
+      expect(cloned).not.toBe(original);
+      expect(cloned.a).not.toBe(original.a);
+      expect(cloned.a.b).not.toBe(original.a.b);
+    });
+
+    test("clones arrays", () => {
+      const original = [1, 2, 3];
+      const cloned = clone(original);
+
+      expect(cloned).toEqual(original);
+      expect(cloned).not.toBe(original);
+    });
+
+    test("clones arrays with nested objects", () => {
+      const original = [{ a: 1 }, { b: 2 }];
+      const cloned = clone(original);
+
+      expect(cloned).toEqual(original);
+      expect(cloned).not.toBe(original);
+      expect(cloned[0]).not.toBe(original[0]);
+      expect(cloned[1]).not.toBe(original[1]);
+    });
+
+    test("does not mutate the original value", () => {
+      const original = { a: 1, b: { c: 2 } };
+      const cloned = clone(original);
+
+      cloned.a = 99;
+      cloned.b.c = 99;
+
+      expect(original.a).toBe(1);
+      expect(original.b.c).toBe(2);
+    });
+  });
+
+  describe("when structuredClone is not available (fallback to cloneDeep)", () => {
+    beforeEach(() => {
+      // Delete structuredClone to force fallback to cloneDeep
+      delete (global as any).structuredClone;
+    });
+
+    test("clones primitive values using cloneDeep", () => {
+      expect(clone(42)).toBe(42);
+      expect(clone("test")).toBe("test");
+      expect(clone(true)).toBe(true);
+      expect(clone(null)).toBe(null);
+    });
+
+    test("clones simple objects using cloneDeep", () => {
+      const original = { a: 1, b: 2 };
+      const cloned = clone(original);
+
+      expect(cloned).toEqual(original);
+      expect(cloned).not.toBe(original);
+    });
+
+    test("clones nested objects using cloneDeep", () => {
+      const original = { a: { b: { c: 1 } } };
+      const cloned = clone(original);
+
+      expect(cloned).toEqual(original);
+      expect(cloned).not.toBe(original);
+      expect(cloned.a).not.toBe(original.a);
+      expect(cloned.a.b).not.toBe(original.a.b);
+    });
+
+    test("clones arrays using cloneDeep", () => {
+      const original = [1, 2, 3];
+      const cloned = clone(original);
+
+      expect(cloned).toEqual(original);
+      expect(cloned).not.toBe(original);
+    });
+
+    test("clones arrays with nested objects using cloneDeep", () => {
+      const original = [{ a: 1 }, { b: 2 }];
+      const cloned = clone(original);
+
+      expect(cloned).toEqual(original);
+      expect(cloned).not.toBe(original);
+      expect(cloned[0]).not.toBe(original[0]);
+      expect(cloned[1]).not.toBe(original[1]);
+    });
+
+    test("does not mutate the original value when using cloneDeep", () => {
+      const original = { a: 1, b: { c: 2 } };
+      const cloned = clone(original);
+
+      cloned.a = 99;
+      cloned.b.c = 99;
+
+      expect(original.a).toBe(1);
+      expect(original.b.c).toBe(2);
+    });
+
+    test("handles complex objects with multiple levels", () => {
+      const original = {
+        name: "test",
+        data: {
+          items: [
+            { id: 1, value: "a" },
+            { id: 2, value: "b" },
+          ],
+          meta: { count: 2 },
+        },
+      };
+
+      const cloned = clone(original);
+
+      expect(cloned).toEqual(original);
+      expect(cloned).not.toBe(original);
+      expect(cloned.data).not.toBe(original.data);
+      expect(cloned.data.items).not.toBe(original.data.items);
+      expect(cloned.data.items[0]).not.toBe(original.data.items[0]);
+      expect(cloned.data.meta).not.toBe(original.data.meta);
+    });
+  });
+});

package/utils/__tests__/path.test.ts

@@ -31,3 +31,10 @@ test("example 4", () => {
 
   expect(path(route, xs)).toBeUndefined();
 });
+
+test("example 5", () => {
+  const route = ["a", "b", 0];
+  const xs = { a: { b: [1, 2, 3] } };
+
+  expect(path(route, xs)).toBe(1);
+});

package/utils/clone.ts

@@ -0,0 +1,7 @@
+import { cloneDeep } from "lodash";
+
+export const clone = (value) => {
+  return typeof structuredClone !== "undefined"
+    ? structuredClone(value) // no support for hermes, fallback to cloneDeep
+    : cloneDeep(value);
+};

package/utils/index.ts

@@ -20,8 +20,9 @@ export { mapAccum } from "./mapAccum";
 
 export { mergeRight } from "./mergeRight";
 
+export { clone } from "./clone";
+
 export {
-  cloneDeep as clone,
   flatten,
   drop,
   size,

package/reactHooks/componentsMap/index.ts

@@ -1,55 +0,0 @@
-import * as React from "react";
-
-const layoutReducer = (state, { payload }) => {
-  return state.map((item, index, _state) => ({
-    height: index === payload.index ? payload.height : item.height,
-    y:
-      index > 0
-        ? _state.slice(0, index).reduce((acc, value) => acc + value.height, 0)
-        : 0,
-  }));
-};
-
-export const useComponentsLayout = (count, onFinishLoadingVisible) => {
-  const [itemsLayout, dispatchItemLayout] = React.useReducer(
-    layoutReducer,
-    Array.from({ length: count }, () => ({ height: 0, y: 0 }))
-  );
-
-  const notified = React.useRef(false);
-  const [listHeight, setListHeight] = React.useState<number>(0);
-
-  const onItemLayout = React.useCallback(
-    (index) => (event) => {
-      const { height } = event.nativeEvent.layout;
-      dispatchItemLayout({ payload: { index, height } });
-    },
-    []
-  );
-
-  const onListLayout = React.useCallback((event) => {
-    const { height } = event.nativeEvent.layout;
-    setListHeight(height);
-  }, []);
-
-  React.useEffect(() => {
-    if (!notified.current) {
-      const finishLoadingVisible = !!itemsLayout.find(
-        (item) => item.y > listHeight
-      );
-
-      if (finishLoadingVisible) {
-        notified.current = true;
-        onFinishLoadingVisible?.();
-      }
-    }
-  }, [itemsLayout, listHeight]);
-
-  return React.useMemo(
-    () => ({
-      onItemLayout,
-      onListLayout,
-    }),
-    []
-  );
-};

package/reactHooks/feed/__tests__/useFeedRefresh.test.tsx

@@ -1,75 +0,0 @@
-import { renderHook } from "@testing-library/react-native";
-
-jest.useFakeTimers();
-
-jest.mock("@applicaster/zapp-react-native-utils/reactHooks/navigation", () => ({
-  useIsScreenActive: () => true,
-}));
-
-const { useFeedRefresh, feedRefreshLogger } = require("..");
-
-describe("useFeedRefresh", () => {
-  const reloadData = jest.fn();
-
-  const component = {
-    id: "foo",
-    rules: { enable_data_refreshing: true, refreshing_interval: 61 },
-  };
-
-  it("Calls reloadData after passed time lapses", () => {
-    renderHook(() => useFeedRefresh({ reloadData, component }));
-
-    expect(reloadData).not.toBeCalled();
-    jest.runOnlyPendingTimers();
-    expect(reloadData).toBeCalled();
-  });
-
-  it("Logs warning message if refresh time set below minimum value", () => {
-    const loggerSpy = jest.spyOn(feedRefreshLogger, "warning");
-
-    renderHook(() =>
-      useFeedRefresh({
-        reloadData,
-        component: {
-          ...component,
-          rules: { enable_data_refreshing: true, refreshing_interval: 2 },
-        },
-      })
-    );
-
-    expect(loggerSpy).toBeCalled();
-  });
-
-  it("Calls reloadData on a Component that had a timer setup and was re-mounted", () => {
-    reloadData.mockReset();
-
-    // it is not called before rendering hook"
-    expect(reloadData).not.toBeCalled();
-
-    // it is not called when rendering new component (Not previously rendered)
-    renderHook(() =>
-      useFeedRefresh({ reloadData, component: { ...component, id: "bar" } })
-    );
-
-    expect(reloadData).not.toBeCalled();
-
-    // it is called when rendering previously rendered component",
-    renderHook(() => useFeedRefresh({ reloadData, component }));
-    expect(reloadData).toBeCalled();
-  });
-
-  it("Doesn't refresh data when enable_data_refreshing if false", () => {
-    reloadData.mockReset();
-
-    renderHook(() =>
-      useFeedRefresh({
-        reloadData,
-        component: { ...component, rules: { enable_data_refreshing: false } },
-      })
-    );
-
-    jest.runOnlyPendingTimers();
-
-    expect(reloadData).not.toBeCalled();
-  });
-});

package/reactHooks/feed/useFeedRefresh.tsx

@@ -1,65 +0,0 @@
-import * as React from "react";
-import { path, max } from "ramda";
-import { isTrue } from "@applicaster/zapp-react-native-utils/booleanUtils";
-import { toNumberWithDefault } from "@applicaster/zapp-react-native-utils/numberUtils";
-import { useIsScreenActive } from "@applicaster/zapp-react-native-utils/reactHooks/navigation";
-
-import { reactHooksLogger } from "../logger";
-import { ReloadDataFunction } from "./useFeedLoader";
-
-export const feedRefreshLogger = reactHooksLogger.addSubsystem("feed-refresh");
-
-type Props = {
-  reloadData?: ReloadDataFunction;
-  component: ZappUIComponent;
-};
-
-const previousTimersMap = {};
-const minimumRefreshingInterval = 5;
-const defaultRefreshInterval = 60;
-
-export const useFeedRefresh = ({ reloadData, component }: Props): void => {
-  const isDataRefreshingEnabled = isTrue(
-    path(["rules", "enable_data_refreshing"], component)
-  );
-
-  const refreshing_interval = toNumberWithDefault(
-    defaultRefreshInterval,
-    component?.rules?.refreshing_interval
-  );
-
-  const refreshingIntervalInMilliseconds =
-    max(refreshing_interval, minimumRefreshingInterval) * 1000;
-
-  const isScreenActive = useIsScreenActive();
-
-  React.useEffect(() => {
-    if (isDataRefreshingEnabled && refreshing_interval && isScreenActive) {
-      if (refreshing_interval < minimumRefreshingInterval) {
-        feedRefreshLogger.warning({
-          message: `You set your feed refresh interval to ${refreshing_interval} when minimum value is ${minimumRefreshingInterval}seconds.Your feed will refresh after ${minimumRefreshingInterval}seconds.`,
-        });
-      }
-
-      if (!reloadData || typeof reloadData !== "function") {
-        feedRefreshLogger.warning({
-          message:
-            "reloadData function is undefined, feed refresh feature won't work properly",
-        });
-      }
-
-      if (previousTimersMap[component?.id]) {
-        reloadData?.();
-      }
-
-      const refreshInterval = setInterval(() => {
-        reloadData?.();
-      }, refreshingIntervalInMilliseconds);
-
-      return () => {
-        previousTimersMap[component?.id] = true;
-        clearInterval(refreshInterval);
-      };
-    }
-  }, [reloadData, isScreenActive]);
-};