feat: add ability to process records, which are filtered

Author: yaroslav8765

custom/VisionAction.vue

@@ -67,7 +67,7 @@
     :click-to-close-outside="false"
   >
     <div class="bulk-vision-table flex flex-col items-center gap-3 md:gap-4 overflow-y-auto">
-      <template v-if="globalState.records.length && props.checkboxes.length && popupMode === 'generation'" >
+      <template v-if="globalState.records.length && popupMode === 'generation'" >
         <VisionTable
           class="md:max-h-[75vh] max-w-[1560px] w-full h-full"
           :records="globalState.records"
@@ -152,9 +152,11 @@ import { AdminUser, type AdminForthResourceCommon } from '@/types/Common';
 import { useCoreStore } from '@/stores/core';
 import { IconShieldSolid, IconInfoCircleSolid } from '@iconify-prerendered/vue-flowbite';
 import { IconExclamationTriangle } from '@iconify-prerendered/vue-humbleicons';
+import { useFiltersStore } from '@/stores/filters';
 
 
 const coreStore = useCoreStore();
+const filtersStore = useFiltersStore();
 
 const { t } = useI18n();
 const props = defineProps<{
@@ -232,7 +234,7 @@ const openDialog = async () => {
   isDialogOpen.value = true;
   confirmDialog.value.open();
   isFetchingRecords.value = true;
-  initializeGlobalState();
+  await initializeGlobalState();
   await findPreviewURLForImages();
   isFetchingRecords.value = false;
   if (!generationPrompts.value || Object.keys(generationPrompts.value).length === 0) {
@@ -242,6 +244,35 @@ const openDialog = async () => {
     runAiActions();
   }
 }
+
+async function getListOfIds() {
+  if ( props.meta.recordSelector === 'filtered' ) {
+    const filters = filtersStore.getFilters(props.resource.resourceId);
+    let res;
+    try {
+      res = await callAdminForthApi({
+        path: `/plugin/${props.meta.pluginInstanceId}/get_filtered_ids`,
+        method: 'POST',
+        body: { filters },
+        silentError: true,
+      });
+    } catch (e) {
+      console.error('Failed to get records for filtered selector:', e);
+      isError.value = true;
+      errorMessage.value = t(`Failed to fetch records. Please, try to re-run the action.`);
+      return [];
+    }
+    if (!res?.ok || !res?.recordIds) {
+      console.error('Failed to get records for filtered selector, response error:', res);
+      isError.value = true;
+      errorMessage.value = t(`Failed to fetch records. Please, try to re-run the action.`);
+      return [];
+    }
+    return res.recordIds;
+  } else {
+   return props.checkboxes;
+  }
+}
  
 
 async function runAiActions() {
@@ -267,8 +298,9 @@ const closeDialog = () => {
   isDataSaved.value = false;
 }
 
-function initializeGlobalState() {
-  const records = props.checkboxes.map((recordId: any) => createEmptyRecord(recordId));
+async function initializeGlobalState() {
+  const ids = await getListOfIds();
+  const records = ids.map((recordId: any) => createEmptyRecord(recordId));
   globalState.records.splice(0, globalState.records.length, ...records);
   globalState.recordsById = Object.fromEntries(records.map(record => [String(record.id), record]));
 }

index.ts

@@ -1,4 +1,4 @@
-import { AdminForthPlugin, Filters } from "adminforth";
+import { AdminForthFilterOperators, AdminForthPlugin, Filters } from "adminforth";
 import type { IAdminForth, IHttpServer, AdminForthComponentDeclaration, AdminForthResource } from "adminforth";
 import { suggestIfTypo } from "adminforth";
 import type { PluginOptions } from './types.js';
@@ -601,7 +601,7 @@ export default class  BulkAiFlowPlugin extends AdminForthPlugin {
         isFieldsForAnalizePlain: this.options.fillPlainFields ? Object.keys(this.options.fillPlainFields).length > 0 : false,
         isImageGeneration: this.options.generateImages ? Object.keys(this.options.generateImages).length > 0 : false,
         isAttachFiles: this.options.attachFiles ? true : false,
-        disabledWhenNoCheckboxes: true,
+        disabledWhenNoCheckboxes: this.options.recordSelector === 'filtered' ? false : true,
         refreshRates: {
           fillFieldsFromImages: this.options.refreshRates?.fillFieldsFromImages || 2_000,
           fillPlainFields: this.options.refreshRates?.fillPlainFields || 1_000,
@@ -610,6 +610,7 @@ export default class  BulkAiFlowPlugin extends AdminForthPlugin {
         },
         askConfirmationBeforeGenerating: this.options.askConfirmationBeforeGenerating || false,
         concurrencyLimit: this.options.concurrencyLimit || 10,
+        recordSelector: this.options.recordSelector || 'checkbox',
         generationPrompts: {
           plainFieldsPrompts: this.options.fillPlainFields || {},
           imageFieldsPrompts: this.options.fillFieldsFromImages || {},
@@ -1034,5 +1035,44 @@ export default class  BulkAiFlowPlugin extends AdminForthPlugin {
         }
       }
     });
+
+    server.endpoint({
+      method: 'POST',
+      path: `/plugin/${this.pluginInstanceId}/get_filtered_ids`,
+      handler: async ({ body, adminUser, headers }) => {
+        const filters = body.filters;
+
+        const normalizedFilters = { operator: AdminForthFilterOperators.AND, subFilters: [] };
+        if (filters) {
+          if (typeof filters !== 'object') {
+            throw new Error(`Filter should be an array or an object`);
+          }
+          if (Array.isArray(filters)) {
+            // if filters are an array, they will be connected with "AND" operator by default
+            normalizedFilters.subFilters = filters;
+          } else if (filters.field) {
+            // assume filter is a SingleFilter
+            normalizedFilters.subFilters = [filters];
+          } else if (filters.subFilters) {
+            // assume filter is a AndOr filter
+            normalizedFilters.operator = filters.operator;
+            normalizedFilters.subFilters = filters.subFilters;
+          } else {
+            // wrong filter
+            throw new Error(`Wrong filter object value: ${JSON.stringify(filters)}`);
+          }
+        }
+
+        const records = await this.adminforth.resource(this.resourceConfig.resourceId).list(normalizedFilters);
+        if (!records) {
+          return { ok: true, recordIds: [] };
+        }
+        const primaryKeyColumn = this.resourceConfig.columns.find((col) => col.primaryKey);
+
+        const recordIds = records.map(record => record[primaryKeyColumn.name]);
+
+        return { ok: true, recordIds }
+      }
+    });
   }
 }

types.ts

@@ -124,4 +124,16 @@ export interface PluginOptions {
    * Maximum number of records processed concurrently on the frontend.
    */
   concurrencyLimit?: number;
+
+  /**
+   * Defines the way how records are selected for the action. 
+   * 
+   * 'checkbox' means that user will select records manually by checkboxes, 
+   * 
+   * 'filtered' means that action will be applied to all records matching current 
+   *  filters without showing any checkboxes (use with caution). 
+   * 
+   * Default is 'checkbox'.
+   */
+  recordSelector?: 'checkbox' | 'filtered';
 }