CHANGELOG.md

Changelog

3.0.0 (2024-10-02)

⚠ BREAKING CHANGES

• dropped support for fastify v4.x
• dropped support for node 14, 16 and 18

Continuous integration

• cd: sort release note sections alphabetically (5a4a974)
• cd: standardise @fdawgs cd workflows (d6ed4ea)
• ci: audit package signatures and provenance attestations (6365f2b)
• ci: standardise @fdawgs ci workflows (d2c24f6)
• dependabot: add [@eslint-community](https://github.com/eslint-community) scoped deps to eslint group (bc3f03f)
• deps: bump actions/dependency-review-action from 3 to 4 (#222) (a782893)
• deps: bump coverallsapp/github-action from 2.2.3 to 2.3.0 (#235) (be36112)
• deps: bump wagoid/commitlint-github-action from 5 to 6 (#228) (704a92b)
• use latest node lts version (bdc0666)

Dependencies

• deps-dev: bump dev dependencies (dd41126)
• deps-dev: bump husky from 8.0.3 to 9.0.6 (#223) (caf4eb3)
• deps-dev: bump the commitlint group with 2 updates (#227) (253e0cf)

Features

• support fastify v5.x (2c51678)

Improvements

• index: swap negated condition (327480e)

Miscellaneous

• .husky/commit-msg: remove npx usage (a5528e4)
• .husky: migrate hooks to v9 style (06a1816)
• .npmrc: enforce strict engine checks (17451c3)
• .npmrc: remove excess whitespace (b46f290)
• .vscode: fix prettier.prettierPath setting (89ed836)
• drop support for node 14, 16, and 18 (d6c007e)
• index: inline comment re export types (0768f72)
• jsconfig: enable strict type checking (e981513)
• package: change author email (22ea6c7)

2.1.11 (2024-01-24)

Dependencies

• deps-dev: bump dev dependencies (1c7e53d)

Miscellaneous

• .vscode: use local prettier version (105035c)
• jsconfig: remove lib; target will be used in absence (9d7608a)
• package: fix repository structure (c6673f0)
• scripts/license-checker: handle old license arrays or missing (00b52f5)

Continuous integration

• automerge: optimise inline js scripts (9099ff6)
• cd: param order (2852a50)
• cd: publish to github packages with provenance (db56d80)
• cd: use main environment for publish-npm job (2ea9d76)

Documentation

• readme: grammar fixes (535691e)

2.1.10 (2024-01-08)

Continuous integration

• cd: remove redundant npm publish args (820db1d)
• cd: use granular job permissions over top-level (e33f437)

2.1.9 (2024-01-07)

Miscellaneous

• .github: use shared files from fdawgs/.github (6091b36)

Continuous integration

• cd: grant write permissions to packages (b8e4335)

2.1.8 (2024-01-07)

Dependencies

• deps-dev: bump dev dependencies (ccc0e58)

Miscellaneous

• jsdoc comments must be complete sentences (4803a67)
• license: update license year (cc74fc8)
• package: add lint:fix script (27773f0)
• package: run lint:prettier in test script (29ca973)

Continuous integration

• cd: publish to github packages as well as npm (ac794e9)
• dependabot: ignore release-please-action major updates (d1b1998)
• deps: bump actions/upload-artifact from 3 to 4 (#210) (7661586)
• deps: bump github/codeql-action from 2 to 3 (#209) (9819999)

Documentation

• readme: update links (f9ebbc6)
• use shared files from fdawgs/.github (e8d5b63)

2.1.7 (2023-11-29)

Dependencies

• deps-dev: add eslint-community/eslint-plugin-eslint-comments (7f6ccfb)
• deps-dev: bump dev dependencies (2edfd34)
• deps-dev: bump the commitlint group with 2 updates (#202) (e420770)
• deps-dev: bump the eslint group with 1 update (#203) (7f795f2)
• deps-dev: remove broken eslint-plugin-security-node (6c605fe)

Miscellaneous

• .vscode: add github-markdown-preview to recommended extension (45d1af1)
• .vscode: add gitlens to recommended extensions (d26b303)
• jsconfig: use es2022 lib (81b0d89)
• scripts/license-checker: update link to deprecated list (8e6d41d)

Continuous integration

• deps: bump actions/github-script from 6 to 7 (#204) (acf7aea)
• deps: bump actions/setup-node from 3 to 4 (#201) (d71ccd8)

Documentation

• readme: fix broken ci badge link (46433d8)
• readme: use full cjs for example (9f4eb87)

2.1.6 (2023-09-23)

Miscellaneous

• .gitattributes: auto lf eol all files (1934a44)
• add missing .gitattributes file (80198d7)
• change comment blocks with one line into single block (7f062d5)
• eslintrc: bump ecma version to 2023 (8c9e76d)
• jsconfig: set module to nodenext (d7bf975)
• jsconfig: target es2022 (395c27f)
• package: explicitly declare js module type (d84dceb)
• scripts/license-checker: declare copyLeftLicenses type (4c16e57)
• scripts/license-checker: destruct upath module import (#194) (7e7746c)
• scripts/license-checker: ignore invalid ts error (dc53501)
• use [@see](https://github.com/see) jsdoc tag for inline comment links (538f3a1)

Continuous integration

• dependabot: group dependabot updates (7dc8559)
• deps: bump actions/checkout from 3 to 4 (#197) (86ca5db)
• deps: bump coverallsapp/github-action from 2.2.1 to 2.2.3 (#196) (64a2079)

Improvements

• use node: prefix to bypass require.cache call for builtins (1d3f738)

Documentation

• readme: update acknowledgements (6a3a91f)

2.1.5 (2023-08-16)

Dependencies

• deps-dev: bump dev dependencies (cbf371b)
• deps-dev: bump eslint-config-prettier from 8.10.0 to 9.0.0 (#187) (7072c0c)
• deps: bump fastify-plugin from 4.5.0 to 4.5.1 (cf5ea41)

Miscellaneous

• .eslintrc: error on google closure jsdoc syntax (24e4486)
• add jsconfig; type check js (#189) (7e7d164)
• index: add whitespace between import and comment (0a53983)
• jsconfig: add target (cd68ea5)
• package: add google's topics api to keywords (3b9b742)
• rename lint:prettier scripts to reflect their function (#183) (e54a5e7)
• scripts/license-checker: use console.error() to log failures (0e02ff4)

Continuous integration

• ci: error on new jest snapshot (2466487)
• deps: bump coverallsapp/github-action from 2.2.0 to 2.2.1 (#185) (f7acf13)

Improvements

• scripts/license-checker: deconstruct imports (d23b1a7)

Documentation

• readme: add mention of google's topics api (2f27618)

2.1.4 (2023-07-08)

Miscellaneous

• .eslintrc: sort extends array (ca12e6b)

Dependencies

• deps-dev: add eslint-plugin-regexp (fe91de2)
• deps-dev: bump dev dependencies (936db39)

Bug fixes

• add missing strict mode directives (#180) (c91d11b)

2.1.3 (2023-06-24)

Continuous integration

• deps: bump coverallsapp/github-action from 2.1.2 to 2.2.0 (#175) (b29327c)

Miscellaneous

• .eslintrc: enable additional jest plugin rules (886a714)
• .eslintrc: enable additional jsdoc plugin rules (15ac3cd)
• .eslintrc: only use jest plugin to lint test-related files (280f8f9)
• .eslintrc: update ecmascript version (f5f7aa4)
• import fastify type for server jsdoc param (c8d3d1d)
• package: remove global jest mock config values (aa9c6fa)
• package: set jest coverage threshold (728eefd)
• scripts/license-checker: resolve eslint jsdoc warning (#167) (952236a)
• scripts: fix inline comment style (0b69a96)
• use nouns for leading word in function description tags (#169) (20b642f)

Dependencies

• deps-dev: bump dev dependencies (#171) (6b667f7)
• deps-dev: bump dev dependencies (#176) (c1ea98e)
• deps-dev: bump eslint-plugin-jsdoc from 44.2.7 to 46.1.0 (#172) (5c7418a)

2.1.2 (2023-04-24)

Miscellaneous

• .prettierrc: enable arrowParens option (#161) (897ceea)

Dependencies

• deps-dev: bump eslint-plugin-jsdoc from 40.3.0 to 43.0.7 (#164) (de98fb9)

Continuous integration

• cd: publish to npm with provenance (#166) (d3d8756)
• ci: add node 20 to test matrix (#165) (7a59aeb)
• deps: bump coverallsapp/github-action from 2.0.0 to 2.1.2 (#163) (b00ed0c)

2.1.1 (2023-03-31)

Miscellaneous

• ignore bun lockfile (#155) (d8b8ecc)
• package: add funding url (2c3a500)
• scripts: add eslint rule file (408b031)
• scripts: remove redundant export (03d8415)
• scripts: sort eslint comments alphabetically (f9a0a93)
• scripts: use js script to check licenses (#156) (f3a63f2)

Documentation

• changelog: spelling mistake (189a192)
• contributing: add link to conventional config (#158) (56bd5bc)

Continuous integration

• dependabot: change commit message prefix for gh actions to ci (#157) (676b01a)
• deps: bump coverallsapp/github-action from 1.2.4 to 2.0.0 (#159) (faff339)

Dependencies

• deps-dev: bump dev dependencies (2e011e6)
• deps: bump coverallsapp/github-action from 1.1.3 to 1.2.3 (#153) (e1496f1)
• deps: bump coverallsapp/github-action from 1.2.3 to 1.2.4 (#154) (b0c0417)

2.1.0 (2023-02-15)

Features

• add nodenext compatibility (0480910)

Documentation

• readme: add acknowledgements section (ab27d82)

2.0.6 (2023-02-13)

Continuous integration

• cd: use sentence case for changelog headings (721b31f)

Dependencies

• deps-dev: bump dev dependencies (49baad0)

Documentation

• contributing: update title style guidance (9336051)
• readme: rename intro to overview (35da4a0)

Miscellaneous

• rename master branch to main (#148) (880a2ce)
• use sentence case over ap style for titles and headings (c23fa0d)

2.0.5 (2023-01-31)

Bug fixes

• index: add to permissions-policy header if one already exists (#144) (2b12ab4)

Miscellaneous

• license: update license year (b0556c0)

Documentation

• contributing: update min node version (4744d1e)
• grammar and clarity fixes (b7273e9)
• readme: remove fluff (06ff83b)

Dependencies

• deps-dev: bump dev dependencies (bb5d908)
• deps: bump actions/dependency-review-action from 2 to 3 (#141) (2f401a7)
• deps: bump fastify-plugin from 4.3.0 to 4.5.0 (752bde3)

2.0.4 (2022-10-25)

Continuous integration

• cd: remove dev values from package.json (#138) (2c7f75c)

Dependencies

• deps-dev: bump dev dependencies (54ce990)
• deps: bump fastify-plugin from 4.2.1 to 4.3.0 (a7ea7a8)

2.0.3 (2022-10-03)

Documentation

• readme: convert sync async example to sync only (4737968)
• readme: remove redundant statement (218b43c)
• use shorter urls; remove yarn install guidance (fe7690d)

Miscellaneous

• .husky: shell path and arg updates (#132) (c98fb33)
• .npmignore: reduce entries (9d60422)
• .vscode/extensions: remove unmaintained extension (f3ff5f8)
• *.ignore: add clinicjs directory (d227d4d)
• LICENSE: remove trailing whitespace (5dbd665)
• prefer object destructuring (#137) (4d4f336)

Dependencies

• deps-dev: bump eslint-plugin-jest from 26.9.0 to 27.0.1 (#135) (34b5458)
• deps-dev: bump jest from 28.1.3 to 29.0.1 (#134) (26988f2)
• deps: bump dependencies (904e991)

2.0.2 (2022-08-09)

Miscellaneous

• .npmrc: disable package-lock generation (#128) (e722bad)

Dependencies

• .npmignore: add CHANGELOG.md; reduce package size by ~82% (#130) (18d45da)
• deps: bump dependencies (#131) (f34ab36)

2.0.1 (2022-07-25)

Miscellaneous

• .github/funding: remove unused keys (8d7365d)
• .github: add FUNDING.yml (f1653b5)
• .gitignore: use latest github ignore template (0977ef6)
• .prettierignore: add new paths from .gitignore (4ff9118)
• ignore pnpm lock file (67fbd42)

Dependencies

• dependabot: increase open-pull-requests-limit from 5 to 20 (4a3fc2b)
• deps: bump actions/dependency-review-action from 1 to 2 (#125) (944b827)
• deps: bump fastify-plugin from 3.0.1 to 4.0.0 (#127) (a437977)
• deps: bump wagoid/commitlint-github-action from 4 to 5 (#126) (58a9ef2)

Documentation

• readme: update example for fastify v4 (84161cf)

2.0.0 (2022-05-26)

⚠ BREAKING CHANGES

• • Dropped support for Fastify v3.x and Node 10.x

Features

• support fastify v4.x (#122) (56247e9)

1.0.7 (2022-05-25)

Documentation

• readme: remove snyk badge (af7eb11)

Miscellaneous

• .eslintrc: enable plugin:jest/style rules (#113) (b23ebcd)
• .github/codeql-config: remove quotation marks (53e81b2)
• .github/workflows/link-check: use skip input (85f1b3d)
• bug_report: use node 18 as placeholder for node-version (ebedd18)
• ci: remove quotation marks from step name (9238948)
• use npm install alias (c52fc0a)

Continuous integration

• add dependency-review job (14f81fd)
• automerge: fix context (7c3cab1)
• automerge: squash automerge prs (#102) (51db005)
• cd: update org name for release-please-action (26aa002)
• cd: use lts/* for node setup in release job (bcff76c)
• check user.login is dependabot instead of actor (#115) (fc853c1)
• ci: add node 18 to test matrix (#114) (4941eb1)
• ci: require unit-tests job to pass for save-pr-number job to run (2550c32)
• ci: use lts/* for node setup in lint job (2c89dd6)
• ci: use node-version for node matrix key (51d4cef)
• codeql: only run on pr changes to .html, .js, and .yml files (0a34500)
• codeql: resolve missing analyses (9da0a10)
• codeql: specify which files to scan during analysis (bd55ff5)
• link-check: replace npx linkinator call with github action (67ffdfe)
• only trigger dependency-review on pr (ce56e18)
• reduce workflow permissions to minimum (97558a7)
• remove git credentials after checkout (#118) (65dedb2)
• replace workflow-run-cleanup-action with github concurrency (3644841)

Dependencies

• deps-dev: bump @commitlint/cli from 16.3.0 to 17.0.1 (#120) (0637d06)
• deps-dev: bump @commitlint/config-conventional (#119) (05a3e8b)
• deps-dev: bump eslint-plugin-jsdoc from 38.1.6 to 39.2.9 (#109) (5c90649)
• deps-dev: bump husky from 7.0.4 to 8.0.1 (#121) (04e5380)
• deps-dev: bump jest from 27.5.1 to 28.0.3 (#110) (02c9166)
• deps: bump actions/upload-artifact from 2 to 3 (#107) (696d5e6)
• deps: bump github/codeql-action from 1 to 2 (#108) (eafd106)

1.0.6 (2022-03-28)

Documentation

• improve readability (991f362)

Miscellaneous

• scripts: remove redundant gitkraken fix from prepare script (83943d6)
• scripts: use shorter arg aliases; remove debugging args from jest (ac15f3b)

Continuous integration

• add job step names, workflow comments, and whitespace (970f4db)
• codeql-analysis: remove unused autobuild step (3648199)
• codeql: grant minimum permissions to run; rename file (#98) (6ba714f)
• only save pr number artifact for dependabot (a7525d9)

Dependencies

• deps-dev: bump eslint-plugin-jsdoc from 37.9.7 to 38.0.6 (e501410)
• deps: bump actions/checkout from 2 to 3 (6df37d1)

Improvements

• index: use header() instead of headers() (#101) (35cc795)

1.0.5 (2022-02-25)

Miscellaneous

• .github: remove trailing whitespace (7de0f06)

Dependencies

• dependabot: ignore minor and patch commit-lint updates (#87) (f6f0c5f)
• dependabot: major tags no longer need ignore support (b0776cd)
• dependabot: use default open-pull-requests-limit value (ccbbd8e)
• deps-dev: bump dev dependencies (f73618e)
• deps-dev: bump eslint-plugin-jest from 25.7.0 to 26.0.0 (69220ba)
• deps-dev: unpin prettier version (9a86e04)
• deps: bump actions/github-script from 5 to 6 (051669a)
• deps: bump actions/setup-node from 2 to 3 (a3fdea0)

1.0.4 (2022-01-07)

Documentation

• coc: reduce verbosity (16a2def)
• contributing: add mention of husky pre-commit hook (ada22c8)
• contributing: add step for lint:licenses script (e0d78c8)

Miscellaneous

• .prettierrc: only enable bracketSameLine for html (#63) (797d9a3)
• husky/pre-commit: add lint:licenses script (#73) (5093967)
• ignore .yarnclean (#74) (263ed53)
• index: fix server jsdoc tag param type (4e73240)

Continuous integration

• cd: stop prepare script running (#65) (7758b27)
• ci: do not run clean-up on draft prs (cc8d3a0)
• remove spellcheck workflow (#84) (500b258)
• spell-check: do not run on draft prs (7560aae)
• trigger workflows when drafts marked as "ready to review" (#67) (5266ebc)

Dependencies

• dependabot: ignore minor and patch github-actions updates (#68) (c8cde67)
• dependabot: ignore minor and patch release-please-action updates (#77) (cdbbcf4)
• deps-dev: bump @commitlint/cli from 13.2.1 to 14.1.0 (fc255dc)
• deps-dev: bump @commitlint/cli from 14.1.0 to 15.0.0 (3511356)
• deps-dev: bump @commitlint/cli from 15.0.0 to 16.0.1 (93ea8df)
• deps-dev: bump @commitlint/config-conventional (c865c75)
• deps-dev: bump @commitlint/config-conventional (93e89ff)
• deps-dev: bump @commitlint/config-conventional (e220eb1)
• deps-dev: bump eslint from 7.32.0 to 8.6.0 (3a208f4)
• deps-dev: bump eslint-config-airbnb-base from 14.2.1 to 15.0.0 (49947ff)
• deps-dev: bump eslint-plugin-promise from 5.2.0 to 6.0.0 (38182a2)
• deps-dev: bump prettier from 2.4.1 to 2.5.0 (a0df2bf)
• deps-dev: bump prettier from 2.5.0 to 2.5.1 (4a8569c)
• deps: bump GoogleCloudPlatform/release-please-action (7c62c19)
• deps: bump GoogleCloudPlatform/release-please-action from 2 to 3 (d917de8)

1.0.3 (2021-10-29)

Continuous integration

• automerge: update location of octokit rest methods (0e82ead)
• ci: revert to workflow-run-clean-action from github concurrency (2aa77ca)

Miscellaneous

• .eslintrc: remove inaccurate sourcetype (#50) (d8ed606)
• .eslintrc: remove redundant impliedStrict option (#52) (944ed87)
• .eslintrc: set correct ecmascript version (#39) (bd46255)
• .husky/.gitignore: remove now redundant file (38199a8)
• .prettierrc: enable bracketsameline option (336b0ed)
• .prettierrc: override defaults for html, css, and scss files (#40) (e9cd573)
• .vscode: add mhutchie.git-graph extension (085479a)
• .vscode: remove deprecated settings (#51) (38d4b67)

Documentation

• bump coc from v2.0.0 to v2.1.0 (#53) (939cf51)

Dependencies

• deps-dev: add eslint-plugin-security-node (#41) (00db130)
• deps-dev: bump dev dependencies (#60) (e8f3b93)
• deps-dev: bump eslint-plugin-jest from 24.7.0 to 25.2.2 (e16c871)
• deps-dev: bump eslint-plugin-jsdoc from 36.1.1 to 37.0.3 (106412f)
• deps-dev: bump prettier from 2.3.2 to 2.4.1 (b8316d3)
• deps: bump actions/checkout from 2.3.4 to 2.3.5 (42c7bdc)
• deps: bump actions/github-script from 4.1 to 5 (08a9724)
• deps: bump actions/setup-node from 2.4.0 to 2.4.1 (3ad60a8)
• deps: bump GoogleCloudPlatform/release-please-action (99e9e9f)
• deps: bump GoogleCloudPlatform/release-please-action (d8bf0d5)
• deps: bump wagoid/commitlint-github-action from 4.1.1 to 4.1.4 (77dd11e)
• deps: bump wagoid/commitlint-github-action from 4.1.4 to 4.1.9 (7bb7c56)

1.0.2 (2021-09-06)

Documentation

• readme: grammar and wordiness fixes (bf30cbf)
• readme: update contributing section (83df0b3)

Miscellaneous

• .github: use new YAML configured GitHub issue forms (#35) (81aa63e)
• ci: replace node-version key with shorter node (#14) (099340c)
• vscode: disable red hat telemetry (b57bcf7)
• vscode: remove user space config setting (96a4f82)
• workflows: remove stale.yml (5c66306)

Continuous integration

• cd: move perf optimizations and refactoring into same section (256e987)
• ci: replace workflow-run-cleanup-action with github concurrency (#36) (ae97274)
• fix key usage in action/setup-node (67b257f)
• link-check: reduce frequency from daily to monthly (#21) (a544aff)

Dependencies

• add .npmignore; reduce package size from 12.8kB to 3.9kB (#37) (71e4be1)
• deps-dev: bump @commitlint/cli from 12.1.4 to 13.1.0 (5ffa2ef)
• deps-dev: bump @commitlint/config-conventional (e005c28)
• deps-dev: bump eslint-plugin-jsdoc from 33.3.0 to 35.1.2 (afd7e92)
• deps-dev: bump eslint-plugin-jsdoc from 35.5.1 to 36.0.6 (87cb2a5)
• deps-dev: bump husky from 6.0.0 to 7.0.0 (dcb877b)
• deps-dev: bump jest from 26.6.3 to 27.0.3 (c97caa5)
• deps-dev: bump prettier from 2.2.1 to 2.3.0 (83dad6e)
• deps-dev: bump prettier from 2.3.0 to 2.3.2 (a74fe91)
• deps: bump actions/github-script from 4.0.2 to 4.1 (cb4ae30)
• deps: bump actions/setup-node from 2.1.5 to 2.2.0 (b7609e8)
• deps: bump actions/setup-node from 2.2.0 to 2.3.0 (d25cb30)
• deps: bump actions/setup-node from 2.3.0 to 2.4.0 (53b492a)
• deps: bump actions/upload-artifact from 2.2.3 to 2.2.4 (e0937e2)
• deps: bump coverallsapp/github-action from 1.1.2 to 1.1.3 (4a2b86a)
• deps: bump GoogleCloudPlatform/release-please-action (d1966e8)
• deps: bump wagoid/commitlint-github-action from 3.1.1 to 3.1.4 (e0b9bdb)
• deps: bump wagoid/commitlint-github-action from 3.1.4 to 4.1.1 (048d35c)

1.0.1 (2021-05-06)

Documentation

• grammar and readability fixes (912958f)
• security: add missing hyphen (65b2715)

Dependencies

• deps-dev: bump eslint-plugin-jsdoc from 32.3.4 to 33.0.0 (dfafef3)
• deps: bump GoogleCloudPlatform/release-please-action (a8b1884)
• deps: bump GoogleCloudPlatform/release-please-action (4ecd92e)
• deps: bump typoci/spellcheck-action from v1.0.0 to v1.1.0 (465f6ba)
• deps: bump wagoid/commitlint-github-action from v3.1.0 to v3.1.1 (f656012)

1.0.0 (2021-04-28)

Miscellaneous

• initial code commit (1be3232)

Dependencies

• deps-dev: bump eslint-plugin-promise from 4.3.1 to 5.1.0 (a5e8135)
• deps: bump actions/github-script from v3.1.1 to v4.0.2 (01fdfe2)
• deps: bump actions/upload-artifact from v2.2.2 to v2.2.3 (dc05865)
• deps: bump GoogleCloudPlatform/release-please-action (c2d6d63)
• deps: bump typoci/spellcheck-action from v0.4.0 to v1.0.0 (a5a3141)
• deps: bump wagoid/commitlint-github-action from v3.0.6 to v3.1.0 (63d9774)