types.ts

/*
 * Copyright 2025, Salesforce, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import {
  ComponentStatus,
  FileResponse,
  MetadataApiDeployStatus,
  MetadataApiRetrieveStatus,
  RequestStatus,
  SourceComponent,
  FileResponseFailure,
  FileResponseSuccess,
  ComponentLike,
} from '@salesforce/source-deploy-retrieve';
import { isObject } from '@salesforce/ts-types';
import { DefaultReportOptions } from '@salesforce/apex-node';

export const reportsFormatters = Object.keys(DefaultReportOptions);

export enum TestLevel {
  NoTestRun = 'NoTestRun',
  RunSpecifiedTests = 'RunSpecifiedTests',
  RunLocalTests = 'RunLocalTests',
  RunAllTestsInOrg = 'RunAllTestsInOrg',
  RunRelevantTests = 'RunRelevantTests',
}

export enum API {
  SOAP = 'SOAP',
  REST = 'REST',
}

export type PathInfo = {
  type: 'directory' | 'file';
  path: string;
};

export type Verbosity = 'verbose' | 'concise' | 'normal';

export type AsyncDeployResultJson = Omit<Partial<MetadataApiDeployStatus>, 'status'> & {
  status: RequestStatus | 'Queued' | 'Nothing to deploy';
  files: FileResponse[];
  zipSize?: number;
  zipFileCount?: number;
  deployUrl?: string;
};

type ConvertEntry = {
  fullName: string;
  type: string;
  filePath: string;
  state: 'Add';
};

export type ConvertMdapiJson = ConvertEntry[];

export type ConvertResultJson = {
  location: string;
};

export type DeleteSourceJson = {
  deletedSource?: FileResponse[];
  deployedSource: FileResponse[];
  outboundFiles: string[];
  deploys?: MetadataApiDeployStatus[];
  deletes?: MetadataApiDeployStatus[];
  replacements?: Record<string, string[]>;
  coverage?: CoverageResultsFileInfo;
  junit?: string;
} & MetadataApiDeployStatus;

export type CoverageResultsFileInfo = Record<keyof Partial<typeof DefaultReportOptions>, string>;

export type DeployResultJson =
  | (MetadataApiDeployStatus & {
      files: FileResponse[];
      replacements?: Record<string, string[]>;
      zipSize?: number;
      zipFileCount?: number;
      deployUrl?: string;
    })
  | AsyncDeployResultJson;

export type MetadataRetrieveResultJson = Omit<MetadataApiRetrieveStatus, 'zipFile'> & {
  zipFilePath: string;
  files: FileResponse[];
};

export type RetrieveResultJson =
  | (Omit<MetadataApiRetrieveStatus, 'zipFile'> & { files: FileResponse[] })
  | MetadataRetrieveResultJson;

export type Formatter<T> = {
  getJson: () => Promise<T>;
  display: () => void;
};

/** validates source component with fullname, type, and xml props */
export const isSourceComponent = (sc: ComponentLike): sc is SourceComponent =>
  isObject(sc) &&
  'type' in sc &&
  typeof sc.type === 'object' &&
  sc.type !== null &&
  'name' in sc.type &&
  typeof sc.type.name === 'string' &&
  'fullName' in sc &&
  'walkContent' in sc &&
  // (typeof sc.fullName === 'string' || typeof sc.fullName === 'function');
  typeof sc.fullName === 'string';

export const isSourceComponentWithXml = (sc: ComponentLike): sc is SourceComponent & { xml: string } =>
  isSourceComponent(sc) && 'xml' in sc && typeof sc.xml === 'string';

export const isSdrFailure = (fileResponse: FileResponse): fileResponse is FileResponseFailure =>
  fileResponse.state === ComponentStatus.Failed;

export const isSdrSuccess = (fileResponse: FileResponse): fileResponse is FileResponseSuccess =>
  fileResponse.state !== ComponentStatus.Failed;

export const isFileResponseDeleted = (fileResponse: FileResponseSuccess): boolean =>
  fileResponse.state === ComponentStatus.Deleted;

export const isDefined = <T>(value?: T): value is T => value !== undefined;

export function isTruthy(value: string | undefined): boolean {
  return value !== '0' && value !== 'false';
}