@wix/bex-utils 2.66.0 → 2.68.0

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

@@ -10,6 +10,7 @@
  * @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
+ * @property {boolean} isAiSiteCreation - true - user created site using AI Site Creation flow; false- site was created by templates flow
  * @return {LogObject<bmOverEditorPanelClickSrc110Evid122Params>} LogObject<bmOverEditorPanelClickSrc110Evid122Params>
  */
 export function bmOverEditorPanelClickSrc110Evid122(params) {
@@ -23,6 +24,7 @@ export function bmOverEditorPanelClickSrc110Evid122(params) {
  * @param {dpKbMcpServerCallSrc11Evid1992Params} params - The parameters for this event
  * @property {string} service_status - the request status
  * @property {string} mcp_query - the mcp query
+ * @property {string} username - username
  * @return {LogObject<dpKbMcpServerCallSrc11Evid1992Params>} LogObject<dpKbMcpServerCallSrc11Evid1992Params>
  */
 export function dpKbMcpServerCallSrc11Evid1992(params) {
@@ -50,6 +52,31 @@ export function dpKbMcpServerCallSrc11Evid1992(params) {
 export function wixPatternsSummaryBarIsShownSrc144Evid1(params) {
     return { evid: 1, src: 144, endpoint: '', params };
 }
+/**
+ * A function to create a log object for the 'wixPatternsDeleteModalShownSrc144Evid10' event (evid: 10)
+ *
+ * Event description: Wix Patterns - Delete Modal Shown
+ *
+ * @param {wixPatternsDeleteModalShownSrc144Evid10Params} params - The parameters for this event
+ * @property {string} artifactId - Artifact that owns the component
+ * @property {string} location - CTA location: multi bulk action toolbar, bulk action toolbar, action cell, Customize columns action cell
+ * @property {GUID} csid - cairo sessionId
+ * @property {string} cairoVersion - Wix Patterns_version(cairo_version)
+ * @property {boolean} isSelectAll - Are all items in the list selected. numItems = filteredListSize ==> isSelectAll = TRUE
+ * @property {boolean} isTPA - is_tpa
+ * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
+ * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
+ * @property {string} itemId - ID of the item that the user clicked on its CTA
+ * @property {number} itemIndex - Out of the list of items, what is the index of the clicked item . ** filteredListSize = X --> (1 <= itemIndex <= X)
+ * @property {number} numItems - How many items have been selected
+ * @property {string} appId - app_id
+ * @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<wixPatternsDeleteModalShownSrc144Evid10Params>} LogObject<wixPatternsDeleteModalShownSrc144Evid10Params>
+ */
+export function wixPatternsDeleteModalShownSrc144Evid10(params) {
+    return { evid: 10, src: 144, endpoint: '', params };
+}
 /**
  * A function to create a log object for the 'wixPatternsPageInteractiveSrc144Evid1000' event (evid: 1000)
  *
@@ -308,6 +335,32 @@ export function pikachuCategoriesDropdownButtonClicked(params) {
 export function pikachuItemCategorySelected(params) {
     return { evid: 109, src: 144, endpoint: '', params };
 }
+/**
+ * A function to create a log object for the 'wixPatternsDeleteModalCtaClickedSrc144Evid11' event (evid: 11)
+ *
+ * Event description: Sent when a user clicks any CTA (e.g., Cancel, Close (X), Delete) within the Delete Modal.
+ *
+ * @param {wixPatternsDeleteModalCtaClickedSrc144Evid11Params} params - The parameters for this event
+ * @property {string} artifactId - Artifact that owns the component
+ * @property {string} location - CTA location: multi bulk action toolbar, bulk action toolbar, action cell, Customize columns action cell
+ * @property {GUID} csid - cairo sessionId
+ * @property {string} cairoVersion - Wix Patterns_version(cairo_version)
+ * @property {boolean} isSelectAll - Are all items in the list selected. numItems = filteredListSize ==> isSelectAll = TRUE
+ * @property {boolean} isTPA - is_tpa
+ * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
+ * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
+ * @property {string} ctaName - 'X', 'Cancel' , Delete' - in english
+ * @property {string} itemId - ID of the item that the user clicked on its CTA
+ * @property {number} itemIndex - Out of the list of items, what is the index of the clicked item . ** filteredListSize = X --> (1 <= itemIndex <= X)
+ * @property {number} numItems - How many items have been selected
+ * @property {string} appId - app_id
+ * @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<wixPatternsDeleteModalCtaClickedSrc144Evid11Params>} LogObject<wixPatternsDeleteModalCtaClickedSrc144Evid11Params>
+ */
+export function wixPatternsDeleteModalCtaClickedSrc144Evid11(params) {
+    return { evid: 11, src: 144, endpoint: '', params };
+}
 /**
  * A function to create a log object for the 'loadStart' event (evid: 110)
  *
@@ -334,6 +387,7 @@ export function pikachuItemCategorySelected(params) {
  * @property {string} providerId - provider Id
  * @property {string} providerName - providerName
  * @property {string} referralInfo - Referral from which the component was opened (dashboard or editor)
+ * @property {boolean} isAutoPatterns - true if the page was created via auto patterns, otherwise false
  * @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
@@ -386,6 +440,7 @@ export function loadStart(params) {
  * @property {string} currentKanban - relevant for TableKanbanSwitch
  * @property {string} referralInfo - Referral from which the component was opened (dashboard or editor)
  * @property {string} sectionsOverview - Relevant for components with sections: For each section, include the section name, number of items, and item IDs
+ * @property {boolean} isAutoPatterns - true if the page was created via auto patterns, otherwise false
  * @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
@@ -2629,6 +2684,153 @@ export function retryErrorSrc176Evid103(params) {
 export function httpClientErrorSrc176Evid404(params) {
     return { evid: 404, src: 176, endpoint: '', params };
 }
+/**
+ * A function to create a log object for the 'genericUserActionSrc193Evid2' event (evid: 2)
+ *
+ * Event description: Captures a user initiated event, describing the interaction type, intent, context, and target.
+ *
+ * @param {genericUserActionSrc193Evid2Params} params - The parameters for this event
+ * @property {string} actionType - Type of user interaction (limited to: click/drag/resize / crop / extend / rotate / drag_extend / drag_crop, or hover
+ * @property {string} actionIntent - The specific intent of the action, restricted to selection,navigation,add,delete,edit
+ * @property {string} hostingPlatform - The environment where the action took place. restricted to Editor/Home/Templated/Profile
+ * @property {string} origin - The source or context from which the action was triggered.
+ * Restricted to Project Setting, Add Panel, Smart Breakdown, Top Bar, Asset Panel
+ * @property {string} messageId - the message id if the action was initiated from an AI Assistant
+ * @property {string} conversationId - the conversation id if the action was initiated from an AI Assistant
+ * @property {string} entityType - The entity associated with the action (component, asset, or project).
+ * @property {string} entityId - the relevant id of the entity (project/asset/component)
+ * @property {string} actionName - The call-to-action performed by the user. Usually will be the button name.
+ * @property {string} requestId - The relevant request id if applicable
+ * @property {string} assetId - The relevant asset id if applicable
+ * @property {string} projectId - The relevant project id if applicable
+ * @property {string} componentId - The relevant component id if applicable
+ * @property {string} assetClass - The relevant asset class if applicable (Image  / Video / Logo / Events / Forms / PDF / Docs)
+ * @property {string} additionalInfo - Used by any consumer who wants to send specific content
+ * @return {LogObject<genericUserActionSrc193Evid2Params>} LogObject<genericUserActionSrc193Evid2Params>
+ */
+export function genericUserActionSrc193Evid2(params) {
+    return { evid: 2, src: 193, endpoint: '', params };
+}
+/**
+ * A function to create a log object for the 'panelLoadedSrc193Evid4' event (evid: 4)
+ *
+ * Event description: Captures a panel that was loaded in WWW
+ *
+ * @param {panelLoadedSrc193Evid4Params} params - The parameters for this event
+ * @property {string} panelType - Add Panel / Asset Panel
+ * @property {string} hostingPlatform - The environment where the action took place. restricted to Editor/Home/Templated/Profile
+ * @property {string} origin - The source or context from which the action was triggered.
+ * Restricted to Project Setting, Add Panel, Smart Breakdown, Top Bar, Asset Panel
+ * @property {number} duration - time to load panel in ms
+ * @return {LogObject<panelLoadedSrc193Evid4Params>} LogObject<panelLoadedSrc193Evid4Params>
+ */
+export function panelLoadedSrc193Evid4(params) {
+    return { evid: 4, src: 193, endpoint: '', params };
+}
+/**
+ * A function to create a log object for the 'errorSrc193Evid5' event (evid: 5)
+ *
+ * Event description: Captures a system or error event, detailing the error type, affected components, context, and user impact.
+ *
+ * @param {errorSrc193Evid5Params} params - The parameters for this event
+ * @property {string} errorType - Captures a system or user initiated error,  system/applicatiovalidation/network
+ * @property {string} requestId - The unique identifier of the request where the error happened.
+ * @property {string} errorMessage - The message displayed to the user in the error modal.
+ * Example: "Upload failed. Please try again.", "Cannot save changes. Check your input."
+ * @property {string} errorDescription - Adescription of what went wrong.
+ * "User input exceeded maximum length."
+ * @property {number} errorCode - A standardized code representing the error.
+ * @property {string} entityType - The entity associated with the action (component, asset, or project).
+ * @property {string} entityId - the relevant id of the entity (project/asset/component)
+ * @property {string} displayedAction - The action shown in the error modal when the error occurred.
+ * Example: "Retry Upload", "Save Changes", "Submit Form"
+ * @property {boolean} isDisplayed - Whether the error message was actually shown to the user.
+ * @property {string} origin - The source or context from which the action was triggered.
+ * Restricted to Project Setting, Add Panel, Smart Breakdown, Top Bar, Asset Panel
+ * @property {string} hostingPlatform - The environment where the action took place. restricted to Editor/Home/Templated/Profile
+ * @property {string} projectId - The relevant project id if applicable
+ *
+ * @property {boolean} isFatal - True if Wixel crashed because of the error, false otherwise
+ * @return {LogObject<errorSrc193Evid5Params>} LogObject<errorSrc193Evid5Params>
+ */
+export function errorSrc193Evid5(params) {
+    return { evid: 5, src: 193, endpoint: '', params };
+}
+/**
+ * A function to create a log object for the 'panelLoadedSrc193Evid6' event (evid: 6)
+ *
+ * Event description: Captures a panel that was loaded in WWW
+ *
+ * @param {panelLoadedSrc193Evid6Params} params - The parameters for this event
+ * @property {string} panelType - Add Panel / Asset Panel
+ * @property {string} hostingPlatform - The environment where the action took place. restricted to Editor/Home/Templated/Profile
+ * @property {string} origin - The source or context from which the action was triggered.
+ * Restricted to Project Setting, Add Panel, Smart Breakdown, Top Bar, Asset Panel
+ * @property {number} duration - time to load panel in ms
+ * @property {string} projectId - The relevant project id if applicable
+ * @return {LogObject<panelLoadedSrc193Evid6Params>} LogObject<panelLoadedSrc193Evid6Params>
+ */
+export function panelLoadedSrc193Evid6(params) {
+    return { evid: 6, src: 193, endpoint: '', params };
+}
+/**
+ * A function to create a log object for the 'panelClosedSrc193Evid7' event (evid: 7)
+ *
+ * Event description: Captures a panel that was closed in WWW
+ *
+ * @param {panelClosedSrc193Evid7Params} params - The parameters for this event
+ * @property {string} panelType - Add Panel / Asset Panel
+ * @property {string} hostingPlatform - The environment where the action took place. restricted to Editor/Home/Templated/Profile
+ * @property {string} origin - The source or context from which the action was triggered.
+ * Restricted to Project Setting, Add Panel, Smart Breakdown, Top Bar, Asset Panel
+ * @property {string} closingButton - X/Close
+ * @property {string} projectId - The relevant project id if applicable
+ *
+ * @return {LogObject<panelClosedSrc193Evid7Params>} LogObject<panelClosedSrc193Evid7Params>
+ */
+export function panelClosedSrc193Evid7(params) {
+    return { evid: 7, src: 193, endpoint: '', params };
+}
+/**
+ * A function to create a log object for the 'searchInitiatedSrc193Evid8' event (evid: 8)
+ *
+ * Event description: Captures a search execution
+ *
+ * @param {searchInitiatedSrc193Evid8Params} params - The parameters for this event
+ * @property {string} hostingPlatform - The environment where the action took place. restricted to Editor/Home/Templated/Profile
+ * @property {string} origin - Home search bar/Templated/account/editor
+ * @property {string} searchTerm - the search term of the user
+ * @property {number} resultsCnt - home many results returned from the search
+ * @property {string} resultsArray - an array/json of the search results (if templated then templates ids)
+ * @property {string} requestId - the relevant request id of the search
+ * @property {string} projectId - The relevant project id if applicable
+ *
+ * @property {number} duration - Loading time (in milliseconds) from when the user finished typing until the results are returned
+ * @return {LogObject<searchInitiatedSrc193Evid8Params>} LogObject<searchInitiatedSrc193Evid8Params>
+ */
+export function searchInitiatedSrc193Evid8(params) {
+    return { evid: 8, src: 193, endpoint: '', params };
+}
+/**
+ * A function to create a log object for the 'searchResultClickSrc193Evid9' event (evid: 9)
+ *
+ * Event description: Captures a search result click
+ *
+ * @param {searchResultClickSrc193Evid9Params} params - The parameters for this event
+ * @property {string} hostingPlatform - The environment where the action took place. restricted to Editor/Home/Templated/Profile
+ * @property {string} origin - Home search bar/Templated/account/editor
+ * @property {string} searchTerm - the search term of the user
+ * @property {number} itemIdx - the index of the item in the search results
+ * @property {string} resultName - the name of the result
+ * @property {string} resultValue - the value in case of a template
+ * @property {string} requestId - the relevant request id of the search
+ * @property {string} projectId - The relevant project id if applicable
+ *
+ * @return {LogObject<searchResultClickSrc193Evid9Params>} LogObject<searchResultClickSrc193Evid9Params>
+ */
+export function searchResultClickSrc193Evid9(params) {
+    return { evid: 9, src: 193, endpoint: '', params };
+}
 /**
  * A function to create a log object for the 'pingMarketingConsentUnsubscribeClickSrc19Evid10001' event (evid: 10001)
  *
@@ -9186,7 +9388,7 @@ export function teamManagementRemoveTeammateRemoveSuccess(params) {
  * @property {string} context - account/site
  * @property {string} origin - where the user clicked on invite people - team screen/site actions/roles list
  * @property {string} platform - platform
- * @property {boolean} upgrade_required - does the user need to upgrade his plan in order to be able to invite more contributors (contributors enforcement)
+ * @property {boolean} upgrade_required - does the user need to upgrade his plan in order to be able to invite more contributors (contributors enforcement). correct only for legacy app, for new app only triggered from collaborators table
  * @property {GUID} msid - sent only for site level
  * @property {string} app_id - app_id (context = app)
  * @return {LogObject<teamManagementInvitePeopleClickParams>} LogObject<teamManagementInvitePeopleClickParams>
@@ -14199,6 +14401,60 @@ export function invoicesMoreActionsChooseOption(params) {
 export function mobileClickOnCreateNewSite(params) {
     return { evid: 196, src: 5, endpoint: '', params };
 }
+/**
+ * A function to create a log object for the 'toolNotSupportedModalWasShownSrc5Evid1980' event (evid: 1980)
+ *
+ * Event description: When the user arrived to a tool that doesn't exist
+ *
+ * @param {toolNotSupportedModalWasShownSrc5Evid1980Params} params - The parameters for this event
+ * @property {string} hosting_platform - accountmanagr/bizmanagr/devcenter/etc.
+ * @property {string} referral_info - specific button triggered the the view loading (the referral info as in event 302)
+ * @property {number} screen_width - screen width
+ * @property {string} page_id - the page id (the component id of the page)
+ * @property {string} page_name - the component name of the page
+ * @property {number} window_width - window width
+ * @property {number} screen_height - screen height
+ * @property {string} app_id - the app id of the app the page belongs to
+ * @property {string} route - the page's route
+ * @property {number} window_height - window height
+ * @property {boolean} is_internal_page - true if it's an internal page
+ * @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 {Url} url - url
+ * @property {string} displayMode - main / overlay
+ * @return {LogObject<toolNotSupportedModalWasShownSrc5Evid1980Params>} LogObject<toolNotSupportedModalWasShownSrc5Evid1980Params>
+ */
+export function toolNotSupportedModalWasShownSrc5Evid1980(params) {
+    return { evid: 1980, src: 5, endpoint: '', params };
+}
+/**
+ * A function to create a log object for the 'toolNotSupportedModalActionSrc5Evid1981' event (evid: 1981)
+ *
+ * Event description: When the user vote/exit the modal is not supported
+ *
+ * @param {toolNotSupportedModalActionSrc5Evid1981Params} params - The parameters for this event
+ * @property {string} hosting_platform - accountmanagr/bizmanagr/devcenter/etc.
+ * @property {string} referral_info - specific button triggered the the view loading (the referral info as in event 302)
+ * @property {number} screen_width - screen width
+ * @property {string} page_id - the page id (the component id of the page)
+ * @property {string} page_name - the component name of the page
+ * @property {number} window_width - window width
+ * @property {number} screen_height - screen height
+ * @property {string} app_id - the app id of the app the page belongs to
+ * @property {string} route - the page's route
+ * @property {number} window_height - window height
+ * @property {boolean} is_internal_page - true if it's an internal page
+ * @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 {Url} url - url
+ * @property {string} action_type - exit/vote
+ * @property {string} cta - cta
+ * @property {string} displayMode - main / overlay
+ * @return {LogObject<toolNotSupportedModalActionSrc5Evid1981Params>} LogObject<toolNotSupportedModalActionSrc5Evid1981Params>
+ */
+export function toolNotSupportedModalActionSrc5Evid1981(params) {
+    return { evid: 1981, src: 5, endpoint: '', params };
+}
 /**
  * A function to create a log object for the 'dashboardFetchDealerLayoutFailed' event (evid: 1999)
  *
@@ -15632,7 +15888,7 @@ export function clickOnGoToEditorFromBmSrc5Evid3001(params) {
  * @property {string} action - load / click
  * @property {string} component - which component  name did the action apply on (name of page/modal/button)
  * @property {string} origin - name of previous step
- * @property {boolean} isPremiumSite - is the site already premium
+ * @property {boolean} isPremiumSite - is the site already in premium *ELITE* plan
  * @property {boolean} isActive - is hipaa add-on active
  * @property {string} value - type of button chosen
  * @property {string} selection - selected preference
@@ -21912,6 +22168,8 @@ export function crmHomeWorkflowsWidgetGoToWorkflows(params) {
  * @property {GUID} msid - metasite id
  * @property {string} trigger_entity_id - trigger_entity_id
  * @property {string} toast_timeout - toast_timeout
+ * @property {boolean} hasRequestId - boolean field. true if the toast contains request id
+ * @property {string} toastId - A unique identifier for a toast
  * @property {string} message - message
  * @property {string} app_id - app_id
  * @return {LogObject<toastShown85Params>} LogObject<toastShown85Params>
@@ -21999,6 +22257,9 @@ export function crmHomeIntegrationsCommunicationsConnect(params) {
  * @property {GUID} msid - metasite id
  * @property {string} trigger_entity_id - trigger_entity_id
  * @property {string} toast_timeout - toast_timeout
+ * @property {string} ctaName - request id
+ * @property {string} requestId - the relevant request id
+ * @property {string} toastId - A unique identifier for a toast
  * @return {LogObject<toastClicked86Params>} LogObject<toastClicked86Params>
  */
 export function toastClicked86(params) {