@mysf/plugin-sf-data-export 1.0.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.
@@ -0,0 +1,469 @@
1
+ {
2
+ "commands": {
3
+ "data:bulk": {
4
+ "aliases": [],
5
+ "args": {},
6
+ "examples": [
7
+ "sf data bulk --object Account --target-org my-org",
8
+ "sf data bulk --object Contact --target-org my-org"
9
+ ],
10
+ "flags": {
11
+ "json": {
12
+ "description": "Format output as json.",
13
+ "helpGroup": "GLOBAL",
14
+ "name": "json",
15
+ "allowNo": false,
16
+ "type": "boolean"
17
+ },
18
+ "flags-dir": {
19
+ "helpGroup": "GLOBAL",
20
+ "name": "flags-dir",
21
+ "summary": "Import flag values from a directory.",
22
+ "hasDynamicHelp": false,
23
+ "multiple": false,
24
+ "type": "option"
25
+ },
26
+ "target-org": {
27
+ "char": "o",
28
+ "name": "target-org",
29
+ "noCacheDefault": true,
30
+ "required": true,
31
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
32
+ "hasDynamicHelp": true,
33
+ "multiple": false,
34
+ "type": "option"
35
+ },
36
+ "object": {
37
+ "char": "s",
38
+ "name": "object",
39
+ "required": true,
40
+ "summary": "The API name of the object.",
41
+ "hasDynamicHelp": false,
42
+ "multiple": false,
43
+ "type": "option"
44
+ },
45
+ "output": {
46
+ "char": "t",
47
+ "name": "output",
48
+ "summary": "The file path to save the results.",
49
+ "default": "bulkExport.json",
50
+ "hasDynamicHelp": false,
51
+ "multiple": false,
52
+ "type": "option"
53
+ }
54
+ },
55
+ "hasDynamicHelp": true,
56
+ "hiddenAliases": [],
57
+ "id": "data:bulk",
58
+ "pluginAlias": "@mysf/plugin-sf-data-export",
59
+ "pluginName": "@mysf/plugin-sf-data-export",
60
+ "pluginType": "core",
61
+ "strict": true,
62
+ "summary": "Export all fields from a specific object.",
63
+ "enableJsonFlag": true,
64
+ "isESM": true,
65
+ "relativePath": [
66
+ "lib",
67
+ "commands",
68
+ "data",
69
+ "bulk.js"
70
+ ],
71
+ "aliasPermutations": [],
72
+ "permutations": [
73
+ "data:bulk",
74
+ "bulk:data"
75
+ ]
76
+ },
77
+ "data:caseCreationController": {
78
+ "aliases": [],
79
+ "args": {},
80
+ "examples": [
81
+ "sf data export --soql \"SELECT Name FROM Account\" --target-org my-org",
82
+ "sf data export --soql \"SELECT Id, Status FROM Case\" --output results.json"
83
+ ],
84
+ "flags": {
85
+ "json": {
86
+ "description": "Format output as json.",
87
+ "helpGroup": "GLOBAL",
88
+ "name": "json",
89
+ "allowNo": false,
90
+ "type": "boolean"
91
+ },
92
+ "flags-dir": {
93
+ "helpGroup": "GLOBAL",
94
+ "name": "flags-dir",
95
+ "summary": "Import flag values from a directory.",
96
+ "hasDynamicHelp": false,
97
+ "multiple": false,
98
+ "type": "option"
99
+ },
100
+ "target-org": {
101
+ "char": "o",
102
+ "name": "target-org",
103
+ "noCacheDefault": true,
104
+ "required": true,
105
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
106
+ "hasDynamicHelp": true,
107
+ "multiple": false,
108
+ "type": "option"
109
+ }
110
+ },
111
+ "hasDynamicHelp": true,
112
+ "hiddenAliases": [],
113
+ "id": "data:caseCreationController",
114
+ "pluginAlias": "@mysf/plugin-sf-data-export",
115
+ "pluginName": "@mysf/plugin-sf-data-export",
116
+ "pluginType": "core",
117
+ "strict": true,
118
+ "summary": "Calling a specific method of the Apex class present in the target org.",
119
+ "enableJsonFlag": true,
120
+ "isESM": true,
121
+ "relativePath": [
122
+ "lib",
123
+ "commands",
124
+ "data",
125
+ "caseCreationController.js"
126
+ ],
127
+ "aliasPermutations": [],
128
+ "permutations": [
129
+ "data:caseCreationController",
130
+ "caseCreationController:data"
131
+ ]
132
+ },
133
+ "data:compare": {
134
+ "aliases": [],
135
+ "args": {},
136
+ "examples": [
137
+ "sf data compare --object Account --source-org \"DevOrg\" --target-org \"ProdOrg\""
138
+ ],
139
+ "flags": {
140
+ "json": {
141
+ "description": "Format output as json.",
142
+ "helpGroup": "GLOBAL",
143
+ "name": "json",
144
+ "allowNo": false,
145
+ "type": "boolean"
146
+ },
147
+ "flags-dir": {
148
+ "helpGroup": "GLOBAL",
149
+ "name": "flags-dir",
150
+ "summary": "Import flag values from a directory.",
151
+ "hasDynamicHelp": false,
152
+ "multiple": false,
153
+ "type": "option"
154
+ },
155
+ "object": {
156
+ "char": "s",
157
+ "name": "object",
158
+ "required": true,
159
+ "summary": "The API name of the object.",
160
+ "hasDynamicHelp": false,
161
+ "multiple": false,
162
+ "type": "option"
163
+ },
164
+ "source-org": {
165
+ "char": "a",
166
+ "name": "source-org",
167
+ "noCacheDefault": true,
168
+ "required": true,
169
+ "summary": "The first org (Source)",
170
+ "hasDynamicHelp": true,
171
+ "multiple": false,
172
+ "type": "option"
173
+ },
174
+ "target-org": {
175
+ "char": "b",
176
+ "name": "target-org",
177
+ "noCacheDefault": true,
178
+ "required": true,
179
+ "summary": "The second org (Target)",
180
+ "hasDynamicHelp": true,
181
+ "multiple": false,
182
+ "type": "option"
183
+ }
184
+ },
185
+ "hasDynamicHelp": true,
186
+ "hiddenAliases": [],
187
+ "id": "data:compare",
188
+ "pluginAlias": "@mysf/plugin-sf-data-export",
189
+ "pluginName": "@mysf/plugin-sf-data-export",
190
+ "pluginType": "core",
191
+ "strict": true,
192
+ "summary": "Compare fields of an object between two orgs.",
193
+ "enableJsonFlag": true,
194
+ "isESM": true,
195
+ "relativePath": [
196
+ "lib",
197
+ "commands",
198
+ "data",
199
+ "compare.js"
200
+ ],
201
+ "aliasPermutations": [],
202
+ "permutations": [
203
+ "data:compare",
204
+ "compare:data"
205
+ ]
206
+ },
207
+ "data:export": {
208
+ "aliases": [],
209
+ "args": {},
210
+ "examples": [
211
+ "sf data export --soql \"SELECT Name FROM Account\" --target-org my-org",
212
+ "sf data export --soql \"SELECT Id, Status FROM Case\" --output results.json"
213
+ ],
214
+ "flags": {
215
+ "json": {
216
+ "description": "Format output as json.",
217
+ "helpGroup": "GLOBAL",
218
+ "name": "json",
219
+ "allowNo": false,
220
+ "type": "boolean"
221
+ },
222
+ "flags-dir": {
223
+ "helpGroup": "GLOBAL",
224
+ "name": "flags-dir",
225
+ "summary": "Import flag values from a directory.",
226
+ "hasDynamicHelp": false,
227
+ "multiple": false,
228
+ "type": "option"
229
+ },
230
+ "target-org": {
231
+ "char": "o",
232
+ "name": "target-org",
233
+ "noCacheDefault": true,
234
+ "required": true,
235
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
236
+ "hasDynamicHelp": true,
237
+ "multiple": false,
238
+ "type": "option"
239
+ },
240
+ "soql": {
241
+ "char": "q",
242
+ "name": "soql",
243
+ "required": true,
244
+ "summary": "The SOQL query to execute.",
245
+ "hasDynamicHelp": false,
246
+ "multiple": false,
247
+ "type": "option"
248
+ },
249
+ "output": {
250
+ "char": "f",
251
+ "name": "output",
252
+ "summary": "The file path to save the results.",
253
+ "default": "export.json",
254
+ "hasDynamicHelp": false,
255
+ "multiple": false,
256
+ "type": "option"
257
+ }
258
+ },
259
+ "hasDynamicHelp": true,
260
+ "hiddenAliases": [],
261
+ "id": "data:export",
262
+ "pluginAlias": "@mysf/plugin-sf-data-export",
263
+ "pluginName": "@mysf/plugin-sf-data-export",
264
+ "pluginType": "core",
265
+ "strict": true,
266
+ "summary": "Export data from an org in JSON format.",
267
+ "enableJsonFlag": true,
268
+ "isESM": true,
269
+ "relativePath": [
270
+ "lib",
271
+ "commands",
272
+ "data",
273
+ "export.js"
274
+ ],
275
+ "aliasPermutations": [],
276
+ "permutations": [
277
+ "data:export",
278
+ "export:data"
279
+ ]
280
+ },
281
+ "data:gitDifferencePlugin": {
282
+ "aliases": [],
283
+ "args": {},
284
+ "examples": [
285
+ "sf data export --soql \"SELECT Name FROM Account\" --target-org my-org",
286
+ "sf data export --soql \"SELECT Id, Status FROM Case\" --output results.json"
287
+ ],
288
+ "flags": {
289
+ "json": {
290
+ "description": "Format output as json.",
291
+ "helpGroup": "GLOBAL",
292
+ "name": "json",
293
+ "allowNo": false,
294
+ "type": "boolean"
295
+ },
296
+ "flags-dir": {
297
+ "helpGroup": "GLOBAL",
298
+ "name": "flags-dir",
299
+ "summary": "Import flag values from a directory.",
300
+ "hasDynamicHelp": false,
301
+ "multiple": false,
302
+ "type": "option"
303
+ },
304
+ "base-sha": {
305
+ "char": "b",
306
+ "name": "base-sha",
307
+ "summary": "The commit SHA to compare against",
308
+ "default": "HEAD~1",
309
+ "hasDynamicHelp": false,
310
+ "multiple": false,
311
+ "type": "option"
312
+ }
313
+ },
314
+ "hasDynamicHelp": false,
315
+ "hiddenAliases": [],
316
+ "id": "data:gitDifferencePlugin",
317
+ "pluginAlias": "@mysf/plugin-sf-data-export",
318
+ "pluginName": "@mysf/plugin-sf-data-export",
319
+ "pluginType": "core",
320
+ "strict": true,
321
+ "summary": "Detects changed files using Git",
322
+ "enableJsonFlag": true,
323
+ "isESM": true,
324
+ "relativePath": [
325
+ "lib",
326
+ "commands",
327
+ "data",
328
+ "gitDifferencePlugin.js"
329
+ ],
330
+ "aliasPermutations": [],
331
+ "permutations": [
332
+ "data:gitDifferencePlugin",
333
+ "gitDifferencePlugin:data"
334
+ ]
335
+ },
336
+ "data:restExport": {
337
+ "aliases": [],
338
+ "args": {},
339
+ "examples": [
340
+ "sf data restExport --target-org OrgA",
341
+ "sf data restExport --target-org OrgA --output ./custom/path.json"
342
+ ],
343
+ "flags": {
344
+ "json": {
345
+ "description": "Format output as json.",
346
+ "helpGroup": "GLOBAL",
347
+ "name": "json",
348
+ "allowNo": false,
349
+ "type": "boolean"
350
+ },
351
+ "flags-dir": {
352
+ "helpGroup": "GLOBAL",
353
+ "name": "flags-dir",
354
+ "summary": "Import flag values from a directory.",
355
+ "hasDynamicHelp": false,
356
+ "multiple": false,
357
+ "type": "option"
358
+ },
359
+ "target-org": {
360
+ "char": "o",
361
+ "name": "target-org",
362
+ "noCacheDefault": true,
363
+ "required": true,
364
+ "summary": "The second org (Target)",
365
+ "hasDynamicHelp": true,
366
+ "multiple": false,
367
+ "type": "option"
368
+ },
369
+ "output": {
370
+ "char": "f",
371
+ "name": "output",
372
+ "summary": "The file path to save the results.",
373
+ "default": "./data/restExport.json",
374
+ "hasDynamicHelp": false,
375
+ "multiple": false,
376
+ "type": "option"
377
+ }
378
+ },
379
+ "hasDynamicHelp": true,
380
+ "hiddenAliases": [],
381
+ "id": "data:restExport",
382
+ "pluginAlias": "@mysf/plugin-sf-data-export",
383
+ "pluginName": "@mysf/plugin-sf-data-export",
384
+ "pluginType": "core",
385
+ "strict": true,
386
+ "summary": "Exports data from Org A via Apex REST for Git versioning.",
387
+ "enableJsonFlag": true,
388
+ "requiresOrg": true,
389
+ "isESM": true,
390
+ "relativePath": [
391
+ "lib",
392
+ "commands",
393
+ "data",
394
+ "restExport.js"
395
+ ],
396
+ "aliasPermutations": [],
397
+ "permutations": [
398
+ "data:restExport",
399
+ "restExport:data"
400
+ ]
401
+ },
402
+ "data:restImport": {
403
+ "aliases": [],
404
+ "args": {},
405
+ "examples": [
406
+ "sf data restImport --target-org OrgB --input-file ./data/contact.json"
407
+ ],
408
+ "flags": {
409
+ "json": {
410
+ "description": "Format output as json.",
411
+ "helpGroup": "GLOBAL",
412
+ "name": "json",
413
+ "allowNo": false,
414
+ "type": "boolean"
415
+ },
416
+ "flags-dir": {
417
+ "helpGroup": "GLOBAL",
418
+ "name": "flags-dir",
419
+ "summary": "Import flag values from a directory.",
420
+ "hasDynamicHelp": false,
421
+ "multiple": false,
422
+ "type": "option"
423
+ },
424
+ "target-org": {
425
+ "char": "o",
426
+ "name": "target-org",
427
+ "noCacheDefault": true,
428
+ "required": true,
429
+ "summary": "The second org (Target)",
430
+ "hasDynamicHelp": true,
431
+ "multiple": false,
432
+ "type": "option"
433
+ },
434
+ "input-file": {
435
+ "char": "f",
436
+ "name": "input-file",
437
+ "summary": "The file path to be taken as an input for the import.",
438
+ "default": "./data/restExport.json",
439
+ "hasDynamicHelp": false,
440
+ "multiple": false,
441
+ "type": "option"
442
+ }
443
+ },
444
+ "hasDynamicHelp": true,
445
+ "hiddenAliases": [],
446
+ "id": "data:restImport",
447
+ "pluginAlias": "@mysf/plugin-sf-data-export",
448
+ "pluginName": "@mysf/plugin-sf-data-export",
449
+ "pluginType": "core",
450
+ "strict": true,
451
+ "summary": "Import data to the Org B via Apex REST for Git versioning.",
452
+ "enableJsonFlag": true,
453
+ "requiresOrg": true,
454
+ "isESM": true,
455
+ "relativePath": [
456
+ "lib",
457
+ "commands",
458
+ "data",
459
+ "restImport.js"
460
+ ],
461
+ "aliasPermutations": [],
462
+ "permutations": [
463
+ "data:restImport",
464
+ "restImport:data"
465
+ ]
466
+ }
467
+ },
468
+ "version": "1.0.0"
469
+ }
package/package.json ADDED
@@ -0,0 +1,212 @@
1
+ {
2
+ "name": "@mysf/plugin-sf-data-export",
3
+ "description": "Plugin to export data from salesforce",
4
+ "version": "1.0.0",
5
+ "author": "Salesforce",
6
+ "main": "lib/index.js",
7
+ "bin": {
8
+ "plugin-sf-data-export": "./bin/run.js"
9
+ },
10
+
11
+ "pkg": {
12
+ "scripts": "lib/**/*.js",
13
+ "assets": [
14
+ "messages/**/*",
15
+ "oclif.manifest.json"
16
+ ],
17
+ "targets": [
18
+ "node18-win-x64"
19
+ ]
20
+ },
21
+
22
+ "bugs": "https://github.com/forcedotcom/cli/issues",
23
+ "dependencies": {
24
+ "@oclif/core": "^4",
25
+ "@salesforce/core": "^8.24.0",
26
+ "@salesforce/kit": "^3.2.4",
27
+ "@salesforce/sf-plugins-core": "^12",
28
+ "@salesforce/ts-types": "^2.0.12",
29
+ "simple-git": "^3.30.0"
30
+ },
31
+ "devDependencies": {
32
+ "@oclif/plugin-command-snapshot": "^5.3.8",
33
+ "@salesforce/cli-plugins-testkit": "^5.1.12",
34
+ "@salesforce/dev-scripts": "^11.0.4",
35
+ "@salesforce/plugin-command-reference": "^3.1.79",
36
+ "@types/node": "20.19.33",
37
+ "eslint-plugin-sf-plugin": "^1.20.33",
38
+ "oclif": "^4.22.59",
39
+ "ts-node": "^10.9.2",
40
+ "typescript": "5.3.3"
41
+ },
42
+ "engines": {
43
+ "node": ">=18.0.0"
44
+ },
45
+ "files": [
46
+ "lib/**/*.js",
47
+ "messages/**",
48
+ "oclif.manifest.json",
49
+ "package.json"
50
+ ],
51
+ "homepage": "https://github.com/salesforcecli/plugin-sf-data-export",
52
+ "keywords": [
53
+ "force",
54
+ "salesforce",
55
+ "salesforcedx",
56
+ "sf",
57
+ "sf-plugin",
58
+ "sfdx",
59
+ "sfdx-plugin"
60
+ ],
61
+ "license": "Apache-2.0",
62
+ "oclif": {
63
+ "commands": "./lib/commands",
64
+ "bin": "sf",
65
+ "topicSeparator": " ",
66
+ "devPlugins": [
67
+ "@oclif/plugin-help",
68
+ "@oclif/plugin-command-snapshot",
69
+ "@salesforce/plugin-command-reference"
70
+ ],
71
+ "topics": {
72
+ "hello": {
73
+ "description": "Commands to say hello."
74
+ }
75
+ },
76
+ "flexibleTaxonomy": true
77
+ },
78
+ "repository": "salesforcecli/plugin-sf-data-export",
79
+ "scripts": {
80
+ "build": "tsc -p .",
81
+ "pkg": "npm run build && pkg . --output sf-data-export.exe",
82
+ "clean": "sf-clean",
83
+ "clean-all": "sf-clean all",
84
+ "compile": "tsc -p .",
85
+ "lint": "eslint src test --color",
86
+ "prepack": "npm run build",
87
+ "postpack": "",
88
+ "test": "npm run lint",
89
+ "test:nuts": "nyc mocha \"**/*.nut.ts\" --slow 4500 --timeout 600000 --parallel",
90
+ "version": "oclif readme"
91
+ },
92
+ "publishConfig": {
93
+ "access": "public"
94
+ },
95
+ "wireit": {
96
+ "build": {
97
+ "dependencies": [
98
+ "compile",
99
+ "lint"
100
+ ]
101
+ },
102
+ "compile": {
103
+ "command": "tsc -p . --pretty --incremental",
104
+ "files": [
105
+ "src/**/*.ts",
106
+ "**/tsconfig.json",
107
+ "messages/**"
108
+ ],
109
+ "output": [
110
+ "lib/**",
111
+ "*.tsbuildinfo"
112
+ ],
113
+ "clean": "if-file-deleted"
114
+ },
115
+ "format": {
116
+ "command": "prettier --write \"+(src|test|schemas)/**/*.+(ts|js|json)|command-snapshot.json\"",
117
+ "files": [
118
+ "src/**/*.ts",
119
+ "test/**/*.ts",
120
+ "schemas/**/*.json",
121
+ "command-snapshot.json",
122
+ ".prettier*"
123
+ ],
124
+ "output": []
125
+ },
126
+ "lint": {
127
+ "command": "eslint src test --color --cache --cache-location .eslintcache",
128
+ "files": [
129
+ "src/**/*.ts",
130
+ "test/**/*.ts",
131
+ "messages/**",
132
+ "**/.eslint*",
133
+ "**/tsconfig.json"
134
+ ],
135
+ "output": []
136
+ },
137
+ "test:compile": {
138
+ "command": "tsc -p \"./test\" --pretty",
139
+ "files": [
140
+ "test/**/*.ts",
141
+ "**/tsconfig.json"
142
+ ],
143
+ "output": []
144
+ },
145
+ "test": {
146
+ "dependencies": [
147
+ "test:compile",
148
+ "test:only",
149
+ "test:command-reference",
150
+ "test:deprecation-policy",
151
+ "lint",
152
+ "test:json-schema",
153
+ "link-check"
154
+ ]
155
+ },
156
+ "test:only": {
157
+ "command": "nyc mocha \"test/**/*.test.ts\"",
158
+ "env": {
159
+ "FORCE_COLOR": "2"
160
+ },
161
+ "files": [
162
+ "test/**/*.ts",
163
+ "src/**/*.ts",
164
+ "**/tsconfig.json",
165
+ ".mocha*",
166
+ "!*.nut.ts",
167
+ ".nycrc"
168
+ ],
169
+ "output": []
170
+ },
171
+ "test:command-reference": {
172
+ "command": "node --loader ts-node/esm --no-warnings=ExperimentalWarning \"./bin/dev.js\" commandreference:generate --erroronwarnings",
173
+ "files": [
174
+ "src/**/*.ts",
175
+ "messages/**",
176
+ "package.json"
177
+ ],
178
+ "output": [
179
+ "tmp/root"
180
+ ]
181
+ },
182
+ "test:deprecation-policy": {
183
+ "command": "node --loader ts-node/esm --no-warnings=ExperimentalWarning \"./bin/dev.js\" snapshot:compare",
184
+ "files": [
185
+ "src/**/*.ts"
186
+ ],
187
+ "output": [],
188
+ "dependencies": [
189
+ "compile"
190
+ ]
191
+ },
192
+ "test:json-schema": {
193
+ "command": "node --loader ts-node/esm --no-warnings=ExperimentalWarning \"./bin/dev.js\" schema:compare",
194
+ "files": [
195
+ "src/**/*.ts",
196
+ "schemas"
197
+ ],
198
+ "output": []
199
+ },
200
+ "link-check": {
201
+ "command": "node -e \"process.exit(process.env.CI ? 0 : 1)\" || linkinator \"**/*.md\" --skip \"CHANGELOG.md|node_modules|test/|confluence.internal.salesforce.com|my.salesforce.com|localhost|%s\" --markdown --retry --directory-listing --verbosity error",
202
+ "files": [
203
+ "./*.md",
204
+ "./!(CHANGELOG).md",
205
+ "messages/**/*.md"
206
+ ],
207
+ "output": []
208
+ }
209
+ },
210
+ "exports": "./lib/index.js",
211
+ "type": "module"
212
+ }