Merge pull request #17 from devforth/AdminForth/605

feat: add handlebars and remove fields for context

Author: ivictbor

custom/imageGenerator.vue

@@ -181,6 +181,7 @@ import { callAdminForthApi } from '@/utils';
 import { useI18n } from 'vue-i18n';
 import adminforth from '@/adminforth';
 import { ProgressBar } from '@/afcl';
+import * as Handlebars from 'handlebars';
 
 const { t: $t } = useI18n();
 
@@ -214,28 +215,9 @@ onMounted(async () => {
   }
   // iterate over all variables in template and replace them with their values from props.record[field]. 
   // if field is not present in props.record[field] then replace it with empty string and drop warning
-  const regex = /{{(.*?)}}/g;
-  const matches = template.match(regex);
-  if (matches) {
-    matches.forEach((match) => {
-      const field = match.replace(/{{|}}/g, '').trim();
-      if (field in context) {
-        return;
-      } else if (field in props.record) {
-        context[field] = minifyField(props.record[field]);
-      } else {
-        adminforth.alert({
-          message: $t('Field {{field}} defined in template but not found in record', { field }),
-          variant: 'warning',
-          timeout: 15,
-        });
-      } 
-    });
-  }
-
-  prompt.value = template.replace(regex, (_, field) => {
-    return context[field.trim()] || '';
-  });
+  const tpl = Handlebars.compile(template);
+  const compiledTemplate = tpl(props.record);
+  prompt.value = compiledTemplate;
   
   const recordId = props.record[props.meta.recorPkFieldName];
   if (!recordId) return;

custom/package-lock.json

@@ -11,6 +11,7 @@
   "license": "ISC",
   "dependencies": {
     "@iconify-prerendered/vue-mdi": "^0.25.1718880438",
+    "handlebars": "^4.7.8",
     "medium-zoom": "^1.1.0"
   }
 }

custom/package.json

@@ -219,16 +219,6 @@ export default class UploadPlugin extends AdminForthPlugin {
       throw new Error(`Column with name "${pathColumnName}" not found in resource "${resourceConfig.label}"`);
     }
 
-    if (this.options.generation?.fieldsForContext) {
-      this.options.generation?.fieldsForContext.forEach((field: string) => {
-        if (!resourceConfig.columns.find((column: any) => column.name === field)) {
-          const similar = suggestIfTypo(resourceConfig.columns.map((column: any) => column.name), field);
-          throw new Error(`Field "${field}" specified in fieldsForContext not found in
- resource "${resourceConfig.label}". ${similar ? `Did you mean "${similar}"?` : ''}`);
-        }
-      });
-    }
-
     const pluginFrontendOptions = {
       allowedExtensions: this.options.allowedFileExtensions,
       maxFileSize: this.options.maxFileSize,
@@ -386,6 +376,26 @@ export default class UploadPlugin extends AdminForthPlugin {
 
   validateConfigAfterDiscover(adminforth: IAdminForth, resourceConfig: any) {
     this.adminforth = adminforth;
+    
+    if (this.options.generation) {
+      const template = this.options.generation?.generationPrompt;
+      const regex = /{{(.*?)}}/g;
+      const matches = template.match(regex);
+      if (matches) {
+        matches.forEach((match) => {
+          const field = match.replace(/{{|}}/g, '').trim();
+          if (!resourceConfig.columns.find((column: any) => column.name === field)) {
+            const similar = suggestIfTypo(resourceConfig.columns.map((column: any) => column.name), field);
+            throw new Error(`Field "${field}" specified in generationPrompt not found in resource "${resourceConfig.label}". ${similar ? `Did you mean "${similar}"?` : ''}`);
+          } else {
+            let column = resourceConfig.columns.find((column: any) => column.name === field);
+            if (column.backendOnly === true) {
+              throw new Error(`Field "${field}" specified in generationPrompt is marked as backendOnly in resource "${resourceConfig.label}". Please remove backendOnly or choose another field.`);
+            }
+          }
+        });
+      }
+    }
     // called here because modifyResourceConfig can be called in build time where there is no environment and AWS secrets
     this.setupLifecycleRule();
   }

index.ts

@@ -102,12 +102,6 @@ export type PluginOptions = {
      */
     outputSize?: string,
 
-    /**
-     * Fields for conetext which will be used to generate the image.
-     * If specified, the plugin will use fields from the record to provide additional context to the AI model.
-     */
-    fieldsForContext?: string[],
-
     /**
      * The number of images to generate
      * in one request