@capawesome/capacitor-intercom 0.0.1

package/android/src/main/java/io/capawesome/capacitorjs/plugins/intercom/IntercomPlugin.java

@@ -0,0 +1,307 @@
+package io.capawesome.capacitorjs.plugins.intercom;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import com.getcapacitor.Logger;
+import com.getcapacitor.Plugin;
+import com.getcapacitor.PluginCall;
+import com.getcapacitor.PluginMethod;
+import com.getcapacitor.annotation.CapacitorPlugin;
+import io.capawesome.capacitorjs.plugins.intercom.classes.CustomException;
+import io.capawesome.capacitorjs.plugins.intercom.classes.events.UnreadConversationCountChangeEvent;
+import io.capawesome.capacitorjs.plugins.intercom.classes.options.HandlePushNotificationOptions;
+import io.capawesome.capacitorjs.plugins.intercom.classes.options.InitializeOptions;
+import io.capawesome.capacitorjs.plugins.intercom.classes.options.IsIntercomPushNotificationOptions;
+import io.capawesome.capacitorjs.plugins.intercom.classes.options.LogEventOptions;
+import io.capawesome.capacitorjs.plugins.intercom.classes.options.LoginUserOptions;
+import io.capawesome.capacitorjs.plugins.intercom.classes.options.PresentContentOptions;
+import io.capawesome.capacitorjs.plugins.intercom.classes.options.PresentMessageComposerOptions;
+import io.capawesome.capacitorjs.plugins.intercom.classes.options.PresentOptions;
+import io.capawesome.capacitorjs.plugins.intercom.classes.options.SendPushTokenToIntercomOptions;
+import io.capawesome.capacitorjs.plugins.intercom.classes.options.SetBottomPaddingOptions;
+import io.capawesome.capacitorjs.plugins.intercom.classes.options.SetInAppMessagesVisibleOptions;
+import io.capawesome.capacitorjs.plugins.intercom.classes.options.SetLauncherVisibleOptions;
+import io.capawesome.capacitorjs.plugins.intercom.classes.options.SetUserHashOptions;
+import io.capawesome.capacitorjs.plugins.intercom.classes.options.SetUserJwtOptions;
+import io.capawesome.capacitorjs.plugins.intercom.classes.options.UpdateUserOptions;
+import io.capawesome.capacitorjs.plugins.intercom.classes.results.GetUnreadConversationCountResult;
+import io.capawesome.capacitorjs.plugins.intercom.classes.results.IsIntercomPushNotificationResult;
+import io.capawesome.capacitorjs.plugins.intercom.interfaces.EmptyCallback;
+import io.capawesome.capacitorjs.plugins.intercom.interfaces.NonEmptyResultCallback;
+import io.capawesome.capacitorjs.plugins.intercom.interfaces.Result;
+
+@CapacitorPlugin(name = "Intercom")
+public class IntercomPlugin extends Plugin {
+
+    public static final String ERROR_UNKNOWN_ERROR = "An unknown error has occurred.";
+    public static final String EVENT_UNREAD_CONVERSATION_COUNT_CHANGE = "unreadConversationCountChange";
+    public static final String TAG = "IntercomPlugin";
+
+    private Intercom implementation;
+
+    @Override
+    public void load() {
+        super.load();
+        this.implementation = new Intercom(this);
+    }
+
+    @PluginMethod
+    public void getUnreadConversationCount(PluginCall call) {
+        try {
+            NonEmptyResultCallback<GetUnreadConversationCountResult> callback = new NonEmptyResultCallback<>() {
+                @Override
+                public void success(@NonNull GetUnreadConversationCountResult result) {
+                    resolveCall(call, result);
+                }
+
+                @Override
+                public void error(Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+            implementation.getUnreadConversationCount(callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void handlePushNotification(PluginCall call) {
+        try {
+            HandlePushNotificationOptions options = new HandlePushNotificationOptions(call);
+            implementation.handlePushNotification(options, createEmptyCallback(call));
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void hide(PluginCall call) {
+        try {
+            implementation.hide(createEmptyCallback(call));
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void initialize(PluginCall call) {
+        try {
+            InitializeOptions options = new InitializeOptions(call);
+            implementation.initialize(options, createEmptyCallback(call));
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void isIntercomPushNotification(PluginCall call) {
+        try {
+            IsIntercomPushNotificationOptions options = new IsIntercomPushNotificationOptions(call);
+            NonEmptyResultCallback<IsIntercomPushNotificationResult> callback = new NonEmptyResultCallback<>() {
+                @Override
+                public void success(@NonNull IsIntercomPushNotificationResult result) {
+                    resolveCall(call, result);
+                }
+
+                @Override
+                public void error(Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+            implementation.isIntercomPushNotification(options, callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void logEvent(PluginCall call) {
+        try {
+            LogEventOptions options = new LogEventOptions(call);
+            implementation.logEvent(options, createEmptyCallback(call));
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void loginUnidentifiedUser(PluginCall call) {
+        try {
+            implementation.loginUnidentifiedUser(createEmptyCallback(call));
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void loginUser(PluginCall call) {
+        try {
+            LoginUserOptions options = new LoginUserOptions(call);
+            implementation.loginUser(options, createEmptyCallback(call));
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void logout(PluginCall call) {
+        try {
+            implementation.logout(createEmptyCallback(call));
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    public void notifyUnreadConversationCountChangeListeners(@NonNull UnreadConversationCountChangeEvent event) {
+        notifyListeners(EVENT_UNREAD_CONVERSATION_COUNT_CHANGE, event.toJSObject());
+    }
+
+    @PluginMethod
+    public void present(PluginCall call) {
+        try {
+            PresentOptions options = new PresentOptions(call);
+            implementation.present(options, createEmptyCallback(call));
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void presentContent(PluginCall call) {
+        try {
+            PresentContentOptions options = new PresentContentOptions(call);
+            implementation.presentContent(options, createEmptyCallback(call));
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void presentMessageComposer(PluginCall call) {
+        try {
+            PresentMessageComposerOptions options = new PresentMessageComposerOptions(call);
+            implementation.presentMessageComposer(options, createEmptyCallback(call));
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void sendPushTokenToIntercom(PluginCall call) {
+        try {
+            SendPushTokenToIntercomOptions options = new SendPushTokenToIntercomOptions(call);
+            implementation.sendPushTokenToIntercom(options, createEmptyCallback(call));
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void setBottomPadding(PluginCall call) {
+        try {
+            SetBottomPaddingOptions options = new SetBottomPaddingOptions(call);
+            implementation.setBottomPadding(options, createEmptyCallback(call));
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void setInAppMessagesVisible(PluginCall call) {
+        try {
+            SetInAppMessagesVisibleOptions options = new SetInAppMessagesVisibleOptions(call);
+            implementation.setInAppMessagesVisible(options, createEmptyCallback(call));
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void setLauncherVisible(PluginCall call) {
+        try {
+            SetLauncherVisibleOptions options = new SetLauncherVisibleOptions(call);
+            implementation.setLauncherVisible(options, createEmptyCallback(call));
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void setUserHash(PluginCall call) {
+        try {
+            SetUserHashOptions options = new SetUserHashOptions(call);
+            implementation.setUserHash(options, createEmptyCallback(call));
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void setUserJwt(PluginCall call) {
+        try {
+            SetUserJwtOptions options = new SetUserJwtOptions(call);
+            implementation.setUserJwt(options, createEmptyCallback(call));
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void updateUser(PluginCall call) {
+        try {
+            UpdateUserOptions options = new UpdateUserOptions(call);
+            implementation.updateUser(options, createEmptyCallback(call));
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @Override
+    protected void handleOnDestroy() {
+        super.handleOnDestroy();
+        if (implementation != null) {
+            implementation.unregisterUnreadConversationCountListener();
+        }
+    }
+
+    @NonNull
+    private EmptyCallback createEmptyCallback(@NonNull PluginCall call) {
+        return new EmptyCallback() {
+            @Override
+            public void success() {
+                resolveCall(call);
+            }
+
+            @Override
+            public void error(Exception exception) {
+                rejectCall(call, exception);
+            }
+        };
+    }
+
+    private void rejectCall(@NonNull PluginCall call, @NonNull Exception exception) {
+        String message = exception.getMessage();
+        if (message == null) {
+            message = ERROR_UNKNOWN_ERROR;
+        }
+        String code = null;
+        if (exception instanceof CustomException) {
+            code = ((CustomException) exception).getCode();
+        }
+        Logger.error(TAG, message, exception);
+        call.reject(message, code);
+    }
+
+    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());
+        }
+    }
+}

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

@@ -0,0 +1,20 @@
+package io.capawesome.capacitorjs.plugins.intercom.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/intercom/classes/CustomExceptions.java

@@ -0,0 +1,23 @@
+package io.capawesome.capacitorjs.plugins.intercom.classes;
+
+public class CustomExceptions {
+
+    public static final CustomException ANDROID_API_KEY_MISSING = new CustomException(null, "androidApiKey must be provided.");
+    public static final CustomException APP_ID_MISSING = new CustomException(null, "appId must be provided.");
+    public static final CustomException COMPANY_ID_MISSING = new CustomException(null, "company id must be provided.");
+    public static final CustomException DATA_MISSING = new CustomException(null, "data must be provided.");
+    public static final CustomException ID_MISSING = new CustomException(null, "id must be provided.");
+    public static final CustomException IDS_MISSING = new CustomException(null, "ids must be provided.");
+    public static final CustomException JWT_MISSING = new CustomException(null, "jwt must be provided.");
+    public static final CustomException NAME_MISSING = new CustomException(null, "name must be provided.");
+    public static final CustomException NOT_INITIALIZED = new CustomException(
+        "NOT_INITIALIZED",
+        "Intercom is not initialized. Call initialize() first."
+    );
+    public static final CustomException PADDING_MISSING = new CustomException(null, "padding must be provided.");
+    public static final CustomException TOKEN_MISSING = new CustomException(null, "token must be provided.");
+    public static final CustomException TYPE_INVALID = new CustomException(null, "type is invalid.");
+    public static final CustomException USER_HASH_MISSING = new CustomException(null, "userHash must be provided.");
+    public static final CustomException USER_ID_OR_EMAIL_MISSING = new CustomException(null, "userId or email must be provided.");
+    public static final CustomException VISIBLE_MISSING = new CustomException(null, "visible must be provided.");
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/intercom/classes/events/UnreadConversationCountChangeEvent.java

@@ -0,0 +1,22 @@
+package io.capawesome.capacitorjs.plugins.intercom.classes.events;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.intercom.interfaces.Result;
+
+public class UnreadConversationCountChangeEvent implements Result {
+
+    private final int count;
+
+    public UnreadConversationCountChangeEvent(int count) {
+        this.count = count;
+    }
+
+    @Override
+    @NonNull
+    public JSObject toJSObject() {
+        JSObject result = new JSObject();
+        result.put("count", count);
+        return result;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/intercom/classes/options/HandlePushNotificationOptions.java

@@ -0,0 +1,25 @@
+package io.capawesome.capacitorjs.plugins.intercom.classes.options;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.JSObject;
+import com.getcapacitor.PluginCall;
+import io.capawesome.capacitorjs.plugins.intercom.classes.CustomExceptions;
+
+public class HandlePushNotificationOptions {
+
+    @NonNull
+    private final JSObject data;
+
+    public HandlePushNotificationOptions(@NonNull PluginCall call) throws Exception {
+        JSObject data = call.getObject("data");
+        if (data == null) {
+            throw CustomExceptions.DATA_MISSING;
+        }
+        this.data = data;
+    }
+
+    @NonNull
+    public JSObject getData() {
+        return data;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/intercom/classes/options/InitializeOptions.java

@@ -0,0 +1,34 @@
+package io.capawesome.capacitorjs.plugins.intercom.classes.options;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import com.getcapacitor.PluginCall;
+import io.capawesome.capacitorjs.plugins.intercom.classes.CustomExceptions;
+
+public class InitializeOptions {
+
+    @Nullable
+    private final String androidApiKey;
+
+    @NonNull
+    private final String appId;
+
+    public InitializeOptions(@NonNull PluginCall call) throws Exception {
+        String appId = call.getString("appId");
+        if (appId == null) {
+            throw CustomExceptions.APP_ID_MISSING;
+        }
+        this.appId = appId;
+        this.androidApiKey = call.getString("androidApiKey");
+    }
+
+    @Nullable
+    public String getAndroidApiKey() {
+        return androidApiKey;
+    }
+
+    @NonNull
+    public String getAppId() {
+        return appId;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/intercom/classes/options/IsIntercomPushNotificationOptions.java

@@ -0,0 +1,25 @@
+package io.capawesome.capacitorjs.plugins.intercom.classes.options;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.JSObject;
+import com.getcapacitor.PluginCall;
+import io.capawesome.capacitorjs.plugins.intercom.classes.CustomExceptions;
+
+public class IsIntercomPushNotificationOptions {
+
+    @NonNull
+    private final JSObject data;
+
+    public IsIntercomPushNotificationOptions(@NonNull PluginCall call) throws Exception {
+        JSObject data = call.getObject("data");
+        if (data == null) {
+            throw CustomExceptions.DATA_MISSING;
+        }
+        this.data = data;
+    }
+
+    @NonNull
+    public JSObject getData() {
+        return data;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/intercom/classes/options/LogEventOptions.java

@@ -0,0 +1,35 @@
+package io.capawesome.capacitorjs.plugins.intercom.classes.options;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import com.getcapacitor.JSObject;
+import com.getcapacitor.PluginCall;
+import io.capawesome.capacitorjs.plugins.intercom.classes.CustomExceptions;
+
+public class LogEventOptions {
+
+    @Nullable
+    private final JSObject data;
+
+    @NonNull
+    private final String name;
+
+    public LogEventOptions(@NonNull PluginCall call) throws Exception {
+        String name = call.getString("name");
+        if (name == null) {
+            throw CustomExceptions.NAME_MISSING;
+        }
+        this.name = name;
+        this.data = call.getObject("data");
+    }
+
+    @Nullable
+    public JSObject getData() {
+        return data;
+    }
+
+    @NonNull
+    public String getName() {
+        return name;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/intercom/classes/options/LoginUserOptions.java

@@ -0,0 +1,33 @@
+package io.capawesome.capacitorjs.plugins.intercom.classes.options;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import com.getcapacitor.PluginCall;
+import io.capawesome.capacitorjs.plugins.intercom.classes.CustomExceptions;
+
+public class LoginUserOptions {
+
+    @Nullable
+    private final String email;
+
+    @Nullable
+    private final String userId;
+
+    public LoginUserOptions(@NonNull PluginCall call) throws Exception {
+        this.userId = call.getString("userId");
+        this.email = call.getString("email");
+        if (userId == null && email == null) {
+            throw CustomExceptions.USER_ID_OR_EMAIL_MISSING;
+        }
+    }
+
+    @Nullable
+    public String getEmail() {
+        return email;
+    }
+
+    @Nullable
+    public String getUserId() {
+        return userId;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/intercom/classes/options/PresentContentOptions.java

@@ -0,0 +1,71 @@
+package io.capawesome.capacitorjs.plugins.intercom.classes.options;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import com.getcapacitor.JSArray;
+import com.getcapacitor.PluginCall;
+import io.capawesome.capacitorjs.plugins.intercom.classes.CustomExceptions;
+import java.util.ArrayList;
+import java.util.List;
+
+public class PresentContentOptions {
+
+    @Nullable
+    private final String id;
+
+    @Nullable
+    private final List<String> ids;
+
+    @NonNull
+    private final String type;
+
+    public PresentContentOptions(@NonNull PluginCall call) throws Exception {
+        String type = call.getString("type");
+        if (type == null) {
+            throw CustomExceptions.TYPE_INVALID;
+        }
+        this.type = type;
+        this.id = call.getString("id");
+        JSArray ids = call.getArray("ids");
+        if (ids == null) {
+            this.ids = null;
+        } else {
+            this.ids = new ArrayList<>();
+            for (int i = 0; i < ids.length(); i++) {
+                this.ids.add(ids.getString(i));
+            }
+        }
+        switch (type) {
+            case "article":
+            case "carousel":
+            case "survey":
+            case "conversation":
+                if (id == null) {
+                    throw CustomExceptions.ID_MISSING;
+                }
+                break;
+            case "help-center-collections":
+                if (this.ids == null || this.ids.isEmpty()) {
+                    throw CustomExceptions.IDS_MISSING;
+                }
+                break;
+            default:
+                throw CustomExceptions.TYPE_INVALID;
+        }
+    }
+
+    @Nullable
+    public String getId() {
+        return id;
+    }
+
+    @Nullable
+    public List<String> getIds() {
+        return ids;
+    }
+
+    @NonNull
+    public String getType() {
+        return type;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/intercom/classes/options/PresentMessageComposerOptions.java

@@ -0,0 +1,20 @@
+package io.capawesome.capacitorjs.plugins.intercom.classes.options;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import com.getcapacitor.PluginCall;
+
+public class PresentMessageComposerOptions {
+
+    @Nullable
+    private final String initialMessage;
+
+    public PresentMessageComposerOptions(@NonNull PluginCall call) {
+        this.initialMessage = call.getString("initialMessage");
+    }
+
+    @Nullable
+    public String getInitialMessage() {
+        return initialMessage;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/intercom/classes/options/PresentOptions.java

@@ -0,0 +1,19 @@
+package io.capawesome.capacitorjs.plugins.intercom.classes.options;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.PluginCall;
+
+public class PresentOptions {
+
+    @NonNull
+    private final String space;
+
+    public PresentOptions(@NonNull PluginCall call) {
+        this.space = call.getString("space", "home");
+    }
+
+    @NonNull
+    public String getSpace() {
+        return space;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/intercom/classes/options/SendPushTokenToIntercomOptions.java

@@ -0,0 +1,24 @@
+package io.capawesome.capacitorjs.plugins.intercom.classes.options;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.PluginCall;
+import io.capawesome.capacitorjs.plugins.intercom.classes.CustomExceptions;
+
+public class SendPushTokenToIntercomOptions {
+
+    @NonNull
+    private final String token;
+
+    public SendPushTokenToIntercomOptions(@NonNull PluginCall call) throws Exception {
+        String token = call.getString("token");
+        if (token == null) {
+            throw CustomExceptions.TOKEN_MISSING;
+        }
+        this.token = token;
+    }
+
+    @NonNull
+    public String getToken() {
+        return token;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/intercom/classes/options/SetBottomPaddingOptions.java

@@ -0,0 +1,22 @@
+package io.capawesome.capacitorjs.plugins.intercom.classes.options;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.PluginCall;
+import io.capawesome.capacitorjs.plugins.intercom.classes.CustomExceptions;
+
+public class SetBottomPaddingOptions {
+
+    private final int padding;
+
+    public SetBottomPaddingOptions(@NonNull PluginCall call) throws Exception {
+        Integer padding = call.getInt("padding");
+        if (padding == null) {
+            throw CustomExceptions.PADDING_MISSING;
+        }
+        this.padding = padding;
+    }
+
+    public int getPadding() {
+        return padding;
+    }
+}