@capawesome/capacitor-singular 0.0.1

package/android/src/main/java/io/capawesome/capacitorjs/plugins/singular/SingularPlugin.java

@@ -0,0 +1,336 @@
+package io.capawesome.capacitorjs.plugins.singular;
+
+import android.content.Intent;
+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.singular.classes.CustomException;
+import io.capawesome.capacitorjs.plugins.singular.classes.events.DeviceAttributionInfoReceivedEvent;
+import io.capawesome.capacitorjs.plugins.singular.classes.events.SdidReceivedEvent;
+import io.capawesome.capacitorjs.plugins.singular.classes.events.SdidSetEvent;
+import io.capawesome.capacitorjs.plugins.singular.classes.events.SingularLinkResolvedEvent;
+import io.capawesome.capacitorjs.plugins.singular.classes.options.CreateReferrerShortLinkOptions;
+import io.capawesome.capacitorjs.plugins.singular.classes.options.InitializeOptions;
+import io.capawesome.capacitorjs.plugins.singular.classes.options.SetCustomUserIdOptions;
+import io.capawesome.capacitorjs.plugins.singular.classes.options.SetDeviceTokenOptions;
+import io.capawesome.capacitorjs.plugins.singular.classes.options.SetGlobalPropertyOptions;
+import io.capawesome.capacitorjs.plugins.singular.classes.options.SetLimitAdvertisingIdentifiersOptions;
+import io.capawesome.capacitorjs.plugins.singular.classes.options.SetLimitDataSharingOptions;
+import io.capawesome.capacitorjs.plugins.singular.classes.options.TrackAdRevenueOptions;
+import io.capawesome.capacitorjs.plugins.singular.classes.options.TrackEventOptions;
+import io.capawesome.capacitorjs.plugins.singular.classes.options.TrackRevenueOptions;
+import io.capawesome.capacitorjs.plugins.singular.classes.options.UnsetGlobalPropertyOptions;
+import io.capawesome.capacitorjs.plugins.singular.interfaces.EmptyCallback;
+import io.capawesome.capacitorjs.plugins.singular.interfaces.NonEmptyResultCallback;
+import io.capawesome.capacitorjs.plugins.singular.interfaces.Result;
+
+@CapacitorPlugin(name = "Singular")
+public class SingularPlugin extends Plugin {
+
+    public static final String EVENT_DEVICE_ATTRIBUTION_INFO_RECEIVED = "deviceAttributionInfoReceived";
+    public static final String EVENT_SDID_RECEIVED = "sdidReceived";
+    public static final String EVENT_SDID_SET = "sdidSet";
+    public static final String EVENT_SINGULAR_LINK_RESOLVED = "singularLinkResolved";
+    public static final String TAG = "SingularPlugin";
+
+    private static final String ERROR_UNKNOWN_ERROR = "An unknown error has occurred.";
+
+    private Singular implementation;
+
+    @Override
+    public void load() {
+        super.load();
+        this.implementation = new Singular(this);
+    }
+
+    @PluginMethod
+    public void clearGlobalProperties(PluginCall call) {
+        try {
+            implementation.clearGlobalProperties(createEmptyCallback(call));
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void createReferrerShortLink(PluginCall call) {
+        try {
+            CreateReferrerShortLinkOptions options = new CreateReferrerShortLinkOptions(call);
+            implementation.createReferrerShortLink(options, createNonEmptyResultCallback(call));
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void getGlobalProperties(PluginCall call) {
+        try {
+            implementation.getGlobalProperties(createNonEmptyResultCallback(call));
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void getLimitDataSharing(PluginCall call) {
+        try {
+            implementation.getLimitDataSharing(createNonEmptyResultCallback(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 isAllTrackingStopped(PluginCall call) {
+        try {
+            implementation.isAllTrackingStopped(createNonEmptyResultCallback(call));
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    public void notifyDeviceAttributionInfoReceivedListeners(@NonNull DeviceAttributionInfoReceivedEvent event) {
+        notifyListeners(EVENT_DEVICE_ATTRIBUTION_INFO_RECEIVED, event.toJSObject());
+    }
+
+    public void notifySdidReceivedListeners(@NonNull SdidReceivedEvent event) {
+        notifyListeners(EVENT_SDID_RECEIVED, event.toJSObject());
+    }
+
+    public void notifySdidSetListeners(@NonNull SdidSetEvent event) {
+        notifyListeners(EVENT_SDID_SET, event.toJSObject());
+    }
+
+    public void notifySingularLinkResolvedListeners(@NonNull SingularLinkResolvedEvent event) {
+        notifyListeners(EVENT_SINGULAR_LINK_RESOLVED, event.toJSObject());
+    }
+
+    @PluginMethod
+    public void resumeAllTracking(PluginCall call) {
+        try {
+            implementation.resumeAllTracking(createEmptyCallback(call));
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void setCustomUserId(PluginCall call) {
+        try {
+            SetCustomUserIdOptions options = new SetCustomUserIdOptions(call);
+            implementation.setCustomUserId(options, createEmptyCallback(call));
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void setDeviceToken(PluginCall call) {
+        try {
+            SetDeviceTokenOptions options = new SetDeviceTokenOptions(call);
+            implementation.setDeviceToken(options, createEmptyCallback(call));
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void setGlobalProperty(PluginCall call) {
+        try {
+            SetGlobalPropertyOptions options = new SetGlobalPropertyOptions(call);
+            implementation.setGlobalProperty(options, createEmptyCallback(call));
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void setLimitAdvertisingIdentifiers(PluginCall call) {
+        try {
+            SetLimitAdvertisingIdentifiersOptions options = new SetLimitAdvertisingIdentifiersOptions(call);
+            implementation.setLimitAdvertisingIdentifiers(options, createEmptyCallback(call));
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void setLimitDataSharing(PluginCall call) {
+        try {
+            SetLimitDataSharingOptions options = new SetLimitDataSharingOptions(call);
+            implementation.setLimitDataSharing(options, createEmptyCallback(call));
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void skanGetConversionValue(PluginCall call) {
+        rejectCallAsUnimplemented(call);
+    }
+
+    @PluginMethod
+    public void skanRegisterAppForAdNetworkAttribution(PluginCall call) {
+        rejectCallAsUnimplemented(call);
+    }
+
+    @PluginMethod
+    public void skanUpdateConversionValue(PluginCall call) {
+        rejectCallAsUnimplemented(call);
+    }
+
+    @PluginMethod
+    public void stopAllTracking(PluginCall call) {
+        try {
+            implementation.stopAllTracking(createEmptyCallback(call));
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void trackAdRevenue(PluginCall call) {
+        try {
+            TrackAdRevenueOptions options = new TrackAdRevenueOptions(call);
+            implementation.trackAdRevenue(options, createEmptyCallback(call));
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void trackEvent(PluginCall call) {
+        try {
+            TrackEventOptions options = new TrackEventOptions(call);
+            implementation.trackEvent(options, createEmptyCallback(call));
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void trackRevenue(PluginCall call) {
+        try {
+            TrackRevenueOptions options = new TrackRevenueOptions(call);
+            implementation.trackRevenue(options, createEmptyCallback(call));
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void trackingOptIn(PluginCall call) {
+        try {
+            implementation.trackingOptIn(createEmptyCallback(call));
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void trackingUnder13(PluginCall call) {
+        try {
+            implementation.trackingUnder13(createEmptyCallback(call));
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void unsetCustomUserId(PluginCall call) {
+        try {
+            implementation.unsetCustomUserId(createEmptyCallback(call));
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void unsetGlobalProperty(PluginCall call) {
+        try {
+            UnsetGlobalPropertyOptions options = new UnsetGlobalPropertyOptions(call);
+            implementation.unsetGlobalProperty(options, createEmptyCallback(call));
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @Override
+    protected void handleOnNewIntent(Intent intent) {
+        super.handleOnNewIntent(intent);
+        implementation.handleNewIntent(intent);
+    }
+
+    @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);
+            }
+        };
+    }
+
+    @NonNull
+    private <T extends Result> NonEmptyResultCallback<T> createNonEmptyResultCallback(@NonNull PluginCall call) {
+        return new NonEmptyResultCallback<T>() {
+            @Override
+            public void success(@NonNull T result) {
+                resolveCall(call, result);
+            }
+
+            @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 rejectCallAsUnimplemented(@NonNull PluginCall call) {
+        call.unimplemented("This method is not available on this platform.");
+    }
+
+    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/singular/classes/CustomException.java

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

@@ -0,0 +1,34 @@
+package io.capawesome.capacitorjs.plugins.singular.classes;
+
+public class CustomExceptions {
+
+    public static final CustomException AD_PLATFORM_MISSING = new CustomException(null, "adPlatform must be provided.");
+    public static final CustomException AMOUNT_MISSING = new CustomException(null, "amount must be provided.");
+    public static final CustomException API_KEY_MISSING = new CustomException(null, "apiKey must be provided.");
+    public static final CustomException BASE_LINK_MISSING = new CustomException(null, "baseLink must be provided.");
+    public static final CustomException CURRENCY_MISSING = new CustomException(null, "currency must be provided.");
+    public static final CustomException CUSTOM_USER_ID_MISSING = new CustomException(null, "customUserId must be provided.");
+    public static final CustomException EVENT_COULD_NOT_BE_TRACKED = new CustomException(null, "The event could not be tracked.");
+    public static final CustomException GLOBAL_PROPERTY_COULD_NOT_BE_SET = new CustomException(
+        null,
+        "The global property could not be set."
+    );
+    public static final CustomException INITIALIZATION_FAILED = new CustomException(
+        "INITIALIZATION_FAILED",
+        "The initialization of the SDK failed."
+    );
+    public static final CustomException KEY_MISSING = new CustomException(null, "key must be provided.");
+    public static final CustomException LIMIT_MISSING = new CustomException(null, "limit 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",
+        "The plugin has not been initialized yet."
+    );
+    public static final CustomException REFERRER_ID_MISSING = new CustomException(null, "referrerId must be provided.");
+    public static final CustomException REFERRER_NAME_MISSING = new CustomException(null, "referrerName must be provided.");
+    public static final CustomException REVENUE_COULD_NOT_BE_TRACKED = new CustomException(null, "The revenue could not be tracked.");
+    public static final CustomException REVENUE_MISSING = new CustomException(null, "revenue must be provided.");
+    public static final CustomException SECRET_MISSING = new CustomException(null, "secret must be provided.");
+    public static final CustomException TOKEN_MISSING = new CustomException(null, "token must be provided.");
+    public static final CustomException VALUE_MISSING = new CustomException(null, "value must be provided.");
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/singular/classes/events/DeviceAttributionInfoReceivedEvent.java

@@ -0,0 +1,48 @@
+package io.capawesome.capacitorjs.plugins.singular.classes.events;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.singular.interfaces.Result;
+import java.util.Map;
+
+public class DeviceAttributionInfoReceivedEvent implements Result {
+
+    @NonNull
+    private final Map<String, Object> attributionInfo;
+
+    public DeviceAttributionInfoReceivedEvent(@NonNull Map<String, Object> attributionInfo) {
+        this.attributionInfo = attributionInfo;
+    }
+
+    @Override
+    @NonNull
+    public JSObject toJSObject() {
+        JSObject event = new JSObject();
+        putStringIfPresent(event, "campaignId", "campaign_id");
+        putStringIfPresent(event, "campaignName", "campaign_name");
+        putClickTimestampIfPresent(event);
+        putStringIfPresent(event, "creativeId", "creative_id");
+        putStringIfPresent(event, "creativeName", "creative_name");
+        putStringIfPresent(event, "matchType", "match_type");
+        putStringIfPresent(event, "network", "network");
+        putStringIfPresent(event, "passthrough", "passthrough");
+        putStringIfPresent(event, "subcampaignId", "subcampaign_id");
+        putStringIfPresent(event, "subcampaignName", "subcampaign_name");
+        return event;
+    }
+
+    private void putClickTimestampIfPresent(@NonNull JSObject event) {
+        Object value = attributionInfo.get("click_timestamp");
+        if (value instanceof Number) {
+            long timestampInMicroseconds = ((Number) value).longValue();
+            event.put("clickTimestamp", timestampInMicroseconds / 1000);
+        }
+    }
+
+    private void putStringIfPresent(@NonNull JSObject event, @NonNull String key, @NonNull String attributionInfoKey) {
+        Object value = attributionInfo.get(attributionInfoKey);
+        if (value instanceof String) {
+            event.put(key, (String) value);
+        }
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/singular/classes/events/SdidReceivedEvent.java

@@ -0,0 +1,23 @@
+package io.capawesome.capacitorjs.plugins.singular.classes.events;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.singular.interfaces.Result;
+
+public class SdidReceivedEvent implements Result {
+
+    @NonNull
+    private final String sdid;
+
+    public SdidReceivedEvent(@NonNull String sdid) {
+        this.sdid = sdid;
+    }
+
+    @Override
+    @NonNull
+    public JSObject toJSObject() {
+        JSObject event = new JSObject();
+        event.put("sdid", sdid);
+        return event;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/singular/classes/events/SdidSetEvent.java

@@ -0,0 +1,23 @@
+package io.capawesome.capacitorjs.plugins.singular.classes.events;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.singular.interfaces.Result;
+
+public class SdidSetEvent implements Result {
+
+    @NonNull
+    private final String sdid;
+
+    public SdidSetEvent(@NonNull String sdid) {
+        this.sdid = sdid;
+    }
+
+    @Override
+    @NonNull
+    public JSObject toJSObject() {
+        JSObject event = new JSObject();
+        event.put("sdid", sdid);
+        return event;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/singular/classes/events/SingularLinkResolvedEvent.java

@@ -0,0 +1,44 @@
+package io.capawesome.capacitorjs.plugins.singular.classes.events;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import com.getcapacitor.JSObject;
+import com.singular.sdk.SingularLinkParams;
+import io.capawesome.capacitorjs.plugins.singular.interfaces.Result;
+import java.util.HashMap;
+import java.util.Map;
+import org.json.JSONObject;
+
+public class SingularLinkResolvedEvent implements Result {
+
+    @NonNull
+    private final SingularLinkParams linkParams;
+
+    public SingularLinkResolvedEvent(@NonNull SingularLinkParams linkParams) {
+        this.linkParams = linkParams;
+    }
+
+    @Override
+    @NonNull
+    public JSObject toJSObject() {
+        String deepLink = linkParams.getDeeplink();
+        String passthrough = linkParams.getPassthrough();
+        JSObject event = new JSObject();
+        event.put("deepLink", deepLink == null ? JSONObject.NULL : deepLink);
+        event.put("isDeferred", linkParams.isDeferred());
+        event.put("passthrough", passthrough == null ? JSONObject.NULL : passthrough);
+        event.put("urlParameters", createUrlParameters(linkParams.getUrlParameters()));
+        return event;
+    }
+
+    @NonNull
+    private JSObject createUrlParameters(@Nullable HashMap<String, String> parameters) {
+        JSObject urlParameters = new JSObject();
+        if (parameters != null) {
+            for (Map.Entry<String, String> parameter : parameters.entrySet()) {
+                urlParameters.put(parameter.getKey(), parameter.getValue());
+            }
+        }
+        return urlParameters;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/singular/classes/options/CreateReferrerShortLinkOptions.java

@@ -0,0 +1,61 @@
+package io.capawesome.capacitorjs.plugins.singular.classes.options;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import com.getcapacitor.JSObject;
+import com.getcapacitor.PluginCall;
+import io.capawesome.capacitorjs.plugins.singular.classes.CustomExceptions;
+
+public class CreateReferrerShortLinkOptions {
+
+    @NonNull
+    private final String baseLink;
+
+    @Nullable
+    private final JSObject passthroughParameters;
+
+    @NonNull
+    private final String referrerId;
+
+    @NonNull
+    private final String referrerName;
+
+    public CreateReferrerShortLinkOptions(@NonNull PluginCall call) throws Exception {
+        String baseLink = call.getString("baseLink");
+        if (baseLink == null) {
+            throw CustomExceptions.BASE_LINK_MISSING;
+        }
+        String referrerId = call.getString("referrerId");
+        if (referrerId == null) {
+            throw CustomExceptions.REFERRER_ID_MISSING;
+        }
+        String referrerName = call.getString("referrerName");
+        if (referrerName == null) {
+            throw CustomExceptions.REFERRER_NAME_MISSING;
+        }
+        this.baseLink = baseLink;
+        this.passthroughParameters = call.getObject("passthroughParameters");
+        this.referrerId = referrerId;
+        this.referrerName = referrerName;
+    }
+
+    @NonNull
+    public String getBaseLink() {
+        return baseLink;
+    }
+
+    @Nullable
+    public JSObject getPassthroughParameters() {
+        return passthroughParameters;
+    }
+
+    @NonNull
+    public String getReferrerId() {
+        return referrerId;
+    }
+
+    @NonNull
+    public String getReferrerName() {
+        return referrerName;
+    }
+}