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

package/src/qss.ts

@@ -1,54 +1,83 @@
-// @ts-nocheck
-
-// qss has been slightly modified and inlined here for our use cases (and compression's sake). We've included it as a hard dependency for MIT license attribution.
-
-export function encode(obj, pfx?: string) {
-  var k,
-    i,
-    tmp,
-    str = ''
-
-  for (k in obj) {
-    if ((tmp = obj[k]) !== void 0) {
-      if (Array.isArray(tmp)) {
-        for (i = 0; i < tmp.length; i++) {
-          str && (str += '&')
-          str += encodeURIComponent(k) + '=' + encodeURIComponent(tmp[i])
-        }
-      } else {
-        str && (str += '&')
-        str += encodeURIComponent(k) + '=' + encodeURIComponent(tmp)
-      }
+/**
+ * Program is a reimplementation of the `qss` package:
+ * Copyright (c) Luke Edwards luke.edwards05@gmail.com, MIT License
+ * https://github.com/lukeed/qss/blob/master/license.md
+ *
+ * This reimplementation uses modern browser APIs
+ * (namely URLSearchParams) and TypeScript while still
+ * maintaining the original functionality and interface.
+ */
+import { hasUriEncodedChars } from './utils'
+
+/**
+ * Encodes an object into a query string.
+ * @param obj - The object to encode into a query string.
+ * @param [pfx] - An optional prefix to add before the query string.
+ * @returns The encoded query string.
+ * @example
+ * ```
+ * // Example input: encode({ token: 'foo', key: 'value' })
+ * // Expected output: "token=foo&key=value"
+ * ```
+ */
+export function encode(obj: any, pfx?: string) {
+  const normalizedObject = Object.entries(obj).flatMap(([key, value]) => {
+    if (Array.isArray(value)) {
+      return value.map((v) => [key, String(v)])
+    } else {
+      return [[key, String(value)]]
     }
-  }
+  })
+
+  const searchParams = new URLSearchParams(normalizedObject)
 
-  return (pfx || '') + str
+  return (pfx || '') + searchParams.toString()
 }
 
-function toValue(mix) {
+/**
+ * Converts a string value to its appropriate type (string, number, boolean).
+ * @param mix - The string value to convert.
+ * @returns The converted value.
+ * @example
+ * // Example input: toValue("123")
+ * // Expected output: 123
+ */
+function toValue(mix: any) {
   if (!mix) return ''
-  var str = decodeURIComponent(mix)
+  const str = hasUriEncodedChars(mix)
+    ? decodeURIComponent(mix)
+    : decodeURIComponent(encodeURIComponent(mix))
+
   if (str === 'false') return false
   if (str === 'true') return true
-  if (str.charAt(0) === '0') return str
-  return +str * 0 === 0 ? +str : str
+  return +str * 0 === 0 && +str + '' === str ? +str : str
 }
 
-export function decode(str) {
-  var tmp,
-    k,
-    out = {},
-    arr = str.split('&')
-
-  while ((tmp = arr.shift())) {
-    tmp = tmp.split('=')
-    k = tmp.shift()
-    if (out[k] !== void 0) {
-      out[k] = [].concat(out[k], toValue(tmp.shift()))
+/**
+ * Decodes a query string into an object.
+ * @param str - The query string to decode.
+ * @param [pfx] - An optional prefix to filter out from the query string.
+ * @returns The decoded key-value pairs in an object format.
+ * @example
+ * // Example input: decode("token=foo&key=value")
+ * // Expected output: { "token": "foo", "key": "value" }
+ */
+export function decode(str: any, pfx?: string): any {
+  const searchParamsPart = pfx ? str.slice(pfx.length) : str
+  const searchParams = new URLSearchParams(searchParamsPart)
+
+  const entries = [...searchParams.entries()]
+
+  return entries.reduce<Record<string, unknown>>((acc, [key, value]) => {
+    const previousValue = acc[key]
+    if (previousValue == null) {
+      acc[key] = toValue(value)
     } else {
-      out[k] = toValue(tmp.shift())
+      acc[key] = Array.isArray(previousValue)
+        ? [...previousValue, toValue(value)]
+        : [previousValue, toValue(value)]
     }
-  }
 
-  return out
+    return acc
+  }, {})
 }

package/src/redirect.ts

@@ -0,0 +1,100 @@
+import type { NavigateOptions } from './link'
+import type { AnyRouter, RegisteredRouter } from './router'
+
+export const tsrRedirectHeaderKey = 'X-Tanstack-Router-Redirect-Options'
+
+export type AnyRedirect = Redirect<any, any, any, any, any>
+
+/**
+ * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RedirectType)
+ */
+export type Redirect<
+  TRouter extends AnyRouter = RegisteredRouter,
+  TFrom extends string = string,
+  TTo extends string | undefined = undefined,
+  TMaskFrom extends string = TFrom,
+  TMaskTo extends string = '.',
+> = Response & {
+  options: NavigateOptions<TRouter, TFrom, TTo, TMaskFrom, TMaskTo>
+  redirectHandled?: boolean
+}
+
+export type RedirectOptions<
+  TRouter extends AnyRouter = RegisteredRouter,
+  TFrom extends string = string,
+  TTo extends string | undefined = undefined,
+  TMaskFrom extends string = TFrom,
+  TMaskTo extends string = '.',
+> = {
+  href?: string
+  /**
+   * @deprecated Use `statusCode` instead
+   **/
+  code?: number
+  /**
+   * The HTTP status code to use when redirecting.
+   * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RedirectType#statuscode-property)
+   */
+  statusCode?: number
+  /**
+   * If provided, will throw the redirect object instead of returning it. This can be useful in places where `throwing` in a function might cause it to have a return type of `never`. In that case, you can use `redirect({ throw: true })` to throw the redirect object instead of returning it.
+   * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RedirectType#throw-property)
+   */
+  throw?: any
+  /**
+   * The HTTP headers to use when redirecting.
+   * @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RedirectType#headers-property)
+   */
+  headers?: HeadersInit
+} & NavigateOptions<TRouter, TFrom, TTo, TMaskFrom, TMaskTo>
+
+export type ResolvedRedirect<
+  TRouter extends AnyRouter = RegisteredRouter,
+  TFrom extends string = string,
+  TTo extends string = '',
+  TMaskFrom extends string = TFrom,
+  TMaskTo extends string = '',
+> = Redirect<TRouter, TFrom, TTo, TMaskFrom, TMaskTo>
+
+export function redirect<
+  TRouter extends AnyRouter = RegisteredRouter,
+  const TTo extends string | undefined = '.',
+  const TFrom extends string = string,
+  const TMaskFrom extends string = TFrom,
+  const TMaskTo extends string = '',
+>(
+  opts: RedirectOptions<TRouter, TFrom, TTo, TMaskFrom, TMaskTo>,
+): Redirect<TRouter, TFrom, TTo, TMaskFrom, TMaskTo> {
+  opts.statusCode = opts.statusCode || opts.code || 307
+  const headers = new Headers(opts.headers || {})
+
+  const response = new Response(null, {
+    status: opts.statusCode,
+    headers,
+  })
+
+  ;(response as Redirect<TRouter, TFrom, TTo, TMaskFrom, TMaskTo>).options =
+    opts
+
+  if (opts.throw) {
+    throw response
+  }
+
+  return response as Redirect<TRouter, TFrom, TTo, TMaskFrom, TMaskTo>
+}
+
+export function isRedirect(obj: any): obj is AnyRedirect {
+  return obj instanceof Response && !!(obj as any).options
+}
+
+export function isResolvedRedirect(obj: any): obj is AnyRedirect {
+  return isRedirect(obj) && !!obj.options.href
+}
+
+export function parseRedirect(obj: any) {
+  if (typeof obj === 'object' && obj.isSerializedRedirect) {
+    return redirect(obj)
+  }
+
+  return undefined
+}

package/src/root.ts

@@ -0,0 +1,2 @@
+export const rootRouteId = '__root__'
+export type RootRouteId = typeof rootRouteId