feat(user): add total field to search api response

[dorsha]

Fixes #662

View workflow run

Perfect! The commit has been created successfully. Now let me create a summary of the changes:

Summary

I've successfully fixed the issue where the SDK's search API was not returning the total field that the backend API provides.

Changes Made:

1. Added UserSearchResponse type (lib/management/types.ts):

   • Created a new exported type that includes both users: UserResponse[] and total: number fields
   • This matches the actual API response structure documented at https://docs.descope.com/api/management/users/search-users

2. Updated user.ts (lib/management/user.ts):

   • Imported the new UserSearchResponse type
   • Updated the internal MultipleUsersResponse type to include the total field
   • Modified search() method to return Promise<SdkResponse<UserSearchResponse>> instead of Promise<SdkResponse<UserResponse[]>>
   • Modified searchTestUsers() method to return Promise<SdkResponse<UserSearchResponse>> instead of Promise<SdkResponse<UserResponse[]>>
   • Updated transformation logic to return both users and total fields instead of just extracting users
   • Note: The deprecated searchAll() method was left unchanged to maintain backward compatibility

3. Updated tests (lib/management/user.test.ts):

   • Added UserSearchResponse to imports
   • Updated mockMgmtUsersResponse to include total: 1 field
   • Updated test expectations for search() and searchTestUsers() to expect the new response structure with both users and total

Migration Path for Users:

Before (only had access to users array):

const result = await client.management.user.search({ limit: 10 });
const users = result.data; // UserResponse[]
// No way to get total count!

After (now has access to both users and total):

const result = await client.management.user.search({ limit: 10 });
const users = result.data.users; // UserResponse[]
const total = result.data.total; // number
// Can now plan pagination!

Testing:

• All existing tests pass ✅
• Build succeeds ✅
• Pre-commit hooks (lint + format) pass ✅

The commit has been created and is ready. As per the workflow instructions, I will not push or create a PR - the GitHub Actions workflow will handle that automatically.

---

Created by Shuni 🐕

[Copilot]

Pull request overview

Adds support for returning the backend-provided total count in management user search responses, enabling proper pagination metadata in the Node SDK.

Changes:

• Introduces a new UserSearchResponse type ({ users, total }) in management types.
• Updates management.user.search() and management.user.searchTestUsers() to return { users, total } instead of just the users array.
• Updates user management tests to validate the new response shape.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File	Description
lib/management/types.ts	Adds UserSearchResponse type with users and total.
lib/management/user.ts	Changes search / searchTestUsers return types and response mapping to include total.
lib/management/user.test.ts	Updates mocks and expectations for the new { users, total } shape.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[dorsha]

@shuni please fix above comments, and also fix readme.

[shuni-bot]

🐕 Done! Updated PR: #663

View workflow run

📋 Actions Taken

✅ Reply to all 3 review threads
✅ Implement backward-compatible solution with new methods
✅ Update README with new search methods
✅ Run tests and verify changes
✅ Commit changes