feat(cli): Add functionality to operate on Environments

apps/api/src/user/service/user.service.ts

@@ -1,9 +1,18 @@
-import { ConflictException, Inject, Injectable, Logger, UnauthorizedException } from '@nestjs/common'
+import {
+  ConflictException,
+  Inject,
+  Injectable,
+  Logger,
+  UnauthorizedException
+} from '@nestjs/common'
 import { UpdateUserDto } from '../dto/update.user/update.user'
 import { AuthProvider, User } from '@prisma/client'
 import { PrismaService } from '../../prisma/prisma.service'
 import { CreateUserDto } from '../dto/create.user/create.user'
-import { IMailService, MAIL_SERVICE } from '../../mail/services/interface.service'
+import {
+  IMailService,
+  MAIL_SERVICE
+} from '../../mail/services/interface.service'
 import createUser from '../../common/create-user'
 import generateOtp from '../../common/generate-otp'
 import { EnvSchema } from '../../common/env/env.schema'

apps/cli/package.json

@@ -3,6 +3,7 @@
   "version": "1.0.0",
   "description": "CLI for keyshade",
   "main": "index.js",
+  "private": false,
   "type": "commonjs",
   "scripts": {
     "build": "swc src --out-dir dist",
@@ -23,7 +24,8 @@
     "fs": "0.0.1-security",
     "nodemon": "^3.1.4",
     "socket.io-client": "^4.7.5",
-    "typescript": "^5.5.2"
+    "typescript": "^5.5.2",
+    "@keyshade/api-client": "workspace:*"
   },
   "devDependencies": {
     "@swc/cli": "^0.4.0",

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

@@ -0,0 +1,26 @@
+import BaseCommand from './base.command'
+import { CreateEnvironment } from './environment/create.environment'
+import { DeleteEnvironment } from './environment/delete.environment'
+import { GetEnvironment } from './environment/get.environment'
+import { ListEnvironment } from './environment/list.environment'
+import { UpdateEnvironment } from './environment/update.environment'
+
+export default class EnvironmentCommand extends BaseCommand {
+  getName(): string {
+    return 'environment'
+  }
+
+  getDescription(): string {
+    return 'Manage your environments in keyshade.'
+  }
+
+  getSubCommands(): BaseCommand[] {
+    return [
+      new CreateEnvironment(),
+      new DeleteEnvironment(),
+      new GetEnvironment(),
+      new ListEnvironment(),
+      new UpdateEnvironment()
+    ]
+  }
+}

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

@@ -0,0 +1,97 @@
+import BaseCommand from '../base.command'
+import { spinner, text, intro, outro } from '@clack/prompts'
+import {
+  type CommandActionData,
+  type CommandArgument,
+  type CommandOption
+} from 'src/types/command/command.types'
+import { EnvironmentController } from '@keyshade/api-client'
+import { Logger } from '@/util/logger'
+export class CreateEnvironment extends BaseCommand {
+  getName(): string {
+    return 'create'
+  }
+
+  getDescription(): string {
+    return 'Create a new environment'
+  }
+
+  getOptions(): CommandOption[] {
+    return [
+      {
+        short: '-n',
+        long: '--name <string>',
+        description: 'Name of the Environment'
+      },
+      {
+        short: '-d',
+        long: '--desc <string>',
+        description: 'Description about the Environment'
+      }
+    ]
+  }
+
+  getArguments(): CommandArgument[] {
+    return [
+      {
+        name: '<Project ID>',
+        description:
+          'ID of the project under which you want to add the environment'
+      }
+    ]
+  }
+
+  async action({ options, args }: CommandActionData): Promise<void> {
+    const [projectId] = args
+    const { name, description } = await this.parseInput(options)
+
+    if (!projectId) {
+      Logger.error('Project ID is required')
+      return
+    }
+
+    const apiKey = this.apiKey
+
+    const environmentData = {
+      name,
+      description,
+      projectId
+    }
+
+    const headers = {
+      'x-keyshade-token': apiKey
+    }
+
+    try {
+      intro('Creating Environment')
+      const createdEnvironment = await EnvironmentController.createEnvironment(
+        environmentData,
+        headers
+      )
+      const spin = spinner()
+      spin.message(`- Name: ${createdEnvironment.name}`)
+      spin.message(`- ID: ${createdEnvironment.id}`)
+      outro('Environment Created Successfully.')
+      spin.stop()
+    } catch (error) {
+      Logger.error(error.message as string)
+    }
+  }
+
+  private async parseInput(options: CommandActionData['options']): Promise<{
+    name: string
+    description?: string
+  }> {
+    let { name } = options
+    const { description } = options
+
+    if (!name) {
+      name = await text({
+        message: 'Enter the name of the Environment',
+        placeholder: 'env'
+      })
+    }
+
+    return { name, description }
+  }
+}

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

@@ -0,0 +1,53 @@
+import BaseCommand from '../base.command'
+import { intro, outro } from '@clack/prompts'
+import { EnvironmentController } from '@keyshade/api-client'
+import {
+  type CommandActionData,
+  type CommandArgument
+} from 'src/types/command/command.types'
+import { Logger } from '@/util/logger'
+
+export class DeleteEnvironment extends BaseCommand {
+  getName(): string {
+    return 'delete'
+  }
+
+  getDescription(): string {
+    return 'Delete an environment'
+  }
+
+  getArguments(): CommandArgument[] {
+    return [
+      {
+        name: '<Environment ID>',
+        description: 'ID of the environment which you want to delete.'
+      }
+    ]
+  }
+
+  async action({ args }: CommandActionData): Promise<void> {
+    const [environmentId] = args
+
+    if (!environmentId) {
+      Logger.error('Environment ID is required')
+      return
+    }
+
+    const apiKey = this.apiKey
+
+    const headers = {
+      'x-keyshade-token': apiKey
+    }
+
+    try {
+      intro('Deleting Environment...')
+      await EnvironmentController.deleteEnvironment(
+        { id: environmentId },
+        headers
+      )
+      outro(`Environment ${environmentId} has been deleted successfully.`)
+    } catch (error) {
+      Logger.info(error.message as string)
+    }
+  }
+}

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

@@ -0,0 +1,58 @@
+import { Logger } from '@/util/logger'
+import BaseCommand from '../base.command'
+import { spinner, intro, outro } from '@clack/prompts'
+import { EnvironmentController } from '@keyshade/api-client'
+import {
+  type CommandActionData,
+  type CommandArgument
+} from 'src/types/command/command.types'
+
+export class GetEnvironment extends BaseCommand {
+  getName(): string {
+    return 'get'
+  }
+
+  getDescription(): string {
+    return 'Get an environment'
+  }
+
+  getArguments(): CommandArgument[] {
+    return [
+      {
+        name: '<Environment ID>',
+        description: 'ID of the environment which you want to fetch.'
+      }
+    ]
+  }
+
+  async action({ args }: CommandActionData): Promise<void> {
+    const [environmentId] = args
+
+    if (!environmentId) {
+      Logger.error('Environment ID is required')
+      return
+    }
+
+    const apiKey = this.apiKey
+
+    const headers = {
+      'x-keyshade-token': apiKey
+    }
+
+    const spin = spinner()
+    try {
+      intro('Getting Environment...')
+      const environment = await EnvironmentController.getEnvironmentById(
+        { id: environmentId },
+        headers
+      )
+      spin.start(`Environment ${environmentId}:`)
+      spin.message(`- Name: ${environment.name}`)
+      spin.message(`- Description: ${environment.description}`)
+      outro('Successfully Fetched the Environment.')
+      spin.stop()
+    } catch (error) {
+      Logger.error(error.message as string)
+    }
+  }
+}

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

@@ -0,0 +1,65 @@
+import BaseCommand from '../base.command'
+import { EnvironmentController } from '@keyshade/api-client'
+import { intro, spinner, outro } from '@clack/prompts'
+import {
+  type CommandActionData,
+  type CommandArgument
+} from 'src/types/command/command.types'
+import { Logger } from '@/util/logger'
+
+export class ListEnvironment extends BaseCommand {
+  getName(): string {
+    return 'list'
+  }
+
+  getDescription(): string {
+    return 'List all environments under a project'
+  }
+
+  getArguments(): CommandArgument[] {
+    return [
+      {
+        name: '<Project ID>',
+        description: 'ID of the project whose environments you want.'
+      }
+    ]
+  }
+
+  async action({ args }: CommandActionData): Promise<void> {
+    const [projectId] = args
+
+    if (!projectId) {
+      Logger.error('Project ID is required')
+      return
+    }
+
+    const apiKey = this.apiKey
+
+    const headers = {
+      'x-keyshade-token': apiKey
+    }
+
+    if (!apiKey) {
+      Logger.error('Base URL and API Key must be set as environment variables')
+      return
+    }
+
+    intro(`Fetching environments for project ${projectId}...`)
+
+    try {
+      intro(`Getting all Environment for Project ${projectId}`)
+      const environments =
+        await EnvironmentController.getAllEnvironmentsOfProject(
+          { projectId },
+          headers
+        )
+      const spin = spinner()
+      spin.start(`Environments for project ${projectId}:`)
+      spin.message(JSON.stringify(environments))
+      outro('Fetched all Environments.')
+      spin.stop()
+    } catch (error) {
+      Logger.error(error.message as string)
+    }
+  }
+}