@salesforce/plugin-deploy-retrieve 1.3.0 → 1.4.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.
Files changed (60) hide show
  1. package/CHANGELOG.md +6 -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 +319 -169
  38. package/lib/utils/output.js.map +1 -1
  39. package/lib/utils/types.d.ts +11 -5
  40. package/lib/utils/types.js.map +1 -1
  41. package/messages/cache.md +7 -0
  42. package/messages/config.md +7 -0
  43. package/messages/deploy.async.md +19 -0
  44. package/messages/deploy.metadata.cancel.md +62 -0
  45. package/messages/deploy.metadata.md +17 -3
  46. package/messages/deploy.metadata.quick.md +81 -0
  47. package/messages/deploy.metadata.report.md +42 -0
  48. package/messages/deploy.metadata.resume.md +58 -0
  49. package/messages/deploy.metadata.validate.md +123 -0
  50. package/messages/errorCodes.md +27 -0
  51. package/oclif.manifest.json +1 -1
  52. package/package.json +15 -9
  53. package/schemas/deploy-metadata-cancel.json +664 -0
  54. package/schemas/deploy-metadata-quick.json +664 -0
  55. package/schemas/deploy-metadata-report.json +664 -0
  56. package/schemas/deploy-metadata-resume.json +664 -0
  57. package/schemas/deploy-metadata-validate.json +664 -0
  58. package/schemas/deploy-metadata.json +592 -29
  59. package/schemas/hooks/sf-deploy.json +15 -5
  60. package/schemas/retrieve-metadata.json +178 -11
package/schemas/retrieve-metadata.json CHANGED
@@ -1,12 +1,69 @@
1
1
  {
2
2
  "$schema": "http://json-schema.org/draft-07/schema#",
3
- "$ref": "#/definitions/RetrieveMetadataResult",
3
+ "$ref": "#/definitions/RetrieveResultJson",
4
4
  "definitions": {
5
- "RetrieveMetadataResult": {
6
- "type": "array",
7
- "items": {
8
- "$ref": "#/definitions/FileResponse"
9
- }
5
+ "RetrieveResultJson": {
6
+ "type": "object",
7
+ "additionalProperties": false,
8
+ "properties": {
9
+ "files": {
10
+ "type": "array",
11
+ "items": {
12
+ "$ref": "#/definitions/FileResponse"
13
+ }
14
+ },
15
+ "done": {
16
+ "type": "boolean"
17
+ },
18
+ "fileProperties": {
19
+ "anyOf": [
20
+ {
21
+ "$ref": "#/definitions/FileProperties"
22
+ },
23
+ {
24
+ "type": "array",
25
+ "items": {
26
+ "$ref": "#/definitions/FileProperties"
27
+ }
28
+ }
29
+ ]
30
+ },
31
+ "id": {
32
+ "type": "string"
33
+ },
34
+ "status": {
35
+ "$ref": "#/definitions/RequestStatus"
36
+ },
37
+ "success": {
38
+ "type": "boolean"
39
+ },
40
+ "messages": {
41
+ "anyOf": [
42
+ {
43
+ "type": "array",
44
+ "items": {
45
+ "$ref": "#/definitions/RetrieveMessage"
46
+ }
47
+ },
48
+ {
49
+ "$ref": "#/definitions/RetrieveMessage"
50
+ }
51
+ ]
52
+ },
53
+ "zipFile": {
54
+ "type": "string",
55
+ "description": "`base64` encoded string"
56
+ }
57
+ },
58
+ "required": [
59
+ "done",
60
+ "fileProperties",
61
+ "files",
62
+ "id",
63
+ "status",
64
+ "success",
65
+ "zipFile"
66
+ ]
10
67
  },
11
68
  "FileResponse": {
12
69
  "anyOf": [
@@ -24,10 +81,19 @@
24
81
  },
25
82
  "state": {
26
83
  "type": "string",
27
- "enum": ["Created", "Changed", "Unchanged", "Deleted"]
84
+ "enum": [
85
+ "Created",
86
+ "Changed",
87
+ "Unchanged",
88
+ "Deleted"
89
+ ]
28
90
  }
29
91
  },
30
- "required": ["fullName", "state", "type"],
92
+ "required": [
93
+ "fullName",
94
+ "state",
95
+ "type"
96
+ ],
31
97
  "additionalProperties": false
32
98
  },
33
99
  {
@@ -57,13 +123,114 @@
57
123
  },
58
124
  "problemType": {
59
125
  "type": "string",
60
- "enum": ["Warning", "Error"]
126
+ "enum": [
127
+ "Warning",
128
+ "Error"
129
+ ]
61
130
  }
62
131
  },
63
- "required": ["error", "fullName", "problemType", "state", "type"],
132
+ "required": [
133
+ "error",
134
+ "fullName",
135
+ "problemType",
136
+ "state",
137
+ "type"
138
+ ],
64
139
  "additionalProperties": false
65
140
  }
66
141
  ]
142
+ },
143
+ "FileProperties": {
144
+ "type": "object",
145
+ "properties": {
146
+ "createdById": {
147
+ "type": "string"
148
+ },
149
+ "createdByName": {
150
+ "type": "string"
151
+ },
152
+ "createdDate": {
153
+ "type": "string"
154
+ },
155
+ "fileName": {
156
+ "type": "string"
157
+ },
158
+ "fullName": {
159
+ "type": "string"
160
+ },
161
+ "id": {
162
+ "type": "string"
163
+ },
164
+ "lastModifiedById": {
165
+ "type": "string"
166
+ },
167
+ "lastModifiedByName": {
168
+ "type": "string"
169
+ },
170
+ "lastModifiedDate": {
171
+ "type": "string"
172
+ },
173
+ "manageableState": {
174
+ "type": "string",
175
+ "enum": [
176
+ "beta",
177
+ "deleted",
178
+ "deprecated",
179
+ "deprecatedEditable",
180
+ "installed",
181
+ "installedEditable",
182
+ "released",
183
+ "unmanaged"
184
+ ]
185
+ },
186
+ "namespacePrefix": {
187
+ "type": "string"
188
+ },
189
+ "type": {
190
+ "type": "string"
191
+ }
192
+ },
193
+ "required": [
194
+ "createdById",
195
+ "createdByName",
196
+ "createdDate",
197
+ "fileName",
198
+ "fullName",
199
+ "id",
200
+ "lastModifiedById",
201
+ "lastModifiedByName",
202
+ "lastModifiedDate",
203
+ "type"
204
+ ],
205
+ "additionalProperties": false
206
+ },
207
+ "RequestStatus": {
208
+ "type": "string",
209
+ "enum": [
210
+ "Pending",
211
+ "InProgress",
212
+ "Succeeded",
213
+ "SucceededPartial",
214
+ "Failed",
215
+ "Canceling",
216
+ "Canceled"
217
+ ]
218
+ },
219
+ "RetrieveMessage": {
220
+ "type": "object",
221
+ "properties": {
222
+ "fileName": {
223
+ "type": "string"
224
+ },
225
+ "problem": {
226
+ "type": "string"
227
+ }
228
+ },
229
+ "required": [
230
+ "fileName",
231
+ "problem"
232
+ ],
233
+ "additionalProperties": false
67
234
  }
68
235
  }
69
- }
236
+ }