@endora-commerce/mod-admin-roles 0.100.0

package/docs/admin_roles.md

@@ -0,0 +1,38 @@
+---
+title: admin_roles
+description: Admin role definitions + per-module Permissions
+---
+
+# `admin_roles`
+
+Admin role definitions and the per-module Permission matrix the role grants.
+
+## Public surface
+
+| Verb + Path | Purpose |
+| --- | --- |
+| `GET /api/v1/admin/roles` | List Roles |
+| `POST /api/v1/admin/roles` | Create Role with a Permission set |
+| `PATCH /api/v1/admin/roles/:id` | Update Role |
+| `DELETE /api/v1/admin/roles/:id` | Delete (rejected if assigned to active admin users) |
+
+## Permission model
+
+Permissions are strings shaped `module:action` (e.g. `catalog:write`,
+`integrations:manage`, `audit:read`). `permission-service.ts` exposes
+`hasPermission(adminUser, 'module:action')`; the `requireAdmin(permission?)`
+pre-handler in `auth/plugin.ts` consults it on every gated route. A Role
+may also require 2FA — `requireAdmin` enforces the 2FA challenge before
+invoking the route handler.
+
+## Entities
+
+`AdminRole`, with `requires2fa: boolean` and a `permissions: string[]`
+column.
+
+## Extension points
+
+- **Custom permission strings** — define new ones at their first use; the
+  permission set is open and not enumerated server-side.
+- **Hierarchical roles** — `permission-service.hasPermission` can resolve
+  inherited permissions; today every Role is flat.

package/i18n/en.json

@@ -0,0 +1,10 @@
+{
+  "nav.adminRoles.label": "Roles",
+  "actions.openAdminRoles.label": "Admin roles",
+  "actions.openAdminRoles.description": "Which permissions each admin role grants",
+  "errors.ADMIN_ROLE_CODE_TAKEN": "A role with that code already exists. Pick a different code, or edit the existing role.",
+  "errors.ADMIN_ROLE_IN_USE": "This role is still assigned, so it cannot be deleted. Reassign the accounts that hold it first.",
+  "errors.ADMIN_ROLE_IN_USE.assigned": "This role is still assigned to {assigned} admin account(s), so it cannot be deleted. Reassign them first.",
+  "errors.ADMIN_ROLE_IN_USE.assigned_to_deleted": "This role is still assigned to {deleted} deleted account(s). Restoring one of them restores the role with it, so the role cannot be deleted while they are in the bin.",
+  "errors.ADMIN_ROLE_PROTECTED": "The \"{role}\" role is seeded by a module and cannot be deleted. Remove the module to remove its role."
+}

package/i18n/pl.json

@@ -0,0 +1,10 @@
+{
+  "nav.adminRoles.label": "Role",
+  "actions.openAdminRoles.label": "Role panelu",
+  "actions.openAdminRoles.description": "Uprawnienia przypisane do każdej roli",
+  "errors.ADMIN_ROLE_CODE_TAKEN": "Rola o tym kodzie już istnieje. Wybierz inny kod albo edytuj istniejącą rolę.",
+  "errors.ADMIN_ROLE_IN_USE": "Ta rola jest nadal przypisana, więc nie można jej usunąć. Najpierw zmień przypisanie kont, które ją mają.",
+  "errors.ADMIN_ROLE_IN_USE.assigned": "Ta rola jest nadal przypisana do {assigned} kont administratorów, więc nie można jej usunąć. Najpierw zmień im przypisanie.",
+  "errors.ADMIN_ROLE_IN_USE.assigned_to_deleted": "Ta rola jest nadal przypisana do {deleted} usuniętych kont. Przywrócenie takiego konta przywraca też jego rolę, więc roli nie można usunąć, dopóki konta są w koszu.",
+  "errors.ADMIN_ROLE_PROTECTED": "Rola „{role}” pochodzi z modułu i nie można jej usunąć. Aby usunąć rolę, usuń moduł."
+}

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "@endora-commerce/mod-admin-roles",
+  "version": "0.100.0",
+  "type": "module",
+  "sideEffects": false,
+  "description": "Admin RBAC — roles, permissions, and policy enforcement for admin sessions.",
+  "license": "MIT",
+  "endora": {
+    "type": "module",
+    "id": "admin_roles"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/endora-commerce/endora-commerce.git",
+    "directory": "packages/modules/admin_roles"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/manifest.d.ts",
+      "default": "./dist/manifest.js"
+    },
+    "./backend": {
+      "types": "./dist/backend/index.d.ts",
+      "default": "./dist/backend/index.js"
+    },
+    "./admin": {
+      "types": "./dist/admin/index.d.ts",
+      "default": "./dist/admin/index.js"
+    },
+    "./tailwind.css": "./tailwind.css",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "i18n",
+    "docs",
+    "tailwind.css"
+  ],
+  "engines": {
+    "node": ">=22.18.0"
+  },
+  "peerDependencies": {
+    "@mikro-orm/core": "^6",
+    "@mikro-orm/postgresql": "^6",
+    "@endora-commerce/admin-kit": "0.100.0",
+    "@endora-commerce/contracts": "0.100.0",
+    "@endora-commerce/platform": "0.100.0"
+  },
+  "peerDependenciesMeta": {
+    "@endora-commerce/admin-kit": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@mikro-orm/core": "^6.6.13",
+    "@mikro-orm/postgresql": "^6.6.13",
+    "@types/node": "^22.9.0",
+    "typescript": "^5.9.3",
+    "vitest": "^4.1.11",
+    "@endora-commerce/admin-kit": "0.100.0",
+    "@endora-commerce/contracts": "0.100.0",
+    "@endora-commerce/platform": "0.100.0"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json && tsc -p tsconfig.ui.json",
+    "typecheck": "tsc -p tsconfig.json && tsc -p tsconfig.ui.json --noEmit",
+    "lint": "eslint src",
+    "test": "vitest run"
+  }
+}

package/tailwind.css

@@ -0,0 +1,14 @@
+/* @endora-commerce/mod-admin-roles — AUTO-GENERATED by `pnpm --filter backend run manifests:generate`.
+ *
+ * The `@source` directives this package asks its host to scan
+ * (`specs/110-instance-repository/contracts/admin-stylesheet-composition.md` R1).
+ * They resolve relative to **this file**, so they hold wherever the package is
+ * installed — a workspace link here, `node_modules` in a client's instance.
+ *
+ * The `dist` line is what a published tarball ships and is what an instance
+ * scans; the `src` line is inert there and is what keeps `pnpm --filter admin
+ * run dev` reading source in this repository. Do not edit: run
+ * `pnpm --filter backend run manifests:generate`.
+ */
+@source "./dist/admin";
+@source "./src/admin";