sfdx-easy-sources 0.7.6 → 0.8.0

package/README.md

@@ -25,35 +25,75 @@ With this plugin you can:
 
 ## Supported metadata types
 
-| Metadata Label| Metadata api | Available commands    |
-| :---:    | :---:  | :---: | 
-| All Meta | allmeta   | split, upsert, merge, minify, retrieve   |
-| Profiles | profiles | split, upsert, merge, minify, updatekey, delete, clean, clearempty, arealigned |
-| Permission Sets | permissionsets | split, upsert, merge, minify, updatekey, delete, clean, clearempty, arealigned |
-| Record Types | recordtypes | split, upsert, merge, updatekey, delete, clean, arealigned |
-| Labels | labels | split, upsert, merge, updatekey, arealigned |
-| Global Value Sets | globalvaluesets | split, upsert, merge, updatekey, arealigned |
-| Global Value Set Translations | globalvaluesettranslations | split, upsert, merge, updatekey, arealigned |
-| Applications | applications | split, upsert, merge, updatekey, arealigned |
-| Object Translations | objecttranslations | split, upsert, merge, minify, updatekey, clearempty, arealigned |
-| Translations | translations | split, upsert, merge, minify, updatekey, clearempty, arealigned |
+| Metadata Label| Metadata api | Available commands    | Programmatic API |
+| :---:    | :---:  | :---: | :---: |
+| All Meta | allmeta   | split, upsert, merge, minify, retrieve   | ❌ |
+| Profiles | profiles | split, upsert, merge, minify, updatekey, delete, clean, clearempty, arealigned | ✅ **Complete** |
+| Permission Sets | permissionsets | split, upsert, merge, minify, updatekey, delete, clean, clearempty, arealigned | ✅ **Complete** |
+| Record Types | recordtypes | split, upsert, merge, updatekey, delete, clean, arealigned | ✅ **Complete** |
+| Labels | labels | split, upsert, merge, updatekey, arealigned | ✅ **Complete** |
+| Global Value Sets | globalvaluesets | split, upsert, merge, updatekey, arealigned | ✅ **Complete** |
+| Global Value Set Translations | globalvaluesettranslations | split, upsert, merge, updatekey, arealigned | ✅ **Complete** |
+| Applications | applications | split, upsert, merge, updatekey, arealigned | ✅ **Complete** |
+| Object Translations | objecttranslations | split, upsert, merge, minify, updatekey, clearempty, arealigned | ✅ **Complete** |
+| Translations | translations | split, upsert, merge, minify, updatekey, clearempty, arealigned | ✅ **Complete** |
 
 
 
 ```sh-session
 $ npm install -g sfdx-easy-sources
 or
-$ sfdx plugin:install sfdx-easy-sources
+$ sf plugins install sfdx-easy-sources
 
 GENERAL USAGE
-  $ sfdx easysources:<metadataapi>:<command> [...parameters]
-  $ sfdx easysources:<metadataapi>:<command> --help    // to get help, the list of parameters and some examples
+  $ sf easysources <metadataapi> <command> [...parameters]
+  $ sf easysources <metadataapi> <command> --help    // to get help, the list of parameters and some examples
 Examples
-  $ sfdx easysources:profiles:split
-  $ sfdx easysources:labels:upsert
+  $ sf easysources profiles split
+  $ sf easysources labels upsert
 ...
 ```
 
+## 🚀 Programmatic API Usage
+
+**NEW in v0.8.0**: Complete programmatic API with automatic path resolution! Use all metadata operations in your Node.js scripts with **57 total API operations** across 9 metadata types.
+
+```javascript
+// JavaScript - Basic usage with automatic path resolution
+const { profiles, permissionsets, labels, objectTranslations } = require('sfdx-easy-sources');
+
+async function automateMetadata() {
+  // Paths auto-resolved from easysources-settings.json
+  await profiles.split({ input: 'Admin,Standard User' });
+  await profiles.upsert({ input: 'Admin' });
+  await profiles.merge({ input: 'Admin' });
+  
+  // Same pattern for all metadata types
+  await permissionsets.split();
+  await labels.upsert();
+  await objectTranslations.minify();
+}
+```
+
+```typescript
+// TypeScript - Full type safety
+import { profiles, ProfileOptions } from 'sfdx-easy-sources';
+
+const options: ProfileOptions = {
+  input: 'Admin,Standard User',
+  ignoreuserperm: 'true'
+};
+await profiles.split(options);
+```
+
+**📚 Complete Documentation & Examples:** [API.md](./API.md)
+
+### Key Features
+- **🔧 Automatic Path Resolution**: Uses `easysources-settings.json` for defaults
+- **⚙️ Full TypeScript Support**: Complete type definitions for all metadata types  
+- **🔄 Consistent API**: Identical patterns across all 9 supported metadata types
+- **🎯 Zero Code Duplication**: CLI commands delegate to API functions
+
 
 Based on the source type, this plugin provides the following commands:
 - **Split**: Splits the resources into various CSV files, and creates an XML file containing all the tags that weren't split
@@ -75,10 +115,10 @@ Based on the source type, this plugin provides the following commands:
 # Let's start!
 ## Prerequisites
 ### Prerequisite 1 - Initialize the settings
-This should be done once you have your sfdx project (for example after "Creating a new project with manifest").
+This should be done once you have your sf project (for example after "Creating a new project with manifest").
 To better instruct the plugin with the directories of the project, you can run the command
 ```sh-session
-$ sfdx easysources:settings:init
+$ sf easysources settings init
 ```
 and a file _easysources-settings.json_ will appear.
 This file contains the directory of:
@@ -87,7 +127,7 @@ This file contains the directory of:
 - the log files.
 
 Since I prefer to have the csv files near the xml ones, I left the default directories in my project. Consider that, in this case, you should need to:
-- have a .forceignore file to ignore .csv and .part-xml files when running sfdx commands
+- have a .forceignore file to ignore .csv and .part-xml files when running sf commands
 - have a .pipelineignore file to ignore .csv and .part-xml files when running other plugins, for example when using sfdx-git-delta.
 
 Simply put these lines inside those files
@@ -102,7 +142,7 @@ To deal with Salesforce files all the source code from the org must be downloade
 One can perform this task in various ways, but this plugin also offers a simply way to download everything from the org.
 
 ```sh-session
-$ sfdx easysources:allmeta:retrieve --orgname="orgname"
+$ sf easysources allmeta retrieve --orgname="orgname"
 ```
 
 
@@ -118,9 +158,9 @@ Once all the metadata have been downloaded, before to start dealing with the csv
 To do this run these commands (but first, please, understand the meaning of each command reading this guide)
 
 ```sh-session
-$ sfdx easysources:allmeta:split
-$ sfdx easysources:allmeta:minify
-$ sfdx easysources:allmeta:merge
+$ sf easysources allmeta split
+$ sf easysources allmeta minify
+$ sf easysources allmeta merge
 ```
 
 ## Description of each command
@@ -134,7 +174,7 @@ This is an example of an xml profile splitted in csv.
 Once we run the command
 
 ```sh-session
-  $ sfdx easysources:profiles:split
+  $ sf easysources profiles split
 ```
 the plugin generates a folder with all the csv files.
 ![profile_split](.images/profile_split.png)
@@ -176,10 +216,10 @@ This command is very useful if you don't want to have in your csv files all the
 For example, in the following image, the lines in red don't specify any permission so they could be removed.
 
 ```sh-session
-  $ sfdx easysources:profiles:minify
-  $ sfdx easysources:permissionsets:minify
-  $ sfdx easysources:objecttranslations:minify
-  $ sfdx easysources:translations:minify
+  $ sf easysources profiles minify
+  $ sf easysources permissionsets minify
+  $ sf easysources objecttranslations minify
+  $ sf easysources translations minify
 ```
 
 ![profile_minify](.images/profile_minify.png)
@@ -193,10 +233,10 @@ This command removes empty CSV files and folders from the generated CSV files, h
 After splitting metadata into CSV files, you might end up with empty CSV files or empty folders that don't contain any meaningful data. This command identifies and removes these empty files and directories automatically.
 
 ```sh-session
-  $ sfdx easysources:profiles:clearempty
-  $ sfdx easysources:permissionsets:clearempty
-  $ sfdx easysources:objecttranslations:clearempty
-  $ sfdx easysources:translations:clearempty
+  $ sf easysources profiles clearempty
+  $ sf easysources permissionsets clearempty
+  $ sf easysources objecttranslations clearempty
+  $ sf easysources translations clearempty
 ```
 
 This is particularly useful for object translations where you might have many empty field translation files, or for translations where some language files might be empty.
@@ -209,15 +249,15 @@ The command supports two validation modes:
 
 **String Mode** (`--mode string` - default):
 ```sh-session
-$ sfdx easysources:profiles:arealigned --mode string
+$ sf easysources profiles arealigned --mode string
 # or simply (uses string mode by default):
-$ sfdx easysources:profiles:arealigned
+$ sf easysources profiles arealigned
 ```
 Performs an exact string comparison by temporarily merging CSV files back into XML format and comparing the complete file content character by character. This mode detects even minor formatting differences and is the default mode.
 
 **Logic Mode** (`--mode logic`):
 ```sh-session
-$ sfdx easysources:profiles:arealigned --mode logic
+$ sf easysources profiles arealigned --mode logic
 ```
 Performs a logical comparison by parsing both XML and CSV data structures and comparing the actual values. This mode is faster and focuses on data content rather than formatting differences.
 

package/lib/api/applications.d.ts

@@ -0,0 +1,73 @@
+import { AnyJson } from '@salesforce/ts-types';
+import { PathOptions } from './paths';
+/**
+ * Interface for Application operation options.
+ * All properties are optional and will be resolved automatically from easysources-settings.json if not provided.
+ */
+export interface ApplicationOptions extends PathOptions {
+    /** Input applications (comma-separated) */
+    input?: string;
+    /** Sort output (default: 'true') */
+    sort?: 'true' | 'false';
+    /** Mode for areAligned operation (default: 'string') */
+    mode?: 'string' | 'logic';
+}
+/**
+ * Application namespace containing all programmatic API functions for Salesforce Application metadata operations.
+ *
+ * All methods automatically resolve paths from easysources-settings.json configuration file.
+ * You only need to provide options to override the default behavior.
+ *
+ * Available operations:
+ * - split(): Splits applications into separate files
+ * - upsert(): Updates or inserts application records
+ * - merge(): Merges application files
+ * - areAligned(): Checks if applications are aligned between environments
+ * - updateKey(): Updates application keys
+ *
+ * @example
+ * ```javascript
+ * const { applications } = require('sfdx-easy-sources');
+ *
+ * // Using default settings from easysources-settings.json
+ * await applications.split();
+ *
+ * // Override specific paths
+ * await applications.upsert({
+ *   'sf-xml': './custom-metadata-path',
+ *   'es-csv': './custom-csv-path'
+ * });
+ * ```
+ */
+export declare const applications: {
+    /**
+     * Splits applications into separate files for easier management and version control.
+     * @param options Optional configuration, automatically resolved from settings if not provided
+     * @returns Promise resolving to operation result
+     */
+    split: (options?: ApplicationOptions) => Promise<AnyJson>;
+    /**
+     * Updates or inserts application records from CSV files to Salesforce metadata format.
+     * @param options Optional configuration, automatically resolved from settings if not provided
+     * @returns Promise resolving to operation result
+     */
+    upsert: (options?: ApplicationOptions) => Promise<AnyJson>;
+    /**
+     * Merges application files back into unified metadata files.
+     * @param options Optional configuration, automatically resolved from settings if not provided
+     * @returns Promise resolving to operation result
+     */
+    merge: (options?: ApplicationOptions) => Promise<AnyJson>;
+    /**
+     * Checks if applications are aligned between different environments or sources.
+     * @param options Optional configuration, automatically resolved from settings if not provided
+     * @returns Promise resolving to alignment check result
+     */
+    areAligned: (options?: ApplicationOptions) => Promise<AnyJson>;
+    /**
+     * Updates application keys based on configuration rules.
+     * @param options Optional configuration, automatically resolved from settings if not provided
+     * @returns Promise resolving to key update result
+     */
+    updateKey: (options?: ApplicationOptions) => Promise<AnyJson>;
+};

package/lib/api/applications.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applications = void 0;
+const split_1 = require("../commands/easysources/applications/split");
+const upsert_1 = require("../commands/easysources/applications/upsert");
+const merge_1 = require("../commands/easysources/applications/merge");
+const arealigned_1 = require("../commands/easysources/applications/arealigned");
+const updatekey_1 = require("../commands/easysources/applications/updatekey");
+/**
+ * Application namespace containing all programmatic API functions for Salesforce Application metadata operations.
+ *
+ * All methods automatically resolve paths from easysources-settings.json configuration file.
+ * You only need to provide options to override the default behavior.
+ *
+ * Available operations:
+ * - split(): Splits applications into separate files
+ * - upsert(): Updates or inserts application records
+ * - merge(): Merges application files
+ * - areAligned(): Checks if applications are aligned between environments
+ * - updateKey(): Updates application keys
+ *
+ * @example
+ * ```javascript
+ * const { applications } = require('sfdx-easy-sources');
+ *
+ * // Using default settings from easysources-settings.json
+ * await applications.split();
+ *
+ * // Override specific paths
+ * await applications.upsert({
+ *   'sf-xml': './custom-metadata-path',
+ *   'es-csv': './custom-csv-path'
+ * });
+ * ```
+ */
+exports.applications = {
+    /**
+     * Splits applications into separate files for easier management and version control.
+     * @param options Optional configuration, automatically resolved from settings if not provided
+     * @returns Promise resolving to operation result
+     */
+    split: async (options = {}) => {
+        return (0, split_1.applicationSplit)(options);
+    },
+    /**
+     * Updates or inserts application records from CSV files to Salesforce metadata format.
+     * @param options Optional configuration, automatically resolved from settings if not provided
+     * @returns Promise resolving to operation result
+     */
+    upsert: async (options = {}) => {
+        return (0, upsert_1.applicationUpsert)(options);
+    },
+    /**
+     * Merges application files back into unified metadata files.
+     * @param options Optional configuration, automatically resolved from settings if not provided
+     * @returns Promise resolving to operation result
+     */
+    merge: async (options = {}) => {
+        return (0, merge_1.applicationMerge)(options);
+    },
+    /**
+     * Checks if applications are aligned between different environments or sources.
+     * @param options Optional configuration, automatically resolved from settings if not provided
+     * @returns Promise resolving to alignment check result
+     */
+    areAligned: async (options = {}) => {
+        return (0, arealigned_1.applicationAreAligned)(options);
+    },
+    /**
+     * Updates application keys based on configuration rules.
+     * @param options Optional configuration, automatically resolved from settings if not provided
+     * @returns Promise resolving to key update result
+     */
+    updateKey: async (options = {}) => {
+        return (0, updatekey_1.applicationUpdateKey)(options);
+    }
+};
+//# sourceMappingURL=applications.js.map

package/lib/api/applications.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"applications.js","sourceRoot":"","sources":["../../src/api/applications.ts"],"names":[],"mappings":";;;AAEA,sEAA8E;AAC9E,wEAAgF;AAChF,sEAA8E;AAC9E,gFAAwF;AACxF,8EAAsF;AAetF;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACU,QAAA,YAAY,GAAG;IAC1B;;;;OAIG;IACH,KAAK,EAAE,KAAK,EAAE,UAA8B,EAAE,EAAoB,EAAE;QAClE,OAAO,IAAA,wBAAgB,EAAC,OAAO,CAAC,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACH,MAAM,EAAE,KAAK,EAAE,UAA8B,EAAE,EAAoB,EAAE;QACnE,OAAO,IAAA,0BAAiB,EAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IAED;;;;OAIG;IACH,KAAK,EAAE,KAAK,EAAE,UAA8B,EAAE,EAAoB,EAAE;QAClE,OAAO,IAAA,wBAAgB,EAAC,OAAO,CAAC,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACH,UAAU,EAAE,KAAK,EAAE,UAA8B,EAAE,EAAoB,EAAE;QACvE,OAAO,IAAA,kCAAqB,EAAC,OAAO,CAAC,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACH,SAAS,EAAE,KAAK,EAAE,UAA8B,EAAE,EAAoB,EAAE;QACtE,OAAO,IAAA,gCAAoB,EAAC,OAAO,CAAC,CAAC;IACvC,CAAC;CACF,CAAC"}

package/lib/api/globalvaluesets.d.ts

@@ -0,0 +1,73 @@
+import { AnyJson } from '@salesforce/ts-types';
+import { PathOptions } from './paths';
+/**
+ * Interface for Global Value Set operation options.
+ * All properties are optional and will be resolved automatically from easysources-settings.json if not provided.
+ */
+export interface GlobalValueSetOptions extends PathOptions {
+    /** Input global value sets (comma-separated) */
+    input?: string;
+    /** Sort output (default: 'false') */
+    sort?: 'true' | 'false';
+    /** Mode for areAligned operation (default: 'string') */
+    mode?: 'string' | 'logic';
+}
+/**
+ * Global Value Sets namespace containing all programmatic API functions for Salesforce Global Value Set metadata operations.
+ *
+ * All methods automatically resolve paths from easysources-settings.json configuration file.
+ * You only need to provide options to override the default behavior.
+ *
+ * Available operations:
+ * - split(): Splits global value sets into separate CSV files
+ * - upsert(): Updates or inserts global value set records
+ * - merge(): Merges global value set CSV files back to XML
+ * - areAligned(): Checks if global value sets are aligned between environments
+ * - updateKey(): Updates global value set keys
+ *
+ * @example
+ * ```javascript
+ * const { globalValueSets } = require('sfdx-easy-sources');
+ *
+ * // Using default settings from easysources-settings.json
+ * await globalValueSets.split();
+ *
+ * // Override specific paths
+ * await globalValueSets.upsert({
+ *   'sf-xml': './custom-metadata-path',
+ *   'es-csv': './custom-csv-path'
+ * });
+ * ```
+ */
+export declare const globalValueSets: {
+    /**
+     * Splits global value sets into separate CSV files for easier management and version control.
+     * @param options Optional configuration, automatically resolved from settings if not provided
+     * @returns Promise resolving to operation result
+     */
+    split: (options?: GlobalValueSetOptions) => Promise<AnyJson>;
+    /**
+     * Updates or inserts global value set records from CSV files to Salesforce metadata format.
+     * @param options Optional configuration, automatically resolved from settings if not provided
+     * @returns Promise resolving to operation result
+     */
+    upsert: (options?: GlobalValueSetOptions) => Promise<AnyJson>;
+    /**
+     * Merges global value set CSV files back into unified metadata files.
+     * @param options Optional configuration, automatically resolved from settings if not provided
+     * @returns Promise resolving to operation result
+     */
+    merge: (options?: GlobalValueSetOptions) => Promise<AnyJson>;
+    /**
+     * Checks if global value sets are aligned between different environments or sources.
+     * @param options Optional configuration, automatically resolved from settings if not provided
+     * @returns Promise resolving to alignment check result
+     */
+    areAligned: (options?: GlobalValueSetOptions) => Promise<AnyJson>;
+    /**
+     * Updates global value set keys based on configuration rules.
+     * @param options Optional configuration, automatically resolved from settings if not provided
+     * @returns Promise resolving to key update result
+     */
+    updateKey: (options?: GlobalValueSetOptions) => Promise<AnyJson>;
+};

package/lib/api/globalvaluesets.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.globalValueSets = void 0;
+const split_1 = require("../commands/easysources/globalvaluesets/split");
+const upsert_1 = require("../commands/easysources/globalvaluesets/upsert");
+const merge_1 = require("../commands/easysources/globalvaluesets/merge");
+const arealigned_1 = require("../commands/easysources/globalvaluesets/arealigned");
+const updatekey_1 = require("../commands/easysources/globalvaluesets/updatekey");
+/**
+ * Global Value Sets namespace containing all programmatic API functions for Salesforce Global Value Set metadata operations.
+ *
+ * All methods automatically resolve paths from easysources-settings.json configuration file.
+ * You only need to provide options to override the default behavior.
+ *
+ * Available operations:
+ * - split(): Splits global value sets into separate CSV files
+ * - upsert(): Updates or inserts global value set records
+ * - merge(): Merges global value set CSV files back to XML
+ * - areAligned(): Checks if global value sets are aligned between environments
+ * - updateKey(): Updates global value set keys
+ *
+ * @example
+ * ```javascript
+ * const { globalValueSets } = require('sfdx-easy-sources');
+ *
+ * // Using default settings from easysources-settings.json
+ * await globalValueSets.split();
+ *
+ * // Override specific paths
+ * await globalValueSets.upsert({
+ *   'sf-xml': './custom-metadata-path',
+ *   'es-csv': './custom-csv-path'
+ * });
+ * ```
+ */
+exports.globalValueSets = {
+    /**
+     * Splits global value sets into separate CSV files for easier management and version control.
+     * @param options Optional configuration, automatically resolved from settings if not provided
+     * @returns Promise resolving to operation result
+     */
+    split: async (options = {}) => {
+        return (0, split_1.globalValueSetSplit)(options);
+    },
+    /**
+     * Updates or inserts global value set records from CSV files to Salesforce metadata format.
+     * @param options Optional configuration, automatically resolved from settings if not provided
+     * @returns Promise resolving to operation result
+     */
+    upsert: async (options = {}) => {
+        return (0, upsert_1.globalValueSetUpsert)(options);
+    },
+    /**
+     * Merges global value set CSV files back into unified metadata files.
+     * @param options Optional configuration, automatically resolved from settings if not provided
+     * @returns Promise resolving to operation result
+     */
+    merge: async (options = {}) => {
+        return (0, merge_1.globalValueSetMerge)(options);
+    },
+    /**
+     * Checks if global value sets are aligned between different environments or sources.
+     * @param options Optional configuration, automatically resolved from settings if not provided
+     * @returns Promise resolving to alignment check result
+     */
+    areAligned: async (options = {}) => {
+        return (0, arealigned_1.globalValueSetAreAligned)(options);
+    },
+    /**
+     * Updates global value set keys based on configuration rules.
+     * @param options Optional configuration, automatically resolved from settings if not provided
+     * @returns Promise resolving to key update result
+     */
+    updateKey: async (options = {}) => {
+        return (0, updatekey_1.globalValueSetUpdateKey)(options);
+    }
+};
+//# sourceMappingURL=globalvaluesets.js.map

package/lib/api/globalvaluesets.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"globalvaluesets.js","sourceRoot":"","sources":["../../src/api/globalvaluesets.ts"],"names":[],"mappings":";;;AAEA,yEAAoF;AACpF,2EAAsF;AACtF,yEAAoF;AACpF,mFAA8F;AAC9F,iFAA4F;AAe5F;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACU,QAAA,eAAe,GAAG;IAC7B;;;;OAIG;IACH,KAAK,EAAE,KAAK,EAAE,UAAiC,EAAE,EAAoB,EAAE;QACrE,OAAO,IAAA,2BAAmB,EAAC,OAAO,CAAC,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACH,MAAM,EAAE,KAAK,EAAE,UAAiC,EAAE,EAAoB,EAAE;QACtE,OAAO,IAAA,6BAAoB,EAAC,OAAO,CAAC,CAAC;IACvC,CAAC;IAED;;;;OAIG;IACH,KAAK,EAAE,KAAK,EAAE,UAAiC,EAAE,EAAoB,EAAE;QACrE,OAAO,IAAA,2BAAmB,EAAC,OAAO,CAAC,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACH,UAAU,EAAE,KAAK,EAAE,UAAiC,EAAE,EAAoB,EAAE;QAC1E,OAAO,IAAA,qCAAwB,EAAC,OAAO,CAAC,CAAC;IAC3C,CAAC;IAED;;;;OAIG;IACH,SAAS,EAAE,KAAK,EAAE,UAAiC,EAAE,EAAoB,EAAE;QACzE,OAAO,IAAA,mCAAuB,EAAC,OAAO,CAAC,CAAC;IAC1C,CAAC;CACF,CAAC"}

package/lib/api/globalvaluesettranslations.d.ts

@@ -0,0 +1,73 @@
+import { AnyJson } from '@salesforce/ts-types';
+import { PathOptions } from './paths';
+/**
+ * Interface for Global Value Set Translation operation options.
+ * All properties are optional and will be resolved automatically from easysources-settings.json if not provided.
+ */
+export interface GlobalValueSetTranslationOptions extends PathOptions {
+    /** Input global value set translations (comma-separated) */
+    input?: string;
+    /** Sort output (default: 'false') */
+    sort?: 'true' | 'false';
+    /** Mode for areAligned operation (default: 'string') */
+    mode?: 'string' | 'logic';
+}
+/**
+ * Global Value Set Translations namespace containing all programmatic API functions for Salesforce Global Value Set Translation metadata operations.
+ *
+ * All methods automatically resolve paths from easysources-settings.json configuration file.
+ * You only need to provide options to override the default behavior.
+ *
+ * Available operations:
+ * - split(): Splits global value set translations into separate CSV files
+ * - upsert(): Updates or inserts global value set translation records
+ * - merge(): Merges global value set translation CSV files back to XML
+ * - areAligned(): Checks if global value set translations are aligned between environments
+ * - updateKey(): Updates global value set translation keys
+ *
+ * @example
+ * ```javascript
+ * const { globalValueSetTranslations } = require('sfdx-easy-sources');
+ *
+ * // Using default settings from easysources-settings.json
+ * await globalValueSetTranslations.split();
+ *
+ * // Override specific paths
+ * await globalValueSetTranslations.upsert({
+ *   'sf-xml': './custom-metadata-path',
+ *   'es-csv': './custom-csv-path'
+ * });
+ * ```
+ */
+export declare const globalValueSetTranslations: {
+    /**
+     * Splits global value set translations into separate CSV files for easier management and version control.
+     * @param options Optional configuration, automatically resolved from settings if not provided
+     * @returns Promise resolving to operation result
+     */
+    split: (options?: GlobalValueSetTranslationOptions) => Promise<AnyJson>;
+    /**
+     * Updates or inserts global value set translation records from CSV files to Salesforce metadata format.
+     * @param options Optional configuration, automatically resolved from settings if not provided
+     * @returns Promise resolving to operation result
+     */
+    upsert: (options?: GlobalValueSetTranslationOptions) => Promise<AnyJson>;
+    /**
+     * Merges global value set translation CSV files back into unified metadata files.
+     * @param options Optional configuration, automatically resolved from settings if not provided
+     * @returns Promise resolving to operation result
+     */
+    merge: (options?: GlobalValueSetTranslationOptions) => Promise<AnyJson>;
+    /**
+     * Checks if global value set translations are aligned between different environments or sources.
+     * @param options Optional configuration, automatically resolved from settings if not provided
+     * @returns Promise resolving to alignment check result
+     */
+    areAligned: (options?: GlobalValueSetTranslationOptions) => Promise<AnyJson>;
+    /**
+     * Updates global value set translation keys based on configuration rules.
+     * @param options Optional configuration, automatically resolved from settings if not provided
+     * @returns Promise resolving to key update result
+     */
+    updateKey: (options?: GlobalValueSetTranslationOptions) => Promise<AnyJson>;
+};

package/lib/api/globalvaluesettranslations.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.globalValueSetTranslations = void 0;
+const split_1 = require("../commands/easysources/globalvaluesettranslations/split");
+const upsert_1 = require("../commands/easysources/globalvaluesettranslations/upsert");
+const merge_1 = require("../commands/easysources/globalvaluesettranslations/merge");
+const arealigned_1 = require("../commands/easysources/globalvaluesettranslations/arealigned");
+const updatekey_1 = require("../commands/easysources/globalvaluesettranslations/updatekey");
+/**
+ * Global Value Set Translations namespace containing all programmatic API functions for Salesforce Global Value Set Translation metadata operations.
+ *
+ * All methods automatically resolve paths from easysources-settings.json configuration file.
+ * You only need to provide options to override the default behavior.
+ *
+ * Available operations:
+ * - split(): Splits global value set translations into separate CSV files
+ * - upsert(): Updates or inserts global value set translation records
+ * - merge(): Merges global value set translation CSV files back to XML
+ * - areAligned(): Checks if global value set translations are aligned between environments
+ * - updateKey(): Updates global value set translation keys
+ *
+ * @example
+ * ```javascript
+ * const { globalValueSetTranslations } = require('sfdx-easy-sources');
+ *
+ * // Using default settings from easysources-settings.json
+ * await globalValueSetTranslations.split();
+ *
+ * // Override specific paths
+ * await globalValueSetTranslations.upsert({
+ *   'sf-xml': './custom-metadata-path',
+ *   'es-csv': './custom-csv-path'
+ * });
+ * ```
+ */
+exports.globalValueSetTranslations = {
+    /**
+     * Splits global value set translations into separate CSV files for easier management and version control.
+     * @param options Optional configuration, automatically resolved from settings if not provided
+     * @returns Promise resolving to operation result
+     */
+    split: async (options = {}) => {
+        return (0, split_1.globalValueSetTranslationSplit)(options);
+    },
+    /**
+     * Updates or inserts global value set translation records from CSV files to Salesforce metadata format.
+     * @param options Optional configuration, automatically resolved from settings if not provided
+     * @returns Promise resolving to operation result
+     */
+    upsert: async (options = {}) => {
+        return (0, upsert_1.globalValueSetTranslationUpsert)(options);
+    },
+    /**
+     * Merges global value set translation CSV files back into unified metadata files.
+     * @param options Optional configuration, automatically resolved from settings if not provided
+     * @returns Promise resolving to operation result
+     */
+    merge: async (options = {}) => {
+        return (0, merge_1.globalValueSetTranslationMerge)(options);
+    },
+    /**
+     * Checks if global value set translations are aligned between different environments or sources.
+     * @param options Optional configuration, automatically resolved from settings if not provided
+     * @returns Promise resolving to alignment check result
+     */
+    areAligned: async (options = {}) => {
+        return (0, arealigned_1.globalValueSetTranslationAreAligned)(options);
+    },
+    /**
+     * Updates global value set translation keys based on configuration rules.
+     * @param options Optional configuration, automatically resolved from settings if not provided
+     * @returns Promise resolving to key update result
+     */
+    updateKey: async (options = {}) => {
+        return (0, updatekey_1.globalValueSetTranslationUpdateKey)(options);
+    }
+};
+//# sourceMappingURL=globalvaluesettranslations.js.map

package/lib/api/globalvaluesettranslations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"globalvaluesettranslations.js","sourceRoot":"","sources":["../../src/api/globalvaluesettranslations.ts"],"names":[],"mappings":";;;AAEA,oFAA0G;AAC1G,sFAA4G;AAC5G,oFAA0G;AAC1G,8FAAoH;AACpH,4FAAkH;AAelH;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACU,QAAA,0BAA0B,GAAG;IACxC;;;;OAIG;IACH,KAAK,EAAE,KAAK,EAAE,UAA4C,EAAE,EAAoB,EAAE;QAChF,OAAO,IAAA,sCAA8B,EAAC,OAAO,CAAC,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACH,MAAM,EAAE,KAAK,EAAE,UAA4C,EAAE,EAAoB,EAAE;QACjF,OAAO,IAAA,wCAA+B,EAAC,OAAO,CAAC,CAAC;IAClD,CAAC;IAED;;;;OAIG;IACH,KAAK,EAAE,KAAK,EAAE,UAA4C,EAAE,EAAoB,EAAE;QAChF,OAAO,IAAA,sCAA8B,EAAC,OAAO,CAAC,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACH,UAAU,EAAE,KAAK,EAAE,UAA4C,EAAE,EAAoB,EAAE;QACrF,OAAO,IAAA,gDAAmC,EAAC,OAAO,CAAC,CAAC;IACtD,CAAC;IAED;;;;OAIG;IACH,SAAS,EAAE,KAAK,EAAE,UAA4C,EAAE,EAAoB,EAAE;QACpF,OAAO,IAAA,8CAAkC,EAAC,OAAO,CAAC,CAAC;IACrD,CAAC;CACF,CAAC"}