@salesforce/plugin-metadata-enrichment 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE.txt ADDED
@@ -0,0 +1,206 @@
1
+ Apache License Version 2.0
2
+
3
+ Copyright (c) 2026 Salesforce, Inc.
4
+ All rights reserved.
5
+
6
+ Apache License
7
+ Version 2.0, January 2004
8
+ http://www.apache.org/licenses/
9
+
10
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
11
+
12
+ 1. Definitions.
13
+
14
+ "License" shall mean the terms and conditions for use, reproduction,
15
+ and distribution as defined by Sections 1 through 9 of this document.
16
+
17
+ "Licensor" shall mean the copyright owner or entity authorized by
18
+ the copyright owner that is granting the License.
19
+
20
+ "Legal Entity" shall mean the union of the acting entity and all
21
+ other entities that control, are controlled by, or are under common
22
+ control with that entity. For the purposes of this definition,
23
+ "control" means (i) the power, direct or indirect, to cause the
24
+ direction or management of such entity, whether by contract or
25
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
26
+ outstanding shares, or (iii) beneficial ownership of such entity.
27
+
28
+ "You" (or "Your") shall mean an individual or Legal Entity
29
+ exercising permissions granted by this License.
30
+
31
+ "Source" form shall mean the preferred form for making modifications,
32
+ including but not limited to software source code, documentation
33
+ source, and configuration files.
34
+
35
+ "Object" form shall mean any form resulting from mechanical
36
+ transformation or translation of a Source form, including but
37
+ not limited to compiled object code, generated documentation,
38
+ and conversions to other media types.
39
+
40
+ "Work" shall mean the work of authorship, whether in Source or
41
+ Object form, made available under the License, as indicated by a
42
+ copyright notice that is included in or attached to the work
43
+ (an example is provided in the Appendix below).
44
+
45
+ "Derivative Works" shall mean any work, whether in Source or Object
46
+ form, that is based on (or derived from) the Work and for which the
47
+ editorial revisions, annotations, elaborations, or other modifications
48
+ represent, as a whole, an original work of authorship. For the purposes
49
+ of this License, Derivative Works shall not include works that remain
50
+ separable from, or merely link (or bind by name) to the interfaces of,
51
+ the Work and Derivative Works thereof.
52
+
53
+ "Contribution" shall mean any work of authorship, including
54
+ the original version of the Work and any modifications or additions
55
+ to that Work or Derivative Works thereof, that is intentionally
56
+ submitted to Licensor for inclusion in the Work by the copyright owner
57
+ or by an individual or Legal Entity authorized to submit on behalf of
58
+ the copyright owner. For the purposes of this definition, "submitted"
59
+ means any form of electronic, verbal, or written communication sent
60
+ to the Licensor or its representatives, including but not limited to
61
+ communication on electronic mailing lists, source code control systems,
62
+ and issue tracking systems that are managed by, or on behalf of, the
63
+ Licensor for the purpose of discussing and improving the Work, but
64
+ excluding communication that is conspicuously marked or otherwise
65
+ designated in writing by the copyright owner as "Not a Contribution."
66
+
67
+ "Contributor" shall mean Licensor and any individual or Legal Entity
68
+ on behalf of whom a Contribution has been received by Licensor and
69
+ subsequently incorporated within the Work.
70
+
71
+ 2. Grant of Copyright License. Subject to the terms and conditions of
72
+ this License, each Contributor hereby grants to You a perpetual,
73
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
74
+ copyright license to reproduce, prepare Derivative Works of,
75
+ publicly display, publicly perform, sublicense, and distribute the
76
+ Work and such Derivative Works in Source or Object form.
77
+
78
+ 3. Grant of Patent License. Subject to the terms and conditions of
79
+ this License, each Contributor hereby grants to You a perpetual,
80
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
81
+ (except as stated in this section) patent license to make, have made,
82
+ use, offer to sell, sell, import, and otherwise transfer the Work,
83
+ where such license applies only to those patent claims licensable
84
+ by such Contributor that are necessarily infringed by their
85
+ Contribution(s) alone or by combination of their Contribution(s)
86
+ with the Work to which such Contribution(s) was submitted. If You
87
+ institute patent litigation against any entity (including a
88
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
89
+ or a Contribution incorporated within the Work constitutes direct
90
+ or contributory patent infringement, then any patent licenses
91
+ granted to You under this License for that Work shall terminate
92
+ as of the date such litigation is filed.
93
+
94
+ 4. Redistribution. You may reproduce and distribute copies of the
95
+ Work or Derivative Works thereof in any medium, with or without
96
+ modifications, and in Source or Object form, provided that You
97
+ meet the following conditions:
98
+
99
+ (a) You must give any other recipients of the Work or
100
+ Derivative Works a copy of this License; and
101
+
102
+ (b) You must cause any modified files to carry prominent notices
103
+ stating that You changed the files; and
104
+
105
+ (c) You must retain, in the Source form of any Derivative Works
106
+ that You distribute, all copyright, patent, trademark, and
107
+ attribution notices from the Source form of the Work,
108
+ excluding those notices that do not pertain to any part of
109
+ the Derivative Works; and
110
+
111
+ (d) If the Work includes a "NOTICE" text file as part of its
112
+ distribution, then any Derivative Works that You distribute must
113
+ include a readable copy of the attribution notices contained
114
+ within such NOTICE file, excluding those notices that do not
115
+ pertain to any part of the Derivative Works, in at least one
116
+ of the following places: within a NOTICE text file distributed
117
+ as part of the Derivative Works; within the Source form or
118
+ documentation, if provided along with the Derivative Works; or,
119
+ within a display generated by the Derivative Works, if and
120
+ wherever such third-party notices normally appear. The contents
121
+ of the NOTICE file are for informational purposes only and
122
+ do not modify the License. You may add Your own attribution
123
+ notices within Derivative Works that You distribute, alongside
124
+ or as an addendum to the NOTICE text from the Work, provided
125
+ that such additional attribution notices cannot be construed
126
+ as modifying the License.
127
+
128
+ You may add Your own copyright statement to Your modifications and
129
+ may provide additional or different license terms and conditions
130
+ for use, reproduction, or distribution of Your modifications, or
131
+ for any such Derivative Works as a whole, provided Your use,
132
+ reproduction, and distribution of the Work otherwise complies with
133
+ the conditions stated in this License.
134
+
135
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
136
+ any Contribution intentionally submitted for inclusion in the Work
137
+ by You to the Licensor shall be under the terms and conditions of
138
+ this License, without any additional terms or conditions.
139
+ Notwithstanding the above, nothing herein shall supersede or modify
140
+ the terms of any separate license agreement you may have executed
141
+ with Licensor regarding such Contributions.
142
+
143
+ 6. Trademarks. This License does not grant permission to use the trade
144
+ names, trademarks, service marks, or product names of the Licensor,
145
+ except as required for reasonable and customary use in describing the
146
+ origin of the Work and reproducing the content of the NOTICE file.
147
+
148
+ 7. Disclaimer of Warranty. Unless required by applicable law or
149
+ agreed to in writing, Licensor provides the Work (and each
150
+ Contributor provides its Contributions) on an "AS IS" BASIS,
151
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
152
+ implied, including, without limitation, any warranties or conditions
153
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
154
+ PARTICULAR PURPOSE. You are solely responsible for determining the
155
+ appropriateness of using or redistributing the Work and assume any
156
+ risks associated with Your exercise of permissions under this License.
157
+
158
+ 8. Limitation of Liability. In no event and under no legal theory,
159
+ whether in tort (including negligence), contract, or otherwise,
160
+ unless required by applicable law (such as deliberate and grossly
161
+ negligent acts) or agreed to in writing, shall any Contributor be
162
+ liable to You for damages, including any direct, indirect, special,
163
+ incidental, or consequential damages of any character arising as a
164
+ result of this License or out of the use or inability to use the
165
+ Work (including but not limited to damages for loss of goodwill,
166
+ work stoppage, computer failure or malfunction, or any and all
167
+ other commercial damages or losses), even if such Contributor
168
+ has been advised of the possibility of such damages.
169
+
170
+ 9. Accepting Warranty or Additional Liability. While redistributing
171
+ the Work or Derivative Works thereof, You may choose to offer,
172
+ and charge a fee for, acceptance of support, warranty, indemnity,
173
+ or other liability obligations and/or rights consistent with this
174
+ License. However, in accepting such obligations, You may act only
175
+ on Your own behalf and on Your sole responsibility, not on behalf
176
+ of any other Contributor, and only if You agree to indemnify,
177
+ defend, and hold each Contributor harmless for any liability
178
+ incurred by, or claims asserted against, such Contributor by reason
179
+ of your accepting any such warranty or additional liability.
180
+
181
+ END OF TERMS AND CONDITIONS
182
+
183
+ APPENDIX: How to apply the Apache License to your work.
184
+
185
+ To apply the Apache License to your work, attach the following
186
+ boilerplate notice, with the fields enclosed by brackets "{}"
187
+ replaced with your own identifying information. (Don't include
188
+ the brackets!) The text should be enclosed in the appropriate
189
+ comment syntax for the file format. We also recommend that a
190
+ file or class name and description of purpose be included on the
191
+ same "printed page" as the copyright notice for easier
192
+ identification within third-party archives.
193
+
194
+ Copyright {yyyy} {name of copyright owner}
195
+
196
+ Licensed under the Apache License, Version 2.0 (the "License");
197
+ you may not use this file except in compliance with the License.
198
+ You may obtain a copy of the License at
199
+
200
+ http://www.apache.org/licenses/LICENSE-2.0
201
+
202
+ Unless required by applicable law or agreed to in writing, software
203
+ distributed under the License is distributed on an "AS IS" BASIS,
204
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
205
+ See the License for the specific language governing permissions and
206
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,122 @@
1
+ # plugin-metadata-enrichment
2
+
3
+ [![NPM](https://img.shields.io/npm/v/@salesforce/plugin-metadata-enrichment.svg?label=@salesforce/plugin-metadata-enrichment)](https://www.npmjs.com/package/@salesforce/plugin-metadata-enrichment) [![Downloads/week](https://img.shields.io/npm/dw/@salesforce/plugin-metadata-enrichment.svg)](https://npmjs.org/package/@salesforce/plugin-metadata-enrichment) [![License](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](https://opensource.org/license/apache-2-0)
4
+
5
+ ## Install
6
+
7
+ ```bash
8
+ sf plugins install @salesforce/plugin-metadata-enrichment@x.y.z
9
+ ```
10
+
11
+ ## Issues
12
+
13
+ Please report any issues at https://github.com/forcedotcom/cli/issues
14
+
15
+ ## Contributing
16
+
17
+ 1. Please read our [Code of Conduct](CODE_OF_CONDUCT.md)
18
+ 2. Create a new issue before starting your project so that we can keep track of
19
+ what you are trying to add/fix. That way, we can also offer suggestions or
20
+ let you know if there is already an effort in progress.
21
+ 3. Fork this repository.
22
+ 4. [Build the plugin locally](#build)
23
+ 5. Create a _topic_ branch in your fork. Note, this step is recommended but technically not required if contributing using a fork.
24
+ 6. Edit the code in your fork.
25
+ 7. Write appropriate tests for your changes. Try to achieve at least 95% code coverage on any new code. No pull request will be accepted without unit tests.
26
+ 8. Sign CLA (see [CLA](#cla) below).
27
+ 9. Send us a pull request when you are done. We'll review your code, suggest any needed changes, and merge it in.
28
+
29
+ ### CLA
30
+
31
+ External contributors will be required to sign a Contributor's License
32
+ Agreement. You can do so by going to https://cla.salesforce.com/sign-cla.
33
+
34
+ ### Build
35
+
36
+ To build the plugin locally, make sure to have yarn installed and run the following commands:
37
+
38
+ ```bash
39
+ # Clone the repository
40
+ git clone git@github.com:salesforcecli/plugin-metadata-enrichment
41
+
42
+ # Install the dependencies and compile
43
+ yarn && yarn build
44
+ ```
45
+
46
+ To use your plugin, run using the local `./bin/dev` or `./bin/dev.cmd` file.
47
+
48
+ ```bash
49
+ # Run using local run file.
50
+ ./bin/dev metadata enrich
51
+ ```
52
+
53
+ There should be no differences when running via the Salesforce CLI or using the local run file. However, it can be useful to link the plugin to do some additional testing or run your commands from anywhere on your machine.
54
+
55
+ ```bash
56
+ # Link your plugin to the sf cli
57
+ sf plugins link .
58
+ # To verify
59
+ sf plugins
60
+ ```
61
+
62
+ ## Commands
63
+
64
+ <!-- commands -->
65
+
66
+ - [`sf metadata enrich`](#sf-metadata-enrich)
67
+
68
+ ## `sf metadata enrich`
69
+
70
+ Enrich metadata
71
+
72
+ ```
73
+ USAGE
74
+ $ sf metadata enrich -o <value> -m <value>... [--json] [--flags-dir <value>]
75
+
76
+ FLAGS
77
+ -m, --metadata=<value>... (required) (required) Metadata type and optional component name to enrich.
78
+ -o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
79
+ configuration variable is already set.
80
+
81
+ GLOBAL FLAGS
82
+ --flags-dir=<value> Import flag values from a directory.
83
+ --json Format output as json.
84
+
85
+ DESCRIPTION
86
+ Enrich metadata for a Salesforce component.
87
+
88
+ You must run this command from within a project.
89
+
90
+ Generate and store descriptions in metadata that provide additional context to the component’s functionality and
91
+ purpose.
92
+
93
+ To deploy multiple metadata components, either set multiple --metadata flags or a single --metadata flag with multiple
94
+ names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to
95
+ --source-dir.
96
+
97
+ This is not saved in the org until you deploy the project.
98
+
99
+ This plugin only supports enrichment for LightningComponentBundle metadata at the moment.
100
+
101
+ EXAMPLES
102
+ Enrich metadata for a select LightningComponentBundle in the project
103
+ $ sf metadata enrich --metadata LightningComponentBundle:ComponentName
104
+
105
+ Enrich metadata for a select LightningComponentBundle in the project for a specified target org
106
+ $ sf metadata enrich --metadata LightningComponentBundle:ComponentName --target-org OrgAlias
107
+
108
+ Enrich metadata for multiple LightningComponentBundle in the project
109
+ $ sf metadata enrich --metadata LightningComponentBundle:Component1 --metadata LightningComponentBundle:Component2
110
+
111
+ Enrich metadata for multiple LightningComponentBundle in the project matching wildcard
112
+ $ sf metadata enrich --metadata LightningComponentBundle:Component*
113
+
114
+ FLAG DESCRIPTIONS
115
+ -m, --metadata=<value>... (required) Metadata type and optional component name to enrich.
116
+
117
+ Wildcards (* ) supported as long as you use quotes, such as "LightningComponentBundle:MyClass*"
118
+ ```
119
+
120
+ _See code: [src/commands/metadata/enrich.ts](https://github.com/salesforcecli/plugin-metadata-enrichment/blob/1.1.76/src/commands/metadata/enrich.ts)_
121
+
122
+ <!-- commandsstop -->
@@ -0,0 +1,12 @@
1
+ import { SfCommand } from '@salesforce/sf-plugins-core';
2
+ import { EnrichmentMetrics } from '@salesforce/metadata-enrichment';
3
+ export default class MetadataEnrich extends SfCommand<EnrichmentMetrics> {
4
+ static readonly summary: string;
5
+ static readonly description: string;
6
+ static readonly examples: string[];
7
+ static readonly flags: {
8
+ 'target-org': import("@oclif/core/interfaces").OptionFlag<import("@salesforce/core").Org, import("@oclif/core/interfaces").CustomOptions>;
9
+ metadata: import("@oclif/core/interfaces").OptionFlag<string[], import("@oclif/core/interfaces").CustomOptions>;
10
+ };
11
+ run(): Promise<EnrichmentMetrics>;
12
+ }
@@ -0,0 +1,83 @@
1
+ /*
2
+ * Copyright 2026, Salesforce, Inc.
3
+ *
4
+ * Licensed under the Apache License, Version 2.0 (the "License");
5
+ * you may not use this file except in compliance with the License.
6
+ * You may obtain a copy of the License at
7
+ *
8
+ * http://www.apache.org/licenses/LICENSE-2.0
9
+ *
10
+ * Unless required by applicable law or agreed to in writing, software
11
+ * distributed under the License is distributed on an "AS IS" BASIS,
12
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ * See the License for the specific language governing permissions and
14
+ * limitations under the License.
15
+ */
16
+ import { Messages, SfProject } from '@salesforce/core';
17
+ import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
18
+ import { ComponentSetBuilder } from '@salesforce/source-deploy-retrieve';
19
+ import { EnrichmentHandler, EnrichmentMetrics, EnrichmentStatus, FileProcessor } from '@salesforce/metadata-enrichment';
20
+ import { ComponentProcessor } from '../../component/index.js';
21
+ import { MetricsFormatter, EnrichmentRecords } from '../../utils/index.js';
22
+ Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
23
+ const commandMessages = Messages.loadMessages('@salesforce/plugin-metadata-enrichment', 'metadata.enrich');
24
+ const errorsMessages = Messages.loadMessages('@salesforce/plugin-metadata-enrichment', 'errors');
25
+ const metricsMessages = Messages.loadMessages('@salesforce/plugin-metadata-enrichment', 'metrics');
26
+ export default class MetadataEnrich extends SfCommand {
27
+ static summary = commandMessages.getMessage('summary');
28
+ static description = commandMessages.getMessage('description');
29
+ static examples = commandMessages.getMessages('examples');
30
+ static flags = {
31
+ 'target-org': Flags.requiredOrg(),
32
+ metadata: Flags.string({
33
+ multiple: true,
34
+ char: 'm',
35
+ summary: commandMessages.getMessage('flags.metadata.summary'),
36
+ description: commandMessages.getMessage('flags.metadata.description'),
37
+ required: true,
38
+ }),
39
+ };
40
+ async run() {
41
+ const project = await SfProject.resolve();
42
+ const { flags } = await this.parse(MetadataEnrich);
43
+ const org = flags['target-org'];
44
+ const metadataEntries = flags['metadata'];
45
+ this.spinner.start(commandMessages.getMessage('spinner.setup'));
46
+ const projectComponentSet = await ComponentSetBuilder.build({
47
+ metadata: {
48
+ metadataEntries,
49
+ directoryPaths: [project.getPath()],
50
+ },
51
+ });
52
+ const projectSourceComponents = projectComponentSet.getSourceComponents().toArray();
53
+ const enrichmentRecords = new EnrichmentRecords(projectSourceComponents, errorsMessages);
54
+ const componentsToSkip = ComponentProcessor.getComponentsToSkip(projectSourceComponents, metadataEntries, project.getPath());
55
+ enrichmentRecords.addSkippedComponents(componentsToSkip);
56
+ enrichmentRecords.updateWithStatus(componentsToSkip, EnrichmentStatus.SKIPPED);
57
+ enrichmentRecords.generateSkipReasons(componentsToSkip, projectSourceComponents);
58
+ const componentsEligibleToProcess = projectSourceComponents.filter((component) => {
59
+ const componentName = component.fullName ?? component.name;
60
+ if (!componentName)
61
+ return false;
62
+ for (const skip of componentsToSkip) {
63
+ if (skip.componentName === componentName)
64
+ return false;
65
+ }
66
+ return true;
67
+ });
68
+ this.spinner.stop();
69
+ this.spinner.start(commandMessages.getMessage('spinner.executing', [componentsEligibleToProcess.length]));
70
+ const connection = org.getConnection();
71
+ const enrichmentResults = await EnrichmentHandler.enrich(connection, componentsEligibleToProcess);
72
+ enrichmentRecords.updateWithResults(enrichmentResults);
73
+ this.spinner.stop();
74
+ this.spinner.start(commandMessages.getMessage('spinner.updating.files'));
75
+ const fileUpdatedRecords = await FileProcessor.updateMetadataFiles(componentsEligibleToProcess, enrichmentRecords.recordSet);
76
+ enrichmentRecords.updateWithResults(Array.from(fileUpdatedRecords));
77
+ this.spinner.stop();
78
+ const metrics = EnrichmentMetrics.createEnrichmentMetrics(Array.from(enrichmentRecords.recordSet));
79
+ MetricsFormatter.logMetrics(this.log.bind(this), metrics, metricsMessages);
80
+ return metrics;
81
+ }
82
+ }
83
+ //# sourceMappingURL=enrich.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"enrich.js","sourceRoot":"","sources":["../../../src/commands/metadata/enrich.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AACxH,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAE3E,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,eAAe,GAAG,QAAQ,CAAC,YAAY,CAAC,wCAAwC,EAAE,iBAAiB,CAAC,CAAC;AAC3G,MAAM,cAAc,GAAG,QAAQ,CAAC,YAAY,CAAC,wCAAwC,EAAE,QAAQ,CAAC,CAAC;AACjG,MAAM,eAAe,GAAG,QAAQ,CAAC,YAAY,CAAC,wCAAwC,EAAE,SAAS,CAAC,CAAC;AAEnG,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,SAA4B;IAC/D,MAAM,CAAU,OAAO,GAAG,eAAe,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IAChE,MAAM,CAAU,WAAW,GAAG,eAAe,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACxE,MAAM,CAAU,QAAQ,GAAG,eAAe,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAEnE,MAAM,CAAU,KAAK,GAAG;QAC7B,YAAY,EAAE,KAAK,CAAC,WAAW,EAAE;QACjC,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC;YACrB,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,GAAG;YACT,OAAO,EAAE,eAAe,CAAC,UAAU,CAAC,wBAAwB,CAAC;YAC7D,WAAW,EAAE,eAAe,CAAC,UAAU,CAAC,4BAA4B,CAAC;YACrE,QAAQ,EAAE,IAAI;SACf,CAAC;KACH,CAAC;IAEK,KAAK,CAAC,GAAG;QACd,MAAM,OAAO,GAAG,MAAM,SAAS,CAAC,OAAO,EAAE,CAAC;QAC1C,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QACnD,MAAM,GAAG,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC;QAChC,MAAM,eAAe,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;QAE1C,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC;QAChE,MAAM,mBAAmB,GAAG,MAAM,mBAAmB,CAAC,KAAK,CAAC;YAC1D,QAAQ,EAAE;gBACR,eAAe;gBACf,cAAc,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;aACpC;SACF,CAAC,CAAC;QACH,MAAM,uBAAuB,GAAG,mBAAmB,CAAC,mBAAmB,EAAE,CAAC,OAAO,EAAE,CAAC;QACpF,MAAM,iBAAiB,GAAG,IAAI,iBAAiB,CAAC,uBAAuB,EAAE,cAAc,CAAC,CAAC;QAEzF,MAAM,gBAAgB,GAAG,kBAAkB,CAAC,mBAAmB,CAC7D,uBAAuB,EACvB,eAAe,EACf,OAAO,CAAC,OAAO,EAAE,CAClB,CAAC;QACF,iBAAiB,CAAC,oBAAoB,CAAC,gBAAgB,CAAC,CAAC;QACzD,iBAAiB,CAAC,gBAAgB,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAC/E,iBAAiB,CAAC,mBAAmB,CAAC,gBAAgB,EAAE,uBAAuB,CAAC,CAAC;QAEjF,MAAM,2BAA2B,GAAG,uBAAuB,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE;YAC/E,MAAM,aAAa,GAAG,SAAS,CAAC,QAAQ,IAAI,SAAS,CAAC,IAAI,CAAC;YAC3D,IAAI,CAAC,aAAa;gBAAE,OAAO,KAAK,CAAC;YACjC,KAAK,MAAM,IAAI,IAAI,gBAAgB,EAAE,CAAC;gBACpC,IAAI,IAAI,CAAC,aAAa,KAAK,aAAa;oBAAE,OAAO,KAAK,CAAC;YACzD,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QAEpB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAC,2BAA2B,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAC1G,MAAM,UAAU,GAAG,GAAG,CAAC,aAAa,EAAE,CAAC;QACvC,MAAM,iBAAiB,GAAG,MAAM,iBAAiB,CAAC,MAAM,CAAC,UAAU,EAAE,2BAA2B,CAAC,CAAC;QAClG,iBAAiB,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,CAAC;QACvD,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QAEpB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC,UAAU,CAAC,wBAAwB,CAAC,CAAC,CAAC;QACzE,MAAM,kBAAkB,GAAG,MAAM,aAAa,CAAC,mBAAmB,CAChE,2BAA2B,EAC3B,iBAAiB,CAAC,SAAS,CAC5B,CAAC;QACF,iBAAiB,CAAC,iBAAiB,CAAC,KAAK,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC;QACpE,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QAEpB,MAAM,OAAO,GAAG,iBAAiB,CAAC,uBAAuB,CAAC,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAC;QACnG,gBAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,eAAe,CAAC,CAAC;QAE3E,OAAO,OAAO,CAAC;IACjB,CAAC"}
@@ -0,0 +1,24 @@
1
+ import { type SourceComponent } from '@salesforce/source-deploy-retrieve';
2
+ import type { MetadataTypeAndName } from '@salesforce/metadata-enrichment';
3
+ export declare class ComponentProcessor {
4
+ /**
5
+ *
6
+ * Determine the components to SKIP based on the source components and the metadata entries.
7
+ * This includes:
8
+ * - Input components that do not exist in the source project
9
+ * - Non-LWC components
10
+ * - LWC components that are missing their metadata configuration file
11
+ *
12
+ * @param sourceComponents
13
+ * @param metadataEntries
14
+ * @param projectDir
15
+ * @returns
16
+ */
17
+ static getComponentsToSkip(sourceComponents: SourceComponent[], metadataEntries: string[], projectDir?: string): Set<MetadataTypeAndName>;
18
+ private static filterComponents;
19
+ private static diffRequestedComponents;
20
+ private static parseRequestedComponents;
21
+ private static getExistingSourceComponentNames;
22
+ private static createSourceComponentMap;
23
+ private static parseMetadataEntry;
24
+ }
@@ -0,0 +1,132 @@
1
+ /*
2
+ * Copyright 2026, Salesforce, Inc.
3
+ *
4
+ * Licensed under the Apache License, Version 2.0 (the "License");
5
+ * you may not use this file except in compliance with the License.
6
+ * You may obtain a copy of the License at
7
+ *
8
+ * http://www.apache.org/licenses/LICENSE-2.0
9
+ *
10
+ * Unless required by applicable law or agreed to in writing, software
11
+ * distributed under the License is distributed on an "AS IS" BASIS,
12
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ * See the License for the specific language governing permissions and
14
+ * limitations under the License.
15
+ */
16
+ import { RegistryAccess } from '@salesforce/source-deploy-retrieve';
17
+ export class ComponentProcessor {
18
+ /**
19
+ *
20
+ * Determine the components to SKIP based on the source components and the metadata entries.
21
+ * This includes:
22
+ * - Input components that do not exist in the source project
23
+ * - Non-LWC components
24
+ * - LWC components that are missing their metadata configuration file
25
+ *
26
+ * @param sourceComponents
27
+ * @param metadataEntries
28
+ * @param projectDir
29
+ * @returns
30
+ */
31
+ static getComponentsToSkip(sourceComponents, metadataEntries, projectDir) {
32
+ const requestedComponents = ComponentProcessor.parseRequestedComponents(metadataEntries, projectDir);
33
+ const missingComponents = ComponentProcessor.diffRequestedComponents(sourceComponents, requestedComponents);
34
+ const filteredComponents = ComponentProcessor.filterComponents(sourceComponents, requestedComponents);
35
+ return new Set([...missingComponents, ...filteredComponents]);
36
+ }
37
+ static filterComponents(sourceComponents, requestedComponents) {
38
+ const sourceComponentMap = ComponentProcessor.createSourceComponentMap(sourceComponents);
39
+ const filteredComponents = new Set();
40
+ for (const requestedComponent of requestedComponents) {
41
+ if (!requestedComponent?.componentName)
42
+ continue;
43
+ const sourceComponent = sourceComponentMap.get(requestedComponent.componentName);
44
+ if (!sourceComponent)
45
+ continue;
46
+ // Filter out non-LWC components
47
+ if (sourceComponent.type?.name !== 'LightningComponentBundle') {
48
+ filteredComponents.add({
49
+ typeName: sourceComponent.type.name,
50
+ componentName: requestedComponent.componentName,
51
+ });
52
+ }
53
+ // Filter out LWC components that are missing the metadata xml file
54
+ else if (sourceComponent.type?.name === 'LightningComponentBundle' && !sourceComponent.xml) {
55
+ filteredComponents.add({
56
+ typeName: sourceComponent.type.name,
57
+ componentName: requestedComponent.componentName,
58
+ });
59
+ }
60
+ }
61
+ return filteredComponents;
62
+ }
63
+ static diffRequestedComponents(sourceComponents, requestedComponents) {
64
+ const existingSourceComponentNames = ComponentProcessor.getExistingSourceComponentNames(sourceComponents);
65
+ const missingComponents = new Set();
66
+ for (const requestedComponent of requestedComponents) {
67
+ if (requestedComponent.componentName && !existingSourceComponentNames.has(requestedComponent.componentName)) {
68
+ missingComponents.add(requestedComponent);
69
+ }
70
+ }
71
+ return missingComponents;
72
+ }
73
+ static parseRequestedComponents(metadataEntries, projectDir) {
74
+ const requestedComponents = new Set();
75
+ for (const entry of metadataEntries) {
76
+ const parsed = ComponentProcessor.parseMetadataEntry(entry, projectDir);
77
+ if (!parsed) {
78
+ continue;
79
+ }
80
+ // Ignore wildcarded component names
81
+ if (parsed.componentName?.includes('*')) {
82
+ continue;
83
+ }
84
+ requestedComponents.add(parsed);
85
+ }
86
+ return requestedComponents;
87
+ }
88
+ static getExistingSourceComponentNames(sourceComponents) {
89
+ const existingSourceComponentNames = new Set();
90
+ for (const component of sourceComponents) {
91
+ const componentName = component.fullName ?? component.name;
92
+ if (componentName) {
93
+ existingSourceComponentNames.add(componentName);
94
+ }
95
+ }
96
+ return existingSourceComponentNames;
97
+ }
98
+ static createSourceComponentMap(sourceComponents) {
99
+ const componentMap = new Map();
100
+ for (const component of sourceComponents) {
101
+ const componentName = component.fullName ?? component.name;
102
+ if (componentName) {
103
+ componentMap.set(componentName, component);
104
+ }
105
+ }
106
+ return componentMap;
107
+ }
108
+ static parseMetadataEntry(rawEntry, projectDir) {
109
+ try {
110
+ const registry = new RegistryAccess(undefined, projectDir);
111
+ // Split on the first colon, and then join the rest back together to support names that include colons
112
+ const [typeName, ...nameParts] = rawEntry.split(':');
113
+ const type = registry.getTypeByName(typeName.trim());
114
+ if (!type) {
115
+ return null;
116
+ }
117
+ const metadataName = nameParts.length > 0 ? nameParts.join(':').trim() : '*';
118
+ // Return null for wildcards since componentName is required
119
+ if (metadataName === '*') {
120
+ return null;
121
+ }
122
+ return {
123
+ typeName: type.name,
124
+ componentName: metadataName,
125
+ };
126
+ }
127
+ catch {
128
+ return null;
129
+ }
130
+ }
131
+ }
132
+ //# sourceMappingURL=componentProcessor.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"componentProcessor.js","sourceRoot":"","sources":["../../src/component/componentProcessor.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,cAAc,EAAwB,MAAM,oCAAoC,CAAC;AAG1F,MAAM,OAAO,kBAAkB;IAC7B;;;;;;;;;;;;OAYG;IACI,MAAM,CAAC,mBAAmB,CAC/B,gBAAmC,EACnC,eAAyB,EACzB,UAAmB;QAEnB,MAAM,mBAAmB,GAAG,kBAAkB,CAAC,wBAAwB,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC;QACrG,MAAM,iBAAiB,GAAG,kBAAkB,CAAC,uBAAuB,CAAC,gBAAgB,EAAE,mBAAmB,CAAC,CAAC;QAC5G,MAAM,kBAAkB,GAAG,kBAAkB,CAAC,gBAAgB,CAAC,gBAAgB,EAAE,mBAAmB,CAAC,CAAC;QACtG,OAAO,IAAI,GAAG,CAAC,CAAC,GAAG,iBAAiB,EAAE,GAAG,kBAAkB,CAAC,CAAC,CAAC;IAChE,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAC7B,gBAAmC,EACnC,mBAAoD;QAEpD,MAAM,kBAAkB,GAAG,kBAAkB,CAAC,wBAAwB,CAAC,gBAAgB,CAAC,CAAC;QACzF,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAuB,CAAC;QAE1D,KAAK,MAAM,kBAAkB,IAAI,mBAAmB,EAAE,CAAC;YACrD,IAAI,CAAC,kBAAkB,EAAE,aAAa;gBAAE,SAAS;YAEjD,MAAM,eAAe,GAAG,kBAAkB,CAAC,GAAG,CAAC,kBAAkB,CAAC,aAAa,CAAC,CAAC;YACjF,IAAI,CAAC,eAAe;gBAAE,SAAS;YAE/B,gCAAgC;YAChC,IAAI,eAAe,CAAC,IAAI,EAAE,IAAI,KAAK,0BAA0B,EAAE,CAAC;gBAC9D,kBAAkB,CAAC,GAAG,CAAC;oBACrB,QAAQ,EAAE,eAAe,CAAC,IAAI,CAAC,IAAI;oBACnC,aAAa,EAAE,kBAAkB,CAAC,aAAa;iBAChD,CAAC,CAAC;YACL,CAAC;YACD,mEAAmE;iBAC9D,IAAI,eAAe,CAAC,IAAI,EAAE,IAAI,KAAK,0BAA0B,IAAI,CAAC,eAAe,CAAC,GAAG,EAAE,CAAC;gBAC3F,kBAAkB,CAAC,GAAG,CAAC;oBACrB,QAAQ,EAAE,eAAe,CAAC,IAAI,CAAC,IAAI;oBACnC,aAAa,EAAE,kBAAkB,CAAC,aAAa;iBAChD,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAEO,MAAM,CAAC,uBAAuB,CACpC,gBAAmC,EACnC,mBAA6C;QAE7C,MAAM,4BAA4B,GAAG,kBAAkB,CAAC,+BAA+B,CAAC,gBAAgB,CAAC,CAAC;QAC1G,MAAM,iBAAiB,GAAG,IAAI,GAAG,EAAuB,CAAC;QACzD,KAAK,MAAM,kBAAkB,IAAI,mBAAmB,EAAE,CAAC;YACrD,IAAI,kBAAkB,CAAC,aAAa,IAAI,CAAC,4BAA4B,CAAC,GAAG,CAAC,kBAAkB,CAAC,aAAa,CAAC,EAAE,CAAC;gBAC5G,iBAAiB,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;YAC5C,CAAC;QACH,CAAC;QACD,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAEO,MAAM,CAAC,wBAAwB,CAAC,eAAyB,EAAE,UAAmB;QACpF,MAAM,mBAAmB,GAAG,IAAI,GAAG,EAAuB,CAAC;QAE3D,KAAK,MAAM,KAAK,IAAI,eAAe,EAAE,CAAC;YACpC,MAAM,MAAM,GAAG,kBAAkB,CAAC,kBAAkB,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;YACxE,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,SAAS;YACX,CAAC;YAED,oCAAoC;YACpC,IAAI,MAAM,CAAC,aAAa,EAAE,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBACxC,SAAS;YACX,CAAC;YAED,mBAAmB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAClC,CAAC;QAED,OAAO,mBAAmB,CAAC;IAC7B,CAAC;IAEO,MAAM,CAAC,+BAA+B,CAAC,gBAAmC;QAChF,MAAM,4BAA4B,GAAG,IAAI,GAAG,EAAU,CAAC;QACvD,KAAK,MAAM,SAAS,IAAI,gBAAgB,EAAE,CAAC;YACzC,MAAM,aAAa,GAAG,SAAS,CAAC,QAAQ,IAAI,SAAS,CAAC,IAAI,CAAC;YAC3D,IAAI,aAAa,EAAE,CAAC;gBAClB,4BAA4B,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;YAClD,CAAC;QACH,CAAC;QACD,OAAO,4BAA4B,CAAC;IACtC,CAAC;IAEO,MAAM,CAAC,wBAAwB,CAAC,gBAAmC;QACzE,MAAM,YAAY,GAAG,IAAI,GAAG,EAA2B,CAAC;QAExD,KAAK,MAAM,SAAS,IAAI,gBAAgB,EAAE,CAAC;YACzC,MAAM,aAAa,GAAG,SAAS,CAAC,QAAQ,IAAI,SAAS,CAAC,IAAI,CAAC;YAC3D,IAAI,aAAa,EAAE,CAAC;gBAClB,YAAY,CAAC,GAAG,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;YAC7C,CAAC;QACH,CAAC;QAED,OAAO,YAAY,CAAC;IACtB,CAAC;IAEO,MAAM,CAAC,kBAAkB,CAAC,QAAgB,EAAE,UAAmB;QACrE,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,IAAI,cAAc,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;YAC3D,sGAAsG;YACtG,MAAM,CAAC,QAAQ,EAAE,GAAG,SAAS,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACrD,MAAM,IAAI,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;YACrD,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,OAAO,IAAI,CAAC;YACd,CAAC;YACD,MAAM,YAAY,GAAG,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;YAC7E,4DAA4D;YAC5D,IAAI,YAAY,KAAK,GAAG,EAAE,CAAC;gBACzB,OAAO,IAAI,CAAC;YACd,CAAC;YACD,OAAO;gBACL,QAAQ,EAAE,IAAI,CAAC,IAAI;gBACnB,aAAa,EAAE,YAAY;aAC5B,CAAC;QACJ,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;CACF"}
@@ -0,0 +1 @@
1
+ export { ComponentProcessor } from './componentProcessor.js';
@@ -0,0 +1,17 @@
1
+ /*
2
+ * Copyright 2026, Salesforce, Inc.
3
+ *
4
+ * Licensed under the Apache License, Version 2.0 (the "License");
5
+ * you may not use this file except in compliance with the License.
6
+ * You may obtain a copy of the License at
7
+ *
8
+ * http://www.apache.org/licenses/LICENSE-2.0
9
+ *
10
+ * Unless required by applicable law or agreed to in writing, software
11
+ * distributed under the License is distributed on an "AS IS" BASIS,
12
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ * See the License for the specific language governing permissions and
14
+ * limitations under the License.
15
+ */
16
+ export { ComponentProcessor } from './componentProcessor.js';
17
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/component/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC"}
package/lib/index.d.ts ADDED
@@ -0,0 +1,2 @@
1
+ declare const _default: {};
2
+ export default _default;
package/lib/index.js ADDED
@@ -0,0 +1,17 @@
1
+ /*
2
+ * Copyright 2026, Salesforce, Inc.
3
+ *
4
+ * Licensed under the Apache License, Version 2.0 (the "License");
5
+ * you may not use this file except in compliance with the License.
6
+ * You may obtain a copy of the License at
7
+ *
8
+ * http://www.apache.org/licenses/LICENSE-2.0
9
+ *
10
+ * Unless required by applicable law or agreed to in writing, software
11
+ * distributed under the License is distributed on an "AS IS" BASIS,
12
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ * See the License for the specific language governing permissions and
14
+ * limitations under the License.
15
+ */
16
+ export default {};
17
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,eAAe,EAAE,CAAC"}