admindb 2.3.1 → 2.4.0

package/README.md

@@ -309,22 +309,22 @@ ADMINDB_AUTH=false npx admindb
 AdminDB exposes a comprehensive REST API under `basePath` returning `{ success, data?, error? }`:
 
 ```text
-GET    /api/tables                                 List tables
-GET    /api/tables/:table/rows                     Paginated rows (with filtering & sorting)
-GET    /api/tables/:table/row/:id                  Get a single row
-GET    /api/tables/:table/row/:id/blob/:column     Stream raw BLOB / BYTEA binary data
-GET    /api/tables/:table/row/:id/blob/:col/meta   BLOB / BYTEA metadata, MIME analysis & hex dump
-PUT    /api/tables/:table/row/:id/blob/:column     Upload / update binary content
-POST   /api/tables/:table/rows                     Insert row (single or batch)
-PUT    /api/tables/:table/row/:id                  Update row
-DELETE /api/tables/:table/row/:id                  Delete row
-POST   /api/tables/:table/rows/bulk-update         Apply staged inline edits atomically
-POST   /api/tables/:table/rows/bulk-delete         Delete selected rows atomically
-POST   /api/tables/:table/seed                     Generate & insert realistic seed rows
-POST   /api/tables                                 Create a new table
-GET    /api/tables/:table/schema                   Inspect table schema & constraints
-GET    /api/tables/:table/ddl                      Get table CREATE SQL & indexes
-POST   /api/query                                  Execute arbitrary SQL
+GET    /api/tables/:db                             List tables
+GET    /api/tables/:db/:table/rows                 Paginated rows (with filtering & sorting)
+GET    /api/tables/:db/:table/row/:id              Get a single row
+GET    /api/tables/:db/:table/row/:id/blob/:column Stream raw BLOB / BYTEA binary data
+GET    /api/tables/:db/:table/row/:id/blob/:col/meta BLOB / BYTEA metadata, MIME analysis & hex dump
+PUT    /api/tables/:db/:table/row/:id/blob/:column Upload / update binary content
+POST   /api/tables/:db/:table/rows                 Insert row (single or batch)
+PUT    /api/tables/:db/:table/row/:id              Update row
+DELETE /api/tables/:db/:table/row/:id              Delete row
+POST   /api/tables/:db/:table/rows/bulk-update     Apply staged inline edits atomically
+POST   /api/tables/:db/:table/rows/bulk-delete     Delete selected rows atomically
+POST   /api/tables/:db/:table/seed                 Generate & insert realistic seed rows
+POST   /api/tables/:db                             Create a new table
+GET    /api/tables/:db/:table/schema               Inspect table schema & constraints
+GET    /api/tables/:db/:table/ddl                  Get table CREATE SQL & indexes
+POST   /api/query/:db                              Execute arbitrary SQL
 GET    /api/databases                              List managed database connections & files
 ```
 

package/dist/app.js

@@ -20,54 +20,10 @@ const serverless_1 = require("./serverless");
 const auth_1 = require("./auth");
 const APP_VERSION = (0, args_1.getPackageVersion)();
 function createRouter(options = {}) {
-    return options.manager ? createManagerApp(options) : createSingleDbApp(options);
-}
-function setupViewEngine(app, _logger) {
-    app.engine('hbs', (0, express_handlebars_1.engine)({
-        extname: '.hbs',
-        defaultLayout: 'main',
-        layoutsDir: node_path_1.default.join(__dirname, 'views', 'layouts'),
-        partialsDir: node_path_1.default.join(__dirname, 'views', 'partials'),
-        helpers: {
-            eq: (a, b) => a === b,
-            startsWith: (a, b) => String(a ?? '').startsWith(String(b ?? '')),
-            isNull: (v) => v === null || v === undefined,
-            truncate: (v, n) => {
-                const s = v == null ? '' : String(v);
-                return s.length > n ? `${s.slice(0, n)}…` : s;
-            },
-            json: (v) => (JSON.stringify(v ?? null) ?? 'null').replace(/</g, '\\u003c'),
-            add: (a, b) => Number(a) + Number(b),
-            sub: (a, b) => Number(a) - Number(b),
-            gt: (a, b) => Number(a) > Number(b),
-            lt: (a, b) => Number(a) < Number(b),
-            join: (arr, sep) => (Array.isArray(arr) ? arr.join(String(sep ?? ',')) : String(arr ?? '')),
-            icon: (name, options) => {
-                const customClass = (options && options.hash && options.hash.class) || undefined;
-                return (0, icons_1.renderIcon)(String(name ?? ''), customClass);
-            },
-        },
-    }));
-    app.set('view engine', 'hbs');
-    app.set('views', node_path_1.default.join(__dirname, 'views'));
-}
-function addErrorHandlers(app, logger) {
-    app.use((req, res) => {
-        if (req.path.startsWith('/api/')) {
-            return res.status(404).json({ success: false, error: 'Not found.' });
-        }
-        res.status(404).render('pages/error', { title: 'Not found', status: 404, error: 'The page you requested does not exist.' });
-    });
-    app.use((err, req, res, _next) => {
-        logger.error('Unhandled error', err);
-        if (req.path.startsWith('/api/')) {
-            return res.status(500).json({ success: false, error: (0, common_1.errorMessage)(err) });
-        }
-        res.status(500).render('pages/error', { title: 'Error', status: 500, error: (0, common_1.errorMessage)(err) });
-    });
-}
-function createSingleDbApp(options) {
     const isServerless = options.serverless !== undefined ? options.serverless : (0, serverless_1.isServerlessEnvironment)();
+    const basePath = (options.basePath ?? '').replace(/\/+$/, '');
+    const logger = options.logger ?? (0, logger_1.createLogger)(options.logLevel ?? 'info', 'admindb');
+    const authConfig = (0, auth_1.resolveAuthConfig)(options.auth);
     const envTarget = process.env.ADMINDB_CONNECTION ||
         process.env.DATABASE_URL ||
         process.env.POSTGRES_URL ||
@@ -77,81 +33,37 @@ function createSingleDbApp(options) {
     const isPg = Boolean(options.pgOptions) ||
         (0, common_1.isPostgresConnectionString)(rawTarget) ||
         options.db?.dialect === 'postgres';
-    const readonly = options.readonly !== undefined
-        ? Boolean(options.readonly)
-        : (isServerless ? !isPg : false);
-    const basePath = (options.basePath ?? '').replace(/\/+$/, '');
-    const logger = options.logger ?? (0, logger_1.createLogger)(options.logLevel ?? 'info', 'admindb');
-    let db;
-    if (options.db) {
-        db = options.db;
-        if (options.readonly !== undefined && db.isReadOnly !== Boolean(options.readonly)) {
-            try {
-                Object.defineProperty(db, 'isReadOnly', { value: Boolean(options.readonly), configurable: true });
+    const explicitReadonly = options.readonly !== undefined ? Boolean(options.readonly) : undefined;
+    const globalReadonly = explicitReadonly !== undefined
+        ? explicitReadonly
+        : options.manager
+            ? options.manager.isReadOnly
+            : isServerless
+                ? !isPg
+                : false;
+    const manager = options.manager;
+    let singleDb;
+    let defaultDbId = options.dbId;
+    if (!manager) {
+        if (options.db) {
+            singleDb = options.db;
+            if (options.readonly !== undefined && singleDb.isReadOnly !== Boolean(options.readonly)) {
+                try {
+                    Object.defineProperty(singleDb, 'isReadOnly', { value: Boolean(options.readonly), configurable: true });
+                }
+                catch { }
             }
-            catch { }
         }
-    }
-    else if (isPg) {
-        db = new postgres_1.PostgresDatabase(options.pgOptions || rawTarget, logger, { readonly });
-    }
-    else {
-        db = new database_1.SqliteDatabase(options.dbPath ?? 'admindb.db', logger, { readonly });
-    }
-    const databasesUrl = options.databasesUrl;
-    const authConfig = (0, auth_1.resolveAuthConfig)(options.auth);
-    const router = (0, express_1.default)();
-    router.disable('x-powered-by');
-    router.use(express_1.default.static(node_path_1.default.join(__dirname, 'public')));
-    setupViewEngine(router, logger);
-    router.use(express_1.default.json({ limit: '10mb' }));
-    router.use(express_1.default.urlencoded({ extended: false }));
-    (0, auth_1.registerAuthRoutes)(router, authConfig, basePath, logger);
-    router.use((0, auth_1.createAuthMiddleware)(authConfig, basePath, logger));
-    router.use(async (req, res, next) => {
-        try {
-            res.locals.basePath = basePath;
-            res.locals.currentPath = req.path;
-            res.locals.currentTable = null;
-            res.locals.dbPath = db.path;
-            res.locals.dbId = options.dbId ?? (db.dialect === 'postgres' ? 'PostgreSQL' : (node_path_1.default.basename(db.path) || 'SQLite'));
-            res.locals.dialect = db.dialect;
-            res.locals.isPostgres = db.dialect === 'postgres';
-            res.locals.isSqlite = db.dialect === 'sqlite';
-            res.locals.dialectName = db.dialect === 'postgres' ? 'PostgreSQL' : 'SQLite';
-            res.locals.databasesUrl = databasesUrl ?? null;
-            res.locals.databasesMode = false;
-            res.locals.readonly = db.isReadOnly;
-            res.locals.serverless = isServerless;
-            res.locals.version = APP_VERSION;
-            res.locals.authEnabled = authConfig.enabled;
-            res.locals.isDefaultPassword = authConfig.isDefaultPassword;
-            res.locals.icons = icons_1.ICONS;
-            if (!req.path.startsWith('/api/')) {
-                const all = await db.listTables();
-                const names = (all.data ?? []).map((t) => t.name);
-                res.locals.tables = names.filter((n) => !n.startsWith('_'));
-                res.locals.internalTables = names.filter((n) => n.startsWith('_'));
-            }
-            next();
+        else if (isPg) {
+            singleDb = new postgres_1.PostgresDatabase(options.pgOptions || rawTarget, logger, { readonly: globalReadonly });
         }
-        catch (err) {
-            next(err);
+        else {
+            singleDb = new database_1.SqliteDatabase(options.dbPath ?? 'admindb.db', logger, { readonly: globalReadonly });
         }
-    });
-    (0, pages_1.registerPages)(router, { db, logger });
-    (0, index_1.registerApi)(router, { db, logger });
-    addErrorHandlers(router, logger);
-    return router;
-}
-function createManagerApp(options) {
-    const isServerless = options.serverless !== undefined ? options.serverless : (0, serverless_1.isServerlessEnvironment)();
-    const explicitReadonly = options.readonly !== undefined ? Boolean(options.readonly) : undefined;
-    const manager = options.manager;
-    const globalReadonly = explicitReadonly ?? manager.isReadOnly;
-    const basePath = (options.basePath ?? '').replace(/\/+$/, '');
-    const logger = options.logger ?? (0, logger_1.createLogger)(options.logLevel ?? 'info', 'admindb');
-    const authConfig = (0, auth_1.resolveAuthConfig)(options.auth);
+        if (!defaultDbId) {
+            defaultDbId = singleDb.dialect === 'postgres' ? 'PostgreSQL' : (node_path_1.default.basename(singleDb.path) || 'SQLite');
+        }
+    }
     const app = (0, express_1.default)();
     app.disable('x-powered-by');
     app.use(express_1.default.static(node_path_1.default.join(__dirname, 'public')));
@@ -165,75 +77,111 @@ function createManagerApp(options) {
             res.locals.basePath = basePath;
             res.locals.currentPath = req.path;
             res.locals.currentTable = null;
-            res.locals.dbPath = manager.directory;
-            res.locals.dbId = null;
-            res.locals.databasesUrl = null;
-            res.locals.databasesMode = true;
+            res.locals.dbPath = manager ? manager.directory : singleDb?.path;
+            res.locals.dbId = defaultDbId ?? null;
+            res.locals.databasesUrl = manager ? `${basePath}/` : (options.databasesUrl ?? null);
+            res.locals.databasesMode = false;
             res.locals.readonly = globalReadonly;
             res.locals.serverless = isServerless;
             res.locals.version = APP_VERSION;
             res.locals.authEnabled = authConfig.enabled;
             res.locals.isDefaultPassword = authConfig.isDefaultPassword;
             res.locals.icons = icons_1.ICONS;
-            if (!req.path.startsWith('/api/')) {
-                res.locals.tables = [];
-                res.locals.internalTables = [];
-            }
+            res.locals.tables = [];
+            res.locals.internalTables = [];
             next();
         }
         catch (err) {
             next(err);
         }
     });
-    const subApps = new Map();
-    (0, databases_1.registerDatabasesRoutes)(app, {
-        manager,
-        logger,
-        basePath,
-        readonly: globalReadonly,
-        allowBrowse: isServerless ? false : options.allowBrowse,
-        browseRoot: options.browseRoot,
-        invalidate: (id) => subApps.delete(id),
-    });
-    app.use('/:dbId', (req, res, next) => {
-        const dbId = String(req.params.dbId);
-        if (!manager.has(dbId)) {
-            if (req.path.startsWith('/api/')) {
-                return res.status(404).json({ success: false, error: `Database "${dbId}" does not exist.` });
+    const getDb = (req) => {
+        if (manager) {
+            const dbId = String(req.params.db || req.params.dbId || req.params.id || '');
+            if (!manager.has(dbId)) {
+                const err = new Error(`Database "${dbId}" does not exist.`);
+                err.status = 404;
+                throw err;
             }
-            return res.status(404).render('pages/error', {
-                title: 'Not found',
-                status: 404,
-                error: `Database "${dbId}" does not exist.`,
-            });
-        }
-        const rawRo = req.query.readonly;
-        if (rawRo !== undefined) {
-            const explicitRo = rawRo === '1' || rawRo === 'true';
-            if (!globalReadonly || explicitRo) {
-                manager.setReadonly(dbId, explicitRo);
-                subApps.delete(dbId);
+            const rawRo = req.query.readonly;
+            if (rawRo !== undefined) {
+                const explicitRo = rawRo === '1' || rawRo === 'true';
+                if (!globalReadonly || explicitRo) {
+                    manager.setReadonly(dbId, explicitRo);
+                }
             }
-        }
-        let sub = subApps.get(dbId);
-        if (!sub) {
-            const subBase = `${basePath || ''}/${encodeURIComponent(dbId)}`;
             const effectiveRo = globalReadonly ? true : manager.isDbReadOnly(dbId);
-            sub = createSingleDbApp({
-                db: manager.open(dbId, effectiveRo),
-                basePath: subBase,
-                logger,
-                logLevel: options.logLevel,
-                dbId,
-                databasesUrl: `${basePath || ''}/`,
-                readonly: effectiveRo,
-                serverless: isServerless,
-                auth: authConfig,
-            });
-            subApps.set(dbId, sub);
+            return manager.open(dbId, effectiveRo);
         }
-        return sub(req, res, next);
-    });
+        return singleDb;
+    };
+    if (manager) {
+        (0, databases_1.registerDatabasesRoutes)(app, {
+            manager,
+            logger,
+            basePath,
+            readonly: globalReadonly,
+            allowBrowse: isServerless ? false : options.allowBrowse,
+            browseRoot: options.browseRoot,
+        });
+    }
+    else {
+        app.get('/', (_req, res) => {
+            res.redirect(302, `${basePath}/home/${encodeURIComponent(defaultDbId)}`);
+        });
+    }
+    (0, pages_1.registerPages)(app, { getDb, logger });
+    (0, index_1.registerApi)(app, { getDb, logger });
     addErrorHandlers(app, logger);
     return app;
 }
+function setupViewEngine(app, _logger) {
+    app.engine('hbs', (0, express_handlebars_1.engine)({
+        extname: '.hbs',
+        defaultLayout: 'main',
+        layoutsDir: node_path_1.default.join(__dirname, 'views', 'layouts'),
+        partialsDir: node_path_1.default.join(__dirname, 'views', 'partials'),
+        helpers: {
+            eq: (a, b) => a === b,
+            startsWith: (a, b) => String(a ?? '').startsWith(String(b ?? '')),
+            isNull: (v) => v === null || v === undefined,
+            truncate: (v, n) => {
+                const s = v == null ? '' : String(v);
+                return s.length > n ? `${s.slice(0, n)}…` : s;
+            },
+            json: (v) => (JSON.stringify(v ?? null) ?? 'null').replace(/</g, '\\u003c'),
+            add: (a, b) => Number(a) + Number(b),
+            sub: (a, b) => Number(a) - Number(b),
+            gt: (a, b) => Number(a) > Number(b),
+            lt: (a, b) => Number(a) < Number(b),
+            join: (arr, sep) => (Array.isArray(arr) ? arr.join(String(sep ?? ',')) : String(arr ?? '')),
+            encodeUri: (str) => encodeURIComponent(String(str ?? '')),
+            or: (a, b) => a || b,
+            tableName: (t) => (typeof t === 'object' && t !== null && 'name' in t ? String(t.name ?? '') : String(t ?? '')),
+            icon: (name, options) => {
+                const customClass = (options && options.hash && options.hash.class) || undefined;
+                return (0, icons_1.renderIcon)(String(name ?? ''), customClass);
+            },
+        },
+    }));
+    app.set('view engine', 'hbs');
+    app.set('views', node_path_1.default.join(__dirname, 'views'));
+}
+function addErrorHandlers(app, logger) {
+    app.use((req, res) => {
+        if (req.path.startsWith('/api/')) {
+            return res.status(404).json({ success: false, error: 'Not found.' });
+        }
+        res.status(404).render('pages/error', { title: 'Not found', status: 404, error: 'The page you requested does not exist.' });
+    });
+    app.use((err, req, res, _next) => {
+        const status = typeof err?.status === 'number' ? err.status : 500;
+        if (status >= 500) {
+            logger.error('Unhandled error', err);
+        }
+        if (req.path.startsWith('/api/')) {
+            return res.status(status).json({ success: false, error: (0, common_1.errorMessage)(err) });
+        }
+        res.status(status).render('pages/error', { title: status === 404 ? 'Not found' : 'Error', status, error: (0, common_1.errorMessage)(err) });
+    });
+}