sfdx-hardis 6.7.2 → 6.7.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +10 -0
- package/lib/commands/hardis/cache/clear.js +2 -2
- package/lib/commands/hardis/cache/clear.js.map +1 -1
- package/lib/commands/hardis/doc/extract/permsetgroups.js +8 -8
- package/lib/commands/hardis/doc/extract/permsetgroups.js.map +1 -1
- package/lib/commands/hardis/doc/fieldusage.js +5 -5
- package/lib/commands/hardis/doc/fieldusage.js.map +1 -1
- package/lib/commands/hardis/doc/flow2markdown.js +3 -3
- package/lib/commands/hardis/doc/flow2markdown.js.map +1 -1
- package/lib/commands/hardis/doc/mkdocs-to-cf.js +10 -10
- package/lib/commands/hardis/doc/mkdocs-to-cf.js.map +1 -1
- package/lib/commands/hardis/doc/mkdocs-to-salesforce.js +16 -17
- package/lib/commands/hardis/doc/mkdocs-to-salesforce.js.map +1 -1
- package/lib/commands/hardis/doc/override-prompts.js +7 -7
- package/lib/commands/hardis/doc/override-prompts.js.map +1 -1
- package/lib/commands/hardis/doc/packagexml2markdown.js +1 -1
- package/lib/commands/hardis/doc/packagexml2markdown.js.map +1 -1
- package/lib/commands/hardis/doc/plugin/generate.js +3 -3
- package/lib/commands/hardis/doc/plugin/generate.js.map +1 -1
- package/lib/commands/hardis/doc/project2markdown.js +7 -7
- package/lib/commands/hardis/doc/project2markdown.js.map +1 -1
- package/lib/commands/hardis/git/pull-requests/extract.js +4 -4
- package/lib/commands/hardis/git/pull-requests/extract.js.map +1 -1
- package/lib/commands/hardis/lint/access.js +4 -4
- package/lib/commands/hardis/lint/access.js.map +1 -1
- package/lib/commands/hardis/lint/metadatastatus.js +2 -2
- package/lib/commands/hardis/lint/metadatastatus.js.map +1 -1
- package/lib/commands/hardis/lint/missingattributes.js +3 -3
- package/lib/commands/hardis/lint/missingattributes.js.map +1 -1
- package/lib/commands/hardis/lint/unusedmetadatas.js +2 -2
- package/lib/commands/hardis/lint/unusedmetadatas.js.map +1 -1
- package/lib/commands/hardis/mdapi/deploy.js +1 -1
- package/lib/commands/hardis/mdapi/deploy.js.map +1 -1
- package/lib/commands/hardis/misc/custom-label-translations.js +7 -7
- package/lib/commands/hardis/misc/custom-label-translations.js.map +1 -1
- package/lib/commands/hardis/misc/purge-references.js +5 -5
- package/lib/commands/hardis/misc/purge-references.js.map +1 -1
- package/lib/commands/hardis/misc/servicenow-report.js +2 -2
- package/lib/commands/hardis/misc/servicenow-report.js.map +1 -1
- package/lib/commands/hardis/misc/toml2csv.js +1 -1
- package/lib/commands/hardis/misc/toml2csv.js.map +1 -1
- package/lib/commands/hardis/org/community/update.js +4 -4
- package/lib/commands/hardis/org/community/update.js.map +1 -1
- package/lib/commands/hardis/org/configure/data.js +4 -4
- package/lib/commands/hardis/org/configure/data.js.map +1 -1
- package/lib/commands/hardis/org/configure/files.js +2 -2
- package/lib/commands/hardis/org/configure/files.js.map +1 -1
- package/lib/commands/hardis/org/configure/monitoring.js +5 -5
- package/lib/commands/hardis/org/configure/monitoring.js.map +1 -1
- package/lib/commands/hardis/org/connect.js +2 -2
- package/lib/commands/hardis/org/connect.js.map +1 -1
- package/lib/commands/hardis/org/create.js +1 -1
- package/lib/commands/hardis/org/create.js.map +1 -1
- package/lib/commands/hardis/org/diagnose/legacyapi.js +1 -1
- package/lib/commands/hardis/org/diagnose/legacyapi.js.map +1 -1
- package/lib/commands/hardis/org/diagnose/unused-apex-classes.js +2 -2
- package/lib/commands/hardis/org/diagnose/unusedlicenses.js +1 -1
- package/lib/commands/hardis/org/files/export.js +2 -2
- package/lib/commands/hardis/org/files/export.js.map +1 -1
- package/lib/commands/hardis/org/files/import.js +2 -2
- package/lib/commands/hardis/org/files/import.js.map +1 -1
- package/lib/commands/hardis/org/monitor/backup.js +1 -1
- package/lib/commands/hardis/org/multi-org-query.js +1 -1
- package/lib/commands/hardis/org/purge/flow.js +4 -4
- package/lib/commands/hardis/org/purge/flow.js.map +1 -1
- package/lib/commands/hardis/org/refresh/after-refresh.js +11 -11
- package/lib/commands/hardis/org/refresh/after-refresh.js.map +1 -1
- package/lib/commands/hardis/org/refresh/before-refresh.js +1 -1
- package/lib/commands/hardis/org/retrieve/sources/dx.js +1 -1
- package/lib/commands/hardis/org/retrieve/sources/dx.js.map +1 -1
- package/lib/commands/hardis/org/user/activateinvalid.js +1 -1
- package/lib/commands/hardis/org/user/activateinvalid.js.map +1 -1
- package/lib/commands/hardis/org/user/freeze.js +2 -2
- package/lib/commands/hardis/org/user/freeze.js.map +1 -1
- package/lib/commands/hardis/org/user/unfreeze.js +1 -1
- package/lib/commands/hardis/org/user/unfreeze.js.map +1 -1
- package/lib/commands/hardis/package/mergexml.js +1 -1
- package/lib/commands/hardis/package/mergexml.js.map +1 -1
- package/lib/commands/hardis/project/configure/auth.js +1 -1
- package/lib/commands/hardis/project/configure/auth.js.map +1 -1
- package/lib/commands/hardis/project/create.js +1 -1
- package/lib/commands/hardis/project/create.js.map +1 -1
- package/lib/commands/hardis/project/deploy/notify.js +1 -1
- package/lib/commands/hardis/project/deploy/simulate.js +1 -1
- package/lib/commands/hardis/project/deploy/simulate.js.map +1 -1
- package/lib/commands/hardis/project/deploy/smart.js +4 -4
- package/lib/commands/hardis/project/deploy/sources/metadata.js +1 -1
- package/lib/commands/hardis/project/generate/flow-git-diff.js +1 -1
- package/lib/commands/hardis/project/generate/flow-git-diff.js.map +1 -1
- package/lib/commands/hardis/project/metadata/activate-decomposed.js +1 -1
- package/lib/commands/hardis/project/metadata/activate-decomposed.js.map +1 -1
- package/lib/commands/hardis/scratch/create.js +2 -2
- package/lib/commands/hardis/scratch/create.js.map +1 -1
- package/lib/commands/hardis/scratch/pull.js +2 -2
- package/lib/commands/hardis/scratch/pull.js.map +1 -1
- package/lib/commands/hardis/source/retrieve.js +1 -1
- package/lib/commands/hardis/work/new.js +34 -34
- package/lib/commands/hardis/work/new.js.map +1 -1
- package/lib/commands/hardis/work/refresh.js +1 -1
- package/lib/commands/hardis/work/resetselection.js +1 -1
- package/lib/commands/hardis/work/resetselection.js.map +1 -1
- package/lib/commands/hardis/work/save.js +56 -26
- package/lib/commands/hardis/work/save.js.map +1 -1
- package/lib/commands/hardis/work/ws.js +1 -1
- package/lib/common/aiProvider/index.js +1 -1
- package/lib/common/docBuilder/docBuilderRoot.js +1 -1
- package/lib/common/gitProvider/azureDevops.js +18 -7
- package/lib/common/gitProvider/azureDevops.js.map +1 -1
- package/lib/common/gitProvider/index.js +18 -7
- package/lib/common/gitProvider/index.js.map +1 -1
- package/lib/common/gitProvider/utilsMarkdown.js +2 -2
- package/lib/common/metadata-utils/index.js +1 -1
- package/lib/common/metadata-utils/index.js.map +1 -1
- package/lib/common/ticketProvider/index.js +1 -1
- package/lib/common/utils/authUtils.js +3 -3
- package/lib/common/utils/authUtils.js.map +1 -1
- package/lib/common/utils/deployTipJson.js +2 -2
- package/lib/common/utils/deployTips.js +1 -1
- package/lib/common/utils/deployTipsList.js +1 -1
- package/lib/common/utils/deployUtils.js +7 -7
- package/lib/common/utils/deployUtils.js.map +1 -1
- package/lib/common/utils/filesUtils.js +5 -5
- package/lib/common/utils/filesUtils.js.map +1 -1
- package/lib/common/utils/flowVisualiser/flowParser.js +2 -2
- package/lib/common/utils/flowVisualiser/flowParser.js.map +1 -1
- package/lib/common/utils/gitUtils.js +3 -3
- package/lib/common/utils/gitUtils.js.map +1 -1
- package/lib/common/utils/index.js +35 -17
- package/lib/common/utils/index.js.map +1 -1
- package/lib/common/utils/markdownUtils.js +1 -1
- package/lib/common/utils/markdownUtils.js.map +1 -1
- package/lib/common/utils/mermaidUtils.js +6 -6
- package/lib/common/utils/mermaidUtils.js.map +1 -1
- package/lib/common/utils/notifUtils.js +1 -1
- package/lib/common/utils/orgConfigUtils.js +2 -2
- package/lib/common/utils/orgConfigUtils.js.map +1 -1
- package/lib/common/utils/orgUtils.js +7 -7
- package/lib/common/utils/orgUtils.js.map +1 -1
- package/lib/common/utils/poolUtils.js +6 -6
- package/lib/common/utils/poolUtils.js.map +1 -1
- package/lib/common/utils/prompts.js +4 -4
- package/lib/common/utils/prompts.js.map +1 -1
- package/lib/common/utils/refresh/connectedAppUtils.js +20 -20
- package/lib/common/utils/refresh/connectedAppUtils.js.map +1 -1
- package/lib/common/utils/wrapUtils.js +1 -1
- package/lib/common/utils/wrapUtils.js.map +1 -1
- package/lib/common/utils/xmlUtils.js +6 -6
- package/lib/common/utils/xmlUtils.js.map +1 -1
- package/lib/common/websocketClient.js +6 -6
- package/lib/common/websocketClient.js.map +1 -1
- package/lib/config/index.js +1 -1
- package/lib/config/index.js.map +1 -1
- package/lib/hooks/finally/notify.js +3 -3
- package/lib/hooks/finally/notify.js.map +1 -1
- package/lib/hooks/init/start-ws-client.js +1 -1
- package/lib/hooks/init/start-ws-client.js.map +1 -1
- package/lib/hooks/prerun/check-dependencies.js +6 -6
- package/lib/hooks/prerun/check-dependencies.js.map +1 -1
- package/oclif.manifest.json +753 -753
- package/package.json +1 -1
package/oclif.manifest.json
CHANGED
|
@@ -863,7 +863,7 @@
|
|
|
863
863
|
"hardis:doc:project2markdown": {
|
|
864
864
|
"aliases": [],
|
|
865
865
|
"args": {},
|
|
866
|
-
"description": "Generates
|
|
866
|
+
"description": "Generates Markdown documentation from a SFDX project\n\n- Objects (with fields, validation rules, relationships and dependencies)\n- Automations\n - Approval Processes\n - Assignment Rules\n - AutoResponse Rules\n - Escalation Rules\n - Flows\n- Authorizations\n - Profiles\n - Permission Set Groups\n - Permission Sets\n- Code\n - Apex\n - Lightning Web Components\n- Lightning Pages\n- Packages\n- SFDX-Hardis Config\n- Branches & Orgs\n- Manifests\n\nCan work on any sfdx project, no need for it to be a sfdx-hardis flavored one.\n\nGenerated markdown files will be written in the **docs** folder (except README.md, where a link to the doc index is added).\n\n- You can customize the pages following [mkdocs-material setup documentation](https://squidfunk.github.io/mkdocs-material/setup/)\n- You can manually add new markdown files in the \"docs\" folder to extend this documentation and add references to them in \"mkdocs.yml\"\n- You can also add images in folder \"docs/assets\" and embed them in markdown files.\n\nTo read flow documentation, if your markdown reader doesn't handle MermaidJS syntax this command may require @mermaid-js/mermaid-cli.\n\n- Run `npm install @mermaid-js/mermaid-cli --global` if puppeteer works in your environment\n- It can also be run as a docker image\n\nBoth modes will be tried by default, but you can also force one of them by defining environment variable `MERMAID_MODES=docker` or `MERMAID_MODES=cli`\n\n_sfdx-hardis docker image is alpine-based and does not succeed to run mermaid/puppeteer: if you can help, please submit a PR !_\n\nIf Flow history doc always display a single state, you probably need to update your workflow configuration:\n\n- on Gitlab: Env variable [`GIT_FETCH_EXTRA_FLAGS: --depth 10000`](https://github.com/hardisgroupcom/sfdx-hardis/blob/main/defaults/monitoring/.gitlab-ci.yml#L11)\n- on GitHub: [`fetch-depth: 0`](https://github.com/hardisgroupcom/sfdx-hardis/blob/main/defaults/monitoring/.github/workflows/org-monitoring.yml#L58)\n- on Azure: [`fetchDepth: \"0\"`](https://github.com/hardisgroupcom/sfdx-hardis/blob/main/defaults/monitoring/azure-pipelines.yml#L39)\n- on Bitbucket: [`step: clone: depth: full`](https://github.com/hardisgroupcom/sfdx-hardis/blob/main/defaults/monitoring/bitbucket-pipelines.yml#L18)\n\n\n\n\n\n\n\n\n\n\n\n\n\nIf it is a sfdx-hardis CI/CD project, a diagram of the branches and orgs strategy will be generated.\n\n\n\nIf [AI integration](https://sfdx-hardis.cloudity.com/salesforce-ai-setup/) is configured, documentation will contain a summary of the Flow.\n\n- Use variable PROMPTS_LANGUAGE (ex: PROMPTS_LANGUAGE=fr) to force language for LLM calls (default:en)\n\nIf you have a complex strategy, you might need to input property **mergeTargets** in branch-scoped sfdx-hardis.yml file to have a correct diagram.\n\nDefine DO_NOT_OVERWRITE_INDEX_MD=true to avoid overwriting the index.md file in docs folder, useful if you want to keep your own index.md file.\n\n## Doc HTML Pages\n\nTo read the documentation as HTML pages, run the following code (you need [**Python**](https://www.python.org/downloads/) on your computer)\n\n```python\npip install mkdocs-material mkdocs-exclude-search mdx_truly_sane_lists || python -m pip install mkdocs-material mkdocs-exclude-search mdx_truly_sane_lists || py -m pip install mkdocs-material mkdocs-exclude-search mdx_truly_sane_lists\nmkdocs serve -v || python -m mkdocs serve -v || py -m mkdocs serve -v\n```\n\nTo just generate HTML pages that you can host anywhere, run `mkdocs build -v || python -m mkdocs build -v || py -m mkdocs build -v`\n\n",
|
|
867
867
|
"examples": [
|
|
868
868
|
"$ sf hardis:doc:project2markdown",
|
|
869
869
|
"$ sf hardis:doc:project2markdown --with-history",
|
|
@@ -1105,9 +1105,9 @@
|
|
|
1105
1105
|
}
|
|
1106
1106
|
],
|
|
1107
1107
|
"messages": {
|
|
1108
|
-
"header": "Check if elements(
|
|
1109
|
-
"allElementsHaveRights": "All elements are included in at least one Permission
|
|
1110
|
-
"someElementsDontHaveRights": "Some elements are not included in
|
|
1108
|
+
"header": "Check if elements (Apex classes and custom fields) are included in at least one Permission Set or Profile.",
|
|
1109
|
+
"allElementsHaveRights": "All elements are included in at least one Permission Set or Profile.",
|
|
1110
|
+
"someElementsDontHaveRights": "Some elements are not included in any Permission Set or Profile."
|
|
1111
1111
|
},
|
|
1112
1112
|
"isESM": true,
|
|
1113
1113
|
"relativePath": [
|
|
@@ -2181,7 +2181,7 @@
|
|
|
2181
2181
|
"hardis:org:multi-org-query": {
|
|
2182
2182
|
"aliases": [],
|
|
2183
2183
|
"args": {},
|
|
2184
|
-
"description": "\n**Executes a SOQL query across multiple Salesforce organizations and consolidates the results into a single report.**\n\nThis command is highly valuable for administrators and developers who need to gather consistent data from various Salesforce environments (e.g., sandboxes, production orgs) for reporting, auditing, or comparison purposes. It streamlines the process of querying multiple orgs, eliminating the need to log into each one individually.\n\nKey functionalities:\n\n- **Flexible Query Input:** You can provide a custom SOQL query directly using the `--query` flag, or select from a list of predefined query templates (e.g., `active-users`, `all-users`) using the `--query-template` flag.\n- **Multiple Org Targeting:** Specify a list of Salesforce org usernames or aliases using the `--target-orgs` flag. If not provided, an interactive menu will allow you to select multiple authenticated orgs.\n- **Consolidated Report:** All query results from the different orgs are combined into a single CSV file, making data analysis and comparison straightforward.\n- **Authentication Handling:** For CI/CD jobs, ensure that the target orgs are already authenticated using Salesforce CLI. In interactive mode, it will prompt for authentication if an org is not connected.\n\n**Visual Demo:**\n\n[](https://marketplace.visualstudio.com/items?itemName=NicolasVuillamy.vscode-sfdx-hardis)\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **Org Authentication and Connection:** It uses `AuthInfo.create` and `Connection.create` to establish connections to each target Salesforce org. It also leverages `makeSureOrgIsConnected` and `promptOrgList` for interactive org selection and authentication checks.\n- **SOQL Query Execution (Bulk API):** It executes the specified SOQL query against each connected org using `bulkQuery` for efficient data retrieval, especially for large datasets.\n- **Data Aggregation:** It collects the records from each org's query result and adds metadata about the source org (instance URL, alias, username) to each record, enabling easy identification of data origin in the consolidated report.\n- **Report Generation:** It uses `generateCsvFile` to create the final CSV report and `generateReportPath` to determine the output file location.\n- **Interactive Prompts:** The `prompts` library is used to guide the user through selecting a query template or entering a custom query, and for selecting target orgs if not provided as command-line arguments.\n- **Error Handling:** It logs errors for any orgs where the query fails, ensuring that the overall process continues and provides a clear summary of successes and failures.\n</details>\n",
|
|
2185
2185
|
"examples": [
|
|
2186
2186
|
"$ sf hardis:org:multi-org-query",
|
|
2187
2187
|
"$ sf hardis:org:multi-org-query --query \"SELECT Id,Username FROM User\"",
|
|
@@ -4341,7 +4341,7 @@
|
|
|
4341
4341
|
"hardis:work:ws": {
|
|
4342
4342
|
"aliases": [],
|
|
4343
4343
|
"args": {},
|
|
4344
|
-
"description": "\n## Command Behavior\n\n**Performs technical operations related to WebSocket communication, primarily for internal use by the sfdx-hardis VS Code
|
|
4344
|
+
"description": "\n## Command Behavior\n\n**Performs technical operations related to WebSocket communication, primarily for internal use by the sfdx-hardis VS Code extension.**\n\nThis command is not intended for direct end-user interaction. It facilitates communication between the sfdx-hardis CLI and the VS Code Extension, enabling features like real-time status updates and plugin refreshes.\n\nKey functionalities:\n\n- **Refresh Status (`--event refreshStatus`):** Sends a message to the VS Code Extension to refresh its displayed status, ensuring that the UI reflects the latest state of Salesforce orgs or project activities.\n- **Refresh Plugins (`--event refreshPlugins`):** Sends a message to the VS Code Extension to refresh its loaded plugins, useful after installing or updating sfdx-hardis or other related extensions.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **WebSocketClient:** It utilizes the `WebSocketClient` utility to establish and manage WebSocket connections.\n- **Event-Driven Communication:** It listens for specific events (e.g., `refreshStatus`, `refreshPlugins`) and triggers corresponding actions on the connected WebSocket client.\n- **Internal Use:** This command is primarily called programmatically by the VS Code Extension to maintain synchronization and provide a seamless user experience.\n</details>\n",
|
|
4345
4345
|
"examples": [
|
|
4346
4346
|
"$ sf hardis:work:ws --event refreshStatus"
|
|
4347
4347
|
],
|
|
@@ -5538,12 +5538,15 @@
|
|
|
5538
5538
|
"import:data:org:hardis"
|
|
5539
5539
|
]
|
|
5540
5540
|
},
|
|
5541
|
-
"hardis:org:
|
|
5541
|
+
"hardis:org:diagnose:audittrail": {
|
|
5542
5542
|
"aliases": [],
|
|
5543
5543
|
"args": {},
|
|
5544
|
-
"description": "
|
|
5544
|
+
"description": "Export Audit trail into a CSV file with selected criteria, and highlight suspect actions\n\nAlso detects updates of Custom Settings values (disable by defining `SKIP_AUDIT_TRAIL_CUSTOM_SETTINGS=true`)\n\nRegular setup actions performed in major orgs are filtered.\n\n- \"\"\n - createScratchOrg\n - changedsenderemail\n - deleteScratchOrg\n - loginasgrantedtopartnerbt\n- Certificate and Key Management\n - insertCertificate\n- Custom App Licenses\n - addeduserpackagelicense\n - granteduserpackagelicense\n - revokeduserpackagelicense\n- Customer Portal\n - createdcustomersuccessuser\n - CSPUserDisabled\n- Currency\n - updateddatedexchrate\n- Data Management\n - queueMembership\n- Email Administration\n - dkimRotationPreparationSuccessful\n - dkimRotationSuccessful\n- External Objects\n - xdsEncryptedFieldChange\n- Groups\n - groupMembership\n- Holidays\n - holiday_insert\n- Inbox mobile and legacy desktop apps\n - enableSIQUserNonEAC\n - siqUserAcceptedTOS\n- Manage Users\n - activateduser\n - createduser\n - changedcommunitynickname\n - changedemail\n - changedfederationid\n - changedpassword\n - changedinteractionuseroffon\n - changedinteractionuseronoff\n - changedmarketinguseroffon\n - changedmarketinguseronoff\n - changedofflineuseroffon\n - changedprofileforuserstdtostd\n - changedprofileforuser\n - changedprofileforusercusttostd\n - changedprofileforuserstdtocust\n - changedroleforusertonone\n - changedroleforuser\n - changedroleforuserfromnone\n - changedUserAdminVerifiedStatusVerified\n - changedUserEmailVerifiedStatusUnverified\n - changedUserEmailVerifiedStatusVerified\n - changedknowledgeuseroffon\n - changedsfcontentuseroffon\n - changedsupportuseroffon\n - changedusername\n - changedUserPhoneNumber\n - changedUserPhoneVerifiedStatusUnverified\n - changedUserPhoneVerifiedStatusVerified\n - deactivateduser\n - deleteAuthenticatorPairing\n - deleteTwoFactorInfo2\n - deleteTwoFactorTempCode\n - frozeuser\n - insertAuthenticatorPairing\n - insertTwoFactorInfo2\n - insertTwoFactorTempCode\n - lightningloginenroll\n - PermSetAssign\n - PermSetGroupAssign\n - PermSetGroupUnassign\n - PermSetLicenseAssign\n - PermSetUnassign\n - PermSetLicenseUnassign\n - registeredUserPhoneNumber\n - resetpassword\n - suNetworkAdminLogin\n - suNetworkAdminLogout\n - suOrgAdminLogin\n - suOrgAdminLogout\n - unfrozeuser\n - useremailchangesent\n- Mobile Administration\n - assigneduserstomobileconfig\n- Reporting Snapshots\n - createdReportJob\n - deletedReportJob\n- Sandboxes\n - DeleteSandbox\n\nBy default, deployment user defined in .sfdx-hardis.yml targetUsername property will be excluded.\n\nYou can define additional users to exclude in .sfdx-hardis.yml **monitoringExcludeUsernames** property.\n\nYou can also add more sections / actions considered as not suspect using property **monitoringAllowedSectionsActions**\n\nExample:\n\n```yaml\nmonitoringExcludeUsernames:\n - deploymentuser@cloudity.com\n - marketingcloud@cloudity.com\n - integration-user@cloudity.com\n\nmonitoringAllowedSectionsActions:\n \"Some section\": [] // Will ignore all actions from such section\n \"Some other section\": [\"actionType1\",\"actionType2\",\"actionType3\"] // Will ignore only those 3 actions from section \"Some other section\". Other actions in the same section will be considered as suspect.\n```\n\n## Excel output example\n\n\n\n## Local output example\n\n\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-suspect-audit-trail/) and can output Grafana, Slack and MsTeams Notifications.\n",
|
|
5545
5545
|
"examples": [
|
|
5546
|
-
"$ sf hardis:org:
|
|
5546
|
+
"$ sf hardis:org:diagnose:audittrail",
|
|
5547
|
+
"$ sf hardis:org:diagnose:audittrail --excludeusers baptiste@titi.com",
|
|
5548
|
+
"$ sf hardis:org:diagnose:audittrail --excludeusers baptiste@titi.com,bertrand@titi.com",
|
|
5549
|
+
"$ sf hardis:org:diagnose:audittrail --lastndays 5"
|
|
5547
5550
|
],
|
|
5548
5551
|
"flags": {
|
|
5549
5552
|
"json": {
|
|
@@ -5561,48 +5564,30 @@
|
|
|
5561
5564
|
"multiple": false,
|
|
5562
5565
|
"type": "option"
|
|
5563
5566
|
},
|
|
5564
|
-
"
|
|
5565
|
-
"char": "
|
|
5566
|
-
"description": "
|
|
5567
|
-
"name": "
|
|
5568
|
-
"hasDynamicHelp": false,
|
|
5569
|
-
"multiple": false,
|
|
5570
|
-
"type": "option"
|
|
5571
|
-
},
|
|
5572
|
-
"chunksize": {
|
|
5573
|
-
"char": "c",
|
|
5574
|
-
"description": "Number of records to add in a chunk before it is processed",
|
|
5575
|
-
"name": "chunksize",
|
|
5576
|
-
"default": 1000,
|
|
5567
|
+
"excludeusers": {
|
|
5568
|
+
"char": "e",
|
|
5569
|
+
"description": "Comma-separated list of usernames to exclude",
|
|
5570
|
+
"name": "excludeusers",
|
|
5577
5571
|
"hasDynamicHelp": false,
|
|
5578
5572
|
"multiple": false,
|
|
5579
5573
|
"type": "option"
|
|
5580
5574
|
},
|
|
5581
|
-
"
|
|
5575
|
+
"lastndays": {
|
|
5582
5576
|
"char": "t",
|
|
5583
|
-
"description": "
|
|
5584
|
-
"name": "
|
|
5585
|
-
"default": 300000,
|
|
5577
|
+
"description": "Number of days to extract from today (included)",
|
|
5578
|
+
"name": "lastndays",
|
|
5586
5579
|
"hasDynamicHelp": false,
|
|
5587
5580
|
"multiple": false,
|
|
5588
5581
|
"type": "option"
|
|
5589
5582
|
},
|
|
5590
|
-
"
|
|
5591
|
-
"char": "
|
|
5592
|
-
"description": "
|
|
5593
|
-
"name": "
|
|
5594
|
-
"default": 0,
|
|
5583
|
+
"outputfile": {
|
|
5584
|
+
"char": "f",
|
|
5585
|
+
"description": "Force the path and name of output report file. Must end with .csv",
|
|
5586
|
+
"name": "outputfile",
|
|
5595
5587
|
"hasDynamicHelp": false,
|
|
5596
5588
|
"multiple": false,
|
|
5597
5589
|
"type": "option"
|
|
5598
5590
|
},
|
|
5599
|
-
"resume": {
|
|
5600
|
-
"char": "r",
|
|
5601
|
-
"description": "Resume previous export by checking existing files (default in CI)",
|
|
5602
|
-
"name": "resume",
|
|
5603
|
-
"allowNo": false,
|
|
5604
|
-
"type": "boolean"
|
|
5605
|
-
},
|
|
5606
5591
|
"debug": {
|
|
5607
5592
|
"char": "d",
|
|
5608
5593
|
"description": "Activate debug mode (more logs)",
|
|
@@ -5641,13 +5626,13 @@
|
|
|
5641
5626
|
},
|
|
5642
5627
|
"hasDynamicHelp": true,
|
|
5643
5628
|
"hiddenAliases": [],
|
|
5644
|
-
"id": "hardis:org:
|
|
5629
|
+
"id": "hardis:org:diagnose:audittrail",
|
|
5645
5630
|
"pluginAlias": "sfdx-hardis",
|
|
5646
5631
|
"pluginName": "sfdx-hardis",
|
|
5647
5632
|
"pluginType": "core",
|
|
5648
5633
|
"strict": true,
|
|
5649
5634
|
"enableJsonFlag": true,
|
|
5650
|
-
"title": "
|
|
5635
|
+
"title": "Diagnose content of Setup Audit Trail",
|
|
5651
5636
|
"requiresProject": false,
|
|
5652
5637
|
"isESM": true,
|
|
5653
5638
|
"relativePath": [
|
|
@@ -5655,43 +5640,43 @@
|
|
|
5655
5640
|
"commands",
|
|
5656
5641
|
"hardis",
|
|
5657
5642
|
"org",
|
|
5658
|
-
"
|
|
5659
|
-
"
|
|
5643
|
+
"diagnose",
|
|
5644
|
+
"audittrail.js"
|
|
5660
5645
|
],
|
|
5661
5646
|
"aliasPermutations": [],
|
|
5662
5647
|
"permutations": [
|
|
5663
|
-
"hardis:org:
|
|
5664
|
-
"org:hardis:
|
|
5665
|
-
"org:
|
|
5666
|
-
"org:
|
|
5667
|
-
"hardis:
|
|
5668
|
-
"
|
|
5669
|
-
"
|
|
5670
|
-
"
|
|
5671
|
-
"hardis:
|
|
5672
|
-
"
|
|
5673
|
-
"
|
|
5674
|
-
"
|
|
5675
|
-
"hardis:org:
|
|
5676
|
-
"org:hardis:
|
|
5677
|
-
"org:
|
|
5678
|
-
"org:
|
|
5679
|
-
"hardis:
|
|
5680
|
-
"
|
|
5681
|
-
"
|
|
5682
|
-
"
|
|
5683
|
-
"hardis:
|
|
5684
|
-
"
|
|
5685
|
-
"
|
|
5686
|
-
"
|
|
5648
|
+
"hardis:org:diagnose:audittrail",
|
|
5649
|
+
"org:hardis:diagnose:audittrail",
|
|
5650
|
+
"org:diagnose:hardis:audittrail",
|
|
5651
|
+
"org:diagnose:audittrail:hardis",
|
|
5652
|
+
"hardis:diagnose:org:audittrail",
|
|
5653
|
+
"diagnose:hardis:org:audittrail",
|
|
5654
|
+
"diagnose:org:hardis:audittrail",
|
|
5655
|
+
"diagnose:org:audittrail:hardis",
|
|
5656
|
+
"hardis:diagnose:audittrail:org",
|
|
5657
|
+
"diagnose:hardis:audittrail:org",
|
|
5658
|
+
"diagnose:audittrail:hardis:org",
|
|
5659
|
+
"diagnose:audittrail:org:hardis",
|
|
5660
|
+
"hardis:org:audittrail:diagnose",
|
|
5661
|
+
"org:hardis:audittrail:diagnose",
|
|
5662
|
+
"org:audittrail:hardis:diagnose",
|
|
5663
|
+
"org:audittrail:diagnose:hardis",
|
|
5664
|
+
"hardis:audittrail:org:diagnose",
|
|
5665
|
+
"audittrail:hardis:org:diagnose",
|
|
5666
|
+
"audittrail:org:hardis:diagnose",
|
|
5667
|
+
"audittrail:org:diagnose:hardis",
|
|
5668
|
+
"hardis:audittrail:diagnose:org",
|
|
5669
|
+
"audittrail:hardis:diagnose:org",
|
|
5670
|
+
"audittrail:diagnose:hardis:org",
|
|
5671
|
+
"audittrail:diagnose:org:hardis"
|
|
5687
5672
|
]
|
|
5688
5673
|
},
|
|
5689
|
-
"hardis:org:
|
|
5674
|
+
"hardis:org:diagnose:instanceupgrade": {
|
|
5690
5675
|
"aliases": [],
|
|
5691
5676
|
"args": {},
|
|
5692
|
-
"description": "\
|
|
5677
|
+
"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
5678
|
"examples": [
|
|
5694
|
-
"$ sf hardis:org:
|
|
5679
|
+
"$ sf hardis:org:diagnose:instanceupgrade"
|
|
5695
5680
|
],
|
|
5696
5681
|
"flags": {
|
|
5697
5682
|
"json": {
|
|
@@ -5709,21 +5694,6 @@
|
|
|
5709
5694
|
"multiple": false,
|
|
5710
5695
|
"type": "option"
|
|
5711
5696
|
},
|
|
5712
|
-
"path": {
|
|
5713
|
-
"char": "p",
|
|
5714
|
-
"description": "Path to the file export project",
|
|
5715
|
-
"name": "path",
|
|
5716
|
-
"hasDynamicHelp": false,
|
|
5717
|
-
"multiple": false,
|
|
5718
|
-
"type": "option"
|
|
5719
|
-
},
|
|
5720
|
-
"overwrite": {
|
|
5721
|
-
"char": "f",
|
|
5722
|
-
"description": "Override existing files (doubles the number of API calls)",
|
|
5723
|
-
"name": "overwrite",
|
|
5724
|
-
"allowNo": false,
|
|
5725
|
-
"type": "boolean"
|
|
5726
|
-
},
|
|
5727
5697
|
"debug": {
|
|
5728
5698
|
"char": "d",
|
|
5729
5699
|
"description": "Activate debug mode (more logs)",
|
|
@@ -5762,13 +5732,13 @@
|
|
|
5762
5732
|
},
|
|
5763
5733
|
"hasDynamicHelp": true,
|
|
5764
5734
|
"hiddenAliases": [],
|
|
5765
|
-
"id": "hardis:org:
|
|
5735
|
+
"id": "hardis:org:diagnose:instanceupgrade",
|
|
5766
5736
|
"pluginAlias": "sfdx-hardis",
|
|
5767
5737
|
"pluginName": "sfdx-hardis",
|
|
5768
5738
|
"pluginType": "core",
|
|
5769
5739
|
"strict": true,
|
|
5770
5740
|
"enableJsonFlag": true,
|
|
5771
|
-
"title": "
|
|
5741
|
+
"title": "Get Instance Upgrade date",
|
|
5772
5742
|
"requiresProject": false,
|
|
5773
5743
|
"isESM": true,
|
|
5774
5744
|
"relativePath": [
|
|
@@ -5776,46 +5746,46 @@
|
|
|
5776
5746
|
"commands",
|
|
5777
5747
|
"hardis",
|
|
5778
5748
|
"org",
|
|
5779
|
-
"
|
|
5780
|
-
"
|
|
5749
|
+
"diagnose",
|
|
5750
|
+
"instanceupgrade.js"
|
|
5781
5751
|
],
|
|
5782
5752
|
"aliasPermutations": [],
|
|
5783
5753
|
"permutations": [
|
|
5784
|
-
"hardis:org:
|
|
5785
|
-
"org:hardis:
|
|
5786
|
-
"org:
|
|
5787
|
-
"org:
|
|
5788
|
-
"hardis:
|
|
5789
|
-
"
|
|
5790
|
-
"
|
|
5791
|
-
"
|
|
5792
|
-
"hardis:
|
|
5793
|
-
"
|
|
5794
|
-
"
|
|
5795
|
-
"
|
|
5796
|
-
"hardis:org:
|
|
5797
|
-
"org:hardis:
|
|
5798
|
-
"org:
|
|
5799
|
-
"org:
|
|
5800
|
-
"hardis:
|
|
5801
|
-
"
|
|
5802
|
-
"
|
|
5803
|
-
"
|
|
5804
|
-
"hardis:
|
|
5805
|
-
"
|
|
5806
|
-
"
|
|
5807
|
-
"
|
|
5754
|
+
"hardis:org:diagnose:instanceupgrade",
|
|
5755
|
+
"org:hardis:diagnose:instanceupgrade",
|
|
5756
|
+
"org:diagnose:hardis:instanceupgrade",
|
|
5757
|
+
"org:diagnose:instanceupgrade:hardis",
|
|
5758
|
+
"hardis:diagnose:org:instanceupgrade",
|
|
5759
|
+
"diagnose:hardis:org:instanceupgrade",
|
|
5760
|
+
"diagnose:org:hardis:instanceupgrade",
|
|
5761
|
+
"diagnose:org:instanceupgrade:hardis",
|
|
5762
|
+
"hardis:diagnose:instanceupgrade:org",
|
|
5763
|
+
"diagnose:hardis:instanceupgrade:org",
|
|
5764
|
+
"diagnose:instanceupgrade:hardis:org",
|
|
5765
|
+
"diagnose:instanceupgrade:org:hardis",
|
|
5766
|
+
"hardis:org:instanceupgrade:diagnose",
|
|
5767
|
+
"org:hardis:instanceupgrade:diagnose",
|
|
5768
|
+
"org:instanceupgrade:hardis:diagnose",
|
|
5769
|
+
"org:instanceupgrade:diagnose:hardis",
|
|
5770
|
+
"hardis:instanceupgrade:org:diagnose",
|
|
5771
|
+
"instanceupgrade:hardis:org:diagnose",
|
|
5772
|
+
"instanceupgrade:org:hardis:diagnose",
|
|
5773
|
+
"instanceupgrade:org:diagnose:hardis",
|
|
5774
|
+
"hardis:instanceupgrade:diagnose:org",
|
|
5775
|
+
"instanceupgrade:hardis:diagnose:org",
|
|
5776
|
+
"instanceupgrade:diagnose:hardis:org",
|
|
5777
|
+
"instanceupgrade:diagnose:org:hardis"
|
|
5808
5778
|
]
|
|
5809
5779
|
},
|
|
5810
|
-
"hardis:org:diagnose:
|
|
5780
|
+
"hardis:org:diagnose:legacyapi": {
|
|
5811
5781
|
"aliases": [],
|
|
5812
5782
|
"args": {},
|
|
5813
|
-
"description": "
|
|
5783
|
+
"description": "Checks if an org uses retired or someday retired API version\n\n\nSee article below\n\n[](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
5784
|
"examples": [
|
|
5815
|
-
"$ sf hardis:org:diagnose:
|
|
5816
|
-
"$ sf hardis:org:diagnose:
|
|
5817
|
-
"$ sf hardis:org:diagnose:
|
|
5818
|
-
"$ sf hardis:org:diagnose:
|
|
5785
|
+
"$ sf hardis:org:diagnose:legacyapi",
|
|
5786
|
+
"$ sf hardis:org:diagnose:legacyapi -u hardis@myclient.com",
|
|
5787
|
+
"$ sf hardis:org:diagnose:legacyapi --outputfile 'c:/path/to/folder/legacyapi.csv'",
|
|
5788
|
+
"$ sf hardis:org:diagnose:legacyapi -u hardis@myclient.com --outputfile ./tmp/legacyapi.csv"
|
|
5819
5789
|
],
|
|
5820
5790
|
"flags": {
|
|
5821
5791
|
"json": {
|
|
@@ -5833,18 +5803,20 @@
|
|
|
5833
5803
|
"multiple": false,
|
|
5834
5804
|
"type": "option"
|
|
5835
5805
|
},
|
|
5836
|
-
"
|
|
5806
|
+
"eventtype": {
|
|
5837
5807
|
"char": "e",
|
|
5838
|
-
"description": "
|
|
5839
|
-
"name": "
|
|
5808
|
+
"description": "Type of EventLogFile event to analyze",
|
|
5809
|
+
"name": "eventtype",
|
|
5810
|
+
"default": "ApiTotalUsage",
|
|
5840
5811
|
"hasDynamicHelp": false,
|
|
5841
5812
|
"multiple": false,
|
|
5842
5813
|
"type": "option"
|
|
5843
5814
|
},
|
|
5844
|
-
"
|
|
5845
|
-
"char": "
|
|
5846
|
-
"description": "Number of
|
|
5847
|
-
"name": "
|
|
5815
|
+
"limit": {
|
|
5816
|
+
"char": "l",
|
|
5817
|
+
"description": "Number of latest EventLogFile events to analyze",
|
|
5818
|
+
"name": "limit",
|
|
5819
|
+
"default": 999,
|
|
5848
5820
|
"hasDynamicHelp": false,
|
|
5849
5821
|
"multiple": false,
|
|
5850
5822
|
"type": "option"
|
|
@@ -5895,13 +5867,13 @@
|
|
|
5895
5867
|
},
|
|
5896
5868
|
"hasDynamicHelp": true,
|
|
5897
5869
|
"hiddenAliases": [],
|
|
5898
|
-
"id": "hardis:org:diagnose:
|
|
5870
|
+
"id": "hardis:org:diagnose:legacyapi",
|
|
5899
5871
|
"pluginAlias": "sfdx-hardis",
|
|
5900
5872
|
"pluginName": "sfdx-hardis",
|
|
5901
5873
|
"pluginType": "core",
|
|
5902
5874
|
"strict": true,
|
|
5903
5875
|
"enableJsonFlag": true,
|
|
5904
|
-
"title": "
|
|
5876
|
+
"title": "Check for legacy API use",
|
|
5905
5877
|
"requiresProject": false,
|
|
5906
5878
|
"isESM": true,
|
|
5907
5879
|
"relativePath": [
|
|
@@ -5910,248 +5882,7 @@
|
|
|
5910
5882
|
"hardis",
|
|
5911
5883
|
"org",
|
|
5912
5884
|
"diagnose",
|
|
5913
|
-
"
|
|
5914
|
-
],
|
|
5915
|
-
"aliasPermutations": [],
|
|
5916
|
-
"permutations": [
|
|
5917
|
-
"hardis:org:diagnose:audittrail",
|
|
5918
|
-
"org:hardis:diagnose:audittrail",
|
|
5919
|
-
"org:diagnose:hardis:audittrail",
|
|
5920
|
-
"org:diagnose:audittrail:hardis",
|
|
5921
|
-
"hardis:diagnose:org:audittrail",
|
|
5922
|
-
"diagnose:hardis:org:audittrail",
|
|
5923
|
-
"diagnose:org:hardis:audittrail",
|
|
5924
|
-
"diagnose:org:audittrail:hardis",
|
|
5925
|
-
"hardis:diagnose:audittrail:org",
|
|
5926
|
-
"diagnose:hardis:audittrail:org",
|
|
5927
|
-
"diagnose:audittrail:hardis:org",
|
|
5928
|
-
"diagnose:audittrail:org:hardis",
|
|
5929
|
-
"hardis:org:audittrail:diagnose",
|
|
5930
|
-
"org:hardis:audittrail:diagnose",
|
|
5931
|
-
"org:audittrail:hardis:diagnose",
|
|
5932
|
-
"org:audittrail:diagnose:hardis",
|
|
5933
|
-
"hardis:audittrail:org:diagnose",
|
|
5934
|
-
"audittrail:hardis:org:diagnose",
|
|
5935
|
-
"audittrail:org:hardis:diagnose",
|
|
5936
|
-
"audittrail:org:diagnose:hardis",
|
|
5937
|
-
"hardis:audittrail:diagnose:org",
|
|
5938
|
-
"audittrail:hardis:diagnose:org",
|
|
5939
|
-
"audittrail:diagnose:hardis:org",
|
|
5940
|
-
"audittrail:diagnose:org:hardis"
|
|
5941
|
-
]
|
|
5942
|
-
},
|
|
5943
|
-
"hardis:org:diagnose:instanceupgrade": {
|
|
5944
|
-
"aliases": [],
|
|
5945
|
-
"args": {},
|
|
5946
|
-
"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",
|
|
5947
|
-
"examples": [
|
|
5948
|
-
"$ sf hardis:org:diagnose:instanceupgrade"
|
|
5949
|
-
],
|
|
5950
|
-
"flags": {
|
|
5951
|
-
"json": {
|
|
5952
|
-
"description": "Format output as json.",
|
|
5953
|
-
"helpGroup": "GLOBAL",
|
|
5954
|
-
"name": "json",
|
|
5955
|
-
"allowNo": false,
|
|
5956
|
-
"type": "boolean"
|
|
5957
|
-
},
|
|
5958
|
-
"flags-dir": {
|
|
5959
|
-
"helpGroup": "GLOBAL",
|
|
5960
|
-
"name": "flags-dir",
|
|
5961
|
-
"summary": "Import flag values from a directory.",
|
|
5962
|
-
"hasDynamicHelp": false,
|
|
5963
|
-
"multiple": false,
|
|
5964
|
-
"type": "option"
|
|
5965
|
-
},
|
|
5966
|
-
"debug": {
|
|
5967
|
-
"char": "d",
|
|
5968
|
-
"description": "Activate debug mode (more logs)",
|
|
5969
|
-
"name": "debug",
|
|
5970
|
-
"allowNo": false,
|
|
5971
|
-
"type": "boolean"
|
|
5972
|
-
},
|
|
5973
|
-
"websocket": {
|
|
5974
|
-
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
5975
|
-
"name": "websocket",
|
|
5976
|
-
"hasDynamicHelp": false,
|
|
5977
|
-
"multiple": false,
|
|
5978
|
-
"type": "option"
|
|
5979
|
-
},
|
|
5980
|
-
"skipauth": {
|
|
5981
|
-
"description": "Skip authentication check when a default username is required",
|
|
5982
|
-
"name": "skipauth",
|
|
5983
|
-
"allowNo": false,
|
|
5984
|
-
"type": "boolean"
|
|
5985
|
-
},
|
|
5986
|
-
"target-org": {
|
|
5987
|
-
"aliases": [
|
|
5988
|
-
"targetusername",
|
|
5989
|
-
"u"
|
|
5990
|
-
],
|
|
5991
|
-
"char": "o",
|
|
5992
|
-
"deprecateAliases": true,
|
|
5993
|
-
"name": "target-org",
|
|
5994
|
-
"noCacheDefault": true,
|
|
5995
|
-
"required": true,
|
|
5996
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
5997
|
-
"hasDynamicHelp": true,
|
|
5998
|
-
"multiple": false,
|
|
5999
|
-
"type": "option"
|
|
6000
|
-
}
|
|
6001
|
-
},
|
|
6002
|
-
"hasDynamicHelp": true,
|
|
6003
|
-
"hiddenAliases": [],
|
|
6004
|
-
"id": "hardis:org:diagnose:instanceupgrade",
|
|
6005
|
-
"pluginAlias": "sfdx-hardis",
|
|
6006
|
-
"pluginName": "sfdx-hardis",
|
|
6007
|
-
"pluginType": "core",
|
|
6008
|
-
"strict": true,
|
|
6009
|
-
"enableJsonFlag": true,
|
|
6010
|
-
"title": "Get Instance Upgrade date",
|
|
6011
|
-
"requiresProject": false,
|
|
6012
|
-
"isESM": true,
|
|
6013
|
-
"relativePath": [
|
|
6014
|
-
"lib",
|
|
6015
|
-
"commands",
|
|
6016
|
-
"hardis",
|
|
6017
|
-
"org",
|
|
6018
|
-
"diagnose",
|
|
6019
|
-
"instanceupgrade.js"
|
|
6020
|
-
],
|
|
6021
|
-
"aliasPermutations": [],
|
|
6022
|
-
"permutations": [
|
|
6023
|
-
"hardis:org:diagnose:instanceupgrade",
|
|
6024
|
-
"org:hardis:diagnose:instanceupgrade",
|
|
6025
|
-
"org:diagnose:hardis:instanceupgrade",
|
|
6026
|
-
"org:diagnose:instanceupgrade:hardis",
|
|
6027
|
-
"hardis:diagnose:org:instanceupgrade",
|
|
6028
|
-
"diagnose:hardis:org:instanceupgrade",
|
|
6029
|
-
"diagnose:org:hardis:instanceupgrade",
|
|
6030
|
-
"diagnose:org:instanceupgrade:hardis",
|
|
6031
|
-
"hardis:diagnose:instanceupgrade:org",
|
|
6032
|
-
"diagnose:hardis:instanceupgrade:org",
|
|
6033
|
-
"diagnose:instanceupgrade:hardis:org",
|
|
6034
|
-
"diagnose:instanceupgrade:org:hardis",
|
|
6035
|
-
"hardis:org:instanceupgrade:diagnose",
|
|
6036
|
-
"org:hardis:instanceupgrade:diagnose",
|
|
6037
|
-
"org:instanceupgrade:hardis:diagnose",
|
|
6038
|
-
"org:instanceupgrade:diagnose:hardis",
|
|
6039
|
-
"hardis:instanceupgrade:org:diagnose",
|
|
6040
|
-
"instanceupgrade:hardis:org:diagnose",
|
|
6041
|
-
"instanceupgrade:org:hardis:diagnose",
|
|
6042
|
-
"instanceupgrade:org:diagnose:hardis",
|
|
6043
|
-
"hardis:instanceupgrade:diagnose:org",
|
|
6044
|
-
"instanceupgrade:hardis:diagnose:org",
|
|
6045
|
-
"instanceupgrade:diagnose:hardis:org",
|
|
6046
|
-
"instanceupgrade:diagnose:org:hardis"
|
|
6047
|
-
]
|
|
6048
|
-
},
|
|
6049
|
-
"hardis:org:diagnose:legacyapi": {
|
|
6050
|
-
"aliases": [],
|
|
6051
|
-
"args": {},
|
|
6052
|
-
"description": "Checks if an org uses retired or someday retired API version\n\n\nSee article below\n\n[](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",
|
|
6053
|
-
"examples": [
|
|
6054
|
-
"$ sf hardis:org:diagnose:legacyapi",
|
|
6055
|
-
"$ sf hardis:org:diagnose:legacyapi -u hardis@myclient.com",
|
|
6056
|
-
"$ sf hardis:org:diagnose:legacyapi --outputfile 'c:/path/to/folder/legacyapi.csv'",
|
|
6057
|
-
"$ sf hardis:org:diagnose:legacyapi -u hardis@myclient.com --outputfile ./tmp/legacyapi.csv"
|
|
6058
|
-
],
|
|
6059
|
-
"flags": {
|
|
6060
|
-
"json": {
|
|
6061
|
-
"description": "Format output as json.",
|
|
6062
|
-
"helpGroup": "GLOBAL",
|
|
6063
|
-
"name": "json",
|
|
6064
|
-
"allowNo": false,
|
|
6065
|
-
"type": "boolean"
|
|
6066
|
-
},
|
|
6067
|
-
"flags-dir": {
|
|
6068
|
-
"helpGroup": "GLOBAL",
|
|
6069
|
-
"name": "flags-dir",
|
|
6070
|
-
"summary": "Import flag values from a directory.",
|
|
6071
|
-
"hasDynamicHelp": false,
|
|
6072
|
-
"multiple": false,
|
|
6073
|
-
"type": "option"
|
|
6074
|
-
},
|
|
6075
|
-
"eventtype": {
|
|
6076
|
-
"char": "e",
|
|
6077
|
-
"description": "Type of EventLogFile event to analyze",
|
|
6078
|
-
"name": "eventtype",
|
|
6079
|
-
"default": "ApiTotalUsage",
|
|
6080
|
-
"hasDynamicHelp": false,
|
|
6081
|
-
"multiple": false,
|
|
6082
|
-
"type": "option"
|
|
6083
|
-
},
|
|
6084
|
-
"limit": {
|
|
6085
|
-
"char": "l",
|
|
6086
|
-
"description": "Number of latest EventLogFile events to analyze",
|
|
6087
|
-
"name": "limit",
|
|
6088
|
-
"default": 999,
|
|
6089
|
-
"hasDynamicHelp": false,
|
|
6090
|
-
"multiple": false,
|
|
6091
|
-
"type": "option"
|
|
6092
|
-
},
|
|
6093
|
-
"outputfile": {
|
|
6094
|
-
"char": "f",
|
|
6095
|
-
"description": "Force the path and name of output report file. Must end with .csv",
|
|
6096
|
-
"name": "outputfile",
|
|
6097
|
-
"hasDynamicHelp": false,
|
|
6098
|
-
"multiple": false,
|
|
6099
|
-
"type": "option"
|
|
6100
|
-
},
|
|
6101
|
-
"debug": {
|
|
6102
|
-
"char": "d",
|
|
6103
|
-
"description": "Activate debug mode (more logs)",
|
|
6104
|
-
"name": "debug",
|
|
6105
|
-
"allowNo": false,
|
|
6106
|
-
"type": "boolean"
|
|
6107
|
-
},
|
|
6108
|
-
"websocket": {
|
|
6109
|
-
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
6110
|
-
"name": "websocket",
|
|
6111
|
-
"hasDynamicHelp": false,
|
|
6112
|
-
"multiple": false,
|
|
6113
|
-
"type": "option"
|
|
6114
|
-
},
|
|
6115
|
-
"skipauth": {
|
|
6116
|
-
"description": "Skip authentication check when a default username is required",
|
|
6117
|
-
"name": "skipauth",
|
|
6118
|
-
"allowNo": false,
|
|
6119
|
-
"type": "boolean"
|
|
6120
|
-
},
|
|
6121
|
-
"target-org": {
|
|
6122
|
-
"aliases": [
|
|
6123
|
-
"targetusername",
|
|
6124
|
-
"u"
|
|
6125
|
-
],
|
|
6126
|
-
"char": "o",
|
|
6127
|
-
"deprecateAliases": true,
|
|
6128
|
-
"name": "target-org",
|
|
6129
|
-
"noCacheDefault": true,
|
|
6130
|
-
"required": true,
|
|
6131
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
6132
|
-
"hasDynamicHelp": true,
|
|
6133
|
-
"multiple": false,
|
|
6134
|
-
"type": "option"
|
|
6135
|
-
}
|
|
6136
|
-
},
|
|
6137
|
-
"hasDynamicHelp": true,
|
|
6138
|
-
"hiddenAliases": [],
|
|
6139
|
-
"id": "hardis:org:diagnose:legacyapi",
|
|
6140
|
-
"pluginAlias": "sfdx-hardis",
|
|
6141
|
-
"pluginName": "sfdx-hardis",
|
|
6142
|
-
"pluginType": "core",
|
|
6143
|
-
"strict": true,
|
|
6144
|
-
"enableJsonFlag": true,
|
|
6145
|
-
"title": "Check for legacy API use",
|
|
6146
|
-
"requiresProject": false,
|
|
6147
|
-
"isESM": true,
|
|
6148
|
-
"relativePath": [
|
|
6149
|
-
"lib",
|
|
6150
|
-
"commands",
|
|
6151
|
-
"hardis",
|
|
6152
|
-
"org",
|
|
6153
|
-
"diagnose",
|
|
6154
|
-
"legacyapi.js"
|
|
5885
|
+
"legacyapi.js"
|
|
6155
5886
|
],
|
|
6156
5887
|
"aliasPermutations": [],
|
|
6157
5888
|
"permutations": [
|
|
@@ -6533,7 +6264,7 @@
|
|
|
6533
6264
|
"hardis:org:diagnose:unused-apex-classes": {
|
|
6534
6265
|
"aliases": [],
|
|
6535
6266
|
"args": {},
|
|
6536
|
-
"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
|
|
6267
|
+
"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\n",
|
|
6537
6268
|
"examples": [
|
|
6538
6269
|
"$ sf hardis:org:diagnose:unused-apex-classes",
|
|
6539
6270
|
"$ sf hardis:org:diagnose:unused-apex-classes --days 700"
|
|
@@ -6787,7 +6518,7 @@
|
|
|
6787
6518
|
"hardis:org:diagnose:unusedlicenses": {
|
|
6788
6519
|
"aliases": [],
|
|
6789
6520
|
"args": {},
|
|
6790
|
-
"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
|
|
6521
|
+
"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",
|
|
6791
6522
|
"examples": [
|
|
6792
6523
|
"$ sf hardis:org:diagnose:unusedlicenses",
|
|
6793
6524
|
"$ sf hardis:org:diagnose:unusedlicenses --fix"
|
|
@@ -6960,30 +6691,299 @@
|
|
|
6960
6691
|
"multiple": false,
|
|
6961
6692
|
"type": "option"
|
|
6962
6693
|
},
|
|
6963
|
-
"licensetypes": {
|
|
6964
|
-
"char": "l",
|
|
6965
|
-
"description": "Type of licenses to check. If set, do not use licenseidentifiers option. In CI, default is all-crm",
|
|
6966
|
-
"name": "licensetypes",
|
|
6694
|
+
"licensetypes": {
|
|
6695
|
+
"char": "l",
|
|
6696
|
+
"description": "Type of licenses to check. If set, do not use licenseidentifiers option. In CI, default is all-crm",
|
|
6697
|
+
"name": "licensetypes",
|
|
6698
|
+
"hasDynamicHelp": false,
|
|
6699
|
+
"multiple": false,
|
|
6700
|
+
"options": [
|
|
6701
|
+
"all",
|
|
6702
|
+
"all-crm",
|
|
6703
|
+
"all-paying"
|
|
6704
|
+
],
|
|
6705
|
+
"type": "option"
|
|
6706
|
+
},
|
|
6707
|
+
"licenseidentifiers": {
|
|
6708
|
+
"char": "i",
|
|
6709
|
+
"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",
|
|
6710
|
+
"name": "licenseidentifiers",
|
|
6711
|
+
"hasDynamicHelp": false,
|
|
6712
|
+
"multiple": false,
|
|
6713
|
+
"type": "option"
|
|
6714
|
+
},
|
|
6715
|
+
"returnactiveusers": {
|
|
6716
|
+
"description": "Inverts the command by returning the active users",
|
|
6717
|
+
"name": "returnactiveusers",
|
|
6718
|
+
"allowNo": false,
|
|
6719
|
+
"type": "boolean"
|
|
6720
|
+
},
|
|
6721
|
+
"debug": {
|
|
6722
|
+
"char": "d",
|
|
6723
|
+
"description": "Activate debug mode (more logs)",
|
|
6724
|
+
"name": "debug",
|
|
6725
|
+
"allowNo": false,
|
|
6726
|
+
"type": "boolean"
|
|
6727
|
+
},
|
|
6728
|
+
"websocket": {
|
|
6729
|
+
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
6730
|
+
"name": "websocket",
|
|
6731
|
+
"hasDynamicHelp": false,
|
|
6732
|
+
"multiple": false,
|
|
6733
|
+
"type": "option"
|
|
6734
|
+
},
|
|
6735
|
+
"skipauth": {
|
|
6736
|
+
"description": "Skip authentication check when a default username is required",
|
|
6737
|
+
"name": "skipauth",
|
|
6738
|
+
"allowNo": false,
|
|
6739
|
+
"type": "boolean"
|
|
6740
|
+
},
|
|
6741
|
+
"target-org": {
|
|
6742
|
+
"aliases": [
|
|
6743
|
+
"targetusername",
|
|
6744
|
+
"u"
|
|
6745
|
+
],
|
|
6746
|
+
"char": "o",
|
|
6747
|
+
"deprecateAliases": true,
|
|
6748
|
+
"name": "target-org",
|
|
6749
|
+
"noCacheDefault": true,
|
|
6750
|
+
"required": true,
|
|
6751
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
6752
|
+
"hasDynamicHelp": true,
|
|
6753
|
+
"multiple": false,
|
|
6754
|
+
"type": "option"
|
|
6755
|
+
}
|
|
6756
|
+
},
|
|
6757
|
+
"hasDynamicHelp": true,
|
|
6758
|
+
"hiddenAliases": [],
|
|
6759
|
+
"id": "hardis:org:diagnose:unusedusers",
|
|
6760
|
+
"pluginAlias": "sfdx-hardis",
|
|
6761
|
+
"pluginName": "sfdx-hardis",
|
|
6762
|
+
"pluginType": "core",
|
|
6763
|
+
"strict": true,
|
|
6764
|
+
"enableJsonFlag": true,
|
|
6765
|
+
"title": "Detect unused Users in Salesforce",
|
|
6766
|
+
"requiresProject": false,
|
|
6767
|
+
"isESM": true,
|
|
6768
|
+
"relativePath": [
|
|
6769
|
+
"lib",
|
|
6770
|
+
"commands",
|
|
6771
|
+
"hardis",
|
|
6772
|
+
"org",
|
|
6773
|
+
"diagnose",
|
|
6774
|
+
"unusedusers.js"
|
|
6775
|
+
],
|
|
6776
|
+
"aliasPermutations": [],
|
|
6777
|
+
"permutations": [
|
|
6778
|
+
"hardis:org:diagnose:unusedusers",
|
|
6779
|
+
"org:hardis:diagnose:unusedusers",
|
|
6780
|
+
"org:diagnose:hardis:unusedusers",
|
|
6781
|
+
"org:diagnose:unusedusers:hardis",
|
|
6782
|
+
"hardis:diagnose:org:unusedusers",
|
|
6783
|
+
"diagnose:hardis:org:unusedusers",
|
|
6784
|
+
"diagnose:org:hardis:unusedusers",
|
|
6785
|
+
"diagnose:org:unusedusers:hardis",
|
|
6786
|
+
"hardis:diagnose:unusedusers:org",
|
|
6787
|
+
"diagnose:hardis:unusedusers:org",
|
|
6788
|
+
"diagnose:unusedusers:hardis:org",
|
|
6789
|
+
"diagnose:unusedusers:org:hardis",
|
|
6790
|
+
"hardis:org:unusedusers:diagnose",
|
|
6791
|
+
"org:hardis:unusedusers:diagnose",
|
|
6792
|
+
"org:unusedusers:hardis:diagnose",
|
|
6793
|
+
"org:unusedusers:diagnose:hardis",
|
|
6794
|
+
"hardis:unusedusers:org:diagnose",
|
|
6795
|
+
"unusedusers:hardis:org:diagnose",
|
|
6796
|
+
"unusedusers:org:hardis:diagnose",
|
|
6797
|
+
"unusedusers:org:diagnose:hardis",
|
|
6798
|
+
"hardis:unusedusers:diagnose:org",
|
|
6799
|
+
"unusedusers:hardis:diagnose:org",
|
|
6800
|
+
"unusedusers:diagnose:hardis:org",
|
|
6801
|
+
"unusedusers:diagnose:org:hardis"
|
|
6802
|
+
]
|
|
6803
|
+
},
|
|
6804
|
+
"hardis:org:files:export": {
|
|
6805
|
+
"aliases": [],
|
|
6806
|
+
"args": {},
|
|
6807
|
+
"description": "\n## Command Behavior\n\n**Exports file attachments (ContentVersion, Attachment) from a Salesforce org based on a predefined configuration.**\n\nThis command enables the mass download of files associated with Salesforce records, providing a robust solution for backing up files, migrating them to other systems, or integrating them with external document management solutions.\n\nKey functionalities:\n\n- **Configuration-Driven Export:** Relies on an `export.json` file within a designated file export project to define the export criteria, including the SOQL query for parent records, file types to export, output naming conventions, and file size filtering.\n- **File Size Filtering:** Supports minimum file size filtering via the `fileSizeMin` configuration parameter (in KB). Files smaller than the specified size will be skipped during export.\n- **File Validation:** After downloading each file, validates the integrity by:\n - **Checksum Validation:** For ContentVersion files, compares MD5 checksum with Salesforce's stored checksum\n - **Size Validation:** For both ContentVersion and Attachment files, verifies actual file size matches expected size\n - **Status Tracking:** Files are categorized with specific statuses: `success` (valid files), `failed` (download errors), `skipped` (filtered files), `invalid` (downloaded but failed validation)\n - All validation results are logged in the CSV export log for audit purposes\n- **Resume/Restart Capability:** \n - **Resume Mode:** When `--resume` flag is used (default in CI environments), checks existing downloaded files for validity. Valid files are skipped, invalid files are re-downloaded.\n - **Restart Mode:** When resume is disabled, clears the output folder and starts a fresh export.\n - **Interactive Mode:** When existing files are found and `--resume` is not explicitly specified (non-CI environments), prompts the user to choose between resume or restart.\n- **Interactive Project Selection:** If the file export project path is not provided via the `--path` flag, it interactively prompts the user to select one.\n- **Configurable Export Options:** Allows overriding default export settings such as `chunksize` (number of records processed in a batch), `polltimeout` (timeout for Bulk API calls), and `startchunknumber` (to resume a failed export).\n- **Support for ContentVersion and Attachment:** Handles both modern Salesforce Files (ContentVersion) and older Attachments.\n\nSee this article for a practical example:\n\n[](https://nicolas.vuillamy.fr/how-to-mass-download-notes-and-attachments-files-from-a-salesforce-org-83a028824afd)\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **FilesExporter Class:** The core logic is encapsulated within the `FilesExporter` class, which orchestrates the entire export process.\n- **SOQL Queries (Bulk API):** It uses Salesforce Bulk API queries to efficiently retrieve large volumes of parent record IDs and file metadata, including checksums and file sizes.\n- **File Download:** Downloads the actual file content from Salesforce.\n- **File Validation:** After each successful download, validates file integrity by comparing checksums (ContentVersion) and file sizes (both ContentVersion and Attachment) against Salesforce metadata.\n- **Resume Logic:** In resume mode, checks for existing files before downloading, validates their integrity, and only re-downloads invalid or missing files. This enables efficient recovery from interrupted exports.\n- **File System Operations:** Writes the downloaded files to the local file system, organizing them into folders based on the configured naming conventions.\n- **Configuration Loading:** Reads the `export.json` file to get the export configuration. It also allows for interactive overriding of these settings.\n- **Interactive Prompts:** Uses `selectFilesWorkspace` to allow the user to choose a file export project, `promptFilesExportConfiguration` for customizing export options, and prompts for resume/restart choice when existing files are found.\n- **Error Handling:** Includes mechanisms to handle potential errors during the export process, such as network issues, API limits, and file validation failures. Each file is assigned a specific status (`success`, `failed`, `skipped`, `invalid`) for comprehensive tracking and troubleshooting.\n</details>\n",
|
|
6808
|
+
"examples": [
|
|
6809
|
+
"$ sf hardis:org:files:export"
|
|
6810
|
+
],
|
|
6811
|
+
"flags": {
|
|
6812
|
+
"json": {
|
|
6813
|
+
"description": "Format output as json.",
|
|
6814
|
+
"helpGroup": "GLOBAL",
|
|
6815
|
+
"name": "json",
|
|
6816
|
+
"allowNo": false,
|
|
6817
|
+
"type": "boolean"
|
|
6818
|
+
},
|
|
6819
|
+
"flags-dir": {
|
|
6820
|
+
"helpGroup": "GLOBAL",
|
|
6821
|
+
"name": "flags-dir",
|
|
6822
|
+
"summary": "Import flag values from a directory.",
|
|
6823
|
+
"hasDynamicHelp": false,
|
|
6824
|
+
"multiple": false,
|
|
6825
|
+
"type": "option"
|
|
6826
|
+
},
|
|
6827
|
+
"path": {
|
|
6828
|
+
"char": "p",
|
|
6829
|
+
"description": "Path to the file export project",
|
|
6830
|
+
"name": "path",
|
|
6831
|
+
"hasDynamicHelp": false,
|
|
6832
|
+
"multiple": false,
|
|
6833
|
+
"type": "option"
|
|
6834
|
+
},
|
|
6835
|
+
"chunksize": {
|
|
6836
|
+
"char": "c",
|
|
6837
|
+
"description": "Number of records to add in a chunk before it is processed",
|
|
6838
|
+
"name": "chunksize",
|
|
6839
|
+
"default": 1000,
|
|
6840
|
+
"hasDynamicHelp": false,
|
|
6841
|
+
"multiple": false,
|
|
6842
|
+
"type": "option"
|
|
6843
|
+
},
|
|
6844
|
+
"polltimeout": {
|
|
6845
|
+
"char": "t",
|
|
6846
|
+
"description": "Timeout in MS for Bulk API calls",
|
|
6847
|
+
"name": "polltimeout",
|
|
6848
|
+
"default": 300000,
|
|
6849
|
+
"hasDynamicHelp": false,
|
|
6850
|
+
"multiple": false,
|
|
6851
|
+
"type": "option"
|
|
6852
|
+
},
|
|
6853
|
+
"startchunknumber": {
|
|
6854
|
+
"char": "s",
|
|
6855
|
+
"description": "Chunk number to start from",
|
|
6856
|
+
"name": "startchunknumber",
|
|
6857
|
+
"default": 0,
|
|
6858
|
+
"hasDynamicHelp": false,
|
|
6859
|
+
"multiple": false,
|
|
6860
|
+
"type": "option"
|
|
6861
|
+
},
|
|
6862
|
+
"resume": {
|
|
6863
|
+
"char": "r",
|
|
6864
|
+
"description": "Resume previous export by checking existing files (default in CI)",
|
|
6865
|
+
"name": "resume",
|
|
6866
|
+
"allowNo": false,
|
|
6867
|
+
"type": "boolean"
|
|
6868
|
+
},
|
|
6869
|
+
"debug": {
|
|
6870
|
+
"char": "d",
|
|
6871
|
+
"description": "Activate debug mode (more logs)",
|
|
6872
|
+
"name": "debug",
|
|
6873
|
+
"allowNo": false,
|
|
6874
|
+
"type": "boolean"
|
|
6875
|
+
},
|
|
6876
|
+
"websocket": {
|
|
6877
|
+
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
6878
|
+
"name": "websocket",
|
|
6879
|
+
"hasDynamicHelp": false,
|
|
6880
|
+
"multiple": false,
|
|
6881
|
+
"type": "option"
|
|
6882
|
+
},
|
|
6883
|
+
"skipauth": {
|
|
6884
|
+
"description": "Skip authentication check when a default username is required",
|
|
6885
|
+
"name": "skipauth",
|
|
6886
|
+
"allowNo": false,
|
|
6887
|
+
"type": "boolean"
|
|
6888
|
+
},
|
|
6889
|
+
"target-org": {
|
|
6890
|
+
"aliases": [
|
|
6891
|
+
"targetusername",
|
|
6892
|
+
"u"
|
|
6893
|
+
],
|
|
6894
|
+
"char": "o",
|
|
6895
|
+
"deprecateAliases": true,
|
|
6896
|
+
"name": "target-org",
|
|
6897
|
+
"noCacheDefault": true,
|
|
6898
|
+
"required": true,
|
|
6899
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
6900
|
+
"hasDynamicHelp": true,
|
|
6901
|
+
"multiple": false,
|
|
6902
|
+
"type": "option"
|
|
6903
|
+
}
|
|
6904
|
+
},
|
|
6905
|
+
"hasDynamicHelp": true,
|
|
6906
|
+
"hiddenAliases": [],
|
|
6907
|
+
"id": "hardis:org:files:export",
|
|
6908
|
+
"pluginAlias": "sfdx-hardis",
|
|
6909
|
+
"pluginName": "sfdx-hardis",
|
|
6910
|
+
"pluginType": "core",
|
|
6911
|
+
"strict": true,
|
|
6912
|
+
"enableJsonFlag": true,
|
|
6913
|
+
"title": "Export files",
|
|
6914
|
+
"requiresProject": false,
|
|
6915
|
+
"isESM": true,
|
|
6916
|
+
"relativePath": [
|
|
6917
|
+
"lib",
|
|
6918
|
+
"commands",
|
|
6919
|
+
"hardis",
|
|
6920
|
+
"org",
|
|
6921
|
+
"files",
|
|
6922
|
+
"export.js"
|
|
6923
|
+
],
|
|
6924
|
+
"aliasPermutations": [],
|
|
6925
|
+
"permutations": [
|
|
6926
|
+
"hardis:org:files:export",
|
|
6927
|
+
"org:hardis:files:export",
|
|
6928
|
+
"org:files:hardis:export",
|
|
6929
|
+
"org:files:export:hardis",
|
|
6930
|
+
"hardis:files:org:export",
|
|
6931
|
+
"files:hardis:org:export",
|
|
6932
|
+
"files:org:hardis:export",
|
|
6933
|
+
"files:org:export:hardis",
|
|
6934
|
+
"hardis:files:export:org",
|
|
6935
|
+
"files:hardis:export:org",
|
|
6936
|
+
"files:export:hardis:org",
|
|
6937
|
+
"files:export:org:hardis",
|
|
6938
|
+
"hardis:org:export:files",
|
|
6939
|
+
"org:hardis:export:files",
|
|
6940
|
+
"org:export:hardis:files",
|
|
6941
|
+
"org:export:files:hardis",
|
|
6942
|
+
"hardis:export:org:files",
|
|
6943
|
+
"export:hardis:org:files",
|
|
6944
|
+
"export:org:hardis:files",
|
|
6945
|
+
"export:org:files:hardis",
|
|
6946
|
+
"hardis:export:files:org",
|
|
6947
|
+
"export:hardis:files:org",
|
|
6948
|
+
"export:files:hardis:org",
|
|
6949
|
+
"export:files:org:hardis"
|
|
6950
|
+
]
|
|
6951
|
+
},
|
|
6952
|
+
"hardis:org:files:import": {
|
|
6953
|
+
"aliases": [],
|
|
6954
|
+
"args": {},
|
|
6955
|
+
"description": "\nThis command facilitates the mass upload of files into Salesforce, allowing you to populate records with associated documents, images, or other file types. It's a crucial tool for data migration, content seeding, or synchronizing external file repositories with Salesforce.\n\nKey functionalities:\n\n- **Configuration-Driven Import:** Relies on an `export.json` file within a designated file export project (created using `sf hardis:org:configure:files`) to determine which files to import and how they should be associated with Salesforce records.\n- **Interactive Project Selection:** If the file import project path is not provided via the `--path` flag, it interactively prompts the user to select one.\n- **Overwrite Option:** The `--overwrite` flag allows you to replace existing files in Salesforce with local versions that have the same name. Be aware that this option doubles the number of API calls used.\n- **Support for ContentVersion and Attachment:** Handles both modern Salesforce Files (ContentVersion) and older Attachments.\n\nSee this article for how to export files, which is often a prerequisite for importing:\n\n[](https://nicolas.vuillamy.fr/how-to-mass-download-notes-and-attachments-files-from-a-salesforce-org-83a028824afd)\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **FilesImporter Class:** The core logic is encapsulated within the `FilesImporter` class, which orchestrates the entire import process.\n- **File System Scan:** Scans the local file system within the configured project directory to identify files for import.\n- **Salesforce API Interaction:** Uses Salesforce APIs (e.g., ContentVersion, Attachment) to upload files and associate them with records.\n- **Configuration Loading:** Reads the `export.json` file to get the import configuration, including SOQL queries to identify parent records for file association.\n- **Interactive Prompts:** Uses `selectFilesWorkspace` to allow the user to choose a file import project and `prompts` for confirming the overwrite behavior.\n- **Error Handling:** Includes mechanisms to handle potential errors during the import process, such as API limits or file upload failures.\n</details>\n",
|
|
6956
|
+
"examples": [
|
|
6957
|
+
"$ sf hardis:org:files:import"
|
|
6958
|
+
],
|
|
6959
|
+
"flags": {
|
|
6960
|
+
"json": {
|
|
6961
|
+
"description": "Format output as json.",
|
|
6962
|
+
"helpGroup": "GLOBAL",
|
|
6963
|
+
"name": "json",
|
|
6964
|
+
"allowNo": false,
|
|
6965
|
+
"type": "boolean"
|
|
6966
|
+
},
|
|
6967
|
+
"flags-dir": {
|
|
6968
|
+
"helpGroup": "GLOBAL",
|
|
6969
|
+
"name": "flags-dir",
|
|
6970
|
+
"summary": "Import flag values from a directory.",
|
|
6967
6971
|
"hasDynamicHelp": false,
|
|
6968
6972
|
"multiple": false,
|
|
6969
|
-
"options": [
|
|
6970
|
-
"all",
|
|
6971
|
-
"all-crm",
|
|
6972
|
-
"all-paying"
|
|
6973
|
-
],
|
|
6974
6973
|
"type": "option"
|
|
6975
6974
|
},
|
|
6976
|
-
"
|
|
6977
|
-
"char": "
|
|
6978
|
-
"description": "
|
|
6979
|
-
"name": "
|
|
6975
|
+
"path": {
|
|
6976
|
+
"char": "p",
|
|
6977
|
+
"description": "Path to the file export project",
|
|
6978
|
+
"name": "path",
|
|
6980
6979
|
"hasDynamicHelp": false,
|
|
6981
6980
|
"multiple": false,
|
|
6982
6981
|
"type": "option"
|
|
6983
6982
|
},
|
|
6984
|
-
"
|
|
6985
|
-
"
|
|
6986
|
-
"
|
|
6983
|
+
"overwrite": {
|
|
6984
|
+
"char": "f",
|
|
6985
|
+
"description": "Override existing files (doubles the number of API calls)",
|
|
6986
|
+
"name": "overwrite",
|
|
6987
6987
|
"allowNo": false,
|
|
6988
6988
|
"type": "boolean"
|
|
6989
6989
|
},
|
|
@@ -7025,13 +7025,13 @@
|
|
|
7025
7025
|
},
|
|
7026
7026
|
"hasDynamicHelp": true,
|
|
7027
7027
|
"hiddenAliases": [],
|
|
7028
|
-
"id": "hardis:org:
|
|
7028
|
+
"id": "hardis:org:files:import",
|
|
7029
7029
|
"pluginAlias": "sfdx-hardis",
|
|
7030
7030
|
"pluginName": "sfdx-hardis",
|
|
7031
7031
|
"pluginType": "core",
|
|
7032
7032
|
"strict": true,
|
|
7033
7033
|
"enableJsonFlag": true,
|
|
7034
|
-
"title": "
|
|
7034
|
+
"title": "Import files",
|
|
7035
7035
|
"requiresProject": false,
|
|
7036
7036
|
"isESM": true,
|
|
7037
7037
|
"relativePath": [
|
|
@@ -7039,35 +7039,35 @@
|
|
|
7039
7039
|
"commands",
|
|
7040
7040
|
"hardis",
|
|
7041
7041
|
"org",
|
|
7042
|
-
"
|
|
7043
|
-
"
|
|
7042
|
+
"files",
|
|
7043
|
+
"import.js"
|
|
7044
7044
|
],
|
|
7045
7045
|
"aliasPermutations": [],
|
|
7046
7046
|
"permutations": [
|
|
7047
|
-
"hardis:org:
|
|
7048
|
-
"org:hardis:
|
|
7049
|
-
"org:
|
|
7050
|
-
"org:
|
|
7051
|
-
"hardis:
|
|
7052
|
-
"
|
|
7053
|
-
"
|
|
7054
|
-
"
|
|
7055
|
-
"hardis:
|
|
7056
|
-
"
|
|
7057
|
-
"
|
|
7058
|
-
"
|
|
7059
|
-
"hardis:org:
|
|
7060
|
-
"org:hardis:
|
|
7061
|
-
"org:
|
|
7062
|
-
"org:
|
|
7063
|
-
"hardis:
|
|
7064
|
-
"
|
|
7065
|
-
"
|
|
7066
|
-
"
|
|
7067
|
-
"hardis:
|
|
7068
|
-
"
|
|
7069
|
-
"
|
|
7070
|
-
"
|
|
7047
|
+
"hardis:org:files:import",
|
|
7048
|
+
"org:hardis:files:import",
|
|
7049
|
+
"org:files:hardis:import",
|
|
7050
|
+
"org:files:import:hardis",
|
|
7051
|
+
"hardis:files:org:import",
|
|
7052
|
+
"files:hardis:org:import",
|
|
7053
|
+
"files:org:hardis:import",
|
|
7054
|
+
"files:org:import:hardis",
|
|
7055
|
+
"hardis:files:import:org",
|
|
7056
|
+
"files:hardis:import:org",
|
|
7057
|
+
"files:import:hardis:org",
|
|
7058
|
+
"files:import:org:hardis",
|
|
7059
|
+
"hardis:org:import:files",
|
|
7060
|
+
"org:hardis:import:files",
|
|
7061
|
+
"org:import:hardis:files",
|
|
7062
|
+
"org:import:files:hardis",
|
|
7063
|
+
"hardis:import:org:files",
|
|
7064
|
+
"import:hardis:org:files",
|
|
7065
|
+
"import:org:hardis:files",
|
|
7066
|
+
"import:org:files:hardis",
|
|
7067
|
+
"hardis:import:files:org",
|
|
7068
|
+
"import:hardis:files:org",
|
|
7069
|
+
"import:files:hardis:org",
|
|
7070
|
+
"import:files:org:hardis"
|
|
7071
7071
|
]
|
|
7072
7072
|
},
|
|
7073
7073
|
"hardis:org:fix:listviewmine": {
|
|
@@ -8111,7 +8111,7 @@
|
|
|
8111
8111
|
"type": "boolean"
|
|
8112
8112
|
},
|
|
8113
8113
|
"websocket": {
|
|
8114
|
-
"description": "
|
|
8114
|
+
"description": "WebSocket host:port for VS Code SFDX Hardis UI integration",
|
|
8115
8115
|
"name": "websocket",
|
|
8116
8116
|
"summary": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
8117
8117
|
"hasDynamicHelp": false,
|
|
@@ -8295,12 +8295,13 @@
|
|
|
8295
8295
|
"before-refresh:refresh:org:hardis"
|
|
8296
8296
|
]
|
|
8297
8297
|
},
|
|
8298
|
-
"hardis:org:
|
|
8298
|
+
"hardis:org:retrieve:packageconfig": {
|
|
8299
8299
|
"aliases": [],
|
|
8300
8300
|
"args": {},
|
|
8301
|
-
"description": "
|
|
8301
|
+
"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",
|
|
8302
8302
|
"examples": [
|
|
8303
|
-
"$ sf hardis:org:
|
|
8303
|
+
"$ sf hardis:org:retrieve:packageconfig",
|
|
8304
|
+
"sf hardis:org:retrieve:packageconfig -u myOrg"
|
|
8304
8305
|
],
|
|
8305
8306
|
"flags": {
|
|
8306
8307
|
"json": {
|
|
@@ -8318,21 +8319,6 @@
|
|
|
8318
8319
|
"multiple": false,
|
|
8319
8320
|
"type": "option"
|
|
8320
8321
|
},
|
|
8321
|
-
"testlevel": {
|
|
8322
|
-
"char": "l",
|
|
8323
|
-
"description": "Level of tests to apply to validate deployment",
|
|
8324
|
-
"name": "testlevel",
|
|
8325
|
-
"default": "RunLocalTests",
|
|
8326
|
-
"hasDynamicHelp": false,
|
|
8327
|
-
"multiple": false,
|
|
8328
|
-
"options": [
|
|
8329
|
-
"NoTestRun",
|
|
8330
|
-
"RunSpecifiedTests",
|
|
8331
|
-
"RunLocalTests",
|
|
8332
|
-
"RunAllTestsInOrg"
|
|
8333
|
-
],
|
|
8334
|
-
"type": "option"
|
|
8335
|
-
},
|
|
8336
8322
|
"debug": {
|
|
8337
8323
|
"char": "d",
|
|
8338
8324
|
"description": "Activate debug mode (more logs)",
|
|
@@ -8371,57 +8357,57 @@
|
|
|
8371
8357
|
},
|
|
8372
8358
|
"hasDynamicHelp": true,
|
|
8373
8359
|
"hiddenAliases": [],
|
|
8374
|
-
"id": "hardis:org:
|
|
8360
|
+
"id": "hardis:org:retrieve:packageconfig",
|
|
8375
8361
|
"pluginAlias": "sfdx-hardis",
|
|
8376
8362
|
"pluginName": "sfdx-hardis",
|
|
8377
8363
|
"pluginType": "core",
|
|
8378
8364
|
"strict": true,
|
|
8379
8365
|
"enableJsonFlag": true,
|
|
8380
|
-
"title": "
|
|
8366
|
+
"title": "Retrieve package configuration from an org",
|
|
8367
|
+
"requiresProject": false,
|
|
8381
8368
|
"isESM": true,
|
|
8382
8369
|
"relativePath": [
|
|
8383
8370
|
"lib",
|
|
8384
8371
|
"commands",
|
|
8385
8372
|
"hardis",
|
|
8386
8373
|
"org",
|
|
8387
|
-
"
|
|
8388
|
-
"
|
|
8374
|
+
"retrieve",
|
|
8375
|
+
"packageconfig.js"
|
|
8389
8376
|
],
|
|
8390
8377
|
"aliasPermutations": [],
|
|
8391
8378
|
"permutations": [
|
|
8392
|
-
"hardis:org:
|
|
8393
|
-
"org:hardis:
|
|
8394
|
-
"org:
|
|
8395
|
-
"org:
|
|
8396
|
-
"hardis:
|
|
8397
|
-
"
|
|
8398
|
-
"
|
|
8399
|
-
"
|
|
8400
|
-
"hardis:
|
|
8401
|
-
"
|
|
8402
|
-
"
|
|
8403
|
-
"
|
|
8404
|
-
"hardis:org:
|
|
8405
|
-
"org:hardis:
|
|
8406
|
-
"org:
|
|
8407
|
-
"org:
|
|
8408
|
-
"hardis:
|
|
8409
|
-
"
|
|
8410
|
-
"
|
|
8411
|
-
"
|
|
8412
|
-
"hardis:
|
|
8413
|
-
"
|
|
8414
|
-
"
|
|
8415
|
-
"
|
|
8379
|
+
"hardis:org:retrieve:packageconfig",
|
|
8380
|
+
"org:hardis:retrieve:packageconfig",
|
|
8381
|
+
"org:retrieve:hardis:packageconfig",
|
|
8382
|
+
"org:retrieve:packageconfig:hardis",
|
|
8383
|
+
"hardis:retrieve:org:packageconfig",
|
|
8384
|
+
"retrieve:hardis:org:packageconfig",
|
|
8385
|
+
"retrieve:org:hardis:packageconfig",
|
|
8386
|
+
"retrieve:org:packageconfig:hardis",
|
|
8387
|
+
"hardis:retrieve:packageconfig:org",
|
|
8388
|
+
"retrieve:hardis:packageconfig:org",
|
|
8389
|
+
"retrieve:packageconfig:hardis:org",
|
|
8390
|
+
"retrieve:packageconfig:org:hardis",
|
|
8391
|
+
"hardis:org:packageconfig:retrieve",
|
|
8392
|
+
"org:hardis:packageconfig:retrieve",
|
|
8393
|
+
"org:packageconfig:hardis:retrieve",
|
|
8394
|
+
"org:packageconfig:retrieve:hardis",
|
|
8395
|
+
"hardis:packageconfig:org:retrieve",
|
|
8396
|
+
"packageconfig:hardis:org:retrieve",
|
|
8397
|
+
"packageconfig:org:hardis:retrieve",
|
|
8398
|
+
"packageconfig:org:retrieve:hardis",
|
|
8399
|
+
"hardis:packageconfig:retrieve:org",
|
|
8400
|
+
"packageconfig:hardis:retrieve:org",
|
|
8401
|
+
"packageconfig:retrieve:hardis:org",
|
|
8402
|
+
"packageconfig:retrieve:org:hardis"
|
|
8416
8403
|
]
|
|
8417
8404
|
},
|
|
8418
|
-
"hardis:org:
|
|
8405
|
+
"hardis:org:test:apex": {
|
|
8419
8406
|
"aliases": [],
|
|
8420
8407
|
"args": {},
|
|
8421
|
-
"description": "
|
|
8408
|
+
"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 60 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",
|
|
8422
8409
|
"examples": [
|
|
8423
|
-
"$ sf hardis:org:
|
|
8424
|
-
"sf hardis:org:retrieve:packageconfig -u myOrg"
|
|
8410
|
+
"$ sf hardis:org:test:apex"
|
|
8425
8411
|
],
|
|
8426
8412
|
"flags": {
|
|
8427
8413
|
"json": {
|
|
@@ -8439,6 +8425,21 @@
|
|
|
8439
8425
|
"multiple": false,
|
|
8440
8426
|
"type": "option"
|
|
8441
8427
|
},
|
|
8428
|
+
"testlevel": {
|
|
8429
|
+
"char": "l",
|
|
8430
|
+
"description": "Level of tests to apply to validate deployment",
|
|
8431
|
+
"name": "testlevel",
|
|
8432
|
+
"default": "RunLocalTests",
|
|
8433
|
+
"hasDynamicHelp": false,
|
|
8434
|
+
"multiple": false,
|
|
8435
|
+
"options": [
|
|
8436
|
+
"NoTestRun",
|
|
8437
|
+
"RunSpecifiedTests",
|
|
8438
|
+
"RunLocalTests",
|
|
8439
|
+
"RunAllTestsInOrg"
|
|
8440
|
+
],
|
|
8441
|
+
"type": "option"
|
|
8442
|
+
},
|
|
8442
8443
|
"debug": {
|
|
8443
8444
|
"char": "d",
|
|
8444
8445
|
"description": "Activate debug mode (more logs)",
|
|
@@ -8477,49 +8478,48 @@
|
|
|
8477
8478
|
},
|
|
8478
8479
|
"hasDynamicHelp": true,
|
|
8479
8480
|
"hiddenAliases": [],
|
|
8480
|
-
"id": "hardis:org:
|
|
8481
|
+
"id": "hardis:org:test:apex",
|
|
8481
8482
|
"pluginAlias": "sfdx-hardis",
|
|
8482
8483
|
"pluginName": "sfdx-hardis",
|
|
8483
8484
|
"pluginType": "core",
|
|
8484
8485
|
"strict": true,
|
|
8485
8486
|
"enableJsonFlag": true,
|
|
8486
|
-
"title": "
|
|
8487
|
-
"requiresProject": false,
|
|
8487
|
+
"title": "Run apex tests",
|
|
8488
8488
|
"isESM": true,
|
|
8489
8489
|
"relativePath": [
|
|
8490
8490
|
"lib",
|
|
8491
8491
|
"commands",
|
|
8492
8492
|
"hardis",
|
|
8493
8493
|
"org",
|
|
8494
|
-
"
|
|
8495
|
-
"
|
|
8494
|
+
"test",
|
|
8495
|
+
"apex.js"
|
|
8496
8496
|
],
|
|
8497
8497
|
"aliasPermutations": [],
|
|
8498
8498
|
"permutations": [
|
|
8499
|
-
"hardis:org:
|
|
8500
|
-
"org:hardis:
|
|
8501
|
-
"org:
|
|
8502
|
-
"org:
|
|
8503
|
-
"hardis:
|
|
8504
|
-
"
|
|
8505
|
-
"
|
|
8506
|
-
"
|
|
8507
|
-
"hardis:
|
|
8508
|
-
"
|
|
8509
|
-
"
|
|
8510
|
-
"
|
|
8511
|
-
"hardis:org:
|
|
8512
|
-
"org:hardis:
|
|
8513
|
-
"org:
|
|
8514
|
-
"org:
|
|
8515
|
-
"hardis:
|
|
8516
|
-
"
|
|
8517
|
-
"
|
|
8518
|
-
"
|
|
8519
|
-
"hardis:
|
|
8520
|
-
"
|
|
8521
|
-
"
|
|
8522
|
-
"
|
|
8499
|
+
"hardis:org:test:apex",
|
|
8500
|
+
"org:hardis:test:apex",
|
|
8501
|
+
"org:test:hardis:apex",
|
|
8502
|
+
"org:test:apex:hardis",
|
|
8503
|
+
"hardis:test:org:apex",
|
|
8504
|
+
"test:hardis:org:apex",
|
|
8505
|
+
"test:org:hardis:apex",
|
|
8506
|
+
"test:org:apex:hardis",
|
|
8507
|
+
"hardis:test:apex:org",
|
|
8508
|
+
"test:hardis:apex:org",
|
|
8509
|
+
"test:apex:hardis:org",
|
|
8510
|
+
"test:apex:org:hardis",
|
|
8511
|
+
"hardis:org:apex:test",
|
|
8512
|
+
"org:hardis:apex:test",
|
|
8513
|
+
"org:apex:hardis:test",
|
|
8514
|
+
"org:apex:test:hardis",
|
|
8515
|
+
"hardis:apex:org:test",
|
|
8516
|
+
"apex:hardis:org:test",
|
|
8517
|
+
"apex:org:hardis:test",
|
|
8518
|
+
"apex:org:test:hardis",
|
|
8519
|
+
"hardis:apex:test:org",
|
|
8520
|
+
"apex:hardis:test:org",
|
|
8521
|
+
"apex:test:hardis:org",
|
|
8522
|
+
"apex:test:org:hardis"
|
|
8523
8523
|
]
|
|
8524
8524
|
},
|
|
8525
8525
|
"hardis:org:user:activateinvalid": {
|
|
@@ -11363,262 +11363,47 @@
|
|
|
11363
11363
|
"pluginName": "sfdx-hardis",
|
|
11364
11364
|
"pluginType": "core",
|
|
11365
11365
|
"strict": true,
|
|
11366
|
-
"enableJsonFlag": true,
|
|
11367
|
-
"title": "Convert Profiles into Permission Sets",
|
|
11368
|
-
"requiresProject": true,
|
|
11369
|
-
"requiresSfdxPlugins": [
|
|
11370
|
-
"shane-sfdx-plugins"
|
|
11371
|
-
],
|
|
11372
|
-
"isESM": true,
|
|
11373
|
-
"relativePath": [
|
|
11374
|
-
"lib",
|
|
11375
|
-
"commands",
|
|
11376
|
-
"hardis",
|
|
11377
|
-
"project",
|
|
11378
|
-
"convert",
|
|
11379
|
-
"profilestopermsets.js"
|
|
11380
|
-
],
|
|
11381
|
-
"aliasPermutations": [],
|
|
11382
|
-
"permutations": [
|
|
11383
|
-
"hardis:project:convert:profilestopermsets",
|
|
11384
|
-
"project:hardis:convert:profilestopermsets",
|
|
11385
|
-
"project:convert:hardis:profilestopermsets",
|
|
11386
|
-
"project:convert:profilestopermsets:hardis",
|
|
11387
|
-
"hardis:convert:project:profilestopermsets",
|
|
11388
|
-
"convert:hardis:project:profilestopermsets",
|
|
11389
|
-
"convert:project:hardis:profilestopermsets",
|
|
11390
|
-
"convert:project:profilestopermsets:hardis",
|
|
11391
|
-
"hardis:convert:profilestopermsets:project",
|
|
11392
|
-
"convert:hardis:profilestopermsets:project",
|
|
11393
|
-
"convert:profilestopermsets:hardis:project",
|
|
11394
|
-
"convert:profilestopermsets:project:hardis",
|
|
11395
|
-
"hardis:project:profilestopermsets:convert",
|
|
11396
|
-
"project:hardis:profilestopermsets:convert",
|
|
11397
|
-
"project:profilestopermsets:hardis:convert",
|
|
11398
|
-
"project:profilestopermsets:convert:hardis",
|
|
11399
|
-
"hardis:profilestopermsets:project:convert",
|
|
11400
|
-
"profilestopermsets:hardis:project:convert",
|
|
11401
|
-
"profilestopermsets:project:hardis:convert",
|
|
11402
|
-
"profilestopermsets:project:convert:hardis",
|
|
11403
|
-
"hardis:profilestopermsets:convert:project",
|
|
11404
|
-
"profilestopermsets:hardis:convert:project",
|
|
11405
|
-
"profilestopermsets:convert:hardis:project",
|
|
11406
|
-
"profilestopermsets:convert:project:hardis"
|
|
11407
|
-
]
|
|
11408
|
-
},
|
|
11409
|
-
"hardis:project:fix:profiletabs": {
|
|
11410
|
-
"aliases": [],
|
|
11411
|
-
"args": {},
|
|
11412
|
-
"description": "\n## Command Behavior\n\n**Interactively updates tab visibility settings in Salesforce profiles, addressing a common issue where tab visibilities are not correctly retrieved by `sf project retrieve start`.**\n\nThis command provides a user-friendly interface to manage tab settings within your profile XML files, ensuring that your local project accurately reflects the intended tab configurations in your Salesforce org.\n\nKey functionalities:\n\n- **Interactive Tab Selection:** Displays a multi-select menu of all available tabs in your org, allowing you to choose which tabs to update.\n- **Visibility Control:** Lets you set the visibility for the selected tabs to either `DefaultOn` (Visible) or `Hidden`.\n- **Profile Selection:** Presents a multi-select menu of all .profile-meta.xml files in your project, allowing you to apply the tab visibility changes to specific profiles.\n- **XML Updates:** Modifies the <tabVisibilities> section of the selected profile XML files to reflect the chosen tab settings. If a tab visibility setting already exists for a selected tab, it will be updated; otherwise, a new one will be added.\n- **Sorted Output:** The <tabVisibilities> in the updated profile XML files are sorted alphabetically for consistency and readability.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **SOQL Queries (Tooling API):** It queries the `TabDefinition` object using `soqlQueryTooling` to retrieve a list of all available tabs in the target org.\n- **File Discovery:** Uses `glob` to find all .profile-meta.xml files within the specified project path.\n- **Interactive Prompts:** Leverages the `prompts` library to create interactive menus for selecting tabs, visibility settings, and profiles.\n- **XML Parsing and Manipulation:** Uses `parseXmlFile` to read the content of profile XML files and `writeXmlFile` to write the modified content back. It manipulates the `tabVisibilities` array within the parsed XML to add or update tab settings.\n- **Array Sorting:** Employs the `sort-array` library to sort the `tabVisibilities` alphabetically by tab name.\n- **Logging:** Provides feedback to the user about which profiles have been updated and a summary of the changes.\n</details>\n",
|
|
11413
|
-
"examples": [
|
|
11414
|
-
"$ sf hardis:project:fix:profiletabs"
|
|
11415
|
-
],
|
|
11416
|
-
"flags": {
|
|
11417
|
-
"json": {
|
|
11418
|
-
"description": "Format output as json.",
|
|
11419
|
-
"helpGroup": "GLOBAL",
|
|
11420
|
-
"name": "json",
|
|
11421
|
-
"allowNo": false,
|
|
11422
|
-
"type": "boolean"
|
|
11423
|
-
},
|
|
11424
|
-
"flags-dir": {
|
|
11425
|
-
"helpGroup": "GLOBAL",
|
|
11426
|
-
"name": "flags-dir",
|
|
11427
|
-
"summary": "Import flag values from a directory.",
|
|
11428
|
-
"hasDynamicHelp": false,
|
|
11429
|
-
"multiple": false,
|
|
11430
|
-
"type": "option"
|
|
11431
|
-
},
|
|
11432
|
-
"path": {
|
|
11433
|
-
"char": "p",
|
|
11434
|
-
"description": "Root folder",
|
|
11435
|
-
"name": "path",
|
|
11436
|
-
"default": "/home/runner/work/sfdx-hardis/sfdx-hardis",
|
|
11437
|
-
"hasDynamicHelp": false,
|
|
11438
|
-
"multiple": false,
|
|
11439
|
-
"type": "option"
|
|
11440
|
-
},
|
|
11441
|
-
"debug": {
|
|
11442
|
-
"char": "d",
|
|
11443
|
-
"description": "Activate debug mode (more logs)",
|
|
11444
|
-
"name": "debug",
|
|
11445
|
-
"allowNo": false,
|
|
11446
|
-
"type": "boolean"
|
|
11447
|
-
},
|
|
11448
|
-
"websocket": {
|
|
11449
|
-
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
11450
|
-
"name": "websocket",
|
|
11451
|
-
"hasDynamicHelp": false,
|
|
11452
|
-
"multiple": false,
|
|
11453
|
-
"type": "option"
|
|
11454
|
-
},
|
|
11455
|
-
"skipauth": {
|
|
11456
|
-
"description": "Skip authentication check when a default username is required",
|
|
11457
|
-
"name": "skipauth",
|
|
11458
|
-
"allowNo": false,
|
|
11459
|
-
"type": "boolean"
|
|
11460
|
-
},
|
|
11461
|
-
"target-org": {
|
|
11462
|
-
"aliases": [
|
|
11463
|
-
"targetusername",
|
|
11464
|
-
"u"
|
|
11465
|
-
],
|
|
11466
|
-
"char": "o",
|
|
11467
|
-
"deprecateAliases": true,
|
|
11468
|
-
"name": "target-org",
|
|
11469
|
-
"noCacheDefault": true,
|
|
11470
|
-
"required": true,
|
|
11471
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
11472
|
-
"hasDynamicHelp": true,
|
|
11473
|
-
"multiple": false,
|
|
11474
|
-
"type": "option"
|
|
11475
|
-
}
|
|
11476
|
-
},
|
|
11477
|
-
"hasDynamicHelp": true,
|
|
11478
|
-
"hiddenAliases": [],
|
|
11479
|
-
"id": "hardis:project:fix:profiletabs",
|
|
11480
|
-
"pluginAlias": "sfdx-hardis",
|
|
11481
|
-
"pluginName": "sfdx-hardis",
|
|
11482
|
-
"pluginType": "core",
|
|
11483
|
-
"strict": true,
|
|
11484
|
-
"enableJsonFlag": true,
|
|
11485
|
-
"title": "Fix profiles to add tabs that are not retrieved by SF CLI",
|
|
11486
|
-
"requiresProject": true,
|
|
11487
|
-
"isESM": true,
|
|
11488
|
-
"relativePath": [
|
|
11489
|
-
"lib",
|
|
11490
|
-
"commands",
|
|
11491
|
-
"hardis",
|
|
11492
|
-
"project",
|
|
11493
|
-
"fix",
|
|
11494
|
-
"profiletabs.js"
|
|
11495
|
-
],
|
|
11496
|
-
"aliasPermutations": [],
|
|
11497
|
-
"permutations": [
|
|
11498
|
-
"hardis:project:fix:profiletabs",
|
|
11499
|
-
"project:hardis:fix:profiletabs",
|
|
11500
|
-
"project:fix:hardis:profiletabs",
|
|
11501
|
-
"project:fix:profiletabs:hardis",
|
|
11502
|
-
"hardis:fix:project:profiletabs",
|
|
11503
|
-
"fix:hardis:project:profiletabs",
|
|
11504
|
-
"fix:project:hardis:profiletabs",
|
|
11505
|
-
"fix:project:profiletabs:hardis",
|
|
11506
|
-
"hardis:fix:profiletabs:project",
|
|
11507
|
-
"fix:hardis:profiletabs:project",
|
|
11508
|
-
"fix:profiletabs:hardis:project",
|
|
11509
|
-
"fix:profiletabs:project:hardis",
|
|
11510
|
-
"hardis:project:profiletabs:fix",
|
|
11511
|
-
"project:hardis:profiletabs:fix",
|
|
11512
|
-
"project:profiletabs:hardis:fix",
|
|
11513
|
-
"project:profiletabs:fix:hardis",
|
|
11514
|
-
"hardis:profiletabs:project:fix",
|
|
11515
|
-
"profiletabs:hardis:project:fix",
|
|
11516
|
-
"profiletabs:project:hardis:fix",
|
|
11517
|
-
"profiletabs:project:fix:hardis",
|
|
11518
|
-
"hardis:profiletabs:fix:project",
|
|
11519
|
-
"profiletabs:hardis:fix:project",
|
|
11520
|
-
"profiletabs:fix:hardis:project",
|
|
11521
|
-
"profiletabs:fix:project:hardis"
|
|
11522
|
-
]
|
|
11523
|
-
},
|
|
11524
|
-
"hardis:project:fix:v53flexipages": {
|
|
11525
|
-
"aliases": [],
|
|
11526
|
-
"args": {},
|
|
11527
|
-
"description": "\n## Command Behavior\n\n**Fixes Salesforce FlexiPages for compatibility with API Version 53.0 (Winter '22 release) by adding missing identifiers to component instances.**\n\nSalesforce introduced a change in API Version 53.0 that requires `identifier` tags within `componentInstance` and `fieldInstance` elements in FlexiPage metadata. If these identifiers are missing, deployments to orgs with API version 53.0 or higher will fail. This command automates the process of adding these missing identifiers, ensuring your FlexiPages remain deployable.\n\nKey functionalities:\n\n- **Targeted FlexiPage Processing:** Scans all .flexipage-meta.xml files within the specified root folder (defaults to current working directory).\n- **Identifier Injection:** Inserts a unique `identifier` tag (e.g., `SFDX_HARDIS_REPLACEMENT_ID`) into `componentInstance` and `fieldInstance` elements that lack one.\n\n**Important Note:** After running this command, ensure you update your `apiVersion` to `53.0` (or higher) in your `package.xml` and `sfdx-project.json` files.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **File Discovery:** Uses `glob` to find all .flexipage-meta.xml files.\n- **Content Reading:** Reads the XML content of each FlexiPage file.\n- **Regular Expression Replacement:** Employs a set of regular expressions to identify specific XML patterns (componentName.../componentName.../componentInstance, componentName.../componentName.../visibilityRule, fieldItem.../fieldItem.../fieldInstance) that are missing the `identifier` tag.\n- **Dynamic ID Generation:** For each match, it generates a unique identifier (e.g., `sfdxHardisIdX`) and injects it into the XML structure.\n- **File Writing:** If changes are made, the modified XML content is written back to the FlexiPage file using `fs.writeFile`.\n- **Logging:** Provides messages about which FlexiPages are being processed and a summary of the total number of identifiers added.\n</details>\n",
|
|
11528
|
-
"examples": [
|
|
11529
|
-
"$ sf hardis:project:fix:v53flexipages"
|
|
11530
|
-
],
|
|
11531
|
-
"flags": {
|
|
11532
|
-
"json": {
|
|
11533
|
-
"description": "Format output as json.",
|
|
11534
|
-
"helpGroup": "GLOBAL",
|
|
11535
|
-
"name": "json",
|
|
11536
|
-
"allowNo": false,
|
|
11537
|
-
"type": "boolean"
|
|
11538
|
-
},
|
|
11539
|
-
"flags-dir": {
|
|
11540
|
-
"helpGroup": "GLOBAL",
|
|
11541
|
-
"name": "flags-dir",
|
|
11542
|
-
"summary": "Import flag values from a directory.",
|
|
11543
|
-
"hasDynamicHelp": false,
|
|
11544
|
-
"multiple": false,
|
|
11545
|
-
"type": "option"
|
|
11546
|
-
},
|
|
11547
|
-
"path": {
|
|
11548
|
-
"char": "p",
|
|
11549
|
-
"description": "Root folder",
|
|
11550
|
-
"name": "path",
|
|
11551
|
-
"default": "/home/runner/work/sfdx-hardis/sfdx-hardis",
|
|
11552
|
-
"hasDynamicHelp": false,
|
|
11553
|
-
"multiple": false,
|
|
11554
|
-
"type": "option"
|
|
11555
|
-
},
|
|
11556
|
-
"debug": {
|
|
11557
|
-
"char": "d",
|
|
11558
|
-
"description": "Activate debug mode (more logs)",
|
|
11559
|
-
"name": "debug",
|
|
11560
|
-
"allowNo": false,
|
|
11561
|
-
"type": "boolean"
|
|
11562
|
-
},
|
|
11563
|
-
"websocket": {
|
|
11564
|
-
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
11565
|
-
"name": "websocket",
|
|
11566
|
-
"hasDynamicHelp": false,
|
|
11567
|
-
"multiple": false,
|
|
11568
|
-
"type": "option"
|
|
11569
|
-
},
|
|
11570
|
-
"skipauth": {
|
|
11571
|
-
"description": "Skip authentication check when a default username is required",
|
|
11572
|
-
"name": "skipauth",
|
|
11573
|
-
"allowNo": false,
|
|
11574
|
-
"type": "boolean"
|
|
11575
|
-
}
|
|
11576
|
-
},
|
|
11577
|
-
"hasDynamicHelp": false,
|
|
11578
|
-
"hiddenAliases": [],
|
|
11579
|
-
"id": "hardis:project:fix:v53flexipages",
|
|
11580
|
-
"pluginAlias": "sfdx-hardis",
|
|
11581
|
-
"pluginName": "sfdx-hardis",
|
|
11582
|
-
"pluginType": "core",
|
|
11583
|
-
"strict": true,
|
|
11584
|
-
"enableJsonFlag": true,
|
|
11585
|
-
"title": "Fix flexipages for v53",
|
|
11586
|
-
"requiresProject": true,
|
|
11587
|
-
"isESM": true,
|
|
11588
|
-
"relativePath": [
|
|
11589
|
-
"lib",
|
|
11590
|
-
"commands",
|
|
11591
|
-
"hardis",
|
|
11592
|
-
"project",
|
|
11593
|
-
"fix",
|
|
11594
|
-
"v53flexipages.js"
|
|
11595
|
-
],
|
|
11596
|
-
"aliasPermutations": [],
|
|
11597
|
-
"permutations": [
|
|
11598
|
-
"hardis:project:fix:v53flexipages",
|
|
11599
|
-
"project:hardis:fix:v53flexipages",
|
|
11600
|
-
"project:fix:hardis:v53flexipages",
|
|
11601
|
-
"project:fix:v53flexipages:hardis",
|
|
11602
|
-
"hardis:fix:project:v53flexipages",
|
|
11603
|
-
"fix:hardis:project:v53flexipages",
|
|
11604
|
-
"fix:project:hardis:v53flexipages",
|
|
11605
|
-
"fix:project:v53flexipages:hardis",
|
|
11606
|
-
"hardis:fix:v53flexipages:project",
|
|
11607
|
-
"fix:hardis:v53flexipages:project",
|
|
11608
|
-
"fix:v53flexipages:hardis:project",
|
|
11609
|
-
"fix:v53flexipages:project:hardis",
|
|
11610
|
-
"hardis:project:v53flexipages:fix",
|
|
11611
|
-
"project:hardis:v53flexipages:fix",
|
|
11612
|
-
"project:v53flexipages:hardis:fix",
|
|
11613
|
-
"project:v53flexipages:fix:hardis",
|
|
11614
|
-
"hardis:v53flexipages:project:fix",
|
|
11615
|
-
"v53flexipages:hardis:project:fix",
|
|
11616
|
-
"v53flexipages:project:hardis:fix",
|
|
11617
|
-
"v53flexipages:project:fix:hardis",
|
|
11618
|
-
"hardis:v53flexipages:fix:project",
|
|
11619
|
-
"v53flexipages:hardis:fix:project",
|
|
11620
|
-
"v53flexipages:fix:hardis:project",
|
|
11621
|
-
"v53flexipages:fix:project:hardis"
|
|
11366
|
+
"enableJsonFlag": true,
|
|
11367
|
+
"title": "Convert Profiles into Permission Sets",
|
|
11368
|
+
"requiresProject": true,
|
|
11369
|
+
"requiresSfdxPlugins": [
|
|
11370
|
+
"shane-sfdx-plugins"
|
|
11371
|
+
],
|
|
11372
|
+
"isESM": true,
|
|
11373
|
+
"relativePath": [
|
|
11374
|
+
"lib",
|
|
11375
|
+
"commands",
|
|
11376
|
+
"hardis",
|
|
11377
|
+
"project",
|
|
11378
|
+
"convert",
|
|
11379
|
+
"profilestopermsets.js"
|
|
11380
|
+
],
|
|
11381
|
+
"aliasPermutations": [],
|
|
11382
|
+
"permutations": [
|
|
11383
|
+
"hardis:project:convert:profilestopermsets",
|
|
11384
|
+
"project:hardis:convert:profilestopermsets",
|
|
11385
|
+
"project:convert:hardis:profilestopermsets",
|
|
11386
|
+
"project:convert:profilestopermsets:hardis",
|
|
11387
|
+
"hardis:convert:project:profilestopermsets",
|
|
11388
|
+
"convert:hardis:project:profilestopermsets",
|
|
11389
|
+
"convert:project:hardis:profilestopermsets",
|
|
11390
|
+
"convert:project:profilestopermsets:hardis",
|
|
11391
|
+
"hardis:convert:profilestopermsets:project",
|
|
11392
|
+
"convert:hardis:profilestopermsets:project",
|
|
11393
|
+
"convert:profilestopermsets:hardis:project",
|
|
11394
|
+
"convert:profilestopermsets:project:hardis",
|
|
11395
|
+
"hardis:project:profilestopermsets:convert",
|
|
11396
|
+
"project:hardis:profilestopermsets:convert",
|
|
11397
|
+
"project:profilestopermsets:hardis:convert",
|
|
11398
|
+
"project:profilestopermsets:convert:hardis",
|
|
11399
|
+
"hardis:profilestopermsets:project:convert",
|
|
11400
|
+
"profilestopermsets:hardis:project:convert",
|
|
11401
|
+
"profilestopermsets:project:hardis:convert",
|
|
11402
|
+
"profilestopermsets:project:convert:hardis",
|
|
11403
|
+
"hardis:profilestopermsets:convert:project",
|
|
11404
|
+
"profilestopermsets:hardis:convert:project",
|
|
11405
|
+
"profilestopermsets:convert:hardis:project",
|
|
11406
|
+
"profilestopermsets:convert:project:hardis"
|
|
11622
11407
|
]
|
|
11623
11408
|
},
|
|
11624
11409
|
"hardis:project:deploy:notify": {
|
|
@@ -11978,7 +11763,7 @@
|
|
|
11978
11763
|
"pluginType": "core",
|
|
11979
11764
|
"strict": true,
|
|
11980
11765
|
"enableJsonFlag": true,
|
|
11981
|
-
"title": "Simulate the deployment of
|
|
11766
|
+
"title": "Simulate the deployment of metadata in an org prompted to the user.\nUsed by VS Code extension.",
|
|
11982
11767
|
"requiresProject": true,
|
|
11983
11768
|
"isESM": true,
|
|
11984
11769
|
"relativePath": [
|
|
@@ -12796,6 +12581,221 @@
|
|
|
12796
12581
|
"validate:deploy:project:hardis"
|
|
12797
12582
|
]
|
|
12798
12583
|
},
|
|
12584
|
+
"hardis:project:fix:profiletabs": {
|
|
12585
|
+
"aliases": [],
|
|
12586
|
+
"args": {},
|
|
12587
|
+
"description": "\n## Command Behavior\n\n**Interactively updates tab visibility settings in Salesforce profiles, addressing a common issue where tab visibilities are not correctly retrieved by `sf project retrieve start`.**\n\nThis command provides a user-friendly interface to manage tab settings within your profile XML files, ensuring that your local project accurately reflects the intended tab configurations in your Salesforce org.\n\nKey functionalities:\n\n- **Interactive Tab Selection:** Displays a multi-select menu of all available tabs in your org, allowing you to choose which tabs to update.\n- **Visibility Control:** Lets you set the visibility for the selected tabs to either `DefaultOn` (Visible) or `Hidden`.\n- **Profile Selection:** Presents a multi-select menu of all .profile-meta.xml files in your project, allowing you to apply the tab visibility changes to specific profiles.\n- **XML Updates:** Modifies the <tabVisibilities> section of the selected profile XML files to reflect the chosen tab settings. If a tab visibility setting already exists for a selected tab, it will be updated; otherwise, a new one will be added.\n- **Sorted Output:** The <tabVisibilities> in the updated profile XML files are sorted alphabetically for consistency and readability.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **SOQL Queries (Tooling API):** It queries the `TabDefinition` object using `soqlQueryTooling` to retrieve a list of all available tabs in the target org.\n- **File Discovery:** Uses `glob` to find all .profile-meta.xml files within the specified project path.\n- **Interactive Prompts:** Leverages the `prompts` library to create interactive menus for selecting tabs, visibility settings, and profiles.\n- **XML Parsing and Manipulation:** Uses `parseXmlFile` to read the content of profile XML files and `writeXmlFile` to write the modified content back. It manipulates the `tabVisibilities` array within the parsed XML to add or update tab settings.\n- **Array Sorting:** Employs the `sort-array` library to sort the `tabVisibilities` alphabetically by tab name.\n- **Logging:** Provides feedback to the user about which profiles have been updated and a summary of the changes.\n</details>\n",
|
|
12588
|
+
"examples": [
|
|
12589
|
+
"$ sf hardis:project:fix:profiletabs"
|
|
12590
|
+
],
|
|
12591
|
+
"flags": {
|
|
12592
|
+
"json": {
|
|
12593
|
+
"description": "Format output as json.",
|
|
12594
|
+
"helpGroup": "GLOBAL",
|
|
12595
|
+
"name": "json",
|
|
12596
|
+
"allowNo": false,
|
|
12597
|
+
"type": "boolean"
|
|
12598
|
+
},
|
|
12599
|
+
"flags-dir": {
|
|
12600
|
+
"helpGroup": "GLOBAL",
|
|
12601
|
+
"name": "flags-dir",
|
|
12602
|
+
"summary": "Import flag values from a directory.",
|
|
12603
|
+
"hasDynamicHelp": false,
|
|
12604
|
+
"multiple": false,
|
|
12605
|
+
"type": "option"
|
|
12606
|
+
},
|
|
12607
|
+
"path": {
|
|
12608
|
+
"char": "p",
|
|
12609
|
+
"description": "Root folder",
|
|
12610
|
+
"name": "path",
|
|
12611
|
+
"default": "/home/runner/work/sfdx-hardis/sfdx-hardis",
|
|
12612
|
+
"hasDynamicHelp": false,
|
|
12613
|
+
"multiple": false,
|
|
12614
|
+
"type": "option"
|
|
12615
|
+
},
|
|
12616
|
+
"debug": {
|
|
12617
|
+
"char": "d",
|
|
12618
|
+
"description": "Activate debug mode (more logs)",
|
|
12619
|
+
"name": "debug",
|
|
12620
|
+
"allowNo": false,
|
|
12621
|
+
"type": "boolean"
|
|
12622
|
+
},
|
|
12623
|
+
"websocket": {
|
|
12624
|
+
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
12625
|
+
"name": "websocket",
|
|
12626
|
+
"hasDynamicHelp": false,
|
|
12627
|
+
"multiple": false,
|
|
12628
|
+
"type": "option"
|
|
12629
|
+
},
|
|
12630
|
+
"skipauth": {
|
|
12631
|
+
"description": "Skip authentication check when a default username is required",
|
|
12632
|
+
"name": "skipauth",
|
|
12633
|
+
"allowNo": false,
|
|
12634
|
+
"type": "boolean"
|
|
12635
|
+
},
|
|
12636
|
+
"target-org": {
|
|
12637
|
+
"aliases": [
|
|
12638
|
+
"targetusername",
|
|
12639
|
+
"u"
|
|
12640
|
+
],
|
|
12641
|
+
"char": "o",
|
|
12642
|
+
"deprecateAliases": true,
|
|
12643
|
+
"name": "target-org",
|
|
12644
|
+
"noCacheDefault": true,
|
|
12645
|
+
"required": true,
|
|
12646
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
12647
|
+
"hasDynamicHelp": true,
|
|
12648
|
+
"multiple": false,
|
|
12649
|
+
"type": "option"
|
|
12650
|
+
}
|
|
12651
|
+
},
|
|
12652
|
+
"hasDynamicHelp": true,
|
|
12653
|
+
"hiddenAliases": [],
|
|
12654
|
+
"id": "hardis:project:fix:profiletabs",
|
|
12655
|
+
"pluginAlias": "sfdx-hardis",
|
|
12656
|
+
"pluginName": "sfdx-hardis",
|
|
12657
|
+
"pluginType": "core",
|
|
12658
|
+
"strict": true,
|
|
12659
|
+
"enableJsonFlag": true,
|
|
12660
|
+
"title": "Fix profiles to add tabs that are not retrieved by SF CLI",
|
|
12661
|
+
"requiresProject": true,
|
|
12662
|
+
"isESM": true,
|
|
12663
|
+
"relativePath": [
|
|
12664
|
+
"lib",
|
|
12665
|
+
"commands",
|
|
12666
|
+
"hardis",
|
|
12667
|
+
"project",
|
|
12668
|
+
"fix",
|
|
12669
|
+
"profiletabs.js"
|
|
12670
|
+
],
|
|
12671
|
+
"aliasPermutations": [],
|
|
12672
|
+
"permutations": [
|
|
12673
|
+
"hardis:project:fix:profiletabs",
|
|
12674
|
+
"project:hardis:fix:profiletabs",
|
|
12675
|
+
"project:fix:hardis:profiletabs",
|
|
12676
|
+
"project:fix:profiletabs:hardis",
|
|
12677
|
+
"hardis:fix:project:profiletabs",
|
|
12678
|
+
"fix:hardis:project:profiletabs",
|
|
12679
|
+
"fix:project:hardis:profiletabs",
|
|
12680
|
+
"fix:project:profiletabs:hardis",
|
|
12681
|
+
"hardis:fix:profiletabs:project",
|
|
12682
|
+
"fix:hardis:profiletabs:project",
|
|
12683
|
+
"fix:profiletabs:hardis:project",
|
|
12684
|
+
"fix:profiletabs:project:hardis",
|
|
12685
|
+
"hardis:project:profiletabs:fix",
|
|
12686
|
+
"project:hardis:profiletabs:fix",
|
|
12687
|
+
"project:profiletabs:hardis:fix",
|
|
12688
|
+
"project:profiletabs:fix:hardis",
|
|
12689
|
+
"hardis:profiletabs:project:fix",
|
|
12690
|
+
"profiletabs:hardis:project:fix",
|
|
12691
|
+
"profiletabs:project:hardis:fix",
|
|
12692
|
+
"profiletabs:project:fix:hardis",
|
|
12693
|
+
"hardis:profiletabs:fix:project",
|
|
12694
|
+
"profiletabs:hardis:fix:project",
|
|
12695
|
+
"profiletabs:fix:hardis:project",
|
|
12696
|
+
"profiletabs:fix:project:hardis"
|
|
12697
|
+
]
|
|
12698
|
+
},
|
|
12699
|
+
"hardis:project:fix:v53flexipages": {
|
|
12700
|
+
"aliases": [],
|
|
12701
|
+
"args": {},
|
|
12702
|
+
"description": "\n## Command Behavior\n\n**Fixes Salesforce FlexiPages for compatibility with API Version 53.0 (Winter '22 release) by adding missing identifiers to component instances.**\n\nSalesforce introduced a change in API Version 53.0 that requires `identifier` tags within `componentInstance` and `fieldInstance` elements in FlexiPage metadata. If these identifiers are missing, deployments to orgs with API version 53.0 or higher will fail. This command automates the process of adding these missing identifiers, ensuring your FlexiPages remain deployable.\n\nKey functionalities:\n\n- **Targeted FlexiPage Processing:** Scans all .flexipage-meta.xml files within the specified root folder (defaults to current working directory).\n- **Identifier Injection:** Inserts a unique `identifier` tag (e.g., `SFDX_HARDIS_REPLACEMENT_ID`) into `componentInstance` and `fieldInstance` elements that lack one.\n\n**Important Note:** After running this command, ensure you update your `apiVersion` to `53.0` (or higher) in your `package.xml` and `sfdx-project.json` files.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **File Discovery:** Uses `glob` to find all .flexipage-meta.xml files.\n- **Content Reading:** Reads the XML content of each FlexiPage file.\n- **Regular Expression Replacement:** Employs a set of regular expressions to identify specific XML patterns (componentName.../componentName.../componentInstance, componentName.../componentName.../visibilityRule, fieldItem.../fieldItem.../fieldInstance) that are missing the `identifier` tag.\n- **Dynamic ID Generation:** For each match, it generates a unique identifier (e.g., `sfdxHardisIdX`) and injects it into the XML structure.\n- **File Writing:** If changes are made, the modified XML content is written back to the FlexiPage file using `fs.writeFile`.\n- **Logging:** Provides messages about which FlexiPages are being processed and a summary of the total number of identifiers added.\n</details>\n",
|
|
12703
|
+
"examples": [
|
|
12704
|
+
"$ sf hardis:project:fix:v53flexipages"
|
|
12705
|
+
],
|
|
12706
|
+
"flags": {
|
|
12707
|
+
"json": {
|
|
12708
|
+
"description": "Format output as json.",
|
|
12709
|
+
"helpGroup": "GLOBAL",
|
|
12710
|
+
"name": "json",
|
|
12711
|
+
"allowNo": false,
|
|
12712
|
+
"type": "boolean"
|
|
12713
|
+
},
|
|
12714
|
+
"flags-dir": {
|
|
12715
|
+
"helpGroup": "GLOBAL",
|
|
12716
|
+
"name": "flags-dir",
|
|
12717
|
+
"summary": "Import flag values from a directory.",
|
|
12718
|
+
"hasDynamicHelp": false,
|
|
12719
|
+
"multiple": false,
|
|
12720
|
+
"type": "option"
|
|
12721
|
+
},
|
|
12722
|
+
"path": {
|
|
12723
|
+
"char": "p",
|
|
12724
|
+
"description": "Root folder",
|
|
12725
|
+
"name": "path",
|
|
12726
|
+
"default": "/home/runner/work/sfdx-hardis/sfdx-hardis",
|
|
12727
|
+
"hasDynamicHelp": false,
|
|
12728
|
+
"multiple": false,
|
|
12729
|
+
"type": "option"
|
|
12730
|
+
},
|
|
12731
|
+
"debug": {
|
|
12732
|
+
"char": "d",
|
|
12733
|
+
"description": "Activate debug mode (more logs)",
|
|
12734
|
+
"name": "debug",
|
|
12735
|
+
"allowNo": false,
|
|
12736
|
+
"type": "boolean"
|
|
12737
|
+
},
|
|
12738
|
+
"websocket": {
|
|
12739
|
+
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
12740
|
+
"name": "websocket",
|
|
12741
|
+
"hasDynamicHelp": false,
|
|
12742
|
+
"multiple": false,
|
|
12743
|
+
"type": "option"
|
|
12744
|
+
},
|
|
12745
|
+
"skipauth": {
|
|
12746
|
+
"description": "Skip authentication check when a default username is required",
|
|
12747
|
+
"name": "skipauth",
|
|
12748
|
+
"allowNo": false,
|
|
12749
|
+
"type": "boolean"
|
|
12750
|
+
}
|
|
12751
|
+
},
|
|
12752
|
+
"hasDynamicHelp": false,
|
|
12753
|
+
"hiddenAliases": [],
|
|
12754
|
+
"id": "hardis:project:fix:v53flexipages",
|
|
12755
|
+
"pluginAlias": "sfdx-hardis",
|
|
12756
|
+
"pluginName": "sfdx-hardis",
|
|
12757
|
+
"pluginType": "core",
|
|
12758
|
+
"strict": true,
|
|
12759
|
+
"enableJsonFlag": true,
|
|
12760
|
+
"title": "Fix flexipages for v53",
|
|
12761
|
+
"requiresProject": true,
|
|
12762
|
+
"isESM": true,
|
|
12763
|
+
"relativePath": [
|
|
12764
|
+
"lib",
|
|
12765
|
+
"commands",
|
|
12766
|
+
"hardis",
|
|
12767
|
+
"project",
|
|
12768
|
+
"fix",
|
|
12769
|
+
"v53flexipages.js"
|
|
12770
|
+
],
|
|
12771
|
+
"aliasPermutations": [],
|
|
12772
|
+
"permutations": [
|
|
12773
|
+
"hardis:project:fix:v53flexipages",
|
|
12774
|
+
"project:hardis:fix:v53flexipages",
|
|
12775
|
+
"project:fix:hardis:v53flexipages",
|
|
12776
|
+
"project:fix:v53flexipages:hardis",
|
|
12777
|
+
"hardis:fix:project:v53flexipages",
|
|
12778
|
+
"fix:hardis:project:v53flexipages",
|
|
12779
|
+
"fix:project:hardis:v53flexipages",
|
|
12780
|
+
"fix:project:v53flexipages:hardis",
|
|
12781
|
+
"hardis:fix:v53flexipages:project",
|
|
12782
|
+
"fix:hardis:v53flexipages:project",
|
|
12783
|
+
"fix:v53flexipages:hardis:project",
|
|
12784
|
+
"fix:v53flexipages:project:hardis",
|
|
12785
|
+
"hardis:project:v53flexipages:fix",
|
|
12786
|
+
"project:hardis:v53flexipages:fix",
|
|
12787
|
+
"project:v53flexipages:hardis:fix",
|
|
12788
|
+
"project:v53flexipages:fix:hardis",
|
|
12789
|
+
"hardis:v53flexipages:project:fix",
|
|
12790
|
+
"v53flexipages:hardis:project:fix",
|
|
12791
|
+
"v53flexipages:project:hardis:fix",
|
|
12792
|
+
"v53flexipages:project:fix:hardis",
|
|
12793
|
+
"hardis:v53flexipages:fix:project",
|
|
12794
|
+
"v53flexipages:hardis:fix:project",
|
|
12795
|
+
"v53flexipages:fix:hardis:project",
|
|
12796
|
+
"v53flexipages:fix:project:hardis"
|
|
12797
|
+
]
|
|
12798
|
+
},
|
|
12799
12799
|
"hardis:project:generate:bypass": {
|
|
12800
12800
|
"aliases": [],
|
|
12801
12801
|
"args": {},
|
|
@@ -15369,5 +15369,5 @@
|
|
|
15369
15369
|
]
|
|
15370
15370
|
}
|
|
15371
15371
|
},
|
|
15372
|
-
"version": "6.7.
|
|
15372
|
+
"version": "6.7.4"
|
|
15373
15373
|
}
|