@magmamath/frontend-config 1.0.22-rc.10 → 1.0.22-rc.2

package/dist/index.d.mts

@@ -104,11 +104,6 @@ declare enum ApiRegion {
     MAIN = "MAIN",
     CANADA = "CANADA"
 }
-declare enum QRCodeSize {
-    DEFAULT = "default",
-    MEDIUM = "medium",
-    LARGE = "large"
-}
 
 declare enum MatrixMode {
     SKILL = "SKILL",
@@ -119,73 +114,6 @@ type IconProps = {
     size?: number;
 };
 
-type SSOConfig<E> = Readonly<{
-    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;
-};
-
-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 SSO_UK = {
     GOOGLE_AUTH: string;
     MICROSOFT_AUTH: string;
@@ -223,6 +151,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 +190,63 @@ type AuthWebVarsPreset = {
     };
 };
 
+type SSOConfigStatic = Readonly<{
+    name: string;
+    icon: ComponentType<IconProps>;
+    type: SSO;
+    loginSource: LoginSource;
+    ownUrl?: boolean;
+}>;
+type SSOConfig<T extends SSOVariant> = SSOConfigStatic & {
+    getUrl: (envs: AuthWebVars<T>) => string;
+};
+
+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 +257,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;
@@ -438,18 +431,18 @@ type DistrictLocaleConfig = CommonLocaleConfig & {
     };
 };
 
-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;
@@ -467,6 +460,27 @@ type WebAdminLocaleConfig = {
     apiRegion: ApiRegion;
 };
 
+type MobileLocaleConfig = {
+    path: string;
+    shortCode: string;
+    icon: ComponentType<IconProps>;
+    sources: {
+        signUp: {
+            list: SSOConfigStatic[];
+        };
+        signIn: {
+            withOnboarding: boolean;
+            largeQRCode: boolean;
+            mediumQRCode: boolean;
+            list: SSOConfigStatic[];
+        };
+    };
+    isPrimaryRegion: boolean;
+    regionGroup: string;
+    navigatorLanguages: string[];
+    locale: Locale;
+};
+
 type CommonLocaleConfig = Readonly<{
     name: string;
     languageName: string;
@@ -485,13 +499,13 @@ 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]: MobileLocaleConfig;
     };
 };
 type LocaleConfig<P extends Platform, L extends Locale> = LocalePreset[P][L];
@@ -534,4 +548,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, 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, SSO, type SSOByLocale, type SSOConfig, type SSOConfigStatic, 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 };

package/dist/index.d.ts

@@ -104,11 +104,6 @@ declare enum ApiRegion {
     MAIN = "MAIN",
     CANADA = "CANADA"
 }
-declare enum QRCodeSize {
-    DEFAULT = "default",
-    MEDIUM = "medium",
-    LARGE = "large"
-}
 
 declare enum MatrixMode {
     SKILL = "SKILL",
@@ -119,73 +114,6 @@ type IconProps = {
     size?: number;
 };
 
-type SSOConfig<E> = Readonly<{
-    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;
-};
-
-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 SSO_UK = {
     GOOGLE_AUTH: string;
     MICROSOFT_AUTH: string;
@@ -223,6 +151,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 +190,63 @@ type AuthWebVarsPreset = {
     };
 };
 
+type SSOConfigStatic = Readonly<{
+    name: string;
+    icon: ComponentType<IconProps>;
+    type: SSO;
+    loginSource: LoginSource;
+    ownUrl?: boolean;
+}>;
+type SSOConfig<T extends SSOVariant> = SSOConfigStatic & {
+    getUrl: (envs: AuthWebVars<T>) => string;
+};
+
+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 +257,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;
@@ -438,18 +431,18 @@ type DistrictLocaleConfig = CommonLocaleConfig & {
     };
 };
 
-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;
@@ -467,6 +460,27 @@ type WebAdminLocaleConfig = {
     apiRegion: ApiRegion;
 };
 
+type MobileLocaleConfig = {
+    path: string;
+    shortCode: string;
+    icon: ComponentType<IconProps>;
+    sources: {
+        signUp: {
+            list: SSOConfigStatic[];
+        };
+        signIn: {
+            withOnboarding: boolean;
+            largeQRCode: boolean;
+            mediumQRCode: boolean;
+            list: SSOConfigStatic[];
+        };
+    };
+    isPrimaryRegion: boolean;
+    regionGroup: string;
+    navigatorLanguages: string[];
+    locale: Locale;
+};
+
 type CommonLocaleConfig = Readonly<{
     name: string;
     languageName: string;
@@ -485,13 +499,13 @@ 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]: MobileLocaleConfig;
     };
 };
 type LocaleConfig<P extends Platform, L extends Locale> = LocalePreset[P][L];
@@ -534,4 +548,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, 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, SSO, type SSOByLocale, type SSOConfig, type SSOConfigStatic, 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 };