@magmamath/frontend-config 1.0.22-rc.3 → 1.0.22-rc.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -119,6 +119,73 @@ type IconProps = {
119
119
  size?: number;
120
120
  };
121
121
 
122
+ type SSOConfig<E> = Readonly<{
123
+ name: string;
124
+ icon: ComponentType<IconProps>;
125
+ type: SSO;
126
+ loginSource: LoginSource;
127
+ ownUrl?: boolean;
128
+ getUrl: (envs: E) => string;
129
+ }>;
130
+
131
+ type RegionSpecificVars = {
132
+ API_URL: string;
133
+ AUTH_WEB_URL: string;
134
+ CDN_HOST: string;
135
+ DISTRICT_WEB_URL: string;
136
+ LOGGLY_TAG: string;
137
+ MAGMAMATH_URL: string;
138
+ SOCKET_URL: string;
139
+ STUDENTS_WEB_URL: string;
140
+ TEACHERS_WEB_URL: string;
141
+ };
142
+
143
+ type StudentsWebCommon = {
144
+ GOOGLE_API_KEY: string;
145
+ DESMOS_API_KEY: string;
146
+ LOGGLY_CUSTOMER_TOKEN: string;
147
+ MYSCRIPT_APPLICATION_KEY: string;
148
+ MYSCRIPT_HMAC_KEY: string;
149
+ MYSCRIPT_HOST: string;
150
+ MYSCRIPT_SOCKET_KEY: string;
151
+ MYSCRIPT_REST_APP_KEY: string;
152
+ MYSCRIPT_REST_HMAC_KEY: string;
153
+ };
154
+ type StudentsWebVars = RegionSpecificVars & StudentsWebCommon;
155
+ type StudentsWebVarsPreset = {
156
+ [key in Locale]: {
157
+ [key in Environment]: StudentsWebVars;
158
+ };
159
+ };
160
+
161
+ type TeachersWebCommon = {
162
+ MYSCRIPT_HOST: string;
163
+ MYSCRIPT_REST_APP_KEY: string;
164
+ MYSCRIPT_REST_HMAC_KEY: string;
165
+ PROBLEM_IMAGE_SIZE_LIMIT: number;
166
+ INTERCOM_APP_ID: string;
167
+ CLARITY_PROJECT_ID: string;
168
+ LOGGLY_CUSTOMER_TOKEN: string;
169
+ };
170
+ type TeachersWebVars = RegionSpecificVars & TeachersWebCommon;
171
+ type TeachersWebVarsPreset = {
172
+ [key in Locale]: {
173
+ [key in Environment]: TeachersWebVars;
174
+ };
175
+ };
176
+
177
+ type DistrictCommon = {
178
+ INTERCOM_APP_ID: string;
179
+ CLARITY_PROJECT_ID: string;
180
+ PROBLEM_IMAGE_SIZE_LIMIT: number;
181
+ };
182
+ type DistrictDashboardVars = Omit<RegionSpecificVars, 'SOCKET_URL'> & DistrictCommon;
183
+ type DistrictWebVarsPreset = {
184
+ [key in Locale]: {
185
+ [key in Environment]: DistrictDashboardVars;
186
+ };
187
+ };
188
+
122
189
  type SSO_UK = {
123
190
  GOOGLE_AUTH: string;
124
191
  MICROSOFT_AUTH: string;
@@ -156,18 +223,6 @@ type Prettify<T> = T extends Function ? T : {
156
223
  [K in keyof T]: T[K];
157
224
  };
158
225
 
159
- type RegionSpecificVars = {
160
- API_URL: string;
161
- AUTH_WEB_URL: string;
162
- CDN_HOST: string;
163
- DISTRICT_WEB_URL: string;
164
- LOGGLY_TAG: string;
165
- MAGMAMATH_URL: string;
166
- SOCKET_URL: string;
167
- STUDENTS_WEB_URL: string;
168
- TEACHERS_WEB_URL: string;
169
- };
170
-
171
226
  type AuthWebVars<T extends SSOVariant> = Prettify<AuthWebBaseVars & T>;
172
227
  type AuthWebBaseVars = Omit<RegionSpecificVars, 'CDN_HOST' | 'LOGGLY_TAG' | 'SOCKET_URL'> & {
173
228
  TOS_URL: string;
@@ -195,61 +250,6 @@ type AuthWebVarsPreset = {
195
250
  };
196
251
  };
197
252
 
198
- type SSOConfig<T extends SSOVariant> = Readonly<{
199
- name: string;
200
- icon: ComponentType<IconProps>;
201
- type: SSO;
202
- loginSource: LoginSource;
203
- ownUrl?: boolean;
204
- getUrl: (envs: AuthWebVars<T>) => string;
205
- }>;
206
-
207
- type StudentsWebCommon = {
208
- GOOGLE_API_KEY: string;
209
- DESMOS_API_KEY: string;
210
- LOGGLY_CUSTOMER_TOKEN: string;
211
- MYSCRIPT_APPLICATION_KEY: string;
212
- MYSCRIPT_HMAC_KEY: string;
213
- MYSCRIPT_HOST: string;
214
- MYSCRIPT_SOCKET_KEY: string;
215
- MYSCRIPT_REST_APP_KEY: string;
216
- MYSCRIPT_REST_HMAC_KEY: string;
217
- };
218
- type StudentsWebVars = RegionSpecificVars & StudentsWebCommon;
219
- type StudentsWebVarsPreset = {
220
- [key in Locale]: {
221
- [key in Environment]: StudentsWebVars;
222
- };
223
- };
224
-
225
- type TeachersWebCommon = {
226
- MYSCRIPT_HOST: string;
227
- MYSCRIPT_REST_APP_KEY: string;
228
- MYSCRIPT_REST_HMAC_KEY: string;
229
- PROBLEM_IMAGE_SIZE_LIMIT: number;
230
- INTERCOM_APP_ID: string;
231
- CLARITY_PROJECT_ID: string;
232
- LOGGLY_CUSTOMER_TOKEN: string;
233
- };
234
- type TeachersWebVars = RegionSpecificVars & TeachersWebCommon;
235
- type TeachersWebVarsPreset = {
236
- [key in Locale]: {
237
- [key in Environment]: TeachersWebVars;
238
- };
239
- };
240
-
241
- type DistrictCommon = {
242
- INTERCOM_APP_ID: string;
243
- CLARITY_PROJECT_ID: string;
244
- PROBLEM_IMAGE_SIZE_LIMIT: number;
245
- };
246
- type DistrictDashboardVars = Omit<RegionSpecificVars, 'SOCKET_URL'> & DistrictCommon;
247
- type DistrictWebVarsPreset = {
248
- [key in Locale]: {
249
- [key in Environment]: DistrictDashboardVars;
250
- };
251
- };
252
-
253
253
  type MobileCommon = {
254
254
  DESMOS_API_KEY: string;
255
255
  USER_AGENT: string;
@@ -434,18 +434,18 @@ type DistrictLocaleConfig = CommonLocaleConfig & {
434
434
  };
435
435
  };
436
436
 
437
- type AuthLocaleConfig<T extends SSOVariant> = {
437
+ type AuthLocaleConfig<E> = {
438
438
  path: string;
439
439
  shortCode: string;
440
440
  icon: ComponentType<IconProps>;
441
441
  sources: {
442
442
  signUp: {
443
- list: SSOConfig<T>[];
443
+ list: SSOConfig<E>[];
444
444
  };
445
445
  signIn: {
446
446
  withOnboarding: boolean;
447
447
  qrCodeSize: QRCodeSize;
448
- list: SSOConfig<T>[];
448
+ list: SSOConfig<E>[];
449
449
  };
450
450
  };
451
451
  isPrimaryRegion: boolean;
@@ -481,13 +481,13 @@ type LocalePreset = {
481
481
  [key in Locale]: DistrictLocaleConfig;
482
482
  };
483
483
  [Platform.AUTH_WEB]: {
484
- [key in Locale]: AuthLocaleConfig<SSOByLocale[key]>;
484
+ [key in Locale]: AuthLocaleConfig<AuthWebVars<SSOByLocale[key]>>;
485
485
  };
486
486
  [Platform.WEB_ADMIN]: {
487
487
  [key in Locale]: WebAdminLocaleConfig;
488
488
  };
489
489
  [Platform.MOBILE]: {
490
- [key in Locale]: AuthLocaleConfig<SSOByLocale[key]>;
490
+ [key in Locale]: AuthLocaleConfig<MobileVars<SSOByLocale[key]>>;
491
491
  };
492
492
  };
493
493
  type LocaleConfig<P extends Platform, L extends Locale> = LocalePreset[P][L];
package/dist/index.d.ts CHANGED
@@ -119,6 +119,73 @@ type IconProps = {
119
119
  size?: number;
120
120
  };
121
121
 
122
+ type SSOConfig<E> = Readonly<{
123
+ name: string;
124
+ icon: ComponentType<IconProps>;
125
+ type: SSO;
126
+ loginSource: LoginSource;
127
+ ownUrl?: boolean;
128
+ getUrl: (envs: E) => string;
129
+ }>;
130
+
131
+ type RegionSpecificVars = {
132
+ API_URL: string;
133
+ AUTH_WEB_URL: string;
134
+ CDN_HOST: string;
135
+ DISTRICT_WEB_URL: string;
136
+ LOGGLY_TAG: string;
137
+ MAGMAMATH_URL: string;
138
+ SOCKET_URL: string;
139
+ STUDENTS_WEB_URL: string;
140
+ TEACHERS_WEB_URL: string;
141
+ };
142
+
143
+ type StudentsWebCommon = {
144
+ GOOGLE_API_KEY: string;
145
+ DESMOS_API_KEY: string;
146
+ LOGGLY_CUSTOMER_TOKEN: string;
147
+ MYSCRIPT_APPLICATION_KEY: string;
148
+ MYSCRIPT_HMAC_KEY: string;
149
+ MYSCRIPT_HOST: string;
150
+ MYSCRIPT_SOCKET_KEY: string;
151
+ MYSCRIPT_REST_APP_KEY: string;
152
+ MYSCRIPT_REST_HMAC_KEY: string;
153
+ };
154
+ type StudentsWebVars = RegionSpecificVars & StudentsWebCommon;
155
+ type StudentsWebVarsPreset = {
156
+ [key in Locale]: {
157
+ [key in Environment]: StudentsWebVars;
158
+ };
159
+ };
160
+
161
+ type TeachersWebCommon = {
162
+ MYSCRIPT_HOST: string;
163
+ MYSCRIPT_REST_APP_KEY: string;
164
+ MYSCRIPT_REST_HMAC_KEY: string;
165
+ PROBLEM_IMAGE_SIZE_LIMIT: number;
166
+ INTERCOM_APP_ID: string;
167
+ CLARITY_PROJECT_ID: string;
168
+ LOGGLY_CUSTOMER_TOKEN: string;
169
+ };
170
+ type TeachersWebVars = RegionSpecificVars & TeachersWebCommon;
171
+ type TeachersWebVarsPreset = {
172
+ [key in Locale]: {
173
+ [key in Environment]: TeachersWebVars;
174
+ };
175
+ };
176
+
177
+ type DistrictCommon = {
178
+ INTERCOM_APP_ID: string;
179
+ CLARITY_PROJECT_ID: string;
180
+ PROBLEM_IMAGE_SIZE_LIMIT: number;
181
+ };
182
+ type DistrictDashboardVars = Omit<RegionSpecificVars, 'SOCKET_URL'> & DistrictCommon;
183
+ type DistrictWebVarsPreset = {
184
+ [key in Locale]: {
185
+ [key in Environment]: DistrictDashboardVars;
186
+ };
187
+ };
188
+
122
189
  type SSO_UK = {
123
190
  GOOGLE_AUTH: string;
124
191
  MICROSOFT_AUTH: string;
@@ -156,18 +223,6 @@ type Prettify<T> = T extends Function ? T : {
156
223
  [K in keyof T]: T[K];
157
224
  };
158
225
 
159
- type RegionSpecificVars = {
160
- API_URL: string;
161
- AUTH_WEB_URL: string;
162
- CDN_HOST: string;
163
- DISTRICT_WEB_URL: string;
164
- LOGGLY_TAG: string;
165
- MAGMAMATH_URL: string;
166
- SOCKET_URL: string;
167
- STUDENTS_WEB_URL: string;
168
- TEACHERS_WEB_URL: string;
169
- };
170
-
171
226
  type AuthWebVars<T extends SSOVariant> = Prettify<AuthWebBaseVars & T>;
172
227
  type AuthWebBaseVars = Omit<RegionSpecificVars, 'CDN_HOST' | 'LOGGLY_TAG' | 'SOCKET_URL'> & {
173
228
  TOS_URL: string;
@@ -195,61 +250,6 @@ type AuthWebVarsPreset = {
195
250
  };
196
251
  };
197
252
 
198
- type SSOConfig<T extends SSOVariant> = Readonly<{
199
- name: string;
200
- icon: ComponentType<IconProps>;
201
- type: SSO;
202
- loginSource: LoginSource;
203
- ownUrl?: boolean;
204
- getUrl: (envs: AuthWebVars<T>) => string;
205
- }>;
206
-
207
- type StudentsWebCommon = {
208
- GOOGLE_API_KEY: string;
209
- DESMOS_API_KEY: string;
210
- LOGGLY_CUSTOMER_TOKEN: string;
211
- MYSCRIPT_APPLICATION_KEY: string;
212
- MYSCRIPT_HMAC_KEY: string;
213
- MYSCRIPT_HOST: string;
214
- MYSCRIPT_SOCKET_KEY: string;
215
- MYSCRIPT_REST_APP_KEY: string;
216
- MYSCRIPT_REST_HMAC_KEY: string;
217
- };
218
- type StudentsWebVars = RegionSpecificVars & StudentsWebCommon;
219
- type StudentsWebVarsPreset = {
220
- [key in Locale]: {
221
- [key in Environment]: StudentsWebVars;
222
- };
223
- };
224
-
225
- type TeachersWebCommon = {
226
- MYSCRIPT_HOST: string;
227
- MYSCRIPT_REST_APP_KEY: string;
228
- MYSCRIPT_REST_HMAC_KEY: string;
229
- PROBLEM_IMAGE_SIZE_LIMIT: number;
230
- INTERCOM_APP_ID: string;
231
- CLARITY_PROJECT_ID: string;
232
- LOGGLY_CUSTOMER_TOKEN: string;
233
- };
234
- type TeachersWebVars = RegionSpecificVars & TeachersWebCommon;
235
- type TeachersWebVarsPreset = {
236
- [key in Locale]: {
237
- [key in Environment]: TeachersWebVars;
238
- };
239
- };
240
-
241
- type DistrictCommon = {
242
- INTERCOM_APP_ID: string;
243
- CLARITY_PROJECT_ID: string;
244
- PROBLEM_IMAGE_SIZE_LIMIT: number;
245
- };
246
- type DistrictDashboardVars = Omit<RegionSpecificVars, 'SOCKET_URL'> & DistrictCommon;
247
- type DistrictWebVarsPreset = {
248
- [key in Locale]: {
249
- [key in Environment]: DistrictDashboardVars;
250
- };
251
- };
252
-
253
253
  type MobileCommon = {
254
254
  DESMOS_API_KEY: string;
255
255
  USER_AGENT: string;
@@ -434,18 +434,18 @@ type DistrictLocaleConfig = CommonLocaleConfig & {
434
434
  };
435
435
  };
436
436
 
437
- type AuthLocaleConfig<T extends SSOVariant> = {
437
+ type AuthLocaleConfig<E> = {
438
438
  path: string;
439
439
  shortCode: string;
440
440
  icon: ComponentType<IconProps>;
441
441
  sources: {
442
442
  signUp: {
443
- list: SSOConfig<T>[];
443
+ list: SSOConfig<E>[];
444
444
  };
445
445
  signIn: {
446
446
  withOnboarding: boolean;
447
447
  qrCodeSize: QRCodeSize;
448
- list: SSOConfig<T>[];
448
+ list: SSOConfig<E>[];
449
449
  };
450
450
  };
451
451
  isPrimaryRegion: boolean;
@@ -481,13 +481,13 @@ type LocalePreset = {
481
481
  [key in Locale]: DistrictLocaleConfig;
482
482
  };
483
483
  [Platform.AUTH_WEB]: {
484
- [key in Locale]: AuthLocaleConfig<SSOByLocale[key]>;
484
+ [key in Locale]: AuthLocaleConfig<AuthWebVars<SSOByLocale[key]>>;
485
485
  };
486
486
  [Platform.WEB_ADMIN]: {
487
487
  [key in Locale]: WebAdminLocaleConfig;
488
488
  };
489
489
  [Platform.MOBILE]: {
490
- [key in Locale]: AuthLocaleConfig<SSOByLocale[key]>;
490
+ [key in Locale]: AuthLocaleConfig<MobileVars<SSOByLocale[key]>>;
491
491
  };
492
492
  };
493
493
  type LocaleConfig<P extends Platform, L extends Locale> = LocalePreset[P][L];
package/dist/index.js CHANGED
@@ -2317,7 +2317,7 @@ var GoogleIcon = ({ size = 38 }) => {
2317
2317
  ] });
2318
2318
  };
2319
2319
 
2320
- // src/configs/sso/auth-web/sso.google.ts
2320
+ // src/configs/sso/sso.google.ts
2321
2321
  var SSO_GOOGLE_CONFIG = {
2322
2322
  name: "Google",
2323
2323
  type: "GOOGLE" /* GOOGLE */,
@@ -2334,7 +2334,7 @@ var MicrosoftIcon = ({ size = 38 }) => {
2334
2334
  ] });
2335
2335
  };
2336
2336
 
2337
- // src/configs/sso/auth-web/sso.microsoft.ts
2337
+ // src/configs/sso/sso.microsoft.ts
2338
2338
  var SSO_MICROSOFT_CONFIG = {
2339
2339
  name: "Microsoft",
2340
2340
  type: "MICROSOFT" /* MICROSOFT */,
@@ -2362,7 +2362,7 @@ var ClasslinkIcon = ({ size = 38 }) => {
2362
2362
  ] });
2363
2363
  };
2364
2364
 
2365
- // src/configs/sso/auth-web/sso.classlink.ts
2365
+ // src/configs/sso/sso.classlink.ts
2366
2366
  var SSO_CLASSLINK_CONFIG = {
2367
2367
  name: "Classlink",
2368
2368
  type: "CLASS_LINK" /* CLASS_LINK */,
@@ -2396,7 +2396,7 @@ var SchoologyIcon = ({ size = 37.5 }) => {
2396
2396
  ] });
2397
2397
  };
2398
2398
 
2399
- // src/configs/sso/auth-web/sso.schoology.ts
2399
+ // src/configs/sso/sso.schoology.ts
2400
2400
  var SSO_SCHOOLOGY_CONFIG = {
2401
2401
  name: "Schoology",
2402
2402
  type: "SCHOOLOGY" /* SCHOOLOGY */,
@@ -2423,7 +2423,7 @@ var CleverIcon = ({ size = 37.5 }) => {
2423
2423
  ] });
2424
2424
  };
2425
2425
 
2426
- // src/configs/sso/auth-web/sso.clever.ts
2426
+ // src/configs/sso/sso.clever.ts
2427
2427
  var SSO_CLEVER_CONFIG = {
2428
2428
  name: "Clever",
2429
2429
  type: "CLEVER" /* CLEVER */,
@@ -2463,7 +2463,7 @@ var CanvasIcon = ({ size = 38 }) => /* @__PURE__ */ jsxRuntime.jsx(Svg__default.
2463
2463
  }
2464
2464
  ) }) });
2465
2465
 
2466
- // src/configs/sso/auth-web/sso.canvas.ts
2466
+ // src/configs/sso/sso.canvas.ts
2467
2467
  var SSO_CANVAS_CONFIG = {
2468
2468
  name: "Canvas",
2469
2469
  type: "CANVAS" /* CANVAS */,
@@ -2481,7 +2481,7 @@ var QRCodeIcon = ({ size = 38 }) => {
2481
2481
  ) });
2482
2482
  };
2483
2483
 
2484
- // src/configs/sso/auth-web/sso.qrcode.ts
2484
+ // src/configs/sso/sso.qrcode.ts
2485
2485
  var SSO_QR_CODE_CONFIG = {
2486
2486
  name: "QR Code",
2487
2487
  type: "QR_CODE" /* QR_CODE */,
@@ -2545,7 +2545,7 @@ var SkolonIcon = ({ size = 38 }) => {
2545
2545
  ] });
2546
2546
  };
2547
2547
 
2548
- // src/configs/sso/auth-web/sso.skolon.ts
2548
+ // src/configs/sso/sso.skolon.ts
2549
2549
  var SSO_SKOLON_CONFIG = {
2550
2550
  name: "Skolon",
2551
2551
  type: "SKOLON" /* SKOLON */,
@@ -2572,7 +2572,7 @@ var SkolfederationIcon = ({ size = 38 }) => {
2572
2572
  ] });
2573
2573
  };
2574
2574
 
2575
- // src/configs/sso/auth-web/sso.skolfederation.ts
2575
+ // src/configs/sso/sso.skolfederation.ts
2576
2576
  var SSO_SKOLFEDERATION_CONFIG = {
2577
2577
  name: "Skolfederation",
2578
2578
  type: "SKOLFEDERATION" /* SKOLFEDERATION */,
@@ -2632,7 +2632,7 @@ var WondeIcon = ({ size = 38 }) => {
2632
2632
  ) });
2633
2633
  };
2634
2634
 
2635
- // src/configs/sso/auth-web/sso.wonde.ts
2635
+ // src/configs/sso/sso.wonde.ts
2636
2636
  var SSO_WONDE_CONFIG = {
2637
2637
  name: "Mylogin",
2638
2638
  type: "WONDE" /* WONDE */,
@@ -2886,7 +2886,7 @@ var AppleIcon = ({ size = 38 }) => /* @__PURE__ */ jsxRuntime.jsxs(Svg__default.
2886
2886
  /* @__PURE__ */ jsxRuntime.jsx(Svg.Defs, { children: /* @__PURE__ */ jsxRuntime.jsx(Svg.ClipPath, { id: "clip0_5168_15698", children: /* @__PURE__ */ jsxRuntime.jsx(Svg.Path, { fill: "#fff", transform: "translate(.451 .5)", d: "M0 0H87.098V107H0z" }) }) })
2887
2887
  ] });
2888
2888
 
2889
- // src/configs/sso/mobile/sso.apple.ts
2889
+ // src/configs/sso/sso.apple.ts
2890
2890
  var SSO_APPLE_CONFIG = {
2891
2891
  name: "Apple",
2892
2892
  type: "APPLE" /* APPLE */,
@@ -2944,7 +2944,7 @@ var LOCALE_MOBILE_SE = {
2944
2944
  ]
2945
2945
  },
2946
2946
  signUp: {
2947
- list: [SSO_GOOGLE_CONFIG, SSO_APPLE_CONFIG, SSO_MICROSOFT_CONFIG]
2947
+ list: [SSO_GOOGLE_CONFIG, SSO_APPLE_CONFIG, SSO_MICROSOFT_CONFIG, SSO_SKOLFEDERATION_CONFIG]
2948
2948
  }
2949
2949
  },
2950
2950
  isPrimaryRegion: true,