@revenuecat/purchases-js 1.23.0 → 1.23.1

package/dist/Purchases.es.d.ts

@@ -56,6 +56,13 @@ export declare interface BrandingAppearance {
     show_product_description: boolean;
 }
 
+declare interface BuildVariablesPerPackageOptions {
+    selectedLocale?: string;
+    fallbackLocale?: string;
+    customTranslations?: CustomTranslations;
+    translator?: Translator;
+}
+
 /**
  * Type containing all information regarding the customer.
  * @public
@@ -139,6 +146,8 @@ declare type CustomTranslations = {
     };
 };
 
+declare type EmptyString = "";
+
 /**
  * This object gives you access to all the information about the status
  * of a user's entitlements.
@@ -350,6 +359,18 @@ export declare interface IdentifyResult {
     readonly wasCreated: boolean;
 }
 
+declare class LocaleTranslations {
+    readonly labels: Record<string, string>;
+    readonly localeKey: string;
+    constructor(labels: Record<string, string> | undefined, localeKey: string);
+    private replaceVariables;
+    translate(labelId: LocalizationKeys | EmptyString, variables?: TranslationVariables): string | undefined;
+    translatePeriod(amount: number, period: PeriodUnit, options?: TranslatePeriodOptions): string | undefined;
+    translatePeriodUnit(period: PeriodUnit, options?: TranslatePeriodOptions): string | undefined;
+    translatePeriodFrequency(amount: number, period: PeriodUnit, options?: TranslateFrequencyOptions): string | undefined;
+    translateDate(date: Date, options?: Intl.DateTimeFormatOptions): string | undefined;
+}
+
 declare enum LocalizationKeys {
     PeriodsWeek = "periods.week",
     PeriodsMonth = "periods.month",
@@ -1167,6 +1188,7 @@ export declare class Purchases {
      * @experimental
      * */
     static setPlatformInfo(platformInfo: PlatformInfo): void;
+    /* Excluded from this release type: buildVariablesPerPackage */
     /* Excluded from this release type: getPlatformInfo */
     /**
      * Get the singleton instance of Purchases. It's preferred to use the instance
@@ -1826,6 +1848,58 @@ export declare class Purchases {
                 properties?: EventProperties;
             }
 
+            declare interface TranslateFrequencyOptions {
+                useMultipleWords?: boolean;
+            }
+
+            declare interface TranslatePeriodOptions {
+                noWhitespace?: boolean;
+                short?: boolean;
+            }
+
+            /**
+             * Translation variables to be used in the translation.
+             * This class allows you to pass variables to the translate method.
+             * @public
+             * @example Given a label with id `periods.monthPlural` and value `{{amount}} months`. This example will replace the variable `{{amount}}` with the value `10`.
+             * ```typescript
+             * translator.translate('periods.monthPlural', { amount: 10 });
+             * // Output: 10 months
+             * ```
+             */
+            declare type TranslationVariables = Record<string, string | number | undefined | null>;
+
+            declare class Translator {
+                readonly selectedLocale: string;
+                readonly defaultLocale: string;
+                readonly locales: Record<string, LocaleTranslations>;
+                static fallback(): Translator;
+                constructor(customTranslations?: CustomTranslations, selectedLocale?: string, defaultLocale?: string);
+                override(customTranslations: CustomTranslations): void;
+                formatPrice(priceInMicros: number, currency: string): string;
+                /**
+                 * Returns the locale in a format that is compatible with other JS libraries.
+                 * This is particularly important for zh_Hans and zh_Hant that are instead
+                 * represented as zh-Hans and zh-Hant in Intl.DateTimeFormat.
+                 */
+                get bcp47Locale(): string;
+                /**
+                 * Returns the fallback locale in a format that is compatible with other JS
+                 * libraries.
+                 * This is particularly important for zh_Hans and zh_Hant that are instead
+                 * represented as zh-Hans and zh-Hant in Intl.DateTimeFormat.
+                 */
+                get fallbackBcp47Locale(): string;
+                private getLanguageCodeString;
+                private getLocaleInstance;
+                translate(key: LocalizationKeys | EmptyString, variables?: TranslationVariables): string;
+                formatCountry(countryCode: string): string;
+                translatePeriod(amount: number, period: PeriodUnit, options?: TranslatePeriodOptions): string | undefined;
+                translatePeriodUnit(period: PeriodUnit, options?: TranslatePeriodOptions): string | undefined;
+                translatePeriodFrequency(amount: number, period: PeriodUnit, options?: TranslateFrequencyOptions): string | undefined;
+                translateDate(date: Date, options?: Intl.DateTimeFormatOptions): string | undefined;
+            }
+
             /**
              * Error indicating that the SDK was accessed before it was initialized.
              * @public