@zakyyudha/node-authzkit 1.0.0

package/src/dashboard/router.ts

@@ -0,0 +1,79 @@
+import { Router } from 'express';
+import * as express from 'express';
+import * as path from 'path';
+import * as fs from 'fs';
+import basicAuth from 'basic-auth';
+import rolesRouter from './routes/roles';
+import permissionsRouter from './routes/permissions';
+import usersRouter from './routes/users';
+import { Authzkit } from '../classes/Authzkit';
+
+export interface DashboardOptions {
+  /**
+   * Authzkit instance to use. If not provided, uses the singleton.
+   */
+  authzkit?: Authzkit;
+  /**
+   * Secret password for Basic Auth.
+   * If not provided, checks AUTHZKIT_DASHBOARD_SECRET env var.
+   * If neither is present, dashboard will not be accessible (returns 500 configuration error or 401).
+   */
+  secret?: string;
+  /**
+   * Usersname for Basic Auth. Defaults to 'admin'.
+   */
+  username?: string;
+}
+
+export function createDashboardRouter(options: DashboardOptions = {}): Router {
+  const router = Router();
+  const username = options.username || process.env.AUTHZKIT_DASHBOARD_USERNAME || 'admin';
+  const secret = options.secret || process.env.AUTHZKIT_DASHBOARD_SECRET;
+
+  // Trailing slash redirection for proper relative path resolution in frontend
+  router.use((req, res, next) => {
+    if (req.path === '/' && !req.originalUrl.endsWith('/')) {
+      return res.redirect(req.originalUrl + '/');
+    }
+    next();
+  });
+
+  // Basic Authentication Middleware
+  router.use((req, res, next) => {
+    if (!secret) {
+      console.warn('Authzkit Dashboard: No secret provided. Dashboard is disabled.');
+      return res.status(500).send('Dashboard configuration error: No secret provided.');
+    }
+
+    const user = basicAuth(req);
+    if (!user || user.name !== username || user.pass !== secret) {
+      res.set('WWW-Authenticate', 'Basic realm="Authzkit Dashboard"');
+      return res.status(401).send('Authentication required.');
+    }
+    next();
+  });
+
+  // API Routes
+  router.use('/api/roles', rolesRouter);
+  router.use('/api/permissions', permissionsRouter);
+  router.use('/api/users', usersRouter);
+
+  // Static Assets
+  // In src environment: ./web/dist (relative to this file)
+  const staticPath = path.join(__dirname, 'web/dist');
+
+  // In dist environment, this file is in dist/src/dashboard/router.js
+  // And web assets are in dist/src/dashboard/web/dist (copied by build script)
+  // So relative path is still 'web/dist'
+
+  // Check if dist exists (maybe we are in dev and it hasn't been built yet, or path is wrong)
+  if (!fs.existsSync(staticPath)) {
+    console.warn(
+      `Authzkit Dashboard: Static assets not found at ${staticPath}. Did you run 'pnpm build:web'?`
+    );
+  }
+
+  router.use(express.static(staticPath));
+
+  return router;
+}

package/src/dashboard/routes/permissions.ts

@@ -0,0 +1,38 @@
+import { Router } from 'express';
+import { Authzkit } from '../../classes/Authzkit';
+
+const router: Router = Router();
+
+router.get('/', async (req, res) => {
+  try {
+    const authzkit = Authzkit.getInstance();
+    const permissions = await authzkit.getPermissions();
+    res.json(permissions);
+  } catch (err: any) {
+    res.status(500).json({ error: err.message });
+  }
+});
+
+router.post('/', async (req, res) => {
+  try {
+    const { name, guard_name } = req.body;
+    const authzkit = Authzkit.getInstance();
+    const permission = await authzkit.definePermission(name, guard_name);
+    res.status(201).json(permission);
+  } catch (err: any) {
+    res.status(400).json({ error: err.message });
+  }
+});
+
+router.delete('/:name', async (req, res) => {
+  try {
+    const { name } = req.params;
+    const authzkit = Authzkit.getInstance();
+    await authzkit.deletePermission(name);
+    res.status(204).send();
+  } catch (err: any) {
+    res.status(500).json({ error: err.message });
+  }
+});
+
+export default router;

package/src/dashboard/routes/roles.ts

@@ -0,0 +1,38 @@
+import { Router } from 'express';
+import { Authzkit } from '../../classes/Authzkit';
+
+const router: Router = Router();
+
+router.get('/', async (req, res) => {
+  try {
+    const authzkit = Authzkit.getInstance();
+    const roles = await authzkit.getRoles();
+    res.json(roles);
+  } catch (err: any) {
+    res.status(500).json({ error: err.message });
+  }
+});
+
+router.post('/', async (req, res) => {
+  try {
+    const { name, permissions, guard_name } = req.body;
+    const authzkit = Authzkit.getInstance();
+    const role = await authzkit.defineRole(name, permissions, guard_name);
+    res.status(201).json(role);
+  } catch (err: any) {
+    res.status(400).json({ error: err.message });
+  }
+});
+
+router.delete('/:name', async (req, res) => {
+  try {
+    const { name } = req.params;
+    const authzkit = Authzkit.getInstance();
+    await authzkit.deleteRole(name);
+    res.status(204).send();
+  } catch (err: any) {
+    res.status(500).json({ error: err.message });
+  }
+});
+
+export default router;

package/src/dashboard/routes/users.ts

@@ -0,0 +1,81 @@
+import { Router } from 'express';
+import { Authzkit } from '../../classes/Authzkit';
+import { Authorizable } from '../../interfaces/Authorizable';
+
+const router: Router = Router();
+
+router.get('/:userId/roles', async (req, res) => {
+  try {
+    const { userId } = req.params;
+    const user: Authorizable = { id: userId, roles: [], permissions: [] };
+    const authzkit = Authzkit.getInstance();
+    const roles = await authzkit.getUserRoles(user);
+    res.json(Array.from(roles));
+  } catch (err: any) {
+    res.status(500).json({ error: err.message });
+  }
+});
+
+router.post('/:userId/roles', async (req, res) => {
+  try {
+    const { userId } = req.params;
+    const { roleName } = req.body;
+    const user: Authorizable = { id: userId, roles: [], permissions: [] };
+    const authzkit = Authzkit.getInstance();
+    await authzkit.assignRole(user, roleName);
+    res.status(201).send();
+  } catch (err: any) {
+    res.status(400).json({ error: err.message });
+  }
+});
+
+router.delete('/:userId/roles/:roleName', async (req, res) => {
+  try {
+    const { userId, roleName } = req.params;
+    const user: Authorizable = { id: userId, roles: [], permissions: [] };
+    const authzkit = Authzkit.getInstance();
+    await authzkit.revokeRole(user, roleName);
+    res.status(204).send();
+  } catch (err: any) {
+    res.status(500).json({ error: err.message });
+  }
+});
+
+router.get('/:userId/permissions', async (req, res) => {
+  try {
+    const { userId } = req.params;
+    const user: Authorizable = { id: userId, roles: [], permissions: [] };
+    const authzkit = Authzkit.getInstance();
+    const permissions = await authzkit.getUserPermissions(user);
+    res.json(Array.from(permissions));
+  } catch (err: any) {
+    res.status(500).json({ error: err.message });
+  }
+});
+
+router.post('/:userId/permissions', async (req, res) => {
+  try {
+    const { userId } = req.params;
+    const { permissionName } = req.body;
+    const user: Authorizable = { id: userId, roles: [], permissions: [] };
+    const authzkit = Authzkit.getInstance();
+    await authzkit.assignPermission(user, permissionName);
+    res.status(201).send();
+  } catch (err: any) {
+    res.status(400).json({ error: err.message });
+  }
+});
+
+router.delete('/:userId/permissions/:permissionName', async (req, res) => {
+  try {
+    const { userId, permissionName } = req.params;
+    const user: Authorizable = { id: userId, roles: [], permissions: [] };
+    const authzkit = Authzkit.getInstance();
+    await authzkit.revokePermission(user, permissionName);
+    res.status(204).send();
+  } catch (err: any) {
+    res.status(500).json({ error: err.message });
+  }
+});
+
+export default router;

package/src/dashboard/web/README.md

@@ -0,0 +1,73 @@
+# React + TypeScript + Vite
+
+This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+
+Currently, two official plugins are available:
+
+- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) (or [oxc](https://oxc.rs) when used in [rolldown-vite](https://vite.dev/guide/rolldown)) for Fast Refresh
+- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+
+## React Compiler
+
+The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation).
+
+## Expanding the ESLint configuration
+
+If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
+
+```js
+export default defineConfig([
+  globalIgnores(['dist']),
+  {
+    files: ['**/*.{ts,tsx}'],
+    extends: [
+      // Other configs...
+
+      // Remove tseslint.configs.recommended and replace with this
+      tseslint.configs.recommendedTypeChecked,
+      // Alternatively, use this for stricter rules
+      tseslint.configs.strictTypeChecked,
+      // Optionally, add this for stylistic rules
+      tseslint.configs.stylisticTypeChecked,
+
+      // Other configs...
+    ],
+    languageOptions: {
+      parserOptions: {
+        project: ['./tsconfig.node.json', './tsconfig.app.json'],
+        tsconfigRootDir: import.meta.dirname,
+      },
+      // other options...
+    },
+  },
+])
+```
+
+You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
+
+```js
+// eslint.config.js
+import reactX from 'eslint-plugin-react-x'
+import reactDom from 'eslint-plugin-react-dom'
+
+export default defineConfig([
+  globalIgnores(['dist']),
+  {
+    files: ['**/*.{ts,tsx}'],
+    extends: [
+      // Other configs...
+      // Enable lint rules for React
+      reactX.configs['recommended-typescript'],
+      // Enable lint rules for React DOM
+      reactDom.configs.recommended,
+    ],
+    languageOptions: {
+      parserOptions: {
+        project: ['./tsconfig.node.json', './tsconfig.app.json'],
+        tsconfigRootDir: import.meta.dirname,
+      },
+      // other options...
+    },
+  },
+])
+```

package/src/dashboard/web/eslint.config.js

@@ -0,0 +1,23 @@
+import js from '@eslint/js'
+import globals from 'globals'
+import reactHooks from 'eslint-plugin-react-hooks'
+import reactRefresh from 'eslint-plugin-react-refresh'
+import tseslint from 'typescript-eslint'
+import { defineConfig, globalIgnores } from 'eslint/config'
+
+export default defineConfig([
+  globalIgnores(['dist']),
+  {
+    files: ['**/*.{ts,tsx}'],
+    extends: [
+      js.configs.recommended,
+      tseslint.configs.recommended,
+      reactHooks.configs.flat.recommended,
+      reactRefresh.configs.vite,
+    ],
+    languageOptions: {
+      ecmaVersion: 2020,
+      globals: globals.browser,
+    },
+  },
+])

package/src/dashboard/web/index.html

@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>web</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>

package/src/dashboard/web/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "web",
+  "private": true,
+  "version": "0.0.0",
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc -b && vite build",
+    "lint": "eslint .",
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "react": "^19.2.0",
+    "react-dom": "^19.2.0",
+    "react-router-dom": "^7.13.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.39.1",
+    "@types/node": "^24.10.1",
+    "@types/react": "^19.2.5",
+    "@types/react-dom": "^19.2.3",
+    "@vitejs/plugin-react": "^5.1.1",
+    "eslint": "^9.39.1",
+    "eslint-plugin-react-hooks": "^7.0.1",
+    "eslint-plugin-react-refresh": "^0.4.24",
+    "globals": "^16.5.0",
+    "typescript": "~5.9.3",
+    "typescript-eslint": "^8.46.4",
+    "vite": "^7.2.4"
+  }
+}