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

package/dist/index.d.mts

@@ -35,7 +35,8 @@ declare enum Platform {
     TEACHERS_WEB = "TEACHERS",
     DISTRICT_DASHBOARD = "DISTRICT",
     AUTH_WEB = "AUTH_WEB",
-    WEB_ADMIN = "WEB_ADMIN"
+    WEB_ADMIN = "WEB_ADMIN",
+    MOBILE = "MOBILE"
 }
 declare enum Environment {
     MARS = "MARS",
@@ -48,7 +49,7 @@ declare enum PlatformBuildTarget {
     VENUS = "pre-release",
     PROD = "production"
 }
-declare enum AppLocale {
+declare enum Locale {
     US = "en-SE",
     SE = "sv-SE",
     GB = "en-GB",
@@ -56,13 +57,6 @@ declare enum AppLocale {
     SCT = "en-SCT",
     DE = "de-DE"
 }
-declare enum ContentLocale {
-    US = "en-SE",
-    SE = "sv-SE",
-    GB = "en-GB",
-    CA = "en-CA",
-    DE = "de-DE"
-}
 declare enum Source {
     MATTEAPPEN = 0,
     SKOLON = 1,
@@ -105,6 +99,10 @@ declare enum SSO {
     CANVAS = "CANVAS",
     QR_CODE = "QR_CODE"
 }
+declare enum ApiRegion {
+    MAIN = "MAIN",
+    CANADA = "MAIN"
+}
 
 declare enum MatrixMode {
     SKILL = "SKILL",
@@ -139,6 +137,14 @@ type SSO_DE = {
     MICROSOFT_AUTH: string;
 };
 type SSOVariant = SSO_US | SSO_DE | SSO_UK | SSO_SE;
+type SSOByLocale = {
+    [Locale.US]: SSO_US;
+    [Locale.CA]: SSO_US;
+    [Locale.GB]: SSO_UK;
+    [Locale.SCT]: SSO_UK;
+    [Locale.SE]: SSO_SE;
+    [Locale.DE]: SSO_DE;
+};
 
 type Prettify<T> = T extends Function ? T : {
     [K in keyof T]: T[K];
@@ -155,6 +161,43 @@ type RegionSpecificVars = {
     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;
+    CLARITY_PROJECT_ID: string;
+    INTERCOM_APP_ID: string;
+};
+type AuthWebVarsPreset = {
+    [Locale.CA]: {
+        [key in Environment]: AuthWebVars<SSO_US>;
+    };
+    [Locale.DE]: {
+        [key in Environment]: AuthWebVars<SSO_DE>;
+    };
+    [Locale.GB]: {
+        [key in Environment]: AuthWebVars<SSO_UK>;
+    };
+    [Locale.SCT]: {
+        [key in Environment]: AuthWebVars<SSO_UK>;
+    };
+    [Locale.SE]: {
+        [key in Environment]: AuthWebVars<SSO_SE>;
+    };
+    [Locale.US]: {
+        [key in Environment]: AuthWebVars<SSO_US>;
+    };
+};
+
+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;
@@ -166,6 +209,13 @@ type StudentsWebCommon = {
     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;
@@ -175,11 +225,65 @@ type TeachersWebCommon = {
     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;
+    LOGGLY_CUSTOMER_TOKEN: string;
+    MYSCRIPT_HOST: string;
+    MYSCRIPT_APPLICATION_KEY: string;
+    MYSCRIPT_HMAC_KEY: string;
+    MYSCRIPT_SOCKET_KEY: string;
+    MYSCRIPT_REST_APP_KEY: string;
+    MYSCRIPT_REST_HMAC_KEY: string;
+};
+type MobileBaseVars = {
+    TEACHERS_WEB_URL: string;
+    API_URL: string;
+    CDN_HOST: string;
+    SOCKET_URL: string;
+    LOGGLY_TAG: string;
+} & MobileCommon;
+type MobileVars<T extends SSOVariant> = Prettify<MobileBaseVars & T>;
+type MobileVarsPreset = {
+    [Locale.CA]: {
+        [key in Environment]: MobileVars<SSO_US>;
+    };
+    [Locale.DE]: {
+        [key in Environment]: MobileVars<SSO_DE>;
+    };
+    [Locale.GB]: {
+        [key in Environment]: MobileVars<SSO_UK>;
+    };
+    [Locale.SCT]: {
+        [key in Environment]: MobileVars<SSO_UK>;
+    };
+    [Locale.SE]: {
+        [key in Environment]: MobileVars<SSO_SE>;
+    };
+    [Locale.US]: {
+        [key in Environment]: MobileVars<SSO_US>;
+    };
+};
+
 type RegionSpecificWebAdminVars = {
     API_URL: string;
     CDN_HOST: string;
@@ -191,68 +295,22 @@ type WebAdminCommon = {
     MARS_URL: string;
     PROD_URL: string;
 };
-type StudentsWebVars = RegionSpecificVars & StudentsWebCommon;
-type TeachersWebVars = RegionSpecificVars & TeachersWebCommon;
-type DistrictDashboardVars = Omit<RegionSpecificVars, 'SOCKET_URL'> & DistrictCommon;
 type WebAdminVars = RegionSpecificWebAdminVars & WebAdminCommon;
-type AuthWebBaseVars = Omit<RegionSpecificVars, 'CDN_HOST' | 'LOGGLY_TAG' | 'SOCKET_URL'> & {
-    TOS_URL: string;
-    CLARITY_PROJECT_ID: string;
-    INTERCOM_APP_ID: string;
-};
-type AuthWebVars<T extends SSOVariant> = Prettify<AuthWebBaseVars & T>;
-type EnvPreset = Readonly<{
-    [Platform.STUDENTS_WEB]: {
-        [key in AppLocale]: {
-            [key in Environment]: StudentsWebVars;
-        };
-    };
-    [Platform.TEACHERS_WEB]: {
-        [key in AppLocale]: {
-            [key in Environment]: TeachersWebVars;
-        };
+type WebAdminVarsPreset = {
+    [key in Locale]: {
+        [key in Environment]: WebAdminVars;
     };
-    [Platform.DISTRICT_DASHBOARD]: {
-        [key in AppLocale]: {
-            [key in Environment]: DistrictDashboardVars;
-        };
-    };
-    [Platform.AUTH_WEB]: {
-        [AppLocale.CA]: {
-            [key in Environment]: AuthWebVars<SSO_US>;
-        };
-        [AppLocale.DE]: {
-            [key in Environment]: AuthWebVars<SSO_DE>;
-        };
-        [AppLocale.GB]: {
-            [key in Environment]: AuthWebVars<SSO_UK>;
-        };
-        [AppLocale.SCT]: {
-            [key in Environment]: AuthWebVars<SSO_UK>;
-        };
-        [AppLocale.SE]: {
-            [key in Environment]: AuthWebVars<SSO_SE>;
-        };
-        [AppLocale.US]: {
-            [key in Environment]: AuthWebVars<SSO_US>;
-        };
-    };
-    [Platform.WEB_ADMIN]: {
-        [key in AppLocale]: {
-            [key in Environment]: WebAdminVars;
-        };
-    };
-}>;
-type EnvironmentVars<P extends Platform> = EnvPreset[P][AppLocale][Environment];
+};
 
-type SSOConfig<T extends SSOVariant> = Readonly<{
-    name: string;
-    icon: ComponentType<IconProps>;
-    type: SSO;
-    loginSource: LoginSource;
-    getUrl: (envs: AuthWebVars<T>) => string;
-    ownUrl?: boolean;
+type EnvPreset = Readonly<{
+    [Platform.STUDENTS_WEB]: StudentsWebVarsPreset;
+    [Platform.TEACHERS_WEB]: TeachersWebVarsPreset;
+    [Platform.DISTRICT_DASHBOARD]: DistrictWebVarsPreset;
+    [Platform.AUTH_WEB]: AuthWebVarsPreset;
+    [Platform.WEB_ADMIN]: WebAdminVarsPreset;
+    [Platform.MOBILE]: MobileVarsPreset;
 }>;
+type EnvironmentVars<P extends Platform> = EnvPreset[P][Locale][Environment];
 
 declare function buildTargetToEnvironment(buildTarget: PlatformBuildTarget): Environment;
 
@@ -264,7 +322,7 @@ type StudentsLocaleConfig = CommonLocaleConfig & {
         numberDecimalSeparator: string;
     };
     practiceMode: {
-        languageCode: AppLocale;
+        languageCode: Locale;
         defaultPracticeTreeId: string;
     };
     chatbot: {
@@ -387,89 +445,90 @@ type AuthWebLocaleConfig<T extends SSOVariant> = {
     isPrimaryRegion: boolean;
     regionGroup: string;
     navigatorLanguages: string[];
-    locale: AppLocale;
+    locale: Locale;
+};
+
+type WebAdminLocaleConfig = {
+    name: string;
+    icon: ComponentType<IconProps>;
+    locale: Locale;
+    isPrimaryRegion: boolean;
+    regionGroup: string;
+    apiRegion: ApiRegion;
 };
 
 type CommonLocaleConfig = Readonly<{
     name: string;
     languageName: string;
     languageHeader: string;
-    contentLocale: ContentLocale;
+    contentLocale: Locale;
     shortCode: string;
 }>;
 type LocalePreset = {
     [Platform.STUDENTS_WEB]: {
-        [key in AppLocale]: StudentsLocaleConfig;
+        [key in Locale]: StudentsLocaleConfig;
     };
     [Platform.TEACHERS_WEB]: {
-        [key in AppLocale]: TeachersLocaleConfig;
+        [key in Locale]: TeachersLocaleConfig;
     };
     [Platform.DISTRICT_DASHBOARD]: {
-        [key in AppLocale]: DistrictLocaleConfig;
+        [key in Locale]: DistrictLocaleConfig;
+    };
+    [Platform.AUTH_WEB]: {
+        [key in Locale]: AuthWebLocaleConfig<SSOByLocale[key]>;
     };
     [Platform.WEB_ADMIN]: {
-        [key in AppLocale]: {};
+        [key in Locale]: WebAdminLocaleConfig;
     };
-    [Platform.AUTH_WEB]: {
-        [AppLocale.CA]: AuthWebLocaleConfig<SSO_US>;
-        [AppLocale.DE]: AuthWebLocaleConfig<SSO_DE>;
-        [AppLocale.GB]: AuthWebLocaleConfig<SSO_UK>;
-        [AppLocale.SCT]: AuthWebLocaleConfig<SSO_UK>;
-        [AppLocale.SE]: AuthWebLocaleConfig<SSO_SE>;
-        [AppLocale.US]: AuthWebLocaleConfig<SSO_US>;
+    [Platform.MOBILE]: {
+        [key in Locale]: AuthWebLocaleConfig<SSOByLocale[key]>;
     };
 };
-type LocaleConfig<P extends Platform> = LocalePreset[P][AppLocale];
+type LocaleConfig<P extends Platform, L extends Locale> = LocalePreset[P][L];
 
 type DevOverrides<P extends Platform> = {
-    [K in AppLocale]?: Partial<EnvironmentVars<P>>;
+    [K in Locale]?: Partial<EnvironmentVars<P>>;
 };
 type ConfigOptions<P extends Platform> = {
     platform: P;
     environment: Environment;
     _DEV_OVERRIDES_?: DevOverrides<P>;
 };
-type SetProps = {
-    locale?: AppLocale;
-    envsRegion?: AppLocale;
+type SetProps<L extends Locale> = {
+    locale?: L;
+    envsRegion?: L;
     environment?: Environment;
 };
-declare class AppConfigManager<P extends Platform> {
+declare class AppConfigManager<P extends Platform, L extends Locale> {
     private readonly _DEV_OVERRIDES_?;
     private readonly platform;
     environment: Environment;
-    locale: AppLocale;
-    envsRegion: AppLocale;
+    locale: L;
+    envsRegion: L;
     private readonly setEnvs;
     private readonly setLocaleConfig;
     readonly $envs: effector.StoreWritable<EnvironmentVars<P>>;
-    readonly $localeConfig: effector.StoreWritable<LocaleConfig<P>>;
+    readonly $localeConfig: effector.StoreWritable<LocaleConfig<P, L>>;
     constructor(opts: ConfigOptions<P>);
     private readonly syncConfigsStores;
-    readonly set: (props: SetProps) => void;
+    readonly set: (props: SetProps<L>) => void;
     getEnvs: () => EnvironmentVars<P>;
-    getLocaleConfig: () => LocaleConfig<P> & {
-        locale: AppLocale;
+    getLocaleConfig: () => LocaleConfig<P, L> & {
+        locale: L;
     };
     readonly onEnvsChange: (cb: (cfg: EnvironmentVars<P>) => void) => effector.Subscription;
-    readonly onLocaleChange: (cb: (cfg: LocaleConfig<P>) => void) => effector.Subscription;
+    readonly onLocaleChange: (cb: (cfg: LocaleConfig<P, L>) => void) => effector.Subscription;
     readonly getPresets: () => {
         envPreset: Readonly<{
-            STUDENTS: { [key in AppLocale]: { [key_1 in Environment]: StudentsWebVars; }; };
-            TEACHERS: { [key in AppLocale]: { [key_1 in Environment]: TeachersWebVars; }; };
-            DISTRICT: { [key in AppLocale]: { [key_1 in Environment]: DistrictDashboardVars; }; };
-            AUTH_WEB: {
-                [AppLocale.CA]: { [key in Environment]: AuthWebVars<SSO_US>; };
-                [AppLocale.DE]: { [key in Environment]: AuthWebVars<SSO_DE>; };
-                [AppLocale.GB]: { [key in Environment]: AuthWebVars<SSO_UK>; };
-                [AppLocale.SCT]: { [key in Environment]: AuthWebVars<SSO_UK>; };
-                [AppLocale.SE]: { [key in Environment]: AuthWebVars<SSO_SE>; };
-                [AppLocale.US]: { [key in Environment]: AuthWebVars<SSO_US>; };
-            };
-            WEB_ADMIN: { [key in AppLocale]: { [key_1 in Environment]: WebAdminVars; }; };
+            STUDENTS: StudentsWebVarsPreset;
+            TEACHERS: TeachersWebVarsPreset;
+            DISTRICT: DistrictWebVarsPreset;
+            AUTH_WEB: AuthWebVarsPreset;
+            WEB_ADMIN: WebAdminVarsPreset;
+            MOBILE: MobileVarsPreset;
         }>;
         localePreset: LocalePreset;
     };
 }
 
-export { AppConfigManager, AppLocale, type AuthWebVars, ContentLocale, DateFormat, DateLocale, type DistrictCommon, type DistrictDashboardVars, type EnvPreset, Environment, type EnvironmentVars, LoginSource, MatrixMode, Platform, PlatformBuildTarget, type RegionSpecificVars, type RegionSpecificWebAdminVars, SSO, type SSOConfig, Source, type StudentsWebCommon, type StudentsWebVars, type TeachersWebCommon, type TeachersWebVars, type WebAdminCommon, type WebAdminVars, buildTargetToEnvironment };
+export { ApiRegion, AppConfigManager, DateFormat, DateLocale, type EnvPreset, Environment, type EnvironmentVars, Locale, LoginSource, MatrixMode, Platform, PlatformBuildTarget, SSO, type SSOConfig, Source, buildTargetToEnvironment };