sfdx-easy-sources 0.7.7 → 0.8.0
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/README.md +52 -12
- package/lib/api/applications.d.ts +73 -0
- package/lib/api/applications.js +78 -0
- package/lib/api/applications.js.map +1 -0
- package/lib/api/globalvaluesets.d.ts +73 -0
- package/lib/api/globalvaluesets.js +78 -0
- package/lib/api/globalvaluesets.js.map +1 -0
- package/lib/api/globalvaluesettranslations.d.ts +73 -0
- package/lib/api/globalvaluesettranslations.js +78 -0
- package/lib/api/globalvaluesettranslations.js.map +1 -0
- package/lib/api/labels.d.ts +71 -0
- package/lib/api/labels.js +79 -0
- package/lib/api/labels.js.map +1 -0
- package/lib/api/objecttranslations.d.ts +81 -0
- package/lib/api/objecttranslations.js +89 -0
- package/lib/api/objecttranslations.js.map +1 -0
- package/lib/api/paths.d.ts +56 -0
- package/lib/api/paths.js +61 -0
- package/lib/api/paths.js.map +1 -0
- package/lib/api/permissionsets.d.ts +118 -0
- package/lib/api/permissionsets.js +119 -0
- package/lib/api/permissionsets.js.map +1 -0
- package/lib/api/profiles.d.ts +120 -0
- package/lib/api/profiles.js +119 -0
- package/lib/api/profiles.js.map +1 -0
- package/lib/api/recordtypes.d.ts +102 -0
- package/lib/api/recordtypes.js +99 -0
- package/lib/api/recordtypes.js.map +1 -0
- package/lib/api/translations.d.ts +80 -0
- package/lib/api/translations.js +89 -0
- package/lib/api/translations.js.map +1 -0
- package/lib/commands/easysources/applications/arealigned.d.ts +1 -0
- package/lib/commands/easysources/applications/arealigned.js +7 -7
- package/lib/commands/easysources/applications/arealigned.js.map +1 -1
- package/lib/commands/easysources/applications/merge.d.ts +1 -0
- package/lib/commands/easysources/applications/merge.js +7 -1
- package/lib/commands/easysources/applications/merge.js.map +1 -1
- package/lib/commands/easysources/applications/split.d.ts +1 -0
- package/lib/commands/easysources/applications/split.js +7 -1
- package/lib/commands/easysources/applications/split.js.map +1 -1
- package/lib/commands/easysources/applications/updatekey.d.ts +1 -0
- package/lib/commands/easysources/applications/updatekey.js +6 -0
- package/lib/commands/easysources/applications/updatekey.js.map +1 -1
- package/lib/commands/easysources/applications/upsert.d.ts +1 -0
- package/lib/commands/easysources/applications/upsert.js +7 -1
- package/lib/commands/easysources/applications/upsert.js.map +1 -1
- package/lib/commands/easysources/globalvaluesets/arealigned.d.ts +1 -0
- package/lib/commands/easysources/globalvaluesets/arealigned.js +7 -7
- package/lib/commands/easysources/globalvaluesets/arealigned.js.map +1 -1
- package/lib/commands/easysources/globalvaluesets/merge.d.ts +1 -0
- package/lib/commands/easysources/globalvaluesets/merge.js +7 -1
- package/lib/commands/easysources/globalvaluesets/merge.js.map +1 -1
- package/lib/commands/easysources/globalvaluesets/split.d.ts +1 -0
- package/lib/commands/easysources/globalvaluesets/split.js +6 -0
- package/lib/commands/easysources/globalvaluesets/split.js.map +1 -1
- package/lib/commands/easysources/globalvaluesets/updatekey.d.ts +1 -0
- package/lib/commands/easysources/globalvaluesets/updatekey.js +6 -0
- package/lib/commands/easysources/globalvaluesets/updatekey.js.map +1 -1
- package/lib/commands/easysources/globalvaluesets/upsert.d.ts +1 -0
- package/lib/commands/easysources/globalvaluesets/upsert.js +6 -0
- package/lib/commands/easysources/globalvaluesets/upsert.js.map +1 -1
- package/lib/commands/easysources/globalvaluesettranslations/arealigned.d.ts +1 -0
- package/lib/commands/easysources/globalvaluesettranslations/arealigned.js +7 -7
- package/lib/commands/easysources/globalvaluesettranslations/arealigned.js.map +1 -1
- package/lib/commands/easysources/globalvaluesettranslations/merge.d.ts +1 -0
- package/lib/commands/easysources/globalvaluesettranslations/merge.js +6 -0
- package/lib/commands/easysources/globalvaluesettranslations/merge.js.map +1 -1
- package/lib/commands/easysources/globalvaluesettranslations/split.d.ts +1 -0
- package/lib/commands/easysources/globalvaluesettranslations/split.js +6 -0
- package/lib/commands/easysources/globalvaluesettranslations/split.js.map +1 -1
- package/lib/commands/easysources/globalvaluesettranslations/updatekey.d.ts +1 -0
- package/lib/commands/easysources/globalvaluesettranslations/updatekey.js +6 -0
- package/lib/commands/easysources/globalvaluesettranslations/updatekey.js.map +1 -1
- package/lib/commands/easysources/globalvaluesettranslations/upsert.d.ts +1 -0
- package/lib/commands/easysources/globalvaluesettranslations/upsert.js +7 -1
- package/lib/commands/easysources/globalvaluesettranslations/upsert.js.map +1 -1
- package/lib/commands/easysources/labels/arealigned.d.ts +8 -1
- package/lib/commands/easysources/labels/arealigned.js +13 -11
- package/lib/commands/easysources/labels/arealigned.js.map +1 -1
- package/lib/commands/easysources/labels/merge.d.ts +8 -0
- package/lib/commands/easysources/labels/merge.js +13 -1
- package/lib/commands/easysources/labels/merge.js.map +1 -1
- package/lib/commands/easysources/labels/split.d.ts +8 -0
- package/lib/commands/easysources/labels/split.js +13 -1
- package/lib/commands/easysources/labels/split.js.map +1 -1
- package/lib/commands/easysources/labels/updatekey.d.ts +8 -0
- package/lib/commands/easysources/labels/updatekey.js +13 -1
- package/lib/commands/easysources/labels/updatekey.js.map +1 -1
- package/lib/commands/easysources/labels/upsert.d.ts +8 -0
- package/lib/commands/easysources/labels/upsert.js +13 -1
- package/lib/commands/easysources/labels/upsert.js.map +1 -1
- package/lib/commands/easysources/objecttranslations/arealigned.d.ts +16 -6
- package/lib/commands/easysources/objecttranslations/arealigned.js +328 -331
- package/lib/commands/easysources/objecttranslations/arealigned.js.map +1 -1
- package/lib/commands/easysources/objecttranslations/clearempty.d.ts +5 -0
- package/lib/commands/easysources/objecttranslations/clearempty.js +74 -65
- package/lib/commands/easysources/objecttranslations/clearempty.js.map +1 -1
- package/lib/commands/easysources/objecttranslations/merge.d.ts +3 -0
- package/lib/commands/easysources/objecttranslations/merge.js +47 -42
- package/lib/commands/easysources/objecttranslations/merge.js.map +1 -1
- package/lib/commands/easysources/objecttranslations/minify.d.ts +3 -0
- package/lib/commands/easysources/objecttranslations/minify.js +59 -53
- package/lib/commands/easysources/objecttranslations/minify.js.map +1 -1
- package/lib/commands/easysources/objecttranslations/split.d.ts +1 -0
- package/lib/commands/easysources/objecttranslations/split.js +87 -81
- package/lib/commands/easysources/objecttranslations/split.js.map +1 -1
- package/lib/commands/easysources/objecttranslations/upsert.d.ts +3 -0
- package/lib/commands/easysources/objecttranslations/upsert.js +111 -105
- package/lib/commands/easysources/objecttranslations/upsert.js.map +1 -1
- package/lib/commands/easysources/permissionsets/arealigned.d.ts +8 -0
- package/lib/commands/easysources/permissionsets/arealigned.js +13 -7
- package/lib/commands/easysources/permissionsets/arealigned.js.map +1 -1
- package/lib/commands/easysources/permissionsets/clean.d.ts +8 -0
- package/lib/commands/easysources/permissionsets/clean.js +144 -133
- package/lib/commands/easysources/permissionsets/clean.js.map +1 -1
- package/lib/commands/easysources/permissionsets/clearempty.d.ts +8 -0
- package/lib/commands/easysources/permissionsets/clearempty.js +13 -1
- package/lib/commands/easysources/permissionsets/clearempty.js.map +1 -1
- package/lib/commands/easysources/permissionsets/delete.d.ts +8 -0
- package/lib/commands/easysources/permissionsets/delete.js +64 -52
- package/lib/commands/easysources/permissionsets/delete.js.map +1 -1
- package/lib/commands/easysources/permissionsets/merge.d.ts +8 -0
- package/lib/commands/easysources/permissionsets/merge.js +13 -1
- package/lib/commands/easysources/permissionsets/merge.js.map +1 -1
- package/lib/commands/easysources/permissionsets/minify.d.ts +8 -0
- package/lib/commands/easysources/permissionsets/minify.js +65 -53
- package/lib/commands/easysources/permissionsets/minify.js.map +1 -1
- package/lib/commands/easysources/permissionsets/split.d.ts +8 -0
- package/lib/commands/easysources/permissionsets/split.js +13 -1
- package/lib/commands/easysources/permissionsets/split.js.map +1 -1
- package/lib/commands/easysources/permissionsets/updatekey.d.ts +8 -0
- package/lib/commands/easysources/permissionsets/updatekey.js +13 -1
- package/lib/commands/easysources/permissionsets/updatekey.js.map +1 -1
- package/lib/commands/easysources/permissionsets/upsert.d.ts +8 -0
- package/lib/commands/easysources/permissionsets/upsert.js +13 -1
- package/lib/commands/easysources/permissionsets/upsert.js.map +1 -1
- package/lib/commands/easysources/profiles/arealigned.d.ts +1 -0
- package/lib/commands/easysources/profiles/arealigned.js +7 -7
- package/lib/commands/easysources/profiles/arealigned.js.map +1 -1
- package/lib/commands/easysources/profiles/clean.d.ts +1 -0
- package/lib/commands/easysources/profiles/clean.js +137 -132
- package/lib/commands/easysources/profiles/clean.js.map +1 -1
- package/lib/commands/easysources/profiles/clearempty.d.ts +1 -0
- package/lib/commands/easysources/profiles/clearempty.js +7 -1
- package/lib/commands/easysources/profiles/clearempty.js.map +1 -1
- package/lib/commands/easysources/profiles/delete.d.ts +1 -0
- package/lib/commands/easysources/profiles/delete.js +57 -52
- package/lib/commands/easysources/profiles/delete.js.map +1 -1
- package/lib/commands/easysources/profiles/merge.d.ts +1 -0
- package/lib/commands/easysources/profiles/merge.js +7 -1
- package/lib/commands/easysources/profiles/merge.js.map +1 -1
- package/lib/commands/easysources/profiles/minify.d.ts +1 -0
- package/lib/commands/easysources/profiles/minify.js +59 -53
- package/lib/commands/easysources/profiles/minify.js.map +1 -1
- package/lib/commands/easysources/profiles/split.d.ts +8 -0
- package/lib/commands/easysources/profiles/split.js +13 -1
- package/lib/commands/easysources/profiles/split.js.map +1 -1
- package/lib/commands/easysources/profiles/updatekey.d.ts +1 -0
- package/lib/commands/easysources/profiles/updatekey.js +7 -1
- package/lib/commands/easysources/profiles/updatekey.js.map +1 -1
- package/lib/commands/easysources/profiles/upsert.d.ts +1 -0
- package/lib/commands/easysources/profiles/upsert.js +7 -1
- package/lib/commands/easysources/profiles/upsert.js.map +1 -1
- package/lib/commands/easysources/recordtypes/arealigned.d.ts +1 -4
- package/lib/commands/easysources/recordtypes/arealigned.js +214 -311
- package/lib/commands/easysources/recordtypes/arealigned.js.map +1 -1
- package/lib/commands/easysources/recordtypes/clean.d.ts +1 -0
- package/lib/commands/easysources/recordtypes/clean.js +122 -137
- package/lib/commands/easysources/recordtypes/clean.js.map +1 -1
- package/lib/commands/easysources/recordtypes/delete.d.ts +1 -0
- package/lib/commands/easysources/recordtypes/delete.js +76 -71
- package/lib/commands/easysources/recordtypes/delete.js.map +1 -1
- package/lib/commands/easysources/recordtypes/merge.d.ts +1 -0
- package/lib/commands/easysources/recordtypes/merge.js +48 -45
- package/lib/commands/easysources/recordtypes/merge.js.map +1 -1
- package/lib/commands/easysources/recordtypes/split.d.ts +1 -0
- package/lib/commands/easysources/recordtypes/split.js +82 -77
- package/lib/commands/easysources/recordtypes/split.js.map +1 -1
- package/lib/commands/easysources/recordtypes/updatekey.d.ts +1 -0
- package/lib/commands/easysources/recordtypes/updatekey.js +62 -57
- package/lib/commands/easysources/recordtypes/updatekey.js.map +1 -1
- package/lib/commands/easysources/recordtypes/upsert.d.ts +1 -0
- package/lib/commands/easysources/recordtypes/upsert.js +109 -104
- package/lib/commands/easysources/recordtypes/upsert.js.map +1 -1
- package/lib/commands/easysources/settings/init.js +1 -2
- package/lib/commands/easysources/settings/init.js.map +1 -1
- package/lib/commands/easysources/translations/arealigned.d.ts +1 -0
- package/lib/commands/easysources/translations/arealigned.js +7 -7
- package/lib/commands/easysources/translations/arealigned.js.map +1 -1
- package/lib/commands/easysources/translations/clearempty.d.ts +1 -0
- package/lib/commands/easysources/translations/clearempty.js +11 -0
- package/lib/commands/easysources/translations/clearempty.js.map +1 -1
- package/lib/commands/easysources/translations/merge.d.ts +1 -0
- package/lib/commands/easysources/translations/merge.js +6 -0
- package/lib/commands/easysources/translations/merge.js.map +1 -1
- package/lib/commands/easysources/translations/minify.d.ts +1 -0
- package/lib/commands/easysources/translations/minify.js +60 -53
- package/lib/commands/easysources/translations/minify.js.map +1 -1
- package/lib/commands/easysources/translations/split.d.ts +1 -0
- package/lib/commands/easysources/translations/split.js +7 -66
- package/lib/commands/easysources/translations/split.js.map +1 -1
- package/lib/commands/easysources/translations/upsert.d.ts +1 -0
- package/lib/commands/easysources/translations/upsert.js +6 -0
- package/lib/commands/easysources/translations/upsert.js.map +1 -1
- package/lib/index.d.ts +27 -1
- package/lib/index.js +48 -1
- package/lib/index.js.map +1 -1
- package/lib/utils/commands/alignmentChecker.d.ts +2 -5
- package/lib/utils/commands/alignmentChecker.js +57 -98
- package/lib/utils/commands/alignmentChecker.js.map +1 -1
- package/lib/utils/commands/keyupdater.js +1 -2
- package/lib/utils/commands/keyupdater.js.map +1 -1
- package/lib/utils/commands/splitter.js +1 -2
- package/lib/utils/commands/splitter.js.map +1 -1
- package/lib/utils/commands/upserter.js +1 -2
- package/lib/utils/commands/upserter.js.map +1 -1
- package/lib/utils/commands/utils.js +59 -36
- package/lib/utils/commands/utils.js.map +1 -1
- package/lib/utils/constants/constants_permissionsets.js +1 -1
- package/lib/utils/constants/constants_permissionsets.js.map +1 -1
- package/messages/permissionsets_clean.json +1 -1
- package/messages/profiles_clean.json +1 -1
- package/messages/recordtypes_clean.json +1 -1
- package/oclif.manifest.json +1 -1
- package/package.json +3 -1
package/README.md
CHANGED
|
@@ -25,18 +25,18 @@ With this plugin you can:
|
|
|
25
25
|
|
|
26
26
|
## Supported metadata types
|
|
27
27
|
|
|
28
|
-
| Metadata Label| Metadata api | Available commands |
|
|
29
|
-
| :---: | :---: | :---: |
|
|
30
|
-
| All Meta | allmeta | split, upsert, merge, minify, retrieve |
|
|
31
|
-
| Profiles | profiles | split, upsert, merge, minify, updatekey, delete, clean, clearempty, arealigned |
|
|
32
|
-
| Permission Sets | permissionsets | split, upsert, merge, minify, updatekey, delete, clean, clearempty, arealigned |
|
|
33
|
-
| Record Types | recordtypes | split, upsert, merge, updatekey, delete, clean, arealigned |
|
|
34
|
-
| Labels | labels | split, upsert, merge, updatekey, arealigned |
|
|
35
|
-
| Global Value Sets | globalvaluesets | split, upsert, merge, updatekey, arealigned |
|
|
36
|
-
| Global Value Set Translations | globalvaluesettranslations | split, upsert, merge, updatekey, arealigned |
|
|
37
|
-
| Applications | applications | split, upsert, merge, updatekey, arealigned |
|
|
38
|
-
| Object Translations | objecttranslations | split, upsert, merge, minify, updatekey, clearempty, arealigned |
|
|
39
|
-
| Translations | translations | split, upsert, merge, minify, updatekey, clearempty, arealigned |
|
|
28
|
+
| Metadata Label| Metadata api | Available commands | Programmatic API |
|
|
29
|
+
| :---: | :---: | :---: | :---: |
|
|
30
|
+
| All Meta | allmeta | split, upsert, merge, minify, retrieve | ❌ |
|
|
31
|
+
| Profiles | profiles | split, upsert, merge, minify, updatekey, delete, clean, clearempty, arealigned | ✅ **Complete** |
|
|
32
|
+
| Permission Sets | permissionsets | split, upsert, merge, minify, updatekey, delete, clean, clearempty, arealigned | ✅ **Complete** |
|
|
33
|
+
| Record Types | recordtypes | split, upsert, merge, updatekey, delete, clean, arealigned | ✅ **Complete** |
|
|
34
|
+
| Labels | labels | split, upsert, merge, updatekey, arealigned | ✅ **Complete** |
|
|
35
|
+
| Global Value Sets | globalvaluesets | split, upsert, merge, updatekey, arealigned | ✅ **Complete** |
|
|
36
|
+
| Global Value Set Translations | globalvaluesettranslations | split, upsert, merge, updatekey, arealigned | ✅ **Complete** |
|
|
37
|
+
| Applications | applications | split, upsert, merge, updatekey, arealigned | ✅ **Complete** |
|
|
38
|
+
| Object Translations | objecttranslations | split, upsert, merge, minify, updatekey, clearempty, arealigned | ✅ **Complete** |
|
|
39
|
+
| Translations | translations | split, upsert, merge, minify, updatekey, clearempty, arealigned | ✅ **Complete** |
|
|
40
40
|
|
|
41
41
|
|
|
42
42
|
|
|
@@ -54,6 +54,46 @@ Examples
|
|
|
54
54
|
...
|
|
55
55
|
```
|
|
56
56
|
|
|
57
|
+
## 🚀 Programmatic API Usage
|
|
58
|
+
|
|
59
|
+
**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.
|
|
60
|
+
|
|
61
|
+
```javascript
|
|
62
|
+
// JavaScript - Basic usage with automatic path resolution
|
|
63
|
+
const { profiles, permissionsets, labels, objectTranslations } = require('sfdx-easy-sources');
|
|
64
|
+
|
|
65
|
+
async function automateMetadata() {
|
|
66
|
+
// Paths auto-resolved from easysources-settings.json
|
|
67
|
+
await profiles.split({ input: 'Admin,Standard User' });
|
|
68
|
+
await profiles.upsert({ input: 'Admin' });
|
|
69
|
+
await profiles.merge({ input: 'Admin' });
|
|
70
|
+
|
|
71
|
+
// Same pattern for all metadata types
|
|
72
|
+
await permissionsets.split();
|
|
73
|
+
await labels.upsert();
|
|
74
|
+
await objectTranslations.minify();
|
|
75
|
+
}
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
```typescript
|
|
79
|
+
// TypeScript - Full type safety
|
|
80
|
+
import { profiles, ProfileOptions } from 'sfdx-easy-sources';
|
|
81
|
+
|
|
82
|
+
const options: ProfileOptions = {
|
|
83
|
+
input: 'Admin,Standard User',
|
|
84
|
+
ignoreuserperm: 'true'
|
|
85
|
+
};
|
|
86
|
+
await profiles.split(options);
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
**📚 Complete Documentation & Examples:** [API.md](./API.md)
|
|
90
|
+
|
|
91
|
+
### Key Features
|
|
92
|
+
- **🔧 Automatic Path Resolution**: Uses `easysources-settings.json` for defaults
|
|
93
|
+
- **⚙️ Full TypeScript Support**: Complete type definitions for all metadata types
|
|
94
|
+
- **🔄 Consistent API**: Identical patterns across all 9 supported metadata types
|
|
95
|
+
- **🎯 Zero Code Duplication**: CLI commands delegate to API functions
|
|
96
|
+
|
|
57
97
|
|
|
58
98
|
Based on the source type, this plugin provides the following commands:
|
|
59
99
|
- **Split**: Splits the resources into various CSV files, and creates an XML file containing all the tags that weren't split
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
import { AnyJson } from '@salesforce/ts-types';
|
|
2
|
+
import { PathOptions } from './paths';
|
|
3
|
+
/**
|
|
4
|
+
* Interface for Application operation options.
|
|
5
|
+
* All properties are optional and will be resolved automatically from easysources-settings.json if not provided.
|
|
6
|
+
*/
|
|
7
|
+
export interface ApplicationOptions extends PathOptions {
|
|
8
|
+
/** Input applications (comma-separated) */
|
|
9
|
+
input?: string;
|
|
10
|
+
/** Sort output (default: 'true') */
|
|
11
|
+
sort?: 'true' | 'false';
|
|
12
|
+
/** Mode for areAligned operation (default: 'string') */
|
|
13
|
+
mode?: 'string' | 'logic';
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* Application namespace containing all programmatic API functions for Salesforce Application metadata operations.
|
|
17
|
+
*
|
|
18
|
+
* All methods automatically resolve paths from easysources-settings.json configuration file.
|
|
19
|
+
* You only need to provide options to override the default behavior.
|
|
20
|
+
*
|
|
21
|
+
* Available operations:
|
|
22
|
+
* - split(): Splits applications into separate files
|
|
23
|
+
* - upsert(): Updates or inserts application records
|
|
24
|
+
* - merge(): Merges application files
|
|
25
|
+
* - areAligned(): Checks if applications are aligned between environments
|
|
26
|
+
* - updateKey(): Updates application keys
|
|
27
|
+
*
|
|
28
|
+
* @example
|
|
29
|
+
* ```javascript
|
|
30
|
+
* const { applications } = require('sfdx-easy-sources');
|
|
31
|
+
*
|
|
32
|
+
* // Using default settings from easysources-settings.json
|
|
33
|
+
* await applications.split();
|
|
34
|
+
*
|
|
35
|
+
* // Override specific paths
|
|
36
|
+
* await applications.upsert({
|
|
37
|
+
* 'sf-xml': './custom-metadata-path',
|
|
38
|
+
* 'es-csv': './custom-csv-path'
|
|
39
|
+
* });
|
|
40
|
+
* ```
|
|
41
|
+
*/
|
|
42
|
+
export declare const applications: {
|
|
43
|
+
/**
|
|
44
|
+
* Splits applications into separate files for easier management and version control.
|
|
45
|
+
* @param options Optional configuration, automatically resolved from settings if not provided
|
|
46
|
+
* @returns Promise resolving to operation result
|
|
47
|
+
*/
|
|
48
|
+
split: (options?: ApplicationOptions) => Promise<AnyJson>;
|
|
49
|
+
/**
|
|
50
|
+
* Updates or inserts application records from CSV files to Salesforce metadata format.
|
|
51
|
+
* @param options Optional configuration, automatically resolved from settings if not provided
|
|
52
|
+
* @returns Promise resolving to operation result
|
|
53
|
+
*/
|
|
54
|
+
upsert: (options?: ApplicationOptions) => Promise<AnyJson>;
|
|
55
|
+
/**
|
|
56
|
+
* Merges application files back into unified metadata files.
|
|
57
|
+
* @param options Optional configuration, automatically resolved from settings if not provided
|
|
58
|
+
* @returns Promise resolving to operation result
|
|
59
|
+
*/
|
|
60
|
+
merge: (options?: ApplicationOptions) => Promise<AnyJson>;
|
|
61
|
+
/**
|
|
62
|
+
* Checks if applications are aligned between different environments or sources.
|
|
63
|
+
* @param options Optional configuration, automatically resolved from settings if not provided
|
|
64
|
+
* @returns Promise resolving to alignment check result
|
|
65
|
+
*/
|
|
66
|
+
areAligned: (options?: ApplicationOptions) => Promise<AnyJson>;
|
|
67
|
+
/**
|
|
68
|
+
* Updates application keys based on configuration rules.
|
|
69
|
+
* @param options Optional configuration, automatically resolved from settings if not provided
|
|
70
|
+
* @returns Promise resolving to key update result
|
|
71
|
+
*/
|
|
72
|
+
updateKey: (options?: ApplicationOptions) => Promise<AnyJson>;
|
|
73
|
+
};
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.applications = void 0;
|
|
4
|
+
const split_1 = require("../commands/easysources/applications/split");
|
|
5
|
+
const upsert_1 = require("../commands/easysources/applications/upsert");
|
|
6
|
+
const merge_1 = require("../commands/easysources/applications/merge");
|
|
7
|
+
const arealigned_1 = require("../commands/easysources/applications/arealigned");
|
|
8
|
+
const updatekey_1 = require("../commands/easysources/applications/updatekey");
|
|
9
|
+
/**
|
|
10
|
+
* Application namespace containing all programmatic API functions for Salesforce Application metadata operations.
|
|
11
|
+
*
|
|
12
|
+
* All methods automatically resolve paths from easysources-settings.json configuration file.
|
|
13
|
+
* You only need to provide options to override the default behavior.
|
|
14
|
+
*
|
|
15
|
+
* Available operations:
|
|
16
|
+
* - split(): Splits applications into separate files
|
|
17
|
+
* - upsert(): Updates or inserts application records
|
|
18
|
+
* - merge(): Merges application files
|
|
19
|
+
* - areAligned(): Checks if applications are aligned between environments
|
|
20
|
+
* - updateKey(): Updates application keys
|
|
21
|
+
*
|
|
22
|
+
* @example
|
|
23
|
+
* ```javascript
|
|
24
|
+
* const { applications } = require('sfdx-easy-sources');
|
|
25
|
+
*
|
|
26
|
+
* // Using default settings from easysources-settings.json
|
|
27
|
+
* await applications.split();
|
|
28
|
+
*
|
|
29
|
+
* // Override specific paths
|
|
30
|
+
* await applications.upsert({
|
|
31
|
+
* 'sf-xml': './custom-metadata-path',
|
|
32
|
+
* 'es-csv': './custom-csv-path'
|
|
33
|
+
* });
|
|
34
|
+
* ```
|
|
35
|
+
*/
|
|
36
|
+
exports.applications = {
|
|
37
|
+
/**
|
|
38
|
+
* Splits applications into separate files for easier management and version control.
|
|
39
|
+
* @param options Optional configuration, automatically resolved from settings if not provided
|
|
40
|
+
* @returns Promise resolving to operation result
|
|
41
|
+
*/
|
|
42
|
+
split: async (options = {}) => {
|
|
43
|
+
return (0, split_1.applicationSplit)(options);
|
|
44
|
+
},
|
|
45
|
+
/**
|
|
46
|
+
* Updates or inserts application records from CSV files to Salesforce metadata format.
|
|
47
|
+
* @param options Optional configuration, automatically resolved from settings if not provided
|
|
48
|
+
* @returns Promise resolving to operation result
|
|
49
|
+
*/
|
|
50
|
+
upsert: async (options = {}) => {
|
|
51
|
+
return (0, upsert_1.applicationUpsert)(options);
|
|
52
|
+
},
|
|
53
|
+
/**
|
|
54
|
+
* Merges application files back into unified metadata files.
|
|
55
|
+
* @param options Optional configuration, automatically resolved from settings if not provided
|
|
56
|
+
* @returns Promise resolving to operation result
|
|
57
|
+
*/
|
|
58
|
+
merge: async (options = {}) => {
|
|
59
|
+
return (0, merge_1.applicationMerge)(options);
|
|
60
|
+
},
|
|
61
|
+
/**
|
|
62
|
+
* Checks if applications are aligned between different environments or sources.
|
|
63
|
+
* @param options Optional configuration, automatically resolved from settings if not provided
|
|
64
|
+
* @returns Promise resolving to alignment check result
|
|
65
|
+
*/
|
|
66
|
+
areAligned: async (options = {}) => {
|
|
67
|
+
return (0, arealigned_1.applicationAreAligned)(options);
|
|
68
|
+
},
|
|
69
|
+
/**
|
|
70
|
+
* Updates application keys based on configuration rules.
|
|
71
|
+
* @param options Optional configuration, automatically resolved from settings if not provided
|
|
72
|
+
* @returns Promise resolving to key update result
|
|
73
|
+
*/
|
|
74
|
+
updateKey: async (options = {}) => {
|
|
75
|
+
return (0, updatekey_1.applicationUpdateKey)(options);
|
|
76
|
+
}
|
|
77
|
+
};
|
|
78
|
+
//# sourceMappingURL=applications.js.map
|
|
@@ -0,0 +1 @@
|
|
|
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"}
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
import { AnyJson } from '@salesforce/ts-types';
|
|
2
|
+
import { PathOptions } from './paths';
|
|
3
|
+
/**
|
|
4
|
+
* Interface for Global Value Set operation options.
|
|
5
|
+
* All properties are optional and will be resolved automatically from easysources-settings.json if not provided.
|
|
6
|
+
*/
|
|
7
|
+
export interface GlobalValueSetOptions extends PathOptions {
|
|
8
|
+
/** Input global value sets (comma-separated) */
|
|
9
|
+
input?: string;
|
|
10
|
+
/** Sort output (default: 'false') */
|
|
11
|
+
sort?: 'true' | 'false';
|
|
12
|
+
/** Mode for areAligned operation (default: 'string') */
|
|
13
|
+
mode?: 'string' | 'logic';
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* Global Value Sets namespace containing all programmatic API functions for Salesforce Global Value Set metadata operations.
|
|
17
|
+
*
|
|
18
|
+
* All methods automatically resolve paths from easysources-settings.json configuration file.
|
|
19
|
+
* You only need to provide options to override the default behavior.
|
|
20
|
+
*
|
|
21
|
+
* Available operations:
|
|
22
|
+
* - split(): Splits global value sets into separate CSV files
|
|
23
|
+
* - upsert(): Updates or inserts global value set records
|
|
24
|
+
* - merge(): Merges global value set CSV files back to XML
|
|
25
|
+
* - areAligned(): Checks if global value sets are aligned between environments
|
|
26
|
+
* - updateKey(): Updates global value set keys
|
|
27
|
+
*
|
|
28
|
+
* @example
|
|
29
|
+
* ```javascript
|
|
30
|
+
* const { globalValueSets } = require('sfdx-easy-sources');
|
|
31
|
+
*
|
|
32
|
+
* // Using default settings from easysources-settings.json
|
|
33
|
+
* await globalValueSets.split();
|
|
34
|
+
*
|
|
35
|
+
* // Override specific paths
|
|
36
|
+
* await globalValueSets.upsert({
|
|
37
|
+
* 'sf-xml': './custom-metadata-path',
|
|
38
|
+
* 'es-csv': './custom-csv-path'
|
|
39
|
+
* });
|
|
40
|
+
* ```
|
|
41
|
+
*/
|
|
42
|
+
export declare const globalValueSets: {
|
|
43
|
+
/**
|
|
44
|
+
* Splits global value sets into separate CSV files for easier management and version control.
|
|
45
|
+
* @param options Optional configuration, automatically resolved from settings if not provided
|
|
46
|
+
* @returns Promise resolving to operation result
|
|
47
|
+
*/
|
|
48
|
+
split: (options?: GlobalValueSetOptions) => Promise<AnyJson>;
|
|
49
|
+
/**
|
|
50
|
+
* Updates or inserts global value set records from CSV files to Salesforce metadata format.
|
|
51
|
+
* @param options Optional configuration, automatically resolved from settings if not provided
|
|
52
|
+
* @returns Promise resolving to operation result
|
|
53
|
+
*/
|
|
54
|
+
upsert: (options?: GlobalValueSetOptions) => Promise<AnyJson>;
|
|
55
|
+
/**
|
|
56
|
+
* Merges global value set CSV files back into unified metadata files.
|
|
57
|
+
* @param options Optional configuration, automatically resolved from settings if not provided
|
|
58
|
+
* @returns Promise resolving to operation result
|
|
59
|
+
*/
|
|
60
|
+
merge: (options?: GlobalValueSetOptions) => Promise<AnyJson>;
|
|
61
|
+
/**
|
|
62
|
+
* Checks if global value sets are aligned between different environments or sources.
|
|
63
|
+
* @param options Optional configuration, automatically resolved from settings if not provided
|
|
64
|
+
* @returns Promise resolving to alignment check result
|
|
65
|
+
*/
|
|
66
|
+
areAligned: (options?: GlobalValueSetOptions) => Promise<AnyJson>;
|
|
67
|
+
/**
|
|
68
|
+
* Updates global value set keys based on configuration rules.
|
|
69
|
+
* @param options Optional configuration, automatically resolved from settings if not provided
|
|
70
|
+
* @returns Promise resolving to key update result
|
|
71
|
+
*/
|
|
72
|
+
updateKey: (options?: GlobalValueSetOptions) => Promise<AnyJson>;
|
|
73
|
+
};
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.globalValueSets = void 0;
|
|
4
|
+
const split_1 = require("../commands/easysources/globalvaluesets/split");
|
|
5
|
+
const upsert_1 = require("../commands/easysources/globalvaluesets/upsert");
|
|
6
|
+
const merge_1 = require("../commands/easysources/globalvaluesets/merge");
|
|
7
|
+
const arealigned_1 = require("../commands/easysources/globalvaluesets/arealigned");
|
|
8
|
+
const updatekey_1 = require("../commands/easysources/globalvaluesets/updatekey");
|
|
9
|
+
/**
|
|
10
|
+
* Global Value Sets namespace containing all programmatic API functions for Salesforce Global Value Set metadata operations.
|
|
11
|
+
*
|
|
12
|
+
* All methods automatically resolve paths from easysources-settings.json configuration file.
|
|
13
|
+
* You only need to provide options to override the default behavior.
|
|
14
|
+
*
|
|
15
|
+
* Available operations:
|
|
16
|
+
* - split(): Splits global value sets into separate CSV files
|
|
17
|
+
* - upsert(): Updates or inserts global value set records
|
|
18
|
+
* - merge(): Merges global value set CSV files back to XML
|
|
19
|
+
* - areAligned(): Checks if global value sets are aligned between environments
|
|
20
|
+
* - updateKey(): Updates global value set keys
|
|
21
|
+
*
|
|
22
|
+
* @example
|
|
23
|
+
* ```javascript
|
|
24
|
+
* const { globalValueSets } = require('sfdx-easy-sources');
|
|
25
|
+
*
|
|
26
|
+
* // Using default settings from easysources-settings.json
|
|
27
|
+
* await globalValueSets.split();
|
|
28
|
+
*
|
|
29
|
+
* // Override specific paths
|
|
30
|
+
* await globalValueSets.upsert({
|
|
31
|
+
* 'sf-xml': './custom-metadata-path',
|
|
32
|
+
* 'es-csv': './custom-csv-path'
|
|
33
|
+
* });
|
|
34
|
+
* ```
|
|
35
|
+
*/
|
|
36
|
+
exports.globalValueSets = {
|
|
37
|
+
/**
|
|
38
|
+
* Splits global value sets into separate CSV files for easier management and version control.
|
|
39
|
+
* @param options Optional configuration, automatically resolved from settings if not provided
|
|
40
|
+
* @returns Promise resolving to operation result
|
|
41
|
+
*/
|
|
42
|
+
split: async (options = {}) => {
|
|
43
|
+
return (0, split_1.globalValueSetSplit)(options);
|
|
44
|
+
},
|
|
45
|
+
/**
|
|
46
|
+
* Updates or inserts global value set records from CSV files to Salesforce metadata format.
|
|
47
|
+
* @param options Optional configuration, automatically resolved from settings if not provided
|
|
48
|
+
* @returns Promise resolving to operation result
|
|
49
|
+
*/
|
|
50
|
+
upsert: async (options = {}) => {
|
|
51
|
+
return (0, upsert_1.globalValueSetUpsert)(options);
|
|
52
|
+
},
|
|
53
|
+
/**
|
|
54
|
+
* Merges global value set CSV files back into unified metadata files.
|
|
55
|
+
* @param options Optional configuration, automatically resolved from settings if not provided
|
|
56
|
+
* @returns Promise resolving to operation result
|
|
57
|
+
*/
|
|
58
|
+
merge: async (options = {}) => {
|
|
59
|
+
return (0, merge_1.globalValueSetMerge)(options);
|
|
60
|
+
},
|
|
61
|
+
/**
|
|
62
|
+
* Checks if global value sets are aligned between different environments or sources.
|
|
63
|
+
* @param options Optional configuration, automatically resolved from settings if not provided
|
|
64
|
+
* @returns Promise resolving to alignment check result
|
|
65
|
+
*/
|
|
66
|
+
areAligned: async (options = {}) => {
|
|
67
|
+
return (0, arealigned_1.globalValueSetAreAligned)(options);
|
|
68
|
+
},
|
|
69
|
+
/**
|
|
70
|
+
* Updates global value set keys based on configuration rules.
|
|
71
|
+
* @param options Optional configuration, automatically resolved from settings if not provided
|
|
72
|
+
* @returns Promise resolving to key update result
|
|
73
|
+
*/
|
|
74
|
+
updateKey: async (options = {}) => {
|
|
75
|
+
return (0, updatekey_1.globalValueSetUpdateKey)(options);
|
|
76
|
+
}
|
|
77
|
+
};
|
|
78
|
+
//# sourceMappingURL=globalvaluesets.js.map
|
|
@@ -0,0 +1 @@
|
|
|
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"}
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
import { AnyJson } from '@salesforce/ts-types';
|
|
2
|
+
import { PathOptions } from './paths';
|
|
3
|
+
/**
|
|
4
|
+
* Interface for Global Value Set Translation operation options.
|
|
5
|
+
* All properties are optional and will be resolved automatically from easysources-settings.json if not provided.
|
|
6
|
+
*/
|
|
7
|
+
export interface GlobalValueSetTranslationOptions extends PathOptions {
|
|
8
|
+
/** Input global value set translations (comma-separated) */
|
|
9
|
+
input?: string;
|
|
10
|
+
/** Sort output (default: 'false') */
|
|
11
|
+
sort?: 'true' | 'false';
|
|
12
|
+
/** Mode for areAligned operation (default: 'string') */
|
|
13
|
+
mode?: 'string' | 'logic';
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* Global Value Set Translations namespace containing all programmatic API functions for Salesforce Global Value Set Translation metadata operations.
|
|
17
|
+
*
|
|
18
|
+
* All methods automatically resolve paths from easysources-settings.json configuration file.
|
|
19
|
+
* You only need to provide options to override the default behavior.
|
|
20
|
+
*
|
|
21
|
+
* Available operations:
|
|
22
|
+
* - split(): Splits global value set translations into separate CSV files
|
|
23
|
+
* - upsert(): Updates or inserts global value set translation records
|
|
24
|
+
* - merge(): Merges global value set translation CSV files back to XML
|
|
25
|
+
* - areAligned(): Checks if global value set translations are aligned between environments
|
|
26
|
+
* - updateKey(): Updates global value set translation keys
|
|
27
|
+
*
|
|
28
|
+
* @example
|
|
29
|
+
* ```javascript
|
|
30
|
+
* const { globalValueSetTranslations } = require('sfdx-easy-sources');
|
|
31
|
+
*
|
|
32
|
+
* // Using default settings from easysources-settings.json
|
|
33
|
+
* await globalValueSetTranslations.split();
|
|
34
|
+
*
|
|
35
|
+
* // Override specific paths
|
|
36
|
+
* await globalValueSetTranslations.upsert({
|
|
37
|
+
* 'sf-xml': './custom-metadata-path',
|
|
38
|
+
* 'es-csv': './custom-csv-path'
|
|
39
|
+
* });
|
|
40
|
+
* ```
|
|
41
|
+
*/
|
|
42
|
+
export declare const globalValueSetTranslations: {
|
|
43
|
+
/**
|
|
44
|
+
* Splits global value set translations into separate CSV files for easier management and version control.
|
|
45
|
+
* @param options Optional configuration, automatically resolved from settings if not provided
|
|
46
|
+
* @returns Promise resolving to operation result
|
|
47
|
+
*/
|
|
48
|
+
split: (options?: GlobalValueSetTranslationOptions) => Promise<AnyJson>;
|
|
49
|
+
/**
|
|
50
|
+
* Updates or inserts global value set translation records from CSV files to Salesforce metadata format.
|
|
51
|
+
* @param options Optional configuration, automatically resolved from settings if not provided
|
|
52
|
+
* @returns Promise resolving to operation result
|
|
53
|
+
*/
|
|
54
|
+
upsert: (options?: GlobalValueSetTranslationOptions) => Promise<AnyJson>;
|
|
55
|
+
/**
|
|
56
|
+
* Merges global value set translation CSV files back into unified metadata files.
|
|
57
|
+
* @param options Optional configuration, automatically resolved from settings if not provided
|
|
58
|
+
* @returns Promise resolving to operation result
|
|
59
|
+
*/
|
|
60
|
+
merge: (options?: GlobalValueSetTranslationOptions) => Promise<AnyJson>;
|
|
61
|
+
/**
|
|
62
|
+
* Checks if global value set translations are aligned between different environments or sources.
|
|
63
|
+
* @param options Optional configuration, automatically resolved from settings if not provided
|
|
64
|
+
* @returns Promise resolving to alignment check result
|
|
65
|
+
*/
|
|
66
|
+
areAligned: (options?: GlobalValueSetTranslationOptions) => Promise<AnyJson>;
|
|
67
|
+
/**
|
|
68
|
+
* Updates global value set translation keys based on configuration rules.
|
|
69
|
+
* @param options Optional configuration, automatically resolved from settings if not provided
|
|
70
|
+
* @returns Promise resolving to key update result
|
|
71
|
+
*/
|
|
72
|
+
updateKey: (options?: GlobalValueSetTranslationOptions) => Promise<AnyJson>;
|
|
73
|
+
};
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.globalValueSetTranslations = void 0;
|
|
4
|
+
const split_1 = require("../commands/easysources/globalvaluesettranslations/split");
|
|
5
|
+
const upsert_1 = require("../commands/easysources/globalvaluesettranslations/upsert");
|
|
6
|
+
const merge_1 = require("../commands/easysources/globalvaluesettranslations/merge");
|
|
7
|
+
const arealigned_1 = require("../commands/easysources/globalvaluesettranslations/arealigned");
|
|
8
|
+
const updatekey_1 = require("../commands/easysources/globalvaluesettranslations/updatekey");
|
|
9
|
+
/**
|
|
10
|
+
* Global Value Set Translations namespace containing all programmatic API functions for Salesforce Global Value Set Translation metadata operations.
|
|
11
|
+
*
|
|
12
|
+
* All methods automatically resolve paths from easysources-settings.json configuration file.
|
|
13
|
+
* You only need to provide options to override the default behavior.
|
|
14
|
+
*
|
|
15
|
+
* Available operations:
|
|
16
|
+
* - split(): Splits global value set translations into separate CSV files
|
|
17
|
+
* - upsert(): Updates or inserts global value set translation records
|
|
18
|
+
* - merge(): Merges global value set translation CSV files back to XML
|
|
19
|
+
* - areAligned(): Checks if global value set translations are aligned between environments
|
|
20
|
+
* - updateKey(): Updates global value set translation keys
|
|
21
|
+
*
|
|
22
|
+
* @example
|
|
23
|
+
* ```javascript
|
|
24
|
+
* const { globalValueSetTranslations } = require('sfdx-easy-sources');
|
|
25
|
+
*
|
|
26
|
+
* // Using default settings from easysources-settings.json
|
|
27
|
+
* await globalValueSetTranslations.split();
|
|
28
|
+
*
|
|
29
|
+
* // Override specific paths
|
|
30
|
+
* await globalValueSetTranslations.upsert({
|
|
31
|
+
* 'sf-xml': './custom-metadata-path',
|
|
32
|
+
* 'es-csv': './custom-csv-path'
|
|
33
|
+
* });
|
|
34
|
+
* ```
|
|
35
|
+
*/
|
|
36
|
+
exports.globalValueSetTranslations = {
|
|
37
|
+
/**
|
|
38
|
+
* Splits global value set translations into separate CSV files for easier management and version control.
|
|
39
|
+
* @param options Optional configuration, automatically resolved from settings if not provided
|
|
40
|
+
* @returns Promise resolving to operation result
|
|
41
|
+
*/
|
|
42
|
+
split: async (options = {}) => {
|
|
43
|
+
return (0, split_1.globalValueSetTranslationSplit)(options);
|
|
44
|
+
},
|
|
45
|
+
/**
|
|
46
|
+
* Updates or inserts global value set translation records from CSV files to Salesforce metadata format.
|
|
47
|
+
* @param options Optional configuration, automatically resolved from settings if not provided
|
|
48
|
+
* @returns Promise resolving to operation result
|
|
49
|
+
*/
|
|
50
|
+
upsert: async (options = {}) => {
|
|
51
|
+
return (0, upsert_1.globalValueSetTranslationUpsert)(options);
|
|
52
|
+
},
|
|
53
|
+
/**
|
|
54
|
+
* Merges global value set translation CSV files back into unified metadata files.
|
|
55
|
+
* @param options Optional configuration, automatically resolved from settings if not provided
|
|
56
|
+
* @returns Promise resolving to operation result
|
|
57
|
+
*/
|
|
58
|
+
merge: async (options = {}) => {
|
|
59
|
+
return (0, merge_1.globalValueSetTranslationMerge)(options);
|
|
60
|
+
},
|
|
61
|
+
/**
|
|
62
|
+
* Checks if global value set translations are aligned between different environments or sources.
|
|
63
|
+
* @param options Optional configuration, automatically resolved from settings if not provided
|
|
64
|
+
* @returns Promise resolving to alignment check result
|
|
65
|
+
*/
|
|
66
|
+
areAligned: async (options = {}) => {
|
|
67
|
+
return (0, arealigned_1.globalValueSetTranslationAreAligned)(options);
|
|
68
|
+
},
|
|
69
|
+
/**
|
|
70
|
+
* Updates global value set translation keys based on configuration rules.
|
|
71
|
+
* @param options Optional configuration, automatically resolved from settings if not provided
|
|
72
|
+
* @returns Promise resolving to key update result
|
|
73
|
+
*/
|
|
74
|
+
updateKey: async (options = {}) => {
|
|
75
|
+
return (0, updatekey_1.globalValueSetTranslationUpdateKey)(options);
|
|
76
|
+
}
|
|
77
|
+
};
|
|
78
|
+
//# sourceMappingURL=globalvaluesettranslations.js.map
|
|
@@ -0,0 +1 @@
|
|
|
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"}
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
import { AnyJson } from '@salesforce/ts-types';
|
|
2
|
+
import { PathOptions } from './paths';
|
|
3
|
+
/**
|
|
4
|
+
* Label-specific options interface
|
|
5
|
+
* Extends the common PathOptions with label-specific settings
|
|
6
|
+
*/
|
|
7
|
+
export interface LabelOptions extends PathOptions {
|
|
8
|
+
/** Sort output (default: 'false') */
|
|
9
|
+
sort?: 'true' | 'false';
|
|
10
|
+
/** Mode for areAligned operation (default: 'string') */
|
|
11
|
+
mode?: 'string' | 'logic';
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* Labels namespace containing all programmatic API functions for Salesforce Custom Label metadata operations.
|
|
15
|
+
*
|
|
16
|
+
* All methods automatically resolve paths from easysources-settings.json configuration file.
|
|
17
|
+
* You only need to provide options to override the default behavior.
|
|
18
|
+
*
|
|
19
|
+
* Available operations:
|
|
20
|
+
* - split(): Splits custom labels into separate CSV files
|
|
21
|
+
* - upsert(): Updates or inserts label records from XML to CSV
|
|
22
|
+
* - merge(): Merges label CSV files back to XML
|
|
23
|
+
* - areAligned(): Checks if labels are aligned between XML and CSV
|
|
24
|
+
* - updateKey(): Updates label keys in CSV files
|
|
25
|
+
*
|
|
26
|
+
* @example
|
|
27
|
+
* ```javascript
|
|
28
|
+
* const { labels } = require('sfdx-easy-sources');
|
|
29
|
+
*
|
|
30
|
+
* // Using default settings from easysources-settings.json
|
|
31
|
+
* await labels.split();
|
|
32
|
+
*
|
|
33
|
+
* // Override specific paths
|
|
34
|
+
* await labels.upsert({
|
|
35
|
+
* 'sf-xml': './custom-metadata-path',
|
|
36
|
+
* 'es-csv': './custom-csv-path'
|
|
37
|
+
* });
|
|
38
|
+
* ```
|
|
39
|
+
*/
|
|
40
|
+
export declare const labels: {
|
|
41
|
+
/**
|
|
42
|
+
* Splits custom labels into separate CSV files for easier management and version control.
|
|
43
|
+
* @param options Optional configuration, automatically resolved from settings if not provided
|
|
44
|
+
* @returns Promise resolving to operation result
|
|
45
|
+
*/
|
|
46
|
+
split: (options?: LabelOptions) => Promise<AnyJson>;
|
|
47
|
+
/**
|
|
48
|
+
* Updates or inserts label records from XML to CSV format.
|
|
49
|
+
* @param options Optional configuration, automatically resolved from settings if not provided
|
|
50
|
+
* @returns Promise resolving to operation result
|
|
51
|
+
*/
|
|
52
|
+
upsert: (options?: LabelOptions) => Promise<AnyJson>;
|
|
53
|
+
/**
|
|
54
|
+
* Merges label CSV files back into unified XML metadata files.
|
|
55
|
+
* @param options Optional configuration, automatically resolved from settings if not provided
|
|
56
|
+
* @returns Promise resolving to operation result
|
|
57
|
+
*/
|
|
58
|
+
merge: (options?: LabelOptions) => Promise<AnyJson>;
|
|
59
|
+
/**
|
|
60
|
+
* Checks if labels are aligned between different environments or sources.
|
|
61
|
+
* @param options Optional configuration, automatically resolved from settings if not provided
|
|
62
|
+
* @returns Promise resolving to alignment check result
|
|
63
|
+
*/
|
|
64
|
+
areAligned: (options?: LabelOptions) => Promise<AnyJson>;
|
|
65
|
+
/**
|
|
66
|
+
* Updates label keys based on configuration rules.
|
|
67
|
+
* @param options Optional configuration, automatically resolved from settings if not provided
|
|
68
|
+
* @returns Promise resolving to key update result
|
|
69
|
+
*/
|
|
70
|
+
updateKey: (options?: LabelOptions) => Promise<AnyJson>;
|
|
71
|
+
};
|