Merge branch 'next' of github.com:devforth/adminforth into next

Author: ivictbor

adminforth/documentation/docs/tutorial/08-Plugins/04-RichEditor.md

@@ -145,7 +145,7 @@ To get completion suggestions for the text in the editor, you can use the `compl
 
 ![alt text](gptDemo.gif)
 
-### Imges in Rich editor
+### Images in Rich editor
 
 First, you need to create resource for images:
 ```prisma title="schema.prisma"

adminforth/documentation/docs/tutorial/08-Plugins/14-markdown.md

@@ -37,7 +37,7 @@ Here is how it looks in show view:
 ![alt text](markdown-show1.png)
 ![alt text](markdown-show2.png)
 
-### Imges in Markdown
+### Images in Markdown
 
 First, you need to create resource for images:
 ```prisma title="schema.prisma"

adminforth/modules/restApi.ts

@@ -1399,7 +1399,7 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {
             }
 
             const { error } = await this.adminforth.updateResourceRecord({ 
-              resource, record, adminUser, oldRecord, recordId, response, 
+              resource, updates: record, adminUser, oldRecord, recordId, response, 
               extra: { body, query, headers, cookies, requestUrl, response } 
             });
             if (error) {

adminforth/spa/src/afcl/Dialog.vue

@@ -62,7 +62,7 @@
             <p class="mb-6 text-lightDialogBodyText dark:text-darkDialogBodyText">{{ props.closeConfirmationText }}</p>
             <div class="flex justify-end">
               <Button
-                class="me-3"
+                class="me-3 !bg-gray-50 dark:!bg-gray-700 !text-lightDialogBodyText dark:!text-darkDialogBodyText hover:!bg-gray-100 dark:hover:!bg-gray-600 !border-gray-200 dark:!border-gray-600"
                 @click="showConfirmationOnClose = false"
               >
                 Cancel

adminforth/spa/src/components/MenuLink.vue

@@ -16,6 +16,9 @@
       class="min-w-5 min-h-5 text-lightSidebarIcons dark:text-darkSidebarIcons group-hover:text-lightSidebarIconsHover dark:group-hover:text-darkSidebarIconsHover transition-all duration-200 ease-in-out"
     >
     </component>
+    <IconFileImageOutline v-else
+      class="min-w-5 min-h-5 text-lightSidebarIcons dark:text-darkSidebarIcons group-hover:text-lightSidebarIconsHover dark:group-hover:text-darkSidebarIconsHover transition-all duration-200 ease-in-out"
+    />
     <div 
       class="overflow-hidden block ms-3 pr-4 text-left rtl:text-right transition-all duration-200 ease-in-out"
       :class="{
@@ -57,6 +60,7 @@ import { getIcon } from '@/utils';
 import { Tooltip } from '@/afcl';
 import { ref, watch, computed } from 'vue';
 import { useCoreStore } from '@/stores/core';
+import { IconFileImageOutline } from '@iconify-prerendered/vue-flowbite';
 
 const props = defineProps(['item', 'isChild', 'isSidebarIconOnly', 'isSidebarHovering']);
 

adminforth/types/Back.ts

@@ -737,45 +737,143 @@ export type DeleteResourceRecordResult = {
  * Return ok: false and error: string to stop execution and show error message to user. Return ok: true to continue execution.
  */
 export type BeforeDeleteSaveFunction = (params: {
+  /**
+   * Resource info.
+   */
   resource: AdminForthResource, 
+  /**
+   * Primary key value of the record to delete.
+   */
   recordId: any, 
-  adminUser: AdminUser, 
+  /**
+   * Admin user performing the action.
+   */
+  adminUser: AdminUser,
+  /**
+   * Record data before deletion.
+   */
   record: any, 
+  /**
+   * Adminforth instance.
+   */
   adminforth: IAdminForth,
+  /**
+   * HTTP response object.
+   *
+   * @deprecated Since 1.2.9. Will be removed in 2.0.0. Use extra.response instead.
+   */
   response?: IAdminForthHttpResponse,
+  /**
+   * Extra HTTP information. Prefer using extra.response over the top-level response field.
+   */
   extra?: HttpExtra,
 }) => Promise<{ok: boolean, error?: string}>;
 
 
 export type BeforeEditSaveFunction = (params: {
+    /**
+   * Resource info.
+   */
   resource: AdminForthResource, 
+    /**
+   * Primary key value of the record to delete.
+   */
   recordId: any, 
+    /**
+   * Admin user performing the action.
+   */
   adminUser: AdminUser, 
+  /*
+  * Fields to update in record.
+  */
   updates: any,
+  /** 
+  * Record with updates
+  *
+  *  @deprecated. Will be removed in 2.0.0. Use updates instead.
+  */
   record: any, // legacy, 'updates' should be used instead
+  /**
+   * Record data before update.
+   */
   oldRecord: any,
+  /**
+   * Adminforth instance.
+   */
   adminforth: IAdminForth,
+    /**
+   * HTTP response object.
+   *
+   * @deprecated Since 1.2.9. Will be removed in 2.0.0. Use extra.response instead.
+   */
   response: IAdminForthHttpResponse,
+    /**
+   * Extra HTTP information. Prefer using extra.response over the top-level response field.
+   */
   extra?: HttpExtra,
 }) => Promise<{ok: boolean, error?: string | null}>;
 
 export type BeforeCreateSaveFunction = (params: {
+  /**
+   * Resource info.
+   */
   resource: AdminForthResource, 
+  /**
+   * Admin user performing the action.
+   */
   adminUser: AdminUser, 
+  /**
+  * Record data to create.
+  */
   record: any, 
+  /**
+   * Adminforth instance.
+   */
   adminforth: IAdminForth,
+  /**
+   * HTTP response object.
+   *
+   * @deprecated Since 1.2.9. Will be removed in 2.0.0. Use extra.response instead.
+   */
   response: IAdminForthHttpResponse,
+
   extra?: HttpExtra,
 }) => Promise<{ok: boolean, error?: string | null, newRecordId?: string}>;
 
 export type AfterCreateSaveFunction = (params: {
+    /**
+   * Resource info.
+   */
   resource: AdminForthResource, 
+    /**
+   * Primary key value of the record to delete.
+   */
   recordId: any, 
+    /**
+   * Admin user performing the action.
+   */
   adminUser: AdminUser, 
+  /**
+   * Record data after creation.
+   */
   record: any, 
+    /**
+   * Adminforth instance.
+   */
   adminforth: IAdminForth,
+  /**
+   * Record with virtual columns after creation.
+   */
   recordWithVirtualColumns?: any,
+  /**
+   * HTTP response object.
+   *
+   * @deprecated Since 1.2.9. Will be removed in 2.0.0. Use extra.response instead.
+   */
   response: IAdminForthHttpResponse,
+    /**
+   * Extra HTTP information. Prefer using extra.response over the top-level response field.
+   */
   extra?: HttpExtra,
 }) => Promise<{ok: boolean, error?: string}>;
 
@@ -784,36 +882,107 @@ export type AfterCreateSaveFunction = (params: {
  * Return ok: false and error: string to stop execution and show error message to user. Return ok: true to continue execution.
  */
 export type AfterDeleteSaveFunction = (params: {
+    /**
+   * Resource info.
+   */
   resource: AdminForthResource, 
+    /**
+   * Primary key value of the record to delete.
+   */
   recordId: any, 
+    /**
+   * Admin user performing the action.
+   */
   adminUser: AdminUser, 
+  /**
+   * Record data, that was deleted.
+   */
   record: any, 
+  /**
+   * Adminforth instance.
+   */
   adminforth: IAdminForth,
+  /**
+   * HTTP response object.
+   *
+   * @deprecated Since 1.2.9. Will be removed in 2.0.0. Use extra.response instead.
+   */
   response: IAdminForthHttpResponse,
+    /**
+   * Extra HTTP information. Prefer using extra.response over the top-level response field.
+   */
   extra?: HttpExtra,
 }) => Promise<{ok: boolean, error?: string}>;
 
 
 export type AfterEditSaveFunction = (params: {
+    /**
+   * Resource info.
+   */
   resource: AdminForthResource, 
+    /**
+   * Primary key value of the record to delete.
+   */
   recordId: any, 
+    /**
+   * Admin user performing the action.
+   */
   adminUser: AdminUser,
+  /**
+  * Record updates.
+  */
   updates: any, 
+  /** 
+  * Record after update.
+  *
+  *  @deprecated. Will be removed in 2.0.0. Use updates instead.
+  */
   record: any, // legacy, 'updates' should be used instead 
+  /**
+   * Record data before update.
+   */
   oldRecord: any,
+  /**
+   * Adminforth instance.
+   */
   adminforth: IAdminForth,
+  /**
+   * HTTP response object.
+   *
+   * @deprecated Since 1.2.9. Will be removed in 2.0.0. Use extra.response instead.
+   */
   response: IAdminForthHttpResponse,
+    /**
+   * Extra HTTP information. Prefer using extra.response over the top-level response field.
+   */
   extra?: HttpExtra,
 }) => Promise<{ok: boolean, error?: string}>;
 
 /**
  * Allow to get user data before login confirmation, will triger when user try to login.
  */
 export type BeforeLoginConfirmationFunction = (params?: { 
+    /**
+   * Admin user performing the action.
+   */
     adminUser: AdminUser,
+    /**
+     * HTTP response object.
+     *
+     * @deprecated Since 1.2.9. Will be removed in 2.0.0. Use extra.response instead.
+     */
     response: IAdminForthHttpResponse,
+    /**
+     * Adminforth instance.
+     */
     adminforth: IAdminForth,
+      /**
+     * Extra HTTP information. Prefer using extra.response over the top-level response field.
+     */
     extra?: HttpExtra,
+      /**
+     * Duration of session in format "1s", "1m", "1h", or "1d" (e.g., "30d" for 30 days)
+     */
     sessionDuration?: string,
 }) => Promise<{
   error?: string, 
@@ -827,9 +996,23 @@ export type BeforeLoginConfirmationFunction = (params?: {
  * Allow to make extra authorization
  */
 export type AdminUserAuthorizeFunction = ((params?: { 
+    /**
+   * Admin user performing the action.
+   */
     adminUser: AdminUser,
+      /**
+     * HTTP response object.
+     *
+     * @deprecated Since 1.2.9. Will be removed in 2.0.0. Use extra.response instead.
+     */
     response: IAdminForthHttpResponse,
+    /**
+     * Adminforth instance.
+     */
     adminforth: IAdminForth,
+      /**
+     * Extra HTTP information. Prefer using extra.response over the top-level response field.
+     */
     extra?: HttpExtra,
 }) => Promise<{
   error?: string,

dev-demo/resources/carsResourseTemplate.ts

@@ -247,13 +247,19 @@ export default function carsResourseTemplate(resourceId: string, dataSource: str
                   `${dataSource}/car_images/cars_promo_images_generated/${originalFilename}_${Date.now()}.${originalExtension}`,
             preview: {
               maxShowWidth: "300px",
+              previewUrl({ filePath }) {
+                return `https://tmpbucket-adminforth.s3.eu-central-1.amazonaws.com/${filePath}`;
+              },
             },
             generation: {
               countToGenerate: 2,
               adapter: new ImageGenerationAdapterOpenAI({
                 openAiApiKey: process.env.OPENAI_API_KEY as string,
                 model: 'gpt-image-1', 
               }),
+              attachFiles: async ({ record }) => {
+                return [`https://tmpbucket-adminforth.s3.eu-central-1.amazonaws.com/${record.promo_picture}`];
+              },
               generationPrompt: "Generate a high-quality promotional image for a car with model {{model}} and color {{color}}. The car is a {{body_type}} type. The image should be vibrant and eye-catching, suitable for advertising purposes.",
               outputSize: '1536x1024'
             }