airbridge-react-native-sdk-restricted 4.2.0 → 4.3.0

package/qa/source/navigations/Stack.js

@@ -15,6 +15,7 @@ import { RequestPermissionsPage } from '../pages/RequestPermissions'
 import BrowsePage from '../pages/Browse'
 import AppInfoPage from '../pages/AppInfo'
 import SkadPage from '../pages/Skad'
+import TrackingLinkPage from '../pages/TrackingLink'
 
 const Stack = createStackNavigator()
 
@@ -110,6 +111,12 @@ const StackNavigation = () => {
                     headerLeft: () => createNavigateBackButton(navigation),
                     headerRight: () => createNavigateHomeButton(navigation)
                 })} />
+            <Stack.Screen name='createTrackingLink'
+                component={TrackingLinkPage}
+                options={({ navigation }) => ({
+                    headerLeft: () => createNavigateBackButton(navigation),
+                    headerRight: () => createNavigateHomeButton(navigation)
+                })} />
         </Stack.Navigator>  
     )
 }

package/qa/source/pages/Home.js

@@ -105,6 +105,11 @@ export default function HomePage({ navigation }) {
         title={'Tracking Links Within Apps'}
         accessibilityLabel={'trackingLinksWithinApps'}
         onPress={() => navigation.navigate('trackingLinksWithinApps')} />
+      <CustomButton
+        buttonColor={Colors.blue}
+        title={'Create Tracking Link'}
+        accessibilityLabel={'Create Tracking Link'}
+        onPress={() => navigation.navigate('createTrackingLink')} />
       <CustomButton
         buttonColor={Colors.teal}
         title={'Browse'}

package/qa/source/pages/Identifiers.js

@@ -27,11 +27,13 @@ export default class IdentifiersPage extends Component {
       gaid: 'N/A',
       fcmToken: storage.get('fcmToken') ?? 'N/A',
       apnsToken: storage.get('apnsToken') ?? 'N/A',
+      airbridgeJSON: '-'
     };
 
     this.confirmRef = React.createRef()
 
     this.fetchIdentifiers()
+    this.fetchAirbridgeJSON()
 
     if (Platform.OS === 'ios') {
       fcmService.requestPermission()
@@ -40,7 +42,7 @@ export default class IdentifiersPage extends Component {
 
   fetchIdentifiers = async () => {
     const response = await NativeModules.IdentifiersInteractor.identifiers()
-    console.log('response : ' + response)
+    console.log('fetchIdentifiers response : ' + response)
     const jsonData = JSON.parse(response)
     const data = jsonData['data']
     this.setState({ 
@@ -51,6 +53,14 @@ export default class IdentifiersPage extends Component {
     })
   }
 
+  fetchAirbridgeJSON = async () => {
+    const response = await NativeModules.IdentifiersInteractor.airbridgeJSON()
+    console.log('fetchAirbridgeJSON response : ' + response)
+    this.setState({ 
+      airbridgeJSON: response
+    })
+  }
+
   reloadToken = async () => {
     this.setState({ 
       fcmToken: 'Reloading..',
@@ -101,6 +111,10 @@ export default class IdentifiersPage extends Component {
             title={'PushToken'} 
             text={this.state.apnsToken}
             accessibilityLabel={'airbridgePushToken'} />
+          <VerticalPreference 
+            title={'airbridgeJSON'} 
+            text={this.state.airbridgeJSON}
+            accessibilityLabel={'airbridgeJSON'} />
 
           <ConfirmDialog
             ref={this.confirmRef}

package/qa/source/pages/TrackingLink.js

@@ -0,0 +1,162 @@
+import React, { Component } from 'react'
+import { View } from 'react-native'
+
+import { Styles } from '../common/Styles'
+import { Colors } from '../common/Colors'
+import CustomButton from '../component/CustomButton'
+import CustomTextInput from '../component/CustomTextInput'
+
+import { Airbridge, AirbridgeTrackingLinkOption } from 'airbridge-react-native-sdk-restricted';
+
+import VerticalPreference from '../component/VerticalPreference';
+
+export default class TrackingLinkPage extends Component {
+
+  constructor(props) {
+    super(props);
+
+    this.state = {
+      channel: '',
+      option: '',
+      shortURL: '',
+      qrcodeURL: ''
+    }
+  }
+
+  request = () => {
+    var outputChannel = this.state.channel.trim()
+    var flatOption = this.state.option.trim()
+    outputChannel = outputChannel.length == 0 ? null : outputChannel
+    flatOption = flatOption.length == 0 ? '{}' : flatOption
+
+    console.log(`outputChannel: ${outputChannel}`)
+    console.log(`flatOption: ${flatOption}`)
+
+    if (outputChannel == null || flatOption == null) {
+      return
+    }
+
+    var outputOption = null
+    try {
+      outputOption = JSON.parse(flatOption)
+    } catch (error) {
+      console.log(`TrackingLinkPage request error : ${error}`)
+      return
+    }
+
+    if (outputOption == null) {
+      return
+    }
+
+    Airbridge.createTrackingLink(
+      outputChannel,
+      outputOption,
+      (airbridgeTrackingLink) => {
+        console.log(`airbridgeTrackingLink. shortURL: ${airbridgeTrackingLink.shortURL}`)
+        this.setState({
+          shortURL: airbridgeTrackingLink.shortURL,
+          qrcodeURL: airbridgeTrackingLink.qrcodeURL,
+        })
+      }
+    )
+  }
+
+  clear = () => {
+    this.setState({
+      shortURL: '',
+      qrcodeURL: '',
+    })
+  }
+
+  request_tmp1 = () => {
+    this.request_template(
+      'test',
+      {
+        [AirbridgeTrackingLinkOption.CAMPAIGN]: 'test_campaign',
+        [AirbridgeTrackingLinkOption.AD_GROUP]: 'request_1_group',
+      }
+    )
+  }
+
+  request_tmp2 = () => {
+    this.request_template(
+      'test',
+      {
+        [AirbridgeTrackingLinkOption.CAMPAIGN]: 'test_campaign',
+        [AirbridgeTrackingLinkOption.AD_GROUP]: 'request_2_group',
+      }
+    )
+  }
+
+  request_template = (channel, option) => {
+    Airbridge.createTrackingLink(
+      channel,
+      option,
+      (airbridgeTrackingLink) => {
+        console.log(`airbridgeTrackingLink. shortURL: ${airbridgeTrackingLink.shortURL}`)
+        this.setState({
+          shortURL: airbridgeTrackingLink.shortURL,
+          qrcodeURL: airbridgeTrackingLink.qrcodeURL
+        })
+      }
+    )
+  }
+
+  render() {
+    return (
+      <View style={Styles.container}>
+          <CustomTextInput
+              title={'channel'}
+              placeholder={'channel'}
+              accessibilityLabel='channel'
+              onChangeText={newText => this.setState({ channel: newText })}
+              value={this.state.value} />
+          <View style={{ margin: 4 }} />
+          <CustomTextInput
+              title={'option'}
+              placeholder={'option'}
+              accessibilityLabel='option'
+              onChangeText={newText => this.setState({ option: newText })}
+              value={this.state.value} />
+          <View style={{ margin: 8 }} />
+          <CustomButton
+              buttonColor={Colors.blue}
+              title={'REQUEST'}
+              titleColor='white'
+              accessibilityLabel={'REQUEST'}
+              onPress={() => this.request()} />
+          <CustomButton
+              buttonColor={Colors.blue}
+              title={'clear'}
+              titleColor='white'
+              accessibilityLabel={'clear'}
+              onPress={() => this.clear()} />
+
+          <View style={{ margin: 16 }} />
+          <VerticalPreference 
+            title={'shortUrl'} 
+            text={this.state.shortURL}
+            accessibilityLabel={'shortUrl'} />
+          <VerticalPreference 
+            title={'qrUrl'} 
+            text={this.state.qrcodeURL}
+            accessibilityLabel={'qrUrl'} />
+
+          <View style={{ margin: 16 }} />
+          <CustomButton
+              buttonColor={Colors.blue}
+              title={'request-tmp1'}
+              titleColor='white'
+              accessibilityLabel={'request-tmp1'}
+              onPress={() => this.request_tmp1()} />
+          <CustomButton
+              buttonColor={Colors.blue}
+              title={'request-tmp2'}
+              titleColor='white'
+              accessibilityLabel={'request-tmp2'}
+              onPress={() => this.request_tmp2()} />
+
+      </View>
+    )
+  }
+}

package/readme.md

@@ -6,6 +6,6 @@ Airbridge SDK for React Native
 
 - https://help.airbridge.io/
 
-### Reference
+## Reference
 
 - https://reference.airbridge.io/airbridge-react-native-sdk/latest/

package/source/Airbridge.ts

@@ -7,6 +7,8 @@ import { createRegisterModule } from './module/Register'
 import { createSwitchModule } from './module/Switch'
 import { createWebInterfaceModule } from './module/WebInterface'
 
+import { AirbridgeTrackingLink } from './type/AirbridgeTrackingLink'
+
 export const createDependency = () => {}
 
 createDependency.Airbridge = () => ({
@@ -337,4 +339,22 @@ export class Airbridge {
     static handleWebInterfaceCommand(command: string): void {
         this.#dependency.webInterfaceModule.handleWebInterfaceCommand(command)
     }
-}
+
+    /**
+     * Creates a tracking-link using airbridge-server that move user
+     * to specific page of app and track click-event.
+     * 
+     * @param channel The channel of tracking-link.
+     * @param option The option to create tracking-link.
+     * @param onSuccess Created tracking-link is delivered if succeed.
+     * @param onFailure Error is delivered if failed.
+     */
+    static createTrackingLink(
+        channel: string,
+        option: Record<string, any>,
+        onSuccess: (airbridgeTrackingLink: AirbridgeTrackingLink) => void,
+        onFailure?: (error: Error) => void
+    ): void {
+        this.#dependency.placementModule.createTrackingLink(channel, option, onSuccess, onFailure)
+    }
+}

package/source/constant/AirbridgeTrackingLinkOption.ts

@@ -0,0 +1,122 @@
+/**
+ * Contains key of tracking-link option.
+ */
+export class AirbridgeTrackingLinkOption {
+    /// A campaign parameter. (String)
+    static get CAMPAIGN() {
+        return 'campaign'
+    }
+
+    /// A campaign parameter. (String)
+    static get AD_GROUP() {
+        return 'ad_group'
+    }
+
+    /// A campaign parameter. (String)
+    static get AD_CREATIVE() {
+        return 'ad_creative'
+    }
+
+    /// A campaign parameter. (String)
+    static get CONTENT() {
+        return 'content'
+    }
+
+    /// A campaign parameter. (String)
+    static get TERM() {
+        return 'term'
+    }
+
+    /// A campaign parameter. (String)
+    static get SUB_ID() {
+        return 'sub_id'
+    }
+
+    /// A campaign parameter. (String)
+    static get SUB_ID_1() {
+        return 'sub_id_1'
+    }
+
+    /// A campaign parameter. (String)
+    static get SUB_ID_2() {
+        return 'sub_id_2'
+    }
+
+    /// A campaign parameter. (String)
+    static get SUB_ID_3() {
+        return 'sub_id_3'
+    }
+
+    /// A url of deeplink open the app. (Custom Scheme URL String)
+    static get DEEPLINK_URL() {
+        return 'deeplink_url'
+    }
+
+    /// A option enable stop-over-feature of deeplink. (Boolean)
+    static get DEEPLINK_STOPOVER() {
+        return 'deeplink_stopover'
+    }
+
+    /// A url of fallback for ios if app is not installed. ("store" | Web URL String)
+    static get FALLBACK_IOS() {
+        return 'fallback_ios'
+    }
+
+    /// A url of fallback for android if app is not installed. ("store" | Web URL String)
+    static get FALLBACK_ANDROID() {
+        return 'fallback_android'
+    }
+
+    /// A url of fallback for desktop if app is not installed. (Web URL String)
+    static get FALLBACK_DESKTOP() {
+        return 'fallback_desktop'
+    }
+
+    /// A custom id of store for ios used when user move to store. (String)
+    static get FALLBACK_IOS_STORE_PPID() {
+        return 'fallback_ios_store_ppid'
+    }
+
+    /// A custom id of store for android used when user move to store. (String)
+    static get FALLBACK_ANDROID_STORE_LISTING() {
+        return 'fallback_android_store_listing'
+    }
+
+    /// A title of link-preview. (String)
+    static get OGTAG_TITLE() {
+        return 'ogtag_title'
+    }
+
+    /// A description of link-preview. (String)
+    static get OGTAG_DESCRIPTION() {
+        return 'ogtag_description'
+    }
+
+    /// A image-url of link-preview. (Web URL String)
+    static get OGTAG_IMAGE_URL() {
+        return 'ogtag_image_url'
+    }
+
+    /// A customization of link-preview. ("desktop")
+    /// - Note: Airbridge crawl og-tag from response of FALLBACK_DESKTOP.
+    static get OGTAG_WEBSITE_CRAWL() {
+        return 'ogtag_website_crawl'
+    }
+
+    /// A custom-short-id of tracking-link. (String)
+    /// - Warning: Must be used with CUSTOM_DOMAIN option.
+    /// - Note: Refer example. <https://app.example.com/invite>
+    static get CUSTOM_SHORT_ID() {
+        return 'custom_short_id'
+    }
+
+    /// A option enable re-engagement-feature of attribution. ("off" | "on_true" | "on_false")
+    /// - Note: "off" uses touchpoint from install and deeplink event.
+    /// - Note: "on_true" uses touchpoint from deeplink event only.
+    /// Can be used by re-engagement campaign.
+    /// - Note: "on_false" uses touchpoint from install event only.
+    /// Can be used by UA(user-acquisition) campaign.
+    static get IS_REENGAGEMENT() {
+        return 'is_reengagement'
+    }
+}

package/source/module/Placement.ts

@@ -4,7 +4,9 @@ import { createInteractor } from '../architecture/Interactor'
 import { check } from '../utility/check'
 import { log } from '../utility/log'
 
-export const createDependency = () => {}
+import { AirbridgeTrackingLink } from '../type/AirbridgeTrackingLink'
+
+export const createDependency = () => { }
 
 type PlacementInteractor = {
     click(
@@ -13,12 +15,20 @@ type PlacementInteractor = {
         onSuccess: () => void,
         onFailure: (message: string) => void,
     ): Promise<boolean>
+
     impression(
         promiseID: string,
         trackingLink: string,
         onSuccess: () => void,
         onFailure: (message: string) => void,
     ): Promise<boolean>
+
+    createTrackingLink(
+        channel: string,
+        option: Record<string, any>,
+        onSuccess: (airbridgeTrackingLink: Record<string, string>) => void,
+        onFailure: (message: string) => void,
+    ): void
 }
 
 createDependency.PlacementModule = () => ({
@@ -28,7 +38,7 @@ createDependency.PlacementModule = () => ({
 
 export type PlacementModule = ReturnType<typeof createPlacementModule>
 
-export const createPlacementModule= () => {
+export const createPlacementModule = () => {
     // create dependency
     const { emitter, interactor } = createDependency.PlacementModule()
 
@@ -126,9 +136,51 @@ export const createPlacementModule= () => {
         })
     }
 
+    const createTrackingLink = (
+        channel: string,
+        option: Record<string, any>,
+        onSuccess: (airbridgeTrackingLink: AirbridgeTrackingLink) => void,
+        onFailure?: (error: Error) => void
+    ): void => {
+        if (!check.string(channel)) {
+            log.unmatchedType('channel', 'string')
+            return
+        }
+        if (!(check.undefined(option) || check.object(option))) {
+            log.unmatchedType('option', 'object')
+            return
+        }
+        if (!check.function(onSuccess)) {
+            log.unmatchedType('onSuccess', 'function?')
+            return
+        }
+        if (!(check.function(onFailure) || check.undefined(onFailure))) {
+            log.unmatchedType('onFailure', 'function?')
+            return
+        }
+
+        interactor.createTrackingLink(
+            channel,
+            option,
+            (airbridgeTrackingLink: Record<string, string>) => {
+                if (
+                    check.string(airbridgeTrackingLink['qrcodeURL']) &&
+                    check.string(airbridgeTrackingLink['shortURL'])
+                ) {
+                    onSuccess?.({
+                        qrcodeURL: airbridgeTrackingLink['qrcodeURL'],
+                        shortURL: airbridgeTrackingLink['shortURL']
+                    })
+                }
+            },
+            (message: string) => { onFailure?.(Error(message)) }
+        )
+    }
+
     // create object
     return {
         click,
         impression,
+        createTrackingLink
     }
 }

package/source/module.ts

@@ -1,3 +1,5 @@
 export { Airbridge } from './Airbridge'
+export * from './type/AirbridgeTrackingLink'
 export * from './constant/AirbridgeAttribute'
 export * from './constant/AirbridgeCategory'
+export * from './constant/AirbridgeTrackingLinkOption'

package/source/type/AirbridgeTrackingLink.ts

@@ -0,0 +1,10 @@
+/**
+ * Holds variable types of tracking-link that move user
+ * to specific page of app and track click-event.
+ */
+export type AirbridgeTrackingLink = {
+    /// A tracking-link url contains short mapping-id of option
+    shortURL: string
+    /// A qrcode image-url of tracking-link
+    qrcodeURL: string
+}