@frigade/react 1.37.18 → 1.37.20

package/dist/index.d.ts

@@ -123,6 +123,10 @@ interface StepData {
      * Whether to show a highlight in the page where the step is shown. Typically used in tooltips for creating small pings.
      */
     showHighlight?: boolean;
+    /**
+     * Any other additional props defined in config.yml
+     */
+    [x: string | number | symbol]: unknown;
 }
 interface DefaultFrigadeFlowProps {
     flowId: string;
@@ -712,7 +716,13 @@ declare function useFlowOpens(): {
 declare function useUser(): {
     readonly userId: string | null;
     readonly setUserId: React__default.Dispatch<React__default.SetStateAction<string | null>>;
-    readonly setUserIdWithProperties: (userId: string, properties?: EntityProperties) => Promise<void>;
+    /**
+     * Sets the user id and properties for the current user.
+     * @param userId The user id of the user that is currently logged in.
+     * @param properties The properties of the user that is currently logged in.
+     * @param linkGuestSession If true, any data/state collected during guest session will be linked to the user.
+     */
+    readonly setUserIdWithProperties: (userId: string, properties?: EntityProperties, linkGuestSession?: boolean) => Promise<void>;
     readonly addPropertiesToUser: (properties: EntityProperties) => Promise<void>;
     readonly trackEventForUser: (event: string, properties?: EntityProperties) => Promise<void>;
 };
@@ -1039,4 +1049,4 @@ declare const tokens: {
     };
 };
 
-export { Appearance, Box, Button, CheckBox, CustomFormTypeProps, EntityProperties, Flow, FlowResponse, FlowType, FormInputProps, FormInputType, Label as FormLabel, TextField as FormTextField, FormValidationError, FrigadeAnnouncement, FrigadeBanner, FrigadeChecklist, DefaultAppearance as FrigadeDefaultAppearance, FrigadeEmbeddedTip, FrigadeForm, FrigadeGuide, FrigadeHeroChecklist, FrigadeNPSSurvey, FrigadeProgressBadge, FrigadeProvider, FrigadeSupportWidget, BaseTheme as FrigadeTheme, FrigadeTour, ProgressBar, ProgressRing, PublicStepState, StepContentProps, StepData, Text, tokens, useFlowOpens, useFlowResponses, useFlows, useOrganization, useUser, useUserFlowStates };
+export { Appearance, Box, Button, CheckBox, CustomFormTypeProps, EntityProperties, Flow, FlowResponse, FlowType, FormInputProps, FormInputType, Label as FormLabel, TextField as FormTextField, FormValidationError, FrigadeAnnouncement, FrigadeAnnouncementProps, FrigadeBanner, FrigadeBannerProps, FrigadeChecklist, FrigadeChecklistProps, DefaultAppearance as FrigadeDefaultAppearance, FrigadeEmbeddedTip, FrigadeEmbeddedTipProps, FrigadeForm, FrigadeFormProps, FrigadeGuide, FrigadeHeroChecklist, FrigadeNPSSurvey, FrigadeNPSSurveyProps, FrigadeProgressBadge, FrigadeProgressBadgeProps, FrigadeProvider, FrigadeSupportWidget, BaseTheme as FrigadeTheme, FrigadeTour, FrigadeTourProps, ProgressBar, ProgressRing, PublicStepState, StepContentProps, StepData, Text, tokens, useFlowOpens, useFlowResponses, useFlows, useOrganization, useUser, useUserFlowStates };