Skip to content

OpenAPI schema sync (v3.3.0)#241

Merged
JuroUhlar merged 14 commits into
mainfrom
feat/open-api-v3.3.0
May 19, 2026
Merged

OpenAPI schema sync (v3.3.0)#241
JuroUhlar merged 14 commits into
mainfrom
feat/open-api-v3.3.0

Conversation

@fingerprint-dx-team-actions-runner
Copy link
Copy Markdown

@fingerprint-dx-team-actions-runner fingerprint-dx-team-actions-runner Bot commented May 15, 2026

Schema sync for v3.3.0 OpenAPI schema release.

Manual follow-ups on top of the generated sync:

  • Updated delete visitor and search events JSDoc to match the new API docs (retention, rate limits, RFC3339 start/end).
  • Expanded search events tests with bot_info* filters, RFC3339 timestamps, and a shared URL builder helper.
  • Examples: @ts-check on all scripts, JSDoc-typed searchEvents filter, and a check:examples tsc pass (tsconfig.examples.json); lint now covers .mjs so examples are checked in CI.
  • Consolidated changesets; added a minor changeset calling out type breaking changes (BotInfo.category narrowing, new BotInfoCategory members).
  • Smoke tests: use an 89-day search window to stay within API limits.

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 15, 2026

🦋 Changeset detected

Latest 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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 15, 2026

Coverage report

St.
Category Percentage Covered / Total
🟢 Statements 100% 183/183
🟢 Branches 100% 63/63
🟢 Functions 100% 35/35
🟢 Lines 100% 181/181

Test suite run success

75 tests passing in 9 suites.

Report generated by 🧪jest coverage report action from 61fba36

Show full coverage report
St File % Stmts % Branch % Funcs % Lines Uncovered Line #s
🟢 All files 100 100 100 100
🟢  src 100 100 100 100
🟢   index.ts 100 100 100 100
🟢   sealedResults.ts 100 100 100 100
🟢   serverApiClient.ts 100 100 100 100
🟢   types.ts 100 100 100 100
🟢   urlUtils.ts 100 100 100 100
🟢   webhook.ts 100 100 100 100
🟢  src/errors 100 100 100 100
🟢   apiErrors.ts 100 100 100 100
🟢   handleErrorResponse.ts 100 100 100 100
🟢   toError.ts 100 100 100 100
🟢   unsealError.ts 100 100 100 100

JuroUhlar and others added 6 commits May 18, 2026 23:37
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>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.yaml for v3.3.0 (new BotInfoCategory/BotInfoIdentity/BotInfoConfidence/Labels, bot_info_* search filters, start/end accepting number | string, updated deleteVisitorData and other descriptions).
  • Updated serverApiClient.ts JSDoc, extended searchEventsTests.spec.ts (shared URL builder, bot_info_*, RFC3339 cases), added labels to event fixtures, and bumped .schema-version.
  • Added @ts-check to example .mjs files, introduced tsconfig.examples.json + check:examples script, widened lint to .mjs, increased smoke-test start to 89 days, and added several changesets (including a minor changeset for breaking BotInfo.category type 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.

JuroUhlar and others added 6 commits May 19, 2026 11:55
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>
@github-actions
Copy link
Copy Markdown
Contributor

🚀 Following releases will be created using changesets from this PR:

@fingerprint/node-sdk@7.3.0-test.0

Minor Changes

  • events: Add Android and iOS platform support to developer_tools smart signal (bbd6920)

  • events: Add labels to Event (1c5b353)

  • types: Type-breaking changes in generated TypeScript types for OpenAPI v3.3.0:

    • SearchEventsFilter.start and SearchEventsFilter.end are now number | string (RFC3339 strings in addition to Unix milliseconds)
    • BotInfo.category is now BotInfoCategory instead of string. Update assignments, comparisons, and narrowing that assumed a free-form string.
    • BotInfoCategory includes new enum members such as unknown (exhaustive switch statements may need updates) (ed8d5ab)
  • events-search: Add bot_info filter parameters (1c5b353)

Patch Changes

  • events: Clarify availability of proxy and VM ML score signals (1c5b353)
  • events: Clarify semantics of incremental_identification_status (1c5b353)
  • visitors: Clarify rate limits for deleteVisitorData operation (1c5b353)
  • events-search: Clarify availability of rare_device and rare_device_percentile_bucket query parameters (1c5b353)
  • events-search: Fix pagination_key example (1c5b353)

@JuroUhlar JuroUhlar merged commit 4c613aa into main May 19, 2026
17 checks passed
@JuroUhlar JuroUhlar deleted the feat/open-api-v3.3.0 branch May 19, 2026 17:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants