@tanstack/router-core 0.0.1-beta.9 → 1.20.3-alpha.1

package/src/index.ts

@@ -1,20 +1,422 @@
+export { TSR_DEFERRED_PROMISE, defer } from './defer'
+export type { DeferredPromiseState, DeferredPromise } from './defer'
+export { preloadWarning } from './link'
+export type {
+  IsRequiredParams,
+  ParsePathParams,
+  AddTrailingSlash,
+  RemoveTrailingSlashes,
+  AddLeadingSlash,
+  RemoveLeadingSlashes,
+  ActiveOptions,
+  LinkOptionsProps,
+  ResolveCurrentPath,
+  ResolveParentPath,
+  ResolveRelativePath,
+  LinkCurrentTargetElement,
+  FindDescendantToPaths,
+  InferDescendantToPaths,
+  RelativeToPath,
+  RelativeToParentPath,
+  RelativeToCurrentPath,
+  AbsoluteToPath,
+  RelativeToPathAutoComplete,
+  NavigateOptions,
+  ToOptions,
+  ToMaskOptions,
+  ToSubOptions,
+  ResolveRoute,
+  SearchParamOptions,
+  PathParamOptions,
+  ToPathOption,
+  LinkOptions,
+  MakeOptionalPathParams,
+  FromPathOption,
+  MakeOptionalSearchParams,
+  MaskOptions,
+  ToSubOptionsProps,
+  RequiredToOptions,
+} from './link'
+
+export type {
+  RouteToPath,
+  TrailingSlashOptionByRouter,
+  ParseRoute,
+  CodeRouteToPath,
+  RouteIds,
+  FullSearchSchema,
+  FullSearchSchemaInput,
+  AllParams,
+  RouteById,
+  AllContext,
+  RoutePaths,
+  RoutesById,
+  RoutesByPath,
+  AllLoaderData,
+  RouteByPath,
+} from './routeInfo'
+
+export type {
+  InferFileRouteTypes,
+  FileRouteTypes,
+  FileRoutesByPath,
+  CreateFileRoute,
+  LazyRoute,
+  LazyRouteOptions,
+  CreateLazyFileRoute,
+} from './fileRoute'
+
+export type {
+  StartSerializer,
+  Serializable,
+  SerializerParse,
+  SerializerParseBy,
+  SerializerStringify,
+  SerializerStringifyBy,
+  SerializerExtensions,
+} from './serializer'
+
+export type { ParsedLocation } from './location'
+export type { Manifest, RouterManagedTag } from './manifest'
+export { isMatch } from './Matches'
+export type {
+  AnyMatchAndValue,
+  FindValueByIndex,
+  FindValueByKey,
+  CreateMatchAndValue,
+  NextMatchAndValue,
+  IsMatchKeyOf,
+  IsMatchPath,
+  IsMatchResult,
+  IsMatchParse,
+  IsMatch,
+  RouteMatch,
+  RouteMatchExtensions,
+  MakeRouteMatchUnion,
+  MakeRouteMatch,
+  AnyRouteMatch,
+  MakeRouteMatchFromRoute,
+  MatchRouteOptions,
+} from './Matches'
 export {
-  createHashHistory,
-  createBrowserHistory,
-  createMemoryHistory,
-} from 'history'
-
-export { default as invariant } from 'tiny-invariant'
-
-export * from './frameworks'
-export * from './index'
-export * from './link'
-export * from './path'
-export * from './qss'
-export * from './route'
-export * from './routeConfig'
-export * from './routeInfo'
-export * from './routeMatch'
-export * from './router'
-export * from './searchParams'
-export * from './utils'
+  joinPaths,
+  cleanPath,
+  trimPathLeft,
+  trimPathRight,
+  trimPath,
+  removeTrailingSlash,
+  exactPathTest,
+  resolvePath,
+  parsePathname,
+  interpolatePath,
+  matchPathname,
+  removeBasepath,
+  matchByPath,
+} from './path'
+export type { Segment } from './path'
+export { encode, decode } from './qss'
+export { rootRouteId } from './root'
+export type { RootRouteId } from './root'
+
+export { BaseRoute, BaseRouteApi, BaseRootRoute } from './route'
+export type {
+  AnyPathParams,
+  SearchSchemaInput,
+  AnyContext,
+  RouteContext,
+  PreloadableObj,
+  RoutePathOptions,
+  StaticDataRouteOption,
+  RoutePathOptionsIntersection,
+  SearchFilter,
+  SearchMiddlewareContext,
+  SearchMiddleware,
+  ResolveId,
+  InferFullSearchSchema,
+  InferFullSearchSchemaInput,
+  InferAllParams,
+  InferAllContext,
+  MetaDescriptor,
+  RouteLinkEntry,
+  SearchValidator,
+  AnySearchValidator,
+  DefaultSearchValidator,
+  ErrorRouteProps,
+  ErrorComponentProps,
+  NotFoundRouteProps,
+  ParseSplatParams,
+  SplatParams,
+  ResolveParams,
+  ParseParamsFn,
+  StringifyParamsFn,
+  ParamsOptions,
+  UpdatableStaticRouteOption,
+  ContextReturnType,
+  ContextAsyncReturnType,
+  ResolveRouteContext,
+  ResolveLoaderData,
+  RoutePrefix,
+  TrimPath,
+  TrimPathLeft,
+  TrimPathRight,
+  ResolveSearchSchemaFnInput,
+  ResolveSearchSchemaInput,
+  ResolveSearchSchemaFn,
+  ResolveSearchSchema,
+  ResolveFullSearchSchema,
+  ResolveFullSearchSchemaInput,
+  ResolveAllContext,
+  BeforeLoadContextParameter,
+  RouteContextParameter,
+  ResolveAllParamsFromParent,
+  AnyRoute,
+  Route,
+  RouteTypes,
+  FullSearchSchemaOption,
+  RemountDepsOptions,
+  MakeRemountDepsOptionsUnion,
+  ResolveFullPath,
+  AnyRouteWithContext,
+  RouteOptions,
+  FileBaseRouteOptions,
+  BaseRouteOptions,
+  UpdatableRouteOptions,
+  RouteLoaderFn,
+  LoaderFnContext,
+  RouteContextFn,
+  BeforeLoadFn,
+  ContextOptions,
+  RouteContextOptions,
+  BeforeLoadContextOptions,
+  RootRouteOptions,
+  UpdatableRouteOptionsExtensions,
+  RouteConstraints,
+  RouteTypesById,
+  RouteMask,
+  RouteExtensions,
+  RouteLazyFn,
+  RouteAddChildrenFn,
+  RouteAddFileChildrenFn,
+  RouteAddFileTypesFn,
+} from './route'
+
+export {
+  defaultSerializeError,
+  getLocationChangeInfo,
+  RouterCore,
+  componentTypes,
+  lazyFn,
+  SearchParamError,
+  PathParamError,
+  getInitialRouterState,
+  processRouteTree,
+  getMatchedRoutes,
+} from './router'
+export type {
+  ViewTransitionOptions,
+  ExtractedBaseEntry,
+  ExtractedStream,
+  ExtractedPromise,
+  ExtractedEntry,
+  StreamState,
+  TrailingSlashOption,
+  Register,
+  AnyRouter,
+  AnyRouterWithContext,
+  RegisteredRouter,
+  RouterState,
+  BuildNextOptions,
+  RouterListener,
+  RouterEvent,
+  ListenerFn,
+  RouterEvents,
+  MatchRoutesOpts,
+  RouterOptionsExtensions,
+  DefaultRemountDepsFn,
+  PreloadRouteFn,
+  MatchRouteFn,
+  RouterContextOptions,
+  RouterOptions,
+  RouterConstructorOptions,
+  UpdateFn,
+  ParseLocationFn,
+  InvalidateFn,
+  ControllablePromise,
+  InjectedHtmlEntry,
+  RouterErrorSerializer,
+  MatchedRoutesResult,
+  EmitFn,
+  LoadFn,
+  GetMatchFn,
+  SubscribeFn,
+  UpdateMatchFn,
+  CommitLocationFn,
+  GetMatchRoutesFn,
+  MatchRoutesFn,
+  StartTransitionFn,
+  LoadRouteChunkFn,
+  ServerSrr,
+  ClearCacheFn,
+  CreateRouterFn,
+} from './router'
+
+export type {
+  MatchLocation,
+  CommitLocationOptions,
+  NavigateFn,
+  BuildLocationFn,
+} from './RouterProvider'
+
+export { retainSearchParams, stripSearchParams } from './searchMiddleware'
+
+export {
+  defaultParseSearch,
+  defaultStringifySearch,
+  parseSearchWith,
+  stringifySearchWith,
+} from './searchParams'
+export type { SearchSerializer, SearchParser } from './searchParams'
+
+export type { OptionalStructuralSharing } from './structuralSharing'
+
+export {
+  last,
+  functionalUpdate,
+  pick,
+  replaceEqualDeep,
+  isPlainObject,
+  isPlainArray,
+  deepEqual,
+  escapeJSON,
+  shallow,
+  createControlledPromise,
+} from './utils'
+export type {
+  NoInfer,
+  IsAny,
+  PickAsRequired,
+  PickRequired,
+  PickOptional,
+  WithoutEmpty,
+  Expand,
+  DeepPartial,
+  MakeDifferenceOptional,
+  IsUnion,
+  IsNonEmptyObject,
+  Assign,
+  IntersectAssign,
+  Timeout,
+  Updater,
+  NonNullableUpdater,
+  StringLiteral,
+  ThrowOrOptional,
+  ThrowConstraint,
+  ControlledPromise,
+  ExtractObjects,
+  PartialMergeAllObject,
+  MergeAllPrimitive,
+  ExtractPrimitives,
+  PartialMergeAll,
+  Constrain,
+  ConstrainLiteral,
+  UnionToIntersection,
+  MergeAllObjects,
+  MergeAll,
+  ValidateJSON,
+  StrictOrFrom,
+  LooseReturnType,
+  LooseAsyncReturnType,
+} from './utils'
+
+export type {
+  StandardSchemaValidatorProps,
+  StandardSchemaValidator,
+  AnyStandardSchemaValidator,
+  StandardSchemaValidatorTypes,
+  AnyStandardSchemaValidateSuccess,
+  AnyStandardSchemaValidateFailure,
+  AnyStandardSchemaValidateIssue,
+  AnyStandardSchemaValidateInput,
+  AnyStandardSchemaValidate,
+  ValidatorObj,
+  AnyValidatorObj,
+  ValidatorAdapter,
+  AnyValidatorAdapter,
+  AnyValidatorFn,
+  ValidatorFn,
+  Validator,
+  AnyValidator,
+  AnySchema,
+  DefaultValidator,
+  ResolveSearchValidatorInputFn,
+  ResolveSearchValidatorInput,
+  ResolveValidatorInputFn,
+  ResolveValidatorInput,
+  ResolveValidatorOutputFn,
+  ResolveValidatorOutput,
+} from './validators'
+
+export type {
+  UseRouteContextBaseOptions,
+  UseRouteContextOptions,
+  UseRouteContextResult,
+} from './useRouteContext'
+
+export type { UseSearchResult, ResolveUseSearch } from './useSearch'
+
+export type { UseParamsResult, ResolveUseParams } from './useParams'
+
+export type { UseNavigateResult } from './useNavigate'
+
+export type { UseLoaderDepsResult, ResolveUseLoaderDeps } from './useLoaderDeps'
+
+export type { UseLoaderDataResult, ResolveUseLoaderData } from './useLoaderData'
+
+export type { Redirect, ResolvedRedirect, AnyRedirect } from './redirect'
+
+export {
+  redirect,
+  isRedirect,
+  isResolvedRedirect,
+  tsrRedirectHeaderKey,
+  parseRedirect,
+} from './redirect'
+
+export type { NotFoundError } from './not-found'
+export { isNotFound, notFound } from './not-found'
+
+export {
+  defaultGetScrollRestorationKey,
+  restoreScroll,
+  storageKey,
+  getCssSelector,
+  scrollRestorationCache,
+  setupScrollRestoration,
+  handleHashScroll,
+} from './scroll-restoration'
+
+export type {
+  ScrollRestorationOptions,
+  ScrollRestorationEntry,
+} from './scroll-restoration'
+
+export type {
+  ValidateFromPath,
+  ValidateToPath,
+  ValidateSearch,
+  ValidateParams,
+  InferFrom,
+  InferTo,
+  InferMaskTo,
+  InferMaskFrom,
+  ValidateNavigateOptions,
+  ValidateNavigateOptionsArray,
+  ValidateRedirectOptions,
+  ValidateRedirectOptionsArray,
+  ValidateId,
+  InferStrict,
+  InferShouldThrow,
+  InferSelected,
+  ValidateUseSearchResult,
+  ValidateUseParamsResult,
+} from './typePrimitives'