@salesforce/source-tracking/lib/shared/remote/expectedSourceMembers.js

API for tracking local and remote Salesforce metadata changes

"use strict";
/*
 * 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.
 */
Object.defineProperty(exports, "__esModule", { value: true });
exports.calculateExpectedSourceMembers = void 0;
const source_deploy_retrieve_1 = require("@salesforce/source-deploy-retrieve");
const metadataKeys_1 = require("../metadataKeys");
const typesToNoPollFor = [
    'CustomObject',
    'EmailFolder',
    'EmailTemplateFolder',
    'StandardValueSet',
    'Portal',
    'StandardValueSetTranslation',
    'SharingRules',
    'SharingCriteriaRule',
    'GlobalValueSetTranslation',
    'AssignmentRules',
    'InstalledPackage',
    'DataCategoryGroup',
    'ManagedContentType',
    'CustomObjectTranslation',
    'TopicsForObjects',
];
const typesNotToPollForIfNamespace = ['CustomLabels', 'CustomMetadata', 'DuplicateRule', 'WebLink'];
const isEncodedTypeWithPercentSign = (type, filePath) => ['Layout', 'Profile', 'HomePageComponent', 'HomePageLayout', 'MilestoneType'].includes(type) &&
    Boolean(filePath?.includes('%'));
// aura xml aren't tracked as SourceMembers
const isSpecialAuraXml = (filePath) => Boolean(filePath &&
    (filePath.endsWith('.cmp-meta.xml') ||
        filePath.endsWith('.tokens-meta.xml') ||
        filePath.endsWith('.evt-meta.xml') ||
        filePath.endsWith('.app-meta.xml') ||
        filePath.endsWith('.intf-meta.xml')));
// things that never have SourceMembers
const excludedKeys = [
    'AppMenu###Salesforce1',
    'Profile###Standard',
    'Profile###Guest License User',
    'CustomTab###standard-home',
    'Profile###Minimum Access - Salesforce',
    'Profile###Salesforce API Only System Integrations',
    'AssignmentRules###Case',
    'ListView###CollaborationGroup.All_ChatterGroups',
    'CustomTab###standard-mailapp',
    'ApexEmailNotifications###apexEmailNotifications',
];
const calculateExpectedSourceMembers = (expectedMembers) => {
    const outstandingSourceMembers = new Map();
    expectedMembers
        .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') &&
        !(fileResponse.type === 'NavigationMenu' && fileResponse.fullName.startsWith('SFDC_Default_Navigation_')) &&
        // 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
            .filter((key) => 
        // CustomObject could have been re-added by the key generator from one of its fields
        !key.startsWith('CustomObject###') && !excludedKeys.includes(key))
            .map((key) => outstandingSourceMembers.set(key, member));
    });
    return outstandingSourceMembers;
};
exports.calculateExpectedSourceMembers = calculateExpectedSourceMembers;
//# sourceMappingURL=expectedSourceMembers.js.map