@adminforth/bulk-ai-flow 1.7.4 → 1.8.1

package/index.ts

@@ -73,58 +73,30 @@ export default class  BulkAiFlowPlugin extends AdminForthPlugin {
     const columns = this.resourceConfig.columns;
     let columnEnums = [];
     if (this.options.fillFieldsFromImages) {
-      if (!this.options.attachFiles) {
-        throw new Error('⚠️ attachFiles function must be provided in options when fillFieldsFromImages is used');
-      }
-      if (!this.options.visionAdapter) {
-        throw new Error('⚠️ visionAdapter must be provided in options when fillFieldsFromImages is used');
-      }
-
       for (const [key, value] of Object.entries((this.options.fillFieldsFromImages ))) {
         const column = columns.find(c => c.name.toLowerCase() === key.toLowerCase());
-        if (column) {
-          if(column.enum){
-            (this.options.fillFieldsFromImages as any)[key] = `${value} Select ${key} from the list (USE ONLY VALUE FIELD. USE ONLY VALUES FROM THIS LIST): ${JSON.stringify(column.enum)}`;
-            columnEnums.push({
-              name: key,
-              enum: column.enum,
-            });
-          }
-        } else {
-          throw new Error(`⚠️ No column found for key "${key}"`);
+        if (column && column.enum) {
+          (this.options.fillFieldsFromImages as any)[key] = `${value} Select ${key} from the list (USE ONLY VALUE FIELD. USE ONLY VALUES FROM THIS LIST): ${JSON.stringify(column.enum)}`;
+          columnEnums.push({
+            name: key,
+            enum: column.enum,
+          });
         }
       }
     }
 
     if (this.options.fillPlainFields) {
-      if (!this.options.textCompleteAdapter) {
-        throw new Error('⚠️ textCompleteAdapter must be provided in options when fillPlainFields is used');
-      }
-
       for (const [key, value] of Object.entries((this.options.fillPlainFields))) {
         const column = columns.find(c => c.name.toLowerCase() === key.toLowerCase());
-        if (column) {
-          if(column.enum){
-            (this.options.fillPlainFields as any)[key] = `${value} Select ${key} from the list (USE ONLY VALUE FIELD. USE ONLY VALUES FROM THIS LIST): ${JSON.stringify(column.enum)}`;
-            columnEnums.push({
-              name: key,
-              enum: column.enum,
-            });
-          }
-        } else {
-          throw new Error(`⚠️ No column found for key "${key}"`);
-        }
-      }
-    }
-
-    if (this.options.generateImages && !this.options.imageGenerationAdapter) {
-      for (const [key, value] of Object.entries(this.options.generateImages)) {
-        if (!this.options.generateImages[key].adapter) {
-          throw new Error(`⚠️ No image generation adapter found for key "${key}"`);
+        if (column && column.enum) {
+          (this.options.fillPlainFields as any)[key] = `${value} Select ${key} from the list (USE ONLY VALUE FIELD. USE ONLY VALUES FROM THIS LIST): ${JSON.stringify(column.enum)}`;
+          columnEnums.push({
+            name: key,
+            enum: column.enum,
+          });
         }
       }
-    }
-  
+    }  
 
     const outputImageFields = [];
     if (this.options.generateImages) {
@@ -136,25 +108,11 @@ export default class  BulkAiFlowPlugin extends AdminForthPlugin {
     //check if Upload plugin is installed on all attachment fields
     if (this.options.generateImages) {
       for (const [key, value] of Object.entries(this.options.generateImages)) {
-        const column = columns.find(c => c.name.toLowerCase() === key.toLowerCase());
-        if (!column) {
-          throw new Error(`⚠️ No column found for key "${key}"`);
-        }
         const plugin = adminforth.activatedPlugins.find(p => 
           p.resourceConfig!.resourceId === this.resourceConfig.resourceId &&
           p.pluginOptions.pathColumnName === key
         );
-        if (!plugin) {
-          throw new Error(`Plugin for attachment field '${key}' not found in resource '${this.resourceConfig.resourceId}', please check if Upload Plugin is installed on the field ${key}`);
-        }
-        if (!plugin.pluginOptions.storageAdapter.objectCanBeAccesedPublicly()) {
-          throw new Error(`Upload Plugin for attachment field '${key}' in resource '${this.resourceConfig.resourceId}' 
-            uses adapter which is not configured to store objects in public way, so it will produce only signed private URLs which can not be used in HTML text of blog posts.
-            Please configure adapter in such way that it will store objects publicly (e.g.  for S3 use 'public-read' ACL).  
-          `);
-        }
-
-        outputImagesPluginInstanceIds[key] = plugin.pluginInstanceId;
+          outputImagesPluginInstanceIds[key] = plugin.pluginInstanceId;
       }
     }
 
@@ -168,7 +126,7 @@ export default class  BulkAiFlowPlugin extends AdminForthPlugin {
     const primaryKeyColumn = this.resourceConfig.columns.find((col) => col.primaryKey);
 
     const pageInjection = {
-      file: this.componentPath('visionAction.vue'),
+      file: this.componentPath('VisionAction.vue'),
       meta: {
         pluginInstanceId: this.pluginInstanceId,
         outputFields: outputFields,
@@ -199,18 +157,71 @@ export default class  BulkAiFlowPlugin extends AdminForthPlugin {
   }
   
   validateConfigAfterDiscover(adminforth: IAdminForth, resourceConfig: AdminForthResource) {
-    // optional method where you can safely check field types after database discovery was performed
+    const columns = this.resourceConfig.columns;
+    if (this.options.fillFieldsFromImages) {
+      if (!this.options.attachFiles) {
+        throw new Error('⚠️ attachFiles function must be provided when fillFieldsFromImages is used');
+      }
+      if (!this.options.visionAdapter) {
+        throw new Error('⚠️ visionAdapter must be provided when fillFieldsFromImages is used');
+      }
+      for (const key of Object.keys(this.options.fillFieldsFromImages)) {
+        const column = columns.find(c => c.name.toLowerCase() === key.toLowerCase());
+        if (!column) {
+          throw new Error(`⚠️ No column found for key "${key}"`);
+        }
+      }
+    }
+    if (this.options.fillPlainFields) {
+      if (!this.options.textCompleteAdapter) {
+        throw new Error('⚠️ textCompleteAdapter must be provided when fillPlainFields is used');
+      }
+      for (const key of Object.keys(this.options.fillPlainFields)) {
+        const column = columns.find(c => c.name.toLowerCase() === key.toLowerCase());
+        if (!column) {
+          throw new Error(`⚠️ No column found for key "${key}"`);
+        }
+      }
+    }
+    if (this.options.generateImages) {
+      for (const key of Object.keys(this.options.generateImages)) {
+        const column = columns.find(c => c.name.toLowerCase() === key.toLowerCase());
+        if (!column) {
+          throw new Error(`⚠️ No column found for key "${key}"`);
+        }
+        const perKeyAdapter = this.options.generateImages[key].adapter;
+        if (!perKeyAdapter && !this.options.imageGenerationAdapter) {
+          throw new Error(`⚠️ No image generation adapter provided for key "${key}"`);
+        }
+
+        const plugin = adminforth.activatedPlugins.find(p => 
+          p.resourceConfig!.resourceId === this.resourceConfig.resourceId &&
+          p.pluginOptions.pathColumnName === key
+        );
+        if (!plugin) {
+          throw new Error(`Plugin for attachment field '${key}' not found in resource '${this.resourceConfig.resourceId}', please check if Upload Plugin is installed on the field ${key}`);
+        }
+        if (!plugin.pluginOptions || !plugin.pluginOptions.storageAdapter) {
+          throw new Error(`Upload Plugin for attachment field '${key}' in resource '${this.resourceConfig.resourceId}' is missing a storageAdapter configuration.`);
+        }
+        if (typeof plugin.pluginOptions.storageAdapter.objectCanBeAccesedPublicly !== 'function') {
+          throw new Error(`Upload Plugin for attachment field '${key}' in resource '${this.resourceConfig.resourceId}' uses a storage adapter without 'objectCanBeAccesedPublicly' method.`);
+        }
+        if (!plugin.pluginOptions.storageAdapter.objectCanBeAccesedPublicly()) {
+          throw new Error(`Upload Plugin for attachment field '${key}' in resource '${this.resourceConfig.resourceId}' 
+            uses adapter which is not configured to store objects in public way, so it will produce only signed private URLs which can not be used in HTML text of blog posts.
+            Please configure adapter in such way that it will store objects publicly (e.g.  for S3 use 'public-read' ACL).  
+          `);
+        }
+      }
+    }
   }
 
   instanceUniqueRepresentation(pluginOptions: any) : string {
-    // optional method to return unique string representation of plugin instance. 
-    // Needed if plugin can have multiple instances on one resource 
     return `${this.pluginOptions.actionName}`;
   }
 
   setupEndpoints(server: IHttpServer) {
-
-
     server.endpoint({
       method: 'POST',
       path: `/plugin/${this.pluginInstanceId}/analyze`,
@@ -224,7 +235,7 @@ export default class  BulkAiFlowPlugin extends AdminForthPlugin {
       const tasks = selectedIds.map(async (ID) => {
         // Fetch the record using the provided ID
         const primaryKeyColumn = this.resourceConfig.columns.find((col) => col.primaryKey);
-        const record = await this.adminforth.resource(this.resourceConfig.resourceId).get( [Filters.EQ(primaryKeyColumn.name, ID)] );
+        const record = await this.adminforth.resource(this.resourceConfig.resourceId).get([Filters.EQ(primaryKeyColumn.name, ID)] );
 
         //recieve image URLs to analyze
         const attachmentFiles = await this.options.attachFiles({ record: record });
@@ -274,26 +285,23 @@ export default class  BulkAiFlowPlugin extends AdminForthPlugin {
         }
       }
       const tasks = selectedIds.map(async (ID) => {
-        // Fetch the record using the provided ID
         const primaryKeyColumn = this.resourceConfig.columns.find((col) => col.primaryKey);
         const record = await this.adminforth.resource(this.resourceConfig.resourceId).get( [Filters.EQ(primaryKeyColumn.name, ID)] );
 
-        //create prompt for OpenAI
         const compiledOutputFields = this.compileOutputFieldsTemplatesNoImage(record);
         const prompt = `Analyze the following fields and return a single JSON in format like: {'param1': 'value1', 'param2': 'value2'}. 
           Do NOT return array of objects. Do NOT include any Markdown, code blocks, explanations, or extra text. Only return valid JSON. 
           Each object must contain the following fields: ${JSON.stringify(compiledOutputFields)} Use the exact field names. 
           If it's number field - return only number.`;
         //send prompt to OpenAI and get response
-        const { content: chatResponse } = await this.options.textCompleteAdapter.complete(prompt, [], 500);
+        const numberOfTokens = this.options.fillPlainFieldsMaxTokens ? this.options.fillPlainFieldsMaxTokens : 1000;
+        const { content: chatResponse } = await this.options.textCompleteAdapter.complete(prompt, [], numberOfTokens);
 
         const resp: any = (chatResponse as any).response;
         const topLevelError = (chatResponse as any).error;
         if (topLevelError || resp?.error) {
           throw new Error(`ERROR: ${JSON.stringify(topLevelError || resp?.error)}`);
         }
-
-        //parse response and update record
         const resData = JSON.parse(chatResponse);
 
         return resData;
@@ -304,8 +312,6 @@ export default class  BulkAiFlowPlugin extends AdminForthPlugin {
       return { result };
       }
     });
-
-
     server.endpoint({
       method: 'POST',
       path: `/plugin/${this.pluginInstanceId}/get_records`,
@@ -316,13 +322,16 @@ export default class  BulkAiFlowPlugin extends AdminForthPlugin {
         for( const [index, record] of records.entries() ) {
           records[index]._label = this.resourceConfig.recordLabel(records[index]);
         }
+        const order = Object.fromEntries(body.body.record.map((id, i) => [id, i]));
+
+        const sortedRecords = records.sort(
+          (a, b) => order[a.id] - order[b.id]
+        );
         return {
-          records,
+          records: sortedRecords,
         };
       }
     });
-
-
     server.endpoint({
       method: 'POST',
       path: `/plugin/${this.pluginInstanceId}/get_images`,
@@ -340,8 +349,6 @@ export default class  BulkAiFlowPlugin extends AdminForthPlugin {
         };
       }
     });
-
-
     server.endpoint({
       method: 'POST',
       path: `/plugin/${this.pluginInstanceId}/update_fields`,
@@ -387,6 +394,35 @@ export default class  BulkAiFlowPlugin extends AdminForthPlugin {
                 }
               }
             }
+            try {
+              const AuditLogPlugin:any = this.adminforth.getPluginByClassName('AuditLogPlugin');
+              if (AuditLogPlugin) {
+
+                for (const [key, value] of Object.entries(oldRecord)) {
+                  if (!(key in fieldsToUpdate[idx])) {
+                    delete oldRecord[key];
+                  }
+                }
+
+                const reorderedOldRecord = Object.keys(fieldsToUpdate[idx]).reduce((acc, key) => {
+                  if (key in oldRecord) {
+                    acc[key] = oldRecord[key];
+                  }
+                  return acc;
+                }, {} as Record<string, unknown>);
+
+                AuditLogPlugin.logCustomAction({
+                  resourceId: this.resourceConfig.resourceId,
+                  recordId: ID,
+                  actionId: 'Bulk-ai-flow',
+                  oldData: reorderedOldRecord,
+                  data: fieldsToUpdate[idx],
+                  user: adminUser,
+                  headers: headers
+                });
+              }
+            } catch (error) { }
+            
             return this.adminforth.resource(this.resourceConfig.resourceId).update(ID, fieldsToUpdate[idx])
           });
           await Promise.all(updates);
@@ -396,8 +432,6 @@ export default class  BulkAiFlowPlugin extends AdminForthPlugin {
         }
       }
     });
-
-
     server.endpoint({
       method: 'POST',
       path: `/plugin/${this.pluginInstanceId}/regenerate_images`,
@@ -449,8 +483,6 @@ export default class  BulkAiFlowPlugin extends AdminForthPlugin {
         return { images };
       }
     });
-
-
     server.endpoint({
       method: 'POST',
       path: `/plugin/${this.pluginInstanceId}/initial_image_generate`,
@@ -518,8 +550,6 @@ export default class  BulkAiFlowPlugin extends AdminForthPlugin {
         return { result };
       }
     });
-
-
     server.endpoint({
       method: 'POST',
       path: `/plugin/${this.pluginInstanceId}/get_generation_prompts`,
@@ -530,8 +560,6 @@ export default class  BulkAiFlowPlugin extends AdminForthPlugin {
         return { generationOptions: compiledGenerationOptions };
       }
     });
-
-
     server.endpoint({
       method: 'GET',
       path: `/plugin/${this.pluginInstanceId}/averageDuration`,
@@ -543,8 +571,5 @@ export default class  BulkAiFlowPlugin extends AdminForthPlugin {
         };
       }
     });
-
-
-
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adminforth/bulk-ai-flow",
-  "version": "1.7.4",
+  "version": "1.8.1",
   "publishConfig": {
     "access": "public"
   },

package/types.ts

@@ -1,20 +1,52 @@
-import { ImageVisionAdapter, AdminUser, IAdminForth, StorageAdapter, ImageGenerationAdapter, CompletionAdapter } from "adminforth";
+import { ImageVisionAdapter, ImageGenerationAdapter, CompletionAdapter } from "adminforth";
 
 
 export interface PluginOptions {
+    /**
+     * Name of the action in three dots menu.
+     */
     actionName: string,
+
+     /**
+     * The adapter to use for scaning images and filling fields basing on the image content.
+     */
     visionAdapter?: ImageVisionAdapter,
+    
+    /**
+     * The adapter to use for text->text generation.
+     */
     textCompleteAdapter?: CompletionAdapter,
+
     /**
      * The adapter to use for image generation. 
      */
     imageGenerationAdapter?: ImageGenerationAdapter,
+    
+    /**
+     * List of fields that should be filled based on the image content analysis.
+     */
     fillFieldsFromImages?: Record<string, string>, // can analyze what is on image and fill fields, typical tasks "find dominant color", "describe what is on image", "clasify to one enum item, e.g. what is on image dog/cat/plant"
+
+    /**
+     * List of fields that should be filled based on the text.
+     */
     fillPlainFields?: Record<string, string>,
+
+    /**
+     * Number of tokens to generate (Only for text completion adapter). Default is 1000. 1 token ~= ¾ words
+     */
+    fillPlainFieldsMaxTokens?: number,
+
+    /**
+     * If you want to generate fields or images based on the image content attached images 
+     */
     attachFiles?: ({ record }: {
       record: any,
     }) => string[] | Promise<string[]>,
 
+    /**
+     * List of image fields, that should be filled.
+     */
     generateImages?: Record<
       string, {
         // can generate from images or just from another fields, e.g. "remove text from images", "improve image quality", "turn image into ghibli style"
@@ -43,6 +75,10 @@ export interface PluginOptions {
        */
       countToGenerate: number,
     }>,
+
+    /**
+     * Rate limits for each action.
+     */
     rateLimits?: {
       fillFieldsFromImages?: string, // e.g. 5/1d - 5 requests per day
       fillPlainFields?: string,