Merge pull request #558 from devforth/next

Next

Author: yaroslav8765

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

@@ -11,7 +11,7 @@ export function initApi(app: Express, admin: IAdminForth) {
         message: "List of admin users from AdminForth API",
         users: allUsers,
       });
-    }
+    },
 
     // you can use admin.express.authorize to get info about the current user
     admin.express.authorize(

adminforth/dataConnectors/clickhouse.ts

@@ -149,7 +149,9 @@ class ClickhouseConnector extends AdminForthBaseConnector implements IAdminForth
           return dayjs.unix(+value).toISOString();
         } else if (field._underlineType.startsWith('DateTime') 
             || field._underlineType.startsWith('String') 
-            || field._underlineType.startsWith('FixedString')) {
+            || field._underlineType.startsWith('FixedString')
+            || field._underlineType.startsWith('Nullable(String)')
+            || field._underlineType.startsWith('Nullable(FixedString)')) {
           const v = dayjs(value).toISOString();
           return v;
         } else {
@@ -163,7 +165,10 @@ class ClickhouseConnector extends AdminForthBaseConnector implements IAdminForth
       } else if (field.type == AdminForthDataTypes.BOOLEAN) {
         return value === null ? null : !!value;
       } else if (field.type == AdminForthDataTypes.JSON) {
-        if (field._underlineType.startsWith('String') || field._underlineType.startsWith('FixedString')) {
+        if (field._underlineType.startsWith('String') 
+            || field._underlineType.startsWith('FixedString') 
+            || field._underlineType.startsWith('Nullable(String)')
+            || field._underlineType.startsWith('Nullable(FixedString)')) {
           try {
             return JSON.parse(value);
           } catch (e) {
@@ -186,7 +191,9 @@ class ClickhouseConnector extends AdminForthBaseConnector implements IAdminForth
           return dayjs(value).unix();
         } else if (field._underlineType.startsWith('DateTime') 
           || field._underlineType.startsWith('String') 
-          || field._underlineType.startsWith('FixedString')) {
+          || field._underlineType.startsWith('FixedString')
+          || field._underlineType.startsWith('Nullable(String)')
+          || field._underlineType.startsWith('Nullable(FixedString)')) {
           // value is iso string now, convert to unix timestamp
           const iso = dayjs(value).format('YYYY-MM-DDTHH:mm:ss');
           return iso;
@@ -195,7 +202,10 @@ class ClickhouseConnector extends AdminForthBaseConnector implements IAdminForth
         return  value === null ? null : (value ? 1 : 0);
       } else if (field.type == AdminForthDataTypes.JSON) {
         // check underline type is text or string
-        if (field._underlineType.startsWith('String') || field._underlineType.startsWith('FixedString')) {
+        if (field._underlineType.startsWith('String') 
+            || field._underlineType.startsWith('FixedString') 
+            || field._underlineType.startsWith('Nullable(String)')
+            || field._underlineType.startsWith('Nullable(FixedString)')) {
           return JSON.stringify(value);
         } else {
           afLogger.warn(`AdminForth: JSON field is not a string/text but ${field._underlineType}, this is not supported yet`);
@@ -226,6 +236,21 @@ class ClickhouseConnector extends AdminForthBaseConnector implements IAdminForth
       [AdminForthSortDirections.asc]: 'ASC',
       [AdminForthSortDirections.desc]: 'DESC',
     };
+
+    isArrayType(underlineType: string): boolean {
+      return underlineType.startsWith('Array(') || underlineType.startsWith('Nullable(Array(');
+    }
+
+    isNullableType(underlineType: string): boolean {
+      return underlineType.startsWith('Nullable(');
+    }
+
+    isStringLikeType(underlineType: string): boolean {
+      return underlineType.startsWith('String')
+        || underlineType.startsWith('FixedString')
+        || underlineType.startsWith('Nullable(String)')
+        || underlineType.startsWith('Nullable(FixedString)');
+    }
 
     getFilterString(resource: AdminForthResource, filter: IAdminForthSingleFilter | IAdminForthAndOrFilter): string {
       if ((filter as IAdminForthSingleFilter).field) {
@@ -247,6 +272,49 @@ class ClickhouseConnector extends AdminForthBaseConnector implements IAdminForth
           return `${field} ${operator}`;
         }
 
+        if ((filter.operator == AdminForthFilterOperators.LIKE || filter.operator == AdminForthFilterOperators.ILIKE)
+            && column.isArray?.enabled) {
+          placeholder = '{f$?:String}';
+
+          if (this.isArrayType(column._underlineType)) {
+            const arrayField = this.isNullableType(column._underlineType) ? `assumeNotNull(${field})` : field;
+            const arrayMatch = `arrayExists(item -> toString(item) ${operator} ${placeholder}, ${arrayField})`;
+            return this.isNullableType(column._underlineType)
+              ? `${field} IS NOT NULL AND ${arrayMatch}`
+              : arrayMatch;
+          }
+
+          if (this.isStringLikeType(column._underlineType)) {
+            return `${field} ${operator} ${placeholder}`;
+          }
+        }
+
+        if ((filter.operator == AdminForthFilterOperators.IN || filter.operator == AdminForthFilterOperators.NIN)
+            && column.isArray?.enabled
+            && this.isArrayType(column._underlineType)) {
+          const itemType = column._underlineType
+            .replace(/^Nullable\(/, '')
+            .match(/^Array\((.*)\)$/)?.[1];
+
+          if (!itemType) {
+            throw new Error(`Unable to determine item type for array field '${column.name}' with type '${column._underlineType}'`);
+          }
+
+          placeholder = `{f$?:Array(${itemType})}`;
+          const arrayField = this.isNullableType(column._underlineType) ? `assumeNotNull(${field})` : field;
+          const hasAnyExpression = `hasAny(${arrayField}, ${placeholder})`;
+
+          if (filter.operator == AdminForthFilterOperators.NIN) {
+            return this.isNullableType(column._underlineType)
+              ? `(${field} IS NULL OR NOT ${hasAnyExpression})`
+              : `NOT ${hasAnyExpression}`;
+          }
+
+          return this.isNullableType(column._underlineType)
+            ? `${field} IS NOT NULL AND ${hasAnyExpression}`
+            : hasAnyExpression;
+        }
+
         if (column._underlineType.startsWith('Decimal')) {
           field = `toDecimal64(${field}, 8)`;
           placeholder = `toDecimal64({f$?:String}, 8)`;
@@ -293,20 +361,24 @@ class ClickhouseConnector extends AdminForthBaseConnector implements IAdminForth
       }).join(` ${this.OperatorsMap[filter.operator]} `);
     }
 
-    getFilterParams(filter: IAdminForthSingleFilter | IAdminForthAndOrFilter): any[] {
+    getFilterParams(resource: AdminForthResource, filter: IAdminForthSingleFilter | IAdminForthAndOrFilter): any[] {
       if ((filter as IAdminForthSingleFilter).field) {
         if ((filter as IAdminForthSingleFilter).rightField) {
           // No params for field-to-field comparisons
           return [];
         }
         // filter is a Single filter
+        const column = resource.dataSourceColumns.find((col) => col.name == (filter as IAdminForthSingleFilter).field);
 
         // Handle IS_EMPTY and IS_NOT_EMPTY operators - no params needed
         if (filter.operator == AdminForthFilterOperators.IS_EMPTY || filter.operator == AdminForthFilterOperators.IS_NOT_EMPTY) {
           return [];
         } else if (filter.operator == AdminForthFilterOperators.LIKE || filter.operator == AdminForthFilterOperators.ILIKE) {
           return [{ 'f': `%${filter.value}%` }];
         } else if (filter.operator == AdminForthFilterOperators.IN || filter.operator == AdminForthFilterOperators.NIN) {
+          if (column?.isArray?.enabled && this.isArrayType(column._underlineType)) {
+            return [{ 'f': filter.value }];
+          }
           return [{ 'p': filter.value }];
         } else if (filter.operator == AdminForthFilterOperators.EQ && filter.value === null) {
           // there is no param for IS NULL filter
@@ -326,15 +398,15 @@ class ClickhouseConnector extends AdminForthBaseConnector implements IAdminForth
 
       // filter is a AndOrFilter
       return (filter as IAdminForthAndOrFilter).subFilters.reduce((params: any[], f: IAdminForthSingleFilter | IAdminForthAndOrFilter) => {
-        return params.concat(this.getFilterParams(f));
+        return params.concat(this.getFilterParams(resource, f));
       }, []);
     }
 
-    whereParams(filters: IAdminForthAndOrFilter): any {
+    whereParams(resource: AdminForthResource, filters: IAdminForthAndOrFilter): any {
       if (filters.subFilters.length === 0) {
         return {};
       }
-      const paramsArray = this.getFilterParams(filters);
+      const paramsArray = this.getFilterParams(resource, filters);
       const params = paramsArray.reduce((acc, param, paramIndex) => {
         if (param.f !== undefined) {
           acc[`f${paramIndex}`] = param.f;
@@ -362,7 +434,7 @@ class ClickhouseConnector extends AdminForthBaseConnector implements IAdminForth
           params: {},
         }
       }
-      const params = this.whereParams(filters);
+      const params = this.whereParams(resource, filters);
       const where = Object.keys(params).reduce((w, paramKey) => {
         // remove first char of string (will be "f" or "p") to leave only index
         const keyIndex = paramKey.substring(1);
@@ -388,6 +460,7 @@ class ClickhouseConnector extends AdminForthBaseConnector implements IAdminForth
       }).join(', ');
       const tableName = resource.table;
 
+      console.log('getDataWithOriginalTypes called with filters', JSON.stringify(filters), 'and sort', JSON.stringify(sort));
       const { where, params } = this.whereClause(resource, filters);
 
       const orderBy = sort.length ? `ORDER BY ${sort.map((s) => `${s.field} ${this.SortDirectionsMap[s.direction]}`).join(', ')}` : '';

adminforth/documentation/docs/tutorial/03-Customization/09-Actions.md

@@ -224,7 +224,7 @@ Keep the `<slot />` (that's where AdminForth renders the default button) and emi
   <!-- Keep the slot: AdminForth renders the default action button/icon here -->
   <!-- Emit `callAction` (optionally with a payload) to trigger the action when the wrapper is clicked -->
   <!-- Example: provide `meta.extra` to send custom data. In list views we merge with `row` so recordId context is kept. -->
-  <div :style="styleObj" @click="emit('callAction', { ...props.row, ...(props.meta?.extra ?? {}) })">
+  <div :style="styleObj" @click="click({ ...props.row, ...(props.meta?.extra ?? {}) })">
     <slot />
   </div>
 </template>
@@ -248,6 +248,14 @@ const styleObj = computed(() => ({
   borderRadius: (props.meta?.radius ?? 8) + 'px',
   padding: (props.meta?.padding ?? 2) + 'px',
 }));
+
+function click(payload: any) {
+  emit('callAction', { ...props.row, ...(props.meta?.extra ?? {}) })
+}
+//we need to define this expose, because padding is added by adminforth wrapper and to trigger click on this padding we use this expose
+defineExpose({
+  click
+});
 </script>
 ```
 

adminforth/documentation/docs/tutorial/03-Customization/10-menuConfiguration.md

@@ -207,8 +207,12 @@ Most times you need to refresh the badge from some backend API or hook. To do th
       resourceId: 'posts',
 //diff-add
       itemId: 'postsMenuItem',
-      badge: async (adminUser: AdminUser) => {
-        return 10
+      //diff-add
+      badge: async (adminUser: AdminUser, adminForth: IAdminForth) => {
+        //diff-add
+        const newCount = await adminforth.resource('posts').count(Filters.EQ('verified', false));
+        //diff-add
+        return newCount;
       },
       badgeTooltip: 'Unverified posts',  // explain user what this badge means
       ...
@@ -226,15 +230,13 @@ Most times you need to refresh the badge from some backend API or hook. To do th
   table: 'posts',
   hooks: {
     edit: {
-//diff-add
+      //diff-add
       afterSave: async ({ record, adminUser, resource, adminforth }) => {
-//diff-add
-        const newCount = await adminforth.resource('posts').count(Filters.EQ('verified', false));
-//diff-add
-        adminforth.websocket.publish(`/opentopic/update-menu-badge/postsMenuItem`, { badge: newCount });
-//diff-add
+        //diff-add
+        adminforth.refreshMenuBadge('postsMenuItem', adminUser);
+        //diff-add
         return { ok: true }
-//diff-add
+        //diff-add
       }
     }
   }

adminforth/documentation/docs/tutorial/03-Customization/11-dataApi.md

@@ -125,7 +125,7 @@ const users = await admin.resource('adminuser').list(
 
 ## Using a raw SQL in queries.
 
-Rarely you might want to add ciondition for some exotic SQL but still want to keep the rest of API.
+Rarely you might want to add condition for some exotic SQL but still want to keep the rest of API.
 Technically it happened that AdminForth allows you to do this also
 
 ```js
@@ -139,9 +139,8 @@ const usersWithNoUgcAccess = await admin.resource('adminuser').list(
 
   ], 15, 0, Sorts.DESC('createdAt')
 );
-
-This will produce next SQL query:
 ```
+This will produce next SQL query:
 
 ```
 SELECT *
@@ -150,10 +149,8 @@ WHERE "role" != 'Admin'
   AND (user_meta->>'age') < 18
 ORDER BY "createdAt" DESC
 LIMIT 15 OFFSET 0;
-
 ```
 
-
 Finds users with age less then 18 from meta field which should be a JSONB field in Postgress.
 
 ## Create a new item in database