@frontegg/types 6.0.3-alpha.3 → 6.2.0

package/FronteggAppOptions.d.ts

@@ -6,6 +6,10 @@ import { LocalizationsOverrides } from './Localizations';
 import { CustomEventsOptions } from '@frontegg/redux-store';
 import { PrivateOptions } from './PrivateOptions';
 export interface FronteggAppOptions extends FronteggStoreOptions, PrivateOptions {
+    /**
+     * use this flag if you want to hide the field "Company name" from the sign up form
+     @deprecated, use themeOptions.loginBox.signup.hideSignUpFields.hideCompanyName
+     */
     withCompanyName?: boolean;
     contextOptions: ContextOptions;
     events?: CustomEventsOptions;

package/Localizations/LoginBoxLocalization/socialLogins.d.ts

@@ -34,19 +34,19 @@ export interface SocialLoginsLocalization {
          */
         socialactivationButtonTextPrefix: string;
         /**
-         * Deprecated
+         * @Deprecated
          * Text to be display in socialLogin buttons if rendering inside login section
          * Ex: 'Continue with {{providerName}}'
          */
         loginButtonText: string;
         /**
-         * Deprecated
+         * @Deprecated
          * Text to be display in socialLogin buttons if rendering inside signup section
          * Ex: 'Login with {{providerName}}'
          */
         signupButtonText: string;
         /**
-         * Deprecated
+         * @Deprecated
          * Text to be display in socialLogin buttons if rendering inside activation section
          * Ex: 'Sign up with {{providerName}}'
          */

package/Metadata/colorManipulator.js

@@ -1,6 +1,19 @@
+/**
+ * Returns a number whose value is limited to the given range.
+ * @param {number} value The value to be clamped
+ * @param {number} min The lower boundary of the output range
+ * @param {number} max The upper boundary of the output range
+ * @returns {number} A number in the range [min, max]
+ */
 function clamp(value, min = 0, max = 1) {
   return Math.min(Math.max(min, value), max);
 }
+/**
+ * Converts a color from CSS hex format to CSS rgb format.
+ * @param {string} color - Hex color, i.e. #nnn or #nnnnnn
+ * @returns {string} A CSS rgb color string
+ */
+
 
 export function hexToRgb(color) {
   color = color.substr(1);
@@ -20,8 +33,17 @@ function intToHex(int) {
   const hex = int.toString(16);
   return hex.length === 1 ? `0${hex}` : hex;
 }
+/**
+ * Returns an object with the type and values of a color.
+ *
+ * Note: Does not support rgb % values.
+ * @param {string} color - CSS color, i.e. one of: #nnn, #nnnnnn, rgb(), rgba(), hsl(), hsla()
+ * @returns {object} - A MUI color object: {type: string, values: number[]}
+ */
+
 
 export function decomposeColor(color) {
+  // Idempotent
   if (color.type) {
     return color;
   }
@@ -62,6 +84,14 @@ export function decomposeColor(color) {
     colorSpace
   };
 }
+/**
+ * Converts a color object with type and values to a string.
+ * @param {object} color - Decomposed color
+ * @param {string} color.type - One of: 'rgb', 'rgba', 'hsl', 'hsla'
+ * @param {array} color.values - [n,n,n] or [n,n,n,n]
+ * @returns {string} A CSS color string
+ */
+
 export function recomposeColor(color) {
   const {
     type,
@@ -72,6 +102,7 @@ export function recomposeColor(color) {
   } = color;
 
   if (type.indexOf('rgb') !== -1) {
+    // Only convert the first 3 values to int (i.e. not alpha)
     values = values.map((n, i) => i < 3 ? parseInt(n, 10) : n);
   } else if (type.indexOf('hsl') !== -1) {
     values[1] = `${values[1]}%`;
@@ -86,7 +117,14 @@ export function recomposeColor(color) {
 
   return `${type}(${values})`;
 }
+/**
+ * Converts a color from CSS rgb format to CSS hex format.
+ * @param {string} color - RGB color, i.e. rgb(n, n, n)
+ * @returns {string} A CSS rgb color string, i.e. #nnnnnn
+ */
+
 export function rgbToHex(color) {
+  // Idempotent
   if (color.indexOf('#') === 0) {
     return color;
   }
@@ -96,6 +134,12 @@ export function rgbToHex(color) {
   } = decomposeColor(color);
   return `#${values.map((n, i) => intToHex(i === 3 ? Math.round(255 * n) : n)).join('')}`;
 }
+/**
+ * Converts a color from hsl format to rgb format.
+ * @param {string} color - HSL color values
+ * @returns {string} rgb color values
+ */
+
 export function hslToRgb(color) {
   color = decomposeColor(color);
   const {
@@ -121,18 +165,36 @@ export function hslToRgb(color) {
     values: rgb
   });
 }
+/**
+ * The relative brightness of any point in a color space,
+ * normalized to 0 for darkest black and 1 for lightest white.
+ *
+ * Formula: https://www.w3.org/TR/WCAG20-TECHS/G17.html#G17-tests
+ * @param {string} color - CSS color, i.e. one of: #nnn, #nnnnnn, rgb(), rgba(), hsl(), hsla(), color()
+ * @returns {number} The relative brightness of the color in the range 0 - 1
+ */
+
 export function getLuminance(color) {
   color = decomposeColor(color);
   let rgb = color.type === 'hsl' ? decomposeColor(hslToRgb(color)).values : color.values;
   rgb = rgb.map(val => {
     if (color.type !== 'color') {
-      val /= 255;
+      val /= 255; // normalized
     }
 
     return val <= 0.03928 ? val / 12.92 : ((val + 0.055) / 1.055) ** 2.4;
-  });
+  }); // Truncate at 3 digits
+
   return Number((0.2126 * rgb[0] + 0.7152 * rgb[1] + 0.0722 * rgb[2]).toFixed(3));
 }
+/**
+ * Sets the absolute transparency of a color.
+ * Any existing alpha values are overwritten.
+ * @param {string} color - CSS color, i.e. one of: #nnn, #nnnnnn, rgb(), rgba(), hsl(), hsla(), color()
+ * @param {number} value - value to set the alpha channel to in the range 0 - 1
+ * @returns {string} A CSS color string. Hex input values are returned as rgb
+ */
+
 export function alpha(color, value) {
   color = decomposeColor(color);
   value = clamp(value);
@@ -149,6 +211,13 @@ export function alpha(color, value) {
 
   return recomposeColor(color);
 }
+/**
+ * Darkens a color.
+ * @param {string} color - CSS color, i.e. one of: #nnn, #nnnnnn, rgb(), rgba(), hsl(), hsla(), color()
+ * @param {number} coefficient - multiplier in the range 0 - 1
+ * @returns {string} A CSS color string. Hex input values are returned as rgb
+ */
+
 export function darken(color, coefficient) {
   color = decomposeColor(color);
   coefficient = clamp(coefficient);
@@ -163,6 +232,13 @@ export function darken(color, coefficient) {
 
   return recomposeColor(color);
 }
+/**
+ * Lightens a color.
+ * @param {string} color - CSS color, i.e. one of: #nnn, #nnnnnn, rgb(), rgba(), hsl(), hsla(), color()
+ * @param {number} coefficient - multiplier in the range 0 - 1
+ * @returns {string} A CSS color string. Hex input values are returned as rgb
+ */
+
 export function lighten(color, coefficient) {
   color = decomposeColor(color);
   coefficient = clamp(coefficient);
@@ -181,6 +257,14 @@ export function lighten(color, coefficient) {
 
   return recomposeColor(color);
 }
+/**
+ * Darken or lighten a color, depending on its luminance.
+ * Light colors are darkened, dark colors are lightened.
+ * @param {string} color - CSS color, i.e. one of: #nnn, #nnnnnn, rgb(), rgba(), hsl(), hsla(), color()
+ * @param {number} coefficient=0.15 - multiplier in the range 0 - 1
+ * @returns {string} A CSS color string. Hex input values are returned as rgb
+ */
+
 export function emphasize(color, coefficient = 0.15) {
   return getLuminance(color) > 0.5 ? darken(color, coefficient) : lighten(color, coefficient);
 }

package/PrivateOptions.d.ts

@@ -1,5 +1,5 @@
 import { RedirectOptions } from '@frontegg/rest-api';
-import { EnhancedStore } from '@reduxjs/toolkit';
+import { EnhancedStore } from '@frontegg/redux-store';
 export interface PrivateOptions {
     /**
      * Option to open admin portal as Preview mode without HTTP requests for demo mode purpose

package/ThemeOptions/LoginBoxTheme/SignupPageTheme.d.ts

@@ -92,6 +92,12 @@ export interface SignupPageComponentsTheme {
      * use this flag if you want to hide the sign up form and use only SSO or social sign ups
      */
     hideSignUpForm?: boolean;
+    /**
+     * use this flag if you want to hide the field "Company name" from the sign up form
+     */
+    hideSignUpFields?: {
+        hideCompanyName?: boolean;
+    };
 }
 export interface SignupPageThemeOptions extends LoginBoxCommonThemeOptions, SignupPageComponentsTheme {
 }

package/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v6.0.3-alpha.3
+/** @license Frontegg v6.2.0
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.

package/node/Metadata/colorManipulator.js

@@ -14,9 +14,22 @@ exports.lighten = lighten;
 exports.recomposeColor = recomposeColor;
 exports.rgbToHex = rgbToHex;
 
+/**
+ * Returns a number whose value is limited to the given range.
+ * @param {number} value The value to be clamped
+ * @param {number} min The lower boundary of the output range
+ * @param {number} max The upper boundary of the output range
+ * @returns {number} A number in the range [min, max]
+ */
 function clamp(value, min = 0, max = 1) {
   return Math.min(Math.max(min, value), max);
 }
+/**
+ * Converts a color from CSS hex format to CSS rgb format.
+ * @param {string} color - Hex color, i.e. #nnn or #nnnnnn
+ * @returns {string} A CSS rgb color string
+ */
+
 
 function hexToRgb(color) {
   color = color.substr(1);
@@ -36,8 +49,17 @@ function intToHex(int) {
   const hex = int.toString(16);
   return hex.length === 1 ? `0${hex}` : hex;
 }
+/**
+ * Returns an object with the type and values of a color.
+ *
+ * Note: Does not support rgb % values.
+ * @param {string} color - CSS color, i.e. one of: #nnn, #nnnnnn, rgb(), rgba(), hsl(), hsla()
+ * @returns {object} - A MUI color object: {type: string, values: number[]}
+ */
+
 
 function decomposeColor(color) {
+  // Idempotent
   if (color.type) {
     return color;
   }
@@ -78,6 +100,14 @@ function decomposeColor(color) {
     colorSpace
   };
 }
+/**
+ * Converts a color object with type and values to a string.
+ * @param {object} color - Decomposed color
+ * @param {string} color.type - One of: 'rgb', 'rgba', 'hsl', 'hsla'
+ * @param {array} color.values - [n,n,n] or [n,n,n,n]
+ * @returns {string} A CSS color string
+ */
+
 
 function recomposeColor(color) {
   const {
@@ -89,6 +119,7 @@ function recomposeColor(color) {
   } = color;
 
   if (type.indexOf('rgb') !== -1) {
+    // Only convert the first 3 values to int (i.e. not alpha)
     values = values.map((n, i) => i < 3 ? parseInt(n, 10) : n);
   } else if (type.indexOf('hsl') !== -1) {
     values[1] = `${values[1]}%`;
@@ -103,8 +134,15 @@ function recomposeColor(color) {
 
   return `${type}(${values})`;
 }
+/**
+ * Converts a color from CSS rgb format to CSS hex format.
+ * @param {string} color - RGB color, i.e. rgb(n, n, n)
+ * @returns {string} A CSS rgb color string, i.e. #nnnnnn
+ */
+
 
 function rgbToHex(color) {
+  // Idempotent
   if (color.indexOf('#') === 0) {
     return color;
   }
@@ -114,6 +152,12 @@ function rgbToHex(color) {
   } = decomposeColor(color);
   return `#${values.map((n, i) => intToHex(i === 3 ? Math.round(255 * n) : n)).join('')}`;
 }
+/**
+ * Converts a color from hsl format to rgb format.
+ * @param {string} color - HSL color values
+ * @returns {string} rgb color values
+ */
+
 
 function hslToRgb(color) {
   color = decomposeColor(color);
@@ -140,19 +184,37 @@ function hslToRgb(color) {
     values: rgb
   });
 }
+/**
+ * The relative brightness of any point in a color space,
+ * normalized to 0 for darkest black and 1 for lightest white.
+ *
+ * Formula: https://www.w3.org/TR/WCAG20-TECHS/G17.html#G17-tests
+ * @param {string} color - CSS color, i.e. one of: #nnn, #nnnnnn, rgb(), rgba(), hsl(), hsla(), color()
+ * @returns {number} The relative brightness of the color in the range 0 - 1
+ */
+
 
 function getLuminance(color) {
   color = decomposeColor(color);
   let rgb = color.type === 'hsl' ? decomposeColor(hslToRgb(color)).values : color.values;
   rgb = rgb.map(val => {
     if (color.type !== 'color') {
-      val /= 255;
+      val /= 255; // normalized
     }
 
     return val <= 0.03928 ? val / 12.92 : ((val + 0.055) / 1.055) ** 2.4;
-  });
+  }); // Truncate at 3 digits
+
   return Number((0.2126 * rgb[0] + 0.7152 * rgb[1] + 0.0722 * rgb[2]).toFixed(3));
 }
+/**
+ * Sets the absolute transparency of a color.
+ * Any existing alpha values are overwritten.
+ * @param {string} color - CSS color, i.e. one of: #nnn, #nnnnnn, rgb(), rgba(), hsl(), hsla(), color()
+ * @param {number} value - value to set the alpha channel to in the range 0 - 1
+ * @returns {string} A CSS color string. Hex input values are returned as rgb
+ */
+
 
 function alpha(color, value) {
   color = decomposeColor(color);
@@ -170,6 +232,13 @@ function alpha(color, value) {
 
   return recomposeColor(color);
 }
+/**
+ * Darkens a color.
+ * @param {string} color - CSS color, i.e. one of: #nnn, #nnnnnn, rgb(), rgba(), hsl(), hsla(), color()
+ * @param {number} coefficient - multiplier in the range 0 - 1
+ * @returns {string} A CSS color string. Hex input values are returned as rgb
+ */
+
 
 function darken(color, coefficient) {
   color = decomposeColor(color);
@@ -185,6 +254,13 @@ function darken(color, coefficient) {
 
   return recomposeColor(color);
 }
+/**
+ * Lightens a color.
+ * @param {string} color - CSS color, i.e. one of: #nnn, #nnnnnn, rgb(), rgba(), hsl(), hsla(), color()
+ * @param {number} coefficient - multiplier in the range 0 - 1
+ * @returns {string} A CSS color string. Hex input values are returned as rgb
+ */
+
 
 function lighten(color, coefficient) {
   color = decomposeColor(color);
@@ -204,6 +280,14 @@ function lighten(color, coefficient) {
 
   return recomposeColor(color);
 }
+/**
+ * Darken or lighten a color, depending on its luminance.
+ * Light colors are darkened, dark colors are lightened.
+ * @param {string} color - CSS color, i.e. one of: #nnn, #nnnnnn, rgb(), rgba(), hsl(), hsla(), color()
+ * @param {number} coefficient=0.15 - multiplier in the range 0 - 1
+ * @returns {string} A CSS color string. Hex input values are returned as rgb
+ */
+
 
 function emphasize(color, coefficient = 0.15) {
   return getLuminance(color) > 0.5 ? darken(color, coefficient) : lighten(color, coefficient);

package/node/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v6.0.3-alpha.3
+/** @license Frontegg v6.2.0
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@frontegg/types",
-  "version": "6.0.3-alpha.3",
+  "version": "6.2.0",
   "main": "./node/index.js",
   "author": "Frontegg LTD",
   "license": "MIT",
   "dependencies": {
     "@babel/runtime": "^7.17.2",
-    "@frontegg/redux-store": "6.0.3-alpha.3",
+    "@frontegg/redux-store": "6.2.0",
     "csstype": "^3.0.9",
     "deepmerge": "^4.2.2"
   },