@vtex/faststore-plugin-buyer-portal 1.3.27 → 1.3.28

package/src/features/shared/services/logger/analytics/types.ts

@@ -0,0 +1,108 @@
+/**
+ * Analytics event categories
+ */
+export type EventCategory =
+  | "click"
+  | "view"
+  | "apiAnswer"
+  | "webVitals"
+  | "creation"
+  | "edition"
+  | "error"
+  | "timing"
+  | "interaction";
+
+/**
+ * Analytics event fields
+ */
+export interface DataIngestionApiFields {
+  /** The type of the event */
+  event_category?: EventCategory;
+  /** The name of the event. Has to be unique through the app. */
+  event_name: string;
+  /** Additional informations */
+  /** Time spent on page */
+  time_on_page?: number;
+  /** Additional metadata about the event */
+  metadata?: Record<string, unknown>;
+  /** Entity type (e.g., 'budget', 'buying_policy') */
+  entity_type?: string;
+  /** Entity ID */
+  entity_id?: string;
+  /** Is this a new entity? */
+  is_new?: boolean;
+  /** Duration in milliseconds */
+  duration_ms?: number;
+  /** Step name for multi-step flows */
+  step_name?: string;
+  /** Flow name for multi-step flows */
+  flow_name?: string;
+  /** Component type for interactions */
+  component_type?: string;
+  /** Action performed */
+  action?: string;
+}
+
+/**
+ * Internal params for data ingestion API
+ */
+export interface DataIngestionApiParams {
+  [key: string]: string | number | boolean | object | undefined;
+  workspace?: string;
+}
+
+/**
+ * Step timing properties
+ */
+export interface StepTimingProperties {
+  flow_name: string;
+  step_name: string;
+  from_step?: string;
+  to_step?: string;
+  duration_ms: number;
+  step_index?: number;
+  total_steps?: number;
+}
+
+/**
+ * Error tracking properties
+ */
+export interface ErrorEventProperties {
+  error_message: string;
+  error_type?: string;
+  error_stack?: string;
+  entity_type?: string;
+  entity_id?: string;
+  is_new_entity: boolean;
+  operation?: string; // create, update, delete
+}
+
+/**
+ * Interaction properties
+ */
+export interface InteractionEventProperties {
+  component_type: string;
+  component_id?: string;
+  action: string;
+  selected_option?: string;
+  metadata?: Record<string, unknown>;
+}
+
+/**
+ * Generic entity creation properties
+ */
+export interface EntityCreatedProperties {
+  entity_type: string;
+  entity_id?: string;
+  properties: Record<string, unknown>;
+}
+
+/**
+ * Generic entity edition properties
+ */
+export interface EntityEditedProperties {
+  entity_type: string;
+  entity_id: string;
+  changed_fields?: string[];
+  properties: Record<string, unknown>;
+}

package/src/features/shared/services/logger/index.ts

@@ -2,3 +2,4 @@ export * from "./types";
 export * from "./constants";
 export * from "./context";
 export * from "./otlp-logger.service";
+export * from "./analytics/analytics";

package/src/features/shared/utils/constants.ts

@@ -13,4 +13,4 @@ export const LOCAL_STORAGE_LOCATION_EDIT_KEY = "bp_hide_edit_location_confirm";
 export const LOCAL_STORAGE_RECIPIENT_EDIT_KEY =
   "bp_hide_edit_recipient_confirm";
 
-export const CURRENT_VERSION = "1.3.27";
+export const CURRENT_VERSION = "1.3.28";

package/src/features/users/components/CreateUserDrawer/CreateUserDrawer.tsx

@@ -12,6 +12,8 @@ import {
   Icon,
   InputText,
 } from "../../../shared/components";
+import { useAnalytics } from "../../../shared/hooks";
+import { ANALYTICS_EVENTS } from "../../../shared/services/logger/analytics/constants";
 import { buyerPortalRoutes } from "../../../shared/utils/buyerPortalRoutes";
 import { maskPhoneNumber } from "../../../shared/utils/phoneNumber";
 import { useAddUserToOrgUnit } from "../../hooks";
@@ -31,6 +33,11 @@ export const CreateUserDrawer = ({
 }: CreateUserDrawerProps) => {
   const { pushToast } = useUI();
   const router = useRouter();
+  const { trackEntityCreated, trackEntityCreateError } = useAnalytics({
+    entityType: "user",
+    defaultTimerName: "user_creation",
+    shouldTrackDefaultTimer: true,
+  });
   const [drawerState, setDrawerState] = useState<
     "CREATE_USER" | "USER_ALREADY_EXISTS"
   >("CREATE_USER");
@@ -74,6 +81,15 @@ export const CreateUserDrawer = ({
   };
 
   const handleAddUserSuccess = ({ user }: { user: { id: string } }) => {
+    trackEntityCreated(ANALYTICS_EVENTS.USER_CREATED, "user", {
+      user_name: name,
+      user_email: email,
+      user_phone: phone,
+      roles_count: roles.length,
+      role_ids: roles,
+      org_unit_id: orgUnitId,
+    });
+
     pushToast({
       message: "User successfully added",
       status: "INFO",
@@ -112,6 +128,14 @@ export const CreateUserDrawer = ({
         };
       };
 
+      trackEntityCreateError(ANALYTICS_EVENTS.USER_CREATE_ERROR, err, {
+        org_unit_id: orgUnitId,
+        error_type:
+          error.code === "USER_ALREADY_EXISTS"
+            ? "user_already_exists"
+            : "unknown",
+      });
+
       setUserAlreadyInUse({
         ...error.user,
         orgUnit: error.orgUnit,

package/src/features/users/components/DeleteUserDrawer/DeleteUserDrawer.tsx

@@ -8,6 +8,8 @@ import {
   InputText,
   type BasicDrawerProps,
 } from "../../../shared/components";
+import { useAnalytics } from "../../../shared/hooks";
+import { ANALYTICS_EVENTS } from "../../../shared/services/logger/analytics/constants";
 import { buyerPortalRoutes } from "../../../shared/utils/buyerPortalRoutes";
 import { useRemoveUserFromOrgUnit } from "../../hooks";
 
@@ -26,10 +28,22 @@ export const DeleteUserDrawer = ({
   const [userNameConfirmation, setUserNameConfirmation] = useState("");
 
   const { pushToast } = useUI();
-
   const { orgUnit } = useOrgUnitByUser(user.id);
+  const { trackEvent } = useAnalytics({
+    entityType: "user",
+    entityId: user.id,
+    defaultTimerName: "user_delete",
+    shouldTrackDefaultTimer: true,
+  });
 
   const handleRemoveSuccess = () => {
+    trackEvent(ANALYTICS_EVENTS.USER_DELETED, {
+      user_id: user.id,
+      user_name: user.name,
+      org_unit_id: orgUnit?.id,
+      entity_type: "user",
+    });
+
     pushToast({
       message: "User successfully deleted",
       status: "INFO",
@@ -52,7 +66,14 @@ export const DeleteUserDrawer = ({
   const { removeUserFromOrgUnit, isRemoveUserFromOrgUnitLoading } =
     useRemoveUserFromOrgUnit({
       onSuccess: handleRemoveSuccess,
-      onError: () => {
+      onError: (error) => {
+        trackEvent(ANALYTICS_EVENTS.USER_DELETE_ERROR, {
+          entity_id: user.id,
+          user_name: user.name,
+          error_message: error instanceof Error ? error.message : String(error),
+          org_unit_id: orgUnit?.id,
+        });
+
         pushToast({
           message: "An error occurred while deleting the user",
           status: "ERROR",

package/src/features/users/components/UpdateUserDrawer/UpdateUserDrawer.tsx

@@ -1,4 +1,4 @@
-import { useState } from "react";
+import { useRef, useState } from "react";
 
 import { Skeleton, useUI } from "@faststore/ui";
 
@@ -10,6 +10,8 @@ import {
   ErrorMessage,
   InputText,
 } from "../../../shared/components";
+import { useAnalytics } from "../../../shared/hooks";
+import { ANALYTICS_EVENTS } from "../../../shared/services/logger/analytics/constants";
 import { maskPhoneNumber } from "../../../shared/utils/phoneNumber";
 import { useGetUserById, useUpdateUser } from "../../hooks";
 
@@ -29,16 +31,25 @@ export const UpdateUserDrawer = ({
   ...props
 }: UpdateUserDrawerProps) => {
   const { pushToast } = useUI();
+  const { trackEntityEdited, trackEntityEditError } = useAnalytics({
+    entityType: "user",
+    entityId: userId,
+    defaultTimerName: "user_edit",
+    shouldTrackDefaultTimer: true,
+  });
+  const initialRolesRef = useRef<string[]>([]);
 
   const { isUserLoading } = useGetUserById(
     { orgUnitId, userId },
     {
       onSuccess: (data) => {
+        const userRoles = data?.roles ? data.roles : [];
+        initialRolesRef.current = userRoles;
         setForm({
           name: data?.name ?? "",
           email: data?.email ?? "",
           phone: data?.phone ?? "",
-          roles: data?.roles ? data.roles : [],
+          roles: userRoles,
         });
       },
       onError: () => {
@@ -74,6 +85,16 @@ export const UpdateUserDrawer = ({
   };
 
   const handleUpdateUserSuccess = () => {
+    trackEntityEdited(ANALYTICS_EVENTS.USER_EDITED, {
+      user_id: userId,
+      user_name: name,
+      user_phone: phone,
+      old_roles: initialRolesRef.current,
+      new_roles: roles,
+      roles_count: roles.length,
+      org_unit_id: orgUnitId,
+    });
+
     pushToast({
       message: "User successfully updated",
       status: "INFO",
@@ -84,7 +105,17 @@ export const UpdateUserDrawer = ({
 
   const { updateUser, isUpdateUserLoading } = useUpdateUser({
     onSuccess: handleUpdateUserSuccess,
-    onError: () => {
+    onError: (error) => {
+      trackEntityEditError(
+        ANALYTICS_EVENTS.USER_EDIT_ERROR,
+        "user",
+        userId,
+        error,
+        {
+          org_unit_id: orgUnitId,
+        }
+      );
+
       pushToast({
         message: "Failed to update user",
         status: "ERROR",
@@ -94,7 +125,17 @@ export const UpdateUserDrawer = ({
 
   const { updateRoles, isUpdateRolesLoading } = useUpdateRoles({
     onSuccess: handleUpdateUserSuccess,
-    onError: () => {
+    onError: (error) => {
+      trackEntityEditError(
+        ANALYTICS_EVENTS.USER_EDIT_ERROR,
+        "user",
+        userId,
+        error,
+        {
+          org_unit_id: orgUnitId,
+        }
+      );
+
       pushToast({
         message: "Failed to update user",
         status: "ERROR",