@wix/bex-utils 2.54.0 → 2.56.0

package/@wix/bi-logger-os-data/dist/esm/v2/index.js

@@ -1,3 +1,20 @@
+/**
+ * A function to create a log object for the 'bmOverEditorPanelClickSrc110Evid122' event (evid: 122)
+ *
+ * Event description: BM Over Editor Panel Click
+ * Tracks when a user hovers over the Business Manager (BM) panel within the editor and then clicks on it.
+ * X or "go to editor"
+ *
+ * @param {bmOverEditorPanelClickSrc110Evid122Params} params - The parameters for this event
+ * @property {string} cta - X or "go to dashboard)
+ * @property {string} current_page_id - the page_id of the current page
+ * @property {string} panel_name - the name of the panel
+ * @property {string} builderType - builder type - relevant for BM over editor
+ * @return {LogObject<bmOverEditorPanelClickSrc110Evid122Params>} LogObject<bmOverEditorPanelClickSrc110Evid122Params>
+ */
+export function bmOverEditorPanelClickSrc110Evid122(params) {
+    return { evid: 122, src: 110, endpoint: '', params };
+}
 /**
  * A function to create a log object for the 'wixPatternsSummaryBarIsShownSrc144Evid1' event (evid: 1)
  *
@@ -350,6 +367,9 @@ export function loadStart(params) {
  * @property {boolean} preLoadToolbarUsed - will be true if the user used the toolbar before the component was loaded, false otherwise
  * @property {string} providerName - providerName
  * @property {string} providerId - provider Id
+ * @property {string} stageCardCnt - JSON field: each key is the section ID or name, and the value is the number of cards in that section relevant for TableKanbanSwtich
+ *
+ * @property {string} currentKanban - relevant for TableKanbanSwitch
  * @property {string} hostingPlatformContextId - the id of the context entity that the user view or edit (app/account/site)
  *
  * @property {string} theme - relevant to custom field - inline / card
@@ -494,6 +514,12 @@ export function cairoItemSelectionToggled(params) {
  * @property {string} appId - app_id
  * @property {number} filteredListSize - How many items are to be presented (filtered)
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
+ * @property {string} ctaType - primary button / primary dropdown / secondary button
+ * @property {string} kanbanId - kanban id. relevant for TableKanbanSwitch
+ *
+ * @property {number} stageIndex - relevant for TableKanbanSwitch.
+ * @property {string} stageName - relevant for TableKanbanSwitch. name in EN
+ * @property {string} stageId - stage_id. relevant for TableKanbanSwitch
  * @property {string} hostingPlatformContextId - the id of the context entity that the user view or edit (app/account/site)
  * @property {string} url - Page's url
  * @return {LogObject<cairoCtaClickedParams>} LogObject<cairoCtaClickedParams>
@@ -520,6 +546,10 @@ export function cairoCtaClicked(params) {
  * @property {number} loadingTime - How much time (in ms) did it take to load the results for searchQuery
  * @property {string} appId - app_id
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
+ * @property {string} stageCardCnt - JSON field:  each key is the section ID or name, and the value is the number of cards in that section
+ * relevant for TableKanbanSwtich
+ * @property {string} kanbanId - kanban id. relevant for TableKanbanSwitch
+ *
  * @property {string} hostingPlatformContextId - the id of the context entity that the user view or edit (app/account/site)
  *
  * @return {LogObject<cairoSearchResultsParams>} LogObject<cairoSearchResultsParams>
@@ -552,6 +582,8 @@ export function cairoSearchResults(params) {
  * @property {number} filteredListSize - How many items are currently presented to user, after filter toggle (filtered)
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
  * @property {boolean} preLoadToolbarUsed - will be true if the user used the filter before the component was loaded, false otherwise
+ * @property {string} kanbanId - kanban id. relevant for TableKanbanSwitch
+ *
  * @property {string} filterType - The type of the filter - Multi Selection, Single Selection, Number Range
  * @property {boolean} isCustomField - true if the field is customized
  * @return {LogObject<cairoFilterToggledParams>} LogObject<cairoFilterToggledParams>
@@ -1185,6 +1217,8 @@ export function cairoTableTopNotificationDismissed(params) {
  * @property {number} filteredListSize - How many items are to be presented (filtered)
  * @property {boolean} isFromSearch - Did the user try to drag the item from a list of search results (relate to ticket 521).
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
+ * @property {string} kanbanId - relevant for TableKanbanSwitch
+ * @property {string} stageType - relevant for TableKanbanSwitch
  * @property {number} itemLevel - indicates the level of the hierarchy the item is in.
  * @property {string} hierarchyPathIndex - gives the indexes path to get to the item from the parent where in each level the index is calculated from the beginning
  * @return {LogObject<cairoDragItemParams>} LogObject<cairoDragItemParams>
@@ -1228,6 +1262,9 @@ export function cairoDragItem(params) {
  * @property {number} filteredListSize - How many items are to be presented (filtered)
  * @property {boolean} isFromSearch - Did the user try to drag the item from a list of search results (relate to ticket 521).
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
+ * @property {string} kanbanId - relevant for TableKanbanSwitch
+ * @property {string} stageTypeBefore - relevant for TableKanbanSwitch
+ * @property {string} stageTypeAfter - relevant for TableKanbanSwitch
  * @property {number} itemLevelBefore -  indicates the level of the hierarchy the item is in before the drag and drop
  * @property {number} itemLevelAfter -  indicates the level of the hierarchy the item is in after the drag and drop
  * @property {string} hierarchyPathIndexBefore - gives the indexes path to get to the item from the parent where in each level the index is calculated from the beginning (the path before the drag and drop)
@@ -1568,6 +1605,9 @@ export function cairoApiRequestDataLoadEnd(params) {
  * @property {string} pageType - Collection / Entity
  * @property {string} appId - app_id
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
+ * @property {string} pipelineId - pipeline id. relevant for TableKanbanSwitch
+ *
+ * @property {string} additionalInfo - Used by any consumer who wants to send specific content
  * @property {string} url - The page's url
  * @property {string} origin - the origin of the page - collection page or entity page
  * @return {LogObject<cairoPageCtaClickedParams>} LogObject<cairoPageCtaClickedParams>
@@ -1649,6 +1689,7 @@ export function cairoPageBackOrBreadcrumbClicked(params) {
  * @property {string} ctaId - CTA ID
  * @property {string} appId - app_id
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
+ * @property {string} kanbanId - kanban id. relevant for TableKanbanSwitch
  * @return {LogObject<cairoSectionCtaClickedParams>} LogObject<cairoSectionCtaClickedParams>
  */
 export function cairoSectionCtaClicked(params) {
@@ -14492,6 +14533,8 @@ export function dashboardSettingsUpdate(params) {
  * @property {string} method_name - The method name
  * @property {string} component_id - the component id of the component that triggered the API call. the component id it's the id of the component in dev center.
  * @property {string} hosting_platform_context_id - f.e.: metasite id  will be reported when there is context of site like in BizMgr
+ * @property {string} pageId - page id
+ * @property {string} sdkModule - admin / dashboard
  * @property {string} tool - tool
  * @return {LogObject<gizaSdkApiCallReceivedSrc5Evid2222Params>} LogObject<gizaSdkApiCallReceivedSrc5Evid2222Params>
  */
@@ -15125,7 +15168,7 @@ export function notificationsEnableToTurnOnOffAllSiteNotificationsExperts(params
 /**
  * A function to create a log object for the 'notificationsEnableToTurnOnOffNotificationsPerChannel' event (evid: 276)
  *
- * Event description: User turned on his desktop notification for the first time for all his sites (actually browser turned on)
+ * Event description: User turned on his notification for the first time for all his sites (actually browser turned on)
  *
  * @param {notificationsEnableToTurnOnOffNotificationsPerChannelParams} params - The parameters for this event
  * @property {string} channel - desktop/email/ sms/ mobile
@@ -15134,6 +15177,9 @@ export function notificationsEnableToTurnOnOffAllSiteNotificationsExperts(params
  * @property {string} section - notification context - desktop/general/ wix chat/bookings/...
  * @property {string} platform - platform
  * @property {string} group - preference guid(extension_id)
+ * @property {string} areaName - the toggle area(e.g. location)
+ * @property {string} entityId - goes with area_name, specifies the  entity.
+ * @property {string} entityName - goes with area_name, specifies the  entity.
  * @property {GUID} contactId - contact id
  * @property {string} notificationName - The specifc notification that is toggled(on/off).
  * @property {string} targetEntity - The entity that the preferences is changed for.(e.g. owner/member/contact/msid)
@@ -23472,6 +23518,8 @@ export function sdkLoaded9000(params) {
  * @property {string} hosting_platform_context_id - context id: when the context is site - msid, when the context is app_id (like in devCenter f.e) - appDefId. In account manager is null
  * @property {string} internal_route - in case of internal page- in this field we will get the additional part of the route
  * @property {boolean} firstFromIframe - currently relevant for BM over editor
+ * @property {Url} url - url
+ * @property {string} builderType - builder type - relevant for BM over editor
  * @property {string} prevRoute - the previous route
  * @property {string} displayMode - main / overlay
  * @property {string} prevDisplayMode - previous display mode - main / overlay
@@ -23509,6 +23557,8 @@ export function gizaPageStartLoading9001(params) {
  * @property {number} loading_time - loading time from the moment the loader of the page is shown  (in milliseconds)
  * @property {boolean} firstFromIframe - currently relevant for BM over editor
  *
+ * @property {Url} url - url
+ * @property {string} builderType - builder type - relevant for BM over editor
  * @property {string} prevRoute - the previous route
  * @property {string} displayMode - main / overlay
  * @property {string} prevDisplayMode - previous display mode - main / overlay
@@ -23794,6 +23844,8 @@ export function wixInvoicesBannerWhenCreatingInvoiceOrder(params) {
  * @property {number} loading_time - loading time from event 9001 (page start load) until all the loaders are down (in milliseconds)
  * @property {boolean} firstFromIframe - currently relevant for BM over editor
  *
+ * @property {Url} url - url
+ * @property {string} builderType - builder type - relevant for BM over editor
  * @property {string} prevRoute - the previous route
  * @property {string} displayMode - main / overlay
  * @property {string} prevDisplayMode - previous display mode - main / overlay