refactor: move expo-router imports to dedicated path

Author: piaccho

examples/expo-router-advanced/app/+native-intent.tsx

@@ -1,7 +1,7 @@
 import {
   createDetourNativeIntentHandler,
-  type NativeIntentArgs,
-} from '@swmansion/react-native-detour';
+  type DetourNativeIntentArgs,
+} from '@swmansion/react-native-detour/expo-router';
 import { applicationName } from 'expo-application';
 
 // Example of a custom native intent handler that first delegates to Detour for processing,
@@ -10,7 +10,7 @@ const detourHandler = createDetourNativeIntentHandler({
   hosts: [/\.godetour\.link$/i],
 });
 
-export async function redirectSystemPath(args: NativeIntentArgs) {
+export async function redirectSystemPath(args: DetourNativeIntentArgs) {
   // First let Detour process the incoming path to handle any matching deferred links.
   const detourResult = await detourHandler(args);
   if (detourResult !== args.path) {

examples/expo-router-native-intent/README.md

@@ -1,13 +1,13 @@
 # Detour Expo Router Native Intent Example
 
-This example demonstrates the **new Expo Router native-intent API** from `@swmansion/react-native-detour`.
+This example demonstrates the **new Expo Router native-intent API** from `@swmansion/react-native-detour/expo-router`.
 
 ## What this example shows
 
 Unlike the basic `examples/expo-router` setup, this app uses `createDetourNativeIntentHandler` in **resolve mode**:
 
 - `app/+native-intent.tsx`
-  - calls `createDetourNativeIntentHandler(...)` with `config` (`API_KEY`, `appID`, `timeoutMs`),
+  - calls `createDetourNativeIntentHandler(...)` with `config` (`apiKey`, `appID`, `timeoutMs`),
   - resolves Detour short links inside native intent,
   - maps resolved URLs to Expo Router paths via `mapToRoute`.
 - `app/_layout.tsx`

examples/expo-router-native-intent/app/+native-intent.tsx

@@ -1,4 +1,4 @@
-import { createDetourNativeIntentHandler } from '@swmansion/react-native-detour';
+import { createDetourNativeIntentHandler } from '@swmansion/react-native-detour/expo-router';
 
 const detourNativeIntentHandler = createDetourNativeIntentHandler({
   fallbackPath: '',

examples/expo-router/app/+native-intent.tsx

@@ -1,4 +1,4 @@
-import { createDetourNativeIntentHandler } from '@swmansion/react-native-detour';
+import { createDetourNativeIntentHandler } from '@swmansion/react-native-detour/expo-router';
 
 // Example of a custom native intent handler that delegates to Detour for processing.
 // It detects links from Detour domain by default, but you can customize it further with the `hosts` option to fit your needs.

package.json

@@ -10,6 +10,11 @@
       "types": "./lib/typescript/src/index.d.ts",
       "default": "./lib/module/index.js"
     },
+    "./expo-router": {
+      "source": "./src/expo-router/index.ts",
+      "types": "./lib/typescript/src/expo-router/index.d.ts",
+      "default": "./lib/module/expo-router/index.js"
+    },
     "./package.json": "./package.json"
   },
   "files": [

src/expo-router/index.ts

@@ -0,0 +1,9 @@
+export { createDetourNativeIntentHandler } from './nativeIntent';
+
+export type {
+  DetourNativeIntentArgs,
+  DetourNativeIntentHandler,
+  DetourNativeIntentOptions,
+  DetourNativeIntentResolveConfig,
+  DetourNativeIntentResolvedValue,
+} from './nativeIntent';

src/expo-router/nativeIntent.ts

@@ -5,7 +5,7 @@ import { getRouteFromDeepLink } from '../links/utils/urlHelpers';
 /**
  * Arguments passed by Expo Router to `redirectSystemPath`.
  */
-export type NativeIntentArgs = {
+export type DetourNativeIntentArgs = {
   /**
    * Incoming system path/URL that should be evaluated.
    */
@@ -19,21 +19,14 @@ export type NativeIntentArgs = {
 /**
  * Function signature compatible with Expo Router native intent handlers.
  */
-export type NativeIntentHandler = (
-  args: NativeIntentArgs
+export type DetourNativeIntentHandler = (
+  args: DetourNativeIntentArgs
 ) => string | Promise<string>;
 
-/**
- * Match context with a parsed URL object.
- */
-export type NativeIntentMatchContext = NativeIntentArgs & {
-  url: URL;
-};
-
 /**
  * Value passed to `mapToRoute` after URL resolution.
  */
-export type NativeIntentResolvedValue = {
+export type DetourNativeIntentResolvedValue = {
   /**
    * Original incoming system path passed by Expo Router.
    */
@@ -51,7 +44,10 @@ export type NativeIntentResolvedValue = {
 /**
  * Resolve configuration for `createDetourNativeIntentHandler`.
  */
-export type NativeIntentResolveConfig = Pick<Config, 'apiKey' | 'appID'> & {
+export type DetourNativeIntentResolveConfig = Pick<
+  Config,
+  'apiKey' | 'appID'
+> & {
   /**
    * Timeout for short-link resolution call.
    * Defaults to `1200` ms.
@@ -60,7 +56,7 @@ export type NativeIntentResolveConfig = Pick<Config, 'apiKey' | 'appID'> & {
   /**
    * Optional callback invoked when short-link resolution fails or times out.
    */
-  onResolveError?: (error: unknown, context: NativeIntentArgs) => void;
+  onResolveError?: (error: unknown, context: DetourNativeIntentArgs) => void;
 };
 
 /**
@@ -93,19 +89,14 @@ export type DetourNativeIntentOptions = {
    * Without this field, the handler works in intercept mode and simply returns
    * `fallbackPath` on host match.
    */
-  config?: NativeIntentResolveConfig;
+  config?: DetourNativeIntentResolveConfig;
   /**
    * Optional mapping callback used in resolve mode.
    * If omitted, SDK uses the default mapping strategy.
    */
-  mapToRoute?: (value: NativeIntentResolvedValue) => string;
+  mapToRoute?: (value: DetourNativeIntentResolvedValue) => string;
 };
 
-/**
- * Backward-compatible alias for options type.
- */
-export type NativeIntentOptions = DetourNativeIntentOptions;
-
 const DEFAULT_HOSTS: Array<string | RegExp> = [/\.godetour\.link$/i];
 const DEFAULT_TIMEOUT_MS = 1200;
 
@@ -186,7 +177,9 @@ const normalizeRoute = (value: string, fallbackPath: string) => {
  * Custom scheme mapping:
  * - convert to Expo Router path (`myapp://app/details?id=1` -> `/app/details?id=1`)
  */
-const defaultMapToRoute = ({ resolvedUrl }: NativeIntentResolvedValue) => {
+const defaultMapToRoute = ({
+  resolvedUrl,
+}: DetourNativeIntentResolvedValue) => {
   if (!isWebProtocol(resolvedUrl)) {
     return getRouteFromDeepLink(resolvedUrl);
   }
@@ -249,7 +242,7 @@ const withTimeout = async <T>(promise: Promise<T>, timeoutMs: number) => {
  * @returns A `redirectSystemPath` handler function compatible with Expo Router.
  * @example
  * ```tsx title="app/+native-intent.tsx"
- * import { createDetourNativeIntentHandler } from '@swmansion/react-native-detour';
+ * import { createDetourNativeIntentHandler } from '@swmansion/react-native-detour/expo-router';
  *
  * export const redirectSystemPath = createDetourNativeIntentHandler({
  *   fallbackPath: '',
@@ -258,7 +251,7 @@ const withTimeout = async <T>(promise: Promise<T>, timeoutMs: number) => {
  *
  * @example
  * ```tsx title="app/+native-intent.tsx"
- * import { createDetourNativeIntentHandler } from '@swmansion/react-native-detour';
+ * import { createDetourNativeIntentHandler } from '@swmansion/react-native-detour/expo-router';
  *
  * export const redirectSystemPath = createDetourNativeIntentHandler({
  *   fallbackPath: '',
@@ -268,12 +261,12 @@ const withTimeout = async <T>(promise: Promise<T>, timeoutMs: number) => {
  *
  * @example
  * ```tsx title="app/+native-intent.tsx"
- * import { createDetourNativeIntentHandler } from '@swmansion/react-native-detour';
+ * import { createDetourNativeIntentHandler } from '@swmansion/react-native-detour/expo-router';
  *
  * export const redirectSystemPath = createDetourNativeIntentHandler({
  *   fallbackPath: '',
  *   config: {
- *     API_KEY: process.env.EXPO_PUBLIC_DETOUR_API_KEY!,
+ *     apiKey: process.env.EXPO_PUBLIC_DETOUR_API_KEY!,
  *     appID: process.env.EXPO_PUBLIC_DETOUR_APP_ID!,
  *     timeoutMs: 1200,
  *   },
@@ -285,12 +278,12 @@ const withTimeout = async <T>(promise: Promise<T>, timeoutMs: number) => {
  */
 export const createDetourNativeIntentHandler = (
   options: DetourNativeIntentOptions = {}
-): NativeIntentHandler => {
+): DetourNativeIntentHandler => {
   const fallbackPath = options.fallbackPath ?? '';
   const hosts = options.hosts?.length ? options.hosts : DEFAULT_HOSTS;
   const mapToRoute = options.mapToRoute ?? defaultMapToRoute;
 
-  return async ({ path, initial }: NativeIntentArgs) => {
+  return async ({ path, initial }: DetourNativeIntentArgs) => {
     const url = parseIntentUrl(path);
     if (!url?.hostname) {
       return path;

src/index.ts

@@ -5,18 +5,6 @@ export type {
   DetourContextType,
   DetourStorage,
 } from './links/types/index';
-export type { ResolveShortLinkResponse } from './links/api/resolveShortLink';
 
 export { DetourAnalytics } from './analytics/analytics';
-export type { DetourEventNames } from './analytics/types/index';
-
-export { createDetourNativeIntentHandler } from './expo-router/nativeIntent';
-export type {
-  DetourNativeIntentOptions,
-  NativeIntentArgs,
-  NativeIntentHandler,
-  NativeIntentMatchContext,
-  NativeIntentOptions,
-  NativeIntentResolveConfig,
-  NativeIntentResolvedValue,
-} from './expo-router/nativeIntent';
+export { DetourEventNames } from './analytics/types/index';

tsconfig.json

@@ -2,7 +2,10 @@
   "compilerOptions": {
     "rootDir": ".",
     "paths": {
-      "@swmansion/react-native-detour": ["./src/index"]
+      "@swmansion/react-native-detour": ["./src/index"],
+      "@swmansion/react-native-detour/expo-router": [
+        "./src/expo-router/index"
+      ]
     },
     "allowUnreachableCode": false,
     "allowUnusedLabels": false,