Dev Build / cleanup (push) Canceled after 0s
Dev Build / typecheck (push) Canceled after 0s
Dev Build / build (linux-arm64, ubuntu-24.04-arm, linux-arm64) (push) Canceled after 0s
Dev Build / build (linux-x64, ubuntu-latest, linux-x64) (push) Canceled after 0s
Dev Build / build (win-x64, windows-latest, win32-x64) (push) Canceled after 0s
Dev Build / dispatch-dev-docker (push) Skipped
91 lines
2.8 KiB
Plaintext
91 lines
2.8 KiB
Plaintext
import { decode, encode } from './qss'
|
|
import type { AnySchema } from './validators'
|
|
|
|
/** Default `parseSearch` that strips leading '?' and JSON-parses values. */
|
|
export const defaultParseSearch = parseSearchWith(JSON.parse)
|
|
/** Default `stringifySearch` using JSON.stringify for complex values. */
|
|
export const defaultStringifySearch = stringifySearchWith(
|
|
JSON.stringify,
|
|
JSON.parse,
|
|
)
|
|
|
|
/**
|
|
* Build a `parseSearch` function using a provided JSON-like parser.
|
|
*
|
|
* The returned function strips a leading `?`, decodes values, and attempts to
|
|
* JSON-parse string values using the given `parser`.
|
|
*
|
|
* @param parser Function to parse a string value (e.g. `JSON.parse`).
|
|
* @returns A `parseSearch` function compatible with `Router` options.
|
|
* @link https://tanstack.com/router/latest/docs/framework/react/guide/custom-search-param-serialization
|
|
*/
|
|
export function parseSearchWith(parser: (str: string) => any) {
|
|
return (searchStr: string): AnySchema => {
|
|
if (searchStr[0] === '?') {
|
|
searchStr = searchStr.substring(1)
|
|
}
|
|
|
|
const query: Record<string, unknown> = decode(searchStr)
|
|
|
|
// Try to parse any query params that might be json
|
|
for (const key in query) {
|
|
const value = query[key]
|
|
if (typeof value === 'string') {
|
|
try {
|
|
query[key] = parser(value)
|
|
} catch (_err) {
|
|
// silent
|
|
}
|
|
}
|
|
}
|
|
|
|
return query
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Build a `stringifySearch` function using a provided serializer.
|
|
*
|
|
* Non-primitive values are serialized with `stringify`. If a `parser` is
|
|
* supplied, string values that are parseable are re-serialized to ensure
|
|
* symmetry with `parseSearch`.
|
|
*
|
|
* @param stringify Function to serialize a value (e.g. `JSON.stringify`).
|
|
* @param parser Optional parser to detect parseable strings.
|
|
* @returns A `stringifySearch` function compatible with `Router` options.
|
|
* @link https://tanstack.com/router/latest/docs/framework/react/guide/custom-search-param-serialization
|
|
*/
|
|
export function stringifySearchWith(
|
|
stringify: (search: any) => string,
|
|
parser?: (str: string) => any,
|
|
) {
|
|
const hasParser = typeof parser === 'function'
|
|
function stringifyValue(val: any) {
|
|
if (typeof val === 'object' && val !== null) {
|
|
try {
|
|
return stringify(val)
|
|
} catch (_err) {
|
|
// silent
|
|
}
|
|
} else if (hasParser && typeof val === 'string') {
|
|
try {
|
|
// Check if it's a valid parseable string.
|
|
// If it is, then stringify it again.
|
|
parser(val)
|
|
return stringify(val)
|
|
} catch (_err) {
|
|
// silent
|
|
}
|
|
}
|
|
return val
|
|
}
|
|
|
|
return (search: Record<string, any>) => {
|
|
const searchStr = encode(search, stringifyValue)
|
|
return searchStr ? `?${searchStr}` : ''
|
|
}
|
|
}
|
|
|
|
export type SearchSerializer = (searchObj: Record<string, any>) => string
|
|
export type SearchParser = (searchStr: string) => Record<string, any>
|