feat(cli): Implemented pagination support (keyshade-xyz#453)

apps/cli/src/commands/environment/list.environment.ts

@@ -1,10 +1,12 @@
 import BaseCommand from '../base.command'
 import { EnvironmentController } from '@keyshade/api-client'
 import {
+  CommandOption,
   type CommandActionData,
   type CommandArgument
 } from 'src/types/command/command.types'
 import { Logger } from '@/util/logger'
+import { PAGINATION_OPTION } from '@/util/pagination-options'
 
 export class ListEnvironment extends BaseCommand {
   getName(): string {
@@ -24,7 +26,11 @@ export class ListEnvironment extends BaseCommand {
     ]
   }
 
-  async action({ args }: CommandActionData): Promise<void> {
+  getOptions(): CommandOption[] {
+    return PAGINATION_OPTION
+  }
+
+  async action({ args, options }: CommandActionData): Promise<void> {
     const [projectSlug] = args
 
     if (!projectSlug) {
@@ -44,7 +50,7 @@ export class ListEnvironment extends BaseCommand {
       data: environments,
       error
     } = await environmentController.getAllEnvironmentsOfProject(
-      { projectSlug },
+      { projectSlug, ...options },
       headers
     )
 

apps/cli/src/commands/workspace/list.workspace.ts

@@ -1,6 +1,8 @@
 import BaseCommand from '@/commands/base.command'
 import { Logger } from '@/util/logger'
 import ControllerInstance from '@/util/controller-instance'
+import { CommandActionData, CommandOption } from '@/types/command/command.types'
+import { PAGINATION_OPTION } from '@/util/pagination-options'
 
 export default class ListWorkspace extends BaseCommand {
   getName(): string {
@@ -11,12 +13,18 @@ export default class ListWorkspace extends BaseCommand {
     return 'Fetches all the workspace you have access to'
   }
 
-  async action(): Promise<void> {
+  getOptions(): CommandOption[] {
+    return PAGINATION_OPTION
+  }
+
+  async action({ options }: CommandActionData): Promise<void> {
     Logger.info('Fetching all workspaces...')
 
     const { success, data, error } =
       await ControllerInstance.getInstance().workspaceController.getWorkspacesOfUser(
-        {},
+        {
+          ...options
+        },
         this.headers
       )
 

apps/cli/src/util/pagination-options.ts

@@ -0,0 +1,31 @@
+import { CommandOption } from '@/types/command/command.types'
+
+export const PAGINATION_OPTION: CommandOption[] = [
+  {
+    short: '-p',
+    long: '--page <int>',
+    description: 'Index of the page.'
+  },
+  {
+    short: '-l',
+    long: '--limit <int>',
+    description: 'Total number of items per page.'
+  },
+  {
+    short: '-o',
+    long: '--order <string>',
+    description:
+      'Order to sort by - either ascending (ASC) or descending (DESC).',
+    choices: ['ASC', 'DESC']
+  },
+  {
+    short: '--sort',
+    long: '--sort <string>',
+    description: 'Field to sort by.'
+  },
+  {
+    short: '-s',
+    long: '--search <string>',
+    description: 'Search term.'
+  }
+]