airbridge-react-native-sdk-restricted 2.8.8 → 4.1.0

package/source/Airbridge.ts

@@ -0,0 +1,340 @@
+import { createAttributionModule } from './module/Attribution'
+import { createDeeplinkModule } from './module/Deeplink'
+import { createEventModule } from './module/Event'
+import { createFetchModule } from './module/Fetch'
+import { createPlacementModule } from './module/Placement'
+import { createRegisterModule } from './module/Register'
+import { createSwitchModule } from './module/Switch'
+import { createWebInterfaceModule } from './module/WebInterface'
+
+export const createDependency = () => {}
+
+createDependency.Airbridge = () => ({
+    attributionModule: createAttributionModule(),
+    deeplinkModule: createDeeplinkModule(),
+    eventModule: createEventModule(),
+    fetchModule: createFetchModule(),
+    placementModule: createPlacementModule(),
+    registerModule: createRegisterModule(),
+    switchModule: createSwitchModule(),
+    webInterfaceModule: createWebInterfaceModule(),
+})
+
+export class Airbridge {
+    static #dependency = createDependency.Airbridge()
+
+    // attribution
+
+    /**
+     * Sets a listener for receiving attribution of install event.
+     * @param onReceived Map of attribution is delivered.
+     */
+    static setOnAttributionReceived(
+        onReceived: (attribution: Record<string, string>) => void,
+    ): void {
+        this.#dependency.attributionModule.setOnAttributionReceived(onReceived)
+    }
+
+    // deeplink
+
+    /**
+     * Handles deeplink and deferred-deeplink.
+     * @param onReceived URL of deeplink is delivered.
+     */
+    static setOnDeeplinkReceived(
+        onReceived: (deeplink: string) => void,
+    ): void {
+        this.#dependency.deeplinkModule.setOnDeeplinkReceived(onReceived)
+    }
+
+    // event
+
+    /**
+     * Tracks user behavior through event tracking with attributes.
+     * @param category Name of event.
+     * @param semanticAttributes Additional attributes of the event that defined by Airbridge.
+     * @param customAttributes Additional attributes of the event.
+     */
+    static trackEvent(
+        category: string,
+        semanticAttributes?: Record<string, any>,
+        customAttributes?: Record<string, any>,
+    ): void {
+        this.#dependency.eventModule.trackEvent(category, semanticAttributes, customAttributes)
+    }
+
+    // fetch
+
+    /**
+     * Fetch deviceUUID of SDK.
+     * @param onSuccess Callback to be invoked when deviceUUID is successfully handled.
+     * @param onFailure Callback to be invoked when any error occurs.
+     */
+    static fetchDeviceUUID(
+        onSuccess: (deviceUUID: string) => void,
+        onFailure?: (error: Error) => void
+    ): Promise<boolean> {
+        return this.#dependency.fetchModule.fetchDeviceUUID(onSuccess, onFailure)
+    }
+
+    /**
+     * Fetch airbridgeGeneratedUUID of SDK.
+     * @param onSuccess Callback to be invoked when airbridgeGeneratedUUID is successfully handled.
+     * @param onFailure Callback to be invoked when any error occurs.
+     */
+    static fetchAirbridgeGeneratedUUID(
+        onSuccess: (airbridgeGeneratedUUID: string) => void,
+        onFailure?: (error: Error) => void
+    ): Promise<boolean> {
+        return this.#dependency.fetchModule.fetchAirbridgeGeneratedUUID(onSuccess, onFailure)
+    }
+
+    /**
+     * Indicates whether notification was sent by Airbridge to track uninstall of app.
+     * @param notification The notification to check.
+     */
+    static isUninstallTrackingNotification(
+        notification: Record<string, any>,
+    ): boolean {
+        return this.#dependency.fetchModule.isUninstallTrackingNotification(notification)
+    }
+
+    // placement
+
+    /**
+     * Notifies that an in-app area within an app has been clicked on by the user.
+     * @param trackingLink tracking link uri
+     * @param onSuccess Callback to be invoked when tracking link is successfully handled.
+     * @param onFailure Callback to be invoked when any error occurs.
+     * @return `true` if all of the following conditions are met below, `false` otherwise.
+     *  - If the SDK is initialized and enabled.
+     *  - If tracking link is successfully handled.
+     */
+    static click(
+        trackingLink: string,
+        onSuccess?: () => void,
+        onFailure?: (error: Error) => void
+    ): Promise<boolean> {
+        return this.#dependency.placementModule.click(trackingLink, onSuccess, onFailure)
+    }
+
+    /**
+     * Notifies that the in-app area within the app has been exposed to the user.
+     * @param trackingLink tracking link uri
+     * @param onSuccess Callback to be invoked when tracking link is successfully handled.
+     * @param onFailure Callback to be invoked when any error occurs.
+     * @return `true` if all of the following conditions are met below, `false` otherwise.
+     *  - If the SDK is initialized and enabled.
+     *  - If tracking link is successfully handled.
+     */
+    static impression(
+        trackingLink: string,
+        onSuccess?: () => void,
+        onFailure?: ((error: Error) => void)
+    ): Promise<boolean> {
+        return this.#dependency.placementModule.impression(trackingLink, onSuccess, onFailure)
+    }
+
+    // register
+
+    /**
+     * Sets the user ID.
+     * @param id The user ID.
+     */
+    static setUserID(id: string): void {
+        this.#dependency.registerModule.setUserID(id)
+    }
+
+    /**
+     * Clear the user ID.
+     */
+    static clearUserID(): void {
+        this.#dependency.registerModule.clearUserID()
+    }
+
+    /**
+     * Sets the user email.
+     * @param email The user email.
+     */
+    static setUserEmail(email: string): void {
+        this.#dependency.registerModule.setUserEmail(email)
+    }
+
+    /**
+     * Clear the user email.
+     */
+    static clearUserEmail(): void {
+        this.#dependency.registerModule.clearUserEmail()
+    }
+
+    /**
+     * Sets the user phone number.
+     * @param phone The user phone number.
+     */
+    static setUserPhone(phone: string): void {
+        this.#dependency.registerModule.setUserPhone(phone)
+    }
+
+    /**
+     * Clear the user phone number.
+     */
+    static clearUserPhone(): void {
+        this.#dependency.registerModule.clearUserPhone()
+    }
+
+    /**
+     * Sets the key, value pair to the user attribute.
+     * @param key The key that uniquely identifies the user attribute.
+     * @param value The value to set for the user attribute.
+     */
+    static setUserAttribute(key: string, value: any): void {
+        this.#dependency.registerModule.setUserAttribute(key, value)
+    }
+
+    /**
+     * Removes the user attribute with the given key.
+     * @param key The key that uniquely identifies the user attribute.
+     */
+    static removeUserAttribute(key: string): void {
+        this.#dependency.registerModule.removeUserAttribute(key)
+    }
+
+    /**
+     * Clears all user attributes.
+     */
+    static clearUserAttributes(): void {
+        this.#dependency.registerModule.clearUserAttributes()
+    }
+
+    /**
+     * Sets the key, value pair to the user alias.
+     * @param key The key that uniquely identifies the user alias.
+     * @param value The value to set for the user alias.
+     */
+    static setUserAlias(key: string, value: string): void {
+        this.#dependency.registerModule.setUserAlias(key, value)
+    }
+
+     /**
+     * Removes the user alias with the given key.
+     * @param key The key that uniquely identifies the user alias.
+     */
+     static removeUserAlias(key: string): void {
+        this.#dependency.registerModule.removeUserAlias(key)
+    }
+
+    /**
+     * Clears all user aliases.
+     */
+    static clearUserAlias(): void {
+        this.#dependency.registerModule.clearUserAlias()
+    }
+
+    /**
+     * Clears all user information.
+     */
+    static clearUser(): void {
+        this.#dependency.registerModule.clearUser()
+    }
+
+    /**
+     * Sets the key, value pair to the device alias.
+     * @param key The key that uniquely identifies the device alias.
+     * @param value The value to set for the device alias.
+     */
+    static setDeviceAlias(key: string, value: string): void {
+        this.#dependency.registerModule.setDeviceAlias(key, value)
+    }
+
+    /**
+     * Removes the device alias with the given key.
+     * @param key The key that uniquely identifies the device alias.
+     */
+    static removeDeviceAlias(key: string): void {
+        this.#dependency.registerModule.removeDeviceAlias(key)
+    }
+
+    /**
+     * Clears all device aliases.
+     */
+    static clearDeviceAlias(): void {
+        this.#dependency.registerModule.clearDeviceAlias()
+    }
+
+    /**
+     * Registers the FCM or APNS registration token to track app uninstalls.
+     * @param token The FCM or APNS registration token.
+     */
+    static registerPushToken(token: string): void {
+        this.#dependency.registerModule.registerPushToken(token)
+    }
+
+    // switch
+
+    /**
+     * Enables the SDK.
+     */
+    static enableSDK(): void {
+        this.#dependency.switchModule.enableSDK()
+    }
+
+    /**
+     * Disables the SDK.
+     */
+    static disableSDK(): void {
+        this.#dependency.switchModule.disableSDK()
+    }
+
+    /**
+     * Checks whether the SDK is currently enabled.
+     * @return `true` if the SDK is enabled, `false` otherwise.
+     */
+    static isSDKEnabled(): Promise<boolean> {
+        return this.#dependency.switchModule.isSDKEnabled()
+    }
+
+    /**
+     * Start collecting and transferring events.
+     */
+    static startTracking(): void {
+        this.#dependency.switchModule.startTracking()
+    }
+
+    /**
+     * Stop collecting and transferring events.
+     */
+    static stopTracking(): void {
+        this.#dependency.switchModule.stopTracking()
+    }
+
+    /**
+     * Checks whether the tracking feature of SDK is currently enabled.
+     * @return `true` if the tracking feature of SDK tracking is enabled,`false` otherwise.
+     */
+    static isTrackingEnabled(): Promise<boolean> {
+        return this.#dependency.switchModule.isSDKEnabled()
+    }
+
+    // web interface
+
+    /**
+     * Creates a script that initialize the web interface.
+     * @param webToken The token to initialize Airbridge Web SDK.
+     * @param postMessageScript The JavaScript code to post commands from web to app.
+     * @return web interface script
+     */
+    static createWebInterfaceScript(
+        webToken: string,
+        postMessageScript: string,
+    ): Promise<string|undefined> {
+        return this.#dependency.webInterfaceModule.createWebInterfaceScript(webToken, postMessageScript)
+    }
+
+    /**
+     * Handles commands from the web interface.
+     * @param command The command to handle.
+     */
+    static handleWebInterfaceCommand(command: string): void {
+        this.#dependency.webInterfaceModule.handleWebInterfaceCommand(command)
+    }
+}

package/source/architecture/Interactor.ts

@@ -0,0 +1,10 @@
+export type Interactor = {}
+
+export const createInteractor = <ActualInteractor extends Interactor> (
+    nativeModule: any,
+): ActualInteractor => {
+    return Object.assign(nativeModule, {
+        ios: nativeModule,
+        android: nativeModule,
+    })
+}

package/source/architecture/module.ts

@@ -0,0 +1 @@
+export type Module = {}

package/source/constant/AirbridgeAttribute.ts

@@ -0,0 +1,188 @@
+/**
+ * Contains key of semantic attributes.
+ */
+export class AirbridgeAttribute {
+    static get ACTION() {
+        return 'action'
+    }
+
+    static get LABEL() {
+        return 'label'
+    }
+
+    static get VALUE() {
+        return 'value'
+    }
+
+    static get CURRENCY() {
+        return 'currency'
+    }
+
+    static get ORIGINAL_CURRENCY() {
+        return 'originalCurrency'
+    }
+
+    static get PRODUCTS() {
+        return 'products'
+    }
+
+    static get PERIOD() {
+        return 'period'
+    }
+
+    static get IS_RENEWAL() {
+        return 'isRenewal'
+    }
+
+    static get RENEWAL_COUNT() {
+        return 'renewalCount'
+    }
+
+    static get PRODUCT_LIST_ID() {
+        return 'productListID'
+    }
+
+    static get CART_ID() {
+        return 'cartID'
+    }
+
+    static get TRANSACTION_ID() {
+        return 'transactionID'
+    }
+
+    static get TRANSACTION_TYPE() {
+        return 'transactionType'
+    }
+
+    static get TRANSACTION_PAIRED_EVENT_CATEGORY() {
+        return 'transactionPairedEventCategory'
+    }
+
+    static get TRANSACTION_PAIRED_EVENT_TIMESTAMP() {
+        return 'transactionPairedEventTimestamp'
+    }
+
+    static get TOTAL_QUANTITY() {
+        return 'totalQuantity'
+    }
+
+    static get QUERY() {
+        return 'query'
+    }
+
+    static get IN_APP_PURCHASED() {
+        return 'inAppPurchased'
+    }
+
+    static get CONTRIBUTION_MARGIN() {
+        return 'contributionMargin'
+    }
+
+    static get ORIGINAL_CONTRIBUTION_MARGIN() {
+        return 'originalContributionMargin'
+    }
+
+    static get LIST_ID() {
+        return 'listID'
+    }
+
+    static get RATE_ID() {
+        return 'rateID'
+    }
+
+    static get RATE() {
+        return 'rate'
+    }
+
+    static get MAX_RATE() {
+        return 'maxRate'
+    }
+
+    static get ACHIEVEMENT_ID() {
+        return 'achievementID'
+    }
+
+    static get SHARED_CHANNEL() {
+        return 'sharedChannel'
+    }
+
+    static get DATE_TIME() {
+        return 'datetime'
+    }
+
+    static get DESCRIPTION() {
+        return 'description'
+    }
+
+    static get IS_REVENUE() {
+        return 'isRevenue'
+    }
+
+    static get PLACE() {
+        return 'place'
+    }
+
+    static get SCHEDULE_ID() {
+        return 'scheduleID'
+    }
+
+    static get TYPE() {
+        return 'type'
+    }
+
+    static get LEVEL() {
+        return 'level'
+    }
+
+    static get SCORE() {
+        return 'score'
+    }
+
+    static get PRODUCT_ID() {
+        return 'productID'
+    }
+
+    static get PRODUCT_NAME() {
+        return 'name'
+    }
+
+    static get PRODUCT_PRICE() {
+        return 'price'
+    }
+
+    static get PRODUCT_QUANTITY() {
+        return 'quantity'
+    }
+
+    static get PRODUCT_CURRENCY() {
+        return 'currency'
+    }
+
+    static get PRODUCT_POSITION() {
+        return 'position'
+    }
+
+    static get PRODUCT_CATEGORY_ID() {
+        return 'categoryID'
+    }
+
+    static get PRODUCT_CATEGORY_NAME() {
+        return 'categoryName'
+    }
+
+    static get PRODUCT_BRAND_ID() {
+        return 'brandID'
+    }
+
+    static get PRODUCT_BRAND_NAME() {
+        return 'brandName'
+    }
+
+    static get AD_PARTNERS() {
+        return 'adPartners'
+    }
+
+    static get IS_FIRST_PER_USER() {
+        return 'isFirstPerUser'
+    }
+}

package/source/constant/AirbridgeCategory.ts

@@ -0,0 +1,104 @@
+/**
+ * Contains category of standard events.
+ */
+export class AirbridgeCategory {
+    static get SIGN_UP() {
+        return 'airbridge.user.signup'
+    }
+
+    static get SIGN_IN() {
+        return 'airbridge.user.signin'
+    }
+
+    static get SIGN_OUT() {
+        return 'airbridge.user.signout'
+    }
+
+    static get HOME_VIEWED() {
+        return 'airbridge.ecommerce.home.viewed'
+    }
+
+    static get PRODUCT_LIST_VIEWED() {
+        return 'airbridge.ecommerce.productList.viewed'
+    }
+
+    static get SEARCH_RESULTS_VIEWED() {
+        return 'airbridge.ecommerce.searchResults.viewed'
+    }
+
+    static get PRODUCT_VIEWED() {
+        return 'airbridge.ecommerce.product.viewed'
+    }
+
+    static get ADD_PAYMENT_INFO() {
+        return 'airbridge.addPaymentInfo'
+    }
+
+    static get ADD_TO_WISHLIST() {
+        return 'airbridge.addToWishlist'
+    }
+
+    static get ADDED_TO_CART() {
+        return 'airbridge.ecommerce.product.addedToCart'
+    }
+
+    static get INITIATE_CHECKOUT() {
+        return 'airbridge.initiateCheckout'
+    }
+
+    static get ORDER_COMPLETED() {
+        return 'airbridge.ecommerce.order.completed'
+    }
+
+    static get ORDER_CANCELED() {
+        return 'airbridge.ecommerce.order.canceled'
+    }
+
+    static get START_TRIAL() {
+        return 'airbridge.startTrial'
+    }
+
+    static get SUBSCRIBE() {
+        return 'airbridge.subscribe'
+    }
+
+    static get UNSUBSCRIBE() {
+        return 'airbridge.unsubscribe'
+    }
+
+    static get AD_IMPRESSION() {
+        return 'airbridge.adImpression'
+    }
+
+    static get AD_CLICK() {
+        return 'airbridge.adClick'
+    }
+
+    static get COMPLETE_TUTORIAL() {
+        return 'airbridge.completeTutorial'
+    }
+
+    static get ACHIEVE_LEVEL() {
+        return 'airbridge.achieveLevel'
+    }
+
+    static get UNLOCK_ACHIEVEMENT() {
+        return 'airbridge.unlockAchievement'
+    }
+
+    static get RATE() {
+        return 'airbridge.rate'
+    }
+
+    static get SHARE() {
+        return 'airbridge.share'
+    }
+
+    static get SCHEDULE() {
+        return 'airbridge.schedule'
+    }
+
+    static get SPEND_CREDITS() {
+        return 'airbridge.spendCredits'
+    }
+}

package/source/module/Attribution.ts

@@ -0,0 +1,56 @@
+import { NativeModules, NativeEventEmitter } from 'react-native'
+
+import { createInteractor } from '../architecture/Interactor'
+import { check } from '../utility/check'
+import { log } from '../utility/log'
+
+export const createDependency = () => {}
+
+type AttributionInteractor = {
+    listen(): void
+}
+
+createDependency.AttributionModule = () => ({
+    emitter: new NativeEventEmitter(NativeModules.AttributionInteractor),
+    interactor: createInteractor<AttributionInteractor>(NativeModules.AttributionInteractor),
+})
+
+export type AttributionModule = ReturnType<typeof createAttributionModule>
+
+export const createAttributionModule= () => {
+    // create dependency
+    const { emitter, interactor } = createDependency.AttributionModule()
+
+    let cache: Record<string, string> | undefined
+    let listener: (result: Record<string, string>) => void = (result) => {
+        cache = result
+    }
+
+    // initialize
+    emitter.addListener('airbridge.attribution', (result) => {
+        listener(result)
+    })
+    interactor.listen()
+
+    // define method
+    const setOnAttributionReceived = (
+        onReceived: (attribution: Record<string, string>) => void,
+    ): void => {
+        if (!check.function(onReceived)) {
+            log.unmatchedType('onReceived', 'function')
+            return
+        }
+
+        if (cache !== undefined) {
+            onReceived(cache)
+            cache = undefined
+        }
+
+        listener = onReceived
+    }
+
+    // create object
+    return {
+        setOnAttributionReceived,
+    }
+}