Merge pull request #26378 from drodil/scaffolder_pagination_backend

feat: allow scaffolder tasks pagination in the backend

plugins/scaffolder-node/api-report.md

@@ -315,8 +315,27 @@ export interface TaskBroker {
   // (undocumented)
   get(taskId: string): Promise<SerializedTask>;
   // (undocumented)
-  list?(options?: { createdBy?: string; status?: TaskStatus }): Promise<{
+  list?(options?: {
+    filters?: {
+      createdBy?: string | string[];
+      status?: TaskStatus | TaskStatus[];
+    };
+    pagination?: {
+      limit?: number;
+      offset?: number;
+    };
+    order?: {
+      order: 'asc' | 'desc';
+      field: string;
+    }[];
+  }): Promise<{
     tasks: SerializedTask[];
+    totalTasks?: number;
+  }>;
+  // @deprecated (undocumented)
+  list?(options: { createdBy?: string; status?: TaskStatus }): Promise<{
+    tasks: SerializedTask[];
+    totalTasks?: number;
   }>;
   // (undocumented)
   recoverTasks?(): Promise<void>;

plugins/scaffolder-node/src/tasks/types.ts

@@ -181,7 +181,22 @@ export interface TaskBroker {
   get(taskId: string): Promise<SerializedTask>;
 
   list?(options?: {
+    filters?: {
+      createdBy?: string | string[];
+      status?: TaskStatus | TaskStatus[];
+    };
+    pagination?: {
+      limit?: number;
+      offset?: number;
+    };
+    order?: { order: 'asc' | 'desc'; field: string }[];
+  }): Promise<{ tasks: SerializedTask[]; totalTasks?: number }>;
+
+  /**
+   * @deprecated Make sure to pass `createdBy` and `status` in the `filters` parameter instead
+   */
+  list?(options: {
     createdBy?: string;
     status?: TaskStatus;
-  }): Promise<{ tasks: SerializedTask[] }>;
+  }): Promise<{ tasks: SerializedTask[]; totalTasks?: number }>;
 }