@simplysf/simply-package 1.0.0

package/oclif.manifest.json

@@ -0,0 +1,317 @@
+{
+  "commands": {
+    "simply:package:dependencies:install": {
+      "aliases": [],
+      "args": {},
+      "description": "Installs all specified package dependencies in a Salesforce DX project using the sfdx-project.json definition.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> --target-org myTargetOrg --target-dev-hub myTargetDevHub",
+        "<%= config.bin %> <%= command.id %> --target-org myTargetOrg --target-dev-hub myTargetDevHub --installation-key \"MyPackage1Alias:MyPackage1Key\"",
+        "<%= config.bin %> <%= command.id %> --target-org myTargetOrg --target-dev-hub myTargetDevHub --installation-key \"MyPackage1Alias:MyPackage1Key\" --installation-key \"MyPackage2Alias:MyPackage2Key\""
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "apex-compile": {
+          "char": "a",
+          "description": "Applies to unlocked packages only. Specifies whether to compile all Apex in the org and package, or only the Apex in the package.\r\n\r\nFor 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.\r\n\r\nThis 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.",
+          "name": "apex-compile",
+          "summary": "Compile all Apex in the org and package, or only Apex in the package; unlocked packages only.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "all",
+            "package"
+          ],
+          "type": "option"
+        },
+        "api-version": {
+          "description": "Override the api version used for api requests made by this command",
+          "name": "api-version",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "branch": {
+          "char": "z",
+          "description": "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.",
+          "name": "branch",
+          "summary": "Package branch to consider when specifiying a Package/VersionNumber combination",
+          "default": "",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "install-type": {
+          "char": "i",
+          "description": "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.",
+          "name": "install-type",
+          "summary": "Install all packages or only deltas.",
+          "default": "Delta",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "All",
+            "Delta"
+          ],
+          "type": "option"
+        },
+        "installation-key": {
+          "char": "k",
+          "description": "Installation key for key-protected packages in the key:value format of SubscriberPackageVersionId:Key",
+          "name": "installation-key",
+          "summary": "Installation key for key-protected packages",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "type": "option"
+        },
+        "no-prompt": {
+          "char": "r",
+          "description": "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.",
+          "name": "no-prompt",
+          "required": false,
+          "summary": "Don't prompt for confirmation.",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "publish-wait": {
+          "char": "b",
+          "name": "publish-wait",
+          "summary": "Maximum number of minutes to wait for the Subscriber Package Version ID to become available in the target org before canceling the install request.",
+          "default": {
+            "quantity": 0,
+            "unit": 0
+          },
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "security-type": {
+          "char": "s",
+          "name": "security-type",
+          "summary": "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.)",
+          "default": "AdminsOnly",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "AllUsers",
+            "AdminsOnly"
+          ],
+          "type": "option"
+        },
+        "skip-handlers": {
+          "char": "l",
+          "description": "Allows the installer of a package to optionally skip install handlers in order to decrease overall installation time (available handlers: FeatureEnforcement).",
+          "hidden": true,
+          "name": "skip-handlers",
+          "summary": "Skip install handlers (available handlers: FeatureEnforcement).",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "options": [
+            "FeatureEnforcement"
+          ],
+          "type": "option"
+        },
+        "target-dev-hub": {
+          "char": "v",
+          "name": "target-dev-hub",
+          "summary": "Username or alias of the Dev Hub org.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "target-org": {
+          "char": "o",
+          "name": "target-org",
+          "noCacheDefault": true,
+          "required": true,
+          "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        },
+        "upgrade-type": {
+          "char": "t",
+          "description": "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.",
+          "name": "upgrade-type",
+          "summary": "Upgrade type for the package installation; available only for unlocked packages.",
+          "default": "Mixed",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "DeprecateOnly",
+            "Mixed",
+            "Delete"
+          ],
+          "type": "option"
+        },
+        "wait": {
+          "char": "w",
+          "name": "wait",
+          "summary": "Number of minutes to wait for installation status.",
+          "default": {
+            "quantity": 30,
+            "unit": 0
+          },
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": true,
+      "hiddenAliases": [],
+      "id": "simply:package:dependencies:install",
+      "pluginAlias": "@simplysf/simply-package",
+      "pluginName": "@simplysf/simply-package",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Install package dependencies for a Salesforce project.",
+      "enableJsonFlag": true,
+      "SF_ENV": "SF_ENV",
+      "requiresProject": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "simply",
+        "package",
+        "dependencies",
+        "install.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "simply:package:dependencies:install",
+        "package:simply:dependencies:install",
+        "package:dependencies:simply:install",
+        "package:dependencies:install:simply",
+        "simply:dependencies:package:install",
+        "dependencies:simply:package:install",
+        "dependencies:package:simply:install",
+        "dependencies:package:install:simply",
+        "simply:dependencies:install:package",
+        "dependencies:simply:install:package",
+        "dependencies:install:simply:package",
+        "dependencies:install:package:simply",
+        "simply:package:install:dependencies",
+        "package:simply:install:dependencies",
+        "package:install:simply:dependencies",
+        "package:install:dependencies:simply",
+        "simply:install:package:dependencies",
+        "install:simply:package:dependencies",
+        "install:package:simply:dependencies",
+        "install:package:dependencies:simply",
+        "simply:install:dependencies:package",
+        "install:simply:dependencies:package",
+        "install:dependencies:simply:package",
+        "install:dependencies:package:simply"
+      ]
+    },
+    "simply:package:version:cleanup": {
+      "aliases": [],
+      "args": {},
+      "description": "Delete package versions for a given package provided a MAJOR.MINOR.PATCH matcher. Does not delete released pacakge versions.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> --package 0Hoxx00000000CqCAI --matcher 2.10.0 --target-dev-hub myDevHub"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "api-version": {
+          "description": "Override the api version used for api requests made by this command",
+          "name": "api-version",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "matcher": {
+          "char": "s",
+          "description": "The MAJOR.MINOR.PATCH matcher that should be used to find package versions to delete.",
+          "name": "matcher",
+          "required": true,
+          "summary": "MAJOR.MINOR.PATCH",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "package": {
+          "char": "p",
+          "description": "The 0Ht Package Id that you wish to cleanup versions for.",
+          "name": "package",
+          "required": true,
+          "summary": "Package Id",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "target-dev-hub": {
+          "char": "v",
+          "name": "target-dev-hub",
+          "noCacheDefault": true,
+          "required": true,
+          "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": true,
+      "hiddenAliases": [],
+      "id": "simply:package:version:cleanup",
+      "pluginAlias": "@simplysf/simply-package",
+      "pluginName": "@simplysf/simply-package",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Cleanup package versions.",
+      "enableJsonFlag": true,
+      "SF_ENV": "SF_ENV",
+      "requiresProject": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "simply",
+        "package",
+        "version",
+        "cleanup.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "simply:package:version:cleanup",
+        "package:simply:version:cleanup",
+        "package:version:simply:cleanup",
+        "package:version:cleanup:simply",
+        "simply:version:package:cleanup",
+        "version:simply:package:cleanup",
+        "version:package:simply:cleanup",
+        "version:package:cleanup:simply",
+        "simply:version:cleanup:package",
+        "version:simply:cleanup:package",
+        "version:cleanup:simply:package",
+        "version:cleanup:package:simply",
+        "simply:package:cleanup:version",
+        "package:simply:cleanup:version",
+        "package:cleanup:simply:version",
+        "package:cleanup:version:simply",
+        "simply:cleanup:package:version",
+        "cleanup:simply:package:version",
+        "cleanup:package:simply:version",
+        "cleanup:package:version:simply",
+        "simply:cleanup:version:package",
+        "cleanup:simply:version:package",
+        "cleanup:version:simply:package",
+        "cleanup:version:package:simply"
+      ]
+    }
+  },
+  "version": "1.0.0"
+}

package/package.json

@@ -0,0 +1,226 @@
+{
+  "name": "@simplysf/simply-package",
+  "description": "Utilities for working with packages",
+  "version": "1.0.0",
+  "author": "@ClayChipps",
+  "bugs": "https://github.com/SimplySF/simply-package/issues",
+  "dependencies": {
+    "@oclif/core": "^3.19.4",
+    "@salesforce/core": "^6.5.5",
+    "@salesforce/kit": "^3.0.15",
+    "@salesforce/packaging": "^3.2.15",
+    "@salesforce/sf-plugins-core": "^5.0.13",
+    "@salesforce/ts-types": "^2.0.9"
+  },
+  "devDependencies": {
+    "@oclif/plugin-command-snapshot": "^5.0.6",
+    "@salesforce/cli-plugins-testkit": "^5.1.9",
+    "@salesforce/plugin-command-reference": "^3.0.67",
+    "@salesforce/ts-sinon": "1.4.19",
+    "@simplysf/dev-scripts": "^2.0.0",
+    "@types/shelljs": "^0.8.15",
+    "eslint-plugin-sf-plugin": "^1.17.3",
+    "oclif": "^4.4.8",
+    "shelljs": "^0.8.5",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.3.3"
+  },
+  "config": {},
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "files": [
+    "/lib",
+    "/messages",
+    "/npm-shrinkwrap.json",
+    "/oclif.lock",
+    "/oclif.manifest.json"
+  ],
+  "homepage": "https://github.com/SimplySF/simply-package",
+  "keywords": [
+    "force",
+    "salesforce",
+    "sfdx",
+    "salesforcedx",
+    "sfdx-plugin",
+    "sf-plugin",
+    "sf"
+  ],
+  "license": "BSD-3-Clause",
+  "oclif": {
+    "additionalVersionFlags": [
+      "-v"
+    ],
+    "additionalHelpFlags": [
+      "-h"
+    ],
+    "bin": "sf",
+    "commands": "./lib/commands",
+    "devPlugins": [
+      "@oclif/plugin-command-snapshot",
+      "@oclif/plugin-help",
+      "@salesforce/plugin-command-reference"
+    ],
+    "flexibleTaxonomy": true,
+    "plugins": [],
+    "repositoryPrefix": "<%- repo %>/blob/<%- version %>/<%- commandPath %>",
+    "topics": {
+      "simply": {
+        "description": "Commands for simplifying Salesforce",
+        "subtopics": {
+          "package": {
+            "description": "Commands for working with packages",
+            "subtopics": {
+              "dependencies": {
+                "description": "Commands for working with package dependencies"
+              },
+              "version": {
+                "description": "Commands for working with package versions"
+              }
+            }
+          }
+        }
+      }
+    },
+    "topicSeparator": " "
+  },
+  "repository": "SimplySF/simply-package",
+  "scripts": {
+    "build": "wireit",
+    "clean": "sf-clean",
+    "clean-all": "sf-clean all",
+    "compile": "wireit",
+    "docs": "sf-docs",
+    "format": "wireit",
+    "link-check": "wireit",
+    "lint": "wireit",
+    "postpack": "sf-clean",
+    "prepack": "sf-prepack",
+    "prepare": "sf-install",
+    "readme": "oclif readme --no-aliases",
+    "test": "wireit",
+    "test:nuts": "nyc mocha \"**/*.nut.ts\" --slow 4500 --timeout 1200000 --parallel --jobs 5",
+    "test:only": "wireit",
+    "test:watch": "mocha --watch \"./test/**/*.test.ts\""
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "wireit": {
+    "build": {
+      "dependencies": [
+        "compile",
+        "lint"
+      ]
+    },
+    "compile": {
+      "command": "tsc -p . --pretty --incremental",
+      "files": [
+        "src/**/*.ts",
+        "**/tsconfig.json",
+        "messages/**"
+      ],
+      "output": [
+        "lib/**",
+        "*.tsbuildinfo"
+      ],
+      "clean": "if-file-deleted"
+    },
+    "format": {
+      "command": "prettier --write \"+(src|test|schemas)/**/*.+(ts|js|json)|command-snapshot.json\"",
+      "files": [
+        "src/**/*.ts",
+        "test/**/*.ts",
+        "schemas/**/*.json",
+        "command-snapshot.json",
+        ".prettier*"
+      ],
+      "output": []
+    },
+    "lint": {
+      "command": "eslint src test --color --cache --cache-location .eslintcache",
+      "files": [
+        "src/**/*.ts",
+        "test/**/*.ts",
+        "messages/**",
+        "**/.eslint*",
+        "**/tsconfig.json"
+      ],
+      "output": []
+    },
+    "test": {
+      "dependencies": [
+        "test:compile",
+        "test:only",
+        "test:command-reference",
+        "test:deprecation-policy",
+        "lint",
+        "test:json-schema",
+        "link-check"
+      ]
+    },
+    "test:command-reference": {
+      "command": "node --loader ts-node/esm --no-warnings=ExperimentalWarning \"./bin/dev.js\" commandreference:generate --erroronwarnings",
+      "files": [
+        "src/**/*.ts",
+        "messages/**",
+        "package.json"
+      ],
+      "output": [
+        "tmp/root"
+      ]
+    },
+    "test:deprecation-policy": {
+      "command": "node --loader ts-node/esm --no-warnings=ExperimentalWarning \"./bin/dev.js\" snapshot:compare",
+      "files": [
+        "src/**/*.ts"
+      ],
+      "output": [],
+      "dependencies": [
+        "compile"
+      ]
+    },
+    "test:json-schema": {
+      "command": "node --loader ts-node/esm --no-warnings=ExperimentalWarning \"./bin/dev.js\" schema:compare",
+      "files": [
+        "src/**/*.ts",
+        "schemas"
+      ],
+      "output": []
+    },
+    "test:compile": {
+      "command": "tsc -p \"./test\" --pretty",
+      "files": [
+        "test/**/*.ts",
+        "**/tsconfig.json"
+      ],
+      "output": []
+    },
+    "test:only": {
+      "command": "nyc mocha \"test/**/*.test.ts\"",
+      "env": {
+        "FORCE_COLOR": "2"
+      },
+      "files": [
+        "test/**/*.ts",
+        "src/**/*.ts",
+        "**/tsconfig.json",
+        ".mocha*",
+        "!*.nut.ts",
+        ".nycrc"
+      ],
+      "output": []
+    },
+    "link-check": {
+      "command": "node -e \"process.exit(process.env.CI ? 0 : 1)\" || linkinator \"**/*.md\" --skip \"CHANGELOG.md|node_modules|test/|confluence.internal.salesforce.com|my.salesforce.com|%s\" --markdown --retry --directory-listing --verbosity error",
+      "files": [
+        "./*.md",
+        "./!(CHANGELOG).md",
+        "messages/**/*.md"
+      ],
+      "output": []
+    }
+  },
+  "exports": "./lib/index.js",
+  "type": "module"
+}