@ohos-ports/react-native-fbsdk-next 13.4.3-beta.0

package/src/FBAccessToken.ts

@@ -0,0 +1,222 @@
+/**
+ * Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
+ *
+ * You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
+ * copy, modify, and distribute this software in source code or binary form for use
+ * in connection with the web services and APIs provided by Facebook.
+ *
+ * As with any software that integrates with the Facebook platform, your use of
+ * this software is subject to the Facebook Developer Principles and Policies
+ * [http://developers.facebook.com/policy/]. This copyright notice shall be
+ * included in all copies or substantial portions of the software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+ * @format
+ */
+import {NativeModules, NativeEventEmitter} from 'react-native';
+
+const AccessToken = NativeModules.FBAccessToken;
+
+const eventEmitter = new NativeEventEmitter(AccessToken);
+
+export type AccessTokenMap = {
+  accessToken: string;
+  permissions: Array<string>;
+  declinedPermissions: Array<string>;
+  expiredPermissions: Array<string>;
+  applicationID: string;
+  userID: string;
+  expirationTime: number;
+  lastRefreshTime: number;
+  dataAccessExpirationTime: number;
+  accessTokenSource?: string;
+};
+
+/**
+ * Represents an immutable access token for using Facebook services.
+ */
+class FBAccessToken {
+  /**
+   * The access token string.
+   */
+  accessToken: string;
+
+  /**
+   * The known granted permissions.
+   */
+  permissions: Array<string>;
+
+  /**
+   * The known declined permissions.
+   */
+  declinedPermissions: Array<string>;
+
+  /**
+   * The known expired permissions.
+   */
+  expiredPermissions: Array<string>;
+
+  /**
+   * The app ID.
+   */
+  applicationID: string;
+
+  /**
+   * The user ID.
+   */
+  userID: string;
+
+  /**
+   * The expiration time of the access token.
+   * The value is the number of milliseconds since Jan. 1, 1970, midnight GMT.
+   */
+  expirationTime: number;
+
+  /**
+   * The last refresh time of the access token.
+   * The value is the number of milliseconds since Jan. 1, 1970, midnight GMT.
+   */
+  lastRefreshTime: number;
+
+  /**
+   * The data access expiration time of the access token.
+   * The value is the number of milliseconds since Jan. 1, 1970, midnight GMT.
+   */
+  dataAccessExpirationTime: number;
+
+  /**
+   * The source of access token.
+   * @platform android
+   */
+  accessTokenSource?: string;
+
+  constructor(tokenMap: AccessTokenMap) {
+    this.accessToken = tokenMap.accessToken;
+    this.permissions = tokenMap.permissions;
+    this.declinedPermissions = tokenMap.declinedPermissions;
+    this.expiredPermissions = tokenMap.expiredPermissions;
+    this.applicationID = tokenMap.applicationID;
+    this.userID = tokenMap.userID;
+    this.expirationTime = tokenMap.expirationTime;
+    this.lastRefreshTime = tokenMap.lastRefreshTime;
+    this.dataAccessExpirationTime = tokenMap.dataAccessExpirationTime;
+    this.accessTokenSource = tokenMap.accessTokenSource;
+    Object.freeze(this);
+  }
+
+  /**
+   * Getter for the access token that is current for the application.
+   */
+  static getCurrentAccessToken() {
+    return new Promise<FBAccessToken | null>((resolve) => {
+      AccessToken.getCurrentAccessToken((tokenMap?: AccessTokenMap) => {
+        if (tokenMap) {
+          resolve(new FBAccessToken(tokenMap));
+        } else {
+          resolve(null);
+        }
+      });
+    });
+  }
+
+  /**
+   * Setter for the access token that is current for the application.
+   */
+  static setCurrentAccessToken(accessToken: AccessTokenMap) {
+    AccessToken.setCurrentAccessToken(accessToken);
+  }
+
+  /**
+   * Updates the current access token with up to date permissions,
+   * and extends the expiration date, if extension is possible.
+   */
+  static refreshCurrentAccessTokenAsync(): Promise<AccessTokenMap> {
+    return AccessToken.refreshCurrentAccessTokenAsync();
+  }
+
+  /**
+   * Adds a listener for when the access token changes. Returns a functions which removes the
+   * listener when called.
+   */
+  static addListener(listener: (accessToken: FBAccessToken | null) => void) {
+    const subscription = eventEmitter.addListener(
+      'fbsdk.accessTokenDidChange',
+      (tokenMap: AccessTokenMap) => {
+        if (tokenMap) {
+          listener(new FBAccessToken(tokenMap));
+        } else {
+          listener(null);
+        }
+      },
+    );
+    return () => subscription.remove();
+  }
+
+  /**
+   * Gets the date at which the access token expires. The value is the number of
+   * milliseconds since Jan. 1, 1970, midnight GMT.
+   */
+  getExpires() {
+    return this.expirationTime;
+  }
+
+  /**
+   * Get the list of permissions associated with this access token. Note that the most up-to-date
+   * list of permissions is maintained by Facebook, so this list may be outdated if permissions
+   * have been added or removed since the time the AccessToken object was created. See
+   * https://developers.facebook.com/docs/reference/login/#permissions for details.
+   */
+  getPermissions() {
+    return this.permissions;
+  }
+
+  /**
+   * Gets the list of permissions declined by the user with this access token. It represents the
+   * entire set of permissions that have been requested and declined. Note that the most
+   * up-to-date list of permissions is maintained by Facebook, so this list may be outdated if
+   * permissions have been granted or declined since the last time an AccessToken object was
+   * created. See https://developers.facebook.com/docs/reference/login/#permissions for details.
+   */
+  getDeclinedPermissions() {
+    return this.declinedPermissions;
+  }
+
+  getExpiredPermissions() {
+    return this.expiredPermissions;
+  }
+
+  /**
+   * Gets the date at which the token was last refreshed. Since tokens expire, the Facebook SDK
+   * will attempt to renew them periodically. The value is the number of milliseconds since
+   * Jan. 1, 1970, midnight GMT.
+   */
+  getLastRefresh() {
+    return this.lastRefreshTime;
+  }
+
+  getDataAccessExpiration() {
+    return this.dataAccessExpirationTime;
+  }
+
+  /**
+   * Gets the ID of the Facebook Application associated with this access token.
+   */
+  getApplicationId() {
+    return this.applicationID;
+  }
+
+  /**
+   * Gets user ID associated with this access token.
+   */
+  getUserId() {
+    return this.userID;
+  }
+}
+
+export default FBAccessToken;

package/src/FBAppEventsLogger.ts

@@ -0,0 +1,375 @@
+/**
+ * Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
+ *
+ * You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
+ * copy, modify, and distribute this software in source code or binary form for use
+ * in connection with the web services and APIs provided by Facebook.
+ *
+ * As with any software that integrates with the Facebook platform, your use of
+ * this software is subject to the Facebook Developer Principles and Policies
+ * [http://developers.facebook.com/policy/]. This copyright notice shall be
+ * included in all copies or substantial portions of the software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+ * @format
+ */
+import {isDefined, isNumber, isOneOf, isString} from './util/validate';
+import {NativeModules} from 'react-native';
+import {Platform} from 'react-native';
+
+const AppEventsLogger = NativeModules.FBAppEventsLogger;
+
+/**
+ * Controls when an AppEventsLogger sends log events to the server
+ */
+export type AppEventsFlushBehavior =
+  /**
+   * Flush automatically: periodically (every 15 seconds or after every 100 events), and
+   * always at app reactivation. This is the default value.
+   */
+  | 'auto'
+  /**
+   * Only flush when AppEventsLogger.flush() is explicitly invoked.
+   */
+  | 'explicit_only';
+
+/**
+ * Specifies product availability for Product Catalog product item update
+ */
+export type ProductAvailability =
+  /**
+   * Item ships immediately
+   */
+  | 'in_stock'
+  /**
+   * No plan to restock
+   */
+  | 'out_of_stock'
+  /**
+   * Available in future
+   */
+  | 'preorder'
+  /**
+   * Ships in 1-2 weeks
+   */
+  | 'avaliable_for_order'
+  /**
+   * Discontinued
+   */
+  | 'discontinued';
+
+/**
+ * Specifies product condition for Product Catalog product item update
+ */
+export type ProductCondition = 'new' | 'refurbished' | 'used';
+
+export type Params = {[key: string]: string | number};
+
+/**
+ * Info about a user to increase chances of matching a Facebook user.
+ * See https://developers.facebook.com/docs/app-events/advanced-matching for
+ * more info about the expected format of each field.
+ */
+export type UserData = Readonly<{
+  email?: string;
+  firstName?: string;
+  lastName?: string;
+  phone?: string;
+  dateOfBirth?: string;
+  gender?: 'm' | 'f';
+  city?: string;
+  state?: string;
+  zip?: string;
+  country?: string;
+}>;
+
+export type AppEvent = {
+  AchievedLevel: string;
+  AdClick: string;
+  AdImpression: string;
+  AddedPaymentInfo: string;
+  AddedToCart: string;
+  AddedToWishlist: string;
+  CompletedRegistration: string;
+  CompletedTutorial: string;
+  Contact: string;
+  CustomizeProduct: string;
+  Donate: string;
+  FindLocation: string;
+  InitiatedCheckout: string;
+  Purchased: string;
+  Rated: string;
+  Searched: string;
+  SpentCredits: string;
+  Schedule: string;
+  StartTrial: string;
+  SubmitApplication: string;
+  Subscribe: string;
+  UnlockedAchievement: string;
+  ViewedContent: string;
+};
+
+export type AppEventParam = {
+  AddType: string;
+  Content: string;
+  ContentID: string;
+  ContentType: string;
+  Currency: string;
+  Description: string;
+  Level: string;
+  NumItems: string;
+  MaxRatingValue: string;
+  OrderId: string;
+  PaymentInfoAvailable: string;
+  RegistrationMethod: string;
+  SearchString: string;
+  Success: string;
+  ValueNo: string;
+  ValueYes: string;
+};
+
+const {
+  AppEvents,
+  AppEventParams,
+}: {AppEvents: AppEvent; AppEventParams: AppEventParam} =
+  AppEventsLogger?.getConstants() || {};
+
+export default {
+  /**
+   * Sets the current event flushing behavior specifying when events
+   * are sent back to Facebook servers.
+   */
+  setFlushBehavior(flushBehavior: AppEventsFlushBehavior) {
+    AppEventsLogger.setFlushBehavior(flushBehavior);
+  },
+
+  /**
+   * Logs an event with eventName and optional arguments.
+   * This function supports the following usage:
+   * logEvent(eventName: string);
+   * logEvent(eventName: string, valueToSum: number);
+   * logEvent(eventName: string, parameters: {[key:string]:string|number});
+   * logEvent(eventName: string, valueToSum: number, parameters: {[key:string]:string|number});
+   * See https://developers.facebook.com/docs/app-events/android for detail.
+   */
+  logEvent(eventName: string, ...args: Array<number | Params>) {
+    let valueToSum = 0;
+    if (typeof args[0] === 'number') {
+      valueToSum = Number(args.shift());
+    }
+    let parameters = null;
+    if (typeof args[0] === 'object') {
+      parameters = args[0];
+    }
+    AppEventsLogger.logEvent(eventName, valueToSum, parameters);
+  },
+
+  /**
+   * Logs a purchase. See http://en.wikipedia.org/wiki/ISO_4217 for currencyCode.
+   */
+  logPurchase(
+    purchaseAmount: number,
+    currencyCode: string,
+    parameters?: Params,
+  ) {
+    AppEventsLogger.logPurchase(purchaseAmount, currencyCode, parameters);
+  },
+
+  /**
+   * Logs an app event that tracks that the application was open via Push Notification.
+   */
+  logPushNotificationOpen(payload?: Record<string, string | number>) {
+    AppEventsLogger.logPushNotificationOpen(payload);
+  },
+
+  /**
+   * Uploads product catalog product item as an app event
+   * @param itemID – Unique ID for the item. Can be a variant for a product. Max size is 100.
+   * @param availability – If item is in stock. Accepted values are: in stock - Item ships immediately out of stock - No plan to restock preorder - Available in future available for order - Ships in 1-2 weeks discontinued - Discontinued
+   * @param condition – Product condition: new, refurbished or used.
+   * @param description – Short text describing product. Max size is 5000.
+   * @param imageLink – Link to item image used in ad.
+   * @param link – Link to merchant's site where someone can buy the item.
+   * @param title – Title of item.
+   * @param priceAmount – Amount of purchase, in the currency specified by the 'currency' parameter. This value will be rounded to the thousandths place (e.g., 12.34567 becomes 12.346).
+   * @param currency – Currency used to specify the amount.
+   * @param gtin – Global Trade Item Number including UPC, EAN, JAN and ISBN
+   * @param mpn – Unique manufacture ID for product
+   * @param brand – Name of the brand Note: Either gtin, mpn or brand is required.
+   * @param parameters – Optional fields for deep link specification.
+   */
+  logProductItem(
+    itemID: string,
+    availability: ProductAvailability,
+    condition: ProductCondition,
+    description: string,
+    imageLink: string,
+    link: string,
+    title: string,
+    priceAmount: number,
+    currency: string,
+    gtin?: string,
+    mpn?: string,
+    brand?: string,
+    parameters?: Params,
+  ) {
+    if (!isDefined(itemID) || !isString(itemID)) {
+      throw new Error("logProductItem expected 'itemID' to be a string");
+    }
+    if (
+      !isDefined(availability) ||
+      !isOneOf(availability, [
+        'in_stock',
+        'out_of_stock',
+        'preorder',
+        'avaliable_for_order',
+        'discontinued',
+      ])
+    ) {
+      throw new Error(
+        "logProductItem expected 'availability' to be one of 'in_stock' | 'out_of_stock' | 'preorder' | 'avaliable_for_order' | 'discontinued'",
+      );
+    }
+    if (
+      !isDefined(condition) ||
+      !isOneOf(condition, ['new', 'refurbished', 'used'])
+    ) {
+      throw new Error(
+        "logProductItem expected 'condition' to be one of 'new' | 'refurbished' | 'used'",
+      );
+    }
+    if (!isDefined(description) || !isString(description)) {
+      throw new Error("logProductItem expected 'description' to be a string");
+    }
+    if (!isDefined(imageLink) || !isString(imageLink)) {
+      throw new Error("logProductItem expected 'imageLink' to be a string");
+    }
+    if (!isDefined(link) || !isString(link)) {
+      throw new Error("logProductItem expected 'link' to be a string");
+    }
+    if (!isDefined(title) || !isString(title)) {
+      throw new Error("logProductItem expected 'title' to be a string");
+    }
+    if (!isDefined(priceAmount) || !isNumber(priceAmount)) {
+      throw new Error("logProductItem expected 'priceAmount' to be a number");
+    }
+    if (!isDefined(currency) || !isString(currency)) {
+      throw new Error("logProductItem expected 'currency' to be a string");
+    }
+    if (!isDefined(gtin) && !isDefined(mpn) && !isDefined(brand)) {
+      throw new Error(
+        'logProductItem expected either gtin, mpn or brand to be defined',
+      );
+    }
+
+    AppEventsLogger.logProductItem(
+      itemID,
+      availability,
+      condition,
+      description,
+      imageLink,
+      link,
+      title,
+      priceAmount,
+      currency,
+      gtin,
+      mpn,
+      brand,
+      parameters,
+    );
+  },
+
+  /**
+   * Explicitly kicks off flushing of events to Facebook.
+   */
+  flush() {
+    AppEventsLogger.flush();
+  },
+
+  /**
+   * Sets a custom user ID to associate with all app events.
+   * The userID is persisted until this method is called again with a null userId
+   */
+  setUserID(userID: string | null) {
+    AppEventsLogger.setUserID(userID);
+  },
+
+  /**
+   * Clears the currently set user id.
+   * @deprecated use setUserID(null) instead
+   */
+  clearUserID() {
+    AppEventsLogger.clearUserID();
+  },
+
+  /**
+   * Returns user id or null if not set
+   */
+  async getUserID(): Promise<string | null> {
+    return await AppEventsLogger.getUserID();
+  },
+
+  /**
+   * Returns anonymous id or null if not set
+   */
+  async getAnonymousID(): Promise<string | null> {
+    return await AppEventsLogger.getAnonymousID();
+  },
+
+  /**
+   * Returns advertiser id or null if not set
+   */
+  async getAdvertiserID(): Promise<string | null> {
+    return await AppEventsLogger.getAdvertiserID();
+  },
+
+  /**
+   * Returns advertiser id or null if not set.
+   * @platform android
+   */
+  async getAttributionID(): Promise<string | null> {
+    if (Platform.OS === 'ios') {
+      return null;
+    }
+    return await AppEventsLogger.getAttributionID();
+  },
+
+  /**
+   * Set additional data about the user to increase chances of matching a Facebook user.
+   */
+  setUserData(userData: UserData) {
+    AppEventsLogger.setUserData(userData);
+  },
+
+  /**
+   * For iOS only, sets and sends device token to register the current application for push notifications.
+   * @platform ios
+   */
+  setPushNotificationsDeviceToken(deviceToken: string) {
+    AppEventsLogger.setPushNotificationsDeviceToken(deviceToken);
+  },
+
+  /**
+   * For Android only, sets and sends registration id to register the current app for push notifications.
+   * @platform Android
+   */
+  setPushNotificationsRegistrationId(registrationId: string) {
+    AppEventsLogger.setPushNotificationsRegistrationId(registrationId);
+  },
+
+  /**
+   * Predefined event names for logging events common to many apps.
+   */
+  AppEvents,
+
+  /**
+   *  Predefined event name parameters for common additional information to accompany events logged through the `logEvent`.
+   */
+  AppEventParams,
+};

package/src/FBAppLink.ts

@@ -0,0 +1,30 @@
+/**
+ * Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
+ *
+ * You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
+ * copy, modify, and distribute this software in source code or binary form for use
+ * in connection with the web services and APIs provided by Facebook.
+ *
+ * As with any software that integrates with the Facebook platform, your use of
+ * this software is subject to the Facebook Developer Principles and Policies
+ * [http://developers.facebook.com/policy/]. This copyright notice shall be
+ * included in all copies or substantial portions of the software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+ * @format
+ */
+import {NativeModules} from 'react-native';
+
+const AppLink = NativeModules.FBAppLink;
+
+export default {
+  fetchDeferredAppLink(): Promise<string | null> {
+    return AppLink.fetchDeferredAppLink();
+  },
+};

package/src/FBAuthenticationToken.ts

@@ -0,0 +1,61 @@
+/**
+ * @format
+ */
+import {Platform, NativeModules} from 'react-native';
+
+const AuthenticationToken = NativeModules.FBAuthenticationToken;
+
+export type AuthenticationTokenMap = {
+  authenticationToken: string;
+  nonce: string;
+  graphDomain: string;
+};
+
+/**
+ * Represents an immutable access token for using Facebook services.
+ */
+class FBAuthenticationToken {
+  /**
+     The raw token string from the authentication response
+    */
+  authenticationToken: string;
+
+  /**
+     The nonce from the decoded authentication response
+    */
+  nonce: string;
+
+  /**
+    The graph domain where the user is authenticated.
+   */
+  graphDomain: string;
+
+  constructor(tokenMap: AuthenticationTokenMap) {
+    this.authenticationToken = tokenMap.authenticationToken;
+    this.nonce = tokenMap.nonce;
+    this.graphDomain = tokenMap.graphDomain;
+    Object.freeze(this);
+  }
+
+  /**
+   * Getter for the authentication token
+   */
+  static getAuthenticationTokenIOS() {
+    if (Platform.OS === 'android') {
+      return Promise.resolve(null);
+    }
+    return new Promise<FBAuthenticationToken | null>((resolve) => {
+      AuthenticationToken.getAuthenticationToken(
+        (tokenMap: AuthenticationTokenMap) => {
+          if (tokenMap) {
+            resolve(new FBAuthenticationToken(tokenMap));
+          } else {
+            resolve(null);
+          }
+        },
+      );
+    });
+  }
+}
+
+export default FBAuthenticationToken;