@revenuecat/purchases-js 0.0.14 → 0.0.16

package/README.md

@@ -55,10 +55,12 @@ By downloading the current Offerings you can easily build a Paywall page using t
 associated `rcBillingProduct` and price.
 
 ```typescript
-const appUserId = "the unique id of the user in your systems";
-const purchases = new Purchases("your RC_PUBLISHABLE_API_KEY");
+const purchases = Purchases.configure(
+  "your RC_PUBLISHABLE_API_KEY",
+  "the unique id of the user in your systems",
+);
 
-purchases.getOfferings(appUserId).then((offerings) => {
+purchases.getOfferings().then((offerings) => {
   // Get current offering
   console.log(offerings.current);
   // Or a dictionary of all offerings
@@ -77,12 +79,15 @@ You can check the entitlements granted to your users throughout all the platform
 also on your website!
 
 ```typescript
-const appUserId = "the unique id of the user in your systems";
 const entitlementId = "the entitlementId you set up in RC";
 
-const purchases = new Purchases("your RC_PUBLISHABLE_API_KEY");
+const purchases = Purchases.configure(
+  "your RC_PUBLISHABLE_API_KEY",
+  "the unique id of the user in your systems",
+);
+const appUserID = purchases.getAppUserId();
 
-purchases.isEntitledTo(appUserId, entitlementId).then((isEntitled) => {
+purchases.isEntitledTo(entitlementId).then((isEntitled) => {
   if (isEntitled == true) {
     console.log(`User ${appUserID} is entitled to ${entitlementId}`);
   } else {
@@ -94,15 +99,21 @@ purchases.isEntitledTo(appUserId, entitlementId).then((isEntitled) => {
 As example, you can build a cool React component with it:
 
 ```tsx
-const WithEntitlement = ({ appUserId, entitlementId, children }) => {
+Purchases.configure(
+  "your RC_PUBLISHABLE_API_KEY",
+  "the unique id of the user in your systems",
+);
+
+const WithEntitlement = ({ entitlementId, children }) => {
   const [isEntitled, setIsEntitled] = useState<boolean | null>(null);
 
   useEffect(() => {
-    const purchases = new Purchases("your RC_PUBLISHABLE_API_KEY");
-    purchases.isEntitledTo(appUserId, entitlementId).then((isEntitled) => {
-      setIsEntitled(isEntitled);
-    });
-  }, [appUserId, entitlementId]);
+    Purchases.getSharedInstance()
+      .isEntitledTo(entitlementId)
+      .then((isEntitled) => {
+        setIsEntitled(isEntitled);
+      });
+  }, [entitlementId]);
 
   if (isEntitled === null) {
     return <>"loading..."</>;
@@ -121,7 +132,7 @@ And then use it in your app:
 ```tsx
 const App = () => (
   <>
-    <WithEntitlement appUserId={"user12345"} entitlementId={"functionality5"}>
+    <WithEntitlement entitlementId={"functionality5"}>
       <Functionality5 />
     </WithEntitlement>
   </>
@@ -131,7 +142,7 @@ const App = () => (
 If you need further information about the user's entitlements, you can use the `getCustomerInfo` method:
 
 ```ts
-const customerInfo = await purchases.getCustomerInfo(appUserId);
+const customerInfo = await purchases.getCustomerInfo();
 ```
 
 ### Important note
@@ -149,15 +160,17 @@ In this example we will show Stripe, more will be supported soon!
 You built your paywall, and your user just clicked on the offer they want to subscribe to.
 
 ```tsx
-const purchases = new Purchases("your RC_PUBLISHABLE_API_KEY");
+const purchases = Purchases.configure(
+  "your RC_PUBLISHABLE_API_KEY",
+  "the unique id of the user in your systems",
+);
 // You can retrieve the package from the offerings through `getOfferings`:
 const rcBillingPackage = offerings.current.availablePackages[0];
-const appUserId =
-  "the unique id of the user that wants to subscribe to your product";
+const appUserId = purchases.getAppUserId();
 const entitlementIdToCheck =
   "the entitlementId you set up in RC for your product"; // TODO: remove once this is not needed
 
-purchase.purchasePackage(appUserId, rcBillingPackage).then((response) => {
+purchase.purchasePackage(rcBillingPackage).then((response) => {
   const isEntitled =
     entitlementIdToCheck in response.customerInfo.entitlements.active;
   if (isEntitled == true) {

package/dist/Purchases.es.d.ts

@@ -368,92 +368,123 @@ 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.configure} method when possible.
+     * @throws {@link UninitializedPurchasesError} if the instance has not been initialized yet.
          */
-     isEntitledTo(appUserId: string, entitlementIdentifier: string): Promise<boolean>;
+     static getSharedInstance(): Purchases;
+     /**
+      * Returns whether the Purchases SDK is configured or not.
+      */
+     static isConfigured(): boolean;
+     /**
+      * Configures 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 configure(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.
+        * @public
+        */
+       export declare class UninitializedPurchasesError extends Error {
+           constructor();
+       }
 
-      export { }
+       export { }