yup - npm Package Versions

1.0.0 (2023-02-08)

1.0.0-beta.8 (2022-11-10)

Bug Fixes

• check if field exists when generating defaults (37f686c)
• correct minor typo in README (#1760) (62786c4)
• don't return any for oneOf (74c5bc5), closes #1675
• export more types (f250109)
• string().notRequired() (#1824) (dcb4b63)
• TS 4.8 compat (bc74c34)
• types: undefined defaults produce optional outputs (1afbac0)

Features

• add some more type exports (d5e9c99)
• Export ValidateOptions, ISchema for external use (#1812) (584df11)
• respect nullable() with oneOf (#1757) (61ec302), closes #768 #104
• simplify email validation (440db3e)

BREAKING CHANGES

• previously oneOf required adding null explicitly to allowed values when using oneOf. Folks have found this confusing and unintuitive so I am deferring and adjusting the behavior
• Use a simpler regex for email addresses that aligns with browsers, and add docs about how to override.

1.0.0-beta.7 (2022-08-20)

1.0.0-beta.5 (2022-08-19)

Bug Fixes

• coarce -> coerce (#1677) (99aa257)
• docs: correct typo "coarce" to "coerce" (#1654) (f29ff71)

Features

• add cast nullability migration path. (#1749) (2bb099e)
• better Lazy types and deepPartial fixes (#1748) (e4ae6ed)

BREAKING CHANGES

• The types for Lazy have changes a bit, it's unlikely that this affects anyone but it is technically a breaking change.

1.0.0-beta.4 (2022-04-10)

Bug Fixes

• boolean: calling optional made it non-optional (4ba02a1), closes #1627

1.0.0-beta.3 (2022-03-09)

Bug Fixes

• correct minor typo in README (#1582) (facea53)
• partial() (1207261)

BREAKING CHANGES

• 'required' no longer adds a test for most schema, to determine if a schema is required, check it's spec.optional and spec.nullable values, also accessible via describe()

1.0.0-beta.2 (2022-01-21)

Bug Fixes

• add originalValue to TestContext type (#1527) (fcc5ae7), closes /github.com/abnersajr/DefinitelyTyped/blob/a186d99d0c3a92424691a82130374a1b9145c7cd/types/yup/index.d.ts#L446

• Merge next into master (#1547) (366f7d8), closes #1547 #1542 #1541 #1543 #1545

Features

• add Tuple type (#1546) (a8febdd)

BREAKING CHANGES

• The builder object version of when() requires then and otherwise to be functions (schema: Schema) => Schema.

• The function version of when() has been changed to make it easier to type. values are always passed as an array and schema, and options always the second and third argument. this is no longer set to the schema instance. and all functions must return a schema to be type safe

 string()
-   .when('other', function (other) => {
-      if (other) return this.required()
+   .when('other', ([other], schema) => {
+     return other ? schema.required() : schema
  })

• concat works shallowly now. Previously concat functioned like a deep merge for object, which produced confusing behavior with incompatible concat'ed schema. Now concat for objects works similar to how it works for other types, the provided schema is applied on top of the existing schema, producing a new schema that is the same as calling each builder method in order

• docs: update readme

• chore: update to readonly arrays and test string type narrowing

• test: add boolean tests

• docs: more docs

• feat: allow mixed schema to specify type check

• mixed schema are no longer treated as the base class for other schema types. It hasn't been for a while, but we've done some nasty prototype slinging to make it behave like it was. Now typescript types should be 1 to 1 with the actual classes yup exposes.

In general this should not affect anything unless you are extending (via addMethod or otherwise) mixed prototype.

import {
-  mixed,
+  Schema,
} from 'yup';

- addMethod(mixed, 'method', impl)
+ addMethod(Schema, 'method', impl)

• chore: prep work for toggling coercion

• Publish v1.0.0-alpha.4

• chore: docs

• feat!: add json() method and remove default object/array coercion

• object and array schema no longer parse JSON strings by default, nor do they return null for invalid casts.

object().json().cast('{}')
array().json().cast('[]')

to mimic the previous behavior

• feat: Make Array generic consistent with others

• types only, ArraySchema initial generic is the array type not the type of the array element. array<T>() is still the inner type.

• Publish v1.0.0-beta.0

• docs

1.0.0-beta.1 (2022-01-03)

Features

• flat bundles and size reductions (753abdf)

1.0.0-beta.0 (2021-12-29)

• feat!: add json() method and remove default object/array coercion (94b73c4)

Features

• Make Array generic consistent with others (a82353f)

BREAKING CHANGES

• types only, ArraySchema initial generic is the array type not the type of the array element. array<T>() is still the inner type.
• object and array schema no longer parse JSON strings by default, nor do they return null for invalid casts.

object().json().cast('{}')
array().json().cast('[]')

to mimic the previous behavior

1.0.0-alpha.4 (2021-12-29)

Bug Fixes

• add originalValue to TestContext type (#1527) (fcc5ae7), closes /github.com/abnersajr/DefinitelyTyped/blob/a186d99d0c3a92424691a82130374a1b9145c7cd/types/yup/index.d.ts#L446

Features

• allow mixed schema to specify type check (3923039)
• concat() is shallow and does not merge (#1541) (a2f99d9)
• simplify base class hierarchy (#1543) (c184dcf)
• stricter when types and API (#1542) (da74254)

BREAKING CHANGES

• mixed schema are no longer treated as the base class for other schema types. It hasn't been for a while, but we've done some nasty prototype slinging to make it behave like it was. Now typescript types should be 1 to 1 with the actual classes yup exposes.

In general this should not affect anything unless you are extending (via addMethod or otherwise) mixed prototype.

import {
-  mixed,
+  Schema,
} from 'yup';

- addMethod(mixed, 'method', impl)
+ addMethod(Schema, 'method', impl)

• concat works shallowly now. Previously concat functioned like a deep merge for object, which produced confusing behavior with incompatible concat'ed schema. Now concat for objects works similar to how it works for other types, the provided schema is applied on top of the existing schema, producing a new schema that is the same as calling each builder method in order
• The builder object version of when() requires then and otherwise to be functions (schema: Schema) => Schema.
• The function version of when() has been changed to make it easier to type. values are always passed as an array and schema, and options always the second and third argument. this is no longer set to the schema instance. and all functions must return a schema to be type safe

 string()
-   .when('other', function (other) => {
-      if (other) return this.required()
+   .when('other', ([other], schema) => {
+     return other ? schema.required() : schema
  })