@capgo/capacitor-uploader 0.0.1 → 0.0.4

package/README.md

@@ -8,7 +8,7 @@
 
 This plugin provides a flexible way to upload natively files to various servers, including S3 with presigned URLs.
 
-WIP: this is a work in progress still not ready for use
+Can be used in combination with the [Capacitor Camera preview](https://github.com/Cap-go/camera-preview) To upload file in reliable manner instead of reading them in buffer of webview and then upload in JS.
 
 ## Install
 
@@ -138,16 +138,16 @@ uploadToCustomServer(filePath, serverUrl);
 ### startUpload(...)
 
 ```typescript
-startUpload(options: uploadOption) => any
+startUpload(options: uploadOption) => Promise<{ id: string; }>
 ```
 
-| Param         | Type                                                  |
-| ------------- | ----------------------------------------------------- |
-| **`options`** | <code><a href="#uploadoption">uploadOption</a></code> |
+| Param         | Type                                                  | Description                              |
+| ------------- | ----------------------------------------------------- | ---------------------------------------- |
+| **`options`** | <code><a href="#uploadoption">uploadOption</a></code> | <a href="#uploadoption">uploadOption</a> |
 
-**Returns:** <code>any</code>
+**Returns:** <code>Promise&lt;{ id: string; }&gt;</code>
 
-**Since:** 1.0.0
+**Since:** 0.0.1
 
 --------------------
 
@@ -155,16 +155,14 @@ startUpload(options: uploadOption) => any
 ### removeUpload(...)
 
 ```typescript
-removeUpload(options: { id: string; }) => any
+removeUpload(options: { id: string; }) => Promise<void>
 ```
 
 | Param         | Type                         |
 | ------------- | ---------------------------- |
 | **`options`** | <code>{ id: string; }</code> |
 
-**Returns:** <code>any</code>
-
-**Since:** 1.0.0
+**Since:** 0.0.1
 
 --------------------
 
@@ -172,7 +170,7 @@ removeUpload(options: { id: string; }) => any
 ### addListener('events', ...)
 
 ```typescript
-addListener(eventName: 'events', listenerFunc: (state: UploadEvent) => void) => any
+addListener(eventName: "events", listenerFunc: (state: UploadEvent) => void) => Promise<PluginListenerHandle>
 ```
 
 | Param              | Type                                                                    |
@@ -180,9 +178,9 @@ addListener(eventName: 'events', listenerFunc: (state: UploadEvent) => void) =>
 | **`eventName`**    | <code>'events'</code>                                                   |
 | **`listenerFunc`** | <code>(state: <a href="#uploadevent">UploadEvent</a>) =&gt; void</code> |
 
-**Returns:** <code>any</code>
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
 
-**Since:** 1.0.0
+**Since:** 0.0.1
 
 --------------------
 
@@ -194,30 +192,30 @@ addListener(eventName: 'events', listenerFunc: (state: UploadEvent) => void) =>
 
 | Prop                    | Type                                    | Default                  | Since |
 | ----------------------- | --------------------------------------- | ------------------------ | ----- |
-| **`filePath`**          | <code>string</code>                     |                          | 1.0.0 |
-| **`serverUrl`**         | <code>string</code>                     |                          | 1.0.0 |
-| **`notificationTitle`** | <code>number</code>                     | <code>'Uploading'</code> | 1.0.0 |
-| **`headers`**           | <code>{ [key: string]: string; }</code> |                          | 1.0.0 |
-| **`method`**            | <code>'PUT' \| 'POST'</code>            | <code>'POST'</code>      | 1.0.0 |
-| **`mimeType`**          | <code>string</code>                     |                          | 1.0.0 |
-| **`parameters`**        | <code>{ [key: string]: string; }</code> |                          | 1.0.0 |
-| **`maxRetries`**        | <code>number</code>                     |                          | 1.0.0 |
+| **`filePath`**          | <code>string</code>                     |                          | 0.0.1 |
+| **`serverUrl`**         | <code>string</code>                     |                          | 0.0.1 |
+| **`notificationTitle`** | <code>number</code>                     | <code>'Uploading'</code> | 0.0.1 |
+| **`headers`**           | <code>{ [key: string]: string; }</code> |                          | 0.0.1 |
+| **`method`**            | <code>'PUT' \| 'POST'</code>            | <code>'POST'</code>      | 0.0.1 |
+| **`mimeType`**          | <code>string</code>                     |                          | 0.0.1 |
+| **`parameters`**        | <code>{ [key: string]: string; }</code> |                          | 0.0.1 |
+| **`maxRetries`**        | <code>number</code>                     |                          | 0.0.1 |
 
 
-#### UploadEvent
+#### PluginListenerHandle
 
-| Prop          | Type                                                                    | Description                                  | Since |
-| ------------- | ----------------------------------------------------------------------- | -------------------------------------------- | ----- |
-| **`name`**    | <code>'uploading' \| 'completed' \| 'failed'</code>                     | Current status of upload, between 0 and 100. |       |
-| **`payload`** | <code>{ percent?: number; error?: string; statusCode?: number; }</code> |                                              | 1.0.0 |
-| **`id`**      | <code>string</code>                                                     |                                              | 1.0.0 |
+| Prop         | Type                                      |
+| ------------ | ----------------------------------------- |
+| **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |
 
 
-#### PluginListenerHandle
+#### UploadEvent
 
-| Prop         | Type                      |
-| ------------ | ------------------------- |
-| **`remove`** | <code>() =&gt; any</code> |
+| Prop          | Type                                                                    | Description                                  | Default                                               | Since |
+| ------------- | ----------------------------------------------------------------------- | -------------------------------------------- | ----------------------------------------------------- | ----- |
+| **`name`**    | <code>'uploading' \| 'completed' \| 'failed'</code>                     | Current status of upload, between 0 and 100. |                                                       | 0.0.1 |
+| **`payload`** | <code>{ percent?: number; error?: string; statusCode?: number; }</code> |                                              | <code>{ percent: 0, error: '', statusCode: 0 }</code> | 0.0.1 |
+| **`id`**      | <code>string</code>                                                     |                                              |                                                       | 0.0.1 |
 
 </docgen-api>
 

package/android/src/main/java/ee/forgr/capacitor/uploader/Uploader.java

@@ -2,122 +2,157 @@ package ee.forgr.capacitor.uploader;
 
 import android.app.Application;
 import android.content.Context;
+import android.database.Cursor;
 import android.net.Uri;
 import android.provider.OpenableColumns;
-import android.database.Cursor;
-
+import java.util.Map;
 import net.gotev.uploadservice.UploadServiceConfig;
 import net.gotev.uploadservice.data.UploadNotificationConfig;
 import net.gotev.uploadservice.data.UploadNotificationStatusConfig;
-import net.gotev.uploadservice.protocols.multipart.MultipartUploadRequest;
 import net.gotev.uploadservice.observer.request.RequestObserverDelegate;
-
-import java.util.Map;
+import net.gotev.uploadservice.protocols.multipart.MultipartUploadRequest;
 
 public class Uploader {
 
-    private final Context context;
-    private final RequestObserverDelegate delegate;
-
-    public Uploader(Context context, RequestObserverDelegate delegate) {
-        this.context = context;
-        this.delegate = delegate;
-        initializeUploadService(context);
+  private final Context context;
+  private final RequestObserverDelegate delegate;
+
+  public Uploader(Context context, RequestObserverDelegate delegate) {
+    this.context = context;
+    this.delegate = delegate;
+    initializeUploadService(context);
+  }
+
+  private void initializeUploadService(Context context) {
+    Application application = getApplication(context);
+    if (application != null) {
+      UploadServiceConfig.initialize(
+        application,
+        "ee.forgr.capacitor.uploader.notification_channel_id",
+        true
+      );
+    } else {
+      throw new IllegalStateException("Unable to get Application instance");
     }
-
-    private void initializeUploadService(Context context) {
-        Application application = getApplication(context);
-        if (application != null) {
-            UploadServiceConfig.initialize(application, "ee.forgr.capacitor.uploader.notification_channel_id", true);
-        } else {
-            throw new IllegalStateException("Unable to get Application instance");
-        }
+  }
+
+  private Application getApplication(Context context) {
+    if (context == null) {
+      return null;
+    } else if (context instanceof Application) {
+      return (Application) context;
+    } else {
+      return getApplication(context.getApplicationContext());
     }
-
-    private Application getApplication(Context context) {
-        if (context == null) {
-            return null;
-        } else if (context instanceof Application) {
-            return (Application) context;
-        } else {
-            return getApplication(context.getApplicationContext());
-        }
+  }
+
+  public String startUpload(
+    String filePath,
+    String serverUrl,
+    Map<String, String> headers,
+    Map<String, String> parameters,
+    String httpMethod,
+    String notificationTitle,
+    int maxRetries,
+    String mimeType
+  ) throws Exception {
+    UploadNotificationConfig notificationConfig = createNotificationConfig(
+      notificationTitle
+    );
+
+    MultipartUploadRequest request = new MultipartUploadRequest(
+      context,
+      serverUrl
+    )
+      .setMethod(httpMethod)
+      .addFileToUpload(filePath, "file", mimeType) // Updated this line
+      .setNotificationConfig((ctx, uploadId) -> notificationConfig)
+      .setMaxRetries(maxRetries);
+
+    // Add headers
+    for (Map.Entry<String, String> entry : headers.entrySet()) {
+      request.addHeader(entry.getKey(), entry.getValue());
     }
 
-    public String startUpload(String filePath, String serverUrl, Map<String, String> headers, Map<String, String> parameters, 
-                            String httpMethod, String notificationTitle, int maxRetries, String mimeType) throws Exception {
-        UploadNotificationConfig notificationConfig = createNotificationConfig(notificationTitle);
-
-        MultipartUploadRequest request = new MultipartUploadRequest(context, serverUrl)
-            .setMethod(httpMethod)
-            .addFileToUpload(filePath, "file", mimeType) // Updated this line
-            .setNotificationConfig((ctx, uploadId) -> notificationConfig)
-            .setMaxRetries(maxRetries);
-
-        // Add headers
-        for (Map.Entry<String, String> entry : headers.entrySet()) {
-            request.addHeader(entry.getKey(), entry.getValue());
-        }
-
-        // Add parameters
-        for (Map.Entry<String, String> entry : parameters.entrySet()) {
-            request.addParameter(entry.getKey(), entry.getValue());
-        }
-
-        // Set file name if it's a content URI
-        if (filePath.startsWith("content://")) {
-            Uri uri = Uri.parse(filePath);
-            String fileName = getFileNameFromUri(uri);
-            if (fileName != null) {
-                request.addParameter("filename", fileName);
-            }
-        }
-
-        // Start the upload
-        return request.startUpload();
-    }
-
-    public void removeUpload(String uploadId) {
-        net.gotev.uploadservice.UploadService.stopUpload(uploadId);
+    // Add parameters
+    for (Map.Entry<String, String> entry : parameters.entrySet()) {
+      request.addParameter(entry.getKey(), entry.getValue());
     }
 
-    private UploadNotificationConfig createNotificationConfig(String notificationTitle) {
-        UploadNotificationStatusConfig progress = new UploadNotificationStatusConfig(notificationTitle, notificationTitle + " - In Progress");
-        UploadNotificationStatusConfig success = new UploadNotificationStatusConfig(notificationTitle, notificationTitle + " - Completed");
-        UploadNotificationStatusConfig error = new UploadNotificationStatusConfig(notificationTitle, notificationTitle + " - Error");
-        UploadNotificationStatusConfig cancelled = new UploadNotificationStatusConfig(notificationTitle, notificationTitle + " - Cancelled");
-
-        return new UploadNotificationConfig(
-            "ee.forgr.capacitor.uploader.notification_channel_id",
-            false,
-            progress,
-            success,
-            error,
-            cancelled
-        );
+    // Set file name if it's a content URI
+    if (filePath.startsWith("content://")) {
+      Uri uri = Uri.parse(filePath);
+      String fileName = getFileNameFromUri(uri);
+      if (fileName != null) {
+        request.addParameter("filename", fileName);
+      }
     }
 
-    private String getFileNameFromUri(Uri uri) {
-        String result = null;
-        if (uri.getScheme().equals("content")) {
-            try (Cursor cursor = context.getContentResolver().query(uri, null, null, null, null)) {
-                if (cursor != null && cursor.moveToFirst()) {
-                    int index = cursor.getColumnIndex(OpenableColumns.DISPLAY_NAME);
-                    if (index != -1) {
-                        result = cursor.getString(index);
-                    }
-                }
-            } catch (Exception e) {
-                e.printStackTrace();
-            }
-        }
-        if (result == null) {
-            result = uri.getPath();
-            int cut = result.lastIndexOf('/');
-            if (cut != -1) {
-                result = result.substring(cut + 1);
-            }
+    // Start the upload
+    return request.startUpload();
+  }
+
+  public void removeUpload(String uploadId) {
+    net.gotev.uploadservice.UploadService.stopUpload(uploadId);
+  }
+
+  private UploadNotificationConfig createNotificationConfig(
+    String notificationTitle
+  ) {
+    UploadNotificationStatusConfig progress =
+      new UploadNotificationStatusConfig(
+        notificationTitle,
+        notificationTitle + " - In Progress"
+      );
+    UploadNotificationStatusConfig success = new UploadNotificationStatusConfig(
+      notificationTitle,
+      notificationTitle + " - Completed"
+    );
+    UploadNotificationStatusConfig error = new UploadNotificationStatusConfig(
+      notificationTitle,
+      notificationTitle + " - Error"
+    );
+    UploadNotificationStatusConfig cancelled =
+      new UploadNotificationStatusConfig(
+        notificationTitle,
+        notificationTitle + " - Cancelled"
+      );
+
+    return new UploadNotificationConfig(
+      "ee.forgr.capacitor.uploader.notification_channel_id",
+      false,
+      progress,
+      success,
+      error,
+      cancelled
+    );
+  }
+
+  private String getFileNameFromUri(Uri uri) {
+    String result = null;
+    if (uri.getScheme().equals("content")) {
+      try (
+        Cursor cursor = context
+          .getContentResolver()
+          .query(uri, null, null, null, null)
+      ) {
+        if (cursor != null && cursor.moveToFirst()) {
+          int index = cursor.getColumnIndex(OpenableColumns.DISPLAY_NAME);
+          if (index != -1) {
+            result = cursor.getString(index);
+          }
         }
-        return result;
+      } catch (Exception e) {
+        e.printStackTrace();
+      }
+    }
+    if (result == null) {
+      result = uri.getPath();
+      int cut = result.lastIndexOf('/');
+      if (cut != -1) {
+        result = result.substring(cut + 1);
+      }
     }
+    return result;
+  }
 }

package/android/src/main/java/ee/forgr/capacitor/uploader/UploaderPlugin.java

@@ -6,111 +6,132 @@ import com.getcapacitor.Plugin;
 import com.getcapacitor.PluginCall;
 import com.getcapacitor.PluginMethod;
 import com.getcapacitor.annotation.CapacitorPlugin;
-
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.Map;
 import net.gotev.uploadservice.data.UploadInfo;
 import net.gotev.uploadservice.network.ServerResponse;
 import net.gotev.uploadservice.observer.request.RequestObserverDelegate;
 
-import java.util.Map;
-import java.util.HashMap;
-import java.util.Iterator;
-
 @CapacitorPlugin(name = "Uploader")
 public class UploaderPlugin extends Plugin {
 
-    private Uploader implementation;
+  private Uploader implementation;
 
-    @Override
-    public void load() {
-        implementation = new Uploader(getContext(), new RequestObserverDelegate() {
-            @Override
-            public void onProgress(Context context, UploadInfo uploadInfo) {
-                JSObject event = new JSObject();
-                event.put("name", "uploading");
-                JSObject payload = new JSObject();
-                payload.put("percent", uploadInfo.getProgressPercent());
-                event.put("payload", payload);
-                event.put("id", uploadInfo.getUploadId());
-                notifyListeners("events", event);
-            }
+  @Override
+  public void load() {
+    implementation = new Uploader(
+      getContext(),
+      new RequestObserverDelegate() {
+        @Override
+        public void onProgress(Context context, UploadInfo uploadInfo) {
+          JSObject event = new JSObject();
+          event.put("name", "uploading");
+          JSObject payload = new JSObject();
+          payload.put("percent", uploadInfo.getProgressPercent());
+          event.put("payload", payload);
+          event.put("id", uploadInfo.getUploadId());
+          notifyListeners("events", event);
+        }
 
-            @Override
-            public void onSuccess(Context context, UploadInfo uploadInfo, ServerResponse serverResponse) {
-                JSObject event = new JSObject();
-                event.put("name", "completed");
-                JSObject payload = new JSObject();
-                payload.put("statusCode", serverResponse.getCode());
-                event.put("payload", payload);
-                event.put("id", uploadInfo.getUploadId());
-                notifyListeners("events", event);
-            }
+        @Override
+        public void onSuccess(
+          Context context,
+          UploadInfo uploadInfo,
+          ServerResponse serverResponse
+        ) {
+          JSObject event = new JSObject();
+          event.put("name", "completed");
+          JSObject payload = new JSObject();
+          payload.put("statusCode", serverResponse.getCode());
+          event.put("payload", payload);
+          event.put("id", uploadInfo.getUploadId());
+          notifyListeners("events", event);
+        }
 
-            @Override
-            public void onError(Context context, UploadInfo uploadInfo, Throwable exception) {
-                JSObject event = new JSObject();
-                event.put("name", "failed");
-                JSObject payload = new JSObject();
-                payload.put("error", exception.getMessage());
-                event.put("payload", payload);
-                event.put("id", uploadInfo.getUploadId());
-                notifyListeners("events", event);
-            }
+        @Override
+        public void onError(
+          Context context,
+          UploadInfo uploadInfo,
+          Throwable exception
+        ) {
+          JSObject event = new JSObject();
+          event.put("name", "failed");
+          JSObject payload = new JSObject();
+          payload.put("error", exception.getMessage());
+          event.put("payload", payload);
+          event.put("id", uploadInfo.getUploadId());
+          notifyListeners("events", event);
+        }
 
-            @Override
-            public void onCompleted(Context context, UploadInfo uploadInfo) {
-                // This method is called after onSuccess or onError
-            }
+        @Override
+        public void onCompleted(Context context, UploadInfo uploadInfo) {
+          // This method is called after onSuccess or onError
+        }
 
-            @Override
-            public void onCompletedWhileNotObserving() {
-                // This method is called when the upload completes while the observer is not registered
-            }
-        });
-    }
+        @Override
+        public void onCompletedWhileNotObserving() {
+          // This method is called when the upload completes while the observer is not registered
+        }
+      }
+    );
+  }
 
-    @PluginMethod
-    public void startUpload(PluginCall call) {
-        String filePath = call.getString("filePath");
-        String serverUrl = call.getString("serverUrl");
-        JSObject headersObj = call.getObject("headers", new JSObject());
-        JSObject parametersObj = call.getObject("parameters", new JSObject());
-        String httpMethod = call.getString("method", "POST");
-        String notificationTitle = call.getString("notificationTitle", "File Upload");
-        int maxRetries = call.getInt("maxRetries", 2);
-        String mimeType = call.getString("mimeType"); // Add this line
+  @PluginMethod
+  public void startUpload(PluginCall call) {
+    String filePath = call.getString("filePath");
+    String serverUrl = call.getString("serverUrl");
+    JSObject headersObj = call.getObject("headers", new JSObject());
+    JSObject parametersObj = call.getObject("parameters", new JSObject());
+    String httpMethod = call.getString("method", "POST");
+    String notificationTitle = call.getString(
+      "notificationTitle",
+      "File Upload"
+    );
+    int maxRetries = call.getInt("maxRetries", 2);
+    String mimeType = call.getString("mimeType"); // Add this line
 
-        Map<String, String> headers = JSObjectToMap(headersObj);
-        Map<String, String> parameters = JSObjectToMap(parametersObj);
+    Map<String, String> headers = JSObjectToMap(headersObj);
+    Map<String, String> parameters = JSObjectToMap(parametersObj);
 
-        try {
-            String id = implementation.startUpload(filePath, serverUrl, headers, parameters, httpMethod, notificationTitle, maxRetries, mimeType);
-            JSObject result = new JSObject();
-            result.put("id", id);
-            call.resolve(result);
-        } catch (Exception e) {
-            call.reject(e.getMessage());
-        }
+    try {
+      String id = implementation.startUpload(
+        filePath,
+        serverUrl,
+        headers,
+        parameters,
+        httpMethod,
+        notificationTitle,
+        maxRetries,
+        mimeType
+      );
+      JSObject result = new JSObject();
+      result.put("id", id);
+      call.resolve(result);
+    } catch (Exception e) {
+      call.reject(e.getMessage());
     }
+  }
 
-    @PluginMethod
-    public void removeUpload(PluginCall call) {
-        String id = call.getString("id");
-        try {
-            implementation.removeUpload(id);
-            call.resolve();
-        } catch (Exception e) {
-            call.reject(e.getMessage());
-        }
+  @PluginMethod
+  public void removeUpload(PluginCall call) {
+    String id = call.getString("id");
+    try {
+      implementation.removeUpload(id);
+      call.resolve();
+    } catch (Exception e) {
+      call.reject(e.getMessage());
     }
+  }
 
-    private Map<String, String> JSObjectToMap(JSObject object) {
-        Map<String, String> map = new HashMap<>();
-        if (object != null) {
-            for (Iterator<String> it = object.keys(); it.hasNext(); ) {
-                String key = it.next();
-                map.put(key, object.getString(key));
-            }
-        }
-        return map;
+  private Map<String, String> JSObjectToMap(JSObject object) {
+    Map<String, String> map = new HashMap<>();
+    if (object != null) {
+      for (Iterator<String> it = object.keys(); it.hasNext();) {
+        String key = it.next();
+        map.put(key, object.getString(key));
+      }
     }
+    return map;
+  }
 }