-
Notifications
You must be signed in to change notification settings - Fork 0
37 add new researcher assistant endpoints to client ts #38
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.
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
base: develop
Are you sure you want to change the base?
37 add new researcher assistant endpoints to client ts #38
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds support for researcher assistant management in the Study client, extends recruitment listing with sorting, and updates versioning and changelog.
- Introduce
addResearcherAssistantToStudy,getStudyResearcherAssistants, andremoveResearcherAssistantFromStudymethods; deprecate related researcher endpoints. - Add
is_descendingparameter to participant accounts API and update its test. - Bump package version to 2.0.9 and document changes in CHANGELOG.md.
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/test/endpoints/study/study.test.ts | Added tests for adding/removing researcher assistants |
| src/test/endpoints/study/recruitment.test.ts | Updated recruitment test to include is_descending |
| src/endpoints/study/researchers.ts | Introduced researcher assistant endpoints and deprecations |
| src/endpoints/study/recruitment.ts | Added is_descending parameter to participant accounts |
| package.json | Bumped client version from 2.0.7 to 2.0.9 |
| CHANGELOG.md | Documented new endpoints, deprecations, and parameter change |
Comments suppressed due to low confidence (7)
src/endpoints/study/researchers.ts:37
- JSDoc for addResearcherAssistantToStudy is missing a @returns annotation. Consider adding @returns to clarify the method's return value (void).
async addResearcherAssistantToStudy({
src/endpoints/study/researchers.ts:109
- JSDoc for removeResearcherAssistantFromStudy is missing a @returns annotation. Consider adding @returns to document the method's return type.
async removeResearcherAssistantFromStudy({
src/endpoints/study/recruitment.ts:84
- The JSDoc for this method isn't updated to include the new is_descending parameter. Please add a @param description for is_descending.
is_descending,
src/test/endpoints/study/recruitment.test.ts:151
- The test adds is_descending but only asserts that the response is defined; consider adding assertions to verify that the results are returned in descending order to fully cover the new behavior.
is_descending: false,
CHANGELOG.md:10
- [nitpick] The release date for version 2.0.8 is the same as 2.0.9, which may cause confusion. Consider adjusting the dates to reflect the correct release order.
## [2.0.8] - 2025-06-25
src/test/endpoints/study/study.test.ts:226
- [nitpick] In the researcher assistant test, the variable
researcherrefers to an assistant. Rename it toresearcherAssistantfor clarity.
const researcher = researcherAssistants.find(
src/endpoints/study/researchers.ts:8
- [nitpick] The @deprecated tag has an unnecessary trailing period and lacks guidance on the alternative. You may want to update to
@deprecated Use addResearcherAssistantToStudy instead.
* @deprecated.
Coverage Report
File Coverage
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
…nhance error handling in accounts and exports Refactor imports and enhance Accounts endpoint; add Collections tests for document management Update version to 2.1.0-dev.2 and refactor test imports to use CarpTestClient Update version to 2.1.0-dev.3 and enhance build script; add TODO for refactoring token casting Bump version to 2.1.0-dev.4; remove unused Auth import from index.ts and update import in CarpTestClient Bump version to 2.1.0-dev.5; refactor CarpClient to use readonly instance and add CarpTestClient for authentication; update imports and fix return type in Accounts endpoint
…nd adjust test timeouts
…t and update tests
No description provided.