Merge pull request #547 from uploadcare/feat/metadata-callback-argument

Feat/metadata-callback-argument
uploadcare · Oct 27, 2023 · 8f448c5 · 8f448c5
2 parents 542dd9c + 9a79bf6
commit 8f448c5
Show file tree

Hide file tree

Showing 4 changed files with 47 additions and 40 deletions.
diff --git a/abstract/UploaderBlock.js b/abstract/UploaderBlock.js
@@ -607,18 +607,22 @@ export class UploaderBlock extends ActivityBlock {
     }
   }
 
-  /** @private */
-  async getMetadata() {
+  /**
+   * @param {string} entryId
+   * @protected
+   */
+  async getMetadataFor(entryId) {
     const configValue = this.cfg.metadata ?? /** @type {import('../types').Metadata} */ (this.$['*uploadMetadata']);
     if (typeof configValue === 'function') {
-      const metadata = await configValue();
+      const outputFileEntry = this.getOutputItem(entryId);
+      const metadata = await configValue(outputFileEntry);
       return metadata;
     }
     return configValue;
   }
 
-  /** @returns {Promise<import('@uploadcare/upload-client').FileFromOptions>} */
-  async getUploadClientOptions() {
+  /** @returns {import('@uploadcare/upload-client').FileFromOptions} */
+  getUploadClientOptions() {
     let options = {
       store: this.cfg.store,
       publicKey: this.cfg.pubkey,
@@ -635,48 +639,49 @@ export class UploaderBlock extends ActivityBlock {
       multipartMaxAttempts: this.cfg.multipartMaxAttempts,
       checkForUrlDuplicates: !!this.cfg.checkForUrlDuplicates,
       saveUrlForRecurrentUploads: !!this.cfg.saveUrlForRecurrentUploads,
-      metadata: await this.getMetadata(),
     };
 
-    console.log('Upload client options:', options);
-
     return options;
   }
 
+  /**
+   * @param {string} entryId
+   * @returns {import('../types/exported.js').OutputFileEntry}
+   */
+  getOutputItem(entryId) {
+    const uploadEntryData = Data.getCtx(entryId).store;
+    /** @type {import('@uploadcare/upload-client').UploadcareFile} */
+    const fileInfo = uploadEntryData.fileInfo || {
+      name: uploadEntryData.fileName,
+      originalFilename: uploadEntryData.fileName,
+      size: uploadEntryData.fileSize,
+      isImage: uploadEntryData.isImage,
+      mimeType: uploadEntryData.mimeType,
+    };
+    /** @type {import('../types/exported.js').OutputFileEntry} */
+    const outputItem = {
+      ...fileInfo,
+      file: uploadEntryData.file,
+      externalUrl: uploadEntryData.externalUrl,
+      cdnUrlModifiers: uploadEntryData.cdnUrlModifiers,
+      cdnUrl: uploadEntryData.cdnUrl ?? fileInfo.cdnUrl ?? null,
+      validationErrorMessage: uploadEntryData.validationErrorMsg,
+      uploadError: uploadEntryData.uploadError,
+      isUploaded: !!uploadEntryData.uuid && !!uploadEntryData.fileInfo,
+      isValid: !uploadEntryData.validationErrorMsg && !uploadEntryData.uploadError,
+      fullPath: uploadEntryData.fullPath,
+      uploadProgress: uploadEntryData.uploadProgress,
+    };
+    return outputItem;
+  }
+
   /**
    * @param {(item: import('./TypedData.js').TypedData) => Boolean} [checkFn]
    * @returns {import('../types/exported.js').OutputFileEntry[]}
    */
   getOutputData(checkFn) {
-    // @ts-ignore TODO: fix this
-    let data = [];
-    let items = checkFn ? this.uploadCollection.findItems(checkFn) : this.uploadCollection.items();
-    items.forEach((itemId) => {
-      let uploadEntryData = Data.getCtx(itemId).store;
-      /** @type {import('@uploadcare/upload-client').UploadcareFile} */
-      let fileInfo = uploadEntryData.fileInfo || {
-        name: uploadEntryData.fileName,
-        originalFilename: uploadEntryData.fileName,
-        size: uploadEntryData.fileSize,
-        isImage: uploadEntryData.isImage,
-        mimeType: uploadEntryData.mimeType,
-      };
-      /** @type {import('../types/exported.js').OutputFileEntry} */
-      let outputItem = {
-        ...fileInfo,
-        file: uploadEntryData.file,
-        externalUrl: uploadEntryData.externalUrl,
-        cdnUrlModifiers: uploadEntryData.cdnUrlModifiers,
-        cdnUrl: uploadEntryData.cdnUrl ?? fileInfo.cdnUrl ?? null,
-        uploadProgress: uploadEntryData.uploadProgress,
-        validationErrorMessage: uploadEntryData.validationErrorMsg,
-        uploadError: uploadEntryData.uploadError,
-        isUploaded: !!uploadEntryData.uuid && !!uploadEntryData.fileInfo && !uploadEntryData.uploadError,
-        isValid: !uploadEntryData.validationErrorMsg && !uploadEntryData.uploadError,
-      };
-      data.push(outputItem);
-    });
-    // @ts-ignore TODO: fix this
+    const entriesIds = checkFn ? this.uploadCollection.findItems(checkFn) : this.uploadCollection.items();
+    const data = entriesIds.map((itemId) => this.getOutputItem(itemId));
     return data;
   }
 }

diff --git a/blocks/DataOutput/DataOutput.js b/blocks/DataOutput/DataOutput.js
@@ -130,7 +130,7 @@ export class DataOutput extends UploaderBlock {
             return;
           }
 
-          const uploadClientOptions = await this.getUploadClientOptions();
+          const uploadClientOptions = this.getUploadClientOptions();
           const uuidList = data.map((fileDesc) => {
             return fileDesc.uuid + (fileDesc.cdnUrlModifiers ? `/${fileDesc.cdnUrlModifiers}` : '');
           });

diff --git a/blocks/FileItem/FileItem.js b/blocks/FileItem/FileItem.js
@@ -392,7 +392,7 @@ export class FileItem extends UploaderBlock {
       entry.setValue('abortController', abortController);
 
       const uploadTask = async () => {
-        const uploadClientOptions = await this.getUploadClientOptions();
+        const uploadClientOptions = this.getUploadClientOptions();
         return uploadFile(entry.getValue('file') || entry.getValue('externalUrl') || entry.getValue('uuid'), {
           ...uploadClientOptions,
           fileName: entry.getValue('fileName'),
@@ -405,6 +405,7 @@ export class FileItem extends UploaderBlock {
             this.$.progressUnknown = !progress.isComputable;
           },
           signal: abortController.signal,
+          metadata: await this.getMetadataFor(entry.uid),
         });
       };
 

diff --git a/types/exported.d.ts b/types/exported.d.ts
@@ -1,7 +1,7 @@
 import { UploadcareFile } from '@uploadcare/upload-client';
 
 export type Metadata = import('@uploadcare/upload-client').Metadata;
-export type MetadataCallback = () => Promise<Metadata>;
+export type MetadataCallback = (fileEntry: OutputFileEntry) => Promise<Metadata> | Metadata;
 export type ConfigType = {
   pubkey: string;
   multiple: boolean;
@@ -68,6 +68,7 @@ export type OutputFileEntry = Pick<UploadcareFile, requiredFileInfoFields> &
     externalUrl: string | null;
     isValid: boolean;
     isUploaded: boolean;
+    fullPath: string | null;
     uploadProgress: number;
   };