Skip to content
This repository has been archived by the owner on Jul 10, 2024. It is now read-only.

chore(deps): bump zod-validation-error from 2.1.0 to 3.0.0 #41

Merged
merged 1 commit into from
Jan 19, 2024

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Jan 19, 2024

Bumps zod-validation-error from 2.1.0 to 3.0.0.

Release notes

Sourced from zod-validation-error's releases.

v3.0.0

Major Changes

  • deb4639: BREAKING CHANGE: Refactor ValidationError to accept ErrorOptions as second parameter.

    What changed?

    Previously, ValidationError accepted Array<ZodIssue> as 2nd parameter. Now, it accepts ErrorOptions which contains a cause property. If cause is a ZodError then it will extract the attached issues and expose them over error.details.

    Why?

    This change allows us to use ValidationError like a native JavaScript Error. For example, we can now do:

    import { ValidationError } from 'zod-validation-error';
    try {
    // attempt to do something that might throw an error
    } catch (err) {
    throw new ValidationError('Something went deeply wrong', { cause: err });
    }

    How can you update your code?

    If you are using ValidationError directly, then you need to update your code to pass ErrorOptions as a 2nd parameter.

    import { ValidationError } from 'zod-validation-error';
    // before
    const err = new ValidationError('Something went wrong', zodError.issues);
    // after
    const err = new ValidationError('Something went wrong', { cause: zodError });

    If you were never using ValidationError directly, then you don't need to do anything.

Changelog

Sourced from zod-validation-error's changelog.

3.0.0

Major Changes

  • deb4639: BREAKING CHANGE: Refactor ValidationError to accept ErrorOptions as second parameter.

    What changed?

    Previously, ValidationError accepted Array<ZodIssue> as 2nd parameter. Now, it accepts ErrorOptions which contains a cause property. If cause is a ZodError then it will extract the attached issues and expose them over error.details.

    Why?

    This change allows us to use ValidationError like a native JavaScript Error. For example, we can now do:

    import { ValidationError } from 'zod-validation-error';
    try {
    // attempt to do something that might throw an error
    } catch (err) {
    throw new ValidationError('Something went deeply wrong', { cause: err });
    }

    How can you update your code?

    If you are using ValidationError directly, then you need to update your code to pass ErrorOptions as a 2nd parameter.

    import { ValidationError } from 'zod-validation-error';
    // before
    const err = new ValidationError('Something went wrong', zodError.issues);
    // after
    const err = new ValidationError('Something went wrong', { cause: zodError });

    If you were never using ValidationError directly, then you don't need to do anything.

Commits
  • bfc7eaa chore: version packages
  • d42a422 docs: ensure the difference between error.toString and error is clear
  • 7facf89 refactor: move prefixMessage to its own file
  • 0a402e3 fix: drop accidental ternary operation
  • d86448b docs: add example for using zod-validation-error with react-hook-form
  • ee7015f test: cover the cause property in ValidationError tests
  • 4ad2589 docs: set options.cause as any
  • deb4639 feat: add changesets
  • 316e796 refactor: expose issues via details to ease the migration path
  • 9b6d169 docs: update docs
  • Additional commits viewable in compare view

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Jan 19, 2024
Copy link

socket-security bot commented Jan 19, 2024

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package New capabilities Transitives Size Publisher
npm/[email protected] None +1 669 kB jmike

🚮 Removed packages: npm/[email protected]

View full report↗︎

@lishaduck lishaduck force-pushed the dependabot/npm_and_yarn/zod-validation-error-3.0.0 branch from 363ced5 to c4fd31d Compare January 19, 2024 17:00
@lishaduck lishaduck enabled auto-merge January 19, 2024 17:12
Bumps [zod-validation-error](https://github.com/causaly/zod-validation-error) from 2.1.0 to 3.0.0.
- [Release notes](https://github.com/causaly/zod-validation-error/releases)
- [Changelog](https://github.com/causaly/zod-validation-error/blob/main/CHANGELOG.md)
- [Commits](causaly/zod-validation-error@v2.1.0...v3.0.0)

---
updated-dependencies:
- dependency-name: zod-validation-error
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
@lishaduck lishaduck force-pushed the dependabot/npm_and_yarn/zod-validation-error-3.0.0 branch from c4fd31d to 14d5b6c Compare January 19, 2024 18:44
@lishaduck lishaduck disabled auto-merge January 19, 2024 18:44
@lishaduck lishaduck merged commit a7495f8 into main Jan 19, 2024
5 checks passed
@dependabot dependabot bot deleted the dependabot/npm_and_yarn/zod-validation-error-3.0.0 branch January 19, 2024 18:45
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant