From f864df8f0f77c2eb138ba61789c169d51269ae5c Mon Sep 17 00:00:00 2001 From: xunn-bot Date: Wed, 6 Jan 2021 12:02:02 +0000 Subject: [PATCH] release: 1.2.5 [skip ci] ## [1.2.5](https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.4...v1.2.5) (2021-01-06) ### Build System * **.github:** add is-next-compat workflow ([1823c05](https://github.com/Xunnamius/next-test-api-route-handler/commit/1823c055f034e528337c68d710164097e423f6e2)) * **.github/workflows/post-release-check.yml:** add new post-release-check ([a307efc](https://github.com/Xunnamius/next-test-api-route-handler/commit/a307efcf2cdf60679d68fab385bdc8951a476ace)) --- CHANGELOG.md | 116 ++++++++++++++++++++++++++-------------------- docs/README.md | 10 ++-- package-lock.json | 2 +- package.json | 2 +- 4 files changed, 72 insertions(+), 58 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c494ba73..85b8263f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,121 +2,135 @@ All notable changes to this project will be documented in this file. -The format is based on [Conventional Commits][22], and this project adheres to -[Semantic Versioning][23]. +The format is based on [Conventional Commits][24], and this project adheres to +[Semantic Versioning][25]. -## [1.2.4][24] (2021-01-06) +## [1.2.5][26] (2021-01-06) ### Build System -- **readme.md:** add quick start example ([4e5e12c][25]) +- **.github:** add is-next-compat workflow ([1823c05][27]) +- **.github/workflows/post-release-check.yml:** add new post-release-check + ([a307efc][28]) -## [1.2.3][1] (2021-01-05) +## [1.2.4][1] (2021-01-06) + +### Build System + +- **readme.md:** add quick start example ([4e5e12c][2]) + +## [1.2.3][3] (2021-01-05) ### Build System - **package.json:** favor "prepare" over "postinstall" and use npx for dev tools - ([a111c87][2]) + ([a111c87][4]) -## [1.2.2][3] (2021-01-05) +## [1.2.2][5] (2021-01-05) ### Build System -- **readme.md:** cosmetic ([98b65c6][4]) +- **readme.md:** cosmetic ([98b65c6][6]) -## [1.2.1][5] (2021-01-05) +## [1.2.1][7] (2021-01-05) ### Build System - **package.json:** update dependencies, prune unused dependencies - ([6ef6cbe][6]) + ([6ef6cbe][8]) -# [1.2.0][7] (2021-01-05) +# [1.2.0][9] (2021-01-05) ### Build System -- **deps:** bump node-notifier from 8.0.0 to 8.0.1 ([45a79d4][8]) +- **deps:** bump node-notifier from 8.0.0 to 8.0.1 ([45a79d4][10]) - **test/unit-externals.test.ts:** add mongo uri env var to test explicitly - ([e0e1fd9][9]) + ([e0e1fd9][11]) ### Features - **.changelogrc.js:** transfer repository over to semantic-release CI/CD - ([b9d2bf0][10]) + ([b9d2bf0][12]) -## [1.1.3][11] (2020-12-06) +## [1.1.3][13] (2020-12-06) ### Build System -- **package.json:** audit and update deps ([c82695a][12]) -- **package.json:** manually bump version ([813b21a][13]) +- **package.json:** audit and update deps ([c82695a][14]) +- **package.json:** manually bump version ([813b21a][15]) -## [1.1.2][14] (2020-11-26) +## [1.1.2][16] (2020-11-26) ### Bug Fixes -- **README:** update install language ([b68c721][15]) +- **README:** update install language ([b68c721][17]) -## [1.1.1][16] (2020-11-26) +## [1.1.1][18] (2020-11-26) ### Bug Fixes -- **externals:** revert sort-package-json to maintainer version ([750055b][17]) -- **externals:** rewrite test workflow ([d604dfc][18]) +- **externals:** revert sort-package-json to maintainer version ([750055b][19]) +- **externals:** rewrite test workflow ([d604dfc][20]) -# [1.1.0][19] (2020-11-25) +# [1.1.0][21] (2020-11-25) ### Bug Fixes -- **build:** move Next.js dependency to peer/dev dependencies ([0e7541f][20]) +- **build:** move Next.js dependency to peer/dev dependencies ([0e7541f][22]) - **externals:** updated remaining dependency references to peerDependency - references ([ccf54fb][21]) + references ([ccf54fb][23]) [1]: - 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 [2]: - https://github.com/Xunnamius/next-test-api-route-handler/commit/a111c87ccd863ce4dac85a5bd0281d87affe3b63 + https://github.com/Xunnamius/next-test-api-route-handler/commit/4e5e12c0df4fc80abb696d32718440ff294902e7 [3]: - 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 [4]: - https://github.com/Xunnamius/next-test-api-route-handler/commit/98b65c6da330040e4bcbc22fe28db87c3965fd0e + https://github.com/Xunnamius/next-test-api-route-handler/commit/a111c87ccd863ce4dac85a5bd0281d87affe3b63 [5]: - 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 [6]: - https://github.com/Xunnamius/next-test-api-route-handler/commit/6ef6cbeb143648eb1fed5eff39071a06e7354275 + https://github.com/Xunnamius/next-test-api-route-handler/commit/98b65c6da330040e4bcbc22fe28db87c3965fd0e [7]: - 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 [8]: - https://github.com/Xunnamius/next-test-api-route-handler/commit/45a79d41835b5146912511f8b583c9128d154cf9 + https://github.com/Xunnamius/next-test-api-route-handler/commit/6ef6cbeb143648eb1fed5eff39071a06e7354275 [9]: - 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 [10]: - https://github.com/Xunnamius/next-test-api-route-handler/commit/b9d2bf010fba4b163e1eea0801271292a0e74308 + https://github.com/Xunnamius/next-test-api-route-handler/commit/45a79d41835b5146912511f8b583c9128d154cf9 [11]: - 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 [12]: - https://github.com/Xunnamius/next-test-api-route-handler/commit/c82695a8816b6cd5f0e11d09cc2f948a30a416e9 + https://github.com/Xunnamius/next-test-api-route-handler/commit/b9d2bf010fba4b163e1eea0801271292a0e74308 [13]: - 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 [14]: - 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 [15]: - https://github.com/Xunnamius/next-test-api-route-handler/commit/b68c721e5100baa883c7096e5cc4e81c1c60ed00 + https://github.com/Xunnamius/next-test-api-route-handler/commit/813b21ad1e2c78594903b3a8f504f4460d8e506e [16]: - 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 [17]: - https://github.com/Xunnamius/next-test-api-route-handler/commit/750055b92699fc7f1c06349ccdb0ddc0179f891a + https://github.com/Xunnamius/next-test-api-route-handler/commit/b68c721e5100baa883c7096e5cc4e81c1c60ed00 [18]: - 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 [19]: - 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 [20]: - https://github.com/Xunnamius/next-test-api-route-handler/commit/0e7541fbecd2e3bacc124f624bfca2b56ceeb89f + https://github.com/Xunnamius/next-test-api-route-handler/commit/d604dfc39d2e77cbe1234b8349a2ecef81a9e54a [21]: + https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.0.10...v1.1.0 +[22]: + https://github.com/Xunnamius/next-test-api-route-handler/commit/0e7541fbecd2e3bacc124f624bfca2b56ceeb89f +[23]: https://github.com/Xunnamius/next-test-api-route-handler/commit/ccf54fb480e35961647900d345149d3cd1cf60d8 -[22]: https://conventionalcommits.org -[23]: https://semver.org -[24]: - https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.3...v1.2.4 -[25]: - https://github.com/Xunnamius/next-test-api-route-handler/commit/4e5e12c0df4fc80abb696d32718440ff294902e7 +[24]: https://conventionalcommits.org +[25]: https://semver.org +[26]: + https://github.com/Xunnamius/next-test-api-route-handler/compare/v1.2.4...v1.2.5 +[27]: + https://github.com/Xunnamius/next-test-api-route-handler/commit/1823c055f034e528337c68d710164097e423f6e2 +[28]: + https://github.com/Xunnamius/next-test-api-route-handler/commit/a307efcf2cdf60679d68fab385bdc8951a476ace diff --git a/docs/README.md b/docs/README.md index 5589295e..3b301c4e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -8,7 +8,7 @@ ### testApiHandler -▸ **testApiHandler**({ `handler`: (`req`: *NextApiRequest*, `res`: *NextApiResponse*<*any*>) => *Promise*<*void*> ; `params?`: *undefined* | *Record*<*string*, *unknown*> ; `requestPatcher?`: *undefined* | (`req`: *IncomingMessage*) => *void* ; `responsePatcher?`: *undefined* | (`res`: *ServerResponse*) => *void* ; `test`: (`obj`: { `fetch`: (`init?`: RequestInit) => *Promise*\ }) => *Promise*<*void*> }): *Promise*<*void*> +▸ **testApiHandler**({ `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*> }): *Promise*<*void*> Uses Next's internal `apiResolver` to execute api route handlers in a Next-like testing environment. @@ -32,9 +32,9 @@ unfetch's `fetch(...)` function but with the first parameter omitted. #### Parameters: -| Name | Type | -| ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `(destructured)` | { `handler`: (`req`: *NextApiRequest*, `res`: *NextApiResponse*<*any*>) => *Promise*<*void*> ; `params?`: *undefined* \| *Record*<*string*, *unknown*> ; `requestPatcher?`: *undefined* \| (`req`: *IncomingMessage*) => *void* ; `responsePatcher?`: *undefined* \| (`res`: *ServerResponse*) => *void* ; `test`: (`obj`: { `fetch`: (`init?`: RequestInit) => *Promise* }) => *Promise*<*void*> } | +| 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*> } | **Returns:** *Promise*<*void*> @@ -42,4 +42,4 @@ Defined in: [index.ts:31][2] [1]: README.md#testapihandler -[2]: https://github.com/Xunnamius/next-test-api-route-handler/blob/4e5e12c/src/index.ts#L31 +[2]: https://github.com/Xunnamius/next-test-api-route-handler/blob/d8868ab/src/index.ts#L31 diff --git a/package-lock.json b/package-lock.json index b8a09aac..75ace9b5 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "next-test-api-route-handler", - "version": "1.2.4", + "version": "1.2.5", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index 650fc3e8..8d2d4ff1 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "next-test-api-route-handler", - "version": "1.2.4", + "version": "1.2.5", "description": "Confidently unit test your Next.js API routes/handlers in an isolated Next.js-like environment", "keywords": [ "api",