fix: add getKeyAsDataURL into storage adapter

Author: ivictbor

adminforth/documentation/docs/tutorial/05-Plugins/05-upload.md

@@ -358,6 +358,59 @@ generation: {
 }
 ```
 
+`attachFiles` function can return an array of URLs to images which will be used as input for image generation. 
+URLs can be absolute HTTP URLs (should be public in this case) or data-URLs (`data:image/png;base64,<base64 content of image>`).
+
+For example you can use `getKeyAsDataURL` function from any storage adapter to get image as data-URL:
+
+```ts title="./apartments.ts"
+
+import { StorageAdapter } from 'adminforth'
+
+let sourceAdapter: StorageAdapter = null;
+
+columns: [
+  ...
+  {
+    name: 'source_image',
+  },
+  {
+    name: 'destination_image',
+  }
+],
+plugins: [ 
+  ...
+  new UploadPlugin({
+    pathColumnName: 'apartment_source',
+    storageAdapter: (sourcesAdapter = new AdminForthStorageAdapterLocalFilesystem({
+      fileSystemFolder: "./db/uploads",
+      mode: "public",
+      signingSecret: process.env.ADMINFORTH_SECRET, // secret used to generate presigned URLs
+    }), sourcesAdapter),
+  }),
+  new UploadPlugin({
+    pathColumnName: 'apartment_image',
+    storageAdapter: new AdminForthAdapterLocalFilesystem({
+      fileSystemFolder: "./db/uploads",
+      mode: "public",
+      signingSecret: process.env.ADMINFORTH_SECRET, // secret used to generate presigned URLs
+    }),
+    generation: {
+      attachFiles: ({ record }) => {
+        // get picture stored in apartment_source column as data-URL
+        return [sourceAdapter.getKeyAsDataURL(record.apartment_source)];
+      },
+      generationPrompt: "Remove text from the image",
+      countToGenerate: 3,
+      outputSize: '1024x1024',
+    }
+  })
+]
+```
+
+With thus setup you can upload image to `apartment_source` column, save entity and then generate new image by clicking on `Generate` button in the `apartment_image` to remove any text from the image.
+
+
 ### Rate limits
 
 You can set rate limits for image generation per IP address:

adminforth/servers/express.ts

@@ -118,6 +118,7 @@ class ExpressServer implements IExpressHttpServer {
         }
       }
       this.expressApp.get(`${slashedPrefix}assets/*`, handler);
+      process.env.HEAVY_DEBUG && console.log('®️ Registering SPA serve handler', `${slashedPrefix}assets/*`);
       this.expressApp.get(`${prefix}*`, handler);
 
 

adminforth/types/Adapters.ts

@@ -201,6 +201,13 @@ export interface StorageAdapter {
    * If adapter is configured to publically, this method should return true.
    */
   objectCanBeAccesedPublicly(): Promise<boolean>;
+
+  /**
+   * This method should return the key as a data URL (base64 encoded string).
+   * @param key - The key of the file to be converted to a data URL
+   * @returns A promise that resolves to a string containing the data URL
+   */
+  getKeyAsDataURL(key: string): Promise<string>;
 }
 
 

dev-demo/resources/apartments.ts

@@ -18,6 +18,7 @@ import AdminForthAdapterS3Storage from "../../adapters/adminforth-storage-adapte
 import AdminForthAdapterLocal from "../../adapters/adminforth-storage-adapter-local/index.js";
 import AdminForthStorageAdapterLocalFilesystem from "../../adapters/adminforth-storage-adapter-local/index.js";
 import AdminForth from "../../adminforth";
+import { StorageAdapter } from "../../adminforth";
 
 
 const demoChecker = async ({ record, adminUser, resource }) => {
@@ -40,6 +41,8 @@ declare global {
   }
 }
 
+let sourcesAdapter: StorageAdapter;
+
 export default {
   dataSource: "maindb",
   table: "apartments",
@@ -319,10 +322,14 @@ export default {
                 openAiApiKey: process.env.OPENAI_API_KEY as string,
               }),
 
-              // attachFiles: ({ record, adminUser }: { record: any; adminUser: AdminUser }) => {
-              //   // attach apartment source image to generation, image should be public
-              //   return [`https://tmpbucket-adminforth.s3.eu-central-1.amazonaws.com/${record.apartment_source}`];
-              // },
+              attachFiles: async ({ record, adminUser }: { record: any; adminUser: AdminUser }) => {
+                // attach apartment source image to generation, image should be public
+                return [
+                  await sourcesAdapter.getKeyAsDataURL(record.apartment_source)
+                ];
+                    
+                // return [`https://tmpbucket-adminforth.s3.eu-central-1.amazonaws.com/${record.apartment_source}`];
+              },
               generationPrompt: "Add a 10 kittyies to the appartment look, it should be foto-realistic, they should be different colors, sitting all around the appartment",
               countToGenerate: 1,
               outputSize: '1024x1024',
@@ -341,19 +348,21 @@ export default {
           new UploadPlugin({
             pathColumnName: "apartment_source",
 
-            // storageAdapter: new AdminForthAdapterS3Storage({
-            //   region: "eu-central-1",
-            //   bucket: "tmpbucket-adminforth",
-            //   accessKeyId: process.env.AWS_ACCESS_KEY_ID,
-            //   secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
-            //   s3ACL: 'public-read', // ACL which will be set to uploaded file
-            // }),
+            storageAdapter: (sourcesAdapter = new AdminForthAdapterS3Storage({
+              region: "eu-central-1",
+              bucket: "tmpbucket-adminforth",
+              accessKeyId: process.env.AWS_ACCESS_KEY_ID,
+              secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
+              s3ACL: 'public-read', // ACL which will be set to uploaded file
+            }), sourcesAdapter),
 
-            storageAdapter: new AdminForthStorageAdapterLocalFilesystem({
-              fileSystemFolder: "./db/uploads",
-              mode: "public", // public if all files should be accessible from the web, private only if could be accesed by temporary presigned links
-              signingSecret: process.env.ADMINFORTH_SECRET, // secret used to generate presigned URLs
-            }),
+            // storageAdapter: (sourcesAdapter = new AdminForthStorageAdapterLocalFilesystem({
+            //   fileSystemFolder: "./db/uploads", // folder where files will be stored on disk
+            //   adminServeBaseUrl: "static/source", // the adapter not only stores files, but also serves them for HTTP requests
+            //      // this optional path allows to set the base URL for the files. Should be unique for each adapter if set.
+            //   mode: "public", // public if all files should be accessible from the web, private only if could be accesed by temporary presigned links
+            //   signingSecret: process.env.ADMINFORTH_SECRET, // secret used to generate presigned URLs
+            // }), sourcesAdapter),
 
             allowedFileExtensions: [
               "jpg",