Initialize custom user role aliases and access levels

Author: faisalnjs

README.md

@@ -57,8 +57,19 @@ commtrackr.init({ // Initialize CommTracker with configurations
   },
   vars: {
     userId: 'username', // req.session object variable for unique user identification
-    userName: 'name', // req.session object variable for user name
+    userName: 'Name', // req.session object variable for user name
     role: 'role', // req.session object variable for user role
+    roleAliases: { // Use if your role names differ from 'admin', 'dev', or 'user'
+      user: ['user', 'standard', 'basic'], // Aliases for user roles
+      dev: ['dev', 'developer'], // Aliases for developer roles
+      admin: ['admin', 'administrator', 'superuser'] // Aliases for admin roles
+    },
+    access: { // Alternative access control using numeric levels
+      var: 'access', // req.session object variable for access level
+      user: [0], // Access levels for standard users
+      dev: [1], // Access levels for developers
+      admin: [2] // Access levels for admins
+    },
     commissions: 'commissions', // req.session object variable for user commissions array
   },
 });
@@ -78,37 +89,69 @@ These variables must be set in your `req.session` object to enable CommTrackr fu
 
 Type: `String`
 
+Default: `'username'`
+
 Fallback: None
 
-Example: `'username'`
+Session Example: `'id'`
 
 ### userName
 
 `req.session.userName` should contain the name of the user. This is used for display purposes in the CommTrackr interface. Fallback to `userId` if not set.
 
 Type: `String`
 
+Default: `'name'`
+
 Fallback: `req.session.userId`
 
-Example: `'John Doe'`
+Session Example: `'John Doe'`
 
 ### role
 
 `req.session.role` should contain the role of the user: 'admin', `dev`, or 'user'. This is used to control access to certain features and functionalities within CommTrackr.
 
 Type: `String`
 
+Default: `'role'`
+
 Fallback: `user`
 
-Example: `'user'`, `'dev'`, `'admin'`
+Session Example: `'user'`, `'dev'`, `'admin'`
+
+### roleAliases
+
+`req.session.role` can also be set to custom role names. Use `roleAliases` to map your custom role names to the standard roles used by CommTrackr.
+
+Type: `Object`
+
+Default:
+
+```javascript
+{}
+```
+
+### access
+
+`req.session.access` can be used as an alternative to `role` for access control. It should contain numeric access levels. Use the `access` configuration to define which levels correspond to 'user', 'dev', and 'admin'.
+
+Type: `Array`
+
+Default:
+
+```javascript
+{}
+```
 
 ### commissions
 
 `req.session.commissions` should be an array of commission objects associated with the user. Each commission object should have the following structure:
 
 Type: `Array`
 
-Example:
+Default: `'commissions'`
+
+Session Example:
 
 ```javascript
 [

frontend/public/scripts.js

@@ -16,7 +16,7 @@ function anim_out() {
     document.querySelector('main').classList.add('out');
 };
 
-anim_in();
+document.onload = anim_in();
 
 // anim_out();
 // setTimeout(() => {

frontend/public/styles.css

@@ -112,7 +112,7 @@ main {
         max-width: 1000px;
 		height: 100%;
 		position: relative;
-		transition-timing-function: linear;
+		transition-timing-function: ease-in-out;
 		opacity: 0;
 
 		> img {

index.js

@@ -39,13 +39,25 @@ function init({
     auth: {
       enabled: false,
       provider: '',
-      url: '',
-    },
+      url: ''
+    }
   },
   vars: newVars = {
     userId: 'username',
+    userName: 'name',
     role: 'role',
-    commissions: 'commissions',
+    roleAliases: {
+      user: ['user', 'standard', 'basic'],
+      dev: ['dev', 'developer'],
+      admin: ['admin', 'administrator', 'superuser']
+    },
+    access: {
+      var: 'access',
+      user: [0],
+      dev: [2],
+      admin: [4, 5]
+    },
+    commissions: 'commissions'
   },
   handler: newHandler = null
 }) {
@@ -67,7 +79,10 @@ function init({
   };
   vars = {
     userId: 'username',
+    userName: 'name',
     role: 'role',
+    roleAliases: {},
+    access: {},
     commissions: 'commissions',
     ...newVars
   },
@@ -89,14 +104,14 @@ app.get('/', async (req, res) => {
   if (!on) return res.render('off', { tenant, title: 'Activation - ' });
   if (!req.session) return res.render('session', { tenant, title: 'Session - ' });
   if (!tenant.slug || !tenant.name || !tenant.domain) return res.render('tenant', { tenant, title: 'Configuration - ' });
-  if (tenant.auth && tenant.auth.enabled && !user.id) return res.render('auth', { tenant, title: 'Authenticate - ' });
-  res.send(tenant.slug);
+  if (tenant.auth && tenant.auth.enabled && vars.userId && !req.session[vars.userId]) return res.render('auth', { tenant, title: 'Authenticate - ' });
+  res.send(`Hello ${req.session[vars.name] || req.session[vars.userId]}`);
 });
 
 module.exports = {
   routes: app,
   init,
   activate,
   on: activate,
-  setUser
+  // setUser
 };