@appcues/web-sdk 7.22.2 → 7.24.0

package/build/actions/core-actions.d.ts

@@ -0,0 +1,259 @@
+/**
+ * An action creator for the INITIALIZE action.
+ *
+ * @param {object} transport An object describing the the transport. This
+ *                           contains `type`, `module` and `details` properties.
+ *
+ * @return {function} An INITIALIZE action object.
+ */
+export const initialize: Function;
+/**
+ * An action creator for IDENTIFY actions.
+ *
+ * @param {string} userId The ID of the user being identified.
+ *
+ * @return {object} An IDENTIFY action object.
+ */
+export const identify: Function;
+/**
+ * An action creator for SENT_REQUEST actions.
+ *
+ * @param {string} requestId The ID of the request that was sent.
+ *
+ * @return {object} A SENT_REQUEST action object.
+ */
+export const sentRequest: Function;
+/**
+ * An action creator for the CONFIGURE_TRANSPORT action.
+ *
+ * @param {object} details Details of the transport configuration. This is the
+ *  place to store any persistent information that the transport layer needs
+ *  access to.
+ *
+ * @return {object} A CONFIGURE_TRANSPORT action object.
+ */
+export const configureTransport: Function;
+/**
+ * An action creator for the UPDATE_USER action.
+ *
+ * @param {object} profile A hash of user properties.
+ * @param {Boolean} if true merge the profile properties with the current
+ * user state before reducing
+ *
+ * @return {object} An UPDATE_USER action object.
+ */
+export const updateUser: Function;
+/**
+ * An action creator for RESET.
+ *
+ * @return {object} A RESET action object.
+ */
+export const reset: Function;
+/**
+ * An action creator for the UPDATE_CONTENT action.
+ *
+ * @param {Array} orderedContent A list of content IDs, sorted in order
+ *  of priority.
+ * @param {object} content A hash of content IDs to content objects.
+ *
+ * @return {object} An UPDATE_CONTENT action object.
+ */
+export const updateContent: Function;
+/**
+ * An action creator for the UPDATE_STYLES action.
+ *
+ * @param {Array} styles A list of one or more style objects.
+ *
+ * @return {object} An UPDATE_STYLES action object.
+ */
+export const updateStyles: Function;
+/**
+ * An action creator for WILL_SHOW_CONTENT actions.
+ *
+ * @param  {string} contentId The ID of the content being shown.
+ *
+ * @return {object} A WILL_SHOW_CONTENT action object.
+ */
+export const willShowContent: Function;
+/**
+ * An action creator for SHOW_CONTENT actions
+ *
+ * @return {object} a SHOW_CONTENT action object.
+ */
+export const showContent: Function;
+/**
+ * An action creator for WILL_CLOSE_CONTENT actions
+ *
+ * @return {object} a WILL_CLOSE_CONTENT action object.
+ */
+export const willCloseContent: Function;
+/**
+ * An action creator for FETCHING_CONTENT actions. This action is used to set
+ * the current content ID and content status to FETCHING, so that we don't
+ * try overriding the content while fetching it.
+ *
+ * @param {string} contentId The ID of the content being fetched.
+ * @param {string} url The URL at which this flow was valid. We use this URL to
+ *                     set the `shownUrl` for content, which is used when
+ *                     checking if we should clear content or not.
+ *
+ * @return {object} a FETCHING_CONTENT action object.
+ */
+export const fetchingContent: Function;
+/**
+ * An action creator for REGISTER_RENDERER actions.
+ *
+ * @param  {string} contentType The content type that the render function
+ *  applies to.
+ * @param  {function} render Function to render the content type.
+ *
+ * @return {object} A REGISTER_RENDERER action object.
+ */
+export const registerRenderer: Function;
+/**
+ * An action creator for REGISTER_CALLBACKS actions.
+ *
+ * @param  {string} contentType The content type these callbacks apply to.
+ * @param  {object} callbacks Object with callback functions.
+ *
+ * @return {object} A REGISTER_CALLBACKS action object.
+ */
+export const registerCallbacks: Function;
+/**
+ * An action creator for ADD_EVENT_LISTENER actions.
+ *
+ * @param  {string} name The name(s) of the event(s) to listen for, or 'all' to
+ *  listen to all events.
+ * @param  {function} callback The function to call when the specified event(s)
+ *  occur.
+ * @param {object} context A context object the `callback` should be called with.
+ *
+ * @return {object} An ADD_EVENT_LISTENER action object.
+ */
+export const addEventListener: Function;
+/**
+ * An action creator for REMOVE_EVENT_LISTENER actions.
+ *
+ * @param  {string} name The name(s) of the event(s) to remove listeners for, or
+ *  'all' to remove listener for all events.
+ * @param  {function} callback The function that the listener was originally
+ *  added with.
+ * @param {object} context The context object the listener was originally added
+ *  with.
+ *
+ * @return {object} A REMOVE_EVENT_LISTENER action object.
+ */
+export const removeEventListener: Function;
+/**
+ * An action creator for WAIT_IDENTIFY actions.
+ *
+ * @param {function} callback A function to call after the identify process
+ *  has completed
+ */
+export const waitIdentify: Function;
+/**
+ * An action creator for COMPLETED_IDENTIFY actions.
+ */
+export const completedIdentify: Function;
+/**
+ * An action creator for STORE_TASK actions. These are used to add redux-saga
+ * task descriptors to a hash maintained in state. This allows us to cancel
+ * sagas by their key later on.
+ *
+ * @param  {string} key  The key under which to store the task. See TaskNames in
+ *                       the constants module.
+ * @param  {object} task The task descriptor.
+ *
+ * @return {object} A STORE_TASK action object.
+ */
+export const storeTask: Function;
+/**
+ * An action creator for CLEAR_TASKS actions. This is used to remove all the
+ * tasks under the specified key from the state object.
+ *
+ * @param {string} key The key to clear.
+ *
+ * @return {object} A CLEAR_TASKS action object.
+ */
+export const clearTasks: Function;
+/**
+ * An action creator for CLEAR_TASK actions. This is used to remove one task
+ * under the specified key with the specified `id` from the state object.
+ *
+ * @param {string} key The key to clear.
+ * @param {number} id  The ID of the specific task to clear.
+ *
+ * @return {object} A CLEAR_TASKS action object.
+ */
+export const clearTask: Function;
+/**
+ * An action creator for CLEAR_CURRENT_CONTENT actions. This is used to reset
+ * the current content completely.
+ *
+ * @return {object} A CLEAR_CURRENT_CONTENT action object.
+ */
+export const clearCurrentContent: Function;
+/**
+ * An action creator for RUN_ACTION action objects. This is used to start the
+ * process of performing the action defined in the action step.
+ *
+ * @param  {object} action  The step/action object to resume
+ *
+ * @return {object} A RUN_ACTION action object.
+ */
+export const runAction: Function;
+/**
+ * An action creator for RESUME_ACTION actions. This is used to resume an action
+ * step from a particular point in its lifecycle.
+ *
+ * @param  {object} action  The step/action object to resume
+ * @param  {String} status  The lifecycle status from which to resume
+ *
+ * @return {object} A RESUME_ACTION action object.
+ */
+export const resumeAction: Function;
+/**
+ * An action creator for CHECKED_FOR_INITIAL_CONTENT actions. This is used to
+ * indicate what URL we've checked for initial content and if we've completed
+ * that check or if it's still in progress.
+ *
+ * @param  {String}  url       The URL that check is performed for
+ * @param  {Boolean} complete  If the check is complete or still in progress
+ *
+ * @return {object}  A CHECKED_FOR_INITIAL_CONTENT action object.
+ */
+export const checkedForInitialContent: Function;
+/**
+ * An action creator for SENT_ACTIVITY_UPDATE actions. These are used by sagas
+ * that want to wait (take) until an activity update has been sent.
+ *
+ * @return {object}  A SENT_ACTIVITY_UPDATE action object.
+ */
+export const sentActivityUpdate: Function;
+/**
+ * Mainly an action for our own internal metrics-keeping. Tells us when a flow
+ * was able to be shown immediately, rather than waiting for some conditions to
+ * be met.
+ *
+ * @return {object} A STARTED_FLOW_IMM action object.
+ */
+export const startedFlowImmediately: Function;
+export const setBodyReady: Function;
+export const saveOpenBuilderInstance: Function;
+export const initializeOpenBuilder: Function;
+export const setOpenBuilderInitialized: Function;
+/**
+ * An action creator to save flow experiments for later use
+ *
+ * @return {object} A SAVE_EXPERIMENTS action object.
+ */
+export const saveExperiments: Function;
+/**
+ * An action creator to track when an experiment is started
+ *
+ * @return {object} A EXPERIMENT_STARTED action object.
+ */
+export const experimentStarted: Function;
+export const saveGroupProps: Function;
+export const updateSettings: Function;
+//# sourceMappingURL=core-actions.d.ts.map

package/build/actions/core-actions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"core-actions.d.ts","sourceRoot":"","sources":["../../src/scripts/actions/core-actions.js"],"names":[],"mappings":"AAGA;;;;;;;GAOG;AACH,kCAEG;AAEH;;;;;;GAMG;AACH,gCAA2D;AAE3D;;;;;;GAMG;AACH,mCAKE;AAEF;;;;;;;;GAQG;AACH,0CAAgF;AAEhF;;;;;;;;GAQG;AACH,kCAKE;AAEF;;;;GAIG;AACH,6BAAqD;AAErD;;;;;;;;GAQG;AACH,qCAKE;AAEF;;;;;;GAMG;AACH,oCAAoE;AAEpE;;;;;;GAMG;AACH,uCAA2E;AAE3E;;;;GAIG;AACH,mCAAkE;AAElE;;;;GAIG;AACH,wCAA6E;AAE7E;;;;;;;;;;;GAWG;AACH,uCAKE;AAEF;;;;;;;;GAQG;AACH,wCAA4E;AAE5E;;;;;;;GAOG;AACH,yCAA8E;AAE9E;;;;;;;;;;GAUG;AACH,wCASE;AAEF;;;;;;;;;;;GAWG;AACH,2CASE;AAEF;;;;;GAKG;AACH,oCAAoE;AAEpE;;GAEG;AACH,yCAA8E;AAE9E;;;;;;;;;;GAUG;AACH,iCAEG;AAEH;;;;;;;GAOG;AACH,kCAAgE;AAEhE;;;;;;;;GAQG;AACH,iCAEG;AAEH;;;;;GAKG;AACH,2CAEE;AAEF;;;;;;;GAOG;AACH,iCAA8D;AAE9D;;;;;;;;GAQG;AACH,oCAKE;AAEF;;;;;;;;;GASG;AACH,gDAKE;AAEF;;;;;GAKG;AACH,0CAEE;AAEF;;;;;;GAMG;AACH,8CAEE;AAEF,oCAAqE;AAErE,+CAEE;AAEF,6CAEE;AAEF,iDAEE;AAEF;;;;GAIG;AACH,uCAA0E;AAE1E;;;;GAIG;AACH,yCAKE;AAEF,sCAAyE;AAEzE,sCAAwE"}

package/build/actions/create-action.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Creates an action creator function for the specified `type` with an optional
+ * `transformer` function. The transformer function is applied to the action
+ * creator functions's arguments and the transformed value becomes the action
+ * `payload`.
+ *
+ * @param  {string} type The type (name) of the action.
+ * @param {function} [transformer = (x) => x] A transformer function that is
+ *  applied to create the `payload` of the action. Defaults to the identity
+ *  function.
+ *
+ * @return {function} A function that produces an FSA-compliant action. Has a
+ *  `type` and `payload` property. If the `payload` is an `Error` object, then
+ *  the `error` property is true.
+ */
+export default function createAction(type: string, transformer?: Function): Function;
+//# sourceMappingURL=create-action.d.ts.map

package/build/actions/create-action.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-action.d.ts","sourceRoot":"","sources":["../../src/scripts/actions/create-action.js"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,2CATY,MAAM,oCAyBjB"}

package/build/actions/debugger-actions.d.ts

@@ -0,0 +1,8 @@
+export const toggleRowDetails: Function;
+export const toggleCollapsed: Function;
+export const setCurrentPage: Function;
+export const trackPage: Function;
+export const addContentError: Function;
+export const addChildError: Function;
+export const closeDebugger: Function;
+//# sourceMappingURL=debugger-actions.d.ts.map

package/build/actions/debugger-actions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"debugger-actions.d.ts","sourceRoot":"","sources":["../../src/scripts/actions/debugger-actions.js"],"names":[],"mappings":"AAKA,wCAEE;AAEF,uCAA8E;AAI9E,sCAA6E;AAE7E,iCAAkE;AAElE,uCAKE;AAEF,qCAKE;AAEF,qCAA0E"}

package/build/actions/experience-actions.d.ts

@@ -0,0 +1,48 @@
+/**
+ * An action creator for PAUSE_EXPERIENCE action.
+ *
+ * @param {string} experienceId
+ *
+ * @return {object} An PAUSE_EXPERIENCE action object.
+ */
+export const pauseExperience: Function;
+/**
+ * An action creator for RESUME_EXPERIENCE action.
+ *
+ *
+ * @return {object} An RESUME_EXPERIENCE action object.
+ */
+export const resumeExperience: Function;
+/**
+ * An action creator for SHOW_EXPERIENCES action.
+ *
+ * @param {array} experiences
+ *
+ * @return {object} An SHOW_EXPERIENCES action object.
+ */
+export const showExperiences: Function;
+/**
+ * An action creator for SAVE_ON_HOLD_LAUNCHPADS action.
+ *
+ * @param {array} experiences
+ *
+ * @return {object} An SAVE_ON_HOLD_LAUNCHPADS action object.
+ */
+export const saveOnHoldLaunchpads: Function;
+/**
+ * An action creator for UNHIDE_LAUNCHPADS action.
+ *
+ * @param {array} experiences
+ *
+ * @return {object} An UNHIDE_LAUNCHPADS action object.
+ */
+export const unHideLaunchpads: Function;
+/**
+ * An action creator for HIDE_LAUNCHPADS action.
+ *
+ * @param {array} experiences
+ *
+ * @return {object} An HIDE_LAUNCHPADS action object.
+ */
+export const hideLaunchpads: Function;
+//# sourceMappingURL=experience-actions.d.ts.map

package/build/actions/experience-actions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"experience-actions.d.ts","sourceRoot":"","sources":["../../src/scripts/actions/experience-actions.js"],"names":[],"mappings":"AAGA;;;;;;GAMG;AACH,uCAAgF;AAEhF;;;;;GAKG;AACH,wCAEE;AAEF;;;;;;GAMG;AACH,uCAAgF;AAEhF;;;;;;GAMG;AACH,4CAEE;AAEF;;;;;;GAMG;AACH,wCAEE;AAEF;;;;;;GAMG;AACH,sCAA8E"}

package/build/actions/hotspots-actions.d.ts

@@ -0,0 +1,36 @@
+/**
+ * An action creator for EXPAND_HOTSPOT actions.
+ *
+ * @param {string} hotspotId The ID of the individual hotspot to expand.
+ *
+ * @return {object} An EXPAND_HOTSPOT action object.
+ */
+export const expandHotspot: Function;
+/**
+ * An action creator for PREPARE_HOTSPOTS actions.
+ *
+ * @return {object} A PREPARE_HOTSPOTS action object.
+ */
+export const prepareHotspots: Function;
+/**
+ * An action creator for SET_BEACON_SETTLED actions. This is used to make sure the user doesn't see their
+ * hotspot "dance" while it is being rapidly re-sized and placed.
+ *
+ * @param {string} the hotspot stepChildId
+ * @param {boolean} the new value for `currentContent.annotationState.stepId.isBeaconSettled`
+ * @return {object} a SET_TOOLTIP_SETTLED action object.
+ */
+export const setBeaconSettled: Function;
+/**
+ * An action creator for CLOSE_LAST_HOTSPOT actions. This is used to send the
+ * STEP_END lifecycle message after the last hotspot or tooltip has been removed
+ * from the page and we know it's safe to end the step. This triggers the
+ * `waitForLast` saga in the hotspots-sagas module.
+ *
+ * @param  {string} stepId
+ * @param  {string} childId
+ *
+ * @return {object} A CLOSE_LAST_HOTSPOT action object.
+ */
+export const closeLastHotspot: Function;
+//# sourceMappingURL=hotspots-actions.d.ts.map

package/build/actions/hotspots-actions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hotspots-actions.d.ts","sourceRoot":"","sources":["../../src/scripts/actions/hotspots-actions.js"],"names":[],"mappings":"AAGA;;;;;;GAMG;AACH,qCAA0E;AAE1E;;;;GAIG;AACH,uCAA8E;AAE9E;;;;;;;GAOG;AACH,wCAKE;AAEF;;;;;;;;;;GAUG;AACH,wCAKE"}

package/build/actions/modal-actions.d.ts

@@ -0,0 +1,16 @@
+/**
+ * An action creator for PREPARE_MODAL actions.
+ *
+ * @return {object} A PREPARE_MODAL action object.
+ */
+export const prepareModal: Function;
+/**
+ * An action creator for RESIZE_CONTENT actions.
+ *
+ * @param {string} id the ID of the annotation to resize.
+ * @param {object} size Object with height and width properties.
+ *
+ * @return {object} A RESIZE_CONTENT action object.
+ */
+export const resizeModalContent: Function;
+//# sourceMappingURL=modal-actions.d.ts.map

package/build/actions/modal-actions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"modal-actions.d.ts","sourceRoot":"","sources":["../../src/scripts/actions/modal-actions.js"],"names":[],"mappings":"AAGA;;;;GAIG;AACH,oCAAqE;AAErE;;;;;;;GAOG;AACH,0CAKE"}

package/build/actions/root-actions.d.ts

@@ -0,0 +1,260 @@
+/**
+ * Action creator for the root action START_INITIALIZE.
+ *
+ * @param {object} settings Account and script settings.
+ * @param {function} dispatchMessage A function that will dispatch a
+ *  START_HANDLE_MESSAGE action.
+ * @param {object} transportModule The module to use as data transport layer.
+ * @param {function} reporter Error reporter function.
+ *
+ * @return {object} START_INITIALIZE action object.
+ */
+export const startInitialize: Function;
+/**
+ * Action creator for the root action START_IDENTIFY.
+ *
+ * @param {string} userId The ID of the user being identified.
+ * @param {object} properties The set of user properties for this user.
+ * @param {Array} events List of events to send.
+ *
+ * @return {object} A START_IDENTIFY action object.
+ */
+export const startIdentify: Function;
+/**
+ * Action creator for the root action START_HANDLE_MESSAGE.
+ *
+ * @param {object} msg The message that we're handling.
+ *
+ * @return {object} A START_HANDLE_MESSAGE action object.
+ */
+export const startHandleMessage: Function;
+/**
+ * Action creator for the root action messageTimeout.
+ *
+ * @param {string} requestId The `request_id` of the message that timed out.
+ *
+ * @return {object} A MESSAGE_TIMEOUT action object.
+ */
+export const messageTimeout: Function;
+/**
+ * Action creator for the root action START_EVENT.
+ *
+ * @param {string} flowId The ID of the flow that this event is for.
+ * @param {object} event  The analytics event.
+ *
+ * @return {object} A START_EVENT action object.
+ */
+export const startEvent: Function;
+/**
+ * Action creator for the root action START_OPEN_BUILDER_EVENT.
+ *
+ * @param {string} type The type of the event to be sent.
+ * @param {object} event  The analytics event.
+ *
+ * @return {object} A START_OPEN_BUILDER_EVENT action object.
+ */
+export const startOpenBuilderEvent: Function;
+/**
+ * Action creator for FINISHED_EVENT actions. This is used to indicate when
+ * we've completed triggering registered event listeners.
+ *
+ * @param {string} flowId The ID of the flow that this event is for.
+ * @param {object} event  The analytics event with which we're finished.
+ *
+ * @return {object} A FINISHED_EVENT action object.
+ */
+export const finishedEvent: Function;
+/**
+ * Action creator for the root action START_ACTIVITY.
+ *
+ * @param {object} properties A set of user properties to send in the update.
+ * @param {Array} events List of events to send.
+ * @param {boolean} trigger
+ *
+ * @return {object} A START_ACTIVITY action object.
+ */
+export const startActivity: Function;
+/**
+ * Action creator for the root action START_GROUP_ACTIVITY.
+ *
+ * @param {string} groupId The group ID
+ * @param {object} properties A set of group properties to send in the update.
+ *
+ * @return {object} A START_GROUP_ACTIVITY action object.
+ */
+export const startGroupActivity: Function;
+/**
+ * Action creator for the root action START_ANONYMOUS.
+ *
+ * @return {object} A START_ANONYMOUS action object.
+ */
+export const startAnonymous: Function;
+/**
+ * Action creator for the root action INJECT_CONTENT.
+ *
+ * @return {object} A INJECT_CONTENT action object.
+ */
+export const injectContent: Function;
+/**
+ * Action creator for the root action INJECT_STYLES.
+ *
+ * @return {object} A INJECT_STYLES action object.
+ */
+export const injectStyles: Function;
+/**
+ * Action creator for the root action PREPARE_CONTENT.
+ *
+ * @return {object} A PREPARE_CONTENT action object.
+ */
+export const prepareContent: Function;
+/**
+ * Action creator for the root action CLEANUP_STEP. This is used to trigger
+ * any necessary cleanup after different content types are closed.
+ *
+ * @param {object} content The step object that should be cleaned up.
+ *
+ * @return {object} A CLEANUP_STEP action object.
+ */
+export const cleanupStep: Function;
+/**
+ * Action creator for the root action START_CONTENT.
+ *
+ * @return {object} A START_CONTENT action object.
+ */
+export const startContent: Function;
+/**
+ * Action creator for the root action START_RESET.
+ *
+ * @return {object} A START_RESET action object.
+ */
+export const startReset: Function;
+/**
+ * Action creator for the root action START_DEBUG.
+ *
+ * @return {object} A START_DEBUG action object.
+ */
+export const startDebug: Function;
+/**
+ * Action creator for the root action START_FORM_SUBMISSION.
+ *
+ * @param  {String} formId The ID of the form being submitted.
+ * @param  {Array} fields List of field objects that look like:
+ *   {
+ *     fieldId: $fieldId,
+ *     validation: ($type|null) (optional),
+ *     required: (true|false),
+ *     label: $field_label,
+ *     value: $field_value
+ *   }
+ * @param {function} onSuccess A function that should be called if the form is
+ *   submitted successfully.
+ *
+ * @return {object} A START_FORM_SUBMISSION action object.
+ */
+export const startFormSubmission: Function;
+/**
+ * Action creator for the root action START_SHOW.
+ *
+ * @param {string} contentId The ID of the content to start showing.
+ *
+ * @return {object} A START_SHOW action object.
+ */
+export const startShow: Function;
+/**
+ * Action creator for the root STOP_TASKS action, which is used to cancel and
+ * clear the tasks stored under a particular key.
+ *
+ * @param {string} key  The key used to store the tasks we want to cancel.
+ *
+ * @return {object} A STOP_TASKS action object.
+ */
+export const stopTasks: Function;
+/**
+ * Action creator for the root START_CHECK action, which is used to start
+ * checking for a valid flow to start.
+ *
+ * @param {string} currentUrl The current URL of the page on which this content
+ *                            may be shown. We eventually use this URL to set
+ *                            the `shownUrl` for content, which is used when
+ *                            checking if we should clear content or not.
+ *
+ * @param {boolean} shouldOverrideCurrentFlow Identifies whether the event that
+ *                                     triggers this check is due to a `page_view`
+ *                                     or `event_trigger`
+ *
+ * @return {object} A START_CHECK action object.
+ */
+export const startCheck: Function;
+/**
+ * Action creator for the root START_FLOW action, which is used to begin the
+ * process a showing or resuming a particular flow. The `status` value indicates
+ * that we're resuming a flow at particular point in a step.
+ *
+ * @param {string} flowId  The ID of the flow to start.
+ * @param {string} stepId  The ID of the step to begin with.
+ * @param {string} url The URL at which this flow was valid. We use this URL to
+ *                     set the `shownUrl` for content, which is used when
+ *                     checking if we should clear content or not.
+ * @param {redux-saga.Channel} A redux-saga Channel that serves as the event
+ *                             channel for this flow. Lifecycle messages should
+ *                             be sent over this channel.
+ * @param {string} status  The status of the passed step if we're trying to
+ *                         resume the step.
+ *
+ * @return {object} A START_FLOW action object.
+ */
+export const startFlow: Function;
+/**
+ * Action creator for the root START_STEP action, which is used to begin the
+ * process of running a particular step of a flow. This can result in content
+ * being displayed on the page or an action being performed or a condition being
+ * waited upon.
+ *
+ * @param  {string} step  The step object to run.
+ * @param  {string} url   The URL at which this step was valid.
+ *
+ * @return {object} A START_STEP action object.
+ */
+export const startStep: Function;
+/**
+ * An action creator for CANCEL_ATTEMPTS actions. This is used to cancel any
+ * in-progress flow attempts.
+ *
+ * @return {object} A CANCEL_ATTEMPTS action object.
+ */
+export const cancelAttempts: Function;
+/**
+ * An action creator for SEND_LIFECYCLE_EVENT actions. This is used to put a
+ * FlowLifecycleEvent on the current content event channel, or the passed event
+ * channel (if one is passed).
+ *
+ * @param  {object} event        The FlowLifecycleEvent object to put on the channel.
+ * @param  {object} eventChannel (Optional) The channel over which to send the
+ *                               lifecycle event. This should only be passed to
+ *                               override the default (which is the current
+ *                               content's event channel).
+ *
+ * @return {object} A SEND_LIFECYCLE_EVENT action object.
+ */
+export const sendLifecycleEvent: Function;
+/**
+ * An action creator for CLOSE_CHANNEL actions. This is used to close a
+ * particular redux-saga channel. It kicks off the closeEventChannel saga in
+ * the flow-sagas module. For an explanation of why this is needed, see that
+ * saga's comments.
+ *
+ * @param  {object} eventChannel The channel to close.
+ *
+ * @return {object} A CLOSE_CHANNEL action object.
+ */
+export const closeChannel: Function;
+/**
+ * Action creator for the root action START_IDENTIFY.
+ *
+ * @param {string} groupId The ID of the group being identified.
+ * @param {object} groupProperties The set of group properties.
+ *
+ * @return {object} A START_IDENTIFY action object.
+ */
+export const startIdentifyGroup: Function;
+//# sourceMappingURL=root-actions.d.ts.map

package/build/actions/root-actions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"root-actions.d.ts","sourceRoot":"","sources":["../../src/scripts/actions/root-actions.js"],"names":[],"mappings":"AAGA;;;;;;;;;;GAUG;AACH,uCAKE;AAEF;;;;;;;;GAQG;AACH,qCAKE;AAEF;;;;;;GAMG;AACH,0CAEE;AAEF;;;;;;GAMG;AACH,sCAAwE;AAExE;;;;;;;GAOG;AACH,kCAKE;AAEF;;;;;;;GAOG;AACH,6CAKE;AAEF;;;;;;;;GAQG;AACH,qCAKE;AAEF;;;;;;;;GAQG;AACH,qCASE;AACF;;;;;;;GAOG;AACH,0CAKE;AAEF;;;;GAIG;AACH,sCAAwE;AAExE;;;;GAIG;AACH,qCAKE;AAEF;;;;GAIG;AACH,oCAKE;AAEF;;;;GAIG;AACH,sCAAwE;AAExE;;;;;;;GAOG;AACH,mCAAkE;AAElE;;;;GAIG;AACH,oCAAoE;AAEpE;;;;GAIG;AACH,kCAAgE;AAEhE;;;;GAIG;AACH,kCAAgE;AAEhE;;;;;;;;;;;;;;;;GAgBG;AACH,2CAKE;AAEF;;;;;;GAMG;AACH,iCAGE;AAEF;;;;;;;GAOG;AACH,iCAA8D;AAE9D;;;;;;;;;;;;;;GAcG;AAEH,kCAKE;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,iCAWE;AAEF;;;;;;;;;;GAUG;AACH,iCAKE;AAEF;;;;;GAKG;AACH,sCAAwE;AAExE;;;;;;;;;;;;GAYG;AACH,0CAKE;AAEF;;;;;;;;;GASG;AACH,oCAAoE;AAEpE;;;;;;;GAOG;AACH,0CAKE"}