@simplysf/simply-package 1.0.0 → 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.
package/CHANGELOG.md CHANGED
@@ -0,0 +1,9 @@
1
+ # 1.1.0 (2024-02-24)
2
+
3
+
4
+ ### Features
5
+
6
+ * update with simply versions ([1c6e766](https://github.com/SimplySF/simply-package/commit/1c6e766aba0597fa96a5a4e37bacf1eaa61d0173))
7
+
8
+
9
+
package/README.md CHANGED
@@ -1,60 +1,60 @@
1
- # @simplysf/simply-package
2
-
3
- [![NPM](https://img.shields.io/npm/v/@simplysf/simply-package.svg?label=@simplysf/simply-package)](https://www.npmjs.com/package/@simplysf/simply-package) [![Downloads/week](https://img.shields.io/npm/dw/@simplysf/simply-package.svg)](https://npmjs.org/package/@simplysf/simply-package) [![License: BSD-3-Clause](https://img.shields.io/badge/License-BSD_3--Clause-yellow.svg)](https://raw.githubusercontent.com/@simplysf/simply-package/main/LICENSE.txt)
4
-
5
- ## Install
6
-
7
- ```bash
8
- sf plugins install @simplysf/simply-package
9
- ```
10
-
11
- ## Issues
12
-
13
- Please report any issues at https://github.com/SimplySF/simply-package/issues
14
-
15
- ## Contributing
16
-
17
- 1. Please read our [Code of Conduct](CODE_OF_CONDUCT.md)
18
- 2. Create a new issue before starting your project so that we can keep track of
19
- what you are trying to add/fix. That way, we can also offer suggestions or
20
- let you know if there is already an effort in progress.
21
- 3. Fork this repository.
22
- 4. [Build the plugin locally](#build)
23
- 5. Create a _topic_ branch in your fork. Note, this step is recommended but technically not required if contributing using a fork.
24
- 6. Edit the code in your fork.
25
- 7. Write appropriate tests for your changes. Try to achieve at least 95% code coverage on any new code. No pull request will be accepted without unit tests.
26
- 8. Send us a pull request when you are done. We'll review your code, suggest any needed changes, and merge it in.
27
-
28
- ### Build
29
-
30
- To build the plugin locally, make sure to have yarn installed and run the following commands:
31
-
32
- ```bash
33
- # Clone the repository
34
- git clone git@github.com:SimplySF/simply-package
35
-
36
- # Install the dependencies and compile
37
- yarn && yarn build
38
- ```
39
-
40
- To use your plugin, run using the local `./bin/dev` or `./bin/dev.cmd` file.
41
-
42
- ```bash
43
- # Run using local run file.
44
- ./bin/dev.cmd simply package
45
- ```
46
-
47
- There should be no differences when running via the Salesforce CLI or using the local run file. However, it can be useful to link the plugin to do some additional testing or run your commands from anywhere on your machine.
48
-
49
- ```bash
50
- # Link your plugin to the sf cli
51
- sf plugins link .
52
- # To verify
53
- sf plugins
54
- ```
55
-
56
- ## Commands
57
-
1
+ # @simplysf/simply-package
2
+
3
+ [![NPM](https://img.shields.io/npm/v/@simplysf/simply-package.svg?label=@simplysf/simply-package)](https://www.npmjs.com/package/@simplysf/simply-package) [![Downloads/week](https://img.shields.io/npm/dw/@simplysf/simply-package.svg)](https://npmjs.org/package/@simplysf/simply-package) [![License: BSD-3-Clause](https://img.shields.io/badge/License-BSD_3--Clause-yellow.svg)](https://raw.githubusercontent.com/SimplySF/simply-package/main/LICENSE.txt)
4
+
5
+ ## Install
6
+
7
+ ```bash
8
+ sf plugins install @simplysf/simply-package
9
+ ```
10
+
11
+ ## Issues
12
+
13
+ Please report any issues at https://github.com/SimplySF/simply-package/issues
14
+
15
+ ## Contributing
16
+
17
+ 1. Please read our [Code of Conduct](CODE_OF_CONDUCT.md)
18
+ 2. Create a new issue before starting your project so that we can keep track of
19
+ what you are trying to add/fix. That way, we can also offer suggestions or
20
+ let you know if there is already an effort in progress.
21
+ 3. Fork this repository.
22
+ 4. [Build the plugin locally](#build)
23
+ 5. Create a _topic_ branch in your fork. Note, this step is recommended but technically not required if contributing using a fork.
24
+ 6. Edit the code in your fork.
25
+ 7. Write appropriate tests for your changes. Try to achieve at least 95% code coverage on any new code. No pull request will be accepted without unit tests.
26
+ 8. Send us a pull request when you are done. We'll review your code, suggest any needed changes, and merge it in.
27
+
28
+ ### Build
29
+
30
+ To build the plugin locally, make sure to have yarn installed and run the following commands:
31
+
32
+ ```bash
33
+ # Clone the repository
34
+ git clone git@github.com:SimplySF/simply-package
35
+
36
+ # Install the dependencies and compile
37
+ yarn && yarn build
38
+ ```
39
+
40
+ To use your plugin, run using the local `./bin/dev` or `./bin/dev.cmd` file.
41
+
42
+ ```bash
43
+ # Run using local run file.
44
+ ./bin/dev.cmd simply package
45
+ ```
46
+
47
+ There should be no differences when running via the Salesforce CLI or using the local run file. However, it can be useful to link the plugin to do some additional testing or run your commands from anywhere on your machine.
48
+
49
+ ```bash
50
+ # Link your plugin to the sf cli
51
+ sf plugins link .
52
+ # To verify
53
+ sf plugins
54
+ ```
55
+
56
+ ## Commands
57
+
58
58
  <!-- commands -->
59
59
  * [`sf simply package dependencies install`](#sf-simply-package-dependencies-install)
60
60
  * [`sf simply package version cleanup`](#sf-simply-package-version-cleanup)
@@ -152,7 +152,7 @@ FLAG DESCRIPTIONS
152
152
  from by entering the branch build name. If not specified, the builds from NULL branch will be considered.
153
153
  ```
154
154
 
155
- _See code: [src/commands/simply/package/dependencies/install.ts](https://github.com/SimplySF/simply-package/blob/1.0.0/src/commands/simply/package/dependencies/install.ts)_
155
+ _See code: [src/commands/simply/package/dependencies/install.ts](https://github.com/SimplySF/simply-package/blob/0.1.0/src/commands/simply/package/dependencies/install.ts)_
156
156
 
157
157
  ## `sf simply package version cleanup`
158
158
 
@@ -191,5 +191,5 @@ FLAG DESCRIPTIONS
191
191
  The MAJOR.MINOR.PATCH matcher that should be used to find package versions to delete.
192
192
  ```
193
193
 
194
- _See code: [src/commands/simply/package/version/cleanup.ts](https://github.com/SimplySF/simply-package/blob/1.0.0/src/commands/simply/package/version/cleanup.ts)_
194
+ _See code: [src/commands/simply/package/version/cleanup.ts](https://github.com/SimplySF/simply-package/blob/0.1.0/src/commands/simply/package/version/cleanup.ts)_
195
195
  <!-- commandsstop -->
@@ -1,151 +1,151 @@
1
- # summary
2
-
3
- Install package dependencies for a Salesforce project.
4
-
5
- # description
6
-
7
- Installs all specified package dependencies in a Salesforce DX project using the sfdx-project.json definition.
8
-
9
- # flags.branch.summary
10
-
11
- Package branch to consider when specifiying a Package/VersionNumber combination
12
-
13
- # flags.branch.description
14
-
15
- For dependencies specified by Package/VersionNumber combination, you can specify the branch group of builds to work from by entering the branch build name. If not specified, the builds from NULL branch will be considered.
16
-
17
- # flags.apex-compile.summary
18
-
19
- Compile all Apex in the org and package, or only Apex in the package; unlocked packages only.
20
-
21
- # flags.apex-compile.description
22
-
23
- Applies to unlocked packages only. Specifies whether to compile all Apex in the org and package, or only the Apex in the package.
24
-
25
- For package installs into production orgs, or any org that has Apex Compile on Deploy enabled, the platform compiles all Apex in the org after the package install or upgrade operation completes.
26
-
27
- This approach assures that package installs and upgrades don’t impact the performance of an org, and is done even if --apex-compile package is specified.
28
-
29
- # flags.install-type.summary
30
-
31
- Install all packages or only deltas.
32
-
33
- # flags.install-type.description
34
-
35
- If 'All' is specified, then all packages specified in package dependencies are installed, regardless of if the version already is installed in the org. If 'Delta' is specified, then only packages that differ from what is installed in the org will be installed.
36
-
37
- # flags.installation-key.summary
38
-
39
- Installation key for key-protected packages
40
-
41
- # flags.installation-key.description
42
-
43
- Installation key for key-protected packages in the key:value format of SubscriberPackageVersionId:Key
44
-
45
- # flags.no-prompt.summary
46
-
47
- Don't prompt for confirmation.
48
-
49
- # flags.no-prompt.description
50
-
51
- Allows the following without an explicit confirmation response: 1) Remote Site Settings and Content Security Policy websites to send or receive data, and 2) --upgrade-type Delete to proceed.
52
-
53
- # flags.publish-wait.summary
54
-
55
- Maximum number of minutes to wait for the Subscriber Package Version ID to become available in the target org before canceling the install request.
56
-
57
- # flags.security-type.summary
58
-
59
- Security access type for the installed package. (deprecation notice: The default --security-type value will change from AllUsers to AdminsOnly in v47.0 or later.)
60
-
61
- # flags.skip-handlers.summary
62
-
63
- Skip install handlers (available handlers: FeatureEnforcement).
64
-
65
- # flags.skip-handlers.description
66
-
67
- Allows the installer of a package to optionally skip install handlers in order to decrease overall installation time (available handlers: FeatureEnforcement).
68
-
69
- # flags.target-dev-hub.summary
70
-
71
- Username or alias of the Dev Hub org.
72
-
73
- # flags.upgrade-type.summary
74
-
75
- Upgrade type for the package installation; available only for unlocked packages.
76
-
77
- # flags.upgrade-type.description
78
-
79
- For package upgrades, specifies whether to mark all removed components as deprecated (DeprecateOnly), to delete removed components that can be safely deleted and deprecate the others (Mixed), or to delete all removed components, except for custom objects and custom fields, that don't have dependencies (Delete). The default is Mixed. Can specify DeprecateOnly or Delete only for unlocked package upgrades.
80
-
81
- # flags.wait.summary
82
-
83
- Number of minutes to wait for installation status.
84
-
85
- # examples
86
-
87
- - <%= config.bin %> <%= command.id %> --target-org myTargetOrg --target-dev-hub myTargetDevHub
88
-
89
- - <%= config.bin %> <%= command.id %> --target-org myTargetOrg --target-dev-hub myTargetDevHub --installation-key "MyPackage1Alias:MyPackage1Key"
90
-
91
- - <%= config.bin %> <%= command.id %> --target-org myTargetOrg --target-dev-hub myTargetDevHub --installation-key "MyPackage1Alias:MyPackage1Key" --installation-key "MyPackage2Alias:MyPackage2Key"
92
-
93
- # error.apiVersionTooLow
94
-
95
- This command is supported only on API versions 36.0 and higher.
96
-
97
- # error.installationKeyFormat
98
-
99
- Installation Key should have the key:value format of SubscriberPackageVersionId:Key.
100
-
101
- You can use an alias in place of the SubscriberPackageVersionId.
102
-
103
- # error.invalidPackage2Id
104
-
105
- Unable to determine a valid Package2Id for %s.
106
-
107
- # error.invalidSubscriberPackageVersionId
108
-
109
- Unable to determine a valid SubscriberPackageVersionId for %s.
110
-
111
- # error.packageInstall
112
-
113
- Encountered errors installing the package! %s
114
-
115
- # error.packageInstallInProgress
116
-
117
- The package install is still In-Progress, so subsuequent dependencies cannot be installed yet. You can query the status using %s package install report -i %s -o %s.
118
-
119
- # error.packageInstallPollingTimeout
120
-
121
- Polling timeout exceeded
122
-
123
- # error.targetDevHubConnectionFailed
124
-
125
- Unable to establish connection to the org.
126
-
127
- # error.targetDevHubMissing
128
-
129
- This command requires a DevHub to be specified if providing a Package2Id and VersionNumber instead of a SubscriberPackageVersionId.
130
-
131
- # error.targetOrgConnectionFailed
132
-
133
- Unable to establish connection to the org.
134
-
135
- # info.canceledPackageInstall
136
-
137
- We canceled this package installation per your request.
138
-
139
- # prompt.enableRss
140
-
141
- This package might send or receive data from these third-party websites:
142
-
143
- [%s]
144
-
145
- Grant access (y/n)?
146
-
147
- # prompt.upgradeType
148
-
149
- The Delete upgrade type permanently deletes metadata types that have been removed from the package. Deleted metadata can’t be recovered. We don't delete custom objects and custom fields. Instead, we deprecate them.
150
-
151
- Do you want to continue? (y/n)
1
+ # summary
2
+
3
+ Install package dependencies for a Salesforce project.
4
+
5
+ # description
6
+
7
+ Installs all specified package dependencies in a Salesforce DX project using the sfdx-project.json definition.
8
+
9
+ # flags.branch.summary
10
+
11
+ Package branch to consider when specifiying a Package/VersionNumber combination
12
+
13
+ # flags.branch.description
14
+
15
+ For dependencies specified by Package/VersionNumber combination, you can specify the branch group of builds to work from by entering the branch build name. If not specified, the builds from NULL branch will be considered.
16
+
17
+ # flags.apex-compile.summary
18
+
19
+ Compile all Apex in the org and package, or only Apex in the package; unlocked packages only.
20
+
21
+ # flags.apex-compile.description
22
+
23
+ Applies to unlocked packages only. Specifies whether to compile all Apex in the org and package, or only the Apex in the package.
24
+
25
+ For package installs into production orgs, or any org that has Apex Compile on Deploy enabled, the platform compiles all Apex in the org after the package install or upgrade operation completes.
26
+
27
+ This approach assures that package installs and upgrades don’t impact the performance of an org, and is done even if --apex-compile package is specified.
28
+
29
+ # flags.install-type.summary
30
+
31
+ Install all packages or only deltas.
32
+
33
+ # flags.install-type.description
34
+
35
+ If 'All' is specified, then all packages specified in package dependencies are installed, regardless of if the version already is installed in the org. If 'Delta' is specified, then only packages that differ from what is installed in the org will be installed.
36
+
37
+ # flags.installation-key.summary
38
+
39
+ Installation key for key-protected packages
40
+
41
+ # flags.installation-key.description
42
+
43
+ Installation key for key-protected packages in the key:value format of SubscriberPackageVersionId:Key
44
+
45
+ # flags.no-prompt.summary
46
+
47
+ Don't prompt for confirmation.
48
+
49
+ # flags.no-prompt.description
50
+
51
+ Allows the following without an explicit confirmation response: 1) Remote Site Settings and Content Security Policy websites to send or receive data, and 2) --upgrade-type Delete to proceed.
52
+
53
+ # flags.publish-wait.summary
54
+
55
+ Maximum number of minutes to wait for the Subscriber Package Version ID to become available in the target org before canceling the install request.
56
+
57
+ # flags.security-type.summary
58
+
59
+ Security access type for the installed package. (deprecation notice: The default --security-type value will change from AllUsers to AdminsOnly in v47.0 or later.)
60
+
61
+ # flags.skip-handlers.summary
62
+
63
+ Skip install handlers (available handlers: FeatureEnforcement).
64
+
65
+ # flags.skip-handlers.description
66
+
67
+ Allows the installer of a package to optionally skip install handlers in order to decrease overall installation time (available handlers: FeatureEnforcement).
68
+
69
+ # flags.target-dev-hub.summary
70
+
71
+ Username or alias of the Dev Hub org.
72
+
73
+ # flags.upgrade-type.summary
74
+
75
+ Upgrade type for the package installation; available only for unlocked packages.
76
+
77
+ # flags.upgrade-type.description
78
+
79
+ For package upgrades, specifies whether to mark all removed components as deprecated (DeprecateOnly), to delete removed components that can be safely deleted and deprecate the others (Mixed), or to delete all removed components, except for custom objects and custom fields, that don't have dependencies (Delete). The default is Mixed. Can specify DeprecateOnly or Delete only for unlocked package upgrades.
80
+
81
+ # flags.wait.summary
82
+
83
+ Number of minutes to wait for installation status.
84
+
85
+ # examples
86
+
87
+ - <%= config.bin %> <%= command.id %> --target-org myTargetOrg --target-dev-hub myTargetDevHub
88
+
89
+ - <%= config.bin %> <%= command.id %> --target-org myTargetOrg --target-dev-hub myTargetDevHub --installation-key "MyPackage1Alias:MyPackage1Key"
90
+
91
+ - <%= config.bin %> <%= command.id %> --target-org myTargetOrg --target-dev-hub myTargetDevHub --installation-key "MyPackage1Alias:MyPackage1Key" --installation-key "MyPackage2Alias:MyPackage2Key"
92
+
93
+ # error.apiVersionTooLow
94
+
95
+ This command is supported only on API versions 36.0 and higher.
96
+
97
+ # error.installationKeyFormat
98
+
99
+ Installation Key should have the key:value format of SubscriberPackageVersionId:Key.
100
+
101
+ You can use an alias in place of the SubscriberPackageVersionId.
102
+
103
+ # error.invalidPackage2Id
104
+
105
+ Unable to determine a valid Package2Id for %s.
106
+
107
+ # error.invalidSubscriberPackageVersionId
108
+
109
+ Unable to determine a valid SubscriberPackageVersionId for %s.
110
+
111
+ # error.packageInstall
112
+
113
+ Encountered errors installing the package! %s
114
+
115
+ # error.packageInstallInProgress
116
+
117
+ The package install is still In-Progress, so subsuequent dependencies cannot be installed yet. You can query the status using %s package install report -i %s -o %s.
118
+
119
+ # error.packageInstallPollingTimeout
120
+
121
+ Polling timeout exceeded
122
+
123
+ # error.targetDevHubConnectionFailed
124
+
125
+ Unable to establish connection to the org.
126
+
127
+ # error.targetDevHubMissing
128
+
129
+ This command requires a DevHub to be specified if providing a Package2Id and VersionNumber instead of a SubscriberPackageVersionId.
130
+
131
+ # error.targetOrgConnectionFailed
132
+
133
+ Unable to establish connection to the org.
134
+
135
+ # info.canceledPackageInstall
136
+
137
+ We canceled this package installation per your request.
138
+
139
+ # prompt.enableRss
140
+
141
+ This package might send or receive data from these third-party websites:
142
+
143
+ [%s]
144
+
145
+ Grant access (y/n)?
146
+
147
+ # prompt.upgradeType
148
+
149
+ The Delete upgrade type permanently deletes metadata types that have been removed from the package. Deleted metadata can’t be recovered. We don't delete custom objects and custom fields. Instead, we deprecate them.
150
+
151
+ Do you want to continue? (y/n)
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "@simplysf/simply-package",
3
- "version": "1.0.0",
3
+ "version": "1.1.0",
4
4
  "lockfileVersion": 3,
5
5
  "requires": true,
6
6
  "packages": {
7
7
  "": {
8
8
  "name": "@simplysf/simply-package",
9
- "version": "1.0.0",
9
+ "version": "1.1.0",
10
10
  "license": "BSD-3-Clause",
11
11
  "dependencies": {
12
12
  "@oclif/core": "^3.19.4",
@@ -14907,21 +14907,6 @@
14907
14907
  "vscode-textmate": "^8.0.0"
14908
14908
  }
14909
14909
  },
14910
- "node_modules/shx": {
14911
- "version": "0.3.4",
14912
- "extraneous": true,
14913
- "license": "MIT",
14914
- "dependencies": {
14915
- "minimist": "^1.2.3",
14916
- "shelljs": "^0.8.5"
14917
- },
14918
- "bin": {
14919
- "shx": "lib/cli.js"
14920
- },
14921
- "engines": {
14922
- "node": ">=6"
14923
- }
14924
- },
14925
14910
  "node_modules/side-channel": {
14926
14911
  "version": "1.0.4",
14927
14912
  "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.0.4.tgz",