sfdx-hardis 6.9.1-alpha202510270034.0 → 6.9.1-alpha202510282151.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.
Files changed (29) hide show
  1. package/CHANGELOG.md +1 -0
  2. package/lib/commands/hardis/doc/mkdocs-to-cf.js +38 -39
  3. package/lib/commands/hardis/doc/mkdocs-to-cf.js.map +1 -1
  4. package/lib/common/actionsProvider/actionsProvider.d.ts +4 -0
  5. package/lib/common/actionsProvider/actionsProvider.js +56 -2
  6. package/lib/common/actionsProvider/actionsProvider.js.map +1 -1
  7. package/lib/common/actionsProvider/apexAction.d.ts +1 -1
  8. package/lib/common/actionsProvider/apexAction.js +2 -2
  9. package/lib/common/actionsProvider/apexAction.js.map +1 -1
  10. package/lib/common/actionsProvider/commandAction.d.ts +1 -1
  11. package/lib/common/actionsProvider/commandAction.js +2 -1
  12. package/lib/common/actionsProvider/commandAction.js.map +1 -1
  13. package/lib/common/actionsProvider/dataAction.d.ts +1 -1
  14. package/lib/common/actionsProvider/dataAction.js +9 -2
  15. package/lib/common/actionsProvider/dataAction.js.map +1 -1
  16. package/lib/common/actionsProvider/manualAction.d.ts +1 -1
  17. package/lib/common/actionsProvider/manualAction.js +1 -1
  18. package/lib/common/actionsProvider/manualAction.js.map +1 -1
  19. package/lib/common/actionsProvider/publishCommunityAction.d.ts +1 -1
  20. package/lib/common/actionsProvider/publishCommunityAction.js +2 -2
  21. package/lib/common/actionsProvider/publishCommunityAction.js.map +1 -1
  22. package/lib/common/utils/authUtils.d.ts +15 -2
  23. package/lib/common/utils/authUtils.js +48 -29
  24. package/lib/common/utils/authUtils.js.map +1 -1
  25. package/lib/common/utils/orgUtils.d.ts +1 -0
  26. package/lib/common/utils/orgUtils.js +12 -0
  27. package/lib/common/utils/orgUtils.js.map +1 -1
  28. package/oclif.manifest.json +1046 -1046
  29. package/package.json +1 -1
@@ -132,13 +132,12 @@
132
132
  "clear:cache:hardis"
133
133
  ]
134
134
  },
135
- "hardis:auth:login": {
135
+ "hardis:config:get": {
136
136
  "aliases": [],
137
137
  "args": {},
138
- "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",
138
+ "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",
139
139
  "examples": [
140
- "$ sf hardis:auth:login",
141
- "CI=true CI_COMMIT_REF_NAME=monitoring_myclient sf hardis:auth:login"
140
+ "$ sf hardis:project:deploy:sources:metadata"
142
141
  ],
143
142
  "flags": {
144
143
  "json": {
@@ -156,28 +155,20 @@
156
155
  "multiple": false,
157
156
  "type": "option"
158
157
  },
159
- "instanceurl": {
160
- "char": "r",
161
- "description": "URL of org instance",
162
- "name": "instanceurl",
158
+ "level": {
159
+ "char": "l",
160
+ "description": "project,branch or user",
161
+ "name": "level",
162
+ "default": "project",
163
163
  "hasDynamicHelp": false,
164
164
  "multiple": false,
165
+ "options": [
166
+ "project",
167
+ "branch",
168
+ "user"
169
+ ],
165
170
  "type": "option"
166
171
  },
167
- "devhub": {
168
- "char": "h",
169
- "description": "Also connect associated DevHub",
170
- "name": "devhub",
171
- "allowNo": false,
172
- "type": "boolean"
173
- },
174
- "scratchorg": {
175
- "char": "s",
176
- "description": "Scratch org",
177
- "name": "scratchorg",
178
- "allowNo": false,
179
- "type": "boolean"
180
- },
181
172
  "debug": {
182
173
  "char": "d",
183
174
  "description": "Activate debug mode (more logs)",
@@ -201,38 +192,39 @@
201
192
  },
202
193
  "hasDynamicHelp": false,
203
194
  "hiddenAliases": [],
204
- "id": "hardis:auth:login",
195
+ "id": "hardis:config:get",
205
196
  "pluginAlias": "sfdx-hardis",
206
197
  "pluginName": "sfdx-hardis",
207
198
  "pluginType": "core",
208
199
  "strict": true,
209
200
  "enableJsonFlag": true,
210
- "title": "Login",
201
+ "title": "Deploy metadata sources to org",
211
202
  "requiresProject": false,
212
203
  "isESM": true,
213
204
  "relativePath": [
214
205
  "lib",
215
206
  "commands",
216
207
  "hardis",
217
- "auth",
218
- "login.js"
208
+ "config",
209
+ "get.js"
219
210
  ],
220
211
  "aliasPermutations": [],
221
212
  "permutations": [
222
- "hardis:auth:login",
223
- "auth:hardis:login",
224
- "auth:login:hardis",
225
- "hardis:login:auth",
226
- "login:hardis:auth",
227
- "login:auth:hardis"
213
+ "hardis:config:get",
214
+ "config:hardis:get",
215
+ "config:get:hardis",
216
+ "hardis:get:config",
217
+ "get:hardis:config",
218
+ "get:config:hardis"
228
219
  ]
229
220
  },
230
- "hardis:config:get": {
221
+ "hardis:auth:login": {
231
222
  "aliases": [],
232
223
  "args": {},
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",
224
+ "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",
234
225
  "examples": [
235
- "$ sf hardis:project:deploy:sources:metadata"
226
+ "$ sf hardis:auth:login",
227
+ "CI=true CI_COMMIT_REF_NAME=monitoring_myclient sf hardis:auth:login"
236
228
  ],
237
229
  "flags": {
238
230
  "json": {
@@ -250,20 +242,28 @@
250
242
  "multiple": false,
251
243
  "type": "option"
252
244
  },
253
- "level": {
254
- "char": "l",
255
- "description": "project,branch or user",
256
- "name": "level",
257
- "default": "project",
245
+ "instanceurl": {
246
+ "char": "r",
247
+ "description": "URL of org instance",
248
+ "name": "instanceurl",
258
249
  "hasDynamicHelp": false,
259
250
  "multiple": false,
260
- "options": [
261
- "project",
262
- "branch",
263
- "user"
264
- ],
265
251
  "type": "option"
266
252
  },
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:config:get",
290
+ "id": "hardis:auth:login",
291
291
  "pluginAlias": "sfdx-hardis",
292
292
  "pluginName": "sfdx-hardis",
293
293
  "pluginType": "core",
294
294
  "strict": true,
295
295
  "enableJsonFlag": true,
296
- "title": "Deploy metadata sources to org",
296
+ "title": "Login",
297
297
  "requiresProject": false,
298
298
  "isESM": true,
299
299
  "relativePath": [
300
300
  "lib",
301
301
  "commands",
302
302
  "hardis",
303
- "config",
304
- "get.js"
303
+ "auth",
304
+ "login.js"
305
305
  ],
306
306
  "aliasPermutations": [],
307
307
  "permutations": [
308
- "hardis:config:get",
309
- "config:hardis:get",
310
- "config:get:hardis",
311
- "hardis:get:config",
312
- "get:hardis:config",
313
- "get:config:hardis"
308
+ "hardis:auth:login",
309
+ "auth:hardis:login",
310
+ "auth:login:hardis",
311
+ "hardis:login:auth",
312
+ "login:hardis:auth",
313
+ "login:auth:hardis"
314
314
  ]
315
315
  },
316
316
  "hardis:doc:fieldusage": {
@@ -509,7 +509,7 @@
509
509
  "hardis:doc:mkdocs-to-cf": {
510
510
  "aliases": [],
511
511
  "args": {},
512
- "description": "## Command Behavior**Generates MkDocs HTML pages and uploads them to Cloudflare as a static site, secured with Cloudflare Access.**This command automates the deployment of your project's documentation (built with MkDocs) to Cloudflare Pages, making it accessible and secure. It handles the entire process from HTML generation to Cloudflare configuration.Key operations performed:- **MkDocs HTML Generation:** Builds the MkDocs project into static HTML pages. It can use a locally installed `mkdocs-material` or a `mkdocs` Docker image.- **Cloudflare Pages Project Creation/Update:** Creates a new Cloudflare Pages project if one doesn't exist for your documentation, or updates an existing one.- **Cloudflare Access Policy Assignment:** Assigns a policy to restrict access to the deployed application, ensuring only authorized users can view your documentation.- **Cloudflare Access Application Setup:** Configures a Cloudflare Access application for the deployed site, integrating it with your Zero Trust policies.- **HTML Page Upload:** Deploys the generated HTML pages to Cloudflare Pages.- **Browser Opening (Non-CI):** Opens the newly deployed website in your default browser if the command is not run in a CI/CD environment.**Prerequisite:** The documentation must have been previously generated using `sf hardis:doc:project2markdown --with-history`.**Customization:** You can override default styles by customizing your `mkdocs.yml` file.More information can be found in the [Documentation section](https://sfdx-hardis.cloudity.com/salesforce-project-documentation/).**Environment Variables for Cloudflare Configuration:**| Variable | Description | Default || :---------------------------------------- | :----------------------------------------------------------------------- | :------------------------------------: || `CLOUDFLARE_EMAIL` | Cloudflare account email | _Required_ || `CLOUDFLARE_API_TOKEN` | Cloudflare API token | _Required_ || `CLOUDFLARE_ACCOUNT_ID` | Cloudflare account ID | _Required_ || `CLOUDFLARE_PROJECT_NAME` | Project name, also used for the site URL | Built from Git branch name || `CLOUDFLARE_DEFAULT_LOGIN_METHOD_TYPE` | Cloudflare default login method type | `onetimepin` || `CLOUDFLARE_DEFAULT_ACCESS_EMAIL_DOMAIN` | Cloudflare default access email domain | `@cloudity.com` || `CLOUDFLARE_EXTRA_ACCESS_POLICY_ID_LIST` | Comma-separated list of additional policy IDs to assign to the application | _Optional_ |<details markdown=\"1\">\n<summary>Technical explanations</summary>The command orchestrates interactions with MkDocs, Cloudflare APIs, and Git:- **MkDocs Integration:** It calls `generateMkDocsHTML()` to execute the MkDocs build process, which converts Markdown files into static HTML. It checks for the presence of `mkdocs.yml` to ensure it's a valid MkDocs project.- **Cloudflare API Interaction:** It uses the `cloudflare` npm package to interact with the Cloudflare API. This involves: - **Authentication:** Initializes the Cloudflare client using `CLOUDFLARE_EMAIL`, `CLOUDFLARE_API_TOKEN`, and `CLOUDFLARE_ACCOUNT_ID` environment variables. - **Pages Project Management:** Calls `client.pages.projects.get()` to check for an existing project and `client.pages.projects.create()` to create a new one if needed. - **Access Policy Management:** Lists existing access policies (`client.zeroTrust.access.policies.list()`) and creates a new one (`client.zeroTrust.access.policies.create()`) if the required policy doesn't exist. It configures the policy with email domain restrictions and a default login method. - **Access Application Management:** Lists existing access applications (`client.zeroTrust.access.applications.list()`) and creates a new one (`client.zeroTrust.access.applications.create()`) for the deployed site. It then updates the application to associate it with the created access policy.- **Git Integration:** Retrieves the current Git branch name using `getCurrentGitBranch()` to construct the Cloudflare project name and branch for deployment.- **Wrangler CLI:** Uses the `wrangler` CLI (Cloudflare's developer tool) to deploy the generated HTML pages to Cloudflare Pages via `wrangler pages deploy`.- **Environment Variable Management:** Reads various environment variables to configure Cloudflare settings and project names.- **Error Handling:** Includes checks for missing `mkdocs.yml` and Cloudflare environment variables, throwing `SfError` when necessary.</details>\n",
512
+ "description": "## Command Behavior\n\n**Generates MkDocs HTML pages and uploads them to Cloudflare as a static site, secured with Cloudflare Access.**\n\nThis command automates the deployment of your project's documentation (built with MkDocs) to Cloudflare Pages, making it accessible and secure. It handles the entire process from HTML generation to Cloudflare configuration.\n\nKey operations performed:\n\n- **MkDocs HTML Generation:** Builds the MkDocs project into static HTML pages. It can use a locally installed `mkdocs-material` or a `mkdocs` Docker image.\n- **Cloudflare Pages Project Creation/Update:** Creates a new Cloudflare Pages project if one doesn't exist for your documentation, or updates an existing one.\n- **Cloudflare Access Policy Assignment:** Assigns a policy to restrict access to the deployed application, ensuring only authorized users can view your documentation.\n- **Cloudflare Access Application Setup:** Configures a Cloudflare Access application for the deployed site, integrating it with your Zero Trust policies.\n- **HTML Page Upload:** Deploys the generated HTML pages to Cloudflare Pages.\n- **Browser Opening (Non-CI):** Opens the newly deployed website in your default browser if the command is not run in a CI/CD environment.\n\n**Prerequisite:** The documentation must have been previously generated using `sf hardis:doc:project2markdown --with-history`.\n\n**Customization:** You can override default styles by customizing your `mkdocs.yml` file.\n\nMore information can be found in the [Documentation section](https://sfdx-hardis.cloudity.com/salesforce-project-documentation/).\n\n**Environment Variables for Cloudflare Configuration:**\n\n| Variable | Description | Default || :---------------------------------------- | :----------------------------------------------------------------------- | :------------------------------------: || `CLOUDFLARE_EMAIL` | Cloudflare account email | _Required_ || `CLOUDFLARE_API_TOKEN` | Cloudflare API token | _Required_ || `CLOUDFLARE_ACCOUNT_ID` | Cloudflare account ID | _Required_ || `CLOUDFLARE_PROJECT_NAME` | Project name, also used for the site URL | Built from Git branch name || `CLOUDFLARE_DEFAULT_LOGIN_METHOD_TYPE` | Cloudflare default login method type | `onetimepin` || `CLOUDFLARE_DEFAULT_ACCESS_EMAIL_DOMAIN` | Cloudflare default access email domain | `@cloudity.com` || `CLOUDFLARE_EXTRA_ACCESS_POLICY_ID_LIST` | Comma-separated list of additional policy IDs to assign to the application | _Optional_ |\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command orchestrates interactions with MkDocs, Cloudflare APIs, and Git:\n\n- **MkDocs Integration:** It calls `generateMkDocsHTML()` to execute the MkDocs build process, which converts Markdown files into static HTML. It checks for the presence of `mkdocs.yml` to ensure it's a valid MkDocs project.\n- **Cloudflare API Interaction:** It uses the `cloudflare` npm package to interact with the Cloudflare API. This involves:\n - **Authentication:** Initializes the Cloudflare client using `CLOUDFLARE_EMAIL`, `CLOUDFLARE_API_TOKEN`, and `CLOUDFLARE_ACCOUNT_ID` environment variables.\n - **Pages Project Management:** Calls `client.pages.projects.get()` to check for an existing project and `client.pages.projects.create()` to create a new one if needed.\n - **Access Policy Management:** Lists existing access policies (`client.zeroTrust.access.policies.list()`) and creates a new one (`client.zeroTrust.access.policies.create()`) if the required policy doesn't exist. It configures the policy with email domain restrictions and a default login method.\n - **Access Application Management:** Lists existing access applications (`client.zeroTrust.access.applications.list()`) and creates a new one (`client.zeroTrust.access.applications.create()`) for the deployed site. It then updates the application to associate it with the created access policy.\n- **Git Integration:** Retrieves the current Git branch name using `getCurrentGitBranch()` to construct the Cloudflare project name and branch for deployment.\n- **Wrangler CLI:** Uses the `wrangler` CLI (Cloudflare's developer tool) to deploy the generated HTML pages to Cloudflare Pages via `wrangler pages deploy`.\n- **Environment Variable Management:** Reads various environment variables to configure Cloudflare settings and project names.\n- **Error Handling:** Includes checks for missing `mkdocs.yml` and Cloudflare environment variables, throwing `SfError` when necessary.\n</details>\n",
513
513
  "examples": [
514
514
  "$ sf hardis:doc:mkdocs-to-cf"
515
515
  ],
@@ -5539,15 +5539,12 @@
5539
5539
  "import:data:org:hardis"
5540
5540
  ]
5541
5541
  },
5542
- "hardis:org:diagnose:audittrail": {
5542
+ "hardis:org:files:export": {
5543
5543
  "aliases": [],
5544
5544
  "args": {},
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![](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/screenshot-monitoring-audittrail-excel.jpg)\n\n## Local output example\n\n![](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/screenshot-monitoring-audittrail-local.jpg)\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",
5545
+ "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[![How to mass download notes and attachments files from a Salesforce org](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/article-mass-download.jpg)](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",
5546
5546
  "examples": [
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"
5547
+ "$ sf hardis:org:files:export"
5551
5548
  ],
5552
5549
  "flags": {
5553
5550
  "json": {
@@ -5565,30 +5562,48 @@
5565
5562
  "multiple": false,
5566
5563
  "type": "option"
5567
5564
  },
5568
- "excludeusers": {
5569
- "char": "e",
5570
- "description": "Comma-separated list of usernames to exclude",
5571
- "name": "excludeusers",
5565
+ "path": {
5566
+ "char": "p",
5567
+ "description": "Path to the file export project",
5568
+ "name": "path",
5572
5569
  "hasDynamicHelp": false,
5573
5570
  "multiple": false,
5574
5571
  "type": "option"
5575
5572
  },
5576
- "lastndays": {
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,
5578
+ "hasDynamicHelp": false,
5579
+ "multiple": false,
5580
+ "type": "option"
5581
+ },
5582
+ "polltimeout": {
5577
5583
  "char": "t",
5578
- "description": "Number of days to extract from today (included)",
5579
- "name": "lastndays",
5584
+ "description": "Timeout in MS for Bulk API calls",
5585
+ "name": "polltimeout",
5586
+ "default": 300000,
5580
5587
  "hasDynamicHelp": false,
5581
5588
  "multiple": false,
5582
5589
  "type": "option"
5583
5590
  },
5584
- "outputfile": {
5585
- "char": "f",
5586
- "description": "Force the path and name of output report file. Must end with .csv",
5587
- "name": "outputfile",
5591
+ "startchunknumber": {
5592
+ "char": "s",
5593
+ "description": "Chunk number to start from",
5594
+ "name": "startchunknumber",
5595
+ "default": 0,
5588
5596
  "hasDynamicHelp": false,
5589
5597
  "multiple": false,
5590
5598
  "type": "option"
5591
5599
  },
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
+ },
5592
5607
  "debug": {
5593
5608
  "char": "d",
5594
5609
  "description": "Activate debug mode (more logs)",
@@ -5627,13 +5642,13 @@
5627
5642
  },
5628
5643
  "hasDynamicHelp": true,
5629
5644
  "hiddenAliases": [],
5630
- "id": "hardis:org:diagnose:audittrail",
5645
+ "id": "hardis:org:files:export",
5631
5646
  "pluginAlias": "sfdx-hardis",
5632
5647
  "pluginName": "sfdx-hardis",
5633
5648
  "pluginType": "core",
5634
5649
  "strict": true,
5635
5650
  "enableJsonFlag": true,
5636
- "title": "Diagnose content of Setup Audit Trail",
5651
+ "title": "Export files",
5637
5652
  "requiresProject": false,
5638
5653
  "isESM": true,
5639
5654
  "relativePath": [
@@ -5641,43 +5656,43 @@
5641
5656
  "commands",
5642
5657
  "hardis",
5643
5658
  "org",
5644
- "diagnose",
5645
- "audittrail.js"
5659
+ "files",
5660
+ "export.js"
5646
5661
  ],
5647
5662
  "aliasPermutations": [],
5648
5663
  "permutations": [
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"
5664
+ "hardis:org:files:export",
5665
+ "org:hardis:files:export",
5666
+ "org:files:hardis:export",
5667
+ "org:files:export:hardis",
5668
+ "hardis:files:org:export",
5669
+ "files:hardis:org:export",
5670
+ "files:org:hardis:export",
5671
+ "files:org:export:hardis",
5672
+ "hardis:files:export:org",
5673
+ "files:hardis:export:org",
5674
+ "files:export:hardis:org",
5675
+ "files:export:org:hardis",
5676
+ "hardis:org:export:files",
5677
+ "org:hardis:export:files",
5678
+ "org:export:hardis:files",
5679
+ "org:export:files:hardis",
5680
+ "hardis:export:org:files",
5681
+ "export:hardis:org:files",
5682
+ "export:org:hardis:files",
5683
+ "export:org:files:hardis",
5684
+ "hardis:export:files:org",
5685
+ "export:hardis:files:org",
5686
+ "export:files:hardis:org",
5687
+ "export:files:org:hardis"
5673
5688
  ]
5674
5689
  },
5675
- "hardis:org:diagnose:instanceupgrade": {
5690
+ "hardis:org:files:import": {
5676
5691
  "aliases": [],
5677
5692
  "args": {},
5678
- "description": "\n## Command Behavior\n\n**Retrieves and displays the scheduled upgrade date for a Salesforce org's instance.**\n\nThis command provides crucial information about when your Salesforce instance will be upgraded to the next major release (Spring, Summer, or Winter). This is vital for release planning, testing, and ensuring compatibility with upcoming Salesforce features.\n\nKey functionalities:\n\n- **Instance Identification:** Determines the Salesforce instance name of your target org.\n- **Upgrade Date Retrieval:** Fetches the planned start time of the next major core service upgrade for that instance from the Salesforce Status API.\n- **Days Until Upgrade:** Calculates and displays the number of days remaining until the next major upgrade.\n- **Severity-Based Logging:** Adjusts the log severity (info, warning) based on the proximity of the upgrade date, providing a visual cue for urgency.\n- **Notifications:** Sends notifications to configured channels (e.g., Slack, MS Teams, Grafana) with the upgrade information, making it suitable for automated monitoring.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **Salesforce SOQL Query:** It first queries the `Organization` object in Salesforce to get the `InstanceName` of the target org.\n- **Salesforce Status API Integration:** It makes an HTTP GET request to the Salesforce Status API (`https://api.status.salesforce.com/v1/instances/{instanceName}/status`) to retrieve detailed information about the instance, including scheduled maintenances.\n- **Data Parsing:** It parses the JSON response from the Status API to extract the relevant major release upgrade information.\n- **Date Calculation:** Uses the `moment` library to calculate the difference in days between the current date and the planned upgrade date.\n- **Notification Integration:** It integrates with the `NotifProvider` to send notifications, including the instance name, upgrade date, and days remaining, along with relevant metrics for monitoring dashboards.\n- **User Feedback:** Provides clear messages to the user about the upgrade status and proximity.\n</details>\n",
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[![How to mass download notes and attachments files from a Salesforce org](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/article-mass-download.jpg)](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",
5679
5694
  "examples": [
5680
- "$ sf hardis:org:diagnose:instanceupgrade"
5695
+ "$ sf hardis:org:files:import"
5681
5696
  ],
5682
5697
  "flags": {
5683
5698
  "json": {
@@ -5695,6 +5710,21 @@
5695
5710
  "multiple": false,
5696
5711
  "type": "option"
5697
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
+ },
5698
5728
  "debug": {
5699
5729
  "char": "d",
5700
5730
  "description": "Activate debug mode (more logs)",
@@ -5733,13 +5763,13 @@
5733
5763
  },
5734
5764
  "hasDynamicHelp": true,
5735
5765
  "hiddenAliases": [],
5736
- "id": "hardis:org:diagnose:instanceupgrade",
5766
+ "id": "hardis:org:files:import",
5737
5767
  "pluginAlias": "sfdx-hardis",
5738
5768
  "pluginName": "sfdx-hardis",
5739
5769
  "pluginType": "core",
5740
5770
  "strict": true,
5741
5771
  "enableJsonFlag": true,
5742
- "title": "Get Instance Upgrade date",
5772
+ "title": "Import files",
5743
5773
  "requiresProject": false,
5744
5774
  "isESM": true,
5745
5775
  "relativePath": [
@@ -5747,46 +5777,44 @@
5747
5777
  "commands",
5748
5778
  "hardis",
5749
5779
  "org",
5750
- "diagnose",
5751
- "instanceupgrade.js"
5780
+ "files",
5781
+ "import.js"
5752
5782
  ],
5753
5783
  "aliasPermutations": [],
5754
5784
  "permutations": [
5755
- "hardis:org:diagnose:instanceupgrade",
5756
- "org:hardis:diagnose:instanceupgrade",
5757
- "org:diagnose:hardis:instanceupgrade",
5758
- "org:diagnose:instanceupgrade:hardis",
5759
- "hardis:diagnose:org:instanceupgrade",
5760
- "diagnose:hardis:org:instanceupgrade",
5761
- "diagnose:org:hardis:instanceupgrade",
5762
- "diagnose:org:instanceupgrade:hardis",
5763
- "hardis:diagnose:instanceupgrade:org",
5764
- "diagnose:hardis:instanceupgrade:org",
5765
- "diagnose:instanceupgrade:hardis:org",
5766
- "diagnose:instanceupgrade:org:hardis",
5767
- "hardis:org:instanceupgrade:diagnose",
5768
- "org:hardis:instanceupgrade:diagnose",
5769
- "org:instanceupgrade:hardis:diagnose",
5770
- "org:instanceupgrade:diagnose:hardis",
5771
- "hardis:instanceupgrade:org:diagnose",
5772
- "instanceupgrade:hardis:org:diagnose",
5773
- "instanceupgrade:org:hardis:diagnose",
5774
- "instanceupgrade:org:diagnose:hardis",
5775
- "hardis:instanceupgrade:diagnose:org",
5776
- "instanceupgrade:hardis:diagnose:org",
5777
- "instanceupgrade:diagnose:hardis:org",
5778
- "instanceupgrade:diagnose:org:hardis"
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"
5779
5809
  ]
5780
5810
  },
5781
- "hardis:org:diagnose:legacyapi": {
5811
+ "hardis:org:fix:listviewmine": {
5782
5812
  "aliases": [],
5783
5813
  "args": {},
5784
- "description": "Checks if an org uses retired or someday retired API version\n\n\nSee article below\n\n[![Handle Salesforce API versions Deprecation like a pro](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/article-deprecated-api.jpg)](https://nicolas.vuillamy.fr/handle-salesforce-api-versions-deprecation-like-a-pro-335065f52238)\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-deprecated-api-calls/) and can output Grafana, Slack and MsTeams Notifications.\n",
5814
+ "description": "Fix listviews whose scope Mine has been replaced by Everything\n\n[![Invalid scope:Mine, not allowed ? Deploy your ListViews anyway !](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/article-invalid-scope-mine.jpg)](https://nicolas.vuillamy.fr/invalid-scope-mine-not-allowed-deploy-your-listviews-anyway-443aceca8ac7)\n\nList of ListViews can be:\n\n- read from .sfdx-hardis.yml file in property **listViewsToSetToMine**\n- sent in argument listviews\n\nNote: property **listViewsToSetToMine** can be auto-generated by command hardis:work:save if .sfdx-hardis.yml contains the following configuration\n\n```yaml\nautoCleanTypes:\n - listViewsMine\n```\n\n- Example of sfdx-hardis.yml property `listViewsToSetToMine`:\n\n```yaml\nlistViewsToSetToMine:\n - \"force-app/main/default/objects/Operation__c/listViews/MyCurrentOperations.listView-meta.xml\"\n - \"force-app/main/default/objects/Operation__c/listViews/MyFinalizedOperations.listView-meta.xml\"\n - \"force-app/main/default/objects/Opportunity/listViews/Default_Opportunity_Pipeline.listView-meta.xml\"\n - \"force-app/main/default/objects/Opportunity/listViews/MyCurrentSubscriptions.listView-meta.xml\"\n - \"force-app/main/default/objects/Opportunity/listViews/MySubscriptions.listView-meta.xml\"\n - \"force-app/main/default/objects/Account/listViews/MyActivePartners.listView-meta.xml\"\n```\n\n- If manually written, this could also be:\n\n```yaml\nlistViewsToSetToMine:\n - \"Operation__c:MyCurrentOperations\"\n - \"Operation__c:MyFinalizedOperations\"\n - \"Opportunity:Default_Opportunity_Pipeline\"\n - \"Opportunity:MyCurrentSubscriptions\"\n - \"Opportunity:MySubscriptions\"\n - \"Account:MyActivePartners\"\n```\n\nTroubleshooting: if you need to run this command from an alpine-linux based docker image, use this workaround in your dockerfile:\n\n```dockerfile\n# Do not use puppeteer embedded chromium\nRUN apk add --update --no-cache chromium\nENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=\"true\"\nENV CHROMIUM_PATH=\"/usr/bin/chromium-browser\"\nENV PUPPETEER_EXECUTABLE_PATH=\"$\\{CHROMIUM_PATH}\" // remove \\ before {\n```\n",
5785
5815
  "examples": [
5786
- "$ sf hardis:org:diagnose:legacyapi",
5787
- "$ sf hardis:org:diagnose:legacyapi -u hardis@myclient.com",
5788
- "$ sf hardis:org:diagnose:legacyapi --outputfile 'c:/path/to/folder/legacyapi.csv'",
5789
- "$ sf hardis:org:diagnose:legacyapi -u hardis@myclient.com --outputfile ./tmp/legacyapi.csv"
5816
+ "$ sf hardis:org:fix:listviewmine",
5817
+ "$ sf hardis:org:fix:listviewmine --listviews Opportunity:MySubscriptions,Account:MyActivePartners"
5790
5818
  ],
5791
5819
  "flags": {
5792
5820
  "json": {
@@ -5804,28 +5832,10 @@
5804
5832
  "multiple": false,
5805
5833
  "type": "option"
5806
5834
  },
5807
- "eventtype": {
5808
- "char": "e",
5809
- "description": "Type of EventLogFile event to analyze",
5810
- "name": "eventtype",
5811
- "default": "ApiTotalUsage",
5812
- "hasDynamicHelp": false,
5813
- "multiple": false,
5814
- "type": "option"
5815
- },
5816
- "limit": {
5835
+ "listviews": {
5817
5836
  "char": "l",
5818
- "description": "Number of latest EventLogFile events to analyze",
5819
- "name": "limit",
5820
- "default": 999,
5821
- "hasDynamicHelp": false,
5822
- "multiple": false,
5823
- "type": "option"
5824
- },
5825
- "outputfile": {
5826
- "char": "f",
5827
- "description": "Force the path and name of output report file. Must end with .csv",
5828
- "name": "outputfile",
5837
+ "description": "Comma-separated list of listviews following format Object:ListViewName\nExample: Contact:MyContacts,Contact:MyActiveContacts,Opportunity:MYClosedOpportunities",
5838
+ "name": "listviews",
5829
5839
  "hasDynamicHelp": false,
5830
5840
  "multiple": false,
5831
5841
  "type": "option"
@@ -5868,57 +5878,60 @@
5868
5878
  },
5869
5879
  "hasDynamicHelp": true,
5870
5880
  "hiddenAliases": [],
5871
- "id": "hardis:org:diagnose:legacyapi",
5881
+ "id": "hardis:org:fix:listviewmine",
5872
5882
  "pluginAlias": "sfdx-hardis",
5873
5883
  "pluginName": "sfdx-hardis",
5874
5884
  "pluginType": "core",
5875
5885
  "strict": true,
5876
5886
  "enableJsonFlag": true,
5877
- "title": "Check for legacy API use",
5878
- "requiresProject": false,
5887
+ "title": "Fix listviews with ",
5888
+ "requiresProject": true,
5879
5889
  "isESM": true,
5880
5890
  "relativePath": [
5881
5891
  "lib",
5882
5892
  "commands",
5883
5893
  "hardis",
5884
5894
  "org",
5885
- "diagnose",
5886
- "legacyapi.js"
5895
+ "fix",
5896
+ "listviewmine.js"
5887
5897
  ],
5888
5898
  "aliasPermutations": [],
5889
5899
  "permutations": [
5890
- "hardis:org:diagnose:legacyapi",
5891
- "org:hardis:diagnose:legacyapi",
5892
- "org:diagnose:hardis:legacyapi",
5893
- "org:diagnose:legacyapi:hardis",
5894
- "hardis:diagnose:org:legacyapi",
5895
- "diagnose:hardis:org:legacyapi",
5896
- "diagnose:org:hardis:legacyapi",
5897
- "diagnose:org:legacyapi:hardis",
5898
- "hardis:diagnose:legacyapi:org",
5899
- "diagnose:hardis:legacyapi:org",
5900
- "diagnose:legacyapi:hardis:org",
5901
- "diagnose:legacyapi:org:hardis",
5902
- "hardis:org:legacyapi:diagnose",
5903
- "org:hardis:legacyapi:diagnose",
5904
- "org:legacyapi:hardis:diagnose",
5905
- "org:legacyapi:diagnose:hardis",
5906
- "hardis:legacyapi:org:diagnose",
5907
- "legacyapi:hardis:org:diagnose",
5908
- "legacyapi:org:hardis:diagnose",
5909
- "legacyapi:org:diagnose:hardis",
5910
- "hardis:legacyapi:diagnose:org",
5911
- "legacyapi:hardis:diagnose:org",
5912
- "legacyapi:diagnose:hardis:org",
5913
- "legacyapi:diagnose:org:hardis"
5900
+ "hardis:org:fix:listviewmine",
5901
+ "org:hardis:fix:listviewmine",
5902
+ "org:fix:hardis:listviewmine",
5903
+ "org:fix:listviewmine:hardis",
5904
+ "hardis:fix:org:listviewmine",
5905
+ "fix:hardis:org:listviewmine",
5906
+ "fix:org:hardis:listviewmine",
5907
+ "fix:org:listviewmine:hardis",
5908
+ "hardis:fix:listviewmine:org",
5909
+ "fix:hardis:listviewmine:org",
5910
+ "fix:listviewmine:hardis:org",
5911
+ "fix:listviewmine:org:hardis",
5912
+ "hardis:org:listviewmine:fix",
5913
+ "org:hardis:listviewmine:fix",
5914
+ "org:listviewmine:hardis:fix",
5915
+ "org:listviewmine:fix:hardis",
5916
+ "hardis:listviewmine:org:fix",
5917
+ "listviewmine:hardis:org:fix",
5918
+ "listviewmine:org:hardis:fix",
5919
+ "listviewmine:org:fix:hardis",
5920
+ "hardis:listviewmine:fix:org",
5921
+ "listviewmine:hardis:fix:org",
5922
+ "listviewmine:fix:hardis:org",
5923
+ "listviewmine:fix:org:hardis"
5914
5924
  ]
5915
5925
  },
5916
- "hardis:org:diagnose:licenses": {
5926
+ "hardis:org:diagnose:audittrail": {
5917
5927
  "aliases": [],
5918
5928
  "args": {},
5919
- "description": "\n**Lists and analyzes User Licenses and Permission Set Licenses subscribed and used in a Salesforce org.**\n\nThis command provides a comprehensive overview of your Salesforce license consumption. It's particularly useful for:\n\n- **License Management:** Understanding which licenses are active, how many are available, and how many are being used.\n- **Cost Optimization:** Identifying unused or underutilized licenses that could be reallocated or decommissioned.\n- **Compliance:** Ensuring that your organization is compliant with Salesforce licensing agreements.\n- **Monitoring:** Tracking license usage trends over time.\n\nKey functionalities:\n\n- **User License Details:** Retrieves information about standard and custom User Licenses, including `MasterLabel`, `Name`, `TotalLicenses`, and `UsedLicenses`.\n- **Permission Set License Details:** Retrieves information about Permission Set Licenses, including `MasterLabel`, `PermissionSetLicenseKey`, `TotalLicenses`, and `UsedLicenses`.\n- **Used Licenses Filter:** The `--usedonly` flag allows you to filter the report to show only licenses that have at least one `UsedLicenses` count greater than zero.\n- **CSV Report Generation:** Generates a CSV file containing all the retrieved license information, suitable for detailed analysis.\n- **Notifications:** Sends notifications to configured channels (e.g., Grafana, Slack, MS Teams) with a summary of license usage, including lists of active and used licenses.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **Salesforce SOQL Queries:** It executes SOQL queries against the `UserLicense` and `PermissionSetLicense` objects in Salesforce to retrieve license data.\n- **Data Transformation:** It processes the query results, reformatting the data to be more readable and consistent for reporting purposes (e.g., removing `Id` and `attributes`, renaming `PermissionSetLicenseKey` to `Name`).\n- **Data Aggregation:** It aggregates license information, creating a `licensesByKey` object for quick lookups and a `usedLicenses` array for a concise list of actively used licenses.\n- **Report Generation:** It uses `generateCsvFile` to create the CSV report of license data.\n- **Notification Integration:** It integrates with the `NotifProvider` to send notifications, including attachments of the generated CSV report and metrics for monitoring dashboards.\n- **User Feedback:** Provides clear messages to the user about the license extraction process and the used licenses.\n</details>\n",
5929
+ "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![](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/screenshot-monitoring-audittrail-excel.jpg)\n\n## Local output example\n\n![](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/screenshot-monitoring-audittrail-local.jpg)\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",
5920
5930
  "examples": [
5921
- "$ sf hardis:org:diagnose:licenses"
5931
+ "$ sf hardis:org:diagnose:audittrail",
5932
+ "$ sf hardis:org:diagnose:audittrail --excludeusers baptiste@titi.com",
5933
+ "$ sf hardis:org:diagnose:audittrail --excludeusers baptiste@titi.com,bertrand@titi.com",
5934
+ "$ sf hardis:org:diagnose:audittrail --lastndays 5"
5922
5935
  ],
5923
5936
  "flags": {
5924
5937
  "json": {
@@ -5936,6 +5949,22 @@
5936
5949
  "multiple": false,
5937
5950
  "type": "option"
5938
5951
  },
5952
+ "excludeusers": {
5953
+ "char": "e",
5954
+ "description": "Comma-separated list of usernames to exclude",
5955
+ "name": "excludeusers",
5956
+ "hasDynamicHelp": false,
5957
+ "multiple": false,
5958
+ "type": "option"
5959
+ },
5960
+ "lastndays": {
5961
+ "char": "t",
5962
+ "description": "Number of days to extract from today (included)",
5963
+ "name": "lastndays",
5964
+ "hasDynamicHelp": false,
5965
+ "multiple": false,
5966
+ "type": "option"
5967
+ },
5939
5968
  "outputfile": {
5940
5969
  "char": "f",
5941
5970
  "description": "Force the path and name of output report file. Must end with .csv",
@@ -5944,13 +5973,6 @@
5944
5973
  "multiple": false,
5945
5974
  "type": "option"
5946
5975
  },
5947
- "usedonly": {
5948
- "char": "u",
5949
- "description": "Filter to have only used licenses",
5950
- "name": "usedonly",
5951
- "allowNo": false,
5952
- "type": "boolean"
5953
- },
5954
5976
  "debug": {
5955
5977
  "char": "d",
5956
5978
  "description": "Activate debug mode (more logs)",
@@ -5989,13 +6011,13 @@
5989
6011
  },
5990
6012
  "hasDynamicHelp": true,
5991
6013
  "hiddenAliases": [],
5992
- "id": "hardis:org:diagnose:licenses",
6014
+ "id": "hardis:org:diagnose:audittrail",
5993
6015
  "pluginAlias": "sfdx-hardis",
5994
6016
  "pluginName": "sfdx-hardis",
5995
6017
  "pluginType": "core",
5996
6018
  "strict": true,
5997
6019
  "enableJsonFlag": true,
5998
- "title": "List licenses subscribed and used in a Salesforce org",
6020
+ "title": "Diagnose content of Setup Audit Trail",
5999
6021
  "requiresProject": false,
6000
6022
  "isESM": true,
6001
6023
  "relativePath": [
@@ -6004,42 +6026,42 @@
6004
6026
  "hardis",
6005
6027
  "org",
6006
6028
  "diagnose",
6007
- "licenses.js"
6029
+ "audittrail.js"
6008
6030
  ],
6009
6031
  "aliasPermutations": [],
6010
6032
  "permutations": [
6011
- "hardis:org:diagnose:licenses",
6012
- "org:hardis:diagnose:licenses",
6013
- "org:diagnose:hardis:licenses",
6014
- "org:diagnose:licenses:hardis",
6015
- "hardis:diagnose:org:licenses",
6016
- "diagnose:hardis:org:licenses",
6017
- "diagnose:org:hardis:licenses",
6018
- "diagnose:org:licenses:hardis",
6019
- "hardis:diagnose:licenses:org",
6020
- "diagnose:hardis:licenses:org",
6021
- "diagnose:licenses:hardis:org",
6022
- "diagnose:licenses:org:hardis",
6023
- "hardis:org:licenses:diagnose",
6024
- "org:hardis:licenses:diagnose",
6025
- "org:licenses:hardis:diagnose",
6026
- "org:licenses:diagnose:hardis",
6027
- "hardis:licenses:org:diagnose",
6028
- "licenses:hardis:org:diagnose",
6029
- "licenses:org:hardis:diagnose",
6030
- "licenses:org:diagnose:hardis",
6031
- "hardis:licenses:diagnose:org",
6032
- "licenses:hardis:diagnose:org",
6033
- "licenses:diagnose:hardis:org",
6034
- "licenses:diagnose:org:hardis"
6033
+ "hardis:org:diagnose:audittrail",
6034
+ "org:hardis:diagnose:audittrail",
6035
+ "org:diagnose:hardis:audittrail",
6036
+ "org:diagnose:audittrail:hardis",
6037
+ "hardis:diagnose:org:audittrail",
6038
+ "diagnose:hardis:org:audittrail",
6039
+ "diagnose:org:hardis:audittrail",
6040
+ "diagnose:org:audittrail:hardis",
6041
+ "hardis:diagnose:audittrail:org",
6042
+ "diagnose:hardis:audittrail:org",
6043
+ "diagnose:audittrail:hardis:org",
6044
+ "diagnose:audittrail:org:hardis",
6045
+ "hardis:org:audittrail:diagnose",
6046
+ "org:hardis:audittrail:diagnose",
6047
+ "org:audittrail:hardis:diagnose",
6048
+ "org:audittrail:diagnose:hardis",
6049
+ "hardis:audittrail:org:diagnose",
6050
+ "audittrail:hardis:org:diagnose",
6051
+ "audittrail:org:hardis:diagnose",
6052
+ "audittrail:org:diagnose:hardis",
6053
+ "hardis:audittrail:diagnose:org",
6054
+ "audittrail:hardis:diagnose:org",
6055
+ "audittrail:diagnose:hardis:org",
6056
+ "audittrail:diagnose:org:hardis"
6035
6057
  ]
6036
6058
  },
6037
- "hardis:org:diagnose:releaseupdates": {
6059
+ "hardis:org:diagnose:instanceupgrade": {
6038
6060
  "aliases": [],
6039
6061
  "args": {},
6040
- "description": "Export Release Updates into a CSV file with selected criteria, and highlight Release Updates that should be checked.\n\nBefore publishing **Breaking Changes** ❌, Salesforce announce them in the setup menu [**Release Updates**](https://help.salesforce.com/s/articleView?id=sf.release_updates.htm&type=5)\n\n⚠️ Some of them are very important, because if you don't make the related upgrades in time (ex: before Winter 25) , your production org can crash !\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-release-updates/) and can output Grafana, Slack and MsTeams Notifications.\n",
6062
+ "description": "\n## Command Behavior\n\n**Retrieves and displays the scheduled upgrade date for a Salesforce org's instance.**\n\nThis command provides crucial information about when your Salesforce instance will be upgraded to the next major release (Spring, Summer, or Winter). This is vital for release planning, testing, and ensuring compatibility with upcoming Salesforce features.\n\nKey functionalities:\n\n- **Instance Identification:** Determines the Salesforce instance name of your target org.\n- **Upgrade Date Retrieval:** Fetches the planned start time of the next major core service upgrade for that instance from the Salesforce Status API.\n- **Days Until Upgrade:** Calculates and displays the number of days remaining until the next major upgrade.\n- **Severity-Based Logging:** Adjusts the log severity (info, warning) based on the proximity of the upgrade date, providing a visual cue for urgency.\n- **Notifications:** Sends notifications to configured channels (e.g., Slack, MS Teams, Grafana) with the upgrade information, making it suitable for automated monitoring.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **Salesforce SOQL Query:** It first queries the `Organization` object in Salesforce to get the `InstanceName` of the target org.\n- **Salesforce Status API Integration:** It makes an HTTP GET request to the Salesforce Status API (`https://api.status.salesforce.com/v1/instances/{instanceName}/status`) to retrieve detailed information about the instance, including scheduled maintenances.\n- **Data Parsing:** It parses the JSON response from the Status API to extract the relevant major release upgrade information.\n- **Date Calculation:** Uses the `moment` library to calculate the difference in days between the current date and the planned upgrade date.\n- **Notification Integration:** It integrates with the `NotifProvider` to send notifications, including the instance name, upgrade date, and days remaining, along with relevant metrics for monitoring dashboards.\n- **User Feedback:** Provides clear messages to the user about the upgrade status and proximity.\n</details>\n",
6041
6063
  "examples": [
6042
- "$ sf hardis:org:diagnose:releaseupdates"
6064
+ "$ sf hardis:org:diagnose:instanceupgrade"
6043
6065
  ],
6044
6066
  "flags": {
6045
6067
  "json": {
@@ -6057,14 +6079,6 @@
6057
6079
  "multiple": false,
6058
6080
  "type": "option"
6059
6081
  },
6060
- "outputfile": {
6061
- "char": "f",
6062
- "description": "Force the path and name of output report file. Must end with .csv",
6063
- "name": "outputfile",
6064
- "hasDynamicHelp": false,
6065
- "multiple": false,
6066
- "type": "option"
6067
- },
6068
6082
  "debug": {
6069
6083
  "char": "d",
6070
6084
  "description": "Activate debug mode (more logs)",
@@ -6103,13 +6117,13 @@
6103
6117
  },
6104
6118
  "hasDynamicHelp": true,
6105
6119
  "hiddenAliases": [],
6106
- "id": "hardis:org:diagnose:releaseupdates",
6120
+ "id": "hardis:org:diagnose:instanceupgrade",
6107
6121
  "pluginAlias": "sfdx-hardis",
6108
6122
  "pluginName": "sfdx-hardis",
6109
6123
  "pluginType": "core",
6110
6124
  "strict": true,
6111
6125
  "enableJsonFlag": true,
6112
- "title": "Check Release Updates of an org",
6126
+ "title": "Get Instance Upgrade date",
6113
6127
  "requiresProject": false,
6114
6128
  "isESM": true,
6115
6129
  "relativePath": [
@@ -6118,42 +6132,45 @@
6118
6132
  "hardis",
6119
6133
  "org",
6120
6134
  "diagnose",
6121
- "releaseupdates.js"
6135
+ "instanceupgrade.js"
6122
6136
  ],
6123
6137
  "aliasPermutations": [],
6124
6138
  "permutations": [
6125
- "hardis:org:diagnose:releaseupdates",
6126
- "org:hardis:diagnose:releaseupdates",
6127
- "org:diagnose:hardis:releaseupdates",
6128
- "org:diagnose:releaseupdates:hardis",
6129
- "hardis:diagnose:org:releaseupdates",
6130
- "diagnose:hardis:org:releaseupdates",
6131
- "diagnose:org:hardis:releaseupdates",
6132
- "diagnose:org:releaseupdates:hardis",
6133
- "hardis:diagnose:releaseupdates:org",
6134
- "diagnose:hardis:releaseupdates:org",
6135
- "diagnose:releaseupdates:hardis:org",
6136
- "diagnose:releaseupdates:org:hardis",
6137
- "hardis:org:releaseupdates:diagnose",
6138
- "org:hardis:releaseupdates:diagnose",
6139
- "org:releaseupdates:hardis:diagnose",
6140
- "org:releaseupdates:diagnose:hardis",
6141
- "hardis:releaseupdates:org:diagnose",
6142
- "releaseupdates:hardis:org:diagnose",
6143
- "releaseupdates:org:hardis:diagnose",
6144
- "releaseupdates:org:diagnose:hardis",
6145
- "hardis:releaseupdates:diagnose:org",
6146
- "releaseupdates:hardis:diagnose:org",
6147
- "releaseupdates:diagnose:hardis:org",
6148
- "releaseupdates:diagnose:org:hardis"
6139
+ "hardis:org:diagnose:instanceupgrade",
6140
+ "org:hardis:diagnose:instanceupgrade",
6141
+ "org:diagnose:hardis:instanceupgrade",
6142
+ "org:diagnose:instanceupgrade:hardis",
6143
+ "hardis:diagnose:org:instanceupgrade",
6144
+ "diagnose:hardis:org:instanceupgrade",
6145
+ "diagnose:org:hardis:instanceupgrade",
6146
+ "diagnose:org:instanceupgrade:hardis",
6147
+ "hardis:diagnose:instanceupgrade:org",
6148
+ "diagnose:hardis:instanceupgrade:org",
6149
+ "diagnose:instanceupgrade:hardis:org",
6150
+ "diagnose:instanceupgrade:org:hardis",
6151
+ "hardis:org:instanceupgrade:diagnose",
6152
+ "org:hardis:instanceupgrade:diagnose",
6153
+ "org:instanceupgrade:hardis:diagnose",
6154
+ "org:instanceupgrade:diagnose:hardis",
6155
+ "hardis:instanceupgrade:org:diagnose",
6156
+ "instanceupgrade:hardis:org:diagnose",
6157
+ "instanceupgrade:org:hardis:diagnose",
6158
+ "instanceupgrade:org:diagnose:hardis",
6159
+ "hardis:instanceupgrade:diagnose:org",
6160
+ "instanceupgrade:hardis:diagnose:org",
6161
+ "instanceupgrade:diagnose:hardis:org",
6162
+ "instanceupgrade:diagnose:org:hardis"
6149
6163
  ]
6150
6164
  },
6151
- "hardis:org:diagnose:unsecure-connected-apps": {
6165
+ "hardis:org:diagnose:legacyapi": {
6152
6166
  "aliases": [],
6153
6167
  "args": {},
6154
- "description": "\n## Command Behavior\n\n**Detects unsecured Connected Apps in a Salesforce org and generates detailed reports for security analysis.**\n\nThis command is a critical security diagnostic tool that helps administrators identify Connected Apps that may pose security risks due to improper configuration. It provides comprehensive analysis of OAuth tokens and Connected App security settings to ensure proper access control.\n\nKey functionalities:\n\n- **OAuth Token Analysis:** Queries all OAuth tokens in the org using SOQL to retrieve comprehensive token information including app names, users, authorization status, and usage statistics.\n- **Security Status Assessment:** Evaluates each Connected App's security configuration by checking the `IsUsingAdminAuthorization` flag to determine if admin pre-approval is required.\n- **Unsecured App Detection:** Identifies Connected Apps that allow users to authorize themselves without admin approval, which can pose security risks.\n- **Detailed Reporting:** Generates two comprehensive CSV reports:\n - **OAuth Tokens Report:** Lists all OAuth tokens with security status, user information, and usage data\n - **Connected Apps Summary:** Aggregates unsecured Connected Apps with counts of associated OAuth tokens\n- **Visual Indicators:** Uses status icons (❌ for unsecured, ✅ for secured) to provide immediate visual feedback on security status.\n- **Security Recommendations:** Provides actionable guidance on how to secure Connected Apps through proper configuration.\n- **Notifications:** Sends alerts to configured channels (Grafana, Slack, MS Teams) with security findings and attached reports.\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-org-security/) and can output Grafana, Slack and MsTeams Notifications.\n\n<iframe width=\"560\" height=\"315\" src=\"https://www.youtube.com/embed/jHv8yrSK8Dg\" title=\"YouTube video player\" frameborder=\"0\" allow=\"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture\" allowfullscreen></iframe>\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **SOQL Query Execution:** Executes a comprehensive SOQL query on the `OauthToken` object, joining with `AppMenuItem` and `User` objects to gather complete security context.\n- **Security Analysis Logic:** Analyzes the `AppMenuItem.IsUsingAdminAuthorization` field to determine if a Connected App requires admin pre-approval for user authorization.\n- **Data Transformation:** Processes raw SOQL results to add security status indicators and reorganize data for optimal reporting and analysis.\n- **Aggregation Processing:** Groups OAuth tokens by Connected App name to provide summary statistics and identify the most problematic applications.\n- **Report Generation:** Uses `generateCsvFile` to create structured CSV reports with proper formatting and metadata for easy analysis and sharing.\n- **Notification Integration:** Integrates with the `NotifProvider` to send security alerts with detailed metrics, including the number of unsecured Connected Apps and associated OAuth tokens.\n- **File Management:** Generates multiple output formats (CSV, XLSX) and manages file paths using `generateReportPath` for consistent report organization.\n- **Connection Management:** Uses `setConnectionVariables` to ensure proper authentication context for notification providers that require org connection details.\n</details>\n",
6168
+ "description": "Checks if an org uses retired or someday retired API version\n\n\nSee article below\n\n[![Handle Salesforce API versions Deprecation like a pro](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/article-deprecated-api.jpg)](https://nicolas.vuillamy.fr/handle-salesforce-api-versions-deprecation-like-a-pro-335065f52238)\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-deprecated-api-calls/) and can output Grafana, Slack and MsTeams Notifications.\n",
6155
6169
  "examples": [
6156
- "$ sf hardis:org:diagnose:unsecure-connected-apps"
6170
+ "$ sf hardis:org:diagnose:legacyapi",
6171
+ "$ sf hardis:org:diagnose:legacyapi -u hardis@myclient.com",
6172
+ "$ sf hardis:org:diagnose:legacyapi --outputfile 'c:/path/to/folder/legacyapi.csv'",
6173
+ "$ sf hardis:org:diagnose:legacyapi -u hardis@myclient.com --outputfile ./tmp/legacyapi.csv"
6157
6174
  ],
6158
6175
  "flags": {
6159
6176
  "json": {
@@ -6171,6 +6188,24 @@
6171
6188
  "multiple": false,
6172
6189
  "type": "option"
6173
6190
  },
6191
+ "eventtype": {
6192
+ "char": "e",
6193
+ "description": "Type of EventLogFile event to analyze",
6194
+ "name": "eventtype",
6195
+ "default": "ApiTotalUsage",
6196
+ "hasDynamicHelp": false,
6197
+ "multiple": false,
6198
+ "type": "option"
6199
+ },
6200
+ "limit": {
6201
+ "char": "l",
6202
+ "description": "Number of latest EventLogFile events to analyze",
6203
+ "name": "limit",
6204
+ "default": 999,
6205
+ "hasDynamicHelp": false,
6206
+ "multiple": false,
6207
+ "type": "option"
6208
+ },
6174
6209
  "outputfile": {
6175
6210
  "char": "f",
6176
6211
  "description": "Force the path and name of output report file. Must end with .csv",
@@ -6217,13 +6252,13 @@
6217
6252
  },
6218
6253
  "hasDynamicHelp": true,
6219
6254
  "hiddenAliases": [],
6220
- "id": "hardis:org:diagnose:unsecure-connected-apps",
6255
+ "id": "hardis:org:diagnose:legacyapi",
6221
6256
  "pluginAlias": "sfdx-hardis",
6222
6257
  "pluginName": "sfdx-hardis",
6223
6258
  "pluginType": "core",
6224
6259
  "strict": true,
6225
6260
  "enableJsonFlag": true,
6226
- "title": "Detect Unsecured Connected Apps",
6261
+ "title": "Check for legacy API use",
6227
6262
  "requiresProject": false,
6228
6263
  "isESM": true,
6229
6264
  "relativePath": [
@@ -6232,43 +6267,42 @@
6232
6267
  "hardis",
6233
6268
  "org",
6234
6269
  "diagnose",
6235
- "unsecure-connected-apps.js"
6270
+ "legacyapi.js"
6236
6271
  ],
6237
6272
  "aliasPermutations": [],
6238
6273
  "permutations": [
6239
- "hardis:org:diagnose:unsecure-connected-apps",
6240
- "org:hardis:diagnose:unsecure-connected-apps",
6241
- "org:diagnose:hardis:unsecure-connected-apps",
6242
- "org:diagnose:unsecure-connected-apps:hardis",
6243
- "hardis:diagnose:org:unsecure-connected-apps",
6244
- "diagnose:hardis:org:unsecure-connected-apps",
6245
- "diagnose:org:hardis:unsecure-connected-apps",
6246
- "diagnose:org:unsecure-connected-apps:hardis",
6247
- "hardis:diagnose:unsecure-connected-apps:org",
6248
- "diagnose:hardis:unsecure-connected-apps:org",
6249
- "diagnose:unsecure-connected-apps:hardis:org",
6250
- "diagnose:unsecure-connected-apps:org:hardis",
6251
- "hardis:org:unsecure-connected-apps:diagnose",
6252
- "org:hardis:unsecure-connected-apps:diagnose",
6253
- "org:unsecure-connected-apps:hardis:diagnose",
6254
- "org:unsecure-connected-apps:diagnose:hardis",
6255
- "hardis:unsecure-connected-apps:org:diagnose",
6256
- "unsecure-connected-apps:hardis:org:diagnose",
6257
- "unsecure-connected-apps:org:hardis:diagnose",
6258
- "unsecure-connected-apps:org:diagnose:hardis",
6259
- "hardis:unsecure-connected-apps:diagnose:org",
6260
- "unsecure-connected-apps:hardis:diagnose:org",
6261
- "unsecure-connected-apps:diagnose:hardis:org",
6262
- "unsecure-connected-apps:diagnose:org:hardis"
6274
+ "hardis:org:diagnose:legacyapi",
6275
+ "org:hardis:diagnose:legacyapi",
6276
+ "org:diagnose:hardis:legacyapi",
6277
+ "org:diagnose:legacyapi:hardis",
6278
+ "hardis:diagnose:org:legacyapi",
6279
+ "diagnose:hardis:org:legacyapi",
6280
+ "diagnose:org:hardis:legacyapi",
6281
+ "diagnose:org:legacyapi:hardis",
6282
+ "hardis:diagnose:legacyapi:org",
6283
+ "diagnose:hardis:legacyapi:org",
6284
+ "diagnose:legacyapi:hardis:org",
6285
+ "diagnose:legacyapi:org:hardis",
6286
+ "hardis:org:legacyapi:diagnose",
6287
+ "org:hardis:legacyapi:diagnose",
6288
+ "org:legacyapi:hardis:diagnose",
6289
+ "org:legacyapi:diagnose:hardis",
6290
+ "hardis:legacyapi:org:diagnose",
6291
+ "legacyapi:hardis:org:diagnose",
6292
+ "legacyapi:org:hardis:diagnose",
6293
+ "legacyapi:org:diagnose:hardis",
6294
+ "hardis:legacyapi:diagnose:org",
6295
+ "legacyapi:hardis:diagnose:org",
6296
+ "legacyapi:diagnose:hardis:org",
6297
+ "legacyapi:diagnose:org:hardis"
6263
6298
  ]
6264
6299
  },
6265
- "hardis:org:diagnose:unused-apex-classes": {
6300
+ "hardis:org:diagnose:licenses": {
6266
6301
  "aliases": [],
6267
6302
  "args": {},
6268
- "description": "List all async Apex classes (Batch,Queueable,Schedulable) that has not been called for more than 365 days.\n \nThe result class list probably can be removed from the project, and that will improve your test classes performances 😊\n\nThe number of unused day is overridable using --days option. \n\nThe command uses queries on AsyncApexJob and CronTrigger technical tables to build the result.\n\nApex Classes CreatedBy and CreatedOn fields are calculated from MIN(date from git, date from org)\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-unused-apex-classes/) and can output Grafana, Slack and MsTeams Notifications.\n\n![](https://sfdx-hardis.cloudity.com/assets/images/screenshot-monitoring-unused-apex-grafana.jpg)\n",
6303
+ "description": "\n**Lists and analyzes User Licenses and Permission Set Licenses subscribed and used in a Salesforce org.**\n\nThis command provides a comprehensive overview of your Salesforce license consumption. It's particularly useful for:\n\n- **License Management:** Understanding which licenses are active, how many are available, and how many are being used.\n- **Cost Optimization:** Identifying unused or underutilized licenses that could be reallocated or decommissioned.\n- **Compliance:** Ensuring that your organization is compliant with Salesforce licensing agreements.\n- **Monitoring:** Tracking license usage trends over time.\n\nKey functionalities:\n\n- **User License Details:** Retrieves information about standard and custom User Licenses, including `MasterLabel`, `Name`, `TotalLicenses`, and `UsedLicenses`.\n- **Permission Set License Details:** Retrieves information about Permission Set Licenses, including `MasterLabel`, `PermissionSetLicenseKey`, `TotalLicenses`, and `UsedLicenses`.\n- **Used Licenses Filter:** The `--usedonly` flag allows you to filter the report to show only licenses that have at least one `UsedLicenses` count greater than zero.\n- **CSV Report Generation:** Generates a CSV file containing all the retrieved license information, suitable for detailed analysis.\n- **Notifications:** Sends notifications to configured channels (e.g., Grafana, Slack, MS Teams) with a summary of license usage, including lists of active and used licenses.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **Salesforce SOQL Queries:** It executes SOQL queries against the `UserLicense` and `PermissionSetLicense` objects in Salesforce to retrieve license data.\n- **Data Transformation:** It processes the query results, reformatting the data to be more readable and consistent for reporting purposes (e.g., removing `Id` and `attributes`, renaming `PermissionSetLicenseKey` to `Name`).\n- **Data Aggregation:** It aggregates license information, creating a `licensesByKey` object for quick lookups and a `usedLicenses` array for a concise list of actively used licenses.\n- **Report Generation:** It uses `generateCsvFile` to create the CSV report of license data.\n- **Notification Integration:** It integrates with the `NotifProvider` to send notifications, including attachments of the generated CSV report and metrics for monitoring dashboards.\n- **User Feedback:** Provides clear messages to the user about the license extraction process and the used licenses.\n</details>\n",
6269
6304
  "examples": [
6270
- "$ sf hardis:org:diagnose:unused-apex-classes",
6271
- "$ sf hardis:org:diagnose:unused-apex-classes --days 700"
6305
+ "$ sf hardis:org:diagnose:licenses"
6272
6306
  ],
6273
6307
  "flags": {
6274
6308
  "json": {
@@ -6294,13 +6328,12 @@
6294
6328
  "multiple": false,
6295
6329
  "type": "option"
6296
6330
  },
6297
- "days": {
6298
- "char": "t",
6299
- "description": "Extracts the users that have been inactive for the amount of days specified. In CI, default is 180 days",
6300
- "name": "days",
6301
- "hasDynamicHelp": false,
6302
- "multiple": false,
6303
- "type": "option"
6331
+ "usedonly": {
6332
+ "char": "u",
6333
+ "description": "Filter to have only used licenses",
6334
+ "name": "usedonly",
6335
+ "allowNo": false,
6336
+ "type": "boolean"
6304
6337
  },
6305
6338
  "debug": {
6306
6339
  "char": "d",
@@ -6340,13 +6373,13 @@
6340
6373
  },
6341
6374
  "hasDynamicHelp": true,
6342
6375
  "hiddenAliases": [],
6343
- "id": "hardis:org:diagnose:unused-apex-classes",
6376
+ "id": "hardis:org:diagnose:licenses",
6344
6377
  "pluginAlias": "sfdx-hardis",
6345
6378
  "pluginName": "sfdx-hardis",
6346
6379
  "pluginType": "core",
6347
6380
  "strict": true,
6348
6381
  "enableJsonFlag": true,
6349
- "title": "Detect unused Apex classes in an org",
6382
+ "title": "List licenses subscribed and used in a Salesforce org",
6350
6383
  "requiresProject": false,
6351
6384
  "isESM": true,
6352
6385
  "relativePath": [
@@ -6355,42 +6388,42 @@
6355
6388
  "hardis",
6356
6389
  "org",
6357
6390
  "diagnose",
6358
- "unused-apex-classes.js"
6391
+ "licenses.js"
6359
6392
  ],
6360
6393
  "aliasPermutations": [],
6361
6394
  "permutations": [
6362
- "hardis:org:diagnose:unused-apex-classes",
6363
- "org:hardis:diagnose:unused-apex-classes",
6364
- "org:diagnose:hardis:unused-apex-classes",
6365
- "org:diagnose:unused-apex-classes:hardis",
6366
- "hardis:diagnose:org:unused-apex-classes",
6367
- "diagnose:hardis:org:unused-apex-classes",
6368
- "diagnose:org:hardis:unused-apex-classes",
6369
- "diagnose:org:unused-apex-classes:hardis",
6370
- "hardis:diagnose:unused-apex-classes:org",
6371
- "diagnose:hardis:unused-apex-classes:org",
6372
- "diagnose:unused-apex-classes:hardis:org",
6373
- "diagnose:unused-apex-classes:org:hardis",
6374
- "hardis:org:unused-apex-classes:diagnose",
6375
- "org:hardis:unused-apex-classes:diagnose",
6376
- "org:unused-apex-classes:hardis:diagnose",
6377
- "org:unused-apex-classes:diagnose:hardis",
6378
- "hardis:unused-apex-classes:org:diagnose",
6379
- "unused-apex-classes:hardis:org:diagnose",
6380
- "unused-apex-classes:org:hardis:diagnose",
6381
- "unused-apex-classes:org:diagnose:hardis",
6382
- "hardis:unused-apex-classes:diagnose:org",
6383
- "unused-apex-classes:hardis:diagnose:org",
6384
- "unused-apex-classes:diagnose:hardis:org",
6385
- "unused-apex-classes:diagnose:org:hardis"
6395
+ "hardis:org:diagnose:licenses",
6396
+ "org:hardis:diagnose:licenses",
6397
+ "org:diagnose:hardis:licenses",
6398
+ "org:diagnose:licenses:hardis",
6399
+ "hardis:diagnose:org:licenses",
6400
+ "diagnose:hardis:org:licenses",
6401
+ "diagnose:org:hardis:licenses",
6402
+ "diagnose:org:licenses:hardis",
6403
+ "hardis:diagnose:licenses:org",
6404
+ "diagnose:hardis:licenses:org",
6405
+ "diagnose:licenses:hardis:org",
6406
+ "diagnose:licenses:org:hardis",
6407
+ "hardis:org:licenses:diagnose",
6408
+ "org:hardis:licenses:diagnose",
6409
+ "org:licenses:hardis:diagnose",
6410
+ "org:licenses:diagnose:hardis",
6411
+ "hardis:licenses:org:diagnose",
6412
+ "licenses:hardis:org:diagnose",
6413
+ "licenses:org:hardis:diagnose",
6414
+ "licenses:org:diagnose:hardis",
6415
+ "hardis:licenses:diagnose:org",
6416
+ "licenses:hardis:diagnose:org",
6417
+ "licenses:diagnose:hardis:org",
6418
+ "licenses:diagnose:org:hardis"
6386
6419
  ]
6387
6420
  },
6388
- "hardis:org:diagnose:unused-connected-apps": {
6421
+ "hardis:org:diagnose:releaseupdates": {
6389
6422
  "aliases": [],
6390
6423
  "args": {},
6391
- "description": "\n## Command Behavior\n\n**Identifies and reports on potentially unused Connected Apps in a Salesforce org, suggesting candidates for deletion or deactivation.**\n\nThis command helps improve org security and reduce technical debt by pinpointing Connected Apps that are no longer actively used. Connected Apps can pose security risks if left unmonitored, and cleaning them up contributes to a healthier Salesforce environment.\n\nKey functionalities:\n\n- **Connected App Data Collection:** Gathers information about all Connected Apps in the org, including creation and last modified dates, and associated users.\n- **Usage Analysis:** Analyzes `LoginHistory` and `OAuthToken` records to determine the last usage date of each Connected App.\n- **Inactivity Detection:** Flags Connected Apps as potentially unused if they have no recent login history or OAuth token usage.\n- **Accessibility Check:** Examines Connected App metadata to identify if they are accessible (e.g., if they require admin approval and have no profiles or permission sets assigned).\n- **Ignored Apps:** Automatically ignores a predefined list of common Salesforce Connected Apps (e.g., `Salesforce CLI`, `Salesforce Mobile Dashboards`). You can extend this list by defining the `ALLOWED_INACTIVE_CONNECTED_APPS` environment variable.\n- **CSV Report Generation:** Generates a CSV file containing details of all analyzed Connected Apps, including their usage status, last usage date, and reasons for being flagged as potentially unused.\n- **Notifications:** Sends notifications to configured channels (Grafana, Slack, MS Teams) with a summary of potentially unused Connected Apps.\n\n**Default Ignored Connected Apps:**\n\n- Ant Migration Tool\n- Chatter Desktop\n- Chatter Mobile for BlackBerry\n- Force.com IDE\n- OIQ_Integration\n- Salesforce CLI\n- Salesforce Files\n- Salesforce Mobile Dashboards\n- Salesforce Touch\n- Salesforce for Outlook\n- SalesforceA\n- SalesforceA for Android\n- SalesforceA for iOS\n- SalesforceDX Namespace Registry\n- SalesforceIQ\n\nYou can add more ignored apps by defining a comma-separated list of names in the `ALLOWED_INACTIVE_CONNECTED_APPS` environment variable.\n\n_Example: \nALLOWED_INACTIVE_CONNECTED_APPS=My App 1,My App 2, My App 3_\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-unused-connected-apps/) and can output Grafana, Slack and MsTeams Notifications.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **Salesforce SOQL Queries:** It performs SOQL queries against `ConnectedApplication`, `LoginHistory`, and `OAuthToken` objects to gather comprehensive data about Connected Apps and their usage.\n- **Temporary SFDX Project:** It creates a temporary SFDX project to retrieve Connected App metadata, allowing for local parsing and analysis of their XML files.\n- **Metadata Parsing:** It parses the `connectedApp-meta.xml` files to check for `isAdminApproved` and the presence of `profileName` or `permissionsetName` to determine accessibility.\n- **Data Correlation:** It correlates data from various Salesforce objects to build a complete picture of each Connected App's usage and status.\n- **Date Calculation:** Uses `moment` to calculate the time since the last OAuth token usage.\n- **Report Generation:** It uses `generateCsvFile` to create the CSV report of unused Connected Apps.\n- **Notification Integration:** It integrates with the `NotifProvider` to send notifications, including attachments of the generated CSV report and metrics for monitoring dashboards.\n- **File System Operations:** Uses `fs-extra` for creating and removing temporary directories and files.\n- **Environment Variable Reading:** Reads the `ALLOWED_INACTIVE_CONNECTED_APPS` environment variable to customize the list of ignored Connected Apps.\n</details>\n",
6424
+ "description": "Export Release Updates into a CSV file with selected criteria, and highlight Release Updates that should be checked.\n\nBefore publishing **Breaking Changes** ❌, Salesforce announce them in the setup menu [**Release Updates**](https://help.salesforce.com/s/articleView?id=sf.release_updates.htm&type=5)\n\n⚠️ Some of them are very important, because if you don't make the related upgrades in time (ex: before Winter 25) , your production org can crash !\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-release-updates/) and can output Grafana, Slack and MsTeams Notifications.\n",
6392
6425
  "examples": [
6393
- "$ sf hardis:org:diagnose:unused-connected-apps"
6426
+ "$ sf hardis:org:diagnose:releaseupdates"
6394
6427
  ],
6395
6428
  "flags": {
6396
6429
  "json": {
@@ -6454,30 +6487,13 @@
6454
6487
  },
6455
6488
  "hasDynamicHelp": true,
6456
6489
  "hiddenAliases": [],
6457
- "id": "hardis:org:diagnose:unused-connected-apps",
6490
+ "id": "hardis:org:diagnose:releaseupdates",
6458
6491
  "pluginAlias": "sfdx-hardis",
6459
6492
  "pluginName": "sfdx-hardis",
6460
6493
  "pluginType": "core",
6461
6494
  "strict": true,
6462
6495
  "enableJsonFlag": true,
6463
- "title": "Unused Connected Apps in an org",
6464
- "allowedInactiveConnectedApps": [
6465
- "Ant Migration Tool",
6466
- "Chatter Desktop",
6467
- "Chatter Mobile for BlackBerry",
6468
- "Force.com IDE",
6469
- "OIQ_Integration",
6470
- "Salesforce CLI",
6471
- "Salesforce Files",
6472
- "Salesforce Mobile Dashboards",
6473
- "Salesforce Touch",
6474
- "Salesforce for Outlook",
6475
- "SalesforceA",
6476
- "SalesforceA for Android",
6477
- "SalesforceA for iOS",
6478
- "SalesforceDX Namespace Registry",
6479
- "SalesforceIQ"
6480
- ],
6496
+ "title": "Check Release Updates of an org",
6481
6497
  "requiresProject": false,
6482
6498
  "isESM": true,
6483
6499
  "relativePath": [
@@ -6486,56 +6502,55 @@
6486
6502
  "hardis",
6487
6503
  "org",
6488
6504
  "diagnose",
6489
- "unused-connected-apps.js"
6505
+ "releaseupdates.js"
6490
6506
  ],
6491
6507
  "aliasPermutations": [],
6492
6508
  "permutations": [
6493
- "hardis:org:diagnose:unused-connected-apps",
6494
- "org:hardis:diagnose:unused-connected-apps",
6495
- "org:diagnose:hardis:unused-connected-apps",
6496
- "org:diagnose:unused-connected-apps:hardis",
6497
- "hardis:diagnose:org:unused-connected-apps",
6498
- "diagnose:hardis:org:unused-connected-apps",
6499
- "diagnose:org:hardis:unused-connected-apps",
6500
- "diagnose:org:unused-connected-apps:hardis",
6501
- "hardis:diagnose:unused-connected-apps:org",
6502
- "diagnose:hardis:unused-connected-apps:org",
6503
- "diagnose:unused-connected-apps:hardis:org",
6504
- "diagnose:unused-connected-apps:org:hardis",
6505
- "hardis:org:unused-connected-apps:diagnose",
6506
- "org:hardis:unused-connected-apps:diagnose",
6507
- "org:unused-connected-apps:hardis:diagnose",
6508
- "org:unused-connected-apps:diagnose:hardis",
6509
- "hardis:unused-connected-apps:org:diagnose",
6510
- "unused-connected-apps:hardis:org:diagnose",
6511
- "unused-connected-apps:org:hardis:diagnose",
6512
- "unused-connected-apps:org:diagnose:hardis",
6513
- "hardis:unused-connected-apps:diagnose:org",
6514
- "unused-connected-apps:hardis:diagnose:org",
6515
- "unused-connected-apps:diagnose:hardis:org",
6516
- "unused-connected-apps:diagnose:org:hardis"
6517
- ]
6518
- },
6519
- "hardis:org:diagnose:unusedlicenses": {
6520
- "aliases": [],
6521
- "args": {},
6522
- "description": "\n## Command Behavior\n\n**Detects and suggests the deletion of unused Permission Set License Assignments in a Salesforce org.**\n\nWhen a Permission Set (PS) linked to a Permission Set License (PSL) is assigned to a user, a Permission Set License Assignment (PSLA) is automatically created. However, when that PS is unassigned from the user, the PSLA is *not* automatically deleted. This can lead to organizations being charged for unused PSLAs, representing a hidden cost and technical debt.\n\nThis command identifies such useless PSLAs and provides options to delete them, helping to optimize license usage and reduce unnecessary expenses.\n\nKey functionalities:\n\n- **PSLA Detection:** Queries the Salesforce org to find all active PSLAs.\n- **Usage Verification:** Correlates PSLAs with actual Permission Set Assignments and Permission Set Group Assignments to determine if the underlying Permission Sets are still assigned to the user.\n- **Special Case Handling:** Accounts for specific scenarios where profiles might implicitly assign PSLAs (e.g., `Salesforce API Only` profile assigning `SalesforceAPIIntegrationPsl`) and allows for always excluding certain PSLAs from the unused check.\n- **Reporting:** Generates a CSV report of all identified unused PSLAs, including the user and the associated Permission Set License.\n- **Notifications:** Sends notifications to configured channels (Grafana, Slack, MS Teams) with a summary of unused PSLAs.\n- **Interactive Deletion:** In non-CI environments, it offers an interactive prompt to bulk delete the identified unused PSLAs.\n\nMany thanks to [Vincent Finet](https://www.linkedin.com/in/vincentfinet/) for the inspiration during his great speaker session at [French Touch Dreamin '23](https://frenchtouchdreamin.com/), and his kind agreement for reusing such inspiration in this command 😊\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-unused-licenses/) and can output Grafana, Slack and MsTeams Notifications.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves extensive querying of Salesforce objects and data correlation:\n\n- **SOQL Queries (Bulk API):** It uses `bulkQuery` and `bulkQueryChunksIn` to efficiently retrieve large volumes of data from `PermissionSetLicenseAssign`, `PermissionSetLicense`, `PermissionSet`, `PermissionSetGroupComponent`, and `PermissionSetAssignment` objects.\n- **Data Correlation:** It meticulously correlates data across these objects to determine if a `PermissionSetLicenseAssign` record has a corresponding active assignment to a Permission Set or Permission Set Group for the same user.\n- **Filtering Logic:** It applies complex filtering logic to exclude PSLAs that are genuinely in use or are part of predefined exceptions (e.g., `alwaysExcludeForActiveUsersPermissionSetLicenses`).\n- **Bulk Deletion:** If the user opts to delete unused PSLAs, it uses `bulkUpdate` with the `delete` operation to efficiently remove multiple records.\n- **Report Generation:** It uses `generateCsvFile` to create the CSV report of unused PSLAs.\n- **Notification Integration:** It integrates with the `NotifProvider` to send notifications, including attachments of the generated CSV report and metrics for monitoring dashboards.\n- **User Interaction:** Uses `prompts` for interactive confirmation before performing deletion operations.\n</details>\n",
6523
- "examples": [
6524
- "$ sf hardis:org:diagnose:unusedlicenses",
6525
- "$ sf hardis:org:diagnose:unusedlicenses --fix"
6526
- ],
6527
- "flags": {
6528
- "json": {
6529
- "description": "Format output as json.",
6530
- "helpGroup": "GLOBAL",
6531
- "name": "json",
6532
- "allowNo": false,
6533
- "type": "boolean"
6534
- },
6535
- "flags-dir": {
6536
- "helpGroup": "GLOBAL",
6537
- "name": "flags-dir",
6538
- "summary": "Import flag values from a directory.",
6509
+ "hardis:org:diagnose:releaseupdates",
6510
+ "org:hardis:diagnose:releaseupdates",
6511
+ "org:diagnose:hardis:releaseupdates",
6512
+ "org:diagnose:releaseupdates:hardis",
6513
+ "hardis:diagnose:org:releaseupdates",
6514
+ "diagnose:hardis:org:releaseupdates",
6515
+ "diagnose:org:hardis:releaseupdates",
6516
+ "diagnose:org:releaseupdates:hardis",
6517
+ "hardis:diagnose:releaseupdates:org",
6518
+ "diagnose:hardis:releaseupdates:org",
6519
+ "diagnose:releaseupdates:hardis:org",
6520
+ "diagnose:releaseupdates:org:hardis",
6521
+ "hardis:org:releaseupdates:diagnose",
6522
+ "org:hardis:releaseupdates:diagnose",
6523
+ "org:releaseupdates:hardis:diagnose",
6524
+ "org:releaseupdates:diagnose:hardis",
6525
+ "hardis:releaseupdates:org:diagnose",
6526
+ "releaseupdates:hardis:org:diagnose",
6527
+ "releaseupdates:org:hardis:diagnose",
6528
+ "releaseupdates:org:diagnose:hardis",
6529
+ "hardis:releaseupdates:diagnose:org",
6530
+ "releaseupdates:hardis:diagnose:org",
6531
+ "releaseupdates:diagnose:hardis:org",
6532
+ "releaseupdates:diagnose:org:hardis"
6533
+ ]
6534
+ },
6535
+ "hardis:org:diagnose:unsecure-connected-apps": {
6536
+ "aliases": [],
6537
+ "args": {},
6538
+ "description": "\n## Command Behavior\n\n**Detects unsecured Connected Apps in a Salesforce org and generates detailed reports for security analysis.**\n\nThis command is a critical security diagnostic tool that helps administrators identify Connected Apps that may pose security risks due to improper configuration. It provides comprehensive analysis of OAuth tokens and Connected App security settings to ensure proper access control.\n\nKey functionalities:\n\n- **OAuth Token Analysis:** Queries all OAuth tokens in the org using SOQL to retrieve comprehensive token information including app names, users, authorization status, and usage statistics.\n- **Security Status Assessment:** Evaluates each Connected App's security configuration by checking the `IsUsingAdminAuthorization` flag to determine if admin pre-approval is required.\n- **Unsecured App Detection:** Identifies Connected Apps that allow users to authorize themselves without admin approval, which can pose security risks.\n- **Detailed Reporting:** Generates two comprehensive CSV reports:\n - **OAuth Tokens Report:** Lists all OAuth tokens with security status, user information, and usage data\n - **Connected Apps Summary:** Aggregates unsecured Connected Apps with counts of associated OAuth tokens\n- **Visual Indicators:** Uses status icons (❌ for unsecured, for secured) to provide immediate visual feedback on security status.\n- **Security Recommendations:** Provides actionable guidance on how to secure Connected Apps through proper configuration.\n- **Notifications:** Sends alerts to configured channels (Grafana, Slack, MS Teams) with security findings and attached reports.\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-org-security/) and can output Grafana, Slack and MsTeams Notifications.\n\n<iframe width=\"560\" height=\"315\" src=\"https://www.youtube.com/embed/jHv8yrSK8Dg\" title=\"YouTube video player\" frameborder=\"0\" allow=\"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture\" allowfullscreen></iframe>\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **SOQL Query Execution:** Executes a comprehensive SOQL query on the `OauthToken` object, joining with `AppMenuItem` and `User` objects to gather complete security context.\n- **Security Analysis Logic:** Analyzes the `AppMenuItem.IsUsingAdminAuthorization` field to determine if a Connected App requires admin pre-approval for user authorization.\n- **Data Transformation:** Processes raw SOQL results to add security status indicators and reorganize data for optimal reporting and analysis.\n- **Aggregation Processing:** Groups OAuth tokens by Connected App name to provide summary statistics and identify the most problematic applications.\n- **Report Generation:** Uses `generateCsvFile` to create structured CSV reports with proper formatting and metadata for easy analysis and sharing.\n- **Notification Integration:** Integrates with the `NotifProvider` to send security alerts with detailed metrics, including the number of unsecured Connected Apps and associated OAuth tokens.\n- **File Management:** Generates multiple output formats (CSV, XLSX) and manages file paths using `generateReportPath` for consistent report organization.\n- **Connection Management:** Uses `setConnectionVariables` to ensure proper authentication context for notification providers that require org connection details.\n</details>\n",
6539
+ "examples": [
6540
+ "$ sf hardis:org:diagnose:unsecure-connected-apps"
6541
+ ],
6542
+ "flags": {
6543
+ "json": {
6544
+ "description": "Format output as json.",
6545
+ "helpGroup": "GLOBAL",
6546
+ "name": "json",
6547
+ "allowNo": false,
6548
+ "type": "boolean"
6549
+ },
6550
+ "flags-dir": {
6551
+ "helpGroup": "GLOBAL",
6552
+ "name": "flags-dir",
6553
+ "summary": "Import flag values from a directory.",
6539
6554
  "hasDynamicHelp": false,
6540
6555
  "multiple": false,
6541
6556
  "type": "option"
@@ -6586,32 +6601,14 @@
6586
6601
  },
6587
6602
  "hasDynamicHelp": true,
6588
6603
  "hiddenAliases": [],
6589
- "id": "hardis:org:diagnose:unusedlicenses",
6604
+ "id": "hardis:org:diagnose:unsecure-connected-apps",
6590
6605
  "pluginAlias": "sfdx-hardis",
6591
6606
  "pluginName": "sfdx-hardis",
6592
6607
  "pluginType": "core",
6593
6608
  "strict": true,
6594
6609
  "enableJsonFlag": true,
6595
- "title": "Detect unused Permission Set Licenses (beta)",
6610
+ "title": "Detect Unsecured Connected Apps",
6596
6611
  "requiresProject": false,
6597
- "additionalPermissionSetsToAlwaysGet": [
6598
- "Sales_User"
6599
- ],
6600
- "permSetsPermSetLicenses": [
6601
- {
6602
- "permSet": "Sales_User",
6603
- "permSetLicense": "SalesUserPsl"
6604
- }
6605
- ],
6606
- "profilesPermissionSetLicenses": [
6607
- {
6608
- "profile": "Salesforce API Only",
6609
- "permSetLicense": "SalesforceAPIIntegrationPsl"
6610
- }
6611
- ],
6612
- "alwaysExcludeForActiveUsersPermissionSetLicenses": [
6613
- "IdentityConnect"
6614
- ],
6615
6612
  "isESM": true,
6616
6613
  "relativePath": [
6617
6614
  "lib",
@@ -6619,46 +6616,43 @@
6619
6616
  "hardis",
6620
6617
  "org",
6621
6618
  "diagnose",
6622
- "unusedlicenses.js"
6619
+ "unsecure-connected-apps.js"
6623
6620
  ],
6624
6621
  "aliasPermutations": [],
6625
6622
  "permutations": [
6626
- "hardis:org:diagnose:unusedlicenses",
6627
- "org:hardis:diagnose:unusedlicenses",
6628
- "org:diagnose:hardis:unusedlicenses",
6629
- "org:diagnose:unusedlicenses:hardis",
6630
- "hardis:diagnose:org:unusedlicenses",
6631
- "diagnose:hardis:org:unusedlicenses",
6632
- "diagnose:org:hardis:unusedlicenses",
6633
- "diagnose:org:unusedlicenses:hardis",
6634
- "hardis:diagnose:unusedlicenses:org",
6635
- "diagnose:hardis:unusedlicenses:org",
6636
- "diagnose:unusedlicenses:hardis:org",
6637
- "diagnose:unusedlicenses:org:hardis",
6638
- "hardis:org:unusedlicenses:diagnose",
6639
- "org:hardis:unusedlicenses:diagnose",
6640
- "org:unusedlicenses:hardis:diagnose",
6641
- "org:unusedlicenses:diagnose:hardis",
6642
- "hardis:unusedlicenses:org:diagnose",
6643
- "unusedlicenses:hardis:org:diagnose",
6644
- "unusedlicenses:org:hardis:diagnose",
6645
- "unusedlicenses:org:diagnose:hardis",
6646
- "hardis:unusedlicenses:diagnose:org",
6647
- "unusedlicenses:hardis:diagnose:org",
6648
- "unusedlicenses:diagnose:hardis:org",
6649
- "unusedlicenses:diagnose:org:hardis"
6623
+ "hardis:org:diagnose:unsecure-connected-apps",
6624
+ "org:hardis:diagnose:unsecure-connected-apps",
6625
+ "org:diagnose:hardis:unsecure-connected-apps",
6626
+ "org:diagnose:unsecure-connected-apps:hardis",
6627
+ "hardis:diagnose:org:unsecure-connected-apps",
6628
+ "diagnose:hardis:org:unsecure-connected-apps",
6629
+ "diagnose:org:hardis:unsecure-connected-apps",
6630
+ "diagnose:org:unsecure-connected-apps:hardis",
6631
+ "hardis:diagnose:unsecure-connected-apps:org",
6632
+ "diagnose:hardis:unsecure-connected-apps:org",
6633
+ "diagnose:unsecure-connected-apps:hardis:org",
6634
+ "diagnose:unsecure-connected-apps:org:hardis",
6635
+ "hardis:org:unsecure-connected-apps:diagnose",
6636
+ "org:hardis:unsecure-connected-apps:diagnose",
6637
+ "org:unsecure-connected-apps:hardis:diagnose",
6638
+ "org:unsecure-connected-apps:diagnose:hardis",
6639
+ "hardis:unsecure-connected-apps:org:diagnose",
6640
+ "unsecure-connected-apps:hardis:org:diagnose",
6641
+ "unsecure-connected-apps:org:hardis:diagnose",
6642
+ "unsecure-connected-apps:org:diagnose:hardis",
6643
+ "hardis:unsecure-connected-apps:diagnose:org",
6644
+ "unsecure-connected-apps:hardis:diagnose:org",
6645
+ "unsecure-connected-apps:diagnose:hardis:org",
6646
+ "unsecure-connected-apps:diagnose:org:hardis"
6650
6647
  ]
6651
6648
  },
6652
- "hardis:org:diagnose:unusedusers": {
6649
+ "hardis:org:diagnose:unused-apex-classes": {
6653
6650
  "aliases": [],
6654
6651
  "args": {},
6655
- "description": "\n## Command Behavior\n\n**Detects and reports on inactive or unused Salesforce user accounts, helping to optimize license usage and enhance security.**\n\nEfficient user management is vital in Salesforce to ensure resources are optimized and costs are controlled. However, inactive or unused user accounts can often go unnoticed, leading to wasted licenses and potential security risks. This tool addresses this challenge by enabling administrators to identify users who haven't logged in within a specified period.\n\nBy analyzing user login activity and last login timestamps, this feature highlights inactive user accounts, allowing administrators to take appropriate action. Whether it's deactivating dormant accounts, freeing up licenses, or ensuring compliance with security policies, this functionality empowers administrators to maintain a lean and secure Salesforce environment.\n\nKey functionalities:\n\n- **Inactivity Detection:** Identifies users who have not logged in for a specified number of days (`--days` flag, default 180 days in CI, 365 days otherwise).\n- **License Type Filtering:** Allows filtering users by license type using `--licensetypes` (e.g., `all-crm`, `all-paying`) or specific license identifiers using `--licenseidentifiers`.\n - `all-crm`: Includes `SFDC`, `AUL`, `AUL1`, `AULL_IGHT` licenses.\n - `all-paying`: Includes `SFDC`, `AUL`, `AUL1`, `AULL_IGHT`, `PID_Customer_Community`, `PID_Customer_Community_Login`, `PID_Partner_Community`, `PID_Partner_Community_Login` licenses.\n - Note: You can see the full list of available license identifiers in [Salesforce Documentation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/sfdx_cli_reference/sforce_api_objects_userlicense.htm).\n- **Active User Retrieval:** The `--returnactiveusers` flag inverts the command, allowing you to retrieve active users who *have* logged in during the specified period.\n- **CSV Report Generation:** Generates a CSV file containing details of all identified users (inactive or active), including their last login date, profile, and license information.\n- **Notifications:** Sends notifications to configured channels (Grafana, Slack, MS Teams) with a summary of inactive or active users.\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-inactive-users/) and can output Grafana, Slack and MsTeams Notifications.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **SOQL Query (Bulk API):** It uses `bulkQuery` to efficiently retrieve user records from the Salesforce `User` object. The SOQL query dynamically constructs its WHERE clause based on the `--days`, `--licensetypes`, `--licenseidentifiers`, and `--returnactiveusers` flags.\n- **Interactive Prompts:** Uses `prompts` to interactively ask the user for the number of inactive days and license types if not provided via flags.\n- **License Mapping:** Internally maps common license type aliases (e.g., `all-crm`) to their corresponding Salesforce `LicenseDefinitionKey` values.\n- **Report Generation:** It uses `generateCsvFile` to create the CSV report of users.\n- **Notification Integration:** It integrates with the `NotifProvider` to send notifications, including attachments of the generated CSV report and metrics for monitoring dashboards.\n- **User Feedback:** Provides a summary of the findings in the console, indicating the number of inactive or active users found.\n</details>",
6652
+ "description": "List all async Apex classes (Batch,Queueable,Schedulable) that has not been called for more than 365 days.\n \nThe result class list probably can be removed from the project, and that will improve your test classes performances 😊\n\nThe number of unused day is overridable using --days option. \n\nThe command uses queries on AsyncApexJob and CronTrigger technical tables to build the result.\n\nApex Classes CreatedBy and CreatedOn fields are calculated from MIN(date from git, date from org)\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-unused-apex-classes/) and can output Grafana, Slack and MsTeams Notifications.\n\n![](https://sfdx-hardis.cloudity.com/assets/images/screenshot-monitoring-unused-apex-grafana.jpg)\n",
6656
6653
  "examples": [
6657
- "$ sf hardis:org:diagnose:unusedusers",
6658
- "$ sf hardis:org:diagnose:unusedusers --days 365",
6659
- "$ sf hardis:org:diagnose:unusedusers --days 60 --licensetypes all-crm",
6660
- "$ sf hardis:org:diagnose:unusedusers --days 60 --licenseidentifiers SFDC,AUL,AUL1",
6661
- "$ sf hardis:org:diagnose:unusedusers --days 60 --licensetypes all-crm --returnactiveusers"
6654
+ "$ sf hardis:org:diagnose:unused-apex-classes",
6655
+ "$ sf hardis:org:diagnose:unused-apex-classes --days 700"
6662
6656
  ],
6663
6657
  "flags": {
6664
6658
  "json": {
@@ -6692,33 +6686,6 @@
6692
6686
  "multiple": false,
6693
6687
  "type": "option"
6694
6688
  },
6695
- "licensetypes": {
6696
- "char": "l",
6697
- "description": "Type of licenses to check. If set, do not use licenseidentifiers option. In CI, default is all-crm",
6698
- "name": "licensetypes",
6699
- "hasDynamicHelp": false,
6700
- "multiple": false,
6701
- "options": [
6702
- "all",
6703
- "all-crm",
6704
- "all-paying"
6705
- ],
6706
- "type": "option"
6707
- },
6708
- "licenseidentifiers": {
6709
- "char": "i",
6710
- "description": "Comma-separated list of license identifiers, in case licensetypes is not used.. Identifiers available at https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userlicense.htm",
6711
- "name": "licenseidentifiers",
6712
- "hasDynamicHelp": false,
6713
- "multiple": false,
6714
- "type": "option"
6715
- },
6716
- "returnactiveusers": {
6717
- "description": "Inverts the command by returning the active users",
6718
- "name": "returnactiveusers",
6719
- "allowNo": false,
6720
- "type": "boolean"
6721
- },
6722
6689
  "debug": {
6723
6690
  "char": "d",
6724
6691
  "description": "Activate debug mode (more logs)",
@@ -6757,13 +6724,13 @@
6757
6724
  },
6758
6725
  "hasDynamicHelp": true,
6759
6726
  "hiddenAliases": [],
6760
- "id": "hardis:org:diagnose:unusedusers",
6727
+ "id": "hardis:org:diagnose:unused-apex-classes",
6761
6728
  "pluginAlias": "sfdx-hardis",
6762
6729
  "pluginName": "sfdx-hardis",
6763
6730
  "pluginType": "core",
6764
6731
  "strict": true,
6765
6732
  "enableJsonFlag": true,
6766
- "title": "Detect unused Users in Salesforce",
6733
+ "title": "Detect unused Apex classes in an org",
6767
6734
  "requiresProject": false,
6768
6735
  "isESM": true,
6769
6736
  "relativePath": [
@@ -6772,42 +6739,42 @@
6772
6739
  "hardis",
6773
6740
  "org",
6774
6741
  "diagnose",
6775
- "unusedusers.js"
6742
+ "unused-apex-classes.js"
6776
6743
  ],
6777
6744
  "aliasPermutations": [],
6778
6745
  "permutations": [
6779
- "hardis:org:diagnose:unusedusers",
6780
- "org:hardis:diagnose:unusedusers",
6781
- "org:diagnose:hardis:unusedusers",
6782
- "org:diagnose:unusedusers:hardis",
6783
- "hardis:diagnose:org:unusedusers",
6784
- "diagnose:hardis:org:unusedusers",
6785
- "diagnose:org:hardis:unusedusers",
6786
- "diagnose:org:unusedusers:hardis",
6787
- "hardis:diagnose:unusedusers:org",
6788
- "diagnose:hardis:unusedusers:org",
6789
- "diagnose:unusedusers:hardis:org",
6790
- "diagnose:unusedusers:org:hardis",
6791
- "hardis:org:unusedusers:diagnose",
6792
- "org:hardis:unusedusers:diagnose",
6793
- "org:unusedusers:hardis:diagnose",
6794
- "org:unusedusers:diagnose:hardis",
6795
- "hardis:unusedusers:org:diagnose",
6796
- "unusedusers:hardis:org:diagnose",
6797
- "unusedusers:org:hardis:diagnose",
6798
- "unusedusers:org:diagnose:hardis",
6799
- "hardis:unusedusers:diagnose:org",
6800
- "unusedusers:hardis:diagnose:org",
6801
- "unusedusers:diagnose:hardis:org",
6802
- "unusedusers:diagnose:org:hardis"
6746
+ "hardis:org:diagnose:unused-apex-classes",
6747
+ "org:hardis:diagnose:unused-apex-classes",
6748
+ "org:diagnose:hardis:unused-apex-classes",
6749
+ "org:diagnose:unused-apex-classes:hardis",
6750
+ "hardis:diagnose:org:unused-apex-classes",
6751
+ "diagnose:hardis:org:unused-apex-classes",
6752
+ "diagnose:org:hardis:unused-apex-classes",
6753
+ "diagnose:org:unused-apex-classes:hardis",
6754
+ "hardis:diagnose:unused-apex-classes:org",
6755
+ "diagnose:hardis:unused-apex-classes:org",
6756
+ "diagnose:unused-apex-classes:hardis:org",
6757
+ "diagnose:unused-apex-classes:org:hardis",
6758
+ "hardis:org:unused-apex-classes:diagnose",
6759
+ "org:hardis:unused-apex-classes:diagnose",
6760
+ "org:unused-apex-classes:hardis:diagnose",
6761
+ "org:unused-apex-classes:diagnose:hardis",
6762
+ "hardis:unused-apex-classes:org:diagnose",
6763
+ "unused-apex-classes:hardis:org:diagnose",
6764
+ "unused-apex-classes:org:hardis:diagnose",
6765
+ "unused-apex-classes:org:diagnose:hardis",
6766
+ "hardis:unused-apex-classes:diagnose:org",
6767
+ "unused-apex-classes:hardis:diagnose:org",
6768
+ "unused-apex-classes:diagnose:hardis:org",
6769
+ "unused-apex-classes:diagnose:org:hardis"
6803
6770
  ]
6804
6771
  },
6805
- "hardis:org:files:export": {
6772
+ "hardis:org:diagnose:unused-connected-apps": {
6806
6773
  "aliases": [],
6807
6774
  "args": {},
6808
- "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[![How to mass download notes and attachments files from a Salesforce org](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/article-mass-download.jpg)](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",
6775
+ "description": "\n## Command Behavior\n\n**Identifies and reports on potentially unused Connected Apps in a Salesforce org, suggesting candidates for deletion or deactivation.**\n\nThis command helps improve org security and reduce technical debt by pinpointing Connected Apps that are no longer actively used. Connected Apps can pose security risks if left unmonitored, and cleaning them up contributes to a healthier Salesforce environment.\n\nKey functionalities:\n\n- **Connected App Data Collection:** Gathers information about all Connected Apps in the org, including creation and last modified dates, and associated users.\n- **Usage Analysis:** Analyzes `LoginHistory` and `OAuthToken` records to determine the last usage date of each Connected App.\n- **Inactivity Detection:** Flags Connected Apps as potentially unused if they have no recent login history or OAuth token usage.\n- **Accessibility Check:** Examines Connected App metadata to identify if they are accessible (e.g., if they require admin approval and have no profiles or permission sets assigned).\n- **Ignored Apps:** Automatically ignores a predefined list of common Salesforce Connected Apps (e.g., `Salesforce CLI`, `Salesforce Mobile Dashboards`). You can extend this list by defining the `ALLOWED_INACTIVE_CONNECTED_APPS` environment variable.\n- **CSV Report Generation:** Generates a CSV file containing details of all analyzed Connected Apps, including their usage status, last usage date, and reasons for being flagged as potentially unused.\n- **Notifications:** Sends notifications to configured channels (Grafana, Slack, MS Teams) with a summary of potentially unused Connected Apps.\n\n**Default Ignored Connected Apps:**\n\n- Ant Migration Tool\n- Chatter Desktop\n- Chatter Mobile for BlackBerry\n- Force.com IDE\n- OIQ_Integration\n- Salesforce CLI\n- Salesforce Files\n- Salesforce Mobile Dashboards\n- Salesforce Touch\n- Salesforce for Outlook\n- SalesforceA\n- SalesforceA for Android\n- SalesforceA for iOS\n- SalesforceDX Namespace Registry\n- SalesforceIQ\n\nYou can add more ignored apps by defining a comma-separated list of names in the `ALLOWED_INACTIVE_CONNECTED_APPS` environment variable.\n\n_Example: \nALLOWED_INACTIVE_CONNECTED_APPS=My App 1,My App 2, My App 3_\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-unused-connected-apps/) and can output Grafana, Slack and MsTeams Notifications.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **Salesforce SOQL Queries:** It performs SOQL queries against `ConnectedApplication`, `LoginHistory`, and `OAuthToken` objects to gather comprehensive data about Connected Apps and their usage.\n- **Temporary SFDX Project:** It creates a temporary SFDX project to retrieve Connected App metadata, allowing for local parsing and analysis of their XML files.\n- **Metadata Parsing:** It parses the `connectedApp-meta.xml` files to check for `isAdminApproved` and the presence of `profileName` or `permissionsetName` to determine accessibility.\n- **Data Correlation:** It correlates data from various Salesforce objects to build a complete picture of each Connected App's usage and status.\n- **Date Calculation:** Uses `moment` to calculate the time since the last OAuth token usage.\n- **Report Generation:** It uses `generateCsvFile` to create the CSV report of unused Connected Apps.\n- **Notification Integration:** It integrates with the `NotifProvider` to send notifications, including attachments of the generated CSV report and metrics for monitoring dashboards.\n- **File System Operations:** Uses `fs-extra` for creating and removing temporary directories and files.\n- **Environment Variable Reading:** Reads the `ALLOWED_INACTIVE_CONNECTED_APPS` environment variable to customize the list of ignored Connected Apps.\n</details>\n",
6809
6776
  "examples": [
6810
- "$ sf hardis:org:files:export"
6777
+ "$ sf hardis:org:diagnose:unused-connected-apps"
6811
6778
  ],
6812
6779
  "flags": {
6813
6780
  "json": {
@@ -6825,58 +6792,24 @@
6825
6792
  "multiple": false,
6826
6793
  "type": "option"
6827
6794
  },
6828
- "path": {
6829
- "char": "p",
6830
- "description": "Path to the file export project",
6831
- "name": "path",
6832
- "hasDynamicHelp": false,
6833
- "multiple": false,
6834
- "type": "option"
6835
- },
6836
- "chunksize": {
6837
- "char": "c",
6838
- "description": "Number of records to add in a chunk before it is processed",
6839
- "name": "chunksize",
6840
- "default": 1000,
6795
+ "outputfile": {
6796
+ "char": "f",
6797
+ "description": "Force the path and name of output report file. Must end with .csv",
6798
+ "name": "outputfile",
6841
6799
  "hasDynamicHelp": false,
6842
6800
  "multiple": false,
6843
6801
  "type": "option"
6844
6802
  },
6845
- "polltimeout": {
6846
- "char": "t",
6847
- "description": "Timeout in MS for Bulk API calls",
6848
- "name": "polltimeout",
6849
- "default": 300000,
6850
- "hasDynamicHelp": false,
6851
- "multiple": false,
6852
- "type": "option"
6803
+ "debug": {
6804
+ "char": "d",
6805
+ "description": "Activate debug mode (more logs)",
6806
+ "name": "debug",
6807
+ "allowNo": false,
6808
+ "type": "boolean"
6853
6809
  },
6854
- "startchunknumber": {
6855
- "char": "s",
6856
- "description": "Chunk number to start from",
6857
- "name": "startchunknumber",
6858
- "default": 0,
6859
- "hasDynamicHelp": false,
6860
- "multiple": false,
6861
- "type": "option"
6862
- },
6863
- "resume": {
6864
- "char": "r",
6865
- "description": "Resume previous export by checking existing files (default in CI)",
6866
- "name": "resume",
6867
- "allowNo": false,
6868
- "type": "boolean"
6869
- },
6870
- "debug": {
6871
- "char": "d",
6872
- "description": "Activate debug mode (more logs)",
6873
- "name": "debug",
6874
- "allowNo": false,
6875
- "type": "boolean"
6876
- },
6877
- "websocket": {
6878
- "description": "Websocket host:port for VsCode SFDX Hardis UI integration",
6879
- "name": "websocket",
6810
+ "websocket": {
6811
+ "description": "Websocket host:port for VsCode SFDX Hardis UI integration",
6812
+ "name": "websocket",
6880
6813
  "hasDynamicHelp": false,
6881
6814
  "multiple": false,
6882
6815
  "type": "option"
@@ -6905,13 +6838,30 @@
6905
6838
  },
6906
6839
  "hasDynamicHelp": true,
6907
6840
  "hiddenAliases": [],
6908
- "id": "hardis:org:files:export",
6841
+ "id": "hardis:org:diagnose:unused-connected-apps",
6909
6842
  "pluginAlias": "sfdx-hardis",
6910
6843
  "pluginName": "sfdx-hardis",
6911
6844
  "pluginType": "core",
6912
6845
  "strict": true,
6913
6846
  "enableJsonFlag": true,
6914
- "title": "Export files",
6847
+ "title": "Unused Connected Apps in an org",
6848
+ "allowedInactiveConnectedApps": [
6849
+ "Ant Migration Tool",
6850
+ "Chatter Desktop",
6851
+ "Chatter Mobile for BlackBerry",
6852
+ "Force.com IDE",
6853
+ "OIQ_Integration",
6854
+ "Salesforce CLI",
6855
+ "Salesforce Files",
6856
+ "Salesforce Mobile Dashboards",
6857
+ "Salesforce Touch",
6858
+ "Salesforce for Outlook",
6859
+ "SalesforceA",
6860
+ "SalesforceA for Android",
6861
+ "SalesforceA for iOS",
6862
+ "SalesforceDX Namespace Registry",
6863
+ "SalesforceIQ"
6864
+ ],
6915
6865
  "requiresProject": false,
6916
6866
  "isESM": true,
6917
6867
  "relativePath": [
@@ -6919,43 +6869,44 @@
6919
6869
  "commands",
6920
6870
  "hardis",
6921
6871
  "org",
6922
- "files",
6923
- "export.js"
6872
+ "diagnose",
6873
+ "unused-connected-apps.js"
6924
6874
  ],
6925
6875
  "aliasPermutations": [],
6926
6876
  "permutations": [
6927
- "hardis:org:files:export",
6928
- "org:hardis:files:export",
6929
- "org:files:hardis:export",
6930
- "org:files:export:hardis",
6931
- "hardis:files:org:export",
6932
- "files:hardis:org:export",
6933
- "files:org:hardis:export",
6934
- "files:org:export:hardis",
6935
- "hardis:files:export:org",
6936
- "files:hardis:export:org",
6937
- "files:export:hardis:org",
6938
- "files:export:org:hardis",
6939
- "hardis:org:export:files",
6940
- "org:hardis:export:files",
6941
- "org:export:hardis:files",
6942
- "org:export:files:hardis",
6943
- "hardis:export:org:files",
6944
- "export:hardis:org:files",
6945
- "export:org:hardis:files",
6946
- "export:org:files:hardis",
6947
- "hardis:export:files:org",
6948
- "export:hardis:files:org",
6949
- "export:files:hardis:org",
6950
- "export:files:org:hardis"
6877
+ "hardis:org:diagnose:unused-connected-apps",
6878
+ "org:hardis:diagnose:unused-connected-apps",
6879
+ "org:diagnose:hardis:unused-connected-apps",
6880
+ "org:diagnose:unused-connected-apps:hardis",
6881
+ "hardis:diagnose:org:unused-connected-apps",
6882
+ "diagnose:hardis:org:unused-connected-apps",
6883
+ "diagnose:org:hardis:unused-connected-apps",
6884
+ "diagnose:org:unused-connected-apps:hardis",
6885
+ "hardis:diagnose:unused-connected-apps:org",
6886
+ "diagnose:hardis:unused-connected-apps:org",
6887
+ "diagnose:unused-connected-apps:hardis:org",
6888
+ "diagnose:unused-connected-apps:org:hardis",
6889
+ "hardis:org:unused-connected-apps:diagnose",
6890
+ "org:hardis:unused-connected-apps:diagnose",
6891
+ "org:unused-connected-apps:hardis:diagnose",
6892
+ "org:unused-connected-apps:diagnose:hardis",
6893
+ "hardis:unused-connected-apps:org:diagnose",
6894
+ "unused-connected-apps:hardis:org:diagnose",
6895
+ "unused-connected-apps:org:hardis:diagnose",
6896
+ "unused-connected-apps:org:diagnose:hardis",
6897
+ "hardis:unused-connected-apps:diagnose:org",
6898
+ "unused-connected-apps:hardis:diagnose:org",
6899
+ "unused-connected-apps:diagnose:hardis:org",
6900
+ "unused-connected-apps:diagnose:org:hardis"
6951
6901
  ]
6952
6902
  },
6953
- "hardis:org:files:import": {
6903
+ "hardis:org:diagnose:unusedlicenses": {
6954
6904
  "aliases": [],
6955
6905
  "args": {},
6956
- "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[![How to mass download notes and attachments files from a Salesforce org](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/article-mass-download.jpg)](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",
6906
+ "description": "\n## Command Behavior\n\n**Detects and suggests the deletion of unused Permission Set License Assignments in a Salesforce org.**\n\nWhen a Permission Set (PS) linked to a Permission Set License (PSL) is assigned to a user, a Permission Set License Assignment (PSLA) is automatically created. However, when that PS is unassigned from the user, the PSLA is *not* automatically deleted. This can lead to organizations being charged for unused PSLAs, representing a hidden cost and technical debt.\n\nThis command identifies such useless PSLAs and provides options to delete them, helping to optimize license usage and reduce unnecessary expenses.\n\nKey functionalities:\n\n- **PSLA Detection:** Queries the Salesforce org to find all active PSLAs.\n- **Usage Verification:** Correlates PSLAs with actual Permission Set Assignments and Permission Set Group Assignments to determine if the underlying Permission Sets are still assigned to the user.\n- **Special Case Handling:** Accounts for specific scenarios where profiles might implicitly assign PSLAs (e.g., `Salesforce API Only` profile assigning `SalesforceAPIIntegrationPsl`) and allows for always excluding certain PSLAs from the unused check.\n- **Reporting:** Generates a CSV report of all identified unused PSLAs, including the user and the associated Permission Set License.\n- **Notifications:** Sends notifications to configured channels (Grafana, Slack, MS Teams) with a summary of unused PSLAs.\n- **Interactive Deletion:** In non-CI environments, it offers an interactive prompt to bulk delete the identified unused PSLAs.\n\nMany thanks to [Vincent Finet](https://www.linkedin.com/in/vincentfinet/) for the inspiration during his great speaker session at [French Touch Dreamin '23](https://frenchtouchdreamin.com/), and his kind agreement for reusing such inspiration in this command 😊\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-unused-licenses/) and can output Grafana, Slack and MsTeams Notifications.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves extensive querying of Salesforce objects and data correlation:\n\n- **SOQL Queries (Bulk API):** It uses `bulkQuery` and `bulkQueryChunksIn` to efficiently retrieve large volumes of data from `PermissionSetLicenseAssign`, `PermissionSetLicense`, `PermissionSet`, `PermissionSetGroupComponent`, and `PermissionSetAssignment` objects.\n- **Data Correlation:** It meticulously correlates data across these objects to determine if a `PermissionSetLicenseAssign` record has a corresponding active assignment to a Permission Set or Permission Set Group for the same user.\n- **Filtering Logic:** It applies complex filtering logic to exclude PSLAs that are genuinely in use or are part of predefined exceptions (e.g., `alwaysExcludeForActiveUsersPermissionSetLicenses`).\n- **Bulk Deletion:** If the user opts to delete unused PSLAs, it uses `bulkUpdate` with the `delete` operation to efficiently remove multiple records.\n- **Report Generation:** It uses `generateCsvFile` to create the CSV report of unused PSLAs.\n- **Notification Integration:** It integrates with the `NotifProvider` to send notifications, including attachments of the generated CSV report and metrics for monitoring dashboards.\n- **User Interaction:** Uses `prompts` for interactive confirmation before performing deletion operations.\n</details>\n",
6957
6907
  "examples": [
6958
- "$ sf hardis:org:files:import"
6908
+ "$ sf hardis:org:diagnose:unusedlicenses",
6909
+ "$ sf hardis:org:diagnose:unusedlicenses --fix"
6959
6910
  ],
6960
6911
  "flags": {
6961
6912
  "json": {
@@ -6973,21 +6924,14 @@
6973
6924
  "multiple": false,
6974
6925
  "type": "option"
6975
6926
  },
6976
- "path": {
6977
- "char": "p",
6978
- "description": "Path to the file export project",
6979
- "name": "path",
6927
+ "outputfile": {
6928
+ "char": "f",
6929
+ "description": "Force the path and name of output report file. Must end with .csv",
6930
+ "name": "outputfile",
6980
6931
  "hasDynamicHelp": false,
6981
6932
  "multiple": false,
6982
6933
  "type": "option"
6983
6934
  },
6984
- "overwrite": {
6985
- "char": "f",
6986
- "description": "Override existing files (doubles the number of API calls)",
6987
- "name": "overwrite",
6988
- "allowNo": false,
6989
- "type": "boolean"
6990
- },
6991
6935
  "debug": {
6992
6936
  "char": "d",
6993
6937
  "description": "Activate debug mode (more logs)",
@@ -7026,58 +6970,79 @@
7026
6970
  },
7027
6971
  "hasDynamicHelp": true,
7028
6972
  "hiddenAliases": [],
7029
- "id": "hardis:org:files:import",
6973
+ "id": "hardis:org:diagnose:unusedlicenses",
7030
6974
  "pluginAlias": "sfdx-hardis",
7031
6975
  "pluginName": "sfdx-hardis",
7032
6976
  "pluginType": "core",
7033
6977
  "strict": true,
7034
6978
  "enableJsonFlag": true,
7035
- "title": "Import files",
6979
+ "title": "Detect unused Permission Set Licenses (beta)",
7036
6980
  "requiresProject": false,
6981
+ "additionalPermissionSetsToAlwaysGet": [
6982
+ "Sales_User"
6983
+ ],
6984
+ "permSetsPermSetLicenses": [
6985
+ {
6986
+ "permSet": "Sales_User",
6987
+ "permSetLicense": "SalesUserPsl"
6988
+ }
6989
+ ],
6990
+ "profilesPermissionSetLicenses": [
6991
+ {
6992
+ "profile": "Salesforce API Only",
6993
+ "permSetLicense": "SalesforceAPIIntegrationPsl"
6994
+ }
6995
+ ],
6996
+ "alwaysExcludeForActiveUsersPermissionSetLicenses": [
6997
+ "IdentityConnect"
6998
+ ],
7037
6999
  "isESM": true,
7038
7000
  "relativePath": [
7039
7001
  "lib",
7040
7002
  "commands",
7041
7003
  "hardis",
7042
7004
  "org",
7043
- "files",
7044
- "import.js"
7005
+ "diagnose",
7006
+ "unusedlicenses.js"
7045
7007
  ],
7046
7008
  "aliasPermutations": [],
7047
7009
  "permutations": [
7048
- "hardis:org:files:import",
7049
- "org:hardis:files:import",
7050
- "org:files:hardis:import",
7051
- "org:files:import:hardis",
7052
- "hardis:files:org:import",
7053
- "files:hardis:org:import",
7054
- "files:org:hardis:import",
7055
- "files:org:import:hardis",
7056
- "hardis:files:import:org",
7057
- "files:hardis:import:org",
7058
- "files:import:hardis:org",
7059
- "files:import:org:hardis",
7060
- "hardis:org:import:files",
7061
- "org:hardis:import:files",
7062
- "org:import:hardis:files",
7063
- "org:import:files:hardis",
7064
- "hardis:import:org:files",
7065
- "import:hardis:org:files",
7066
- "import:org:hardis:files",
7067
- "import:org:files:hardis",
7068
- "hardis:import:files:org",
7069
- "import:hardis:files:org",
7070
- "import:files:hardis:org",
7071
- "import:files:org:hardis"
7010
+ "hardis:org:diagnose:unusedlicenses",
7011
+ "org:hardis:diagnose:unusedlicenses",
7012
+ "org:diagnose:hardis:unusedlicenses",
7013
+ "org:diagnose:unusedlicenses:hardis",
7014
+ "hardis:diagnose:org:unusedlicenses",
7015
+ "diagnose:hardis:org:unusedlicenses",
7016
+ "diagnose:org:hardis:unusedlicenses",
7017
+ "diagnose:org:unusedlicenses:hardis",
7018
+ "hardis:diagnose:unusedlicenses:org",
7019
+ "diagnose:hardis:unusedlicenses:org",
7020
+ "diagnose:unusedlicenses:hardis:org",
7021
+ "diagnose:unusedlicenses:org:hardis",
7022
+ "hardis:org:unusedlicenses:diagnose",
7023
+ "org:hardis:unusedlicenses:diagnose",
7024
+ "org:unusedlicenses:hardis:diagnose",
7025
+ "org:unusedlicenses:diagnose:hardis",
7026
+ "hardis:unusedlicenses:org:diagnose",
7027
+ "unusedlicenses:hardis:org:diagnose",
7028
+ "unusedlicenses:org:hardis:diagnose",
7029
+ "unusedlicenses:org:diagnose:hardis",
7030
+ "hardis:unusedlicenses:diagnose:org",
7031
+ "unusedlicenses:hardis:diagnose:org",
7032
+ "unusedlicenses:diagnose:hardis:org",
7033
+ "unusedlicenses:diagnose:org:hardis"
7072
7034
  ]
7073
7035
  },
7074
- "hardis:org:fix:listviewmine": {
7036
+ "hardis:org:diagnose:unusedusers": {
7075
7037
  "aliases": [],
7076
7038
  "args": {},
7077
- "description": "Fix listviews whose scope Mine has been replaced by Everything\n\n[![Invalid scope:Mine, not allowed ? Deploy your ListViews anyway !](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/article-invalid-scope-mine.jpg)](https://nicolas.vuillamy.fr/invalid-scope-mine-not-allowed-deploy-your-listviews-anyway-443aceca8ac7)\n\nList of ListViews can be:\n\n- read from .sfdx-hardis.yml file in property **listViewsToSetToMine**\n- sent in argument listviews\n\nNote: property **listViewsToSetToMine** can be auto-generated by command hardis:work:save if .sfdx-hardis.yml contains the following configuration\n\n```yaml\nautoCleanTypes:\n - listViewsMine\n```\n\n- Example of sfdx-hardis.yml property `listViewsToSetToMine`:\n\n```yaml\nlistViewsToSetToMine:\n - \"force-app/main/default/objects/Operation__c/listViews/MyCurrentOperations.listView-meta.xml\"\n - \"force-app/main/default/objects/Operation__c/listViews/MyFinalizedOperations.listView-meta.xml\"\n - \"force-app/main/default/objects/Opportunity/listViews/Default_Opportunity_Pipeline.listView-meta.xml\"\n - \"force-app/main/default/objects/Opportunity/listViews/MyCurrentSubscriptions.listView-meta.xml\"\n - \"force-app/main/default/objects/Opportunity/listViews/MySubscriptions.listView-meta.xml\"\n - \"force-app/main/default/objects/Account/listViews/MyActivePartners.listView-meta.xml\"\n```\n\n- If manually written, this could also be:\n\n```yaml\nlistViewsToSetToMine:\n - \"Operation__c:MyCurrentOperations\"\n - \"Operation__c:MyFinalizedOperations\"\n - \"Opportunity:Default_Opportunity_Pipeline\"\n - \"Opportunity:MyCurrentSubscriptions\"\n - \"Opportunity:MySubscriptions\"\n - \"Account:MyActivePartners\"\n```\n\nTroubleshooting: if you need to run this command from an alpine-linux based docker image, use this workaround in your dockerfile:\n\n```dockerfile\n# Do not use puppeteer embedded chromium\nRUN apk add --update --no-cache chromium\nENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=\"true\"\nENV CHROMIUM_PATH=\"/usr/bin/chromium-browser\"\nENV PUPPETEER_EXECUTABLE_PATH=\"$\\{CHROMIUM_PATH}\" // remove \\ before {\n```\n",
7039
+ "description": "\n## Command Behavior\n\n**Detects and reports on inactive or unused Salesforce user accounts, helping to optimize license usage and enhance security.**\n\nEfficient user management is vital in Salesforce to ensure resources are optimized and costs are controlled. However, inactive or unused user accounts can often go unnoticed, leading to wasted licenses and potential security risks. This tool addresses this challenge by enabling administrators to identify users who haven't logged in within a specified period.\n\nBy analyzing user login activity and last login timestamps, this feature highlights inactive user accounts, allowing administrators to take appropriate action. Whether it's deactivating dormant accounts, freeing up licenses, or ensuring compliance with security policies, this functionality empowers administrators to maintain a lean and secure Salesforce environment.\n\nKey functionalities:\n\n- **Inactivity Detection:** Identifies users who have not logged in for a specified number of days (`--days` flag, default 180 days in CI, 365 days otherwise).\n- **License Type Filtering:** Allows filtering users by license type using `--licensetypes` (e.g., `all-crm`, `all-paying`) or specific license identifiers using `--licenseidentifiers`.\n - `all-crm`: Includes `SFDC`, `AUL`, `AUL1`, `AULL_IGHT` licenses.\n - `all-paying`: Includes `SFDC`, `AUL`, `AUL1`, `AULL_IGHT`, `PID_Customer_Community`, `PID_Customer_Community_Login`, `PID_Partner_Community`, `PID_Partner_Community_Login` licenses.\n - Note: You can see the full list of available license identifiers in [Salesforce Documentation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/sfdx_cli_reference/sforce_api_objects_userlicense.htm).\n- **Active User Retrieval:** The `--returnactiveusers` flag inverts the command, allowing you to retrieve active users who *have* logged in during the specified period.\n- **CSV Report Generation:** Generates a CSV file containing details of all identified users (inactive or active), including their last login date, profile, and license information.\n- **Notifications:** Sends notifications to configured channels (Grafana, Slack, MS Teams) with a summary of inactive or active users.\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-inactive-users/) and can output Grafana, Slack and MsTeams Notifications.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **SOQL Query (Bulk API):** It uses `bulkQuery` to efficiently retrieve user records from the Salesforce `User` object. The SOQL query dynamically constructs its WHERE clause based on the `--days`, `--licensetypes`, `--licenseidentifiers`, and `--returnactiveusers` flags.\n- **Interactive Prompts:** Uses `prompts` to interactively ask the user for the number of inactive days and license types if not provided via flags.\n- **License Mapping:** Internally maps common license type aliases (e.g., `all-crm`) to their corresponding Salesforce `LicenseDefinitionKey` values.\n- **Report Generation:** It uses `generateCsvFile` to create the CSV report of users.\n- **Notification Integration:** It integrates with the `NotifProvider` to send notifications, including attachments of the generated CSV report and metrics for monitoring dashboards.\n- **User Feedback:** Provides a summary of the findings in the console, indicating the number of inactive or active users found.\n</details>",
7078
7040
  "examples": [
7079
- "$ sf hardis:org:fix:listviewmine",
7080
- "$ sf hardis:org:fix:listviewmine --listviews Opportunity:MySubscriptions,Account:MyActivePartners"
7041
+ "$ sf hardis:org:diagnose:unusedusers",
7042
+ "$ sf hardis:org:diagnose:unusedusers --days 365",
7043
+ "$ sf hardis:org:diagnose:unusedusers --days 60 --licensetypes all-crm",
7044
+ "$ sf hardis:org:diagnose:unusedusers --days 60 --licenseidentifiers SFDC,AUL,AUL1",
7045
+ "$ sf hardis:org:diagnose:unusedusers --days 60 --licensetypes all-crm --returnactiveusers"
7081
7046
  ],
7082
7047
  "flags": {
7083
7048
  "json": {
@@ -7095,14 +7060,49 @@
7095
7060
  "multiple": false,
7096
7061
  "type": "option"
7097
7062
  },
7098
- "listviews": {
7063
+ "outputfile": {
7064
+ "char": "f",
7065
+ "description": "Force the path and name of output report file. Must end with .csv",
7066
+ "name": "outputfile",
7067
+ "hasDynamicHelp": false,
7068
+ "multiple": false,
7069
+ "type": "option"
7070
+ },
7071
+ "days": {
7072
+ "char": "t",
7073
+ "description": "Extracts the users that have been inactive for the amount of days specified. In CI, default is 180 days",
7074
+ "name": "days",
7075
+ "hasDynamicHelp": false,
7076
+ "multiple": false,
7077
+ "type": "option"
7078
+ },
7079
+ "licensetypes": {
7099
7080
  "char": "l",
7100
- "description": "Comma-separated list of listviews following format Object:ListViewName\nExample: Contact:MyContacts,Contact:MyActiveContacts,Opportunity:MYClosedOpportunities",
7101
- "name": "listviews",
7081
+ "description": "Type of licenses to check. If set, do not use licenseidentifiers option. In CI, default is all-crm",
7082
+ "name": "licensetypes",
7083
+ "hasDynamicHelp": false,
7084
+ "multiple": false,
7085
+ "options": [
7086
+ "all",
7087
+ "all-crm",
7088
+ "all-paying"
7089
+ ],
7090
+ "type": "option"
7091
+ },
7092
+ "licenseidentifiers": {
7093
+ "char": "i",
7094
+ "description": "Comma-separated list of license identifiers, in case licensetypes is not used.. Identifiers available at https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userlicense.htm",
7095
+ "name": "licenseidentifiers",
7102
7096
  "hasDynamicHelp": false,
7103
7097
  "multiple": false,
7104
7098
  "type": "option"
7105
7099
  },
7100
+ "returnactiveusers": {
7101
+ "description": "Inverts the command by returning the active users",
7102
+ "name": "returnactiveusers",
7103
+ "allowNo": false,
7104
+ "type": "boolean"
7105
+ },
7106
7106
  "debug": {
7107
7107
  "char": "d",
7108
7108
  "description": "Activate debug mode (more logs)",
@@ -7141,49 +7141,49 @@
7141
7141
  },
7142
7142
  "hasDynamicHelp": true,
7143
7143
  "hiddenAliases": [],
7144
- "id": "hardis:org:fix:listviewmine",
7144
+ "id": "hardis:org:diagnose:unusedusers",
7145
7145
  "pluginAlias": "sfdx-hardis",
7146
7146
  "pluginName": "sfdx-hardis",
7147
7147
  "pluginType": "core",
7148
7148
  "strict": true,
7149
7149
  "enableJsonFlag": true,
7150
- "title": "Fix listviews with ",
7151
- "requiresProject": true,
7150
+ "title": "Detect unused Users in Salesforce",
7151
+ "requiresProject": false,
7152
7152
  "isESM": true,
7153
7153
  "relativePath": [
7154
7154
  "lib",
7155
7155
  "commands",
7156
7156
  "hardis",
7157
7157
  "org",
7158
- "fix",
7159
- "listviewmine.js"
7158
+ "diagnose",
7159
+ "unusedusers.js"
7160
7160
  ],
7161
7161
  "aliasPermutations": [],
7162
7162
  "permutations": [
7163
- "hardis:org:fix:listviewmine",
7164
- "org:hardis:fix:listviewmine",
7165
- "org:fix:hardis:listviewmine",
7166
- "org:fix:listviewmine:hardis",
7167
- "hardis:fix:org:listviewmine",
7168
- "fix:hardis:org:listviewmine",
7169
- "fix:org:hardis:listviewmine",
7170
- "fix:org:listviewmine:hardis",
7171
- "hardis:fix:listviewmine:org",
7172
- "fix:hardis:listviewmine:org",
7173
- "fix:listviewmine:hardis:org",
7174
- "fix:listviewmine:org:hardis",
7175
- "hardis:org:listviewmine:fix",
7176
- "org:hardis:listviewmine:fix",
7177
- "org:listviewmine:hardis:fix",
7178
- "org:listviewmine:fix:hardis",
7179
- "hardis:listviewmine:org:fix",
7180
- "listviewmine:hardis:org:fix",
7181
- "listviewmine:org:hardis:fix",
7182
- "listviewmine:org:fix:hardis",
7183
- "hardis:listviewmine:fix:org",
7184
- "listviewmine:hardis:fix:org",
7185
- "listviewmine:fix:hardis:org",
7186
- "listviewmine:fix:org:hardis"
7163
+ "hardis:org:diagnose:unusedusers",
7164
+ "org:hardis:diagnose:unusedusers",
7165
+ "org:diagnose:hardis:unusedusers",
7166
+ "org:diagnose:unusedusers:hardis",
7167
+ "hardis:diagnose:org:unusedusers",
7168
+ "diagnose:hardis:org:unusedusers",
7169
+ "diagnose:org:hardis:unusedusers",
7170
+ "diagnose:org:unusedusers:hardis",
7171
+ "hardis:diagnose:unusedusers:org",
7172
+ "diagnose:hardis:unusedusers:org",
7173
+ "diagnose:unusedusers:hardis:org",
7174
+ "diagnose:unusedusers:org:hardis",
7175
+ "hardis:org:unusedusers:diagnose",
7176
+ "org:hardis:unusedusers:diagnose",
7177
+ "org:unusedusers:hardis:diagnose",
7178
+ "org:unusedusers:diagnose:hardis",
7179
+ "hardis:unusedusers:org:diagnose",
7180
+ "unusedusers:hardis:org:diagnose",
7181
+ "unusedusers:org:hardis:diagnose",
7182
+ "unusedusers:org:diagnose:hardis",
7183
+ "hardis:unusedusers:diagnose:org",
7184
+ "unusedusers:hardis:diagnose:org",
7185
+ "unusedusers:diagnose:hardis:org",
7186
+ "unusedusers:diagnose:org:hardis"
7187
7187
  ]
7188
7188
  },
7189
7189
  "hardis:org:generate:packagexmlfull": {
@@ -7689,287 +7689,18 @@
7689
7689
  "allowNo": false,
7690
7690
  "type": "boolean"
7691
7691
  },
7692
- "flags-dir": {
7693
- "helpGroup": "GLOBAL",
7694
- "name": "flags-dir",
7695
- "summary": "Import flag values from a directory.",
7696
- "hasDynamicHelp": false,
7697
- "multiple": false,
7698
- "type": "option"
7699
- },
7700
- "outputfile": {
7701
- "char": "f",
7702
- "description": "Force the path and name of output report file. Must end with .csv",
7703
- "name": "outputfile",
7704
- "hasDynamicHelp": false,
7705
- "multiple": false,
7706
- "type": "option"
7707
- },
7708
- "debug": {
7709
- "char": "d",
7710
- "description": "Activate debug mode (more logs)",
7711
- "name": "debug",
7712
- "allowNo": false,
7713
- "type": "boolean"
7714
- },
7715
- "websocket": {
7716
- "description": "Websocket host:port for VsCode SFDX Hardis UI integration",
7717
- "name": "websocket",
7718
- "hasDynamicHelp": false,
7719
- "multiple": false,
7720
- "type": "option"
7721
- },
7722
- "skipauth": {
7723
- "description": "Skip authentication check when a default username is required",
7724
- "name": "skipauth",
7725
- "allowNo": false,
7726
- "type": "boolean"
7727
- },
7728
- "target-org": {
7729
- "aliases": [
7730
- "targetusername",
7731
- "u"
7732
- ],
7733
- "char": "o",
7734
- "deprecateAliases": true,
7735
- "name": "target-org",
7736
- "noCacheDefault": true,
7737
- "required": true,
7738
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
7739
- "hasDynamicHelp": true,
7740
- "multiple": false,
7741
- "type": "option"
7742
- }
7743
- },
7744
- "hasDynamicHelp": true,
7745
- "hiddenAliases": [],
7746
- "id": "hardis:org:monitor:limits",
7747
- "pluginAlias": "sfdx-hardis",
7748
- "pluginName": "sfdx-hardis",
7749
- "pluginType": "core",
7750
- "strict": true,
7751
- "enableJsonFlag": true,
7752
- "title": "Check org limits",
7753
- "requiresProject": true,
7754
- "triggerNotification": true,
7755
- "isESM": true,
7756
- "relativePath": [
7757
- "lib",
7758
- "commands",
7759
- "hardis",
7760
- "org",
7761
- "monitor",
7762
- "limits.js"
7763
- ],
7764
- "aliasPermutations": [],
7765
- "permutations": [
7766
- "hardis:org:monitor:limits",
7767
- "org:hardis:monitor:limits",
7768
- "org:monitor:hardis:limits",
7769
- "org:monitor:limits:hardis",
7770
- "hardis:monitor:org:limits",
7771
- "monitor:hardis:org:limits",
7772
- "monitor:org:hardis:limits",
7773
- "monitor:org:limits:hardis",
7774
- "hardis:monitor:limits:org",
7775
- "monitor:hardis:limits:org",
7776
- "monitor:limits:hardis:org",
7777
- "monitor:limits:org:hardis",
7778
- "hardis:org:limits:monitor",
7779
- "org:hardis:limits:monitor",
7780
- "org:limits:hardis:monitor",
7781
- "org:limits:monitor:hardis",
7782
- "hardis:limits:org:monitor",
7783
- "limits:hardis:org:monitor",
7784
- "limits:org:hardis:monitor",
7785
- "limits:org:monitor:hardis",
7786
- "hardis:limits:monitor:org",
7787
- "limits:hardis:monitor:org",
7788
- "limits:monitor:hardis:org",
7789
- "limits:monitor:org:hardis"
7790
- ]
7791
- },
7792
- "hardis:org:purge:apexlog": {
7793
- "aliases": [],
7794
- "args": {},
7795
- "description": "\n**Purges Apex debug logs from a Salesforce org.**\n\nThis command provides a quick and efficient way to clear out accumulated Apex debug logs from your Salesforce environment. This is particularly useful for:\n\n- **Storage Management:** Freeing up valuable data storage space in your Salesforce org.\n- **Performance Optimization:** Reducing the overhead associated with large volumes of debug logs.\n- **Troubleshooting:** Ensuring that new debug logs are generated cleanly without interference from old, irrelevant logs.\n\nKey functionalities:\n\n- **Log Identification:** Queries the `ApexLog` object to identify all existing debug logs.\n- **Confirmation Prompt:** Before deletion, it prompts for user confirmation, displaying the number of Apex logs that will be deleted.\n- **Bulk Deletion:** Uses the Salesforce Bulk API to efficiently delete a large number of Apex logs.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **SOQL Query:** It executes a SOQL query (`SELECT Id FROM ApexLog LIMIT 50000`) to retrieve the IDs of Apex logs to be deleted. The limit is set to 50,000 to handle large volumes of logs.\n- **CSV Export:** The retrieved log IDs are temporarily exported to a CSV file (`ApexLogsToDelete_*.csv`) in the `./tmp` directory.\n- **User Confirmation:** It uses the `prompts` library to ask for user confirmation before proceeding with the deletion, displaying the count of logs to be purged.\n- **Bulk API Deletion:** It then uses the Salesforce CLI's `sf data delete bulk` command, pointing to the generated CSV file, to perform the mass deletion of Apex logs.\n- **File System Operations:** It uses `fs-extra` to create the temporary directory and manage the CSV file.\n- **Error Handling:** Includes error handling for the query and deletion operations.\n</details>\n",
7796
- "examples": [
7797
- "$ sf hardis:org:purge:apexlog",
7798
- "$ sf hardis:org:purge:apexlog --target-org nicolas.vuillamy@gmail.com"
7799
- ],
7800
- "flags": {
7801
- "json": {
7802
- "description": "Format output as json.",
7803
- "helpGroup": "GLOBAL",
7804
- "name": "json",
7805
- "allowNo": false,
7806
- "type": "boolean"
7807
- },
7808
- "flags-dir": {
7809
- "helpGroup": "GLOBAL",
7810
- "name": "flags-dir",
7811
- "summary": "Import flag values from a directory.",
7812
- "hasDynamicHelp": false,
7813
- "multiple": false,
7814
- "type": "option"
7815
- },
7816
- "prompt": {
7817
- "char": "z",
7818
- "description": "Prompt for confirmation (true by default, use --no-prompt to skip)",
7819
- "name": "prompt",
7820
- "allowNo": true,
7821
- "type": "boolean"
7822
- },
7823
- "debug": {
7824
- "char": "d",
7825
- "description": "Activate debug mode (more logs)",
7826
- "name": "debug",
7827
- "allowNo": false,
7828
- "type": "boolean"
7829
- },
7830
- "websocket": {
7831
- "description": "Websocket host:port for VsCode SFDX Hardis UI integration",
7832
- "name": "websocket",
7833
- "hasDynamicHelp": false,
7834
- "multiple": false,
7835
- "type": "option"
7836
- },
7837
- "skipauth": {
7838
- "description": "Skip authentication check when a default username is required",
7839
- "name": "skipauth",
7840
- "allowNo": false,
7841
- "type": "boolean"
7842
- },
7843
- "target-org": {
7844
- "aliases": [
7845
- "targetusername",
7846
- "u"
7847
- ],
7848
- "char": "o",
7849
- "deprecateAliases": true,
7850
- "name": "target-org",
7851
- "noCacheDefault": true,
7852
- "required": true,
7853
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
7854
- "hasDynamicHelp": true,
7855
- "multiple": false,
7856
- "type": "option"
7857
- }
7858
- },
7859
- "hasDynamicHelp": true,
7860
- "hiddenAliases": [],
7861
- "id": "hardis:org:purge:apexlog",
7862
- "pluginAlias": "sfdx-hardis",
7863
- "pluginName": "sfdx-hardis",
7864
- "pluginType": "core",
7865
- "strict": true,
7866
- "enableJsonFlag": true,
7867
- "title": "Purge Apex Logs",
7868
- "requiresProject": false,
7869
- "isESM": true,
7870
- "relativePath": [
7871
- "lib",
7872
- "commands",
7873
- "hardis",
7874
- "org",
7875
- "purge",
7876
- "apexlog.js"
7877
- ],
7878
- "aliasPermutations": [],
7879
- "permutations": [
7880
- "hardis:org:purge:apexlog",
7881
- "org:hardis:purge:apexlog",
7882
- "org:purge:hardis:apexlog",
7883
- "org:purge:apexlog:hardis",
7884
- "hardis:purge:org:apexlog",
7885
- "purge:hardis:org:apexlog",
7886
- "purge:org:hardis:apexlog",
7887
- "purge:org:apexlog:hardis",
7888
- "hardis:purge:apexlog:org",
7889
- "purge:hardis:apexlog:org",
7890
- "purge:apexlog:hardis:org",
7891
- "purge:apexlog:org:hardis",
7892
- "hardis:org:apexlog:purge",
7893
- "org:hardis:apexlog:purge",
7894
- "org:apexlog:hardis:purge",
7895
- "org:apexlog:purge:hardis",
7896
- "hardis:apexlog:org:purge",
7897
- "apexlog:hardis:org:purge",
7898
- "apexlog:org:hardis:purge",
7899
- "apexlog:org:purge:hardis",
7900
- "hardis:apexlog:purge:org",
7901
- "apexlog:hardis:purge:org",
7902
- "apexlog:purge:hardis:org",
7903
- "apexlog:purge:org:hardis"
7904
- ]
7905
- },
7906
- "hardis:org:purge:flow": {
7907
- "aliases": [],
7908
- "args": {},
7909
- "description": "\n**Purges old or unwanted Flow versions from a Salesforce org, with an option to delete related Flow Interviews.**\n\nThis command helps maintain a clean and performant Salesforce org by removing obsolete Flow versions. Over time, multiple versions of Flows can accumulate, consuming storage and potentially impacting performance. This tool provides a controlled way to clean up these versions.\n\nKey functionalities:\n\n- **Targeted Flow Selection:** Allows you to filter Flow versions to delete by name (`--name`) and status (`--status`, e.g., `Obsolete`, `Draft`, `Inactive`).\n- **Flow Interview Deletion:** If a Flow version cannot be deleted due to active Flow Interviews, the `--delete-flow-interviews` flag (or interactive prompt) allows you to delete these interviews first, then retry the Flow version deletion.\n- **Confirmation Prompt:** In interactive mode, it prompts for confirmation before proceeding with the deletion of Flow versions and Flow Interviews.\n- **Partial Success Handling:** The `--allowpurgefailure` flag (default `true`) allows the command to continue even if some deletions fail, reporting the errors.\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 `Flow` object (using the Tooling API) to list Flow versions based on the provided filters (name, status, manageable state).\n- **Bulk Deletion (Tooling API):** It uses `bulkDeleteTooling` to perform mass deletions of Flow versions. If deletion fails due to active interviews, it extracts the interview IDs.\n- **Flow Interview Management:** If `delete-flow-interviews` is enabled, it queries `FlowInterview` objects, performs bulk deletion of the identified interviews using `bulkDelete`, and then retries the Flow version deletion.\n- **Interactive Prompts:** Uses the `prompts` library to interact with the user for selecting Flows, statuses, and confirming deletion actions.\n- **Error Reporting:** Logs detailed error messages for failed deletions, including the specific reasons.\n- **Command-Line Execution:** Uses `execSfdxJson` to execute Salesforce CLI commands for querying Flow data.\n</details>\n",
7910
- "examples": [
7911
- "$ sf hardis:org:purge:flow",
7912
- "$ sf hardis:org:purge:flow --target-org nicolas.vuillamy@gmail.com --no-prompt --delete-flow-interviews",
7913
- "$ sf hardis:org:purge:flow --target-org nicolas.vuillamy@gmail.com --status \"Obsolete,Draft,InvalidDraft\" --name TestFlow"
7914
- ],
7915
- "flags": {
7916
- "json": {
7917
- "description": "Format output as json.",
7918
- "helpGroup": "GLOBAL",
7919
- "name": "json",
7920
- "allowNo": false,
7921
- "type": "boolean"
7922
- },
7923
- "flags-dir": {
7924
- "helpGroup": "GLOBAL",
7925
- "name": "flags-dir",
7926
- "summary": "Import flag values from a directory.",
7927
- "hasDynamicHelp": false,
7928
- "multiple": false,
7929
- "type": "option"
7930
- },
7931
- "prompt": {
7932
- "char": "z",
7933
- "description": "Prompt for confirmation (true by default, use --no-prompt to skip)",
7934
- "name": "prompt",
7935
- "allowNo": true,
7936
- "type": "boolean"
7937
- },
7938
- "name": {
7939
- "char": "n",
7940
- "description": "Filter according to Name criteria",
7941
- "name": "name",
7942
- "hasDynamicHelp": false,
7943
- "multiple": false,
7944
- "type": "option"
7945
- },
7946
- "status": {
7947
- "char": "s",
7948
- "description": "Filter according to Status criteria",
7949
- "name": "status",
7692
+ "flags-dir": {
7693
+ "helpGroup": "GLOBAL",
7694
+ "name": "flags-dir",
7695
+ "summary": "Import flag values from a directory.",
7950
7696
  "hasDynamicHelp": false,
7951
7697
  "multiple": false,
7952
7698
  "type": "option"
7953
7699
  },
7954
- "delete-flow-interviews": {
7955
- "char": "w",
7956
- "description": "If the presence of Flow interviews prevent to delete flows versions, delete them before retrying to delete flow versions",
7957
- "name": "delete-flow-interviews",
7958
- "allowNo": false,
7959
- "type": "boolean"
7960
- },
7961
- "allowpurgefailure": {
7700
+ "outputfile": {
7962
7701
  "char": "f",
7963
- "description": "Allows purges to fail without exiting with 1. Use --no-allowpurgefailure to disable",
7964
- "name": "allowpurgefailure",
7965
- "allowNo": true,
7966
- "type": "boolean"
7967
- },
7968
- "instanceurl": {
7969
- "char": "r",
7970
- "description": "URL of org instance",
7971
- "name": "instanceurl",
7972
- "default": "https://login.salesforce.com",
7702
+ "description": "Force the path and name of output report file. Must end with .csv",
7703
+ "name": "outputfile",
7973
7704
  "hasDynamicHelp": false,
7974
7705
  "multiple": false,
7975
7706
  "type": "option"
@@ -8012,49 +7743,50 @@
8012
7743
  },
8013
7744
  "hasDynamicHelp": true,
8014
7745
  "hiddenAliases": [],
8015
- "id": "hardis:org:purge:flow",
7746
+ "id": "hardis:org:monitor:limits",
8016
7747
  "pluginAlias": "sfdx-hardis",
8017
7748
  "pluginName": "sfdx-hardis",
8018
7749
  "pluginType": "core",
8019
7750
  "strict": true,
8020
7751
  "enableJsonFlag": true,
8021
- "title": "Purge Flow versions",
8022
- "requiresProject": false,
7752
+ "title": "Check org limits",
7753
+ "requiresProject": true,
7754
+ "triggerNotification": true,
8023
7755
  "isESM": true,
8024
7756
  "relativePath": [
8025
7757
  "lib",
8026
7758
  "commands",
8027
7759
  "hardis",
8028
7760
  "org",
8029
- "purge",
8030
- "flow.js"
7761
+ "monitor",
7762
+ "limits.js"
8031
7763
  ],
8032
7764
  "aliasPermutations": [],
8033
7765
  "permutations": [
8034
- "hardis:org:purge:flow",
8035
- "org:hardis:purge:flow",
8036
- "org:purge:hardis:flow",
8037
- "org:purge:flow:hardis",
8038
- "hardis:purge:org:flow",
8039
- "purge:hardis:org:flow",
8040
- "purge:org:hardis:flow",
8041
- "purge:org:flow:hardis",
8042
- "hardis:purge:flow:org",
8043
- "purge:hardis:flow:org",
8044
- "purge:flow:hardis:org",
8045
- "purge:flow:org:hardis",
8046
- "hardis:org:flow:purge",
8047
- "org:hardis:flow:purge",
8048
- "org:flow:hardis:purge",
8049
- "org:flow:purge:hardis",
8050
- "hardis:flow:org:purge",
8051
- "flow:hardis:org:purge",
8052
- "flow:org:hardis:purge",
8053
- "flow:org:purge:hardis",
8054
- "hardis:flow:purge:org",
8055
- "flow:hardis:purge:org",
8056
- "flow:purge:hardis:org",
8057
- "flow:purge:org:hardis"
7766
+ "hardis:org:monitor:limits",
7767
+ "org:hardis:monitor:limits",
7768
+ "org:monitor:hardis:limits",
7769
+ "org:monitor:limits:hardis",
7770
+ "hardis:monitor:org:limits",
7771
+ "monitor:hardis:org:limits",
7772
+ "monitor:org:hardis:limits",
7773
+ "monitor:org:limits:hardis",
7774
+ "hardis:monitor:limits:org",
7775
+ "monitor:hardis:limits:org",
7776
+ "monitor:limits:hardis:org",
7777
+ "monitor:limits:org:hardis",
7778
+ "hardis:org:limits:monitor",
7779
+ "org:hardis:limits:monitor",
7780
+ "org:limits:hardis:monitor",
7781
+ "org:limits:monitor:hardis",
7782
+ "hardis:limits:org:monitor",
7783
+ "limits:hardis:org:monitor",
7784
+ "limits:org:hardis:monitor",
7785
+ "limits:org:monitor:hardis",
7786
+ "hardis:limits:monitor:org",
7787
+ "limits:hardis:monitor:org",
7788
+ "limits:monitor:hardis:org",
7789
+ "limits:monitor:org:hardis"
8058
7790
  ]
8059
7791
  },
8060
7792
  "hardis:org:refresh:after-refresh": {
@@ -8296,13 +8028,128 @@
8296
8028
  "before-refresh:refresh:org:hardis"
8297
8029
  ]
8298
8030
  },
8299
- "hardis:org:retrieve:packageconfig": {
8031
+ "hardis:org:purge:apexlog": {
8300
8032
  "aliases": [],
8301
8033
  "args": {},
8302
- "description": "\n**Retrieves the installed package configuration from a Salesforce org and optionally updates the local project configuration.**\n\nThis command is useful for maintaining an accurate record of installed packages within your Salesforce project, which is crucial for managing dependencies and ensuring consistent deployments across environments.\n\nKey functionalities:\n\n- **Package Listing:** Connects to a specified Salesforce org (or prompts for one if not provided) and retrieves a list of all installed packages.\n- **Configuration Update:** Offers the option to update your local project's configuration with the retrieved list of installed packages. This can be beneficial for automating package installations during environment setup or CI/CD processes.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **Org Connection:** It establishes a connection to the target Salesforce org using the provided or prompted username.\n- **Metadata Retrieval:** It utilizes `MetadataUtils.listInstalledPackages` to query the Salesforce org and obtain details about the installed packages.\n- **Interactive Prompt:** It uses the `prompts` library to ask the user whether they want to update their local project configuration with the retrieved package list.\n- **Configuration Management:** If the user confirms, it calls `managePackageConfig` to update the project's configuration file (likely `.sfdx-hardis.yml`) with the new package information.\n- **User Feedback:** Provides clear messages to the user about the success of the package retrieval and configuration update.\n</details>\n",
8034
+ "description": "\n**Purges Apex debug logs from a Salesforce org.**\n\nThis command provides a quick and efficient way to clear out accumulated Apex debug logs from your Salesforce environment. This is particularly useful for:\n\n- **Storage Management:** Freeing up valuable data storage space in your Salesforce org.\n- **Performance Optimization:** Reducing the overhead associated with large volumes of debug logs.\n- **Troubleshooting:** Ensuring that new debug logs are generated cleanly without interference from old, irrelevant logs.\n\nKey functionalities:\n\n- **Log Identification:** Queries the `ApexLog` object to identify all existing debug logs.\n- **Confirmation Prompt:** Before deletion, it prompts for user confirmation, displaying the number of Apex logs that will be deleted.\n- **Bulk Deletion:** Uses the Salesforce Bulk API to efficiently delete a large number of Apex logs.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **SOQL Query:** It executes a SOQL query (`SELECT Id FROM ApexLog LIMIT 50000`) to retrieve the IDs of Apex logs to be deleted. The limit is set to 50,000 to handle large volumes of logs.\n- **CSV Export:** The retrieved log IDs are temporarily exported to a CSV file (`ApexLogsToDelete_*.csv`) in the `./tmp` directory.\n- **User Confirmation:** It uses the `prompts` library to ask for user confirmation before proceeding with the deletion, displaying the count of logs to be purged.\n- **Bulk API Deletion:** It then uses the Salesforce CLI's `sf data delete bulk` command, pointing to the generated CSV file, to perform the mass deletion of Apex logs.\n- **File System Operations:** It uses `fs-extra` to create the temporary directory and manage the CSV file.\n- **Error Handling:** Includes error handling for the query and deletion operations.\n</details>\n",
8303
8035
  "examples": [
8304
- "$ sf hardis:org:retrieve:packageconfig",
8305
- "sf hardis:org:retrieve:packageconfig -u myOrg"
8036
+ "$ sf hardis:org:purge:apexlog",
8037
+ "$ sf hardis:org:purge:apexlog --target-org nicolas.vuillamy@gmail.com"
8038
+ ],
8039
+ "flags": {
8040
+ "json": {
8041
+ "description": "Format output as json.",
8042
+ "helpGroup": "GLOBAL",
8043
+ "name": "json",
8044
+ "allowNo": false,
8045
+ "type": "boolean"
8046
+ },
8047
+ "flags-dir": {
8048
+ "helpGroup": "GLOBAL",
8049
+ "name": "flags-dir",
8050
+ "summary": "Import flag values from a directory.",
8051
+ "hasDynamicHelp": false,
8052
+ "multiple": false,
8053
+ "type": "option"
8054
+ },
8055
+ "prompt": {
8056
+ "char": "z",
8057
+ "description": "Prompt for confirmation (true by default, use --no-prompt to skip)",
8058
+ "name": "prompt",
8059
+ "allowNo": true,
8060
+ "type": "boolean"
8061
+ },
8062
+ "debug": {
8063
+ "char": "d",
8064
+ "description": "Activate debug mode (more logs)",
8065
+ "name": "debug",
8066
+ "allowNo": false,
8067
+ "type": "boolean"
8068
+ },
8069
+ "websocket": {
8070
+ "description": "Websocket host:port for VsCode SFDX Hardis UI integration",
8071
+ "name": "websocket",
8072
+ "hasDynamicHelp": false,
8073
+ "multiple": false,
8074
+ "type": "option"
8075
+ },
8076
+ "skipauth": {
8077
+ "description": "Skip authentication check when a default username is required",
8078
+ "name": "skipauth",
8079
+ "allowNo": false,
8080
+ "type": "boolean"
8081
+ },
8082
+ "target-org": {
8083
+ "aliases": [
8084
+ "targetusername",
8085
+ "u"
8086
+ ],
8087
+ "char": "o",
8088
+ "deprecateAliases": true,
8089
+ "name": "target-org",
8090
+ "noCacheDefault": true,
8091
+ "required": true,
8092
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
8093
+ "hasDynamicHelp": true,
8094
+ "multiple": false,
8095
+ "type": "option"
8096
+ }
8097
+ },
8098
+ "hasDynamicHelp": true,
8099
+ "hiddenAliases": [],
8100
+ "id": "hardis:org:purge:apexlog",
8101
+ "pluginAlias": "sfdx-hardis",
8102
+ "pluginName": "sfdx-hardis",
8103
+ "pluginType": "core",
8104
+ "strict": true,
8105
+ "enableJsonFlag": true,
8106
+ "title": "Purge Apex Logs",
8107
+ "requiresProject": false,
8108
+ "isESM": true,
8109
+ "relativePath": [
8110
+ "lib",
8111
+ "commands",
8112
+ "hardis",
8113
+ "org",
8114
+ "purge",
8115
+ "apexlog.js"
8116
+ ],
8117
+ "aliasPermutations": [],
8118
+ "permutations": [
8119
+ "hardis:org:purge:apexlog",
8120
+ "org:hardis:purge:apexlog",
8121
+ "org:purge:hardis:apexlog",
8122
+ "org:purge:apexlog:hardis",
8123
+ "hardis:purge:org:apexlog",
8124
+ "purge:hardis:org:apexlog",
8125
+ "purge:org:hardis:apexlog",
8126
+ "purge:org:apexlog:hardis",
8127
+ "hardis:purge:apexlog:org",
8128
+ "purge:hardis:apexlog:org",
8129
+ "purge:apexlog:hardis:org",
8130
+ "purge:apexlog:org:hardis",
8131
+ "hardis:org:apexlog:purge",
8132
+ "org:hardis:apexlog:purge",
8133
+ "org:apexlog:hardis:purge",
8134
+ "org:apexlog:purge:hardis",
8135
+ "hardis:apexlog:org:purge",
8136
+ "apexlog:hardis:org:purge",
8137
+ "apexlog:org:hardis:purge",
8138
+ "apexlog:org:purge:hardis",
8139
+ "hardis:apexlog:purge:org",
8140
+ "apexlog:hardis:purge:org",
8141
+ "apexlog:purge:hardis:org",
8142
+ "apexlog:purge:org:hardis"
8143
+ ]
8144
+ },
8145
+ "hardis:org:purge:flow": {
8146
+ "aliases": [],
8147
+ "args": {},
8148
+ "description": "\n**Purges old or unwanted Flow versions from a Salesforce org, with an option to delete related Flow Interviews.**\n\nThis command helps maintain a clean and performant Salesforce org by removing obsolete Flow versions. Over time, multiple versions of Flows can accumulate, consuming storage and potentially impacting performance. This tool provides a controlled way to clean up these versions.\n\nKey functionalities:\n\n- **Targeted Flow Selection:** Allows you to filter Flow versions to delete by name (`--name`) and status (`--status`, e.g., `Obsolete`, `Draft`, `Inactive`).\n- **Flow Interview Deletion:** If a Flow version cannot be deleted due to active Flow Interviews, the `--delete-flow-interviews` flag (or interactive prompt) allows you to delete these interviews first, then retry the Flow version deletion.\n- **Confirmation Prompt:** In interactive mode, it prompts for confirmation before proceeding with the deletion of Flow versions and Flow Interviews.\n- **Partial Success Handling:** The `--allowpurgefailure` flag (default `true`) allows the command to continue even if some deletions fail, reporting the errors.\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 `Flow` object (using the Tooling API) to list Flow versions based on the provided filters (name, status, manageable state).\n- **Bulk Deletion (Tooling API):** It uses `bulkDeleteTooling` to perform mass deletions of Flow versions. If deletion fails due to active interviews, it extracts the interview IDs.\n- **Flow Interview Management:** If `delete-flow-interviews` is enabled, it queries `FlowInterview` objects, performs bulk deletion of the identified interviews using `bulkDelete`, and then retries the Flow version deletion.\n- **Interactive Prompts:** Uses the `prompts` library to interact with the user for selecting Flows, statuses, and confirming deletion actions.\n- **Error Reporting:** Logs detailed error messages for failed deletions, including the specific reasons.\n- **Command-Line Execution:** Uses `execSfdxJson` to execute Salesforce CLI commands for querying Flow data.\n</details>\n",
8149
+ "examples": [
8150
+ "$ sf hardis:org:purge:flow",
8151
+ "$ sf hardis:org:purge:flow --target-org nicolas.vuillamy@gmail.com --no-prompt --delete-flow-interviews",
8152
+ "$ sf hardis:org:purge:flow --target-org nicolas.vuillamy@gmail.com --status \"Obsolete,Draft,InvalidDraft\" --name TestFlow"
8306
8153
  ],
8307
8154
  "flags": {
8308
8155
  "json": {
@@ -8320,6 +8167,52 @@
8320
8167
  "multiple": false,
8321
8168
  "type": "option"
8322
8169
  },
8170
+ "prompt": {
8171
+ "char": "z",
8172
+ "description": "Prompt for confirmation (true by default, use --no-prompt to skip)",
8173
+ "name": "prompt",
8174
+ "allowNo": true,
8175
+ "type": "boolean"
8176
+ },
8177
+ "name": {
8178
+ "char": "n",
8179
+ "description": "Filter according to Name criteria",
8180
+ "name": "name",
8181
+ "hasDynamicHelp": false,
8182
+ "multiple": false,
8183
+ "type": "option"
8184
+ },
8185
+ "status": {
8186
+ "char": "s",
8187
+ "description": "Filter according to Status criteria",
8188
+ "name": "status",
8189
+ "hasDynamicHelp": false,
8190
+ "multiple": false,
8191
+ "type": "option"
8192
+ },
8193
+ "delete-flow-interviews": {
8194
+ "char": "w",
8195
+ "description": "If the presence of Flow interviews prevent to delete flows versions, delete them before retrying to delete flow versions",
8196
+ "name": "delete-flow-interviews",
8197
+ "allowNo": false,
8198
+ "type": "boolean"
8199
+ },
8200
+ "allowpurgefailure": {
8201
+ "char": "f",
8202
+ "description": "Allows purges to fail without exiting with 1. Use --no-allowpurgefailure to disable",
8203
+ "name": "allowpurgefailure",
8204
+ "allowNo": true,
8205
+ "type": "boolean"
8206
+ },
8207
+ "instanceurl": {
8208
+ "char": "r",
8209
+ "description": "URL of org instance",
8210
+ "name": "instanceurl",
8211
+ "default": "https://login.salesforce.com",
8212
+ "hasDynamicHelp": false,
8213
+ "multiple": false,
8214
+ "type": "option"
8215
+ },
8323
8216
  "debug": {
8324
8217
  "char": "d",
8325
8218
  "description": "Activate debug mode (more logs)",
@@ -8358,13 +8251,13 @@
8358
8251
  },
8359
8252
  "hasDynamicHelp": true,
8360
8253
  "hiddenAliases": [],
8361
- "id": "hardis:org:retrieve:packageconfig",
8254
+ "id": "hardis:org:purge:flow",
8362
8255
  "pluginAlias": "sfdx-hardis",
8363
8256
  "pluginName": "sfdx-hardis",
8364
8257
  "pluginType": "core",
8365
8258
  "strict": true,
8366
8259
  "enableJsonFlag": true,
8367
- "title": "Retrieve package configuration from an org",
8260
+ "title": "Purge Flow versions",
8368
8261
  "requiresProject": false,
8369
8262
  "isESM": true,
8370
8263
  "relativePath": [
@@ -8372,43 +8265,44 @@
8372
8265
  "commands",
8373
8266
  "hardis",
8374
8267
  "org",
8375
- "retrieve",
8376
- "packageconfig.js"
8268
+ "purge",
8269
+ "flow.js"
8377
8270
  ],
8378
8271
  "aliasPermutations": [],
8379
8272
  "permutations": [
8380
- "hardis:org:retrieve:packageconfig",
8381
- "org:hardis:retrieve:packageconfig",
8382
- "org:retrieve:hardis:packageconfig",
8383
- "org:retrieve:packageconfig:hardis",
8384
- "hardis:retrieve:org:packageconfig",
8385
- "retrieve:hardis:org:packageconfig",
8386
- "retrieve:org:hardis:packageconfig",
8387
- "retrieve:org:packageconfig:hardis",
8388
- "hardis:retrieve:packageconfig:org",
8389
- "retrieve:hardis:packageconfig:org",
8390
- "retrieve:packageconfig:hardis:org",
8391
- "retrieve:packageconfig:org:hardis",
8392
- "hardis:org:packageconfig:retrieve",
8393
- "org:hardis:packageconfig:retrieve",
8394
- "org:packageconfig:hardis:retrieve",
8395
- "org:packageconfig:retrieve:hardis",
8396
- "hardis:packageconfig:org:retrieve",
8397
- "packageconfig:hardis:org:retrieve",
8398
- "packageconfig:org:hardis:retrieve",
8399
- "packageconfig:org:retrieve:hardis",
8400
- "hardis:packageconfig:retrieve:org",
8401
- "packageconfig:hardis:retrieve:org",
8402
- "packageconfig:retrieve:hardis:org",
8403
- "packageconfig:retrieve:org:hardis"
8273
+ "hardis:org:purge:flow",
8274
+ "org:hardis:purge:flow",
8275
+ "org:purge:hardis:flow",
8276
+ "org:purge:flow:hardis",
8277
+ "hardis:purge:org:flow",
8278
+ "purge:hardis:org:flow",
8279
+ "purge:org:hardis:flow",
8280
+ "purge:org:flow:hardis",
8281
+ "hardis:purge:flow:org",
8282
+ "purge:hardis:flow:org",
8283
+ "purge:flow:hardis:org",
8284
+ "purge:flow:org:hardis",
8285
+ "hardis:org:flow:purge",
8286
+ "org:hardis:flow:purge",
8287
+ "org:flow:hardis:purge",
8288
+ "org:flow:purge:hardis",
8289
+ "hardis:flow:org:purge",
8290
+ "flow:hardis:org:purge",
8291
+ "flow:org:hardis:purge",
8292
+ "flow:org:purge:hardis",
8293
+ "hardis:flow:purge:org",
8294
+ "flow:hardis:purge:org",
8295
+ "flow:purge:hardis:org",
8296
+ "flow:purge:org:hardis"
8404
8297
  ]
8405
8298
  },
8406
- "hardis:org:test:apex": {
8299
+ "hardis:org:retrieve:packageconfig": {
8407
8300
  "aliases": [],
8408
8301
  "args": {},
8409
- "description": "Run apex tests in Salesforce org\n\nIf following configuration is defined, it will fail if apex coverage target is not reached:\n\n- Env `APEX_TESTS_MIN_COVERAGE_ORG_WIDE` or `.sfdx-hardis` property `apexTestsMinCoverageOrgWide`\n- Env `APEX_TESTS_MIN_COVERAGE_ORG_WIDE` or `.sfdx-hardis` property `apexTestsMinCoverageOrgWide`\n\nYou can override env var SFDX_TEST_WAIT_MINUTES to wait more than 120 minutes.\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-apex-tests/) and can output Grafana, Slack and MsTeams Notifications.\n",
8302
+ "description": "\n**Retrieves the installed package configuration from a Salesforce org and optionally updates the local project configuration.**\n\nThis command is useful for maintaining an accurate record of installed packages within your Salesforce project, which is crucial for managing dependencies and ensuring consistent deployments across environments.\n\nKey functionalities:\n\n- **Package Listing:** Connects to a specified Salesforce org (or prompts for one if not provided) and retrieves a list of all installed packages.\n- **Configuration Update:** Offers the option to update your local project's configuration with the retrieved list of installed packages. This can be beneficial for automating package installations during environment setup or CI/CD processes.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **Org Connection:** It establishes a connection to the target Salesforce org using the provided or prompted username.\n- **Metadata Retrieval:** It utilizes `MetadataUtils.listInstalledPackages` to query the Salesforce org and obtain details about the installed packages.\n- **Interactive Prompt:** It uses the `prompts` library to ask the user whether they want to update their local project configuration with the retrieved package list.\n- **Configuration Management:** If the user confirms, it calls `managePackageConfig` to update the project's configuration file (likely `.sfdx-hardis.yml`) with the new package information.\n- **User Feedback:** Provides clear messages to the user about the success of the package retrieval and configuration update.\n</details>\n",
8410
8303
  "examples": [
8411
- "$ sf hardis:org:test:apex"
8304
+ "$ sf hardis:org:retrieve:packageconfig",
8305
+ "sf hardis:org:retrieve:packageconfig -u myOrg"
8412
8306
  ],
8413
8307
  "flags": {
8414
8308
  "json": {
@@ -8426,21 +8320,6 @@
8426
8320
  "multiple": false,
8427
8321
  "type": "option"
8428
8322
  },
8429
- "testlevel": {
8430
- "char": "l",
8431
- "description": "Level of tests to apply to validate deployment",
8432
- "name": "testlevel",
8433
- "default": "RunLocalTests",
8434
- "hasDynamicHelp": false,
8435
- "multiple": false,
8436
- "options": [
8437
- "NoTestRun",
8438
- "RunSpecifiedTests",
8439
- "RunLocalTests",
8440
- "RunAllTestsInOrg"
8441
- ],
8442
- "type": "option"
8443
- },
8444
8323
  "debug": {
8445
8324
  "char": "d",
8446
8325
  "description": "Activate debug mode (more logs)",
@@ -8479,48 +8358,49 @@
8479
8358
  },
8480
8359
  "hasDynamicHelp": true,
8481
8360
  "hiddenAliases": [],
8482
- "id": "hardis:org:test:apex",
8361
+ "id": "hardis:org:retrieve:packageconfig",
8483
8362
  "pluginAlias": "sfdx-hardis",
8484
8363
  "pluginName": "sfdx-hardis",
8485
8364
  "pluginType": "core",
8486
8365
  "strict": true,
8487
8366
  "enableJsonFlag": true,
8488
- "title": "Run apex tests",
8367
+ "title": "Retrieve package configuration from an org",
8368
+ "requiresProject": false,
8489
8369
  "isESM": true,
8490
8370
  "relativePath": [
8491
8371
  "lib",
8492
8372
  "commands",
8493
8373
  "hardis",
8494
8374
  "org",
8495
- "test",
8496
- "apex.js"
8375
+ "retrieve",
8376
+ "packageconfig.js"
8497
8377
  ],
8498
8378
  "aliasPermutations": [],
8499
8379
  "permutations": [
8500
- "hardis:org:test:apex",
8501
- "org:hardis:test:apex",
8502
- "org:test:hardis:apex",
8503
- "org:test:apex:hardis",
8504
- "hardis:test:org:apex",
8505
- "test:hardis:org:apex",
8506
- "test:org:hardis:apex",
8507
- "test:org:apex:hardis",
8508
- "hardis:test:apex:org",
8509
- "test:hardis:apex:org",
8510
- "test:apex:hardis:org",
8511
- "test:apex:org:hardis",
8512
- "hardis:org:apex:test",
8513
- "org:hardis:apex:test",
8514
- "org:apex:hardis:test",
8515
- "org:apex:test:hardis",
8516
- "hardis:apex:org:test",
8517
- "apex:hardis:org:test",
8518
- "apex:org:hardis:test",
8519
- "apex:org:test:hardis",
8520
- "hardis:apex:test:org",
8521
- "apex:hardis:test:org",
8522
- "apex:test:hardis:org",
8523
- "apex:test:org:hardis"
8380
+ "hardis:org:retrieve:packageconfig",
8381
+ "org:hardis:retrieve:packageconfig",
8382
+ "org:retrieve:hardis:packageconfig",
8383
+ "org:retrieve:packageconfig:hardis",
8384
+ "hardis:retrieve:org:packageconfig",
8385
+ "retrieve:hardis:org:packageconfig",
8386
+ "retrieve:org:hardis:packageconfig",
8387
+ "retrieve:org:packageconfig:hardis",
8388
+ "hardis:retrieve:packageconfig:org",
8389
+ "retrieve:hardis:packageconfig:org",
8390
+ "retrieve:packageconfig:hardis:org",
8391
+ "retrieve:packageconfig:org:hardis",
8392
+ "hardis:org:packageconfig:retrieve",
8393
+ "org:hardis:packageconfig:retrieve",
8394
+ "org:packageconfig:hardis:retrieve",
8395
+ "org:packageconfig:retrieve:hardis",
8396
+ "hardis:packageconfig:org:retrieve",
8397
+ "packageconfig:hardis:org:retrieve",
8398
+ "packageconfig:org:hardis:retrieve",
8399
+ "packageconfig:org:retrieve:hardis",
8400
+ "hardis:packageconfig:retrieve:org",
8401
+ "packageconfig:hardis:retrieve:org",
8402
+ "packageconfig:retrieve:hardis:org",
8403
+ "packageconfig:retrieve:org:hardis"
8524
8404
  ]
8525
8405
  },
8526
8406
  "hardis:org:user:activateinvalid": {
@@ -8923,6 +8803,126 @@
8923
8803
  "unfreeze:user:org:hardis"
8924
8804
  ]
8925
8805
  },
8806
+ "hardis:org:test:apex": {
8807
+ "aliases": [],
8808
+ "args": {},
8809
+ "description": "Run apex tests in Salesforce org\n\nIf following configuration is defined, it will fail if apex coverage target is not reached:\n\n- Env `APEX_TESTS_MIN_COVERAGE_ORG_WIDE` or `.sfdx-hardis` property `apexTestsMinCoverageOrgWide`\n- Env `APEX_TESTS_MIN_COVERAGE_ORG_WIDE` or `.sfdx-hardis` property `apexTestsMinCoverageOrgWide`\n\nYou can override env var SFDX_TEST_WAIT_MINUTES to wait more than 120 minutes.\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-apex-tests/) and can output Grafana, Slack and MsTeams Notifications.\n",
8810
+ "examples": [
8811
+ "$ sf hardis:org:test:apex"
8812
+ ],
8813
+ "flags": {
8814
+ "json": {
8815
+ "description": "Format output as json.",
8816
+ "helpGroup": "GLOBAL",
8817
+ "name": "json",
8818
+ "allowNo": false,
8819
+ "type": "boolean"
8820
+ },
8821
+ "flags-dir": {
8822
+ "helpGroup": "GLOBAL",
8823
+ "name": "flags-dir",
8824
+ "summary": "Import flag values from a directory.",
8825
+ "hasDynamicHelp": false,
8826
+ "multiple": false,
8827
+ "type": "option"
8828
+ },
8829
+ "testlevel": {
8830
+ "char": "l",
8831
+ "description": "Level of tests to apply to validate deployment",
8832
+ "name": "testlevel",
8833
+ "default": "RunLocalTests",
8834
+ "hasDynamicHelp": false,
8835
+ "multiple": false,
8836
+ "options": [
8837
+ "NoTestRun",
8838
+ "RunSpecifiedTests",
8839
+ "RunLocalTests",
8840
+ "RunAllTestsInOrg"
8841
+ ],
8842
+ "type": "option"
8843
+ },
8844
+ "debug": {
8845
+ "char": "d",
8846
+ "description": "Activate debug mode (more logs)",
8847
+ "name": "debug",
8848
+ "allowNo": false,
8849
+ "type": "boolean"
8850
+ },
8851
+ "websocket": {
8852
+ "description": "Websocket host:port for VsCode SFDX Hardis UI integration",
8853
+ "name": "websocket",
8854
+ "hasDynamicHelp": false,
8855
+ "multiple": false,
8856
+ "type": "option"
8857
+ },
8858
+ "skipauth": {
8859
+ "description": "Skip authentication check when a default username is required",
8860
+ "name": "skipauth",
8861
+ "allowNo": false,
8862
+ "type": "boolean"
8863
+ },
8864
+ "target-org": {
8865
+ "aliases": [
8866
+ "targetusername",
8867
+ "u"
8868
+ ],
8869
+ "char": "o",
8870
+ "deprecateAliases": true,
8871
+ "name": "target-org",
8872
+ "noCacheDefault": true,
8873
+ "required": true,
8874
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
8875
+ "hasDynamicHelp": true,
8876
+ "multiple": false,
8877
+ "type": "option"
8878
+ }
8879
+ },
8880
+ "hasDynamicHelp": true,
8881
+ "hiddenAliases": [],
8882
+ "id": "hardis:org:test:apex",
8883
+ "pluginAlias": "sfdx-hardis",
8884
+ "pluginName": "sfdx-hardis",
8885
+ "pluginType": "core",
8886
+ "strict": true,
8887
+ "enableJsonFlag": true,
8888
+ "title": "Run apex tests",
8889
+ "isESM": true,
8890
+ "relativePath": [
8891
+ "lib",
8892
+ "commands",
8893
+ "hardis",
8894
+ "org",
8895
+ "test",
8896
+ "apex.js"
8897
+ ],
8898
+ "aliasPermutations": [],
8899
+ "permutations": [
8900
+ "hardis:org:test:apex",
8901
+ "org:hardis:test:apex",
8902
+ "org:test:hardis:apex",
8903
+ "org:test:apex:hardis",
8904
+ "hardis:test:org:apex",
8905
+ "test:hardis:org:apex",
8906
+ "test:org:hardis:apex",
8907
+ "test:org:apex:hardis",
8908
+ "hardis:test:apex:org",
8909
+ "test:hardis:apex:org",
8910
+ "test:apex:hardis:org",
8911
+ "test:apex:org:hardis",
8912
+ "hardis:org:apex:test",
8913
+ "org:hardis:apex:test",
8914
+ "org:apex:hardis:test",
8915
+ "org:apex:test:hardis",
8916
+ "hardis:apex:org:test",
8917
+ "apex:hardis:org:test",
8918
+ "apex:org:hardis:test",
8919
+ "apex:org:test:hardis",
8920
+ "hardis:apex:test:org",
8921
+ "apex:hardis:test:org",
8922
+ "apex:test:hardis:org",
8923
+ "apex:test:org:hardis"
8924
+ ]
8925
+ },
8926
8926
  "hardis:package:version:create": {
8927
8927
  "aliases": [],
8928
8928
  "args": {},
@@ -15370,5 +15370,5 @@
15370
15370
  ]
15371
15371
  }
15372
15372
  },
15373
- "version": "6.9.1-alpha202510270034.0"
15373
+ "version": "6.9.1-alpha202510282151.0"
15374
15374
  }