OpenAPI schema sync (v3.3.0)#241
Conversation
🦋 Changeset detectedLatest commit: 61fba36 The changes in this PR will be included in the next version bump. Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Coverage report
Test suite run success75 tests passing in 9 suites. Report generated by 🧪jest coverage report action from 61fba36 Show full coverage report
|
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Enable @ts-check on examples with a dedicated check:examples script. Extend lint to cover .mjs so examples are linted in CI. Co-authored-by: Cursor <cursoragent@cursor.com>
Add mocked tests for bot_info filters and RFC3339 start/end timestamps. Co-authored-by: Cursor <cursoragent@cursor.com>
Merge duplicate developer_tools and RFC3339 changeset entries. Co-authored-by: Cursor <cursoragent@cursor.com>
Add a changeset for BotInfo.category narrowing and note RFC3339 start/end widening. Co-authored-by: Cursor <cursoragent@cursor.com>
Chain check:examples after declaration emit check so examples are validated post-build. Co-authored-by: Cursor <cursoragent@cursor.com>
There was a problem hiding this comment.
Pull request overview
Schema sync for the Fingerprint Pro Server API OpenAPI v3.3.0 release. The generated types are regenerated, the SDK's searchEvents/deleteVisitorData JSDoc is brought in line with the new docs (RFC3339 timestamps, retention/rate-limit notes), test fixtures gain labels, mocked tests cover the new bot_info_* filters and RFC3339 start/end, examples gain @ts-check plus a tsconfig.examples.json/check:examples script, and the smoke test uses an 89-day window to stay within the new 90-day API cap.
Changes:
- Regenerated
generatedApiTypes.ts/fingerprint-server-api.yamlfor v3.3.0 (newBotInfoCategory/BotInfoIdentity/BotInfoConfidence/Labels,bot_info_*search filters,start/endacceptingnumber | string, updateddeleteVisitorDataand other descriptions). - Updated
serverApiClient.tsJSDoc, extendedsearchEventsTests.spec.ts(shared URL builder,bot_info_*, RFC3339 cases), addedlabelsto event fixtures, and bumped.schema-version. - Added
@ts-checkto example.mjsfiles, introducedtsconfig.examples.json+check:examplesscript, widenedlintto.mjs, increased smoke-test start to 89 days, and added several changesets (including a minor changeset for breakingBotInfo.categorytype narrowing).
Reviewed changes
Copilot reviewed 29 out of 29 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| .schema-version | Bumps tracked OpenAPI schema to v3.3.0. |
| resources/fingerprint-server-api.yaml | Synced OpenAPI source with v3.3.0 additions/clarifications. |
| src/generatedApiTypes.ts | Regenerated TS types incl. new bot info enums, Labels, bot_info_* filters, `start |
| src/serverApiClient.ts | Refreshed JSDoc for deleteVisitorData and searchEvents start/end. |
| tests/mocked-responses-tests/searchEventsTests.spec.ts | Extracted URL helper; added bot_info_* and RFC3339 timestamp tests. |
| tests/mocked-responses-tests/mocked-responses-data/events/*.json | Added labels array to event fixtures. |
| tests/functional-tests/smokeTests.mjs | Reformat + use 89-day window to stay under API's 90-day cap. |
| example/*.mjs | Added @ts-check; searchEvents.mjs typed via JSDoc and uncommented sample filters incl. RFC3339 notes. |
| tsconfig.examples.json | New tsconfig enabling checkJs over example/**/*.mjs. |
| package.json | Lint covers .mjs; new check:examples tsc script. |
| .changeset/*.md | Changesets describing the user-facing additions and the BotInfo.category type breaking change. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Run example typecheck via typecheck:examples in test:dts; keep typecheck:source for local use only. Co-authored-by: Cursor <cursoragent@cursor.com>
Enter changesets pre-release mode with test tag for OpenAPI v3.3.0. Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
🚀 Following releases will be created using changesets from this PR:@fingerprint/node-sdk@7.3.0-test.0Minor Changes
Patch Changes
|
Schema sync for v3.3.0 OpenAPI schema release.
Manual follow-ups on top of the generated sync:
start/end).bot_info*filters, RFC3339 timestamps, and a shared URL builder helper.@ts-checkon all scripts, JSDoc-typedsearchEventsfilter, and acheck:examplestscpass (tsconfig.examples.json); lint now covers.mjsso examples are checked in CI.BotInfo.categorynarrowing, newBotInfoCategorymembers).