Release docs, README/config fixes, and dev dependency bumps#191
Merged
Conversation
The repo switched from Yarn to npm in 3.0.0; update the release steps (`npm install` / `npm run build && npm pack` / `npm publish`) and drop the now-tracked `src` from the `git clean` step.
- `createListItem` example was missing the required `author` field, so it did not type-check against `CreateListItemPayload`. - `searchListItems` `filters` is an array of filter objects, not an object; fix the example accordingly. - Widen `ConfigurationProperties.trustedProxies` to `(string | RegExp)[]` so the documented string form type-checks (the constructor already wraps each entry in `new RegExp(...)`); update the config table type to match. - Clarify in the errors section that `ConfigurationError` and `WebhookVerificationError` extend `Error` directly rather than `APIError`.
- @eslint/eslintrc 3.3.5 - @typescript-eslint/eslint-plugin, @typescript-eslint/parser 8.60.1 - eslint-config-prettier 10.1.8 - eslint-plugin-prettier 5.5.6 - express 5.2.1 - jest 30.4.2 - prettier 3.8.3 - rimraf 6.1.3 - ts-jest 29.4.11 - tsup 8.5.1
afterdesign
approved these changes
Jun 3, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
RELEASING.mdto npm:npm install,npm run build && npm pack,npm publish; dropsrcfrom thegit cleanstep.authorfield to thecreateListItemREADME example.searchListItemsREADME example:filterstakes an array of{ field, op, value }.trustedProxiesto(string | RegExp)[]; entries are wrapped innew RegExp(...)in the constructor.ConfigurationErrorandWebhookVerificationErrorextendErrordirectly.@eslint/eslintrc3.3.5,@typescript-eslint/*8.60.1,eslint-config-prettier10.1.8,eslint-plugin-prettier5.5.6,express5.2.1,jest30.4.2,prettier3.8.3,rimraf6.1.3,ts-jest29.4.11,tsup8.5.1.