Skip to content

Release docs, README/config fixes, and dev dependency bumps #191

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bartes merged 3 commits into from
Jun 3, 2026
Merged

Release docs, README/config fixes, and dev dependency bumps #191

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0ed0ad6
docs: update RELEASING.md to npm
bartes Jun 2, 2026
3e88af6
docs: fix README Lists examples and widen trustedProxies type
bartes Jun 2, 2026
18e0932
chore(deps): bump dev dependencies within current majors
bartes Jun 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 17 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,20 +100,20 @@ const castle = new Castle({

### Config options

| Option | Type | Default | Description |
| ------------------- | ------------------ | -------------------------- | --------------------------------------------------------------------------------------------------------------- |
| `apiSecret` | `string` | | API secret from the [dashboard](https://dashboard.castle.io/settings/general). |
| `timeout` | `number` | `1500` | Time in ms before returning the failover strategy. |
| `failoverStrategy` | `FailoverStrategy` | `FailoverStrategy.allow` | Automatic `risk` response on timeout: `allow`, `deny`, or `challenge`. |
| `logger` | `object` | | Logs Castle API requests/responses; must respond to `info`. |
| `doNotTrack` | `boolean` | `false` | When `true`, suppresses all requests and triggers failover on `risk`. Useful in development and testing. |
| `allowlisted` | `string[]` | `[]` | Strict header allow-list (see [Header allow/deny lists](#header-allowdeny-lists)). |
| `denylisted` | `string[]` | `[]` | Headers to always scrub, in addition to the always-blocked `Cookie` / `Authorization`. |
| `ipHeaders` | `string[]` | `[]` | Custom headers to read the client IP from (see [Client IP detection](#client-ip-detection)). |
| `trustedProxies` | `string[]` | `[]` | Known proxy IPs (strings or regexes). Pick this **or** `trustedProxyDepth`, never both. |
| `trustedProxyDepth` | `number` | `0` | Number of known trusted proxies in the chain. Pick this **or** `trustedProxies`, never both. |
| `trustProxyChain` | `boolean` | `false` | Trust the entire `X-Forwarded-For` chain. **Warning:** promiscuous — a malicious proxy can spoof the client IP. |
| `baseUrl` | `string` | `https://api.castle.io/v1` | Base Castle API URL. |
| Option | Type | Default | Description |
| ------------------- | ---------------------- | -------------------------- | --------------------------------------------------------------------------------------------------------------- |
| `apiSecret` | `string` | | API secret from the [dashboard](https://dashboard.castle.io/settings/general). |
| `timeout` | `number` | `1500` | Time in ms before returning the failover strategy. |
| `failoverStrategy` | `FailoverStrategy` | `FailoverStrategy.allow` | Automatic `risk` response on timeout: `allow`, `deny`, or `challenge`. |
| `logger` | `object` | | Logs Castle API requests/responses; must respond to `info`. |
| `doNotTrack` | `boolean` | `false` | When `true`, suppresses all requests and triggers failover on `risk`. Useful in development and testing. |
| `allowlisted` | `string[]` | `[]` | Strict header allow-list (see [Header allow/deny lists](#header-allowdeny-lists)). |
| `denylisted` | `string[]` | `[]` | Headers to always scrub, in addition to the always-blocked `Cookie` / `Authorization`. |
| `ipHeaders` | `string[]` | `[]` | Custom headers to read the client IP from (see [Client IP detection](#client-ip-detection)). |
| `trustedProxies` | `(string \| RegExp)[]` | `[]` | Known proxy IPs (strings or regexes). Pick this **or** `trustedProxyDepth`, never both. |
| `trustedProxyDepth` | `number` | `0` | Number of known trusted proxies in the chain. Pick this **or** `trustedProxies`, never both. |
| `trustProxyChain` | `boolean` | `false` | Trust the entire `X-Forwarded-For` chain. **Warning:** promiscuous — a malicious proxy can spoof the client IP. |
| `baseUrl` | `string` | `https://api.castle.io/v1` | Base Castle API URL. |

### Multi-environment / multi-tenant

Expand Down Expand Up @@ -187,11 +187,12 @@ const list = await castle.createList({
await castle.createListItem({
list_id: list.id,
primary_value: '1.2.3.4',
author: { type: '$analyst_email', identifier: 'analyst@example.com' },
});

await castle.searchListItems({
list_id: list.id,
filters: { primary_value: '1.2.3.4' },
filters: [{ field: 'primary_value', op: '$eq', value: '1.2.3.4' }],
});
```

Expand Down Expand Up @@ -329,7 +330,7 @@ Pick **either** `trustedProxies` **or** `trustedProxyDepth`, never both. Private

## Errors

All API exceptions inherit from `APIError`; `ConfigurationError` is raised for setup problems. The most useful ones:
All HTTP/API exceptions inherit from `APIError`. `ConfigurationError` (setup problems) and `WebhookVerificationError` (webhook signature mismatch) extend `Error` directly. The most useful ones:

| Class | Raised when |
| -------------------------- | ------------------------------------------------------- |
Expand Down
8 changes: 4 additions & 4 deletions RELEASING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

1. Create branch `release/X.Y.Z` from `master`.
2. Update `version` in `package.json` to the new version
3. Run `yarn`
3. Run `npm install` (to refresh `package-lock.json`)
4. Update the `CHANGELOG.md` for the impending release
5. `git commit -am "release X.Y.Z"` (where X.Y.Z is the new version)
6. Push to Github, make PR to the `master` branch, and when approved, merge.
7. Make a release on Github from the `master` branch, specify tag as `vX.Y.Z` to create a tag.
8. `git checkout master && git pull`
9. Clean unversioned files: `git clean -fdx dist src`
10. `yarn build && yarn pack` to verify the package
11. `yarn publish`
9. Clean unversioned files: `git clean -fdx dist`
10. `npm run build && npm pack` to verify the package
11. `npm publish`
Loading
Loading