feat: most of sourceStatus logic, code cleanup

Author: mshanemc

src/index.ts

@@ -7,4 +7,12 @@
 
 export * from './sourceTracking';
 export * from './compatibility';
-export { RemoteSyncInput } from './shared/types';
+export {
+  RemoteSyncInput,
+  ChangeOptionType,
+  ChangeOptions,
+  LocalUpdateOptions,
+  ChangeResult,
+  ConflictError,
+} from './shared/types';
+export { getKeyFromObject } from './shared/functions';

src/shared/functions.ts

@@ -0,0 +1,19 @@
+/*
+ * Copyright (c) 2020, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+import { RemoteChangeElement, ChangeResult } from './types';
+
+export const getMetadataKey = (metadataType: string, metadataName: string): string => {
+  return `${metadataType}__${metadataName}`;
+};
+
+export const getKeyFromObject = (element: RemoteChangeElement | ChangeResult): string => {
+  if (element.type && element.name) {
+    return getMetadataKey(element.type, element.name);
+  }
+  throw new Error(`unable to complete key from ${JSON.stringify(element)}`);
+};

src/shared/guards.ts

@@ -0,0 +1,15 @@
+/*
+ * Copyright (c) 2020, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import { SourceComponent } from '@salesforce/source-deploy-retrieve';
+
+export const stringGuard = (input: string | undefined): input is string => {
+  return typeof input === 'string';
+};
+
+export const sourceComponentGuard = (input: SourceComponent | undefined): input is SourceComponent => {
+  return input instanceof SourceComponent;
+};

src/shared/metadataKeys.ts

@@ -6,7 +6,7 @@
  */
 import * as path from 'path';
 import { RemoteSyncInput } from './types';
-import { getMetadataKey } from './remoteSourceTrackingService';
+import { getMetadataKey } from './functions';
 
 // LWC can have child folders (ex: dynamic templates like /templates/noDataIllustration.html
 const pathAfterFullName = (fileResponse: RemoteSyncInput): string =>

src/shared/remoteSourceTrackingService.ts

@@ -13,8 +13,9 @@ import { ConfigFile, Logger, Org, SfdxError, Messages, fs } from '@salesforce/co
 import { ComponentStatus } from '@salesforce/source-deploy-retrieve';
 import { Dictionary, Optional } from '@salesforce/ts-types';
 import { env, toNumber } from '@salesforce/kit';
-import { RemoteSyncInput } from '../shared/types';
+import { RemoteSyncInput, RemoteChangeElement } from '../shared/types';
 import { getMetadataKeyFromFileResponse } from './metadataKeys';
+import { getMetadataKey } from './functions';
 
 export type MemberRevision = {
   serverRevisionCounter: number;
@@ -30,13 +31,6 @@ export type SourceMember = {
   RevisionCounter: number;
 };
 
-export type RemoteChangeElement = {
-  name: string;
-  type: string;
-  deleted?: boolean;
-  modified?: boolean;
-};
-
 // represents the contents of the config file stored in 'maxRevision.json'
 interface Contents {
   serverMaxRevisionCounter: number;
@@ -52,10 +46,6 @@ export namespace RemoteSourceTrackingService {
   }
 }
 
-export const getMetadataKey = (metadataType: string, metadataName: string): string => {
-  return `${metadataType}__${metadataName}`;
-};
-
 /**
  * This service handles source tracking of metadata between a local project and an org.
  * Source tracking state is persisted to .sfdx/orgs/<orgId>/maxRevision.json.

src/shared/types.ts

@@ -5,6 +5,46 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { FileResponse } from '@salesforce/source-deploy-retrieve';
+import { FileResponse, SourceComponent } from '@salesforce/source-deploy-retrieve';
+import { getMetadataKey } from '../shared/functions';
+
+export interface ChangeOptions {
+  origin: 'local' | 'remote';
+  state: 'add' | 'delete' | 'modify' | 'nondelete';
+  format: 'ChangeResult' | 'SourceComponent' | 'string' | 'ChangeResultWithPaths';
+}
 
 export type RemoteSyncInput = Pick<FileResponse, 'fullName' | 'filePath' | 'type' | 'state'>;
+
+export type StatusOutputRow = Pick<FileResponse, 'fullName' | 'filePath' | 'type'> & {
+  conflict?: boolean;
+  ignored?: boolean;
+} & Pick<ChangeOptions, 'origin' | 'state'>;
+
+export interface LocalUpdateOptions {
+  files?: string[];
+  deletedFiles?: string[];
+}
+
+export type RemoteChangeElement = {
+  name: string;
+  type: string;
+  deleted?: boolean;
+  modified?: boolean;
+};
+
+/**
+ * Summary type that supports both local and remote change types
+ */
+export type ChangeResult = Partial<RemoteChangeElement> & {
+  origin: 'local' | 'remote';
+  filenames?: string[];
+};
+
+export interface ConflictError {
+  message: string;
+  name: 'conflict';
+  conflicts: ChangeResult[];
+}
+
+export type ChangeOptionType = ChangeResult | SourceComponent | string;