feat: When uploading, include record information (#478)

* feat: When uploading, include record information, such as the resource ID * add changeset * modify docs --------- Co-authored-by: Colin Regourd <[email protected]>
premieroctet · Nov 18, 2024 · 9959cfd · 9959cfd
1 parent 46a3dba
commit 9959cfd
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 6 deletions.
diff --git a/.changeset/rich-dodos-repair.md b/.changeset/rich-dodos-repair.md
@@ -0,0 +1,5 @@
+---
+"@premieroctet/next-admin": patch
+---
+
+When uploading, include record information - Thanks to [@huinalam](https://github.com/huinalam)
diff --git a/apps/docs/pages/docs/api/model-configuration.mdx b/apps/docs/pages/docs/api/model-configuration.mdx
@@ -448,8 +448,10 @@ When you define a field, use the field's name as the key and the following objec
           an async function that is used only for formats <code>file</code> and{" "}
           <code>data-url</code>. It takes a Buffer object and an information
           object containing <code>name</code> and <code>type</code> properties
-          as parameters and must return a string. It can be useful to upload a
-          file to a remote provider
+          as parameters and must return a string. It has <code>context</code> as
+          a parameter, which holds record information such as the resource ID,
+          which does not exist during record creation. It can be useful to
+          upload a file to a remote provider
         </>
       ),
     },

diff --git a/apps/example/options.tsx b/apps/example/options.tsx
@@ -133,7 +133,7 @@ export const options: NextAdminOptions = {
                * for example you can upload the file to an S3 bucket.
                * Make sure to return a string.
                */
-              upload: async (buffer, infos) => {
+              upload: async (buffer, infos, context) => {
                 return "https://raw.githubusercontent.com/premieroctet/next-admin/33fcd755a34f1ec5ad53ca8e293029528af814ca/apps/example/public/assets/logo.svg";
               },
             },

diff --git a/apps/example/pageRouterOptions.tsx b/apps/example/pageRouterOptions.tsx
@@ -84,7 +84,7 @@ export const options: NextAdminOptions = {
                * for example you can upload the file to an S3 bucket.
                * Make sure to return a string.
                */
-              upload: async (buffer, infos) => {
+              upload: async (buffer, infos, context) => {
                 return "https://raw.githubusercontent.com/premieroctet/next-admin/33fcd755a34f1ec5ad53ca8e293029528af814ca/apps/example/public/assets/logo.svg";
               },
             },

diff --git a/packages/next-admin/src/types.ts b/packages/next-admin/src/types.ts
@@ -317,14 +317,22 @@ export type Handler<
   get?: (input: T) => any;
   /**
    * an async function that is used only for formats `file` and `data-url`. It takes a buffer as parameter and must return a string. Useful to upload a file to a remote provider.
-   * @param file
+   * @param buffer
+   * @param infos
+   * @param context - This object contains record information, such as the resource ID.
    * @returns
    */
   upload?: (
     buffer: Buffer,
     infos: {
       name: string;
       type: string | null;
+    },
+    context: {
+      /**
+       * the resource ID if it exists, otherwise undefined
+      */
+      resourceId: string | number | undefined;
     }
   ) => Promise<string>;
   /**

diff --git a/packages/next-admin/src/utils/server.ts b/packages/next-admin/src/utils/server.ts
@@ -943,7 +943,10 @@ export const formattedFormData = async <M extends ModelName>(
             } else {
               try {
                 const uploadResult = await uploadHandler(
-                  ...(formData[propertyName] as unknown as UploadParameters)
+                  ...(formData[propertyName] as unknown as UploadParameters),
+                  {
+                    resourceId,
+                  }
                 );
                 if (typeof uploadResult !== "string") {
                   console.warn(