Lowercase ULIDs should be considered valid ULIDs #3582
Comments
Waziio
pushed a commit
to Waziio/zod
that referenced
this issue
Jun 21, 2024
|
Hello ! I have modified the ULID regex to make it case insensitive. Here is the PR |
colinhacks
added a commit
that referenced
this issue
Jun 29, 2024
alexandresoro
pushed a commit
to alexandresoro/ouca
that referenced
this issue
Dec 22, 2024
This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [zod](https://zod.dev) ([source](https://github.com/colinhacks/zod)) | dependencies | minor | [`3.23.8` -> `3.24.1`](https://renovatebot.com/diffs/npm/zod/3.23.8/3.24.1) | --- ### Release Notes <details> <summary>colinhacks/zod (zod)</summary> ### [`v3.24.1`](https://github.com/colinhacks/zod/releases/tag/v3.24.1) [Compare Source](colinhacks/zod@v3.24.0...v3.24.1) ##### Commits: - [`0c6cbbd`](colinhacks/zod@0c6cbbd) Undeprecate .nonempty() - [`4e219d6`](colinhacks/zod@4e219d6) Bump min TS version to 5.0 - [`65adeea`](colinhacks/zod@65adeea) v3.24.1 ### [`v3.24.0`](https://github.com/colinhacks/zod/releases/tag/v3.24.0) [Compare Source](colinhacks/zod@v3.23.8...v3.24.0) ##### Implement `@standard-schema/spec` This is the first version of Zod to implement the [Standard Schema](https://github.com/standard-schema/standard-schema) spec. This is a new community effort among several validation library authors to implement a common interface, with the goal of simplifying the process of integrating schema validators with the rest of the ecosystem. Read more about the project and goals [here](https://github.com/standard-schema/standard-schema). ##### `z.string().jwt()` Thanks to [@​Mokshit06](https://github.com/Mokshit06) and [@​Cognition-Labs](https://github.com/Cognition-Labs) for this contribution! To verify that a string is a valid 3-part JWT. z.string().jwt(); >⚠️ This does not *verify* your JWT cryptographically! It merely ensures its in the proper format. Use a library like [`jsonwebtoken`](https://github.com/auth0/node-jsonwebtoken) to verify the JWT signature, parse the token, and read the claims. To constrain the JWT to a specific algorithm: ```ts z.string().jwt({ alg: "RS256" }); ``` ##### `z.string().base64url()` Thank you to [@​marvinruder](https://github.com/marvinruder)! To complement the JWT validation, Zod 3.24 implements a standalone `.base64url()` string validation API. (The three elements of JWTs are base64url-encoded JSON strings.) ```ts z.string().base64url() ``` This functionality is available along the standard `z.string().base64()` validator added in Zod 3.23. ##### `z.string().cidr()` Thanks to [@​wataryooou](https://github.com/wataryooou) for their work on this! A validator for [CIDR notation](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) for specifying IP address ranges, e.g. `192.24.12.0/22`. ```ts z.string().cidr() ``` To specify an IP version: ```ts z.string().cidr({ version: "v4" }) z.string().cidr({ version: "v6" }) ``` *** View the full diff from 3.23.8: colinhacks/zod@v3.23.8...v3.24.0 - [`294f54f`](colinhacks/zod@294f54f) Update README_ZH.md about Discriminated unions ([#​3493](colinhacks/zod#3493)) - [`1247caf`](colinhacks/zod@1247caf) Add Kubb as X-to-Zod community tool ([#​3508](colinhacks/zod#3508)) - [`62b7842`](colinhacks/zod@62b7842) Update default branch - [`c6bc80d`](colinhacks/zod@c6bc80d) Fix issue [#​3582](colinhacks/zod#3582) : ULID should be case insensitive ([#​3593](colinhacks/zod#3593)) - [`a5b9dc3`](colinhacks/zod@a5b9dc3) docs: add zod-schema-faker to ecosystem ([#​3605](colinhacks/zod#3605)) - [`9818d0e`](colinhacks/zod@9818d0e) Add zod-sockets ([#​3609](colinhacks/zod#3609)) - [`7173d0b`](colinhacks/zod@7173d0b) Add drizzle-zod library to X to Zod README.md section ([#​3648](colinhacks/zod#3648)) - [`c5a4edc`](colinhacks/zod@c5a4edc) Add 'schemql' in Powered by Zod ([#​3800](colinhacks/zod#3800)) - [`85916b3`](colinhacks/zod@85916b3) docs: add zod-form-renderer to form integration docs ([#​3697](colinhacks/zod#3697)) - [`51f1dc3`](colinhacks/zod@51f1dc3) docs: add unplugin-environment in powered by zod ([#​3778](colinhacks/zod#3778)) - [`8e74db3`](colinhacks/zod@8e74db3) fix: ipv6 regex validation ([#​3513](colinhacks/zod#3513)) - [`1f4f0da`](colinhacks/zod@1f4f0da) refactor: rename ip version types ([#​3755](colinhacks/zod#3755)) - [`f487d74`](colinhacks/zod@f487d74) Remove faulty ip test case - [`48f1c47`](colinhacks/zod@48f1c47) docs: Remove invalid semicolon in ERROR_HANDLING.md ([#​3857](colinhacks/zod#3857)) - [`1d0a4b9`](colinhacks/zod@1d0a4b9) fix: bigint coerce crash ([#​3822](colinhacks/zod#3822)) - [`14dceaa`](colinhacks/zod@14dceaa) Add API library ([#​3814](colinhacks/zod#3814)) - [`f82f817`](colinhacks/zod@f82f817) feat: z.string.cidr() - support CIDR notation ([#​3820](colinhacks/zod#3820)) - [`71a0c33`](colinhacks/zod@71a0c33) docs: add info on unqualified local datetime strings ([#​3760](colinhacks/zod#3760)) - [`b85686a`](colinhacks/zod@b85686a) Add support for `base64url` strings ([#​3712](colinhacks/zod#3712)) - [`6407bed`](colinhacks/zod@6407bed) Allow creation of discriminated unions with a readonly array of options ([#​3535](colinhacks/zod#3535)) - [`3755146`](colinhacks/zod@3755146) Remove createParams cascade from .array() ([#​3530](colinhacks/zod#3530)) - [`963386d`](colinhacks/zod@963386d) Fix lint - [`69a1798`](colinhacks/zod@69a1798) Implement Standard Schema spec ([#​3850](colinhacks/zod#3850)) - [`c1dd537`](colinhacks/zod@c1dd537) Adds `frrm` package to documentation ([#​3818](colinhacks/zod#3818)) - [`b68c05f`](colinhacks/zod@b68c05f) feat: Add JWT string validator ([#​3893](colinhacks/zod#3893)) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOS44Mi4wIiwidXBkYXRlZEluVmVyIjoiMzkuODIuMCIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiZGVwZW5kZW5jaWVzIl19--> Reviewed-on: https://git.tristess.app/alexandresoro/ouca/pulls/406 Reviewed-by: Alexandre Soro <code@soro.dev> Co-authored-by: renovate <renovate@git.tristess.app> Co-committed-by: renovate <renovate@git.tristess.app>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Hello everyone.
For a project at work our API uses ULIDs. I noticed Zod comes with a ULID validator built in, however, it always marks our ULIDs as invalid. After a short investigation, I learned that only uppercase ULIDs are considered valid by Zod.
I think the regex Zod uses to check ULID validity, should also allow lowercase ULIDs (or even mix of upper and lower case) as the ULID spec indicates they are case insensitive.
The simple workaround we use right now is
z.string().toUpperCase().ulid()(we used to userefine()and a custom validation function), but imo it's not ideal as it affects other validation checks and it might be confusing to other users why lowercase ULIDs are considered invalid. wdyt?I don't mind working on this myself, as I believe it's just updating the regex to be case insensitive and making sure tests still succeed.
The text was updated successfully, but these errors were encountered: