@j-schreiber/sf-cli-security-audit 0.8.2 → 0.8.4

package/oclif.manifest.json

@@ -1,4 +1,255 @@
 {
-  "commands": {},
-  "version": "0.8.2"
+  "commands": {
+    "org:audit:init": {
+      "aliases": [],
+      "args": {},
+      "description": "Uses your org's configuration to set up a new audit config at the target destination. This creates the basic classification and policy files that make up an audit config. You can select from presets to initialise risk levels with default values. After initialisation, you can customize the files to suit your needs.",
+      "examples": [
+        "Initialise audit policies at the root directory\n<%= config.bin %> <%= command.id %> -o MyTargetOrg",
+        "Initialise audit config at custom directory with preset\n<%= config.bin %> <%= command.id %> -o MyTargetOrg -d my_dir -p loose"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "flags-dir": {
+          "helpGroup": "GLOBAL",
+          "name": "flags-dir",
+          "summary": "Import flag values from a directory.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "target-org": {
+          "char": "o",
+          "name": "target-org",
+          "noCacheDefault": true,
+          "required": true,
+          "summary": "Target org to export permissions, profiles, users, etc.",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        },
+        "output-dir": {
+          "char": "d",
+          "name": "output-dir",
+          "required": false,
+          "summary": "Directory where the audit config is initialised. If not set, the root directory will be used.",
+          "default": "",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "preset": {
+          "char": "p",
+          "description": "The selected preset is applied before any other default mechanisms (such as template configs). This means, values from a selected template override the preset. Consult the documentation to learn more about the rationale behind the default risk levels. The risk levels interact with the configured preset on profiles and permission sets and essentially control, if a permission is allowed in a certain profile / permission set.",
+          "name": "preset",
+          "summary": "Preset to initialise defaults for permission risk levels.",
+          "default": "strict",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "strict",
+            "loose",
+            "none"
+          ],
+          "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"
+        }
+      },
+      "hasDynamicHelp": true,
+      "hiddenAliases": [],
+      "id": "org:audit:init",
+      "pluginAlias": "@j-schreiber/sf-cli-security-audit",
+      "pluginName": "@j-schreiber/sf-cli-security-audit",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Initialise a new audit config.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "org",
+        "audit",
+        "init.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "org:audit:init",
+        "audit:org:init",
+        "audit:init:org",
+        "org:init:audit",
+        "init:org:audit",
+        "init:audit:org"
+      ]
+    },
+    "org:audit:run": {
+      "aliases": [],
+      "args": {},
+      "description": "Loads an existing audit config from the source directory and audits the target org. The audit run always creates a comprehensive report in JSON format.",
+      "examples": [
+        "Audit the org MyTargetOrg with the config in configs/prod\n<%= config.bin %> <%= command.id %> -o MyTargetOrg -d configs/prod"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "flags-dir": {
+          "helpGroup": "GLOBAL",
+          "name": "flags-dir",
+          "summary": "Import flag values from a directory.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "target-org": {
+          "char": "o",
+          "name": "target-org",
+          "noCacheDefault": true,
+          "required": true,
+          "summary": "The org that is audited.",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        },
+        "source-dir": {
+          "char": "d",
+          "name": "source-dir",
+          "required": false,
+          "summary": "Source directory of the audit config to run.",
+          "default": "",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "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"
+        }
+      },
+      "hasDynamicHelp": true,
+      "hiddenAliases": [],
+      "id": "org:audit:run",
+      "pluginAlias": "@j-schreiber/sf-cli-security-audit",
+      "pluginName": "@j-schreiber/sf-cli-security-audit",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Audit your org with an existing config.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "org",
+        "audit",
+        "run.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "org:audit:run",
+        "audit:org:run",
+        "audit:run:org",
+        "org:run:audit",
+        "run:org:audit",
+        "run:audit:org"
+      ]
+    },
+    "org:scan:user-perms": {
+      "aliases": [],
+      "args": {},
+      "description": "The target org is scanned \"in memory\" and searches Profiles and Permission Sets for the named user permissions. This command does not need an audit config and does not create a report file.",
+      "examples": [
+        "Search for multiple permissions on MyTargetOrg\n<%= config.bin %> <%= command.id %> -o MyTargetOrg -n AuthorApex -n ModifyMetadata"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "flags-dir": {
+          "helpGroup": "GLOBAL",
+          "name": "flags-dir",
+          "summary": "Import flag values from a directory.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "name": {
+          "char": "n",
+          "description": "You can specify any valid user permission on your org, such as \"AuthorApex\", \"CustomizeApplication\" or \"ViewSetup\". If you are unsure what permissions are available on your org, initialise a new audit config and check the created userPermissions.yml. Currently, the names are not validated: If you have a typo (such as \"AutorApex\", the scan will retun 0 results).",
+          "name": "name",
+          "required": true,
+          "summary": "One or more permissions to be searched for.",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "type": "option"
+        },
+        "target-org": {
+          "char": "o",
+          "name": "target-org",
+          "noCacheDefault": true,
+          "required": true,
+          "summary": "The target org to scan.",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "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"
+        }
+      },
+      "hasDynamicHelp": true,
+      "hiddenAliases": [],
+      "id": "org:scan:user-perms",
+      "pluginAlias": "@j-schreiber/sf-cli-security-audit",
+      "pluginName": "@j-schreiber/sf-cli-security-audit",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Performs a quick scan for specific user permissions.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "org",
+        "scan",
+        "user-perms.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "org:scan:user-perms",
+        "scan:org:user-perms",
+        "scan:user-perms:org",
+        "org:user-perms:scan",
+        "user-perms:org:scan",
+        "user-perms:scan:org"
+      ]
+    }
+  },
+  "version": "0.8.4"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@j-schreiber/sf-cli-security-audit",
   "description": "Salesforce CLI plugin to automate highly configurable security audits",
-  "version": "0.8.2",
+  "version": "0.8.4",
   "repository": {
     "type": "https",
     "url": "https://github.com/j-schreiber/js-sf-cli-security-audit"
@@ -23,21 +23,19 @@
     "zod": "4"
   },
   "devDependencies": {
-    "@oclif/plugin-command-snapshot": "^5.1.9",
-    "@oclif/test": "^4.1.13",
     "@release-it/conventional-changelog": "^10.0.1",
     "@salesforce/cli-plugins-testkit": "^5.3.10",
-    "@salesforce/dev-scripts": "11",
+    "@salesforce/dev-scripts": "^11.0.4",
+    "@salesforce/plugin-command-reference": "^3.1.79",
     "@types/js-yaml": "^4.0.9",
-    "@types/node": "^24.2.1",
-    "eslint": "8",
+    "@types/node": "25",
     "eslint-plugin-sf-plugin": "^1.18.6",
     "husky": "^9.1.7",
     "oclif": "^4.14.0",
     "release-it": "^19.0.3",
-    "ts-node": "^10.9.2",
-    "tsx": "^4.19.2",
-    "typescript": "^5.8.3"
+    "tsx": "^4.21.0",
+    "typescript": "^5.8.3",
+    "wireit": "^0.14.12"
   },
   "engines": {
     "node": ">=18.0.0"
@@ -63,7 +61,8 @@
     "bin": "sf",
     "topicSeparator": " ",
     "devPlugins": [
-      "@oclif/plugin-help"
+      "@oclif/plugin-help",
+      "@salesforce/plugin-command-reference"
     ],
     "topics": {
       "org": {
@@ -85,9 +84,7 @@
     "docs": "sf-docs",
     "format": "wireit",
     "pretty-quick-staged": "pretty-quick --staged",
-    "link-check": "wireit",
     "lint": "wireit",
-    "postpack": "sf-clean --ignore-signing-artifacts",
     "prepack": "sf-prepack",
     "test": "wireit",
     "test:nuts": "nyc mocha \"**/*.nut.ts\" --slow 4500 --timeout 600000 --parallel",
@@ -158,6 +155,7 @@
       "dependencies": [
         "test:compile",
         "test:only",
+        "test:command-reference",
         "lint"
       ]
     },
@@ -177,7 +175,7 @@
       "output": []
     },
     "test:command-reference": {
-      "command": "node --loader ts-node/esm --no-warnings=ExperimentalWarning \"./bin/dev.js\" commandreference:generate --erroronwarnings",
+      "command": "node --import tsx \"./bin/dev.js\" commandreference:generate --error-on-warnings",
       "files": [
         "src/**/*.ts",
         "messages/**",
@@ -187,33 +185,6 @@
         "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": []
-    },
-    "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": []
-    },
     "readme": {
       "dependencies": [
         "build"
@@ -231,5 +202,6 @@
   "directories": {
     "lib": "lib",
     "test": "test"
-  }
+  },
+  "packageManager": "yarn@4.12.0"
 }