@magmamath/frontend-config 0.0.1-rc.1

package/dist/index.d.mts

@@ -0,0 +1,245 @@
+import * as effector from 'effector';
+
+declare enum DateFormat {
+    FULL = "YYYY-MM-DD HH:mm",
+    FULL_US = "YYYY-MM-DD hh:mm A",
+    DAY_MONTH_YEAR = "DD-MM-YYYY",
+    DAY_MONTH_YEAR_US = "YYYY-MM-DD",
+    HOURS_MINUTES = "HH:mm",
+    HOURS_MINUTES_US = "hh:mm A",
+    DAY_MONTH = "DD MMM",
+    DAY_MONTH_US = "MMM DD",
+    YEAR_MONTH_DAY = "YYYY-MM-DD",
+    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 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"
+}
+declare enum Locale {
+    US = "en-SE",
+    SE = "sv-SE",
+    GB = "en-GB",
+    CA = "en-CA",
+    SCT = "en-SCT",
+    DE = "de-DE"
+}
+declare enum Environment {
+    MARS = "MARS",
+    PROD = "PROD"
+}
+
+type RegionEnv = Readonly<{
+    API_URL: string;
+    AUTH_WEB_URL: string;
+    MYSCRIPT_HOST: string;
+    LOGGLY_TAG: string;
+    SKOLFED_AUTH: string;
+    SOCKET_URL: string;
+    STUDENTS_WEB_URL: string;
+    TEACHERS_WEB_URL: string;
+    CDN_HOST: string;
+}>;
+type CommonEnv = Readonly<{
+    GOOGLE_API_KEY: string;
+    DESMOS_API_KEY: string;
+    MYSCRIPT_APPLICATION_KEY: string;
+    MYSCRIPT_HMAC_KEY: string;
+    MYSCRIPT_SOCKET_KEY: string;
+    MYSCRIPT_REST_APP_KEY: string;
+    MYSCRIPT_REST_HMAC_KEY: string;
+    LOGGLY_CUSTOMER_TOKEN: string;
+}>;
+type EnvironmentVariables = RegionEnv & CommonEnv;
+
+type StudentsLocaleConfig = CommonLocaleConfig & {
+    textFormatting: {
+        replaceCommaWithSpace: boolean;
+    };
+    symbols: {
+        numberDecimalSeparator: string;
+    };
+    practiceMode: {
+        languageCode: Locale;
+        defaultPracticeTreeId: string;
+    };
+    chatbot: {
+        languageName: string;
+        tts: {
+            languageCodeFallback: string;
+            voiceNameFallback: string;
+        };
+    };
+    tts: {
+        replaceCommaWithSpace: boolean;
+    };
+    translate: {
+        languageCodeFallback: string;
+    };
+    problem: {
+        choiceInputSelector: {
+            useSmallText: boolean;
+        };
+        choiceAnswerFeedback: {
+            useSlimLayout: boolean;
+        };
+        answer: {
+            shortButton: boolean;
+        };
+    };
+    exampleSolutions: {
+        languageName: string;
+    };
+    statsTab: {
+        buttonWithMinWidth: boolean;
+    };
+};
+
+type DistrictLocaleConfig = CommonLocaleConfig & {
+    date: {
+        use24HourFormat: boolean;
+        locale: DateLocale;
+        formats: {
+            full: DateFormat;
+            dayMonthYear: DateFormat;
+            dayMonth: DateFormat;
+            hoursMinutes: DateFormat;
+            fullWithSeconds: DateFormat;
+        };
+    };
+};
+
+declare enum MatrixMode {
+    SKILL = "SKILL",
+    STANDARD = "STANDARD"
+}
+
+type TeachersLocaleConfig = CommonLocaleConfig & {
+    emails: {
+        studentsList: string;
+    };
+    symbols: {
+        decimalSeparator: string;
+    };
+    date: {
+        use24HourFormat: boolean;
+        locale: DateLocale;
+        formats: {
+            full: DateFormat;
+            dayMonth: DateFormat;
+            hoursMinutes: DateFormat;
+            fullWithSeconds: DateFormat;
+        };
+    };
+    urls: {
+        specialBook: string;
+        helpCenter: string;
+        about: string;
+    };
+    bookshelf: {
+        limitSharedExercisesTooltipWidth: boolean;
+    };
+    problemsList: {
+        showProblemComplexity: boolean;
+    };
+    practiceMode: {
+        defaultTreeIdFallback: string;
+    };
+    matrix: {
+        forceShowRecommendations: boolean;
+        forceMatrixMode?: MatrixMode;
+    };
+    pieChart: {
+        showExtraTreeDataContent: boolean;
+    };
+    problem: {
+        allowCommaDecimal: boolean;
+    };
+    getStarted: {
+        showSentEmailInfo: boolean;
+    };
+    grades: {
+        showPrefix: boolean;
+        showOtherGrade: boolean;
+    };
+};
+
+type CommonLocaleConfig = Readonly<{
+    name: string;
+    languageName: string;
+    languageHeader: string;
+    contentLocale: Locale;
+    shortCode: string;
+}>;
+type LocalePreset = {
+    [Platform.STUDENTS_WEB]: {
+        [key in Locale]: StudentsLocaleConfig;
+    };
+    [Platform.TEACHERS_WEB]: {
+        [key in Locale]: TeachersLocaleConfig;
+    };
+    [Platform.DISTRICT_DASHBOARD]: {
+        [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;
+    };
+};
+
+type Locales<P extends Platform, L extends Locale> = LocalePreset[P][L];
+type ConfigOptions<P extends Platform, L extends Locale> = {
+    platform: P;
+    locale: L;
+    environment: Environment;
+};
+type SetProps = {
+    locale?: Locale;
+    environment?: Environment;
+};
+declare class AppConfigManager<P extends Platform, L extends Locale> {
+    private readonly platform;
+    private readonly locale;
+    private readonly environment;
+    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 getConfig: () => {
+        platform: P;
+        currentLocale: L;
+        envs: EnvironmentVariables;
+        locales: Locales<P, L>;
+    };
+}
+
+export { AppConfigManager, DateFormat, DateLocale };

package/dist/index.d.ts

@@ -0,0 +1,245 @@
+import * as effector from 'effector';
+
+declare enum DateFormat {
+    FULL = "YYYY-MM-DD HH:mm",
+    FULL_US = "YYYY-MM-DD hh:mm A",
+    DAY_MONTH_YEAR = "DD-MM-YYYY",
+    DAY_MONTH_YEAR_US = "YYYY-MM-DD",
+    HOURS_MINUTES = "HH:mm",
+    HOURS_MINUTES_US = "hh:mm A",
+    DAY_MONTH = "DD MMM",
+    DAY_MONTH_US = "MMM DD",
+    YEAR_MONTH_DAY = "YYYY-MM-DD",
+    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 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"
+}
+declare enum Locale {
+    US = "en-SE",
+    SE = "sv-SE",
+    GB = "en-GB",
+    CA = "en-CA",
+    SCT = "en-SCT",
+    DE = "de-DE"
+}
+declare enum Environment {
+    MARS = "MARS",
+    PROD = "PROD"
+}
+
+type RegionEnv = Readonly<{
+    API_URL: string;
+    AUTH_WEB_URL: string;
+    MYSCRIPT_HOST: string;
+    LOGGLY_TAG: string;
+    SKOLFED_AUTH: string;
+    SOCKET_URL: string;
+    STUDENTS_WEB_URL: string;
+    TEACHERS_WEB_URL: string;
+    CDN_HOST: string;
+}>;
+type CommonEnv = Readonly<{
+    GOOGLE_API_KEY: string;
+    DESMOS_API_KEY: string;
+    MYSCRIPT_APPLICATION_KEY: string;
+    MYSCRIPT_HMAC_KEY: string;
+    MYSCRIPT_SOCKET_KEY: string;
+    MYSCRIPT_REST_APP_KEY: string;
+    MYSCRIPT_REST_HMAC_KEY: string;
+    LOGGLY_CUSTOMER_TOKEN: string;
+}>;
+type EnvironmentVariables = RegionEnv & CommonEnv;
+
+type StudentsLocaleConfig = CommonLocaleConfig & {
+    textFormatting: {
+        replaceCommaWithSpace: boolean;
+    };
+    symbols: {
+        numberDecimalSeparator: string;
+    };
+    practiceMode: {
+        languageCode: Locale;
+        defaultPracticeTreeId: string;
+    };
+    chatbot: {
+        languageName: string;
+        tts: {
+            languageCodeFallback: string;
+            voiceNameFallback: string;
+        };
+    };
+    tts: {
+        replaceCommaWithSpace: boolean;
+    };
+    translate: {
+        languageCodeFallback: string;
+    };
+    problem: {
+        choiceInputSelector: {
+            useSmallText: boolean;
+        };
+        choiceAnswerFeedback: {
+            useSlimLayout: boolean;
+        };
+        answer: {
+            shortButton: boolean;
+        };
+    };
+    exampleSolutions: {
+        languageName: string;
+    };
+    statsTab: {
+        buttonWithMinWidth: boolean;
+    };
+};
+
+type DistrictLocaleConfig = CommonLocaleConfig & {
+    date: {
+        use24HourFormat: boolean;
+        locale: DateLocale;
+        formats: {
+            full: DateFormat;
+            dayMonthYear: DateFormat;
+            dayMonth: DateFormat;
+            hoursMinutes: DateFormat;
+            fullWithSeconds: DateFormat;
+        };
+    };
+};
+
+declare enum MatrixMode {
+    SKILL = "SKILL",
+    STANDARD = "STANDARD"
+}
+
+type TeachersLocaleConfig = CommonLocaleConfig & {
+    emails: {
+        studentsList: string;
+    };
+    symbols: {
+        decimalSeparator: string;
+    };
+    date: {
+        use24HourFormat: boolean;
+        locale: DateLocale;
+        formats: {
+            full: DateFormat;
+            dayMonth: DateFormat;
+            hoursMinutes: DateFormat;
+            fullWithSeconds: DateFormat;
+        };
+    };
+    urls: {
+        specialBook: string;
+        helpCenter: string;
+        about: string;
+    };
+    bookshelf: {
+        limitSharedExercisesTooltipWidth: boolean;
+    };
+    problemsList: {
+        showProblemComplexity: boolean;
+    };
+    practiceMode: {
+        defaultTreeIdFallback: string;
+    };
+    matrix: {
+        forceShowRecommendations: boolean;
+        forceMatrixMode?: MatrixMode;
+    };
+    pieChart: {
+        showExtraTreeDataContent: boolean;
+    };
+    problem: {
+        allowCommaDecimal: boolean;
+    };
+    getStarted: {
+        showSentEmailInfo: boolean;
+    };
+    grades: {
+        showPrefix: boolean;
+        showOtherGrade: boolean;
+    };
+};
+
+type CommonLocaleConfig = Readonly<{
+    name: string;
+    languageName: string;
+    languageHeader: string;
+    contentLocale: Locale;
+    shortCode: string;
+}>;
+type LocalePreset = {
+    [Platform.STUDENTS_WEB]: {
+        [key in Locale]: StudentsLocaleConfig;
+    };
+    [Platform.TEACHERS_WEB]: {
+        [key in Locale]: TeachersLocaleConfig;
+    };
+    [Platform.DISTRICT_DASHBOARD]: {
+        [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;
+    };
+};
+
+type Locales<P extends Platform, L extends Locale> = LocalePreset[P][L];
+type ConfigOptions<P extends Platform, L extends Locale> = {
+    platform: P;
+    locale: L;
+    environment: Environment;
+};
+type SetProps = {
+    locale?: Locale;
+    environment?: Environment;
+};
+declare class AppConfigManager<P extends Platform, L extends Locale> {
+    private readonly platform;
+    private readonly locale;
+    private readonly environment;
+    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 getConfig: () => {
+        platform: P;
+        currentLocale: L;
+        envs: EnvironmentVariables;
+        locales: Locales<P, L>;
+    };
+}
+
+export { AppConfigManager, DateFormat, DateLocale };