@magmamath/frontend-config 1.0.13-rc.9 → 1.0.14

package/dist/index.d.mts

@@ -43,6 +43,7 @@ declare enum Environment {
 declare enum PlatformBuildTarget {
     PLUTO = "pluto",
     MARS = "mars",
+    VENUS = "pre-release",
     PROD = "production"
 }
 declare enum Locale {
@@ -128,6 +129,11 @@ type SSO_DE = {
     GOOGLE_AUTH: string;
     MICROSOFT_AUTH: string;
 };
+type SSOVariant = SSO_US | SSO_DE | SSO_UK | SSO_SE;
+
+type Prettify<T> = T extends Function ? T : {
+    [K in keyof T]: T[K];
+};
 
 type RegionSpecificVars = {
     API_URL: string;
@@ -173,12 +179,7 @@ type AuthWebBaseVars = Omit<RegionSpecificVars, 'CDN_HOST' | 'LOGGLY_TAG' | 'SOC
     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 AuthWebVars = AuthWebBaseVars & (SSO_US | SSO_DE | SSO_UK | SSO_SE);
+type AuthWebVars<T extends SSOVariant> = Prettify<AuthWebBaseVars & T>;
 type EnvPreset = Readonly<{
     [Platform.STUDENTS_WEB]: {
         [key in Locale]: {
@@ -197,39 +198,36 @@ type EnvPreset = Readonly<{
     };
     [Platform.AUTH_WEB]: {
         [Locale.CA]: {
-            [key in Environment]: AuthWebCAVars;
+            [key in Environment]: AuthWebVars<SSO_US>;
         };
         [Locale.DE]: {
-            [key in Environment]: AuthWebDEVars;
+            [key in Environment]: AuthWebVars<SSO_DE>;
         };
         [Locale.GB]: {
-            [key in Environment]: AuthWebUKVars;
+            [key in Environment]: AuthWebVars<SSO_UK>;
         };
         [Locale.SCT]: {
-            [key in Environment]: AuthWebUKVars;
+            [key in Environment]: AuthWebVars<SSO_UK>;
         };
         [Locale.SE]: {
-            [key in Environment]: AuthWebSEVars;
+            [key in Environment]: AuthWebVars<SSO_SE>;
         };
         [Locale.US]: {
-            [key in Environment]: AuthWebUSVars;
+            [key in Environment]: AuthWebVars<SSO_US>;
         };
     };
 }>;
 type EnvironmentVars<P extends Platform> = EnvPreset[P][Locale][Environment];
 
-type SSOConfig = Readonly<{
+type SSOConfig<T extends SSOVariant> = Readonly<{
     name: string;
     icon: ComponentType<IconProps>;
     type: SSO;
     loginSource: LoginSource;
-    getUrl: (envs: AuthWebVars) => string;
+    getUrl: (envs: AuthWebVars<T>) => string;
     ownUrl?: boolean;
 }>;
 
-type UnionKeys<T> = T extends any ? keyof T : never;
-
-declare function safeEnv<T, K extends UnionKeys<T>>(envs: T, key: K): string;
 declare function buildTargetToEnvironment(buildTarget: PlatformBuildTarget): Environment;
 
 type StudentsLocaleConfig = CommonLocaleConfig & {
@@ -346,18 +344,18 @@ type DistrictLocaleConfig = CommonLocaleConfig & {
     };
 };
 
-type AuthWebLocaleConfig = {
+type AuthWebLocaleConfig<T extends SSOVariant> = {
     path: string;
     shortCode: string;
     icon: ComponentType<IconProps>;
     sources: {
         signUp: {
-            list: SSOConfig[];
+            list: SSOConfig<T>[];
         };
         signIn: {
             withOnboarding: boolean;
             largeQRCode: boolean;
-            list: SSOConfig[];
+            list: SSOConfig<T>[];
         };
     };
     isPrimaryRegion: boolean;
@@ -384,7 +382,7 @@ type LocalePreset = {
         [key in Locale]: DistrictLocaleConfig;
     };
     [Platform.AUTH_WEB]: {
-        [key in Locale]: AuthWebLocaleConfig;
+        [key in Locale]: AuthWebLocaleConfig<SSOVariant>;
     };
 };
 type LocaleConfig<P extends Platform> = LocalePreset[P][Locale];
@@ -427,16 +425,16 @@ declare class AppConfigManager<P extends Platform> {
             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; };
+                [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>; };
             };
         }>;
         localePreset: LocalePreset;
     };
 }
 
-export { AppConfigManager, type AuthWebCAVars, type AuthWebDEVars, type AuthWebSEVars, type AuthWebUKVars, type AuthWebUSVars, type AuthWebVars, DateFormat, DateLocale, type DistrictCommon, type DistrictDashboardVars, type EnvPreset, Environment, type EnvironmentVars, Locale, LoginSource, MatrixMode, Platform, PlatformBuildTarget, type RegionSpecificVars, SSO, type SSOConfig, Source, type StudentsWebCommon, type StudentsWebVars, type TeachersWebCommon, type TeachersWebVars, buildTargetToEnvironment, safeEnv };
+export { AppConfigManager, type AuthWebVars, DateFormat, DateLocale, type DistrictCommon, type DistrictDashboardVars, type EnvPreset, Environment, type EnvironmentVars, Locale, LoginSource, MatrixMode, Platform, PlatformBuildTarget, type RegionSpecificVars, SSO, type SSOConfig, Source, type StudentsWebCommon, type StudentsWebVars, type TeachersWebCommon, type TeachersWebVars, buildTargetToEnvironment };

package/dist/index.d.ts

@@ -43,6 +43,7 @@ declare enum Environment {
 declare enum PlatformBuildTarget {
     PLUTO = "pluto",
     MARS = "mars",
+    VENUS = "pre-release",
     PROD = "production"
 }
 declare enum Locale {
@@ -128,6 +129,11 @@ type SSO_DE = {
     GOOGLE_AUTH: string;
     MICROSOFT_AUTH: string;
 };
+type SSOVariant = SSO_US | SSO_DE | SSO_UK | SSO_SE;
+
+type Prettify<T> = T extends Function ? T : {
+    [K in keyof T]: T[K];
+};
 
 type RegionSpecificVars = {
     API_URL: string;
@@ -173,12 +179,7 @@ type AuthWebBaseVars = Omit<RegionSpecificVars, 'CDN_HOST' | 'LOGGLY_TAG' | 'SOC
     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 AuthWebVars = AuthWebBaseVars & (SSO_US | SSO_DE | SSO_UK | SSO_SE);
+type AuthWebVars<T extends SSOVariant> = Prettify<AuthWebBaseVars & T>;
 type EnvPreset = Readonly<{
     [Platform.STUDENTS_WEB]: {
         [key in Locale]: {
@@ -197,39 +198,36 @@ type EnvPreset = Readonly<{
     };
     [Platform.AUTH_WEB]: {
         [Locale.CA]: {
-            [key in Environment]: AuthWebCAVars;
+            [key in Environment]: AuthWebVars<SSO_US>;
         };
         [Locale.DE]: {
-            [key in Environment]: AuthWebDEVars;
+            [key in Environment]: AuthWebVars<SSO_DE>;
         };
         [Locale.GB]: {
-            [key in Environment]: AuthWebUKVars;
+            [key in Environment]: AuthWebVars<SSO_UK>;
         };
         [Locale.SCT]: {
-            [key in Environment]: AuthWebUKVars;
+            [key in Environment]: AuthWebVars<SSO_UK>;
         };
         [Locale.SE]: {
-            [key in Environment]: AuthWebSEVars;
+            [key in Environment]: AuthWebVars<SSO_SE>;
         };
         [Locale.US]: {
-            [key in Environment]: AuthWebUSVars;
+            [key in Environment]: AuthWebVars<SSO_US>;
         };
     };
 }>;
 type EnvironmentVars<P extends Platform> = EnvPreset[P][Locale][Environment];
 
-type SSOConfig = Readonly<{
+type SSOConfig<T extends SSOVariant> = Readonly<{
     name: string;
     icon: ComponentType<IconProps>;
     type: SSO;
     loginSource: LoginSource;
-    getUrl: (envs: AuthWebVars) => string;
+    getUrl: (envs: AuthWebVars<T>) => string;
     ownUrl?: boolean;
 }>;
 
-type UnionKeys<T> = T extends any ? keyof T : never;
-
-declare function safeEnv<T, K extends UnionKeys<T>>(envs: T, key: K): string;
 declare function buildTargetToEnvironment(buildTarget: PlatformBuildTarget): Environment;
 
 type StudentsLocaleConfig = CommonLocaleConfig & {
@@ -346,18 +344,18 @@ type DistrictLocaleConfig = CommonLocaleConfig & {
     };
 };
 
-type AuthWebLocaleConfig = {
+type AuthWebLocaleConfig<T extends SSOVariant> = {
     path: string;
     shortCode: string;
     icon: ComponentType<IconProps>;
     sources: {
         signUp: {
-            list: SSOConfig[];
+            list: SSOConfig<T>[];
         };
         signIn: {
             withOnboarding: boolean;
             largeQRCode: boolean;
-            list: SSOConfig[];
+            list: SSOConfig<T>[];
         };
     };
     isPrimaryRegion: boolean;
@@ -384,7 +382,7 @@ type LocalePreset = {
         [key in Locale]: DistrictLocaleConfig;
     };
     [Platform.AUTH_WEB]: {
-        [key in Locale]: AuthWebLocaleConfig;
+        [key in Locale]: AuthWebLocaleConfig<SSOVariant>;
     };
 };
 type LocaleConfig<P extends Platform> = LocalePreset[P][Locale];
@@ -427,16 +425,16 @@ declare class AppConfigManager<P extends Platform> {
             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; };
+                [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>; };
             };
         }>;
         localePreset: LocalePreset;
     };
 }
 
-export { AppConfigManager, type AuthWebCAVars, type AuthWebDEVars, type AuthWebSEVars, type AuthWebUKVars, type AuthWebUSVars, type AuthWebVars, DateFormat, DateLocale, type DistrictCommon, type DistrictDashboardVars, type EnvPreset, Environment, type EnvironmentVars, Locale, LoginSource, MatrixMode, Platform, PlatformBuildTarget, type RegionSpecificVars, SSO, type SSOConfig, Source, type StudentsWebCommon, type StudentsWebVars, type TeachersWebCommon, type TeachersWebVars, buildTargetToEnvironment, safeEnv };
+export { AppConfigManager, type AuthWebVars, DateFormat, DateLocale, type DistrictCommon, type DistrictDashboardVars, type EnvPreset, Environment, type EnvironmentVars, Locale, LoginSource, MatrixMode, Platform, PlatformBuildTarget, type RegionSpecificVars, SSO, type SSOConfig, Source, type StudentsWebCommon, type StudentsWebVars, type TeachersWebCommon, type TeachersWebVars, buildTargetToEnvironment };

package/dist/index.js

@@ -3140,6 +3140,7 @@ var Environment = /* @__PURE__ */ ((Environment3) => {
 var PlatformBuildTarget = /* @__PURE__ */ ((PlatformBuildTarget2) => {
   PlatformBuildTarget2["PLUTO"] = "pluto";
   PlatformBuildTarget2["MARS"] = "mars";
+  PlatformBuildTarget2["VENUS"] = "pre-release";
   PlatformBuildTarget2["PROD"] = "production";
   return PlatformBuildTarget2;
 })(PlatformBuildTarget || {});
@@ -3184,18 +3185,18 @@ var LoginSource = /* @__PURE__ */ ((LoginSource2) => {
   LoginSource2[LoginSource2["MY_LOGIN"] = 9] = "MY_LOGIN";
   return LoginSource2;
 })(LoginSource || {});
-var SSO = /* @__PURE__ */ ((SSO3) => {
-  SSO3["GOOGLE"] = "GOOGLE";
-  SSO3["MICROSOFT"] = "MICROSOFT";
-  SSO3["CLEVER"] = "CLEVER";
-  SSO3["SCHOOLOGY"] = "SCHOOLOGY";
-  SSO3["CLASS_LINK"] = "CLASS_LINK";
-  SSO3["SKOLFEDERATION"] = "SKOLFEDERATION";
-  SSO3["SKOLON"] = "SKOLON";
-  SSO3["WONDE"] = "WONDE";
-  SSO3["CANVAS"] = "CANVAS";
-  SSO3["QR_CODE"] = "QR_CODE";
-  return SSO3;
+var SSO = /* @__PURE__ */ ((SSO2) => {
+  SSO2["GOOGLE"] = "GOOGLE";
+  SSO2["MICROSOFT"] = "MICROSOFT";
+  SSO2["CLEVER"] = "CLEVER";
+  SSO2["SCHOOLOGY"] = "SCHOOLOGY";
+  SSO2["CLASS_LINK"] = "CLASS_LINK";
+  SSO2["SKOLFEDERATION"] = "SKOLFEDERATION";
+  SSO2["SKOLON"] = "SKOLON";
+  SSO2["WONDE"] = "WONDE";
+  SSO2["CANVAS"] = "CANVAS";
+  SSO2["QR_CODE"] = "QR_CODE";
+  return SSO2;
 })(SSO || {});
 
 // src/shared/constants/matrix.constants.ts
@@ -3206,18 +3207,14 @@ var MatrixMode = /* @__PURE__ */ ((MatrixMode2) => {
 })(MatrixMode || {});
 
 // src/configs/env/env.helpers.ts
-function safeEnv(envs, key) {
-  const value = envs[key];
-  if (value == null || value === "") throw new Error(`Missing required env variable: ${String(key)}`);
-  return value;
-}
+var ENV_BY_BUILD_TARGET = {
+  ["pluto" /* PLUTO */]: "MARS" /* MARS */,
+  ["mars" /* MARS */]: "MARS" /* MARS */,
+  ["pre-release" /* VENUS */]: "PROD" /* PROD */,
+  ["production" /* PROD */]: "PROD" /* PROD */
+};
 function buildTargetToEnvironment(buildTarget) {
-  const map = {
-    ["pluto" /* PLUTO */]: "MARS" /* MARS */,
-    ["mars" /* MARS */]: "MARS" /* MARS */,
-    ["production" /* PROD */]: "PROD" /* PROD */
-  };
-  const env = map[buildTarget];
+  const env = ENV_BY_BUILD_TARGET[buildTarget];
   if (!env) throw new Error(`Unknown build target: ${buildTarget}`);
   return env;
 }
@@ -4865,7 +4862,7 @@ var SSO_GOOGLE_CONFIG = {
   type: "GOOGLE" /* GOOGLE */,
   loginSource: 5 /* GOOGLE */,
   icon: GoogleIcon,
-  getUrl: (envs) => safeEnv(envs, "GOOGLE_AUTH")
+  getUrl: (envs) => envs.GOOGLE_AUTH
 };
 
 // src/shared/icons/sso/MicrosoftIcon.tsx
@@ -4885,7 +4882,7 @@ var SSO_MICROSOFT_CONFIG = {
   type: "MICROSOFT" /* MICROSOFT */,
   loginSource: 6 /* MICROSOFT */,
   icon: MicrosoftIcon,
-  getUrl: (envs) => safeEnv(envs, "MICROSOFT_AUTH")
+  getUrl: (envs) => envs.MICROSOFT_AUTH
 };
 
 // src/shared/icons/sso/ClasslinkIcon.tsx
@@ -4923,7 +4920,7 @@ var SSO_CLASSLINK_CONFIG = {
   type: "CLASS_LINK" /* CLASS_LINK */,
   loginSource: 2 /* CLASS_LINK */,
   icon: ClasslinkIcon,
-  getUrl: (envs) => safeEnv(envs, "CLASS_LINK_AUTH")
+  getUrl: (envs) => envs.CLASS_LINK_AUTH
 };
 
 // src/shared/icons/sso/SchoologyIcon.tsx
@@ -4963,7 +4960,7 @@ var SSO_SCHOOLOGY_CONFIG = {
   type: "SCHOOLOGY" /* SCHOOLOGY */,
   loginSource: 8 /* SCHOOLOGY */,
   icon: SchoologyIcon,
-  getUrl: (envs) => safeEnv(envs, "SCHOOLOGY_AUTH")
+  getUrl: (envs) => envs.SCHOOLOGY_AUTH
 };
 
 // src/shared/icons/sso/CleverIcon.tsx
@@ -4995,7 +4992,7 @@ var SSO_CLEVER_CONFIG = {
   type: "CLEVER" /* CLEVER */,
   loginSource: 1 /* CLEVER */,
   icon: CleverIcon,
-  getUrl: (envs) => safeEnv(envs, "CLEVER_AUTH")
+  getUrl: (envs) => envs.CLEVER_AUTH
 };
 
 // src/shared/icons/country/USFlagIcon.tsx
@@ -5079,7 +5076,7 @@ var SSO_CANVAS_CONFIG = {
   type: "CANVAS" /* CANVAS */,
   loginSource: 8 /* SCHOOLOGY */,
   icon: CanvasIcon,
-  getUrl: (envs) => safeEnv(envs, "SCHOOLOGY_AUTH")
+  getUrl: (envs) => envs.SCHOOLOGY_AUTH
 };
 
 // src/shared/icons/sso/QRCodeIcon.tsx
@@ -5124,7 +5121,15 @@ var LOCALE_AUTHWEB_US = {
     signIn: {
       withOnboarding: true,
       largeQRCode: false,
-      list: [SSO_CLASSLINK_CONFIG, SSO_CLEVER_CONFIG, SSO_SCHOOLOGY_CONFIG, SSO_CANVAS_CONFIG, SSO_GOOGLE_CONFIG, SSO_MICROSOFT_CONFIG, SSO_QR_CODE_CONFIG]
+      list: [
+        SSO_CLASSLINK_CONFIG,
+        SSO_CLEVER_CONFIG,
+        SSO_SCHOOLOGY_CONFIG,
+        SSO_CANVAS_CONFIG,
+        SSO_GOOGLE_CONFIG,
+        SSO_MICROSOFT_CONFIG,
+        SSO_QR_CODE_CONFIG
+      ]
     },
     signUp: {
       list: [SSO_GOOGLE_CONFIG, SSO_MICROSOFT_CONFIG]
@@ -5199,7 +5204,7 @@ var SSO_SKOLON_CONFIG = {
   type: "SKOLON" /* SKOLON */,
   loginSource: 3 /* SKOLON */,
   icon: SkolonIcon,
-  getUrl: (envs) => safeEnv(envs, "SKOLON_AUTH")
+  getUrl: (envs) => envs.SKOLON_AUTH
 };
 
 // src/shared/icons/sso/SkolfederationIcon.tsx
@@ -5236,7 +5241,7 @@ var SSO_SKOLFEDERATION_CONFIG = {
   ownUrl: true,
   getUrl: (envs) => {
     const returnUrl = encodeURIComponent(`${envs.API_URL}/auth/skolfederation`);
-    return `${safeEnv(envs, "SKOLFEDERATION_AUTH")}?return=${returnUrl}`;
+    return `${envs.SKOLFEDERATION_AUTH}?return=${returnUrl}`;
   }
 };
 
@@ -5316,7 +5321,7 @@ var SSO_WONDE_CONFIG = {
   type: "WONDE" /* WONDE */,
   loginSource: 9 /* MY_LOGIN */,
   icon: WondeIcon,
-  getUrl: (envs) => safeEnv(envs, "WONDE_AUTH")
+  getUrl: (envs) => envs.WONDE_AUTH
 };
 
 // src/shared/icons/country/UKFlagIcon.tsx
@@ -5466,7 +5471,15 @@ var LOCALE_AUTHWEB_CA = {
     signIn: {
       withOnboarding: true,
       largeQRCode: false,
-      list: [SSO_CLASSLINK_CONFIG, SSO_CLEVER_CONFIG, SSO_SCHOOLOGY_CONFIG, SSO_CANVAS_CONFIG, SSO_GOOGLE_CONFIG, SSO_MICROSOFT_CONFIG, SSO_QR_CODE_CONFIG]
+      list: [
+        SSO_CLASSLINK_CONFIG,
+        SSO_CLEVER_CONFIG,
+        SSO_SCHOOLOGY_CONFIG,
+        SSO_CANVAS_CONFIG,
+        SSO_GOOGLE_CONFIG,
+        SSO_MICROSOFT_CONFIG,
+        SSO_QR_CODE_CONFIG
+      ]
     },
     signUp: {
       list: [SSO_GOOGLE_CONFIG, SSO_MICROSOFT_CONFIG]
@@ -5717,6 +5730,5 @@ exports.PlatformBuildTarget = PlatformBuildTarget;
 exports.SSO = SSO;
 exports.Source = Source;
 exports.buildTargetToEnvironment = buildTargetToEnvironment;
-exports.safeEnv = safeEnv;
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map