breaking: remove param files in folder in favor of params.js/ts file#16189
Draft
dummdidumm wants to merge 15 commits into
Draft
breaking: remove param files in folder in favor of params.js/ts file#16189dummdidumm wants to merge 15 commits into
params.js/ts file#16189dummdidumm wants to merge 15 commits into
Conversation
basically implements #10407 (comment): - new `parse` function can be exported from `params/someMatcher.js` - can be either alongside `match` or standalone - if it throws it counts as invalid and the route will not be matched closes #10407
match can now also be a standard schema. If it parses you get the transformed value. If it throws it counts as invalid and the route will not be matched. closes #10407
…`'~standard'` property, so callable Standard Schemas (e.g. ArkType) are misclassified as plain predicate functions, breaking validation and transformation.
This commit fixes the issue reported at packages/kit/src/utils/routing.js:139
## Bug
`ParamMatcher` is typed as `((param: string) => boolean) | StandardSchemaV1<string, any>`. Several headline Standard Schema implementations expose their schema as a **callable function that also carries a `'~standard'` property**. ArkType is the canonical example:
```js
const t = type('string.numeric.parse');
t('42'); // → 42 (parsed value, or an ArkErrors object on failure)
t['~standard'].validate('42'); // also available
```
In the original `run_matcher`, the `typeof matcher === 'function'` branch comes first:
```js
if (typeof matcher === 'function') {
return matcher(value) ? { success: true, value } : { success: false };
}
if ('~standard' in matcher) { ... }
```
Because an ArkType schema is a function, it never reaches the `'~standard'` branch. Instead `matcher(value)` is called and its return value treated as a boolean:
- **Invalid input**: ArkType returns a truthy `ArkErrors` object → treated as a *successful* match, and the raw, untransformed string is stored as the param value. The route matches when it should not.
- **Valid input that transforms to a falsy value** (e.g. `0`, empty string): the truthiness check fails → the route is incorrectly rejected.
So both validation and transformation are broken for callable Standard Schemas.
## Fix
Reorder the checks so `'~standard'` is tested first. `'~standard' in matcher` works on functions too (functions are objects), so a callable Standard Schema is now routed through the proper `validate` path. Plain predicate functions lack the `'~standard'` property and correctly fall through to the function branch.
```js
function run_matcher(matcher, value) {
if ('~standard' in matcher) {
const result = matcher['~standard'].validate(value);
if (result instanceof Promise || result.issues) {
return { success: false };
}
return { success: true, value: result.value };
}
if (typeof matcher === 'function') {
return matcher(value) ? { success: true, value } : { success: false };
}
return { success: false };
}
```
Co-authored-by: Vercel <vercel[bot]@users.noreply.github.com>
Co-authored-by: dummdidumm <sholthausen@web.de>
Instead of having to declare one param matcher per file, you now declare all of them within one file. A `defineParams` function both helps with declaring them in a type-safe way and also normalizes the property values: You can either parse a standard schema object, or a function that either throws or returns the parsed value (if you don't want to bring in a schema library). closes #10407 Kudos to @phi-bre for suggesting this in #16148 (comment)
🦋 Changeset detectedLatest commit: 4f2e270 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
![vercel[bot]](https://avatars.githubusercontent.com/in/8329?s=60&v=4){kind=small}
…cing the invalid path `src/params/.js` instead of `src/params.js`.
This commit fixes the issue reported at packages/kit/src/core/sync/write_types/index.js:605
## Bug
In `generate_params_type` (`write_types/index.js:606`) and the identical logic in `write_non_ambient.js:101`, the fallback used when `resolve_entry` returns `null` was:
```js
path.join(config.kit.files.params.replace(/.(js|ts)$/, ''), '.js');
```
`config.kit.files.params` defaults to `path.join(files.src, 'params')` → `src/params` (no extension). The `.replace(/.(js|ts)$/, '')` is a no-op there, and `path.join('src/params', '.js')` inserts a path separator, yielding `src/params/.js`. Even when the config value has an extension (e.g. `src/params.ts`), the replace strips it to `src/params` and `path.join` again yields `src/params/.js`.
Verified with Node:
```
$ node -e "console.log(require('path').join('src/params', '.js'))"
src/params/.js
```
### Trigger / impact
When a route references a matcher but `resolve_entry(config.kit.files.params)` returns `null` (params file not found at resolution time), the generated `$types`/app-types contain an import from the broken path `src/params/.js` instead of `src/params.js`, producing invalid type imports.
## Fix
Replaced `path.join(base, '.js')` with string concatenation `base + '.js'` in both locations:
```js
config.kit.files.params.replace(/.(js|ts)$/, '') + '.js';
```
Verified output is now `src/params.js` for both `src/params` and `src/params.ts` inputs.
Co-authored-by: Vercel <vercel[bot]@users.noreply.github.com>
Co-authored-by: dummdidumm <sholthausen@web.de>
|
Hello, Two remarks.
For example if I have this params : export const params = defineParams({
details: v.picklist(['min', 'standard', 'max']);
});I think this should be typed accordingly : resolve('/info/[details=details]', { details: 'min' }); // OK
resolve('/info/[details=details]', { details: 'minimum' }); // Type Error
For example, if I have bigint as uid, and I want to use it as hexadecimal on the URL : export const params = defineParams({
uid: {
// parse the uid as a hexa BigInt :
parse: v.pipe(v.string(),v.transform((value) => BigInt(`0x${value}`)),
// format the BigInt in hexa
format: (value) => value.toString(16)
}
}); |
Conduitry
changed the title
params.js/ts fileparams.js/ts file
Conduitry
reviewed
Jun 29, 2026
Co-authored-by: Conduitry <git@chor.date>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Instead of having to declare one param matcher per file, you now declare all of them within one file. A
defineParamsfunction both helps with declaring them in a type-safe way and also normalizes the property values: You can either parse a standard schema object, or a function that either throws or returns the parsed value (if you don't want to bring in a schema library).closes #10407
Kudos to @phi-bre for suggesting this in #16148 (comment)