Skip to content

Conversation

@fern-api
Copy link
Contributor

@fern-api fern-api bot commented Oct 30, 2025

Changes

This PR enhances the SDK's pagination API with improved type safety and adds a new OAuth scope for token vault privileged access management.

Pagination API Improvements

  • Enhanced type safety for all paginated list methods across the SDK
  • Improved Page class to expose both item data and the underlying API response
  • Added explicit response types to ~50+ list methods (Actions, Clients, Connections, Users, Organizations, Roles, etc.)
  • Simplified type parameters for better developer experience

Example usage:

let page = await client.users.list({ page: 1, per_page: 10 });

// Access items in current page
console.log(page.data);

// Navigate to next pages
while (page.hasNextPage()) {
    page = await page.getNextPage();
    console.log(page.data);
}

// Access the underlying API response
const response = page.response;

Removed Endpoint

  • Removed client.users.groups.get() method (endpoint no longer available in Management API)
  • Removed associated GetUserGroupsRequestParameters interface
  • Removed related test files

New OAuth Scope

  • Added update:client_token_vault_privileged_access OAuth scope for managing client token vault privileged access

Documentation

  • Added comprehensive CONTRIBUTING.md guide with instructions on:
    • Working with auto-generated code
    • Which files can/cannot be edited
    • How to customize the SDK
    • Contributing to the code generator

Dependency Updates

  • Updated @babel/* packages to 7.28.x
  • Updated auth0-legacy (v4 SDK) from 4.33.0 to 4.34.0
  • Updated browserslist, electron-to-chromium, and other build dependencies

References

  • Management API v2 specification updates
  • Internal API definition changes

Testing

All existing tests have been updated to reflect the pagination API changes.

  • This change adds unit test coverage (pagination tests updated)
  • This change adds integration test coverage (wire tests updated)

All CI checks passing:

  • ✅ Lint & Format
  • ✅ Build & Package Lint
  • ✅ Tests (Node.js 20.x, 22.x, 24.x)
  • ✅ Type Check
  • ✅ Code Coverage
  • ✅ Semgrep Security Scan

Checklist

@fern-api fern-api bot requested a review from a team as a code owner October 30, 2025 15:14
@codecov
Copy link

codecov bot commented Oct 30, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 79.58%. Comparing base (fd8a406) to head (ce33205).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1226      +/-   ##
==========================================
- Coverage   79.61%   79.58%   -0.03%     
==========================================
  Files         506      503       -3     
  Lines       18571    18496      -75     
  Branches     8985     8812     -173     
==========================================
- Hits        14785    14720      -65     
+ Misses       3786     3776      -10     
Flag Coverage Δ
alltests 79.58% <100.00%> (-0.03%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@developerkunal developerkunal changed the title 🌿 Fern Regeneration -- October 30, 2025 chore: enhance pagination API with improved type safety Oct 30, 2025
Comment on lines 126 to 132
## Questions or Issues?

If you have questions or run into issues:

1. Check the [Fern documentation](https://buildwithfern.com)
2. Search existing [GitHub issues](https://github.com/fern-api/fern/issues)
3. Open a new issue if your question hasn't been addressed
Copy link
Member

Choose a reason for hiding this comment

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

Is this expected? Feels a bit generic to request people to contact Fern instead of Auth0 in case of questions or issues.

Copy link
Contributor

Choose a reason for hiding this comment

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

updated a bit!

@developerkunal developerkunal merged commit 36456f8 into master Nov 4, 2025
11 checks passed
@developerkunal developerkunal deleted the fern-bot/2025-10-30T15-14Z branch November 4, 2025 09:47
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.

4 participants