@capgo/native-purchases 0.0.1

package/dist/docs.json

@@ -0,0 +1,371 @@
+{
+  "api": {
+    "name": "NativePurchasesPlugin",
+    "slug": "nativepurchasesplugin",
+    "docs": "",
+    "tags": [],
+    "methods": [
+      {
+        "name": "restorePurchases",
+        "signature": "() => any",
+        "parameters": [],
+        "returns": "any",
+        "tags": [],
+        "docs": "Restores a user's previous  and links their appUserIDs to any user's also using those .",
+        "complexTypes": [
+          "CustomerInfo"
+        ],
+        "slug": "restorepurchases"
+      },
+      {
+        "name": "purchaseProduct",
+        "signature": "(options: { productIdentifier: string; quantity: number; }) => any",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ productIdentifier: string; quantity: number; }"
+          }
+        ],
+        "returns": "any",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "CustomerInfo"
+        ],
+        "slug": "purchaseproduct"
+      },
+      {
+        "name": "getProducts",
+        "signature": "(options: { productIdentifiers: string[]; }) => any",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ productIdentifiers: {}; }"
+          }
+        ],
+        "returns": "any",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "Product"
+        ],
+        "slug": "getproducts"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "CustomerInfo",
+      "slug": "customerinfo",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "activeSubscriptions",
+          "tags": [],
+          "docs": "Set of active subscription skus",
+          "complexTypes": [],
+          "type": "[string]"
+        },
+        {
+          "name": "allPurchasedProductIdentifiers",
+          "tags": [],
+          "docs": "Set of purchased skus, active and inactive",
+          "complexTypes": [],
+          "type": "[string]"
+        },
+        {
+          "name": "nonSubscriptionTransactions",
+          "tags": [],
+          "docs": "Returns all the non-subscription  a user has made.\nThe  are ordered by purchase date in ascending order.",
+          "complexTypes": [
+            "Transaction"
+          ],
+          "type": "{}"
+        },
+        {
+          "name": "latestExpirationDate",
+          "tags": [],
+          "docs": "The latest expiration date of all purchased skus",
+          "complexTypes": [],
+          "type": "string | null"
+        },
+        {
+          "name": "firstSeen",
+          "tags": [],
+          "docs": "The date this user was first seen in RevenueCat.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "originalAppUserId",
+          "tags": [],
+          "docs": "The original App User Id recorded for this user.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "requestDate",
+          "tags": [],
+          "docs": "Date when this info was requested",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "originalApplicationVersion",
+          "tags": [],
+          "docs": "Returns the version number for the version of the application when the\nuser bought the app. Use this for grandfathering users when migrating\nto subscriptions.\n\nThis corresponds to the value of CFBundleVersion (in iOS) in the\nInfo.plist file when the purchase was originally made. This is always null\nin Android",
+          "complexTypes": [],
+          "type": "string | null"
+        },
+        {
+          "name": "originalPurchaseDate",
+          "tags": [],
+          "docs": "Returns the purchase date for the version of the application when the user bought the app.\nUse this for grandfathering users when migrating to subscriptions.",
+          "complexTypes": [],
+          "type": "string | null"
+        },
+        {
+          "name": "managementURL",
+          "tags": [],
+          "docs": "URL to manage the active subscription of the user. If this user has an active iOS\nsubscription, this will point to the App Store, if the user has an active Play Store subscription\nit will point there. If there are no active subscriptions it will be null.\nIf there are multiple for different platforms, it will point to the device store.",
+          "complexTypes": [],
+          "type": "string | null"
+        }
+      ]
+    },
+    {
+      "name": "Transaction",
+      "slug": "transaction",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "transactionIdentifier",
+          "tags": [],
+          "docs": "RevenueCat Id associated to the transaction.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "productIdentifier",
+          "tags": [],
+          "docs": "Product Id associated with the transaction.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "purchaseDate",
+          "tags": [],
+          "docs": "Purchase date of the transaction in ISO 8601 format.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "Product",
+      "slug": "product",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "identifier",
+          "tags": [],
+          "docs": "Product Id.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "description",
+          "tags": [],
+          "docs": "Description of the product.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "title",
+          "tags": [],
+          "docs": "Title of the product.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "price",
+          "tags": [],
+          "docs": "Price of the product in the local currency.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "priceString",
+          "tags": [],
+          "docs": "Formatted price of the item, including its currency sign, such as €3.99.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "currencyCode",
+          "tags": [],
+          "docs": "Currency code for price and original price.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "currencySymbol",
+          "tags": [],
+          "docs": "Currency symbol for price and original price.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "isFamilyShareable",
+          "tags": [],
+          "docs": "Boolean indicating if the product is sharable with family",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "subscriptionGroupIdentifier",
+          "tags": [],
+          "docs": "Group identifier for the product.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "subscriptionPeriod",
+          "tags": [],
+          "docs": "The Product subcription group identifier.",
+          "complexTypes": [
+            "SubscriptionPeriod"
+          ],
+          "type": "SubscriptionPeriod"
+        },
+        {
+          "name": "introductoryPrice",
+          "tags": [],
+          "docs": "The Product introductory Price.",
+          "complexTypes": [
+            "SKProductDiscount"
+          ],
+          "type": "SKProductDiscount | null"
+        },
+        {
+          "name": "discounts",
+          "tags": [],
+          "docs": "The Product discounts list.",
+          "complexTypes": [
+            "SKProductDiscount"
+          ],
+          "type": "{}"
+        }
+      ]
+    },
+    {
+      "name": "SubscriptionPeriod",
+      "slug": "subscriptionperiod",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "numberOfUnits",
+          "tags": [],
+          "docs": "The Subscription Period number of unit.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "unit",
+          "tags": [],
+          "docs": "The Subscription Period unit.",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    },
+    {
+      "name": "SKProductDiscount",
+      "slug": "skproductdiscount",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "identifier",
+          "tags": [],
+          "docs": "The Product discount identifier.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "type",
+          "tags": [],
+          "docs": "The Product discount type.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "price",
+          "tags": [],
+          "docs": "The Product discount price.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "priceString",
+          "tags": [],
+          "docs": "Formatted price of the item, including its currency sign, such as €3.99.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "currencySymbol",
+          "tags": [],
+          "docs": "The Product discount currency symbol.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "currencyCode",
+          "tags": [],
+          "docs": "The Product discount currency code.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "paymentMode",
+          "tags": [],
+          "docs": "The Product discount paymentMode.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "numberOfPeriods",
+          "tags": [],
+          "docs": "The Product discount number Of Periods.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "subscriptionPeriod",
+          "tags": [],
+          "docs": "The Product discount subscription period.",
+          "complexTypes": [
+            "SubscriptionPeriod"
+          ],
+          "type": "SubscriptionPeriod"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [],
+  "pluginConfigs": []
+}

package/dist/esm/definitions.d.ts

@@ -0,0 +1,305 @@
+export declare enum ATTRIBUTION_NETWORK {
+    APPLE_SEARCH_ADS = 0,
+    ADJUST = 1,
+    APPSFLYER = 2,
+    BRANCH = 3,
+    TENJIN = 4,
+    FACEBOOK = 5
+}
+export declare enum PURCHASE_TYPE {
+    /**
+     * A type of SKU for in-app products.
+     */
+    INAPP = "inapp",
+    /**
+     * A type of SKU for subscriptions.
+     */
+    SUBS = "subs"
+}
+/**
+ * Enum for billing features.
+ * Currently, these are only relevant for Google Play Android users:
+ * https://developer.android.com/reference/com/android/billingclient/api/BillingClient.FeatureType
+ */
+export declare enum BILLING_FEATURE {
+    /**
+     * Purchase/query for subscriptions.
+     */
+    SUBSCRIPTIONS = 0,
+    /**
+     * Subscriptions update/replace.
+     */
+    SUBSCRIPTIONS_UPDATE = 1,
+    /**
+     * Purchase/query for in-app items on VR.
+     */
+    IN_APP_ITEMS_ON_VR = 2,
+    /**
+     * Purchase/query for subscriptions on VR.
+     */
+    SUBSCRIPTIONS_ON_VR = 3,
+    /**
+     * Launch a price change confirmation flow.
+     */
+    PRICE_CHANGE_CONFIRMATION = 4
+}
+export declare enum PRORATION_MODE {
+    UNKNOWN_SUBSCRIPTION_UPGRADE_DOWNGRADE_POLICY = 0,
+    /**
+     * Replacement takes effect immediately, and the remaining time will be
+     * prorated and credited to the user. This is the current default behavior.
+     */
+    IMMEDIATE_WITH_TIME_PRORATION = 1,
+    /**
+     * Replacement takes effect immediately, and the billing cycle remains the
+     * same. The price for the remaining period will be charged. This option is
+     * only available for subscription upgrade.
+     */
+    IMMEDIATE_AND_CHARGE_PRORATED_PRICE = 2,
+    /**
+     * Replacement takes effect immediately, and the new price will be charged on
+     * next recurrence time. The billing cycle stays the same.
+     */
+    IMMEDIATE_WITHOUT_PRORATION = 3,
+    /**
+     * Replacement takes effect when the old plan expires, and the new price will
+     * be charged at the same time.
+     */
+    DEFERRED = 4
+}
+export declare enum PACKAGE_TYPE {
+    /**
+     * A package that was defined with a custom identifier.
+     */
+    UNKNOWN = "UNKNOWN",
+    /**
+     * A package that was defined with a custom identifier.
+     */
+    CUSTOM = "CUSTOM",
+    /**
+     * A package configured with the predefined lifetime identifier.
+     */
+    LIFETIME = "LIFETIME",
+    /**
+     * A package configured with the predefined annual identifier.
+     */
+    ANNUAL = "ANNUAL",
+    /**
+     * A package configured with the predefined six month identifier.
+     */
+    SIX_MONTH = "SIX_MONTH",
+    /**
+     * A package configured with the predefined three month identifier.
+     */
+    THREE_MONTH = "THREE_MONTH",
+    /**
+     * A package configured with the predefined two month identifier.
+     */
+    TWO_MONTH = "TWO_MONTH",
+    /**
+     * A package configured with the predefined monthly identifier.
+     */
+    MONTHLY = "MONTHLY",
+    /**
+     * A package configured with the predefined weekly identifier.
+     */
+    WEEKLY = "WEEKLY"
+}
+export declare enum INTRO_ELIGIBILITY_STATUS {
+    /**
+     * RevenueCat doesn't have enough information to determine eligibility.
+     */
+    INTRO_ELIGIBILITY_STATUS_UNKNOWN = 0,
+    /**
+     * The user is not eligible for a free trial or intro pricing for this product.
+     */
+    INTRO_ELIGIBILITY_STATUS_INELIGIBLE = 1,
+    /**
+     * The user is eligible for a free trial or intro pricing for this product.
+     */
+    INTRO_ELIGIBILITY_STATUS_ELIGIBLE = 2
+}
+export interface Transaction {
+    /**
+     * RevenueCat Id associated to the transaction.
+     */
+    readonly transactionIdentifier: string;
+    /**
+     * Product Id associated with the transaction.
+     */
+    readonly productIdentifier: string;
+    /**
+     * Purchase date of the transaction in ISO 8601 format.
+     */
+    readonly purchaseDate: string;
+}
+export interface CustomerInfo {
+    /**
+     * Set of active subscription skus
+     */
+    readonly activeSubscriptions: [string];
+    /**
+     * Set of purchased skus, active and inactive
+     */
+    readonly allPurchasedProductIdentifiers: [string];
+    /**
+     * Returns all the non-subscription  a user has made.
+     * The  are ordered by purchase date in ascending order.
+     */
+    readonly nonSubscriptionTransactions: Transaction[];
+    /**
+     * The latest expiration date of all purchased skus
+     */
+    readonly latestExpirationDate: string | null;
+    /**
+     * The date this user was first seen in RevenueCat.
+     */
+    readonly firstSeen: string;
+    /**
+     * The original App User Id recorded for this user.
+     */
+    readonly originalAppUserId: string;
+    /**
+     * Date when this info was requested
+     */
+    readonly requestDate: string;
+    /**
+     * Returns the version number for the version of the application when the
+     * user bought the app. Use this for grandfathering users when migrating
+     * to subscriptions.
+     *
+     * This corresponds to the value of CFBundleVersion (in iOS) in the
+     * Info.plist file when the purchase was originally made. This is always null
+     * in Android
+     */
+    readonly originalApplicationVersion: string | null;
+    /**
+     * Returns the purchase date for the version of the application when the user bought the app.
+     * Use this for grandfathering users when migrating to subscriptions.
+     */
+    readonly originalPurchaseDate: string | null;
+    /**
+     * URL to manage the active subscription of the user. If this user has an active iOS
+     * subscription, this will point to the App Store, if the user has an active Play Store subscription
+     * it will point there. If there are no active subscriptions it will be null.
+     * If there are multiple for different platforms, it will point to the device store.
+     */
+    readonly managementURL: string | null;
+}
+export interface SubscriptionPeriod {
+    /**
+     * The Subscription Period number of unit.
+     */
+    readonly numberOfUnits: number;
+    /**
+     * The Subscription Period unit.
+     */
+    readonly unit: number;
+}
+export interface SKProductDiscount {
+    /**
+     * The Product discount identifier.
+     */
+    readonly identifier: string;
+    /**
+     * The Product discount type.
+     */
+    readonly type: number;
+    /**
+     * The Product discount price.
+     */
+    readonly price: number;
+    /**
+     * Formatted price of the item, including its currency sign, such as €3.99.
+     */
+    readonly priceString: string;
+    /**
+     * The Product discount currency symbol.
+     */
+    readonly currencySymbol: string;
+    /**
+     * The Product discount currency code.
+     */
+    readonly currencyCode: string;
+    /**
+     * The Product discount paymentMode.
+     */
+    readonly paymentMode: number;
+    /**
+     * The Product discount number Of Periods.
+     */
+    readonly numberOfPeriods: number;
+    /**
+     * The Product discount subscription period.
+     */
+    readonly subscriptionPeriod: SubscriptionPeriod;
+}
+export interface Product {
+    /**
+     * Product Id.
+     */
+    readonly identifier: string;
+    /**
+     * Description of the product.
+     */
+    readonly description: string;
+    /**
+     * Title of the product.
+     */
+    readonly title: string;
+    /**
+     * Price of the product in the local currency.
+     */
+    readonly price: number;
+    /**
+     * Formatted price of the item, including its currency sign, such as €3.99.
+     */
+    readonly priceString: string;
+    /**
+     * Currency code for price and original price.
+     */
+    readonly currencyCode: string;
+    /**
+     * Currency symbol for price and original price.
+     */
+    readonly currencySymbol: string;
+    /**
+     * Boolean indicating if the product is sharable with family
+     */
+    readonly isFamilyShareable: boolean;
+    /**
+     * Group identifier for the product.
+     */
+    readonly subscriptionGroupIdentifier: string;
+    /**
+     * The Product subcription group identifier.
+     */
+    readonly subscriptionPeriod: SubscriptionPeriod;
+    /**
+     * The Product introductory Price.
+     */
+    readonly introductoryPrice: SKProductDiscount | null;
+    /**
+     * The Product discounts list.
+     */
+    readonly discounts: SKProductDiscount[];
+}
+export interface NativePurchasesPlugin {
+    /**
+     * Restores a user's previous  and links their appUserIDs to any user's also using those .
+     */
+    restorePurchases(): Promise<{
+        customerInfo: CustomerInfo;
+    }>;
+    purchaseProduct(options: {
+        productIdentifier: string;
+        quantity: number;
+    }): Promise<{
+        customerInfo: CustomerInfo;
+    }>;
+    getProducts(options: {
+        productIdentifiers: string[];
+    }): Promise<{
+        products: Product[];
+    }>;
+}