@revenuecat/purchases-js 1.3.0 → 1.4.1

package/dist/Purchases.es.d.ts

@@ -911,227 +911,434 @@ export declare class Purchases {
            */
           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>;
+           * Sets attributes for the current user. Attributes are useful for storing additional, structured information on a customer that can be used elsewhere in the system.
+           * For example, you could store your customer's email address or additional system identifiers through the applicable reserved attributes, or store arbitrary facts like onboarding survey responses, feature usage, or other dimensions as custom attributes.
+           *
+           * Note: Unlike our mobile SDKs, the web SDK does not cache or retry sending attributes if the request fails. If the request fails, the attributes will not be saved and you will need to retry the operation.
+           *
+           * @param attributes - A dictionary of attributes to set for the current user.
+           * @throws {@link PurchasesError} if there is an error while setting the attributes or if the customer doesn't exist.
+               */
+           setAttributes(attributes: {
+               [key: string | ReservedCustomerAttribute]: string | null;
+           }): Promise<void>;
+           /**
+            * 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;
+           /**
+            * @returns Whether the current user is anonymous.
+            */
+           isAnonymous(): boolean;
+           /**
+            * Closes the Purchases instance. You should never have to do this normally.
+            */
+           close(): void;
+           /**
+            * 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\>
+            * Example: $RCAnonymousID:123e4567e89b12d3a456426614174000
+            * @returns A new anonymous app user ID string
+            * @public
+            */
+           static generateRevenueCatAnonymousAppUserId(): string;
+          }
+
           /**
-           * @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;
+              /**
+               * Contains extra information that is available in certain types of errors.
+               */
+              readonly extra?: PurchasesErrorExtra | 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, 
+              /**
+               * Contains extra information that is available in certain types of errors.
+               */
+              extra?: PurchasesErrorExtra | undefined);
+              toString: () => string;
+          }
+
           /**
-           * @returns Whether the current user is anonymous.
+           * Extra information that is available in certain types of errors.
+           * @public
            */
-          isAnonymous(): boolean;
+          export declare interface PurchasesErrorExtra {
+              /**
+               * If this is a request error, the HTTP status code of the response.
+               */
+              readonly statusCode?: number;
+              /**
+               * If this is a RevenueCat backend error, the error code from the servers.
+               */
+              readonly backendErrorCode?: number;
+          }
+
           /**
-           * Closes the Purchases instance. You should never have to do this normally.
+           * This object gives you access to the purchase redemption data when
+           * the purchase can be redeemed to a mobile user, like in the case of anonymous users.
+           * @public
            */
-          close(): void;
+          export declare interface RedemptionInfo {
+              /**
+               * The redeem url.
+               */
+              readonly redeemUrl: string | null;
+          }
+
           /**
-           * 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\>
-           * Example: $RCAnonymousID:123e4567e89b12d3a456426614174000
-           * @returns A new anonymous app user ID string
+           * Enumeration of reserved customer attributes.
            * @public
            */
-          static generateRevenueCatAnonymousAppUserId(): 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;
-             /**
-              * Contains extra information that is available in certain types of errors.
-              */
-             readonly extra?: PurchasesErrorExtra | 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, 
-             /**
-              * Contains extra information that is available in certain types of errors.
-              */
-             extra?: PurchasesErrorExtra | undefined);
-             toString: () => string;
-         }
-
-         /**
-          * Extra information that is available in certain types of errors.
-          * @public
-          */
-         export declare interface PurchasesErrorExtra {
-             /**
-              * If this is a request error, the HTTP status code of the response.
-              */
-             readonly statusCode?: number;
-             /**
-              * If this is a RevenueCat backend error, the error code from the servers.
-              */
-             readonly backendErrorCode?: number;
-         }
+          export declare enum ReservedCustomerAttribute {
+              /**
+               * The display name that should be used to reference the customer.
+               */
+              DisplayName = "$displayName",
+              /**
+               * The email address of the customer.
+               */
+              Email = "$email",
+              /**
+               * The phone number of the customer.
+               */
+              PhoneNumber = "$phoneNumber",
+              /**
+               * iOS advertising identifier UUID for the customer.
+               */
+              IDFA = "$idfa",
+              /**
+               * iOS vendor identifier UUID for the customer.
+               */
+              IDFV = "$idfv",
+              /**
+               * The advertising ID that is provided by Google Play services for the customer.
+               */
+              GPSAdId = "$gpsAdId",
+              /**
+               * The Android ID of the customer.
+               */
+              AndroidId = "$androidId",
+              /**
+               * The Amazon Advertising ID of the customer.
+               */
+              AmazonAdId = "$amazonAdId",
+              /**
+               * The IP address of the customer.
+               */
+              IP = "$ip",
+              /**
+               * The unique Adjust identifier for the customer.
+               */
+              AdjustId = "$adjustId",
+              /**
+               * The Amplitude device ID of the customer.
+               */
+              AmplitudeDeviceId = "$amplitudeDeviceId",
+              /**
+               * The Amplitude user ID of the customer.
+               */
+              AmplitudeUserId = "$amplitudeUserId",
+              /**
+               * Appsflyer Id. The unique Appsflyer identifier for the customer.
+               */
+              AppsflyerId = "$appsflyerId",
+              /**
+               * The AppsFlyer sharing filter of the customer.
+               */
+              AppsflyerSharingFilter = "$appsflyerSharingFilter",
+              /**
+               * The Branch ID of the customer.
+               */
+              BranchId = "$branchId",
+              /**
+               * The Braze 'alias_name' in User Alias Object.
+               */
+              BrazeAliasName = "$brazeAliasName",
+              /**
+               * The Braze 'alias_label' in User Alias Object.
+               */
+              BrazeAliasLabel = "$brazeAliasLabel",
+              /**
+               * The CleverTap ID of the customer.
+               */
+              ClevertapId = "$clevertapId",
+              /**
+               * The Facebook anonymous ID of the customer.
+               */
+              FbAnonId = "$fbAnonId",
+              /**
+               * The unique mParticle user identifier (mpid).
+               */
+              MparticleId = "$mparticleId",
+              /**
+               * The OneSignal Player Id for the customer.
+               */
+              OnesignalId = "$onesignalId",
+              /**
+               * The OneSignal user ID of the customer.
+               */
+              OnesignalUserId = "$onesignalUserId",
+              /**
+               * The Intercom contact ID of the customer.
+               */
+              IntercomContactId = "$intercomContactId",
+              /**
+               * The media source of the customer.
+               */
+              MediaSource = "$mediaSource",
+              /**
+               * The campaign of the customer.
+               */
+              Campaign = "$campaign",
+              /**
+               * The ad group of the customer.
+               */
+              AdGroup = "$adGroup",
+              /**
+               * The Ad ID of the customer.
+               */
+              AdId = "$ad",
+              /**
+               * The keyword of the customer.
+               */
+              Keyword = "$keyword",
+              /**
+               * The creative of the customer.
+               */
+              Creative = "$creative",
+              /**
+               * Apple push notification tokens for the customer.
+               */
+              APNSTokens = "$apnsTokens",
+              /**
+               * Google push notification tokens for the customer.
+               */
+              FCMTokens = "$fcmTokens",
+              /**
+               * The Airship channel ID of the customer.
+               */
+              AirshipChannelId = "$airshipChannelId",
+              /**
+               * The segment ID of the customer.
+               */
+              SegmentId = "$segmentId",
+              /**
+               * The Iterable user ID of the customer.
+               */
+              IterableUserId = "$iterableUserId",
+              /**
+               * The Iterable campaign ID of the customer.
+               */
+              IterableCampaignId = "$iterableCampaignId",
+              /**
+               * The Iterable template ID of the customer.
+               */
+              IterableTemplateId = "$iterableTemplateId",
+              /**
+               * The Firebase app instance ID of the customer.
+               */
+              FirebaseAppInstanceId = "$firebaseAppInstanceId",
+              /**
+               * The Mixpanel distinct ID of the customer.
+               */
+              MixpanelDistinctId = "$mixpanelDistinctId",
+              /**
+               * Apple App Tracking Transparency consent status for the customer.
+               */
+              ATTConsentStatus = "$attConsentStatus",
+              /**
+               * The unique Kochava device identifier of the customer.
+               */
+              KochavaDeviceId = "$kochavaDeviceId",
+              /**
+               * The device version of the customer.
+               */
+              DeviceVersion = "$deviceVersion",
+              /**
+               * The PostHog user ID of the customer.
+               */
+              PosthogUserId = "$posthogUserId",
+              /**
+               * The Telemetry Deck user ID of the customer.
+               */
+              TelemetryDeckUserId = "$telemetryDeckUserId",
+              /**
+               * The Telemetry Deck app ID of the customer.
+               */
+              TelemetryDeckAppId = "$telemetryDeckAppId",
+              /**
+               * The Apple refund handling preference of the customer.
+               */
+              AppleRefundHandlingPreference = "$appleRefundHandlingPreference",
+              /**
+               * The customer.io ID of the customer.
+               */
+              CustomerioId = "$customerioId",
+              /**
+               * The Tenjin ID of the customer.
+               */
+              TenjinId = "$tenjinId"
+          }
 
-         /**
-          * This object gives you access to the purchase redemption data when
-          * the purchase can be redeemed to a mobile user, like in the case of anonymous users.
-          * @public
-          */
-         export declare interface RedemptionInfo {
-             /**
-              * The redeem url.
-              */
-             readonly redeemUrl: string | null;
-         }
-
-         /**
-          * 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";
 
-         /**
-          * Subscription purchases of the Customer.
-          * @public
-          */
-         export declare interface SubscriptionInfo {
-             /**
-              * The product identifier.
-              */
-             readonly productIdentifier: string;
-             /**
-              * Date when the last subscription period started.
-              */
-             readonly purchaseDate: Date;
-             /**
-              * Date when this subscription first started. This property does not update with renewals.
-              * This property also does not update for product changes within a subscription group or
-              * re-subscriptions by lapsed subscribers.
-              */
-             readonly originalPurchaseDate: Date | null;
-             /**
-              * Date when the subscription expires/expired
-              */
-             readonly expiresDate: Date | null;
-             /**
-              * Store where the subscription was purchased.
-              */
-             readonly store: Store;
-             /**
-              * Date when RevenueCat detected that auto-renewal was turned off for this subscription.
-              * Note the subscription may still be active, check the {@link SubscriptionInfo.expiresDate} attribute.
-              */
-             readonly unsubscribeDetectedAt: Date | null;
-             /**
-              * Whether or not the purchase was made in sandbox mode.
-              */
-             readonly isSandbox: boolean;
-             /**
-              * Date when RevenueCat detected any billing issues with this subscription.
-              * If and when the billing issue gets resolved, this field is set to null.
-              * Note the subscription may still be active, check the {@link SubscriptionInfo.expiresDate} attribute.
-              */
-             readonly billingIssuesDetectedAt: Date | null;
-             /**
-              * Date when any grace period for this subscription expires/expired.
-              * null if the customer has never been in a grace period.
-              */
-             readonly gracePeriodExpiresDate: Date | null;
-             /**
-              * How the Customer received access to this subscription:
-              * - "PURCHASED": The customer bought the subscription.
-              * - "FAMILY_SHARED": The customer has access to the product via their family.
-              */
-             readonly ownershipType: OwnershipType;
-             /**
-              * Type of the current subscription period:
-              * - "normal": The product is in a normal period (default)
-              * - "trial": The product is in a free trial period
-              * - "intro": The product is in an introductory pricing period
-              * - "prepaid": The product is in a prepaid pricing period
-              */
-             readonly periodType: PeriodType;
-             /**
-              * Date when RevenueCat detected a refund of this subscription.
-              */
-             readonly refundedAt: Date | null;
-             /**
-              * The transaction id in the store of the subscription.
-              */
-             readonly storeTransactionId: string | null;
-             /**
-              * Whether the subscription is currently active
-              * (at the time this object was obtained).
-              */
-             readonly isActive: boolean;
-             /**
-              * Whether the subscription will renew at the next billing period.
-              */
-             readonly willRenew: boolean;
-         }
+          /**
+           * Subscription purchases of the Customer.
+           * @public
+           */
+          export declare interface SubscriptionInfo {
+              /**
+               * The product identifier.
+               */
+              readonly productIdentifier: string;
+              /**
+               * Date when the last subscription period started.
+               */
+              readonly purchaseDate: Date;
+              /**
+               * Date when this subscription first started. This property does not update with renewals.
+               * This property also does not update for product changes within a subscription group or
+               * re-subscriptions by lapsed subscribers.
+               */
+              readonly originalPurchaseDate: Date | null;
+              /**
+               * Date when the subscription expires/expired
+               */
+              readonly expiresDate: Date | null;
+              /**
+               * Store where the subscription was purchased.
+               */
+              readonly store: Store;
+              /**
+               * Date when RevenueCat detected that auto-renewal was turned off for this subscription.
+               * Note the subscription may still be active, check the {@link SubscriptionInfo.expiresDate} attribute.
+               */
+              readonly unsubscribeDetectedAt: Date | null;
+              /**
+               * Whether or not the purchase was made in sandbox mode.
+               */
+              readonly isSandbox: boolean;
+              /**
+               * Date when RevenueCat detected any billing issues with this subscription.
+               * If and when the billing issue gets resolved, this field is set to null.
+               * Note the subscription may still be active, check the {@link SubscriptionInfo.expiresDate} attribute.
+               */
+              readonly billingIssuesDetectedAt: Date | null;
+              /**
+               * Date when any grace period for this subscription expires/expired.
+               * null if the customer has never been in a grace period.
+               */
+              readonly gracePeriodExpiresDate: Date | null;
+              /**
+               * How the Customer received access to this subscription:
+               * - "PURCHASED": The customer bought the subscription.
+               * - "FAMILY_SHARED": The customer has access to the product via their family.
+               */
+              readonly ownershipType: OwnershipType;
+              /**
+               * Type of the current subscription period:
+               * - "normal": The product is in a normal period (default)
+               * - "trial": The product is in a free trial period
+               * - "intro": The product is in an introductory pricing period
+               * - "prepaid": The product is in a prepaid pricing period
+               */
+              readonly periodType: PeriodType;
+              /**
+               * Date when RevenueCat detected a refund of this subscription.
+               */
+              readonly refundedAt: Date | null;
+              /**
+               * The transaction id in the store of the subscription.
+               */
+              readonly storeTransactionId: string | null;
+              /**
+               * Whether the subscription is currently active
+               * (at the time this object was obtained).
+               */
+              readonly isActive: boolean;
+              /**
+               * Whether the subscription will renew at the next billing period.
+               */
+              readonly willRenew: boolean;
+          }
 
-         /**
-          * Represents a possible option to purchase a subscription product.
-          * @public
-          */
-         export declare interface SubscriptionOption extends PurchaseOption {
-             /**
-              * The base phase for a SubscriptionOption, represents
-              * the price that the customer will be charged after all the discounts have
-              * been consumed and the period at which it will renew.
-              */
-             readonly base: PricingPhase;
-             /**
-              * The trial information for this subscription option if available.
-              */
-             readonly trial: PricingPhase | null;
-         }
+          /**
+           * Represents a possible option to purchase a subscription product.
+           * @public
+           */
+          export declare interface SubscriptionOption extends PurchaseOption {
+              /**
+               * The base phase for a SubscriptionOption, represents
+               * the price that the customer will be charged after all the discounts have
+               * been consumed and the period at which it will renew.
+               */
+              readonly base: PricingPhase;
+              /**
+               * The trial information for this subscription option if available.
+               */
+              readonly trial: PricingPhase | null;
+          }
 
-         /**
-          * Contains information about the targeting context used to obtain an object.
-          * @public
-          */
-         export declare interface TargetingContext {
-             /**
-              * The rule id from the targeting used to obtain this object.
-              */
-             readonly ruleId: string;
-             /**
-              * The revision of the targeting used to obtain this object.
-              */
-             readonly revision: number;
-         }
+          /**
+           * Contains information about the targeting context used to obtain an object.
+           * @public
+           */
+          export declare interface TargetingContext {
+              /**
+               * The rule id from the targeting used to obtain this object.
+               */
+              readonly ruleId: string;
+              /**
+               * The revision of the targeting used to obtain this object.
+               */
+              readonly revision: number;
+          }
 
-         /**
-          * Error indicating that the SDK was accessed before it was initialized.
-          * @public
-          */
-         export declare class UninitializedPurchasesError extends Error {
-             constructor();
-         }
+          /**
+           * Error indicating that the SDK was accessed before it was initialized.
+           * @public
+           */
+          export declare class UninitializedPurchasesError extends Error {
+              constructor();
+          }
 
-         export { }
+          export { }