Feature/moments file upload progress (#41)

* Add on file progress update callbacks

* bump package versions

* Fix comments

packages/drops/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@poap-xyz/drops",
-  "version": "0.0.26",
+  "version": "0.0.27",
   "description": "Drops module for the poap.js library",
   "main": "dist/cjs/index.cjs",
   "module": "dist/esm/index.mjs",
@@ -29,7 +29,7 @@
     "rollup": "^3.20.2"
   },
   "peerDependencies": {
-    "@poap-xyz/providers": "0.0.26",
-    "@poap-xyz/utils": "0.0.26"
+    "@poap-xyz/providers": "0.0.27",
+    "@poap-xyz/utils": "0.0.27"
   }
 }

packages/moments/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@poap-xyz/moments",
-  "version": "0.0.26",
+  "version": "0.0.27",
   "description": "Moments module for the poap.js library",
   "main": "dist/cjs/index.cjs",
   "module": "dist/esm/index.mjs",
@@ -29,6 +29,6 @@
     "rollup": "^3.20.2"
   },
   "peerDependencies": {
-    "@poap-xyz/providers": "0.0.26"
+    "@poap-xyz/providers": "0.0.27"
   }
 }

packages/moments/src/client/MomentsClient.ts

@@ -31,7 +31,12 @@ export class MomentsClient {
     void onStepUpdate(CreateSteps.REQUESTING_MEDIA_UPLOAD_URL);
     const { url, key } = await this.poapMomentsApi.getSignedUrl();
     void onStepUpdate(CreateSteps.UPLOADING_MEDIA);
-    await this.poapMomentsApi.uploadFile(input.file, url, input.fileType);
+    await this.poapMomentsApi.uploadFile(
+      input.file,
+      url,
+      input.fileType,
+      input.onFileUploadProgress,
+    );
     void onStepUpdate(CreateSteps.UPLOADING_MEDIA_METADATA);
     //  we will be adding metadata to the media in the future
     void onStepUpdate(CreateSteps.PROCESSING_MEDIA);

packages/moments/src/client/dtos/create/CreateInput.ts

@@ -9,6 +9,8 @@ import { CreateSteps } from './CreateSteps';
  * @property {string} author - The author of the moment.
  * @property {string} timeOut - The amount of time to wait until media is processed.
  * @property {string} fileType - The type of the file.
+ * @property {(step: CreateSteps) => void | Promise<void>} [onStepUpdate] - Optional callback function to be called when the step changes.
+ * @property {(progress: number) => void | Promise<void>} [onFileProgress] - Optional callback function to be called when the file upload progress change - progress is a number between 0 and 1.
  */
 export interface CreateMomentInput {
   dropId: number;
@@ -18,4 +20,5 @@ export interface CreateMomentInput {
   timeOut?: number;
   fileType: string;
   onStepUpdate?: (step: CreateSteps) => void | Promise<void>;
+  onFileUploadProgress?: (progress: number) => void | Promise<void>;
 }

packages/poaps/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@poap-xyz/poaps",
-  "version": "0.0.26",
+  "version": "0.0.27",
   "description": "Poaps module for the poap.js library",
   "main": "dist/cjs/index.cjs",
   "module": "dist/esm/index.mjs",
@@ -29,7 +29,7 @@
     "rollup": "^3.20.2"
   },
   "peerDependencies": {
-    "@poap-xyz/providers": "0.0.26",
-    "@poap-xyz/utils": "0.0.26"
+    "@poap-xyz/providers": "0.0.27",
+    "@poap-xyz/utils": "0.0.27"
   }
 }

packages/providers/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@poap-xyz/providers",
-  "version": "0.0.26",
+  "version": "0.0.27",
   "description": "Providers module for the poap.js library",
   "main": "dist/cjs/index.cjs",
   "module": "dist/esm/index.mjs",
@@ -26,7 +26,6 @@
   },
   "devDependencies": {
     "axios-mock-adapter": "^1.21.4",
-    "jest-mock-extended": "^3.0.4",
     "rollup": "^3.20.2"
   },
   "peerDependencies": {

packages/providers/src/core/PoapMomentsApi/PoapMomentsApi.ts

@@ -53,17 +53,24 @@ export class PoapMomentsApi implements MomentsApiProvider {
    * @param {Buffer} file - The file to be uploaded as a Buffer
    * @param {string} fileType - The file type
    * @param {string} signedUrl - The signed URL for uploading the file
+   * @param {(progress: number) => void} [onProgress] - Optional callback function to be called when the upload progress changes - progress is a number between 0 and 1
    * @returns {Promise<void>} - A Promise that resolves when the file has been uploaded
    */
   public async uploadFile(
     file: Buffer,
     signedUrl: string,
     fileType: string,
+    onProgress?: (progress: number) => void,
   ): Promise<void> {
     await axios.put(signedUrl, file, {
       headers: {
         'Content-Type': fileType,
       },
+      onUploadProgress: (progressEvent) => {
+        if (onProgress) {
+          onProgress(progressEvent.progress || 0);
+        }
+      },
     });
   }
 

packages/providers/src/index.ts

@@ -1,4 +1,5 @@
 export { InvalidMediaFileError } from './core/PoapMomentsApi/errors/InvalidMediaFileError';
 export { DropResponse } from './ports/DropApiProvider/Types/response';
+export { AuthenticationProvider } from './ports/AuthenticationProvider/AuthenticationProvider';
 export * from './ports';
 export * from './core';

packages/utils/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@poap-xyz/utils",
-  "version": "0.0.26",
+  "version": "0.0.27",
   "description": "Utils module for the poap.js library",
   "type": "module",
   "main": "dist/cjs/index.cjs",

yarn.lock

@@ -872,8 +872,8 @@ __metadata:
   dependencies:
     rollup: ^3.20.2
   peerDependencies:
-    "@poap-xyz/providers": 0.0.26
-    "@poap-xyz/utils": 0.0.26
+    "@poap-xyz/providers": 0.0.27
+    "@poap-xyz/utils": 0.0.27
   languageName: unknown
   linkType: soft
 
@@ -883,7 +883,7 @@ __metadata:
   dependencies:
     rollup: ^3.20.2
   peerDependencies:
-    "@poap-xyz/providers": 0.0.26
+    "@poap-xyz/providers": 0.0.27
   languageName: unknown
   linkType: soft
 
@@ -893,8 +893,8 @@ __metadata:
   dependencies:
     rollup: ^3.20.2
   peerDependencies:
-    "@poap-xyz/providers": 0.0.26
-    "@poap-xyz/utils": 0.0.26
+    "@poap-xyz/providers": 0.0.27
+    "@poap-xyz/utils": 0.0.27
   languageName: unknown
   linkType: soft
 
@@ -903,7 +903,6 @@ __metadata:
   resolution: "@poap-xyz/providers@workspace:packages/providers"
   dependencies:
     axios-mock-adapter: ^1.21.4
-    jest-mock-extended: ^3.0.4
     rollup: ^3.20.2
   peerDependencies:
     axios: ^1.3.5