@simplysf/simply-data 1.0.0 → 1.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/CHANGELOG.md +19 -0
  2. package/README.md +59 -59
  3. package/messages/simply.data.file.upload.md +29 -29
  4. package/messages/simply.data.files.upload.md +33 -33
  5. package/npm-shrinkwrap.json +9 -9
  6. package/oclif.lock +9269 -9269
  7. package/oclif.manifest.json +81 -81
  8. package/package.json +219 -219
package/oclif.manifest.json CHANGED
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "commands": {
3
- "simply:data:file:upload": {
3
+ "simply:data:files:upload": {
4
4
  "aliases": [],
5
5
  "args": {},
6
- "description": "Uploads a file to a Salesforce org.",
6
+ "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.",
7
7
  "examples": [
8
- "<%= config.bin %> <%= command.id %> --file-path fileToUpload.txt --target-org myTargetOrg",
9
- "<%= config.bin %> <%= command.id %> --file-path fileToUpload.txt --first-publish-location-id 0019000000DmehK --target-org myTargetOrg"
8
+ "<%= config.bin %> <%= command.id %> --file-path filesToUpload.csv --target-org myTargetOrg",
9
+ "<%= config.bin %> <%= command.id %> --file-path filesToUpload.csv --max-parallel-jobs 5 --target-org myTargetOrg"
10
10
  ],
11
11
  "flags": {
12
12
  "json": {
@@ -24,16 +24,19 @@
24
24
  "type": "option"
25
25
  },
26
26
  "file-path": {
27
+ "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.",
27
28
  "name": "file-path",
28
29
  "required": true,
29
- "summary": "Path to the file to upload.",
30
+ "summary": "Path to the csv file that specifies the upload.",
30
31
  "hasDynamicHelp": false,
31
32
  "multiple": false,
32
33
  "type": "option"
33
34
  },
34
- "first-publish-location-id": {
35
- "name": "first-publish-location-id",
36
- "summary": "Specify a record Id that the file should be linked to.",
35
+ "max-parallel-jobs": {
36
+ "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.",
37
+ "name": "max-parallel-jobs",
38
+ "summary": "Maximum number of parallel jobs.",
39
+ "default": 1,
37
40
  "hasDynamicHelp": false,
38
41
  "multiple": false,
39
42
  "type": "option"
@@ -47,23 +50,16 @@
47
50
  "hasDynamicHelp": true,
48
51
  "multiple": false,
49
52
  "type": "option"
50
- },
51
- "title": {
52
- "name": "title",
53
- "summary": "Specify the title for the file being uploaded.",
54
- "hasDynamicHelp": false,
55
- "multiple": false,
56
- "type": "option"
57
53
  }
58
54
  },
59
55
  "hasDynamicHelp": true,
60
56
  "hiddenAliases": [],
61
- "id": "simply:data:file:upload",
57
+ "id": "simply:data:files:upload",
62
58
  "pluginAlias": "@simplysf/simply-data",
63
59
  "pluginName": "@simplysf/simply-data",
64
60
  "pluginType": "core",
65
61
  "strict": true,
66
- "summary": "Upload a file to a Salesforce org.",
62
+ "summary": "Upload files to a Salesforce org.",
67
63
  "enableJsonFlag": true,
68
64
  "SF_ENV": "SF_ENV",
69
65
  "isESM": true,
@@ -72,44 +68,44 @@
72
68
  "commands",
73
69
  "simply",
74
70
  "data",
75
- "file",
71
+ "files",
76
72
  "upload.js"
77
73
  ],
78
74
  "aliasPermutations": [],
79
75
  "permutations": [
80
- "simply:data:file:upload",
81
- "data:simply:file:upload",
82
- "data:file:simply:upload",
83
- "data:file:upload:simply",
84
- "simply:file:data:upload",
85
- "file:simply:data:upload",
86
- "file:data:simply:upload",
87
- "file:data:upload:simply",
88
- "simply:file:upload:data",
89
- "file:simply:upload:data",
90
- "file:upload:simply:data",
91
- "file:upload:data:simply",
92
- "simply:data:upload:file",
93
- "data:simply:upload:file",
94
- "data:upload:simply:file",
95
- "data:upload:file:simply",
96
- "simply:upload:data:file",
97
- "upload:simply:data:file",
98
- "upload:data:simply:file",
99
- "upload:data:file:simply",
100
- "simply:upload:file:data",
101
- "upload:simply:file:data",
102
- "upload:file:simply:data",
103
- "upload:file:data:simply"
76
+ "simply:data:files:upload",
77
+ "data:simply:files:upload",
78
+ "data:files:simply:upload",
79
+ "data:files:upload:simply",
80
+ "simply:files:data:upload",
81
+ "files:simply:data:upload",
82
+ "files:data:simply:upload",
83
+ "files:data:upload:simply",
84
+ "simply:files:upload:data",
85
+ "files:simply:upload:data",
86
+ "files:upload:simply:data",
87
+ "files:upload:data:simply",
88
+ "simply:data:upload:files",
89
+ "data:simply:upload:files",
90
+ "data:upload:simply:files",
91
+ "data:upload:files:simply",
92
+ "simply:upload:data:files",
93
+ "upload:simply:data:files",
94
+ "upload:data:simply:files",
95
+ "upload:data:files:simply",
96
+ "simply:upload:files:data",
97
+ "upload:simply:files:data",
98
+ "upload:files:simply:data",
99
+ "upload:files:data:simply"
104
100
  ]
105
101
  },
106
- "simply:data:files:upload": {
102
+ "simply:data:file:upload": {
107
103
  "aliases": [],
108
104
  "args": {},
109
- "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.",
105
+ "description": "Uploads a file to a Salesforce org.",
110
106
  "examples": [
111
- "<%= config.bin %> <%= command.id %> --file-path filesToUpload.csv --target-org myTargetOrg",
112
- "<%= config.bin %> <%= command.id %> --file-path filesToUpload.csv --max-parallel-jobs 5 --target-org myTargetOrg"
107
+ "<%= config.bin %> <%= command.id %> --file-path fileToUpload.txt --target-org myTargetOrg",
108
+ "<%= config.bin %> <%= command.id %> --file-path fileToUpload.txt --first-publish-location-id 0019000000DmehK --target-org myTargetOrg"
113
109
  ],
114
110
  "flags": {
115
111
  "json": {
@@ -127,19 +123,16 @@
127
123
  "type": "option"
128
124
  },
129
125
  "file-path": {
130
- "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.",
131
126
  "name": "file-path",
132
127
  "required": true,
133
- "summary": "Path to the csv file that specifies the upload.",
128
+ "summary": "Path to the file to upload.",
134
129
  "hasDynamicHelp": false,
135
130
  "multiple": false,
136
131
  "type": "option"
137
132
  },
138
- "max-parallel-jobs": {
139
- "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.",
140
- "name": "max-parallel-jobs",
141
- "summary": "Maximum number of parallel jobs.",
142
- "default": 1,
133
+ "first-publish-location-id": {
134
+ "name": "first-publish-location-id",
135
+ "summary": "Specify a record Id that the file should be linked to.",
143
136
  "hasDynamicHelp": false,
144
137
  "multiple": false,
145
138
  "type": "option"
@@ -153,16 +146,23 @@
153
146
  "hasDynamicHelp": true,
154
147
  "multiple": false,
155
148
  "type": "option"
149
+ },
150
+ "title": {
151
+ "name": "title",
152
+ "summary": "Specify the title for the file being uploaded.",
153
+ "hasDynamicHelp": false,
154
+ "multiple": false,
155
+ "type": "option"
156
156
  }
157
157
  },
158
158
  "hasDynamicHelp": true,
159
159
  "hiddenAliases": [],
160
- "id": "simply:data:files:upload",
160
+ "id": "simply:data:file:upload",
161
161
  "pluginAlias": "@simplysf/simply-data",
162
162
  "pluginName": "@simplysf/simply-data",
163
163
  "pluginType": "core",
164
164
  "strict": true,
165
- "summary": "Upload files to a Salesforce org.",
165
+ "summary": "Upload a file to a Salesforce org.",
166
166
  "enableJsonFlag": true,
167
167
  "SF_ENV": "SF_ENV",
168
168
  "isESM": true,
@@ -171,37 +171,37 @@
171
171
  "commands",
172
172
  "simply",
173
173
  "data",
174
- "files",
174
+ "file",
175
175
  "upload.js"
176
176
  ],
177
177
  "aliasPermutations": [],
178
178
  "permutations": [
179
- "simply:data:files:upload",
180
- "data:simply:files:upload",
181
- "data:files:simply:upload",
182
- "data:files:upload:simply",
183
- "simply:files:data:upload",
184
- "files:simply:data:upload",
185
- "files:data:simply:upload",
186
- "files:data:upload:simply",
187
- "simply:files:upload:data",
188
- "files:simply:upload:data",
189
- "files:upload:simply:data",
190
- "files:upload:data:simply",
191
- "simply:data:upload:files",
192
- "data:simply:upload:files",
193
- "data:upload:simply:files",
194
- "data:upload:files:simply",
195
- "simply:upload:data:files",
196
- "upload:simply:data:files",
197
- "upload:data:simply:files",
198
- "upload:data:files:simply",
199
- "simply:upload:files:data",
200
- "upload:simply:files:data",
201
- "upload:files:simply:data",
202
- "upload:files:data:simply"
179
+ "simply:data:file:upload",
180
+ "data:simply:file:upload",
181
+ "data:file:simply:upload",
182
+ "data:file:upload:simply",
183
+ "simply:file:data:upload",
184
+ "file:simply:data:upload",
185
+ "file:data:simply:upload",
186
+ "file:data:upload:simply",
187
+ "simply:file:upload:data",
188
+ "file:simply:upload:data",
189
+ "file:upload:simply:data",
190
+ "file:upload:data:simply",
191
+ "simply:data:upload:file",
192
+ "data:simply:upload:file",
193
+ "data:upload:simply:file",
194
+ "data:upload:file:simply",
195
+ "simply:upload:data:file",
196
+ "upload:simply:data:file",
197
+ "upload:data:simply:file",
198
+ "upload:data:file:simply",
199
+ "simply:upload:file:data",
200
+ "upload:simply:file:data",
201
+ "upload:file:simply:data",
202
+ "upload:file:data:simply"
203
203
  ]
204
204
  }
205
205
  },
206
- "version": "1.0.0"
206
+ "version": "1.1.1"
207
207
  }