Merge pull request #87 from devforth/next

Next

Author: ivictbor

README.md

@@ -61,8 +61,6 @@ cd adminforth
 npm ci
 npm run build
 
-# create link to built "adminforth" package in local system
-npm link
 
 # this will install all official plugins and link adminforth package, if plugin installed it will git pull and npm ci
 npm run install-plugins

adminforth/commands/createApp/templates/users.ts.hbs renamed to adminforth/commands/createApp/templates/adminuser.ts.hbs

@@ -8,7 +8,7 @@ async function canModifyUsers({ adminUser }: { adminUser: AdminUser }): Promise<
 export default {
   dataSource: 'maindb',
   table: 'adminuser',
-  resourceId: 'users',
+  resourceId: 'adminuser',
   label: 'Users',
   recordLabel: (r) => `👤 ${r.email}`,
   options: {
@@ -44,7 +44,7 @@ export default {
     {
       name: 'created_at',
       type: AdminForthDataTypes.DATETIME,
-      showIn: [{
+      showIn: {
         edit: false,
         create: false,
       },

adminforth/commands/createApp/templates/index.ts.hbs

@@ -1,13 +1,13 @@
 import express from 'express';
 import AdminForth, { Filters } from 'adminforth';
-import usersResource from "./resources/users";
+import usersResource from "./resources/adminuser";
 
 const ADMIN_BASE_URL = '';
 
 export const admin = new AdminForth({
   baseUrl: ADMIN_BASE_URL,
   auth: {
-    usersResourceId: 'users',
+    usersResourceId: 'adminuser',
     usernameField: 'email',
     passwordHashField: 'password_hash',
     rememberMeDays: 30,
@@ -51,7 +51,7 @@ export const admin = new AdminForth({
     {
       label: 'Users',
       icon: 'flowbite:user-solid',
-      resourceId: 'users'
+      resourceId: 'adminuser'
     }
   ],
 });
@@ -68,8 +68,8 @@ if (import.meta.url === `file://${process.argv[1]}`) {
   admin.express.serve(app)
 
   admin.discoverDatabases().then(async () => {
-    if (!await admin.resource('users').get([Filters.EQ('email', 'adminforth')])) {
-      await admin.resource('users').create({
+    if (!await admin.resource('adminuser').get([Filters.EQ('email', 'adminforth')])) {
+      await admin.resource('adminuser').create({
         email: 'adminforth',
         password_hash: await AdminForth.Utils.generatePasswordHash('adminforth'),
         role: 'superadmin',

adminforth/commands/createApp/utils.js

@@ -191,8 +191,8 @@ async function writeTemplateFiles(dirname, cwd, options) {
       data: { dbUrl, prismaDbUrl },
     },
     {
-      src: 'users.ts.hbs',
-      dest: 'resources/users.ts',
+      src: 'adminuser.ts.hbs',
+      dest: 'resources/adminuser.ts',
       data: {},
     },
     {

adminforth/dataConnectors/baseConnector.ts

@@ -11,6 +11,18 @@ import { AdminForthFilterOperators, AdminForthSortDirections } from "../types/Co
 
 
 export default class AdminForthBaseConnector implements IAdminForthDataSourceConnectorBase {
+
+  client: any;
+
+  get db() {
+    console.warn('db is deprecated, use client instead');
+    return this.client;
+  }
+
+  setupClient(url: string): Promise<void> {
+    throw new Error('Method not implemented.');
+  }
+
   getPrimaryKey(resource: AdminForthResource): string {
     for (const col of resource.dataSourceColumns) {
         if (col.primaryKey) {

adminforth/dataConnectors/clickhouse.ts

@@ -6,37 +6,30 @@ import { createClient } from '@clickhouse/client'
 import { AdminForthDataTypes, AdminForthFilterOperators, AdminForthSortDirections } from '../types/Common.js';
 
 class ClickhouseConnector extends AdminForthBaseConnector implements IAdminForthDataSourceConnector {
-
-    client: any;
+  
     dbName: string;
     url: string;
-
-    /**
-     * url: http[s]://[username:password@]hostname:port[/database][?param1=value1&param2=value2]
-     * @param param0 
-     */
-    constructor({ url }: { url: string }) {
-      super();
-      this.dbName = new URL(url).pathname.replace('/', '');
-      this.url = url;
-      // create connection here
-      this.client = createClient({ 
-        url: url.replace('clickhouse://', 'http://'),
-        clickhouse_settings: {
-          // Allows to insert serialized JS Dates (such as '2023-12-06T10:54:48.000Z')
-          date_time_input_format: 'best_effort',
-
-          // Recommended for cluster usage to avoid situations where a query processing error occurred after the response code, 
-          // and HTTP headers were already sent to the client.
-          // See https://clickhouse.com/docs/en/interfaces/http/#response-buffering
-          wait_end_of_query: 1,
-        },
-        // log:{
-        //   level: ClickHouseLogLevel.TRACE,
-        // }
-      });
-      
-    }
+  
+  async setupClient(url): Promise<void> {
+    this.dbName = new URL(url).pathname.replace('/', '');
+    this.url = url;
+    // create connection here
+    this.client = createClient({
+      url: url.replace('clickhouse://', 'http://'),
+      clickhouse_settings: {
+        // Allows to insert serialized JS Dates (such as '2023-12-06T10:54:48.000Z')
+        date_time_input_format: 'best_effort',
+
+        // Recommended for cluster usage to avoid situations where a query processing error occurred after the response code, 
+        // and HTTP headers were already sent to the client.
+        // See https://clickhouse.com/docs/en/interfaces/http/#response-buffering
+        wait_end_of_query: 1,
+      },
+      // log:{
+      //   level: ClickHouseLogLevel.TRACE,
+      // }
+    });
+  }
 
     async discoverFields(resource: AdminForthResource): Promise<{[key: string]: AdminForthResourceColumn}> {
         const tableName = resource.table;

adminforth/dataConnectors/mongo.ts

@@ -10,20 +10,18 @@ const escapeRegex = (value) => {
 };
 
 class MongoConnector extends AdminForthBaseConnector implements IAdminForthDataSourceConnector {
-    db: MongoClient
 
-    constructor({ url }: { url: string }) {
-        super();
-        this.db = new MongoClient(url);
+    async setupClient(url): Promise<void> {
+        this.client = new MongoClient(url);
         (async () => {
             try {
-                await this.db.connect();
-                this.db.on('error', (err) => {
+                await this.client.connect();
+                this.client.on('error', (err) => {
                     console.log('Mongo error: ', err.message)
-                 });
+                });
                 console.log('Connected to Mongo');
             } catch (e) {
-                console.error('ERROR: Failed to connect to Mongo', e);
+                console.error(`Failed to connect to Mongo: ${e}`);
             }
         })();
     }
@@ -133,7 +131,7 @@ class MongoConnector extends AdminForthBaseConnector implements IAdminForthDataS
         // const columns = resource.dataSourceColumns.filter(c=> !c.virtual).map((col) => col.name).join(', ');
         const tableName = resource.table;
 
-        const collection = this.db.db().collection(tableName);
+        const collection = this.client.db().collection(tableName);
         const query = await this.genQuery({ filters });
 
         const sortArray: any[] = sort.map((s) => {
@@ -154,7 +152,7 @@ class MongoConnector extends AdminForthBaseConnector implements IAdminForthDataS
             filters: { field: string, operator: AdminForthFilterOperators, value: any }[] 
     }): Promise<number> {
 
-        const collection = this.db.db().collection(resource.table);
+        const collection = this.client.db().collection(resource.table);
         const query = {};
         for (const filter of filters) {
             query[filter.field] = this.OperatorsMap[filter.operator](filter.value);
@@ -164,7 +162,7 @@ class MongoConnector extends AdminForthBaseConnector implements IAdminForthDataS
 
     async getMinMaxForColumnsWithOriginalTypes({ resource, columns }) {
         const tableName = resource.table;
-        const collection = this.db.db().collection(tableName);
+        const collection = this.client.db().collection(tableName);
         const result = {};
         for (const column of columns) {
             result[column] = await collection
@@ -178,7 +176,7 @@ class MongoConnector extends AdminForthBaseConnector implements IAdminForthDataS
 
     async createRecordOriginalValues({ resource, record }) {
         const tableName = resource.table;
-        const collection = this.db.db().collection(tableName);
+        const collection = this.client.db().collection(tableName);
         const columns = Object.keys(record);
         const newRecord = {};
         for (const colName of columns) {
@@ -188,19 +186,19 @@ class MongoConnector extends AdminForthBaseConnector implements IAdminForthDataS
     }
 
     async updateRecordOriginalValues({ resource, recordId, newValues }) {
-        const collection = this.db.db().collection(resource.table);
+        const collection = this.client.db().collection(resource.table);
         await collection.updateOne({ [this.getPrimaryKey(resource)]: recordId }, { $set: newValues });
     }
 
     async deleteRecord({ resource, recordId }): Promise<boolean> {
         const primaryKey = this.getPrimaryKey(resource);
-        const collection = this.db.db().collection(resource.table);
+        const collection = this.client.db().collection(resource.table);
         const res = await collection.deleteOne({ [primaryKey]: recordId });
         return res.deletedCount > 0;
     }
 
     async close() {
-        await this.db.close()
+        await this.client.close()
     }
 }