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

Author: NoOne7135

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,7 +57,6 @@ 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.
@@ -66,20 +68,24 @@ Fork repo, pull it and do next:
 cd adminforth
 npm ci
 npm run build
+```
+
+To run dev demo:
+```sh
+cd dev-demo
+cp .env.sample .env
 
 # this will install all official plugins and link adminforth package, if plugin installed it will git pull and npm ci
 npm run install-plugins
 
 # same for official adapters
 npm run install-adapters
-```
 
-To run dev demo:
-```sh
-cd dev-demo
-cp .env.sample .env
 npm ci
-npm run migrate
+
+./run_inventory.sh
+
+npm run migrate:local
 npm start
 ```
 
@@ -92,3 +98,29 @@ npm run namemigration -- --name desctiption_of_changes
 ```
 
 
+### 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

@@ -76,19 +76,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 +98,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/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);
   }
 }
 

adminforth/commands/callTsProxy.js

@@ -0,0 +1,133 @@
+// callTsProxy.js
+import { spawn } from "child_process";
+import path from "path";
+import fs from "fs";
+import chalk from "chalk";
+import dotenv from "dotenv";
+
+const currentFilePath = import.meta.url;
+const currentFileFolder = path.dirname(currentFilePath).replace("file:", "");
+
+export function callTsProxy(tsCode, silent=false) {
+
+  const currentDirectory = process.cwd();
+  const envPath = path.resolve(currentDirectory, ".env");
+  const envLocalPath = path.resolve(currentDirectory, ".env.local");
+  if (fs.existsSync(envLocalPath)) {
+    dotenv.config({ path: envLocalPath, override: true });
+  }
+  if (fs.existsSync(envPath)) {
+    dotenv.config({ path: envPath, override: true });
+  }
+
+  process.env.HEAVY_DEBUG && console.log("🌐 Calling tsproxy with code:", path.join(currentFileFolder, "proxy.ts"));
+  return new Promise((resolve, reject) => {
+    const child = spawn("tsx", [path.join(currentFileFolder, "proxy.ts")], {
+      env: process.env,
+    });
+    let stdout = "";
+    let stderr = "";
+
+    child.stdout.on("data", (data) => {
+      stdout += data;
+    });
+
+    child.stderr.on("data", (data) => {
+      stderr += data;
+    });
+
+    child.on("close", (code) => {
+      if (code === 0) {
+        try {
+          const parsed = JSON.parse(stdout);
+          if (!silent) {
+            parsed.capturedLogs.forEach((log) => {
+              console.log(...log);
+            });
+          }
+
+          if (parsed.error) {
+            reject(new Error(`${parsed.error}\n${parsed.stack}`));
+          }
+          resolve(parsed.result);
+        } catch (e) {
+          reject(new Error("Invalid JSON from tsproxy: " + stdout));
+        }
+      } else {
+        console.error(`tsproxy exited with non-0, this should never happen, stdout: ${stdout}, stderr: ${stderr}`);
+        reject(new Error(stderr));
+      }
+    });
+
+    process.env.HEAVY_DEBUG && console.log("🪲 Writing to tsproxy stdin...\n'''", tsCode, "'''");
+    child.stdin.write(tsCode);
+    child.stdin.end();
+  });
+}
+
+export async function findAdminInstance() {
+  process.env.HEAVY_DEBUG && console.log("🌐 Finding admin instance...");
+  const currentDirectory = process.cwd();
+
+  let files = fs.readdirSync(currentDirectory);
+  let instanceFound = {
+    file: null,
+    version: null,
+  };
+  // try index.ts first
+  if (files.includes("index.ts")) {
+    files = files.filter((file) => file !== "index.ts");
+    files.unshift("index.ts");
+  }
+
+  for (const file of files) {
+    if (file.endsWith(".ts")) {
+      const fileNoTs = file.replace(/\.ts$/, "");
+      process.env.HEAVY_DEBUG && console.log(`🪲 Trying bundleing ${file}...`);
+      try {
+        const res = await callTsProxy(`
+          import { admin } from './${fileNoTs}.js';
+
+          export async function exec() {
+            return admin.formatAdminForth();
+          }
+        `, true);
+        instanceFound.file = fileNoTs;
+        instanceFound.version = res;
+        break;
+
+      } catch (e) {
+        // do our best to guess that this file has a good chance to be admin instance
+        // and show the error so user can fix it
+        const fileContent = fs.readFileSync(file, "utf-8");
+        if (fileContent.includes("export const admin")) {
+          console.error(chalk.red(`Error running ${file}:`, e));
+          process.exit(1);
+        }
+        process.env.HEAVY_DEBUG && console.log(`🪲 File ${file} failed`, e);
+      }
+    }
+  }
+  if (!instanceFound.file) {
+    console.error(
+      chalk.red(
+        `Error: No valid instance found to bundle.\n` +
+        `Make sure you have a file in the current directory with a .ts extension, and it exports an ` +
+        chalk.cyan.bold('admin') +
+        ` instance like:\n\n` +
+        chalk.yellow('export const admin = new AdminForth({...})') +
+        `\n\nFor example, adminforth CLI creates an index.ts file which exports the admin instance.`
+      )
+    );
+    process.exit(1);
+  }
+  return instanceFound;
+}
+
+// Example usage:
+// callTsProxy(`
+//   import admin from './admin';
+//   function exec() {
+//     return admin.doX();
+//   }
+// `).then(console.log).catch(console.error);