airbridge-react-native-sdk-restricted 2.5.2

package/index.d.ts

@@ -0,0 +1,292 @@
+declare module "airbridge-react-native-sdk-restricted" {
+
+    /**
+     * main class (singleton)
+     */
+    class Airbridge {
+        event: Event;
+        deeplink: Deeplink;
+        state: State;
+        placement: Placement;
+
+        /**
+         * Set device alias
+         * @param {string} key - device alias key
+         * @param {string} value - device alias value
+         */
+        setDeviceAlias(key: string, value: string): void;
+
+        /**
+         * Remove device alias
+         * @param {string} key - callback of attribution
+         */
+        removeDeviceAlias(key: string): void;
+
+        /**
+         * clear device alias
+         */
+        clearDeviceAlias(): void;
+
+        /**
+         * Send event to server.
+         * @param {string} category event name
+         * @param {EventOption} [option={}] event options
+         */
+        trackEvent(category: string, option?: EventOption): void;
+
+        /**
+         * register push token
+         * @param {string} token - push token
+         */
+        registerPushToken(token: string): void;
+
+        /**
+         * create interface of webview
+         * @param webToken token for airbridge web sdk that using on webview
+         * @param postCommandFunction notify to interface how to post command to native
+         * @returns {WebInterface} Web Interface
+         */
+        createWebInterface(
+            webToken: string,
+            postCommandFunction: (command: string) => string,
+        ): WebInterface;
+    }
+
+    /**
+     * class for interface of webview
+     */
+    class WebInterface {
+        script: string;
+        /**
+         * handle command from webview
+         * @param {String} command command from webview
+         */
+        handle(command: string): void;
+    }
+
+    /**
+     * @param deeplink - URL of deeplink
+     */
+    type DeeplinkListener = (deeplink: string | null) => void;
+
+    /**
+     * class for set SDK's deeplink behavior (singleton)
+     */
+    class Deeplink {
+        /**
+         * Set DeeplinkListener (listen deeplink or deferred-deeplink)<br/>
+         * @param listener - callback of deeplink & deferred-deeplink
+         */
+        setDeeplinkListener(listener: DeeplinkListener): void;
+    }
+
+    /**
+     * class for send event (singleton)
+     */
+    class Event {
+        /**
+         * Send event to server.
+         * @param {string} category event name
+         * @param {EventOption} [option={}] event options
+         */
+        trackEvent(category: string, option?: EventOption): void;
+    }
+
+    /**
+     * class for use SDK's placement function (singleton)
+     */
+    class Placement {
+        /**
+         * 1. send +1 click statistics to server<br/>
+         * 2. get deeplink and fallback from server<br/>
+         * 3. open deeplink. when fail, open fallback<br/>
+         * 4. parameter's deeplink, fallback is spare for network-fail
+         * @param trackingLink - created on dashboard
+         */
+        click(trackingLink: string): void;
+        /**
+         * send +1 impression statistics to server<br/>
+         * @param trackingLink - created on dashboard
+         */
+        impression(trackingLink: string): void;
+    }
+
+    /**
+     * @param attribution - URL of attribution
+     */
+    type AttributionListener = (attribution: {
+        [key: string]: string;
+    }) => void;
+
+    /**
+     * class for manage SDK's state (singleton)
+     */
+    class State {
+        /**
+         * set current user<br/>
+         *
+         * user.property is null, if input.property is null
+         * @param user - user infomation
+         */
+        setUser(user: User): void;
+        /**
+         * update current user<br/>
+         *
+         * user.property not be changed, if input.property is null
+         * @param user - user infomation
+         */
+        updateUser(user: User): void;
+        /**
+         * make airbridge start tracking
+         */
+        startTracking(): void;
+        /**
+         * get deviceUUID of Airbridge SDK.
+         */
+        deviceUUID(): Promise<string>;
+        /**
+         * Set AttributionListener (listen attribution)<br/>
+         * @param listener - callback of attribution
+         */
+        setAttributionListener(listener: AttributionListener): void;
+
+        /**
+         * Set device alias
+         * @param {string} key - device alias key
+         * @param {string} value - device alias value
+         */
+        setDeviceAlias(key: string, value: string): void;
+
+        /**
+         * Remove device alias
+         * @param {string} key - callback of attribution
+         */
+        removeDeviceAlias(key: string): void;
+
+        /**
+         * clear device alias
+         */
+        clearDeviceAlias(): void;
+
+        /**
+         * register push token
+         * @param {string} token - push token
+         */
+        registerPushToken(token: string): void;
+    }
+
+    class WebInterface {
+
+        /**
+         * handle command from webview
+         */
+        public readonly script: string;
+
+        /**
+         * handle command from webview
+         * @param {String} command command from webview
+         */
+        handle(command: string): void;    
+    }
+
+    /**
+     * @property {string} [action] event group name 1
+     * @property {string} [label] event group name 2
+     * @property {number} [value] event custom value
+     * @property {{}} [customAttributes] event custom attributes
+     * @property {{}} [semanticAttributes] event semantic attributes
+     */
+    type EventOption = {
+        action?: string;
+        label?: string;
+        value?: number;
+        customAttributes?: {
+            [key: string]: string;
+        };
+        semanticAttributes?: {
+            [key: string]: any;
+        };
+    };
+
+    /**
+     * @property {string} [ID] - Product's unique identifier
+     * @property {string} [name] - Product's name
+     * @property {string} [currency] - currency in <a href='https://en.wikipedia.org/wiki/ISO_4217'>ISO 4217<a/>
+     * @property {number} [price] - Product's price
+     * @property {number} [quantity] - Purchased quantity
+     * @property {number} [position] - Product's index in list
+     */
+    type Product = {
+        ID?: string;
+        name?: string;
+        currency?: string;
+        price?: number;
+        quantity?: number;
+        position?: number;
+    };
+
+    /**
+     * @property {string} [ID] - User's ID (not allow empty string)
+     * @property {string} [email] - User's Email (not allow empty string)
+     * @property {string} [phone] - User's Phone Number (not allow empty string)
+     * @property {{}} [alias] - User's Alias
+     * @property {{}} [attributes] - User's Attributes
+     */
+    type User = {
+        ID?: string;
+        email?: string;
+        phone?: string;
+        alias?: {
+            [key: string]: string;
+        };
+        attributes?: {
+            [key: string]: any;
+        };
+    };
+
+    const AirbridgeCategory: {
+        SIGN_UP: string
+        SIGN_IN: string
+        SIGN_OUT: string
+
+        HOME_VIEW: string
+        SEARCH_RESULT_VIEW: string
+        PRODUCT_LIST_VIEW: string
+        PRODUCT_DETAILS_VIEW: string
+
+        ADD_TO_CART: string
+        ORDER_COMPLETED: string
+    }
+
+    const AirbridgeAttributes: {
+        QUERY: string
+        PRODUCT_LIST_ID: string
+        CART_ID: string
+        TRANSACTION_ID: string
+        PRODUCTS: string
+        IN_APP_PURCHASED: string
+        CURRENCY: string
+        TOTAL_VALUE: string
+        TOTAL_QUANTITY: string
+    }
+
+    const AirbridgeProduct: {
+        PRODUCT_ID: string
+        NAME: string
+        CURRENCY: string
+        PRICE: string
+        QUANTITY: string
+        POSITION: string
+    }
+
+    const airbridge: Airbridge;
+
+    export default airbridge;
+
+    export {
+        AirbridgeCategory,
+        AirbridgeAttributes,
+        AirbridgeProduct,
+        WebInterface,
+    }
+}

package/index.js

@@ -0,0 +1,8 @@
+import Airbridge from './src/Airbridge';
+
+export * from './src/type/AirbridgeCategory';
+export * from './src/type/AirbridgeProduct';
+export * from './src/type/AirbridgeAttributes';
+export * from './src/WebInterface';
+
+export default Airbridge;

package/ios/AirbridgeRN/ARNConfigReader.h

@@ -0,0 +1,19 @@
+//
+//  ARNConfigReader.h
+//  AirbridgeRN
+//
+//  Created by WOF on 2020/06/22.
+//  Copyright © 2020 ab180. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface ARNConfigReader : NSObject
+
++ (void) apply;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/ios/AirbridgeRN/ARNConfigReader.m

@@ -0,0 +1,79 @@
+//
+//  ARNConfigReader.m
+//  AirbridgeRN
+//
+//  Created by WOF on 2020/06/22.
+//  Copyright © 2020 ab180. All rights reserved.
+//
+
+#import "ARNConfigReader.h"
+
+#import "AirbridgeAttribution.h"
+#import "ARNGet.h"
+
+#import <AirBridge/AirBridge.h>
+
+@implementation ARNConfigReader
+
++ (void) apply {
+    NSString* path = [NSBundle.mainBundle pathForResource:@"airbridge" ofType:@"json"];
+    NSData* data = [NSData dataWithContentsOfFile:path];
+    NSDictionary* json = nil;
+    if (data != nil) {
+        json = [NSJSONSerialization JSONObjectWithData:data options:0 error:nil];
+    }
+    
+    NSNumber* sessionTimeoutSeconds = [ARNGet type:NSNumber.class dictionary:json key:@"sessionTimeoutSeconds"];
+    if (sessionTimeoutSeconds != nil) {
+        [AirBridge setSessionTimeout:sessionTimeoutSeconds.intValue * 1000];
+    }
+    
+    NSNumber* autoStartTrackingEnabled = [ARNGet type:NSNumber.class dictionary:json key:@"autoStartTrackingEnabled"];
+    if (autoStartTrackingEnabled != nil) {
+        [AirBridge setAutoStartTrackingEnabled:autoStartTrackingEnabled.boolValue];
+    }
+    
+    NSNumber* userInfoHashEnabled = [ARNGet type:NSNumber.class dictionary:json key:@"userInfoHashEnabled"];
+    if (userInfoHashEnabled != nil) {
+        [AirBridge setIsUserInfoHashed:userInfoHashEnabled.boolValue];
+    }
+    
+    NSNumber* trackAirbridgeLinkOnly = [ARNGet type:NSNumber.class dictionary:json key:@"trackAirbridgeLinkOnly"];
+    if (trackAirbridgeLinkOnly != nil) {
+        [AirBridge setIsTrackAirbridgeDeeplinkOnly:trackAirbridgeLinkOnly.boolValue];
+    }
+    
+    NSNumber* facebookDeferredAppLinkEnabled = [ARNGet type:NSNumber.class dictionary:json key:@"facebookDeferredAppLinkEnabled"];
+    if (facebookDeferredAppLinkEnabled != nil) {
+        [AirBridge setIsFacebookDeferredAppLinkEnabled:facebookDeferredAppLinkEnabled.boolValue];
+    }
+
+    NSNumber* trackingAuthorizeTimeoutSeconds = [ARNGet type:NSNumber.class dictionary:json key:@"trackingAuthorizeTimeoutSeconds"];
+    if (trackingAuthorizeTimeoutSeconds != nil) {
+        AirBridge.setting.trackingAuthorizeTimeout = trackingAuthorizeTimeoutSeconds.unsignedLongLongValue * 1000;
+    }
+    
+    NSString* secretID = [ARNGet type:NSString.class dictionary:json key:@"sdkSignatureSecretID"];
+    NSString* secretKey = [ARNGet type:NSString.class dictionary:json key:@"sdkSignatureSecret"];
+    if (secretID != nil && secretKey != nil) {
+        [AirBridge setSDKSignatureSecretWithID:secretID secret:secretKey];
+    }
+
+    NSString* logLevel = [ARNGet type:NSString.class dictionary:json key:@"logLevel"] ?: @"";
+    [AirBridge setLogLevel:(
+        [@{
+            @"debug": @(AB_LOG_DEBUG),
+            @"info": @(AB_LOG_INFO),
+            @"warning": @(AB_LOG_WARNING),
+            @"error": @(AB_LOG_CRITICAL),
+            @"fault": @(AB_LOG_CRASH)
+        } objectForKey: [logLevel lowercaseString]
+        ] ?: @(AB_LOG_WARNING)
+    )];
+
+    [AirBridge.state setSDKDevelopmentPlatform:@"react_native"];
+    
+    [AirbridgeAttribution setInitialAttributionCallback];
+}
+
+@end

package/ios/AirbridgeRN/ARNGet.h

@@ -0,0 +1,20 @@
+//
+//  ARNGet.h
+//  AirbridgeRN
+//
+//  Created by WOF on 17/10/2019.
+//
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface ARNGet : NSObject
+
++ (nullable id) type:(Class)type object:(nullable id)object;
++ (nullable id) type:(Class)type dictionary:(nullable NSDictionary*)dictionary key:(NSString*)key;
++ (nullable id) type:(Class)type array:(nullable NSArray*)array index:(int)index;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/ios/AirbridgeRN/ARNGet.m

@@ -0,0 +1,40 @@
+//
+//  ARNGet.m
+//  AirbridgeRN
+//
+//  Created by WOF on 17/10/2019.
+//
+
+#import "ARNGet.h"
+
+@implementation ARNGet
+
++ (nullable id) type:(Class)type object:(nullable id)object {
+    if (object == nil || [object isKindOfClass:type]) {
+        return object;
+    } else {
+        return nil;
+    }
+}
+
++ (nullable id) type:(Class)type dictionary:(nullable NSDictionary*)dictionary key:(NSString*)key {
+    if (dictionary == nil) {
+        return nil;
+    }
+    
+    NSObject* object = dictionary[key];
+    
+    return [ARNGet type:type object:object];
+}
+
++ (nullable id) type:(Class)type array:(nullable NSArray*)array index:(int)index {
+    if (array == nil || index < 0 || index > array.count) {
+        return nil;
+    }
+    
+    NSObject* object = array[index];
+    
+    return [ARNGet type:type object:object];
+}
+
+@end

package/ios/AirbridgeRN/AirbridgeAttribution.h

@@ -0,0 +1,19 @@
+//
+//  AirbridgeAttribution.h
+//  AirbridgeRN
+//
+//  Created by WOF on 2022/01/25.
+//
+
+#import <React/RCTBridgeModule.h>
+#import <React/RCTEventEmitter.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface AirbridgeAttribution : RCTEventEmitter <RCTBridgeModule>
+
++ (void) setInitialAttributionCallback;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/ios/AirbridgeRN/AirbridgeAttribution.m

@@ -0,0 +1,47 @@
+//
+//  AirbridgeAttribution.m
+//  AirbridgeRN
+//
+//  Created by WOF on 2022/01/25.
+//
+
+#import "AirbridgeAttribution.h"
+
+#import <AirBridge/AirBridge.h>
+
+@implementation AirbridgeAttribution
+
+static NSDictionary* initialAttribution = nil;
+
++ (void) setInitialAttributionCallback {
+    AirBridge.setting.attributionCallback = ^(NSDictionary<NSString*, NSString*>* attribution) {
+        initialAttribution = attribution;
+    };
+}
+
+RCT_EXPORT_MODULE();
+
+RCT_EXPORT_METHOD(listen) {
+    if (initialAttribution != nil) {
+        [self sendEventWithName:@"airbridge.attribution" body:initialAttribution];
+        initialAttribution = nil;
+    }
+    
+    AirBridge.setting.attributionCallback = ^(NSDictionary<NSString*, NSString*>* attribution) {
+        [self sendEventWithName:@"airbridge.attribution" body:attribution];
+    };
+}
+
+- (NSArray<NSString *> *)supportedEvents {
+    return @[@"airbridge.attribution"];
+}
+
++ (BOOL)requiresMainQueueSetup {
+    return YES;
+}
+
+- (dispatch_queue_t)methodQueue {
+    return dispatch_get_main_queue();
+}
+
+@end

package/ios/AirbridgeRN/AirbridgeDeeplink.h

@@ -0,0 +1,20 @@
+//
+//  AirbridgeDeeplink.h
+//  AirbridgeRN
+//
+//  Created by WOF on 15/04/2019.
+//  Copyright © 2019 ab180. All rights reserved.
+//
+
+#import <React/RCTBridgeModule.h>
+#import <React/RCTEventEmitter.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface AirbridgeDeeplink : RCTEventEmitter <RCTBridgeModule>
+
++ (void) setInitialDeeplinkCallback;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/ios/AirbridgeRN/AirbridgeDeeplink.m

@@ -0,0 +1,59 @@
+//
+//  AirbridgeDeeplink.m
+//  AirbridgeRN
+//
+//  Created by WOF on 15/04/2019.
+//  Copyright © 2019 ab180. All rights reserved.
+//
+
+#import "AirbridgeDeeplink.h"
+
+// Airbridge
+#import <AirBridge/AirBridge.h>
+
+@implementation AirbridgeDeeplink
+
+static NSString* initialDeeplink;
+
++ (void) setInitialDeeplinkCallback {
+    [AirBridge.deeplink setDeeplinkCallback:^(NSString* deeplink) {
+        initialDeeplink = deeplink;
+    }];
+}
+
+//
+// react native method
+//
+
+RCT_EXPORT_MODULE();
+
+RCT_EXPORT_METHOD(listen) {
+    __block AirbridgeDeeplink* _self = self;
+
+    if (initialDeeplink != nil) {
+        [_self sendEventWithName:@"airbridge.deeplink" body:initialDeeplink];
+        initialDeeplink = nil;
+    }
+
+    [AirBridge.deeplink setDeeplinkCallback:^(NSString* deeplink) {
+        [_self sendEventWithName:@"airbridge.deeplink" body:deeplink];
+    }];
+}
+
+//
+// override
+//
+
+- (NSArray<NSString*>*)supportedEvents {
+    return @[@"airbridge.deeplink"];
+}
+
++ (BOOL)requiresMainQueueSetup {
+    return YES;
+}
+
+- (dispatch_queue_t)methodQueue {
+    return dispatch_get_main_queue();
+}
+
+@end

package/ios/AirbridgeRN/AirbridgeEvent.h

@@ -0,0 +1,17 @@
+//
+//  AirbridgeEvent.h
+//  AirbridgeRN
+//
+//  Created by WOF on 15/04/2019.
+//  Copyright © 2019 ab180. All rights reserved.
+//
+
+#import <React/RCTBridgeModule.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface AirbridgeEvent : NSObject <RCTBridgeModule>
+
+@end
+
+NS_ASSUME_NONNULL_END

package/ios/AirbridgeRN/AirbridgeEvent.m

@@ -0,0 +1,63 @@
+//
+//  AirbridgeEvent.m
+//  AirbridgeRN
+//
+//  Created by WOF on 15/04/2019.
+//  Copyright © 2019 ab180. All rights reserved.
+//
+
+#import "AirbridgeEvent.h"
+
+// Airbridge
+#import <AirBridge/AirBridge.h>
+#import <AirBridge/ABUserEvent.h>
+#import <AirBridge/ABEcommerceEvent.h>
+// AB
+#import "ARNGet.h"
+
+@implementation AirbridgeEvent
+
+//
+// react native method
+//
+
+RCT_EXPORT_MODULE();
+
+RCT_EXPORT_METHOD(trackEvent:(NSString*)category option:(nullable NSDictionary*)option) {    
+    ABInAppEvent* event = [[ABInAppEvent alloc] init];
+    
+    [event setCategory:category];
+    addOptionToEvent(event, option);
+    
+    [event send];
+}
+
+//
+// private - tool
+//
+
+/**
+ * Add option infomation to event
+ * @discussion  add nil when some data has unmatch type
+ * @param       event
+ *                  target event
+ * @param       option
+ *                  dictionary which has option infomation
+ */
+static void addOptionToEvent(ABInAppEvent* event, NSDictionary* __nullable option) {
+    if(option == nil) return;
+    
+    NSString* action = [ARNGet type:NSString.class dictionary:option key:@"action"];
+    NSString* label = [ARNGet type:NSString.class dictionary:option key:@"label"];
+    NSNumber* value = [ARNGet type:NSNumber.class dictionary:option key:@"value"];
+    NSDictionary* attributes = [ARNGet type:NSDictionary.class dictionary:option key:@"customAttributes"];
+    NSDictionary* semantics = [ARNGet type:NSDictionary.class dictionary:option key:@"semanticAttributes"];
+    
+    [event setAction:action];
+    [event setLabel:label];
+    [event setValue:value];
+    [event setCustoms:attributes];
+    [event setSemantics:semantics];
+}
+
+@end