react-native-screen-transitions 3.11.3 → 3.13.0-beta.0

package/src/shared/components/boundary/hooks/lifecycles/use-initial-destination-measurement.ts

@@ -1,267 +0,0 @@
-import { useCallback, useLayoutEffect, useMemo } from "react";
-import {
-	cancelAnimation,
-	runOnUI,
-	useAnimatedReaction,
-	useSharedValue,
-	withDelay,
-	withTiming,
-} from "react-native-reanimated";
-import { useStack } from "../../../../hooks/navigation/use-stack";
-import { useDescriptorsStore } from "../../../../providers/screen/descriptors";
-import { AnimationStore } from "../../../../stores/animation.store";
-import {
-	createScreenPairKey,
-	getSourceScreenKeyFromPairKey,
-} from "../../../../stores/bounds/helpers/link-pairs.helpers";
-import {
-	getEntry,
-	getMatchingSourceScreenKey,
-} from "../../../../stores/bounds/internals/entries";
-import { getLink } from "../../../../stores/bounds/internals/links";
-import { pairs } from "../../../../stores/bounds/internals/state";
-import type { BoundTag } from "../../../../stores/bounds/types";
-import { SystemStore } from "../../../../stores/system.store";
-import { logger } from "../../../../utils/logger";
-import type { MeasureBoundary } from "../../types";
-import { getInitialDestinationMeasurementSignal } from "../../utils/destination-signals";
-
-// A missed layout should be retried on the next frame. The previous 100 ms
-// interval made each ordinary Android layout miss visibly delay navigation.
-const HANDSHAKE_RETRY_DELAY_MS = 16;
-/**
- * A destination whose initial handshake never completes must not hold the
- * transition gate forever. After this budget, release the block with a warning
- * so the open proceeds without that boundary.
- */
-const MAX_HANDSHAKE_RETRIES = 20;
-
-interface UseInitialDestinationMeasurementParams {
-	boundTag: BoundTag;
-	enabled: boolean;
-	measureBoundary: MeasureBoundary;
-}
-
-export const useInitialDestinationMeasurement = ({
-	boundTag,
-	enabled,
-	measureBoundary,
-}: UseInitialDestinationMeasurementParams) => {
-	const { tag, linkKey, group } = boundTag;
-	const currentScreenKey = useDescriptorsStore(
-		(s) => s.derivations.currentScreenKey,
-	);
-	const nextScreenKey = useDescriptorsStore((s) => s.derivations.nextScreenKey);
-	const destinationPairKey = useDescriptorsStore(
-		(s) => s.derivations.destinationPairKey,
-	);
-	const destinationEnabled = enabled && !nextScreenKey;
-	const canReceiveDestination = destinationEnabled && !!destinationPairKey;
-	const preferredSourceScreenKey = destinationPairKey
-		? getSourceScreenKeyFromPairKey(destinationPairKey)
-		: undefined;
-	const stackScenes = useStack((store) => store.scenes);
-	// A retained closing screen can still have registered boundaries, but it
-	// cannot own a new transition link.
-	const closingSourceScreenKeys = useMemo(
-		() =>
-			stackScenes
-				.filter((scene) => scene.activity === "closing")
-				.map((scene) => scene.route.key),
-		[stackScenes],
-	);
-	const progress = AnimationStore.getValue(
-		currentScreenKey,
-		"transitionProgress",
-	);
-
-	const {
-		actions: { blockLifecycleStart, unblockLifecycleStart },
-	} = SystemStore.getBag(currentScreenKey);
-
-	const isBlockingLifecycleStart = useSharedValue(0);
-	const retryToken = useSharedValue(0);
-	const handshakeRetries = useSharedValue(0);
-	const hasGivenUp = useSharedValue(0);
-	const hasFinishedInitialMeasurement = useSharedValue(0);
-
-	const releaseLifecycleStartBlock = useCallback(() => {
-		"worklet";
-		cancelAnimation(retryToken);
-
-		if (!isBlockingLifecycleStart.get()) {
-			return;
-		}
-
-		hasFinishedInitialMeasurement.set(1);
-		isBlockingLifecycleStart.set(0);
-		unblockLifecycleStart();
-	}, [
-		hasFinishedInitialMeasurement,
-		isBlockingLifecycleStart,
-		retryToken,
-		unblockLifecycleStart,
-	]);
-
-	const claimLifecycleStartBlock = useCallback(() => {
-		"worklet";
-		if (
-			!canReceiveDestination ||
-			hasFinishedInitialMeasurement.get() ||
-			!getMatchingSourceScreenKey(tag, currentScreenKey)
-		) {
-			return;
-		}
-
-		// The progress check and block claim must share one UI-thread operation.
-		// Otherwise a JS-thread layout effect can observe zero, enqueue the block,
-		// and let the opening animation start before that block reaches the UI thread.
-		if (progress.get() > 0 || isBlockingLifecycleStart.get()) {
-			return;
-		}
-
-		blockLifecycleStart();
-		isBlockingLifecycleStart.set(1);
-	}, [
-		blockLifecycleStart,
-		canReceiveDestination,
-		currentScreenKey,
-		hasFinishedInitialMeasurement,
-		isBlockingLifecycleStart,
-		progress,
-		tag,
-	]);
-
-	useLayoutEffect(() => {
-		if (!canReceiveDestination) {
-			return;
-		}
-
-		runOnUI(claimLifecycleStartBlock)();
-
-		return () => {
-			// This is an abandonment fallback, not a second release. Run it on the UI
-			// runtime so it serializes with the handshake's guarded release.
-			runOnUI(releaseLifecycleStartBlock)();
-		};
-	}, [
-		claimLifecycleStartBlock,
-		canReceiveDestination,
-		releaseLifecycleStartBlock,
-	]);
-
-	useAnimatedReaction(
-		() => {
-			"worklet";
-
-			if (
-				!canReceiveDestination ||
-				hasFinishedInitialMeasurement.get() ||
-				isBlockingLifecycleStart.get() <= 0
-			) {
-				return null;
-			}
-
-			if (progress.get() > 0) {
-				return null;
-			}
-
-			const retryTick = retryToken.get();
-			const sourceScreenKey = getMatchingSourceScreenKey(
-				tag,
-				currentScreenKey,
-				preferredSourceScreenKey,
-				closingSourceScreenKeys,
-			);
-			const pairKey = sourceScreenKey
-				? createScreenPairKey(sourceScreenKey, currentScreenKey)
-				: undefined;
-			const signal = getInitialDestinationMeasurementSignal({
-				enabled: destinationEnabled,
-				pairKey,
-				linkId: linkKey,
-				group,
-				destinationPresent: getEntry(tag, currentScreenKey) !== null,
-				sourcePresent: sourceScreenKey !== null,
-				linkState: pairs.get(),
-			});
-
-			return [
-				signal?.pairKey ?? null,
-				signal?.action ?? null,
-				retryTick,
-			] as const;
-		},
-		(next, previous) => {
-			"worklet";
-			if (!next || hasFinishedInitialMeasurement.get()) {
-				return;
-			}
-
-			const [measurePairKey, action, retryTick] = next;
-			if (!action) {
-				return;
-			}
-
-			const previousMeasurePairKey = previous?.[0];
-			const previousAction = previous?.[1];
-			const previousRetryTick = previous?.[2];
-			const shouldHandleSignal =
-				measurePairKey !== previousMeasurePairKey ||
-				action !== previousAction ||
-				retryTick !== previousRetryTick;
-
-			if (!shouldHandleSignal) {
-				return;
-			}
-
-			if (hasGivenUp.get()) {
-				return;
-			}
-
-			if (action === "release") {
-				releaseLifecycleStartBlock();
-				handshakeRetries.set(0);
-				return;
-			}
-
-			if (action === "measure" && measurePairKey) {
-				measureBoundary({
-					type: "destination",
-					pairKey: measurePairKey,
-				});
-			}
-
-			const link = measurePairKey ? getLink(measurePairKey, linkKey) : null;
-			const linkComplete = !!link?.source && !!link.destination;
-
-			if (linkComplete || action === "complete") {
-				cancelAnimation(retryToken);
-				handshakeRetries.set(0);
-				hasFinishedInitialMeasurement.set(1);
-				releaseLifecycleStartBlock();
-				return;
-			}
-
-			if (handshakeRetries.get() >= MAX_HANDSHAKE_RETRIES) {
-				hasGivenUp.set(1);
-				releaseLifecycleStartBlock();
-				logger.warn(
-					`Boundary "${linkKey}" never formed a complete source/destination link after ${MAX_HANDSHAKE_RETRIES} attempts; releasing the transition gate without it. One side is likely off-viewport or unmounted.`,
-				);
-				return;
-			}
-
-			// Keep the lifecycle blocked while registration, measurement, or source
-			// attachment settles. The retry token also retries rejected destination bounds.
-			handshakeRetries.set(handshakeRetries.get() + 1);
-			cancelAnimation(retryToken);
-			retryToken.set(
-				withDelay(
-					HANDSHAKE_RETRY_DELAY_MS,
-					withTiming(retryToken.get() + 1, { duration: 0 }),
-				),
-			);
-		},
-	);
-};

package/src/shared/components/boundary/hooks/lifecycles/use-initial-source-measurement.ts

@@ -1,51 +0,0 @@
-import { useAnimatedReaction, useSharedValue } from "react-native-reanimated";
-import { useDescriptorsStore } from "../../../../providers/screen/descriptors";
-import { getPairKeyForSource } from "../../../../stores/bounds/internals/links";
-import { pairs } from "../../../../stores/bounds/internals/state";
-import type { BoundTag } from "../../../../stores/bounds/types";
-import type { MeasureBoundary } from "../../types";
-import { getInitialSourceCaptureSignal } from "../../utils/source-signals";
-
-export const useInitialSourceMeasurement = (params: {
-	enabled: boolean;
-	measureBoundary: MeasureBoundary;
-	boundTag: BoundTag;
-}) => {
-	const { enabled, measureBoundary, boundTag } = params;
-	const currentScreenKey = useDescriptorsStore(
-		(s) => s.derivations.currentScreenKey,
-	);
-	const lastSourceCaptureSignal = useSharedValue<string | null>(null);
-
-	useAnimatedReaction(
-		() => {
-			"worklet";
-			const sourcePairKey =
-				getPairKeyForSource(boundTag.tag, currentScreenKey) ?? undefined;
-			return getInitialSourceCaptureSignal({
-				enabled,
-				sourcePairKey,
-				linkId: boundTag.linkKey,
-				group: boundTag.group,
-				linkState: sourcePairKey ? pairs.get() : undefined,
-			});
-		},
-		(captureSignal) => {
-			"worklet";
-			if (!enabled || !captureSignal) {
-				lastSourceCaptureSignal.set(null);
-				return;
-			}
-
-			if (lastSourceCaptureSignal.get() === captureSignal.signal) {
-				return;
-			}
-
-			lastSourceCaptureSignal.set(captureSignal.signal);
-			measureBoundary({
-				type: "source",
-				pairKey: captureSignal.pairKey,
-			});
-		},
-	);
-};

package/src/shared/components/boundary/hooks/lifecycles/use-refresh-boundary.ts

@@ -1,90 +0,0 @@
-import { useAnimatedReaction } from "react-native-reanimated";
-import { useDescriptorsStore } from "../../../../providers/screen/descriptors";
-import { AnimationStore } from "../../../../stores/animation.store";
-import {
-	getPairKeyForDestination,
-	getPairKeyForSource,
-} from "../../../../stores/bounds/internals/links";
-import { pairs } from "../../../../stores/bounds/internals/state";
-import type { BoundTag } from "../../../../stores/bounds/types";
-import type { MeasureBoundary } from "../../types";
-import { getRefreshBoundarySignal } from "../../utils/refresh-signals";
-
-interface UseRefreshBoundaryParams {
-	enabled: boolean;
-	boundTag: BoundTag;
-	measureBoundary: MeasureBoundary;
-}
-
-export const useRefreshBoundary = ({
-	enabled,
-	boundTag,
-	measureBoundary,
-}: UseRefreshBoundaryParams) => {
-	const { linkKey, group } = boundTag;
-	const currentScreenKey = useDescriptorsStore(
-		(s) => s.derivations.currentScreenKey,
-	);
-	const nextScreenKey = useDescriptorsStore((s) => s.derivations.nextScreenKey);
-	// Source-side boundaries refresh from the next screen's lifecycle pulse.
-	// Destination-side boundaries have no next screen, so they refresh from self.
-	const refreshScreenKey = nextScreenKey ?? currentScreenKey;
-	const refreshWillAnimate = AnimationStore.getValue(
-		refreshScreenKey,
-		"willAnimate",
-	);
-	const refreshSettled = AnimationStore.getValue(
-		refreshScreenKey,
-		"progressSettled",
-	);
-	const refreshClosing = AnimationStore.getValue(refreshScreenKey, "closing");
-
-	useAnimatedReaction(
-		() => {
-			"worklet";
-
-			if (!enabled) return null;
-
-			const shouldRefresh = !!refreshWillAnimate.get();
-			const settled = !!refreshSettled.get();
-			// A group's active member can change while the transition is settled
-			// (for example, paging a destination gallery). Let that member publish
-			// fresh bounds even though there is no willAnimate lifecycle pulse yet.
-			if (!shouldRefresh && (!group || !settled)) {
-				return null;
-			}
-			const sourcePairKey =
-				getPairKeyForSource(boundTag.tag, currentScreenKey) ?? undefined;
-			const destinationPairKey =
-				getPairKeyForDestination(boundTag.tag, currentScreenKey) ?? undefined;
-
-			return getRefreshBoundarySignal({
-				enabled,
-				currentScreenKey,
-				sourcePairKey,
-				destinationPairKey,
-				linkId: linkKey,
-				group,
-				shouldRefresh,
-				settled,
-				closing: !!refreshClosing.get(),
-				linkState: pairs.get(),
-			});
-		},
-		(refreshSignal, prevRefreshSignal) => {
-			"worklet";
-
-			if (
-				!refreshSignal ||
-				refreshSignal.signal === prevRefreshSignal?.signal
-			) {
-				return;
-			}
-
-			measureBoundary({
-				type: refreshSignal.type,
-				pairKey: refreshSignal.pairKey,
-			});
-		},
-	);
-};

package/src/shared/components/boundary/utils/destination-signals.ts

@@ -1,75 +0,0 @@
-import {
-	getActiveGroupId,
-	getLinkKeyFromTag,
-} from "../../../stores/bounds/helpers/link-pairs.helpers";
-import type {
-	LinkPairsState,
-	ScreenPairKey,
-} from "../../../stores/bounds/types";
-
-export type InitialDestinationMeasurementAction =
-	| "wait"
-	| "release"
-	| "measure"
-	| "complete";
-
-export type InitialDestinationMeasurementSignal = {
-	pairKey: ScreenPairKey | null;
-	action: InitialDestinationMeasurementAction;
-};
-
-export const getInitialDestinationMeasurementSignal = (params: {
-	enabled: boolean;
-	pairKey?: ScreenPairKey;
-	linkId: string;
-	group?: string;
-	destinationPresent: boolean;
-	sourcePresent: boolean;
-	linkState?: LinkPairsState;
-}): InitialDestinationMeasurementSignal | null => {
-	"worklet";
-	const {
-		enabled,
-		pairKey,
-		linkId,
-		group,
-		destinationPresent,
-		sourcePresent,
-		linkState,
-	} = params;
-	if (!enabled) {
-		return null;
-	}
-
-	if (!pairKey) {
-		return { pairKey: null, action: "wait" };
-	}
-
-	if (!destinationPresent) {
-		return { pairKey, action: "wait" };
-	}
-
-	if (!sourcePresent) {
-		return { pairKey, action: "release" };
-	}
-
-	const linkKey = getLinkKeyFromTag(linkId);
-	const activeGroupId =
-		group && linkState ? getActiveGroupId(linkState, pairKey, group) : null;
-
-	if (activeGroupId && activeGroupId !== linkKey) {
-		return { pairKey, action: "release" };
-	}
-
-	const link = linkState?.[pairKey]?.links?.[linkKey];
-
-	if (!link?.destination) {
-		return { pairKey, action: "measure" };
-	}
-
-	if (!link.source) {
-		return { pairKey, action: "wait" };
-	}
-
-	return { pairKey, action: "complete" };
-};

package/src/shared/components/boundary/utils/refresh-signals.ts

@@ -1,164 +0,0 @@
-import type {
-	LinkPairsState,
-	ScreenPairKey,
-} from "../../../stores/bounds/types";
-import type { MeasureTarget } from "../types";
-
-const SOURCE_SIGNAL_PREFIX = "source|";
-const DESTINATION_SIGNAL_PREFIX = "destination|";
-
-type RefreshBoundarySignal = MeasureTarget & {
-	signal: string;
-};
-
-const buildRefreshSignal = (
-	type: MeasureTarget["type"],
-	pairKey: ScreenPairKey,
-	key: string,
-): RefreshBoundarySignal => {
-	"worklet";
-	const prefix =
-		type === "source" ? SOURCE_SIGNAL_PREFIX : DESTINATION_SIGNAL_PREFIX;
-	return {
-		type,
-		pairKey,
-		signal: `${prefix}${pairKey}|${key}`,
-	};
-};
-
-export const getRefreshBoundarySignal = (params: {
-	enabled: boolean;
-	currentScreenKey: string;
-	sourcePairKey?: ScreenPairKey;
-	destinationPairKey?: ScreenPairKey;
-	linkId: string;
-	group?: string;
-	shouldRefresh: boolean;
-	settled?: boolean;
-	closing: boolean;
-	linkState?: LinkPairsState;
-}): RefreshBoundarySignal | null => {
-	"worklet";
-	const {
-		enabled,
-		currentScreenKey,
-		sourcePairKey,
-		destinationPairKey,
-		linkId,
-		group,
-		shouldRefresh,
-		settled = false,
-		closing,
-		linkState,
-	} = params;
-
-	if (!enabled) return null;
-
-	if (!shouldRefresh && (!group || !settled)) {
-		return null;
-	}
-
-	// A source may move while its destination is active, so refresh whichever
-	// side of the pair this boundary currently represents.
-	if (!group) {
-		if (sourcePairKey) {
-			const sourcePair = linkState?.[sourcePairKey];
-			const participates =
-				!!sourcePair?.links?.[linkId] || !!sourcePair?.sourceRequests?.[linkId];
-
-			if (!participates) {
-				return null;
-			}
-
-			return buildRefreshSignal(
-				"source",
-				sourcePairKey,
-				[currentScreenKey, closing ? "closing" : "settled"].join("|"),
-			);
-		}
-
-		const refreshDestinationPairKey = destinationPairKey;
-
-		if (!refreshDestinationPairKey) {
-			return null;
-		}
-
-		if (!linkState?.[refreshDestinationPairKey]?.links?.[linkId]) {
-			return null;
-		}
-
-		return buildRefreshSignal(
-			"destination",
-			refreshDestinationPairKey,
-			[currentScreenKey, closing ? "closing" : "settled"].join("|"),
-		);
-	}
-
-	// Source side:
-	// When the activeId changes, trigger a refresh to ensure the source bounds are captured.
-	if (sourcePairKey) {
-		const pair = linkState?.[sourcePairKey];
-		const groupState = pair?.groups?.[group];
-		const activeId = groupState?.activeId;
-
-		if (activeId !== linkId) {
-			return null;
-		}
-
-		// The opening member is captured by the initial handshake. A settled
-		// refresh is only needed after selection moves to another member.
-		if (
-			!shouldRefresh &&
-			(groupState?.initialId === undefined ||
-				activeId === groupState.initialId ||
-				!!pair?.links?.[linkId]?.source)
-		) {
-			return null;
-		}
-
-		return buildRefreshSignal(
-			"source",
-			sourcePairKey,
-			[
-				group,
-				linkId,
-				shouldRefresh ? (closing ? "closing" : "settled") : "retarget",
-			].join("|"),
-		);
-	}
-
-	const refreshDestinationPairKey = destinationPairKey;
-
-	if (!refreshDestinationPairKey) return null;
-
-	// Destination side:
-	// When the activeId changes, trigger a refresh to ensure the destination bounds are captured.
-	const pair = linkState?.[refreshDestinationPairKey];
-	const groupState = pair?.groups?.[group];
-	const activeId = groupState?.activeId;
-
-	// Destination retargeting should only measure a concrete member that already
-	// participates in the pair. Missing members fall back to initialId at resolve.
-	if (activeId !== linkId) {
-		return null;
-	}
-
-	if (
-		!shouldRefresh &&
-		(groupState?.initialId === undefined ||
-			activeId === groupState.initialId ||
-			!!pair?.links?.[linkId]?.destination)
-	) {
-		return null;
-	}
-
-	return buildRefreshSignal(
-		"destination",
-		refreshDestinationPairKey,
-		[
-			group,
-			linkId,
-			shouldRefresh ? (closing ? "closing" : "settled") : "retarget",
-		].join("|"),
-	);
-};

package/src/shared/components/boundary/utils/source-signals.ts

@@ -1,51 +0,0 @@
-import type {
-	LinkPairsState,
-	ScreenPairKey,
-} from "../../../stores/bounds/types";
-
-const SOURCE_SIGNAL_PREFIX = "source|";
-
-type SourceCaptureSignal = {
-	pairKey: ScreenPairKey;
-	signal: string;
-};
-
-export const getInitialSourceCaptureSignal = (params: {
-	enabled: boolean;
-	sourcePairKey?: ScreenPairKey;
-	linkId: string;
-	group?: string;
-	linkState?: LinkPairsState;
-}): SourceCaptureSignal | null => {
-	"worklet";
-	const { enabled, sourcePairKey, linkId, group, linkState } = params;
-
-	if (!enabled || !sourcePairKey) {
-		return null;
-	}
-
-	const pair = linkState?.[sourcePairKey];
-	const link = pair?.links?.[linkId];
-	const hasSourceRequest = pair?.sourceRequests?.[linkId];
-
-	if ((!link?.destination && !hasSourceRequest) || link?.source) {
-		return null;
-	}
-
-	if (group) {
-		const activeId = linkState?.[sourcePairKey]?.groups?.[group]?.activeId;
-
-		// Passive grouped sources should not measure every mounted item. Once a
-		// group has an active id, only that concrete member can auto-capture.
-		if (activeId && activeId !== linkId) {
-			return null;
-		}
-	}
-
-	const signalParts = group ? [group, linkId] : [linkId];
-
-	return {
-		pairKey: sourcePairKey,
-		signal: `${SOURCE_SIGNAL_PREFIX}${sourcePairKey}|${signalParts.join("|")}`,
-	};
-};