fix: pr review

Author: ad-shreya

messages/commonErrors.md

@@ -45,3 +45,7 @@ Connection is required
 # error.query-string-required
 
 Query string is required and must be a non-empty string
+
+# error.DevopsCenterNotEnabled
+
+DevOps Center is not enabled in this org. Enable DevOps Center in Setup before using this command.

messages/devops.project.list.md

@@ -6,10 +6,6 @@ List all DevOps Center projects in a Salesforce org.
 
 This command queries the DevopsProject standard object and returns the project Id, Name, and Description for each project found.
 
-# flags.target-org.summary
-
-Username or alias of the DevOps Center org.
-
 # examples
 
 - List all DevOps Center projects in an org with alias "my-devops-org":

messages/devops.work-item.create.md

@@ -4,11 +4,7 @@ Create a new work item in a DevOps Center project.
 
 # description
 
-The command creates the work item using the Connect API. Requires a project ID and a subject for the new work item; run the `devops project list` command to get the IDs for all existing projects. 
-
-# flags.target-org.summary
-
-Username or alias of the DevOps Center org.
+The command creates the work item using the Connect API. Requires a project ID and a subject for the new work item; run the `devops project list` command to get the IDs for all existing projects.
 
 # flags.project-id.summary
 
@@ -20,11 +16,11 @@ Subject (title) of the new work item.
 
 # flags.description.summary
 
-Description of the new work item; if not specified, the description is blank. 
+Description of the new work item; if not specified, the description is blank.
 
 # examples
 
-- Create a work item for the project with the specified ID and give the work item the specified subject (title); use the DevOps Center org with alias "my-devops-org": 
+- Create a work item for the project with the specified ID and give the work item the specified subject (title); use the DevOps Center org with alias "my-devops-org":
 
       <%= config.bin %> <%= command.id %> --target-org my-devops-org --project-id 0Hn000000000001 --subject "Fix login bug"
 

messages/devops.work-item.list.md

@@ -4,11 +4,7 @@ List all work items for a DevOps Center project.
 
 # description
 
-Each work item displays the branch, environment, and repository details needed for checkout and promotion. Requires a project ID; run the `devops project list` command to get the IDs for all existing projects.  
-
-# flags.target-org.summary
-
-Username or alias of the DevOps Center org.
+Each work item displays the branch, environment, and repository details needed for checkout and promotion. Requires a project ID; run the `devops project list` command to get the IDs for all existing projects.
 
 # flags.project-id.summary
 

src/commands/devops/project/list.ts

@@ -7,10 +7,10 @@
 
 import { Messages, Org } from '@salesforce/core';
 import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
-import { ux } from '@oclif/core';
 
 Messages.importMessagesDirectory(__dirname);
 const messages = Messages.loadMessages('@salesforce/plugin-devops-center', 'devops.project.list');
+const commonErrorMessages = Messages.loadMessages('@salesforce/plugin-devops-center', 'commonErrors');
 
 export type DevopsProject = {
   Id: string;
@@ -28,17 +28,14 @@ export default class DevopsProjectList extends SfCommand<DevopsProjectListResult
   public static readonly examples = messages.getMessages('examples');
 
   public static readonly flags = {
-    'target-org': Flags.requiredOrg({
-      summary: messages.getMessage('flags.target-org.summary'),
-      char: 'o',
-      required: true,
-    }),
+    'target-org': Flags.requiredOrg(),
+    'api-version': Flags.orgApiVersion(),
   };
 
   public async run(): Promise<DevopsProjectListResult> {
     const { flags } = await this.parse(DevopsProjectList);
     const org: Org = flags['target-org'];
-    const connection = org.getConnection('65.0');
+    const connection = org.getConnection(flags['api-version']);
 
     let projects: DevopsProject[];
     try {
@@ -48,18 +45,16 @@ export default class DevopsProjectList extends SfCommand<DevopsProjectListResult
     } catch (error: unknown) {
       const errMsg = error instanceof Error ? error.message : String(error);
       if (errMsg.includes('sObject type') && errMsg.includes('is not supported')) {
-        this.error(
-          'DevOps Center is not enabled in this org. Enable DevOps Center in Setup before using this command.'
-        );
+        this.error(commonErrorMessages.getMessage('error.DevopsCenterNotEnabled'));
       }
       throw error;
     }
 
     if (projects.length === 0) {
       this.log('No DevOps Center projects found in this org.');
     } else {
-      ux.styledHeader('DevOps Center Projects');
-      ux.table(projects, {
+      this.styledHeader('DevOps Center Projects');
+      this.table(projects, {
         Id: { header: 'Id' },
         Name: { header: 'Name' },
         Description: { header: 'Description' },

src/commands/devops/work-item/create.ts

@@ -11,22 +11,21 @@ import { createWorkItem, CreateWorkItemResult } from '../../../utils/createWorkI
 
 Messages.importMessagesDirectory(__dirname);
 const messages = Messages.loadMessages('@salesforce/plugin-devops-center', 'devops.work-item.create');
+const commonErrorMessages = Messages.loadMessages('@salesforce/plugin-devops-center', 'commonErrors');
 
 export default class DevopsWorkItemCreate extends SfCommand<CreateWorkItemResult> {
   public static readonly summary = messages.getMessage('summary');
   public static readonly description = messages.getMessage('description');
   public static readonly examples = messages.getMessages('examples');
 
   public static readonly flags = {
-    'target-org': Flags.requiredOrg({
-      summary: messages.getMessage('flags.target-org.summary'),
-      char: 'o',
-      required: true,
-    }),
-    'project-id': Flags.string({
+    'target-org': Flags.requiredOrg(),
+    'api-version': Flags.orgApiVersion(),
+    'project-id': Flags.salesforceId({
       summary: messages.getMessage('flags.project-id.summary'),
       char: 'p',
       required: true,
+      startsWith: '1Qg',
     }),
     subject: Flags.string({
       summary: messages.getMessage('flags.subject.summary'),
@@ -42,7 +41,7 @@ export default class DevopsWorkItemCreate extends SfCommand<CreateWorkItemResult
   public async run(): Promise<CreateWorkItemResult> {
     const { flags } = await this.parse(DevopsWorkItemCreate);
     const org: Org = flags['target-org'];
-    const connection = org.getConnection('65.0');
+    const connection = org.getConnection(flags['api-version']);
 
     let result: CreateWorkItemResult;
     try {
@@ -55,9 +54,7 @@ export default class DevopsWorkItemCreate extends SfCommand<CreateWorkItemResult
     } catch (error: unknown) {
       const errMsg = error instanceof Error ? error.message : String(error);
       if (errMsg.includes('sObject type') && errMsg.includes('is not supported')) {
-        this.error(
-          'DevOps Center is not enabled in this org. Enable DevOps Center in Setup before using this command.'
-        );
+        this.error(commonErrorMessages.getMessage('error.DevopsCenterNotEnabled'));
       }
       throw error;
     }

src/commands/devops/work-item/list.ts

@@ -7,12 +7,12 @@
 
 import { Messages, Org } from '@salesforce/core';
 import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
-import { ux } from '@oclif/core';
 import { fetchWorkItems } from '../../../utils/workItems';
 import { WorkItem } from '../../../utils/types';
 
 Messages.importMessagesDirectory(__dirname);
 const messages = Messages.loadMessages('@salesforce/plugin-devops-center', 'devops.work-item.list');
+const commonErrorMessages = Messages.loadMessages('@salesforce/plugin-devops-center', 'commonErrors');
 
 export type DevopsWorkItemListResult = {
   workItems: WorkItem[];
@@ -24,33 +24,29 @@ export default class DevopsWorkItemList extends SfCommand<DevopsWorkItemListResu
   public static readonly examples = messages.getMessages('examples');
 
   public static readonly flags = {
-    'target-org': Flags.requiredOrg({
-      summary: messages.getMessage('flags.target-org.summary'),
-      char: 'o',
-      required: true,
-    }),
-    'project-id': Flags.string({
+    'target-org': Flags.requiredOrg(),
+    'api-version': Flags.orgApiVersion(),
+    'project-id': Flags.salesforceId({
       summary: messages.getMessage('flags.project-id.summary'),
       char: 'p',
       required: true,
+      startsWith: '1Qg',
     }),
   };
 
   public async run(): Promise<DevopsWorkItemListResult> {
     const { flags } = await this.parse(DevopsWorkItemList);
     const org: Org = flags['target-org'];
     const projectId: string = flags['project-id'];
-    const connection = org.getConnection('65.0');
+    const connection = org.getConnection(flags['api-version']);
 
     let workItems: WorkItem[];
     try {
       workItems = await fetchWorkItems(connection, projectId);
     } catch (error: unknown) {
       const errMsg = error instanceof Error ? error.message : String(error);
       if (errMsg.includes('sObject type') && errMsg.includes('is not supported')) {
-        this.error(
-          'DevOps Center is not enabled in this org. Enable DevOps Center in Setup before using this command.'
-        );
+        this.error(commonErrorMessages.getMessage('error.DevopsCenterNotEnabled'));
       }
       throw error;
     }
@@ -66,8 +62,8 @@ export default class DevopsWorkItemList extends SfCommand<DevopsWorkItemListResu
         'Target Branch': wi.TargetBranch ?? '',
       }));
 
-      ux.styledHeader('DevOps Center Work Items');
-      ux.table(tableData, {
+      this.styledHeader('DevOps Center Work Items');
+      this.table(tableData, {
         Name: { header: 'Name' },
         Subject: { header: 'Subject' },
         Status: { header: 'Status' },

src/utils/pipelineUtils.ts

@@ -6,22 +6,18 @@
  */
 
 import { Connection } from '@salesforce/core';
-import { PipelineStageRecord } from './types';
+import { DevopsProjectPipelineQueryRecord, PipelineStageRecord } from './types';
 
 export async function getPipelineIdForProject(connection: Connection, projectId: string): Promise<string | undefined> {
   const query = `SELECT DevopsPipelineId FROM DevopsProjectPipeline WHERE DevopsProjectId = '${projectId}' LIMIT 1`;
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  const result: any = await connection.query(query);
-  // eslint-disable-next-line @typescript-eslint/no-unsafe-return, @typescript-eslint/no-unsafe-member-access
-  return (result?.records ?? [])[0]?.DevopsPipelineId;
+  const result = await connection.query<DevopsProjectPipelineQueryRecord>(query);
+  return result.records[0]?.DevopsPipelineId;
 }
 
 export async function fetchPipelineStages(connection: Connection, pipelineId: string): Promise<PipelineStageRecord[]> {
   const stageQuery = `SELECT Id, Name, NextStageId, SourceCodeRepositoryBranch.Name FROM DevopsPipelineStage WHERE DevopsPipelineId = '${pipelineId}'`;
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  const stageResult: any = await connection.query(stageQuery);
-  // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-  return (stageResult?.records ?? []) as PipelineStageRecord[];
+  const stageResult = await connection.query<PipelineStageRecord>(stageQuery);
+  return stageResult.records ?? [];
 }
 
 export function computeFirstStageId(stages: PipelineStageRecord[]): string | undefined {

src/utils/types.ts

@@ -38,3 +38,32 @@ export type ProjectStagesContext = {
 };
 
 export type VcsType = 'GITHUB' | 'BITBUCKET';
+
+export type SourceCodeRepositoryQueryRecord = {
+  Name: string | null;
+  RepositoryOwner: string | null;
+  Provider: string | null;
+};
+
+export type SourceCodeRepositoryBranchQueryRecord = {
+  Name: string | null;
+  SourceCodeRepositoryId: string | null;
+  SourceCodeRepository: SourceCodeRepositoryQueryRecord | null;
+};
+
+export type WorkItemQueryRecord = {
+  Id: string;
+  Name: string;
+  Subject: string | null;
+  Description: string | null;
+  Status: string;
+  AssignedToId: string | null;
+  SourceCodeRepositoryBranchId: string | null;
+  SourceCodeRepositoryBranch: SourceCodeRepositoryBranchQueryRecord | null;
+  DevopsPipelineStageId: string | null;
+  DevopsProjectId: string;
+};
+
+export type DevopsProjectPipelineQueryRecord = {
+  DevopsPipelineId: string;
+};