Merge next into master (#1547)

* feat: stricter `when` types and API (#1542) BREAKING CHANGE: 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 ```diff string() - .when('other', function (other) => { - if (other) return this.required() + .when('other', ([other], schema) => { + return other ? schema.required() : schema }) ``` * feat: concat() is shallow and does not merge (#1541) BREAKING CHANGE: 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 * feat: simplify base class hierarchy (#1543) BREAKING CHANGE: `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. ```diff 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 BREAKING CHANGE: object and array schema no longer parse JSON strings by default, nor do they return `null` for invalid casts. ```ts object().json().cast('{}') array().json().cast('[]') ``` to mimic the previous behavior * feat: Make Array generic consistent with others BREAKING CHANGE: 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 * chore: improve internal test run APIs and Error handling (#1545) * docs * WIP * chore: clean up internal test running APIs * fix order * feat: flat bundles and size reductions Use rollup to produce flat bundles of yup. * Publish v1.0.0-beta.1 * docs: pre release note Co-authored-by: Michael Li <xiaoyu.tamu@gmail.com>
jquense · Jan 3, 2022 · 366f7d8 · 366f7d8
1 parent 266f33a
commit 366f7d8
Show file tree

Hide file tree

Showing 64 changed files with 7,610 additions and 7,159 deletions.
diff --git a/.babelrc.js b/.babelrc.js
@@ -1,29 +1,17 @@
 module.exports = (api) => ({
   presets: [
     [
-      'babel-preset-jason/esm',
+      'babel-preset-env-modules',
       api.env() !== 'test'
         ? {
             ignoreBrowserslistConfig: true,
             modules: api.env() === 'esm' ? false : 'commonjs',
           }
         : {
             target: 'node',
-
-            // debug: true,
             targets: { node: 'current' },
           },
     ],
     ['@babel/preset-typescript', { allowDeclareFields: true }],
   ],
-  plugins: [
-    '@babel/plugin-proposal-logical-assignment-operators',
-    api.env() === 'modules' && [
-      'transform-rename-import',
-      {
-        original: 'lodash',
-        replacement: 'lodash-es',
-      },
-    ],
-  ].filter(Boolean),
 });
diff --git a/.eslintrc b/.eslintrc
@@ -3,6 +3,9 @@
   "env": {
     "browser": true
   },
+  "parserOptions": {
+    "requireConfigFile": false
+  },
   "rules": {
     "@typescript-eslint/no-shadow": "off",
     "@typescript-eslint/no-empty-interface": "off"
@@ -14,18 +17,14 @@
       "env": {
         "jest/globals": true
       },
-      "globals": {
-        "TestHelpers": false,
-        "sinon": true
-      },
       "rules": {
         "global-require": "off",
         "no-await-in-loop": "off",
         "jest/no-disabled-tests": "warn",
         "jest/no-focused-tests": "error",
         "jest/no-identical-title": "error",
         "jest/prefer-to-have-length": "warn",
-        "jest/valid-expect": "off"
+        "@typescript-eslint/no-empty-function": "off"
       }
     }
   ]

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,18 @@
+name: Test
+on:
+  push:
+    branches: [master, next]
+  pull_request:
+    branches: [master, next]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Node
+        uses: actions/setup-node@v2
+        with:
+          node-version: 'lts/*'
+          cache: 'yarn'
+      - run: yarn install --frozen-lockfile
+      - run: yarn test
diff --git a/.gitignore b/.gitignore
@@ -1,45 +1,46 @@
-# Logs
-logs
-*.log
-
-# Runtime data
-pids
-*.pid
-*.seed
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Compiled binary addons (http://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directory
-# Commenting this out is preferred by some people, see
-# https://npmjs.org/doc/faq.html#Should-I-check-my-node_modules-folder-into-git
-node_modules
-
-# Users Environment Variables
-.lock-wscript
-
-# =========================
-# Operating System Files
-# =========================
-
-# OSX
-# =========================
-
+# Logs
+logs
+*.log
+dts/
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directory
+# Commenting this out is preferred by some people, see
+# https://npmjs.org/doc/faq.html#Should-I-check-my-node_modules-folder-into-git
+node_modules
+
+# Users Environment Variables
+.lock-wscript
+
+# =========================
+# Operating System Files
+# =========================
+
+# OSX
+# =========================
+
 .DS_Store
 .AppleDouble
 .LSOverride
 
 # Icon must end with two \r
-Icon
+Icon
+
 
 # Thumbnails
 ._*
@@ -54,25 +55,25 @@ Icon
 Network Trash Folder
 Temporary Items
 .apdisk
-
-# Windows
-# =========================
-
-# Windows image file caches
-Thumbs.db
-ehthumbs.db
-
-# Folder config file
-Desktop.ini
-
-# Recycle Bin used on file shares
-$RECYCLE.BIN/
-
-# Windows Installer files
-*.cab
-*.msi
-*.msm
-*.msp
+
+# Windows
+# =========================
+
+# Windows image file caches
+Thumbs.db
+ehthumbs.db
+
+# Folder config file
+Desktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msm
+*.msp
 
 # Ignore build files
 lib/

diff --git a/CHANGELOG-pre.md b/CHANGELOG-pre.md
@@ -0,0 +1,103 @@
+# [1.0.0-beta.1](https://github.com/jquense/yup/compare/v1.0.0-beta.0...v1.0.0-beta.1) (2022-01-03)
+
+
+### Features
+
+* flat bundles and size reductions ([753abdf](https://github.com/jquense/yup/commit/753abdf329e33e43c334e405baa9c71999079480))
+
+
+
+# [1.0.0-beta.0](https://github.com/jquense/yup/compare/v1.0.0-alpha.4...v1.0.0-beta.0) (2021-12-29)
+
+
+* feat!: add json() method and remove default object/array coercion ([94b73c4](https://github.com/jquense/yup/commit/94b73c438b3d355253f488325e06c69378e71fc1))
+
+
+### Features
+
+* Make Array generic consistent with others ([a82353f](https://github.com/jquense/yup/commit/a82353f37735daec6e42d18bd4cc0efe52a20f50))
+
+
+### 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.
+
+```ts
+object().json().cast('{}')
+array().json().cast('[]')
+```
+to mimic the previous behavior
+
+
+
+# [1.0.0-alpha.4](https://github.com/jquense/yup/compare/v1.0.0-alpha.3...v1.0.0-alpha.4) (2021-12-29)
+
+### Bug Fixes
+
+- add originalValue to TestContext type ([#1527](https://github.com/jquense/yup/issues/1527)) ([fcc5ae7](https://github.com/jquense/yup/commit/fcc5ae710a1b3ef4b799532291faf894bdbcc11b)), closes [/github.com/abnersajr/DefinitelyTyped/blob/a186d99d0c3a92424691a82130374a1b9145c7cd/types/yup/index.d.ts#L446](https://github.com//github.com/abnersajr/DefinitelyTyped/blob/a186d99d0c3a92424691a82130374a1b9145c7cd/types/yup/index.d.ts/issues/L446)
+
+### Features
+
+- allow mixed schema to specify type check ([3923039](https://github.com/jquense/yup/commit/3923039558733d34586df2b282d34c5b6cbc5111))
+- concat() is shallow and does not merge ([#1541](https://github.com/jquense/yup/issues/1541)) ([a2f99d9](https://github.com/jquense/yup/commit/a2f99d9e8d8ba1b285fa6f48a0dd77a77f629ee4))
+- simplify base class hierarchy ([#1543](https://github.com/jquense/yup/issues/1543)) ([c184dcf](https://github.com/jquense/yup/commit/c184dcf644c09f3c4697cd3e5c795784a5315f77))
+- stricter `when` types and API ([#1542](https://github.com/jquense/yup/issues/1542)) ([da74254](https://github.com/jquense/yup/commit/da742545a228b909fef6f7fa526ea7b459d96051))
+
+### 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.
+
+```diff
+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 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
+
+```diff
+ string()
+-   .when('other', function (other) => {
+-      if (other) return this.required()
++   .when('other', ([other], schema) => {
++     return other ? schema.required() : schema
+  })
+```
+
+# [1.0.0-alpha.3](https://github.com/jquense/yup/compare/v0.32.11...v1.0.0-alpha.3) (2021-12-28)
+
+### Bug Fixes
+
+- schemaOf handles Dates ([c1fc816](https://github.com/jquense/yup/commit/c1fc816cdb03f7c9ff2e6745ff38a2b4f119d556))
+- **types:** use type import/export ([#1238](https://github.com/jquense/yup/issues/1238)) ([bc284b5](https://github.com/jquense/yup/commit/bc284b5dbd4541464eb4a4edee73cb4d50c00fa7))
+
+### Features
+
+- More intuitive Object generics, faster types ([#1540](https://github.com/jquense/yup/issues/1540)) ([912e0be](https://github.com/jquense/yup/commit/912e0bed1e0184ba9c94015dc187eb6f86bb84d5))
+
+# [1.0.0-alpha.2](https://github.com/jquense/yup/compare/v1.0.0-alpha.1...v1.0.0-alpha.2) (2020-12-18)
+
+# [1.0.0-alpha.1](https://github.com/jquense/yup/compare/v1.0.0-alpha.0...v1.0.0-alpha.1) (2020-12-18)
+
+### Bug Fixes
+
+- **types:** make properties optional ([ba107cb](https://github.com/jquense/yup/commit/ba107cb50302e5245b960ed9a33f1c2167cc5d73))
+- **types:** make properties optional ([495ae84](https://github.com/jquense/yup/commit/495ae84f8bfc22b9f4310700d4d8e9586584a4c7))
+
+### Features
+
+- remove unneeded Out type from schema ([0bf9732](https://github.com/jquense/yup/commit/0bf97327d406c9d982b2c0a93069bd047b53d5ef))
+
+# [1.0.0-alpha.0](https://github.com/jquense/yup/compare/v0.32.8...v1.0.0-alpha.0) (2020-12-14)
+
+### Features
+
+- add describe and meta to lazy, with resolve options ([e56fea3](https://github.com/jquense/yup/commit/e56fea3d09707e975fa1e3bc19fadaac4d8b065b))