@databiosphere/findable-ui 52.1.0 → 52.2.0

package/lib/common/analytics/entities.d.ts

@@ -13,7 +13,8 @@ export declare enum EVENT_NAME {
     FILE_DOWNLOADED = "file_downloaded",
     FILTER_SELECTED = "filter_selected",
     INDEX_ANALYZE_IN_TERRA_REQUESTED = "index_analyze_in_terra_requested",
-    INDEX_FILE_MANIFEST_REQUESTED = "index_file_manifest_requested"
+    INDEX_FILE_MANIFEST_REQUESTED = "index_file_manifest_requested",
+    LOGIN = "login"
 }
 /**
  * Set of analytics event parameters.
@@ -78,4 +79,7 @@ export type EventParams = {
     [EVENT_NAME.INDEX_FILE_MANIFEST_REQUESTED]: {
         [EVENT_PARAM.ENTITY_NAME]: string;
     };
+    [EVENT_NAME.LOGIN]: {
+        [EVENT_PARAM.TOOL_NAME]: string;
+    };
 };

package/lib/common/analytics/entities.js

@@ -14,6 +14,7 @@ export var EVENT_NAME;
     EVENT_NAME["FILTER_SELECTED"] = "filter_selected";
     EVENT_NAME["INDEX_ANALYZE_IN_TERRA_REQUESTED"] = "index_analyze_in_terra_requested";
     EVENT_NAME["INDEX_FILE_MANIFEST_REQUESTED"] = "index_file_manifest_requested";
+    EVENT_NAME["LOGIN"] = "login";
 })(EVENT_NAME || (EVENT_NAME = {}));
 /**
  * Set of analytics event parameters.

package/lib/google/provider.js

@@ -8,6 +8,7 @@ import { useCredentialsReducer } from "../auth/hooks/useCredentialsReducer";
 import { useSessionIdleTimer } from "../auth/hooks/useSessionIdleTimer";
 import { useSessionActive } from "../hooks/authentication/session/useSessionActive";
 import { useSessionCallbackUrl } from "../hooks/authentication/session/useSessionCallbackUrl";
+import { useLoginTracking } from "../hooks/authentication/useLoginTracking";
 import { AUTH_STATE, AUTHENTICATION_STATE } from "./constants";
 import { useGoogleSignInService } from "./hooks/useGoogleSignInService";
 import { useTokenReducer } from "./hooks/useTokenReducer";
@@ -35,6 +36,7 @@ export function GoogleSignInAuthenticationProvider({ children, SessionController
     const { authDispatch, authState } = authReducer;
     const { isAuthenticated } = authState;
     const { authenticationState } = authenticationReducer;
+    useLoginTracking(isAuthenticated, authState.status);
     useSessionActive(authState, authenticationState);
     useSessionIdleTimer({
         disabled: !isAuthenticated,

package/lib/hooks/authentication/useLoginTracking.d.ts

@@ -0,0 +1,9 @@
+import { AUTH_STATUS } from "../../auth/types/auth";
+/**
+ * Tracks a GA4 login event when the user transitions from unauthenticated to authenticated.
+ * Does not fire during initial session hydration or on mount if already authenticated.
+ * @param isAuthenticated - Current authentication state.
+ * @param status - Current auth status; tracking only begins after status has settled.
+ * @returns void.
+ */
+export declare function useLoginTracking(isAuthenticated: boolean, status: AUTH_STATUS): void;

package/lib/hooks/authentication/useLoginTracking.js

@@ -0,0 +1,25 @@
+import { useEffect, useRef } from "react";
+import { AUTH_STATUS } from "../../auth/types/auth";
+import { track } from "../../common/analytics/analytics";
+import { EVENT_NAME, EVENT_PARAM } from "../../common/analytics/entities";
+import { GOOGLE_SIGN_IN_PROVIDER_ID } from "../../google/constants";
+/**
+ * Tracks a GA4 login event when the user transitions from unauthenticated to authenticated.
+ * Does not fire during initial session hydration or on mount if already authenticated.
+ * @param isAuthenticated - Current authentication state.
+ * @param status - Current auth status; tracking only begins after status has settled.
+ * @returns void.
+ */
+export function useLoginTracking(isAuthenticated, status) {
+    const wasAuthenticated = useRef(undefined);
+    useEffect(() => {
+        if (status !== AUTH_STATUS.SETTLED)
+            return;
+        if (wasAuthenticated.current === false && isAuthenticated) {
+            track(EVENT_NAME.LOGIN, {
+                [EVENT_PARAM.TOOL_NAME]: GOOGLE_SIGN_IN_PROVIDER_ID,
+            });
+        }
+        wasAuthenticated.current = isAuthenticated;
+    }, [isAuthenticated, status]);
+}

package/lib/nextauth/provider.js

@@ -6,6 +6,7 @@ import { useAuthenticationReducer } from "../auth/hooks/useAuthenticationReducer
 import { useAuthReducer } from "../auth/hooks/useAuthReducer";
 import { useSessionIdleTimer } from "../auth/hooks/useSessionIdleTimer";
 import { useSessionCallbackUrl } from "../hooks/authentication/session/useSessionCallbackUrl";
+import { useLoginTracking } from "../hooks/authentication/useLoginTracking";
 import { useNextAuthService } from "./hooks/useNextAuthService";
 import { SessionController } from "./session-controller";
 /**
@@ -23,6 +24,7 @@ export function NextAuthAuthenticationProvider({ children, refetchInterval = 0,
     const service = useNextAuthService();
     const { authDispatch, authState } = authReducer;
     const { isAuthenticated } = authState;
+    useLoginTracking(isAuthenticated, authState.status);
     const { callbackUrl } = useSessionCallbackUrl();
     useSessionIdleTimer({
         crossTab: true,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@databiosphere/findable-ui",
-  "version": "52.1.0",
+  "version": "52.2.0",
   "description": "",
   "scripts": {
     "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",