expo-iap 1.0.3 → 2.0.0-rc.1

package/src/modules/android.ts

@@ -0,0 +1,89 @@
+import {Linking} from 'react-native';
+import {Product, PurchaseResult, SubscriptionProduct} from '../ExpoIap.types';
+import {ProductAndroid, ReceiptAndroid, SubscriptionProductAndroid} from '../types/ExpoIapAndroid.types';
+import ExpoIapModule from '../ExpoIapModule';
+
+export function isProductAndroid(product: Product): product is ProductAndroid {
+  return (product as ProductAndroid)?.title !== undefined;
+}
+
+export function isSubscriptionProductAndroid(product: SubscriptionProduct): product is SubscriptionProductAndroid {
+  return (product as SubscriptionProductAndroid)?.title !== undefined;
+}
+
+/**
+ * Deep link to subscriptions screen on Android.
+ * @param {string} sku The product's SKU (on Android)
+ * @returns {Promise<void>}
+ */
+export const deepLinkToSubscriptionsAndroid = async ({
+  sku,
+}: {
+  sku: string;
+}): Promise<void> => {
+  return Linking.openURL(
+    `https://play.google.com/store/account/subscriptions?package=${await ExpoIapModule.getPackageName()}&sku=${sku}`,
+  );
+};
+
+/**
+ * Validate receipt for Android. NOTE: This method is here for debugging purposes only. Including
+ * your access token in the binary you ship to users is potentially dangerous.
+ * Use server side validation instead for your production builds
+ * @param {string} packageName package name of your app.
+ * @param {string} productId product id for your in app product.
+ * @param {string} productToken token for your purchase.
+ * @param {string} accessToken accessToken from googleApis.
+ * @param {boolean} isSub whether this is subscription or inapp. `true` for subscription.
+ * @returns {Promise<object>}
+ */
+export const validateReceiptAndroid = async ({
+  packageName,
+  productId,
+  productToken,
+  accessToken,
+  isSub,
+}: {
+  packageName: string;
+  productId: string;
+  productToken: string;
+  accessToken: string;
+  isSub?: boolean;
+}): Promise<ReceiptAndroid> => {
+  const type = isSub ? 'subscriptions' : 'products';
+
+  const url =
+    'https://androidpublisher.googleapis.com/androidpublisher/v3/applications' +
+    `/${packageName}/purchases/${type}/${productId}` +
+    `/tokens/${productToken}?access_token=${accessToken}`;
+
+  const response = await fetch(url, {
+    method: 'GET',
+    headers: {
+      'Content-Type': 'application/json',
+    },
+  });
+
+  if (!response.ok) {
+    throw Object.assign(new Error(response.statusText), {
+      statusCode: response.status,
+    });
+  }
+
+  return response.json();
+};
+
+/**
+ * Acknowledge a product (on Android.) No-op on iOS.
+ * @param {string} token The product's token (on Android)
+ * @returns {Promise<PurchaseResult | void>}
+ */
+export const acknowledgePurchaseAndroid = ({
+  token,
+  developerPayload,
+}: {
+  token: string;
+  developerPayload?: string;
+}): Promise<PurchaseResult | boolean | void> => {
+  return ExpoIapModule.acknowledgePurchase(token, developerPayload);
+};

package/src/modules/ios.ts

@@ -0,0 +1,81 @@
+import {Platform} from 'react-native';
+import {emitter, IapEvent} from '..';
+import {Product, PurchaseError, SubscriptionProduct} from '../ExpoIap.types';
+import type {
+  ProductIos,
+  ProductStatusIos,
+  SubscriptionProductIos,
+  TransactionSk2,
+} from '../types/ExpoIapIos.types';
+import ExpoIapModule from '../ExpoIapModule';
+
+type TransactionEvent = {
+  transaction?: TransactionSk2;
+  error?: PurchaseError;
+};
+
+// Listeners
+export const transactionUpdatedIos = (
+  listener: (event: TransactionEvent) => void,
+) => {
+  if (Platform.OS !== 'ios') {
+    throw new Error('This method is only available on iOS');
+  }
+
+  return emitter.addListener(IapEvent.TransactionIapUpdated, listener);
+};
+
+// Functions
+export function isProductIos(product: Product): product is ProductIos {
+  return (product as ProductIos)?.displayName !== undefined;
+}
+
+export function isSubscriptionProductIos(
+  product: SubscriptionProduct,
+): product is SubscriptionProductIos {
+  return (product as SubscriptionProductIos)?.displayName !== undefined;
+}
+
+/**
+ * Sync state with Appstore (iOS only)
+ * https://developer.apple.com/documentation/storekit/appstore/3791906-sync
+ */
+export const sync = (): Promise<null> => ExpoIapModule.sync();
+
+/**
+ *
+ */
+export const isEligibleForIntroOffer = (groupID: string): Promise<boolean> =>
+  ExpoIapModule.isEligibleForIntroOffer(groupID);
+
+/**
+ *
+ */
+
+export const subscriptionStatus = (sku: string): Promise<ProductStatusIos[]> =>
+  ExpoIapModule.subscriptionStatus(sku);
+
+/**
+ *
+ */
+export const currentEntitlement = (sku: string): Promise<TransactionSk2> =>
+  ExpoIapModule.currentEntitlement(sku);
+
+/**
+ *
+ */
+export const latestTransaction = (sku: string): Promise<TransactionSk2> =>
+  ExpoIapModule.latestTransaction(sku);
+
+/**
+ *
+ */
+type RefundRequestStatus = 'success' | 'userCancelled';
+export const beginRefundRequest = (sku: string): Promise<RefundRequestStatus> =>
+  ExpoIapModule.beginRefundRequest(sku);
+
+/**
+ *
+ */
+export const showManageSubscriptions = (): Promise<null> =>
+  ExpoIapModule.showManageSubscriptions();

package/src/types/ExpoIapAndroid.types.ts

@@ -0,0 +1,123 @@
+type OneTimePurchaseOfferDetails = {
+  priceCurrencyCode: string;
+  formattedPrice: string;
+  priceAmountMicros: string;
+};
+
+type SubscriptionOfferDetail = {
+  basePlanId: string;
+  offerId: string;
+  offerToken: string;
+  offerTags: string[];
+  pricingPhases: PricingPhases;
+};
+
+type PricingPhases = {
+  pricingPhaseList: PricingPhase[];
+};
+
+type PricingPhase = {
+  formattedPrice: string;
+  priceCurrencyCode: string;
+  billingPeriod: string;
+  billingCycleCount: number;
+  priceAmountMicros: string;
+  recurrenceMode: number;
+};
+
+export type ProductAndroid = {
+  productId: string;
+  title: string;
+  description: string;
+  productType: string;
+  name: string;
+  oneTimePurchaseOfferDetails?: OneTimePurchaseOfferDetails;
+  subscriptionOfferDetails?: SubscriptionOfferDetail[];
+};
+
+type PricingPhaseAndroid = {
+  formattedPrice: string;
+  priceCurrencyCode: string;
+  // P1W, P1M, P1Y
+  billingPeriod: string;
+  billingCycleCount: number;
+  priceAmountMicros: string;
+  recurrenceMode: number;
+};
+
+type SubscriptionOfferAndroid = {
+  basePlanId: string;
+  offerId: string | null;
+  offerToken: string;
+  pricingPhases: {pricingPhaseList: PricingPhaseAndroid[]};
+  offerTags: string[];
+};
+
+export type SubscriptionProductAndroid = ProductAndroid & {
+  name: string;
+  title: string;
+  description: string;
+  productId: string;
+  subscriptionOfferDetails: SubscriptionOfferAndroid[];
+};
+
+export type RequestPurchaseAndroidProps = {
+  skus: string[];
+  obfuscatedAccountIdAndroid?: string;
+  obfuscatedProfileIdAndroid?: string;
+  isOfferPersonalized?: boolean; // For AndroidBilling V5 https://developer.android.com/google/play/billing/integrate#personalized-price
+};
+
+enum ReplacementModesAndroid {
+  UNKNOWN_REPLACEMENT_MODE = 0,
+  WITH_TIME_PRORATION = 1,
+  CHARGE_PRORATED_PRICE = 2,
+  WITHOUT_PRORATION = 3,
+  CHARGE_FULL_PRICE = 5,
+  DEFERRED = 6,
+}
+
+type SubscriptionOffer = {
+  sku: string;
+  offerToken: string;
+};
+
+export type RequestSubscriptionAndroidProps = RequestPurchaseAndroidProps & {
+  purchaseTokenAndroid?: string;
+  replacementModeAndroid?: ReplacementModesAndroid;
+  subscriptionOffers: SubscriptionOffer[];
+};
+
+export type ReceiptAndroid = {
+  autoRenewing: boolean;
+  betaProduct: boolean;
+  cancelDate: number | null;
+  cancelReason: string;
+  deferredDate: number | null;
+  deferredSku: number | null;
+  freeTrialEndDate: number;
+  gracePeriodEndDate: number;
+  parentProductId: string;
+  productId: string;
+  productType: string;
+  purchaseDate: number;
+  quantity: number;
+  receiptId: string;
+  renewalDate: number;
+  term: string;
+  termSku: string;
+  testTransaction: boolean;
+};
+
+export enum FeatureTypeAndroid {
+  /** Show in-app messages. Included in documentation by the annotations: */
+  IN_APP_MESSAGING = 'IN_APP_MESSAGING',
+  /** Launch a price change confirmation flow. */
+  PRICE_CHANGE_CONFIRMATION = 'PRICE_CHANGE_CONFIRMATION',
+  /** Play billing library support for querying and purchasing with ProductDetails. */
+  PRODUCT_DETAILS = 'PRODUCT_DETAILS',
+  /** Purchase/query for subscriptions. */
+  SUBSCRIPTIONS = 'SUBSCRIPTIONS',
+  /** Subscriptions update/replace. */
+  SUBSCRIPTIONS_UPDATE = 'SUBSCRIPTIONS_UPDATE',
+}

package/src/types/ExpoIapIos.types.ts

@@ -0,0 +1,141 @@
+type SubscriptionIosPeriod = 'DAY' | 'WEEK' | 'MONTH' | 'YEAR' | '';
+type PaymentMode = '' | 'FREETRIAL' | 'PAYASYOUGO' | 'PAYUPFRONT';
+
+type SubscriptionOffer = {
+  displayPrice: string;
+  id: string;
+  paymentMode: PaymentMode;
+  period: SubscriptionIosPeriod;
+  periodCount: number;
+  price: number;
+  type: 'introductory' | 'promotional';
+};
+
+type SubscriptionInfo = {
+  introductoryOffer?: SubscriptionOffer;
+  promotionalOffers?: SubscriptionOffer[];
+  subscriptionGroupID: string;
+  subscriptionPeriod: SubscriptionIosPeriod;
+};
+
+export type ProductIos = {
+  currency: string;
+  description: string;
+  displayName: string;
+  displayPrice: string;
+  id: string;
+  type: 'autoRenewable' | 'consumable' | 'nonConsumable' | 'nonRenewable';
+  isFamilyShareable: boolean;
+  jsonRepresentation: string;
+  price: number;
+  subscription: SubscriptionInfo;
+  introductoryPriceNumberOfPeriodsIOS?: string;
+  introductoryPriceSubscriptionPeriodIOS?: SubscriptionIosPeriod;
+};
+
+type Discount = {
+  identifier: string;
+  type: string;
+  numberOfPeriods: string;
+  price: string;
+  localizedPrice: string;
+  paymentMode: PaymentMode;
+  subscriptionPeriod: string;
+};
+
+export type SubscriptionProductIos = ProductIos & {
+  discounts?: Discount[];
+  introductoryPrice?: string;
+  introductoryPriceAsAmountIOS?: string;
+  introductoryPricePaymentModeIOS?: PaymentMode;
+  introductoryPriceNumberOfPeriodsIOS?: string;
+  introductoryPriceSubscriptionPeriodIOS?: SubscriptionIosPeriod;
+  subscriptionPeriodNumberIOS?: string;
+  subscriptionPeriodUnitIOS?: SubscriptionIosPeriod;
+};
+
+export type PaymentDiscount = {
+  /**
+   * A string used to uniquely identify a discount offer for a product.
+   */
+  identifier: string;
+
+  /**
+   * A string that identifies the key used to generate the signature.
+   */
+  keyIdentifier: string;
+
+  /**
+   * A universally unique ID (UUID) value that you define.
+   */
+  nonce: string;
+
+  /**
+   * A UTF-8 string representing the properties of a specific discount offer, cryptographically signed.
+   */
+  signature: string;
+
+  /**
+   * The date and time of the signature's creation in milliseconds, formatted in Unix epoch time.
+   */
+  timestamp: number;
+};
+
+export type RequestPurchaseIosProps = {
+  sku: string;
+  andDangerouslyFinishTransactionAutomaticallyIOS?: boolean;
+  /**
+   * UUID representing user account
+   */
+  appAccountToken?: string;
+  quantity?: number;
+  withOffer?: PaymentDiscount;
+};
+
+export type RequestSubscriptionIosProps = RequestPurchaseIosProps;
+
+export type TransactionSk2 = {
+  appAccountToken: string;
+  appBundleID: string;
+  debugDescription: string;
+  deviceVerification: string;
+  deviceVerificationNonce: string;
+  expirationDate: number;
+  environment?: 'Production' | 'Sandbox' | 'Xcode'; // Could be undefined in some cases on iOS 15, but it's stable since iOS 16
+  id: number;
+  isUpgraded: boolean;
+  jsonRepresentation: string;
+  offerID: string;
+  offerType: string;
+  originalID: string;
+  originalPurchaseDate: number;
+  ownershipType: string;
+  productID: string;
+  productType: string;
+  purchaseDate: number;
+  purchasedQuantity: number;
+  revocationDate: number;
+  revocationReason: string;
+  signedDate: number;
+  subscriptionGroupID: number;
+  webOrderLineItemID: number;
+  verificationResult?: string;
+};
+
+type SubscriptionStatus =
+  | 'expired'
+  | 'inBillingRetryPeriod'
+  | 'inGracePeriod'
+  | 'revoked'
+  | 'subscribed';
+
+type RenewalInfo = {
+  jsonRepresentation?: string;
+  willAutoRenew: boolean;
+  autoRenewPreference?: string;
+};
+
+export type ProductStatusIos = {
+  state: SubscriptionStatus;
+  renewalInfo?: RenewalInfo;
+};

package/tsconfig.json

@@ -0,0 +1,9 @@
+// @generated by expo-module-scripts
+{
+  "extends": "expo-module-scripts/tsconfig.base",
+  "compilerOptions": {
+    "outDir": "./build"
+  },
+  "include": ["./src"],
+  "exclude": ["**/__mocks__/*", "**/__tests__/*"]
+}

package/.editorconfig

@@ -1,10 +0,0 @@
-root = true
-
-[*]
-end_of_line = lf
-insert_final_newline = true
-
-[*.{js,json,yml}]
-charset = utf-8
-indent_style = space
-indent_size = 2

package/.flowconfig

@@ -1,11 +0,0 @@
-[ignore]
-<PROJECT_ROOT>/node_modules/.*
-[include]
-
-[libs]
-
-[lints]
-
-[options]
-
-[strict]

package/.monolinterrc

@@ -1,3 +0,0 @@
-{
-    "include":["package.json","docs/package.json","IapExample/package.json"]
-}