@magmamath/frontend-config 1.0.23 → 1.0.24-rc.10

package/dist/index.d.mts

@@ -88,7 +88,6 @@ declare enum LoginSource {
     MY_LOGIN = 9
 }
 declare enum SSO {
-    APPLE = "APPLE",
     GOOGLE = "GOOGLE",
     MICROSOFT = "MICROSOFT",
     CLEVER = "CLEVER",
@@ -104,86 +103,57 @@ declare enum ApiRegion {
     MAIN = "MAIN",
     CANADA = "CANADA"
 }
-declare enum QRCodeSize {
-    DEFAULT = "default",
-    MEDIUM = "medium",
-    LARGE = "large"
-}
 
 declare enum MatrixMode {
     SKILL = "SKILL",
     STANDARD = "STANDARD"
 }
 
-type IconProps = {
-    size?: number;
-};
+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",
+    ALL = "all",
+    K = "K"
+}
 
-type SSOConfig<E> = Readonly<{
+type GradeData = {
     name: string;
-    icon: ComponentType<IconProps>;
-    type: SSO;
-    loginSource: LoginSource;
-    ownUrl?: boolean;
-    getUrl: (envs: E) => string;
-}>;
-
-type RegionSpecificVars = {
-    API_URL: string;
-    AUTH_WEB_URL: string;
-    CDN_HOST: string;
-    DISTRICT_WEB_URL: string;
-    LOGGLY_TAG: string;
-    MAGMAMATH_URL: string;
-    SOCKET_URL: string;
-    STUDENTS_WEB_URL: string;
-    TEACHERS_WEB_URL: string;
+    displayOnly?: boolean;
+    noPrefix?: boolean;
 };
+type CommonGrades = Grade.ALL | 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.ALGEBRA_1 | Grade.GEOMETRY | Grade.ALGEBRA_2 | Grade.INTEGRATED_MATH_I | Grade.INTEGRATED_MATH_II | Grade.INTEGRATED_MATH_III | Grade.PRECALCULUS;
+type TreeNodeGrades = Grade.HS | Grade.HSG | Grade.HSA | Grade.HSS | Grade.HSF | Grade.HSN;
 
-type StudentsWebCommon = {
-    GOOGLE_API_KEY: string;
-    DESMOS_API_KEY: string;
-    LOGGLY_CUSTOMER_TOKEN: string;
-    MYSCRIPT_APPLICATION_KEY: string;
-    MYSCRIPT_HMAC_KEY: string;
-    MYSCRIPT_HOST: string;
-    MYSCRIPT_SOCKET_KEY: string;
-    MYSCRIPT_REST_APP_KEY: string;
-    MYSCRIPT_REST_HMAC_KEY: string;
-};
-type StudentsWebVars = RegionSpecificVars & StudentsWebCommon;
-type StudentsWebVarsPreset = {
-    [key in Locale]: {
-        [key in Environment]: StudentsWebVars;
-    };
-};
-
-type TeachersWebCommon = {
-    MYSCRIPT_HOST: string;
-    MYSCRIPT_REST_APP_KEY: string;
-    MYSCRIPT_REST_HMAC_KEY: string;
-    PROBLEM_IMAGE_SIZE_LIMIT: number;
-    INTERCOM_APP_ID: string;
-    CLARITY_PROJECT_ID: string;
-    LOGGLY_CUSTOMER_TOKEN: string;
-};
-type TeachersWebVars = RegionSpecificVars & TeachersWebCommon;
-type TeachersWebVarsPreset = {
-    [key in Locale]: {
-        [key in Environment]: TeachersWebVars;
-    };
-};
-
-type DistrictCommon = {
-    INTERCOM_APP_ID: string;
-    CLARITY_PROJECT_ID: string;
-    PROBLEM_IMAGE_SIZE_LIMIT: number;
-};
-type DistrictDashboardVars = Omit<RegionSpecificVars, 'SOCKET_URL'> & DistrictCommon;
-type DistrictWebVarsPreset = {
-    [key in Locale]: {
-        [key in Environment]: DistrictDashboardVars;
-    };
+type IconProps = {
+    size?: number;
 };
 
 type SSO_UK = {
@@ -223,6 +193,18 @@ type Prettify<T> = T extends Function ? T : {
     [K in keyof T]: T[K];
 };
 
+type RegionSpecificVars = {
+    API_URL: string;
+    AUTH_WEB_URL: string;
+    CDN_HOST: string;
+    DISTRICT_WEB_URL: string;
+    LOGGLY_TAG: string;
+    MAGMAMATH_URL: string;
+    SOCKET_URL: string;
+    STUDENTS_WEB_URL: string;
+    TEACHERS_WEB_URL: string;
+};
+
 type AuthWebVars<T extends SSOVariant> = Prettify<AuthWebBaseVars & T>;
 type AuthWebBaseVars = Omit<RegionSpecificVars, 'CDN_HOST' | 'LOGGLY_TAG' | 'SOCKET_URL'> & {
     TOS_URL: string;
@@ -250,6 +232,61 @@ type AuthWebVarsPreset = {
     };
 };
 
+type SSOConfig<T extends SSOVariant> = Readonly<{
+    name: string;
+    icon: ComponentType<IconProps>;
+    type: SSO;
+    loginSource: LoginSource;
+    getUrl: (envs: AuthWebVars<T>) => string;
+    ownUrl?: boolean;
+}>;
+
+type StudentsWebCommon = {
+    GOOGLE_API_KEY: string;
+    DESMOS_API_KEY: string;
+    LOGGLY_CUSTOMER_TOKEN: string;
+    MYSCRIPT_APPLICATION_KEY: string;
+    MYSCRIPT_HMAC_KEY: string;
+    MYSCRIPT_HOST: string;
+    MYSCRIPT_SOCKET_KEY: string;
+    MYSCRIPT_REST_APP_KEY: string;
+    MYSCRIPT_REST_HMAC_KEY: string;
+};
+type StudentsWebVars = RegionSpecificVars & StudentsWebCommon;
+type StudentsWebVarsPreset = {
+    [key in Locale]: {
+        [key in Environment]: StudentsWebVars;
+    };
+};
+
+type TeachersWebCommon = {
+    MYSCRIPT_HOST: string;
+    MYSCRIPT_REST_APP_KEY: string;
+    MYSCRIPT_REST_HMAC_KEY: string;
+    PROBLEM_IMAGE_SIZE_LIMIT: number;
+    INTERCOM_APP_ID: string;
+    CLARITY_PROJECT_ID: string;
+    LOGGLY_CUSTOMER_TOKEN: string;
+};
+type TeachersWebVars = RegionSpecificVars & TeachersWebCommon;
+type TeachersWebVarsPreset = {
+    [key in Locale]: {
+        [key in Environment]: TeachersWebVars;
+    };
+};
+
+type DistrictCommon = {
+    INTERCOM_APP_ID: string;
+    CLARITY_PROJECT_ID: string;
+    PROBLEM_IMAGE_SIZE_LIMIT: number;
+};
+type DistrictDashboardVars = Omit<RegionSpecificVars, 'SOCKET_URL'> & DistrictCommon;
+type DistrictWebVarsPreset = {
+    [key in Locale]: {
+        [key in Environment]: DistrictDashboardVars;
+    };
+};
+
 type MobileCommon = {
     DESMOS_API_KEY: string;
     USER_AGENT: string;
@@ -260,13 +297,9 @@ type MobileCommon = {
     MYSCRIPT_SOCKET_KEY: string;
     MYSCRIPT_REST_APP_KEY: string;
     MYSCRIPT_REST_HMAC_KEY: string;
-    GOOGLE_API_KEY: string;
-    GOOGLE_TEXT_TO_SPEECH_URL: string;
-    GOOGLE_TRANSLATE_URL: string;
 };
 type MobileBaseVars = {
     TEACHERS_WEB_URL: string;
-    AUTH_WEB_URL: string;
     API_URL: string;
     CDN_HOST: string;
     SOCKET_URL: string;
@@ -371,22 +404,11 @@ type StudentsLocaleConfig = CommonLocaleConfig & {
 };
 
 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;
-        };
+    emails: {
+        studentsList: string;
     };
     urls: {
         specialBook: string;
@@ -417,39 +439,22 @@ type TeachersLocaleConfig = CommonLocaleConfig & {
     };
     firstLoginBooks: {
         isLargeGrade: ((grade: number) => boolean) | null;
-    };
-    grades: {
-        showPrefix: boolean;
-        showOtherGrade: boolean;
-    };
-};
-
-type DistrictLocaleConfig = CommonLocaleConfig & {
-    date: {
-        use24HourFormat: boolean;
-        locale: DateLocale;
-        formats: {
-            full: DateFormat;
-            dayMonthYear: DateFormat;
-            dayMonth: DateFormat;
-            hoursMinutes: DateFormat;
-            fullWithSeconds: DateFormat;
-        };
+        useHighSchoolGrades: boolean;
     };
 };
 
-type AuthLocaleConfig<E> = {
+type AuthWebLocaleConfig<T extends SSOVariant> = {
     path: string;
     shortCode: string;
     icon: ComponentType<IconProps>;
     sources: {
         signUp: {
-            list: SSOConfig<E>[];
+            list: SSOConfig<T>[];
         };
         signIn: {
             withOnboarding: boolean;
-            qrCodeSize: QRCodeSize;
-            list: SSOConfig<E>[];
+            largeQRCode: boolean;
+            list: SSOConfig<T>[];
         };
     };
     isPrimaryRegion: boolean;
@@ -470,9 +475,26 @@ type WebAdminLocaleConfig = {
 type CommonLocaleConfig = Readonly<{
     name: string;
     languageName: string;
+    country: string;
     languageHeader: string;
     contentLocale: Locale;
     shortCode: string;
+    date: {
+        use24HourFormat: boolean;
+        locale: string;
+        formats: {
+            dayMonth: string;
+            dayMonthYear: string;
+            hoursMinutes: string;
+            full: string;
+            fullWithSeconds: string;
+        };
+    };
+    grades: {
+        primary: Partial<Record<PrimaryGrades, GradeData>>;
+        highSchool: Partial<Record<HighSchoolGrades, GradeData>>;
+        treeNode: Partial<Record<TreeNodeGrades, GradeData>>;
+    };
 }>;
 type LocalePreset = {
     [Platform.STUDENTS_WEB]: {
@@ -485,17 +507,19 @@ type LocalePreset = {
         [key in Locale]: DistrictLocaleConfig;
     };
     [Platform.AUTH_WEB]: {
-        [key in Locale]: AuthLocaleConfig<AuthWebVars<SSOByLocale[key]>>;
+        [key in Locale]: AuthWebLocaleConfig<SSOByLocale[key]>;
     };
     [Platform.WEB_ADMIN]: {
         [key in Locale]: WebAdminLocaleConfig;
     };
     [Platform.MOBILE]: {
-        [key in Locale]: AuthLocaleConfig<MobileVars<SSOByLocale[key]>>;
+        [key in Locale]: AuthWebLocaleConfig<SSOByLocale[key]>;
     };
 };
 type LocaleConfig<P extends Platform, L extends Locale> = LocalePreset[P][L];
 
+type DistrictLocaleConfig = CommonLocaleConfig;
+
 type DevOverrides<P extends Platform> = {
     [K in Locale]?: Partial<EnvironmentVars<P>>;
 };
@@ -529,9 +553,16 @@ declare class AppConfigManager<P extends Platform, L extends Locale> {
     readonly onEnvsChange: (cb: (cfg: EnvironmentVars<P>) => void) => effector.Subscription;
     readonly onLocaleChange: (cb: (cfg: LocaleConfig<P, L>) => void) => effector.Subscription;
     readonly getPresets: () => {
-        envPreset: any;
+        envPreset: Readonly<{
+            STUDENTS: StudentsWebVarsPreset;
+            TEACHERS: TeachersWebVarsPreset;
+            DISTRICT: DistrictWebVarsPreset;
+            AUTH_WEB: AuthWebVarsPreset;
+            WEB_ADMIN: WebAdminVarsPreset;
+            MOBILE: MobileVarsPreset;
+        }>;
         localePreset: LocalePreset;
     };
 }
 
-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 CommonGrades, DateFormat, DateLocale, type DistrictCommon, type DistrictDashboardVars, type DistrictLocaleConfig, type DistrictWebVarsPreset, type EnvPreset, Environment, type EnvironmentVars, Grade, type GradeData, type HighSchoolGrades, Locale, LoginSource, MatrixMode, type MobileBaseVars, type MobileCommon, type MobileVars, type MobileVarsPreset, Platform, PlatformBuildTarget, type PrimaryGrades, 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 TeachersLocaleConfig, type TeachersWebCommon, type TeachersWebVars, type TeachersWebVarsPreset, type TreeNodeGrades, buildTargetToEnvironment };