@frigade/react 1.37.22 → 1.38.1

package/dist/index.d.ts

@@ -1,6 +1,5 @@
 import * as React from 'react';
 import React__default, { CSSProperties, FC, ElementType, ReactNode, ComponentPropsWithoutRef } from 'react';
-import * as react_jsx_runtime from 'react/jsx-runtime';
 import { BorderProps, ColorProps, LayoutProps, ShadowProps, SpaceProps, TypographyProps, FontProps } from 'styled-system';
 
 type StepActionType = 'STARTED_STEP' | 'COMPLETED_STEP' | 'NOT_STARTED_STEP';
@@ -159,7 +158,7 @@ interface DefaultFrigadeFlowProps {
      * @param index
      * @param cta
      */
-    onButtonClick?: (step: StepData, index?: number, cta?: 'primary' | 'secondary' | 'link', nextStep?: StepData) => boolean;
+    onButtonClick?: (step: StepData, index?: number, cta?: 'primary' | 'secondary' | 'link' | 'back', nextStep?: StepData) => boolean;
     onDismiss?: () => void;
     onComplete?: () => void;
 }
@@ -243,7 +242,7 @@ declare function useFlows(): {
     markFlowNotStarted: (flowId: string, data?: any) => Promise<void>;
     markFlowStarted: (flowId: string, data?: any) => Promise<void>;
     markFlowCompleted: (flowId: string, data?: any) => Promise<void>;
-    markFlowAborted: (flowId: string, data?: any) => Promise<void>;
+    markFlowSkipped: (flowId: string, data?: any) => Promise<void>;
     markStepNotStarted: (flowId: string, stepId: string, data?: any) => Promise<void>;
     getFlowStatus: (flowId: string) => "COMPLETED_FLOW" | "STARTED_FLOW" | "NOT_STARTED_FLOW";
     getNumberOfStepsCompleted: (flowId: string) => number;
@@ -520,6 +519,7 @@ interface FrigadeFormProps extends DefaultFrigadeFlowProps {
     showPagination?: boolean;
     /**
      * Whether to allow the user to navigate back to previous steps. Default is false.
+     * The title of the button can be controlled by the `backButtonTitle` prop on the step.
      */
     allowBackNavigation?: boolean;
     /**
@@ -634,10 +634,10 @@ interface FrigadeTourProps extends Omit<DefaultFrigadeFlowProps, 'flowId'> {
      */
     showStepCount?: boolean;
     /**
-     * `complete-flow` (default): Completes the entire flow/tour when a single tooltip is dismissed.
-     * `complete-step`: Completes the current step when a tooltip is dismissed.
+     * `skip-flow` (default): Completes the entire flow/tour when a single tooltip is dismissed.
+     * `complete-step`: Completes the current step when a tooltip is dismissed. The user can continue in the tour.
      */
-    dismissBehavior?: 'complete-flow' | 'complete-step';
+    dismissBehavior?: 'skip-flow' | 'complete-step';
     /**
      * @ignore
      */
@@ -701,6 +701,15 @@ interface FrigadeAnnouncementProps extends DefaultFrigadeFlowProps {
      * Indicates the position of the modal if the form type is a modal. Default is center.
      */
     modalPosition?: 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' | 'center' | 'inline';
+    /**
+     * Show a pagination indicator at the bottom of the announcement when using more than 1 page. Default is true.
+     */
+    showPagination?: boolean;
+    /**
+     * Whether to allow the user to navigate back to previous steps. Default is false.
+     * The title of the button can be controlled by the `backButtonTitle` prop on the step.
+     */
+    allowBackNavigation?: boolean;
 }
 declare const FrigadeAnnouncement: React__default.FC<FrigadeAnnouncementProps>;
 
@@ -744,6 +753,7 @@ declare function useUserFlowStates(): {
     isLoadingUserFlowStateData: boolean;
     mutateUserFlowState: () => any;
     optimisticallyMarkFlowCompleted: (flowId: string) => void;
+    optimisticallyMarkFlowSkipped: (flowId: string) => void;
     optimisticallyMarkFlowNotStarted: (flowId: string) => void;
     optimisticallyMarkStepCompleted: (flowId: string, stepId: string, flowResponse: FlowResponse) => void;
     optimisticallyMarkStepNotStarted: (flowId: string, stepId: string, flowResponse: FlowResponse) => void;
@@ -755,9 +765,9 @@ declare function Label({ title, required, appearance, }: {
     title?: string;
     required: boolean;
     appearance?: Appearance;
-}): react_jsx_runtime.JSX.Element;
+}): React__default.JSX.Element;
 
-declare function TextField({ formInput, customFormTypeProps, onSaveInputData, setFormValidationErrors, inputData, }: FormInputProps): react_jsx_runtime.JSX.Element;
+declare function TextField({ formInput, customFormTypeProps, onSaveInputData, setFormValidationErrors, inputData, }: FormInputProps): React__default.JSX.Element;
 
 interface Overrides extends Record<string, Overrides | CSSProperties> {
 }
@@ -767,14 +777,14 @@ type BoxProps<T extends ElementType = 'div'> = {
     children?: ReactNode;
     overrides?: Overrides;
 } & BorderProps & ColorProps & Exclude<LayoutProps, 'size'> & ShadowProps & SpaceProps & TypographyProps & ComponentPropsWithoutRef<T>;
-declare const Box: <T extends React__default.ElementType<any> = "div">({ as, children, overrides, ...rest }: any) => react_jsx_runtime.JSX.Element;
+declare const Box: <T extends React__default.ElementType<any> = "div">({ as, children, overrides, ...rest }: any) => React__default.JSX.Element;
 
 interface ButtonProps extends BoxProps {
     title: string;
 }
 declare const Button: React.FC<ButtonProps> & {
     [k: string]: {
-        (props: ButtonProps): react_jsx_runtime.JSX.Element;
+        (props: ButtonProps): React.JSX.Element;
         displayName: string;
     };
 };
@@ -865,7 +875,7 @@ interface BaseTextProps extends BoxProps, Partial<Pick<FontProps, 'fontWeight'>>
 }
 declare const Text: React__default.FC<BaseTextProps> & {
     [k: string]: {
-        (props: BaseTextProps): react_jsx_runtime.JSX.Element;
+        (props: BaseTextProps): React__default.JSX.Element;
         displayName: string;
     };
 };
@@ -879,7 +889,7 @@ declare const ProgressBar: ({ count, total, display, textLocation, style, textSt
     style?: CSSProperties;
     textStyle?: CSSProperties;
     appearance?: Appearance;
-}) => react_jsx_runtime.JSX.Element;
+}) => React__default.JSX.Element;
 
 declare const tokens: {
     colors: {