@revenuecat/purchases-js 0.13.1 → 0.15.0

package/README.md

@@ -47,11 +47,50 @@ npm install
 npm run build:dev
 ```
 
-To avoid publishing the package you can set it up as a local dependency.
-In your testing project install the library as.
+To avoid publishing the package you can use Yarn's link feature:
+
+1. In the purchases-js directory, register the package:
+
+```bash
+yarn link
+```
+
+2. In your testing project, link to the registered package:
+
+```bash
+yarn link "@revenuecat/purchases-js"
+```
+
+> **Note:** Any changes you make to the library will be automatically reflected in your testing project after running `npm run build:dev` or `npm run build`.
+
+## Running Storybook
+
+```bash
+npm run storybook
+```
+
+### Environment Setup for Needs Payment Info Stories
+
+> **Note:** This setup is only required if you need to test Storybook stories involving the `state-needs-payment-info` component.
+
+To run these specific stories, you'll need to set up some environment variables. There are two options:
+
+### Option 1: Internal Teams
+
+Internal team members can find the required environment variables in 1Password.
+
+### Option 2: Setup Manually
+
+1. Create a test account in Stripe
+2. Go to settings, API keys, and create a restricted key with the following permissions:
+   - Setup intent (read/write)
+   - Payment methods (read/write)
+3. Create a `.env.development.local` file and set the following variables:
 
 ```bash
-npm i /path/to/purchases-js
+VITE_STORYBOOK_RESTRICTED_SECRET="sk_test_1234567890"
+VITE_STORYBOOK_PUBLISHABLE_API_KEY="pk_test_1234567890"
+VITE_STORYBOOK_ACCOUNT_ID="acct_1234567890"
 ```
 
 ## Running tests

package/dist/Purchases.es.d.ts

@@ -637,6 +637,15 @@ export declare interface PurchaseParams {
      * The email of the user. If undefined, RevenueCat will ask the customer for their email.
      */
     customerEmail?: string;
+    /**
+     * The locale to use for the purchase flow. If not specified, English will be used
+     */
+    selectedLocale?: string;
+    /**
+     * The default locale to use if the selectedLocale is not available.
+     * Defaults to english.
+     */
+    defaultLocale?: string;
 }
 
 /**
@@ -769,7 +778,7 @@ export declare class Purchases {
           /**
            * Generates an anonymous app user ID that follows RevenueCat's format.
            * This can be used when you don't have a user identifier system in place.
-           * The generated ID will be in the format: $RCAnonymousID:<UUID without dashes>
+           * The generated ID will be in the format: $RCAnonymousID:\<UUID without dashes\>
            * Example: $RCAnonymousID:123e4567e89b12d3a456426614174000
            * @returns A new anonymous app user ID string
            * @public
@@ -792,7 +801,7 @@ export declare class Purchases {
               * Underlying error message. This provides more details on the error and
               * can be useful for debugging and logging.
               */
-             readonly underlyingErrorMessage?: (string | null) | undefined;
+             readonly underlyingErrorMessage?: string | null | undefined;
              /**
               * Contains extra information that is available in certain types of errors.
               */
@@ -811,7 +820,7 @@ export declare class Purchases {
               * Underlying error message. This provides more details on the error and
               * can be useful for debugging and logging.
               */
-             underlyingErrorMessage?: (string | null) | undefined, 
+             underlyingErrorMessage?: string | null | undefined, 
              /**
               * Contains extra information that is available in certain types of errors.
               */