@salesforce/plugin-deploy-retrieve 1.5.3 → 1.6.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 (46) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/README.md +163 -23
  3. package/lib/commands/deploy/metadata/preview.d.ts +17 -0
  4. package/lib/commands/deploy/metadata/preview.js +86 -0
  5. package/lib/commands/deploy/metadata/preview.js.map +1 -0
  6. package/lib/commands/deploy/metadata/quick.js +2 -3
  7. package/lib/commands/deploy/metadata/quick.js.map +1 -1
  8. package/lib/commands/deploy/metadata.js.map +1 -1
  9. package/lib/commands/deploy.js +19 -11
  10. package/lib/commands/deploy.js.map +1 -1
  11. package/lib/commands/retrieve/metadata/preview.d.ts +14 -0
  12. package/lib/commands/retrieve/metadata/preview.js +63 -0
  13. package/lib/commands/retrieve/metadata/preview.js.map +1 -0
  14. package/lib/commands/retrieve/metadata.d.ts +4 -0
  15. package/lib/commands/retrieve/metadata.js +74 -21
  16. package/lib/commands/retrieve/metadata.js.map +1 -1
  17. package/lib/utils/deploy.js +17 -17
  18. package/lib/utils/deploy.js.map +1 -1
  19. package/lib/utils/flags.d.ts +14 -4
  20. package/lib/utils/flags.js +66 -20
  21. package/lib/utils/flags.js.map +1 -1
  22. package/lib/utils/metadataDeployer.d.ts +2 -2
  23. package/lib/utils/metadataDeployer.js +9 -7
  24. package/lib/utils/metadataDeployer.js.map +1 -1
  25. package/lib/utils/output.d.ts +15 -2
  26. package/lib/utils/output.js +59 -39
  27. package/lib/utils/output.js.map +1 -1
  28. package/lib/utils/previewOutput.d.ts +30 -0
  29. package/lib/utils/previewOutput.js +199 -0
  30. package/lib/utils/previewOutput.js.map +1 -0
  31. package/lib/utils/progressBar.js +1 -2
  32. package/lib/utils/progressBar.js.map +1 -1
  33. package/lib/utils/types.d.ts +5 -1
  34. package/messages/deploy.md +36 -0
  35. package/messages/deploy.metadata.md +9 -1
  36. package/messages/deploy.metadata.preview.md +93 -0
  37. package/messages/deploy.metadata.validate.md +1 -1
  38. package/messages/previewMessages.md +39 -0
  39. package/messages/retrieve.metadata.md +37 -1
  40. package/messages/retrieve.metadata.preview.md +59 -0
  41. package/messages/validation.md +11 -0
  42. package/oclif.manifest.json +1 -1
  43. package/package.json +30 -28
  44. package/schemas/deploy-metadata-preview.json +72 -0
  45. package/schemas/retrieve-metadata-preview.json +72 -0
  46. package/schemas/retrieve-metadata.json +121 -52
package/package.json CHANGED
@@ -1,16 +1,16 @@
1
1
  {
2
2
  "name": "@salesforce/plugin-deploy-retrieve",
3
3
  "description": "deploy and retrieve commands for sf",
4
- "version": "1.5.3",
4
+ "version": "1.6.0",
5
5
  "author": "Salesforce",
6
6
  "bugs": "https://github.com/forcedotcom/cli/issues",
7
7
  "dependencies": {
8
- "@oclif/core": "^1.9.0",
9
- "@salesforce/core": "^3.22.1",
10
- "@salesforce/kit": "^1.5.41",
11
- "@salesforce/sf-plugins-core": "^1.13.0",
12
- "@salesforce/source-deploy-retrieve": "^6.1.0",
13
- "@salesforce/source-tracking": "^2.2.0",
8
+ "@oclif/core": "^1.16.0",
9
+ "@salesforce/core": "^3.26.1",
10
+ "@salesforce/kit": "^1.5.45",
11
+ "@salesforce/sf-plugins-core": "1.14.0",
12
+ "@salesforce/source-deploy-retrieve": "^6.2.9",
13
+ "@salesforce/source-tracking": "^2.2.2",
14
14
  "chalk": "^4.1.2",
15
15
  "fs-extra": "^10.0.1",
16
16
  "shelljs": "^0.8.5",
@@ -18,29 +18,30 @@
18
18
  },
19
19
  "devDependencies": {
20
20
  "@oclif/plugin-command-snapshot": "^3.1.3",
21
- "@salesforce/cli-plugins-testkit": "^2.3.0",
22
- "@salesforce/dev-config": "^3.0.1",
23
- "@salesforce/dev-scripts": "^2.0.1",
21
+ "@salesforce/cli-plugins-testkit": "^2.3.10",
22
+ "@salesforce/dev-config": "^3.1.0",
23
+ "@salesforce/dev-scripts": "^2.0.4",
24
24
  "@salesforce/plugin-command-reference": "^2.2.8",
25
25
  "@salesforce/plugin-config": "^2.3.0",
26
- "@salesforce/plugin-functions": "^1.7.0",
27
- "@salesforce/plugin-source": "^2.0.3",
28
- "@salesforce/plugin-user": "^2.0.2",
26
+ "@salesforce/plugin-functions": "^1.13.4",
27
+ "@salesforce/plugin-source": "^2.0.11",
28
+ "@salesforce/plugin-user": "^2.1.0",
29
29
  "@salesforce/prettier-config": "^0.0.2",
30
30
  "@salesforce/source-testkit": "^1.2.0",
31
31
  "@salesforce/ts-sinon": "1.3.21",
32
+ "@salesforce/ts-types": "^1.5.20",
32
33
  "@types/archiver": "^5.3.1",
33
34
  "@types/fs-extra": "^9.0.13",
34
35
  "@types/shelljs": "^0.8.11",
35
- "@typescript-eslint/eslint-plugin": "^5.27.1",
36
- "@typescript-eslint/parser": "^5.27.1",
36
+ "@typescript-eslint/eslint-plugin": "^5.36.2",
37
+ "@typescript-eslint/parser": "^5.36.2",
37
38
  "archiver": "^5.3.1",
38
39
  "chai": "^4.3.6",
39
40
  "cross-env": "^7.0.3",
40
41
  "cz-conventional-changelog": "^3.3.0",
41
42
  "eslint": "^8.17.0",
42
43
  "eslint-config-prettier": "^6.15.0",
43
- "eslint-config-salesforce": "^1.0.1",
44
+ "eslint-config-salesforce": "^1.1.0",
44
45
  "eslint-config-salesforce-license": "^0.1.6",
45
46
  "eslint-config-salesforce-typescript": "^1.0.0",
46
47
  "eslint-plugin-header": "^3.1.1",
@@ -50,20 +51,16 @@
50
51
  "eslint-plugin-sf-plugin": "^0.3.0",
51
52
  "husky": "^7.0.4",
52
53
  "lint-staged": "^11.2.6",
53
- "mocha": "^9.1.3",
54
+ "mocha": "^10.0.0",
54
55
  "nyc": "^15.1.0",
55
- "oclif": "^2.6.3",
56
- "prettier": "^2.5.1",
56
+ "oclif": "^3.1.2",
57
+ "prettier": "^2.7.1",
57
58
  "pretty-quick": "^3.1.3",
58
59
  "salesforcedx-templates": "^49.8.0",
59
60
  "shx": "0.3.4",
60
61
  "sinon": "11.1.2",
61
- "ts-node": "^10.7.0",
62
- "typescript": "^4.6.2"
63
- },
64
- "resolutions": {
65
- "@oclif/core": "^1.6.4",
66
- "@salesforce/sf-plugins-core": "^1.11.0"
62
+ "ts-node": "^10.9.1",
63
+ "typescript": "^4.7.4"
67
64
  },
68
65
  "config": {
69
66
  "commitizen": {
@@ -117,7 +114,12 @@
117
114
  }
118
115
  },
119
116
  "retrieve": {
120
- "description": "Commands to retrieve artifacts from an environment."
117
+ "description": "Commands to retrieve artifacts from an environment.",
118
+ "subtopics": {
119
+ "metadata": {
120
+ "description": "Commands to retrieve metadata from a Salesforce org."
121
+ }
122
+ }
121
123
  }
122
124
  }
123
125
  },
@@ -155,7 +157,7 @@
155
157
  },
156
158
  "main": "lib/index.js",
157
159
  "sfdx": {
158
- "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-deploy-retrieve/1.5.3.crt",
159
- "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-deploy-retrieve/1.5.3.sig"
160
+ "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-deploy-retrieve/1.6.0.crt",
161
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-deploy-retrieve/1.6.0.sig"
160
162
  }
161
163
  }
@@ -0,0 +1,72 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "$ref": "#/definitions/PreviewResult",
4
+ "definitions": {
5
+ "PreviewResult": {
6
+ "type": "object",
7
+ "properties": {
8
+ "ignored": {
9
+ "type": "array",
10
+ "items": {
11
+ "$ref": "#/definitions/PreviewFile"
12
+ }
13
+ },
14
+ "conflicts": {
15
+ "type": "array",
16
+ "items": {
17
+ "$ref": "#/definitions/PreviewFile"
18
+ }
19
+ },
20
+ "toDeploy": {
21
+ "type": "array",
22
+ "items": {
23
+ "$ref": "#/definitions/PreviewFile"
24
+ }
25
+ },
26
+ "toDelete": {
27
+ "type": "array",
28
+ "items": {
29
+ "$ref": "#/definitions/PreviewFile"
30
+ }
31
+ },
32
+ "toRetrieve": {
33
+ "type": "array",
34
+ "items": {
35
+ "$ref": "#/definitions/PreviewFile"
36
+ }
37
+ }
38
+ },
39
+ "required": ["ignored", "conflicts", "toDeploy", "toDelete", "toRetrieve"],
40
+ "additionalProperties": false
41
+ },
42
+ "PreviewFile": {
43
+ "type": "object",
44
+ "properties": {
45
+ "fullName": {
46
+ "type": "string"
47
+ },
48
+ "type": {
49
+ "type": "string"
50
+ },
51
+ "conflict": {
52
+ "type": "boolean"
53
+ },
54
+ "ignored": {
55
+ "type": "boolean"
56
+ },
57
+ "path": {
58
+ "type": "string"
59
+ },
60
+ "projectRelativePath": {
61
+ "type": "string"
62
+ },
63
+ "operation": {
64
+ "type": "string",
65
+ "enum": ["deploy", "retrieve", "deletePost", "deletePre"]
66
+ }
67
+ },
68
+ "required": ["fullName", "type", "conflict", "ignored"],
69
+ "additionalProperties": false
70
+ }
71
+ }
72
+ }
@@ -0,0 +1,72 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "$ref": "#/definitions/PreviewResult",
4
+ "definitions": {
5
+ "PreviewResult": {
6
+ "type": "object",
7
+ "properties": {
8
+ "ignored": {
9
+ "type": "array",
10
+ "items": {
11
+ "$ref": "#/definitions/PreviewFile"
12
+ }
13
+ },
14
+ "conflicts": {
15
+ "type": "array",
16
+ "items": {
17
+ "$ref": "#/definitions/PreviewFile"
18
+ }
19
+ },
20
+ "toDeploy": {
21
+ "type": "array",
22
+ "items": {
23
+ "$ref": "#/definitions/PreviewFile"
24
+ }
25
+ },
26
+ "toDelete": {
27
+ "type": "array",
28
+ "items": {
29
+ "$ref": "#/definitions/PreviewFile"
30
+ }
31
+ },
32
+ "toRetrieve": {
33
+ "type": "array",
34
+ "items": {
35
+ "$ref": "#/definitions/PreviewFile"
36
+ }
37
+ }
38
+ },
39
+ "required": ["ignored", "conflicts", "toDeploy", "toDelete", "toRetrieve"],
40
+ "additionalProperties": false
41
+ },
42
+ "PreviewFile": {
43
+ "type": "object",
44
+ "properties": {
45
+ "fullName": {
46
+ "type": "string"
47
+ },
48
+ "type": {
49
+ "type": "string"
50
+ },
51
+ "conflict": {
52
+ "type": "boolean"
53
+ },
54
+ "ignored": {
55
+ "type": "boolean"
56
+ },
57
+ "path": {
58
+ "type": "string"
59
+ },
60
+ "projectRelativePath": {
61
+ "type": "string"
62
+ },
63
+ "operation": {
64
+ "type": "string",
65
+ "enum": ["deploy", "retrieve", "deletePost", "deletePre"]
66
+ }
67
+ },
68
+ "required": ["fullName", "type", "conflict", "ignored"],
69
+ "additionalProperties": false
70
+ }
71
+ }
72
+ }
@@ -3,66 +3,73 @@
3
3
  "$ref": "#/definitions/RetrieveResultJson",
4
4
  "definitions": {
5
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
- {
6
+ "anyOf": [
7
+ {
8
+ "type": "object",
9
+ "additionalProperties": false,
10
+ "properties": {
11
+ "files": {
43
12
  "type": "array",
44
13
  "items": {
45
- "$ref": "#/definitions/RetrieveMessage"
14
+ "$ref": "#/definitions/FileResponse"
46
15
  }
47
16
  },
48
- {
49
- "$ref": "#/definitions/RetrieveMessage"
17
+ "done": {
18
+ "type": "boolean"
19
+ },
20
+ "fileProperties": {
21
+ "anyOf": [
22
+ {
23
+ "$ref": "#/definitions/FileProperties"
24
+ },
25
+ {
26
+ "type": "array",
27
+ "items": {
28
+ "$ref": "#/definitions/FileProperties"
29
+ }
30
+ }
31
+ ]
32
+ },
33
+ "id": {
34
+ "type": "string"
35
+ },
36
+ "status": {
37
+ "$ref": "#/definitions/RequestStatus"
38
+ },
39
+ "success": {
40
+ "type": "boolean"
41
+ },
42
+ "messages": {
43
+ "anyOf": [
44
+ {
45
+ "type": "array",
46
+ "items": {
47
+ "$ref": "#/definitions/RetrieveMessage"
48
+ }
49
+ },
50
+ {
51
+ "$ref": "#/definitions/RetrieveMessage"
52
+ }
53
+ ]
54
+ },
55
+ "zipFile": {
56
+ "type": "string",
57
+ "description": "`base64` encoded string"
50
58
  }
59
+ },
60
+ "required": [
61
+ "done",
62
+ "fileProperties",
63
+ "files",
64
+ "id",
65
+ "status",
66
+ "success",
67
+ "zipFile"
51
68
  ]
52
69
  },
53
- "zipFile": {
54
- "type": "string",
55
- "description": "`base64` encoded string"
70
+ {
71
+ "$ref": "#/definitions/MetadataRetrieveResultJson"
56
72
  }
57
- },
58
- "required": [
59
- "done",
60
- "fileProperties",
61
- "files",
62
- "id",
63
- "status",
64
- "success",
65
- "zipFile"
66
73
  ]
67
74
  },
68
75
  "FileResponse": {
@@ -231,6 +238,68 @@
231
238
  "problem"
232
239
  ],
233
240
  "additionalProperties": false
241
+ },
242
+ "MetadataRetrieveResultJson": {
243
+ "type": "object",
244
+ "additionalProperties": false,
245
+ "properties": {
246
+ "zipFilePath": {
247
+ "type": "string"
248
+ },
249
+ "files": {
250
+ "type": "array",
251
+ "items": {
252
+ "$ref": "#/definitions/FileResponse"
253
+ }
254
+ },
255
+ "done": {
256
+ "type": "boolean"
257
+ },
258
+ "fileProperties": {
259
+ "anyOf": [
260
+ {
261
+ "$ref": "#/definitions/FileProperties"
262
+ },
263
+ {
264
+ "type": "array",
265
+ "items": {
266
+ "$ref": "#/definitions/FileProperties"
267
+ }
268
+ }
269
+ ]
270
+ },
271
+ "id": {
272
+ "type": "string"
273
+ },
274
+ "status": {
275
+ "$ref": "#/definitions/RequestStatus"
276
+ },
277
+ "success": {
278
+ "type": "boolean"
279
+ },
280
+ "messages": {
281
+ "anyOf": [
282
+ {
283
+ "type": "array",
284
+ "items": {
285
+ "$ref": "#/definitions/RetrieveMessage"
286
+ }
287
+ },
288
+ {
289
+ "$ref": "#/definitions/RetrieveMessage"
290
+ }
291
+ ]
292
+ }
293
+ },
294
+ "required": [
295
+ "done",
296
+ "fileProperties",
297
+ "files",
298
+ "id",
299
+ "status",
300
+ "success",
301
+ "zipFilePath"
302
+ ]
234
303
  }
235
304
  }
236
305
  }