@magmamath/frontend-config 0.0.1-rc.2 → 0.0.1-rc.21

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+import * as react from 'react';
+import { ComponentType } from 'react';
 import * as effector from 'effector';
 
 declare enum DateFormat {
@@ -13,28 +15,31 @@ declare enum DateFormat {
     FULL_WITH_SECONDS = "DD MMM YYYY HH:mm:ss",
     FULL_WITH_SECONDS_US = "DD MMM YYYY hh:mm:ss A"
 }
-declare enum DateLocale {
-    US = "en",
-    SV = "sv",
-    'en-SE' = "en",
-    'sv-SE' = "sv",
-    GB = "en",
-    'en-GB' = "en",
-    CA = "en",
-    'en-CA' = "en",
-    SCT = "en",
-    'en-SCT' = "en",
-    DE = "de",
-    'de-DE' = "de"
-}
+declare const DateLocale: {
+    readonly US: "en";
+    readonly SV: "sv";
+    readonly 'en-SE': "en";
+    readonly 'sv-SE': "sv";
+    readonly GB: "en";
+    readonly 'en-GB': "en";
+    readonly CA: "en";
+    readonly 'en-CA': "en";
+    readonly SCT: "en";
+    readonly 'en-SCT': "en";
+    readonly DE: "de";
+    readonly 'de-DE': "de";
+};
+type DateLocale = (typeof DateLocale)[keyof typeof DateLocale];
 
 declare enum Platform {
     STUDENTS_WEB = "STUDENTS",
     TEACHERS_WEB = "TEACHERS",
     DISTRICT_DASHBOARD = "DISTRICT",
-    AUTH_WEB = "AUTH_WEB",
-    STUDENTS_APP = "STUDENTS_RN_APP",
-    TEACHERS_APP = "TEACHERS_RN_APP"
+    AUTH_WEB = "AUTH_WEB"
+}
+declare enum Environment {
+    MARS = "MARS",
+    PROD = "PROD"
 }
 declare enum Locale {
     US = "en-SE",
@@ -44,33 +49,168 @@ declare enum Locale {
     SCT = "en-SCT",
     DE = "de-DE"
 }
-declare enum Environment {
-    MARS = "MARS",
-    PROD = "PROD"
+declare enum Source {
+    MATTEAPPEN = 0,
+    SKOLON = 1,
+    SKOLFEDERATION = 2,
+    GOOGLE = 3,
+    MICROSOFT = 4,
+    CLEVER = 5,
+    APPLE = 6,
+    MATHSYNC = 7,
+    CLASSLINK = 8,
+    EDUCLOUD = 9,
+    EGIL = 10,
+    WONDE = 12,
+    SCHOOLOGY = 13,
+    SEEMIS = 14,
+    IMPORT = 15,
+    CANVAS = 16
+}
+declare enum LoginSource {
+    MAGMA = 0,
+    CLEVER = 1,
+    CLASS_LINK = 2,
+    SKOLON = 3,
+    SKOLFEDERATION = 4,
+    GOOGLE = 5,
+    MICROSOFT = 6,
+    APPLE = 7,
+    SCHOOLOGY = 8,
+    MY_LOGIN = 9
+}
+declare enum SSO {
+    GOOGLE = "GOOGLE",
+    MICROSOFT = "MICROSOFT",
+    CLEVER = "CLEVER",
+    SCHOOLOGY = "SCHOOLOGY",
+    CLASS_LINK = "CLASS_LINK",
+    SKOLFEDERATION = "SKOLFEDERATION",
+    SKOLON = "SKOLON",
+    WONDE = "WONDE"
 }
 
-type RegionEnv = Readonly<{
+declare enum MatrixMode {
+    SKILL = "SKILL",
+    STANDARD = "STANDARD"
+}
+
+type IconProps = {
+    size?: number;
+};
+
+type SSO_UK = {
+    GOOGLE_AUTH: string;
+    MICROSOFT_AUTH: string;
+    WONDE_AUTH: string;
+    SKOLON_AUTH: string;
+    CLEVER_AUTH: never;
+    CLASS_LINK_AUTH: never;
+    SKOLFEDERATION_AUTH: never;
+    SCHOOLOGY_AUTH: never;
+};
+type SSO_US = {
+    GOOGLE_AUTH: string;
+    MICROSOFT_AUTH: string;
+    CLASS_LINK_AUTH: string;
+    SCHOOLOGY_AUTH: string;
+    CLEVER_AUTH: string;
+};
+type SSO_SE = {
+    GOOGLE_AUTH: string;
+    MICROSOFT_AUTH: string;
+    SKOLFEDERATION_AUTH: string;
+    SKOLON_AUTH: string;
+};
+type SSO_DE = {
+    GOOGLE_AUTH: string;
+    MICROSOFT_AUTH: string;
+};
+
+type RegionSpecificVars = {
     API_URL: string;
     AUTH_WEB_URL: string;
-    MYSCRIPT_HOST: string;
+    CDN_HOST: string;
+    DISTRICT_WEB_URL: string;
     LOGGLY_TAG: string;
-    SKOLFED_AUTH: string;
+    MAGMAMATH_URL: string;
     SOCKET_URL: string;
     STUDENTS_WEB_URL: string;
     TEACHERS_WEB_URL: string;
-    CDN_HOST: string;
-}>;
-type CommonEnv = Readonly<{
+};
+type StudentsWebCommon = {
     GOOGLE_API_KEY: string;
     DESMOS_API_KEY: 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;
-    LOGGLY_CUSTOMER_TOKEN: string;
+};
+type StudentsWebVars = RegionSpecificVars & StudentsWebCommon;
+type TeachersWebVars = RegionSpecificVars & {};
+type DistrictDashboardVars = RegionSpecificVars & {};
+type AuthWebBaseVars = Omit<RegionSpecificVars, 'CDN_HOST' | 'LOGGLY_TAG' | 'SOCKET_URL'> & {
+    TOS_URL: string;
+    CLARITY_PROJECT_ID: string;
+    INTERCOM_APP_ID: string;
+};
+type AuthWebCAVars = AuthWebBaseVars & SSO_US;
+type AuthWebDEVars = AuthWebBaseVars & SSO_DE;
+type AuthWebUKVars = AuthWebBaseVars & SSO_UK;
+type AuthWebSEVars = AuthWebBaseVars & SSO_SE;
+type AuthWebUSVars = AuthWebBaseVars & SSO_US;
+type EnvPreset = Readonly<{
+    [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]: AuthWebCAVars;
+        };
+        [Locale.DE]: {
+            [key in Environment]: AuthWebDEVars;
+        };
+        [Locale.GB]: {
+            [key in Environment]: AuthWebUKVars;
+        };
+        [Locale.SCT]: {
+            [key in Environment]: AuthWebUKVars;
+        };
+        [Locale.SE]: {
+            [key in Environment]: AuthWebSEVars;
+        };
+        [Locale.US]: {
+            [key in Environment]: AuthWebUSVars;
+        };
+    };
+}>;
+type EnvironmentVars<P extends Platform> = EnvPreset[P][Locale][Environment];
+
+type SSOConfig = Readonly<{
+    name: string;
+    icon: ComponentType<IconProps>;
+    type: SSO;
+    loginSource: LoginSource;
+    getUrl: (envs: EnvironmentVars<Platform.AUTH_WEB>) => string;
+    ownUrl?: boolean;
 }>;
-type EnvironmentVariables = RegionEnv & CommonEnv;
+
+declare const SSO_CONFIG_MAP: Record<SSO, SSOConfig>;
+declare const SSO_CONFIG_LIST: SSOConfig[];
 
 type StudentsLocaleConfig = CommonLocaleConfig & {
     textFormatting: {
@@ -113,28 +253,13 @@ type StudentsLocaleConfig = CommonLocaleConfig & {
     statsTab: {
         buttonWithMinWidth: boolean;
     };
-};
-
-type DistrictLocaleConfig = CommonLocaleConfig & {
-    date: {
-        use24HourFormat: boolean;
-        locale: DateLocale;
-        formats: {
-            full: DateFormat;
-            dayMonthYear: DateFormat;
-            dayMonth: DateFormat;
-            hoursMinutes: DateFormat;
-            fullWithSeconds: DateFormat;
-        };
+    smartEval: {
+        language: string;
     };
 };
 
-declare enum MatrixMode {
-    SKILL = "SKILL",
-    STANDARD = "STANDARD"
-}
-
 type TeachersLocaleConfig = CommonLocaleConfig & {
+    country: string;
     emails: {
         studentsList: string;
     };
@@ -178,12 +303,47 @@ type TeachersLocaleConfig = CommonLocaleConfig & {
     getStarted: {
         showSentEmailInfo: boolean;
     };
+    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;
+        };
+    };
+};
+
+type AuthWebLocaleConfig = {
+    path: string;
+    shortCode: string;
+    icon: ComponentType<IconProps>;
+    sources: {
+        signUp: {
+            list: SSOConfig[];
+        };
+        signIn: {
+            withOnboarding: boolean;
+            largeQRCode: boolean;
+            list: SSOConfig[];
+        };
+    };
+    isPrimaryRegion: boolean;
+    regionGroup: string;
+};
+
 type CommonLocaleConfig = Readonly<{
     name: string;
     languageName: string;
@@ -202,44 +362,68 @@ type LocalePreset = {
         [key in Locale]: DistrictLocaleConfig;
     };
     [Platform.AUTH_WEB]: {
-        [key in Locale]: DistrictLocaleConfig;
-    };
-    [Platform.STUDENTS_APP]: {
-        [key in Locale]: StudentsLocaleConfig;
-    };
-    [Platform.TEACHERS_APP]: {
-        [key in Locale]: TeachersLocaleConfig;
+        [key in Locale]: AuthWebLocaleConfig;
     };
 };
+type LocaleConfig<P extends Platform> = LocalePreset[P][Locale];
 
-type Locales<P extends Platform, L extends Locale> = LocalePreset[P][L];
-type ConfigOptions<P extends Platform, L extends Locale> = {
+type ConfigOptions<P extends Platform> = {
     platform: P;
-    locale: L;
     environment: Environment;
 };
 type SetProps = {
     locale?: Locale;
     environment?: Environment;
 };
-declare class AppConfigManager<P extends Platform, L extends Locale> {
+declare class AppConfigManager<P extends Platform> {
     private readonly platform;
-    private readonly locale;
-    private readonly environment;
+    environment: Environment;
+    locale: Locale;
     private readonly setEnvs;
     private readonly setLocaleConfig;
-    readonly $envs: effector.StoreWritable<EnvironmentVariables>;
-    readonly $localeConfig: effector.StoreWritable<Locales<P, L>>;
-    constructor(opts: ConfigOptions<P, L>);
-    readonly set: (props?: SetProps) => void;
-    readonly onEnvsChange: (cb: () => void) => effector.Subscription;
-    readonly onLocaleChange: (cb: () => void) => effector.Subscription;
+    readonly $envs: effector.StoreWritable<EnvironmentVars<P>>;
+    readonly $localeConfig: effector.StoreWritable<LocaleConfig<P>>;
+    constructor(opts: ConfigOptions<P>);
+    private readonly syncConfigsStores;
+    readonly set: (props: SetProps) => void;
+    readonly onEnvsChange: (cb: (cfg: EnvironmentVars<P>) => void) => this;
+    readonly onLocaleChange: (cb: (cfg: LocaleConfig<P>) => void) => this;
     readonly getConfig: () => {
-        platform: P;
-        currentLocale: L;
-        envs: EnvironmentVariables;
-        locales: Locales<P, L>;
+        envs: EnvironmentVars<P>;
+        localeConfig: LocaleConfig<P>;
+    };
+    readonly getSSOList: () => Readonly<{
+        name: string;
+        icon: react.ComponentType<IconProps>;
+        type: SSO;
+        loginSource: LoginSource;
+        getUrl: (envs: EnvironmentVars<Platform.AUTH_WEB>) => string;
+        ownUrl?: boolean;
+    }>[];
+    readonly getSSO: (key: SSO) => Readonly<{
+        name: string;
+        icon: react.ComponentType<IconProps>;
+        type: SSO;
+        loginSource: LoginSource;
+        getUrl: (envs: EnvironmentVars<Platform.AUTH_WEB>) => string;
+        ownUrl?: boolean;
+    }>;
+    readonly getPresets: () => {
+        envPreset: Readonly<{
+            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]: AuthWebCAVars; };
+                [Locale.DE]: { [key in Environment]: AuthWebDEVars; };
+                [Locale.GB]: { [key in Environment]: AuthWebUKVars; };
+                [Locale.SCT]: { [key in Environment]: AuthWebUKVars; };
+                [Locale.SE]: { [key in Environment]: AuthWebSEVars; };
+                [Locale.US]: { [key in Environment]: AuthWebUSVars; };
+            };
+        }>;
+        localePreset: LocalePreset;
     };
 }
 
-export { AppConfigManager, DateFormat, DateLocale, Environment, Locale, Platform };
+export { AppConfigManager, type AuthWebCAVars, type AuthWebDEVars, type AuthWebSEVars, type AuthWebUKVars, type AuthWebUSVars, DateFormat, DateLocale, type DistrictDashboardVars, type EnvPreset, Environment, type EnvironmentVars, Locale, LoginSource, MatrixMode, Platform, type RegionSpecificVars, SSO, type SSOConfig, SSO_CONFIG_LIST, SSO_CONFIG_MAP, Source, type StudentsWebCommon, type StudentsWebVars, type TeachersWebVars };