mbkauthe 1.4.1 → 2.0.0

package/.github/PACKAGE.md

@@ -10,7 +10,7 @@ npm install mbkauthe
 
 ## Version
 
-Current Version: 1.4.1
+Current Version: 1.4.2
 
 ## Registry
 

package/.github/workflows/publish.yml

@@ -1,4 +1,4 @@
-name: Publish to npm
+name: Publish to npm and GitHub Packages
 on:
   push:
     branches:
@@ -36,19 +36,52 @@ jobs:
         run: |
           for i in {1..3}; do npm install && break || sleep 10; done
 
+      - name: Check if version exists on npm
+        id: check_version
+        run: |
+          PACKAGE_NAME=$(node -p "require('./package.json').name")
+          VERSION=$(node -p "require('./package.json').version")
+          if npm view $PACKAGE_NAME@$VERSION version 2>/dev/null; then
+            echo "exists=true" >> $GITHUB_OUTPUT
+            echo "Version $VERSION already exists on npm"
+          else
+            echo "exists=false" >> $GITHUB_OUTPUT
+            echo "Version $VERSION does not exist, will publish"
+          fi
+
       - name: Publish to npm
+        if: steps.check_version.outputs.exists == 'false'
         run: npm publish
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
 
+      - name: Check if version exists on GitHub Packages
+        id: check_github_version
+        run: |
+          VERSION=$(node -p "require('./package.json').version")
+          if curl -f -H "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \
+            https://npm.pkg.github.com/@mibnekhalid/mbkauthe/$VERSION 2>/dev/null; then
+            echo "exists=true" >> $GITHUB_OUTPUT
+            echo "Version $VERSION already exists on GitHub Packages"
+          else
+            echo "exists=false" >> $GITHUB_OUTPUT
+            echo "Version $VERSION does not exist on GitHub Packages, will publish"
+          fi
+
+      - name: Modify package.json for GitHub Packages
+        if: steps.check_github_version.outputs.exists == 'false'
+        run: |
+          node -e "const pkg = require('./package.json'); pkg.name = '@mibnekhalid/mbkauthe'; pkg.publishConfig = { registry: 'https://npm.pkg.github.com' }; require('fs').writeFileSync('package.json', JSON.stringify(pkg, null, 2));"
+
       - name: Setup Node.js for GitHub Packages
+        if: steps.check_github_version.outputs.exists == 'false'
         uses: actions/setup-node@v3
         with:
           node-version: '18'
           registry-url: 'https://npm.pkg.github.com'
-          scope: '@MIbnEKhalid'
 
       - name: Publish to GitHub Packages
+        if: steps.check_github_version.outputs.exists == 'false'
         run: npm publish
         env:
           NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/README.md

@@ -6,7 +6,7 @@
 [![Publish to npm](https://github.com/MIbnEKhalid/mbkauthe/actions/workflows/publish.yml/badge.svg?branch=main)](https://github.com/MIbnEKhalid/mbkauthe/actions/workflows/publish.yml)
 [![CodeQL Advanced](https://github.com/MIbnEKhalid/mbkauthe/actions/workflows/codeql.yml/badge.svg?branch=main)](https://github.com/MIbnEKhalid/mbkauthe/actions/workflows/codeql.yml)
 
-**MBKAuth** is a reusable, production-ready authentication system for Node.js applications built by MBKTechStudio. It provides secure session management, two-factor authentication (2FA), role-based access control, and multi-application support out of the box.
+**MBKAuth** is a reusable, production-ready authentication system for Node.js applications built by MBKTech.org. It provides secure session management, two-factor authentication (2FA), role-based access control, and multi-application support out of the box.
 
 ## ✨ Features
 
@@ -313,8 +313,8 @@ Found a bug or need help? Please [open an issue](https://github.com/MIbnEKhalid/
 
 - [npm Package](https://www.npmjs.com/package/mbkauthe)
 - [GitHub Repository](https://github.com/MIbnEKhalid/mbkauthe)
-- [MBKTechStudio](https://mbktechstudio.com)
+- [MBKTech.org](https://mbktech.org)
 
 ---
 
-Made with ❤️ by [MBKTechStudio](https://mbktechstudio.com)
+Made with ❤️ by [MBKTech.org](https://mbktech.org)

package/docs/api.md

@@ -328,10 +328,77 @@ Displays MBKAuthe version information and configuration.
 
 #### `GET /mbkauthe/main.js`
 
-Serves the client-side JavaScript file.
+Serves the client-side JavaScript file containing helper functions for authentication operations.
+
+**Purpose:** Provides frontend JavaScript utilities including:
+- `logout()` - Logout function with confirmation dialog and cache clearing
+- `logoutuser()` - Alias for logout function
+- `nuclearCacheClear()` - Comprehensive cache and storage clearing (preserves rememberedUsername)
+- `getCookieValue(cookieName)` - Cookie retrieval helper
+- `loadpage(url)` - Page navigation helper
+- `formatDate(date)` - Date formatting utility
+- `reloadPage()` - Page reload helper
+- `checkSession()` - Session validity checker
 
 **Response:** JavaScript file (Content-Type: application/javascript)
 
+**Usage:**
+```html
+<script src="/mbkauthe/main.js"></script>
+<button onclick="logout()">Logout</button>
+```
+
+**Main Functions:**
+
+**`logout()`**
+- Shows confirmation dialog before logout
+- Clears all caches except rememberedUsername
+- Calls `/mbkauthe/api/logout` endpoint
+- Redirects to home page on success
+
+**`nuclearCacheClear()`**
+- Clears service workers and cache storage
+- Clears localStorage and sessionStorage (preserves rememberedUsername)
+- Clears IndexedDB
+- Clears cookies
+- Forces page reload
+
+
+---
+
+#### `GET /mbkauthe/test`
+
+Test endpoint to verify authentication and display user session information.
+
+**Authentication:** Session required
+
+**Rate Limit:** 8 requests per minute
+
+**Response:** HTML page displaying:
+- Current username
+- User role
+- Logout button
+- Quick links to info and login pages
+
+**Example Response:**
+```html
+<head> 
+  <script src="/mbkauthe/main.js"></script> 
+</head>
+<p>if you are seeing this page than User is logged in.</p>
+<p>id: '${req.session.user.id}', UserName: '${req.session.user.username}', Role: '${req.session.user.role}', SessionId: '${req.session.user.sessionId}'</p>
+<button onclick="logout()">Logout</button><br>
+<a href="/mbkauthe/info">Info Page</a><br>
+<a href="/mbkauthe/login">Login Page</a><br>
+```
+
+**Usage:**
+```
+GET /mbkauthe/test
+```
+
+**Note:** This endpoint is primarily for testing and debugging authentication. It should not be used in production environments.
+
 ---
 
 ## Middleware Reference
@@ -347,7 +414,7 @@ import { validateSession } from 'mbkauthe';
 app.get('/protected', validateSession, (req, res) => {
   // User is authenticated
   const user = req.session.user;
-  // user contains: { id, username, UserName, role, Role, sessionId, allowedApps }
+  // user contains: { id, username, UserName, role, Role, sessionId }
   res.send(`Welcome ${user.username}!`);
 });
 ```
@@ -369,7 +436,6 @@ req.session.user = {
   role: "NormalUser",       // User role
   Role: "NormalUser",       // User role (alias)
   sessionId: "abc123...",   // 64-char hex session ID
-  allowedApps: ["app1"]     // Array of allowed applications
 }
 ```
 
@@ -836,6 +902,6 @@ For issues, questions, or contributions:
 ---
 
 **Last Updated:** November 17, 2025  
-**Version:** 1.4.1
+**Version:** 1.4.2
 
 [← Back to README](../README.md)

package/env.md

@@ -54,7 +54,7 @@ DOMAIN=localhost
 **Description:** Your application's domain name.
 
 **Configuration:**
-- **Production:** Set to your actual domain (e.g., `mbktechstudio.com`)
+- **Production:** Set to your actual domain (e.g., `mbktech.com`)
 - **Development:** Use `localhost` or set `IS_DEPLOYED=false`
 - **Subdomains:** When `IS_DEPLOYED=true`, sessions are shared across all subdomains