diff --git a/CHANGELOG.md b/CHANGELOG.md index 170b61bb..bd36e558 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,539 +1,573 @@ # Changelog All notable changes to this project will be documented in this auto-generated -file. The format is based on [Conventional Commits][1]; this project adheres to -[Semantic Versioning][2]. +file. The format is based on [Conventional Commits][125]; this project adheres +to [Semantic Versioning][126]. -### [1.2.24][3] (2021-05-08) +## [2.0.0][127] (2021-06-27) + +### 💥 BREAKING CHANGES 💥 + +- **_package.json_:** **this version (and the version before this version) no + longer works with next@<10** + +#### ✨ Features + +- Add `url` and `paramsPatcher` ([ee31fa8][128]) + +#### ⚙️ Build system + +- Switch to @xunnamius/conventional-changelog-projector shared config + ([bc7eb3d][129]) +- Update dependencies ([20ca255][130]) +- **package.json:** update dependencies ([2f1125c][131]) +- **package.json:** update dependencies ([7583209][132]) +- **package.json:** update next peer dependency to >=10.0.x ([bc5e72d][133]) + +### [1.2.24][1] (2021-05-08) #### 🪄 Fixes -- **index.ts:** next 10.2.0 compat ([af177c5][4]) +- **index.ts:** next 10.2.0 compat ([af177c5][2]) #### ⚙️ Build system - **.github:** split BTD workflow into two separate workflows (security) - ([99ad127][5]) + ([99ad127][3]) - **.github/workflows:** disable old pipeline; begin transition to new pipeline - ([364549e][6]) -- **.github/workflows:** overhaul pipeline workflows ([4db5d04][7]) + ([364549e][4]) +- **.github/workflows:** overhaul pipeline workflows ([4db5d04][5]) - **contributing.md:** split pipeline architecture information off into workflow - README.md ([6d52302][8]) + README.md ([6d52302][6]) - **package.json:** ensure hidden dirs' markdown files are seen by remark - (linted and formatted) ([1f7fad4][9]) -- **package.json:** update dependencies ([d328a86][10]) -- **readme.md:** fix broken links ([6e7173f][11]) -- **readme.md:** improvements ([23cb780][12]) + (linted and formatted) ([1f7fad4][7]) +- **package.json:** update dependencies ([d328a86][8]) +- **readme.md:** fix broken links ([6e7173f][9]) +- **readme.md:** improvements ([23cb780][10]) - **readme.md:** include architecture description as workflow README.md - ([1f25e5f][13]) + ([1f25e5f][11]) -### [1.2.23][14] (2021-03-14) +### [1.2.23][12] (2021-03-14) #### ⚙️ Build system -- Better documentation ([0040582][15]) +- Better documentation ([0040582][13]) -### [1.2.22][16] (2021-03-12) +### [1.2.22][14] (2021-03-12) #### ⚙️ Build system -- Update dependencies and fix find-package-json usage ([df9ede3][17]) +- Update dependencies and fix find-package-json usage ([df9ede3][15]) -### [1.2.21][18] (2021-03-12) +### [1.2.21][16] (2021-03-12) #### ⚙️ Build system -- **build-test-deploy.yml:** actions version updates ([29aa25a][19]) +- **build-test-deploy.yml:** actions version updates ([29aa25a][17]) - **build-test-deploy.yml:** rollback some pipeline version updates - ([8065757][20]) -- **package.json:** fix typedoc-markdown-plugin patch ([dd3e7fa][21]) - closes [#126][22] + ([8065757][18]) +- **package.json:** fix typedoc-markdown-plugin patch ([dd3e7fa][19]) + closes [#126][20] -### [1.2.20][23] (2021-02-22) +### [1.2.20][21] (2021-02-22) #### ⚙️ Build system -- **package-lock.json:** update deps ([5a2d98f][24]) +- **package-lock.json:** update deps ([5a2d98f][22]) -### [1.2.19][25] (2021-02-22) +### [1.2.19][23] (2021-02-22) #### 🪄 Fixes -- **.changelogrc.js:** fix dark magic ([b4157eb][26]) -- **is-next-compat.ts:** never use console.log ([81533c8][27]) -- **is-next-compat.ts:** use template string instead of literal ([3a4f0f1][28]) -- **unit-index.test.ts:** 100% test coverage ([72189e8][29]) +- **.changelogrc.js:** fix dark magic ([b4157eb][24]) +- **is-next-compat.ts:** never use console.log ([81533c8][25]) +- **is-next-compat.ts:** use template string instead of literal ([3a4f0f1][26]) +- **unit-index.test.ts:** 100% test coverage ([72189e8][27]) #### ⚙️ Build system -- **.eslintrc.js:** account for node 12 ([cad0fb2][30]) -- **.github:** update workflows and templates ([54e51eb][31]) +- **.eslintrc.js:** account for node 12 ([cad0fb2][28]) +- **.github:** update workflows and templates ([54e51eb][29]) - **integration-external.test.ts:** ensure proper cwd is used for executing - externals ([31c1d5b][32]) + externals ([31c1d5b][30]) - **is-next-compat.ts:** use execa instead of shelljs under the hood - ([9d12004][33]) -- **package.json:** remove shelljs, update other deps ([11e192a][34]) -- **package.json:** update dependencies ([9e1705b][35]) -- **test:** update with new lib-pkg tools ([004a657][36]) -- Spellcheck-commit and .changelogrc no longer use shelljs ([dd72fd1][37]) -- **setup.ts:** fix several lib-pkg tools ([44d1967][38]) -- **unit-external.test.ts:** update with new lib-pkg tools ([6df7e73][39]) -- Backport new webpack config ([b268534][40]) -- Rename env-expect to expect-env ([035e98b][41]) + ([9d12004][31]) +- **package.json:** remove shelljs, update other deps ([11e192a][32]) +- **package.json:** update dependencies ([9e1705b][33]) +- **test:** update with new lib-pkg tools ([004a657][34]) +- Spellcheck-commit and .changelogrc no longer use shelljs ([dd72fd1][35]) +- **setup.ts:** fix several lib-pkg tools ([44d1967][36]) +- **unit-external.test.ts:** update with new lib-pkg tools ([6df7e73][37]) +- Backport new webpack config ([b268534][38]) +- Rename env-expect to expect-env ([035e98b][39]) #### 🔥 Reverted -- _"debug(build-test-deploy.yml): disable debug mode"_ ([6cefa7a][42]) +- _"debug(build-test-deploy.yml): disable debug mode"_ ([6cefa7a][40]) -### [1.2.18][43] (2021-02-11) +### [1.2.18][41] (2021-02-11) #### ⚙️ Build system -- **package.json:** update to proper forked dependencies ([042291d][44]) +- **package.json:** update to proper forked dependencies ([042291d][42]) -### [1.2.17][45] (2021-02-10) +### [1.2.17][43] (2021-02-10) #### ⚙️ Build system - **webpack.config.js:** normalize webpack configuration across repos - ([65f48a3][46]) -- **webpack.config.js:** remove ES6 syntax from JS file ([5ed6dbd][47]) + ([65f48a3][44]) +- **webpack.config.js:** remove ES6 syntax from JS file ([5ed6dbd][45]) -### [1.2.16][48] (2021-02-10) +### [1.2.16][46] (2021-02-10) #### ⚙️ Build system -- **package.json:** update dependencies ([aeef7a9][49]) +- **package.json:** update dependencies ([aeef7a9][47]) -### [1.2.15][50] (2021-02-08) +### [1.2.15][48] (2021-02-08) #### 🪄 Fixes - **readme.md:** simplify all examples with more modern syntax; remove - @ergodark/types ([964bc47][51]) + @ergodark/types ([964bc47][49]) -### [1.2.14][52] (2021-02-08) +### [1.2.14][50] (2021-02-08) #### 🪄 Fixes -- **readme.md:** add Apollo example and additional guidance ([ed357f5][53]) +- **readme.md:** add Apollo example and additional guidance ([ed357f5][51]) -### [1.2.13][54] (2021-02-05) +### [1.2.13][52] (2021-02-05) #### 🪄 Fixes - **config:** use transform-rename-import when building externals - ([d224f5e][55]) -- **index.ts:** use NextApiHandler type (thanks [@janhesters][56]) - ([473ff50][57]) -- **integration-webpack.test.ts:** actually call bundle in test ([f7a12de][58]) -- **is-next-compat.ts:** better handling of generics ([d7bc091][59]) -- Next no longer misclassified as CJS ([9ebac01][60]) + ([d224f5e][53]) +- **index.ts:** use NextApiHandler type (thanks [@janhesters][54]) + ([473ff50][55]) +- **integration-webpack.test.ts:** actually call bundle in test ([f7a12de][56]) +- **is-next-compat.ts:** better handling of generics ([d7bc091][57]) +- Next no longer misclassified as CJS ([9ebac01][58]) #### ⚙️ Build system -- Properly mocked unit tests for externals ([b3273df][61]) -- **build-test-deploy.yml:** drop support for webpack 4 ([e508c06][62]) -- **test:** improved testing infrastructure ([fffe02e][63]) -- Only silence sjx if not DEBUG ([f01ce40][64]) -- **build-test-deploy.yml:** drop support for node 10 ([6adde15][65]) -- **build-test-deploy.yml:** remove externals exception ([5e3893a][66]) -- **cleanup.yml:** fix bugs in workflow ([cbf22fd][67]) -- **package.json:** improved build-dist ([a3526f2][68]) -- **package.json:** nicer destructured vals in docs ([661e62d][69]) -- **package.json:** remove extraneous module ([1f2ad6a][70]) -- **package.json:** update dependencies ([c64f761][71]) -- **post-release-check.yml:** add five-minute-sleep ([4a0552d][72]) -- **post-release-check.yml:** more resilient post-release check ([856435f][73]) -- **types:** more precise unique-filename type ([a60793c][74]) -- Drop support for node 10 ([71e9103][75]) - -### [1.2.12][76] (2021-01-23) +- Properly mocked unit tests for externals ([b3273df][59]) +- **build-test-deploy.yml:** drop support for webpack 4 ([e508c06][60]) +- **test:** improved testing infrastructure ([fffe02e][61]) +- Only silence sjx if not DEBUG ([f01ce40][62]) +- **build-test-deploy.yml:** drop support for node 10 ([6adde15][63]) +- **build-test-deploy.yml:** remove externals exception ([5e3893a][64]) +- **cleanup.yml:** fix bugs in workflow ([cbf22fd][65]) +- **package.json:** improved build-dist ([a3526f2][66]) +- **package.json:** nicer destructured vals in docs ([661e62d][67]) +- **package.json:** remove extraneous module ([1f2ad6a][68]) +- **package.json:** update dependencies ([c64f761][69]) +- **post-release-check.yml:** add five-minute-sleep ([4a0552d][70]) +- **post-release-check.yml:** more resilient post-release check ([856435f][71]) +- **types:** more precise unique-filename type ([a60793c][72]) +- Drop support for node 10 ([71e9103][73]) + +### [1.2.12][74] (2021-01-23) #### ⚙️ Build system -- Remove erroneous module import ([6eb2a34][77]) +- Remove erroneous module import ([6eb2a34][75]) -### [1.2.11][78] (2021-01-23) +### [1.2.11][76] (2021-01-23) #### ⚙️ Build system -- Backport/normalize across packages ([e589c1d][79]) +- Backport/normalize across packages ([e589c1d][77]) -### [1.2.10][80] (2021-01-22) +### [1.2.10][78] (2021-01-22) #### ⚙️ Build system -- Update debug statement syntax ([52a2276][81]) +- Update debug statement syntax ([52a2276][79]) -### [1.2.9][82] (2021-01-21) +### [1.2.9][80] (2021-01-21) #### ⚙️ Build system - **.github/workflows/build-test-deploy.yml:** fix peer dependency installation - ([12e5bbe][83]) + ([12e5bbe][81]) -### [1.2.8][84] (2021-01-13) +### [1.2.8][82] (2021-01-13) #### 🪄 Fixes -- **readme.md:** ensure quick start example is functional ([87dc31f][85]) +- **readme.md:** ensure quick start example is functional ([87dc31f][83]) -### [1.2.7][86] (2021-01-12) +### [1.2.7][84] (2021-01-12) #### ⚙️ Build system -- Rebuild lockfile ([94cfa38][87]) -- Update babel-plugin-transform-mjs-imports ([62089c7][88]) +- Rebuild lockfile ([94cfa38][85]) +- Update babel-plugin-transform-mjs-imports ([62089c7][86]) -### [1.2.6][89] (2021-01-06) +### [1.2.6][87] (2021-01-06) #### ⚙️ Build system -- **package.json:** prune old deps ([2cf1d29][90]) +- **package.json:** prune old deps ([2cf1d29][88]) -### [1.2.5][91] (2021-01-06) +### [1.2.5][89] (2021-01-06) #### ⚙️ Build system -- **.github:** add is-next-compat workflow ([1823c05][92]) +- **.github:** add is-next-compat workflow ([1823c05][90]) - **.github/workflows/post-release-check.yml:** add new post-release-check - ([a307efc][93]) + ([a307efc][91]) -### [1.2.4][94] (2021-01-06) +### [1.2.4][92] (2021-01-06) #### ⚙️ Build system -- **readme.md:** add quick start example ([4e5e12c][95]) +- **readme.md:** add quick start example ([4e5e12c][93]) -### [1.2.3][96] (2021-01-05) +### [1.2.3][94] (2021-01-05) #### ⚙️ Build system - **package.json:** favor "prepare" over "postinstall" and use npx for dev tools - ([a111c87][97]) + ([a111c87][95]) -### [1.2.2][98] (2021-01-05) +### [1.2.2][96] (2021-01-05) #### ⚙️ Build system -- **readme.md:** cosmetic ([98b65c6][99]) +- **readme.md:** cosmetic ([98b65c6][97]) -### [1.2.1][100] (2021-01-05) +### [1.2.1][98] (2021-01-05) #### ⚙️ Build system - **package.json:** update dependencies, prune unused dependencies - ([6ef6cbe][101]) + ([6ef6cbe][99]) -## [1.2.0][102] (2021-01-05) +## [1.2.0][100] (2021-01-05) #### ✨ Features - **.changelogrc.js:** transfer repository over to semantic-release CI/CD - ([b9d2bf0][103]) + ([b9d2bf0][101]) #### ⚙️ Build system -- **deps:** bump node-notifier from 8.0.0 to 8.0.1 ([45a79d4][104]) +- **deps:** bump node-notifier from 8.0.0 to 8.0.1 ([45a79d4][102]) - **test/unit-externals.test.ts:** add mongo uri env var to test explicitly - ([e0e1fd9][105]) + ([e0e1fd9][103]) -### [1.1.3][106] (2020-12-06) +### [1.1.3][104] (2020-12-06) #### ⚙️ Build system -- **package.json:** audit and update deps ([c82695a][107]) -- **package.json:** manually bump version ([813b21a][108]) +- **package.json:** audit and update deps ([c82695a][105]) +- **package.json:** manually bump version ([813b21a][106]) -### [1.1.2][109] (2020-11-26) +### [1.1.2][107] (2020-11-26) #### 🪄 Fixes -- **readme:** update install language ([b68c721][110]) +- **readme:** update install language ([b68c721][108]) -### [1.1.1][111] (2020-11-26) +### [1.1.1][109] (2020-11-26) #### 🪄 Fixes -- **externals:** revert sort-package-json to maintainer version ([750055b][112]) -- **externals:** rewrite test workflow ([d604dfc][113]) +- **externals:** revert sort-package-json to maintainer version ([750055b][110]) +- **externals:** rewrite test workflow ([d604dfc][111]) -## [1.1.0][114] (2020-11-25) +## [1.1.0][112] (2020-11-25) #### 🪄 Fixes -- **build:** move Next.js dependency to peer/dev dependencies ([0e7541f][115]) +- **build:** move Next.js dependency to peer/dev dependencies ([0e7541f][113]) - **externals:** updated remaining dependency references to peerDependency - references ([ccf54fb][116]) + references ([ccf54fb][114]) -### [1.0.10][117] (2020-10-24) +### [1.0.10][115] (2020-10-24) -### [1.0.9][118] (2020-10-23) +### [1.0.9][116] (2020-10-23) -### [1.0.8][119] (2020-10-20) +### [1.0.8][117] (2020-10-20) -### [1.0.7][120] (2020-10-19) +### [1.0.7][118] (2020-10-19) -### [1.0.6][121] (2020-10-17) +### [1.0.6][119] (2020-10-17) -### [1.0.5][122] (2020-10-13) +### [1.0.5][120] (2020-10-13) -### [1.0.4][123] (2020-10-12) +### [1.0.4][121] (2020-10-12) -### [1.0.3][124] (2020-10-12) +### [1.0.3][122] (2020-10-12) -### [1.0.2][125] (2020-10-07) +### [1.0.2][123] (2020-10-07) -### [1.0.1][126] (2020-10-07) +### [1.0.1][124] (2020-10-07) ## 1.0.0 (2020-10-07) -[1]: https://conventionalcommits.org -[2]: https://semver.org -[3]: +[1]: https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.23...v1.2.24 -[4]: +[2]: https://github.com/Xunnamius/next-test-api-route-handler/commit/af177c5035c22ab923dd62f6dc82702373f740d4 -[5]: +[3]: https://github.com/Xunnamius/next-test-api-route-handler/commit/99ad1276e7e69218719ee2b27173e4ffcb7337f6 -[6]: +[4]: https://github.com/Xunnamius/next-test-api-route-handler/commit/364549e2845965954af62fdfa6c1dfa0d6f91f2f -[7]: +[5]: https://github.com/Xunnamius/next-test-api-route-handler/commit/4db5d04d6a7117fe8e2113d2fafc6150a81f611c -[8]: +[6]: https://github.com/Xunnamius/next-test-api-route-handler/commit/6d523027b8d650ae0a2d121c349e6a4c48af6792 -[9]: +[7]: https://github.com/Xunnamius/next-test-api-route-handler/commit/1f7fad4d512f1839d96c6264f2d4abb1c5ed11e7 -[10]: +[8]: https://github.com/Xunnamius/next-test-api-route-handler/commit/d328a86317c60206bda565ba2e315113dadd0c9b -[11]: +[9]: https://github.com/Xunnamius/next-test-api-route-handler/commit/6e7173fca4cbe778419eeff92ddbf7c03c2b00d5 -[12]: +[10]: https://github.com/Xunnamius/next-test-api-route-handler/commit/23cb7804d5f0e775b75eaefb4588beb179dcdcdf -[13]: +[11]: https://github.com/Xunnamius/next-test-api-route-handler/commit/1f25e5fb8b2797621d316e18b01ee503fb4d1263 -[14]: +[12]: https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.22...v1.2.23 -[15]: +[13]: https://github.com/Xunnamius/next-test-api-route-handler/commit/0040582d2f89e9a14c2335dc85cd5f9201bff644 -[16]: +[14]: https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.21...v1.2.22 -[17]: +[15]: https://github.com/Xunnamius/next-test-api-route-handler/commit/df9ede3ddde3a2df6a42224ab3302e599bd61516 -[18]: +[16]: https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.20...v1.2.21 -[19]: +[17]: https://github.com/Xunnamius/next-test-api-route-handler/commit/29aa25a9e2572be5b418fbee9d2d8aba2056583e -[20]: +[18]: https://github.com/Xunnamius/next-test-api-route-handler/commit/806575792fe9e1522bd6bce0eb10f1bd3407da64 -[21]: +[19]: https://github.com/Xunnamius/next-test-api-route-handler/commit/dd3e7faadf148b23994f443a2247cc1316639e7d -[22]: https://github.com/Xunnamius/next-test-api-route-handler/issues/126 -[23]: +[20]: https://github.com/Xunnamius/next-test-api-route-handler/issues/126 +[21]: https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.19...v1.2.20 -[24]: +[22]: https://github.com/Xunnamius/next-test-api-route-handler/commit/5a2d98f3ddb34e9d934f16510a73cacd43ee42ee -[25]: +[23]: https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.18...v1.2.19 -[26]: +[24]: https://github.com/Xunnamius/next-test-api-route-handler/commit/b4157eba128f6a787531fdabf2bebf78851a0d9a -[27]: +[25]: https://github.com/Xunnamius/next-test-api-route-handler/commit/81533c8953adde75499cd11b552bca5f970addca -[28]: +[26]: https://github.com/Xunnamius/next-test-api-route-handler/commit/3a4f0f150779a226ee3c9f45fde201391fa1bec0 -[29]: +[27]: https://github.com/Xunnamius/next-test-api-route-handler/commit/72189e80136b0567de8fc65eed9b2a4be365ca1a -[30]: +[28]: https://github.com/Xunnamius/next-test-api-route-handler/commit/cad0fb2b6153434d3be41f394f1fa636cc930435 -[31]: +[29]: https://github.com/Xunnamius/next-test-api-route-handler/commit/54e51ebd0e133fb469306b76bc756c283a71a2c1 -[32]: +[30]: https://github.com/Xunnamius/next-test-api-route-handler/commit/31c1d5b358df78e0f27e881c0329355d91370995 -[33]: +[31]: https://github.com/Xunnamius/next-test-api-route-handler/commit/9d12004ad5adfc5d4d6992bdb67c52168829967e -[34]: +[32]: https://github.com/Xunnamius/next-test-api-route-handler/commit/11e192a670c5cf40faff32abeecb610534cd382b -[35]: +[33]: https://github.com/Xunnamius/next-test-api-route-handler/commit/9e1705b88fbcb5c4794abfb56691bdea7500db0d -[36]: +[34]: https://github.com/Xunnamius/next-test-api-route-handler/commit/004a657bafaab0419e645b6388c7536e38a1ef22 -[37]: +[35]: https://github.com/Xunnamius/next-test-api-route-handler/commit/dd72fd1859fd74df3af0d47a1747d8c404abc3a7 -[38]: +[36]: https://github.com/Xunnamius/next-test-api-route-handler/commit/44d1967a412ca67829deeb29c7603ddf7e42f435 -[39]: +[37]: https://github.com/Xunnamius/next-test-api-route-handler/commit/6df7e73fff51036c63efc7ba898c3d76bc47deb7 -[40]: +[38]: https://github.com/Xunnamius/next-test-api-route-handler/commit/b2685345493165cc63136b051cc5fafbf02f5c48 -[41]: +[39]: https://github.com/Xunnamius/next-test-api-route-handler/commit/035e98bbe4b6bcf1ec6de40ee38b36ec107e8186 -[42]: +[40]: https://github.com/Xunnamius/next-test-api-route-handler/commit/6cefa7ae41832e61ef6df75409be61141f7d1687 -[43]: +[41]: https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.17...v1.2.18 -[44]: +[42]: https://github.com/Xunnamius/next-test-api-route-handler/commit/042291d26742dfdda3742e6171efa25e9d3953ce -[45]: +[43]: https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.16...v1.2.17 -[46]: +[44]: https://github.com/Xunnamius/next-test-api-route-handler/commit/65f48a3d97184bb8a1be4fd27e86be0d7cd6bb00 -[47]: +[45]: https://github.com/Xunnamius/next-test-api-route-handler/commit/5ed6dbd1cdcb15745f4979f1a716d9bce9a93afb -[48]: +[46]: https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.15...v1.2.16 -[49]: +[47]: https://github.com/Xunnamius/next-test-api-route-handler/commit/aeef7a9726934852e1a51c9da98c4a96a9c70044 -[50]: +[48]: https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.14...v1.2.15 -[51]: +[49]: https://github.com/Xunnamius/next-test-api-route-handler/commit/964bc47f80691e83d92082fcaa0679219b8543f5 -[52]: +[50]: https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.13...v1.2.14 -[53]: +[51]: https://github.com/Xunnamius/next-test-api-route-handler/commit/ed357f5211a49bfffbb28f03d60f157fa23d14b4 -[54]: +[52]: https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.12...v1.2.13 -[55]: +[53]: https://github.com/Xunnamius/next-test-api-route-handler/commit/d224f5eff5a786b96614b2c3f826eba610027da0 -[56]: https://github.com/janhesters -[57]: +[54]: https://github.com/janhesters +[55]: https://github.com/Xunnamius/next-test-api-route-handler/commit/473ff500fb2c954ce32be911bde943259ae1bbef -[58]: +[56]: https://github.com/Xunnamius/next-test-api-route-handler/commit/f7a12ded8f43359fd3079ea8294a2199c34b2d26 -[59]: +[57]: https://github.com/Xunnamius/next-test-api-route-handler/commit/d7bc091fe8f8e85b70987cfa4c663c7c8fd018c8 -[60]: +[58]: https://github.com/Xunnamius/next-test-api-route-handler/commit/9ebac018798ac82b97b8163bc5713b43001f592c -[61]: +[59]: https://github.com/Xunnamius/next-test-api-route-handler/commit/b3273dfbe43cb4c9ececdb4863ff4259f38807ec -[62]: +[60]: https://github.com/Xunnamius/next-test-api-route-handler/commit/e508c06b77d225f150ebfce6409c2506a88efe4c -[63]: +[61]: https://github.com/Xunnamius/next-test-api-route-handler/commit/fffe02e14615daba1f9f8ec1bb2a4024ceb93e84 -[64]: +[62]: https://github.com/Xunnamius/next-test-api-route-handler/commit/f01ce4041b2fb1fd24052ce17008df9746652730 -[65]: +[63]: https://github.com/Xunnamius/next-test-api-route-handler/commit/6adde1576f4aeb8b9a72cdcefc2ea6bd4b71a5cd -[66]: +[64]: https://github.com/Xunnamius/next-test-api-route-handler/commit/5e3893a425b95ac2b12edc2195171de85afcfd0a -[67]: +[65]: https://github.com/Xunnamius/next-test-api-route-handler/commit/cbf22fdd78e28e02ec4213156c6c72ba16c8bfa3 -[68]: +[66]: https://github.com/Xunnamius/next-test-api-route-handler/commit/a3526f28057201fcce19c752e554e705b8e3a922 -[69]: +[67]: https://github.com/Xunnamius/next-test-api-route-handler/commit/661e62d53be74211d3d158ad90c196f43c8fe6db -[70]: +[68]: https://github.com/Xunnamius/next-test-api-route-handler/commit/1f2ad6a2cdc863b183ac7f7bef756dd90c057ebe -[71]: +[69]: https://github.com/Xunnamius/next-test-api-route-handler/commit/c64f761c3b2cc69cf07cd7dd88e9671deb66fc4f -[72]: +[70]: https://github.com/Xunnamius/next-test-api-route-handler/commit/4a0552d2c730842371325111276c58651dabc558 -[73]: +[71]: https://github.com/Xunnamius/next-test-api-route-handler/commit/856435f02ebe2f44b13c92cc6c794eeab2b345d0 -[74]: +[72]: https://github.com/Xunnamius/next-test-api-route-handler/commit/a60793c620fe926308f8c99c61076da81aebe2fa -[75]: +[73]: https://github.com/Xunnamius/next-test-api-route-handler/commit/71e9103df5660fea2af3211b1d6c1fa72b1dd3c7 -[76]: +[74]: https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.11...v1.2.12 -[77]: +[75]: https://github.com/Xunnamius/next-test-api-route-handler/commit/6eb2a348b1352e9f30d7ecacbaba01fa11cf1cfe -[78]: +[76]: https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.10...v1.2.11 -[79]: +[77]: https://github.com/Xunnamius/next-test-api-route-handler/commit/e589c1d48aa1dae40643385c6acfcbacf9b40e16 -[80]: +[78]: https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.9...v1.2.10 -[81]: +[79]: https://github.com/Xunnamius/next-test-api-route-handler/commit/52a22765e17759271e7ba6c83ce9f3609500b5f3 -[82]: +[80]: https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.8...v1.2.9 -[83]: +[81]: https://github.com/Xunnamius/next-test-api-route-handler/commit/12e5bbe1bf36fda3ef938c7ed7cd445fec3901c9 -[84]: +[82]: https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.7...v1.2.8 -[85]: +[83]: https://github.com/Xunnamius/next-test-api-route-handler/commit/87dc31f264682d8048ee8d4cba4dbf866666bf07 -[86]: +[84]: https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.6...v1.2.7 -[87]: +[85]: https://github.com/Xunnamius/next-test-api-route-handler/commit/94cfa3806bfa0250e9b2dd5b3abfb2ff65c77c6a -[88]: +[86]: https://github.com/Xunnamius/next-test-api-route-handler/commit/62089c79f6c9b585d2bb8ca0a8b87bd355b8695f -[89]: +[87]: https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.5...v1.2.6 -[90]: +[88]: https://github.com/Xunnamius/next-test-api-route-handler/commit/2cf1d29159fb746dc4a7c09a8193e46c6bec3823 -[91]: +[89]: https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.4...v1.2.5 -[92]: +[90]: https://github.com/Xunnamius/next-test-api-route-handler/commit/1823c055f034e528337c68d710164097e423f6e2 -[93]: +[91]: https://github.com/Xunnamius/next-test-api-route-handler/commit/a307efcf2cdf60679d68fab385bdc8951a476ace -[94]: +[92]: https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.3...v1.2.4 -[95]: +[93]: https://github.com/Xunnamius/next-test-api-route-handler/commit/4e5e12c0df4fc80abb696d32718440ff294902e7 -[96]: +[94]: https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.2...v1.2.3 -[97]: +[95]: https://github.com/Xunnamius/next-test-api-route-handler/commit/a111c87ccd863ce4dac85a5bd0281d87affe3b63 -[98]: +[96]: https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.1...v1.2.2 -[99]: +[97]: https://github.com/Xunnamius/next-test-api-route-handler/commit/98b65c6da330040e4bcbc22fe28db87c3965fd0e -[100]: +[98]: https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.0...v1.2.1 -[101]: +[99]: https://github.com/Xunnamius/next-test-api-route-handler/commit/6ef6cbeb143648eb1fed5eff39071a06e7354275 -[102]: +[100]: https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.1.3...v1.2.0 -[103]: +[101]: https://github.com/Xunnamius/next-test-api-route-handler/commit/b9d2bf010fba4b163e1eea0801271292a0e74308 -[104]: +[102]: https://github.com/Xunnamius/next-test-api-route-handler/commit/45a79d41835b5146912511f8b583c9128d154cf9 -[105]: +[103]: https://github.com/Xunnamius/next-test-api-route-handler/commit/e0e1fd951fbe63c04c264ad11ab1fa7a39e1679a -[106]: +[104]: https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.1.2...v1.1.3 -[107]: +[105]: https://github.com/Xunnamius/next-test-api-route-handler/commit/c82695a8816b6cd5f0e11d09cc2f948a30a416e9 -[108]: +[106]: https://github.com/Xunnamius/next-test-api-route-handler/commit/813b21ad1e2c78594903b3a8f504f4460d8e506e -[109]: +[107]: https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.1.1...v1.1.2 -[110]: +[108]: https://github.com/Xunnamius/next-test-api-route-handler/commit/b68c721e5100baa883c7096e5cc4e81c1c60ed00 -[111]: +[109]: https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.1.0...v1.1.1 -[112]: +[110]: https://github.com/Xunnamius/next-test-api-route-handler/commit/750055b92699fc7f1c06349ccdb0ddc0179f891a -[113]: +[111]: https://github.com/Xunnamius/next-test-api-route-handler/commit/d604dfc39d2e77cbe1234b8349a2ecef81a9e54a -[114]: +[112]: https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.0.10...v1.1.0 -[115]: +[113]: https://github.com/Xunnamius/next-test-api-route-handler/commit/0e7541fbecd2e3bacc124f624bfca2b56ceeb89f -[116]: +[114]: https://github.com/Xunnamius/next-test-api-route-handler/commit/ccf54fb480e35961647900d345149d3cd1cf60d8 -[117]: +[115]: https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.0.9...v1.0.10 -[118]: +[116]: https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.0.8...v1.0.9 -[119]: +[117]: https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.0.7...v1.0.8 -[120]: +[118]: https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.0.6...v1.0.7 -[121]: +[119]: https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.0.5...v1.0.6 -[122]: +[120]: https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.0.4...v1.0.5 -[123]: +[121]: https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.0.3...v1.0.4 -[124]: +[122]: https://github.com/Xunnamius/next-test-api-route-handler/compare/1.0.2...v1.0.3 -[125]: +[123]: https://github.com/Xunnamius/next-test-api-route-handler/compare/1.0.1...1.0.2 -[126]: +[124]: https://github.com/Xunnamius/next-test-api-route-handler/compare/1.0.0...1.0.1 +[125]: https://conventionalcommits.org +[126]: https://semver.org +[127]: + https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.24...v2.0.0 +[128]: + https://github.com/Xunnamius/next-test-api-route-handler/commit/ee31fa8cefdc2b8b8197d3889fb8aac27467b374 +[129]: + https://github.com/Xunnamius/next-test-api-route-handler/commit/bc7eb3db18aa70345a1c11d96436b374a15c3b7f +[130]: + https://github.com/Xunnamius/next-test-api-route-handler/commit/20ca255e01d0c2e7824707e19f41ca5a8de0140e +[131]: + https://github.com/Xunnamius/next-test-api-route-handler/commit/2f1125cfb481e94af4248cf5b5dfce729cc4d662 +[132]: + https://github.com/Xunnamius/next-test-api-route-handler/commit/75832099f4c4d0e329aca469ac16c8a25100c26d +[133]: + https://github.com/Xunnamius/next-test-api-route-handler/commit/bc5e72d9d40f1991315ac0657a4b212331dc065f diff --git a/docs/README.md b/docs/README.md index f090e4fa..85b5fa3b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -8,11 +8,8 @@ ### testApiHandler -▸ **testApiHandler**({ `handler`: NextApiHandler ; `params?`: _Record_\ ; `requestPatcher?`: (`req`: IncomingMessage) => _void_ ; -`responsePatcher?`: (`res`: ServerResponse) => _void_ ; `test`: (`obj`: { -`fetch`: (`init?`: RequestInit) => _ReturnType_<_typeof_ fetch> }) => -_Promise_\ }): _Promise_\ +▸ **testApiHandler**<`NextApiHandlerType`>(`__namedParameters`): +`Promise`<`void`> Uses Next's internal `apiResolver` to execute api route handlers in a Next-like testing environment. @@ -33,21 +30,33 @@ parameters. assertions can be run. This function receives one parameter: fetch, which is unfetch's `fetch(...)` function but with the first parameter omitted. -#### Parameters: +#### Type parameters -| Name | Type | -| :----------------------- | :---------------------------------------------------------------------------------------------- | -| `(destructured)` | _object_ | -| `({ handler })` | NextApiHandler | -| `({ params? })` | _Record_ | -| `({ requestPatcher? })` | (`req`: IncomingMessage) => _void_ | -| `({ responsePatcher? })` | (`res`: ServerResponse) => _void_ | -| `({ test })` | (`obj`: { `fetch`: (`init?`: RequestInit) => _ReturnType_<_typeof_ fetch> }) => _Promise_ | +| Name | Type | +| :------------------- | :-------- | +| `NextApiHandlerType` | `unknown` | -**Returns:** _Promise_\ +#### Parameters -Defined in: [index.ts:31][2] +| Name | Type | +| :----------------------------------- | :-------------------------------------------------------------------------------------------------- | +| `__namedParameters` | `Object` | +| `__namedParameters.handler` | `NextApiHandler`<`NextApiHandlerType`> | +| `__namedParameters.params?` | `Record`<`string`, `string` \| `string`[]> | +| `__namedParameters.paramsPatcher?` | (`params`: `Record`<`string`, `unknown`>) => `void` | +| `__namedParameters.requestPatcher?` | (`req`: `IncomingMessage`) => `void` | +| `__namedParameters.responsePatcher?` | (`res`: `ServerResponse`) => `void` | +| `__namedParameters.test` | (`obj`: { `fetch`: (`init?`: `RequestInit`) => `ReturnType` }) => `Promise`<`void`> | +| `__namedParameters.url?` | `string` | + +#### Returns + +`Promise`<`void`> + +#### Defined in + +[index.ts:31][2] [1]: README.md#testapihandler [2]: - https://github.com/Xunnamius/next-test-api-route-handler/blob/0040582/src/index.ts#L31 + https://github.com/Xunnamius/next-test-api-route-handler/blob/8c41589/src/index.ts#L31 diff --git a/package-lock.json b/package-lock.json index 25888f98..42cbab28 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,11 +1,11 @@ { "name": "next-test-api-route-handler", - "version": "1.2.24", + "version": "2.0.0", "lockfileVersion": 2, "requires": true, "packages": { "": { - "version": "1.2.24", + "version": "2.0.0", "license": "Unlicense", "dependencies": { "debug": "^4.3.1", diff --git a/package.json b/package.json index 3424ba76..d093c4cf 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "next-test-api-route-handler", - "version": "1.2.24", + "version": "2.0.0", "description": "Confidently unit test your Next.js API routes/handlers in an isolated Next.js-like environment", "keywords": [ "api",