@wix/bex-utils 2.41.0 → 2.43.0

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

@@ -189,6 +189,7 @@ export function pickerPickerOpenButton(params) {
  * @property {string} appId - app_id
  * @property {number} filteredListSize - How many items are currently presented to user (filtered)
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
+ * @property {string} consumerArtifactId - consumerArtifactId  - relevant for item selection
  * @return {LogObject<newItemCreationStartParams>} LogObject<newItemCreationStartParams>
  */
 export function newItemCreationStart(params) {
@@ -224,6 +225,7 @@ export function newItemCreationStart(params) {
  * @property {string} appId - app_id
  * @property {number} filteredListSize - How many items are currently presented to user (filtered)
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
+ * @property {string} consumerArtifactId - consumerArtifactId  - relevant for item selection
  * @return {LogObject<newItemCreationEndParams>} LogObject<newItemCreationEndParams>
  */
 export function newItemCreationEnd(params) {
@@ -300,6 +302,8 @@ export function pikachuItemCategorySelected(params) {
  * @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
+ * @property {string} consumerId - consumer Id - relevant for artifact_id = item selection module
+ * @property {string} consumerArtifactId - consumerArtifactId  - relevant for item selection
  * @property {boolean} routerUsage - returns true if Wix Patterns router is being used, else false
  *
  * @property {boolean} isCurrentViewCustomMade -  will be True if the current view is custom-made; otherwise, it will be False
@@ -342,6 +346,9 @@ export function loadStart(params) {
  * @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
+ * @property {string} consumerId - consumer Id - relevant for artifact_id = item selection module
+ * @property {string} consumerArtifactId - consumerArtifactId - relevant for item selection
+ * @property {string} route - The page's route
  * @property {boolean} routerUsage - returns true if Wix Patterns router is being used, else false
  * @property {boolean} isCurrentViewCustomMade - will be True if the current view is custom-made; otherwise, it will be False
  *
@@ -539,6 +546,8 @@ export function cairoSearchResults(params) {
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
  * @property {string} filterType - The type of the filter - Multi Selection, Single Selection, Number Range
  * @property {boolean} isCustomField - true if the field is customized
+ * @property {number} loadingTime - Component loading time (in ms) after toggling
+ * @property {boolean} isOriginComponentLoaded - True if the original component was loaded before toggling
  * @return {LogObject<cairoFilterToggledParams>} LogObject<cairoFilterToggledParams>
  */
 export function cairoFilterToggled(params) {
@@ -2111,6 +2120,7 @@ export function cairoSearchForTags(params) {
  * @property {string} itemId - The entity ID (that the widget was loaded in its page)
  * @property {string} appId - app_id
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
+ * @property {string} theme - Card/ Inline
  * @return {LogObject<cairoTagsWidgetLoadedParams>} LogObject<cairoTagsWidgetLoadedParams>
  */
 export function cairoTagsWidgetLoaded(params) {
@@ -2136,6 +2146,7 @@ export function cairoTagsWidgetLoaded(params) {
  * @property {string} itemId - The entity ID
  * @property {string} appId - app_id
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
+ * @property {string} theme - Card/ Inline
  * @return {LogObject<cairoTagsWidgetClickOnCtaParams>} LogObject<cairoTagsWidgetClickOnCtaParams>
  */
 export function cairoTagsWidgetClickOnCta(params) {
@@ -2165,6 +2176,7 @@ export function cairoTagsWidgetClickOnCta(params) {
  * @property {string} appId - app_id
  * @property {boolean} isFromSearch - Is the action made from a list of tags search results?
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
+ * @property {string} theme - Card/ Inline
  * @return {LogObject<cairoTagsAssignTagParams>} LogObject<cairoTagsAssignTagParams>
  */
 export function cairoTagsAssignTag(params) {
@@ -2471,6 +2483,7 @@ export function httpClientErrorMappingSrc176Evid100(params) {
  *
  * @param {getResolvedErrorSrc176Evid101Params} params - The parameters for this event
  * @property {string} session_id - the key for connecting the error event
+ * @property {boolean} isEn - True if the user sees the message in english
  * @property {string} mapped_error_not_available - mapped_error_not_available
  * @property {string} translated_message - the translated message of the error
  * @property {string} action_text - the action of the text
@@ -2488,6 +2501,7 @@ export function getResolvedErrorSrc176Evid101(params) {
  *
  * @param {showErrorSrc176Evid102Params} params - The parameters for this event
  * @property {string} session_id - the key for connecting the error event
+ * @property {boolean} isEn - True if the user sees the message in english
  * @property {string} displayed_message - displayed_message to the user
  * @property {string} displayed_action - displayed_action to the user
  * @property {string} action_was_provided - action_was_provided
@@ -2496,6 +2510,18 @@ export function getResolvedErrorSrc176Evid101(params) {
 export function showErrorSrc176Evid102(params) {
     return { evid: 102, src: 176, endpoint: '', params };
 }
+/**
+ * A function to create a log object for the 'retryErrorSrc176Evid103' event (evid: 103)
+ *
+ * Event description: Support cases of errors retries
+ *
+ * @param {retryErrorSrc176Evid103Params} params - The parameters for this event
+ * @property {string} session_id - the key for connecting the error event
+ * @return {LogObject<retryErrorSrc176Evid103Params>} LogObject<retryErrorSrc176Evid103Params>
+ */
+export function retryErrorSrc176Evid103(params) {
+    return { evid: 103, src: 176, endpoint: '', params };
+}
 /**
  * A function to create a log object for the 'httpClientErrorSrc176Evid404' event (evid: 404)
  *
@@ -2512,6 +2538,7 @@ export function showErrorSrc176Evid102(params) {
  * @property {string} is_override_error_state_function - is_override_error_state_function
  * @property {string} error_json - the full error json
  * @property {string} translated_message - translated_message
+ * @property {string} method - HTTP request method (GET,POST,HEAD etc.)
  * @property {string} error_message - the error message from the json
  * @property {string} exception_message - exception message
  * @property {string} client_error_code - client error code (browser code)
@@ -2995,6 +3022,8 @@ export function dashboardDeleteAndRestoreSiteOpenPopup(params) {
  * @property {number} score - accuracy of the page type
  * @property {Url} url - url
  * @property {string} previewUrl - preview
+ * @property {boolean} isPatternsPage - yes if it is on Patterns
+ * @property {string} fullRoute - Full Route
  * @return {LogObject<pageClassifierSrc5Evid10000Params>} LogObject<pageClassifierSrc5Evid10000Params>
  */
 export function pageClassifierSrc5Evid10000(params) {
@@ -9111,14 +9140,15 @@ export function teamManagementInvitePeoplePageLoad(params) {
 /**
  * A function to create a log object for the 'teamManagementInvitePeopleSendInvite' event (evid: 1411)
  *
- * Event description: User clicks on 'send invite' in the add people window
+ * Event description: User clicks on 'send invite' in the add people window.
+ *
+ *
  *
  * @param {teamManagementInvitePeopleSendInviteParams} params - The parameters for this event
  * @property {string} context - account/site
  * @property {number} number_of_invalid_emails - number of invalid emails (only errors for not typing correctly - exclude errors for existing emails)
  * @property {string} invite_role_ids - the role_ids that the user sends to the invitees
  * @property {string} assignment_type - all/specific
- * @property {number} number_of_existing_emails - emails that already exist in the team
  * @property {string} origin - where the modal was clicked from
  * @property {GUID} invite_id - the invite_id
  * @property {number} num_sites - the distinct number of sites in the invite (null if all)
@@ -9128,6 +9158,7 @@ export function teamManagementInvitePeoplePageLoad(params) {
  * @property {number} num_folders - the distinct number of folders in the invite (null if all)
  * @property {number} contributors_quota - How many contributors can be added to the site based on the premium package quota
  *
+ * @property {string} invite_role_names - the names of the rols assigned in the invite.
  * @property {number} contributors_count - How many contributors are actually active on the site
  * @property {string} app_id - app_id (context = app)
  * @property {boolean} Has_ai_assistant - Does the user has AI assistant on this page
@@ -9244,8 +9275,6 @@ export function teamManagementManageRolesRolePageLoad(params) {
  * @property {string} role_id - role_id of the role that the user is duplicating
  * @property {string} role_type - custom/predefined
  * @property {string} origin - where the user clicked from - roles list/role page
- * @property {string} platform - platform
- * @property {GUID} msid - msid
  * @return {LogObject<teamManagementManageRolesDuplicateAndEditRoleParams>} LogObject<teamManagementManageRolesDuplicateAndEditRoleParams>
  */
 export function teamManagementManageRolesDuplicateAndEditRole(params) {
@@ -9259,8 +9288,8 @@ export function teamManagementManageRolesDuplicateAndEditRole(params) {
  * @param {teamManagementManageRolesEditCustomRoleParams} params - The parameters for this event
  * @property {string} context - account/site
  * @property {string} role_id - the role_id
- * @property {string} platform - platform
  * @property {GUID} msid - msid
+ * @property {string} origin - where the user clicked from - roles list/role page
  * @return {LogObject<teamManagementManageRolesEditCustomRoleParams>} LogObject<teamManagementManageRolesEditCustomRoleParams>
  */
 export function teamManagementManageRolesEditCustomRole(params) {
@@ -13724,6 +13753,24 @@ export function searchToDeleteSrc5Evid1847(params) {
 export function teamManagementResendInviteClick(params) {
     return { evid: 185, src: 5, endpoint: '', params };
 }
+/**
+ * A function to create a log object for the 'leavingWithoutSavingModalOpenedSrc5Evid1858' event (evid: 1858)
+ *
+ * Event description: Leaving without saving -  modal opened
+ *
+ * @param {leavingWithoutSavingModalOpenedSrc5Evid1858Params} params - The parameters for this event
+ * @property {string} hosting_platform - accountmanagr/bizmanagr/devcenter/etc.
+ * @property {string} page_id - the page id (the component id of the page)
+ * @property {string} page_name - the component name of the page
+ * @property {string} route - the page's route
+ * @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 {string} displayMode - main / overlay
+ * @return {LogObject<leavingWithoutSavingModalOpenedSrc5Evid1858Params>} LogObject<leavingWithoutSavingModalOpenedSrc5Evid1858Params>
+ */
+export function leavingWithoutSavingModalOpenedSrc5Evid1858(params) {
+    return { evid: 1858, src: 5, endpoint: '', params };
+}
 /**
  * A function to create a log object for the 'dashboardContributorsClickOnMangeRolesAndPermissions' event (evid: 187)
  *
@@ -13739,6 +13786,99 @@ export function teamManagementResendInviteClick(params) {
 export function dashboardContributorsClickOnMangeRolesAndPermissions(params) {
     return { evid: 187, src: 5, endpoint: '', params };
 }
+/**
+ * A function to create a log object for the 'rolesAndPermissionsManageRolesEditRoleSrc5Evid1871' event (evid: 1871)
+ *
+ * Event description: User clicks on 'edit role' (and not edit & duplicate) from the role actions menu (considered as creating a new role). The user can click on a custom role or a pre-defined role.
+ *
+ * @param {rolesAndPermissionsManageRolesEditRoleSrc5Evid1871Params} params - The parameters for this event
+ * @property {string} context - account/site
+ * @property {string} role_id - role_id of the role that the user is duplicating
+ * @property {string} role_type - custom/predefined
+ * @property {string} origin - where the user clicked from - roles list/role page
+ * @property {string} platform - platform
+ * @property {string} role_name - role_name of the role that the user is duplicating
+ * @property {boolean} Has_ai_assistant - Is He had AI assistant? (True/False)
+ * @return {LogObject<rolesAndPermissionsManageRolesEditRoleSrc5Evid1871Params>} LogObject<rolesAndPermissionsManageRolesEditRoleSrc5Evid1871Params>
+ */
+export function rolesAndPermissionsManageRolesEditRoleSrc5Evid1871(params) {
+    return { evid: 1871, src: 5, endpoint: '', params };
+}
+/**
+ * A function to create a log object for the 'rolesAndPermissionsInviteTeammatesSendInviteClickSrc5Evid1874' event (evid: 1874)
+ *
+ * Event description: User clicks on 'send invites' in the invite Teammates window (user level only).
+ *
+ * @param {rolesAndPermissionsInviteTeammatesSendInviteClickSrc5Evid1874Params} params - The parameters for this event
+ * @property {string} context - account
+ * @property {string} origin - where the modal was clicked from
+ * @property {GUID} invite_id - the invite_id
+ * @property {number} number_of_valid_emails - number of valid emails
+ * @property {string} role_ids - the role_ids that the user sends to the invitees alongside binary indicator for the 'All sites and folders' (True for usage in this).
+ * @property {string} app_id - The team account id
+ * @property {boolean} Has_ai_assistant - Does the user has AI assistant on this page
+ *
+ * @return {LogObject<rolesAndPermissionsInviteTeammatesSendInviteClickSrc5Evid1874Params>} LogObject<rolesAndPermissionsInviteTeammatesSendInviteClickSrc5Evid1874Params>
+ */
+export function rolesAndPermissionsInviteTeammatesSendInviteClickSrc5Evid1874(params) {
+    return { evid: 1874, src: 5, endpoint: '', params };
+}
+/**
+ * A function to create a log object for the 'restoreSiteModalOpenedSrc5Evid1875' event (evid: 1875)
+ *
+ * Event description: Restore site -  modal opened
+ *
+ * @param {restoreSiteModalOpenedSrc5Evid1875Params} params - The parameters for this event
+ * @property {string} hosting_platform - accountmanagr/bizmanagr/devcenter/etc.
+ * @property {string} page_id - the page id (the component id of the page)
+ * @property {string} page_name - the component name of the page
+ * @property {string} route - the page's route
+ * @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 {string} origin - The origin from which the modal was opened
+ * @return {LogObject<restoreSiteModalOpenedSrc5Evid1875Params>} LogObject<restoreSiteModalOpenedSrc5Evid1875Params>
+ */
+export function restoreSiteModalOpenedSrc5Evid1875(params) {
+    return { evid: 1875, src: 5, endpoint: '', params };
+}
+/**
+ * A function to create a log object for the 'restoreSiteModalCtaClickedSrc5Evid1876' event (evid: 1876)
+ *
+ * Event description: Restore site – Modal CTA clicked
+ *
+ * @param {restoreSiteModalCtaClickedSrc5Evid1876Params} params - The parameters for this event
+ * @property {string} hosting_platform - accountmanagr/bizmanagr/devcenter/etc.
+ * @property {string} page_id - the page id (the component id of the page)
+ * @property {string} page_name - the component name of the page
+ * @property {string} route - the page's route
+ * @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 {string} cta - Keep in trash / Restore site
+ * @property {string} origin - The origin from which the modal was opened
+ * @return {LogObject<restoreSiteModalCtaClickedSrc5Evid1876Params>} LogObject<restoreSiteModalCtaClickedSrc5Evid1876Params>
+ */
+export function restoreSiteModalCtaClickedSrc5Evid1876(params) {
+    return { evid: 1876, src: 5, endpoint: '', params };
+}
+/**
+ * A function to create a log object for the 'leavingWithoutSavingModalCtaClickedSrc5Evid1878' event (evid: 1878)
+ *
+ * Event description: Leaving without saving – Modal CTA clicked
+ *
+ * @param {leavingWithoutSavingModalCtaClickedSrc5Evid1878Params} params - The parameters for this event
+ * @property {string} hosting_platform - accountmanagr/bizmanagr/devcenter/etc.
+ * @property {string} page_id - the page id (the component id of the page)
+ * @property {string} page_name - the component name of the page
+ * @property {string} route - the page's route
+ * @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 {string} cta - Exit (click on x), Leave, Keep editing (in english)
+ * @property {string} displayMode - main / overlay
+ * @return {LogObject<leavingWithoutSavingModalCtaClickedSrc5Evid1878Params>} LogObject<leavingWithoutSavingModalCtaClickedSrc5Evid1878Params>
+ */
+export function leavingWithoutSavingModalCtaClickedSrc5Evid1878(params) {
+    return { evid: 1878, src: 5, endpoint: '', params };
+}
 /**
  * A function to create a log object for the 'ascendHoverOnUpgradeAscend' event (evid: 188)
  *
@@ -14250,6 +14390,7 @@ export function osFavoritesPopupCtaClicked(params) {
  * @property {string} favoritesName - the component name of the page that the user picks
  * @property {boolean} wasSuccess - Send true if the action completed successfully
  * @property {string} hostingPlatformContextId - 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} origin - Favorites popup / sidebar
  * @return {LogObject<osFavoritesPagesEditParams>} LogObject<osFavoritesPagesEditParams>
  */
 export function osFavoritesPagesEdit(params) {
@@ -21330,6 +21471,7 @@ export function gdprUsersUserGdprFormSubmissionFailed(params) {
  * @property {Url} url - url
  * @property {string} origin - origin
  * @property {string} action - accept/settings/dismiss/read_policy/render/decline_all/save/hide
+ * @property {string} esi - esi
  * @return {LogObject<cookiesBannerCtaParams>} LogObject<cookiesBannerCtaParams>
  */
 export function cookiesBannerCta(params) {
@@ -21344,6 +21486,7 @@ export function cookiesBannerCta(params) {
  * @property {Url} url - url
  * @property {boolean} toggle - (optional) on/off
  * @property {string} action - save/dismiss/toggle/read_policy
+ * @property {string} esi - esi
  * @return {LogObject<cookiesBannerSettingsWindowCtaParams>} LogObject<cookiesBannerSettingsWindowCtaParams>
  */
 export function cookiesBannerSettingsWindowCta(params) {