tapjoy-react-native-sdk 14.2.1 → 14.3.0

package/src/TJOfferwallDiscoverView.tsx

@@ -29,7 +29,7 @@ export default class TJOfferwallDiscoverView extends React.Component<TJOfferwall
     super(props);
   }
 
-  render() {
+  override render () {
     return (
       <TJOfferwallDiscoverNativeView
         {...this.props}
@@ -51,7 +51,8 @@ export default class TJOfferwallDiscoverView extends React.Component<TJOfferwall
   clearContent() {
     UIManager.dispatchViewManagerCommand(
       this.nativeCompHandle!!,
-      Command.CLEAR_CONTENT
+      Command.CLEAR_CONTENT,
+      []
     );
   }
 }

package/src/TJPlacement.ts

@@ -20,9 +20,31 @@ class TJPlacement extends EventEmitter {
   static readonly CONTENT_DID_APPEAR = 'contentDidAppear';
   static readonly CONTENT_DID_DISAPPEAR = 'contentDidDisappear';
 
+  /**
+   * Returns the name of this placement. This is the same name passed to the
+   * constructor when creating this {@link TJPlacement} object.
+   */
   public name: string;
+
+  /**
+   * Returns a description of the error, if any, that was encountered when processing 
+   * the placement request. If the request completes successfully, this property remains 
+   * undefined. You can use this property to determine why a placement request failed by 
+   * listening to the {@link TJPlacement.REQUEST_DID_FAIL} event.
+   */
   public error: string | undefined;
 
+  /**
+   * Creates a new instance of a Tapjoy placement. Each placement is defined on the Tapjoy dashboard and can be configured
+   * to serve different content to your users.
+   *
+   * @param name - The unique identifier for this placement. It is used to register and
+   * retrieve the placement from Tapjoy.
+   *
+   * @example
+   * const placement = new TJPlacement('MainMenuPlacement');
+   *
+   */
   public constructor(name: string) {
     super();
     this.name = name;
@@ -99,7 +121,7 @@ class TJPlacement extends EventEmitter {
    * Sets the currency balance for given currency id.
    *
    * @param {String} currencyId - The identifier of the currency.
-   * @param {Number} currencyBalance - The amount of the currency to set.
+   * @param {Number} currencyBalance - The amount of the currency to set. Must be greater than or equal to 0.
    */
   async setCurrencyBalance(
     currencyId: String,
@@ -139,7 +161,7 @@ class TJPlacement extends EventEmitter {
   }
 
   /**
-   * Sets entry point.
+   * Sets the entry point for this placement instance.
    *
    * @param {TJEntryPoint} entryPoint - Entry point.
    * @see TJEntryPoint
@@ -149,7 +171,7 @@ class TJPlacement extends EventEmitter {
   }
 
   /**
-   * Gets entry point.
+   * Gets the entry point for this placement instance.
    *
    * @returns Entry point.
    * @see TJEntryPoint

package/src/TJPrivacyPolicy.ts

@@ -67,6 +67,15 @@ class TJPrivacyPolicy {
       console.warn('optOutAdvertisingID is only supported on Android.');
     }
   }
+
+  getOptOutAdvertisingID(): Promise<boolean> {
+    if (Platform.OS === 'android') {
+      return Tapjoy.getOptOutAdvertisingID();
+    } else {
+      console.warn('getOptOutAdvertisingID is only supported on Android.');
+      return Promise.resolve(false);
+    }
+  }
 }
 
 export default TJPrivacyPolicy;

package/src/TJVersion.ts

@@ -1,4 +1,4 @@
-const REACT_LIBRARY_VERSION = '14.2.1';
+const REACT_LIBRARY_VERSION = '14.3.0';
 const REACT_LIBRARY_VERSION_SUFFIX = '';
 
 export class TJVersion {

package/src/Tapjoy.ts

@@ -0,0 +1,240 @@
+import { NativeModules, Platform, NativeEventEmitter } from 'react-native';
+import TJSegment from './TJSegment';
+import TJConnect from './TJConnect';
+
+const LINKING_ERROR =
+`The package 'tapjoy-react-native-sdk' doesn't seem to be linked. Make sure: \n\n` +
+Platform.select({ ios: "- You have run 'pod install'\n", default: '' }) +
+'- You rebuilt the app after installing the package\n' +
+'- You are not using Expo Go\n';
+
+const TapjoyAPI = NativeModules.TapjoyReactNativeSdk
+? NativeModules.TapjoyReactNativeSdk
+: new Proxy(
+    {},
+    {
+      get() {
+        throw new Error(LINKING_ERROR);
+      },
+    }
+  );
+
+class Tapjoy {
+
+  /**
+   * Connects to the Tapjoy Server.
+   * 
+   * @param sdkKey Your Tapjoy SDK Key.
+   * @param flags Special connect flags.
+   * @param onWarning Callback for connection warning.
+   * 
+   * @return true if successful or error message if failed.
+   */
+  public static async connect(sdkKey: string, flags: object, onWarning?: (message: TapjoyEvent) => void) {
+    const TJ = NativeModules.TapjoyReactNativeSdk;
+    const TapjoyEmitter = new NativeEventEmitter(TJ);
+    const TapjoyEventType = 'Tapjoy';
+    const subscription = TapjoyEmitter.addListener(
+      TapjoyEventType,
+      (event: TapjoyEvent) => {
+        if (event.name === TJConnect.TJC_CONNECT_WARNING) {
+          onWarning?.(event);   
+          subscription.remove();         
+        }
+    }
+    );
+    return await TapjoyAPI.connect(sdkKey, flags);
+  };
+
+	/**
+	 * Helper function to check if SDK is initialized
+	 *
+	 * @return true if successful
+	 */
+  public static isConnected() {
+    return TapjoyAPI.isConnected();
+  };
+
+	/**
+	 * Gets the virtual currency data from the server for this device.
+   * 
+   * @returns a map with "currencyName" and "amount" or error message if failed.
+	 */
+  public static async getCurrencyBalance() {
+    return await TapjoyAPI.getCurrencyBalance();
+  }
+
+  /**
+   * Spends virtual currency. This can only be used for currency managed by
+	 * Tapjoy.
+   * 
+   * @param amount the amount of currency
+   * @return a map with "currencyName" and "amount" or error message if failed.
+	 */
+  public static async spendCurrency(amount: number) {
+    return await TapjoyAPI.spendCurrency(amount);
+  }
+
+  /**
+	 * Awards virtual currency. This can only be used for currency managed by
+	 * Tapjoy.
+	 *
+	 * @param amount the amount of currency
+   * @return a map with "currencyName" and "amount" or error message if failed.
+	 */
+  public static async awardCurrency(amount: number) {
+    return await TapjoyAPI.awardCurrency(amount);
+  }
+
+  /**
+	 * Tracks a purchase
+	 *
+	 * @param currencyCode
+	 *            the currency code of price as an alphabetic currency code
+	 *            specified in ISO 4217, i.e. "USD", "KRW"
+	 * @param price
+	 *            the price of product
+	 */
+  public static trackPurchase(currencyCode: string, price: number) {
+    TapjoyAPI.trackPurchase(currencyCode, price);
+  }
+
+	/**
+	 * Enables or disables Tapjoy logging
+	 * 
+	 * @param enable
+	 *            set to true if logging should be enabled, false to disable
+	 *            logging
+	 */
+  public static setDebugEnabled(enable: Boolean) {
+    TapjoyAPI.setDebugEnabled(enable);
+  };
+
+  /**
+	 * Assigns a user ID for this user/device. This is used to identify the user
+	 * in your application.
+	 *
+	 * This is REQUIRED for NON-MANAGED currency apps.
+	 *
+	 * @param userID
+	 *            user ID you wish to assign to this device
+   * @return the user ID if successful or error message if failed.
+	 */
+  public static async setUserId(userID: string) { 
+    return await TapjoyAPI.setUserId(userID);
+  }
+
+  /**
+	 * Gets the ID of the user.
+	 *
+	 * @return the id of the user.
+	 */
+  public static async getUserId() {
+    return await TapjoyAPI.getUserId();
+  }
+  
+  /**
+	 * Sets the level of the user.
+	 * 
+	 * @param userLevel
+	 *            the level of the user
+	 */
+  public static setUserLevel(userLevel: number) {
+    TapjoyAPI.setUserLevel(userLevel);
+  }
+
+  /**
+	 * Gets the level of the user.
+	 *
+	 * @return the level of the user.
+	 */
+  public static async getUserLevel() {
+    return await TapjoyAPI.getUserLevel();
+  }
+
+  /**
+	 * Sets the maximum level of the user.
+	 *
+	 * @param maxUserLevel
+	 *            the maximum level
+	 */
+  public static setMaxLevel(maxUserLevel: number) {
+    TapjoyAPI.setMaxLevel(maxUserLevel);
+  }
+
+  /**
+	 * Gets the maximum level of the user.
+	 *
+	 * @return the maximum level
+	 */
+  public static async getMaxLevel() {
+    return await TapjoyAPI.getMaxLevel();
+  }
+
+	/**
+	 * Sets the segment of the user
+	 *
+	 * @param segment NON_PAYER (0), PAYER (1), VIP (2)
+	 *
+	 */
+  public static setUserSegment(segment: TJSegment) {
+    TapjoyAPI.setUserSegment(segment);
+  }
+
+  /**
+	 * Gets the segment of the user
+	 *
+	 * @return userSegment NON_PAYER (0), PAYER (1), VIP (2)
+	 *
+	 */
+  public static async getUserSegment() {
+    return await TapjoyAPI.getUserSegment();
+  }
+
+  /**
+	 * Sets tags for the user.
+	 *
+	 * @param tags
+	 *        the tags to be set
+	 */
+  public static setUserTags(tags: string[]) {
+    TapjoyAPI.setUserTags(tags);
+  }
+
+  /**
+	 * Returns a String set which contains tags on the user.
+	 *
+	 * @return list of user tags
+	 */
+  public static async getUserTags() {
+    return TapjoyAPI.getUserTags();
+  }
+
+  /**
+	 * Removes all tags from the user.
+	 */
+    public static clearUserTags() {
+      TapjoyAPI.clearUserTags();
+    }
+
+  /**
+	 * Adds the given tag to the user if it is not already present.
+	 *
+	 * @param tag
+	 *        the tag to be added
+	 */
+  public static addUserTag(tag: string) {
+    TapjoyAPI.addUserTag(tag);
+  }
+
+  /**
+	 * Removes the given tag from the user if it is present.
+	 *
+	 * @param tag
+	 *        the tag to be removed
+	 */
+  public static removeUserTag(tag: string) {
+    TapjoyAPI.removeUserTag(tag);
+  }
+}
+export default Tapjoy;

package/src/TapjoyEvent.ts

@@ -0,0 +1,5 @@
+interface TapjoyEvent {
+  name: string;
+  code: string;
+  message: string;
+}

package/src/index.ts

@@ -1,29 +1,12 @@
-import { NativeModules, Platform } from 'react-native';
 import TJPlacement from './TJPlacement';
 import TJPrivacyPolicy from './TJPrivacyPolicy';
 import TJVersion from './TJVersion';
 import TJStatus from './TJStatus';
 import TJSegment from './TJSegment';
 import TJOfferwallDiscoverView from './TJOfferwallDiscoverView';
-import TJConnect from './TJConnect';
 import TJPurchase from './TJPurchase';
+import Tapjoy from './Tapjoy';
 
-const LINKING_ERROR =
-  `The package 'tapjoy-react-native-sdk' doesn't seem to be linked. Make sure: \n\n` +
-  Platform.select({ ios: "- You have run 'pod install'\n", default: '' }) +
-  '- You rebuilt the app after installing the package\n' +
-  '- You are not using Expo Go\n';
-
-const Tapjoy = NativeModules.TapjoyReactNativeSdk
-  ? NativeModules.TapjoyReactNativeSdk
-  : new Proxy(
-      {},
-      {
-        get() {
-          throw new Error(LINKING_ERROR);
-        },
-      }
-    );
 
 export {
   Tapjoy,
@@ -33,7 +16,6 @@ export {
   TJStatus,
   TJSegment,
   TJOfferwallDiscoverView,
-  TJConnect,
   TJPurchase,
 };
 export default Tapjoy;

package/tapjoy-react-native-sdk.podspec

@@ -17,7 +17,7 @@ Pod::Spec.new do |s|
   s.source_files = "ios/**/*.{h,m,mm,swift}"
 
   s.dependency "React-Core"
-  s.dependency "TapjoySDK", "14.2.1"
+  s.dependency "TapjoySDK", "14.3.0"
 
   # Don't install the dependencies when we run `pod install` in the old architecture.
   if ENV['RCT_NEW_ARCH_ENABLED'] == '1' then