@salesforce/plugin-deploy-retrieve 1.3.0 → 1.4.2

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 (62) hide show
  1. package/CHANGELOG.md +18 -0
  2. package/README.md +385 -7
  3. package/lib/commands/deploy/metadata/cancel.d.ts +18 -0
  4. package/lib/commands/deploy/metadata/cancel.js +86 -0
  5. package/lib/commands/deploy/metadata/cancel.js.map +1 -0
  6. package/lib/commands/deploy/metadata/quick.d.ts +23 -0
  7. package/lib/commands/deploy/metadata/quick.js +116 -0
  8. package/lib/commands/deploy/metadata/quick.js.map +1 -0
  9. package/lib/commands/deploy/metadata/report.d.ts +14 -0
  10. package/lib/commands/deploy/metadata/report.js +54 -0
  11. package/lib/commands/deploy/metadata/report.js.map +1 -0
  12. package/lib/commands/deploy/metadata/resume.d.ts +21 -0
  13. package/lib/commands/deploy/metadata/resume.js +89 -0
  14. package/lib/commands/deploy/metadata/resume.js.map +1 -0
  15. package/lib/commands/deploy/metadata/validate.d.ts +27 -0
  16. package/lib/commands/deploy/metadata/validate.js +136 -0
  17. package/lib/commands/deploy/metadata/validate.js.map +1 -0
  18. package/lib/commands/deploy/metadata.d.ts +7 -9
  19. package/lib/commands/deploy/metadata.js +40 -15
  20. package/lib/commands/deploy/metadata.js.map +1 -1
  21. package/lib/commands/deploy.js.map +1 -1
  22. package/lib/commands/retrieve/metadata.d.ts +4 -6
  23. package/lib/commands/retrieve/metadata.js +11 -25
  24. package/lib/commands/retrieve/metadata.js.map +1 -1
  25. package/lib/configMeta.d.ts +17 -0
  26. package/lib/configMeta.js +31 -0
  27. package/lib/configMeta.js.map +1 -0
  28. package/lib/utils/deploy.d.ts +26 -7
  29. package/lib/utils/deploy.js +114 -24
  30. package/lib/utils/deploy.js.map +1 -1
  31. package/lib/utils/errorCodes.d.ts +3 -0
  32. package/lib/utils/errorCodes.js +26 -0
  33. package/lib/utils/errorCodes.js.map +1 -0
  34. package/lib/utils/metadataDeployer.js +7 -4
  35. package/lib/utils/metadataDeployer.js.map +1 -1
  36. package/lib/utils/output.d.ts +65 -8
  37. package/lib/utils/output.js +320 -169
  38. package/lib/utils/output.js.map +1 -1
  39. package/lib/utils/progressBar.js +2 -1
  40. package/lib/utils/progressBar.js.map +1 -1
  41. package/lib/utils/types.d.ts +11 -5
  42. package/lib/utils/types.js.map +1 -1
  43. package/messages/cache.md +7 -0
  44. package/messages/config.md +7 -0
  45. package/messages/deploy.async.md +19 -0
  46. package/messages/deploy.metadata.cancel.md +62 -0
  47. package/messages/deploy.metadata.md +17 -3
  48. package/messages/deploy.metadata.quick.md +81 -0
  49. package/messages/deploy.metadata.report.md +42 -0
  50. package/messages/deploy.metadata.resume.md +58 -0
  51. package/messages/deploy.metadata.validate.md +123 -0
  52. package/messages/errorCodes.md +27 -0
  53. package/oclif.manifest.json +1 -1
  54. package/package.json +16 -9
  55. package/schemas/deploy-metadata-cancel.json +664 -0
  56. package/schemas/deploy-metadata-quick.json +664 -0
  57. package/schemas/deploy-metadata-report.json +664 -0
  58. package/schemas/deploy-metadata-resume.json +664 -0
  59. package/schemas/deploy-metadata-validate.json +664 -0
  60. package/schemas/deploy-metadata.json +592 -29
  61. package/schemas/hooks/sf-deploy.json +15 -5
  62. package/schemas/retrieve-metadata.json +178 -11
package/schemas/deploy-metadata.json CHANGED
@@ -1,25 +1,125 @@
1
1
  {
2
2
  "$schema": "http://json-schema.org/draft-07/schema#",
3
- "$ref": "#/definitions/DeployMetadataResult",
3
+ "$ref": "#/definitions/DeployResultJson",
4
4
  "definitions": {
5
- "DeployMetadataResult": {
6
- "type": "object",
7
- "properties": {
8
- "files": {
9
- "type": "array",
10
- "items": {
11
- "$ref": "#/definitions/FileResponse"
12
- }
13
- },
14
- "jobId": {
15
- "type": "string"
5
+ "DeployResultJson": {
6
+ "anyOf": [
7
+ {
8
+ "type": "object",
9
+ "additionalProperties": false,
10
+ "properties": {
11
+ "files": {
12
+ "type": "array",
13
+ "items": {
14
+ "$ref": "#/definitions/FileResponse"
15
+ }
16
+ },
17
+ "id": {
18
+ "type": "string"
19
+ },
20
+ "status": {
21
+ "$ref": "#/definitions/RequestStatus"
22
+ },
23
+ "success": {
24
+ "type": "boolean"
25
+ },
26
+ "done": {
27
+ "type": "boolean"
28
+ },
29
+ "canceledBy": {
30
+ "type": "string"
31
+ },
32
+ "canceledByName": {
33
+ "type": "string"
34
+ },
35
+ "checkOnly": {
36
+ "type": "boolean"
37
+ },
38
+ "completedDate": {
39
+ "type": "string"
40
+ },
41
+ "createdBy": {
42
+ "type": "string"
43
+ },
44
+ "createdByName": {
45
+ "type": "string"
46
+ },
47
+ "createdDate": {
48
+ "type": "string"
49
+ },
50
+ "details": {
51
+ "$ref": "#/definitions/DeployDetails"
52
+ },
53
+ "errorMessage": {
54
+ "type": "string"
55
+ },
56
+ "errorStatusCode": {
57
+ "type": "string"
58
+ },
59
+ "ignoreWarnings": {
60
+ "type": "boolean"
61
+ },
62
+ "lastModifiedDate": {
63
+ "type": "string"
64
+ },
65
+ "numberComponentErrors": {
66
+ "type": "number"
67
+ },
68
+ "numberComponentsDeployed": {
69
+ "type": "number"
70
+ },
71
+ "numberComponentsTotal": {
72
+ "type": "number"
73
+ },
74
+ "numberTestErrors": {
75
+ "type": "number"
76
+ },
77
+ "numberTestsCompleted": {
78
+ "type": "number"
79
+ },
80
+ "numberTestsTotal": {
81
+ "type": "number"
82
+ },
83
+ "runTestsEnabled": {
84
+ "type": "boolean"
85
+ },
86
+ "rollbackOnError": {
87
+ "type": "boolean"
88
+ },
89
+ "startDate": {
90
+ "type": "string"
91
+ },
92
+ "stateDetail": {
93
+ "type": "string"
94
+ }
95
+ },
96
+ "required": [
97
+ "checkOnly",
98
+ "createdBy",
99
+ "createdByName",
100
+ "createdDate",
101
+ "details",
102
+ "done",
103
+ "files",
104
+ "id",
105
+ "ignoreWarnings",
106
+ "lastModifiedDate",
107
+ "numberComponentErrors",
108
+ "numberComponentsDeployed",
109
+ "numberComponentsTotal",
110
+ "numberTestErrors",
111
+ "numberTestsCompleted",
112
+ "numberTestsTotal",
113
+ "rollbackOnError",
114
+ "runTestsEnabled",
115
+ "status",
116
+ "success"
117
+ ]
16
118
  },
17
- "tests": {
18
- "$ref": "#/definitions/TestResults"
119
+ {
120
+ "$ref": "#/definitions/AsyncDeployResultJson"
19
121
  }
20
- },
21
- "required": ["files", "jobId"],
22
- "additionalProperties": false
122
+ ]
23
123
  },
24
124
  "FileResponse": {
25
125
  "anyOf": [
@@ -37,10 +137,19 @@
37
137
  },
38
138
  "state": {
39
139
  "type": "string",
40
- "enum": ["Created", "Changed", "Unchanged", "Deleted"]
140
+ "enum": [
141
+ "Created",
142
+ "Changed",
143
+ "Unchanged",
144
+ "Deleted"
145
+ ]
41
146
  }
42
147
  },
43
- "required": ["fullName", "state", "type"],
148
+ "required": [
149
+ "fullName",
150
+ "state",
151
+ "type"
152
+ ],
44
153
  "additionalProperties": false
45
154
  },
46
155
  {
@@ -70,32 +179,486 @@
70
179
  },
71
180
  "problemType": {
72
181
  "type": "string",
73
- "enum": ["Warning", "Error"]
182
+ "enum": [
183
+ "Warning",
184
+ "Error"
185
+ ]
74
186
  }
75
187
  },
76
- "required": ["error", "fullName", "problemType", "state", "type"],
188
+ "required": [
189
+ "error",
190
+ "fullName",
191
+ "problemType",
192
+ "state",
193
+ "type"
194
+ ],
77
195
  "additionalProperties": false
78
196
  }
79
197
  ]
80
198
  },
81
- "TestResults": {
199
+ "RequestStatus": {
200
+ "type": "string",
201
+ "enum": [
202
+ "Pending",
203
+ "InProgress",
204
+ "Succeeded",
205
+ "SucceededPartial",
206
+ "Failed",
207
+ "Canceling",
208
+ "Canceled"
209
+ ]
210
+ },
211
+ "DeployDetails": {
212
+ "type": "object",
213
+ "properties": {
214
+ "componentFailures": {
215
+ "anyOf": [
216
+ {
217
+ "$ref": "#/definitions/DeployMessage"
218
+ },
219
+ {
220
+ "type": "array",
221
+ "items": {
222
+ "$ref": "#/definitions/DeployMessage"
223
+ }
224
+ }
225
+ ]
226
+ },
227
+ "componentSuccesses": {
228
+ "anyOf": [
229
+ {
230
+ "$ref": "#/definitions/DeployMessage"
231
+ },
232
+ {
233
+ "type": "array",
234
+ "items": {
235
+ "$ref": "#/definitions/DeployMessage"
236
+ }
237
+ }
238
+ ]
239
+ },
240
+ "runTestResult": {
241
+ "$ref": "#/definitions/RunTestResult"
242
+ }
243
+ },
244
+ "additionalProperties": false
245
+ },
246
+ "DeployMessage": {
82
247
  "type": "object",
83
248
  "properties": {
84
- "passing": {
249
+ "changed": {
250
+ "type": [
251
+ "string",
252
+ "boolean"
253
+ ],
254
+ "enum": [
255
+ "true",
256
+ "false",
257
+ true,
258
+ false
259
+ ]
260
+ },
261
+ "columnNumber": {
262
+ "type": "string"
263
+ },
264
+ "componentType": {
265
+ "type": "string"
266
+ },
267
+ "created": {
268
+ "type": [
269
+ "string",
270
+ "boolean"
271
+ ],
272
+ "enum": [
273
+ "true",
274
+ "false",
275
+ true,
276
+ false
277
+ ]
278
+ },
279
+ "createdDate": {
280
+ "type": "string"
281
+ },
282
+ "deleted": {
283
+ "type": [
284
+ "string",
285
+ "boolean"
286
+ ],
287
+ "enum": [
288
+ "true",
289
+ "false",
290
+ true,
291
+ false
292
+ ]
293
+ },
294
+ "fileName": {
295
+ "type": "string"
296
+ },
297
+ "fullName": {
298
+ "type": "string"
299
+ },
300
+ "id": {
301
+ "type": "string"
302
+ },
303
+ "lineNumber": {
304
+ "type": "string"
305
+ },
306
+ "problem": {
307
+ "type": "string"
308
+ },
309
+ "problemType": {
310
+ "type": "string",
311
+ "enum": [
312
+ "Warning",
313
+ "Error"
314
+ ]
315
+ },
316
+ "success": {
317
+ "type": [
318
+ "string",
319
+ "boolean"
320
+ ],
321
+ "enum": [
322
+ "true",
323
+ "false",
324
+ true,
325
+ false
326
+ ]
327
+ }
328
+ },
329
+ "required": [
330
+ "changed",
331
+ "created",
332
+ "createdDate",
333
+ "deleted",
334
+ "fileName",
335
+ "fullName",
336
+ "success"
337
+ ],
338
+ "additionalProperties": false
339
+ },
340
+ "RunTestResult": {
341
+ "type": "object",
342
+ "properties": {
343
+ "codeCoverage": {
344
+ "anyOf": [
345
+ {
346
+ "type": "array",
347
+ "items": {
348
+ "$ref": "#/definitions/CodeCoverage"
349
+ }
350
+ },
351
+ {
352
+ "$ref": "#/definitions/CodeCoverage"
353
+ }
354
+ ]
355
+ },
356
+ "codeCoverageWarnings": {
357
+ "anyOf": [
358
+ {
359
+ "type": "array",
360
+ "items": {
361
+ "$ref": "#/definitions/CodeCoverageWarnings"
362
+ }
363
+ },
364
+ {
365
+ "$ref": "#/definitions/CodeCoverageWarnings"
366
+ }
367
+ ]
368
+ },
369
+ "failures": {
370
+ "anyOf": [
371
+ {
372
+ "type": "array",
373
+ "items": {
374
+ "$ref": "#/definitions/Failures"
375
+ }
376
+ },
377
+ {
378
+ "$ref": "#/definitions/Failures"
379
+ }
380
+ ]
381
+ },
382
+ "numFailures": {
383
+ "type": "string"
384
+ },
385
+ "numTestsRun": {
386
+ "type": "string"
387
+ },
388
+ "successes": {
389
+ "anyOf": [
390
+ {
391
+ "type": "array",
392
+ "items": {
393
+ "$ref": "#/definitions/Successes"
394
+ }
395
+ },
396
+ {
397
+ "$ref": "#/definitions/Successes"
398
+ }
399
+ ]
400
+ },
401
+ "totalTime": {
402
+ "type": "string"
403
+ }
404
+ },
405
+ "required": [
406
+ "numFailures",
407
+ "numTestsRun",
408
+ "totalTime"
409
+ ],
410
+ "additionalProperties": false
411
+ },
412
+ "CodeCoverage": {
413
+ "type": "object",
414
+ "properties": {
415
+ "id": {
416
+ "type": "string"
417
+ },
418
+ "locationsNotCovered": {
419
+ "anyOf": [
420
+ {
421
+ "type": "array",
422
+ "items": {
423
+ "$ref": "#/definitions/LocationsNotCovered"
424
+ }
425
+ },
426
+ {
427
+ "$ref": "#/definitions/LocationsNotCovered"
428
+ }
429
+ ]
430
+ },
431
+ "name": {
432
+ "type": "string"
433
+ },
434
+ "numLocations": {
435
+ "type": "string"
436
+ },
437
+ "numLocationsNotCovered": {
438
+ "type": "string"
439
+ },
440
+ "type": {
441
+ "type": "string"
442
+ }
443
+ },
444
+ "required": [
445
+ "id",
446
+ "name",
447
+ "numLocations",
448
+ "numLocationsNotCovered",
449
+ "type"
450
+ ],
451
+ "additionalProperties": false
452
+ },
453
+ "LocationsNotCovered": {
454
+ "type": "object",
455
+ "properties": {
456
+ "column": {
457
+ "type": "string"
458
+ },
459
+ "line": {
460
+ "type": "string"
461
+ },
462
+ "numExecutions": {
463
+ "type": "string"
464
+ },
465
+ "time": {
466
+ "type": "string"
467
+ }
468
+ },
469
+ "required": [
470
+ "column",
471
+ "line",
472
+ "numExecutions",
473
+ "time"
474
+ ],
475
+ "additionalProperties": false
476
+ },
477
+ "CodeCoverageWarnings": {
478
+ "type": "object",
479
+ "properties": {
480
+ "id": {
481
+ "type": "string"
482
+ },
483
+ "message": {
484
+ "type": "string"
485
+ },
486
+ "namespace": {
487
+ "type": "string"
488
+ }
489
+ },
490
+ "required": [
491
+ "id",
492
+ "message",
493
+ "namespace"
494
+ ],
495
+ "additionalProperties": false
496
+ },
497
+ "Failures": {
498
+ "type": "object",
499
+ "properties": {
500
+ "id": {
501
+ "type": "string"
502
+ },
503
+ "message": {
504
+ "type": "string"
505
+ },
506
+ "methodName": {
507
+ "type": "string"
508
+ },
509
+ "name": {
510
+ "type": "string"
511
+ },
512
+ "packageName": {
513
+ "type": "string"
514
+ },
515
+ "stackTrace": {
516
+ "type": "string"
517
+ },
518
+ "time": {
519
+ "type": "string"
520
+ },
521
+ "type": {
522
+ "type": "string"
523
+ }
524
+ },
525
+ "required": [
526
+ "id",
527
+ "message",
528
+ "methodName",
529
+ "name",
530
+ "packageName",
531
+ "stackTrace",
532
+ "time",
533
+ "type"
534
+ ],
535
+ "additionalProperties": false
536
+ },
537
+ "Successes": {
538
+ "type": "object",
539
+ "properties": {
540
+ "id": {
541
+ "type": "string"
542
+ },
543
+ "methodName": {
544
+ "type": "string"
545
+ },
546
+ "name": {
547
+ "type": "string"
548
+ },
549
+ "time": {
550
+ "type": "string"
551
+ }
552
+ },
553
+ "required": [
554
+ "id",
555
+ "methodName",
556
+ "name",
557
+ "time"
558
+ ],
559
+ "additionalProperties": false
560
+ },
561
+ "AsyncDeployResultJson": {
562
+ "type": "object",
563
+ "additionalProperties": false,
564
+ "properties": {
565
+ "status": {
566
+ "anyOf": [
567
+ {
568
+ "$ref": "#/definitions/RequestStatus"
569
+ },
570
+ {
571
+ "type": "string",
572
+ "const": "Queued"
573
+ }
574
+ ]
575
+ },
576
+ "files": {
577
+ "type": "array",
578
+ "items": {
579
+ "$ref": "#/definitions/FileResponse"
580
+ }
581
+ },
582
+ "canceledBy": {
583
+ "type": "string"
584
+ },
585
+ "canceledByName": {
586
+ "type": "string"
587
+ },
588
+ "checkOnly": {
589
+ "type": "boolean"
590
+ },
591
+ "completedDate": {
592
+ "type": "string"
593
+ },
594
+ "createdBy": {
595
+ "type": "string"
596
+ },
597
+ "createdByName": {
598
+ "type": "string"
599
+ },
600
+ "createdDate": {
601
+ "type": "string"
602
+ },
603
+ "details": {
604
+ "$ref": "#/definitions/DeployDetails"
605
+ },
606
+ "errorMessage": {
607
+ "type": "string"
608
+ },
609
+ "errorStatusCode": {
610
+ "type": "string"
611
+ },
612
+ "ignoreWarnings": {
613
+ "type": "boolean"
614
+ },
615
+ "lastModifiedDate": {
616
+ "type": "string"
617
+ },
618
+ "numberComponentErrors": {
85
619
  "type": "number"
86
620
  },
87
- "failing": {
621
+ "numberComponentsDeployed": {
88
622
  "type": "number"
89
623
  },
90
- "total": {
624
+ "numberComponentsTotal": {
91
625
  "type": "number"
92
626
  },
93
- "time": {
627
+ "numberTestErrors": {
628
+ "type": "number"
629
+ },
630
+ "numberTestsCompleted": {
631
+ "type": "number"
632
+ },
633
+ "numberTestsTotal": {
634
+ "type": "number"
635
+ },
636
+ "runTestsEnabled": {
637
+ "type": "boolean"
638
+ },
639
+ "rollbackOnError": {
640
+ "type": "boolean"
641
+ },
642
+ "startDate": {
94
643
  "type": "string"
644
+ },
645
+ "stateDetail": {
646
+ "type": "string"
647
+ },
648
+ "id": {
649
+ "type": "string"
650
+ },
651
+ "success": {
652
+ "type": "boolean"
653
+ },
654
+ "done": {
655
+ "type": "boolean"
95
656
  }
96
657
  },
97
- "required": ["passing", "failing", "total"],
98
- "additionalProperties": false
658
+ "required": [
659
+ "files",
660
+ "status"
661
+ ]
99
662
  }
100
663
  }
101
- }
664
+ }
package/schemas/hooks/sf-deploy.json CHANGED
@@ -13,7 +13,9 @@
13
13
  "description": "Deployables are individual pieces that can be deployed on their own. For example, each package in a salesforce project is considered a deployable that can be deployed on its own."
14
14
  }
15
15
  },
16
- "required": ["deployables"],
16
+ "required": [
17
+ "deployables"
18
+ ],
17
19
  "additionalProperties": false
18
20
  },
19
21
  "DeployablePackage": {
@@ -23,7 +25,9 @@
23
25
  "$ref": "#/definitions/NamedPackageDir"
24
26
  }
25
27
  },
26
- "required": ["pkg"],
28
+ "required": [
29
+ "pkg"
30
+ ],
27
31
  "additionalProperties": false
28
32
  },
29
33
  "NamedPackageDir": {
@@ -87,7 +91,11 @@
87
91
  "type": "string"
88
92
  }
89
93
  },
90
- "required": ["fullPath", "name", "path"]
94
+ "required": [
95
+ "fullPath",
96
+ "name",
97
+ "path"
98
+ ]
91
99
  },
92
100
  "PackageDirDependency": {
93
101
  "type": "object",
@@ -99,8 +107,10 @@
99
107
  "type": "string"
100
108
  }
101
109
  },
102
- "required": ["package"],
110
+ "required": [
111
+ "package"
112
+ ],
103
113
  "additionalProperties": {}
104
114
  }
105
115
  }
106
- }
116
+ }