@magmamath/frontend-config 1.0.16-rc.21 → 1.0.16-rc.3

package/dist/index.d.mts

@@ -35,8 +35,7 @@ declare enum Platform {
     TEACHERS_WEB = "TEACHERS",
     DISTRICT_DASHBOARD = "DISTRICT",
     AUTH_WEB = "AUTH_WEB",
-    WEB_ADMIN = "WEB_ADMIN",
-    MOBILE = "MOBILE"
+    WEB_ADMIN = "WEB_ADMIN"
 }
 declare enum Environment {
     MARS = "MARS",
@@ -99,10 +98,6 @@ declare enum SSO {
     CANVAS = "CANVAS",
     QR_CODE = "QR_CODE"
 }
-declare enum ApiRegion {
-    MAIN = "MAIN",
-    CANADA = "CANADA"
-}
 
 declare enum MatrixMode {
     SKILL = "SKILL",
@@ -137,14 +132,6 @@ 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];
@@ -161,43 +148,6 @@ 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;
@@ -209,13 +159,6 @@ 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;
@@ -225,65 +168,11 @@ 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;
@@ -295,23 +184,69 @@ 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 WebAdminVarsPreset = {
-    [key in Locale]: {
-        [key in Environment]: WebAdminVars;
-    };
+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]: StudentsWebVarsPreset;
-    [Platform.TEACHERS_WEB]: TeachersWebVarsPreset;
-    [Platform.DISTRICT_DASHBOARD]: DistrictWebVarsPreset;
-    [Platform.AUTH_WEB]: AuthWebVarsPreset;
-    [Platform.WEB_ADMIN]: WebAdminVarsPreset;
-    [Platform.MOBILE]: MobileVarsPreset;
+    [Platform.STUDENTS_WEB]: {
+        [key in Locale]: {
+            [key in Environment]: StudentsWebVars;
+        };
+    };
+    [Platform.TEACHERS_WEB]: {
+        [key in Locale]: {
+            [key in Environment]: TeachersWebVars;
+        };
+    };
+    [Platform.DISTRICT_DASHBOARD]: {
+        [key in Locale]: {
+            [key in Environment]: DistrictDashboardVars;
+        };
+    };
+    [Platform.AUTH_WEB]: {
+        [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>;
+        };
+    };
+    [Platform.WEB_ADMIN]: {
+        [key in Locale]: {
+            [key in Environment]: WebAdminVars;
+        };
+    };
 }>;
 type EnvironmentVars<P extends Platform> = EnvPreset[P][Locale][Environment];
 
+type SSOConfig<T extends SSOVariant> = Readonly<{
+    name: string;
+    icon: ComponentType<IconProps>;
+    type: SSO;
+    loginSource: LoginSource;
+    getUrl: (envs: AuthWebVars<T>) => string;
+    ownUrl?: boolean;
+}>;
+
 declare function buildTargetToEnvironment(buildTarget: PlatformBuildTarget): Environment;
 
 type StudentsLocaleConfig = CommonLocaleConfig & {
@@ -428,33 +363,12 @@ type DistrictLocaleConfig = CommonLocaleConfig & {
     };
 };
 
-type AuthWebLocaleConfig<T extends SSOVariant> = {
-    path: string;
-    shortCode: string;
-    icon: ComponentType<IconProps>;
-    sources: {
-        signUp: {
-            list: SSOConfig<T>[];
-        };
-        signIn: {
-            withOnboarding: boolean;
-            largeQRCode: boolean;
-            list: SSOConfig<T>[];
-        };
-    };
-    isPrimaryRegion: boolean;
-    regionGroup: string;
-    navigatorLanguages: string[];
-    locale: Locale;
-};
-
 type WebAdminLocaleConfig = {
     name: string;
     icon: ComponentType<IconProps>;
     locale: Locale;
     isPrimaryRegion: boolean;
     regionGroup: string;
-    apiRegion: ApiRegion;
 };
 
 type CommonLocaleConfig = Readonly<{
@@ -474,17 +388,14 @@ type LocalePreset = {
     [Platform.DISTRICT_DASHBOARD]: {
         [key in Locale]: DistrictLocaleConfig;
     };
-    [Platform.AUTH_WEB]: {
-        [key in Locale]: AuthWebLocaleConfig<SSOByLocale[key]>;
-    };
     [Platform.WEB_ADMIN]: {
         [key in Locale]: WebAdminLocaleConfig;
     };
-    [Platform.MOBILE]: {
-        [key in Locale]: AuthWebLocaleConfig<SSOByLocale[key]>;
+    [Platform.AUTH_WEB]: {
+        [key in Locale]: AuthWebVars<SSOVariant>;
     };
 };
-type LocaleConfig<P extends Platform, L extends Locale> = LocalePreset[P][L];
+type LocaleConfig<P extends Platform> = LocalePreset[P][Locale];
 
 type DevOverrides<P extends Platform> = {
     [K in Locale]?: Partial<EnvironmentVars<P>>;
@@ -494,41 +405,47 @@ type ConfigOptions<P extends Platform> = {
     environment: Environment;
     _DEV_OVERRIDES_?: DevOverrides<P>;
 };
-type SetProps<L extends Locale> = {
-    locale?: L;
-    envsRegion?: L;
+type SetProps = {
+    locale?: Locale;
+    envsRegion?: Locale;
     environment?: Environment;
 };
-declare class AppConfigManager<P extends Platform, L extends Locale> {
+declare class AppConfigManager<P extends Platform> {
     private readonly _DEV_OVERRIDES_?;
     private readonly platform;
     environment: Environment;
-    locale: L;
-    envsRegion: L;
+    locale: Locale;
+    envsRegion: Locale;
     private readonly setEnvs;
     private readonly setLocaleConfig;
     readonly $envs: effector.StoreWritable<EnvironmentVars<P>>;
-    readonly $localeConfig: effector.StoreWritable<LocaleConfig<P, L>>;
+    readonly $localeConfig: effector.StoreWritable<LocaleConfig<P>>;
     constructor(opts: ConfigOptions<P>);
     private readonly syncConfigsStores;
-    readonly set: (props: SetProps<L>) => void;
+    readonly set: (props: SetProps) => void;
     getEnvs: () => EnvironmentVars<P>;
-    getLocaleConfig: () => LocaleConfig<P, L> & {
-        locale: L;
+    getLocaleConfig: () => LocaleConfig<P> & {
+        locale: Locale;
     };
     readonly onEnvsChange: (cb: (cfg: EnvironmentVars<P>) => void) => effector.Subscription;
-    readonly onLocaleChange: (cb: (cfg: LocaleConfig<P, L>) => void) => effector.Subscription;
+    readonly onLocaleChange: (cb: (cfg: LocaleConfig<P>) => void) => effector.Subscription;
     readonly getPresets: () => {
         envPreset: Readonly<{
-            STUDENTS: StudentsWebVarsPreset;
-            TEACHERS: TeachersWebVarsPreset;
-            DISTRICT: DistrictWebVarsPreset;
-            AUTH_WEB: AuthWebVarsPreset;
-            WEB_ADMIN: WebAdminVarsPreset;
-            MOBILE: MobileVarsPreset;
+            STUDENTS: { [key in Locale]: { [key_1 in Environment]: StudentsWebVars; }; };
+            TEACHERS: { [key in Locale]: { [key_1 in Environment]: TeachersWebVars; }; };
+            DISTRICT: { [key in Locale]: { [key_1 in Environment]: DistrictDashboardVars; }; };
+            AUTH_WEB: {
+                [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>; };
+            };
+            WEB_ADMIN: { [key in Locale]: { [key_1 in Environment]: WebAdminVars; }; };
         }>;
         localePreset: LocalePreset;
     };
 }
 
-export { ApiRegion, AppConfigManager, DateFormat, DateLocale, type EnvPreset, Environment, type EnvironmentVars, Locale, LoginSource, MatrixMode, Platform, PlatformBuildTarget, SSO, type SSOConfig, Source, buildTargetToEnvironment };
+export { AppConfigManager, type AuthWebVars, DateFormat, DateLocale, type DistrictCommon, type DistrictDashboardVars, type EnvPreset, Environment, type EnvironmentVars, Locale, 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 };