@lodev09/react-native-true-sheet 4.0.0-beta.1 → 4.0.0-beta.3

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

@@ -14,15 +14,14 @@ interface MockReanimatedTrueSheetContextValue {
   animatedDetent: SharedValue<number>;
 }
 
-const createMockSharedValue = <T>(initialValue: T): SharedValue<T> =>
-  ({
-    value: initialValue,
-    get: () => initialValue,
-    set: () => {},
-    addListener: () => () => {},
-    removeListener: () => {},
-    modify: () => {},
-  }) as unknown as SharedValue<T>;
+const createMockSharedValue = <T>(initialValue: T): SharedValue<T> => ({
+  value: initialValue,
+  get: () => initialValue,
+  set: () => {},
+  addListener: () => {},
+  removeListener: () => {},
+  modify: () => {},
+});
 
 /**
  * Mock ReanimatedTrueSheet component for testing.

package/src/navigation/{TrueSheetView.tsx → TrueSheetNavigatorContent.tsx}

@@ -1,9 +1,9 @@
-import type { ParamListBase } from '@react-navigation/core';
+import type { NavigatorArgs } from 'standard-navigation';
 
 import type {
-  TrueSheetDescriptorMap,
-  TrueSheetNavigationHelpers,
-  TrueSheetNavigationState,
+  TrueSheetNavigationOptions,
+  TrueSheetNavigatorContentExtraProps,
+  TrueSheetStandardEventMap,
 } from './types';
 import { TrueSheetScreen, type TrueSheetScreenProps } from './screen';
 
@@ -22,15 +22,22 @@ const DEFAULT_DETENTS: ('auto' | number)[] = ['auto'];
 const clampDetentIndex = (index: number, detentsLength: number): number =>
   Math.min(index, Math.max(detentsLength - 1, 0));
 
-interface TrueSheetViewProps {
-  state: TrueSheetNavigationState<ParamListBase>;
-  navigation: TrueSheetNavigationHelpers;
-  descriptors: TrueSheetDescriptorMap;
-}
+export type TrueSheetNavigatorContentProps = NavigatorArgs<
+  TrueSheetNavigationOptions,
+  TrueSheetStandardEventMap
+> &
+  TrueSheetNavigatorContentExtraProps;
 
-export const TrueSheetView = ({ state, navigation, descriptors }: TrueSheetViewProps) => {
-  // First route is the base screen, rest are sheets
-  const [baseRoute, ...sheetRoutes] = state.routes;
+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;
 
@@ -47,7 +54,7 @@ export const TrueSheetView = ({ state, navigation, descriptors }: TrueSheetViewP
           return null;
         }
 
-        const { options, navigation: screenNavigation, render } = descriptor;
+        const { options, render } = descriptor;
         const {
           detentIndex = 0,
           detents = DEFAULT_DETENTS,
@@ -67,8 +74,8 @@ export const TrueSheetView = ({ state, navigation, descriptors }: TrueSheetViewP
               detentIndex={resolvedIndex}
               resizeKey={route.resizeKey}
               detents={detents}
-              navigation={screenNavigation}
-              emit={navigation.emit}
+              dispatch={dispatch}
+              emit={emitter.emit}
               positionChangeHandler={positionChangeHandler}
               {...sheetProps}
             >
@@ -85,8 +92,8 @@ export const TrueSheetView = ({ state, navigation, descriptors }: TrueSheetViewP
             detentIndex={resolvedIndex}
             resizeKey={route.resizeKey}
             detents={detents}
-            navigation={screenNavigation}
-            emit={navigation.emit}
+            dispatch={dispatch}
+            emit={emitter.emit}
             positionChangeHandler={positionChangeHandler}
             {...sheetProps}
           >

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,
+    };
+  };

package/src/navigation/expo-router/index.ts

@@ -0,0 +1,89 @@
+import type { ParamListBase } from '@react-navigation/core';
+import { StackRouter, unstable_integrateWithRouter, useNavigation } from 'expo-router';
+
+import {
+  createTrueSheetRouter,
+  type StackRouterFactory,
+  type TrueSheetRouterOptions,
+} from '../createTrueSheetRouter';
+import { trueSheetNavigator } from '../navigator';
+import type {
+  TrueSheetNavigationOptions,
+  TrueSheetNavigationProp,
+  TrueSheetNavigationState,
+  TrueSheetNavigatorContentExtraProps,
+  TrueSheetNavigatorProps,
+  TrueSheetStandardEventMap,
+} from '../types';
+
+const SheetNavigator = unstable_integrateWithRouter<
+  TrueSheetNavigationOptions,
+  TrueSheetNavigationState<ParamListBase>,
+  TrueSheetStandardEventMap,
+  TrueSheetNavigatorContentExtraProps,
+  TrueSheetRouterOptions
+>(
+  trueSheetNavigator,
+  // expo-router's vendored StackRouter is structurally identical to @react-navigation's
+  createTrueSheetRouter(StackRouter as StackRouterFactory),
+  {
+    createProps: ({ state, dispatch }) => ({
+      routes: state.routes,
+      dispatch,
+    }),
+  }
+);
+
+// Public props: `routes`/`dispatch` are injected by `createProps` (optional here
+// so the navigator type stays comparable), and expo-router intersects the event
+// map with an index signature which breaks precisely typed `screenListeners`
+// callbacks - replace it with the exact map
+type SheetProps = Omit<
+  React.ComponentProps<typeof SheetNavigator>,
+  'screenListeners' | 'routes' | 'dispatch'
+> &
+  Partial<Pick<React.ComponentProps<typeof SheetNavigator>, 'routes' | 'dispatch'>> &
+  Pick<TrueSheetNavigatorProps, 'screenListeners'>;
+
+/**
+ * TrueSheet navigator layout for Expo Router.
+ *
+ * @example
+ * ```tsx
+ * // app/sheet/_layout.tsx
+ * import { Sheet } from '@lodev09/react-native-true-sheet/navigation/expo-router';
+ *
+ * export default function SheetLayout() {
+ *   return (
+ *     <Sheet initialRouteName="(home)">
+ *       <Sheet.Screen name="details" options={{ detents: [0.5, 1] }} />
+ *     </Sheet>
+ *   );
+ * }
+ * ```
+ */
+export const Sheet = SheetNavigator as React.ComponentType<SheetProps> & {
+  Screen: typeof SheetNavigator.Screen;
+  Protected: typeof SheetNavigator.Protected;
+};
+
+/**
+ * Hook to access TrueSheet navigation with the resize helper.
+ * Built on expo-router's `useNavigation`.
+ */
+export const useTrueSheetNavigation = <
+  T extends ParamListBase = ParamListBase,
+>(): TrueSheetNavigationProp<T> => useNavigation<TrueSheetNavigationProp<T>>();
+
+export { TrueSheetActions, type TrueSheetActionType } from '../actions';
+
+export type { DetentInfoEventPayload, PositionChangeEventPayload } from '../../TrueSheet.types';
+
+export type {
+  TrueSheetNavigationEventMap,
+  TrueSheetNavigationHelpers,
+  TrueSheetNavigationOptions,
+  TrueSheetNavigationProp,
+  TrueSheetNavigationState,
+  TrueSheetScreenProps,
+} from '../types';

package/src/navigation/index.ts

@@ -1,5 +1,72 @@
-export { createTrueSheetNavigator } from './createTrueSheetNavigator';
-export { TrueSheetActions, type TrueSheetActionType } from './TrueSheetRouter';
+import {
+  createStandardNavigationFactories,
+  StackRouter,
+  type StandardNavigationTypeBagBase,
+} from '@react-navigation/native';
+
+import { createTrueSheetRouter, type StackRouterFactory } from './createTrueSheetRouter';
+import { trueSheetNavigator } from './navigator';
+import type {
+  TrueSheetActionHelpers,
+  TrueSheetNavigationOptions,
+  TrueSheetNavigationEventMap,
+  TrueSheetNavigationState,
+  TrueSheetNavigatorContentExtraProps,
+} from './types';
+import type { TrueSheetRouterOptions } from './createTrueSheetRouter';
+
+export interface TrueSheetNavigationTypeBag extends StandardNavigationTypeBagBase {
+  State: TrueSheetNavigationState<this['ParamList']>;
+  ActionHelpers: TrueSheetActionHelpers<this['ParamList']>;
+  ScreenOptions: TrueSheetNavigationOptions;
+  EventMap: TrueSheetNavigationEventMap;
+  RouterOptions: TrueSheetRouterOptions;
+}
+
+const { createNavigator, createScreen } = createStandardNavigationFactories<
+  TrueSheetNavigationTypeBag,
+  {},
+  TrueSheetNavigatorContentExtraProps
+>(
+  trueSheetNavigator,
+  createTrueSheetRouter(StackRouter as StackRouterFactory),
+  ({ state, navigation }) => ({ routes: state.routes, dispatch: navigation.dispatch })
+);
+
+/**
+ * Creates a TrueSheet navigator.
+ *
+ * @example
+ * ```tsx
+ * const Sheet = createTrueSheetNavigator();
+ *
+ * function App() {
+ *   return (
+ *     <Sheet.Navigator>
+ *       <Sheet.Screen name="Home" component={HomeScreen} />
+ *       <Sheet.Screen
+ *         name="Details"
+ *         component={DetailsSheet}
+ *         options={{ detents: [0.5, 1] }}
+ *       />
+ *     </Sheet.Navigator>
+ *   );
+ * }
+ * ```
+ */
+export const createTrueSheetNavigator = createNavigator;
+
+/**
+ * Creates a screen configuration for the static API.
+ */
+export const createTrueSheetScreen = createScreen;
+
+export { TrueSheetActions, type TrueSheetActionType } from './actions';
+export {
+  createTrueSheetRouter,
+  type StackRouterFactory,
+  type TrueSheetRouterOptions,
+} from './createTrueSheetRouter';
 export { useTrueSheetNavigation } from './useTrueSheetNavigation';
 
 export type { DetentInfoEventPayload, PositionChangeEventPayload } from '../TrueSheet.types';

package/src/navigation/navigator.ts

@@ -0,0 +1,18 @@
+import { createStandardNavigator } from 'standard-navigation';
+
+import { TrueSheetNavigatorContent } from './TrueSheetNavigatorContent';
+import type {
+  TrueSheetNavigationOptions,
+  TrueSheetNavigatorContentExtraProps,
+  TrueSheetStandardEventMap,
+} from './types';
+
+/**
+ * Framework-agnostic TrueSheet navigator.
+ * Wired into React Navigation via `./index` and Expo Router via `./expo-router`.
+ */
+export const trueSheetNavigator = createStandardNavigator<
+  TrueSheetNavigationOptions,
+  TrueSheetStandardEventMap,
+  TrueSheetNavigatorContentExtraProps
+>(TrueSheetNavigatorContent);

package/src/navigation/screen/ReanimatedTrueSheetScreen.tsx

@@ -12,7 +12,7 @@ const AnimatedTrueSheet = Animated.createAnimatedComponent(TrueSheet);
 export const ReanimatedTrueSheetScreen = ({
   detentIndex,
   resizeKey,
-  navigation,
+  dispatch,
   emit,
   routeKey,
   closing,
@@ -29,7 +29,7 @@ export const ReanimatedTrueSheetScreen = ({
     detentIndex,
     resizeKey,
     closing,
-    navigation,
+    dispatch,
     routeKey,
     emit,
   });

package/src/navigation/screen/TrueSheetScreen.tsx

@@ -8,7 +8,7 @@ import { useSheetScreenState } from './useSheetScreenState';
 export const TrueSheetScreen = ({
   detentIndex,
   resizeKey,
-  navigation,
+  dispatch,
   emit,
   routeKey,
   closing,
@@ -25,7 +25,7 @@ export const TrueSheetScreen = ({
     detentIndex,
     resizeKey,
     closing,
-    navigation,
+    dispatch,
     routeKey,
     emit,
   });

package/src/navigation/screen/types.ts

@@ -1,18 +1,16 @@
-import type { ParamListBase } from '@react-navigation/core';
-
 import type { TrueSheetProps } from '../../TrueSheet.types';
 import type {
   PositionChangeHandler,
-  TrueSheetNavigationHelpers,
-  TrueSheetNavigationProp,
+  TrueSheetDispatch,
+  TrueSheetEmitFn,
   TrueSheetNavigationSheetProps,
 } from '../types';
 
 export interface TrueSheetScreenProps extends TrueSheetNavigationSheetProps {
   detentIndex: number;
   resizeKey?: number;
-  navigation: TrueSheetNavigationProp<ParamListBase>;
-  emit: TrueSheetNavigationHelpers['emit'];
+  dispatch: TrueSheetDispatch;
+  emit: TrueSheetEmitFn;
   routeKey: string;
   closing?: boolean;
   detents: TrueSheetProps['detents'];