sf-plugin-permission-sets 0.0.0-dev.3 → 0.0.0-dev.31

package/messages/ps.apply.md

@@ -0,0 +1,81 @@
+# summary
+
+Reconcile a target org to match the permission set assignment files.
+
+# description
+
+Load the files, resolve every user and target against the org, diff the desired state against what the org currently has, then add, update expirations, and/or remove assignments per the mode. Additions, expiration updates, and removals run through the sObject Collections API with partial success, so one bad record does not roll back the rest. Deletions are capped by --max-deletes and confirmed before they run. Run validate and a --dry-run first.
+
+# flags.file.summary
+
+YAML file or glob to apply. Repeatable.
+
+# flags.mode.summary
+
+Which half of the reconcile to run: additive adds missing assignments and updates expirations, destructive removes only, sync does both.
+
+# flags.max-deletes.summary
+
+Abort before any change if the run would remove more than this many assignments.
+
+# flags.dry-run.summary
+
+Resolve and diff, print the plan, and change nothing.
+
+# flags.no-prompt.summary
+
+Skip the deletion confirmation prompt. Required to delete in JSON or other non-interactive runs.
+
+# confirm.delete
+
+This will remove %s assignment(s) from the org. Continue?
+
+# summary.dryRun
+
+Dry run: %s to add, %s to update, %s to remove. Nothing was changed.
+
+# summary.applied
+
+Applied: %s added, %s updated, %s removed.
+
+# summary.declined
+
+Aborted at the confirmation prompt. Nothing was changed.
+
+# drift.note
+
+%s change(s) the %s mode does not act on were skipped (drift). Run plan to see them.
+
+# failure.line
+
+failed to %s %s on %s: %s
+
+# error.invalid
+
+The files do not resolve cleanly against the org. Fix the errors above, then re-run.
+
+# error.maxDeletes
+
+Refusing to remove %s assignment(s): over the --max-deletes limit of %s. Raise the limit or narrow the change.
+
+# error.promptInJson
+
+Refusing to delete without confirmation in a non-interactive run. Re-run with --no-prompt.
+
+# error.failed
+
+Some changes failed. See the per-record errors above.
+
+# examples
+
+- Preview a full reconcile of the dev org without changing anything:
+
+  <%= config.bin %> <%= command.id %> --file "permissions/*.yml" --target-org dev --mode sync --dry-run
+
+- Grant any missing assignments (additive, the default):
+
+  <%= config.bin %> <%= command.id %> --file "permissions/*.yml" --target-org dev
+
+- Full reconcile of production in CI, without prompts:
+
+  <%= config.bin %> <%= command.id %> --file "permissions/*.yml" --target-org prod --mode sync --no-prompt

package/messages/ps.check.md

@@ -0,0 +1,33 @@
+# summary
+
+Statically check permission set assignment files, with no org connection.
+
+# description
+
+Parse and validate the YAML files offline. Reports invalid YAML, schema violations, duplicate keys, duplicate targets, and empty entries. Run it in a pre-commit hook or in CI before validate, plan, or apply.
+
+# flags.file.summary
+
+YAML file or glob to check. Repeatable.
+
+# flags.strict.summary
+
+Treat warnings as errors.
+
+# summary.counts
+
+%s errors, %s warnings.
+
+# error.failed
+
+Check found problems. See the output above.
+
+# examples
+
+- Check every file under permissions:
+
+  <%= config.bin %> <%= command.id %> --file "permissions/*.yml"
+
+- Check specific files:
+
+  <%= config.bin %> <%= command.id %> --file permissions/sales.yml --file permissions/service.yml

package/messages/ps.export.md

@@ -0,0 +1,25 @@
+# summary
+
+Generate a YAML file from the current org's permission set assignments.
+
+# description
+
+Query the target org for every assignable permission set, group, and license assignment held by active users and write them to a single user-keyed YAML file. The result is valid input for check, validate, plan, and apply, so it is a read-only way to bootstrap adoption from an org's current state. Profile-owned permission sets and inactive users are skipped.
+
+# flags.output-file.summary
+
+Path of the YAML file to write. Created (and its parent directories) if missing, overwritten if present.
+
+# success
+
+Exported %s assignments across %s users to %s.
+
+# examples
+
+- Export the dev org's assignments to permissions.yml:
+
+  <%= config.bin %> <%= command.id %> --target-org dev --output-file permissions.yml
+
+- Export a production org into an environment folder:
+
+  <%= config.bin %> <%= command.id %> --target-org prod --output-file permissions/prod.yml

package/messages/ps.plan.md

@@ -0,0 +1,45 @@
+# summary
+
+Preview the changes that would reconcile a target org to the assignment files.
+
+# description
+
+Load the files, resolve every user and target against the org, fetch the org's current assignments, and diff the desired state against them. Read-only: it queries the org but never changes it, so it is the apply pipeline stopping before any DML. The full picture (assignments to add and would-be removes) is always shown regardless of mode, and whatever the chosen mode would not act on is surfaced as drift. Run it before apply to preview what would change.
+
+# flags.file.summary
+
+YAML file or glob to plan. Repeatable.
+
+# flags.mode.summary
+
+Which half of the reconcile to preview: additive adds and updates expirations, destructive removes only, sync does both. Adds, expiration updates, and removes are always shown either way.
+
+# summary.counts
+
+Plan: %s to add, %s to update, %s to remove, %s unchanged.
+
+# summary.next
+
+Reviewed the plan? Apply it with the same files: sf ps apply --mode %s
+
+# drift.note
+
+%s change(s) the %s mode does not act on were surfaced as drift.
+
+# error.invalid
+
+The files do not resolve cleanly against the org. Fix the errors above, then re-run.
+
+# examples
+
+- Preview a full reconcile of the dev org:
+
+  <%= config.bin %> <%= command.id %> --file "permissions/*.yml" --target-org dev --mode sync
+
+- Preview only the additions the default additive run would make:
+
+  <%= config.bin %> <%= command.id %> --file "permissions/*.yml" --target-org dev
+
+- Preview a full reconcile of production before applying it:
+
+  <%= config.bin %> <%= command.id %> --file "permissions/*.yml" --target-org prod --mode sync

package/messages/ps.validate.md

@@ -0,0 +1,29 @@
+# summary
+
+Validate permission set assignment files against a target org.
+
+# description
+
+Run every offline check, then resolve each referenced user, permission set, group, and license against the org. Reports users that are missing or inactive and targets that are missing or not unique. Read-only: it queries the org but never changes it. Run it before plan or apply.
+
+# flags.file.summary
+
+YAML file or glob to validate. Repeatable.
+
+# summary.counts
+
+%s errors, %s warnings.
+
+# error.failed
+
+Validation found problems. See the output above.
+
+# examples
+
+-   Validate every file under permissions against the dev org:
+
+    <%= config.bin %> <%= command.id %> --file "permissions/\*.yml" --target-org dev
+
+-   Validate specific files against a named org:
+
+    <%= config.bin %> <%= command.id %> --file permissions/sales.yml --file permissions/service.yml --target-org prod

package/package.json

@@ -1,191 +1,129 @@
 {
-  "name": "sf-plugin-permission-sets",
-  "description": "",
-  "version": "0.0.0-dev.3",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/zaclummys/sf-plugin-permission-sets.git"
-  },
-  "dependencies": {
-    "@oclif/core": "^4",
-    "@salesforce/core": "^8",
-    "@salesforce/sf-plugins-core": "^12"
-  },
-  "devDependencies": {
-    "@oclif/plugin-command-snapshot": "^5.1.9",
-    "@salesforce/cli-plugins-testkit": "^5.3.10",
-    "@salesforce/dev-scripts": "^10",
-    "eslint-plugin-sf-plugin": "^1.18.6",
-    "husky": "^7.0.4",
-    "oclif": "^4.14.0",
-    "ts-node": "^10.9.2",
-    "typescript": "^5.4.5"
-  },
-  "engines": {
-    "node": ">=18.0.0"
-  },
-  "files": [
-    "/lib",
-    "/messages",
-    "/oclif.manifest.json",
-    "/oclif.lock"
-  ],
-  "keywords": [
-    "force",
-    "salesforce",
-    "salesforcedx",
-    "sf",
-    "sf-plugin",
-    "sfdx",
-    "sfdx-plugin"
-  ],
-  "license": "BSD-3-Clause",
-  "oclif": {
-    "commands": "./lib/commands",
-    "bin": "sf",
-    "topicSeparator": " ",
-    "devPlugins": [
-      "@oclif/plugin-help"
-    ],
-    "topics": {
-      "hello": {
-        "description": "Commands to say hello."
-      }
-    },
-    "flexibleTaxonomy": true
-  },
-  "scripts": {
-    "build": "wireit",
-    "clean": "sf-clean",
-    "clean-all": "sf-clean all",
-    "compile": "wireit",
-    "docs": "sf-docs",
-    "format": "wireit",
-    "link-check": "wireit",
-    "lint": "wireit",
-    "prepare": "husky install",
-    "postpack": "sf-clean --ignore-signing-artifacts",
-    "prepack": "sf-prepack",
-    "test": "wireit",
-    "test:nuts": "nyc mocha \"**/*.nut.ts\" --slow 4500 --timeout 600000 --parallel",
-    "test:only": "wireit",
-    "version": "oclif readme"
-  },
-  "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"
+    "name": "sf-plugin-permission-sets",
+    "description": "Declarative, GitOps-style management of permission set assignments for Salesforce orgs.",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/zaclummys/sf-plugin-permission-sets.git"
     },
-    "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": []
+    "dependencies": {
+        "@oclif/core": "^4",
+        "@salesforce/core": "^8",
+        "@salesforce/sf-plugins-core": "^12",
+        "globby": "^16.2.0",
+        "yaml": "^2.9.0",
+        "zod": "^4.4.3"
     },
-    "lint": {
-      "command": "eslint src test --color --cache --cache-location .eslintcache",
-      "files": [
-        "src/**/*.ts",
-        "test/**/*.ts",
-        "messages/**",
-        "**/.eslint*",
-        "**/tsconfig.json"
-      ],
-      "output": []
+    "devDependencies": {
+        "@eslint/js": "^10.0.1",
+        "eslint": "^10.6.0",
+        "execa": "^9.6.1",
+        "globals": "^17.7.0",
+        "ts-node": "^10.9.2",
+        "typescript": "^6.0.3",
+        "typescript-eslint": "^8.62.1",
+        "vitest": "^4.1.9",
+        "wireit": "^0.14.0"
     },
-    "test:compile": {
-      "command": "tsc -p \"./test\" --pretty",
-      "files": [
-        "test/**/*.ts",
-        "**/tsconfig.json"
-      ],
-      "output": []
+    "engines": {
+        "node": ">=18.0.0"
     },
-    "test": {
-      "dependencies": [
-        "test:compile",
-        "test:only",
-        "lint"
-      ]
-    },
-    "test:only": {
-      "command": "nyc mocha \"test/**/*.test.ts\"",
-      "env": {
-        "FORCE_COLOR": "2"
-      },
-      "files": [
-        "test/**/*.ts",
-        "src/**/*.ts",
-        "**/tsconfig.json",
-        ".mocha*",
-        "!*.nut.ts",
-        ".nycrc"
-      ],
-      "output": []
+    "files": [
+        "/lib",
+        "/messages"
+    ],
+    "keywords": [
+        "salesforce",
+        "sf-plugin",
+        "sfdx-plugin",
+        "permission-sets",
+        "permission-set-assignment",
+        "permission-set-group",
+        "access-management",
+        "user-provisioning",
+        "gitops",
+        "declarative"
+    ],
+    "license": "BSD-3-Clause",
+    "oclif": {
+        "commands": "./lib/commands",
+        "bin": "sf",
+        "topicSeparator": " ",
+        "devPlugins": [
+            "@oclif/plugin-help"
+        ],
+        "topics": {
+            "ps": {
+                "description": "Manage permission set assignments declaratively."
+            }
+        },
+        "flexibleTaxonomy": true
     },
-    "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"
-      ]
+    "scripts": {
+        "build": "wireit",
+        "clean": "rm -rf lib tmp *.tsbuildinfo .eslintcache .wireit",
+        "compile": "wireit",
+        "lint": "wireit",
+        "prepack": "npm run compile",
+        "test": "wireit",
+        "test:only": "wireit",
+        "version": "oclif readme"
     },
-    "test:deprecation-policy": {
-      "command": "node --loader ts-node/esm --no-warnings=ExperimentalWarning \"./bin/dev.js\" snapshot:compare",
-      "files": [
-        "src/**/*.ts"
-      ],
-      "output": [],
-      "dependencies": [
-        "compile"
-      ]
+    "publishConfig": {
+        "access": "public"
     },
-    "test:json-schema": {
-      "command": "node --loader ts-node/esm --no-warnings=ExperimentalWarning \"./bin/dev.js\" schema:compare",
-      "files": [
-        "src/**/*.ts",
-        "schemas"
-      ],
-      "output": []
+    "wireit": {
+        "build": {
+            "dependencies": [
+                "compile",
+                "lint"
+            ]
+        },
+        "compile": {
+            "command": "tsc -p . --pretty --incremental",
+            "files": [
+                "src/**/*.ts",
+                "**/tsconfig.json",
+                "messages/**"
+            ],
+            "output": [
+                "lib/**",
+                "*.tsbuildinfo"
+            ],
+            "clean": "if-file-deleted"
+        },
+        "lint": {
+            "command": "eslint src --color --cache --cache-location .eslintcache",
+            "files": [
+                "src/**/*.ts",
+                "messages/**",
+                "**/.eslint*",
+                "**/tsconfig.json"
+            ],
+            "output": []
+        },
+        "test": {
+            "dependencies": [
+                "test:only",
+                "lint"
+            ]
+        },
+        "test:only": {
+            "command": "vitest run",
+            "dependencies": [
+                "compile"
+            ],
+            "env": {
+                "FORCE_COLOR": "2"
+            },
+            "files": [
+                "test/**",
+                "vitest.config.js"
+            ],
+            "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",
-  "author": "Isaac Ferreira"
+    "exports": "./lib/index.js",
+    "type": "module",
+    "author": "Isaac Ferreira",
+    "version": "0.0.0-dev.31"
 }

package/lib/commands/hello/world.d.ts

@@ -1,14 +0,0 @@
-import { SfCommand } from '@salesforce/sf-plugins-core';
-export type HelloWorldResult = {
-    name: string;
-    time: string;
-};
-export default class World extends SfCommand<HelloWorldResult> {
-    static readonly summary: string;
-    static readonly description: string;
-    static readonly examples: string[];
-    static readonly flags: {
-        name: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
-    };
-    run(): Promise<HelloWorldResult>;
-}

package/lib/commands/hello/world.js

@@ -1,27 +0,0 @@
-import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
-import { Messages } from '@salesforce/core';
-Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
-const messages = Messages.loadMessages('sf-plugin-permission-sets', 'hello.world');
-export default class World extends SfCommand {
-    static summary = messages.getMessage('summary');
-    static description = messages.getMessage('description');
-    static examples = messages.getMessages('examples');
-    static flags = {
-        name: Flags.string({
-            char: 'n',
-            summary: messages.getMessage('flags.name.summary'),
-            description: messages.getMessage('flags.name.description'),
-            default: 'World',
-        }),
-    };
-    async run() {
-        const { flags } = await this.parse(World);
-        const time = new Date().toDateString();
-        this.log(messages.getMessage('info.hello', [flags.name, time]));
-        return {
-            name: flags.name,
-            time,
-        };
-    }
-}
-//# sourceMappingURL=world.js.map

package/lib/commands/hello/world.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"world.js","sourceRoot":"","sources":["../../../src/commands/hello/world.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAE5C,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,2BAA2B,EAAE,aAAa,CAAC,CAAC;AAOnF,MAAM,CAAC,OAAO,OAAO,KAAM,SAAQ,SAA2B;IACrD,MAAM,CAAU,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACzD,MAAM,CAAU,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,CAAU,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAE5D,MAAM,CAAU,KAAK,GAAG;QAC7B,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC;YACjB,IAAI,EAAE,GAAG;YACT,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC;YAClD,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,wBAAwB,CAAC;YAC1D,OAAO,EAAE,OAAO;SACjB,CAAC;KACH,CAAC;IAEK,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC1C,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC,YAAY,EAAE,CAAC;QACvC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,YAAY,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;QAChE,OAAO;YACL,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,IAAI;SACL,CAAC;IACJ,CAAC"}

package/messages/hello.world.md

@@ -1,29 +0,0 @@
-# summary
-
-Say hello.
-
-# description
-
-Say hello either to the world or someone you know.
-
-# flags.name.summary
-
-The name of the person you'd like to say hello to.
-
-# flags.name.description
-
-This person can be anyone in the world!
-
-# examples
-
-- Say hello to the world:
-
-  <%= config.bin %> <%= command.id %>
-
-- Say hello to someone you know:
-
-  <%= config.bin %> <%= command.id %> --name Astro
-
-# info.hello
-
-Hello %s at %s.