@revenuecat/purchases-js 0.0.13 → 0.0.15

package/dist/Purchases.es.d.ts

@@ -198,31 +198,31 @@ export declare interface Offering {
     /**
      * Lifetime package type configured in the RevenueCat dashboard, if available.
      */
-    readonly lifetimePackage: Package | null;
+    readonly lifetime: Package | null;
     /**
      * Annual package type configured in the RevenueCat dashboard, if available.
      */
-    readonly annualPackage: Package | null;
+    readonly annual: Package | null;
     /**
      * Six month package type configured in the RevenueCat dashboard, if available.
      */
-    readonly sixMonthPackage: Package | null;
+    readonly sixMonth: Package | null;
     /**
      * Three month package type configured in the RevenueCat dashboard, if available.
      */
-    readonly threeMonthPackage: Package | null;
+    readonly threeMonth: Package | null;
     /**
      * Two month package type configured in the RevenueCat dashboard, if available.
      */
-    readonly twoMonthPackage: Package | null;
+    readonly twoMonth: Package | null;
     /**
      * Monthly package type configured in the RevenueCat dashboard, if available.
      */
-    readonly monthlyPackage: Package | null;
+    readonly monthly: Package | null;
     /**
      * Weekly package type configured in the RevenueCat dashboard, if available.
      */
-    readonly weeklyPackage: Package | null;
+    readonly weekly: Package | null;
 }
 
 /**
@@ -368,92 +368,122 @@ export declare interface Product {
  */
 export declare class Purchases {
     /**
-     * Constructor for Purchases.
-     * @param apiKey - RevenueCat API Key. Can be obtained from the RevenueCat dashboard.
-     */
-    constructor(apiKey: string);
-    /**
-     * Fetch the configured offerings for this user. You can configure these
-     * in the RevenueCat dashboard.
-     * @param appUserId - Your app's user id in your system.
-     */
-    getOfferings(appUserId: string): Promise<Offerings>;
-    /**
-     * Convenience method to check whether a user is entitled to a specific
-     * entitlement. This will use {@link Purchases.getCustomerInfo} under the hood.
-     * @param appUserId - Your app's user id in your system.
-     * @param entitlementIdentifier - The entitlement identifier you want to check.
-     * @returns Whether the user is entitled to the specified entitlement
-     * @throws {@link PurchasesError} if there is an error while fetching the customer info.
-         * @see {@link Purchases.getCustomerInfo}
+     * Get the singleton instance of Purchases. It's preferred to use the instance
+     * obtained from the {@link Purchases.initializePurchases} method when possible.
+     * @throws {@link UninitializedPurchasesError} if the instance has not been initialized yet.
          */
-     isEntitledTo(appUserId: string, entitlementIdentifier: string): Promise<boolean>;
+     static getInstance(): Purchases;
+     /**
+      * Returns whether the Purchases SDK is configured or not.
+      */
+     static isConfigured(): boolean;
+     /**
+      * Initializes the Purchases SDK. This should be called as soon as your app
+      * has a unique user id for your user. You should only call this once, and
+      * keep the returned instance around for use throughout your application.
+      * @param apiKey - RevenueCat API Key. Can be obtained from the RevenueCat dashboard.
+      * @param appUserId - Your unique id for identifying the user.
+      */
+     static initializePurchases(apiKey: string, appUserId: string): Purchases;
      /**
-      * Method to perform a purchase for a given package. You can obtain the
-      * package from {@link Purchases.getOfferings}. This method will present the purchase
-      * form on your site, using the given HTML element as the mount point, if
-      * provided, or as a modal if not.
-      * @param appUserId - Your app's user id in your system.
-      * @param rcPackage - The package you want to purchase. Obtained from {@link Purchases.getOfferings}.
-      * @param customerEmail - The email of the user. If null, RevenueCat will ask the customer for their email.
-      * @param htmlTarget - The HTML element where the billing view should be added. If null, a new div will be created at the root of the page and appended to the body.
-      * @returns The customer info after the purchase is completed successfuly.
-      * @throws {@link PurchasesError} if there is an error while performing the purchase. If the {@link PurchasesError.errorCode} is {@link ErrorCode.UserCancelledError}, the user cancelled the purchase.
+      * Fetch the configured offerings for this user. You can configure these
+      * in the RevenueCat dashboard.
+      */
+     getOfferings(): Promise<Offerings>;
+     /**
+      * Convenience method to check whether a user is entitled to a specific
+      * entitlement. This will use {@link Purchases.getCustomerInfo} under the hood.
+      * @param entitlementIdentifier - The entitlement identifier you want to check.
+      * @returns Whether the user is entitled to the specified entitlement
+      * @throws {@link PurchasesError} if there is an error while fetching the customer info.
+          * @see {@link Purchases.getCustomerInfo}
           */
-      purchasePackage(appUserId: string, rcPackage: Package, customerEmail?: string, htmlTarget?: HTMLElement): Promise<{
-          customerInfo: CustomerInfo;
-      }>;
+      isEntitledTo(entitlementIdentifier: string): Promise<boolean>;
       /**
-       * Gets latest available {@link CustomerInfo}.
-       * @param appUserId - Your app's user id in your system.
-       * @returns The latest {@link CustomerInfo}.
-       * @throws {@link PurchasesError} if there is an error while fetching the customer info.
+       * Method to perform a purchase for a given package. You can obtain the
+       * package from {@link Purchases.getOfferings}. This method will present the purchase
+       * form on your site, using the given HTML element as the mount point, if
+       * provided, or as a modal if not.
+       * @param rcPackage - The package you want to purchase. Obtained from {@link Purchases.getOfferings}.
+       * @param customerEmail - The email of the user. If null, RevenueCat will ask the customer for their email.
+       * @param htmlTarget - The HTML element where the billing view should be added. If null, a new div will be created at the root of the page and appended to the body.
+       * @returns The customer info after the purchase is completed successfuly.
+       * @throws {@link PurchasesError} if there is an error while performing the purchase. If the {@link PurchasesError.errorCode} is {@link ErrorCode.UserCancelledError}, the user cancelled the purchase.
            */
-       getCustomerInfo(appUserId: string): Promise<CustomerInfo>;
+       purchasePackage(rcPackage: Package, customerEmail?: string, htmlTarget?: HTMLElement): Promise<{
+           customerInfo: CustomerInfo;
+       }>;
+       /**
+        * Gets latest available {@link CustomerInfo}.
+        * @returns The latest {@link CustomerInfo}.
+        * @throws {@link PurchasesError} if there is an error while fetching the customer info.
+            */
+        getCustomerInfo(): Promise<CustomerInfo>;
+        /**
+         * Gets the current app user id.
+         */
+        getAppUserId(): string;
+        /**
+         * Change the current app user id. Returns the customer info for the new
+         * user id.
+         * @param newAppUserId - The user id to change to.
+         */
+        changeUser(newAppUserId: string): Promise<CustomerInfo>;
+        /**
+         * @returns Whether the SDK is using a sandbox API Key.
+         */
+        isSandbox(): boolean;
+        /**
+         * Closes the Purchases instance. You should never have to do this normally.
+         */
+        close(): void;
+       }
+
        /**
-        * @returns Whether the SDK is using a sandbox API Key.
+        * Error class for Purchases SDK. You should handle these errors and react
+        * accordingly in your app.
+        * @public
         */
-       isSandbox(): boolean;
-      }
+       export declare class PurchasesError extends Error {
+           /**
+            * Error code for the error. This is useful to appropriately react to
+            * different error situations.
+            */
+           readonly errorCode: ErrorCode;
+           /**
+            * Underlying error message. This provides more details on the error and
+            * can be useful for debugging and logging.
+            */
+           readonly underlyingErrorMessage?: string | null | undefined;
+           constructor(
+           /**
+            * Error code for the error. This is useful to appropriately react to
+            * different error situations.
+            */
+           errorCode: ErrorCode, 
+           /**
+            * Message for the error. This is useful for debugging and logging.
+            */
+           message?: string, 
+           /**
+            * Underlying error message. This provides more details on the error and
+            * can be useful for debugging and logging.
+            */
+           underlyingErrorMessage?: string | null | undefined);
+           toString: () => string;
+       }
 
-      /**
-       * Error class for Purchases SDK. You should handle these errors and react
-       * accordingly in your app.
-       * @public
-       */
-      export declare class PurchasesError extends Error {
-          /**
-           * Error code for the error. This is useful to appropriately react to
-           * different error situations.
-           */
-          readonly errorCode: ErrorCode;
-          /**
-           * Underlying error message. This provides more details on the error and
-           * can be useful for debugging and logging.
-           */
-          readonly underlyingErrorMessage?: string | null | undefined;
-          constructor(
-          /**
-           * Error code for the error. This is useful to appropriately react to
-           * different error situations.
-           */
-          errorCode: ErrorCode, 
-          /**
-           * Message for the error. This is useful for debugging and logging.
-           */
-          message?: string, 
-          /**
-           * Underlying error message. This provides more details on the error and
-           * can be useful for debugging and logging.
-           */
-          underlyingErrorMessage?: string | null | undefined);
-          toString: () => string;
-      }
+       /**
+        * The store where the user originally subscribed.
+        * @public
+        */
+       export declare type Store = "app_store" | "mac_app_store" | "play_store" | "amazon" | "stripe" | "rc_billing" | "promotional" | "unknown";
 
-      /**
-       * The store where the user originally subscribed.
-       * @public
-       */
-      export declare type Store = "app_store" | "mac_app_store" | "play_store" | "amazon" | "stripe" | "rc_billing" | "promotional" | "unknown";
+       /**
+        * Error indicating that the SDK was accessed before it was initialized.
+        */
+       export declare class UninitializedPurchasesError extends Error {
+           constructor();
+       }
 
-      export { }
+       export { }