@frontegg/types 5.60.0 → 6.0.1-alpha.1

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.
Files changed (197) hide show
  1. package/CheckoutDialogOptions.d.ts +6 -6
  2. package/CheckoutDialogOptions.js +1 -0
  3. package/Common.d.ts +6 -6
  4. package/Common.js +1 -0
  5. package/ContextOptions.d.ts +31 -31
  6. package/ContextOptions.js +1 -0
  7. package/CustomComponents.d.ts +19 -19
  8. package/CustomComponents.js +1 -0
  9. package/FronteggAppInstance.d.ts +23 -23
  10. package/FronteggAppInstance.js +1 -0
  11. package/FronteggAppOptions.d.ts +76 -76
  12. package/FronteggAppOptions.js +1 -0
  13. package/FronteggMetadata.d.ts +88 -88
  14. package/FronteggMetadata.js +1 -0
  15. package/FronteggStoreOptions.d.ts +13 -13
  16. package/FronteggStoreOptions.js +1 -0
  17. package/Localizations/AdminPortalLocalizations/accountSettings.d.ts +216 -216
  18. package/Localizations/AdminPortalLocalizations/accountSettings.js +1 -0
  19. package/Localizations/AdminPortalLocalizations/allUsers.d.ts +275 -275
  20. package/Localizations/AdminPortalLocalizations/allUsers.js +1 -0
  21. package/Localizations/AdminPortalLocalizations/apiTokens.d.ts +137 -137
  22. package/Localizations/AdminPortalLocalizations/apiTokens.js +1 -0
  23. package/Localizations/AdminPortalLocalizations/auditLogs.d.ts +51 -51
  24. package/Localizations/AdminPortalLocalizations/auditLogs.js +1 -0
  25. package/Localizations/AdminPortalLocalizations/index.d.ts +29 -29
  26. package/Localizations/AdminPortalLocalizations/index.js +15 -0
  27. package/Localizations/AdminPortalLocalizations/navigation.d.ts +85 -85
  28. package/Localizations/AdminPortalLocalizations/navigation.js +1 -0
  29. package/Localizations/AdminPortalLocalizations/personalTokens.d.ts +117 -117
  30. package/Localizations/AdminPortalLocalizations/personalTokens.js +1 -0
  31. package/Localizations/AdminPortalLocalizations/privacy.d.ts +182 -182
  32. package/Localizations/AdminPortalLocalizations/privacy.js +1 -0
  33. package/Localizations/AdminPortalLocalizations/profile.d.ts +243 -243
  34. package/Localizations/AdminPortalLocalizations/profile.js +1 -0
  35. package/Localizations/AdminPortalLocalizations/roles.d.ts +88 -88
  36. package/Localizations/AdminPortalLocalizations/roles.js +1 -0
  37. package/Localizations/AdminPortalLocalizations/security.d.ts +182 -182
  38. package/Localizations/AdminPortalLocalizations/security.js +1 -0
  39. package/Localizations/AdminPortalLocalizations/sso.d.ts +398 -398
  40. package/Localizations/AdminPortalLocalizations/sso.js +1 -0
  41. package/Localizations/AdminPortalLocalizations/subscriptions.d.ts +252 -252
  42. package/Localizations/AdminPortalLocalizations/subscriptions.js +1 -0
  43. package/Localizations/AdminPortalLocalizations/users.d.ts +288 -288
  44. package/Localizations/AdminPortalLocalizations/users.js +1 -0
  45. package/Localizations/AdminPortalLocalizations/webhooks.d.ts +157 -157
  46. package/Localizations/AdminPortalLocalizations/webhooks.js +1 -0
  47. package/Localizations/LocalizationOverrides.d.ts +21 -21
  48. package/Localizations/LocalizationOverrides.js +1 -0
  49. package/Localizations/LocalizationType.d.ts +45 -45
  50. package/Localizations/LocalizationType.js +1 -0
  51. package/Localizations/LoginBoxLocalization/SplitPageTypes/index.d.ts +25 -25
  52. package/Localizations/LoginBoxLocalization/SplitPageTypes/index.js +1 -0
  53. package/Localizations/LoginBoxLocalization/acceptInvitation.d.ts +31 -31
  54. package/Localizations/LoginBoxLocalization/acceptInvitation.js +1 -0
  55. package/Localizations/LoginBoxLocalization/activateAccount.d.ts +79 -79
  56. package/Localizations/LoginBoxLocalization/activateAccount.js +1 -0
  57. package/Localizations/LoginBoxLocalization/forgetPassword.d.ts +35 -35
  58. package/Localizations/LoginBoxLocalization/forgetPassword.js +1 -0
  59. package/Localizations/LoginBoxLocalization/index.d.ts +20 -20
  60. package/Localizations/LoginBoxLocalization/index.js +11 -0
  61. package/Localizations/LoginBoxLocalization/login.d.ts +307 -307
  62. package/Localizations/LoginBoxLocalization/login.js +1 -0
  63. package/Localizations/LoginBoxLocalization/recoveryMfa.d.ts +23 -23
  64. package/Localizations/LoginBoxLocalization/recoveryMfa.js +1 -0
  65. package/Localizations/LoginBoxLocalization/resetPassword.d.ts +67 -67
  66. package/Localizations/LoginBoxLocalization/resetPassword.js +1 -0
  67. package/Localizations/LoginBoxLocalization/resetPhoneNumber.d.ts +34 -34
  68. package/Localizations/LoginBoxLocalization/resetPhoneNumber.js +1 -0
  69. package/Localizations/LoginBoxLocalization/signup.d.ts +186 -186
  70. package/Localizations/LoginBoxLocalization/signup.js +1 -0
  71. package/Localizations/LoginBoxLocalization/socialLogins.d.ts +34 -34
  72. package/Localizations/LoginBoxLocalization/socialLogins.js +1 -0
  73. package/Localizations/index.d.ts +4 -4
  74. package/Localizations/index.js +4 -0
  75. package/Localizations/package.json +6 -0
  76. package/Metadata/colorManipulator.d.ts +73 -73
  77. package/Metadata/colorManipulator.js +186 -0
  78. package/Metadata/getPalette.d.ts +3 -3
  79. package/Metadata/getPalette.js +58 -0
  80. package/Metadata/index.d.ts +15 -15
  81. package/Metadata/index.js +126 -0
  82. package/Metadata/package.json +6 -0
  83. package/PrivateOptions.d.ts +25 -25
  84. package/PrivateOptions.js +1 -0
  85. package/ThemeOptions/AdminPortalThemeOptions.d.ts +84 -84
  86. package/ThemeOptions/AdminPortalThemeOptions.js +16 -0
  87. package/ThemeOptions/BreakpointsOptions.d.ts +17 -17
  88. package/ThemeOptions/BreakpointsOptions.js +1 -0
  89. package/ThemeOptions/ComponentsOptions.d.ts +751 -751
  90. package/ThemeOptions/ComponentsOptions.js +2 -0
  91. package/ThemeOptions/LoginBoxTheme/AcceptInvitationTheme.d.ts +21 -21
  92. package/ThemeOptions/LoginBoxTheme/AcceptInvitationTheme.js +1 -0
  93. package/ThemeOptions/LoginBoxTheme/ActivateAccountPageTheme.d.ts +51 -51
  94. package/ThemeOptions/LoginBoxTheme/ActivateAccountPageTheme.js +1 -0
  95. package/ThemeOptions/LoginBoxTheme/CustomLoginComponents.d.ts +12 -12
  96. package/ThemeOptions/LoginBoxTheme/CustomLoginComponents.js +1 -0
  97. package/ThemeOptions/LoginBoxTheme/ForgotPasswordTheme.d.ts +45 -45
  98. package/ThemeOptions/LoginBoxTheme/ForgotPasswordTheme.js +1 -0
  99. package/ThemeOptions/LoginBoxTheme/LoaderTheme.d.ts +7 -7
  100. package/ThemeOptions/LoginBoxTheme/LoaderTheme.js +1 -0
  101. package/ThemeOptions/LoginBoxTheme/LoginBoxCommon.d.ts +226 -226
  102. package/ThemeOptions/LoginBoxTheme/LoginBoxCommon.js +1 -0
  103. package/ThemeOptions/LoginBoxTheme/LoginPageTheme.d.ts +136 -136
  104. package/ThemeOptions/LoginBoxTheme/LoginPageTheme.js +1 -0
  105. package/ThemeOptions/LoginBoxTheme/ResetPasswordTheme.d.ts +47 -47
  106. package/ThemeOptions/LoginBoxTheme/ResetPasswordTheme.js +1 -0
  107. package/ThemeOptions/LoginBoxTheme/ResetPhoneNumberTheme.d.ts +71 -71
  108. package/ThemeOptions/LoginBoxTheme/ResetPhoneNumberTheme.js +1 -0
  109. package/ThemeOptions/LoginBoxTheme/SignupPageTheme.d.ts +95 -95
  110. package/ThemeOptions/LoginBoxTheme/SignupPageTheme.js +1 -0
  111. package/ThemeOptions/LoginBoxTheme/SocialLoginsTheme.d.ts +64 -64
  112. package/ThemeOptions/LoginBoxTheme/SocialLoginsTheme.js +1 -0
  113. package/ThemeOptions/LoginBoxTheme/index.d.ts +53 -53
  114. package/ThemeOptions/LoginBoxTheme/index.js +11 -0
  115. package/ThemeOptions/LoginBoxThemeOptions.d.ts +46 -46
  116. package/ThemeOptions/LoginBoxThemeOptions.js +1 -0
  117. package/ThemeOptions/Palette.d.ts +85 -85
  118. package/ThemeOptions/Palette.js +1 -0
  119. package/ThemeOptions/Shadows.d.ts +1 -1
  120. package/ThemeOptions/Shadows.js +1 -0
  121. package/ThemeOptions/SpacingOptions.d.ts +9 -9
  122. package/ThemeOptions/SpacingOptions.js +1 -0
  123. package/ThemeOptions/TransitionsOptions.d.ts +23 -23
  124. package/ThemeOptions/TransitionsOptions.js +1 -0
  125. package/ThemeOptions/TypographyOptions.d.ts +13 -13
  126. package/ThemeOptions/TypographyOptions.js +1 -0
  127. package/ThemeOptions/index.d.ts +41 -41
  128. package/ThemeOptions/index.js +3 -0
  129. package/ThemeOptions/package.json +6 -0
  130. package/index.d.ts +7 -7
  131. package/index.js +12 -444
  132. package/node/CheckoutDialogOptions.js +5 -0
  133. package/node/Common.js +5 -0
  134. package/node/ContextOptions.js +5 -0
  135. package/node/CustomComponents.js +5 -0
  136. package/node/FronteggAppInstance.js +5 -0
  137. package/node/FronteggAppOptions.js +5 -0
  138. package/node/FronteggMetadata.js +5 -0
  139. package/node/FronteggStoreOptions.js +5 -0
  140. package/node/Localizations/AdminPortalLocalizations/accountSettings.js +5 -0
  141. package/node/Localizations/AdminPortalLocalizations/allUsers.js +5 -0
  142. package/node/Localizations/AdminPortalLocalizations/apiTokens.js +5 -0
  143. package/node/Localizations/AdminPortalLocalizations/auditLogs.js +5 -0
  144. package/node/Localizations/AdminPortalLocalizations/index.js +187 -0
  145. package/node/Localizations/AdminPortalLocalizations/navigation.js +5 -0
  146. package/node/Localizations/AdminPortalLocalizations/personalTokens.js +5 -0
  147. package/node/Localizations/AdminPortalLocalizations/privacy.js +5 -0
  148. package/node/Localizations/AdminPortalLocalizations/profile.js +5 -0
  149. package/node/Localizations/AdminPortalLocalizations/roles.js +5 -0
  150. package/node/Localizations/AdminPortalLocalizations/security.js +5 -0
  151. package/node/Localizations/AdminPortalLocalizations/sso.js +5 -0
  152. package/node/Localizations/AdminPortalLocalizations/subscriptions.js +5 -0
  153. package/node/Localizations/AdminPortalLocalizations/users.js +5 -0
  154. package/node/Localizations/AdminPortalLocalizations/webhooks.js +5 -0
  155. package/node/Localizations/LocalizationOverrides.js +5 -0
  156. package/node/Localizations/LocalizationType.js +5 -0
  157. package/node/Localizations/LoginBoxLocalization/SplitPageTypes/index.js +5 -0
  158. package/node/Localizations/LoginBoxLocalization/acceptInvitation.js +5 -0
  159. package/node/Localizations/LoginBoxLocalization/activateAccount.js +5 -0
  160. package/node/Localizations/LoginBoxLocalization/forgetPassword.js +5 -0
  161. package/node/Localizations/LoginBoxLocalization/index.js +135 -0
  162. package/node/Localizations/LoginBoxLocalization/login.js +5 -0
  163. package/node/Localizations/LoginBoxLocalization/recoveryMfa.js +5 -0
  164. package/node/Localizations/LoginBoxLocalization/resetPassword.js +5 -0
  165. package/node/Localizations/LoginBoxLocalization/resetPhoneNumber.js +5 -0
  166. package/node/Localizations/LoginBoxLocalization/signup.js +5 -0
  167. package/node/Localizations/LoginBoxLocalization/socialLogins.js +5 -0
  168. package/node/Localizations/index.js +57 -0
  169. package/node/Metadata/colorManipulator.js +210 -0
  170. package/node/Metadata/getPalette.js +70 -0
  171. package/node/Metadata/index.js +140 -0
  172. package/node/PrivateOptions.js +5 -0
  173. package/node/ThemeOptions/AdminPortalThemeOptions.js +23 -0
  174. package/node/ThemeOptions/BreakpointsOptions.js +5 -0
  175. package/node/ThemeOptions/ComponentsOptions.js +6 -0
  176. package/node/ThemeOptions/LoginBoxTheme/AcceptInvitationTheme.js +5 -0
  177. package/node/ThemeOptions/LoginBoxTheme/ActivateAccountPageTheme.js +5 -0
  178. package/node/ThemeOptions/LoginBoxTheme/CustomLoginComponents.js +5 -0
  179. package/node/ThemeOptions/LoginBoxTheme/ForgotPasswordTheme.js +5 -0
  180. package/node/ThemeOptions/LoginBoxTheme/LoaderTheme.js +5 -0
  181. package/node/ThemeOptions/LoginBoxTheme/LoginBoxCommon.js +5 -0
  182. package/node/ThemeOptions/LoginBoxTheme/LoginPageTheme.js +5 -0
  183. package/node/ThemeOptions/LoginBoxTheme/ResetPasswordTheme.js +5 -0
  184. package/node/ThemeOptions/LoginBoxTheme/ResetPhoneNumberTheme.js +5 -0
  185. package/node/ThemeOptions/LoginBoxTheme/SignupPageTheme.js +5 -0
  186. package/node/ThemeOptions/LoginBoxTheme/SocialLoginsTheme.js +5 -0
  187. package/node/ThemeOptions/LoginBoxTheme/index.js +135 -0
  188. package/node/ThemeOptions/LoginBoxThemeOptions.js +5 -0
  189. package/node/ThemeOptions/Palette.js +5 -0
  190. package/node/ThemeOptions/Shadows.js +5 -0
  191. package/node/ThemeOptions/SpacingOptions.js +5 -0
  192. package/node/ThemeOptions/TransitionsOptions.js +5 -0
  193. package/node/ThemeOptions/TypographyOptions.js +5 -0
  194. package/node/ThemeOptions/index.js +31 -0
  195. package/node/index.js +101 -446
  196. package/package.json +8 -5
  197. package/ThemeOptions/helpers.d.ts +0 -0
@@ -1,6 +1,6 @@
1
- export interface FronteggCheckoutDialogOptions {
2
- plan?: string;
3
- onClose?: () => void;
4
- onSuccess?: () => void;
5
- onError?: (msg: string) => void;
6
- }
1
+ export interface FronteggCheckoutDialogOptions {
2
+ plan?: string;
3
+ onClose?: () => void;
4
+ onSuccess?: () => void;
5
+ onError?: (msg: string) => void;
6
+ }
@@ -0,0 +1 @@
1
+ export {};
package/Common.d.ts CHANGED
@@ -1,6 +1,6 @@
1
- import * as CSS from 'csstype';
2
- export declare type CSSProperties = CSS.Properties;
3
- export declare type Color = CSSProperties['color'];
4
- export declare type ExtendedCSSProperties = CSSProperties | {
5
- [k in string]?: CSSProperties;
6
- };
1
+ import * as CSS from 'csstype';
2
+ export declare type CSSProperties = CSS.Properties;
3
+ export declare type Color = CSSProperties['color'];
4
+ export declare type ExtendedCSSProperties = CSSProperties | {
5
+ [k in string]?: CSSProperties;
6
+ };
package/Common.js ADDED
@@ -0,0 +1 @@
1
+ export {};
@@ -1,31 +1,31 @@
1
- import { KeyValuePair, LogLevel } from '@frontegg/rest-api';
2
- export interface ContextOptions {
3
- /**
4
- * Backend API baseUrl, visit https://portal.frontegg.com/administration/domain to get your Frontegg baseUrl
5
- */
6
- baseUrl: string | ((url: string) => string);
7
- /**
8
- * Frontegg clientId. Identifier from your Frontegg workspace account.
9
- */
10
- clientId?: string;
11
- /**
12
- * Whether or not to send Fetch request with Credentials to the Backend
13
- * default: 'include'
14
- */
15
- requestCredentials?: RequestCredentials;
16
- tokenResolver?: () => Promise<string> | string;
17
- additionalQueryParamsResolver?: () => Promise<KeyValuePair[]> | KeyValuePair[];
18
- additionalHeadersResolver?: () => Promise<KeyValuePair[]> | KeyValuePair[];
19
- currentUserRoles?: string[];
20
- urlPrefix?: string;
21
- /**
22
- * @deprecated
23
- */
24
- logLevel?: LogLevel;
25
- /**
26
- * @deprecated, use auditsOptions.* and not contextOptions.auditsOptions
27
- */
28
- auditsOptions?: {
29
- virtualScroll?: boolean;
30
- };
31
- }
1
+ import { KeyValuePair, LogLevel } from '@frontegg/rest-api';
2
+ export interface ContextOptions {
3
+ /**
4
+ * Backend API baseUrl, visit https://portal.frontegg.com/administration/domain to get your Frontegg baseUrl
5
+ */
6
+ baseUrl: string | ((url: string) => string);
7
+ /**
8
+ * Frontegg clientId. Identifier from your Frontegg workspace account.
9
+ */
10
+ clientId?: string;
11
+ /**
12
+ * Whether or not to send Fetch request with Credentials to the Backend
13
+ * default: 'include'
14
+ */
15
+ requestCredentials?: RequestCredentials;
16
+ tokenResolver?: () => Promise<string> | string;
17
+ additionalQueryParamsResolver?: () => Promise<KeyValuePair[]> | KeyValuePair[];
18
+ additionalHeadersResolver?: () => Promise<KeyValuePair[]> | KeyValuePair[];
19
+ currentUserRoles?: string[];
20
+ urlPrefix?: string;
21
+ /**
22
+ * @deprecated
23
+ */
24
+ logLevel?: LogLevel;
25
+ /**
26
+ * @deprecated, use auditsOptions.* and not contextOptions.auditsOptions
27
+ */
28
+ auditsOptions?: {
29
+ virtualScroll?: boolean;
30
+ };
31
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -1,19 +1,19 @@
1
- export interface AuthPageCustomComponents {
2
- customHeader?: any;
3
- customDivider?: any;
4
- footer?: any;
5
- customTopBar?: any;
6
- icons?: {
7
- iconWidth?: string;
8
- googleIcon?: any;
9
- githubIcon?: any;
10
- facebookIcon?: any;
11
- microsoftIcon?: any;
12
- };
13
- content?: {
14
- googleText?: string;
15
- githubText?: string;
16
- facebookText?: string;
17
- microsoftText?: string;
18
- };
19
- }
1
+ export interface AuthPageCustomComponents {
2
+ customHeader?: any;
3
+ customDivider?: any;
4
+ footer?: any;
5
+ customTopBar?: any;
6
+ icons?: {
7
+ iconWidth?: string;
8
+ googleIcon?: any;
9
+ githubIcon?: any;
10
+ facebookIcon?: any;
11
+ microsoftIcon?: any;
12
+ };
13
+ content?: {
14
+ googleText?: string;
15
+ githubText?: string;
16
+ facebookText?: string;
17
+ microsoftText?: string;
18
+ };
19
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -1,23 +1,23 @@
1
- import { EnhancedStore } from '@frontegg/redux-store';
2
- import { FronteggAppOptions, FronteggCheckoutDialogOptions, LocalizationsOverrides } from './index';
3
- export interface FronteggAppInstance {
4
- name: string;
5
- iframeRendering: boolean;
6
- loading: boolean;
7
- customElementName: string;
8
- store: EnhancedStore;
9
- adminPortalEl?: HTMLElement;
10
- loginBoxEl?: HTMLElement;
11
- checkoutDialogEl?: HTMLElement;
12
- adminPortalContainer?: HTMLElement;
13
- loginBoxContainer?: HTMLElement;
14
- checkoutDialogContainer?: HTMLElement;
15
- options: FronteggAppOptions;
16
- updateMetadata: (metadata: FronteggAppOptions['metadata']) => void;
17
- updateLocalizationsSetter: (localizationUpdateFn: (localizations: LocalizationsOverrides) => void) => void;
18
- showAdminPortal: () => void;
19
- hideAdminPortal: () => void;
20
- showCheckoutDialog: (opts: FronteggCheckoutDialogOptions) => void;
21
- hideCheckoutDialog: () => void;
22
- close: () => void;
23
- }
1
+ import { EnhancedStore } from '@frontegg/redux-store';
2
+ import { FronteggAppOptions, FronteggCheckoutDialogOptions, LocalizationsOverrides } from './index';
3
+ export interface FronteggAppInstance {
4
+ name: string;
5
+ iframeRendering: boolean;
6
+ loading: boolean;
7
+ customElementName: string;
8
+ store: EnhancedStore;
9
+ adminPortalEl?: HTMLElement;
10
+ loginBoxEl?: HTMLElement;
11
+ checkoutDialogEl?: HTMLElement;
12
+ adminPortalContainer?: HTMLElement;
13
+ loginBoxContainer?: HTMLElement;
14
+ checkoutDialogContainer?: HTMLElement;
15
+ options: FronteggAppOptions;
16
+ updateMetadata: (metadata: FronteggAppOptions['metadata']) => void;
17
+ updateLocalizationsSetter: (localizationUpdateFn: (localizations: LocalizationsOverrides) => void) => void;
18
+ showAdminPortal: () => void;
19
+ hideAdminPortal: () => void;
20
+ showCheckoutDialog: (opts: FronteggCheckoutDialogOptions) => void;
21
+ hideCheckoutDialog: () => void;
22
+ close: () => void;
23
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -1,76 +1,76 @@
1
- import { FronteggThemeOptions } from './ThemeOptions';
2
- import { FronteggMetadata } from './FronteggMetadata';
3
- import { ContextOptions } from './ContextOptions';
4
- import { FronteggStoreOptions } from './FronteggStoreOptions';
5
- import { LocalizationsOverrides } from './Localizations';
6
- import { CustomEventsOptions } from '@frontegg/redux-store';
7
- import { PrivateOptions } from './PrivateOptions';
8
- export interface FronteggAppOptions extends FronteggStoreOptions, PrivateOptions {
9
- withCompanyName?: boolean;
10
- contextOptions: ContextOptions;
11
- events?: CustomEventsOptions;
12
- themeOptions?: FronteggThemeOptions;
13
- /**
14
- * Authentication background logo image
15
- * @deprecated, use themeOptions.loginBox.rootStyle.background
16
- */
17
- backgroundImage?: string;
18
- /**
19
- * Authentication background logo image
20
- * @deprecated, use themeOptions.loginBox.logo.image from @LogoComponent
21
- */
22
- headerImage?: string;
23
- /**
24
- * pass true to customLoginBox to prevent loading LoginBox and implement authentication pages with @frontegg/react-hooks
25
- */
26
- customLoginBox?: boolean;
27
- /**
28
- * pass true to hostedLoginBox if you are using frontegg hosted login
29
- */
30
- hostedLoginBox?: boolean;
31
- /**
32
- * Option to override Frontegg loader visibility. LoginBox will call this function when
33
- * the full page loader mounted and unmounted, for override and display custom loader
34
- *
35
- * ```tsx
36
- * // App.tsx
37
- *
38
- * export const App = ()=>{
39
- * const [loading, setLoading] = useState(true);
40
- *
41
- * return <>
42
- * <FronteggProvider customLoader={setLoading}>
43
- * <YourAppComponent />
44
- * </FronteggProvider>
45
- *
46
- * {loading && <MyCustomLoaderComponent />}
47
- * </>
48
- * }
49
- * ```
50
- */
51
- customLoader?: boolean | ((loading: boolean) => void);
52
- /**
53
- * Inline CSS styles for native override styles
54
- */
55
- customStyles?: string;
56
- /**
57
- * Global metadata object to customize Admin Portal
58
- */
59
- metadata?: FronteggMetadata;
60
- /**
61
- * Base name for LoginBox router
62
- */
63
- basename?: string;
64
- /**
65
- * Set url strategy to use for LoginBox router
66
- */
67
- urlStrategy?: 'path' | 'hash';
68
- /**
69
- * Option to override i18n localizations in AdminPortal and LoginBox components
70
- */
71
- localizations?: LocalizationsOverrides;
72
- /**
73
- * Option to support tracing from the Frontegg login box
74
- */
75
- tracing?: boolean;
76
- }
1
+ import { FronteggThemeOptions } from './ThemeOptions';
2
+ import { FronteggMetadata } from './FronteggMetadata';
3
+ import { ContextOptions } from './ContextOptions';
4
+ import { FronteggStoreOptions } from './FronteggStoreOptions';
5
+ import { LocalizationsOverrides } from './Localizations';
6
+ import { CustomEventsOptions } from '@frontegg/redux-store';
7
+ import { PrivateOptions } from './PrivateOptions';
8
+ export interface FronteggAppOptions extends FronteggStoreOptions, PrivateOptions {
9
+ withCompanyName?: boolean;
10
+ contextOptions: ContextOptions;
11
+ events?: CustomEventsOptions;
12
+ themeOptions?: FronteggThemeOptions;
13
+ /**
14
+ * Authentication background logo image
15
+ * @deprecated, use themeOptions.loginBox.rootStyle.background
16
+ */
17
+ backgroundImage?: string;
18
+ /**
19
+ * Authentication background logo image
20
+ * @deprecated, use themeOptions.loginBox.logo.image from @LogoComponent
21
+ */
22
+ headerImage?: string;
23
+ /**
24
+ * pass true to customLoginBox to prevent loading LoginBox and implement authentication pages with @frontegg/react-hooks
25
+ */
26
+ customLoginBox?: boolean;
27
+ /**
28
+ * pass true to hostedLoginBox if you are using frontegg hosted login
29
+ */
30
+ hostedLoginBox?: boolean;
31
+ /**
32
+ * Option to override Frontegg loader visibility. LoginBox will call this function when
33
+ * the full page loader mounted and unmounted, for override and display custom loader
34
+ *
35
+ * ```tsx
36
+ * // App.tsx
37
+ *
38
+ * export const App = ()=>{
39
+ * const [loading, setLoading] = useState(true);
40
+ *
41
+ * return <>
42
+ * <FronteggProvider customLoader={setLoading}>
43
+ * <YourAppComponent />
44
+ * </FronteggProvider>
45
+ *
46
+ * {loading && <MyCustomLoaderComponent />}
47
+ * </>
48
+ * }
49
+ * ```
50
+ */
51
+ customLoader?: boolean | ((loading: boolean) => void);
52
+ /**
53
+ * Inline CSS styles for native override styles
54
+ */
55
+ customStyles?: string;
56
+ /**
57
+ * Global metadata object to customize Admin Portal
58
+ */
59
+ metadata?: FronteggMetadata;
60
+ /**
61
+ * Base name for LoginBox router
62
+ */
63
+ basename?: string;
64
+ /**
65
+ * Set url strategy to use for LoginBox router
66
+ */
67
+ urlStrategy?: 'path' | 'hash';
68
+ /**
69
+ * Option to override i18n localizations in AdminPortal and LoginBox components
70
+ */
71
+ localizations?: LocalizationsOverrides;
72
+ /**
73
+ * Option to support tracing from the Frontegg login box
74
+ */
75
+ tracing?: boolean;
76
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -1,88 +1,88 @@
1
- import { PaletteColorOptions, PaletteGreyOptions } from './ThemeOptions/Palette';
2
- import { FronteggThemeOptions } from './ThemeOptions';
3
- import { LocalizationsOverrides } from './Localizations';
4
- declare type PageMetadata = {
5
- visibility: 'hidden' | 'always' | 'byPermissions';
6
- featureFlag?: string;
7
- permissions?: RolePermission[];
8
- };
9
- interface ProfileMetadata extends PageMetadata {
10
- }
11
- interface PrivacyMetadata extends PageMetadata {
12
- }
13
- interface UsageMetadata extends PageMetadata {
14
- }
15
- interface AccountMetadata extends PageMetadata {
16
- }
17
- export interface UsersInviteDialogMetadata {
18
- phoneNumberField?: 'optional' | 'mandatory' | boolean;
19
- }
20
- export interface UsersMetadata extends PageMetadata {
21
- inviteDialog?: UsersInviteDialogMetadata;
22
- }
23
- export interface AllUsersMetadata extends PageMetadata {
24
- }
25
- interface RolesMetadata extends PageMetadata {
26
- }
27
- interface SecurityMetadata extends PageMetadata {
28
- }
29
- interface SsoMetadata extends PageMetadata {
30
- }
31
- interface MultipleSsoMetadata extends PageMetadata {
32
- }
33
- interface AuditsMetadata extends PageMetadata {
34
- paginationMode?: 'virtual' | 'pages';
35
- }
36
- interface WebhooksMetadata extends PageMetadata {
37
- }
38
- interface ApiTokensMetadata extends PageMetadata {
39
- }
40
- interface SubscriptionsMetadata extends PageMetadata {
41
- }
42
- export declare type NavigationMetadata = {
43
- profile?: ProfileMetadata;
44
- privacy?: PrivacyMetadata;
45
- usage?: UsageMetadata;
46
- account?: AccountMetadata;
47
- users?: UsersMetadata;
48
- allUsers?: AllUsersMetadata;
49
- roles?: RolesMetadata;
50
- security?: SecurityMetadata;
51
- sso?: SsoMetadata;
52
- multipleSSO?: MultipleSsoMetadata;
53
- audits?: AuditsMetadata;
54
- webhooks?: WebhooksMetadata;
55
- apiTokens?: ApiTokensMetadata;
56
- personalApiTokens?: ApiTokensMetadata;
57
- subscriptions?: SubscriptionsMetadata;
58
- };
59
- declare type PaletteOptions = {
60
- primary?: PaletteColorOptions;
61
- secondary?: PaletteColorOptions;
62
- danger?: PaletteColorOptions;
63
- info?: PaletteColorOptions;
64
- success?: PaletteColorOptions;
65
- warning?: PaletteColorOptions;
66
- error?: PaletteColorOptions;
67
- grey?: PaletteGreyOptions;
68
- loader?: string;
69
- };
70
- declare type BreakpointsOptions = {
71
- xs: number;
72
- sm: number;
73
- md: number;
74
- lg: number;
75
- xl: number;
76
- };
77
- declare type ThemeMetadata = {
78
- palette?: PaletteOptions;
79
- breakpoints?: BreakpointsOptions;
80
- };
81
- export declare type FronteggMetadata = {
82
- theme?: ThemeMetadata;
83
- themeV2?: FronteggThemeOptions;
84
- navigation?: NavigationMetadata;
85
- localizations?: LocalizationsOverrides;
86
- };
87
- export declare type RolePermission = 'fe.connectivity.*' | 'fe.connectivity.delete.*' | 'fe.connectivity.delete.bellNotifications' | 'fe.connectivity.delete.emailConfig' | 'fe.connectivity.delete.slackAppRegistration' | 'fe.connectivity.delete.slackSubscriptionEvent' | 'fe.connectivity.delete.slackSubscriptions' | 'fe.connectivity.delete.smsConfig' | 'fe.connectivity.delete.webhook' | 'fe.connectivity.read.*' | 'fe.connectivity.read.emailConfig' | 'fe.connectivity.read.eventCategories' | 'fe.connectivity.read.events' | 'fe.connectivity.read.slackApp' | 'fe.connectivity.read.slackChannels' | 'fe.connectivity.read.slackSubscriptions' | 'fe.connectivity.read.slackUsers' | 'fe.connectivity.read.smsConfig' | 'fe.connectivity.read.userBellNotifications' | 'fe.connectivity.read.webhookLogs' | 'fe.connectivity.read.webhooks' | 'fe.connectivity.write.*' | 'fe.connectivity.write.emailConfig' | 'fe.connectivity.write.sendWebpushNotification' | 'fe.connectivity.write.slackAppRegistration' | 'fe.connectivity.write.slackSubscriptions' | 'fe.connectivity.write.smsConfig' | 'fe.connectivity.write.subscribeWebpush' | 'fe.connectivity.write.triggerEvent' | 'fe.connectivity.write.updateSlackSubscription' | 'fe.connectivity.write.updateUserBellNotification' | 'fe.connectivity.write.webhook' | 'fe.secure.*' | 'fe.secure.delete.*' | 'fe.secure.delete.role' | 'fe.secure.delete.samlConfiguration' | 'fe.secure.delete.securityPolicy' | 'fe.secure.delete.tenantApiTokens' | 'fe.secure.delete.userApiTokens' | 'fe.secure.delete.users' | 'fe.secure.delete.usersRoles' | 'fe.secure.read.*' | 'fe.secure.read.permissions' | 'fe.secure.read.roles' | 'fe.secure.read.samlConfiguration' | 'fe.secure.read.securityPolicy' | 'fe.secure.read.tenantApiTokens' | 'fe.secure.read.userApiTokens' | 'fe.secure.read.users' | 'fe.secure.write.*' | 'fe.secure.write.resendActivationEmail' | 'fe.secure.write.roles' | 'fe.secure.write.samlConfiguration' | 'fe.secure.write.securityPolicy' | 'fe.secure.write.tenantApiTokens' | 'fe.secure.write.updateRole' | 'fe.secure.write.updateUser' | 'fe.secure.write.userApiTokens' | 'fe.secure.write.users' | 'fe.secure.write.usersRoles' | 'fe.subscriptions.*' | 'fe.subscriptions.read.*' | 'fe.subscriptions.write.*' | 'fe.account-settings.delete.account';
88
- export {};
1
+ import { PaletteColorOptions, PaletteGreyOptions } from './ThemeOptions/Palette';
2
+ import { FronteggThemeOptions } from './ThemeOptions';
3
+ import { LocalizationsOverrides } from './Localizations';
4
+ declare type PageMetadata = {
5
+ visibility: 'hidden' | 'always' | 'byPermissions';
6
+ featureFlag?: string;
7
+ permissions?: RolePermission[];
8
+ };
9
+ interface ProfileMetadata extends PageMetadata {
10
+ }
11
+ interface PrivacyMetadata extends PageMetadata {
12
+ }
13
+ interface UsageMetadata extends PageMetadata {
14
+ }
15
+ interface AccountMetadata extends PageMetadata {
16
+ }
17
+ export interface UsersInviteDialogMetadata {
18
+ phoneNumberField?: 'optional' | 'mandatory' | boolean;
19
+ }
20
+ export interface UsersMetadata extends PageMetadata {
21
+ inviteDialog?: UsersInviteDialogMetadata;
22
+ }
23
+ export interface AllUsersMetadata extends PageMetadata {
24
+ }
25
+ interface RolesMetadata extends PageMetadata {
26
+ }
27
+ interface SecurityMetadata extends PageMetadata {
28
+ }
29
+ interface SsoMetadata extends PageMetadata {
30
+ }
31
+ interface MultipleSsoMetadata extends PageMetadata {
32
+ }
33
+ interface AuditsMetadata extends PageMetadata {
34
+ paginationMode?: 'virtual' | 'pages';
35
+ }
36
+ interface WebhooksMetadata extends PageMetadata {
37
+ }
38
+ interface ApiTokensMetadata extends PageMetadata {
39
+ }
40
+ interface SubscriptionsMetadata extends PageMetadata {
41
+ }
42
+ export declare type NavigationMetadata = {
43
+ profile?: ProfileMetadata;
44
+ privacy?: PrivacyMetadata;
45
+ usage?: UsageMetadata;
46
+ account?: AccountMetadata;
47
+ users?: UsersMetadata;
48
+ allUsers?: AllUsersMetadata;
49
+ roles?: RolesMetadata;
50
+ security?: SecurityMetadata;
51
+ sso?: SsoMetadata;
52
+ multipleSSO?: MultipleSsoMetadata;
53
+ audits?: AuditsMetadata;
54
+ webhooks?: WebhooksMetadata;
55
+ apiTokens?: ApiTokensMetadata;
56
+ personalApiTokens?: ApiTokensMetadata;
57
+ subscriptions?: SubscriptionsMetadata;
58
+ };
59
+ declare type PaletteOptions = {
60
+ primary?: PaletteColorOptions;
61
+ secondary?: PaletteColorOptions;
62
+ danger?: PaletteColorOptions;
63
+ info?: PaletteColorOptions;
64
+ success?: PaletteColorOptions;
65
+ warning?: PaletteColorOptions;
66
+ error?: PaletteColorOptions;
67
+ grey?: PaletteGreyOptions;
68
+ loader?: string;
69
+ };
70
+ declare type BreakpointsOptions = {
71
+ xs: number;
72
+ sm: number;
73
+ md: number;
74
+ lg: number;
75
+ xl: number;
76
+ };
77
+ declare type ThemeMetadata = {
78
+ palette?: PaletteOptions;
79
+ breakpoints?: BreakpointsOptions;
80
+ };
81
+ export declare type FronteggMetadata = {
82
+ theme?: ThemeMetadata;
83
+ themeV2?: FronteggThemeOptions;
84
+ navigation?: NavigationMetadata;
85
+ localizations?: LocalizationsOverrides;
86
+ };
87
+ export declare type RolePermission = 'fe.connectivity.*' | 'fe.connectivity.delete.*' | 'fe.connectivity.delete.bellNotifications' | 'fe.connectivity.delete.emailConfig' | 'fe.connectivity.delete.slackAppRegistration' | 'fe.connectivity.delete.slackSubscriptionEvent' | 'fe.connectivity.delete.slackSubscriptions' | 'fe.connectivity.delete.smsConfig' | 'fe.connectivity.delete.webhook' | 'fe.connectivity.read.*' | 'fe.connectivity.read.emailConfig' | 'fe.connectivity.read.eventCategories' | 'fe.connectivity.read.events' | 'fe.connectivity.read.slackApp' | 'fe.connectivity.read.slackChannels' | 'fe.connectivity.read.slackSubscriptions' | 'fe.connectivity.read.slackUsers' | 'fe.connectivity.read.smsConfig' | 'fe.connectivity.read.userBellNotifications' | 'fe.connectivity.read.webhookLogs' | 'fe.connectivity.read.webhooks' | 'fe.connectivity.write.*' | 'fe.connectivity.write.emailConfig' | 'fe.connectivity.write.sendWebpushNotification' | 'fe.connectivity.write.slackAppRegistration' | 'fe.connectivity.write.slackSubscriptions' | 'fe.connectivity.write.smsConfig' | 'fe.connectivity.write.subscribeWebpush' | 'fe.connectivity.write.triggerEvent' | 'fe.connectivity.write.updateSlackSubscription' | 'fe.connectivity.write.updateUserBellNotification' | 'fe.connectivity.write.webhook' | 'fe.secure.*' | 'fe.secure.delete.*' | 'fe.secure.delete.role' | 'fe.secure.delete.samlConfiguration' | 'fe.secure.delete.securityPolicy' | 'fe.secure.delete.tenantApiTokens' | 'fe.secure.delete.userApiTokens' | 'fe.secure.delete.users' | 'fe.secure.delete.usersRoles' | 'fe.secure.read.*' | 'fe.secure.read.permissions' | 'fe.secure.read.roles' | 'fe.secure.read.samlConfiguration' | 'fe.secure.read.securityPolicy' | 'fe.secure.read.tenantApiTokens' | 'fe.secure.read.userApiTokens' | 'fe.secure.read.users' | 'fe.secure.write.*' | 'fe.secure.write.resendActivationEmail' | 'fe.secure.write.roles' | 'fe.secure.write.samlConfiguration' | 'fe.secure.write.securityPolicy' | 'fe.secure.write.tenantApiTokens' | 'fe.secure.write.updateRole' | 'fe.secure.write.updateUser' | 'fe.secure.write.userApiTokens' | 'fe.secure.write.users' | 'fe.secure.write.usersRoles' | 'fe.subscriptions.*' | 'fe.subscriptions.read.*' | 'fe.subscriptions.write.*' | 'fe.account-settings.delete.account';
88
+ export {};
@@ -0,0 +1 @@
1
+ export {};
@@ -1,13 +1,13 @@
1
- import { AuditsState, AuthState, AuthPageRoutes } from '@frontegg/redux-store';
2
- export interface AuthOptions extends Partial<Omit<AuthState, 'routes'>> {
3
- keepSessionAlive?: boolean;
4
- includeQueryParam?: boolean;
5
- routes?: Partial<AuthPageRoutes>;
6
- }
7
- export interface AuditsOptions extends Partial<AuditsState> {
8
- virtualScroll?: boolean;
9
- }
10
- export interface FronteggStoreOptions {
11
- authOptions?: AuthOptions;
12
- auditsOptions?: AuditsOptions;
13
- }
1
+ import { AuditsState, AuthState, AuthPageRoutes } from '@frontegg/redux-store';
2
+ export interface AuthOptions extends Partial<Omit<AuthState, 'routes'>> {
3
+ keepSessionAlive?: boolean;
4
+ includeQueryParam?: boolean;
5
+ routes?: Partial<AuthPageRoutes>;
6
+ }
7
+ export interface AuditsOptions extends Partial<AuditsState> {
8
+ virtualScroll?: boolean;
9
+ }
10
+ export interface FronteggStoreOptions {
11
+ authOptions?: AuthOptions;
12
+ auditsOptions?: AuditsOptions;
13
+ }
@@ -0,0 +1 @@
1
+ export {};