@tanstack/router-core 0.0.1-beta.9 → 1.97.24

package/src/Matches.ts

@@ -0,0 +1,94 @@
+import type { Constrain } from './utils'
+
+export type AnyMatchAndValue = { match: any; value: any }
+
+export type FindValueByIndex<
+  TKey,
+  TValue extends ReadonlyArray<any>,
+> = TKey extends `${infer TIndex extends number}` ? TValue[TIndex] : never
+
+export type FindValueByKey<TKey, TValue> =
+  TValue extends ReadonlyArray<any>
+    ? FindValueByIndex<TKey, TValue>
+    : TValue[TKey & keyof TValue]
+
+export type CreateMatchAndValue<TMatch, TValue> = TValue extends any
+  ? {
+      match: TMatch
+      value: TValue
+    }
+  : never
+
+export type NextMatchAndValue<
+  TKey,
+  TMatchAndValue extends AnyMatchAndValue,
+> = TMatchAndValue extends any
+  ? CreateMatchAndValue<
+      TMatchAndValue['match'],
+      FindValueByKey<TKey, TMatchAndValue['value']>
+    >
+  : never
+
+export type IsMatchKeyOf<TValue> =
+  TValue extends ReadonlyArray<any>
+    ? number extends TValue['length']
+      ? `${number}`
+      : keyof TValue & `${number}`
+    : TValue extends object
+      ? keyof TValue & string
+      : never
+
+export type IsMatchPath<
+  TParentPath extends string,
+  TMatchAndValue extends AnyMatchAndValue,
+> = `${TParentPath}${IsMatchKeyOf<TMatchAndValue['value']>}`
+
+export type IsMatchResult<
+  TKey,
+  TMatchAndValue extends AnyMatchAndValue,
+> = TMatchAndValue extends any
+  ? TKey extends keyof TMatchAndValue['value']
+    ? TMatchAndValue['match']
+    : never
+  : never
+
+export type IsMatchParse<
+  TPath,
+  TMatchAndValue extends AnyMatchAndValue,
+  TParentPath extends string = '',
+> = TPath extends `${string}.${string}`
+  ? TPath extends `${infer TFirst}.${infer TRest}`
+    ? IsMatchParse<
+        TRest,
+        NextMatchAndValue<TFirst, TMatchAndValue>,
+        `${TParentPath}${TFirst}.`
+      >
+    : never
+  : {
+      path: IsMatchPath<TParentPath, TMatchAndValue>
+      result: IsMatchResult<TPath, TMatchAndValue>
+    }
+
+export type IsMatch<TMatch, TPath> = IsMatchParse<
+  TPath,
+  TMatch extends any ? { match: TMatch; value: TMatch } : never
+>
+
+/**
+ * Narrows matches based on a path
+ * @experimental
+ */
+export const isMatch = <TMatch, TPath extends string>(
+  match: TMatch,
+  path: Constrain<TPath, IsMatch<TMatch, TPath>['path']>,
+): match is IsMatch<TMatch, TPath>['result'] => {
+  const parts = (path as string).split('.')
+  let part
+  let value: any = match
+
+  while ((part = parts.shift()) != null && value != null) {
+    value = value[part]
+  }
+
+  return value != null
+}

package/src/RouterProvider.ts

@@ -0,0 +1,20 @@
+import type { ViewTransitionOptions } from './router'
+
+export interface MatchLocation {
+  to?: string | number | null
+  fuzzy?: boolean
+  caseSensitive?: boolean
+  from?: string
+}
+
+export interface CommitLocationOptions {
+  replace?: boolean
+  resetScroll?: boolean
+  hashScrollIntoView?: boolean | ScrollIntoViewOptions
+  viewTransition?: boolean | ViewTransitionOptions
+  /**
+   * @deprecated All navigations use React transitions under the hood now
+   **/
+  startTransition?: boolean
+  ignoreBlocker?: boolean
+}

package/src/defer.ts

@@ -0,0 +1,52 @@
+import { defaultSerializeError } from './router'
+
+export const TSR_DEFERRED_PROMISE = Symbol.for('TSR_DEFERRED_PROMISE')
+
+export type DeferredPromiseState<T> =
+  | {
+      status: 'pending'
+      data?: T
+      error?: unknown
+    }
+  | {
+      status: 'success'
+      data: T
+    }
+  | {
+      status: 'error'
+      data?: T
+      error: unknown
+    }
+
+export type DeferredPromise<T> = Promise<T> & {
+  [TSR_DEFERRED_PROMISE]: DeferredPromiseState<T>
+}
+
+export function defer<T>(
+  _promise: Promise<T>,
+  options?: {
+    serializeError?: typeof defaultSerializeError
+  },
+) {
+  const promise = _promise as DeferredPromise<T>
+  // this is already deferred promise
+  if ((promise as any)[TSR_DEFERRED_PROMISE]) {
+    return promise
+  }
+  promise[TSR_DEFERRED_PROMISE] = { status: 'pending' }
+
+  promise
+    .then((data) => {
+      promise[TSR_DEFERRED_PROMISE].status = 'success'
+      promise[TSR_DEFERRED_PROMISE].data = data
+    })
+    .catch((error) => {
+      promise[TSR_DEFERRED_PROMISE].status = 'error'
+      ;(promise[TSR_DEFERRED_PROMISE] as any).error = {
+        data: (options?.serializeError ?? defaultSerializeError)(error),
+        __isServerError: true,
+      }
+    })
+
+  return promise
+}

package/src/index.ts

@@ -1,20 +1,207 @@
+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,
+} from './link'
+
+export type {
+  StartSerializer,
+  Serializable,
+  SerializerParse,
+  SerializerParseBy,
+  SerializerStringify,
+  SerializerStringifyBy,
+} 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,
+} from './Matches'
+export {
+  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 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,
+  LooseReturnType,
+  LooseAsyncReturnType,
+  ContextReturnType,
+  ContextAsyncReturnType,
+  ResolveRouteContext,
+  ResolveLoaderData,
+  RoutePrefix,
+  TrimPath,
+  TrimPathLeft,
+  TrimPathRight,
+  ResolveSearchSchemaFnInput,
+  ResolveSearchSchemaInput,
+  ResolveSearchSchemaFn,
+  ResolveSearchSchema,
+} from './route'
+
+export { defaultSerializeError } from './router'
+export type {
+  ViewTransitionOptions,
+  ExtractedBaseEntry,
+  ExtractedStream,
+  ExtractedPromise,
+  ExtractedEntry,
+  StreamState,
+  TrailingSlashOption,
+} from './router'
+
+export type { MatchLocation, CommitLocationOptions } 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 {
-  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'
+  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,
+  ControlledPromise,
+  ExtractObjects,
+  PartialMergeAllObject,
+  MergeAllPrimitive,
+  ExtractPrimitives,
+  PartialMergeAll,
+  Constrain,
+  ConstrainLiteral,
+  UnionToIntersection,
+  MergeAllObjects,
+  MergeAll,
+  ValidateJSON,
+} 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'