@lodev09/react-native-true-sheet 4.0.0-beta.0 → 4.0.0-beta.2

package/src/mocks/navigation.ts

@@ -0,0 +1,79 @@
+import type { ParamListBase } from '@react-navigation/native';
+
+import type { TrueSheetNavigationProp } from '../navigation/types';
+
+/**
+ * Mock createTrueSheetNavigator for testing.
+ * Import from '@lodev09/react-native-true-sheet/navigation/mock' in your test setup.
+ */
+export const createTrueSheetNavigator = jest.fn(() => ({
+  Navigator: jest.fn(({ children }: { children: React.ReactNode }) => children),
+  Screen: jest.fn(() => null),
+  Group: jest.fn(() => null),
+}));
+
+/**
+ * Mock createTrueSheetScreen for testing the static API.
+ */
+export const createTrueSheetScreen = jest.fn((config: object) => config);
+
+/**
+ * Mock TrueSheetActions for testing.
+ */
+export const TrueSheetActions = {
+  push: jest.fn((name: string, params?: object) => ({ type: 'PUSH', payload: { name, params } })),
+  pop: jest.fn((count?: number) => ({ type: 'POP', payload: { count } })),
+  popTo: jest.fn((name: string, params?: object) => ({
+    type: 'POP_TO',
+    payload: { name, params },
+  })),
+  popToTop: jest.fn(() => ({ type: 'POP_TO_TOP' })),
+  replace: jest.fn((name: string, params?: object) => ({
+    type: 'REPLACE',
+    payload: { name, params },
+  })),
+  resize: jest.fn((index: number) => ({ type: 'RESIZE', index })),
+  dismiss: jest.fn(() => ({ type: 'DISMISS' })),
+  remove: jest.fn(() => ({ type: 'REMOVE' })),
+};
+
+/**
+ * Mock useTrueSheetNavigation hook for testing.
+ */
+export const useTrueSheetNavigation = jest.fn(<T extends ParamListBase = ParamListBase>() => {
+  // Partial drops react-navigation's private-brand member (PrivateValueStore),
+  // which no mock can implement — the members themselves stay type-checked.
+  const navigation: Partial<TrueSheetNavigationProp<T>> = {
+    navigate: jest.fn(),
+    goBack: jest.fn(),
+    reset: jest.fn(),
+    setParams: jest.fn(),
+    dispatch: jest.fn(),
+    isFocused: jest.fn(() => true),
+    canGoBack: jest.fn(() => true),
+    getId: jest.fn(),
+    getParent: jest.fn(),
+    getState: jest.fn(),
+    addListener: jest.fn(() => jest.fn()),
+    removeListener: jest.fn(),
+    setOptions: jest.fn(),
+    push: jest.fn(),
+    pop: jest.fn(),
+    popTo: jest.fn(),
+    popToTop: jest.fn(),
+    replace: jest.fn(),
+    resize: jest.fn(),
+  };
+  return navigation as TrueSheetNavigationProp<T>;
+});
+
+export type { TrueSheetActionType } from '../navigation/actions';
+export type { DetentInfoEventPayload, PositionChangeEventPayload } from '../TrueSheet.types';
+export type {
+  TrueSheetNavigationEventMap,
+  TrueSheetNavigationHelpers,
+  TrueSheetNavigationOptions,
+  TrueSheetNavigationProp,
+  TrueSheetNavigationState,
+  TrueSheetScreenProps,
+} from '../navigation/types';

package/src/mocks/navigationExpoRouter.ts

@@ -0,0 +1,40 @@
+import type { ParamListBase } from '@react-navigation/native';
+
+import type { TrueSheetNavigationProp } from '../navigation/types';
+import {
+  TrueSheetActions,
+  useTrueSheetNavigation as useTrueSheetNavigationMock,
+} from './navigation';
+
+/**
+ * Mock Sheet layout for testing.
+ * Import from '@lodev09/react-native-true-sheet/navigation/expo-router/mock' in your test setup.
+ */
+export const Sheet = Object.assign(
+  jest.fn(({ children }: { children: React.ReactNode }) => children),
+  {
+    Screen: jest.fn(() => null),
+    Protected: jest.fn(() => null),
+  }
+);
+
+/**
+ * Mock useTrueSheetNavigation hook for testing.
+ */
+export const useTrueSheetNavigation = jest.fn(
+  <T extends ParamListBase = ParamListBase>(): TrueSheetNavigationProp<T> =>
+    useTrueSheetNavigationMock() as TrueSheetNavigationProp<T>
+);
+
+export { TrueSheetActions };
+
+export type { TrueSheetActionType } from '../navigation/actions';
+export type { DetentInfoEventPayload, PositionChangeEventPayload } from '../TrueSheet.types';
+export type {
+  TrueSheetNavigationEventMap,
+  TrueSheetNavigationHelpers,
+  TrueSheetNavigationOptions,
+  TrueSheetNavigationProp,
+  TrueSheetNavigationState,
+  TrueSheetScreenProps,
+} from '../navigation/types';

package/src/mocks/reanimated.ts

@@ -0,0 +1,100 @@
+import React, { createElement, isValidElement, type ReactNode } from 'react';
+import { View } from 'react-native';
+import type { SharedValue } from 'react-native-reanimated';
+
+import type { TrueSheetProps, PositionChangeEventPayload } from '../TrueSheet.types';
+
+interface TrueSheetState {
+  shouldRenderNativeView: boolean;
+}
+
+interface MockReanimatedTrueSheetContextValue {
+  animatedPosition: SharedValue<number>;
+  animatedIndex: SharedValue<number>;
+  animatedDetent: SharedValue<number>;
+}
+
+const createMockSharedValue = <T>(initialValue: T): SharedValue<T> => ({
+  value: initialValue,
+  get: () => initialValue,
+  set: () => {},
+  addListener: () => {},
+  removeListener: () => {},
+  modify: () => {},
+});
+
+/**
+ * Mock ReanimatedTrueSheet component for testing.
+ * Import from '@lodev09/react-native-true-sheet/reanimated/mock' in your test setup.
+ */
+export class ReanimatedTrueSheet extends React.Component<TrueSheetProps, TrueSheetState> {
+  static instances: Record<string, ReanimatedTrueSheet> = {};
+
+  static dismiss = jest.fn((_name: string, _animated?: boolean) => Promise.resolve());
+  static dismissStack = jest.fn((_name: string, _animated?: boolean) => Promise.resolve());
+  static present = jest.fn((_name: string, _index?: number, _animated?: boolean) =>
+    Promise.resolve()
+  );
+  static resize = jest.fn((_name: string, _index: number) => Promise.resolve());
+
+  dismiss = jest.fn((_animated?: boolean) => Promise.resolve());
+  dismissStack = jest.fn((_animated?: boolean) => Promise.resolve());
+  present = jest.fn((_index?: number, _animated?: boolean) => Promise.resolve());
+  resize = jest.fn((_index: number) => Promise.resolve());
+
+  componentDidMount() {
+    const { name } = this.props;
+    if (name) {
+      ReanimatedTrueSheet.instances[name] = this;
+    }
+  }
+
+  componentWillUnmount() {
+    const { name } = this.props;
+    if (name) {
+      delete ReanimatedTrueSheet.instances[name];
+    }
+  }
+
+  private renderHeader(): ReactNode {
+    const { header } = this.props;
+    if (!header) return null;
+    return isValidElement(header) ? header : createElement(header);
+  }
+
+  private renderFooter(): ReactNode {
+    const { footer } = this.props;
+    if (!footer) return null;
+    return isValidElement(footer) ? footer : createElement(footer);
+  }
+
+  render() {
+    const { children, style } = this.props;
+    return React.createElement(View, { style }, this.renderHeader(), children, this.renderFooter());
+  }
+}
+
+/**
+ * Mock ReanimatedTrueSheetProvider for testing.
+ */
+export function ReanimatedTrueSheetProvider({ children }: { children: React.ReactNode }) {
+  return children;
+}
+
+/**
+ * Mock useReanimatedTrueSheet hook for testing.
+ */
+export const useReanimatedTrueSheet = jest.fn(
+  (): MockReanimatedTrueSheetContextValue => ({
+    animatedPosition: createMockSharedValue(0),
+    animatedIndex: createMockSharedValue(-1),
+    animatedDetent: createMockSharedValue(0),
+  })
+);
+
+/**
+ * Mock useReanimatedPositionChangeHandler hook for testing.
+ */
+export const useReanimatedPositionChangeHandler = jest.fn(
+  (_handler: (payload: PositionChangeEventPayload) => void, _dependencies?: unknown[]) => jest.fn()
+);

package/src/navigation/TrueSheetNavigatorContent.tsx

@@ -0,0 +1,106 @@
+import type { NavigatorArgs } from 'standard-navigation';
+
+import type {
+  TrueSheetNavigationOptions,
+  TrueSheetNavigatorContentExtraProps,
+  TrueSheetStandardEventMap,
+} from './types';
+import { TrueSheetScreen, type TrueSheetScreenProps } from './screen';
+
+let ReanimatedTrueSheetScreen: React.ComponentType<TrueSheetScreenProps> | null = null;
+
+const getReanimatedScreen = (): React.ComponentType<TrueSheetScreenProps> => {
+  if (!ReanimatedTrueSheetScreen) {
+    ReanimatedTrueSheetScreen =
+      require('./screen/ReanimatedTrueSheetScreen').ReanimatedTrueSheetScreen;
+  }
+  return ReanimatedTrueSheetScreen!;
+};
+
+const DEFAULT_DETENTS: ('auto' | number)[] = ['auto'];
+
+const clampDetentIndex = (index: number, detentsLength: number): number =>
+  Math.min(index, Math.max(detentsLength - 1, 0));
+
+export type TrueSheetNavigatorContentProps = NavigatorArgs<
+  TrueSheetNavigationOptions,
+  TrueSheetStandardEventMap
+> &
+  TrueSheetNavigatorContentExtraProps;
+
+export const TrueSheetNavigatorContent = ({
+  routes,
+  dispatch,
+  descriptors,
+  emitter,
+}: TrueSheetNavigatorContentProps) => {
+  // First route is the base screen, rest are sheets.
+  // Rendered from the raw routes (not the standard state) so custom fields are
+  // available and preloaded routes never present as sheets.
+  const [baseRoute, ...sheetRoutes] = routes;
+
+  const baseDescriptor = baseRoute ? descriptors[baseRoute.key] : null;
+
+  return (
+    <>
+      {/* Render base screen */}
+      {baseDescriptor?.render()}
+
+      {/* Render sheet screens */}
+      {sheetRoutes.map((route) => {
+        const descriptor = descriptors[route.key];
+
+        if (!descriptor) {
+          return null;
+        }
+
+        const { options, render } = descriptor;
+        const {
+          detentIndex = 0,
+          detents = DEFAULT_DETENTS,
+          reanimated,
+          positionChangeHandler,
+          ...sheetProps
+        } = options;
+        const resolvedIndex = clampDetentIndex(route.resizeIndex ?? detentIndex, detents.length);
+
+        if (reanimated) {
+          const ReanimatedScreen = getReanimatedScreen();
+          return (
+            <ReanimatedScreen
+              key={route.key}
+              routeKey={route.key}
+              closing={route.closing}
+              detentIndex={resolvedIndex}
+              resizeKey={route.resizeKey}
+              detents={detents}
+              dispatch={dispatch}
+              emit={emitter.emit}
+              positionChangeHandler={positionChangeHandler}
+              {...sheetProps}
+            >
+              {render()}
+            </ReanimatedScreen>
+          );
+        }
+
+        return (
+          <TrueSheetScreen
+            key={route.key}
+            routeKey={route.key}
+            closing={route.closing}
+            detentIndex={resolvedIndex}
+            resizeKey={route.resizeKey}
+            detents={detents}
+            dispatch={dispatch}
+            emit={emitter.emit}
+            positionChangeHandler={positionChangeHandler}
+            {...sheetProps}
+          >
+            {render()}
+          </TrueSheetScreen>
+        );
+      })}
+    </>
+  );
+};

package/src/navigation/actions.ts

@@ -0,0 +1,78 @@
+export type TrueSheetActionType =
+  | {
+      type: 'PUSH';
+      payload: { name: string; params?: object };
+      source?: string;
+      target?: string;
+    }
+  | {
+      type: 'POP';
+      payload: { count: number };
+      source?: string;
+      target?: string;
+    }
+  | {
+      type: 'POP_TO';
+      payload: { name: string; params?: object; merge?: boolean };
+      source?: string;
+      target?: string;
+    }
+  | {
+      type: 'POP_TO_TOP';
+      source?: string;
+      target?: string;
+    }
+  | {
+      type: 'REPLACE';
+      payload: { name: string; params?: object };
+      source?: string;
+      target?: string;
+    }
+  | {
+      type: 'GO_BACK';
+      source?: string;
+      target?: string;
+    }
+  | {
+      type: 'RESIZE';
+      index: number;
+      source?: string;
+      target?: string;
+    }
+  | {
+      type: 'DISMISS';
+      source?: string;
+      target?: string;
+    }
+  | {
+      type: 'REMOVE';
+      source?: string;
+      target?: string;
+    };
+
+/**
+ * Action creators for the TrueSheet navigator.
+ * Plain objects matching `StackActions` shapes, plus sheet-specific actions.
+ */
+export const TrueSheetActions = {
+  push: (name: string, params?: object): TrueSheetActionType => ({
+    type: 'PUSH',
+    payload: { name, params },
+  }),
+  pop: (count: number = 1): TrueSheetActionType => ({
+    type: 'POP',
+    payload: { count },
+  }),
+  popTo: (name: string, params?: object, options?: { merge?: boolean }): TrueSheetActionType => ({
+    type: 'POP_TO',
+    payload: { name, params, merge: options?.merge },
+  }),
+  popToTop: (): TrueSheetActionType => ({ type: 'POP_TO_TOP' }),
+  replace: (name: string, params?: object): TrueSheetActionType => ({
+    type: 'REPLACE',
+    payload: { name, params },
+  }),
+  resize: (index: number): TrueSheetActionType => ({ type: 'RESIZE', index }),
+  dismiss: (): TrueSheetActionType => ({ type: 'DISMISS' }),
+  remove: (): TrueSheetActionType => ({ type: 'REMOVE' }),
+};

package/src/navigation/createTrueSheetRouter.ts

@@ -0,0 +1,222 @@
+import type {
+  NavigationAction,
+  NavigationState,
+  ParamListBase,
+  Router,
+  StackRouterOptions,
+} from '@react-navigation/core';
+
+import { TrueSheetActions, type TrueSheetActionType } from './actions';
+import type { TrueSheetNavigationState } from './types';
+
+export type TrueSheetRouterOptions = StackRouterOptions;
+
+/**
+ * The base `StackRouter` factory to wrap, typed generically over the state and
+ * action types the wrapper threads through — `StackRouter` is structural and
+ * never touches the sheet-specific fields.
+ * Injected by each entry point so the shared router never imports
+ * `@react-navigation/*` at runtime (Expo Router apps don't install it).
+ */
+export type StackRouterFactory = <
+  State extends NavigationState<ParamListBase>,
+  Action extends NavigationAction,
+>(
+  options: TrueSheetRouterOptions
+) => Router<State, Action>;
+
+const uid = () => Math.random().toString(36).slice(2, 10);
+
+const ensureBaseRoute = <T extends { routes: { name: string }[] }>(
+  state: T,
+  baseRouteName: string | undefined,
+  routeParamList: Record<string, object | undefined> | undefined
+): T & { index: number; routes: T['routes'] } => {
+  if (!baseRouteName) {
+    return state as T & { index: number; routes: T['routes'] };
+  }
+
+  const hasBaseRoute = state.routes.some((r) => r.name === baseRouteName);
+
+  if (!hasBaseRoute) {
+    const baseRoute = {
+      key: `${baseRouteName}-${uid()}`,
+      name: baseRouteName,
+      params: routeParamList?.[baseRouteName],
+    };
+
+    return {
+      ...state,
+      index: state.routes.length,
+      routes: [baseRoute, ...state.routes],
+    } as T & { index: number; routes: T['routes'] };
+  }
+
+  return state as T & { index: number; routes: T['routes'] };
+};
+
+export const createTrueSheetRouter =
+  (stackRouter: StackRouterFactory) =>
+  (
+    routerOptions: TrueSheetRouterOptions
+  ): Router<TrueSheetNavigationState<ParamListBase>, TrueSheetActionType> => {
+    const baseRouter = stackRouter<TrueSheetNavigationState<ParamListBase>, TrueSheetActionType>(
+      routerOptions
+    );
+
+    return {
+      ...baseRouter,
+      type: 'true-sheet',
+
+      getInitialState(options) {
+        const state = baseRouter.getInitialState(options);
+        const baseRouteName = routerOptions.initialRouteName ?? options.routeNames[0];
+        const stateWithBaseRoute = ensureBaseRoute(state, baseRouteName, options.routeParamList);
+
+        return {
+          ...stateWithBaseRoute,
+          stale: false,
+          type: 'true-sheet',
+          key: `true-sheet-${uid()}`,
+        };
+      },
+
+      getStateForAction(state, action, options) {
+        switch (action.type) {
+          case 'RESIZE': {
+            const routeIndex =
+              action.target === state.key && action.source
+                ? state.routes.findIndex((r) => r.key === action.source)
+                : state.index;
+
+            return {
+              ...state,
+              routes: state.routes.map((route, i) =>
+                i === routeIndex
+                  ? {
+                      ...route,
+                      resizeIndex: action.index,
+                      resizeKey: (route.resizeKey ?? 0) + 1,
+                    }
+                  : route
+              ),
+            };
+          }
+
+          case 'GO_BACK':
+          case 'DISMISS': {
+            return this.getStateForAction(state, TrueSheetActions.pop(1), options);
+          }
+
+          case 'POP': {
+            // Only base screen remains - let parent navigator handle it
+            if (state.routes.length <= 1) {
+              return null;
+            }
+
+            const count =
+              'payload' in action && typeof action.payload?.count === 'number'
+                ? action.payload.count
+                : 1;
+
+            // Calculate how many routes we can actually pop (don't pop base screen)
+            const maxPopCount = state.routes.length - 1;
+            const actualCount = Math.min(count, maxPopCount);
+
+            // Base screen - let parent navigator handle it
+            if (actualCount <= 0) {
+              return null;
+            }
+
+            // Target index is the route we want to stay on (land on after pop)
+            // closingIndex is the first route to be dismissed (the one after target)
+            const targetIndex = state.routes.length - 1 - actualCount;
+            const closingIndex = targetIndex + 1;
+
+            // Mark only the bottom-most route to pop as closing
+            // The sheet's dismiss() will handle dismissing sheets above it first
+            return {
+              ...state,
+              index: closingIndex,
+              routes: state.routes.map((route, i) =>
+                i === closingIndex ? { ...route, closing: true } : route
+              ),
+            };
+          }
+
+          case 'POP_TO_TOP': {
+            const popCount = state.routes.length - 1;
+            return this.getStateForAction(state, TrueSheetActions.pop(popCount), options);
+          }
+
+          case 'POP_TO': {
+            const targetName =
+              'payload' in action && typeof action.payload?.name === 'string'
+                ? action.payload.name
+                : null;
+
+            if (!targetName) {
+              return null;
+            }
+
+            const targetIndex = state.routes.findIndex((r) => r.name === targetName);
+
+            // Target not found or is the current route
+            if (targetIndex === -1 || targetIndex >= state.index) {
+              return null;
+            }
+
+            const popCount = state.routes.length - 1 - targetIndex;
+            return this.getStateForAction(state, TrueSheetActions.pop(popCount), options);
+          }
+
+          case 'REMOVE': {
+            // Actually remove the closing route and all routes above it
+            const routeKey = action.source;
+            const routeIndex = routeKey
+              ? state.routes.findIndex((r) => r.key === routeKey)
+              : state.routes.findIndex((r) => r.closing);
+
+            if (routeIndex === -1) {
+              return state;
+            }
+
+            // Remove the route and all routes above it (they were dismissed together)
+            const routes = state.routes.filter((_, i) => i < routeIndex);
+
+            return {
+              ...state,
+              index: Math.min(state.index, routes.length - 1),
+              routes,
+            };
+          }
+
+          default:
+            return baseRouter.getStateForAction(state, action, options);
+        }
+      },
+
+      getRehydratedState(partialState, { routeNames, routeParamList, routeGetIdList }) {
+        if (partialState.stale === false) {
+          return partialState;
+        }
+
+        const state = baseRouter.getRehydratedState(partialState, {
+          routeNames,
+          routeParamList,
+          routeGetIdList,
+        });
+
+        const baseRouteName = routerOptions.initialRouteName ?? routeNames[0];
+        const stateWithBaseRoute = ensureBaseRoute(state, baseRouteName, routeParamList);
+
+        return {
+          ...stateWithBaseRoute,
+          type: 'true-sheet',
+          key: `true-sheet-${uid()}`,
+        };
+      },
+
+      actionCreators: TrueSheetActions,
+    };
+  };