@salesforce/source-tracking 0.2.2 → 0.4.2

package/CHANGELOG.md

@@ -0,0 +1,78 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+### [0.4.2](https://github.com/forcedotcom/source-tracking/compare/v0.4.1...v0.4.2) (2021-10-28)
+
+### [0.4.1](https://github.com/forcedotcom/source-tracking/compare/v0.4.0...v0.4.1) (2021-10-28)
+
+
+### Bug Fixes
+
+* better conflict handling (can match filenames or type/name) ([4441a0a](https://github.com/forcedotcom/source-tracking/commit/4441a0abd70c7f8f315e1c638b4cef7fcf3e2e68))
+* gitignore stashing location ([5145545](https://github.com/forcedotcom/source-tracking/commit/5145545eeee6c800986014327479d20e943143e5))
+* polling exclusion logic for aura meta.xml was wrong ([2d40b2e](https://github.com/forcedotcom/source-tracking/commit/2d40b2ef65ef9a3145d0c75cd4943e4325d5745c))
+
+## 0.4.0 (2021-10-22)
+
+
+### ⚠ BREAKING CHANGES
+
+* remove retrieve simplifier
+
+### Features
+
+* add commitlint and sample circleci config ([43e7fa4](https://github.com/forcedotcom/source-tracking/commit/43e7fa4a44dbcb9da37d21618678687f4edda644))
+* add new tests and upadte readme ([6a7ad54](https://github.com/forcedotcom/source-tracking/commit/6a7ad542f42ce75275ebacc78d50ee4dc0ab6f32))
+* add option to get remoteChanges with filePaths, use for Conflicts ([350a0d6](https://github.com/forcedotcom/source-tracking/commit/350a0d60599cfce2c432c223f4523c25a4f53c81))
+* basic using isogit ([f39e6c5](https://github.com/forcedotcom/source-tracking/commit/f39e6c5e305fcb2fdb6a27b343d9dc20800202c9))
+* conflict detection ([3e22774](https://github.com/forcedotcom/source-tracking/commit/3e22774d8949a1aa4302e62d8580b69c4b35aab5))
+* consolidate conflict handling, return data in error ([45178c7](https://github.com/forcedotcom/source-tracking/commit/45178c7b13ed61e657f9a07ea5b40f49f73f651a))
+* delete handling public for pull ([eb87eb7](https://github.com/forcedotcom/source-tracking/commit/eb87eb7dfa81ba5256735af7f2b8bc29dfb1e16b))
+* finish status, add clear/reset ([c71e66f](https://github.com/forcedotcom/source-tracking/commit/c71e66f7f7a3dc20d2c965349b5e01e15edabf36))
+* handle status ignore marking from STL ([2ec6fad](https://github.com/forcedotcom/source-tracking/commit/2ec6fad4b4f4f2e124da7e4f53cf8e534354d342))
+* ignorewarnings flag for push ([b13fd05](https://github.com/forcedotcom/source-tracking/commit/b13fd0534930fb063075c39e6f75ea46ab9d3be8))
+* migrate messages/descriptions ([8fea6e5](https://github.com/forcedotcom/source-tracking/commit/8fea6e5242c50865dd635412d7592164ab57fec4))
+* most of sourceStatus logic, code cleanup ([f100cb8](https://github.com/forcedotcom/source-tracking/commit/f100cb83f220b3724284ae69301712a08b14376d))
+* non-delete push works ([487a20e](https://github.com/forcedotcom/source-tracking/commit/487a20e48c428a02ef315b58db24b714d2de0416))
+* push supporting bundle types ([639d459](https://github.com/forcedotcom/source-tracking/commit/639d459101cd4990fa217f657b99d64517611383))
+* remote and conflicts ([f98ecf1](https://github.com/forcedotcom/source-tracking/commit/f98ecf17fc6cbe386d8edae6994500388b7e0ed6))
+* remote tracknig with UT ([cb805e5](https://github.com/forcedotcom/source-tracking/commit/cb805e5745020be9a266a261f584979713e4b351))
+* source tracking from toolbelt ([6c2ebb4](https://github.com/forcedotcom/source-tracking/commit/6c2ebb444ce5518eaa81402b685fe00f1090e437))
+* sourcemember polling like toolbelt ([abdd7b3](https://github.com/forcedotcom/source-tracking/commit/abdd7b3ad275ea4739673a6e1b1a99853f1de2da))
+* spinners while waiting on pull ([dfe5aea](https://github.com/forcedotcom/source-tracking/commit/dfe5aeae0a5f9a30eddfe96852e0dab025972e1e))
+* status result sorting ([b7b109c](https://github.com/forcedotcom/source-tracking/commit/b7b109cf3e7bcad60507618099873c717ff31f61))
+* sync customObj when their fields sync ([3ded96d](https://github.com/forcedotcom/source-tracking/commit/3ded96dbd7a7ea45cb8f97719b98bae294905c05))
+* throws if "old" source files are present ([4b868d8](https://github.com/forcedotcom/source-tracking/commit/4b868d8232769eec5e227052bf823a35baedd288))
+* typed push ([6e76812](https://github.com/forcedotcom/source-tracking/commit/6e7681263b81d3b692d002a3ce5deb8ef00bbd13))
+* virtualTree for deletes ([b425d77](https://github.com/forcedotcom/source-tracking/commit/b425d77b4fca5c6fbab2faab7490e3516bf3f547))
+
+
+### Bug Fixes
+
+* again with the promises ([ad9dec5](https://github.com/forcedotcom/source-tracking/commit/ad9dec50336c61996456d48ee489426393c62329))
+* another attempt at node12 support ([c8736d0](https://github.com/forcedotcom/source-tracking/commit/c8736d0bbe53756d1b5572e00402e55af94003c1))
+* case of empty orgId dir ([1cb6333](https://github.com/forcedotcom/source-tracking/commit/1cb6333d14cfcee02b27711b6db273d5db31fc8e))
+* case on formatter filename ([02adf22](https://github.com/forcedotcom/source-tracking/commit/02adf22419d2bf81fb070d7d7d90f7d996bd1ada))
+* casing on imports ([d4425d9](https://github.com/forcedotcom/source-tracking/commit/d4425d9ee2ad77c4e28d32333025e59a3c7e3af9))
+* correct statusCommand description ([b834a2f](https://github.com/forcedotcom/source-tracking/commit/b834a2fa0213fbc72dbc6dc3a563cd92f413d222))
+* don't commit empty changelists ([67b9772](https://github.com/forcedotcom/source-tracking/commit/67b9772eccd6d2d4850322eb80f5a6113aac18e6))
+* export compatibility ([c6e5f7c](https://github.com/forcedotcom/source-tracking/commit/c6e5f7cba68ed6a7739b237adb027fda2442e8c4))
+* fix vscode image in readme ([441c15f](https://github.com/forcedotcom/source-tracking/commit/441c15f79dbaf4a97c84d9d6ddc923eae59bca34))
+* handle org:create's single tracking file ([008793d](https://github.com/forcedotcom/source-tracking/commit/008793d0fa15210ffb263cc5d179a0be8dcb05ff))
+* handle stash failures ([09dacc9](https://github.com/forcedotcom/source-tracking/commit/09dacc9484e48f3cba4813f3d733c66d2a30cd6b))
+* leif .yml merge [skip-validate-pr] ([ff10f84](https://github.com/forcedotcom/source-tracking/commit/ff10f84ec15757df55657ba73cc6976c5892595c))
+* local ST uses graceful via core2 ([3ba883f](https://github.com/forcedotcom/source-tracking/commit/3ba883ff2b02e27b0eb01a709f6c1e03ef91bb73))
+* match server subfiles with forward slash ([c2489a6](https://github.com/forcedotcom/source-tracking/commit/c2489a62c244a64fe0938e0eecdc087f4529b5ad))
+* normalize windows paths on commit, too ([4339e46](https://github.com/forcedotcom/source-tracking/commit/4339e46a1cb9cbeb4cc652572e340b60e3b5bc68))
+* one more fs/promises fixed for node12 ([71bafcf](https://github.com/forcedotcom/source-tracking/commit/71bafcf7738e60d8b86150199ef8d0687167a010))
+* path normalizing for metadata keys ([6190590](https://github.com/forcedotcom/source-tracking/commit/6190590df2c2e7cc9a25eab0fa8891e3b8df9057))
+* path normalizing from iso-git ([b8cddaf](https://github.com/forcedotcom/source-tracking/commit/b8cddaf40930bedd18f3edec578a030220454627))
+* status output on windows uses backslash ([78ac398](https://github.com/forcedotcom/source-tracking/commit/78ac3988d3d04e956f17f35c67de4d1144062fcb))
+* support windows path on commits with \\ ([5712af4](https://github.com/forcedotcom/source-tracking/commit/5712af4447ee03e30d7a5a769fc5ba58f6913552))
+* there could be nested LWC templates ([d833981](https://github.com/forcedotcom/source-tracking/commit/d8339810bf76c0ab75824faee7aef59ff9a2d89e))
+* turns bundle parts of SourceMembers into real MDtypes ([5646042](https://github.com/forcedotcom/source-tracking/commit/564604269be7d56499963699b51920b81227297f))
+* use correct var name ([0708312](https://github.com/forcedotcom/source-tracking/commit/0708312c5b4f11cb94539416d0a10b5432850310))
+
+
+* remove retrieve simplifier ([bd71eef](https://github.com/forcedotcom/source-tracking/commit/bd71eef784bc7c7efd1999ba11193e632aef3d47))

package/README.md

@@ -20,7 +20,7 @@ const tracking = await SourceTracking.create({
 
 Any calls to methods on your instance of `tracking` will check to make sure that the appropriate remote/local files are up to date and loaded.
 
-If you know you need to access remote or local, you can `ensure` them so that the FS and API operations don't happen multiple time (useful before calling operations in that run parallel)
+If you know you need to access remote or local, you can `ensure` them so that the FS and API operations don't happen multiple time (useful before calling operations that run in parallel)
 
 ```ts
 await tracking.ensureRemoteTracking(); // pass `true` if you know you need to force a re-query.
@@ -29,17 +29,17 @@ await tracking.ensureRemoteTracking(); // pass `true` if you know you need to fo
 await tracking.ensureLocalTracking();
 ```
 
-### Use cases:
+## Use cases
 
 1. push,pull,status: `getConflicts()`, `getChanges()`
 1. deploy/retrieve: `updateLocalTracking()`,`updateRemoteTracking`
 
-## Deploy:
+### Deploy
 
 1. Once your SDR-based deploy finishes, you need to update the client's tracking files for both local (because local files went to the server) AND remote (because your deployment will result in new SourceMembers that need to be synced to the client).
 
 ```ts
-// send it an two arrays of Files (nonDeletes and Deletes)
+// send in two arrays of Files (nonDeletes and Deletes)
 await tracking.updateLocalTracking({
   deployedFiles: ['force-app/main/default/classes/MyClass.cls', 'force-app/main/default/classes/MyClass.cls-meta.xml'],
   deletedFiles: [],
@@ -63,7 +63,7 @@ await tracking.updateRemoteTracking([
 ]);
 ```
 
-## Retrieve:
+### Retrieve
 
 Once your retrieve finishes, use the same updateLocalTracking as you did for deploy to commit the file changes to local and remote changes.
 
@@ -93,7 +93,7 @@ await tracking.updateRemoteTracking(
 NUT for tracking file compatibility check logic
 pollSourceMembers should better handle aggregated types. ex:
 
-```
+```txt
 DEBUG Could not find 2 SourceMembers (using ebikes): AuraDefinition__pageTemplate_2_7_3/pageTemplate_2_7_3.cmp-meta.xml,[object Object],CustomObject__Account,[object Object]
 ```
 

package/lib/compatibility.d.ts

@@ -3,11 +3,14 @@ declare type TrackingFileVersion = 'plugin-source' | 'toolbelt' | 'none';
 /**
  * A project can have "old" (toolbelt), "new" (plugin-source) or "none" tracking files
  *
+ * @deprecated use only during transition to new source-tracking commands
  */
 export declare const getTrackingFileVersion: (org: Org, projectPath: string) => TrackingFileVersion;
 /**
  * Convenient wrapper for throwing errors with helpful messages so commands don't have to
  *
+ * @deprecated use only during transition to new source-tracking commands
+ *
  * @param org: an Org, typically from a command's this.org
  * @param project: the project path, typically from this.project.
  * @param toValidate: whether your command lives in 'toolbelt' or 'plugin-source'
@@ -20,11 +23,10 @@ export declare const throwIfInvalid: ({ org, projectPath, toValidate, command, }
     command: string;
 }) => void;
 /**
- *
+ * @deprecated use only during transition to new source-tracking commands
  * @param input the string that might contain things that would be replaced
  * @param reverse use the mappings backward
  * @returns string
  */
 export declare const replaceRenamedCommands: (input: string, reverse?: boolean) => string;
-export declare const renames: Map<string, string>;
 export {};

package/lib/compatibility.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.renames = exports.replaceRenamedCommands = exports.throwIfInvalid = exports.getTrackingFileVersion = void 0;
+exports.replaceRenamedCommands = exports.throwIfInvalid = exports.getTrackingFileVersion = void 0;
 /*
  * Copyright (c) 2020, salesforce.com, inc.
  * All rights reserved.
@@ -15,6 +15,7 @@ const messages = core_1.Messages.loadMessages('@salesforce/source-tracking', 'co
 /**
  * A project can have "old" (toolbelt), "new" (plugin-source) or "none" tracking files
  *
+ * @deprecated use only during transition to new source-tracking commands
  */
 const getTrackingFileVersion = (org, projectPath) => {
     const orgsDir = path.join(projectPath, '.sfdx', 'orgs');
@@ -38,6 +39,8 @@ exports.getTrackingFileVersion = getTrackingFileVersion;
 /**
  * Convenient wrapper for throwing errors with helpful messages so commands don't have to
  *
+ * @deprecated use only during transition to new source-tracking commands
+ *
  * @param org: an Org, typically from a command's this.org
  * @param project: the project path, typically from this.project.
  * @param toValidate: whether your command lives in 'toolbelt' or 'plugin-source'
@@ -65,19 +68,19 @@ const throwIfInvalid = ({ org, projectPath, toValidate, command, }) => {
 };
 exports.throwIfInvalid = throwIfInvalid;
 /**
- *
+ * @deprecated use only during transition to new source-tracking commands
  * @param input the string that might contain things that would be replaced
  * @param reverse use the mappings backward
  * @returns string
  */
 const replaceRenamedCommands = (input, reverse = false) => {
-    exports.renames.forEach((value, key) => {
+    renames.forEach((value, key) => {
         input = reverse ? input.replace(value, key) : input.replace(key, value);
     });
     return input;
 };
 exports.replaceRenamedCommands = replaceRenamedCommands;
-exports.renames = new Map([
+const renames = new Map([
     ['force:source:status', 'force:source:beta:status'],
     ['force:source:push', 'force:source:beta:push'],
     ['force:source:pull', 'force:source:beta:pull'],

package/lib/index.d.ts

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

package/lib/index.js

@@ -16,6 +16,9 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getKeyFromObject = void 0;
 __exportStar(require("./sourceTracking"), exports);
 __exportStar(require("./compatibility"), exports);
+var functions_1 = require("./shared/functions");
+Object.defineProperty(exports, "getKeyFromObject", { enumerable: true, get: function () { return functions_1.getKeyFromObject; } });
 //# sourceMappingURL=index.js.map

package/lib/shared/filenamesToVirtualTree.d.ts

@@ -1,5 +1,6 @@
 import { VirtualTreeContainer } from '@salesforce/source-deploy-retrieve';
 /**
+ * @deprecated this is moving to SDR
  * Designed for recreating virtual files from deleted files where the only information we have is the file's former location
  * Any use of MetadataResolver was trying to access the non-existent files and throwing
  *

package/lib/shared/filenamesToVirtualTree.js

@@ -10,6 +10,7 @@ exports.filenamesToVirtualTree = void 0;
 const path = require("path");
 const source_deploy_retrieve_1 = require("@salesforce/source-deploy-retrieve");
 /**
+ * @deprecated this is moving to SDR
  * Designed for recreating virtual files from deleted files where the only information we have is the file's former location
  * Any use of MetadataResolver was trying to access the non-existent files and throwing
  *

package/lib/shared/functions.d.ts

@@ -0,0 +1,3 @@
+import { RemoteChangeElement, ChangeResult } from './types';
+export declare const getMetadataKey: (metadataType: string, metadataName: string) => string;
+export declare const getKeyFromObject: (element: RemoteChangeElement | ChangeResult) => string;

package/lib/shared/functions.js

@@ -0,0 +1,21 @@
+"use strict";
+/*
+ * 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getKeyFromObject = exports.getMetadataKey = void 0;
+const getMetadataKey = (metadataType, metadataName) => {
+    return `${metadataType}__${metadataName}`;
+};
+exports.getMetadataKey = getMetadataKey;
+const getKeyFromObject = (element) => {
+    if (element.type && element.name) {
+        return (0, exports.getMetadataKey)(element.type, element.name);
+    }
+    throw new Error(`unable to complete key from ${JSON.stringify(element)}`);
+};
+exports.getKeyFromObject = getKeyFromObject;
+//# sourceMappingURL=functions.js.map

package/lib/shared/guards.d.ts

@@ -0,0 +1,3 @@
+import { SourceComponent } from '@salesforce/source-deploy-retrieve';
+export declare const stringGuard: (input: string | undefined) => input is string;
+export declare const sourceComponentGuard: (input: SourceComponent | undefined) => input is SourceComponent;

package/lib/shared/guards.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sourceComponentGuard = exports.stringGuard = void 0;
+/*
+ * 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
+ */
+const source_deploy_retrieve_1 = require("@salesforce/source-deploy-retrieve");
+const stringGuard = (input) => {
+    return typeof input === 'string';
+};
+exports.stringGuard = stringGuard;
+const sourceComponentGuard = (input) => {
+    return input instanceof source_deploy_retrieve_1.SourceComponent;
+};
+exports.sourceComponentGuard = sourceComponentGuard;
+//# sourceMappingURL=guards.js.map

package/lib/shared/localShadowRepo.d.ts

@@ -1,4 +1,3 @@
-import { AsyncCreatable } from '@salesforce/kit';
 import { NamedPackageDir } from '@salesforce/core';
 interface ShadowRepoOptions {
     orgId: string;
@@ -11,14 +10,15 @@ interface CommitRequest {
     deletedFiles?: string[];
     message?: string;
 }
-export declare class ShadowRepo extends AsyncCreatable<ShadowRepoOptions> {
+export declare class ShadowRepo {
+    private static instance;
     gitDir: string;
     projectPath: string;
     private packageDirs;
     private status;
     private logger;
-    private options;
-    constructor(options: ShadowRepoOptions);
+    private constructor();
+    static getInstance(options: ShadowRepoOptions): Promise<ShadowRepo>;
     init(): Promise<void>;
     /**
      * Initialize a new source tracking shadow repo.  Think of git init

package/lib/shared/localShadowRepo.js

@@ -10,9 +10,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ShadowRepo = void 0;
 const path = require("path");
 const os = require("os");
-const kit_1 = require("@salesforce/kit");
 const core_1 = require("@salesforce/core");
 const git = require("isomorphic-git");
+const gitIgnoreFileName = '.gitignore';
+const stashedGitIgnoreFileName = '.BAK.gitignore';
 /**
  * returns the full path to where we store the shadow repo
  */
@@ -25,17 +26,21 @@ const toFilenames = (rows) => rows.map((row) => row[FILE]);
 const FILE = 0;
 const HEAD = 1;
 const WORKDIR = 2;
-class ShadowRepo extends kit_1.AsyncCreatable {
+class ShadowRepo {
     constructor(options) {
-        super(options);
-        this.options = options;
         this.gitDir = getGitDir(options.orgId, options.projectPath);
         this.projectPath = options.projectPath;
         this.packageDirs = options.packageDirs;
     }
+    static async getInstance(options) {
+        if (!ShadowRepo.instance) {
+            ShadowRepo.instance = new ShadowRepo(options);
+            await ShadowRepo.instance.init();
+        }
+        return ShadowRepo.instance;
+    }
     async init() {
         this.logger = await core_1.Logger.child('ShadowRepo');
-        this.logger.debug('options for constructor are', this.options);
         // initialize the shadow repo if it doesn't exist
         if (!core_1.fs.existsSync(this.gitDir)) {
             this.logger.debug('initializing git repo');
@@ -75,21 +80,25 @@ class ShadowRepo extends kit_1.AsyncCreatable {
      */
     async getStatus(noCache = false) {
         if (!this.status || noCache) {
-            await this.stashIgnoreFile();
-            // status hasn't been initalized yet
-            this.status = await git.statusMatrix({
-                fs: core_1.fs,
-                dir: this.projectPath,
-                gitdir: this.gitDir,
-                filepaths: this.packageDirs.map((dir) => dir.path),
-                // filter out hidden files and __tests__ patterns, regardless of gitignore
-                filter: (f) => !f.includes(`${path.sep}.`) && !f.includes('__tests__'),
-            });
-            // isomorphic-git stores things in unix-style tree.  Convert to windows-style if necessary
-            if (os.type() === 'Windows_NT') {
-                this.status = this.status.map((row) => [path.normalize(row[FILE]), row[HEAD], row[WORKDIR], row[3]]);
+            try {
+                await this.stashIgnoreFile();
+                // status hasn't been initalized yet
+                this.status = await git.statusMatrix({
+                    fs: core_1.fs,
+                    dir: this.projectPath,
+                    gitdir: this.gitDir,
+                    filepaths: this.packageDirs.map((dir) => dir.path),
+                    // filter out hidden files and __tests__ patterns, regardless of gitignore
+                    filter: (f) => !f.includes(`${path.sep}.`) && !f.includes('__tests__'),
+                });
+                // isomorphic-git stores things in unix-style tree.  Convert to windows-style if necessary
+                if (os.type() === 'Windows_NT') {
+                    this.status = this.status.map((row) => [path.normalize(row[FILE]), row[HEAD], row[WORKDIR], row[3]]);
+                }
+            }
+            finally {
+                await this.unStashIgnoreFile();
             }
-            await this.unStashIgnoreFile();
         }
         return this.status;
     }
@@ -149,8 +158,8 @@ class ShadowRepo extends kit_1.AsyncCreatable {
     async commitChanges({ deployedFiles = [], deletedFiles = [], message = 'sfdx source tracking', } = {}) {
         // if no files are specified, commit all changes
         if (deployedFiles.length === 0 && deletedFiles.length === 0) {
-            deployedFiles = await this.getNonDeleteFilenames();
-            deletedFiles = await this.getDeleteFilenames();
+            // this is valid, might not be an error
+            return 'no files to commit';
         }
         this.logger.debug('changes are', deployedFiles);
         this.logger.debug('deletes are', deletedFiles);
@@ -173,6 +182,8 @@ class ShadowRepo extends kit_1.AsyncCreatable {
                 message,
                 author: { name: 'sfdx source tracking' },
             });
+            // status changed as a result of the commit.  This prevents users from having to run getStatus(true) to avoid cache
+            await this.getStatus(true);
             return sha;
         }
         finally {
@@ -180,17 +191,17 @@ class ShadowRepo extends kit_1.AsyncCreatable {
         }
     }
     async stashIgnoreFile() {
-        const originalLocation = path.join(this.projectPath, '.gitignore');
+        const originalLocation = path.join(this.projectPath, gitIgnoreFileName);
         // another process may have already stashed the file
         if (core_1.fs.existsSync(originalLocation)) {
-            await core_1.fs.promises.rename(originalLocation, path.join(this.projectPath, '.BAK.gitignore'));
+            await core_1.fs.promises.rename(originalLocation, path.join(this.projectPath, stashedGitIgnoreFileName));
         }
     }
     async unStashIgnoreFile() {
-        const stashedLocation = path.join(this.projectPath, '.gitignore');
+        const stashedLocation = path.join(this.projectPath, stashedGitIgnoreFileName);
         // another process may have already un-stashed the file
         if (core_1.fs.existsSync(stashedLocation)) {
-            await core_1.fs.promises.rename(stashedLocation, path.join(this.projectPath, '.gitignore'));
+            await core_1.fs.promises.rename(stashedLocation, path.join(this.projectPath, gitIgnoreFileName));
         }
     }
 }

package/lib/shared/metadataKeys.js

@@ -8,7 +8,7 @@ exports.getMetadataKeyFromFileResponse = void 0;
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 const path = require("path");
-const remoteSourceTrackingService_1 = require("./remoteSourceTrackingService");
+const functions_1 = require("./functions");
 // LWC can have child folders (ex: dynamic templates like /templates/noDataIllustration.html
 const pathAfterFullName = (fileResponse) => fileResponse && fileResponse.filePath
     ? fileResponse.filePath.substr(fileResponse.filePath.indexOf(fileResponse.fullName)).replace(/\\/gi, '/')
@@ -21,25 +21,25 @@ const getMetadataKeyFromFileResponse = (fileResponse) => {
         const splits = path.normalize(fileResponse.filePath).split(path.sep);
         const objectFolderIndex = splits.indexOf('objects');
         return [
-            (0, remoteSourceTrackingService_1.getMetadataKey)('CustomObject', splits[objectFolderIndex + 1]),
-            (0, remoteSourceTrackingService_1.getMetadataKey)(fileResponse.type, fileResponse.fullName),
+            (0, functions_1.getMetadataKey)('CustomObject', splits[objectFolderIndex + 1]),
+            (0, functions_1.getMetadataKey)(fileResponse.type, fileResponse.fullName),
         ];
     }
     // Aura/LWC need to have both the bundle level and file level keys
     if (fileResponse.type === 'LightningComponentBundle' && fileResponse.filePath) {
         return [
             `LightningComponentResource__${pathAfterFullName(fileResponse)}`,
-            (0, remoteSourceTrackingService_1.getMetadataKey)(fileResponse.type, fileResponse.fullName),
+            (0, functions_1.getMetadataKey)(fileResponse.type, fileResponse.fullName),
         ];
     }
     if (fileResponse.type === 'AuraDefinitionBundle' && fileResponse.filePath) {
         return [
             `AuraDefinition__${pathAfterFullName(fileResponse)}`,
-            (0, remoteSourceTrackingService_1.getMetadataKey)(fileResponse.type, fileResponse.fullName),
+            (0, functions_1.getMetadataKey)(fileResponse.type, fileResponse.fullName),
         ];
     }
     // standard key
-    return [(0, remoteSourceTrackingService_1.getMetadataKey)(fileResponse.type, fileResponse.fullName)];
+    return [(0, functions_1.getMetadataKey)(fileResponse.type, fileResponse.fullName)];
 };
 exports.getMetadataKeyFromFileResponse = getMetadataKeyFromFileResponse;
 //# sourceMappingURL=metadataKeys.js.map

package/lib/shared/remoteSourceTrackingService.d.ts

@@ -1,23 +1,5 @@
 import { ConfigFile, Logger } from '@salesforce/core';
-import { RemoteSyncInput } from '../shared/types';
-export declare type MemberRevision = {
-    serverRevisionCounter: number;
-    lastRetrievedFromServer: number | null;
-    memberType: string;
-    isNameObsolete: boolean;
-};
-export declare type SourceMember = {
-    MemberType: string;
-    MemberName: string;
-    IsNameObsolete: boolean;
-    RevisionCounter: number;
-};
-export declare type RemoteChangeElement = {
-    name: string;
-    type: string;
-    deleted?: boolean;
-    modified?: boolean;
-};
+import { ChangeResult, RemoteChangeElement, SourceMember, RemoteSyncInput } from './types';
 export declare namespace RemoteSourceTrackingService {
     interface Options extends ConfigFile.Options {
         orgId: string;
@@ -25,7 +7,6 @@ export declare namespace RemoteSourceTrackingService {
         username: string;
     }
 }
-export declare const getMetadataKey: (metadataType: string, metadataName: string) => string;
 /**
  * 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.
@@ -143,3 +124,8 @@ export declare class RemoteSourceTrackingService extends ConfigFile<RemoteSource
     private querySourceMembersTo;
     private query;
 }
+/**
+ * pass in an RCE, and this will return a pullable ChangeResult.
+ * Useful for correcing bundle types where the files show change results with types but aren't resolvable
+ */
+export declare const remoteChangeElementToChangeResult: (rce: RemoteChangeElement) => ChangeResult;

package/lib/shared/remoteSourceTrackingService.js

@@ -8,18 +8,14 @@
 /* eslint-disable no-underscore-dangle */
 /* eslint-disable @typescript-eslint/member-ordering */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RemoteSourceTrackingService = exports.getMetadataKey = void 0;
+exports.remoteChangeElementToChangeResult = exports.RemoteSourceTrackingService = void 0;
 const path = require("path");
-const fs = require("fs");
 const ts_retry_promise_1 = require("ts-retry-promise");
 const core_1 = require("@salesforce/core");
 const source_deploy_retrieve_1 = require("@salesforce/source-deploy-retrieve");
 const kit_1 = require("@salesforce/kit");
 const metadataKeys_1 = require("./metadataKeys");
-const getMetadataKey = (metadataType, metadataName) => {
-    return `${metadataType}__${metadataName}`;
-};
-exports.getMetadataKey = getMetadataKey;
+const functions_1 = require("./functions");
 /**
  * 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.
@@ -89,8 +85,8 @@ class RemoteSourceTrackingService extends core_1.ConfigFile {
     static async delete(orgId) {
         const fileToDelete = RemoteSourceTrackingService.getFilePath(orgId);
         // the file might not exist, in which case we don't need to delete it
-        if (fs.existsSync(fileToDelete)) {
-            await fs.promises.unlink(fileToDelete);
+        if (core_1.fs.existsSync(fileToDelete)) {
+            await core_1.fs.promises.unlink(fileToDelete);
         }
         return path.isAbsolute(fileToDelete) ? fileToDelete : path.join(process.cwd(), fileToDelete);
     }
@@ -211,7 +207,7 @@ class RemoteSourceTrackingService extends core_1.ConfigFile {
             members = await this.querySourceMembersFrom({ fromRevision: 0 });
         }
         await this.trackSourceMembers(members, true);
-        return members.map((member) => (0, exports.getMetadataKey)(member.MemberType, member.MemberName));
+        return members.map((member) => (0, functions_1.getMetadataKey)(member.MemberType, member.MemberName));
     }
     //
     //  * * * * *  P R I V A T E    M E T H O D S  * * * * *
@@ -259,7 +255,7 @@ class RemoteSourceTrackingService extends core_1.ConfigFile {
         sourceMembers.forEach((change) => {
             // try accessing the sourceMembers object at the index of the change's name
             // if it exists, we'll update the fields - if it doesn't, we'll create and insert it
-            const key = (0, exports.getMetadataKey)(change.MemberType, change.MemberName);
+            const key = (0, functions_1.getMetadataKey)(change.MemberType, change.MemberName);
             let sourceMember = this.getSourceMember(key);
             if (sourceMember) {
                 // We are already tracking this element so we'll update it
@@ -360,13 +356,13 @@ class RemoteSourceTrackingService extends core_1.ConfigFile {
         // filter known Source tracking issues
         expectedMembers
             .filter((fileResponse) => {
-            var _a, _b;
+            var _a;
             // unchanged files will never be in the sourceMembers.  Not really sure why SDR returns them.
             return fileResponse.state !== source_deploy_retrieve_1.ComponentStatus.Unchanged &&
                 // if a listView is the only change inside an object, the object won't have a sourceMember change.  We won't wait for those to be found
                 fileResponse.type !== 'CustomObject' &&
                 // aura meta.xml aren't tracked as SourceMembers
-                !(((_a = fileResponse.filePath) === null || _a === void 0 ? void 0 : _a.includes('AuraDefinition')) && ((_b = fileResponse.filePath) === null || _b === void 0 ? void 0 : _b.endsWith('.cmp-meta.xml')));
+                !((_a = fileResponse.filePath) === null || _a === void 0 ? void 0 : _a.endsWith('.cmp-meta.xml'));
         })
             .map((member) => {
             (0, metadataKeys_1.getMetadataKeyFromFileResponse)(member).map((key) => outstandingSourceMembers.set(key, member));
@@ -386,7 +382,7 @@ class RemoteSourceTrackingService extends core_1.ConfigFile {
             });
             // remove anything returned from the query list
             queriedMembers.map((member) => {
-                outstandingSourceMembers.delete((0, exports.getMetadataKey)(member.MemberType, member.MemberName));
+                outstandingSourceMembers.delete((0, functions_1.getMetadataKey)(member.MemberType, member.MemberName));
             });
             this.logger.debug(`[${pollAttempts}] Found ${originalSize - outstandingSourceMembers.size} of ${originalSize} SourceMembers`);
             // update but don't sync
@@ -474,4 +470,25 @@ class RemoteSourceTrackingService extends core_1.ConfigFile {
 }
 exports.RemoteSourceTrackingService = RemoteSourceTrackingService;
 RemoteSourceTrackingService.remoteSourceTrackingServiceDictionary = {};
+/**
+ * pass in an RCE, and this will return a pullable ChangeResult.
+ * Useful for correcing bundle types where the files show change results with types but aren't resolvable
+ */
+const remoteChangeElementToChangeResult = (rce) => {
+    return {
+        ...rce,
+        ...(mappingsForSourceMemberTypesToMetadataType.has(rce.type)
+            ? {
+                name: rce.name.split('/')[0],
+                type: mappingsForSourceMemberTypesToMetadataType.get(rce.type),
+            }
+            : {}),
+        origin: 'remote', // we know they're remote
+    };
+};
+exports.remoteChangeElementToChangeResult = remoteChangeElementToChangeResult;
+const mappingsForSourceMemberTypesToMetadataType = new Map([
+    ['AuraDefinition', 'AuraDefinitionBundle'],
+    ['LightningComponentResource', 'LightningComponentBundle'],
+]);
 //# sourceMappingURL=remoteSourceTrackingService.js.map