@revenuecat/purchases-js 0.0.18 → 0.1.0

package/README.md

@@ -10,178 +10,29 @@ Sign up to [get started for free](https://app.revenuecat.com/signup).
 
 Login @ [app.revenuecat.com](https://app.revenuecat.com)
 
+- Connect your Stripe account if you haven't already (More payment gateways are coming soon)
 - Create a Project (if you haven't already)
-
-### ======> Only while testing <======
-
-- Add the private project id (a.k.a. app_id) to the following feature flags
-  - RCBILLING
-  - GENERATE_V2_SUBSCRIPTION_MODELS_FOR_RCBILLING
-  - GENERATE_V2_SUBSCRIPTION_MODELS
-
-### ======> Only while testing <======
-
 - Add a new RCBilling app
-  - Get the `RC_PUBLISHABLE_API_KEY` (you will need it soon)
-  - Connect your Stripe account (More payment gateways are coming soon)
+- Get the sandbox API key or production API key (depending on the environment)
 - Create some products for the RCBilling App
 - Create an offering and add packages with RCBilling products
 - Create the entitlements you need in your app and link them to the RCBilling products
 
 # Installation
 
-### ======> Only during testing <======
-
-- Get a token to download the sdk from our private npm registry
-- Set the environment variable `NODE_AUTH_TOKEN`
-
-```bash
-export NODE_AUTH_TOKEN="the token you got from the npm registry"
-```
-
-### ======> Only during testing <======
-
 - Add the library to your project's dependencies
-
-```
-npm add --save @revenuecat/purchases-js
-```
+  - npm
+    ```
+    npm install --save @revenuecat/purchases-js
+    ```
+  - yarn
+    ```
+    yarn add --save @revenuecat/purchases-js
+    ```
 
 # Usage
 
-## Download the current Offerings
-
-By downloading the current Offerings you can easily build a Paywall page using the embedded Packages and their
-associated `rcBillingProduct` and price.
-
-```typescript
-const purchases = Purchases.configure(
-  "your RC_PUBLISHABLE_API_KEY",
-  "the unique id of the user in your systems",
-);
-
-purchases.getOfferings().then((offerings) => {
-  // Get current offering
-  console.log(offerings.current);
-  // Or a dictionary of all offerings
-  console.log(offerings.all);
-});
-```
-
-This should print the current offerings you have set up in your RC Account.
-
-Please check out [this file](https://github.com/RevenueCat/purchases-js/blob/main/src/entities/offerings.ts) for the
-Offering's data structure
-
-## Check User Entitlements
-
-You can check the entitlements granted to your users throughout all the platforms, now
-also on your website!
-
-```typescript
-const entitlementId = "the entitlementId you set up in RC";
-
-const purchases = Purchases.configure(
-  "your RC_PUBLISHABLE_API_KEY",
-  "the unique id of the user in your systems",
-);
-const appUserID = purchases.getAppUserId();
-
-purchases.isEntitledTo(entitlementId).then((isEntitled) => {
-  if (isEntitled == true) {
-    console.log(`User ${appUserID} is entitled to ${entitlementId}`);
-  } else {
-    console.log(`User ${appUserID} is not entitled to ${entitlementId}`);
-  }
-});
-```
-
-As example, you can build a cool React component with it:
-
-```tsx
-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(() => {
-    Purchases.getSharedInstance()
-      .isEntitledTo(entitlementId)
-      .then((isEntitled) => {
-        setIsEntitled(isEntitled);
-      });
-  }, [entitlementId]);
-
-  if (isEntitled === null) {
-    return <>"loading..."</>;
-  }
-
-  if (isEntitled === true) {
-    return <>{children}</>;
-  }
-
-  return <>You are not entitled!</>;
-};
-```
-
-And then use it in your app:
-
-```tsx
-const App = () => (
-  <>
-    <WithEntitlement entitlementId={"functionality5"}>
-      <Functionality5 />
-    </WithEntitlement>
-  </>
-);
-```
-
-If you need further information about the user's entitlements, you can use the `getCustomerInfo` method:
-
-```ts
-const customerInfo = await purchases.getCustomerInfo();
-```
-
-### Important note
-
-Please be aware that the information about the entitlements can be manipulated by malicious actors, so make sure
-you protect your apps against attacks that modify the entitlements by validating access through your servers.
-
-## Subscribe a User to an entitlement and allow payment with Stripe
-
-RCBilling allows you to use your payment gateway for payments.
-In this example we will show Stripe, more will be supported soon!
-
-### Context
-
-You built your paywall, and your user just clicked on the offer they want to subscribe to.
-
-```tsx
-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 = purchases.getAppUserId();
-const entitlementIdToCheck =
-  "the entitlementId you set up in RC for your product"; // TODO: remove once this is not needed
-
-purchase.purchasePackage(rcBillingPackage).then((response) => {
-  const isEntitled =
-    entitlementIdToCheck in response.customerInfo.entitlements.active;
-  if (isEntitled == true) {
-    console.log(`User ${appUserID} is entitled to ${entitlementId}`);
-  } else {
-    console.log(
-      `User ${appUserID} is not entitled to ${entitlementId}, even after ${numberOfAttempts} attempts`,
-    );
-  }
-});
-```
+See the [RevenueCat docs](https://www.revenuecat.com/docs/web/revenuecat-billing) and the [SDK Reference](https://revenuecat.github.io/purchases-js-docs).
 
 # Development
 
@@ -218,6 +69,17 @@ npm run prettier
 npm run lint
 ```
 
+## Running E2E tests
+
+```bash
+npm run build
+cd examples/rcbilling-demo
+npm run build
+# In a different terminal or background the process
+npm run dev
+npm run test
+```
+
 ## Update API specs
 
 ```bash

package/dist/Purchases.es.d.ts

@@ -421,108 +421,109 @@ export declare class Purchases {
       * 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;
-     /**
-      * 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}
+      * @throws {@link PurchasesError} if the API key or user id are invalid.
           */
-      isEntitledTo(entitlementIdentifier: string): Promise<boolean>;
+      static configure(apiKey: string, appUserId: string): Purchases;
+      /**
+       * Fetch the configured offerings for this user. You can configure these
+       * in the RevenueCat dashboard.
+       */
+      getOfferings(): Promise<Offerings>;
       /**
-       * 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.
+       * 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(rcPackage: Package, customerEmail?: string, htmlTarget?: HTMLElement): Promise<{
-           customerInfo: CustomerInfo;
-       }>;
+       isEntitledTo(entitlementIdentifier: string): Promise<boolean>;
        /**
-        * Gets latest available {@link CustomerInfo}.
-        * @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(): Promise<CustomerInfo>;
+        purchasePackage(rcPackage: Package, customerEmail?: string, htmlTarget?: HTMLElement): Promise<{
+            customerInfo: CustomerInfo;
+        }>;
         /**
-         * Gets the current app user id.
-         */
-        getAppUserId(): string;
+         * 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;
+        }
+
         /**
-         * Change the current app user id. Returns the customer info for the new
-         * user id.
-         * @param newAppUserId - The user id to change to.
+         * Error class for Purchases SDK. You should handle these errors and react
+         * accordingly in your app.
+         * @public
          */
-        changeUser(newAppUserId: string): Promise<CustomerInfo>;
+        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;
+        }
+
         /**
-         * @returns Whether the SDK is using a sandbox API Key.
+         * The store where the user originally subscribed.
+         * @public
          */
-        isSandbox(): boolean;
+        export declare type Store = "app_store" | "mac_app_store" | "play_store" | "amazon" | "stripe" | "rc_billing" | "promotional" | "unknown";
+
         /**
-         * Closes the Purchases instance. You should never have to do this normally.
+         * Error indicating that the SDK was accessed before it was initialized.
+         * @public
          */
-        close(): void;
-       }
-
-       /**
-        * 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";
-
-       /**
-        * Error indicating that the SDK was accessed before it was initialized.
-        * @public
-        */
-       export declare class UninitializedPurchasesError extends Error {
-           constructor();
-       }
+        export declare class UninitializedPurchasesError extends Error {
+            constructor();
+        }
 
-       export { }
+        export { }