Add support for paginating project list (#43727)

GitOrigin-RevId: 324af62ea244a584440a9278b6f7862d6c31acce

Author: atrakh

npm-packages/dashboard/dashboard-management-openapi.json

@@ -492,6 +492,18 @@
             "in": "path",
             "description": "",
             "required": true
+          },
+          {
+            "name": "cursor",
+            "in": "query",
+            "description": "Cursor for pagination (optional)",
+            "required": true
+          },
+          {
+            "name": "limit",
+            "in": "query",
+            "description": "Maximum number of projects to return (optional, defaults to 100)",
+            "required": true
           }
         ],
         "responses": {
@@ -500,10 +512,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "type": "array",
-                  "items": {
-                    "$ref": "#/components/schemas/ProjectDetails"
-                  }
+                  "$ref": "#/components/schemas/ProjectsResponse"
                 }
               }
             }
@@ -4798,6 +4807,41 @@
           }
         }
       },
+      "PaginatedProjectsResponse": {
+        "type": "object",
+        "required": [
+          "items",
+          "pagination"
+        ],
+        "properties": {
+          "items": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ProjectDetails"
+            }
+          },
+          "pagination": {
+            "$ref": "#/components/schemas/PaginationMetadata"
+          }
+        }
+      },
+      "PaginationMetadata": {
+        "type": "object",
+        "required": [
+          "hasMore"
+        ],
+        "properties": {
+          "hasMore": {
+            "type": "boolean"
+          },
+          "nextCursor": {
+            "type": [
+              "string",
+              "null"
+            ]
+          }
+        }
+      },
       "PaymentMethodResponse": {
         "type": "object",
         "required": [
@@ -5039,6 +5083,19 @@
       "ProjectSlug": {
         "type": "string"
       },
+      "ProjectsResponse": {
+        "oneOf": [
+          {
+            "$ref": "#/components/schemas/PaginatedProjectsResponse"
+          },
+          {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ProjectDetails"
+            }
+          }
+        ]
+      },
       "ProposedTeamName": {
         "type": "string"
       },

npm-packages/dashboard/src/api/projects.ts

@@ -35,6 +35,10 @@ export function useProjects(
     // If initial data has been loaded via SSR, we don't need to load projects.
     swrOptions: { refreshInterval, revalidateOnMount: !initialData },
   });
+
+  if (data !== undefined && !Array.isArray(data)) {
+    throw new Error("Expected array of projects");
+  }
   return data;
 }
 

npm-packages/dashboard/src/generatedApi.ts

@@ -2160,6 +2160,14 @@ export interface components {
             plan: components["schemas"]["PlanResponse"];
             status: string;
         };
+        PaginatedProjectsResponse: {
+            items: components["schemas"]["ProjectDetails"][];
+            pagination: components["schemas"]["PaginationMetadata"];
+        };
+        PaginationMetadata: {
+            hasMore: boolean;
+            nextCursor?: string | null;
+        };
         PaymentMethodResponse: {
             display: string;
             kind: string;
@@ -2225,6 +2233,7 @@ export interface components {
             role?: null | components["schemas"]["ProjectRole"];
         };
         ProjectSlug: string;
+        ProjectsResponse: components["schemas"]["PaginatedProjectsResponse"] | components["schemas"]["ProjectDetails"][];
         ProposedTeamName: string;
         ProvisionDeploymentDashboardArgs: {
             deploymentType: components["schemas"]["DeploymentType"];
@@ -2576,6 +2585,8 @@ export type OauthAppResponse = components['schemas']['OauthAppResponse'];
 export type OptIn = components['schemas']['OptIn'];
 export type OptInToAccept = components['schemas']['OptInToAccept'];
 export type OrbSubscriptionResponse = components['schemas']['OrbSubscriptionResponse'];
+export type PaginatedProjectsResponse = components['schemas']['PaginatedProjectsResponse'];
+export type PaginationMetadata = components['schemas']['PaginationMetadata'];
 export type PaymentMethodResponse = components['schemas']['PaymentMethodResponse'];
 export type PeriodicBackupConfig = components['schemas']['PeriodicBackupConfig'];
 export type PlanResponse = components['schemas']['PlanResponse'];
@@ -2590,6 +2601,7 @@ export type ProjectName = components['schemas']['ProjectName'];
 export type ProjectRole = components['schemas']['ProjectRole'];
 export type ProjectRoleUpdateArg = components['schemas']['ProjectRoleUpdateArg'];
 export type ProjectSlug = components['schemas']['ProjectSlug'];
+export type ProjectsResponse = components['schemas']['ProjectsResponse'];
 export type ProposedTeamName = components['schemas']['ProposedTeamName'];
 export type ProvisionDeploymentDashboardArgs = components['schemas']['ProvisionDeploymentDashboardArgs'];
 export type ProvisionDeploymentDashboardResponse = components['schemas']['ProvisionDeploymentDashboardResponse'];
@@ -3101,7 +3113,12 @@ export interface operations {
     };
     get_projects_for_team: {
         parameters: {
-            query?: never;
+            query: {
+                /** @description Cursor for pagination (optional) */
+                cursor: string;
+                /** @description Maximum number of projects to return (optional, defaults to 100) */
+                limit: string;
+            };
             header?: never;
             path: {
                 team_id: string;
@@ -3115,7 +3132,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["ProjectDetails"][];
+                    "application/json": components["schemas"]["ProjectsResponse"];
                 };
             };
         };