@embedreach/components 0.2.3 → 0.2.5

package/dist/index.d.ts

@@ -6,7 +6,7 @@ export declare enum AutomationTriggerType {
     TRIGGER_BASED = "trigger_based"
 }
 
-export declare function CreateAutomationDialog({ open, setOpen, onClose, automationType, }: CreateAutomationDialogProps): JSX_2.Element;
+export declare function CreateAutomationDialog({ open, setOpen, onClose, automationType, getExtraMergeFields, }: CreateAutomationDialogProps): JSX_2.Element;
 
 declare interface CreateAutomationDialogProps extends CreateAutomationModalProps {
     /**
@@ -16,7 +16,10 @@ declare interface CreateAutomationDialogProps extends CreateAutomationModalProps
     setOpen: (open: boolean) => void;
 }
 
-export declare const CreateAutomationModal: default_2.FC<CreateAutomationModalProps>;
+export declare const CreateAutomationModal: default_2.FC<CreateAutomationModalProps & {
+    currentStep: CreateAutomationModalStep;
+    setCurrentStep: (step: CreateAutomationModalStep) => void;
+}>;
 
 declare interface CreateAutomationModalProps {
     /**
@@ -31,6 +34,32 @@ declare interface CreateAutomationModalProps {
      * @Note This will remove the ability to select the automation type (e.g. the user will not be able to change the automation type)
      */
     automationType?: AutomationTriggerType.ONE_TIME;
+    /**
+     * Optional function to return extra merge fields for the automation
+     */
+    getExtraMergeFields?: () => Promise<ReachMergeField[]>;
+    /**
+     * Optional function to call prior to scheduling if a user wants to implement custom
+     * logic to block scheduling
+     *
+     * @param args.estimatedEmailRecipients - The estimated number of email recipients
+     * @param args.estimatedSmsRecipients - The estimated number of sms recipients
+     *
+     * @returns true if the automation should be scheduled, string otherwise that will be displayed to the user in a toast notification
+     */
+    onBeforeSchedule?: (args: {
+        estimatedEmailRecipients: number;
+        estimatedSmsRecipients: number;
+    }) => Promise<true | string>;
+}
+
+/**
+ * The steps of the create automation modal
+ */
+declare enum CreateAutomationModalStep {
+    ChooseAutomationType = "choose-automation-type",
+    SetAutomationName = "set-automation-name",
+    OneTimeWizard = "one-time-wizard"
 }
 
 /**