adminforth 1.3.22 → 1.3.23

package/auth.ts

@@ -30,10 +30,15 @@ class AdminForthAuth {
     response.setHeader('Set-Cookie', `adminforth_jwt=; Path=${this.adminforth.config.baseUrl || '/'}; HttpOnly; SameSite=Strict; Expires=Thu, 01 Jan 1970 00:00:00 GMT`);
   }
 
-  setAuthCookie({ response, username, pk}: {
-    response: any, username: string, pk: string | null
+  setAuthCookie({ expireInDays, response, username, pk}: {
+    expireInDays?: number,
+    response: any, 
+    username: string, 
+    pk: string | null
   }) {
-    const token = this.issueJWT({ username, pk, }, 'auth');
+    const expiresIn: string = expireInDays ? `${expireInDays}d` : (process.env.ADMINFORTH_AUTH_EXPIRESIN || '24h');
+
+    const token = this.issueJWT({ username, pk}, 'auth', expiresIn);
     response.setHeader('Set-Cookie', `adminforth_jwt=${token}; Path=${this.adminforth.config.baseUrl || '/'}; HttpOnly; SameSite=Strict`);
   }
 
@@ -47,11 +52,8 @@ class AdminForthAuth {
     const {name,value,expiry,httpOnly} = payload
     response.setHeader('Set-Cookie', `adminforth_${name}=${value}; Path=${this.adminforth.config.baseUrl || '/'}; HttpOnly; SameSite=Strict; Expires=${new Date(Date.now() + expiry).toUTCString() } `);
   }
-
  
-
-
-  issueJWT(payload: Object, type: string) {
+  issueJWT(payload: Object, type: string, expiresIn: string = '24h'): string {
     // read ADMINFORH_SECRET from environment if not drop error
     const secret = process.env.ADMINFORTH_SECRET;
     if (!secret) {
@@ -59,7 +61,6 @@ class AdminForthAuth {
     }
 
     // issue JWT token
-    const expiresIn = process.env.ADMINFORTH_AUTH_EXPIRESIN || '24h';
     return jwt.sign({...payload, t: type}, secret, { expiresIn });
   }
 

package/dist/auth.js

@@ -30,8 +30,9 @@ class AdminForthAuth {
     removeAuthCookie(response) {
         response.setHeader('Set-Cookie', `adminforth_jwt=; Path=${this.adminforth.config.baseUrl || '/'}; HttpOnly; SameSite=Strict; Expires=Thu, 01 Jan 1970 00:00:00 GMT`);
     }
-    setAuthCookie({ response, username, pk }) {
-        const token = this.issueJWT({ username, pk, }, 'auth');
+    setAuthCookie({ expireInDays, response, username, pk }) {
+        const expiresIn = expireInDays ? `${expireInDays}d` : (process.env.ADMINFORTH_AUTH_EXPIRESIN || '24h');
+        const token = this.issueJWT({ username, pk }, 'auth', expiresIn);
         response.setHeader('Set-Cookie', `adminforth_jwt=${token}; Path=${this.adminforth.config.baseUrl || '/'}; HttpOnly; SameSite=Strict`);
     }
     removeCustomCookie({ response, name }) {
@@ -41,14 +42,13 @@ class AdminForthAuth {
         const { name, value, expiry, httpOnly } = payload;
         response.setHeader('Set-Cookie', `adminforth_${name}=${value}; Path=${this.adminforth.config.baseUrl || '/'}; HttpOnly; SameSite=Strict; Expires=${new Date(Date.now() + expiry).toUTCString()} `);
     }
-    issueJWT(payload, type) {
+    issueJWT(payload, type, expiresIn = '24h') {
         // read ADMINFORH_SECRET from environment if not drop error
         const secret = process.env.ADMINFORTH_SECRET;
         if (!secret) {
             throw new Error('ADMINFORTH_SECRET environment not set');
         }
         // issue JWT token
-        const expiresIn = process.env.ADMINFORTH_AUTH_EXPIRESIN || '24h';
         return jwt.sign(Object.assign(Object.assign({}, payload), { t: type }), secret, { expiresIn });
     }
     verify(jwtToken_1, mustHaveType_1) {

package/dist/modules/restApi.js

@@ -44,7 +44,7 @@ export default class AdminForthRestAPI {
             handler: (_a) => __awaiter(this, [_a], void 0, function* ({ body, response }) {
                 var _b, _c, _d, _e;
                 const INVALID_MESSAGE = 'Invalid Username or Password';
-                const { username, password } = body;
+                const { username, password, rememberMe } = body;
                 let adminUser;
                 let toReturn = { ok: true, allowedLogin: true };
                 // get resource from db
@@ -93,7 +93,13 @@ export default class AdminForthRestAPI {
                         }
                     }
                     if (toReturn.allowedLogin) {
-                        this.adminforth.auth.setAuthCookie({ response, username, pk: userRecord[userResource.columns.find((col) => col.primaryKey).name] });
+                        const expireInDays = rememberMe && this.adminforth.config.auth.rememberMeDays;
+                        this.adminforth.auth.setAuthCookie({
+                            expireInDays,
+                            response,
+                            username,
+                            pk: userRecord[userResource.columns.find((col) => col.primaryKey).name]
+                        });
                     }
                 }
                 else {
@@ -140,6 +146,7 @@ export default class AdminForthRestAPI {
                     demoCredentials: this.adminforth.config.auth.demoCredentials,
                     loginPromptHTML: this.adminforth.config.auth.loginPromptHTML,
                     loginPageInjections: this.adminforth.config.customization.loginPageInjections,
+                    rememberMeDays: this.adminforth.config.auth.rememberMeDays,
                 };
             }),
         });

package/modules/restApi.ts

@@ -63,7 +63,7 @@ export default class AdminForthRestAPI {
       handler: async ({ body, response }) => {
        
         const INVALID_MESSAGE = 'Invalid Username or Password';
-        const { username, password } = body;
+        const { username, password, rememberMe } = body;
         let adminUser: AdminUser;
         let toReturn: { ok: boolean, redirectTo?: string, allowedLogin:boolean } = { ok: true, allowedLogin:true};
 
@@ -120,7 +120,13 @@ export default class AdminForthRestAPI {
             }
           }
           if (toReturn.allowedLogin){
-            this.adminforth.auth.setAuthCookie({ response, username, pk: userRecord[userResource.columns.find((col) => col.primaryKey).name] });
+            const expireInDays = rememberMe && this.adminforth.config.auth.rememberMeDays;
+            this.adminforth.auth.setAuthCookie({ 
+              expireInDays,
+              response, 
+              username, 
+              pk: userRecord[userResource.columns.find((col) => col.primaryKey).name] 
+            });
           } 
         } else {
           return { error: INVALID_MESSAGE };
@@ -172,6 +178,7 @@ export default class AdminForthRestAPI {
           demoCredentials: this.adminforth.config.auth.demoCredentials,
           loginPromptHTML: this.adminforth.config.auth.loginPromptHTML,
           loginPageInjections: this.adminforth.config.customization.loginPageInjections,
+          rememberMeDays: this.adminforth.config.auth.rememberMeDays,
         };
       },
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "adminforth",
-  "version": "1.3.22",
+  "version": "1.3.23",
   "description": "OpenSource Vue3 powered forth-generation admin panel",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/spa/src/views/LoginView.vue

@@ -56,9 +56,16 @@
                             </button>
                         </div>
 
-                        <div class="flex items-start mb-5 hidden">
+                        <div v-if="coreStore.config.rememberMeDays" 
+                            class="flex items-start mb-5"
+                            :title="`Stay logged in for ${coreStore.config.rememberMeDays} days`"
+                        >
                           <div class="flex items-center h-5">
-                            <input id="remember" type="checkbox" value="" class="w-4 h-4 border border-gray-300 rounded bg-gray-50 focus:ring-3 focus:ring-blue-300 dark:bg-gray-700 dark:border-gray-600 dark:focus:ring-blue-600 dark:ring-offset-gray-800 dark:focus:ring-offset-gray-800" required />
+                            <input id="remember" 
+                              ref="rememberInput"
+                              type="checkbox" 
+                              value="" 
+                              class="w-4 h-4 border border-gray-300 rounded bg-gray-50 focus:ring-3 focus:ring-blue-300 dark:bg-gray-700 dark:border-gray-600 dark:focus:ring-blue-600 dark:ring-offset-gray-800 dark:focus:ring-offset-gray-800" />
                           </div>
                           <label for="remember" class="ms-2 text-sm font-medium text-gray-900 dark:text-gray-300">Remember me</label>
                         </div>
@@ -125,6 +132,7 @@ import { useRouter } from 'vue-router';
 
 const passwordInput = ref(null);
 const usernameInput = ref(null);
+const rememberInput = ref(null);
 
 const router = useRouter();
 const inProgress = ref(false);
@@ -166,6 +174,7 @@ async function login() {
     body: {
       username,
       password,
+      rememberMe: rememberInput.value.checked,
     }
   });
   inProgress.value = false;

package/types/AdminForthConfig.ts

@@ -239,11 +239,11 @@ export interface IAdminForthDataSourceConnectorConstructor {
 
 export interface IAdminForthAuth {
   verify(jwt : string, mustHaveType: string, decodeUser?: boolean): Promise<any>;
-  issueJWT(payload: Object, type: string): string;
+  issueJWT(payload: Object, type: string, expiresIn?: string): string;
 
   removeCustomCookie({response, name}: {response: any, name: string}): void;
 
-  setAuthCookie({response, username, pk,}: {response: any, username: string, pk: string}): void;
+  setAuthCookie({expireInDays, response, username, pk,}: {expireInDays?: number, response: any, username: string, pk: string}): void;
   
   removeAuthCookie(response: any): void;
 }
@@ -1178,6 +1178,13 @@ export type AdminForthConfig = {
        * Any prompt to show users on login. Supports HTML.
        */
       loginPromptHTML?: string,
+
+      /**
+       * Remember me days for "Remember Me" checkbox on login page.
+       * If not set or set to null/0/undefined, "Remember Me" checkbox will not be displayed.
+       * If rememberMeDays is set, then users who check "Remember Me" will be staying logged in for this amount of days.
+       */
+      rememberMeDays?: number,
     },
      /**
       * Array of resources which will be displayed in the admin panel.