@7shifts/sous-chef 3.87.0-beta.1 → 3.87.0

package/dist/actions/Button/Button.d.ts

@@ -3,9 +3,11 @@ import type { ButtonTheme, ButtonSize, ButtonType, ButtonTarget } from './types'
 import type { PositionStyles, DataProps } from '../../foundation/types';
 declare const Button: React.ForwardRefExoticComponent<{
     children: React.ReactNode;
+    /** Native HTML button type. If `submit` it will trigger the form `onSubmit`. */
     type?: ButtonType | undefined;
-    /** It controls the button theme */
+    /** Button design theme */
     theme?: ButtonTheme | undefined;
+    /** It turns the disabled state of the button on. */
     disabled?: boolean | undefined;
     onClick?: React.MouseEventHandler<Element> | undefined;
     onMouseEnter?: React.MouseEventHandler<Element> | undefined;
@@ -14,10 +16,19 @@ declare const Button: React.ForwardRefExoticComponent<{
     onFocus?: React.FocusEventHandler<Element> | undefined;
     onKeyDown?: React.KeyboardEventHandler<Element> | undefined;
     id?: string | undefined;
+    /** It turns the loading state of the button on. */
     loading?: boolean | undefined;
     /** This will show a black tooltip when the user hover the button */
     title?: string | React.ReactNode;
+    /**
+     * @description It will show a black tooltip when the user hover the button.
+     * @category Acting as Link
+     */
     href?: string | undefined;
+    /**
+     * @description It will open the link in a new tab or the same tab depending on the value.
+     * @category Acting as Link
+     */
     target?: ButtonTarget | undefined;
     testId?: string | undefined;
     /**

package/dist/actions/PaginationControls/PaginationControls.d.ts

@@ -1,11 +1,16 @@
 import React from 'react';
 import { DataProps } from '../../foundation/types';
 type Props = {
+    /** It will enable or disable the `Previous` button. */
     hasPrevious?: boolean;
+    /** It will enable or disable the `Next` button. */
     hasNext?: boolean;
+    /** It will be fired when the `Previous` button is clicked */
     onPreviousClick: () => void;
+    /** It will be fired when the `Next` button is clicked */
     onNextClick: () => void;
     testId?: string;
+    /** It is a target element that will be scrolled to the top when the buttons are clicked */
     scrollTarget?: React.RefObject<HTMLElement>;
 } & DataProps;
 /**

package/dist/core/SousChefProvider/context/ProviderConfigContext.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 import { CountryCode } from 'libphonenumber-js';
 import { TimeFormat } from '../../../forms/TimeField/types';
 export type ProviderConfigContextType = {

package/dist/feedback/InlineBanner/InlineBanner.d.ts

@@ -3,12 +3,19 @@ import { InlineBannerTheme } from './types';
 import { PositionStyles } from '../../foundation/types';
 type Props = {
     children: React.ReactNode;
+    /** Banner design theme */
     theme?: InlineBannerTheme;
+    /** Overrides the default icon determined by the theme. Generally you should not use this prop in order to maintain visual consistency between banner colours and icons. It is recommended to only use icons that are already in Sous Chef. */
     icon?: React.ReactElement;
+    /** It adds a title to the banner and changes the banner format to multi-line */
     title?: string;
+    /** It is the callback function to close the banner */
     onClose?: () => void;
+    /** It describes the CTA options */
     caption?: React.ReactNode;
+    /** It is the primary CTA button */
     primaryButton?: React.ReactElement;
+    /** It is the secondary CTA button */
     secondaryButton?: React.ReactElement;
     testId?: string;
 } & PositionStyles;

package/dist/feedback/MicroBanner/MicroBanner.d.ts

@@ -1,13 +1,19 @@
 import React from 'react';
 import { MicroBannerTheme } from './types';
+import { PositionStyles } from 'foundation/types';
 type Props = {
     children?: React.ReactNode;
+    /** Banner design theme */
     theme?: MicroBannerTheme;
+    /** Overrides the default icon determined by the theme. Generally you should not use this prop in order to maintain visual consistency between banner colours and icons. It is recommended to only use icons that are already in Sous Chef. */
     icon?: React.ReactElement;
+    /** Turns off the display of the icon */
     hideIcon?: boolean;
+    /** Adds a title to the banner above the body content */
     title?: string;
+    /** The primary CTA button */
     primaryButton?: React.ReactElement;
     testId?: string;
-};
+} & PositionStyles;
 declare const MicroBanner: React.FC<Props>;
 export default MicroBanner;

package/dist/forms/PhoneField/usePhoneField.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 import { RefType } from '../../utils/types';
 import type { Props } from './PhoneField';
 type UseTextFieldProps = Props & {

package/dist/forms/SelectField/useSelectField.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 import type { Props } from './SelectField';
 import { CustomComponentsExtraProps } from './types';
 export declare const useSelectField: <T extends unknown>({ asToolbarFilter, caption, disabled, error, id, isClearable, label, menuShouldScrollIntoView, name, noOptionsMessage, options, onBlur, onChange, placeholder, value, defaultValue, CustomOption: UserCustomOption, SelectedOptionPrefix, testId, creatableButton, onCreate, isSearchable, autoFocus, ...rest }: Props<T>) => {

package/dist/forms/TextField/useTextField.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 import { RefType } from '../../utils/types';
 import type { Props } from './TextField';
 import type { DataProps } from '../../foundation/types';

package/dist/forms/hooks/useDateFieldControllers.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 type FieldControls = {
     id: string;
     error?: React.ReactNode;

package/dist/forms/hooks/useMultiSelectFieldControllers.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 import type { SelectOption } from '../SelectField/types';
 type FieldControls<T> = {
     id: string;

package/dist/forms/hooks/usePhoneFieldControllers.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 import { CountryCode } from 'libphonenumber-js';
 type FieldControls = {
     id: string;

package/dist/forms/hooks/useRangeFieldControllers.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 type FieldControls<T> = {
     id: string;
     error?: React.ReactNode;

package/dist/forms/hooks/useSelectFieldControllers.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 import type { SelectOption } from '../SelectField/types';
 type FieldControls<T> = {
     id: string;

package/dist/foundation/tokens/color/color-constants.d.ts

@@ -162,6 +162,9 @@ export declare const COLORS: {
     readonly 'warning-on-container-variant': "var(--color-warning-on-container-variant)";
     readonly 'shadow-overlay': "var(--color-shadow-overlay)";
     readonly 'shadow-active': "var(--color-shadow-active)";
+    readonly 'hover-inverse': "var(--color-hover-inverse)";
+    readonly 'hover-lighten': "var(--color-hover-lighten)";
+    readonly 'hover-darken': "var(--color-hover-darken)";
     readonly 'brand-neutrals-caviar-dynamic': "var(--color-brand-neutrals-caviar-dynamic)";
     readonly 'brand-neutrals-chefscoat-dynamic': "var(--color-brand-neutrals-chefscoat-dynamic)";
 };

package/dist/foundation/tokens/color/color-types.d.ts

@@ -1 +1 @@
-export type Color = 'white' | 'black' | 'tangerine-100' | 'tangerine-200' | 'tangerine-300' | 'tangerine-400' | 'tangerine-500' | 'tangerine-600' | 'eggplant-100' | 'eggplant-200' | 'eggplant-300' | 'eggplant-400' | 'eggplant-500' | 'eggplant-600' | 'mint-100' | 'mint-200' | 'mint-300' | 'mint-400' | 'mint-500' | 'mint-600' | 'radish-100' | 'radish-200' | 'radish-300' | 'radish-400' | 'radish-500' | 'radish-600' | 'blueberry-100' | 'blueberry-200' | 'blueberry-300' | 'blueberry-400' | 'blueberry-500' | 'blueberry-600' | 'banana-100' | 'banana-200' | 'banana-300' | 'banana-400' | 'banana-500' | 'banana-600' | 'grey-100' | 'grey-200' | 'grey-300' | 'grey-400' | 'grey-500' | 'grey-600' | 'oat-100' | 'oat-200' | 'oat-300' | 'oat-400' | 'oat-500' | 'oat-600' | 'lime-100' | 'lime-200' | 'lime-300' | 'lime-400' | 'lime-500' | 'lime-600' | 'blackberry-100' | 'blackberry-200' | 'blackberry-300' | 'blackberry-400' | 'blackberry-500' | 'blackberry-600' | 'neutral-color' | 'neutral-on-color' | 'neutral-container' | 'neutral-on-container' | 'neutral-container-variant' | 'neutral-on-container-variant' | 'neutral-black-transparent-05' | 'neutral-black-transparent-10' | 'neutral-black-transparent-15' | 'neutral-black-transparent-20' | 'neutral-black-transparent-30' | 'neutral-black-transparent-40' | 'neutral-black-transparent-50' | 'neutral-black-transparent-60' | 'neutral-black-transparent-70' | 'neutral-black-transparent-80' | 'neutral-black-transparent-90' | 'neutral-white-transparent-05' | 'neutral-white-transparent-10' | 'neutral-white-transparent-15' | 'neutral-white-transparent-20' | 'neutral-white-transparent-30' | 'neutral-white-transparent-40' | 'neutral-white-transparent-50' | 'neutral-white-transparent-60' | 'neutral-white-transparent-70' | 'neutral-white-transparent-80' | 'neutral-white-transparent-90' | 'surface-color-overlay' | 'surface-color-dim' | 'surface-color' | 'surface-on-color-disabled' | 'surface-on-color-subtle' | 'surface-on-color' | 'surface-on-color-bold' | 'surface-container' | 'surface-container-high' | 'surface-container-highest' | 'surface-container-disabled' | 'surface-container-disabled-variant' | 'surface-on-container-disabled' | 'surface-inverse' | 'surface-on-inverse' | 'surface-on-inverse-disabled' | 'outline' | 'outline-variant' | 'outline-inverse' | 'primary-color' | 'primary-on-color' | 'primary-color-variant' | 'primary-on-color-variant' | 'primary-container' | 'primary-on-container' | 'primary-container-variant' | 'primary-on-container-variant' | 'secondary-color' | 'secondary-on-color' | 'secondary-container' | 'secondary-on-container' | 'secondary-container-variant' | 'secondary-on-container-variant' | 'tertiary-color' | 'tertiary-on-color' | 'tertiary-container' | 'tertiary-on-container' | 'tertiary-container-variant' | 'tertiary-on-container-variant' | 'success-color' | 'success-on-color' | 'success-container' | 'success-on-container' | 'success-container-variant' | 'success-on-container-variant' | 'danger-color' | 'danger-on-color' | 'danger-container' | 'danger-on-container' | 'danger-container-variant' | 'danger-on-container-variant' | 'info-color' | 'info-on-color' | 'info-container' | 'info-on-container' | 'info-container-variant' | 'info-on-container-variant' | 'upsell-color' | 'upsell-on-color' | 'upsell-color-variant' | 'upsell-on-color-variant' | 'upsell-container' | 'upsell-on-container' | 'upsell-container-variant' | 'upsell-on-container-variant' | 'warning-color' | 'warning-on-color' | 'warning-container' | 'warning-on-container' | 'warning-container-variant' | 'warning-on-container-variant' | 'shadow-overlay' | 'shadow-active' | 'brand-neutrals-caviar-dynamic' | 'brand-neutrals-chefscoat-dynamic';
+export type Color = 'white' | 'black' | 'tangerine-100' | 'tangerine-200' | 'tangerine-300' | 'tangerine-400' | 'tangerine-500' | 'tangerine-600' | 'eggplant-100' | 'eggplant-200' | 'eggplant-300' | 'eggplant-400' | 'eggplant-500' | 'eggplant-600' | 'mint-100' | 'mint-200' | 'mint-300' | 'mint-400' | 'mint-500' | 'mint-600' | 'radish-100' | 'radish-200' | 'radish-300' | 'radish-400' | 'radish-500' | 'radish-600' | 'blueberry-100' | 'blueberry-200' | 'blueberry-300' | 'blueberry-400' | 'blueberry-500' | 'blueberry-600' | 'banana-100' | 'banana-200' | 'banana-300' | 'banana-400' | 'banana-500' | 'banana-600' | 'grey-100' | 'grey-200' | 'grey-300' | 'grey-400' | 'grey-500' | 'grey-600' | 'oat-100' | 'oat-200' | 'oat-300' | 'oat-400' | 'oat-500' | 'oat-600' | 'lime-100' | 'lime-200' | 'lime-300' | 'lime-400' | 'lime-500' | 'lime-600' | 'blackberry-100' | 'blackberry-200' | 'blackberry-300' | 'blackberry-400' | 'blackberry-500' | 'blackberry-600' | 'neutral-color' | 'neutral-on-color' | 'neutral-container' | 'neutral-on-container' | 'neutral-container-variant' | 'neutral-on-container-variant' | 'neutral-black-transparent-05' | 'neutral-black-transparent-10' | 'neutral-black-transparent-15' | 'neutral-black-transparent-20' | 'neutral-black-transparent-30' | 'neutral-black-transparent-40' | 'neutral-black-transparent-50' | 'neutral-black-transparent-60' | 'neutral-black-transparent-70' | 'neutral-black-transparent-80' | 'neutral-black-transparent-90' | 'neutral-white-transparent-05' | 'neutral-white-transparent-10' | 'neutral-white-transparent-15' | 'neutral-white-transparent-20' | 'neutral-white-transparent-30' | 'neutral-white-transparent-40' | 'neutral-white-transparent-50' | 'neutral-white-transparent-60' | 'neutral-white-transparent-70' | 'neutral-white-transparent-80' | 'neutral-white-transparent-90' | 'surface-color-overlay' | 'surface-color-dim' | 'surface-color' | 'surface-on-color-disabled' | 'surface-on-color-subtle' | 'surface-on-color' | 'surface-on-color-bold' | 'surface-container' | 'surface-container-high' | 'surface-container-highest' | 'surface-container-disabled' | 'surface-container-disabled-variant' | 'surface-on-container-disabled' | 'surface-inverse' | 'surface-on-inverse' | 'surface-on-inverse-disabled' | 'outline' | 'outline-variant' | 'outline-inverse' | 'primary-color' | 'primary-on-color' | 'primary-color-variant' | 'primary-on-color-variant' | 'primary-container' | 'primary-on-container' | 'primary-container-variant' | 'primary-on-container-variant' | 'secondary-color' | 'secondary-on-color' | 'secondary-container' | 'secondary-on-container' | 'secondary-container-variant' | 'secondary-on-container-variant' | 'tertiary-color' | 'tertiary-on-color' | 'tertiary-container' | 'tertiary-on-container' | 'tertiary-container-variant' | 'tertiary-on-container-variant' | 'success-color' | 'success-on-color' | 'success-container' | 'success-on-container' | 'success-container-variant' | 'success-on-container-variant' | 'danger-color' | 'danger-on-color' | 'danger-container' | 'danger-on-container' | 'danger-container-variant' | 'danger-on-container-variant' | 'info-color' | 'info-on-color' | 'info-container' | 'info-on-container' | 'info-container-variant' | 'info-on-container-variant' | 'upsell-color' | 'upsell-on-color' | 'upsell-color-variant' | 'upsell-on-color-variant' | 'upsell-container' | 'upsell-on-container' | 'upsell-container-variant' | 'upsell-on-container-variant' | 'warning-color' | 'warning-on-color' | 'warning-container' | 'warning-on-container' | 'warning-container-variant' | 'warning-on-container-variant' | 'shadow-overlay' | 'shadow-active' | 'hover-inverse' | 'hover-lighten' | 'hover-darken' | 'brand-neutrals-caviar-dynamic' | 'brand-neutrals-chefscoat-dynamic';

package/dist/foundation/types.d.ts

@@ -1,23 +1,53 @@
 export type PositionStyles = {
-    /** Shortcut for `margin`. */
+    /**
+     * @description Shortcut for `margin`.
+     * @category Positioning
+     */
     m?: string | number;
-    /** Defines the margin around of the element. */
+    /**
+     * @description Defines the margin around of the element.
+     * @category Positioning
+     */
     margin?: string | number;
-    /** Shortcut for `marginTop`. */
+    /**
+     * @description Shortcut for `marginTop`.
+     * @category Positioning
+     */
     mt?: string | number;
-    /** Defines the margin on the top of the element. */
+    /**
+     * @description Defines the margin on the top of the element.
+     * @category Positioning
+     */
     marginTop?: string | number;
-    /** Shortcut for `marginRight`. */
+    /**
+     * @description Shortcut for `marginRight`.
+     * @category Positioning
+     */
     mr?: string | number;
-    /** Defines the margin on the right side of the element. */
+    /**
+     * @description Defines the margin on the right side of the element.
+     * @category Positioning
+     */
     marginRight?: string | number;
-    /** Shortcut for `marginBottom`. */
+    /**
+     * @description Shortcut for `marginBottom`.
+     * @category Positioning
+     */
     mb?: string | number;
-    /** Defines the margin on the bottom of the element. */
+    /**
+     * @description Defines the margin on the bottom of the element.
+     * @category Positioning
+     */
     marginBottom?: string | number;
-    /** Shortcut for `marginLeft`. */
+    /**
+     * @description Shortcut for `marginLeft`.
+     * @category Positioning
+     */
     ml?: string | number;
-    /** Defines the margin on the left side of the element. */
+    /**
+     * @description Defines the margin on the left side of the element.
+     * @category Positioning
+     */
     marginLeft?: string | number;
 };
 export type DataProps = {

package/dist/hooks/usePositionStyles.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 import { PositionStyles } from '../foundation/types';
 type CSSPositionStyles = Pick<React.CSSProperties, 'margin' | 'marginTop' | 'marginRight' | 'marginBottom' | 'marginLeft'>;
 export declare const usePositionStyles: ({ m, margin, marginTop, mt, marginRight, mr, marginBottom, mb, marginLeft, ml }: PositionStyles) => CSSPositionStyles;

package/dist/i18n/TranslationsContext.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 import en from './locales/en.json';
 export type TranslationsContextType = {
     i18n: typeof en;