@tanstack/router-core 0.0.1-beta.4 → 0.0.1-beta.45

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tanstack/router-core",
   "author": "Tanner Linsley",
-  "version": "0.0.1-beta.4",
+  "version": "0.0.1-beta.45",
   "license": "MIT",
   "repository": "tanstack/router",
   "homepage": "https://tanstack.com/router",
@@ -23,7 +23,7 @@
     "url": "https://github.com/sponsors/tannerlinsley"
   },
   "module": "build/esm/index.js",
-  "main": "build/cjs/packages/router-core/src/index.js",
+  "main": "build/cjs/index.js",
   "browser": "build/umd/index.production.js",
   "types": "build/types/index.d.ts",
   "engines": {
@@ -33,16 +33,18 @@
     "build/**",
     "src"
   ],
+  "sideEffects": false,
   "peerDependencies": {
     "react": ">=16",
     "react-dom": ">=16"
   },
   "dependencies": {
     "@babel/runtime": "^7.16.7",
+    "@solidjs/reactivity": "^0.0.6",
     "history": "^5.2.0",
     "tiny-invariant": "^1.3.1"
   },
   "devDependencies": {
     "babel-plugin-transform-async-to-promises": "^0.8.18"
   }
-}
+}

package/src/frameworks.ts

@@ -3,8 +3,8 @@ export interface FrameworkGenerics {
   // and are extended by framework adapters, but cannot be
   // pre-defined as constraints:
   //
-  // Element: any
-  // SyncOrAsyncElement?: any
+  // Component: any
+  // ErrorComponent: any
 }
 
 export type GetFrameworkGeneric<U> = U extends keyof FrameworkGenerics

package/src/index.ts

@@ -7,7 +7,6 @@ export {
 export { default as invariant } from 'tiny-invariant'
 
 export * from './frameworks'
-export * from './index'
 export * from './link'
 export * from './path'
 export * from './qss'
@@ -18,3 +17,4 @@ export * from './routeMatch'
 export * from './router'
 export * from './searchParams'
 export * from './utils'
+export * from './sharedClone'

package/src/link.ts

@@ -1,11 +1,16 @@
-import { AnyPathParams } from './routeConfig'
 import {
   AnyAllRouteInfo,
   DefaultAllRouteInfo,
   RouteInfoByPath,
 } from './routeInfo'
-import { Location } from './router'
-import { Expand, NoInfer, PickAsRequired, PickRequired, Updater } from './utils'
+import { Location, LocationState } from './router'
+import {
+  Expand,
+  NoInfer,
+  PickRequired,
+  UnionToIntersection,
+  Updater,
+} from './utils'
 
 export type LinkInfo =
   | {
@@ -58,7 +63,7 @@ export type Split<S, TIncludeTrailingSlash = true> = S extends unknown
   : never
 
 export type ParsePathParams<T extends string> = Split<T>[number] extends infer U
-  ? U extends `:${infer V}`
+  ? U extends `$${infer V}`
     ? V
     : never
   : never
@@ -106,11 +111,20 @@ export type RelativeToPathAutoComplete<
     ]
     ? `${TTo}${Join<RestPath>}`
     : never
-  : './' | '../' | AllPaths
+  :
+      | (TFrom extends `/`
+          ? never
+          : SplitPaths extends [...Split<TFrom, false>, ...infer RestPath]
+          ? Join<RestPath> extends { length: 0 }
+            ? never
+            : './'
+          : never)
+      | (TFrom extends `/` ? never : '../')
+      | AllPaths
 
-export type NavigateOptionsAbsolute<
+export type NavigateOptions<
   TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo,
-  TFrom extends ValidFromPath<TAllRouteInfo> = '/',
+  TFrom extends TAllRouteInfo['routePaths'] = '/',
   TTo extends string = '.',
 > = ToOptions<TAllRouteInfo, TFrom, TTo> & {
   // Whether to replace the current history stack instead of pushing a new one
@@ -119,13 +133,15 @@ export type NavigateOptionsAbsolute<
 
 export type ToOptions<
   TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo,
-  TFrom extends ValidFromPath<TAllRouteInfo> = '/',
+  TFrom extends TAllRouteInfo['routePaths'] = '/',
   TTo extends string = '.',
   TResolvedTo = ResolveRelativePath<TFrom, NoInfer<TTo>>,
 > = {
   to?: ToPathOption<TAllRouteInfo, TFrom, TTo>
   // The new has string or a function to update it
   hash?: Updater<string>
+  // State to pass to the history stack
+  state?: LocationState
   // The source route path. This is automatically set when using route-level APIs, but for type-safe relative routing on the router itself, this is required
   from?: TFrom
   // // When using relative route paths, this option forces resolution from the current path, instead of the route API's path or `from` path
@@ -134,57 +150,84 @@ export type ToOptions<
   SearchParamOptions<TAllRouteInfo, TFrom, TResolvedTo> &
   PathParamOptions<TAllRouteInfo, TFrom, TResolvedTo>
 
-type SearchParamOptions<
+export type SearchParamOptions<
   TAllRouteInfo extends AnyAllRouteInfo,
   TFrom,
   TTo,
-  TFromSchema = RouteInfoByPath<TAllRouteInfo, TFrom>['fullSearchSchema'],
-  TToSchema = RouteInfoByPath<TAllRouteInfo, TTo>['fullSearchSchema'],
-> = StartsWith<TFrom, TTo> extends true // If the next route search extend or cover the from route, params will be optional
-  ? {
-      search?: SearchReducer<TFromSchema, TToSchema>
-    }
-  : // Optional search params? Allow it
-  keyof PickRequired<TToSchema> extends never
+  TFromSchema = Expand<
+    UnionToIntersection<
+      TAllRouteInfo['fullSearchSchema'] &
+        RouteInfoByPath<TAllRouteInfo, TFrom> extends never
+        ? {}
+        : RouteInfoByPath<TAllRouteInfo, TFrom>['fullSearchSchema']
+    >
+  >,
+  // Find the schema for the new path, and make optional any keys
+  // that are already defined in the current schema
+  TToSchema = Partial<
+    RouteInfoByPath<TAllRouteInfo, TFrom>['fullSearchSchema']
+  > &
+    Omit<
+      RouteInfoByPath<TAllRouteInfo, TTo>['fullSearchSchema'],
+      keyof PickRequired<
+        RouteInfoByPath<TAllRouteInfo, TFrom>['fullSearchSchema']
+      >
+    >,
+  TFromFullSchema = Expand<
+    UnionToIntersection<TAllRouteInfo['fullSearchSchema'] & TFromSchema>
+  >,
+  TToFullSchema = Expand<
+    UnionToIntersection<TAllRouteInfo['fullSearchSchema'] & TToSchema>
+  >,
+> = keyof PickRequired<TToSchema> extends never
   ? {
-      search?: SearchReducer<TFromSchema, TToSchema>
+      search?: true | SearchReducer<TFromFullSchema, TToFullSchema>
     }
   : {
-      // Must have required search params, enforce it
-      search: SearchReducer<TFromSchema, TToSchema>
+      search: SearchReducer<TFromFullSchema, TToFullSchema>
     }
 
 type SearchReducer<TFrom, TTo> =
   | { [TKey in keyof TTo]: TTo[TKey] }
   | ((current: TFrom) => TTo)
 
-type PathParamOptions<
+export type PathParamOptions<
   TAllRouteInfo extends AnyAllRouteInfo,
   TFrom,
   TTo,
-  TFromParams = RouteInfoByPath<TAllRouteInfo, TFrom>['allParams'],
-  TToParams = RouteInfoByPath<TAllRouteInfo, TTo>['allParams'],
-> =
-  // If the next routes params extend or cover the from route, params will be optional
-  StartsWith<TFrom, TTo> extends true
-    ? {
-        params?: ParamsReducer<TFromParams, TToParams>
-      }
-    : // If the next route doesn't have params, warn if any have been passed
-    AnyPathParams extends TToParams
-    ? {
-        params?: ParamsReducer<TFromParams, Record<string, never>>
-      }
-    : // If the next route has params, enforce them
-      {
-        params: ParamsReducer<TFromParams, TToParams>
-      }
+  TFromSchema = Expand<
+    UnionToIntersection<
+      RouteInfoByPath<TAllRouteInfo, TFrom> extends never
+        ? {}
+        : RouteInfoByPath<TAllRouteInfo, TFrom>['allParams']
+    >
+  >,
+  // Find the schema for the new path, and make optional any keys
+  // that are already defined in the current schema
+  TToSchema = Partial<RouteInfoByPath<TAllRouteInfo, TFrom>['allParams']> &
+    Omit<
+      RouteInfoByPath<TAllRouteInfo, TTo>['allParams'],
+      keyof PickRequired<RouteInfoByPath<TAllRouteInfo, TFrom>['allParams']>
+    >,
+  TFromFullParams = Expand<
+    UnionToIntersection<TAllRouteInfo['allParams'] & TFromSchema>
+  >,
+  TToFullParams = Expand<
+    UnionToIntersection<TAllRouteInfo['allParams'] & TToSchema>
+  >,
+> = keyof PickRequired<TToSchema> extends never
+  ? {
+      params?: ParamsReducer<TFromFullParams, TToFullParams>
+    }
+  : {
+      params: ParamsReducer<TFromFullParams, TToFullParams>
+    }
 
 type ParamsReducer<TFrom, TTo> = TTo | ((current: TFrom) => TTo)
 
 export type ToPathOption<
   TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo,
-  TFrom extends ValidFromPath<TAllRouteInfo> = '/',
+  TFrom extends TAllRouteInfo['routePaths'] = '/',
   TTo extends string = '.',
 > =
   | TTo
@@ -196,7 +239,7 @@ export type ToPathOption<
 
 export type ToIdOption<
   TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo,
-  TFrom extends ValidFromPath<TAllRouteInfo> = '/',
+  TFrom extends TAllRouteInfo['routePaths'] = '/',
   TTo extends string = '.',
 > =
   | TTo
@@ -206,16 +249,16 @@ export type ToIdOption<
       NoInfer<TTo> & string
     >
 
-interface ActiveOptions {
+export interface ActiveOptions {
   exact?: boolean
   includeHash?: boolean
 }
 
 export type LinkOptions<
   TAllRouteInfo extends AnyAllRouteInfo = DefaultAllRouteInfo,
-  TFrom extends ValidFromPath<TAllRouteInfo> = '/',
+  TFrom extends TAllRouteInfo['routePaths'] = '/',
   TTo extends string = '.',
-> = NavigateOptionsAbsolute<TAllRouteInfo, TFrom, TTo> & {
+> = NavigateOptions<TAllRouteInfo, TFrom, TTo> & {
   // The standard anchor tag target attribute
   target?: HTMLAnchorElement['target']
   // Defaults to `{ exact: false, includeHash: false }`

package/src/path.ts

@@ -1,3 +1,4 @@
+import invariant from 'tiny-invariant'
 import { AnyPathParams } from './routeConfig'
 import { MatchLocation } from './router'
 import { last } from './utils'
@@ -97,7 +98,7 @@ export function parsePathname(pathname?: string): Segment[] {
         }
       }
 
-      if (part.charAt(0) === ':') {
+      if (part.charAt(0) === '$') {
         return {
           type: 'param',
           value: part,
@@ -145,29 +146,32 @@ export function interpolatePath(
 }
 
 export function matchPathname(
+  basepath: string,
   currentPathname: string,
   matchLocation: Pick<MatchLocation, 'to' | 'fuzzy' | 'caseSensitive'>,
 ): AnyPathParams | undefined {
-  const pathParams = matchByPath(currentPathname, matchLocation)
+  const pathParams = matchByPath(basepath, currentPathname, matchLocation)
   // const searchMatched = matchBySearch(currentLocation.search, matchLocation)
 
   if (matchLocation.to && !pathParams) {
     return
   }
 
-  // if (matchLocation.search && !searchMatched) {
-  //   return
-  // }
-
   return pathParams ?? {}
 }
 
 export function matchByPath(
+  basepath: string,
   from: string,
   matchLocation: Pick<MatchLocation, 'to' | 'caseSensitive' | 'fuzzy'>,
 ): Record<string, string> | undefined {
+  if (!from.startsWith(basepath)) {
+    return undefined
+  }
+  from = basepath != '/' ? from.substring(basepath.length) : from
   const baseSegments = parsePathname(from)
-  const routeSegments = parsePathname(`${matchLocation.to ?? '*'}`)
+  const to = `${matchLocation.to ?? '*'}`
+  const routeSegments = parsePathname(to)
 
   const params: Record<string, string> = {}
 
@@ -219,7 +223,7 @@ export function matchByPath(
           if (baseSegment?.value === '/') {
             return false
           }
-          if (!baseSegment.value.startsWith(':')) {
+          if (baseSegment.value.charAt(0) !== '$') {
             params[routeSegment.value.substring(1)] = baseSegment.value
           }
         }