Sh/parse cdata (#607)

* fix: allows deployment of metadata files with cdata

* chore: auto-update metadata coverage in METADATA_SUPPORT.md

* fix: exclude the registry completeness test from uts

Author: shetzel

.mocharc.json

@@ -1,5 +1,6 @@
 {
   "require": "ts-node/register,source-map-support/register",
+  "exclude": "test/registry/registryCompleteness.test.ts",
   "watch-extensions": "ts",
   "extensions": [".ts", ".js", ".json"],
   "watch-files": ["src", "test"],

METADATA_SUPPORT.md

@@ -4,7 +4,7 @@ This list compares metadata types found in Salesforce v54 with the [metadata reg
 
 This repository is used by both the Salesforce CLIs and Salesforce's VSCode Extensions.
 
-Currently, there are 442/465 supported metadata types.
+Currently, there are 456/492 supported metadata types.
 For status on any existing gaps, please search or file an issue in the [Salesforce CLI issues only repo](https://github.com/forcedotcom/cli/issues).
 To contribute a new metadata type, please see the [Contributing Metadata Types to the Registry](./contributing/metadata.md)
 
@@ -48,14 +48,15 @@ To contribute a new metadata type, please see the [Contributing Metadata Types t
 |AppointmentSchedulingPolicy|✅||
 |ApprovalProcess|✅||
 |ArchiveSettings|✅||
+|AssessmentQuestion|❌|Not supported, but support could be added|
+|AssessmentQuestionSet|❌|Not supported, but support could be added|
 |AssignmentRules|✅||
 |AssistantContextItem|✅||
 |AssistantDefinition|✅||
 |AssistantSkillQuickAction|✅||
 |AssistantSkillSobjectAction|✅||
 |AssistantVersion|✅||
 |AssociationEngineSettings|✅||
-|AttributeDefinition2|❌|Not supported, but support could be added|
 |Audience|✅||
 |AuraDefinitionBundle|✅||
 |AuthProvider|✅||
@@ -69,6 +70,7 @@ To contribute a new metadata type, please see the [Contributing Metadata Types t
 |BlockchainSettings|✅||
 |Bot|✅||
 |BotSettings|✅||
+|BotTemplate|❌|Not supported, but support could be added|
 |BotVersion|✅||
 |BranchManagementSettings|✅||
 |BrandingSet|✅||
@@ -81,6 +83,7 @@ To contribute a new metadata type, please see the [Contributing Metadata Types t
 |CallCenter|✅||
 |CallCenterRoutingMap|✅||
 |CallCoachingMediaProvider|⚠️|Supports deploy/retrieve but not source tracking|
+|CallCtrAgentFavTrfrDest|❌|Not supported, but support could be added|
 |CampaignInfluenceModel|✅||
 |CampaignSettings|✅||
 |CanvasMetadata|✅||
@@ -119,6 +122,7 @@ To contribute a new metadata type, please see the [Contributing Metadata Types t
 |CorsWhitelistOrigin|✅||
 |CspTrustedSite|✅||
 |CurrencySettings|✅||
+|CustomAddressFieldSettings|✅||
 |CustomApplication|✅||
 |CustomApplicationComponent|✅||
 |CustomFeedFilter|✅||
@@ -142,6 +146,7 @@ To contribute a new metadata type, please see the [Contributing Metadata Types t
 |DataConnectorIngestApi|✅||
 |DataConnectorS3|✅||
 |DataDotComSettings|✅||
+|DataImportManagementSettings|✅||
 |DataMapping|✅||
 |DataMappingFieldDefinition|✅||
 |DataMappingObjectDefinition|✅||
@@ -150,11 +155,16 @@ To contribute a new metadata type, please see the [Contributing Metadata Types t
 |DataSourceObject|✅||
 |DataSourceTenant|✅||
 |DataStreamDefinition|✅||
+|DecisionMatrixDefinition|✅||
+|DecisionMatrixDefinitionVersion|✅||
 |DecisionTable|✅||
 |DecisionTableDatasetLink|✅||
 |DelegateGroup|✅||
 |DeploymentSettings|✅||
 |DevHubSettings|✅||
+|DigitalExperience|undefined|undefined|
+|DigitalExperienceBundle|undefined|undefined|
+|DigitalExperienceBundleSetting|undefined|undefined|
 |DiscoveryAIModel|✅||
 |DiscoveryGoal|✅||
 |DiscoverySettings|✅||
@@ -200,10 +210,13 @@ To contribute a new metadata type, please see the [Contributing Metadata Types t
 |ExperienceBundleSettings|✅||
 |ExplainabilityActionDefinition|✅||
 |ExplainabilityActionVersion|✅||
+|ExpressionSetDefinition|✅||
+|ExpressionSetDefinitionVersion|✅||
 |ExternalAIModel|❌|Not supported, but support could be added|
 |ExternalCredential|❌|Not supported, but support could be added|
 |ExternalDataConnector|✅||
 |ExternalDataSource|✅||
+|ExternalDataSrcDescriptor|❌|Not supported, but support could be added|
 |ExternalServiceRegistration|✅||
 |ExternalServicesSettings|✅||
 |FeatureParameterBoolean|✅||
@@ -222,6 +235,9 @@ To contribute a new metadata type, please see the [Contributing Metadata Types t
 |FlowCategory|✅||
 |FlowDefinition|⚠️|Supports deploy/retrieve but not source tracking|
 |FlowSettings|✅||
+|FlowTest|✅||
+|ForecastingFilter|❌|Not supported, but support could be added|
+|ForecastingFilterCondition|❌|Not supported, but support could be added|
 |ForecastingObjectListSettings|✅||
 |ForecastingSettings|✅||
 |ForecastingSourceDefinition|✅||
@@ -241,19 +257,19 @@ To contribute a new metadata type, please see the [Contributing Metadata Types t
 |Icon|✅||
 |IdeasSettings|✅||
 |IdentityVerificationProcDef|❌|Not supported, but support could be added|
-|IdentityVerificationProcDtl|❌|Not supported, but support could be added|
-|IdentityVerificationProcFld|❌|Not supported, but support could be added|
 |IframeWhiteListUrlSettings|✅||
 |InboundCertificate|✅||
 |InboundNetworkConnection|✅||
 |IncidentMgmtSettings|✅||
 |Index|⚠️|Supports deploy/retrieve but not source tracking|
+|IndustriesAutomotiveSettings|✅||
 |IndustriesLoyaltySettings|✅||
 |IndustriesManufacturingSettings|✅||
 |IndustriesSettings|✅||
 |InstalledPackage|⚠️|Supports deploy/retrieve but not source tracking|
 |InterestTaggingSettings|✅||
 |InternalDataConnector|✅||
+|InvLatePymntRiskCalcSettings|✅||
 |InventorySettings|✅||
 |InvocableActionSettings|✅||
 |IoTSettings|✅||
@@ -286,10 +302,13 @@ To contribute a new metadata type, please see the [Contributing Metadata Types t
 |ManagedContentType|⚠️|Supports deploy/retrieve but not source tracking|
 |ManagedTopics|✅||
 |MapsAndLocationSettings|✅||
+|MarketSegmentDefinition|undefined|undefined|
 |MarketingAppExtActivity|❌|Not supported, but support could be added|
 |MarketingAppExtension|❌|Not supported, but support could be added|
 |MatchingRules|✅||
 |MediaAdSalesSettings|✅||
+|MeetingsSettings|✅||
+|MessagingChannel|undefined|undefined|
 |MfgProgramTemplate|❌|Not supported, but support could be added|
 |MilestoneType|✅||
 |MktCalcInsightObjectDef|✅||
@@ -340,6 +359,7 @@ To contribute a new metadata type, please see the [Contributing Metadata Types t
 |PathAssistant|✅||
 |PathAssistantSettings|✅||
 |PaymentGatewayProvider|✅||
+|PaymentsManagementEnabledSettings|✅||
 |PermissionSet|✅||
 |PermissionSetGroup|✅||
 |PermissionSetLicenseDefinition|✅||
@@ -376,7 +396,9 @@ To contribute a new metadata type, please see the [Contributing Metadata Types t
 |RecordPageSettings|✅||
 |RecordType|✅||
 |RedirectWhitelistUrl|✅||
+|RegisteredExternalService|❌|Not supported, but support could be added|
 |RelatedRecordAssocCriteria|❌|Not supported, but support could be added|
+|RelationshipGraphDefinition|❌|Not supported, but support could be added|
 |RemoteSiteSetting|✅||
 |Report|✅||
 |ReportFolder|✅||
@@ -387,6 +409,7 @@ To contribute a new metadata type, please see the [Contributing Metadata Types t
 |SalesAgreementSettings|✅||
 |SalesWorkQueueSettings|✅||
 |SamlSsoConfig|✅||
+|SchedulingObjective|undefined|undefined|
 |SchedulingRule|✅||
 |SchemaSettings|✅||
 |ScoreCategory|❌|Not supported, but support could be added|
@@ -419,6 +442,8 @@ To contribute a new metadata type, please see the [Contributing Metadata Types t
 |StandardValueSetTranslation|✅||
 |StaticResource|✅||
 |StnryAssetEnvSrcCnfg|✅||
+|StreamingAppDataConnector|❌|Not supported, but support could be added|
+|SubscriptionManagementSettings|✅||
 |SurveySettings|✅||
 |SvcCatalogCategory|✅||
 |SvcCatalogFulfillmentFlow|✅||
@@ -451,6 +476,8 @@ To contribute a new metadata type, please see the [Contributing Metadata Types t
 |VehicleAssetEmssnSrcCnfg|✅||
 |ViewDefinition|✅||
 |VirtualVisitConfig|❌|Not supported, but support could be added|
+|VoiceSettings|✅||
+|WarrantyLifecycleMgmtSettings|✅||
 |WaveApplication|✅||
 |WaveComponent|✅||
 |WaveDashboard|✅||
@@ -483,37 +510,6 @@ v55 introduces the following new types.  Here's their current level of support
 
 |Metadata Type|Support|Notes|
 |:---|:---|:---|
-|AssessmentQuestion|❌|Not supported, but support could be added|
-|AssessmentQuestionSet|❌|Not supported, but support could be added|
-|BotTemplate|❌|Not supported, but support could be added|
-|CallCtrAgentFavTrfrDest|❌|Not supported, but support could be added|
-|ConvReasonReportDefinition|❌|Not supported, but support could be added|
-|ConvReasonReportSegmentDef|❌|Not supported, but support could be added|
-|CustomAddressFieldSettings|✅||
-|DataImportManagementSettings|✅||
-|DecisionMatrixDefinition|✅||
-|DecisionMatrixDefinitionVersion|✅||
-|DigitalExperience|undefined|undefined|
-|DigitalExperienceBundle|undefined|undefined|
-|DigitalExperienceBundleSetting|undefined|undefined|
-|ExpressionSetDefinition|✅||
-|ExpressionSetDefinitionVersion|✅||
-|ExternalDataSrcDescriptor|❌|Not supported, but support could be added|
-|FlowTest|✅||
-|ForecastingFilter|❌|Not supported, but support could be added|
-|ForecastingFilterCondition|❌|Not supported, but support could be added|
-|IndustriesAutomotiveSettings|✅||
-|InvLatePymntRiskCalcSettings|✅||
-|MarketSegmentDefinition|undefined|undefined|
-|MeetingsSettings|✅||
-|MessagingChannel|undefined|undefined|
-|PaymentsManagementEnabledSettings|✅||
-|RegisteredExternalService|❌|Not supported, but support could be added|
-|SchedulingObjective|undefined|undefined|
-|StreamingAppDataConnector|❌|Not supported, but support could be added|
-|SubscriptionManagementSettings|✅||
-|VoiceSettings|✅||
-|WarrantyLifecycleMgmtSettings|✅||
 
 ## Additional Types
 

src/convert/streams.ts

@@ -282,7 +282,7 @@ export class JsToXml extends Readable {
   }
 
   public _read(): void {
-    const js2Xml = new j2xParser({ format: true, indentBy: '    ', ignoreAttributes: false });
+    const js2Xml = new j2xParser({ format: true, indentBy: '    ', ignoreAttributes: false, cdataTagName: '__cdata' });
     const xmlContent = XML_DECL.concat(js2Xml.parse(this.xmlObject));
     this.push(xmlContent);
     this.push(null);

src/resolve/sourceComponent.ts

@@ -221,6 +221,7 @@ export class SourceComponent implements MetadataComponent {
     const parsed = parse(contents.toString(), {
       ignoreAttributes: false,
       parseNodeValue: false,
+      cdataTagName: '__cdata',
     }) as T;
     const [firstElement] = Object.keys(parsed);
     if (firstElement === this.type.name) {

test/convert/streams.test.ts

@@ -516,6 +516,26 @@ describe('Streams', () => {
 
       expect(jsToXml.read().toString()).to.be.equal(expectedBody);
     });
+
+    it('should transform js object with cdata to xml string', () => {
+      const xmlObj = {
+        TestType: {
+          [XML_NS_KEY]: XML_NS_URL,
+          foo: 'bar',
+          value: { __cdata: '<p>Hello</p>' },
+        },
+      };
+      const jsToXml = new streams.JsToXml(xmlObj);
+      let expectedBody = XML_DECL;
+      expectedBody += `<TestType xmlns="${XML_NS_URL}">\n`;
+      expectedBody += '    <foo>bar</foo>\n';
+      expectedBody += '    <value>\n';
+      expectedBody += '<![CDATA[<p>Hello</p>]]>\n';
+      expectedBody += '    </value>\n';
+      expectedBody += '</TestType>\n';
+
+      expect(jsToXml.read().toString()).to.be.equal(expectedBody);
+    });
   });
 
   describe('stream2buffer', () => {

test/resolve/sourceComponent.test.ts

@@ -206,6 +206,22 @@ describe('SourceComponent', () => {
       expect(result).to.deep.equal(expected);
     });
 
+    it('should parse cdata node values', async () => {
+      const component = COMPONENT;
+      env
+        .stub(component.tree, 'readFile')
+        .resolves(Buffer.from('<MatchingContentFile><test><![CDATA[<p>Hello</p>]]></test></MatchingContentFile>'));
+
+      const result = await component.parseXml();
+      const expected = {
+        MatchingContentFile: {
+          test: { __cdata: '<p>Hello</p>' },
+        },
+      };
+
+      expect(result).to.deep.equal(expected);
+    });
+
     it('should parse attributes of nodes', async () => {
       const component = COMPONENT;
       env