@magmamath/frontend-config 1.0.24-rc.2 → 1.0.24-rc.20

package/dist/index.d.mts

@@ -109,6 +109,47 @@ 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"
+}
+
+type GradeData = {
+    name: string;
+    displayOnly?: boolean;
+    noPrefix?: 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.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;
 };
@@ -361,22 +402,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;
@@ -407,24 +437,17 @@ type TeachersLocaleConfig = CommonLocaleConfig & {
     };
     firstLoginBooks: {
         isLargeGrade: ((grade: number) => boolean) | null;
+        useHighSchoolGrades: boolean;
+        withGradeZero: boolean;
     };
-    grades: {
-        showPrefix: boolean;
-        showOtherGrade: boolean;
+    progressStats: {
+        forceHSGrades: boolean;
     };
-};
-
-type DistrictLocaleConfig = CommonLocaleConfig & {
-    date: {
-        use24HourFormat: boolean;
-        locale: DateLocale;
-        formats: {
-            full: DateFormat;
-            dayMonthYear: DateFormat;
-            dayMonth: DateFormat;
-            hoursMinutes: DateFormat;
-            fullWithSeconds: DateFormat;
-        };
+    heatMap: {
+        forceHSGrades: boolean;
+    };
+    classesFilter: {
+        forceHSGrades: boolean;
     };
 };
 
@@ -460,9 +483,25 @@ 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>>;
+    };
 }>;
 type LocalePreset = {
     [Platform.STUDENTS_WEB]: {
@@ -486,6 +525,8 @@ type LocalePreset = {
 };
 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>>;
 };
@@ -531,4 +572,4 @@ declare class AppConfigManager<P extends Platform, L extends Locale> {
     };
 }
 
-export { ApiRegion, AppConfigManager, DateFormat, DateLocale, type EnvPreset, Environment, type EnvironmentVars, Locale, LoginSource, MatrixMode, Platform, PlatformBuildTarget, SSO, type SSOConfig, Source, 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, buildTargetToEnvironment };

package/dist/index.d.ts

@@ -109,6 +109,47 @@ 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"
+}
+
+type GradeData = {
+    name: string;
+    displayOnly?: boolean;
+    noPrefix?: 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.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;
 };
@@ -361,22 +402,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;
@@ -407,24 +437,17 @@ type TeachersLocaleConfig = CommonLocaleConfig & {
     };
     firstLoginBooks: {
         isLargeGrade: ((grade: number) => boolean) | null;
+        useHighSchoolGrades: boolean;
+        withGradeZero: boolean;
     };
-    grades: {
-        showPrefix: boolean;
-        showOtherGrade: boolean;
+    progressStats: {
+        forceHSGrades: boolean;
     };
-};
-
-type DistrictLocaleConfig = CommonLocaleConfig & {
-    date: {
-        use24HourFormat: boolean;
-        locale: DateLocale;
-        formats: {
-            full: DateFormat;
-            dayMonthYear: DateFormat;
-            dayMonth: DateFormat;
-            hoursMinutes: DateFormat;
-            fullWithSeconds: DateFormat;
-        };
+    heatMap: {
+        forceHSGrades: boolean;
+    };
+    classesFilter: {
+        forceHSGrades: boolean;
     };
 };
 
@@ -460,9 +483,25 @@ 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>>;
+    };
 }>;
 type LocalePreset = {
     [Platform.STUDENTS_WEB]: {
@@ -486,6 +525,8 @@ type LocalePreset = {
 };
 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>>;
 };
@@ -531,4 +572,4 @@ declare class AppConfigManager<P extends Platform, L extends Locale> {
     };
 }
 
-export { ApiRegion, AppConfigManager, DateFormat, DateLocale, type EnvPreset, Environment, type EnvironmentVars, Locale, LoginSource, MatrixMode, Platform, PlatformBuildTarget, SSO, type SSOConfig, Source, 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, buildTargetToEnvironment };