@capawesome/capacitor-square-mobile-payments 0.0.1

package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/SquareMobilePaymentsPlugin.java

@@ -0,0 +1,460 @@
+package io.capawesome.capacitorjs.plugins.squaremobilepayments;
+
+import android.Manifest;
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import com.getcapacitor.JSObject;
+import com.getcapacitor.Logger;
+import com.getcapacitor.Plugin;
+import com.getcapacitor.PluginCall;
+import com.getcapacitor.PluginMethod;
+import com.getcapacitor.annotation.CapacitorPlugin;
+import com.getcapacitor.annotation.Permission;
+import io.capawesome.capacitorjs.plugins.squaremobilepayments.classes.events.*;
+import io.capawesome.capacitorjs.plugins.squaremobilepayments.classes.options.*;
+import io.capawesome.capacitorjs.plugins.squaremobilepayments.classes.results.*;
+import io.capawesome.capacitorjs.plugins.squaremobilepayments.interfaces.*;
+
+@CapacitorPlugin(
+    name = "SquareMobilePayments",
+    permissions = {
+        @Permission(strings = { Manifest.permission.ACCESS_FINE_LOCATION }, alias = SquareMobilePaymentsPlugin.PERMISSION_LOCATION),
+        @Permission(strings = { Manifest.permission.RECORD_AUDIO }, alias = SquareMobilePaymentsPlugin.PERMISSION_RECORD_AUDIO),
+        @Permission(strings = { Manifest.permission.BLUETOOTH_CONNECT }, alias = SquareMobilePaymentsPlugin.PERMISSION_BLUETOOTH_CONNECT),
+        @Permission(strings = { Manifest.permission.BLUETOOTH_SCAN }, alias = SquareMobilePaymentsPlugin.PERMISSION_BLUETOOTH_SCAN),
+        @Permission(strings = { Manifest.permission.READ_PHONE_STATE }, alias = SquareMobilePaymentsPlugin.PERMISSION_READ_PHONE_STATE)
+    }
+)
+public class SquareMobilePaymentsPlugin extends Plugin {
+
+    public static final String TAG = "SquareMobilePayments";
+    public static final String ERROR_UNKNOWN_ERROR = "An unknown error occurred.";
+    public static final String PERMISSION_LOCATION = "location";
+    public static final String PERMISSION_RECORD_AUDIO = "recordAudio";
+    public static final String PERMISSION_BLUETOOTH_CONNECT = "bluetoothConnect";
+    public static final String PERMISSION_BLUETOOTH_SCAN = "bluetoothScan";
+    public static final String PERMISSION_READ_PHONE_STATE = "readPhoneState";
+
+    private SquareMobilePayments implementation;
+
+    @Override
+    public void load() {
+        implementation = new SquareMobilePayments(this);
+        implementation.setReaderChangedCallback();
+        implementation.setAvailableCardInputMethodsCallback();
+    }
+
+    @Override
+    protected void handleOnDestroy() {
+        if (implementation != null) {
+            implementation.clearReaderChangedCallback();
+            implementation.clearAvailableCardInputMethodsCallback();
+        }
+    }
+
+    @PluginMethod
+    public void initialize(PluginCall call) {
+        try {
+            InitializeOptions options = new InitializeOptions(call);
+            EmptyCallback callback = new EmptyCallback() {
+                @Override
+                public void success() {
+                    resolveCall(call);
+                }
+
+                @Override
+                public void error(@NonNull Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+
+            assert implementation != null;
+            implementation.initialize(options, callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void authorize(PluginCall call) {
+        try {
+            AuthorizeOptions options = new AuthorizeOptions(call);
+            EmptyCallback callback = new EmptyCallback() {
+                @Override
+                public void success() {
+                    resolveCall(call);
+                }
+
+                @Override
+                public void error(@NonNull Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+
+            assert implementation != null;
+            implementation.authorize(options, callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void isAuthorized(PluginCall call) {
+        try {
+            NonEmptyResultCallback<IsAuthorizedResult> callback = new NonEmptyResultCallback<>() {
+                @Override
+                public void success(@NonNull IsAuthorizedResult result) {
+                    resolveCall(call, result);
+                }
+
+                @Override
+                public void error(@NonNull Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+
+            assert implementation != null;
+            implementation.isAuthorized(callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void deauthorize(PluginCall call) {
+        try {
+            EmptyCallback callback = new EmptyCallback() {
+                @Override
+                public void success() {
+                    resolveCall(call);
+                }
+
+                @Override
+                public void error(@NonNull Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+
+            assert implementation != null;
+            implementation.deauthorize(callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void showSettings(PluginCall call) {
+        try {
+            EmptyCallback callback = new EmptyCallback() {
+                @Override
+                public void success() {
+                    resolveCall(call);
+                }
+
+                @Override
+                public void error(@NonNull Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+
+            assert implementation != null;
+            implementation.showSettings(callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void getSettings(PluginCall call) {
+        try {
+            NonEmptyResultCallback<GetSettingsResult> callback = new NonEmptyResultCallback<>() {
+                @Override
+                public void success(@NonNull GetSettingsResult result) {
+                    resolveCall(call, result);
+                }
+
+                @Override
+                public void error(@NonNull Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+
+            assert implementation != null;
+            implementation.getSettings(callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void startPairing(PluginCall call) {
+        try {
+            EmptyCallback callback = new EmptyCallback() {
+                @Override
+                public void success() {
+                    resolveCall(call);
+                }
+
+                @Override
+                public void error(@NonNull Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+
+            assert implementation != null;
+            implementation.startPairing(callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void stopPairing(PluginCall call) {
+        try {
+            EmptyCallback callback = new EmptyCallback() {
+                @Override
+                public void success() {
+                    resolveCall(call);
+                }
+
+                @Override
+                public void error(@NonNull Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+
+            assert implementation != null;
+            implementation.stopPairing(callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void isPairingInProgress(PluginCall call) {
+        try {
+            NonEmptyResultCallback<IsPairingInProgressResult> callback = new NonEmptyResultCallback<>() {
+                @Override
+                public void success(@NonNull IsPairingInProgressResult result) {
+                    resolveCall(call, result);
+                }
+
+                @Override
+                public void error(@NonNull Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+
+            assert implementation != null;
+            implementation.isPairingInProgress(callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void getReaders(PluginCall call) {
+        try {
+            NonEmptyResultCallback<GetReadersResult> callback = new NonEmptyResultCallback<>() {
+                @Override
+                public void success(@NonNull GetReadersResult result) {
+                    resolveCall(call, result);
+                }
+
+                @Override
+                public void error(@NonNull Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+
+            assert implementation != null;
+            implementation.getReaders(callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void forgetReader(PluginCall call) {
+        try {
+            ForgetReaderOptions options = new ForgetReaderOptions(call);
+            EmptyCallback callback = new EmptyCallback() {
+                @Override
+                public void success() {
+                    resolveCall(call);
+                }
+
+                @Override
+                public void error(@NonNull Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+
+            assert implementation != null;
+            implementation.forgetReader(options, callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void retryConnection(PluginCall call) {
+        try {
+            RetryConnectionOptions options = new RetryConnectionOptions(call);
+            EmptyCallback callback = new EmptyCallback() {
+                @Override
+                public void success() {
+                    resolveCall(call);
+                }
+
+                @Override
+                public void error(@NonNull Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+
+            assert implementation != null;
+            implementation.retryConnection(options, callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void startPayment(PluginCall call) {
+        try {
+            StartPaymentOptions options = new StartPaymentOptions(call);
+            EmptyCallback callback = new EmptyCallback() {
+                @Override
+                public void success() {
+                    resolveCall(call);
+                }
+
+                @Override
+                public void error(@NonNull Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+
+            assert implementation != null;
+            implementation.startPayment(options, callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void cancelPayment(PluginCall call) {
+        try {
+            EmptyCallback callback = new EmptyCallback() {
+                @Override
+                public void success() {
+                    resolveCall(call);
+                }
+
+                @Override
+                public void error(@NonNull Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+
+            assert implementation != null;
+            implementation.cancelPayment(callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void getAvailableCardInputMethods(PluginCall call) {
+        try {
+            NonEmptyResultCallback<GetAvailableCardInputMethodsResult> callback = new NonEmptyResultCallback<>() {
+                @Override
+                public void success(@NonNull GetAvailableCardInputMethodsResult result) {
+                    resolveCall(call, result);
+                }
+
+                @Override
+                public void error(@NonNull Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+
+            assert implementation != null;
+            implementation.getAvailableCardInputMethods(callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void checkPermissions(PluginCall call) {
+        super.checkPermissions(call);
+    }
+
+    @PluginMethod
+    public void requestPermissions(PluginCall call) {
+        super.requestPermissions(call);
+    }
+
+    private void rejectCall(@NonNull PluginCall call, @NonNull Exception exception) {
+        String message = exception.getMessage();
+        if (message == null) {
+            message = ERROR_UNKNOWN_ERROR;
+        }
+        Logger.error(TAG, message, exception);
+        call.reject(message);
+    }
+
+    private void resolveCall(@NonNull PluginCall call) {
+        call.resolve();
+    }
+
+    private void resolveCall(@NonNull PluginCall call, @Nullable Result result) {
+        if (result == null) {
+            call.resolve();
+        } else {
+            call.resolve(result.toJSObject());
+        }
+    }
+
+    public void notifyReaderPairingDidBeginListeners() {
+        notifyListeners("readerPairingDidBegin", new JSObject());
+    }
+
+    public void notifyReaderPairingDidSucceedListeners() {
+        notifyListeners("readerPairingDidSucceed", new JSObject());
+    }
+
+    public void notifyReaderPairingDidFailListeners(@NonNull ReaderPairingDidFailEvent event) {
+        notifyListeners("readerPairingDidFail", event.toJSObject());
+    }
+
+    public void notifyReaderWasAddedListeners(@NonNull ReaderWasAddedEvent event) {
+        notifyListeners("readerWasAdded", event.toJSObject());
+    }
+
+    public void notifyReaderWasRemovedListeners(@NonNull ReaderWasRemovedEvent event) {
+        notifyListeners("readerWasRemoved", event.toJSObject());
+    }
+
+    public void notifyReaderDidChangeListeners(@NonNull ReaderDidChangeEvent event) {
+        notifyListeners("readerDidChange", event.toJSObject());
+    }
+
+    public void notifyAvailableCardInputMethodsDidChangeListeners(@NonNull AvailableCardInputMethodsDidChangeEvent event) {
+        notifyListeners("availableCardInputMethodsDidChange", event.toJSObject());
+    }
+
+    public void notifyPaymentDidFinishListeners(@NonNull PaymentDidFinishEvent event) {
+        notifyListeners("paymentDidFinish", event.toJSObject());
+    }
+
+    public void notifyPaymentDidFailListeners(@NonNull PaymentDidFailEvent event) {
+        notifyListeners("paymentDidFail", event.toJSObject());
+    }
+
+    public void notifyPaymentDidCancelListeners(@NonNull PaymentDidCancelEvent event) {
+        notifyListeners("paymentDidCancel", event.toJSObject());
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/classes/CustomException.java

@@ -0,0 +1,20 @@
+package io.capawesome.capacitorjs.plugins.squaremobilepayments.classes;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+
+public class CustomException extends Exception {
+
+    @Nullable
+    private final String code;
+
+    public CustomException(@Nullable String code, @NonNull String message) {
+        super(message);
+        this.code = code;
+    }
+
+    @Nullable
+    public String getCode() {
+        return code;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/classes/CustomExceptions.java

@@ -0,0 +1,41 @@
+package io.capawesome.capacitorjs.plugins.squaremobilepayments.classes;
+
+public class CustomExceptions {
+
+    public static final CustomException LOCATION_ID_MISSING = new CustomException("LOCATION_ID_MISSING", "locationId must be provided.");
+    public static final CustomException ACCESS_TOKEN_MISSING = new CustomException("ACCESS_TOKEN_MISSING", "accessToken must be provided.");
+    public static final CustomException SERIAL_NUMBER_MISSING = new CustomException(
+        "SERIAL_NUMBER_MISSING",
+        "serialNumber must be provided."
+    );
+    public static final CustomException PAYMENT_PARAMETERS_MISSING = new CustomException(
+        "PAYMENT_PARAMETERS_MISSING",
+        "paymentParameters must be provided."
+    );
+    public static final CustomException PROMPT_PARAMETERS_MISSING = new CustomException(
+        "PROMPT_PARAMETERS_MISSING",
+        "promptParameters must be provided."
+    );
+    public static final CustomException AMOUNT_MONEY_MISSING = new CustomException("AMOUNT_MONEY_MISSING", "amountMoney must be provided.");
+    public static final CustomException PAYMENT_ATTEMPT_ID_MISSING = new CustomException(
+        "PAYMENT_ATTEMPT_ID_MISSING",
+        "paymentAttemptId must be provided."
+    );
+    public static final CustomException NOT_INITIALIZED = new CustomException(
+        "NOT_INITIALIZED",
+        "The SDK is not initialized. Call initialize() first."
+    );
+    public static final CustomException NOT_AUTHORIZED = new CustomException(
+        "NOT_AUTHORIZED",
+        "The SDK is not authorized. Call authorize() first."
+    );
+    public static final CustomException PAIRING_ALREADY_IN_PROGRESS = new CustomException(
+        "PAIRING_ALREADY_IN_PROGRESS",
+        "A pairing process is already in progress."
+    );
+    public static final CustomException NO_PAYMENT_IN_PROGRESS = new CustomException(
+        "NO_PAYMENT_IN_PROGRESS",
+        "No payment is currently in progress."
+    );
+    public static final CustomException READER_NOT_FOUND = new CustomException("READER_NOT_FOUND", "Reader not found.");
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/classes/events/AvailableCardInputMethodsDidChangeEvent.java

@@ -0,0 +1,27 @@
+package io.capawesome.capacitorjs.plugins.squaremobilepayments.classes.events;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.JSArray;
+import com.getcapacitor.JSObject;
+import java.util.List;
+
+public class AvailableCardInputMethodsDidChangeEvent {
+
+    @NonNull
+    private final List<String> cardInputMethods;
+
+    public AvailableCardInputMethodsDidChangeEvent(@NonNull List<String> cardInputMethods) {
+        this.cardInputMethods = cardInputMethods;
+    }
+
+    @NonNull
+    public JSObject toJSObject() {
+        JSObject result = new JSObject();
+        JSArray array = new JSArray();
+        for (String method : cardInputMethods) {
+            array.put(method);
+        }
+        result.put("cardInputMethods", array);
+        return result;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/classes/events/PaymentDidCancelEvent.java

@@ -0,0 +1,24 @@
+package io.capawesome.capacitorjs.plugins.squaremobilepayments.classes.events;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.squaremobilepayments.classes.results.Payment;
+import org.json.JSONObject;
+
+public class PaymentDidCancelEvent {
+
+    @Nullable
+    private final Payment payment;
+
+    public PaymentDidCancelEvent(@Nullable Payment payment) {
+        this.payment = payment;
+    }
+
+    @NonNull
+    public JSObject toJSObject() {
+        JSObject result = new JSObject();
+        result.put("payment", payment == null ? JSONObject.NULL : payment.toJSObject());
+        return result;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/classes/events/PaymentDidFailEvent.java

@@ -0,0 +1,34 @@
+package io.capawesome.capacitorjs.plugins.squaremobilepayments.classes.events;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.squaremobilepayments.classes.results.Payment;
+import org.json.JSONObject;
+
+public class PaymentDidFailEvent {
+
+    @Nullable
+    private final Payment payment;
+
+    @Nullable
+    private final String code;
+
+    @NonNull
+    private final String message;
+
+    public PaymentDidFailEvent(@Nullable Payment payment, @Nullable String code, @NonNull String message) {
+        this.payment = payment;
+        this.code = code;
+        this.message = message;
+    }
+
+    @NonNull
+    public JSObject toJSObject() {
+        JSObject result = new JSObject();
+        result.put("payment", payment == null ? JSONObject.NULL : payment.toJSObject());
+        result.put("code", code == null ? JSONObject.NULL : code);
+        result.put("message", message);
+        return result;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/classes/events/PaymentDidFinishEvent.java

@@ -0,0 +1,22 @@
+package io.capawesome.capacitorjs.plugins.squaremobilepayments.classes.events;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.squaremobilepayments.classes.results.Payment;
+
+public class PaymentDidFinishEvent {
+
+    @NonNull
+    private final Payment payment;
+
+    public PaymentDidFinishEvent(@NonNull Payment payment) {
+        this.payment = payment;
+    }
+
+    @NonNull
+    public JSObject toJSObject() {
+        JSObject result = new JSObject();
+        result.put("payment", payment.toJSObject());
+        return result;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/classes/events/ReaderDidChangeEvent.java

@@ -0,0 +1,27 @@
+package io.capawesome.capacitorjs.plugins.squaremobilepayments.classes.events;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.squaremobilepayments.classes.results.ReaderInfo;
+
+public class ReaderDidChangeEvent {
+
+    @NonNull
+    private final ReaderInfo reader;
+
+    @NonNull
+    private final String change;
+
+    public ReaderDidChangeEvent(@NonNull ReaderInfo reader, @NonNull String change) {
+        this.reader = reader;
+        this.change = change;
+    }
+
+    @NonNull
+    public JSObject toJSObject() {
+        JSObject result = new JSObject();
+        result.put("reader", reader.toJSObject());
+        result.put("change", change);
+        return result;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/classes/events/ReaderPairingDidFailEvent.java

@@ -0,0 +1,28 @@
+package io.capawesome.capacitorjs.plugins.squaremobilepayments.classes.events;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import com.getcapacitor.JSObject;
+import org.json.JSONObject;
+
+public class ReaderPairingDidFailEvent {
+
+    @Nullable
+    private final String code;
+
+    @NonNull
+    private final String message;
+
+    public ReaderPairingDidFailEvent(@Nullable String code, @NonNull String message) {
+        this.code = code;
+        this.message = message;
+    }
+
+    @NonNull
+    public JSObject toJSObject() {
+        JSObject result = new JSObject();
+        result.put("code", code == null ? JSONObject.NULL : code);
+        result.put("message", message);
+        return result;
+    }
+}