Sm/sf-ification

.eslintrc.js

@@ -1,3 +1,3 @@
 module.exports = {
-  extends: ['eslint-config-salesforce-typescript', 'eslint-config-salesforce-license'],
+  extends: ['eslint-config-salesforce-typescript', 'eslint-config-salesforce-license', 'plugin:sf-plugin/recommended'],
 };

.mocharc.json

@@ -1,9 +1,15 @@
 {
   "require": "ts-node/register,source-map-support/register",
   "watch-extensions": "ts",
-  "watch-files": ["src", "test"],
-  "extensions": [".ts", "json"],
+  "watch-files": [
+    "src",
+    "test"
+  ],
+  "extensions": [
+    ".ts",
+    "json"
+  ],
   "recursive": true,
   "reporter": "spec",
-  "timeout": 5000
+  "timeout": 10000
 }

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2022, Salesforce.com, Inc.
+Copyright (c) 2023, Salesforce.com, Inc.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

command-snapshot.json

@@ -1,130 +1,112 @@
 [
   {
-    "command": "force:data:bulk:delete",
+    "command": "data:create:record",
     "plugin": "@salesforce/plugin-data",
-    "flags": ["apiversion", "csvfile", "json", "loglevel", "sobjecttype", "targetusername", "wait"],
-    "alias": []
+    "flags": ["api-version", "json", "loglevel", "perflog", "sobject", "target-org", "use-tooling-api", "values"],
+    "alias": ["force:data:record:create"]
   },
   {
-    "command": "force:data:bulk:status",
+    "command": "data:delete:bulk",
     "plugin": "@salesforce/plugin-data",
-    "flags": ["apiversion", "batchid", "jobid", "json", "loglevel", "targetusername"],
-    "alias": []
+    "flags": ["api-version", "file", "json", "loglevel", "sobject", "target-org", "wait"],
+    "alias": ["force:data:bulk:delete"]
   },
   {
-    "command": "force:data:bulk:upsert",
+    "command": "data:delete:record",
     "plugin": "@salesforce/plugin-data",
     "flags": [
-      "apiversion",
-      "csvfile",
-      "externalid",
-      "json",
-      "loglevel",
-      "serial",
-      "sobjecttype",
-      "targetusername",
-      "wait"
-    ],
-    "alias": []
-  },
-  {
-    "command": "force:data:record:create",
-    "plugin": "@salesforce/plugin-data",
-    "flags": ["apiversion", "json", "loglevel", "perflog", "sobjecttype", "targetusername", "usetoolingapi", "values"],
-    "alias": []
-  },
-  {
-    "command": "force:data:record:delete",
-    "plugin": "@salesforce/plugin-data",
-    "flags": [
-      "apiversion",
+      "api-version",
       "json",
       "loglevel",
       "perflog",
-      "sobjectid",
-      "sobjecttype",
-      "targetusername",
-      "usetoolingapi",
+      "record-id",
+      "sobject",
+      "target-org",
+      "use-tooling-api",
       "where"
     ],
-    "alias": []
+    "alias": ["force:data:record:delete"]
   },
   {
-    "command": "force:data:record:get",
+    "command": "data:export:tree",
     "plugin": "@salesforce/plugin-data",
-    "flags": [
-      "apiversion",
-      "json",
-      "loglevel",
-      "perflog",
-      "sobjectid",
-      "sobjecttype",
-      "targetusername",
-      "usetoolingapi",
-      "where"
-    ],
-    "alias": []
+    "flags": ["api-version", "json", "loglevel", "output-dir", "plan", "prefix", "query", "target-org"],
+    "alias": ["force:data:tree:export"]
   },
   {
-    "command": "force:data:record:update",
+    "command": "data:get:record",
     "plugin": "@salesforce/plugin-data",
     "flags": [
-      "apiversion",
+      "api-version",
       "json",
       "loglevel",
       "perflog",
-      "sobjectid",
-      "sobjecttype",
-      "targetusername",
-      "usetoolingapi",
-      "values",
+      "record-id",
+      "sobject",
+      "target-org",
+      "use-tooling-api",
       "where"
     ],
-    "alias": []
+    "alias": ["force:data:record:get"]
   },
   {
-    "command": "force:data:soql:bulk:report",
+    "command": "data:import:tree",
     "plugin": "@salesforce/plugin-data",
-    "flags": ["apiversion", "bulkqueryid", "json", "loglevel", "resultformat", "targetusername"],
-    "alias": []
+    "flags": ["api-version", "config-help", "content-type", "files", "json", "loglevel", "plan", "target-org"],
+    "alias": ["force:data:tree:import"]
   },
   {
-    "command": "force:data:soql:query",
+    "command": "data:query",
     "plugin": "@salesforce/plugin-data",
     "flags": [
-      "apiversion",
+      "api-version",
+      "async",
       "bulk",
+      "file",
       "json",
       "loglevel",
       "perflog",
       "query",
-      "resultformat",
-      "soqlqueryfile",
-      "targetusername",
-      "usetoolingapi",
+      "result-format",
+      "target-org",
+      "use-tooling-api",
       "wait"
     ],
-    "alias": []
+    "alias": ["force:data:soql:query"]
+  },
+  {
+    "command": "data:query:resume",
+    "plugin": "@salesforce/plugin-data",
+    "flags": ["api-version", "bulk-query-id", "json", "loglevel", "result-format", "target-org"],
+    "alias": ["force:data:soql:bulk:report"]
   },
   {
-    "command": "force:data:tree:export",
+    "command": "data:resume",
     "plugin": "@salesforce/plugin-data",
-    "flags": ["apiversion", "json", "loglevel", "outputdir", "plan", "prefix", "query", "targetusername"],
-    "alias": []
+    "flags": ["api-version", "batch-id", "job-id", "json", "loglevel", "target-org"],
+    "alias": ["force:data:bulk:status"]
   },
   {
-    "command": "force:data:tree:import",
+    "command": "data:update:record",
     "plugin": "@salesforce/plugin-data",
     "flags": [
-      "apiversion",
-      "confighelp",
-      "contenttype",
+      "api-version",
       "json",
       "loglevel",
-      "plan",
-      "sobjecttreefiles",
-      "targetusername"
+      "perflog",
+      "record-id",
+      "sobject",
+      "target-org",
+      "use-tooling-api",
+      "values",
+      "where"
     ],
-    "alias": []
+    "alias": ["force:data:record:update"]
+  },
+  {
+    "command": "data:upsert:bulk",
+    "plugin": "@salesforce/plugin-data",
+    "flags": ["api-version", "external-id", "file", "json", "loglevel", "serial", "sobject", "target-org", "wait"],
+    "alias": ["force:data:bulk:upsert"]
   }
 ]

messages/batcher.md

@@ -0,0 +1,39 @@
+# BulkBatch
+
+Batch #%s
+
+# BulkError
+
+Upsert errors
+
+# BulkJobStatus
+
+Job Status
+
+# BatchStatus
+
+Batch Status
+
+# PollingInfo
+
+Will poll the batch statuses every %s seconds.
+To fetch the status on your own, press CTRL+C and use the command:
+sfdx data resume -i %s -b [<batchId>]
+
+# ExternalIdRequired
+
+An External ID is required on %s to perform an upsert.
+
+# TimeOut
+
+The operation timed out. Check the status with command:
+sfdx data resume -i %s -b %s
+
+# CheckStatusCommand
+
+Check batch #%s’s status with the command:
+sfdx data resume -i %s -b %s
+
+# BatchQueued
+
+Batch #%s queued (Batch ID: %s).

messages/bulk.delete.md

@@ -0,0 +1,31 @@
+# summary
+
+Bulk delete records from an org using a CSV file.
+
+# description
+
+The CSV file must have only one column ("Id") and then the list of record IDs you want to delete, one ID per line.
+
+When you execute this command, it starts a job and one or more batches, displays their IDs, and then immediately returns control of the terminal to you by default. If you prefer to wait, set the --wait flag to the number of minutes; if it times out, the command outputs the IDs. Use the job and batch IDs to check the status of the job with the "<%= config.bin %> data resume" command. A single job can contain many batches, depending on the length of the CSV file.
+
+# examples
+
+- Bulk delete Account records using the list of IDs in the "files/delete.csv" file:
+
+  <%= config.bin %> <%= command.id %> --sobject Account --file files/delete.csv
+
+- Bulk delete records from a custom object and wait 5 minutes for the command to complete:
+
+  <%= config.bin %> <%= command.id %> --sobject MyObject__c --file files/delete.csv --wait 5
+
+# flags.sobjecttype
+
+API name of the Salesforce object, either standard or custom, that you want to delete records from.
+
+# flags.csvfile
+
+CSV file that contains the IDs of the records to delete.
+
+# flags.wait
+
+Number of minutes to wait for the command to complete before displaying the results.

messages/bulk.report.md

@@ -0,0 +1,17 @@
+# summary
+
+View the status of a bulk query.
+
+# description
+
+Run this command using the job ID returned from the "<%= config.bin %> data query --bulk" command.
+
+# examples
+
+- View the status of a bulk query with the specified ID:
+
+  <%= config.bin %> <%= command.id %> --bulk-query-id 7500x000005BdFzXXX
+
+# flags.bulkQueryId
+
+Job ID of the bulk query.

messages/bulk.status.md

@@ -0,0 +1,29 @@
+# summary
+
+View the status of a bulk data load job or batch.
+
+# description
+
+Run this command using the job ID or batch ID returned from the "<%= config.bin %> data delete bulk" or "<%= config.bin %> data upsert bulk" commands.
+
+# examples
+
+- View the status of a bulk load job:
+
+  <%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA
+
+- View the status of a bulk load job and a specific batches:
+
+  <%= config.bin %> <%= command.id %> --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA
+
+# flags.jobid
+
+ID of the job whose status you want to view.
+
+# flags.batchid
+
+ID of the batch whose status you want to view; you must also specify the job ID.
+
+# NoBatchFound
+
+Unable to find batch %s for job %s.