diff --git a/CHANGELOG.md b/CHANGELOG.md index e872fac4..0fa0a87d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,179 +2,189 @@ All notable changes to this project will be documented in this file. -The format is based on [Conventional Commits][34], and this project adheres to -[Semantic Versioning][35]. +The format is based on [Conventional Commits][36], and this project adheres to +[Semantic Versioning][37]. -## [1.2.9][36] (2021-01-21) +## [1.2.10][38] (2021-01-22) + +### Build System + +- Update debug statement syntax ([52a2276][39]) + +## [1.2.9][1] (2021-01-21) ### Build System - **.github/workflows/build-test-deploy.yml:** fix peer dependency installation - ([12e5bbe][37]) + ([12e5bbe][2]) -## [1.2.8][1] (2021-01-13) +## [1.2.8][3] (2021-01-13) ### Bug Fixes -- **readme.md:** ensure quick start example is functional ([87dc31f][2]) +- **readme.md:** ensure quick start example is functional ([87dc31f][4]) -## [1.2.7][3] (2021-01-12) +## [1.2.7][5] (2021-01-12) ### Build System -- Rebuild lockfile ([94cfa38][4]) -- Update babel-plugin-transform-mjs-imports ([62089c7][5]) +- Rebuild lockfile ([94cfa38][6]) +- Update babel-plugin-transform-mjs-imports ([62089c7][7]) -## [1.2.6][6] (2021-01-06) +## [1.2.6][8] (2021-01-06) ### Build System -- **package.json:** prune old deps ([2cf1d29][7]) +- **package.json:** prune old deps ([2cf1d29][9]) -## [1.2.5][8] (2021-01-06) +## [1.2.5][10] (2021-01-06) ### Build System -- **.github:** add is-next-compat workflow ([1823c05][9]) +- **.github:** add is-next-compat workflow ([1823c05][11]) - **.github/workflows/post-release-check.yml:** add new post-release-check - ([a307efc][10]) + ([a307efc][12]) -## [1.2.4][11] (2021-01-06) +## [1.2.4][13] (2021-01-06) ### Build System -- **readme.md:** add quick start example ([4e5e12c][12]) +- **readme.md:** add quick start example ([4e5e12c][14]) -## [1.2.3][13] (2021-01-05) +## [1.2.3][15] (2021-01-05) ### Build System - **package.json:** favor "prepare" over "postinstall" and use npx for dev tools - ([a111c87][14]) + ([a111c87][16]) -## [1.2.2][15] (2021-01-05) +## [1.2.2][17] (2021-01-05) ### Build System -- **readme.md:** cosmetic ([98b65c6][16]) +- **readme.md:** cosmetic ([98b65c6][18]) -## [1.2.1][17] (2021-01-05) +## [1.2.1][19] (2021-01-05) ### Build System - **package.json:** update dependencies, prune unused dependencies - ([6ef6cbe][18]) + ([6ef6cbe][20]) -# [1.2.0][19] (2021-01-05) +# [1.2.0][21] (2021-01-05) ### Build System -- **deps:** bump node-notifier from 8.0.0 to 8.0.1 ([45a79d4][20]) +- **deps:** bump node-notifier from 8.0.0 to 8.0.1 ([45a79d4][22]) - **test/unit-externals.test.ts:** add mongo uri env var to test explicitly - ([e0e1fd9][21]) + ([e0e1fd9][23]) ### Features - **.changelogrc.js:** transfer repository over to semantic-release CI/CD - ([b9d2bf0][22]) + ([b9d2bf0][24]) -## [1.1.3][23] (2020-12-06) +## [1.1.3][25] (2020-12-06) ### Build System -- **package.json:** audit and update deps ([c82695a][24]) -- **package.json:** manually bump version ([813b21a][25]) +- **package.json:** audit and update deps ([c82695a][26]) +- **package.json:** manually bump version ([813b21a][27]) -## [1.1.2][26] (2020-11-26) +## [1.1.2][28] (2020-11-26) ### Bug Fixes -- **README:** update install language ([b68c721][27]) +- **README:** update install language ([b68c721][29]) -## [1.1.1][28] (2020-11-26) +## [1.1.1][30] (2020-11-26) ### Bug Fixes -- **externals:** revert sort-package-json to maintainer version ([750055b][29]) -- **externals:** rewrite test workflow ([d604dfc][30]) +- **externals:** revert sort-package-json to maintainer version ([750055b][31]) +- **externals:** rewrite test workflow ([d604dfc][32]) -# [1.1.0][31] (2020-11-25) +# [1.1.0][33] (2020-11-25) ### Bug Fixes -- **build:** move Next.js dependency to peer/dev dependencies ([0e7541f][32]) +- **build:** move Next.js dependency to peer/dev dependencies ([0e7541f][34]) - **externals:** updated remaining dependency references to peerDependency - references ([ccf54fb][33]) + references ([ccf54fb][35]) [1]: - https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.7...v1.2.8 + https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.8...v1.2.9 [2]: - https://github.com/Xunnamius/next-test-api-route-handler/commit/87dc31f264682d8048ee8d4cba4dbf866666bf07 + https://github.com/Xunnamius/next-test-api-route-handler/commit/12e5bbe1bf36fda3ef938c7ed7cd445fec3901c9 [3]: - https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.6...v1.2.7 + https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.7...v1.2.8 [4]: - https://github.com/Xunnamius/next-test-api-route-handler/commit/94cfa3806bfa0250e9b2dd5b3abfb2ff65c77c6a + https://github.com/Xunnamius/next-test-api-route-handler/commit/87dc31f264682d8048ee8d4cba4dbf866666bf07 [5]: - https://github.com/Xunnamius/next-test-api-route-handler/commit/62089c79f6c9b585d2bb8ca0a8b87bd355b8695f + https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.6...v1.2.7 [6]: - https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.5...v1.2.6 + https://github.com/Xunnamius/next-test-api-route-handler/commit/94cfa3806bfa0250e9b2dd5b3abfb2ff65c77c6a [7]: - https://github.com/Xunnamius/next-test-api-route-handler/commit/2cf1d29159fb746dc4a7c09a8193e46c6bec3823 + https://github.com/Xunnamius/next-test-api-route-handler/commit/62089c79f6c9b585d2bb8ca0a8b87bd355b8695f [8]: - https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.4...v1.2.5 + https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.5...v1.2.6 [9]: - https://github.com/Xunnamius/next-test-api-route-handler/commit/1823c055f034e528337c68d710164097e423f6e2 + https://github.com/Xunnamius/next-test-api-route-handler/commit/2cf1d29159fb746dc4a7c09a8193e46c6bec3823 [10]: - https://github.com/Xunnamius/next-test-api-route-handler/commit/a307efcf2cdf60679d68fab385bdc8951a476ace + https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.4...v1.2.5 [11]: - https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.3...v1.2.4 + https://github.com/Xunnamius/next-test-api-route-handler/commit/1823c055f034e528337c68d710164097e423f6e2 [12]: - https://github.com/Xunnamius/next-test-api-route-handler/commit/4e5e12c0df4fc80abb696d32718440ff294902e7 + https://github.com/Xunnamius/next-test-api-route-handler/commit/a307efcf2cdf60679d68fab385bdc8951a476ace [13]: - https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.2...v1.2.3 + https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.3...v1.2.4 [14]: - https://github.com/Xunnamius/next-test-api-route-handler/commit/a111c87ccd863ce4dac85a5bd0281d87affe3b63 + https://github.com/Xunnamius/next-test-api-route-handler/commit/4e5e12c0df4fc80abb696d32718440ff294902e7 [15]: - https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.1...v1.2.2 + https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.2...v1.2.3 [16]: - https://github.com/Xunnamius/next-test-api-route-handler/commit/98b65c6da330040e4bcbc22fe28db87c3965fd0e + https://github.com/Xunnamius/next-test-api-route-handler/commit/a111c87ccd863ce4dac85a5bd0281d87affe3b63 [17]: - https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.0...v1.2.1 + https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.1...v1.2.2 [18]: - https://github.com/Xunnamius/next-test-api-route-handler/commit/6ef6cbeb143648eb1fed5eff39071a06e7354275 + https://github.com/Xunnamius/next-test-api-route-handler/commit/98b65c6da330040e4bcbc22fe28db87c3965fd0e [19]: - https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.1.3...v1.2.0 + https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.0...v1.2.1 [20]: - https://github.com/Xunnamius/next-test-api-route-handler/commit/45a79d41835b5146912511f8b583c9128d154cf9 + https://github.com/Xunnamius/next-test-api-route-handler/commit/6ef6cbeb143648eb1fed5eff39071a06e7354275 [21]: - https://github.com/Xunnamius/next-test-api-route-handler/commit/e0e1fd951fbe63c04c264ad11ab1fa7a39e1679a + https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.1.3...v1.2.0 [22]: - https://github.com/Xunnamius/next-test-api-route-handler/commit/b9d2bf010fba4b163e1eea0801271292a0e74308 + https://github.com/Xunnamius/next-test-api-route-handler/commit/45a79d41835b5146912511f8b583c9128d154cf9 [23]: - https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.1.2...v1.1.3 + https://github.com/Xunnamius/next-test-api-route-handler/commit/e0e1fd951fbe63c04c264ad11ab1fa7a39e1679a [24]: - https://github.com/Xunnamius/next-test-api-route-handler/commit/c82695a8816b6cd5f0e11d09cc2f948a30a416e9 + https://github.com/Xunnamius/next-test-api-route-handler/commit/b9d2bf010fba4b163e1eea0801271292a0e74308 [25]: - https://github.com/Xunnamius/next-test-api-route-handler/commit/813b21ad1e2c78594903b3a8f504f4460d8e506e + https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.1.2...v1.1.3 [26]: - https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.1.1...v1.1.2 + https://github.com/Xunnamius/next-test-api-route-handler/commit/c82695a8816b6cd5f0e11d09cc2f948a30a416e9 [27]: - https://github.com/Xunnamius/next-test-api-route-handler/commit/b68c721e5100baa883c7096e5cc4e81c1c60ed00 + https://github.com/Xunnamius/next-test-api-route-handler/commit/813b21ad1e2c78594903b3a8f504f4460d8e506e [28]: - https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.1.0...v1.1.1 + https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.1.1...v1.1.2 [29]: - https://github.com/Xunnamius/next-test-api-route-handler/commit/750055b92699fc7f1c06349ccdb0ddc0179f891a + https://github.com/Xunnamius/next-test-api-route-handler/commit/b68c721e5100baa883c7096e5cc4e81c1c60ed00 [30]: - https://github.com/Xunnamius/next-test-api-route-handler/commit/d604dfc39d2e77cbe1234b8349a2ecef81a9e54a + https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.1.0...v1.1.1 [31]: - https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.0.10...v1.1.0 + https://github.com/Xunnamius/next-test-api-route-handler/commit/750055b92699fc7f1c06349ccdb0ddc0179f891a [32]: - https://github.com/Xunnamius/next-test-api-route-handler/commit/0e7541fbecd2e3bacc124f624bfca2b56ceeb89f + https://github.com/Xunnamius/next-test-api-route-handler/commit/d604dfc39d2e77cbe1234b8349a2ecef81a9e54a [33]: + https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.0.10...v1.1.0 +[34]: + https://github.com/Xunnamius/next-test-api-route-handler/commit/0e7541fbecd2e3bacc124f624bfca2b56ceeb89f +[35]: https://github.com/Xunnamius/next-test-api-route-handler/commit/ccf54fb480e35961647900d345149d3cd1cf60d8 -[34]: https://conventionalcommits.org -[35]: https://semver.org -[36]: - https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.8...v1.2.9 -[37]: - https://github.com/Xunnamius/next-test-api-route-handler/commit/12e5bbe1bf36fda3ef938c7ed7cd445fec3901c9 +[36]: https://conventionalcommits.org +[37]: https://semver.org +[38]: + https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.9...v1.2.10 +[39]: + https://github.com/Xunnamius/next-test-api-route-handler/commit/52a22765e17759271e7ba6c83ce9f3609500b5f3 diff --git a/docs/README.md b/docs/README.md index 61c3e346..9dcc8579 100644 --- a/docs/README.md +++ b/docs/README.md @@ -32,9 +32,15 @@ unfetch's `fetch(...)` function but with the first parameter omitted. #### Parameters: -| Name | Type | -| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `(destructured)` | { `handler`: (`req`: NextApiRequest, `res`: NextApiResponse) => *Promise*<*void*> ; `params?`: *Record*<*string*, *unknown*> ; `requestPatcher?`: (`req`: IncomingMessage) => *void* ; `responsePatcher?`: (`res`: ServerResponse) => *void* ; `test`: (`obj`: { `fetch`: (`init?`: RequestInit) => *ReturnType*<*typeof* fetch> }) => *Promise*<*void*> } | +• **(destructured)**: *object* + +| Name | Type | +| ------------------ | -------------------------------------------------------------------------------------------------- | +| `handler` | (`req`: NextApiRequest, `res`: NextApiResponse) => *Promise*<*void*> | +| `params?` | *Record*<*string*, *unknown*> | +| `requestPatcher?` | (`req`: IncomingMessage) => *void* | +| `responsePatcher?` | (`res`: ServerResponse) => *void* | +| `test` | (`obj`: { `fetch`: (`init?`: RequestInit) => *ReturnType*<*typeof* fetch> }) => *Promise*<*void*> | **Returns:** *Promise*<*void*> @@ -42,4 +48,4 @@ Defined in: [index.ts:31][2] [1]: README.md#testapihandler -[2]: https://github.com/Xunnamius/next-test-api-route-handler/blob/12e5bbe/src/index.ts#L31 +[2]: https://github.com/Xunnamius/next-test-api-route-handler/blob/52a2276/src/index.ts#L31 diff --git a/package-lock.json b/package-lock.json index 6aaeeb78..db165a20 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "next-test-api-route-handler", - "version": "1.2.9", + "version": "1.2.10", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index e54c5ae5..fac1bdde 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "next-test-api-route-handler", - "version": "1.2.9", + "version": "1.2.10", "description": "Confidently unit test your Next.js API routes/handlers in an isolated Next.js-like environment", "keywords": [ "api",