sf-decomposer 4.0.0

package/LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2024 Matthew Carvin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,341 @@
+# sf-decomposer
+
+[![NPM](https://img.shields.io/npm/v/sf-decomposer.svg?label=sf-decomposer)](https://www.npmjs.com/package/sf-decomposer) [![Downloads/week](https://img.shields.io/npm/dw/sf-decomposer.svg)](https://npmjs.org/package/sf-decomposer) [![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://raw.githubusercontent.com/mcarvin8/sf-decomposer/main/LICENSE.md)
+
+The `sf-decomposer` is a Salesforce plugin to read the original metadata files (XML) and create smaller, more manageable files for version control. The inverse function (`recompose`) will recreate metadata files for deployments.
+
+This plugin requires [git](https://git-scm.com/downloads) to be installed and that it can be called using the command `git`.
+
+This will parse and retain the following in the original XMLs:
+
+- Character Data (CDATA)
+- Comments
+- Attributes
+
+The decomposed file format can be XML, JSON, or YAML. Based on testing, XML and YAML handles CDATA formatting nicer than JSON.
+
+**DISCLAIMERS:**
+
+- You must update the `.forceignore` to have the Salesforce CLI ignore the decomposed files created by this plugin. See section `Ignore Files`. Updates to the `.gitignore` are optional and can be updated based on what you want staged in your repo.
+- It is highly recommended that you extensively test this plugin in a sandbox environment on the metadata types you wish to use this tool for.
+- Do not change your production/QA pipelines until you have tested this and are happy with the results.
+- Confirm your deployment pipelines are stable prior to implementing this plugin.
+
+## Install
+
+```bash
+sf plugins install sf-decomposer@x.y.z
+```
+
+## Commands
+
+The `sf-decomposer` supports 2 commands:
+
+- `sf decomposer decompose`
+- `sf decomposer recompose`
+
+Both commands need to be ran somewhere inside your Salesforce DX git repository, whether in the root folder (recommended) or in a subfolder. This plugin will determine the root folder of this repository and read the `sfdx-project.json` file in the root folder. All package directories listed in the `sfdx-project.json` file will be processed when running this plugin.
+
+## `sf decomposer decompose`
+
+Decomposes the original metadata files into smaller files for version control. Excluding custom labels, the smaller files will be placed into new sub-directories:
+
+<img src="https://raw.githubusercontent.com/mcarvin8/sf-decomposer/main/.github/images/decomposed-perm-set.png">
+
+<br>
+
+Custom Labels will be decomposed directly in the root labels folder:
+
+<img src="https://raw.githubusercontent.com/mcarvin8/sf-decomposer/main/.github/images/decomposed-labels.png">
+
+<br>
+
+Unique ID elements are used to name decomposed files for nested elements. The default unique ID elements for all metadata types are `<fullName>` and `<name>`. In this example XML below, the `<fullName>` tag is included in the nested element and its contents (`quoteAuto`) will be used to name the decomposed file.
+
+```xml
+    <labels>
+        <fullName>quoteAuto</fullName>
+        <value>This is an automatically generated quote.</value>
+        <language>en_US</language>
+        <protected>false</protected>
+        <shortDescription>Automatic Quote</shortDescription>
+    </labels>
+```
+
+If the default unique ID elements are not found in the nested element, the plugin will look for any other metadata specific unique ID elements (see `CONTRIBUTING` section for more information).
+
+If a unique ID element is not found in the nested element, the short SHA-256 hash of the element contents will be used to name the decomposed file, as shown below.
+
+It's recommended to add the `--prepurge` flag to the `decompose` command to remove pre-existing decomposed files that may conflict with newer decomposed files due to different SHA hashes.
+
+Using the `--format` flag, you can set the desired file type for the decomposed files to XML (default), YAML, or JSON. **Note**: The `--format` flag for the recompose command must match what you selected for the decompose `--format`.
+
+<img src="https://raw.githubusercontent.com/mcarvin8/sf-decomposer/main/.github/images/decomposed-apps-hashes.png">
+
+<br>
+
+```
+USAGE
+  $ sf decomposer decompose -m <value> -f <value> [--prepurge --postpurge --debug --json]
+
+FLAGS
+  -m, --metadata-type=<value> The metadata suffix to process, such as 'flow', 'labels', etc. You can provide this flag multiple times to process multiple metadata types at once.
+  -f, --format=<value> [default: 'xml'] The file type for the decomposed files.
+  --prepurge  [default: false] If provided, purge directories of pre-existing decomposed files.
+  --postpurge  [default: false] If provided, purge the original files after decomposing them.
+  --debug [default: false] If provided, log debugging results to a text file (disassemble.log).
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  This command will read all of the original metadata files and separate them into smaller files in each package directory.
+
+  These smaller decomposed files can be XMLs, YAMLs, or JSONs.
+
+  You should run this after retrieving metadata from an org.
+
+EXAMPLES
+  Decompose all flows:
+
+    $ sf decomposer decompose -m "flow" -f "xml" --prepurge --postpurge --debug
+
+  Decompose all flows and custom labels:
+
+    $ sf decomposer decompose -m "flow" -m "labels" -f "xml" --prepurge --postpurge --debug
+
+```
+
+## `sf decomposer recompose`
+
+Reads all of the files created by the decompose command and recreates metadata files suitable for deployments.
+
+Ensure the `--format` flag of the recompose command matches the file format selected for the `--format` flag in the decompose command. File formats for the decomposed files can be XML (default), YAML, or JSON.
+
+This command will always create XMLs as its output format.
+
+```
+USAGE
+  $ sf decomposer recompose -m <value> -f <value> [--postpurge --debug --json]
+
+FLAGS
+  -m, --metadata-type=<value> The metadata suffix to process, such as 'flow', 'labels', etc. You can provide this flag multiple times to process multiple metadata types at once.
+  -f, --format=<value> [default: 'xml'] The file format for the decomposed files.
+  --postpurge  [default: false] If provided, purge the decomposed files after recomposing them.
+  --debug [default: false] If provided, log debugging results to a text file (disassemble.log).
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  This command will read all of the decomposed files and recreate deployment compatible metadata files in each package directory.
+
+  You should run this before you deploy the metadata to an org.
+
+EXAMPLES
+  Recompose all flows:
+
+    $ sf decomposer recompose -m "flow" -f "xml" --postpurge --debug
+
+  Recompose all flows and custom labels:
+
+    $ sf decomposer recompose -m "flow" -m "labels" -f "xml" --postpurge --debug
+
+```
+
+## Supported Metadata
+
+All parent metadata types imported from this plugin's version of @salesforce/source-deploy-retrieve (SDR) toolkit are supported except for certain types.
+
+The `--metadata-type`/`-m` flag should be the metadata's `"suffix"` value as listed in the [metadataRegistry.json](https://github.com/forcedotcom/source-deploy-retrieve/blob/main/src/registry/metadataRegistry.json).
+
+The suffix is this part of the original meta file name - `labels` is the suffix in `*.labels-meta.xml`.
+
+Here are some examples:
+
+- Custom Labels (`--metadata-type "labels"`)
+- Workflows (`--metadata-type "workflow"`)
+- Profiles (`--metadata-type "profile"`)
+- Permission Sets (`--metadata-type "permissionset"`)
+- Flows (`--metadata-type "flow"`)
+- Matching Rules (`--metadata-type "matchingRule"`)
+- Assignment Rules (`--metadata-type "assignmentRules"`)
+- Escalation Rules (`--metadata-type "escalationRules"`)
+- Sharing Rules (`--metadata-type "sharingRules"`)
+- Auto Response Rules (`--metadata-type "autoResponseRules"`)
+- Global Value Set Translation (`--metadata-type "globalValueSetTranslation"`)
+- Standard Value Set Translation (`--metadata-type "standardValueSetTranslation"`)
+- Translations (`--metadata-type "translation"`)
+- Standard Value Sets (`--metadata-type "standardValueSet"`)
+- Global Value Sets (`--metadata-type "globalValueSet"`)
+- AI Scoring Model Definition (`--metadata-type "aiScoringModelDefinition"`)
+- Decision Matrix Definition (`--metadata-type "decisionMatrixDefinition"`)
+- Bot (`--metadata-type "bot"`)
+  - **NOTE**: Running "bot" will also decompose and recompose Bot Version meta files
+  - The `botVersion` meta suffix will be blocked from running directly
+- Marketing App Extension (`--metadata-type "marketingappextension"`)
+
+### Exceptions
+
+`botVersion` is blocked from being ran directly. Please use the `bot` meta suffix to decompose and recompose bots and bot versions.
+
+```
+Error (1): `botVersion` suffix should not be used. Please use `bot` to decompose/recompose bot and bot version files.
+```
+
+Custom Objects are not supported by this plugin.
+
+```
+Error (1): Custom Objects are not supported by this plugin.
+```
+
+Metadata types such as Apex Classes, Apex Components, Triggers, etc. with certain SDR adapter strategies (`matchingContentFile`, `digitalExperience`, `mixedContent`, `bundle`) are not supported by this plugin.
+
+```
+Error (1): Metadata types with [matchingContentFile, digitalExperience, mixedContent, bundle] strategies are not supported by this plugin.
+```
+
+Children metadata types (ex: custom fields) are not supported and will result in this general error:
+
+```
+Error (1): Metadata type not found for the given suffix: field.
+```
+
+### Issues
+
+Please create "Issues" in this repository if you experience problems decomposing and recomposing specific metadata types or if this plugin's version of SDR needs to be updated to account for new metadata types.
+
+## Warnings and Logging
+
+The package used to decompose and recompose XMLs, `xml-disassembler`, will log errors, and optionally debugging statements, to a log file, `disassemble.log`. This log will be created in the working directory and will be created when runnign this plugin at all times. If there were no XML decomposing/recomposing errors, this log will simply be empty.
+
+By default, this package will only log errors to the file. This plugin will print `xml-disassembler` errors as warnings in the command terminal to allow all other files to be processed.
+
+These warnings when running `decompose` and `recompose` commands will look as such:
+
+```
+Warning: [2024-04-08T19:27:43.622] [ERROR] default - C:\Users\matth\Documents\sf-decomposer\test\baselines\flows\Get_Info\actionCalls\Get_Info.actionCalls-meta.xml was unabled to be parsed and will not be processed. Confirm formatting and try again.
+```
+
+To add additional debugging statements to the log file, provide the `--debug` flag to either command to generate additional logging statements to `disassemble.log`.
+
+General debugging statements in the log file will look like:
+
+```
+[2024-03-30T14:28:37.959] [DEBUG] default - Created disassembled file: mock\no-nested-elements\HR_Admin\HR_Admin.permissionset-meta.xml
+```
+
+Recommend adding the `disassemble.log` to your `.gitignore` file.
+
+## Hook
+
+A post-retrieve hook has been configured if you elect to use it. The post-retrieve hook will automatically decompose the desired metadata types after every Salesforce CLI retrieval if you create this file in the root of your repo: `.sfdecomposer.config.json`
+
+The `.sfdecomposer.config.json` should look like this:
+
+```json
+{
+  "metadataSuffixes": "labels,workflow,profile",
+  "prePurge": true,
+  "postPurge": true,
+  "decomposedFormat": "xml"
+}
+```
+
+- `metadataSuffixes` is required and should be a comma-separated string of metadata suffixes to decompose automatically after retrievals.
+- `prePurge` is optional and should be a boolean. If true, this will delete any existing decomposed files before decomposing the files. If you do not provide this, the default will be `false`.
+- `postPurge` is optional and should be a boolean. If true, this will delete the retrieval file after decomposing it. If you do not provide this, the default will be `false`.
+- `decomposedFormat` is optional and should be either `xml`, `json`, or `yaml`, depending on what file format you want the decomposed files created as. If you do not provide this, the default will be `xml`.
+
+If the `.sfdecomposer.config.json` file isn't found, the hook will be skipped.
+
+**NOTE:** In order to avoid errors during the retrieval, you must configure your `.forceignore` file to have the Salesforce CLI ignore the decomposed files. See section below.
+
+## Ignore Files
+
+The `.gitignore` and `.forceignore` files in your repository should be updated based on the metadata types you wish to decompose.
+
+Reference the below examples:
+
+### `.gitignore` updates
+
+Git should ignore the recomposed files.
+
+```
+# Ignore recomposed files
+**/permissionsets/*.permissionset-meta.xml
+**/profiles/*.profile-meta.xml
+**/labels/CustomLabels.labels-meta.xml
+**/workflows/*.workflow-meta.xml
+**/flows/*.flow-meta.xml
+**/matchingRules/*.matchingRule-meta.xml
+**/assignmentRules/*.assignmentRules-meta.xml
+**/escalationRules/*.escalationRules-meta.xml
+**/sharingRules/*.sharingRules-meta.xml
+**/autoResponseRules/*.autoResponseRules-meta.xml
+**/globalValueSetTranslations/*.globalValueSetTranslation-meta.xml
+**/standardValueSetTranslations/*.standardValueSetTranslation-meta.xml
+**/translations/*.translation-meta.xml
+**/globalValueSets/*.globalValueSet-meta.xml
+**/standardValueSets/*.standardValueSet-meta.xml
+**/decisionMatrixDefinition/*.decisionMatrixDefinition-meta.xml
+**/aiScoringModelDefinitions/*.aiScoringModelDefinition-meta.xml
+**/bots/*/*.botVersion-meta.xml
+**/bots/*/*.bot-meta.xml
+**/marketingappextensions/*.marketingappextension-meta.xml
+```
+
+Git should also ignore the log created by the `xml-disassembler` package (see previous section).
+
+```
+disassemble.log
+```
+
+### `.forceignore` updates
+
+The Salesforce CLI should ignore the decomposed files and should allow the recomposed files. Update based on the decomposed file format you are using (`.xml`, `.json`, or `.yaml`).
+
+```
+# Ignore decomposed files
+**/profiles/**/*.xml
+**/permissionsets/**/*.xml
+**/labels/*.xml
+**/workflows/**/*.xml
+**/flows/**/*.xml
+**/matchingRules/**/*.xml
+**/assignmentRules/**/*.xml
+**/escalationRules/**/*.xml
+**/sharingRules/**/*.xml
+**/autoResponseRules/**/*.xml
+**/globalValueSetTranslations/**/*.xml
+**/standardValueSetTranslations/**/*.xml
+**/translations/**/*.xml
+**/globalValueSets/**/*.xml
+**/standardValueSets/**/*.xml
+**/decisionMatrixDefinition/**/*.xml
+**/aiScoringModelDefinitions/**/*.xml
+**/bots/**/*.xml
+**/marketingappextensions/**/*.xml
+
+# Allow the recomposed files
+!**/permissionsets/*.permissionset-meta.xml
+!**/labels/CustomLabels.labels-meta.xml
+!**/workflows/*.workflow-meta.xml
+!**/profiles/*.profile-meta.xml
+!**/flows/*.flow-meta.xml
+!**/matchingRules/*.matchingRule-meta.xml
+!**/assignmentRules/*.assignmentRules-meta.xml
+!**/escalationRules/*.escalationRules-meta.xml
+!**/sharingRules/*.sharingRules-meta.xml
+!**/autoResponseRules/*.autoResponseRules-meta.xml
+!**/globalValueSetTranslations/*.globalValueSetTranslation-meta.xml
+!**/standardValueSetTranslations/*.standardValueSetTranslation-meta.xml
+!**/translations/*.translation-meta.xml
+!**/globalValueSets/*.globalValueSet-meta.xml
+!**/standardValueSets/*.standardValueSet-meta.xml
+!**/decisionMatrixDefinition/*.decisionMatrixDefinition-meta.xml
+!**/aiScoringModelDefinitions/*.aiScoringModelDefinition-meta.xml
+!**/bots/*/*.botVersion-meta.xml
+!**/bots/*/*.bot-meta.xml
+!**/marketingappextensions/*.marketingappextension-meta.xml
+```

package/lib/commands/decomposer/decompose.d.ts

@@ -0,0 +1,17 @@
+import { SfCommand } from '@salesforce/sf-plugins-core';
+export type DecomposerDecomposeResult = {
+    metadata: string[];
+};
+export default class DecomposerDecompose extends SfCommand<DecomposerDecomposeResult> {
+    static readonly summary: string;
+    static readonly description: string;
+    static readonly examples: string[];
+    static readonly flags: {
+        'metadata-type': import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string[], import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        prepurge: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
+        postpurge: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
+        debug: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
+        format: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    };
+    run(): Promise<DecomposerDecomposeResult>;
+}

package/lib/commands/decomposer/decompose.js

@@ -0,0 +1,70 @@
+'use strict';
+/* eslint-disable no-await-in-loop */
+import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
+import { Messages } from '@salesforce/core';
+import { LOG_FILE, DECOMPOSED_FILE_TYPES } from '../../helpers/constants.js';
+import { decomposeFileHandler } from '../../service/decomposeFileHandler.js';
+import { getRegistryValuesBySuffix } from '../../metadata/getRegistryValuesBySuffix.js';
+import { readOriginalLogFile, checkLogForErrors } from '../../service/checkLogforErrors.js';
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
+const messages = Messages.loadMessages('sf-decomposer', 'decomposer.decompose');
+export default class DecomposerDecompose extends SfCommand {
+    static summary = messages.getMessage('summary');
+    static description = messages.getMessage('description');
+    static examples = messages.getMessages('examples');
+    static flags = {
+        'metadata-type': Flags.string({
+            summary: messages.getMessage('flags.metadata-type.summary'),
+            char: 'm',
+            multiple: true,
+            required: true,
+        }),
+        prepurge: Flags.boolean({
+            summary: messages.getMessage('flags.prepurge.summary'),
+            required: false,
+            default: false,
+        }),
+        postpurge: Flags.boolean({
+            summary: messages.getMessage('flags.postpurge.summary'),
+            required: false,
+            default: false,
+        }),
+        debug: Flags.boolean({
+            summary: messages.getMessage('flags.debug.summary'),
+            required: false,
+            default: false,
+        }),
+        format: Flags.string({
+            summary: messages.getMessage('flags.format.summary'),
+            char: 'f',
+            required: true,
+            multiple: false,
+            default: 'xml',
+            options: DECOMPOSED_FILE_TYPES,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(DecomposerDecompose);
+        const metadataTypes = flags['metadata-type'];
+        const prepurge = flags['prepurge'];
+        const postpurge = flags['postpurge'];
+        const debug = flags['debug'];
+        const format = flags['format'];
+        for (const metadataType of metadataTypes) {
+            const metaAttributes = await getRegistryValuesBySuffix(metadataType, 'decompose');
+            const currentLogFile = await readOriginalLogFile(LOG_FILE);
+            await decomposeFileHandler(metaAttributes, prepurge, postpurge, debug, format);
+            const decomposeErrors = await checkLogForErrors(LOG_FILE, currentLogFile);
+            if (decomposeErrors.length > 0) {
+                decomposeErrors.forEach((error) => {
+                    this.warn(error);
+                });
+            }
+            this.log(`All metadata files have been decomposed for the metadata type: ${metadataType}`);
+        }
+        return {
+            metadata: metadataTypes,
+        };
+    }
+}
+//# sourceMappingURL=decompose.js.map

package/lib/commands/decomposer/decompose.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"decompose.js","sourceRoot":"","sources":["../../../src/commands/decomposer/decompose.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AACb,qCAAqC;AAErC,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAE5C,OAAO,EAAE,QAAQ,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAC7E,OAAO,EAAE,oBAAoB,EAAE,MAAM,uCAAuC,CAAC;AAC7E,OAAO,EAAE,yBAAyB,EAAE,MAAM,6CAA6C,CAAC;AACxF,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AAE5F,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,eAAe,EAAE,sBAAsB,CAAC,CAAC;AAMhF,MAAM,CAAC,OAAO,OAAO,mBAAoB,SAAQ,SAAoC;IAC5E,MAAM,CAAU,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACzD,MAAM,CAAU,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,CAAU,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAE5D,MAAM,CAAU,KAAK,GAAG;QAC7B,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC;YAC5B,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,6BAA6B,CAAC;YAC3D,IAAI,EAAE,GAAG;YACT,QAAQ,EAAE,IAAI;YACd,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC;YACtB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,wBAAwB,CAAC;YACtD,QAAQ,EAAE,KAAK;YACf,OAAO,EAAE,KAAK;SACf,CAAC;QACF,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC;YACvB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,yBAAyB,CAAC;YACvD,QAAQ,EAAE,KAAK;YACf,OAAO,EAAE,KAAK;SACf,CAAC;QACF,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC;YACnB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,qBAAqB,CAAC;YACnD,QAAQ,EAAE,KAAK;YACf,OAAO,EAAE,KAAK;SACf,CAAC;QACF,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;YACnB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,sBAAsB,CAAC;YACpD,IAAI,EAAE,GAAG;YACT,QAAQ,EAAE,IAAI;YACd,QAAQ,EAAE,KAAK;YACf,OAAO,EAAE,KAAK;YACd,OAAO,EAAE,qBAAqB;SAC/B,CAAC;KACH,CAAC;IAEK,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;QACxD,MAAM,aAAa,GAAG,KAAK,CAAC,eAAe,CAAC,CAAC;QAC7C,MAAM,QAAQ,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;QACnC,MAAM,SAAS,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC;QACrC,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QAC7B,MAAM,MAAM,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC/B,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;YACzC,MAAM,cAAc,GAAG,MAAM,yBAAyB,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;YAElF,MAAM,cAAc,GAAG,MAAM,mBAAmB,CAAC,QAAQ,CAAC,CAAC;YAC3D,MAAM,oBAAoB,CAAC,cAAc,EAAE,QAAQ,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;YAC/E,MAAM,eAAe,GAAG,MAAM,iBAAiB,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;YAC1E,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC/B,eAAe,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;oBAChC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACnB,CAAC,CAAC,CAAC;YACL,CAAC;YACD,IAAI,CAAC,GAAG,CAAC,kEAAkE,YAAY,EAAE,CAAC,CAAC;QAC7F,CAAC;QACD,OAAO;YACL,QAAQ,EAAE,aAAa;SACxB,CAAC;IACJ,CAAC"}

package/lib/commands/decomposer/recompose.d.ts

@@ -0,0 +1,16 @@
+import { SfCommand } from '@salesforce/sf-plugins-core';
+export type DecomposerRecomposeResult = {
+    metadata: string[];
+};
+export default class DecomposerRecompose extends SfCommand<DecomposerRecomposeResult> {
+    static readonly summary: string;
+    static readonly description: string;
+    static readonly examples: string[];
+    static readonly flags: {
+        'metadata-type': import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string[], import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        postpurge: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
+        debug: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
+        format: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    };
+    run(): Promise<DecomposerRecomposeResult>;
+}

package/lib/commands/decomposer/recompose.js

@@ -0,0 +1,64 @@
+'use strict';
+/* eslint-disable no-await-in-loop */
+import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
+import { Messages } from '@salesforce/core';
+import { LOG_FILE, DECOMPOSED_FILE_TYPES } from '../../helpers/constants.js';
+import { recomposeFileHandler } from '../../service/recomposeFileHandler.js';
+import { getRegistryValuesBySuffix } from '../../metadata/getRegistryValuesBySuffix.js';
+import { readOriginalLogFile, checkLogForErrors } from '../../service/checkLogforErrors.js';
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
+const messages = Messages.loadMessages('sf-decomposer', 'decomposer.recompose');
+export default class DecomposerRecompose extends SfCommand {
+    static summary = messages.getMessage('summary');
+    static description = messages.getMessage('description');
+    static examples = messages.getMessages('examples');
+    static flags = {
+        'metadata-type': Flags.string({
+            summary: messages.getMessage('flags.metadata-type.summary'),
+            char: 'm',
+            multiple: true,
+            required: true,
+        }),
+        postpurge: Flags.boolean({
+            summary: messages.getMessage('flags.postpurge.summary'),
+            required: false,
+            default: false,
+        }),
+        debug: Flags.boolean({
+            summary: messages.getMessage('flags.debug.summary'),
+            required: false,
+            default: false,
+        }),
+        format: Flags.string({
+            summary: messages.getMessage('flags.format.summary'),
+            char: 'f',
+            required: true,
+            multiple: false,
+            default: 'xml',
+            options: DECOMPOSED_FILE_TYPES,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(DecomposerRecompose);
+        const metadataTypes = flags['metadata-type'];
+        const postpurge = flags['postpurge'];
+        const debug = flags['debug'];
+        const format = flags['format'];
+        for (const metadataType of metadataTypes) {
+            const metaAttributes = await getRegistryValuesBySuffix(metadataType, 'recompose');
+            const currentLogFile = await readOriginalLogFile(LOG_FILE);
+            await recomposeFileHandler(metaAttributes, postpurge, debug, format);
+            const recomposeErrors = await checkLogForErrors(LOG_FILE, currentLogFile);
+            if (recomposeErrors.length > 0) {
+                recomposeErrors.forEach((error) => {
+                    this.warn(error);
+                });
+            }
+            this.log(`All metadata files have been recomposed for the metadata type: ${metadataType}`);
+        }
+        return {
+            metadata: metadataTypes,
+        };
+    }
+}
+//# sourceMappingURL=recompose.js.map

package/lib/commands/decomposer/recompose.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"recompose.js","sourceRoot":"","sources":["../../../src/commands/decomposer/recompose.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AACb,qCAAqC;AAErC,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAE5C,OAAO,EAAE,QAAQ,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAC7E,OAAO,EAAE,oBAAoB,EAAE,MAAM,uCAAuC,CAAC;AAC7E,OAAO,EAAE,yBAAyB,EAAE,MAAM,6CAA6C,CAAC;AACxF,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AAE5F,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,eAAe,EAAE,sBAAsB,CAAC,CAAC;AAMhF,MAAM,CAAC,OAAO,OAAO,mBAAoB,SAAQ,SAAoC;IAC5E,MAAM,CAAU,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACzD,MAAM,CAAU,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,CAAU,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAE5D,MAAM,CAAU,KAAK,GAAG;QAC7B,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC;YAC5B,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,6BAA6B,CAAC;YAC3D,IAAI,EAAE,GAAG;YACT,QAAQ,EAAE,IAAI;YACd,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC;YACvB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,yBAAyB,CAAC;YACvD,QAAQ,EAAE,KAAK;YACf,OAAO,EAAE,KAAK;SACf,CAAC;QACF,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC;YACnB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,qBAAqB,CAAC;YACnD,QAAQ,EAAE,KAAK;YACf,OAAO,EAAE,KAAK;SACf,CAAC;QACF,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;YACnB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,sBAAsB,CAAC;YACpD,IAAI,EAAE,GAAG;YACT,QAAQ,EAAE,IAAI;YACd,QAAQ,EAAE,KAAK;YACf,OAAO,EAAE,KAAK;YACd,OAAO,EAAE,qBAAqB;SAC/B,CAAC;KACH,CAAC;IAEK,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;QACxD,MAAM,aAAa,GAAG,KAAK,CAAC,eAAe,CAAC,CAAC;QAC7C,MAAM,SAAS,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC;QACrC,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QAC7B,MAAM,MAAM,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC/B,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;YACzC,MAAM,cAAc,GAAG,MAAM,yBAAyB,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;YAElF,MAAM,cAAc,GAAG,MAAM,mBAAmB,CAAC,QAAQ,CAAC,CAAC;YAC3D,MAAM,oBAAoB,CAAC,cAAc,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;YACrE,MAAM,eAAe,GAAG,MAAM,iBAAiB,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;YAC1E,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC/B,eAAe,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;oBAChC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACnB,CAAC,CAAC,CAAC;YACL,CAAC;YACD,IAAI,CAAC,GAAG,CAAC,kEAAkE,YAAY,EAAE,CAAC,CAAC;QAC7F,CAAC;QACD,OAAO;YACL,QAAQ,EAAE,aAAa;SACxB,CAAC;IACJ,CAAC"}

package/lib/helpers/constants.d.ts

@@ -0,0 +1,5 @@
+export declare const SFDX_PROJECT_FILE_NAME = "sfdx-project.json";
+export declare const CUSTOM_LABELS_FILE = "CustomLabels.labels-meta.xml";
+export declare const DEFAULT_UNIQUE_ID_ELEMENTS: string;
+export declare const LOG_FILE = "disassemble.log";
+export declare const DECOMPOSED_FILE_TYPES: string[];

package/lib/helpers/constants.js

@@ -0,0 +1,7 @@
+'use strict';
+export const SFDX_PROJECT_FILE_NAME = 'sfdx-project.json';
+export const CUSTOM_LABELS_FILE = 'CustomLabels.labels-meta.xml';
+export const DEFAULT_UNIQUE_ID_ELEMENTS = 'fullName,name';
+export const LOG_FILE = 'disassemble.log';
+export const DECOMPOSED_FILE_TYPES = ['xml', 'json', 'yaml'];
+//# sourceMappingURL=constants.js.map

package/lib/helpers/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/helpers/constants.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AACb,MAAM,CAAC,MAAM,sBAAsB,GAAG,mBAAmB,CAAC;AAC1D,MAAM,CAAC,MAAM,kBAAkB,GAAG,8BAA8B,CAAC;AACjE,MAAM,CAAC,MAAM,0BAA0B,GAAW,eAAe,CAAC;AAClE,MAAM,CAAC,MAAM,QAAQ,GAAG,iBAAiB,CAAC;AAC1C,MAAM,CAAC,MAAM,qBAAqB,GAAa,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC"}

package/lib/hooks/scopedPostRetrieve.d.ts

@@ -0,0 +1,12 @@
+import { Command, Hook, Config } from '@oclif/core';
+import { ScopedPostRetrieve } from '@salesforce/source-deploy-retrieve';
+type HookFunction = (this: Hook.Context, options: HookOptions) => Promise<void>;
+type HookOptions = {
+    Command: Command;
+    argv: string[];
+    commandId: string;
+    result?: ScopedPostRetrieve;
+    config: Config;
+};
+export declare const scopedPostRetrieve: HookFunction;
+export {};

package/lib/hooks/scopedPostRetrieve.js

@@ -0,0 +1,51 @@
+'use strict';
+import { readFile } from 'node:fs/promises';
+import { resolve } from 'node:path';
+import { simpleGit } from 'simple-git';
+import DecomposerDecompose from '../commands/decomposer/decompose.js';
+export const scopedPostRetrieve = async function (options) {
+    if (!options.result?.retrieveResult.response.status) {
+        return;
+    }
+    let configFile;
+    const gitOptions = {
+        baseDir: process.cwd(),
+        binary: 'git',
+        maxConcurrentProcesses: 6,
+        trimmed: true,
+    };
+    const git = simpleGit(gitOptions);
+    const repoRoot = (await git.revparse('--show-toplevel')).trim();
+    const configPath = resolve(repoRoot, '.sfdecomposer.config.json');
+    try {
+        const jsonString = await readFile(configPath, 'utf-8');
+        configFile = JSON.parse(jsonString);
+    }
+    catch (error) {
+        return;
+    }
+    const metadataTypes = configFile.metadataSuffixes || '.';
+    const format = configFile.decomposedFormat || 'xml';
+    const prepurge = configFile.prePurge || false;
+    const postpurge = configFile.postPurge || false;
+    if (metadataTypes.trim() === '.') {
+        return;
+    }
+    const metadataTypesArray = metadataTypes.split(',');
+    const commandArgs = [];
+    for (const metadataType of metadataTypesArray) {
+        const sanitizedMetadataType = metadataType.replace(/,/g, '');
+        commandArgs.push('--metadata-type');
+        commandArgs.push(sanitizedMetadataType);
+    }
+    commandArgs.push('--format');
+    commandArgs.push(format);
+    if (prepurge) {
+        commandArgs.push('--prepurge');
+    }
+    if (postpurge) {
+        commandArgs.push('--postpurge');
+    }
+    await DecomposerDecompose.run(commandArgs);
+};
+//# sourceMappingURL=scopedPostRetrieve.js.map

package/lib/hooks/scopedPostRetrieve.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scopedPostRetrieve.js","sourceRoot":"","sources":["../../src/hooks/scopedPostRetrieve.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAGpC,OAAO,EAAE,SAAS,EAA+B,MAAM,YAAY,CAAC;AACpE,OAAO,mBAAmB,MAAM,qCAAqC,CAAC;AAmBtE,MAAM,CAAC,MAAM,kBAAkB,GAAiB,KAAK,WAAW,OAAO;IACrE,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,cAAc,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QACpD,OAAO;IACT,CAAC;IACD,IAAI,UAAsB,CAAC;IAC3B,MAAM,UAAU,GAA8B;QAC5C,OAAO,EAAE,OAAO,CAAC,GAAG,EAAE;QACtB,MAAM,EAAE,KAAK;QACb,sBAAsB,EAAE,CAAC;QACzB,OAAO,EAAE,IAAI;KACd,CAAC;IAEF,MAAM,GAAG,GAAc,SAAS,CAAC,UAAU,CAAC,CAAC;IAC7C,MAAM,QAAQ,GAAG,CAAC,MAAM,GAAG,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAChE,MAAM,UAAU,GAAG,OAAO,CAAC,QAAQ,EAAE,2BAA2B,CAAC,CAAC;IAElE,IAAI,CAAC;QACH,MAAM,UAAU,GAAW,MAAM,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QAC/D,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAe,CAAC;IACpD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO;IACT,CAAC;IAED,MAAM,aAAa,GAAW,UAAU,CAAC,gBAAgB,IAAI,GAAG,CAAC;IACjE,MAAM,MAAM,GAAW,UAAU,CAAC,gBAAgB,IAAI,KAAK,CAAC;IAC5D,MAAM,QAAQ,GAAY,UAAU,CAAC,QAAQ,IAAI,KAAK,CAAC;IACvD,MAAM,SAAS,GAAY,UAAU,CAAC,SAAS,IAAI,KAAK,CAAC;IAEzD,IAAI,aAAa,CAAC,IAAI,EAAE,KAAK,GAAG,EAAE,CAAC;QACjC,OAAO;IACT,CAAC;IAED,MAAM,kBAAkB,GAAa,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAE9D,MAAM,WAAW,GAAa,EAAE,CAAC;IACjC,KAAK,MAAM,YAAY,IAAI,kBAAkB,EAAE,CAAC;QAC9C,MAAM,qBAAqB,GAAG,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAC7D,WAAW,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QACpC,WAAW,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;IAC1C,CAAC;IACD,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC7B,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACzB,IAAI,QAAQ,EAAE,CAAC;QACb,WAAW,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACjC,CAAC;IACD,IAAI,SAAS,EAAE,CAAC;QACd,WAAW,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAClC,CAAC;IACD,MAAM,mBAAmB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;AAC7C,CAAC,CAAC"}

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+declare const _default: {};
+export default _default;

package/lib/index.js

@@ -0,0 +1,2 @@
+export default {};
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,eAAe,EAAE,CAAC"}

package/lib/metadata/getPackageDirectories.d.ts

@@ -0,0 +1 @@
+export declare function getPackageDirectories(metaDirectory: string): Promise<string[]>;