@simplysf/simply-data 1.0.0

package/LICENSE.txt

@@ -0,0 +1,12 @@
+Copyright (c) 2024, Clay Chipps; Copyright (c) 2024, 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:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+* Neither the name of Salesforce.com nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,138 @@
+# @simplysf/simply-data
+
+[![NPM](https://img.shields.io/npm/v/@simplysf/simply-package?label=@simplysf/simply-package)](https://npmjs.com/package/@simplysf/simply-package) [![Downloads/week](https://img.shields.io/npm/dw/@simplysf/simply-package.svg)](https://npmjs.com/package/@simplysf/simply-package) [![License: BSD-3-Clause](https://img.shields.io/badge/License-BSD_3--Clause-yellow.svg)](https://raw.githubusercontent.com/SimplySF/simply-data/main/LICENSE.txt)
+
+## Install
+
+```bash
+sf plugins install @simplysf/simply-data
+```
+
+## Issues
+
+Please report any issues at https://github.com/SimplySF/simply-data/issues
+
+## Contributing
+
+1. Please read our [Code of Conduct](CODE_OF_CONDUCT.md)
+2. Create a new issue before starting your project so that we can keep track of
+   what you are trying to add/fix. That way, we can also offer suggestions or
+   let you know if there is already an effort in progress.
+3. Fork this repository.
+4. [Build the plugin locally](#build)
+5. Create a _topic_ branch in your fork. Note, this step is recommended but technically not required if contributing using a fork.
+6. Edit the code in your fork.
+7. Write appropriate tests for your changes. Try to achieve at least 95% code coverage on any new code. No pull request will be accepted without unit tests.
+8. Send us a pull request when you are done. We'll review your code, suggest any needed changes, and merge it in.
+
+### Build
+
+To build the plugin locally, make sure to have yarn installed and run the following commands:
+
+```bash
+# Clone the repository
+git clone git@github.com:SimplySF/simply-data
+
+# Install the dependencies and compile
+yarn && yarn build
+```
+
+To use your plugin, run using the local `./bin/dev` or `./bin/dev.cmd` file.
+
+```bash
+# Run using local run file.
+./bin/dev.cmd simply data
+```
+
+There should be no differences when running via the Salesforce CLI or using the local run file. However, it can be useful to link the plugin to do some additional testing or run your commands from anywhere on your machine.
+
+```bash
+# Link your plugin to the sf cli
+sf plugins link .
+# To verify
+sf plugins
+```
+
+## Commands
+
+<!-- commands -->
+* [`sf simply data file upload`](#sf-simply-data-file-upload)
+* [`sf simply data files upload`](#sf-simply-data-files-upload)
+
+## `sf simply data file upload`
+
+Upload a file to a Salesforce org.
+
+```
+USAGE
+  $ sf simply data file upload --file-path <value> -o <value> [--json] [--api-version <value>] [--first-publish-location-id
+    <value>] [--title <value>]
+
+FLAGS
+  -o, --target-org=<value>                 (required) Username or alias of the target org. Not required if the
+                                           `target-org` configuration variable is already set.
+      --api-version=<value>                Override the api version used for api requests made by this command
+      --file-path=<value>                  (required) Path to the file to upload.
+      --first-publish-location-id=<value>  Specify a record Id that the file should be linked to.
+      --title=<value>                      Specify the title for the file being uploaded.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Upload a file to a Salesforce org.
+
+  Uploads a file to a Salesforce org.
+
+EXAMPLES
+  $ sf simply data file upload --file-path fileToUpload.txt --target-org myTargetOrg
+
+  $ sf simply data file upload --file-path fileToUpload.txt --first-publish-location-id 0019000000DmehK --target-org myTargetOrg
+```
+
+_See code: [src/commands/simply/data/file/upload.ts](https://github.com/SimplySF/simply-data/blob/1.0.0/src/commands/simply/data/file/upload.ts)_
+
+## `sf simply data files upload`
+
+Upload files to a Salesforce org.
+
+```
+USAGE
+  $ sf simply data files upload --file-path <value> -o <value> [--json] [--api-version <value>] [--max-parallel-jobs
+  <value>]
+
+FLAGS
+  -o, --target-org=<value>         (required) Username or alias of the target org. Not required if the `target-org`
+                                   configuration variable is already set.
+      --api-version=<value>        Override the api version used for api requests made by this command
+      --file-path=<value>          (required) Path to the csv file that specifies the upload.
+      --max-parallel-jobs=<value>  [default: 1] Maximum number of parallel jobs.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Upload files to a Salesforce org.
+
+  Uploads files specified by a csv to a Salesforce org. By default, the plugin uses the REST API for the upload as the
+  Bulk API is limited in its payload size. This means that each file will use one REST API request.
+
+EXAMPLES
+  $ sf simply data files upload --file-path filesToUpload.csv --target-org myTargetOrg
+
+  $ sf simply data files upload --file-path filesToUpload.csv --max-parallel-jobs 5 --target-org myTargetOrg
+
+FLAG DESCRIPTIONS
+  --file-path=<value>  Path to the csv file that specifies the upload.
+
+    The csv file must specify the columns PathOnClient and Title. Optionally, a FirstPublishLocationId can be specified
+    to have it linked directly to a Salesforce record after upload.
+
+  --max-parallel-jobs=<value>  Maximum number of parallel jobs.
+
+    By default the plugin will only process a single file upload at a time. You can increase this value to allow for
+    quasi concurrent uploads. Please note that setting this value too high can cause performance issues.
+```
+
+_See code: [src/commands/simply/data/files/upload.ts](https://github.com/SimplySF/simply-data/blob/1.0.0/src/commands/simply/data/files/upload.ts)_
+<!-- commandsstop -->

package/lib/commands/simply/data/file/upload.d.ts

@@ -0,0 +1,15 @@
+import { SfCommand } from '@salesforce/sf-plugins-core';
+import { ContentVersion } from '../../../../common/contentVersionTypes.js';
+export default class DataFileUpload extends SfCommand<ContentVersion> {
+    static readonly summary: string;
+    static readonly description: string;
+    static readonly examples: string[];
+    static readonly flags: {
+        'api-version': import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        'file-path': import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        'first-publish-location-id': import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        'target-org': import("@oclif/core/lib/interfaces/parser.js").OptionFlag<import("@salesforce/core").Org, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        title: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    };
+    run(): Promise<ContentVersion>;
+}

package/lib/commands/simply/data/file/upload.js

@@ -0,0 +1,43 @@
+/*
+ * Copyright (c) 2024, Clay Chipps; Copyright (c) 2024, Salesforce.com, Inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import { Messages } from '@salesforce/core';
+import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
+import { uploadContentVersion } from '../../../../common/contentVersionUtils.js';
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
+const messages = Messages.loadMessages('@simplysf/simply-data', 'simply.data.file.upload');
+export default class DataFileUpload extends SfCommand {
+    static summary = messages.getMessage('summary');
+    static description = messages.getMessage('description');
+    static examples = messages.getMessages('examples');
+    static flags = {
+        'api-version': Flags.orgApiVersion(),
+        'file-path': Flags.directory({
+            summary: messages.getMessage('flags.file-path.summary'),
+            required: true,
+        }),
+        'first-publish-location-id': Flags.string({
+            summary: messages.getMessage('flags.first-publish-location-id.summary'),
+        }),
+        'target-org': Flags.requiredOrg(),
+        title: Flags.string({
+            summary: messages.getMessage('flags.title.summary'),
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(DataFileUpload);
+        // Authorize to the target org
+        const targetOrgConnection = flags['target-org']?.getConnection(flags['api-version']);
+        if (!targetOrgConnection) {
+            throw messages.createError('error.targetOrgConnectionFailed');
+        }
+        this.spinner.start('Uploading file', '', { stdout: true });
+        const contentVersion = await uploadContentVersion(targetOrgConnection, flags['file-path'], flags['title'], flags['first-publish-location-id']);
+        this.spinner.stop();
+        return contentVersion;
+    }
+}
+//# sourceMappingURL=upload.js.map

package/lib/commands/simply/data/file/upload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"upload.js","sourceRoot":"","sources":["../../../../../src/commands/simply/data/file/upload.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,oBAAoB,EAAE,MAAM,2CAA2C,CAAC;AAGjF,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,uBAAuB,EAAE,yBAAyB,CAAC,CAAC;AAE3F,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,SAAyB;IAC5D,MAAM,CAAU,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACzD,MAAM,CAAU,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,CAAU,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAE5D,MAAM,CAAU,KAAK,GAAG;QAC7B,aAAa,EAAE,KAAK,CAAC,aAAa,EAAE;QACpC,WAAW,EAAE,KAAK,CAAC,SAAS,CAAC;YAC3B,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,yBAAyB,CAAC;YACvD,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,2BAA2B,EAAE,KAAK,CAAC,MAAM,CAAC;YACxC,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,yCAAyC,CAAC;SACxE,CAAC;QACF,YAAY,EAAE,KAAK,CAAC,WAAW,EAAE;QACjC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC;YAClB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,qBAAqB,CAAC;SACpD,CAAC;KACH,CAAC;IAEK,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QAEnD,8BAA8B;QAC9B,MAAM,mBAAmB,GAAG,KAAK,CAAC,YAAY,CAAC,EAAE,aAAa,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;QAErF,IAAI,CAAC,mBAAmB,EAAE,CAAC;YACzB,MAAM,QAAQ,CAAC,WAAW,CAAC,iCAAiC,CAAC,CAAC;QAChE,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,gBAAgB,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QAE3D,MAAM,cAAc,GAAG,MAAM,oBAAoB,CAC/C,mBAAmB,EACnB,KAAK,CAAC,WAAW,CAAC,EAClB,KAAK,CAAC,OAAO,CAAC,EACd,KAAK,CAAC,2BAA2B,CAAC,CACnC,CAAC;QAEF,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QAEpB,OAAO,cAAc,CAAC;IACxB,CAAC"}

package/lib/commands/simply/data/files/upload.d.ts

@@ -0,0 +1,13 @@
+import { SfCommand } from '@salesforce/sf-plugins-core';
+export default class DataFilesUpload extends SfCommand<void> {
+    static readonly summary: string;
+    static readonly description: string;
+    static readonly examples: string[];
+    static readonly flags: {
+        'api-version': import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        'file-path': import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        'max-parallel-jobs': import("@oclif/core/lib/interfaces/parser.js").OptionFlag<number, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        'target-org': import("@oclif/core/lib/interfaces/parser.js").OptionFlag<import("@salesforce/core").Org, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    };
+    run(): Promise<void>;
+}

package/lib/commands/simply/data/files/upload.js

@@ -0,0 +1,90 @@
+/*
+ * Copyright (c) 2024, Clay Chipps; Copyright (c) 2024, Salesforce.com, Inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import fs from 'node:fs';
+import { parse } from 'csv-parse';
+import { createObjectCsvWriter } from 'csv-writer';
+import PQueue from 'p-queue';
+import { Messages } from '@salesforce/core';
+import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
+import { uploadContentVersion } from '../../../../common/contentVersionUtils.js';
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
+const messages = Messages.loadMessages('@simplysf/simply-data', 'simply.data.files.upload');
+export default class DataFilesUpload extends SfCommand {
+    static summary = messages.getMessage('summary');
+    static description = messages.getMessage('description');
+    static examples = messages.getMessages('examples');
+    static flags = {
+        'api-version': Flags.orgApiVersion(),
+        'file-path': Flags.directory({
+            summary: messages.getMessage('flags.file-path.summary'),
+            description: messages.getMessage('flags.file-path.description'),
+            required: true,
+        }),
+        'max-parallel-jobs': Flags.integer({
+            summary: messages.getMessage('flags.max-parallel-jobs.summary'),
+            description: messages.getMessage('flags.max-parallel-jobs.description'),
+            default: 1,
+        }),
+        'target-org': Flags.requiredOrg(),
+    };
+    async run() {
+        const { flags } = await this.parse(DataFilesUpload);
+        // Authorize to the target org
+        const targetOrgConnection = flags['target-org']?.getConnection(flags['api-version']);
+        if (!targetOrgConnection) {
+            throw messages.createError('error.targetOrgConnectionFailed');
+        }
+        this.spinner.start('Initializing file upload', '\n', { stdout: true });
+        const successWriter = createObjectCsvWriter({
+            path: 'success.csv',
+            header: [
+                { id: 'PathOnClient', title: 'PathOnClient' },
+                { id: 'Title', title: 'Title' },
+                { id: 'FirstPublishLocationId', title: 'FirstPublishLocationId' },
+                { id: 'ContentDocumentId', title: 'ContentDocumentId' },
+            ],
+        });
+        const errorWriter = createObjectCsvWriter({
+            path: 'error.csv',
+            header: [
+                { id: 'PathOnClient', title: 'PathOnClient' },
+                { id: 'Title', title: 'Title' },
+                { id: 'FirstPublishLocationId', title: 'FirstPublishLocationId' },
+                { id: 'Error', title: 'Error' },
+            ],
+        });
+        this.spinner.stop();
+        const fileQueue = new PQueue({ concurrency: flags['max-parallel-jobs'] });
+        const parser = fs.createReadStream(flags['file-path']).pipe(parse({ bom: true, columns: true }));
+        this.spinner.start('Uploading files', 'Initializing\n', { stdout: true });
+        let count = 0;
+        fileQueue.on('add', () => {
+            this.spinner.status = `Completed: ${count}. Size: ${fileQueue.size}  Pending: ${fileQueue.pending}\n`;
+        });
+        fileQueue.on('completed', () => {
+            count++;
+            this.spinner.status = `Completed: ${count}. Size: ${fileQueue.size}  Pending: ${fileQueue.pending}\n`;
+        });
+        for await (const record of parser) {
+            void fileQueue.add(async () => {
+                const contentVersionToUpload = record;
+                try {
+                    const contentVersion = await uploadContentVersion(targetOrgConnection, contentVersionToUpload.PathOnClient, contentVersionToUpload.Title, contentVersionToUpload.FirstPublishLocationId);
+                    contentVersionToUpload.ContentDocumentId = contentVersion.ContentDocumentId;
+                    await successWriter.writeRecords([contentVersionToUpload]);
+                }
+                catch (error) {
+                    contentVersionToUpload.Error = error;
+                    await errorWriter.writeRecords([contentVersionToUpload]);
+                }
+            });
+        }
+        await fileQueue.onIdle();
+        this.spinner.stop();
+    }
+}
+//# sourceMappingURL=upload.js.map

package/lib/commands/simply/data/files/upload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"upload.js","sourceRoot":"","sources":["../../../../../src/commands/simply/data/files/upload.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,MAAM,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,oBAAoB,EAAE,MAAM,2CAA2C,CAAC;AAGjF,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,uBAAuB,EAAE,0BAA0B,CAAC,CAAC;AAE5F,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,SAAe;IACnD,MAAM,CAAU,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACzD,MAAM,CAAU,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,CAAU,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAE5D,MAAM,CAAU,KAAK,GAAG;QAC7B,aAAa,EAAE,KAAK,CAAC,aAAa,EAAE;QACpC,WAAW,EAAE,KAAK,CAAC,SAAS,CAAC;YAC3B,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,yBAAyB,CAAC;YACvD,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,6BAA6B,CAAC;YAC/D,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,mBAAmB,EAAE,KAAK,CAAC,OAAO,CAAC;YACjC,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,iCAAiC,CAAC;YAC/D,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,qCAAqC,CAAC;YACvE,OAAO,EAAE,CAAC;SACX,CAAC;QACF,YAAY,EAAE,KAAK,CAAC,WAAW,EAAE;KAClC,CAAC;IAEK,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QAEpD,8BAA8B;QAC9B,MAAM,mBAAmB,GAAG,KAAK,CAAC,YAAY,CAAC,EAAE,aAAa,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;QAErF,IAAI,CAAC,mBAAmB,EAAE,CAAC;YACzB,MAAM,QAAQ,CAAC,WAAW,CAAC,iCAAiC,CAAC,CAAC;QAChE,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,0BAA0B,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QAEvE,MAAM,aAAa,GAAG,qBAAqB,CAAC;YAC1C,IAAI,EAAE,aAAa;YACnB,MAAM,EAAE;gBACN,EAAE,EAAE,EAAE,cAAc,EAAE,KAAK,EAAE,cAAc,EAAE;gBAC7C,EAAE,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE;gBAC/B,EAAE,EAAE,EAAE,wBAAwB,EAAE,KAAK,EAAE,wBAAwB,EAAE;gBACjE,EAAE,EAAE,EAAE,mBAAmB,EAAE,KAAK,EAAE,mBAAmB,EAAE;aACxD;SACF,CAAC,CAAC;QAEH,MAAM,WAAW,GAAG,qBAAqB,CAAC;YACxC,IAAI,EAAE,WAAW;YACjB,MAAM,EAAE;gBACN,EAAE,EAAE,EAAE,cAAc,EAAE,KAAK,EAAE,cAAc,EAAE;gBAC7C,EAAE,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE;gBAC/B,EAAE,EAAE,EAAE,wBAAwB,EAAE,KAAK,EAAE,wBAAwB,EAAE;gBACjE,EAAE,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE;aAChC;SACF,CAAC,CAAC;QAEH,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QAEpB,MAAM,SAAS,GAAG,IAAI,MAAM,CAAC,EAAE,WAAW,EAAE,KAAK,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAC;QAE1E,MAAM,MAAM,GAAG,EAAE,CAAC,gBAAgB,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QAEjG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,iBAAiB,EAAE,gBAAgB,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QAE1E,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;YACvB,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,cAAc,KAAK,WAAW,SAAS,CAAC,IAAI,cAAc,SAAS,CAAC,OAAO,IAAI,CAAC;QACxG,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,EAAE,CAAC,WAAW,EAAE,GAAG,EAAE;YAC7B,KAAK,EAAE,CAAC;YACR,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,cAAc,KAAK,WAAW,SAAS,CAAC,IAAI,cAAc,SAAS,CAAC,OAAO,IAAI,CAAC;QACxG,CAAC,CAAC,CAAC;QAEH,IAAI,KAAK,EAAE,MAAM,MAAM,IAAI,MAAM,EAAE,CAAC;YAClC,KAAK,SAAS,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE;gBAC5B,MAAM,sBAAsB,GAAG,MAAgC,CAAC;gBAChE,IAAI,CAAC;oBACH,MAAM,cAAc,GAAG,MAAM,oBAAoB,CAC/C,mBAAmB,EACnB,sBAAsB,CAAC,YAAY,EACnC,sBAAsB,CAAC,KAAK,EAC5B,sBAAsB,CAAC,sBAAsB,CAC9C,CAAC;oBACF,sBAAsB,CAAC,iBAAiB,GAAG,cAAc,CAAC,iBAAiB,CAAC;oBAC5E,MAAM,aAAa,CAAC,YAAY,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC;gBAC7D,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,sBAAsB,CAAC,KAAK,GAAG,KAAe,CAAC;oBAC/C,MAAM,WAAW,CAAC,YAAY,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC;gBAC3D,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;QAED,MAAM,SAAS,CAAC,MAAM,EAAE,CAAC;QAEzB,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;IACtB,CAAC"}

package/lib/common/contentVersionTypes.d.ts

@@ -0,0 +1,25 @@
+export interface ContentVersion {
+    ContentDocumentId?: string;
+    FileExtension: string;
+    Id: string;
+    Title: string;
+}
+export interface ContentVersionCreateRequest {
+    FirstPublishLocationId?: string;
+    PathOnClient: string;
+    Title?: string;
+}
+export interface ContentVersionCreateResult {
+    id: string;
+    success: boolean;
+    errors: string[];
+    name: string;
+    message: string;
+}
+export type ContentVersionToUpload = {
+    ContentDocumentId?: string;
+    Error?: string;
+    FirstPublishLocationId?: string;
+    PathOnClient: string;
+    Title: string;
+};

package/lib/common/contentVersionTypes.js

@@ -0,0 +1,8 @@
+/*
+ * Copyright (c) 2024, Clay Chipps; Copyright (c) 2024, Salesforce.com, Inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+export {};
+//# sourceMappingURL=contentVersionTypes.js.map

package/lib/common/contentVersionTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contentVersionTypes.js","sourceRoot":"","sources":["../../src/common/contentVersionTypes.ts"],"names":[],"mappings":"AAAA;;;;;GAKG"}

package/lib/common/contentVersionUtils.d.ts

@@ -0,0 +1,3 @@
+import { Connection } from '@salesforce/core';
+import { ContentVersion } from './contentVersionTypes.js';
+export declare function uploadContentVersion(targetOrgConnection: Connection, pathOnClient: string, title?: string, firstPublishLocationId?: string): Promise<ContentVersion>;

package/lib/common/contentVersionUtils.js

@@ -0,0 +1,34 @@
+/*
+ * Copyright (c) 2024, Clay Chipps; Copyright (c) 2024, Salesforce.com, Inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import fs from 'node:fs';
+import path from 'node:path';
+import FormData from 'form-data';
+import got from 'got';
+export async function uploadContentVersion(targetOrgConnection, pathOnClient, title, firstPublishLocationId) {
+    // Check that we have access to the file
+    await fs.promises.access(pathOnClient, fs.constants.F_OK);
+    const contentVersionCreateRequest = {
+        FirstPublishLocationId: firstPublishLocationId,
+        PathOnClient: pathOnClient,
+        Title: title ?? path.basename(pathOnClient),
+    };
+    const form = new FormData();
+    form.append('entity_content', JSON.stringify(contentVersionCreateRequest), { contentType: 'application/json' });
+    form.append('VersionData', fs.createReadStream(pathOnClient), { filename: path.basename(pathOnClient) });
+    const data = await got.post(`${targetOrgConnection.baseUrl()}/sobjects/ContentVersion`, {
+        body: form,
+        headers: {
+            Authorization: `Bearer ${targetOrgConnection.accessToken}`,
+            'Content-Type': `multipart/form-data; boundary="${form.getBoundary()}"`,
+        },
+        resolveBodyOnly: true,
+        responseType: 'json',
+    });
+    const queryResult = await targetOrgConnection.singleRecordQuery(`SELECT ContentDocumentId, FileExtension, Id, Title FROM ContentVersion WHERE Id='${data.id}'`);
+    return queryResult;
+}
+//# sourceMappingURL=contentVersionUtils.js.map

package/lib/common/contentVersionUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contentVersionUtils.js","sourceRoot":"","sources":["../../src/common/contentVersionUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,QAAQ,MAAM,WAAW,CAAC;AACjC,OAAO,GAAG,MAAM,KAAK,CAAC;AAItB,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,mBAA+B,EAC/B,YAAoB,EACpB,KAAc,EACd,sBAA+B;IAE/B,wCAAwC;IACxC,MAAM,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAE1D,MAAM,2BAA2B,GAAgC;QAC/D,sBAAsB,EAAE,sBAAsB;QAC9C,YAAY,EAAE,YAAY;QAC1B,KAAK,EAAE,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;KAC5C,CAAC;IAEF,MAAM,IAAI,GAAG,IAAI,QAAQ,EAAE,CAAC;IAC5B,IAAI,CAAC,MAAM,CAAC,gBAAgB,EAAE,IAAI,CAAC,SAAS,CAAC,2BAA2B,CAAC,EAAE,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC,CAAC;IAChH,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,EAAE,CAAC,gBAAgB,CAAC,YAAY,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;IAEzG,MAAM,IAAI,GAA+B,MAAM,GAAG,CAAC,IAAI,CAAC,GAAG,mBAAmB,CAAC,OAAO,EAAE,0BAA0B,EAAE;QAClH,IAAI,EAAE,IAAI;QACV,OAAO,EAAE;YACP,aAAa,EAAE,UAAU,mBAAmB,CAAC,WAAW,EAAE;YAC1D,cAAc,EAAE,kCAAkC,IAAI,CAAC,WAAW,EAAE,GAAG;SACxE;QACD,eAAe,EAAE,IAAI;QACrB,YAAY,EAAE,MAAM;KACrB,CAAC,CAAC;IAEH,MAAM,WAAW,GAAG,MAAM,mBAAmB,CAAC,iBAAiB,CAC7D,oFAAoF,IAAI,CAAC,EAAE,GAAG,CAC/F,CAAC;IAEF,OAAO,WAA6B,CAAC;AACvC,CAAC"}

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+declare const _default: {};
+export default _default;

package/lib/index.js

@@ -0,0 +1,8 @@
+/*
+ * Copyright (c) 2024, Clay Chipps; Copyright (c) 2024, Salesforce.com, Inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+export default {};
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAe,EAAE,CAAC"}

package/messages/simply.data.file.upload.md

@@ -0,0 +1,29 @@
+# summary
+
+Upload a file to a Salesforce org.
+
+# description
+
+Uploads a file to a Salesforce org.
+
+# flags.file-path.summary
+
+Path to the file to upload.
+
+# flags.first-publish-location-id.summary
+
+Specify a record Id that the file should be linked to.
+
+# flags.title.summary
+
+Specify the title for the file being uploaded.
+
+# examples
+
+- <%= config.bin %> <%= command.id %> --file-path fileToUpload.txt --target-org myTargetOrg
+
+- <%= config.bin %> <%= command.id %> --file-path fileToUpload.txt --first-publish-location-id 0019000000DmehK --target-org myTargetOrg
+
+# error.targetOrgConnectionFailed
+
+Unable to establish connection to the org.

package/messages/simply.data.files.upload.md

@@ -0,0 +1,33 @@
+# summary
+
+Upload files to a Salesforce org.
+
+# description
+
+Uploads files specified by a csv to a Salesforce org. By default, the plugin uses the REST API for the upload as the Bulk API is limited in its payload size. This means that each file will use one REST API request.
+
+# flags.file-path.summary
+
+Path to the csv file that specifies the upload.
+
+# flags.file-path.description
+
+The csv file must specify the columns PathOnClient and Title. Optionally, a FirstPublishLocationId can be specified to have it linked directly to a Salesforce record after upload.
+
+# flags.max-parallel-jobs.summary
+
+Maximum number of parallel jobs.
+
+# flags.max-parallel-jobs.description
+
+By default the plugin will only process a single file upload at a time. You can increase this value to allow for quasi concurrent uploads. Please note that setting this value too high can cause performance issues.
+
+# examples
+
+- <%= config.bin %> <%= command.id %> --file-path filesToUpload.csv --target-org myTargetOrg
+
+- <%= config.bin %> <%= command.id %> --file-path filesToUpload.csv --max-parallel-jobs 5 --target-org myTargetOrg
+
+# error.targetOrgConnectionFailed
+
+Unable to establish connection to the org.