sfdx-hardis 6.14.5-alpha202512081801.0 → 6.15.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/CHANGELOG.md +2 -0
- package/oclif.manifest.json +704 -704
- package/package.json +1 -1
package/oclif.manifest.json
CHANGED
|
@@ -57,12 +57,13 @@
|
|
|
57
57
|
"world:hello"
|
|
58
58
|
]
|
|
59
59
|
},
|
|
60
|
-
"hardis:
|
|
60
|
+
"hardis:auth:login": {
|
|
61
61
|
"aliases": [],
|
|
62
62
|
"args": {},
|
|
63
|
-
"description": "\n## Command Behavior\n\n**
|
|
63
|
+
"description": "\n## Command Behavior\n\n**Authenticates to a Salesforce org, primarily designed for CI/CD workflows.**\n\nThis command facilitates secure and automated logins to Salesforce organizations within continuous integration and continuous delivery pipelines. It leverages pre-configured authentication details, ensuring that CI/CD processes can interact with Salesforce without manual intervention.\n\nKey aspects:\n\n- **Configuration-Driven:** It relies on authentication variables and files set up by dedicated configuration commands:\n - For CI/CD repositories: [Configure Org CI Authentication](https://sfdx-hardis.cloudity.com/hardis/project/configure/auth/)\n - For Monitoring repositories: [Configure Org Monitoring](https://sfdx-hardis.cloudity.com/hardis/org/configure/monitoring/)\n- **Technical Org Support:** Supports authentication to a 'technical org' (e.g., for calling Agentforce from another org) by utilizing the `SFDX_AUTH_URL_TECHNICAL_ORG` environment variable. If this variable is set, the command authenticates to this org with the alias `TECHNICAL_ORG`.\n\nTo obtain the `SFDX_AUTH_URL_TECHNICAL_ORG` value, you can run `sf org display --verbose --json` and copy the `sfdxAuthUrl` field from the output.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical flow involves:\n\n- **Flag Parsing:** It parses command-line flags such as `instanceurl`, `devhub`, `scratchorg`, and `debug` to determine the authentication context.\n- **Authentication Hook:** It triggers an internal authentication hook (`this.config.runHook('auth', ...`)) which is responsible for executing the actual authentication logic based on the provided flags (e.g., whether it's a Dev Hub or a scratch org).\n- **Environment Variable Check:** It checks for the presence of `SFDX_AUTH_URL_TECHNICAL_ORG` or `TECHNICAL_ORG_ALIAS` environment variables.\n- **`authOrg` Utility:** If a technical org is configured, it calls the `authOrg` utility function to perform the authentication for that specific org, ensuring it's connected and available for subsequent operations.\n- **Salesforce CLI Integration:** It integrates with the Salesforce CLI's authentication mechanisms to establish and manage org connections.\n</details>\n",
|
|
64
64
|
"examples": [
|
|
65
|
-
"$ sf hardis:
|
|
65
|
+
"$ sf hardis:auth:login",
|
|
66
|
+
"CI=true CI_COMMIT_REF_NAME=monitoring_myclient sf hardis:auth:login"
|
|
66
67
|
],
|
|
67
68
|
"flags": {
|
|
68
69
|
"json": {
|
|
@@ -80,6 +81,28 @@
|
|
|
80
81
|
"multiple": false,
|
|
81
82
|
"type": "option"
|
|
82
83
|
},
|
|
84
|
+
"instanceurl": {
|
|
85
|
+
"char": "r",
|
|
86
|
+
"description": "URL of org instance",
|
|
87
|
+
"name": "instanceurl",
|
|
88
|
+
"hasDynamicHelp": false,
|
|
89
|
+
"multiple": false,
|
|
90
|
+
"type": "option"
|
|
91
|
+
},
|
|
92
|
+
"devhub": {
|
|
93
|
+
"char": "h",
|
|
94
|
+
"description": "Also connect associated DevHub",
|
|
95
|
+
"name": "devhub",
|
|
96
|
+
"allowNo": false,
|
|
97
|
+
"type": "boolean"
|
|
98
|
+
},
|
|
99
|
+
"scratchorg": {
|
|
100
|
+
"char": "s",
|
|
101
|
+
"description": "Scratch org",
|
|
102
|
+
"name": "scratchorg",
|
|
103
|
+
"allowNo": false,
|
|
104
|
+
"type": "boolean"
|
|
105
|
+
},
|
|
83
106
|
"debug": {
|
|
84
107
|
"char": "d",
|
|
85
108
|
"description": "Activate debug mode (more logs)",
|
|
@@ -103,41 +126,38 @@
|
|
|
103
126
|
},
|
|
104
127
|
"hasDynamicHelp": false,
|
|
105
128
|
"hiddenAliases": [],
|
|
106
|
-
"id": "hardis:
|
|
129
|
+
"id": "hardis:auth:login",
|
|
107
130
|
"pluginAlias": "sfdx-hardis",
|
|
108
131
|
"pluginName": "sfdx-hardis",
|
|
109
132
|
"pluginType": "core",
|
|
110
133
|
"strict": true,
|
|
111
134
|
"enableJsonFlag": true,
|
|
112
|
-
"title": "
|
|
113
|
-
"uiConfig": {
|
|
114
|
-
"hide": true
|
|
115
|
-
},
|
|
135
|
+
"title": "Login",
|
|
116
136
|
"requiresProject": false,
|
|
117
137
|
"isESM": true,
|
|
118
138
|
"relativePath": [
|
|
119
139
|
"lib",
|
|
120
140
|
"commands",
|
|
121
141
|
"hardis",
|
|
122
|
-
"
|
|
123
|
-
"
|
|
142
|
+
"auth",
|
|
143
|
+
"login.js"
|
|
124
144
|
],
|
|
125
145
|
"aliasPermutations": [],
|
|
126
146
|
"permutations": [
|
|
127
|
-
"hardis:
|
|
128
|
-
"
|
|
129
|
-
"
|
|
130
|
-
"hardis:
|
|
131
|
-
"
|
|
132
|
-
"
|
|
147
|
+
"hardis:auth:login",
|
|
148
|
+
"auth:hardis:login",
|
|
149
|
+
"auth:login:hardis",
|
|
150
|
+
"hardis:login:auth",
|
|
151
|
+
"login:hardis:auth",
|
|
152
|
+
"login:auth:hardis"
|
|
133
153
|
]
|
|
134
154
|
},
|
|
135
|
-
"hardis:
|
|
155
|
+
"hardis:cache:clear": {
|
|
136
156
|
"aliases": [],
|
|
137
157
|
"args": {},
|
|
138
|
-
"description": "\n## Command Behavior\n\n**
|
|
158
|
+
"description": "\n## Command Behavior\n\n**Clears the local cache generated by the sfdx-hardis plugin.**\n\nThis command is designed to remove temporary files, stored configurations, and other cached data that sfdx-hardis uses to optimize its operations. Clearing the cache can be beneficial for:\n\n- **Troubleshooting:** Resolving unexpected behavior or inconsistencies.\n- **Disk Space Management:** Freeing up storage on your local machine.\n- **Ensuring Fresh Data:** Guaranteeing that the plugin operates with the most current data and configurations.\n\n## Technical explanations\n\nThe command's technical implementation is straightforward:\n\n- **Direct Function Call:** It directly invokes the `clearCache()` function, which is imported from \buri../../../common/cache/index.js\buri.\n- **Cache Management Logic:** The \buriclearCache()` function encapsulates the logic for identifying and removing the specific files and directories that constitute the sfdx-hardis cache.\n",
|
|
139
159
|
"examples": [
|
|
140
|
-
"$ sf hardis:
|
|
160
|
+
"$ sf hardis:cache:clear"
|
|
141
161
|
],
|
|
142
162
|
"flags": {
|
|
143
163
|
"json": {
|
|
@@ -155,20 +175,6 @@
|
|
|
155
175
|
"multiple": false,
|
|
156
176
|
"type": "option"
|
|
157
177
|
},
|
|
158
|
-
"level": {
|
|
159
|
-
"char": "l",
|
|
160
|
-
"description": "project,branch or user",
|
|
161
|
-
"name": "level",
|
|
162
|
-
"default": "project",
|
|
163
|
-
"hasDynamicHelp": false,
|
|
164
|
-
"multiple": false,
|
|
165
|
-
"options": [
|
|
166
|
-
"project",
|
|
167
|
-
"branch",
|
|
168
|
-
"user"
|
|
169
|
-
],
|
|
170
|
-
"type": "option"
|
|
171
|
-
},
|
|
172
178
|
"debug": {
|
|
173
179
|
"char": "d",
|
|
174
180
|
"description": "Activate debug mode (more logs)",
|
|
@@ -192,39 +198,41 @@
|
|
|
192
198
|
},
|
|
193
199
|
"hasDynamicHelp": false,
|
|
194
200
|
"hiddenAliases": [],
|
|
195
|
-
"id": "hardis:
|
|
201
|
+
"id": "hardis:cache:clear",
|
|
196
202
|
"pluginAlias": "sfdx-hardis",
|
|
197
203
|
"pluginName": "sfdx-hardis",
|
|
198
204
|
"pluginType": "core",
|
|
199
205
|
"strict": true,
|
|
200
206
|
"enableJsonFlag": true,
|
|
201
|
-
"title": "
|
|
207
|
+
"title": "Clear sfdx-hardis cache",
|
|
208
|
+
"uiConfig": {
|
|
209
|
+
"hide": true
|
|
210
|
+
},
|
|
202
211
|
"requiresProject": false,
|
|
203
212
|
"isESM": true,
|
|
204
213
|
"relativePath": [
|
|
205
214
|
"lib",
|
|
206
215
|
"commands",
|
|
207
216
|
"hardis",
|
|
208
|
-
"
|
|
209
|
-
"
|
|
217
|
+
"cache",
|
|
218
|
+
"clear.js"
|
|
210
219
|
],
|
|
211
220
|
"aliasPermutations": [],
|
|
212
221
|
"permutations": [
|
|
213
|
-
"hardis:
|
|
214
|
-
"
|
|
215
|
-
"
|
|
216
|
-
"hardis:
|
|
217
|
-
"
|
|
218
|
-
"
|
|
222
|
+
"hardis:cache:clear",
|
|
223
|
+
"cache:hardis:clear",
|
|
224
|
+
"cache:clear:hardis",
|
|
225
|
+
"hardis:clear:cache",
|
|
226
|
+
"clear:hardis:cache",
|
|
227
|
+
"clear:cache:hardis"
|
|
219
228
|
]
|
|
220
229
|
},
|
|
221
|
-
"hardis:
|
|
230
|
+
"hardis:config:get": {
|
|
222
231
|
"aliases": [],
|
|
223
232
|
"args": {},
|
|
224
|
-
"description": "\n## Command Behavior\n\n**
|
|
233
|
+
"description": "\n## Command Behavior\n\n**Retrieves and displays the sfdx-hardis configuration for a specified level.**\n\nThis command allows you to inspect the configuration that is currently in effect for your project, which is useful for debugging and understanding how sfdx-hardis will behave.\n\n- **Configuration levels:** It can retrieve configuration from three different levels:\n - **Project:** The configuration defined in the project's `.sfdx-hardis.yml` file.\n - **Branch:** The configuration defined in a branch-specific configuration file (e.g., `.sfdx-hardis.production.yml`).\n - **User:** The global user-level configuration.\n\n## Technical explanations\n\nThe command's logic is straightforward:\n\n- **`getConfig` function:** It calls the `getConfig` utility function, passing the desired configuration level as an argument.\n- **Configuration loading:** The `getConfig` function is responsible for finding the appropriate configuration file, reading its contents, and parsing it as YAML or JSON.\n- **Output:** The retrieved configuration is then displayed to the user as a JSON string.\n",
|
|
225
234
|
"examples": [
|
|
226
|
-
"$ sf hardis:
|
|
227
|
-
"CI=true CI_COMMIT_REF_NAME=monitoring_myclient sf hardis:auth:login"
|
|
235
|
+
"$ sf hardis:project:deploy:sources:metadata"
|
|
228
236
|
],
|
|
229
237
|
"flags": {
|
|
230
238
|
"json": {
|
|
@@ -242,28 +250,20 @@
|
|
|
242
250
|
"multiple": false,
|
|
243
251
|
"type": "option"
|
|
244
252
|
},
|
|
245
|
-
"
|
|
246
|
-
"char": "
|
|
247
|
-
"description": "
|
|
248
|
-
"name": "
|
|
253
|
+
"level": {
|
|
254
|
+
"char": "l",
|
|
255
|
+
"description": "project,branch or user",
|
|
256
|
+
"name": "level",
|
|
257
|
+
"default": "project",
|
|
249
258
|
"hasDynamicHelp": false,
|
|
250
259
|
"multiple": false,
|
|
260
|
+
"options": [
|
|
261
|
+
"project",
|
|
262
|
+
"branch",
|
|
263
|
+
"user"
|
|
264
|
+
],
|
|
251
265
|
"type": "option"
|
|
252
266
|
},
|
|
253
|
-
"devhub": {
|
|
254
|
-
"char": "h",
|
|
255
|
-
"description": "Also connect associated DevHub",
|
|
256
|
-
"name": "devhub",
|
|
257
|
-
"allowNo": false,
|
|
258
|
-
"type": "boolean"
|
|
259
|
-
},
|
|
260
|
-
"scratchorg": {
|
|
261
|
-
"char": "s",
|
|
262
|
-
"description": "Scratch org",
|
|
263
|
-
"name": "scratchorg",
|
|
264
|
-
"allowNo": false,
|
|
265
|
-
"type": "boolean"
|
|
266
|
-
},
|
|
267
267
|
"debug": {
|
|
268
268
|
"char": "d",
|
|
269
269
|
"description": "Activate debug mode (more logs)",
|
|
@@ -287,30 +287,30 @@
|
|
|
287
287
|
},
|
|
288
288
|
"hasDynamicHelp": false,
|
|
289
289
|
"hiddenAliases": [],
|
|
290
|
-
"id": "hardis:
|
|
290
|
+
"id": "hardis:config:get",
|
|
291
291
|
"pluginAlias": "sfdx-hardis",
|
|
292
292
|
"pluginName": "sfdx-hardis",
|
|
293
293
|
"pluginType": "core",
|
|
294
294
|
"strict": true,
|
|
295
295
|
"enableJsonFlag": true,
|
|
296
|
-
"title": "
|
|
296
|
+
"title": "Deploy metadata sources to org",
|
|
297
297
|
"requiresProject": false,
|
|
298
298
|
"isESM": true,
|
|
299
299
|
"relativePath": [
|
|
300
300
|
"lib",
|
|
301
301
|
"commands",
|
|
302
302
|
"hardis",
|
|
303
|
-
"
|
|
304
|
-
"
|
|
303
|
+
"config",
|
|
304
|
+
"get.js"
|
|
305
305
|
],
|
|
306
306
|
"aliasPermutations": [],
|
|
307
307
|
"permutations": [
|
|
308
|
-
"hardis:
|
|
309
|
-
"
|
|
310
|
-
"
|
|
311
|
-
"hardis:
|
|
312
|
-
"
|
|
313
|
-
"
|
|
308
|
+
"hardis:config:get",
|
|
309
|
+
"config:hardis:get",
|
|
310
|
+
"config:get:hardis",
|
|
311
|
+
"hardis:get:config",
|
|
312
|
+
"get:hardis:config",
|
|
313
|
+
"get:config:hardis"
|
|
314
314
|
]
|
|
315
315
|
},
|
|
316
316
|
"hardis:doc:fieldusage": {
|
|
@@ -5539,12 +5539,15 @@
|
|
|
5539
5539
|
"import:data:org:hardis"
|
|
5540
5540
|
]
|
|
5541
5541
|
},
|
|
5542
|
-
"hardis:org:
|
|
5542
|
+
"hardis:org:diagnose:audittrail": {
|
|
5543
5543
|
"aliases": [],
|
|
5544
5544
|
"args": {},
|
|
5545
|
-
"description": "
|
|
5545
|
+
"description": "Export Audit trail into a CSV file with selected criteria, and highlight suspect actions\n\nAlso detects updates of Custom Settings values (disable by defining `SKIP_AUDIT_TRAIL_CUSTOM_SETTINGS=true`)\n\nRegular setup actions performed in major orgs are filtered.\n\n- \"\"\n - createScratchOrg\n - changedsenderemail\n - deleteScratchOrg\n - loginasgrantedtopartnerbt\n- Certificate and Key Management\n - insertCertificate\n- Custom App Licenses\n - addeduserpackagelicense\n - granteduserpackagelicense\n - revokeduserpackagelicense\n- Customer Portal\n - createdcustomersuccessuser\n - CSPUserDisabled\n- Currency\n - updateddatedexchrate\n- Data Management\n - queueMembership\n- Email Administration\n - dkimRotationPreparationSuccessful\n - dkimRotationSuccessful\n- External Objects\n - xdsEncryptedFieldChange\n- Groups\n - groupMembership\n- Holidays\n - holiday_insert\n- Inbox mobile and legacy desktop apps\n - enableSIQUserNonEAC\n - siqUserAcceptedTOS\n- Manage Users\n - activateduser\n - createduser\n - changedcommunitynickname\n - changedemail\n - changedfederationid\n - changedpassword\n - changedinteractionuseroffon\n - changedinteractionuseronoff\n - changedmarketinguseroffon\n - changedmarketinguseronoff\n - changedofflineuseroffon\n - changedprofileforuserstdtostd\n - changedprofileforuser\n - changedprofileforusercusttostd\n - changedprofileforuserstdtocust\n - changedroleforusertonone\n - changedroleforuser\n - changedroleforuserfromnone\n - changedUserAdminVerifiedStatusVerified\n - changedUserEmailVerifiedStatusUnverified\n - changedUserEmailVerifiedStatusVerified\n - changedknowledgeuseroffon\n - changedsfcontentuseroffon\n - changedsupportuseroffon\n - changedusername\n - changedUserPhoneNumber\n - changedUserPhoneVerifiedStatusUnverified\n - changedUserPhoneVerifiedStatusVerified\n - deactivateduser\n - deleteAuthenticatorPairing\n - deleteTwoFactorInfo2\n - deleteTwoFactorTempCode\n - frozeuser\n - insertAuthenticatorPairing\n - insertTwoFactorInfo2\n - insertTwoFactorTempCode\n - lightningloginenroll\n - PermSetAssign\n - PermSetGroupAssign\n - PermSetGroupUnassign\n - PermSetLicenseAssign\n - PermSetUnassign\n - PermSetLicenseUnassign\n - registeredUserPhoneNumber\n - resetpassword\n - suNetworkAdminLogin\n - suNetworkAdminLogout\n - suOrgAdminLogin\n - suOrgAdminLogout\n - unfrozeuser\n - useremailchangesent\n- Mobile Administration\n - assigneduserstomobileconfig\n- Reporting Snapshots\n - createdReportJob\n - deletedReportJob\n- Sandboxes\n - DeleteSandbox\n\nBy default, deployment user defined in .sfdx-hardis.yml targetUsername property will be excluded.\n\nYou can define additional users to exclude in .sfdx-hardis.yml **monitoringExcludeUsernames** property.\n\nYou can also add more sections / actions considered as not suspect using property **monitoringAllowedSectionsActions**\n\nExample:\n\n```yaml\nmonitoringExcludeUsernames:\n - deploymentuser@cloudity.com\n - marketingcloud@cloudity.com\n - integration-user@cloudity.com\n\nmonitoringAllowedSectionsActions:\n \"Some section\": [] // Will ignore all actions from such section\n \"Some other section\": [\"actionType1\",\"actionType2\",\"actionType3\"] // Will ignore only those 3 actions from section \"Some other section\". Other actions in the same section will be considered as suspect.\n```\n\n## Excel output example\n\n\n\n## Local output example\n\n\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-suspect-audit-trail/) and can output Grafana, Slack and MsTeams Notifications.\n",
|
|
5546
5546
|
"examples": [
|
|
5547
|
-
"$ sf hardis:org:
|
|
5547
|
+
"$ sf hardis:org:diagnose:audittrail",
|
|
5548
|
+
"$ sf hardis:org:diagnose:audittrail --excludeusers baptiste@titi.com",
|
|
5549
|
+
"$ sf hardis:org:diagnose:audittrail --excludeusers baptiste@titi.com,bertrand@titi.com",
|
|
5550
|
+
"$ sf hardis:org:diagnose:audittrail --lastndays 5"
|
|
5548
5551
|
],
|
|
5549
5552
|
"flags": {
|
|
5550
5553
|
"json": {
|
|
@@ -5562,48 +5565,30 @@
|
|
|
5562
5565
|
"multiple": false,
|
|
5563
5566
|
"type": "option"
|
|
5564
5567
|
},
|
|
5565
|
-
"
|
|
5566
|
-
"char": "
|
|
5567
|
-
"description": "
|
|
5568
|
-
"name": "
|
|
5569
|
-
"hasDynamicHelp": false,
|
|
5570
|
-
"multiple": false,
|
|
5571
|
-
"type": "option"
|
|
5572
|
-
},
|
|
5573
|
-
"chunksize": {
|
|
5574
|
-
"char": "c",
|
|
5575
|
-
"description": "Number of records to add in a chunk before it is processed",
|
|
5576
|
-
"name": "chunksize",
|
|
5577
|
-
"default": 1000,
|
|
5568
|
+
"excludeusers": {
|
|
5569
|
+
"char": "e",
|
|
5570
|
+
"description": "Comma-separated list of usernames to exclude",
|
|
5571
|
+
"name": "excludeusers",
|
|
5578
5572
|
"hasDynamicHelp": false,
|
|
5579
5573
|
"multiple": false,
|
|
5580
5574
|
"type": "option"
|
|
5581
5575
|
},
|
|
5582
|
-
"
|
|
5576
|
+
"lastndays": {
|
|
5583
5577
|
"char": "t",
|
|
5584
|
-
"description": "
|
|
5585
|
-
"name": "
|
|
5586
|
-
"default": 300000,
|
|
5578
|
+
"description": "Number of days to extract from today (included)",
|
|
5579
|
+
"name": "lastndays",
|
|
5587
5580
|
"hasDynamicHelp": false,
|
|
5588
5581
|
"multiple": false,
|
|
5589
5582
|
"type": "option"
|
|
5590
5583
|
},
|
|
5591
|
-
"
|
|
5592
|
-
"char": "
|
|
5593
|
-
"description": "
|
|
5594
|
-
"name": "
|
|
5595
|
-
"default": 0,
|
|
5584
|
+
"outputfile": {
|
|
5585
|
+
"char": "f",
|
|
5586
|
+
"description": "Force the path and name of output report file. Must end with .csv",
|
|
5587
|
+
"name": "outputfile",
|
|
5596
5588
|
"hasDynamicHelp": false,
|
|
5597
5589
|
"multiple": false,
|
|
5598
5590
|
"type": "option"
|
|
5599
5591
|
},
|
|
5600
|
-
"resume": {
|
|
5601
|
-
"char": "r",
|
|
5602
|
-
"description": "Resume previous export by checking existing files (default in CI)",
|
|
5603
|
-
"name": "resume",
|
|
5604
|
-
"allowNo": false,
|
|
5605
|
-
"type": "boolean"
|
|
5606
|
-
},
|
|
5607
5592
|
"debug": {
|
|
5608
5593
|
"char": "d",
|
|
5609
5594
|
"description": "Activate debug mode (more logs)",
|
|
@@ -5642,13 +5627,13 @@
|
|
|
5642
5627
|
},
|
|
5643
5628
|
"hasDynamicHelp": true,
|
|
5644
5629
|
"hiddenAliases": [],
|
|
5645
|
-
"id": "hardis:org:
|
|
5630
|
+
"id": "hardis:org:diagnose:audittrail",
|
|
5646
5631
|
"pluginAlias": "sfdx-hardis",
|
|
5647
5632
|
"pluginName": "sfdx-hardis",
|
|
5648
5633
|
"pluginType": "core",
|
|
5649
5634
|
"strict": true,
|
|
5650
5635
|
"enableJsonFlag": true,
|
|
5651
|
-
"title": "
|
|
5636
|
+
"title": "Diagnose content of Setup Audit Trail",
|
|
5652
5637
|
"requiresProject": false,
|
|
5653
5638
|
"isESM": true,
|
|
5654
5639
|
"relativePath": [
|
|
@@ -5656,289 +5641,35 @@
|
|
|
5656
5641
|
"commands",
|
|
5657
5642
|
"hardis",
|
|
5658
5643
|
"org",
|
|
5659
|
-
"
|
|
5660
|
-
"
|
|
5644
|
+
"diagnose",
|
|
5645
|
+
"audittrail.js"
|
|
5661
5646
|
],
|
|
5662
5647
|
"aliasPermutations": [],
|
|
5663
5648
|
"permutations": [
|
|
5664
|
-
"hardis:org:
|
|
5665
|
-
"org:hardis:
|
|
5666
|
-
"org:
|
|
5667
|
-
"org:
|
|
5668
|
-
"hardis:
|
|
5669
|
-
"
|
|
5670
|
-
"
|
|
5671
|
-
"
|
|
5672
|
-
"hardis:
|
|
5673
|
-
"
|
|
5674
|
-
"
|
|
5675
|
-
"
|
|
5676
|
-
"hardis:org:
|
|
5677
|
-
"org:hardis:
|
|
5678
|
-
"org:
|
|
5679
|
-
"org:
|
|
5680
|
-
"hardis:
|
|
5681
|
-
"
|
|
5682
|
-
"
|
|
5683
|
-
"
|
|
5684
|
-
"hardis:
|
|
5685
|
-
"
|
|
5686
|
-
"
|
|
5687
|
-
"
|
|
5688
|
-
]
|
|
5689
|
-
},
|
|
5690
|
-
"hardis:org:files:import": {
|
|
5691
|
-
"aliases": [],
|
|
5692
|
-
"args": {},
|
|
5693
|
-
"description": "\nThis command facilitates the mass upload of files into Salesforce, allowing you to populate records with associated documents, images, or other file types. It's a crucial tool for data migration, content seeding, or synchronizing external file repositories with Salesforce.\n\nKey functionalities:\n\n- **Configuration-Driven Import:** Relies on an `export.json` file within a designated file export project (created using `sf hardis:org:configure:files`) to determine which files to import and how they should be associated with Salesforce records.\n- **Interactive Project Selection:** If the file import project path is not provided via the `--path` flag, it interactively prompts the user to select one.\n- **Overwrite Option:** The `--overwrite` flag allows you to replace existing files in Salesforce with local versions that have the same name. Be aware that this option doubles the number of API calls used.\n- **Support for ContentVersion and Attachment:** Handles both modern Salesforce Files (ContentVersion) and older Attachments.\n\nSee this article for how to export files, which is often a prerequisite for importing:\n\n[](https://nicolas.vuillamy.fr/how-to-mass-download-notes-and-attachments-files-from-a-salesforce-org-83a028824afd)\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **FilesImporter Class:** The core logic is encapsulated within the `FilesImporter` class, which orchestrates the entire import process.\n- **File System Scan:** Scans the local file system within the configured project directory to identify files for import.\n- **Salesforce API Interaction:** Uses Salesforce APIs (e.g., ContentVersion, Attachment) to upload files and associate them with records.\n- **Configuration Loading:** Reads the `export.json` file to get the import configuration, including SOQL queries to identify parent records for file association.\n- **Interactive Prompts:** Uses `selectFilesWorkspace` to allow the user to choose a file import project and `prompts` for confirming the overwrite behavior.\n- **Error Handling:** Includes mechanisms to handle potential errors during the import process, such as API limits or file upload failures.\n</details>\n",
|
|
5694
|
-
"examples": [
|
|
5695
|
-
"$ sf hardis:org:files:import"
|
|
5696
|
-
],
|
|
5697
|
-
"flags": {
|
|
5698
|
-
"json": {
|
|
5699
|
-
"description": "Format output as json.",
|
|
5700
|
-
"helpGroup": "GLOBAL",
|
|
5701
|
-
"name": "json",
|
|
5702
|
-
"allowNo": false,
|
|
5703
|
-
"type": "boolean"
|
|
5704
|
-
},
|
|
5705
|
-
"flags-dir": {
|
|
5706
|
-
"helpGroup": "GLOBAL",
|
|
5707
|
-
"name": "flags-dir",
|
|
5708
|
-
"summary": "Import flag values from a directory.",
|
|
5709
|
-
"hasDynamicHelp": false,
|
|
5710
|
-
"multiple": false,
|
|
5711
|
-
"type": "option"
|
|
5712
|
-
},
|
|
5713
|
-
"path": {
|
|
5714
|
-
"char": "p",
|
|
5715
|
-
"description": "Path to the file export project",
|
|
5716
|
-
"name": "path",
|
|
5717
|
-
"hasDynamicHelp": false,
|
|
5718
|
-
"multiple": false,
|
|
5719
|
-
"type": "option"
|
|
5720
|
-
},
|
|
5721
|
-
"overwrite": {
|
|
5722
|
-
"char": "f",
|
|
5723
|
-
"description": "Override existing files (doubles the number of API calls)",
|
|
5724
|
-
"name": "overwrite",
|
|
5725
|
-
"allowNo": false,
|
|
5726
|
-
"type": "boolean"
|
|
5727
|
-
},
|
|
5728
|
-
"debug": {
|
|
5729
|
-
"char": "d",
|
|
5730
|
-
"description": "Activate debug mode (more logs)",
|
|
5731
|
-
"name": "debug",
|
|
5732
|
-
"allowNo": false,
|
|
5733
|
-
"type": "boolean"
|
|
5734
|
-
},
|
|
5735
|
-
"websocket": {
|
|
5736
|
-
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
5737
|
-
"name": "websocket",
|
|
5738
|
-
"hasDynamicHelp": false,
|
|
5739
|
-
"multiple": false,
|
|
5740
|
-
"type": "option"
|
|
5741
|
-
},
|
|
5742
|
-
"skipauth": {
|
|
5743
|
-
"description": "Skip authentication check when a default username is required",
|
|
5744
|
-
"name": "skipauth",
|
|
5745
|
-
"allowNo": false,
|
|
5746
|
-
"type": "boolean"
|
|
5747
|
-
},
|
|
5748
|
-
"target-org": {
|
|
5749
|
-
"aliases": [
|
|
5750
|
-
"targetusername",
|
|
5751
|
-
"u"
|
|
5752
|
-
],
|
|
5753
|
-
"char": "o",
|
|
5754
|
-
"deprecateAliases": true,
|
|
5755
|
-
"name": "target-org",
|
|
5756
|
-
"noCacheDefault": true,
|
|
5757
|
-
"required": true,
|
|
5758
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
5759
|
-
"hasDynamicHelp": true,
|
|
5760
|
-
"multiple": false,
|
|
5761
|
-
"type": "option"
|
|
5762
|
-
}
|
|
5763
|
-
},
|
|
5764
|
-
"hasDynamicHelp": true,
|
|
5765
|
-
"hiddenAliases": [],
|
|
5766
|
-
"id": "hardis:org:files:import",
|
|
5767
|
-
"pluginAlias": "sfdx-hardis",
|
|
5768
|
-
"pluginName": "sfdx-hardis",
|
|
5769
|
-
"pluginType": "core",
|
|
5770
|
-
"strict": true,
|
|
5771
|
-
"enableJsonFlag": true,
|
|
5772
|
-
"title": "Import files",
|
|
5773
|
-
"requiresProject": false,
|
|
5774
|
-
"isESM": true,
|
|
5775
|
-
"relativePath": [
|
|
5776
|
-
"lib",
|
|
5777
|
-
"commands",
|
|
5778
|
-
"hardis",
|
|
5779
|
-
"org",
|
|
5780
|
-
"files",
|
|
5781
|
-
"import.js"
|
|
5782
|
-
],
|
|
5783
|
-
"aliasPermutations": [],
|
|
5784
|
-
"permutations": [
|
|
5785
|
-
"hardis:org:files:import",
|
|
5786
|
-
"org:hardis:files:import",
|
|
5787
|
-
"org:files:hardis:import",
|
|
5788
|
-
"org:files:import:hardis",
|
|
5789
|
-
"hardis:files:org:import",
|
|
5790
|
-
"files:hardis:org:import",
|
|
5791
|
-
"files:org:hardis:import",
|
|
5792
|
-
"files:org:import:hardis",
|
|
5793
|
-
"hardis:files:import:org",
|
|
5794
|
-
"files:hardis:import:org",
|
|
5795
|
-
"files:import:hardis:org",
|
|
5796
|
-
"files:import:org:hardis",
|
|
5797
|
-
"hardis:org:import:files",
|
|
5798
|
-
"org:hardis:import:files",
|
|
5799
|
-
"org:import:hardis:files",
|
|
5800
|
-
"org:import:files:hardis",
|
|
5801
|
-
"hardis:import:org:files",
|
|
5802
|
-
"import:hardis:org:files",
|
|
5803
|
-
"import:org:hardis:files",
|
|
5804
|
-
"import:org:files:hardis",
|
|
5805
|
-
"hardis:import:files:org",
|
|
5806
|
-
"import:hardis:files:org",
|
|
5807
|
-
"import:files:hardis:org",
|
|
5808
|
-
"import:files:org:hardis"
|
|
5809
|
-
]
|
|
5810
|
-
},
|
|
5811
|
-
"hardis:org:diagnose:audittrail": {
|
|
5812
|
-
"aliases": [],
|
|
5813
|
-
"args": {},
|
|
5814
|
-
"description": "Export Audit trail into a CSV file with selected criteria, and highlight suspect actions\n\nAlso detects updates of Custom Settings values (disable by defining `SKIP_AUDIT_TRAIL_CUSTOM_SETTINGS=true`)\n\nRegular setup actions performed in major orgs are filtered.\n\n- \"\"\n - createScratchOrg\n - changedsenderemail\n - deleteScratchOrg\n - loginasgrantedtopartnerbt\n- Certificate and Key Management\n - insertCertificate\n- Custom App Licenses\n - addeduserpackagelicense\n - granteduserpackagelicense\n - revokeduserpackagelicense\n- Customer Portal\n - createdcustomersuccessuser\n - CSPUserDisabled\n- Currency\n - updateddatedexchrate\n- Data Management\n - queueMembership\n- Email Administration\n - dkimRotationPreparationSuccessful\n - dkimRotationSuccessful\n- External Objects\n - xdsEncryptedFieldChange\n- Groups\n - groupMembership\n- Holidays\n - holiday_insert\n- Inbox mobile and legacy desktop apps\n - enableSIQUserNonEAC\n - siqUserAcceptedTOS\n- Manage Users\n - activateduser\n - createduser\n - changedcommunitynickname\n - changedemail\n - changedfederationid\n - changedpassword\n - changedinteractionuseroffon\n - changedinteractionuseronoff\n - changedmarketinguseroffon\n - changedmarketinguseronoff\n - changedofflineuseroffon\n - changedprofileforuserstdtostd\n - changedprofileforuser\n - changedprofileforusercusttostd\n - changedprofileforuserstdtocust\n - changedroleforusertonone\n - changedroleforuser\n - changedroleforuserfromnone\n - changedUserAdminVerifiedStatusVerified\n - changedUserEmailVerifiedStatusUnverified\n - changedUserEmailVerifiedStatusVerified\n - changedknowledgeuseroffon\n - changedsfcontentuseroffon\n - changedsupportuseroffon\n - changedusername\n - changedUserPhoneNumber\n - changedUserPhoneVerifiedStatusUnverified\n - changedUserPhoneVerifiedStatusVerified\n - deactivateduser\n - deleteAuthenticatorPairing\n - deleteTwoFactorInfo2\n - deleteTwoFactorTempCode\n - frozeuser\n - insertAuthenticatorPairing\n - insertTwoFactorInfo2\n - insertTwoFactorTempCode\n - lightningloginenroll\n - PermSetAssign\n - PermSetGroupAssign\n - PermSetGroupUnassign\n - PermSetLicenseAssign\n - PermSetUnassign\n - PermSetLicenseUnassign\n - registeredUserPhoneNumber\n - resetpassword\n - suNetworkAdminLogin\n - suNetworkAdminLogout\n - suOrgAdminLogin\n - suOrgAdminLogout\n - unfrozeuser\n - useremailchangesent\n- Mobile Administration\n - assigneduserstomobileconfig\n- Reporting Snapshots\n - createdReportJob\n - deletedReportJob\n- Sandboxes\n - DeleteSandbox\n\nBy default, deployment user defined in .sfdx-hardis.yml targetUsername property will be excluded.\n\nYou can define additional users to exclude in .sfdx-hardis.yml **monitoringExcludeUsernames** property.\n\nYou can also add more sections / actions considered as not suspect using property **monitoringAllowedSectionsActions**\n\nExample:\n\n```yaml\nmonitoringExcludeUsernames:\n - deploymentuser@cloudity.com\n - marketingcloud@cloudity.com\n - integration-user@cloudity.com\n\nmonitoringAllowedSectionsActions:\n \"Some section\": [] // Will ignore all actions from such section\n \"Some other section\": [\"actionType1\",\"actionType2\",\"actionType3\"] // Will ignore only those 3 actions from section \"Some other section\". Other actions in the same section will be considered as suspect.\n```\n\n## Excel output example\n\n\n\n## Local output example\n\n\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-suspect-audit-trail/) and can output Grafana, Slack and MsTeams Notifications.\n",
|
|
5815
|
-
"examples": [
|
|
5816
|
-
"$ sf hardis:org:diagnose:audittrail",
|
|
5817
|
-
"$ sf hardis:org:diagnose:audittrail --excludeusers baptiste@titi.com",
|
|
5818
|
-
"$ sf hardis:org:diagnose:audittrail --excludeusers baptiste@titi.com,bertrand@titi.com",
|
|
5819
|
-
"$ sf hardis:org:diagnose:audittrail --lastndays 5"
|
|
5820
|
-
],
|
|
5821
|
-
"flags": {
|
|
5822
|
-
"json": {
|
|
5823
|
-
"description": "Format output as json.",
|
|
5824
|
-
"helpGroup": "GLOBAL",
|
|
5825
|
-
"name": "json",
|
|
5826
|
-
"allowNo": false,
|
|
5827
|
-
"type": "boolean"
|
|
5828
|
-
},
|
|
5829
|
-
"flags-dir": {
|
|
5830
|
-
"helpGroup": "GLOBAL",
|
|
5831
|
-
"name": "flags-dir",
|
|
5832
|
-
"summary": "Import flag values from a directory.",
|
|
5833
|
-
"hasDynamicHelp": false,
|
|
5834
|
-
"multiple": false,
|
|
5835
|
-
"type": "option"
|
|
5836
|
-
},
|
|
5837
|
-
"excludeusers": {
|
|
5838
|
-
"char": "e",
|
|
5839
|
-
"description": "Comma-separated list of usernames to exclude",
|
|
5840
|
-
"name": "excludeusers",
|
|
5841
|
-
"hasDynamicHelp": false,
|
|
5842
|
-
"multiple": false,
|
|
5843
|
-
"type": "option"
|
|
5844
|
-
},
|
|
5845
|
-
"lastndays": {
|
|
5846
|
-
"char": "t",
|
|
5847
|
-
"description": "Number of days to extract from today (included)",
|
|
5848
|
-
"name": "lastndays",
|
|
5849
|
-
"hasDynamicHelp": false,
|
|
5850
|
-
"multiple": false,
|
|
5851
|
-
"type": "option"
|
|
5852
|
-
},
|
|
5853
|
-
"outputfile": {
|
|
5854
|
-
"char": "f",
|
|
5855
|
-
"description": "Force the path and name of output report file. Must end with .csv",
|
|
5856
|
-
"name": "outputfile",
|
|
5857
|
-
"hasDynamicHelp": false,
|
|
5858
|
-
"multiple": false,
|
|
5859
|
-
"type": "option"
|
|
5860
|
-
},
|
|
5861
|
-
"debug": {
|
|
5862
|
-
"char": "d",
|
|
5863
|
-
"description": "Activate debug mode (more logs)",
|
|
5864
|
-
"name": "debug",
|
|
5865
|
-
"allowNo": false,
|
|
5866
|
-
"type": "boolean"
|
|
5867
|
-
},
|
|
5868
|
-
"websocket": {
|
|
5869
|
-
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
5870
|
-
"name": "websocket",
|
|
5871
|
-
"hasDynamicHelp": false,
|
|
5872
|
-
"multiple": false,
|
|
5873
|
-
"type": "option"
|
|
5874
|
-
},
|
|
5875
|
-
"skipauth": {
|
|
5876
|
-
"description": "Skip authentication check when a default username is required",
|
|
5877
|
-
"name": "skipauth",
|
|
5878
|
-
"allowNo": false,
|
|
5879
|
-
"type": "boolean"
|
|
5880
|
-
},
|
|
5881
|
-
"target-org": {
|
|
5882
|
-
"aliases": [
|
|
5883
|
-
"targetusername",
|
|
5884
|
-
"u"
|
|
5885
|
-
],
|
|
5886
|
-
"char": "o",
|
|
5887
|
-
"deprecateAliases": true,
|
|
5888
|
-
"name": "target-org",
|
|
5889
|
-
"noCacheDefault": true,
|
|
5890
|
-
"required": true,
|
|
5891
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
5892
|
-
"hasDynamicHelp": true,
|
|
5893
|
-
"multiple": false,
|
|
5894
|
-
"type": "option"
|
|
5895
|
-
}
|
|
5896
|
-
},
|
|
5897
|
-
"hasDynamicHelp": true,
|
|
5898
|
-
"hiddenAliases": [],
|
|
5899
|
-
"id": "hardis:org:diagnose:audittrail",
|
|
5900
|
-
"pluginAlias": "sfdx-hardis",
|
|
5901
|
-
"pluginName": "sfdx-hardis",
|
|
5902
|
-
"pluginType": "core",
|
|
5903
|
-
"strict": true,
|
|
5904
|
-
"enableJsonFlag": true,
|
|
5905
|
-
"title": "Diagnose content of Setup Audit Trail",
|
|
5906
|
-
"requiresProject": false,
|
|
5907
|
-
"isESM": true,
|
|
5908
|
-
"relativePath": [
|
|
5909
|
-
"lib",
|
|
5910
|
-
"commands",
|
|
5911
|
-
"hardis",
|
|
5912
|
-
"org",
|
|
5913
|
-
"diagnose",
|
|
5914
|
-
"audittrail.js"
|
|
5915
|
-
],
|
|
5916
|
-
"aliasPermutations": [],
|
|
5917
|
-
"permutations": [
|
|
5918
|
-
"hardis:org:diagnose:audittrail",
|
|
5919
|
-
"org:hardis:diagnose:audittrail",
|
|
5920
|
-
"org:diagnose:hardis:audittrail",
|
|
5921
|
-
"org:diagnose:audittrail:hardis",
|
|
5922
|
-
"hardis:diagnose:org:audittrail",
|
|
5923
|
-
"diagnose:hardis:org:audittrail",
|
|
5924
|
-
"diagnose:org:hardis:audittrail",
|
|
5925
|
-
"diagnose:org:audittrail:hardis",
|
|
5926
|
-
"hardis:diagnose:audittrail:org",
|
|
5927
|
-
"diagnose:hardis:audittrail:org",
|
|
5928
|
-
"diagnose:audittrail:hardis:org",
|
|
5929
|
-
"diagnose:audittrail:org:hardis",
|
|
5930
|
-
"hardis:org:audittrail:diagnose",
|
|
5931
|
-
"org:hardis:audittrail:diagnose",
|
|
5932
|
-
"org:audittrail:hardis:diagnose",
|
|
5933
|
-
"org:audittrail:diagnose:hardis",
|
|
5934
|
-
"hardis:audittrail:org:diagnose",
|
|
5935
|
-
"audittrail:hardis:org:diagnose",
|
|
5936
|
-
"audittrail:org:hardis:diagnose",
|
|
5937
|
-
"audittrail:org:diagnose:hardis",
|
|
5938
|
-
"hardis:audittrail:diagnose:org",
|
|
5939
|
-
"audittrail:hardis:diagnose:org",
|
|
5940
|
-
"audittrail:diagnose:hardis:org",
|
|
5941
|
-
"audittrail:diagnose:org:hardis"
|
|
5649
|
+
"hardis:org:diagnose:audittrail",
|
|
5650
|
+
"org:hardis:diagnose:audittrail",
|
|
5651
|
+
"org:diagnose:hardis:audittrail",
|
|
5652
|
+
"org:diagnose:audittrail:hardis",
|
|
5653
|
+
"hardis:diagnose:org:audittrail",
|
|
5654
|
+
"diagnose:hardis:org:audittrail",
|
|
5655
|
+
"diagnose:org:hardis:audittrail",
|
|
5656
|
+
"diagnose:org:audittrail:hardis",
|
|
5657
|
+
"hardis:diagnose:audittrail:org",
|
|
5658
|
+
"diagnose:hardis:audittrail:org",
|
|
5659
|
+
"diagnose:audittrail:hardis:org",
|
|
5660
|
+
"diagnose:audittrail:org:hardis",
|
|
5661
|
+
"hardis:org:audittrail:diagnose",
|
|
5662
|
+
"org:hardis:audittrail:diagnose",
|
|
5663
|
+
"org:audittrail:hardis:diagnose",
|
|
5664
|
+
"org:audittrail:diagnose:hardis",
|
|
5665
|
+
"hardis:audittrail:org:diagnose",
|
|
5666
|
+
"audittrail:hardis:org:diagnose",
|
|
5667
|
+
"audittrail:org:hardis:diagnose",
|
|
5668
|
+
"audittrail:org:diagnose:hardis",
|
|
5669
|
+
"hardis:audittrail:diagnose:org",
|
|
5670
|
+
"audittrail:hardis:diagnose:org",
|
|
5671
|
+
"audittrail:diagnose:hardis:org",
|
|
5672
|
+
"audittrail:diagnose:org:hardis"
|
|
5942
5673
|
]
|
|
5943
5674
|
},
|
|
5944
5675
|
"hardis:org:diagnose:instanceupgrade": {
|
|
@@ -7321,10 +7052,279 @@
|
|
|
7321
7052
|
"listviewmine:fix:org:hardis"
|
|
7322
7053
|
]
|
|
7323
7054
|
},
|
|
7324
|
-
"hardis:org:
|
|
7055
|
+
"hardis:org:files:export": {
|
|
7325
7056
|
"aliases": [],
|
|
7326
7057
|
"args": {},
|
|
7327
|
-
"description": "\n## Command Behavior\n\n**
|
|
7058
|
+
"description": "\n## Command Behavior\n\n**Exports file attachments (ContentVersion, Attachment) from a Salesforce org based on a predefined configuration.**\n\nThis command enables the mass download of files associated with Salesforce records, providing a robust solution for backing up files, migrating them to other systems, or integrating them with external document management solutions.\n\nKey functionalities:\n\n- **Configuration-Driven Export:** Relies on an `export.json` file within a designated file export project to define the export criteria, including the SOQL query for parent records, file types to export, output naming conventions, and file size filtering.\n- **File Size Filtering:** Supports minimum file size filtering via the `fileSizeMin` configuration parameter (in KB). Files smaller than the specified size will be skipped during export.\n- **File Validation:** After downloading each file, validates the integrity by:\n - **Checksum Validation:** For ContentVersion files, compares MD5 checksum with Salesforce's stored checksum\n - **Size Validation:** For both ContentVersion and Attachment files, verifies actual file size matches expected size\n - **Status Tracking:** Files are categorized with specific statuses: `success` (valid files), `failed` (download errors), `skipped` (filtered files), `invalid` (downloaded but failed validation)\n - All validation results are logged in the CSV export log for audit purposes\n- **Resume/Restart Capability:** \n - **Resume Mode:** When `--resume` flag is used (default in CI environments), checks existing downloaded files for validity. Valid files are skipped, invalid files are re-downloaded.\n - **Restart Mode:** When resume is disabled, clears the output folder and starts a fresh export.\n - **Interactive Mode:** When existing files are found and `--resume` is not explicitly specified (non-CI environments), prompts the user to choose between resume or restart.\n- **Interactive Project Selection:** If the file export project path is not provided via the `--path` flag, it interactively prompts the user to select one.\n- **Configurable Export Options:** Allows overriding default export settings such as `chunksize` (number of records processed in a batch), `polltimeout` (timeout for Bulk API calls), and `startchunknumber` (to resume a failed export).\n- **Support for ContentVersion and Attachment:** Handles both modern Salesforce Files (ContentVersion) and older Attachments.\n\nSee this article for a practical example:\n\n[](https://nicolas.vuillamy.fr/how-to-mass-download-notes-and-attachments-files-from-a-salesforce-org-83a028824afd)\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **FilesExporter Class:** The core logic is encapsulated within the `FilesExporter` class, which orchestrates the entire export process.\n- **SOQL Queries (Bulk API):** It uses Salesforce Bulk API queries to efficiently retrieve large volumes of parent record IDs and file metadata, including checksums and file sizes.\n- **File Download:** Downloads the actual file content from Salesforce.\n- **File Validation:** After each successful download, validates file integrity by comparing checksums (ContentVersion) and file sizes (both ContentVersion and Attachment) against Salesforce metadata.\n- **Resume Logic:** In resume mode, checks for existing files before downloading, validates their integrity, and only re-downloads invalid or missing files. This enables efficient recovery from interrupted exports.\n- **File System Operations:** Writes the downloaded files to the local file system, organizing them into folders based on the configured naming conventions.\n- **Configuration Loading:** Reads the `export.json` file to get the export configuration. It also allows for interactive overriding of these settings.\n- **Interactive Prompts:** Uses `selectFilesWorkspace` to allow the user to choose a file export project, `promptFilesExportConfiguration` for customizing export options, and prompts for resume/restart choice when existing files are found.\n- **Error Handling:** Includes mechanisms to handle potential errors during the export process, such as network issues, API limits, and file validation failures. Each file is assigned a specific status (`success`, `failed`, `skipped`, `invalid`) for comprehensive tracking and troubleshooting.\n</details>\n",
|
|
7059
|
+
"examples": [
|
|
7060
|
+
"$ sf hardis:org:files:export"
|
|
7061
|
+
],
|
|
7062
|
+
"flags": {
|
|
7063
|
+
"json": {
|
|
7064
|
+
"description": "Format output as json.",
|
|
7065
|
+
"helpGroup": "GLOBAL",
|
|
7066
|
+
"name": "json",
|
|
7067
|
+
"allowNo": false,
|
|
7068
|
+
"type": "boolean"
|
|
7069
|
+
},
|
|
7070
|
+
"flags-dir": {
|
|
7071
|
+
"helpGroup": "GLOBAL",
|
|
7072
|
+
"name": "flags-dir",
|
|
7073
|
+
"summary": "Import flag values from a directory.",
|
|
7074
|
+
"hasDynamicHelp": false,
|
|
7075
|
+
"multiple": false,
|
|
7076
|
+
"type": "option"
|
|
7077
|
+
},
|
|
7078
|
+
"path": {
|
|
7079
|
+
"char": "p",
|
|
7080
|
+
"description": "Path to the file export project",
|
|
7081
|
+
"name": "path",
|
|
7082
|
+
"hasDynamicHelp": false,
|
|
7083
|
+
"multiple": false,
|
|
7084
|
+
"type": "option"
|
|
7085
|
+
},
|
|
7086
|
+
"chunksize": {
|
|
7087
|
+
"char": "c",
|
|
7088
|
+
"description": "Number of records to add in a chunk before it is processed",
|
|
7089
|
+
"name": "chunksize",
|
|
7090
|
+
"default": 1000,
|
|
7091
|
+
"hasDynamicHelp": false,
|
|
7092
|
+
"multiple": false,
|
|
7093
|
+
"type": "option"
|
|
7094
|
+
},
|
|
7095
|
+
"polltimeout": {
|
|
7096
|
+
"char": "t",
|
|
7097
|
+
"description": "Timeout in MS for Bulk API calls",
|
|
7098
|
+
"name": "polltimeout",
|
|
7099
|
+
"default": 300000,
|
|
7100
|
+
"hasDynamicHelp": false,
|
|
7101
|
+
"multiple": false,
|
|
7102
|
+
"type": "option"
|
|
7103
|
+
},
|
|
7104
|
+
"startchunknumber": {
|
|
7105
|
+
"char": "s",
|
|
7106
|
+
"description": "Chunk number to start from",
|
|
7107
|
+
"name": "startchunknumber",
|
|
7108
|
+
"default": 0,
|
|
7109
|
+
"hasDynamicHelp": false,
|
|
7110
|
+
"multiple": false,
|
|
7111
|
+
"type": "option"
|
|
7112
|
+
},
|
|
7113
|
+
"resume": {
|
|
7114
|
+
"char": "r",
|
|
7115
|
+
"description": "Resume previous export by checking existing files (default in CI)",
|
|
7116
|
+
"name": "resume",
|
|
7117
|
+
"allowNo": false,
|
|
7118
|
+
"type": "boolean"
|
|
7119
|
+
},
|
|
7120
|
+
"debug": {
|
|
7121
|
+
"char": "d",
|
|
7122
|
+
"description": "Activate debug mode (more logs)",
|
|
7123
|
+
"name": "debug",
|
|
7124
|
+
"allowNo": false,
|
|
7125
|
+
"type": "boolean"
|
|
7126
|
+
},
|
|
7127
|
+
"websocket": {
|
|
7128
|
+
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
7129
|
+
"name": "websocket",
|
|
7130
|
+
"hasDynamicHelp": false,
|
|
7131
|
+
"multiple": false,
|
|
7132
|
+
"type": "option"
|
|
7133
|
+
},
|
|
7134
|
+
"skipauth": {
|
|
7135
|
+
"description": "Skip authentication check when a default username is required",
|
|
7136
|
+
"name": "skipauth",
|
|
7137
|
+
"allowNo": false,
|
|
7138
|
+
"type": "boolean"
|
|
7139
|
+
},
|
|
7140
|
+
"target-org": {
|
|
7141
|
+
"aliases": [
|
|
7142
|
+
"targetusername",
|
|
7143
|
+
"u"
|
|
7144
|
+
],
|
|
7145
|
+
"char": "o",
|
|
7146
|
+
"deprecateAliases": true,
|
|
7147
|
+
"name": "target-org",
|
|
7148
|
+
"noCacheDefault": true,
|
|
7149
|
+
"required": true,
|
|
7150
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
7151
|
+
"hasDynamicHelp": true,
|
|
7152
|
+
"multiple": false,
|
|
7153
|
+
"type": "option"
|
|
7154
|
+
}
|
|
7155
|
+
},
|
|
7156
|
+
"hasDynamicHelp": true,
|
|
7157
|
+
"hiddenAliases": [],
|
|
7158
|
+
"id": "hardis:org:files:export",
|
|
7159
|
+
"pluginAlias": "sfdx-hardis",
|
|
7160
|
+
"pluginName": "sfdx-hardis",
|
|
7161
|
+
"pluginType": "core",
|
|
7162
|
+
"strict": true,
|
|
7163
|
+
"enableJsonFlag": true,
|
|
7164
|
+
"title": "Export files",
|
|
7165
|
+
"requiresProject": false,
|
|
7166
|
+
"isESM": true,
|
|
7167
|
+
"relativePath": [
|
|
7168
|
+
"lib",
|
|
7169
|
+
"commands",
|
|
7170
|
+
"hardis",
|
|
7171
|
+
"org",
|
|
7172
|
+
"files",
|
|
7173
|
+
"export.js"
|
|
7174
|
+
],
|
|
7175
|
+
"aliasPermutations": [],
|
|
7176
|
+
"permutations": [
|
|
7177
|
+
"hardis:org:files:export",
|
|
7178
|
+
"org:hardis:files:export",
|
|
7179
|
+
"org:files:hardis:export",
|
|
7180
|
+
"org:files:export:hardis",
|
|
7181
|
+
"hardis:files:org:export",
|
|
7182
|
+
"files:hardis:org:export",
|
|
7183
|
+
"files:org:hardis:export",
|
|
7184
|
+
"files:org:export:hardis",
|
|
7185
|
+
"hardis:files:export:org",
|
|
7186
|
+
"files:hardis:export:org",
|
|
7187
|
+
"files:export:hardis:org",
|
|
7188
|
+
"files:export:org:hardis",
|
|
7189
|
+
"hardis:org:export:files",
|
|
7190
|
+
"org:hardis:export:files",
|
|
7191
|
+
"org:export:hardis:files",
|
|
7192
|
+
"org:export:files:hardis",
|
|
7193
|
+
"hardis:export:org:files",
|
|
7194
|
+
"export:hardis:org:files",
|
|
7195
|
+
"export:org:hardis:files",
|
|
7196
|
+
"export:org:files:hardis",
|
|
7197
|
+
"hardis:export:files:org",
|
|
7198
|
+
"export:hardis:files:org",
|
|
7199
|
+
"export:files:hardis:org",
|
|
7200
|
+
"export:files:org:hardis"
|
|
7201
|
+
]
|
|
7202
|
+
},
|
|
7203
|
+
"hardis:org:files:import": {
|
|
7204
|
+
"aliases": [],
|
|
7205
|
+
"args": {},
|
|
7206
|
+
"description": "\nThis command facilitates the mass upload of files into Salesforce, allowing you to populate records with associated documents, images, or other file types. It's a crucial tool for data migration, content seeding, or synchronizing external file repositories with Salesforce.\n\nKey functionalities:\n\n- **Configuration-Driven Import:** Relies on an `export.json` file within a designated file export project (created using `sf hardis:org:configure:files`) to determine which files to import and how they should be associated with Salesforce records.\n- **Interactive Project Selection:** If the file import project path is not provided via the `--path` flag, it interactively prompts the user to select one.\n- **Overwrite Option:** The `--overwrite` flag allows you to replace existing files in Salesforce with local versions that have the same name. Be aware that this option doubles the number of API calls used.\n- **Support for ContentVersion and Attachment:** Handles both modern Salesforce Files (ContentVersion) and older Attachments.\n\nSee this article for how to export files, which is often a prerequisite for importing:\n\n[](https://nicolas.vuillamy.fr/how-to-mass-download-notes-and-attachments-files-from-a-salesforce-org-83a028824afd)\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **FilesImporter Class:** The core logic is encapsulated within the `FilesImporter` class, which orchestrates the entire import process.\n- **File System Scan:** Scans the local file system within the configured project directory to identify files for import.\n- **Salesforce API Interaction:** Uses Salesforce APIs (e.g., ContentVersion, Attachment) to upload files and associate them with records.\n- **Configuration Loading:** Reads the `export.json` file to get the import configuration, including SOQL queries to identify parent records for file association.\n- **Interactive Prompts:** Uses `selectFilesWorkspace` to allow the user to choose a file import project and `prompts` for confirming the overwrite behavior.\n- **Error Handling:** Includes mechanisms to handle potential errors during the import process, such as API limits or file upload failures.\n</details>\n",
|
|
7207
|
+
"examples": [
|
|
7208
|
+
"$ sf hardis:org:files:import"
|
|
7209
|
+
],
|
|
7210
|
+
"flags": {
|
|
7211
|
+
"json": {
|
|
7212
|
+
"description": "Format output as json.",
|
|
7213
|
+
"helpGroup": "GLOBAL",
|
|
7214
|
+
"name": "json",
|
|
7215
|
+
"allowNo": false,
|
|
7216
|
+
"type": "boolean"
|
|
7217
|
+
},
|
|
7218
|
+
"flags-dir": {
|
|
7219
|
+
"helpGroup": "GLOBAL",
|
|
7220
|
+
"name": "flags-dir",
|
|
7221
|
+
"summary": "Import flag values from a directory.",
|
|
7222
|
+
"hasDynamicHelp": false,
|
|
7223
|
+
"multiple": false,
|
|
7224
|
+
"type": "option"
|
|
7225
|
+
},
|
|
7226
|
+
"path": {
|
|
7227
|
+
"char": "p",
|
|
7228
|
+
"description": "Path to the file export project",
|
|
7229
|
+
"name": "path",
|
|
7230
|
+
"hasDynamicHelp": false,
|
|
7231
|
+
"multiple": false,
|
|
7232
|
+
"type": "option"
|
|
7233
|
+
},
|
|
7234
|
+
"overwrite": {
|
|
7235
|
+
"char": "f",
|
|
7236
|
+
"description": "Override existing files (doubles the number of API calls)",
|
|
7237
|
+
"name": "overwrite",
|
|
7238
|
+
"allowNo": false,
|
|
7239
|
+
"type": "boolean"
|
|
7240
|
+
},
|
|
7241
|
+
"debug": {
|
|
7242
|
+
"char": "d",
|
|
7243
|
+
"description": "Activate debug mode (more logs)",
|
|
7244
|
+
"name": "debug",
|
|
7245
|
+
"allowNo": false,
|
|
7246
|
+
"type": "boolean"
|
|
7247
|
+
},
|
|
7248
|
+
"websocket": {
|
|
7249
|
+
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
7250
|
+
"name": "websocket",
|
|
7251
|
+
"hasDynamicHelp": false,
|
|
7252
|
+
"multiple": false,
|
|
7253
|
+
"type": "option"
|
|
7254
|
+
},
|
|
7255
|
+
"skipauth": {
|
|
7256
|
+
"description": "Skip authentication check when a default username is required",
|
|
7257
|
+
"name": "skipauth",
|
|
7258
|
+
"allowNo": false,
|
|
7259
|
+
"type": "boolean"
|
|
7260
|
+
},
|
|
7261
|
+
"target-org": {
|
|
7262
|
+
"aliases": [
|
|
7263
|
+
"targetusername",
|
|
7264
|
+
"u"
|
|
7265
|
+
],
|
|
7266
|
+
"char": "o",
|
|
7267
|
+
"deprecateAliases": true,
|
|
7268
|
+
"name": "target-org",
|
|
7269
|
+
"noCacheDefault": true,
|
|
7270
|
+
"required": true,
|
|
7271
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
7272
|
+
"hasDynamicHelp": true,
|
|
7273
|
+
"multiple": false,
|
|
7274
|
+
"type": "option"
|
|
7275
|
+
}
|
|
7276
|
+
},
|
|
7277
|
+
"hasDynamicHelp": true,
|
|
7278
|
+
"hiddenAliases": [],
|
|
7279
|
+
"id": "hardis:org:files:import",
|
|
7280
|
+
"pluginAlias": "sfdx-hardis",
|
|
7281
|
+
"pluginName": "sfdx-hardis",
|
|
7282
|
+
"pluginType": "core",
|
|
7283
|
+
"strict": true,
|
|
7284
|
+
"enableJsonFlag": true,
|
|
7285
|
+
"title": "Import files",
|
|
7286
|
+
"requiresProject": false,
|
|
7287
|
+
"isESM": true,
|
|
7288
|
+
"relativePath": [
|
|
7289
|
+
"lib",
|
|
7290
|
+
"commands",
|
|
7291
|
+
"hardis",
|
|
7292
|
+
"org",
|
|
7293
|
+
"files",
|
|
7294
|
+
"import.js"
|
|
7295
|
+
],
|
|
7296
|
+
"aliasPermutations": [],
|
|
7297
|
+
"permutations": [
|
|
7298
|
+
"hardis:org:files:import",
|
|
7299
|
+
"org:hardis:files:import",
|
|
7300
|
+
"org:files:hardis:import",
|
|
7301
|
+
"org:files:import:hardis",
|
|
7302
|
+
"hardis:files:org:import",
|
|
7303
|
+
"files:hardis:org:import",
|
|
7304
|
+
"files:org:hardis:import",
|
|
7305
|
+
"files:org:import:hardis",
|
|
7306
|
+
"hardis:files:import:org",
|
|
7307
|
+
"files:hardis:import:org",
|
|
7308
|
+
"files:import:hardis:org",
|
|
7309
|
+
"files:import:org:hardis",
|
|
7310
|
+
"hardis:org:import:files",
|
|
7311
|
+
"org:hardis:import:files",
|
|
7312
|
+
"org:import:hardis:files",
|
|
7313
|
+
"org:import:files:hardis",
|
|
7314
|
+
"hardis:import:org:files",
|
|
7315
|
+
"import:hardis:org:files",
|
|
7316
|
+
"import:org:hardis:files",
|
|
7317
|
+
"import:org:files:hardis",
|
|
7318
|
+
"hardis:import:files:org",
|
|
7319
|
+
"import:hardis:files:org",
|
|
7320
|
+
"import:files:hardis:org",
|
|
7321
|
+
"import:files:org:hardis"
|
|
7322
|
+
]
|
|
7323
|
+
},
|
|
7324
|
+
"hardis:org:generate:packagexmlfull": {
|
|
7325
|
+
"aliases": [],
|
|
7326
|
+
"args": {},
|
|
7327
|
+
"description": "\n## Command Behavior\n\n**Generates a comprehensive `package.xml` file for a Salesforce org, including all metadata components, even managed ones.**\n\nThis command is essential for various Salesforce development and administration tasks, especially when you need a complete snapshot of an org's metadata. It goes beyond typical source tracking by including managed package components, which is crucial for understanding the full metadata footprint of an org.\n\nKey functionalities:\n\n- **Full Org Metadata Retrieval:** Connects to a specified Salesforce org (or prompts for one if not provided) and retrieves a complete list of all metadata types and their members.\n- **Managed Package Inclusion:** Unlike standard source retrieval, this command explicitly includes metadata from managed packages, providing a truly comprehensive `package.xml`.\n- **Customizable Output:** Allows you to specify the output file path for the generated `package.xml`.\n- **Interactive Org Selection:** If no target org is specified, it interactively prompts the user to choose an org. (or use --no-prompt to skip this step)\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **Salesforce Metadata API Interaction:** It leverages the Salesforce Metadata API to list all available metadata types and then retrieve all components for each type.\n- **`buildOrgManifest` Utility:** The core logic for querying the org's metadata and constructing the `package.xml` is encapsulated within the `buildOrgManifest` utility function.\n- **XML Generation:** It dynamically builds the XML structure of the `package.xml` file, including the `types` and `members` elements for all retrieved metadata.\n- **File System Operations:** It writes the generated `package.xml` file to the specified output path.\n- **Interactive Prompts:** Uses `promptOrgUsernameDefault` to guide the user in selecting the target Salesforce org.\n</details>\n",
|
|
7328
7328
|
"examples": [
|
|
7329
7329
|
"$ sf hardis:org:generate:packagexmlfull",
|
|
7330
7330
|
"$ sf hardis:org:generate:packagexmlfull --outputfile /tmp/packagexmlfull.xml",
|
|
@@ -9999,140 +9999,37 @@
|
|
|
9999
9999
|
"name": "target-org",
|
|
10000
10000
|
"noCacheDefault": true,
|
|
10001
10001
|
"summary": "Username or alias of the target org.",
|
|
10002
|
-
"hasDynamicHelp": true,
|
|
10003
|
-
"multiple": false,
|
|
10004
|
-
"type": "option"
|
|
10005
|
-
},
|
|
10006
|
-
"target-dev-hub": {
|
|
10007
|
-
"aliases": [
|
|
10008
|
-
"targetdevhubusername"
|
|
10009
|
-
],
|
|
10010
|
-
"char": "v",
|
|
10011
|
-
"deprecateAliases": true,
|
|
10012
|
-
"name": "target-dev-hub",
|
|
10013
|
-
"noCacheDefault": true,
|
|
10014
|
-
"required": false,
|
|
10015
|
-
"summary": "Username or alias of the Dev Hub org.",
|
|
10016
|
-
"hasDynamicHelp": true,
|
|
10017
|
-
"multiple": false,
|
|
10018
|
-
"type": "option"
|
|
10019
|
-
}
|
|
10020
|
-
},
|
|
10021
|
-
"hasDynamicHelp": true,
|
|
10022
|
-
"hiddenAliases": [],
|
|
10023
|
-
"id": "hardis:project:configure:auth",
|
|
10024
|
-
"pluginAlias": "sfdx-hardis",
|
|
10025
|
-
"pluginName": "sfdx-hardis",
|
|
10026
|
-
"pluginType": "core",
|
|
10027
|
-
"strict": true,
|
|
10028
|
-
"enableJsonFlag": true,
|
|
10029
|
-
"title": "Configure authentication",
|
|
10030
|
-
"requiresProject": false,
|
|
10031
|
-
"requiresDependencies": [
|
|
10032
|
-
"openssl"
|
|
10033
|
-
],
|
|
10034
|
-
"isESM": true,
|
|
10035
|
-
"relativePath": [
|
|
10036
|
-
"lib",
|
|
10037
|
-
"commands",
|
|
10038
|
-
"hardis",
|
|
10039
|
-
"project",
|
|
10040
|
-
"configure",
|
|
10041
|
-
"auth.js"
|
|
10042
|
-
],
|
|
10043
|
-
"aliasPermutations": [],
|
|
10044
|
-
"permutations": [
|
|
10045
|
-
"hardis:project:configure:auth",
|
|
10046
|
-
"project:hardis:configure:auth",
|
|
10047
|
-
"project:configure:hardis:auth",
|
|
10048
|
-
"project:configure:auth:hardis",
|
|
10049
|
-
"hardis:configure:project:auth",
|
|
10050
|
-
"configure:hardis:project:auth",
|
|
10051
|
-
"configure:project:hardis:auth",
|
|
10052
|
-
"configure:project:auth:hardis",
|
|
10053
|
-
"hardis:configure:auth:project",
|
|
10054
|
-
"configure:hardis:auth:project",
|
|
10055
|
-
"configure:auth:hardis:project",
|
|
10056
|
-
"configure:auth:project:hardis",
|
|
10057
|
-
"hardis:project:auth:configure",
|
|
10058
|
-
"project:hardis:auth:configure",
|
|
10059
|
-
"project:auth:hardis:configure",
|
|
10060
|
-
"project:auth:configure:hardis",
|
|
10061
|
-
"hardis:auth:project:configure",
|
|
10062
|
-
"auth:hardis:project:configure",
|
|
10063
|
-
"auth:project:hardis:configure",
|
|
10064
|
-
"auth:project:configure:hardis",
|
|
10065
|
-
"hardis:auth:configure:project",
|
|
10066
|
-
"auth:hardis:configure:project",
|
|
10067
|
-
"auth:configure:hardis:project",
|
|
10068
|
-
"auth:configure:project:hardis"
|
|
10069
|
-
]
|
|
10070
|
-
},
|
|
10071
|
-
"hardis:project:convert:profilestopermsets": {
|
|
10072
|
-
"aliases": [],
|
|
10073
|
-
"args": {},
|
|
10074
|
-
"description": "\n## Command Behavior\n\n**Converts existing Salesforce Profiles into Permission Sets, facilitating a more granular and recommended security model.**\n\nThis command helps in migrating permissions from Profiles to Permission Sets, which is a best practice for managing user access in Salesforce. It creates a new Permission Set for each specified Profile, adopting a naming convention of `PS_PROFILENAME`.\n\nKey functionalities:\n\n- **Profile to Permission Set Conversion:** Automatically extracts permissions from a Profile and creates a corresponding Permission Set.\n- **Naming Convention:** New Permission Sets are named with a `PS_` prefix followed by the Profile name (e.g., `PS_Standard_User`).\n- **Exclusion Filter:** Allows you to exclude specific Profiles from the conversion process using the `--except` flag.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **External Plugin Integration:** It relies on the `shane-sfdx-plugins` (specifically the `sf shane:profile:convert` command) to perform the actual conversion.\n- **File System Scan:** It reads the contents of the `force-app/main/default/profiles` directory to identify all available Profile metadata files.\n- **Command Execution:** For each identified Profile (that is not excluded), it constructs and executes the `sf shane:profile:convert` command with the appropriate Profile name and desired Permission Set name.\n- **Error Handling:** Includes basic error handling for the external command execution.\n</details>\n",
|
|
10075
|
-
"examples": [
|
|
10076
|
-
"$ sf hardis:project:convert:profilestopermsets"
|
|
10077
|
-
],
|
|
10078
|
-
"flags": {
|
|
10079
|
-
"json": {
|
|
10080
|
-
"description": "Format output as json.",
|
|
10081
|
-
"helpGroup": "GLOBAL",
|
|
10082
|
-
"name": "json",
|
|
10083
|
-
"allowNo": false,
|
|
10084
|
-
"type": "boolean"
|
|
10085
|
-
},
|
|
10086
|
-
"flags-dir": {
|
|
10087
|
-
"helpGroup": "GLOBAL",
|
|
10088
|
-
"name": "flags-dir",
|
|
10089
|
-
"summary": "Import flag values from a directory.",
|
|
10090
|
-
"hasDynamicHelp": false,
|
|
10091
|
-
"multiple": false,
|
|
10092
|
-
"type": "option"
|
|
10093
|
-
},
|
|
10094
|
-
"except": {
|
|
10095
|
-
"char": "e",
|
|
10096
|
-
"description": "List of filters",
|
|
10097
|
-
"name": "except",
|
|
10098
|
-
"default": [],
|
|
10099
|
-
"hasDynamicHelp": false,
|
|
10100
|
-
"multiple": true,
|
|
10101
|
-
"type": "option"
|
|
10102
|
-
},
|
|
10103
|
-
"debug": {
|
|
10104
|
-
"char": "d",
|
|
10105
|
-
"description": "Activate debug mode (more logs)",
|
|
10106
|
-
"name": "debug",
|
|
10107
|
-
"allowNo": false,
|
|
10108
|
-
"type": "boolean"
|
|
10109
|
-
},
|
|
10110
|
-
"websocket": {
|
|
10111
|
-
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
10112
|
-
"name": "websocket",
|
|
10113
|
-
"hasDynamicHelp": false,
|
|
10002
|
+
"hasDynamicHelp": true,
|
|
10114
10003
|
"multiple": false,
|
|
10115
10004
|
"type": "option"
|
|
10116
10005
|
},
|
|
10117
|
-
"
|
|
10118
|
-
"
|
|
10119
|
-
|
|
10120
|
-
|
|
10121
|
-
"
|
|
10006
|
+
"target-dev-hub": {
|
|
10007
|
+
"aliases": [
|
|
10008
|
+
"targetdevhubusername"
|
|
10009
|
+
],
|
|
10010
|
+
"char": "v",
|
|
10011
|
+
"deprecateAliases": true,
|
|
10012
|
+
"name": "target-dev-hub",
|
|
10013
|
+
"noCacheDefault": true,
|
|
10014
|
+
"required": false,
|
|
10015
|
+
"summary": "Username or alias of the Dev Hub org.",
|
|
10016
|
+
"hasDynamicHelp": true,
|
|
10017
|
+
"multiple": false,
|
|
10018
|
+
"type": "option"
|
|
10122
10019
|
}
|
|
10123
10020
|
},
|
|
10124
|
-
"hasDynamicHelp":
|
|
10021
|
+
"hasDynamicHelp": true,
|
|
10125
10022
|
"hiddenAliases": [],
|
|
10126
|
-
"id": "hardis:project:
|
|
10023
|
+
"id": "hardis:project:configure:auth",
|
|
10127
10024
|
"pluginAlias": "sfdx-hardis",
|
|
10128
10025
|
"pluginName": "sfdx-hardis",
|
|
10129
10026
|
"pluginType": "core",
|
|
10130
10027
|
"strict": true,
|
|
10131
10028
|
"enableJsonFlag": true,
|
|
10132
|
-
"title": "
|
|
10133
|
-
"requiresProject":
|
|
10134
|
-
"
|
|
10135
|
-
"
|
|
10029
|
+
"title": "Configure authentication",
|
|
10030
|
+
"requiresProject": false,
|
|
10031
|
+
"requiresDependencies": [
|
|
10032
|
+
"openssl"
|
|
10136
10033
|
],
|
|
10137
10034
|
"isESM": true,
|
|
10138
10035
|
"relativePath": [
|
|
@@ -10140,35 +10037,35 @@
|
|
|
10140
10037
|
"commands",
|
|
10141
10038
|
"hardis",
|
|
10142
10039
|
"project",
|
|
10143
|
-
"
|
|
10144
|
-
"
|
|
10040
|
+
"configure",
|
|
10041
|
+
"auth.js"
|
|
10145
10042
|
],
|
|
10146
10043
|
"aliasPermutations": [],
|
|
10147
10044
|
"permutations": [
|
|
10148
|
-
"hardis:project:
|
|
10149
|
-
"project:hardis:
|
|
10150
|
-
"project:
|
|
10151
|
-
"project:
|
|
10152
|
-
"hardis:
|
|
10153
|
-
"
|
|
10154
|
-
"
|
|
10155
|
-
"
|
|
10156
|
-
"hardis:
|
|
10157
|
-
"
|
|
10158
|
-
"
|
|
10159
|
-
"
|
|
10160
|
-
"hardis:project:
|
|
10161
|
-
"project:hardis:
|
|
10162
|
-
"project:
|
|
10163
|
-
"project:
|
|
10164
|
-
"hardis:
|
|
10165
|
-
"
|
|
10166
|
-
"
|
|
10167
|
-
"
|
|
10168
|
-
"hardis:
|
|
10169
|
-
"
|
|
10170
|
-
"
|
|
10171
|
-
"
|
|
10045
|
+
"hardis:project:configure:auth",
|
|
10046
|
+
"project:hardis:configure:auth",
|
|
10047
|
+
"project:configure:hardis:auth",
|
|
10048
|
+
"project:configure:auth:hardis",
|
|
10049
|
+
"hardis:configure:project:auth",
|
|
10050
|
+
"configure:hardis:project:auth",
|
|
10051
|
+
"configure:project:hardis:auth",
|
|
10052
|
+
"configure:project:auth:hardis",
|
|
10053
|
+
"hardis:configure:auth:project",
|
|
10054
|
+
"configure:hardis:auth:project",
|
|
10055
|
+
"configure:auth:hardis:project",
|
|
10056
|
+
"configure:auth:project:hardis",
|
|
10057
|
+
"hardis:project:auth:configure",
|
|
10058
|
+
"project:hardis:auth:configure",
|
|
10059
|
+
"project:auth:hardis:configure",
|
|
10060
|
+
"project:auth:configure:hardis",
|
|
10061
|
+
"hardis:auth:project:configure",
|
|
10062
|
+
"auth:hardis:project:configure",
|
|
10063
|
+
"auth:project:hardis:configure",
|
|
10064
|
+
"auth:project:configure:hardis",
|
|
10065
|
+
"hardis:auth:configure:project",
|
|
10066
|
+
"auth:hardis:configure:project",
|
|
10067
|
+
"auth:configure:hardis:project",
|
|
10068
|
+
"auth:configure:project:hardis"
|
|
10172
10069
|
]
|
|
10173
10070
|
},
|
|
10174
10071
|
"hardis:project:clean:emptyitems": {
|
|
@@ -11757,127 +11654,12 @@
|
|
|
11757
11654
|
"xml:clean:project:hardis"
|
|
11758
11655
|
]
|
|
11759
11656
|
},
|
|
11760
|
-
"hardis:project:
|
|
11761
|
-
"aliases": [],
|
|
11762
|
-
"args": {},
|
|
11763
|
-
"description": "\n## Command Behavior\n\n**Interactively updates tab visibility settings in Salesforce profiles, addressing a common issue where tab visibilities are not correctly retrieved by `sf project retrieve start`.**\n\nThis command provides a user-friendly interface to manage tab settings within your profile XML files, ensuring that your local project accurately reflects the intended tab configurations in your Salesforce org.\n\nKey functionalities:\n\n- **Interactive Tab Selection:** Displays a multi-select menu of all available tabs in your org, allowing you to choose which tabs to update.\n- **Visibility Control:** Lets you set the visibility for the selected tabs to either `DefaultOn` (Visible) or `Hidden`.\n- **Profile Selection:** Presents a multi-select menu of all .profile-meta.xml files in your project, allowing you to apply the tab visibility changes to specific profiles.\n- **XML Updates:** Modifies the <tabVisibilities> section of the selected profile XML files to reflect the chosen tab settings. If a tab visibility setting already exists for a selected tab, it will be updated; otherwise, a new one will be added.\n- **Sorted Output:** The <tabVisibilities> in the updated profile XML files are sorted alphabetically for consistency and readability.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **SOQL Queries (Tooling API):** It queries the `TabDefinition` object using `soqlQueryTooling` to retrieve a list of all available tabs in the target org.\n- **File Discovery:** Uses `glob` to find all .profile-meta.xml files within the specified project path.\n- **Interactive Prompts:** Leverages the `prompts` library to create interactive menus for selecting tabs, visibility settings, and profiles.\n- **XML Parsing and Manipulation:** Uses `parseXmlFile` to read the content of profile XML files and `writeXmlFile` to write the modified content back. It manipulates the `tabVisibilities` array within the parsed XML to add or update tab settings.\n- **Array Sorting:** Employs the `sort-array` library to sort the `tabVisibilities` alphabetically by tab name.\n- **Logging:** Provides feedback to the user about which profiles have been updated and a summary of the changes.\n</details>\n",
|
|
11764
|
-
"examples": [
|
|
11765
|
-
"$ sf hardis:project:fix:profiletabs"
|
|
11766
|
-
],
|
|
11767
|
-
"flags": {
|
|
11768
|
-
"json": {
|
|
11769
|
-
"description": "Format output as json.",
|
|
11770
|
-
"helpGroup": "GLOBAL",
|
|
11771
|
-
"name": "json",
|
|
11772
|
-
"allowNo": false,
|
|
11773
|
-
"type": "boolean"
|
|
11774
|
-
},
|
|
11775
|
-
"flags-dir": {
|
|
11776
|
-
"helpGroup": "GLOBAL",
|
|
11777
|
-
"name": "flags-dir",
|
|
11778
|
-
"summary": "Import flag values from a directory.",
|
|
11779
|
-
"hasDynamicHelp": false,
|
|
11780
|
-
"multiple": false,
|
|
11781
|
-
"type": "option"
|
|
11782
|
-
},
|
|
11783
|
-
"path": {
|
|
11784
|
-
"char": "p",
|
|
11785
|
-
"description": "Root folder",
|
|
11786
|
-
"name": "path",
|
|
11787
|
-
"default": "/home/runner/work/sfdx-hardis/sfdx-hardis",
|
|
11788
|
-
"hasDynamicHelp": false,
|
|
11789
|
-
"multiple": false,
|
|
11790
|
-
"type": "option"
|
|
11791
|
-
},
|
|
11792
|
-
"debug": {
|
|
11793
|
-
"char": "d",
|
|
11794
|
-
"description": "Activate debug mode (more logs)",
|
|
11795
|
-
"name": "debug",
|
|
11796
|
-
"allowNo": false,
|
|
11797
|
-
"type": "boolean"
|
|
11798
|
-
},
|
|
11799
|
-
"websocket": {
|
|
11800
|
-
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
11801
|
-
"name": "websocket",
|
|
11802
|
-
"hasDynamicHelp": false,
|
|
11803
|
-
"multiple": false,
|
|
11804
|
-
"type": "option"
|
|
11805
|
-
},
|
|
11806
|
-
"skipauth": {
|
|
11807
|
-
"description": "Skip authentication check when a default username is required",
|
|
11808
|
-
"name": "skipauth",
|
|
11809
|
-
"allowNo": false,
|
|
11810
|
-
"type": "boolean"
|
|
11811
|
-
},
|
|
11812
|
-
"target-org": {
|
|
11813
|
-
"aliases": [
|
|
11814
|
-
"targetusername",
|
|
11815
|
-
"u"
|
|
11816
|
-
],
|
|
11817
|
-
"char": "o",
|
|
11818
|
-
"deprecateAliases": true,
|
|
11819
|
-
"name": "target-org",
|
|
11820
|
-
"noCacheDefault": true,
|
|
11821
|
-
"required": true,
|
|
11822
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
11823
|
-
"hasDynamicHelp": true,
|
|
11824
|
-
"multiple": false,
|
|
11825
|
-
"type": "option"
|
|
11826
|
-
}
|
|
11827
|
-
},
|
|
11828
|
-
"hasDynamicHelp": true,
|
|
11829
|
-
"hiddenAliases": [],
|
|
11830
|
-
"id": "hardis:project:fix:profiletabs",
|
|
11831
|
-
"pluginAlias": "sfdx-hardis",
|
|
11832
|
-
"pluginName": "sfdx-hardis",
|
|
11833
|
-
"pluginType": "core",
|
|
11834
|
-
"strict": true,
|
|
11835
|
-
"enableJsonFlag": true,
|
|
11836
|
-
"title": "Fix profiles to add tabs that are not retrieved by SF CLI",
|
|
11837
|
-
"requiresProject": true,
|
|
11838
|
-
"isESM": true,
|
|
11839
|
-
"relativePath": [
|
|
11840
|
-
"lib",
|
|
11841
|
-
"commands",
|
|
11842
|
-
"hardis",
|
|
11843
|
-
"project",
|
|
11844
|
-
"fix",
|
|
11845
|
-
"profiletabs.js"
|
|
11846
|
-
],
|
|
11847
|
-
"aliasPermutations": [],
|
|
11848
|
-
"permutations": [
|
|
11849
|
-
"hardis:project:fix:profiletabs",
|
|
11850
|
-
"project:hardis:fix:profiletabs",
|
|
11851
|
-
"project:fix:hardis:profiletabs",
|
|
11852
|
-
"project:fix:profiletabs:hardis",
|
|
11853
|
-
"hardis:fix:project:profiletabs",
|
|
11854
|
-
"fix:hardis:project:profiletabs",
|
|
11855
|
-
"fix:project:hardis:profiletabs",
|
|
11856
|
-
"fix:project:profiletabs:hardis",
|
|
11857
|
-
"hardis:fix:profiletabs:project",
|
|
11858
|
-
"fix:hardis:profiletabs:project",
|
|
11859
|
-
"fix:profiletabs:hardis:project",
|
|
11860
|
-
"fix:profiletabs:project:hardis",
|
|
11861
|
-
"hardis:project:profiletabs:fix",
|
|
11862
|
-
"project:hardis:profiletabs:fix",
|
|
11863
|
-
"project:profiletabs:hardis:fix",
|
|
11864
|
-
"project:profiletabs:fix:hardis",
|
|
11865
|
-
"hardis:profiletabs:project:fix",
|
|
11866
|
-
"profiletabs:hardis:project:fix",
|
|
11867
|
-
"profiletabs:project:hardis:fix",
|
|
11868
|
-
"profiletabs:project:fix:hardis",
|
|
11869
|
-
"hardis:profiletabs:fix:project",
|
|
11870
|
-
"profiletabs:hardis:fix:project",
|
|
11871
|
-
"profiletabs:fix:hardis:project",
|
|
11872
|
-
"profiletabs:fix:project:hardis"
|
|
11873
|
-
]
|
|
11874
|
-
},
|
|
11875
|
-
"hardis:project:fix:v53flexipages": {
|
|
11657
|
+
"hardis:project:convert:profilestopermsets": {
|
|
11876
11658
|
"aliases": [],
|
|
11877
11659
|
"args": {},
|
|
11878
|
-
"description": "\n## Command Behavior\n\n**
|
|
11660
|
+
"description": "\n## Command Behavior\n\n**Converts existing Salesforce Profiles into Permission Sets, facilitating a more granular and recommended security model.**\n\nThis command helps in migrating permissions from Profiles to Permission Sets, which is a best practice for managing user access in Salesforce. It creates a new Permission Set for each specified Profile, adopting a naming convention of `PS_PROFILENAME`.\n\nKey functionalities:\n\n- **Profile to Permission Set Conversion:** Automatically extracts permissions from a Profile and creates a corresponding Permission Set.\n- **Naming Convention:** New Permission Sets are named with a `PS_` prefix followed by the Profile name (e.g., `PS_Standard_User`).\n- **Exclusion Filter:** Allows you to exclude specific Profiles from the conversion process using the `--except` flag.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **External Plugin Integration:** It relies on the `shane-sfdx-plugins` (specifically the `sf shane:profile:convert` command) to perform the actual conversion.\n- **File System Scan:** It reads the contents of the `force-app/main/default/profiles` directory to identify all available Profile metadata files.\n- **Command Execution:** For each identified Profile (that is not excluded), it constructs and executes the `sf shane:profile:convert` command with the appropriate Profile name and desired Permission Set name.\n- **Error Handling:** Includes basic error handling for the external command execution.\n</details>\n",
|
|
11879
11661
|
"examples": [
|
|
11880
|
-
"$ sf hardis:project:
|
|
11662
|
+
"$ sf hardis:project:convert:profilestopermsets"
|
|
11881
11663
|
],
|
|
11882
11664
|
"flags": {
|
|
11883
11665
|
"json": {
|
|
@@ -11895,13 +11677,13 @@
|
|
|
11895
11677
|
"multiple": false,
|
|
11896
11678
|
"type": "option"
|
|
11897
11679
|
},
|
|
11898
|
-
"
|
|
11899
|
-
"char": "
|
|
11900
|
-
"description": "
|
|
11901
|
-
"name": "
|
|
11902
|
-
"default":
|
|
11680
|
+
"except": {
|
|
11681
|
+
"char": "e",
|
|
11682
|
+
"description": "List of filters",
|
|
11683
|
+
"name": "except",
|
|
11684
|
+
"default": [],
|
|
11903
11685
|
"hasDynamicHelp": false,
|
|
11904
|
-
"multiple":
|
|
11686
|
+
"multiple": true,
|
|
11905
11687
|
"type": "option"
|
|
11906
11688
|
},
|
|
11907
11689
|
"debug": {
|
|
@@ -11927,49 +11709,52 @@
|
|
|
11927
11709
|
},
|
|
11928
11710
|
"hasDynamicHelp": false,
|
|
11929
11711
|
"hiddenAliases": [],
|
|
11930
|
-
"id": "hardis:project:
|
|
11712
|
+
"id": "hardis:project:convert:profilestopermsets",
|
|
11931
11713
|
"pluginAlias": "sfdx-hardis",
|
|
11932
11714
|
"pluginName": "sfdx-hardis",
|
|
11933
11715
|
"pluginType": "core",
|
|
11934
11716
|
"strict": true,
|
|
11935
|
-
"enableJsonFlag": true,
|
|
11936
|
-
"title": "
|
|
11937
|
-
"requiresProject": true,
|
|
11938
|
-
"
|
|
11939
|
-
|
|
11940
|
-
|
|
11941
|
-
|
|
11942
|
-
|
|
11943
|
-
"
|
|
11944
|
-
"
|
|
11945
|
-
"
|
|
11946
|
-
|
|
11947
|
-
|
|
11948
|
-
|
|
11949
|
-
|
|
11950
|
-
|
|
11951
|
-
|
|
11952
|
-
"project:
|
|
11953
|
-
"hardis:
|
|
11954
|
-
"
|
|
11955
|
-
"
|
|
11956
|
-
"
|
|
11957
|
-
"hardis:
|
|
11958
|
-
"
|
|
11959
|
-
"
|
|
11960
|
-
"
|
|
11961
|
-
"hardis:project
|
|
11962
|
-
"
|
|
11963
|
-
"project:
|
|
11964
|
-
"project:
|
|
11965
|
-
"hardis:
|
|
11966
|
-
"
|
|
11967
|
-
"
|
|
11968
|
-
"
|
|
11969
|
-
"hardis:
|
|
11970
|
-
"
|
|
11971
|
-
"
|
|
11972
|
-
"
|
|
11717
|
+
"enableJsonFlag": true,
|
|
11718
|
+
"title": "Convert Profiles into Permission Sets",
|
|
11719
|
+
"requiresProject": true,
|
|
11720
|
+
"requiresSfdxPlugins": [
|
|
11721
|
+
"shane-sfdx-plugins"
|
|
11722
|
+
],
|
|
11723
|
+
"isESM": true,
|
|
11724
|
+
"relativePath": [
|
|
11725
|
+
"lib",
|
|
11726
|
+
"commands",
|
|
11727
|
+
"hardis",
|
|
11728
|
+
"project",
|
|
11729
|
+
"convert",
|
|
11730
|
+
"profilestopermsets.js"
|
|
11731
|
+
],
|
|
11732
|
+
"aliasPermutations": [],
|
|
11733
|
+
"permutations": [
|
|
11734
|
+
"hardis:project:convert:profilestopermsets",
|
|
11735
|
+
"project:hardis:convert:profilestopermsets",
|
|
11736
|
+
"project:convert:hardis:profilestopermsets",
|
|
11737
|
+
"project:convert:profilestopermsets:hardis",
|
|
11738
|
+
"hardis:convert:project:profilestopermsets",
|
|
11739
|
+
"convert:hardis:project:profilestopermsets",
|
|
11740
|
+
"convert:project:hardis:profilestopermsets",
|
|
11741
|
+
"convert:project:profilestopermsets:hardis",
|
|
11742
|
+
"hardis:convert:profilestopermsets:project",
|
|
11743
|
+
"convert:hardis:profilestopermsets:project",
|
|
11744
|
+
"convert:profilestopermsets:hardis:project",
|
|
11745
|
+
"convert:profilestopermsets:project:hardis",
|
|
11746
|
+
"hardis:project:profilestopermsets:convert",
|
|
11747
|
+
"project:hardis:profilestopermsets:convert",
|
|
11748
|
+
"project:profilestopermsets:hardis:convert",
|
|
11749
|
+
"project:profilestopermsets:convert:hardis",
|
|
11750
|
+
"hardis:profilestopermsets:project:convert",
|
|
11751
|
+
"profilestopermsets:hardis:project:convert",
|
|
11752
|
+
"profilestopermsets:project:hardis:convert",
|
|
11753
|
+
"profilestopermsets:project:convert:hardis",
|
|
11754
|
+
"hardis:profilestopermsets:convert:project",
|
|
11755
|
+
"profilestopermsets:hardis:convert:project",
|
|
11756
|
+
"profilestopermsets:convert:hardis:project",
|
|
11757
|
+
"profilestopermsets:convert:project:hardis"
|
|
11973
11758
|
]
|
|
11974
11759
|
},
|
|
11975
11760
|
"hardis:project:deploy:notify": {
|
|
@@ -13146,6 +12931,221 @@
|
|
|
13146
12931
|
"validate:deploy:project:hardis"
|
|
13147
12932
|
]
|
|
13148
12933
|
},
|
|
12934
|
+
"hardis:project:fix:profiletabs": {
|
|
12935
|
+
"aliases": [],
|
|
12936
|
+
"args": {},
|
|
12937
|
+
"description": "\n## Command Behavior\n\n**Interactively updates tab visibility settings in Salesforce profiles, addressing a common issue where tab visibilities are not correctly retrieved by `sf project retrieve start`.**\n\nThis command provides a user-friendly interface to manage tab settings within your profile XML files, ensuring that your local project accurately reflects the intended tab configurations in your Salesforce org.\n\nKey functionalities:\n\n- **Interactive Tab Selection:** Displays a multi-select menu of all available tabs in your org, allowing you to choose which tabs to update.\n- **Visibility Control:** Lets you set the visibility for the selected tabs to either `DefaultOn` (Visible) or `Hidden`.\n- **Profile Selection:** Presents a multi-select menu of all .profile-meta.xml files in your project, allowing you to apply the tab visibility changes to specific profiles.\n- **XML Updates:** Modifies the <tabVisibilities> section of the selected profile XML files to reflect the chosen tab settings. If a tab visibility setting already exists for a selected tab, it will be updated; otherwise, a new one will be added.\n- **Sorted Output:** The <tabVisibilities> in the updated profile XML files are sorted alphabetically for consistency and readability.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **SOQL Queries (Tooling API):** It queries the `TabDefinition` object using `soqlQueryTooling` to retrieve a list of all available tabs in the target org.\n- **File Discovery:** Uses `glob` to find all .profile-meta.xml files within the specified project path.\n- **Interactive Prompts:** Leverages the `prompts` library to create interactive menus for selecting tabs, visibility settings, and profiles.\n- **XML Parsing and Manipulation:** Uses `parseXmlFile` to read the content of profile XML files and `writeXmlFile` to write the modified content back. It manipulates the `tabVisibilities` array within the parsed XML to add or update tab settings.\n- **Array Sorting:** Employs the `sort-array` library to sort the `tabVisibilities` alphabetically by tab name.\n- **Logging:** Provides feedback to the user about which profiles have been updated and a summary of the changes.\n</details>\n",
|
|
12938
|
+
"examples": [
|
|
12939
|
+
"$ sf hardis:project:fix:profiletabs"
|
|
12940
|
+
],
|
|
12941
|
+
"flags": {
|
|
12942
|
+
"json": {
|
|
12943
|
+
"description": "Format output as json.",
|
|
12944
|
+
"helpGroup": "GLOBAL",
|
|
12945
|
+
"name": "json",
|
|
12946
|
+
"allowNo": false,
|
|
12947
|
+
"type": "boolean"
|
|
12948
|
+
},
|
|
12949
|
+
"flags-dir": {
|
|
12950
|
+
"helpGroup": "GLOBAL",
|
|
12951
|
+
"name": "flags-dir",
|
|
12952
|
+
"summary": "Import flag values from a directory.",
|
|
12953
|
+
"hasDynamicHelp": false,
|
|
12954
|
+
"multiple": false,
|
|
12955
|
+
"type": "option"
|
|
12956
|
+
},
|
|
12957
|
+
"path": {
|
|
12958
|
+
"char": "p",
|
|
12959
|
+
"description": "Root folder",
|
|
12960
|
+
"name": "path",
|
|
12961
|
+
"default": "/home/runner/work/sfdx-hardis/sfdx-hardis",
|
|
12962
|
+
"hasDynamicHelp": false,
|
|
12963
|
+
"multiple": false,
|
|
12964
|
+
"type": "option"
|
|
12965
|
+
},
|
|
12966
|
+
"debug": {
|
|
12967
|
+
"char": "d",
|
|
12968
|
+
"description": "Activate debug mode (more logs)",
|
|
12969
|
+
"name": "debug",
|
|
12970
|
+
"allowNo": false,
|
|
12971
|
+
"type": "boolean"
|
|
12972
|
+
},
|
|
12973
|
+
"websocket": {
|
|
12974
|
+
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
12975
|
+
"name": "websocket",
|
|
12976
|
+
"hasDynamicHelp": false,
|
|
12977
|
+
"multiple": false,
|
|
12978
|
+
"type": "option"
|
|
12979
|
+
},
|
|
12980
|
+
"skipauth": {
|
|
12981
|
+
"description": "Skip authentication check when a default username is required",
|
|
12982
|
+
"name": "skipauth",
|
|
12983
|
+
"allowNo": false,
|
|
12984
|
+
"type": "boolean"
|
|
12985
|
+
},
|
|
12986
|
+
"target-org": {
|
|
12987
|
+
"aliases": [
|
|
12988
|
+
"targetusername",
|
|
12989
|
+
"u"
|
|
12990
|
+
],
|
|
12991
|
+
"char": "o",
|
|
12992
|
+
"deprecateAliases": true,
|
|
12993
|
+
"name": "target-org",
|
|
12994
|
+
"noCacheDefault": true,
|
|
12995
|
+
"required": true,
|
|
12996
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
12997
|
+
"hasDynamicHelp": true,
|
|
12998
|
+
"multiple": false,
|
|
12999
|
+
"type": "option"
|
|
13000
|
+
}
|
|
13001
|
+
},
|
|
13002
|
+
"hasDynamicHelp": true,
|
|
13003
|
+
"hiddenAliases": [],
|
|
13004
|
+
"id": "hardis:project:fix:profiletabs",
|
|
13005
|
+
"pluginAlias": "sfdx-hardis",
|
|
13006
|
+
"pluginName": "sfdx-hardis",
|
|
13007
|
+
"pluginType": "core",
|
|
13008
|
+
"strict": true,
|
|
13009
|
+
"enableJsonFlag": true,
|
|
13010
|
+
"title": "Fix profiles to add tabs that are not retrieved by SF CLI",
|
|
13011
|
+
"requiresProject": true,
|
|
13012
|
+
"isESM": true,
|
|
13013
|
+
"relativePath": [
|
|
13014
|
+
"lib",
|
|
13015
|
+
"commands",
|
|
13016
|
+
"hardis",
|
|
13017
|
+
"project",
|
|
13018
|
+
"fix",
|
|
13019
|
+
"profiletabs.js"
|
|
13020
|
+
],
|
|
13021
|
+
"aliasPermutations": [],
|
|
13022
|
+
"permutations": [
|
|
13023
|
+
"hardis:project:fix:profiletabs",
|
|
13024
|
+
"project:hardis:fix:profiletabs",
|
|
13025
|
+
"project:fix:hardis:profiletabs",
|
|
13026
|
+
"project:fix:profiletabs:hardis",
|
|
13027
|
+
"hardis:fix:project:profiletabs",
|
|
13028
|
+
"fix:hardis:project:profiletabs",
|
|
13029
|
+
"fix:project:hardis:profiletabs",
|
|
13030
|
+
"fix:project:profiletabs:hardis",
|
|
13031
|
+
"hardis:fix:profiletabs:project",
|
|
13032
|
+
"fix:hardis:profiletabs:project",
|
|
13033
|
+
"fix:profiletabs:hardis:project",
|
|
13034
|
+
"fix:profiletabs:project:hardis",
|
|
13035
|
+
"hardis:project:profiletabs:fix",
|
|
13036
|
+
"project:hardis:profiletabs:fix",
|
|
13037
|
+
"project:profiletabs:hardis:fix",
|
|
13038
|
+
"project:profiletabs:fix:hardis",
|
|
13039
|
+
"hardis:profiletabs:project:fix",
|
|
13040
|
+
"profiletabs:hardis:project:fix",
|
|
13041
|
+
"profiletabs:project:hardis:fix",
|
|
13042
|
+
"profiletabs:project:fix:hardis",
|
|
13043
|
+
"hardis:profiletabs:fix:project",
|
|
13044
|
+
"profiletabs:hardis:fix:project",
|
|
13045
|
+
"profiletabs:fix:hardis:project",
|
|
13046
|
+
"profiletabs:fix:project:hardis"
|
|
13047
|
+
]
|
|
13048
|
+
},
|
|
13049
|
+
"hardis:project:fix:v53flexipages": {
|
|
13050
|
+
"aliases": [],
|
|
13051
|
+
"args": {},
|
|
13052
|
+
"description": "\n## Command Behavior\n\n**Fixes Salesforce FlexiPages for compatibility with API Version 53.0 (Winter '22 release) by adding missing identifiers to component instances.**\n\nSalesforce introduced a change in API Version 53.0 that requires `identifier` tags within `componentInstance` and `fieldInstance` elements in FlexiPage metadata. If these identifiers are missing, deployments to orgs with API version 53.0 or higher will fail. This command automates the process of adding these missing identifiers, ensuring your FlexiPages remain deployable.\n\nKey functionalities:\n\n- **Targeted FlexiPage Processing:** Scans all .flexipage-meta.xml files within the specified root folder (defaults to current working directory).\n- **Identifier Injection:** Inserts a unique `identifier` tag (e.g., `SFDX_HARDIS_REPLACEMENT_ID`) into `componentInstance` and `fieldInstance` elements that lack one.\n\n**Important Note:** After running this command, ensure you update your `apiVersion` to `53.0` (or higher) in your `package.xml` and `sfdx-project.json` files.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **File Discovery:** Uses `glob` to find all .flexipage-meta.xml files.\n- **Content Reading:** Reads the XML content of each FlexiPage file.\n- **Regular Expression Replacement:** Employs a set of regular expressions to identify specific XML patterns (componentName.../componentName.../componentInstance, componentName.../componentName.../visibilityRule, fieldItem.../fieldItem.../fieldInstance) that are missing the `identifier` tag.\n- **Dynamic ID Generation:** For each match, it generates a unique identifier (e.g., `sfdxHardisIdX`) and injects it into the XML structure.\n- **File Writing:** If changes are made, the modified XML content is written back to the FlexiPage file using `fs.writeFile`.\n- **Logging:** Provides messages about which FlexiPages are being processed and a summary of the total number of identifiers added.\n</details>\n",
|
|
13053
|
+
"examples": [
|
|
13054
|
+
"$ sf hardis:project:fix:v53flexipages"
|
|
13055
|
+
],
|
|
13056
|
+
"flags": {
|
|
13057
|
+
"json": {
|
|
13058
|
+
"description": "Format output as json.",
|
|
13059
|
+
"helpGroup": "GLOBAL",
|
|
13060
|
+
"name": "json",
|
|
13061
|
+
"allowNo": false,
|
|
13062
|
+
"type": "boolean"
|
|
13063
|
+
},
|
|
13064
|
+
"flags-dir": {
|
|
13065
|
+
"helpGroup": "GLOBAL",
|
|
13066
|
+
"name": "flags-dir",
|
|
13067
|
+
"summary": "Import flag values from a directory.",
|
|
13068
|
+
"hasDynamicHelp": false,
|
|
13069
|
+
"multiple": false,
|
|
13070
|
+
"type": "option"
|
|
13071
|
+
},
|
|
13072
|
+
"path": {
|
|
13073
|
+
"char": "p",
|
|
13074
|
+
"description": "Root folder",
|
|
13075
|
+
"name": "path",
|
|
13076
|
+
"default": "/home/runner/work/sfdx-hardis/sfdx-hardis",
|
|
13077
|
+
"hasDynamicHelp": false,
|
|
13078
|
+
"multiple": false,
|
|
13079
|
+
"type": "option"
|
|
13080
|
+
},
|
|
13081
|
+
"debug": {
|
|
13082
|
+
"char": "d",
|
|
13083
|
+
"description": "Activate debug mode (more logs)",
|
|
13084
|
+
"name": "debug",
|
|
13085
|
+
"allowNo": false,
|
|
13086
|
+
"type": "boolean"
|
|
13087
|
+
},
|
|
13088
|
+
"websocket": {
|
|
13089
|
+
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
13090
|
+
"name": "websocket",
|
|
13091
|
+
"hasDynamicHelp": false,
|
|
13092
|
+
"multiple": false,
|
|
13093
|
+
"type": "option"
|
|
13094
|
+
},
|
|
13095
|
+
"skipauth": {
|
|
13096
|
+
"description": "Skip authentication check when a default username is required",
|
|
13097
|
+
"name": "skipauth",
|
|
13098
|
+
"allowNo": false,
|
|
13099
|
+
"type": "boolean"
|
|
13100
|
+
}
|
|
13101
|
+
},
|
|
13102
|
+
"hasDynamicHelp": false,
|
|
13103
|
+
"hiddenAliases": [],
|
|
13104
|
+
"id": "hardis:project:fix:v53flexipages",
|
|
13105
|
+
"pluginAlias": "sfdx-hardis",
|
|
13106
|
+
"pluginName": "sfdx-hardis",
|
|
13107
|
+
"pluginType": "core",
|
|
13108
|
+
"strict": true,
|
|
13109
|
+
"enableJsonFlag": true,
|
|
13110
|
+
"title": "Fix flexipages for v53",
|
|
13111
|
+
"requiresProject": true,
|
|
13112
|
+
"isESM": true,
|
|
13113
|
+
"relativePath": [
|
|
13114
|
+
"lib",
|
|
13115
|
+
"commands",
|
|
13116
|
+
"hardis",
|
|
13117
|
+
"project",
|
|
13118
|
+
"fix",
|
|
13119
|
+
"v53flexipages.js"
|
|
13120
|
+
],
|
|
13121
|
+
"aliasPermutations": [],
|
|
13122
|
+
"permutations": [
|
|
13123
|
+
"hardis:project:fix:v53flexipages",
|
|
13124
|
+
"project:hardis:fix:v53flexipages",
|
|
13125
|
+
"project:fix:hardis:v53flexipages",
|
|
13126
|
+
"project:fix:v53flexipages:hardis",
|
|
13127
|
+
"hardis:fix:project:v53flexipages",
|
|
13128
|
+
"fix:hardis:project:v53flexipages",
|
|
13129
|
+
"fix:project:hardis:v53flexipages",
|
|
13130
|
+
"fix:project:v53flexipages:hardis",
|
|
13131
|
+
"hardis:fix:v53flexipages:project",
|
|
13132
|
+
"fix:hardis:v53flexipages:project",
|
|
13133
|
+
"fix:v53flexipages:hardis:project",
|
|
13134
|
+
"fix:v53flexipages:project:hardis",
|
|
13135
|
+
"hardis:project:v53flexipages:fix",
|
|
13136
|
+
"project:hardis:v53flexipages:fix",
|
|
13137
|
+
"project:v53flexipages:hardis:fix",
|
|
13138
|
+
"project:v53flexipages:fix:hardis",
|
|
13139
|
+
"hardis:v53flexipages:project:fix",
|
|
13140
|
+
"v53flexipages:hardis:project:fix",
|
|
13141
|
+
"v53flexipages:project:hardis:fix",
|
|
13142
|
+
"v53flexipages:project:fix:hardis",
|
|
13143
|
+
"hardis:v53flexipages:fix:project",
|
|
13144
|
+
"v53flexipages:hardis:fix:project",
|
|
13145
|
+
"v53flexipages:fix:hardis:project",
|
|
13146
|
+
"v53flexipages:fix:project:hardis"
|
|
13147
|
+
]
|
|
13148
|
+
},
|
|
13149
13149
|
"hardis:project:generate:bypass": {
|
|
13150
13150
|
"aliases": [],
|
|
13151
13151
|
"args": {},
|
|
@@ -15719,5 +15719,5 @@
|
|
|
15719
15719
|
]
|
|
15720
15720
|
}
|
|
15721
15721
|
},
|
|
15722
|
-
"version": "6.
|
|
15722
|
+
"version": "6.15.0"
|
|
15723
15723
|
}
|