Merge branch 'next' of https://github.com/devforth/adminforth into fix-mongo-id-filter

Author: NoOne7135

AGENTS.md

@@ -0,0 +1,5 @@
+Follow SOLID principles
+Use DRY and avoid duplication
+Keep the code KISS unless complexity is required
+Avoid unnecessary abstractions.
+Cover edge cases and clear error handling

README.md

@@ -1,4 +1,4 @@
-# AdminForth - fully free Node.js admin panel framework on Vue & Tailwind
+# AdminForth - free powerfull Node.js admin panel framework on Vue & Tailwind
 
 
 <a href="https://adminforth.dev"><img src="https://img.shields.io/badge/website-adminforth.dev-blue" style="height:24px"/></a> <a href="https://adminforth.dev"><img src="https://img.shields.io/npm/dw/adminforth" style="height:24px"/></a> <a href="https://devforth.io"><img src="https://raw.githubusercontent.com/devforth/OnLogs/e97944fffc24fec0ce2347b205c9bda3be8de5c5/.assets/df_powered_by.svg" style="height:28px"/></a>
@@ -20,12 +20,15 @@
 <br/>
 
 Why AdminForth:
-* AdminForth is always free and open-source (no paid versions, no cloud subscriptions sh*t)
-* Init AdminForth with your database URL in Node.js file, easily describe the tables you wish to see in admin, and get fully functional UI for your data (filter, create, edit, remove)
-* Define Vue components to change look of various parts of admin (place in data cell, instead of row, add something above the table, inject something to header or sidebar, add custom page with charts or custom components)
-* Rich build-in Components library (AdminForth AFCL) with premade easy-to-use build-blocks which follow your theme
+
+* Init AdminForth project with `npx adminforth create-app` and pass your database URL, import the tables you wish to see in admin using `npx adminforth resource`, and get fully functional UI for your data (filter, create, edit, remove)
+* Modern look and simple Tailwind-ish ability to adjust it
+* Supports Postgres, MySQL, Mongo, SQLite, Clickhouse
+* Define Vue components to change look of various parts of admin using `npx adminforth component` (edit data cells, edit fields, add something above the table, inject something to header or sidebar, add custom page with charts or custom components)
+* Build-in Components library (AdminForth AFCL) with premade easy-to-use build-blocks which follow your theme
 * Define express APIs and call them from your components and pages
-* Use various modern back-office-must-have plugins like audit log, files/image upload, TOTP 2FA, I18N, Copilot-style AI writing and image generation
+* Use various modern back-office-must-have plugins like audit log, files/image upload, TOTP 2FA, I18N, Copilot-style AI writing and image generation and many more
+* AdminForth is always free and open-source (no paid versions, no cloud subscriptions sh*t)
 
 
 ## Project initialisation
@@ -54,41 +57,76 @@ npx adminforth create-app
 
 
 
-
 # For developers
 
 The most convenient way to add new features or fixes is using `dev-demo`. It imports the source code of the repository and plugins so you can edit them and see changes on the fly.
 
-Fork repo, pull it and do next:
+To run dev demo:
+```sh
+cd dev-demo
 
+npm run setup-dev-demo
+npm run migrate:all
 
-```sh
-cd adminforth
-npm ci
-npm run build
+npm start
+```
 
-# this will install all official plugins and link adminforth package, if plugin installed it will git pull and npm ci
-npm run install-plugins
+## Adding columns to a database in dev-demo
+
+Open `./migrations` folder. There is prisma migration folder for the sqlite, postgres and mysql and `clickhouse_migrations` folder for the clickhouse:
+
+### Migrations for the MySQL, SQLite and Postgres
+To make migration add to the .prisma file in folder with database you need and add new tables or columns. Then run:
 
-# same for official adapters
-npm run install-adapters
+
+```
+npm run makemigration:sqlite -- --name init
 ```
 
-To run dev demo:
-```sh
-cd dev-demo
-cp .env.sample .env
-npm ci
-npm run migrate
-npm start
+and 
+
+```
+npm run migrate:sqlite
 ```
 
-## Adding columns to a database in dev-demo
+to apply migration
+
+> use :sqlite, :mysql or :postgres for you case
 
-Open `.prisma` file, modify it, and run:
+### Migrations for the clickhouse
 
+In order to make migration for the clickhouse, go to the `./migrations/clickhouse_migrations` folder and add migration file to the folder.
+
+Then run
 ```
-npm run namemigration -- --name desctiption_of_changes
+npm run migrate:clickhouse
 ```
 
+to apply the migration.
+
+## Testing CLI commands during development
+
+
+Make sure you have not `adminforth` globally installed. If you have it, remove it:
+
+
+```sh
+npm uninstall -g adminforth
+```
+
+Then, in the root of the project, run once:
+
+```
+cd adminforth/adminforth
+npm run build
+```
+
+This will automatically make an npm link to the `adminforth` package in the root of the project.
+
+Then, go to testing app, e.g. created with CLI, and use next command:
+
+```
+npx -g adminforth <your command under development>
+```
 
+This will always run latest version of adminforth package.

adapters/install-adapters.sh

@@ -1,5 +1,10 @@
 #!/usr/bin/env bash
-ADAPTERS="adminforth-completion-adapter-open-ai-chat-gpt adminforth-email-adapter-aws-ses adminforth-google-oauth-adapter adminforth-github-oauth-adapter adminforth-facebook-oauth-adapter adminforth-keycloak-oauth-adapter adminforth-microsoft-oauth-adapter"
+ADAPTERS="adminforth-completion-adapter-open-ai-chat-gpt adminforth-email-adapter-aws-ses \
+adminforth-email-adapter-mailgun adminforth-google-oauth-adapter adminforth-github-oauth-adapter \
+adminforth-facebook-oauth-adapter adminforth-keycloak-oauth-adapter adminforth-microsoft-oauth-adapter \
+adminforth-twitch-oauth-adapter adminforth-image-generation-adapter-openai adminforth-storage-adapter-amazon-s3 \
+adminforth-storage-adapter-local adminforth-image-vision-adapter-openai adminforth-key-value-adapter-ram \
+adminforth-login-captcha-adapter-cloudflare adminforth-login-captcha-adapter-recaptcha"
 
 # for each
 install_adapter() {

adminforth/auth.ts

@@ -65,9 +65,8 @@ class AdminForthAuth implements IAdminForthAuth {
        headersLower['client-ip'] || 
        headersLower['client-address'] || 
        headersLower['client'] || 
-       headersLower['x-host'] || 
-       headersLower['host'] || 
-       'unknown';
+       headersLower['x-host'] ||
+       null;
     }
   }
 
@@ -76,19 +75,18 @@ class AdminForthAuth implements IAdminForthAuth {
     response.setHeader('Set-Cookie', `adminforth_${brandSlug}_jwt=; Path=${this.adminforth.config.baseUrl || '/'}; HttpOnly; SameSite=Strict; Expires=Thu, 01 Jan 1970 00:00:00 GMT`);
   }
 
-  setAuthCookie({ expireInDays, response, username, pk}: {
-    expireInDays?: number,
+  setAuthCookie({ expireInDuration, response, username, pk}: {
+    expireInDuration?: string,
     response: any, 
     username: string, 
     pk: string | null
   }) {
-    const expiresIn: string = expireInDays ? `${expireInDays}d` : (process.env.ADMINFORTH_AUTH_EXPIRESIN || '24h');
+    const expiresIn: string = expireInDuration || (process.env.ADMINFORTH_AUTH_EXPIRESIN || '24h');
     // might be h,m,d in string
     const expiresInSec = parseTimeToSeconds(expiresIn);
 
-    const token = this.issueJWT({ username, pk}, 'auth', expiresIn);
+    const token = this.issueJWT({ username, pk}, 'auth', expiresInSec);
     const expiresCookieFormat = new Date(Date.now() + expiresInSec * 1000).toUTCString();
-    
     const brandSlug = this.adminforth.config.customization.brandNameSlug;
     response.setHeader('Set-Cookie', `adminforth_${brandSlug}_jwt=${token}; Path=${this.adminforth.config.baseUrl || '/'}; HttpOnly; SameSite=Strict; Expires=${expiresCookieFormat}`);
   }
@@ -99,16 +97,32 @@ class AdminForthAuth implements IAdminForthAuth {
   }
 
   setCustomCookie({ response, payload }: {
-    response: any, payload: {name: string, value: string, expiry: number, httpOnly: boolean}
+    response: any, payload: { name: string, value: string, expiry: number | undefined, expirySeconds: number | undefined, httpOnly: boolean }
   }) {
-    const {name, value, expiry, httpOnly} = payload;
+    const {name, value, expiry, httpOnly, expirySeconds } = payload;
+
+    let expiryMs = 24 * 60 * 60 * 1000; // default 1 day
+    if (expirySeconds !== undefined) {
+      expiryMs = expirySeconds * 1000;
+    } else if (expiry !== undefined) {
+      console.warn('setCustomCookie: expiry(in ms) is deprecated, use expirySeconds instead (seconds), traceback:', new Error().stack);
+      expiryMs = expiry;
+    }
+
     const brandSlug = this.adminforth.config.customization.brandNameSlug;
     response.setHeader('Set-Cookie', `adminforth_${brandSlug}_${name}=${value}; Path=${this.adminforth.config.baseUrl || '/'};${
       httpOnly ? ' HttpOnly;' : ''
-    } SameSite=Strict; Expires=${new Date(Date.now() + expiry).toUTCString() } `);
+    } SameSite=Strict; Expires=${new Date(Date.now() + expiryMs).toUTCString() } `);
+  }
+
+  getCustomCookie({ cookies, name }: {
+    cookies: {key: string, value: string}[], name: string
+  }): string | null {
+    const brandSlug = this.adminforth.config.customization.brandNameSlug;
+    return cookies.find((cookie) => cookie.key === `adminforth_${brandSlug}_${name}`)?.value || null;
   }
 
-  issueJWT(payload: Object, type: string, expiresIn: string = '24h'): string {
+  issueJWT(payload: Object, type: string, expiresIn: string | number = '24h'): string {
     // read ADMINFORH_SECRET from environment if not drop error
     const secret = process.env.ADMINFORTH_SECRET;
     if (!secret) {

adminforth/basePlugin.ts

@@ -36,7 +36,7 @@ export default class AdminForthPlugin implements IAdminForthPlugin {
     return 'non-uniquely-identified';
   }
 
-  modifyResourceConfig(adminforth: IAdminForth, resourceConfig: AdminForthResource) {
+  modifyResourceConfig(adminforth: IAdminForth, resourceConfig: AdminForthResource, allPluginInstances?: {pi: AdminForthPlugin, resource: AdminForthResource}[]) {
     this.resourceConfig = resourceConfig;
     const uniqueness = this.instanceUniqueRepresentation(this.pluginOptions);
 

adminforth/commands/bundle.js

@@ -1,28 +1,22 @@
-import fs from "fs";
-import { getInstance } from "./utils.js";
+import { callTsProxy, findAdminInstance } from "./callTsProxy.js";
+
 
 async function bundle() {
-  const currentDirectory = process.cwd();
-  const files = fs.readdirSync(currentDirectory);
-  let instanceFound = false;
+  console.log("Bundling admin SPA...");
+  const instance = await findAdminInstance();
+    
+
+  try {
+    await callTsProxy(`
+      import { admin } from './${instance.file}.js';
 
-  for (const file of files) {
-    if (file.endsWith(".js") || file.endsWith(".ts")) {
-      try {
-        const instance = await getInstance(file, currentDirectory);
-        if (instance) {
-          await instance.bundleNow({ hotReload: false });
-          instanceFound = true;
-          break;
-        }
-      } catch (error) {
-        console.error(`Error: Could not bundle '${file}'`, error);
+      export async function exec() {
+        return await admin.bundleNow({ hotReload: false });
       }
-    }
-  }
-  if (!instanceFound) {
-    console.error("Error: No valid instance found to bundle.");
-    return;
+    `);
+
+  } catch (e) {
+    console.log(`Running budndle failed`, e);
   }
 }