@salesforce/plugin-deploy-retrieve 1.0.6 → 1.1.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 +10 -0
  2. package/README.md +211 -1
  3. package/lib/commands/deploy/metadata.d.ts +36 -0
  4. package/lib/commands/deploy/metadata.js +123 -0
  5. package/lib/commands/deploy/metadata.js.map +1 -0
  6. package/lib/commands/deploy.js +3 -3
  7. package/lib/commands/deploy.js.map +1 -1
  8. package/lib/commands/retrieve/metadata.d.ts +29 -0
  9. package/lib/commands/retrieve/metadata.js +134 -0
  10. package/lib/commands/retrieve/metadata.js.map +1 -0
  11. package/lib/hooks/deploy.d.ts +4 -0
  12. package/lib/hooks/deploy.js +17 -0
  13. package/lib/hooks/deploy.js.map +1 -0
  14. package/lib/utils/componentSetBuilder.d.ts +28 -0
  15. package/lib/utils/componentSetBuilder.js +123 -0
  16. package/lib/utils/componentSetBuilder.js.map +1 -0
  17. package/lib/utils/config.d.ts +1 -0
  18. package/lib/utils/config.js +18 -0
  19. package/lib/utils/config.js.map +1 -0
  20. package/lib/utils/metadataDeployer.d.ts +30 -0
  21. package/lib/utils/metadataDeployer.js +178 -0
  22. package/lib/utils/metadataDeployer.js.map +1 -0
  23. package/lib/utils/orgs.d.ts +4 -0
  24. package/lib/utils/orgs.js +39 -0
  25. package/lib/utils/orgs.js.map +1 -0
  26. package/lib/utils/output.d.ts +18 -0
  27. package/lib/utils/output.js +152 -0
  28. package/lib/utils/output.js.map +1 -0
  29. package/lib/utils/progressBar.d.ts +8 -0
  30. package/lib/utils/progressBar.js +55 -0
  31. package/lib/utils/progressBar.js.map +1 -0
  32. package/lib/utils/requiredFlagValidator.d.ts +3 -0
  33. package/lib/utils/requiredFlagValidator.js +19 -0
  34. package/lib/utils/requiredFlagValidator.js.map +1 -0
  35. package/lib/utils/testLevel.d.ts +6 -0
  36. package/lib/utils/testLevel.js +17 -0
  37. package/lib/utils/testLevel.js.map +1 -0
  38. package/messages/deploy.metadata.md +114 -0
  39. package/messages/metadata.transfer.md +27 -0
  40. package/messages/required.flag.md +3 -0
  41. package/messages/retrieve.metadata.md +100 -0
  42. package/oclif.manifest.json +1 -1
  43. package/package.json +20 -11
  44. package/schemas/deploy-metadata.json +98 -0
  45. package/schemas/hooks/sf-deploy.json +106 -0
  46. package/schemas/retrieve-metadata.json +69 -0
package/schemas/hooks/sf-deploy.json ADDED
@@ -0,0 +1,106 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "$ref": "#/definitions/MetadataDeployer",
4
+ "definitions": {
5
+ "MetadataDeployer": {
6
+ "type": "object",
7
+ "properties": {
8
+ "deployables": {
9
+ "type": "array",
10
+ "items": {
11
+ "$ref": "#/definitions/DeployablePackage"
12
+ },
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
+ }
15
+ },
16
+ "required": ["deployables"],
17
+ "additionalProperties": false
18
+ },
19
+ "DeployablePackage": {
20
+ "type": "object",
21
+ "properties": {
22
+ "pkg": {
23
+ "$ref": "#/definitions/NamedPackageDir"
24
+ }
25
+ },
26
+ "required": ["pkg"],
27
+ "additionalProperties": false
28
+ },
29
+ "NamedPackageDir": {
30
+ "type": "object",
31
+ "additionalProperties": false,
32
+ "properties": {
33
+ "name": {
34
+ "type": "string",
35
+ "description": "The [normalized](https://nodejs.org/api/path.html#path_path_normalize_path) path used as the package name."
36
+ },
37
+ "fullPath": {
38
+ "type": "string",
39
+ "description": "The absolute path of the package."
40
+ },
41
+ "ancestorId": {
42
+ "type": "string"
43
+ },
44
+ "ancestorVersion": {
45
+ "type": "string"
46
+ },
47
+ "default": {
48
+ "type": "boolean"
49
+ },
50
+ "definitionFile": {
51
+ "type": "string"
52
+ },
53
+ "dependencies": {
54
+ "type": "array",
55
+ "items": {
56
+ "$ref": "#/definitions/PackageDirDependency"
57
+ }
58
+ },
59
+ "includeProfileUserLicenses": {
60
+ "type": "boolean"
61
+ },
62
+ "package": {
63
+ "type": "string"
64
+ },
65
+ "path": {
66
+ "type": "string"
67
+ },
68
+ "postInstallScript": {
69
+ "type": "string"
70
+ },
71
+ "postInstallUrl": {
72
+ "type": "string"
73
+ },
74
+ "releaseNotesUrl": {
75
+ "type": "string"
76
+ },
77
+ "uninstallScript": {
78
+ "type": "string"
79
+ },
80
+ "versionDescription": {
81
+ "type": "string"
82
+ },
83
+ "versionName": {
84
+ "type": "string"
85
+ },
86
+ "versionNumber": {
87
+ "type": "string"
88
+ }
89
+ },
90
+ "required": ["fullPath", "name", "path"]
91
+ },
92
+ "PackageDirDependency": {
93
+ "type": "object",
94
+ "properties": {
95
+ "package": {
96
+ "type": "string"
97
+ },
98
+ "versionNumber": {
99
+ "type": "string"
100
+ }
101
+ },
102
+ "required": ["package"],
103
+ "additionalProperties": {}
104
+ }
105
+ }
106
+ }
package/schemas/retrieve-metadata.json ADDED
@@ -0,0 +1,69 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "$ref": "#/definitions/RetrieveMetadataResult",
4
+ "definitions": {
5
+ "RetrieveMetadataResult": {
6
+ "type": "array",
7
+ "items": {
8
+ "$ref": "#/definitions/FileResponse"
9
+ }
10
+ },
11
+ "FileResponse": {
12
+ "anyOf": [
13
+ {
14
+ "type": "object",
15
+ "properties": {
16
+ "fullName": {
17
+ "type": "string"
18
+ },
19
+ "type": {
20
+ "type": "string"
21
+ },
22
+ "filePath": {
23
+ "type": "string"
24
+ },
25
+ "state": {
26
+ "type": "string",
27
+ "enum": ["Created", "Changed", "Unchanged", "Deleted"]
28
+ }
29
+ },
30
+ "required": ["fullName", "state", "type"],
31
+ "additionalProperties": false
32
+ },
33
+ {
34
+ "type": "object",
35
+ "properties": {
36
+ "fullName": {
37
+ "type": "string"
38
+ },
39
+ "type": {
40
+ "type": "string"
41
+ },
42
+ "filePath": {
43
+ "type": "string"
44
+ },
45
+ "state": {
46
+ "type": "string",
47
+ "const": "Failed"
48
+ },
49
+ "lineNumber": {
50
+ "type": "number"
51
+ },
52
+ "columnNumber": {
53
+ "type": "number"
54
+ },
55
+ "error": {
56
+ "type": "string"
57
+ },
58
+ "problemType": {
59
+ "type": "string",
60
+ "enum": ["Warning", "Error"]
61
+ }
62
+ },
63
+ "required": ["error", "fullName", "problemType", "state", "type"],
64
+ "additionalProperties": false
65
+ }
66
+ ]
67
+ }
68
+ }
69
+ }