@magmamath/frontend-config 1.1.1 → 1.1.2-rc.1

package/dist/index.d.mts

@@ -12,7 +12,9 @@ declare enum DateFormat {
     DAY_MONTH_US = "MMM DD",
     YEAR_MONTH_DAY = "YYYY-MM-DD",
     FULL_WITH_SECONDS = "DD MMM YYYY HH:mm:ss",
-    FULL_WITH_SECONDS_US = "DD MMM YYYY hh:mm:ss A"
+    FULL_WITH_SECONDS_US = "DD MMM YYYY hh:mm:ss A",
+    MONTH_DAY_TIME = "MMM D HH:mm",
+    MONTH_DAY_TIME_US = "MMM D hh:mm A"
 }
 declare const DateLocale: {
     readonly US: "en";
@@ -29,6 +31,11 @@ declare const DateLocale: {
     readonly 'de-DE': "de";
 };
 type DateLocale = (typeof DateLocale)[keyof typeof DateLocale];
+declare const MomentDateLocale: {
+    GB: string;
+    SE: string;
+    DE: string;
+};
 
 declare enum Platform {
     STUDENTS_WEB = "STUDENTS",
@@ -115,8 +122,248 @@ declare enum MatrixMode {
     STANDARD = "STANDARD"
 }
 
+declare enum Grade {
+    OTHER = -1,
+    ZERO = 0,
+    ONE = 1,
+    TWO = 2,
+    THREE = 3,
+    FOUR = 4,
+    FIVE = 5,
+    SIX = 6,
+    SEVEN = 7,
+    EIGHT = 8,
+    NINE = 9,
+    TEN = 10,
+    ELEVEN = 11,
+    TWELVE = 12,
+    THIRTEEN = 13,
+    ALGEBRA_1 = 21,
+    GEOMETRY = 22,
+    ALGEBRA_2 = 23,
+    INTEGRATED_MATH_I = 24,
+    INTEGRATED_MATH_II = 25,
+    INTEGRATED_MATH_III = 26,
+    PRECALCULUS = 27,
+    HS = "HS",
+    HSG = "HSG",
+    HSA = "HSA",
+    HSS = "HSS",
+    HSF = "HSF",
+    HSN = "HSN",
+    K = "K"
+}
+
+declare enum NumberDecimalSeparator {
+    DOT = ".",
+    COMMA = ","
+}
+declare enum NumberGroupingSeparator {
+    SPACE = "space",
+    COMMA = "comma",
+    DOT = "dot",
+    APOSTROPHE = "apostrophe"
+}
+
+declare enum TTSOverrideSymbol {
+    POWER = "power"
+}
+declare enum Language {
+    AFRIKAANS = "Afrikaans",
+    ALBANIAN = "Albanian",
+    AMHARIC = "Amharic",
+    ARABIC = "Arabic",
+    ARMENIAN = "Armenian",
+    ASSAMESE = "Assamese",
+    AYMARA = "Aymara",
+    AZERBAIJANI = "Azerbaijani",
+    BAMBARA = "Bambara",
+    BASQUE = "Basque",
+    BELARUSIAN = "Belarusian",
+    BENGALI = "Bengali",
+    BHOJPURI = "Bhojpuri",
+    BOSNIAN = "Bosnian",
+    BULGARIAN = "Bulgarian",
+    CATALAN = "Catalan",
+    CEBUANO = "Cebuano",
+    CHINESE_SIMPLIFIED = "Chinese (Simplified)",
+    CHINESE_TRADITIONAL = "Chinese (Traditional)",
+    CORSICAN = "Corsican",
+    CROATIAN = "Croatian",
+    CZECH = "Czech",
+    DANISH = "Danish",
+    DHIVEHI = "Dhivehi",
+    DOGRI = "Dogri",
+    DUTCH = "Dutch",
+    ENGLISH = "English",
+    BRITISH_ENGLISH = "British English",
+    ESPERANTO = "Esperanto",
+    ESTONIAN = "Estonian",
+    EWE = "Ewe",
+    FINNISH = "Finnish",
+    FRENCH = "French",
+    FRISIAN = "Frisian",
+    GALICIAN = "Galician",
+    GEORGIAN = "Georgian",
+    GERMAN = "German",
+    GREEK = "Greek",
+    GUARANI = "Guarani",
+    GUJARATI = "Gujarati",
+    HAITIAN_CREOLE = "Haitian Creole",
+    HAUSA = "Hausa",
+    HAWAIIAN = "Hawaiian",
+    HEBREW = "Hebrew",
+    HINDI = "Hindi",
+    HMONG = "Hmong",
+    HUNGARIAN = "Hungarian",
+    ICELANDIC = "Icelandic",
+    IGBO = "Igbo",
+    ILOCANO = "Ilocano",
+    INDONESIAN = "Indonesian",
+    IRISH = "Irish",
+    ITALIAN = "Italian",
+    JAPANESE = "Japanese",
+    JAVANESE = "Javanese",
+    KANNADA = "Kannada",
+    KAZAKH = "Kazakh",
+    KHMER = "Khmer",
+    KINYARWANDA = "Kinyarwanda",
+    KONKANI = "Konkani",
+    KOREAN = "Korean",
+    KRIO = "Krio",
+    KURDISH = "Kurdish",
+    KURDISH_SORANI = "Kurdish (Sorani)",
+    KYRGYZ = "Kyrgyz",
+    LAO = "Lao",
+    LATVIAN = "Latvian",
+    LINGALA = "Lingala",
+    LITHUANIAN = "Lithuanian",
+    LUGANDA = "Luganda",
+    LUXEMBOURGISH = "Luxembourgish",
+    MACEDONIAN = "Macedonian",
+    MAITHILI = "Maithili",
+    MALAGASY = "Malagasy",
+    MALAY = "Malay",
+    MALAYALAM = "Malayalam",
+    MALTESE = "Maltese",
+    MAORI = "Maori",
+    MARATHI = "Marathi",
+    MEITEILON_MANIPURI = "Meiteilon (Manipuri)",
+    MIZO = "Mizo",
+    MONGOLIAN = "Mongolian",
+    MYANMAR_BURMESE = "Myanmar (Burmese)",
+    NEPALI = "Nepali",
+    NORWEGIAN = "Norwegian",
+    NYANJA_CHICHEWA = "Nyanja (Chichewa)",
+    ODIA_ORIYA = "Odia (Oriya)",
+    OROMO = "Oromo",
+    PASHTO = "Pashto",
+    PERSIAN = "Persian (Farsi)",
+    POLISH = "Polish",
+    PORTUGUESE_PORTUGAL_BRAZIL = "Portuguese (Portugal, Brazil)",
+    PUNJABI = "Punjabi",
+    QUECHUA = "Quechua",
+    ROMANIAN = "Romanian",
+    RUSSIAN = "Russian",
+    SAMOAN = "Samoan",
+    SANSKRIT = "Sanskrit",
+    SCOTS_GAELIC = "Scots Gaelic",
+    SEPEDI = "Sepedi",
+    SERBIAN = "Serbian",
+    SESOTHO = "Sesotho",
+    SHONA = "Shona",
+    SINDHI = "Sindhi",
+    SINHALA_SINHALESE = "Sinhala (Sinhalese)",
+    SLOVAK = "Slovak",
+    SLOVENIAN = "Slovenian",
+    SOMALI = "Somali",
+    SPANISH = "Spanish",
+    SUNDANESE = "Sundanese",
+    SWAHILI = "Swahili",
+    SWEDISH = "Swedish",
+    TAGALOG_FILIPINO = "Tagalog (Filipino)",
+    TAJIK = "Tajik",
+    TAMIL = "Tamil",
+    TATAR = "Tatar",
+    TELUGU = "Telugu",
+    THAI = "Thai",
+    TIGRINYA = "Tigrinya",
+    TSONGA = "Tsonga",
+    TURKISH = "Turkish",
+    TURKMEN = "Turkmen",
+    TWI_AKAN = "Twi (Akan)",
+    UKRAINIAN = "Ukrainian",
+    URDU = "Urdu",
+    UYGHUR = "Uyghur",
+    UZBEK = "Uzbek",
+    VIETNAMESE = "Vietnamese",
+    WELSH = "Welsh",
+    XHOSA = "Xhosa",
+    YIDDISH = "Yiddish",
+    YORUBA = "Yoruba",
+    ZULU = "Zulu"
+}
+declare const LANGUAGES_CONFIG: Record<Language, LanguageConfig>;
+declare const PRIORITY_LANGUAGES: readonly [Language.SPANISH, Language.ARMENIAN, Language.FRENCH, Language.ARABIC, Language.RUSSIAN];
+declare const MOST_USED_LANGUAGES: Language[];
+declare const LANGUAGES_LIST: string[];
+
+type LanguageConfig = {
+    code: string;
+    baseName?: Language;
+    isMostUsed?: boolean;
+    voice?: {
+        code: string;
+        name: string;
+        preprocessing?: {
+            commaAsSpace?: boolean;
+            overrides?: Record<TTSOverrideSymbol, string>;
+        };
+    };
+};
+
+declare enum TreeLevel {
+    DOMAIN = 0,
+    STANDARD = 1,
+    SKILL = 2
+}
+
+declare enum WeekStart {
+    SUNDAY = 0,
+    MONDAY = 1
+}
+declare enum CalendarLocale {
+    EN = "en",
+    SE = "sv",
+    DE = "de"
+}
+type CalendarConfig = {
+    locale: CalendarLocale;
+    weekFirstDay: WeekStart;
+    monthNames: string[];
+    dayNames: string[];
+    dayNamesShort: string[];
+    monthNamesShort: string[];
+    today: string;
+};
+declare const EN_CALENDAR_CONFIG: CalendarConfig;
+declare const SE_CALENDAR_CONFIG: CalendarConfig;
+declare const DE_CALENDAR_CONFIG: CalendarConfig;
+
+type GradeData = {
+    name: string;
+    displayOnly?: boolean;
+    noPrefix?: boolean;
+    excludeFromPieChart?: boolean;
+};
+type CommonGrades = Grade.OTHER | Grade.ZERO | Grade.K;
+type PrimaryGrades = CommonGrades | Grade.ONE | Grade.TWO | Grade.THREE | Grade.FOUR | Grade.FIVE | Grade.SIX | Grade.SEVEN | Grade.EIGHT | Grade.NINE | Grade.TEN | Grade.ELEVEN | Grade.TWELVE | Grade.THIRTEEN;
+type HighSchoolGrades = Grade.NINE | Grade.TEN | Grade.ELEVEN | Grade.TWELVE | Grade.ALGEBRA_1 | Grade.GEOMETRY | Grade.ALGEBRA_2 | Grade.INTEGRATED_MATH_I | Grade.INTEGRATED_MATH_II | Grade.INTEGRATED_MATH_III | Grade.PRECALCULUS | Grade.HS | Grade.HSG | Grade.HSA | Grade.HSS | Grade.HSF | Grade.HSN;
+
 type IconProps = {
     size?: number;
+    color?: string;
+    extraColor?: string;
 };
 
 type SSOConfig<E> = Readonly<{
@@ -224,7 +471,7 @@ type Prettify<T> = T extends Function ? T : {
 };
 
 type AuthWebVars<T extends SSOVariant> = Prettify<AuthWebBaseVars & T>;
-type AuthWebBaseVars = Omit<RegionSpecificVars, 'CDN_HOST' | 'LOGGLY_TAG' | 'SOCKET_URL'> & {
+type AuthWebBaseVars = Omit<RegionSpecificVars, 'LOGGLY_TAG' | 'SOCKET_URL'> & {
     TOS_URL: string;
     CLARITY_PROJECT_ID: string;
     INTERCOM_APP_ID: string;
@@ -263,6 +510,8 @@ type MobileCommon = {
     GOOGLE_API_KEY: string;
     GOOGLE_TEXT_TO_SPEECH_URL: string;
     GOOGLE_TRANSLATE_URL: string;
+    SIGN_UP_BOOKING_ONBOARDING: string;
+    TOS_URL: string;
 };
 type MobileBaseVars = {
     TEACHERS_WEB_URL: string;
@@ -271,6 +520,7 @@ type MobileBaseVars = {
     CDN_HOST: string;
     SOCKET_URL: string;
     LOGGLY_TAG: string;
+    PROBLEM_CREATOR_URL: string;
 } & MobileCommon;
 type MobileVars<T extends SSOVariant> = Prettify<MobileBaseVars & T>;
 type MobileVarsPreset = {
@@ -324,118 +574,114 @@ type EnvironmentVars<P extends Platform> = EnvPreset[P][Locale][Environment];
 
 declare function buildTargetToEnvironment(buildTarget: PlatformBuildTarget): Environment;
 
+declare enum KeyboardPreset {
+    DOT_MIXED = "DotMixed",
+    DOT_MIXED_ALT = "DotMixedAlt",
+    COMMA_METRIC = "CommaMetric"
+}
+declare enum KeyboardCurrencyVariant {
+    DOLLAR_CENT = "DollarCent",
+    POUND_PENCE = "PoundPence",
+    KRONE_EURO_POUND = "KroneEuroPound",
+    EURO_DOLLAR_POUND = "EuroDollarPound"
+}
+declare enum KeyboardTimeVariant {
+    H12 = "H12",
+    H24 = "H24"
+}
+
+type KeyboardConfig = {
+    preset: KeyboardPreset;
+    currencyVariant: KeyboardCurrencyVariant;
+    timeVariant: KeyboardTimeVariant;
+};
+type LocaleLanguageData = LanguageConfig & {
+    name: Language;
+};
 type StudentsLocaleConfig = CommonLocaleConfig & {
-    textFormatting: {
-        replaceCommaWithSpace: boolean;
-    };
-    symbols: {
-        numberDecimalSeparator: string;
-    };
+    language: LocaleLanguageData;
     practiceMode: {
-        languageCode: Locale;
+        locale: Locale;
         defaultPracticeTreeId: string;
+        alwaysShowNavigationTab?: boolean;
     };
-    chatbot: {
-        languageName: string;
-        tts: {
-            languageCodeFallback: string;
-            voiceNameFallback: string;
-        };
-    };
-    tts: {
-        replaceCommaWithSpace: boolean;
-    };
-    translate: {
-        languageCodeFallback: string;
-    };
-    problem: {
-        choiceInputSelector: {
-            useSmallText: boolean;
-        };
-        choiceAnswerFeedback: {
-            useSlimLayout: boolean;
-        };
-        answer: {
-            shortButton: boolean;
-        };
+    keyboard: KeyboardConfig;
+    drawboard: {
+        basicManipulativesMaxGrade: number;
     };
     exampleSolutions: {
         languageName: string;
     };
-    statsTab: {
-        buttonWithMinWidth: boolean;
+    myScript: {
+        enableSolver: boolean;
     };
-    smartEval: {
-        language: string;
+    equationWriter: {
+        replaceBackslashWithQuote: boolean;
     };
 };
 
+declare enum ProblemCreatorKeyboardPreset {
+    DOT_MIXED = "DotMixed",
+    COMMA_METRIC = "CommaMetric"
+}
+declare enum ProblemCreatorMathEntryVariant {
+    DOLLAR = "Dollar",
+    KRONE = "Krone",
+    POUND_PENCE = "PoundPence",
+    EURO = "Euro"
+}
+declare enum ProblemCreatorDescriptionVariant {
+    EXTENDED_MULT_BASIC_ROOTS = "ExtendedMultBasicRoots",
+    DOT_EXTENDED_ROOTS = "DotExtendedRoots",
+    DOT_BASIC_ROOTS = "DotBasicRoots"
+}
+
+type ProblemCreatorKeyboardConfig = {
+    preset: ProblemCreatorKeyboardPreset;
+    mathEntryVariant: ProblemCreatorMathEntryVariant;
+    descriptionVariant: ProblemCreatorDescriptionVariant;
+};
+type ProblemCreatorConfig = {
+    useCommaForDecimal: boolean;
+    useDotForMultiplication: boolean;
+    savedProblemLocale: Locale;
+    keyboard: ProblemCreatorKeyboardConfig;
+};
+
 type TeachersLocaleConfig = CommonLocaleConfig & {
-    country: string;
     emails: {
         studentsList: string;
     };
-    symbols: {
-        decimalSeparator: string;
-    };
-    date: {
-        use24HourFormat: boolean;
-        locale: DateLocale;
-        formats: {
-            full: DateFormat;
-            dayMonth: DateFormat;
-            hoursMinutes: DateFormat;
-            fullWithSeconds: DateFormat;
-        };
-    };
     urls: {
         specialBook: string;
         helpCenter: string;
         about: string;
-    };
-    bookshelf: {
-        limitSharedExercisesTooltipWidth: boolean;
+        onboarding: string;
     };
     problemsList: {
         showProblemComplexity: boolean;
     };
     practiceMode: {
-        defaultTreeIdFallback: string;
+        defaultPracticeTreeId: string;
+        alwaysEnabled: boolean;
     };
     matrix: {
         forceShowRecommendations: boolean;
+        filterStandardsByGradeLevel: boolean;
         forceMatrixMode?: MatrixMode;
     };
     pieChart: {
         showExtraTreeDataContent: boolean;
     };
-    problem: {
-        allowCommaDecimal: boolean;
-    };
-    getStarted: {
-        showSentEmailInfo: boolean;
-    };
     firstLoginBooks: {
         isLargeGrade: ((grade: number) => boolean) | null;
+        mergeHighSchoolGrades: boolean;
+        withGradeZero: boolean;
     };
-    grades: {
-        showPrefix: boolean;
-        showOtherGrade: boolean;
-    };
-};
-
-type DistrictLocaleConfig = CommonLocaleConfig & {
-    date: {
-        use24HourFormat: boolean;
-        locale: DateLocale;
-        formats: {
-            full: DateFormat;
-            dayMonthYear: DateFormat;
-            dayMonth: DateFormat;
-            hoursMinutes: DateFormat;
-            fullWithSeconds: DateFormat;
-        };
+    gradesModal: {
+        withOtherOption: boolean;
     };
+    problemCreator: ProblemCreatorConfig;
 };
 
 type AuthLocaleConfig<E> = {
@@ -456,6 +702,9 @@ type AuthLocaleConfig<E> = {
     regionGroup: string;
     navigatorLanguages: string[];
     locale: Locale;
+    urls?: {
+        onboarding?: string;
+    };
 };
 
 type WebAdminLocaleConfig = {
@@ -467,12 +716,52 @@ type WebAdminLocaleConfig = {
     apiRegion: ApiRegion;
 };
 
+type DateConfig = Readonly<{
+    use24HourFormat: boolean;
+    locale: string;
+    momentLocale: string;
+    formats: {
+        dayMonth: string;
+        dayMonthYear: string;
+        monthDayTime: string;
+        hoursMinutes: string;
+        full: string;
+        fullWithSeconds: string;
+    };
+}>;
+
+type GradesConfig = Readonly<{
+    primary: Partial<Record<PrimaryGrades, GradeData>>;
+    highSchool: Partial<Record<HighSchoolGrades, GradeData>>;
+    treeGradeOffset?: number;
+}>;
+
+type MobileLocaleConfig<E> = StudentsLocaleConfig & TeachersLocaleConfig & AuthLocaleConfig<E> & {
+    localizeCountryCode: string;
+    calendar: CalendarConfig;
+};
+
+declare enum MultiplicationSymbol {
+    CDOT = "CDOT",
+    TIMES = "TIMES"
+}
+
 type CommonLocaleConfig = Readonly<{
     name: string;
     languageName: string;
+    country: string;
     languageHeader: string;
     contentLocale: Locale;
     shortCode: string;
+    date: DateConfig;
+    grades: GradesConfig;
+    numberFormatting: {
+        decimalSeparator: NumberDecimalSeparator;
+        groupingSeparator: NumberGroupingSeparator;
+    };
+    mathSymbols: {
+        multiplication: MultiplicationSymbol;
+    };
 }>;
 type LocalePreset = {
     [Platform.STUDENTS_WEB]: {
@@ -491,11 +780,18 @@ type LocalePreset = {
         [key in Locale]: WebAdminLocaleConfig;
     };
     [Platform.MOBILE]: {
-        [key in Locale]: AuthLocaleConfig<MobileVars<SSOByLocale[key]>>;
+        [key in Locale]: MobileLocaleConfig<MobileVars<SSOByLocale[key]>>;
     };
 };
 type LocaleConfig<P extends Platform, L extends Locale> = LocalePreset[P][L];
 
+type DistrictLocaleConfig = CommonLocaleConfig & {
+    tree: {
+        lowestLevel: TreeLevel;
+    };
+    problemCreator: ProblemCreatorConfig;
+};
+
 type DevOverrides<P extends Platform> = {
     [K in Locale]?: Partial<EnvironmentVars<P>>;
 };
@@ -519,6 +815,14 @@ declare class AppConfigManager<P extends Platform, L extends Locale> {
     private readonly setLocaleConfig;
     readonly $envs: effector.StoreWritable<EnvironmentVars<P>>;
     readonly $localeConfig: effector.StoreWritable<LocaleConfig<P, L>>;
+    readonly $localeFlags: effector.Store<{
+        isUS: boolean;
+        isSwedish: boolean;
+        isBritish: boolean;
+        isCanadian: boolean;
+        isScottish: boolean;
+        isGerman: boolean;
+    }>;
     constructor(opts: ConfigOptions<P>);
     private readonly syncConfigsStores;
     readonly set: (props: SetProps<L>) => void;
@@ -526,6 +830,14 @@ declare class AppConfigManager<P extends Platform, L extends Locale> {
     getLocaleConfig: () => LocaleConfig<P, L> & {
         locale: L;
     };
+    getLocaleFlags: () => {
+        isUS: boolean;
+        isSwedish: boolean;
+        isBritish: boolean;
+        isCanadian: boolean;
+        isScottish: boolean;
+        isGerman: boolean;
+    };
     readonly onEnvsChange: (cb: (cfg: EnvironmentVars<P>) => void) => effector.Subscription;
     readonly onLocaleChange: (cb: (cfg: LocaleConfig<P, L>) => void) => effector.Subscription;
     readonly getPresets: () => {
@@ -534,4 +846,4 @@ declare class AppConfigManager<P extends Platform, L extends Locale> {
     };
 }
 
-export { ApiRegion, AppConfigManager, type AuthWebBaseVars, type AuthWebVars, type AuthWebVarsPreset, DateFormat, DateLocale, type DistrictCommon, type DistrictDashboardVars, type DistrictWebVarsPreset, type EnvPreset, Environment, type EnvironmentVars, Locale, LoginSource, MatrixMode, type MobileBaseVars, type MobileCommon, type MobileVars, type MobileVarsPreset, Platform, PlatformBuildTarget, QRCodeSize, SSO, type SSOByLocale, type SSOConfig, type SSOVariant, type SSO_DE, type SSO_SE, type SSO_UK, type SSO_US, Source, type StudentsWebCommon, type StudentsWebVars, type StudentsWebVarsPreset, type TeachersWebCommon, type TeachersWebVars, type TeachersWebVarsPreset, buildTargetToEnvironment };
+export { ApiRegion, AppConfigManager, type AuthWebBaseVars, type AuthWebVars, type AuthWebVarsPreset, type CalendarConfig, CalendarLocale, type CommonGrades, DE_CALENDAR_CONFIG, DateFormat, DateLocale, type DistrictCommon, type DistrictDashboardVars, type DistrictLocaleConfig, type DistrictWebVarsPreset, EN_CALENDAR_CONFIG, type EnvPreset, Environment, type EnvironmentVars, Grade, type GradeData, type HighSchoolGrades, type KeyboardConfig, KeyboardCurrencyVariant, KeyboardPreset, KeyboardTimeVariant, LANGUAGES_CONFIG, LANGUAGES_LIST, Language, type LanguageConfig, Locale, type LocaleLanguageData, LoginSource, MOST_USED_LANGUAGES, MatrixMode, type MobileBaseVars, type MobileCommon, type MobileLocaleConfig, type MobileVars, type MobileVarsPreset, MomentDateLocale, MultiplicationSymbol, NumberDecimalSeparator, NumberGroupingSeparator, PRIORITY_LANGUAGES, Platform, PlatformBuildTarget, type PrimaryGrades, type ProblemCreatorConfig, ProblemCreatorDescriptionVariant, type ProblemCreatorKeyboardConfig, ProblemCreatorKeyboardPreset, ProblemCreatorMathEntryVariant, QRCodeSize, SE_CALENDAR_CONFIG, SSO, type SSOByLocale, type SSOConfig, type SSOVariant, type SSO_DE, type SSO_SE, type SSO_UK, type SSO_US, Source, type StudentsLocaleConfig, type StudentsWebCommon, type StudentsWebVars, type StudentsWebVarsPreset, TTSOverrideSymbol, type TeachersLocaleConfig, type TeachersWebCommon, type TeachersWebVars, type TeachersWebVarsPreset, TreeLevel, buildTargetToEnvironment };