@simplysf/simply-data 1.0.0 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +9 -0
- package/README.md +59 -59
- package/messages/simply.data.file.upload.md +29 -29
- package/messages/simply.data.files.upload.md +33 -33
- package/npm-shrinkwrap.json +2 -2
- package/oclif.lock +9269 -9269
- package/oclif.manifest.json +1 -1
- package/package.json +219 -219
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -1,60 +1,60 @@
|
|
|
1
|
-
# @simplysf/simply-data
|
|
2
|
-
|
|
3
|
-
[](https://npmjs.com/package/@simplysf/simply-package) [](https://npmjs.com/package/@simplysf/simply-package) [](https://raw.githubusercontent.com/SimplySF/simply-data/main/LICENSE.txt)
|
|
4
|
-
|
|
5
|
-
## Install
|
|
6
|
-
|
|
7
|
-
```bash
|
|
8
|
-
sf plugins install @simplysf/simply-data
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
## Issues
|
|
12
|
-
|
|
13
|
-
Please report any issues at https://github.com/SimplySF/simply-data/issues
|
|
14
|
-
|
|
15
|
-
## Contributing
|
|
16
|
-
|
|
17
|
-
1. Please read our [Code of Conduct](CODE_OF_CONDUCT.md)
|
|
18
|
-
2. Create a new issue before starting your project so that we can keep track of
|
|
19
|
-
what you are trying to add/fix. That way, we can also offer suggestions or
|
|
20
|
-
let you know if there is already an effort in progress.
|
|
21
|
-
3. Fork this repository.
|
|
22
|
-
4. [Build the plugin locally](#build)
|
|
23
|
-
5. Create a _topic_ branch in your fork. Note, this step is recommended but technically not required if contributing using a fork.
|
|
24
|
-
6. Edit the code in your fork.
|
|
25
|
-
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.
|
|
26
|
-
8. Send us a pull request when you are done. We'll review your code, suggest any needed changes, and merge it in.
|
|
27
|
-
|
|
28
|
-
### Build
|
|
29
|
-
|
|
30
|
-
To build the plugin locally, make sure to have yarn installed and run the following commands:
|
|
31
|
-
|
|
32
|
-
```bash
|
|
33
|
-
# Clone the repository
|
|
34
|
-
git clone git@github.com:SimplySF/simply-data
|
|
35
|
-
|
|
36
|
-
# Install the dependencies and compile
|
|
37
|
-
yarn && yarn build
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
To use your plugin, run using the local `./bin/dev` or `./bin/dev.cmd` file.
|
|
41
|
-
|
|
42
|
-
```bash
|
|
43
|
-
# Run using local run file.
|
|
44
|
-
./bin/dev.cmd simply data
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
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.
|
|
48
|
-
|
|
49
|
-
```bash
|
|
50
|
-
# Link your plugin to the sf cli
|
|
51
|
-
sf plugins link .
|
|
52
|
-
# To verify
|
|
53
|
-
sf plugins
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
## Commands
|
|
57
|
-
|
|
1
|
+
# @simplysf/simply-data
|
|
2
|
+
|
|
3
|
+
[](https://npmjs.com/package/@simplysf/simply-package) [](https://npmjs.com/package/@simplysf/simply-package) [](https://raw.githubusercontent.com/SimplySF/simply-data/main/LICENSE.txt)
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
sf plugins install @simplysf/simply-data
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Issues
|
|
12
|
+
|
|
13
|
+
Please report any issues at https://github.com/SimplySF/simply-data/issues
|
|
14
|
+
|
|
15
|
+
## Contributing
|
|
16
|
+
|
|
17
|
+
1. Please read our [Code of Conduct](CODE_OF_CONDUCT.md)
|
|
18
|
+
2. Create a new issue before starting your project so that we can keep track of
|
|
19
|
+
what you are trying to add/fix. That way, we can also offer suggestions or
|
|
20
|
+
let you know if there is already an effort in progress.
|
|
21
|
+
3. Fork this repository.
|
|
22
|
+
4. [Build the plugin locally](#build)
|
|
23
|
+
5. Create a _topic_ branch in your fork. Note, this step is recommended but technically not required if contributing using a fork.
|
|
24
|
+
6. Edit the code in your fork.
|
|
25
|
+
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.
|
|
26
|
+
8. Send us a pull request when you are done. We'll review your code, suggest any needed changes, and merge it in.
|
|
27
|
+
|
|
28
|
+
### Build
|
|
29
|
+
|
|
30
|
+
To build the plugin locally, make sure to have yarn installed and run the following commands:
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
# Clone the repository
|
|
34
|
+
git clone git@github.com:SimplySF/simply-data
|
|
35
|
+
|
|
36
|
+
# Install the dependencies and compile
|
|
37
|
+
yarn && yarn build
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
To use your plugin, run using the local `./bin/dev` or `./bin/dev.cmd` file.
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
# Run using local run file.
|
|
44
|
+
./bin/dev.cmd simply data
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
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.
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
# Link your plugin to the sf cli
|
|
51
|
+
sf plugins link .
|
|
52
|
+
# To verify
|
|
53
|
+
sf plugins
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
## Commands
|
|
57
|
+
|
|
58
58
|
<!-- commands -->
|
|
59
59
|
* [`sf simply data file upload`](#sf-simply-data-file-upload)
|
|
60
60
|
* [`sf simply data files upload`](#sf-simply-data-files-upload)
|
|
@@ -90,7 +90,7 @@ EXAMPLES
|
|
|
90
90
|
$ sf simply data file upload --file-path fileToUpload.txt --first-publish-location-id 0019000000DmehK --target-org myTargetOrg
|
|
91
91
|
```
|
|
92
92
|
|
|
93
|
-
_See code: [src/commands/simply/data/file/upload.ts](https://github.com/SimplySF/simply-data/blob/1.0
|
|
93
|
+
_See code: [src/commands/simply/data/file/upload.ts](https://github.com/SimplySF/simply-data/blob/0.1.0/src/commands/simply/data/file/upload.ts)_
|
|
94
94
|
|
|
95
95
|
## `sf simply data files upload`
|
|
96
96
|
|
|
@@ -134,5 +134,5 @@ FLAG DESCRIPTIONS
|
|
|
134
134
|
quasi concurrent uploads. Please note that setting this value too high can cause performance issues.
|
|
135
135
|
```
|
|
136
136
|
|
|
137
|
-
_See code: [src/commands/simply/data/files/upload.ts](https://github.com/SimplySF/simply-data/blob/1.0
|
|
137
|
+
_See code: [src/commands/simply/data/files/upload.ts](https://github.com/SimplySF/simply-data/blob/0.1.0/src/commands/simply/data/files/upload.ts)_
|
|
138
138
|
<!-- commandsstop -->
|
|
@@ -1,29 +1,29 @@
|
|
|
1
|
-
# summary
|
|
2
|
-
|
|
3
|
-
Upload a file to a Salesforce org.
|
|
4
|
-
|
|
5
|
-
# description
|
|
6
|
-
|
|
7
|
-
Uploads a file to a Salesforce org.
|
|
8
|
-
|
|
9
|
-
# flags.file-path.summary
|
|
10
|
-
|
|
11
|
-
Path to the file to upload.
|
|
12
|
-
|
|
13
|
-
# flags.first-publish-location-id.summary
|
|
14
|
-
|
|
15
|
-
Specify a record Id that the file should be linked to.
|
|
16
|
-
|
|
17
|
-
# flags.title.summary
|
|
18
|
-
|
|
19
|
-
Specify the title for the file being uploaded.
|
|
20
|
-
|
|
21
|
-
# examples
|
|
22
|
-
|
|
23
|
-
- <%= config.bin %> <%= command.id %> --file-path fileToUpload.txt --target-org myTargetOrg
|
|
24
|
-
|
|
25
|
-
- <%= config.bin %> <%= command.id %> --file-path fileToUpload.txt --first-publish-location-id 0019000000DmehK --target-org myTargetOrg
|
|
26
|
-
|
|
27
|
-
# error.targetOrgConnectionFailed
|
|
28
|
-
|
|
29
|
-
Unable to establish connection to the org.
|
|
1
|
+
# summary
|
|
2
|
+
|
|
3
|
+
Upload a file to a Salesforce org.
|
|
4
|
+
|
|
5
|
+
# description
|
|
6
|
+
|
|
7
|
+
Uploads a file to a Salesforce org.
|
|
8
|
+
|
|
9
|
+
# flags.file-path.summary
|
|
10
|
+
|
|
11
|
+
Path to the file to upload.
|
|
12
|
+
|
|
13
|
+
# flags.first-publish-location-id.summary
|
|
14
|
+
|
|
15
|
+
Specify a record Id that the file should be linked to.
|
|
16
|
+
|
|
17
|
+
# flags.title.summary
|
|
18
|
+
|
|
19
|
+
Specify the title for the file being uploaded.
|
|
20
|
+
|
|
21
|
+
# examples
|
|
22
|
+
|
|
23
|
+
- <%= config.bin %> <%= command.id %> --file-path fileToUpload.txt --target-org myTargetOrg
|
|
24
|
+
|
|
25
|
+
- <%= config.bin %> <%= command.id %> --file-path fileToUpload.txt --first-publish-location-id 0019000000DmehK --target-org myTargetOrg
|
|
26
|
+
|
|
27
|
+
# error.targetOrgConnectionFailed
|
|
28
|
+
|
|
29
|
+
Unable to establish connection to the org.
|
|
@@ -1,33 +1,33 @@
|
|
|
1
|
-
# summary
|
|
2
|
-
|
|
3
|
-
Upload files to a Salesforce org.
|
|
4
|
-
|
|
5
|
-
# description
|
|
6
|
-
|
|
7
|
-
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.
|
|
8
|
-
|
|
9
|
-
# flags.file-path.summary
|
|
10
|
-
|
|
11
|
-
Path to the csv file that specifies the upload.
|
|
12
|
-
|
|
13
|
-
# flags.file-path.description
|
|
14
|
-
|
|
15
|
-
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.
|
|
16
|
-
|
|
17
|
-
# flags.max-parallel-jobs.summary
|
|
18
|
-
|
|
19
|
-
Maximum number of parallel jobs.
|
|
20
|
-
|
|
21
|
-
# flags.max-parallel-jobs.description
|
|
22
|
-
|
|
23
|
-
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.
|
|
24
|
-
|
|
25
|
-
# examples
|
|
26
|
-
|
|
27
|
-
- <%= config.bin %> <%= command.id %> --file-path filesToUpload.csv --target-org myTargetOrg
|
|
28
|
-
|
|
29
|
-
- <%= config.bin %> <%= command.id %> --file-path filesToUpload.csv --max-parallel-jobs 5 --target-org myTargetOrg
|
|
30
|
-
|
|
31
|
-
# error.targetOrgConnectionFailed
|
|
32
|
-
|
|
33
|
-
Unable to establish connection to the org.
|
|
1
|
+
# summary
|
|
2
|
+
|
|
3
|
+
Upload files to a Salesforce org.
|
|
4
|
+
|
|
5
|
+
# description
|
|
6
|
+
|
|
7
|
+
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.
|
|
8
|
+
|
|
9
|
+
# flags.file-path.summary
|
|
10
|
+
|
|
11
|
+
Path to the csv file that specifies the upload.
|
|
12
|
+
|
|
13
|
+
# flags.file-path.description
|
|
14
|
+
|
|
15
|
+
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.
|
|
16
|
+
|
|
17
|
+
# flags.max-parallel-jobs.summary
|
|
18
|
+
|
|
19
|
+
Maximum number of parallel jobs.
|
|
20
|
+
|
|
21
|
+
# flags.max-parallel-jobs.description
|
|
22
|
+
|
|
23
|
+
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.
|
|
24
|
+
|
|
25
|
+
# examples
|
|
26
|
+
|
|
27
|
+
- <%= config.bin %> <%= command.id %> --file-path filesToUpload.csv --target-org myTargetOrg
|
|
28
|
+
|
|
29
|
+
- <%= config.bin %> <%= command.id %> --file-path filesToUpload.csv --max-parallel-jobs 5 --target-org myTargetOrg
|
|
30
|
+
|
|
31
|
+
# error.targetOrgConnectionFailed
|
|
32
|
+
|
|
33
|
+
Unable to establish connection to the org.
|
package/npm-shrinkwrap.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@simplysf/simply-data",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.1.0",
|
|
4
4
|
"lockfileVersion": 3,
|
|
5
5
|
"requires": true,
|
|
6
6
|
"packages": {
|
|
7
7
|
"": {
|
|
8
8
|
"name": "@simplysf/simply-data",
|
|
9
|
-
"version": "1.
|
|
9
|
+
"version": "1.1.0",
|
|
10
10
|
"license": "BSD-3-Clause",
|
|
11
11
|
"dependencies": {
|
|
12
12
|
"@oclif/core": "^3.19.2",
|