Repository navigation
feat: add cursor-paged listTasksPage and TaskPage type - #7
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds cursor-paged task listing to
PluginApiClient, matching the host'slistTasksPage()from Paca-AI/paca#598.listTasks()previously stopped silently at the first 200 tasks; there was no way to read the rest.Changes
listTasksPage(filters?)(new) returns one page,{ items, page_size, next_cursor, total_count? }. Passnext_cursorasfilters.cursorto get the next page.page_sizedefaults to 200.listTasks(filters?)now callslistTasksPage()and returns itsitems. It still returns a plain array, so existing callers keep working, but it is the first page only. The docs and JSDoc now say so.TaskPage;TaskFiltersgainscursor.TaskFilters.pageis marked@deprecated. The tasks endpoint pages by cursor and ignores it, so the client no longer sends it.listTasks().Usage
Compatibility
Backwards compatible for callers of
listTasks(): same return type. Callers that passedpageget the first page instead of page N, which the API already did. Code that needs more than 200 tasks should move tolistTasksPage().Notes
apps/webplugin client gains the samelistTasksPage()).listTasksPage().