@salesforce/source-tracking 2.2.1 → 2.2.2

package/CHANGELOG.md

@@ -2,6 +2,26 @@
 
 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.
 
+### [2.2.2](https://github.com/forcedotcom/source-tracking/compare/v2.2.1...v2.2.2) (2022-08-10)
+
+### ⚠ BREAKING CHANGES
+
+- return componentSet and File Responses
+
+### Features
+
+- local CmpSet from changes tracks ignored files like normal CmpSet ([aaa707f](https://github.com/forcedotcom/source-tracking/commit/aaa707fb2e68f5b7199d79d8ea8213068bea09b1))
+- local componentSet can show ignored local files ([c230437](https://github.com/forcedotcom/source-tracking/commit/c23043726dcee304a3b550c0d463719e11f6d9ef))
+- overload to preserve backwards compatibility ([cfc53e3](https://github.com/forcedotcom/source-tracking/commit/cfc53e3ecf0b037cbe7c7ada2588c2e4ead2ab88))
+- return componentSet and File Responses ([b8dc01e](https://github.com/forcedotcom/source-tracking/commit/b8dc01eb0e01ed0aa010c554beae35fa0613d628))
+
+### Bug Fixes
+
+- bump eslint/jsdoc to get automerges flowing again ([afd85ff](https://github.com/forcedotcom/source-tracking/commit/afd85ff420877b7fb969085cf5f59d9c3f80555f))
+- ensure remote changes have a value for ignored (plugin expects it) ([bc1379f](https://github.com/forcedotcom/source-tracking/commit/bc1379f8f020fed5bfca721330f4404662d1b300))
+- force version change ([5483cd3](https://github.com/forcedotcom/source-tracking/commit/5483cd317614aea6aeb50c5544cede92fa9c2cb2))
+- remote changes display ignoredness ([d3533f9](https://github.com/forcedotcom/source-tracking/commit/d3533f9275d2a290b3c34019e204718e16ceaa75))
+
 ### [2.2.1](https://github.com/forcedotcom/source-tracking/compare/v2.2.0...v2.2.1) (2022-07-05)
 
 ### Bug Fixes

package/lib/shared/conflicts.js

@@ -31,8 +31,7 @@ const findConflictsInComponentSet = (cs, conflicts) => {
     conflicts
         .filter((cr) => cr.name && cr.type && cs.has({ fullName: cr.name, type: cr.type }))
         .forEach((cr) => {
-        var _a;
-        (_a = cr.filenames) === null || _a === void 0 ? void 0 : _a.forEach((f) => {
+        cr.filenames?.forEach((f) => {
             conflictMap.set(`${cr.name}#${cr.type}#${f}`, {
                 state: 'Conflict',
                 // the following 2 type assertions are valid because of previous filter statement
@@ -52,17 +51,15 @@ const getDedupedConflictsFromChanges = ({ localChanges = [], remoteChanges = [],
     const fileNameIndex = new Map();
     const metadataKeyIndex = new Map();
     remoteChanges.map((change) => {
-        var _a;
         if (change.name && change.type) {
             metadataKeyIndex.set((0, functions_1.getMetadataKey)(change.name, change.type), change);
         }
-        (_a = change.filenames) === null || _a === void 0 ? void 0 : _a.map((filename) => {
+        change.filenames?.map((filename) => {
             fileNameIndex.set(filename, change);
         });
     });
     const conflicts = new Set();
     (0, populateTypesAndNames_1.populateTypesAndNames)({ elements: localChanges, excludeUnresolvable: true, projectPath, forceIgnore }).map((change) => {
-        var _a;
         const metadataKey = (0, functions_1.getMetadataKey)(change.name, change.type);
         // option 1: name and type match
         if (metadataKeyIndex.has(metadataKey)) {
@@ -70,7 +67,7 @@ const getDedupedConflictsFromChanges = ({ localChanges = [], remoteChanges = [],
         }
         else {
             // option 2: some of the filenames match
-            (_a = change.filenames) === null || _a === void 0 ? void 0 : _a.map((filename) => {
+            change.filenames?.map((filename) => {
                 if (fileNameIndex.has(filename)) {
                     conflicts.add({ ...fileNameIndex.get(filename) });
                 }

package/lib/shared/expectedSourceMembers.js

@@ -24,7 +24,7 @@ const typesToNoPollFor = [
 ];
 const typesNotToPollForIfNamespace = ['CustomLabels', 'CustomMetadata', 'DuplicateRule', 'WebLink'];
 const isEncodedTypeWithPercentSign = (type, filePath) => ['Layout', 'Profile', 'HomePageComponent', 'HomePageLayout', 'MilestoneType'].includes(type) &&
-    Boolean(filePath === null || filePath === void 0 ? void 0 : filePath.includes('%'));
+    Boolean(filePath?.includes('%'));
 // aura xml aren't tracked as SourceMembers
 const isSpecialAuraXml = (filePath) => Boolean(filePath &&
     (filePath.endsWith('.cmp-meta.xml') ||
@@ -35,29 +35,27 @@ const isSpecialAuraXml = (filePath) => Boolean(filePath &&
 const calculateExpectedSourceMembers = (expectedMembers) => {
     const outstandingSourceMembers = new Map();
     expectedMembers
-        .filter((fileResponse) => {
-        var _a, _b, _c, _d;
-        // 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
-            // we don't know which email folder type might be there, so don't require either
-            // Portal doesn't support source tracking, according to the coverage report
-            !typesToNoPollFor.includes(fileResponse.type) &&
-            // don't wait for standard fields on standard objects
-            !(fileResponse.type === 'CustomField' && !((_a = fileResponse.filePath) === null || _a === void 0 ? void 0 : _a.includes('__c'))) &&
-            // deleted fields
-            !(fileResponse.type === 'CustomField' && ((_b = fileResponse.filePath) === null || _b === void 0 ? void 0 : _b.includes('_del__c'))) &&
-            // built-in report type ReportType__screen_flows_prebuilt_crt
-            !(fileResponse.type === 'ReportType' && ((_c = fileResponse.filePath) === null || _c === void 0 ? void 0 : _c.includes('screen_flows_prebuilt_crt'))) &&
-            // they're settings to mdapi, and FooSettings in sourceMembers
-            !fileResponse.type.includes('Settings') &&
-            // mdapi encodes these, sourceMembers don't have encoding
-            !isEncodedTypeWithPercentSign(fileResponse.type, fileResponse.filePath) &&
-            !(typesNotToPollForIfNamespace.includes(fileResponse.type) && ((_d = fileResponse.filePath) === null || _d === void 0 ? void 0 : _d.includes('__'))) &&
-            // don't wait on workflow children
-            !fileResponse.type.startsWith('Workflow') &&
-            !isSpecialAuraXml(fileResponse.filePath);
-    })
+        .filter((fileResponse) => 
+    // unchanged files will never be in the sourceMembers.  Not really sure why SDR returns them.
+    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
+        // we don't know which email folder type might be there, so don't require either
+        // Portal doesn't support source tracking, according to the coverage report
+        !typesToNoPollFor.includes(fileResponse.type) &&
+        // don't wait for standard fields on standard objects
+        !(fileResponse.type === 'CustomField' && !fileResponse.filePath?.includes('__c')) &&
+        // deleted fields
+        !(fileResponse.type === 'CustomField' && fileResponse.filePath?.includes('_del__c')) &&
+        // built-in report type ReportType__screen_flows_prebuilt_crt
+        !(fileResponse.type === 'ReportType' && fileResponse.filePath?.includes('screen_flows_prebuilt_crt')) &&
+        // they're settings to mdapi, and FooSettings in sourceMembers
+        !fileResponse.type.includes('Settings') &&
+        // mdapi encodes these, sourceMembers don't have encoding
+        !isEncodedTypeWithPercentSign(fileResponse.type, fileResponse.filePath) &&
+        !(typesNotToPollForIfNamespace.includes(fileResponse.type) && fileResponse.filePath?.includes('__')) &&
+        // don't wait on workflow children
+        !fileResponse.type.startsWith('Workflow') &&
+        !isSpecialAuraXml(fileResponse.filePath))
         .map((member) => {
         (0, metadataKeys_1.getMetadataKeyFromFileResponse)(member)
             // remove some individual members known to not work with tracking even when their type does

package/lib/shared/functions.js

@@ -20,7 +20,7 @@ const getKeyFromObject = (element) => {
     throw new Error(`unable to complete key from ${JSON.stringify(element)}`);
 };
 exports.getKeyFromObject = getKeyFromObject;
-const isBundle = (cmp) => { var _a; return ((_a = cmp.type.strategies) === null || _a === void 0 ? void 0 : _a.adapter) === 'bundle'; };
+const isBundle = (cmp) => cmp.type.strategies?.adapter === 'bundle';
 exports.isBundle = isBundle;
 const isLwcLocalOnlyTest = (filePath) => filePath.includes('__utam__') || filePath.includes('__tests__');
 exports.isLwcLocalOnlyTest = isLwcLocalOnlyTest;

package/lib/shared/localComponentSetArray.js

@@ -76,9 +76,12 @@ const getComponentSets = (groupings, sourceApiVersion) => {
         })
             .filter(guards_1.sourceComponentGuard)
             .map((component) => componentSet.add(component));
+        // there may have been ignored files, but componentSet.add doesn't automatically track them.
+        // We'll manually set the ignored paths from what the resolver has been tracking
+        componentSet.forceIgnoredPaths = new Set([...(componentSet.forceIgnoredPaths ?? [])].concat(Array.from(resolverForNonDeletes.forceIgnoredPaths)));
         return componentSet;
     })
-        .filter((componentSet) => componentSet.size > 0);
+        .filter((componentSet) => componentSet.size > 0 || componentSet.forceIgnoredPaths?.size);
 };
 exports.getComponentSets = getComponentSets;
 //# sourceMappingURL=localComponentSetArray.js.map

package/lib/shared/metadataKeys.js

@@ -13,7 +13,7 @@ const core_1 = require("@salesforce/core");
 const functions_1 = require("./functions");
 // See UT for examples of the complexity this must handle
 // keys always use forward slashes, even on Windows
-const pathAfterFullName = (fileResponse) => (fileResponse === null || fileResponse === void 0 ? void 0 : fileResponse.filePath)
+const pathAfterFullName = (fileResponse) => fileResponse?.filePath
     ? (0, path_1.join)((0, path_1.dirname)(fileResponse.filePath).substring((0, path_1.dirname)(fileResponse.filePath).lastIndexOf(fileResponse.fullName)), (0, path_1.basename)(fileResponse.filePath)).replace(/\\/gi, '/')
     : '';
 const registry = new source_deploy_retrieve_1.RegistryAccess();

package/lib/shared/populateFilePaths.js

@@ -43,7 +43,7 @@ const populateFilePaths = (elements, packageDirPaths) => {
         // there *could* be something missing
         // some types (ex: LWC) show up as multiple files in the remote changes, but only one in the component set
         // iterate the elements to see which ones didn't make it into the component set
-        const missingComponents = elements.filter((element) => !remoteChangesAsComponentSet.has({ type: element === null || element === void 0 ? void 0 : element.type, fullName: element === null || element === void 0 ? void 0 : element.name }));
+        const missingComponents = elements.filter((element) => !remoteChangesAsComponentSet.has({ type: element?.type, fullName: element?.name }));
         // Throw if anything was actually missing
         if (missingComponents.length > 0) {
             throw new Error(`unable to generate complete component set for ${elements

package/lib/shared/populateTypesAndNames.js

@@ -45,19 +45,18 @@ const populateTypesAndNames = ({ elements, projectPath, forceIgnore, excludeUnre
     // make it simpler to find things later
     const elementMap = new Map();
     elements.map((element) => {
-        var _a;
-        (_a = element.filenames) === null || _a === void 0 ? void 0 : _a.map((filename) => {
+        element.filenames?.map((filename) => {
             elementMap.set((0, functions_1.ensureRelative)(filename, projectPath), element);
         });
     });
     // iterates the local components and sets their filenames
     sourceComponents.map((matchingComponent) => {
-        if ((matchingComponent === null || matchingComponent === void 0 ? void 0 : matchingComponent.fullName) && (matchingComponent === null || matchingComponent === void 0 ? void 0 : matchingComponent.type.name)) {
+        if (matchingComponent?.fullName && matchingComponent?.type.name) {
             const filenamesFromMatchingComponent = [matchingComponent.xml, ...matchingComponent.walkContent()];
             const ignored = filenamesFromMatchingComponent
                 .filter(ts_types_1.isString)
                 .filter((f) => !(0, functions_1.isLwcLocalOnlyTest)(f))
-                .some((f) => forceIgnore === null || forceIgnore === void 0 ? void 0 : forceIgnore.denies(f));
+                .some((f) => forceIgnore?.denies(f));
             filenamesFromMatchingComponent.map((filename) => {
                 if (filename && elementMap.has(filename)) {
                     // add the type/name from the componentSet onto the element

package/lib/shared/remoteSourceTrackingService.js

@@ -7,7 +7,6 @@
  */
 /* eslint-disable no-underscore-dangle */
 /* eslint-disable @typescript-eslint/member-ordering */
-var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.remoteChangeElementToChangeResult = exports.RemoteSourceTrackingService = void 0;
 const path = require("path");
@@ -23,7 +22,7 @@ const expectedSourceMembers_1 = require("./expectedSourceMembers");
  * even when there is a longer timeout remaining (because the deployment is very large)
  */
 const POLLING_DELAY_MS = 1000;
-const CONSECUTIVE_EMPTY_POLLING_RESULT_LIMIT = ((_a = kit_1.env.getNumber('SFDX_SOURCE_MEMBER_POLLING_TIMEOUT')) !== null && _a !== void 0 ? _a : 120) / kit_1.Duration.milliseconds(POLLING_DELAY_MS).seconds;
+const CONSECUTIVE_EMPTY_POLLING_RESULT_LIMIT = (kit_1.env.getNumber('SFDX_SOURCE_MEMBER_POLLING_TIMEOUT') ?? 120) / kit_1.Duration.milliseconds(POLLING_DELAY_MS).seconds;
 /**
  * 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.
@@ -264,11 +263,10 @@ class RemoteSourceTrackingService extends core_1.ConfigFile {
         }
         let serverMaxRevisionCounter = this.getServerMaxRevision();
         sourceMembers.forEach((change) => {
-            var _a;
             // 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, functions_1.getMetadataKey)(change.MemberType, change.MemberName);
-            const sourceMember = (_a = this.getSourceMember(key)) !== null && _a !== void 0 ? _a : {
+            const sourceMember = this.getSourceMember(key) ?? {
                 serverRevisionCounter: change.RevisionCounter,
                 lastRetrievedFromServer: null,
                 memberType: change.MemberType,
@@ -432,8 +430,7 @@ class RemoteSourceTrackingService extends core_1.ConfigFile {
         }
     }
     calculateTimeout(memberCount) {
-        var _a;
-        const overriddenTimeout = (_a = kit_1.env.getNumber('SFDX_SOURCE_MEMBER_POLLING_TIMEOUT', 0)) !== null && _a !== void 0 ? _a : 0;
+        const overriddenTimeout = kit_1.env.getNumber('SFDX_SOURCE_MEMBER_POLLING_TIMEOUT', 0) ?? 0;
         if (overriddenTimeout > 0) {
             this.logger.debug(`Overriding SourceMember polling timeout to ${overriddenTimeout}`);
             return kit_1.Duration.seconds(overriddenTimeout);

package/lib/sourceTracking.d.ts

@@ -19,6 +19,10 @@ export interface SourceTrackingOptions {
      */
     ignoreLocalCache?: boolean;
 }
+declare type RemoteChangesResults = {
+    componentSetFromNonDeletes: ComponentSet;
+    fileResponsesFromDelete: FileResponse[];
+};
 /**
  * Manages source tracking files (remote and local)
  *
@@ -104,11 +108,12 @@ export declare class SourceTracking extends AsyncCreatable {
      *
      * Convenience method to reduce duplicated steps required to do a fka pull
      * It's full of side effects: retrieving remote deletes, deleting those files locall, and then updating tracking files
-     * Most bizarrely, it then returns a ComponentSet of the remote nonDeletes.
+     * Most bizarrely, it then returns a ComponentSet of the remote nonDeletes and the FileResponses from the delete
      *
-     * @returns the ComponentSet for what you would retrieve now that the deletes are done
+     * @returns the ComponentSet for what you would retrieve now that the deletes are done, and optionally, a FileResponses array for the deleted files
      */
-    maybeApplyRemoteDeletesToLocal(): Promise<ComponentSet>;
+    maybeApplyRemoteDeletesToLocal(returnDeleteFileResponses: true): Promise<RemoteChangesResults>;
+    maybeApplyRemoteDeletesToLocal(returnDeleteFileResponses?: false): Promise<ComponentSet>;
     /**
      *
      * returns immediately if there are no changesToDelete
@@ -186,3 +191,4 @@ export declare class SourceTracking extends AsyncCreatable {
     private localChangesToOutputRow;
     private remoteChangesToOutputRows;
 }
+export {};

package/lib/sourceTracking.js

@@ -13,6 +13,8 @@ const core_1 = require("@salesforce/core");
 const kit_1 = require("@salesforce/kit");
 const ts_types_1 = require("@salesforce/ts-types");
 const source_deploy_retrieve_1 = require("@salesforce/source-deploy-retrieve");
+// this is not exported by SDR (see the comments in SDR regarding its limitations)
+const filePathGenerator_1 = require("@salesforce/source-deploy-retrieve/lib/src/utils/filePathGenerator");
 const remoteSourceTrackingService_1 = require("./shared/remoteSourceTrackingService");
 const localShadowRepo_1 = require("./shared/localShadowRepo");
 const conflicts_1 = require("./shared/conflicts");
@@ -31,7 +33,6 @@ const localComponentSetArray_1 = require("./shared/localComponentSetArray");
  */
 class SourceTracking extends kit_1.AsyncCreatable {
     constructor(options) {
-        var _a, _b, _c;
         super(options);
         this.org = options.org;
         this.orgId = this.org.getOrgId();
@@ -39,9 +40,9 @@ class SourceTracking extends kit_1.AsyncCreatable {
         this.packagesDirs = options.project.getPackageDirectories();
         this.logger = core_1.Logger.childFromRoot('SourceTracking');
         this.project = options.project;
-        this.ignoreConflicts = (_a = options.ignoreConflicts) !== null && _a !== void 0 ? _a : false;
-        this.ignoreLocalCache = (_b = options.ignoreLocalCache) !== null && _b !== void 0 ? _b : false;
-        this.subscribeSDREvents = (_c = options.subscribeSDREvents) !== null && _c !== void 0 ? _c : false;
+        this.ignoreConflicts = options.ignoreConflicts ?? false;
+        this.ignoreLocalCache = options.ignoreLocalCache ?? false;
+        this.subscribeSDREvents = options.subscribeSDREvents ?? false;
         this.hasSfdxTrackingFiles = (0, compatibility_1.hasSfdxTrackingFiles)(this.orgId, this.projectPath);
     }
     // eslint-disable-next-line class-methods-use-this
@@ -70,7 +71,7 @@ class SourceTracking extends kit_1.AsyncCreatable {
             packageDirs: this.packagesDirs,
             nonDeletes,
             deletes,
-        }, byPackageDir !== null && byPackageDir !== void 0 ? byPackageDir : Boolean(projectConfig.pushPackageDirectoriesSequentially)); // if the users specified true or false for the param, that overrides the project config
+        }, byPackageDir ?? Boolean(projectConfig.pushPackageDirectoriesSequentially)); // if the users specified true or false for the param, that overrides the project config
         this.logger.debug(`will build array of ${groupings.length} componentSet(s)`);
         return (0, localComponentSetArray_1.getComponentSets)(groupings, sourceApiVersion);
     }
@@ -133,7 +134,7 @@ class SourceTracking extends kit_1.AsyncCreatable {
         return results;
     }
     async getChanges(options) {
-        if ((options === null || options === void 0 ? void 0 : options.origin) === 'local') {
+        if (options?.origin === 'local') {
             await this.ensureLocalTracking();
             const filenames = await this.getLocalChangesAsFilenames(options.state);
             if (options.format === 'string') {
@@ -162,7 +163,7 @@ class SourceTracking extends kit_1.AsyncCreatable {
                     .filter(guards_1.sourceComponentGuard);
             }
         }
-        if ((options === null || options === void 0 ? void 0 : options.origin) === 'remote') {
+        if (options?.origin === 'remote') {
             await this.ensureRemoteTracking();
             const remoteChanges = await this.remoteSourceTrackingService.retrieveUpdates();
             this.logger.debug('remoteChanges', remoteChanges);
@@ -178,8 +179,8 @@ class SourceTracking extends kit_1.AsyncCreatable {
             }
             // turn it into a componentSet to resolve filenames
             const remoteChangesAsComponentSet = new source_deploy_retrieve_1.ComponentSet(filteredChanges.map((element) => ({
-                type: element === null || element === void 0 ? void 0 : element.type,
-                fullName: element === null || element === void 0 ? void 0 : element.name,
+                type: element?.type,
+                fullName: element?.name,
             })));
             const matchingLocalSourceComponentsSet = source_deploy_retrieve_1.ComponentSet.fromSource({
                 fsPaths: this.packagesDirs.map((dir) => (0, path_1.resolve)(dir.fullPath)),
@@ -197,18 +198,12 @@ class SourceTracking extends kit_1.AsyncCreatable {
         }
         throw new Error(`unsupported options: ${JSON.stringify(options)}`);
     }
-    /**
-     *
-     * Convenience method to reduce duplicated steps required to do a fka pull
-     * It's full of side effects: retrieving remote deletes, deleting those files locall, and then updating tracking files
-     * Most bizarrely, it then returns a ComponentSet of the remote nonDeletes.
-     *
-     * @returns the ComponentSet for what you would retrieve now that the deletes are done
-     */
-    async maybeApplyRemoteDeletesToLocal() {
+    async maybeApplyRemoteDeletesToLocal(returnDeleteFileResponses) {
         const changesToDelete = await this.getChanges({ origin: 'remote', state: 'delete', format: 'SourceComponent' });
-        await this.deleteFilesAndUpdateTracking(changesToDelete);
-        return this.remoteNonDeletesAsComponentSet();
+        const fileResponsesFromDelete = await this.deleteFilesAndUpdateTracking(changesToDelete);
+        return returnDeleteFileResponses
+            ? { componentSetFromNonDeletes: await this.remoteNonDeletesAsComponentSet(), fileResponsesFromDelete }
+            : this.remoteNonDeletesAsComponentSet();
     }
     /**
      *
@@ -237,15 +232,12 @@ class SourceTracking extends kit_1.AsyncCreatable {
             })), true // skip polling because it's a pull
             ),
         ]);
-        return filenames.map((filename) => {
-            var _a, _b;
-            return ({
-                state: 'Deleted',
-                filename,
-                type: (_a = sourceComponentByFileName.get(filename)) === null || _a === void 0 ? void 0 : _a.type.name,
-                fullName: (_b = sourceComponentByFileName.get(filename)) === null || _b === void 0 ? void 0 : _b.fullName,
-            });
-        });
+        return filenames.map((filename) => ({
+            state: 'Deleted',
+            filename,
+            type: sourceComponentByFileName.get(filename)?.type.name,
+            fullName: sourceComponentByFileName.get(filename)?.fullName,
+        }));
     }
     /**
      * Update tracking for the options passed.
@@ -253,12 +245,11 @@ class SourceTracking extends kit_1.AsyncCreatable {
      * @param options the files to update
      */
     async updateLocalTracking(options) {
-        var _a, _b;
         await this.ensureLocalTracking();
         // relative paths make smaller trees AND isogit wants them relative
         const relativeOptions = {
-            files: ((_a = options.files) !== null && _a !== void 0 ? _a : []).map((file) => (0, functions_1.ensureRelative)(file, this.projectPath)),
-            deletedFiles: ((_b = options.deletedFiles) !== null && _b !== void 0 ? _b : []).map((file) => (0, functions_1.ensureRelative)(file, this.projectPath)),
+            files: (options.files ?? []).map((file) => (0, functions_1.ensureRelative)(file, this.projectPath)),
+            deletedFiles: (options.deletedFiles ?? []).map((file) => (0, functions_1.ensureRelative)(file, this.projectPath)),
         };
         // plot twist: if you delete a member of a bundle (ex: lwc/foo/foo.css) and push, it'll not be in the fileResponses (deployedFiles) or deletedFiles
         // what got deleted?  Any local changes NOT in the fileResponses but part of a successfully deployed bundle
@@ -378,7 +369,6 @@ class SourceTracking extends kit_1.AsyncCreatable {
      * Compares local and remote changes to detect conflicts
      */
     async getConflicts() {
-        var _a;
         // we're going to need have both initialized
         await Promise.all([this.ensureRemoteTracking(), this.ensureLocalTracking()]);
         // Strategy: check local changes first (since it'll be faster) to avoid callout
@@ -400,7 +390,7 @@ class SourceTracking extends kit_1.AsyncCreatable {
         if (remoteChanges.length === 0) {
             return [];
         }
-        (_a = this.forceIgnore) !== null && _a !== void 0 ? _a : (this.forceIgnore = source_deploy_retrieve_1.ForceIgnore.findAndCreate(this.project.getDefaultPackage().path));
+        this.forceIgnore ?? (this.forceIgnore = source_deploy_retrieve_1.ForceIgnore.findAndCreate(this.project.getDefaultPackage().path));
         return (0, conflicts_1.getDedupedConflictsFromChanges)({
             localChanges,
             remoteChanges,
@@ -538,38 +528,34 @@ class SourceTracking extends kit_1.AsyncCreatable {
         throw new Error(`unable to get local changes for state ${state}`);
     }
     localChangesToOutputRow(input, localType) {
-        var _a;
         this.logger.debug('converting ChangeResult to a row', input);
-        (_a = this.forceIgnore) !== null && _a !== void 0 ? _a : (this.forceIgnore = source_deploy_retrieve_1.ForceIgnore.findAndCreate(this.project.getDefaultPackage().path));
+        this.forceIgnore ?? (this.forceIgnore = source_deploy_retrieve_1.ForceIgnore.findAndCreate(this.project.getDefaultPackage().path));
         if (input.filenames) {
-            return input.filenames.map((filename) => {
-                var _a, _b;
-                return ({
-                    type: (_a = input.type) !== null && _a !== void 0 ? _a : '',
-                    state: localType,
-                    fullName: (_b = input.name) !== null && _b !== void 0 ? _b : '',
-                    filePath: filename,
-                    origin: 'local',
-                    ignored: this.forceIgnore.denies(filename),
-                });
-            });
+            return input.filenames.map((filename) => ({
+                type: input.type ?? '',
+                state: localType,
+                fullName: input.name ?? '',
+                filePath: filename,
+                origin: 'local',
+                ignored: this.forceIgnore.denies(filename),
+            }));
         }
         throw new Error('no filenames found for local ChangeResult');
     }
-    // this will eventually have async call to figure out the target file locations for remote changes
+    // reserve the right to do something more sophisticated in the future
+    // via async for figuring out hypothetical filenames (ex: getting default packageDir)
     // eslint-disable-next-line @typescript-eslint/require-await
     async remoteChangesToOutputRows(input) {
-        var _a, _b, _c, _d;
         this.logger.debug('converting ChangeResult to a row', input);
-        (_a = this.forceIgnore) !== null && _a !== void 0 ? _a : (this.forceIgnore = source_deploy_retrieve_1.ForceIgnore.findAndCreate(this.project.getDefaultPackage().path));
+        this.forceIgnore ?? (this.forceIgnore = source_deploy_retrieve_1.ForceIgnore.findAndCreate(this.project.getDefaultPackage().path));
         const baseObject = {
-            type: (_b = input.type) !== null && _b !== void 0 ? _b : '',
+            type: input.type ?? '',
             origin: input.origin,
             state: stateFromChangeResult(input),
-            fullName: (_c = input.name) !== null && _c !== void 0 ? _c : '',
+            fullName: input.name ?? '',
         };
         // it's easy to check ignores if the filePaths exist locally
-        if ((_d = input.filenames) === null || _d === void 0 ? void 0 : _d.length) {
+        if (input.filenames?.length) {
             return input.filenames.map((filename) => ({
                 ...baseObject,
                 filePath: filename,
@@ -577,7 +563,18 @@ class SourceTracking extends kit_1.AsyncCreatable {
             }));
         }
         // when the file doesn't exist locally, there are no filePaths
-        // So we can't say whether it's ignored or not
+        // SDR can generate the hypothetical place it *would* go and check that
+        if (input.name && input.type) {
+            return [
+                {
+                    ...baseObject,
+                    ignored: (0, filePathGenerator_1.filePathsFromMetadataComponent)({
+                        fullName: input.name,
+                        type: new source_deploy_retrieve_1.RegistryAccess().getTypeByName(input.type),
+                    }).some((hypotheticalFilePath) => this.forceIgnore.denies(hypotheticalFilePath)),
+                },
+            ];
+        }
         return [baseObject];
     }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@salesforce/source-tracking",
   "description": "API for tracking local and remote Salesforce metadata changes",
-  "version": "2.2.1",
+  "version": "2.2.2",
   "author": "Salesforce",
   "license": "BSD-3-Clause",
   "main": "lib/index.js",
@@ -43,17 +43,17 @@
     "/oclif.manifest.json"
   ],
   "dependencies": {
-    "@salesforce/core": "^3.23.1",
-    "@salesforce/kit": "^1.5.42",
-    "@salesforce/source-deploy-retrieve": "^6.1.0",
+    "@salesforce/core": "^3.26.1",
+    "@salesforce/kit": "^1.5.45",
+    "@salesforce/source-deploy-retrieve": "^6.2.7",
     "graceful-fs": "^4.2.9",
     "isomorphic-git": "1.17.0",
     "ts-retry-promise": "^0.6.0"
   },
   "devDependencies": {
-    "@salesforce/cli-plugins-testkit": "^2.3.0",
-    "@salesforce/dev-config": "^3.0.0",
-    "@salesforce/dev-scripts": "^2.0.0",
+    "@salesforce/cli-plugins-testkit": "^2.3.10",
+    "@salesforce/dev-config": "^3.1.0",
+    "@salesforce/dev-scripts": "^2.0.4",
     "@salesforce/prettier-config": "^0.0.2",
     "@salesforce/ts-sinon": "^1.3.21",
     "@types/shelljs": "^0.8.9",
@@ -68,7 +68,7 @@
     "eslint-config-salesforce-typescript": "^1.0.0",
     "eslint-plugin-header": "^3.1.1",
     "eslint-plugin-import": "2.25.4",
-    "eslint-plugin-jsdoc": "^37.0.1",
+    "eslint-plugin-jsdoc": "^39.3.6",
     "eslint-plugin-prettier": "^3.4.0",
     "husky": "^7.0.4",
     "mocha": "^9.1.3",
@@ -78,7 +78,7 @@
     "shelljs": "^0.8.4",
     "shx": "^0.3.3",
     "sinon": "^10.0.0",
-    "ts-node": "^10.1.0",
+    "ts-node": "^10.9.1",
     "ts-prune": "^0.10.0",
     "typescript": "^4.7.4"
   },