@datarecce/ui 0.1.29 → 0.1.31

package/recce-source/js/src/lib/api/track.ts

@@ -0,0 +1,281 @@
+import {
+  AmplitudeReturn,
+  BaseEvent,
+  EventOptions,
+  Result,
+} from "@amplitude/analytics-core";
+import { initAll, track as trk } from "@amplitude/unified";
+
+function track(
+  eventInput: string | BaseEvent,
+  // biome-ignore lint/suspicious/noExplicitAny: Amplitude library uses any for event properties
+  eventProperties?: Record<string, any> | undefined,
+  eventOptions?: EventOptions | undefined,
+): AmplitudeReturn<Result> {
+  // If Amplitude isn't initialized, log to console instead
+  if (!amplitudeInitialized) {
+    console.log("[Tracking]", eventInput, eventProperties, eventOptions);
+  }
+  return trk(eventInput, eventProperties, eventOptions);
+}
+
+let amplitudeInitialized = false;
+
+export function trackInit() {
+  function getCookie(key: string) {
+    const b = document.cookie.match("(^|;)\\s*" + key + "\\s*=\\s*([^;]+)");
+    return b ? b.pop() : "";
+  }
+
+  const userId =
+    process.env.NODE_ENV === "development"
+      ? "web_dev"
+      : getCookie("recce_user_id");
+  const apiKey = process.env.AMPLITUDE_API_KEY;
+  if (userId && apiKey) {
+    try {
+      void initAll(apiKey, {
+        analytics: {
+          userId,
+          autocapture: true,
+        },
+        sessionReplay: {
+          sampleRate: 1,
+        },
+      });
+      amplitudeInitialized = true;
+    } catch (e) {
+      console.error(e);
+    }
+  }
+
+  // Log when Amplitude is not initialized (for development/debugging)
+  if (!amplitudeInitialized) {
+    console.log(
+      "[Tracking] Amplitude not initialized (missing API key or user ID). Events will be logged to console instead.",
+    );
+  }
+}
+
+interface MultiNodeActionProps {
+  type:
+    | "row_count"
+    | "row_count_diff"
+    | "value_diff"
+    | "schema_diff"
+    | "lineage_diff";
+  selected: "single" | "multi" | "none";
+}
+
+export function trackMultiNodesAction(props: MultiNodeActionProps) {
+  track("[Web] multi_nodes_action", props);
+}
+
+interface HistoryActionProps {
+  name: "show" | "hide" | "click_run" | "add_to_checklist" | "go_to_check";
+}
+
+export function trackHistoryAction(props: HistoryActionProps) {
+  track("[Web] history_action", props);
+}
+
+interface PreviewChangeProps {
+  action: "explore" | "run" | "close";
+  node?: string;
+  status?: "success" | "failure";
+}
+
+export function trackPreviewChange(props: PreviewChangeProps) {
+  track("[Experiment] preview_change", props);
+}
+
+interface PreviewChangeFeedbackProps {
+  feedback: "like" | "dislike" | "form";
+  node?: string;
+}
+
+export function trackPreviewChangeFeedback(props: PreviewChangeFeedbackProps) {
+  track("[Experiment] preview_change", props);
+}
+
+interface SingleEnvironmentProps {
+  action:
+    | "onboarding"
+    | "external_link"
+    | "preview_changes"
+    | `target_base_added`;
+  from?: "onboarding" | "preview_changes";
+  node?: string;
+}
+
+export function trackSingleEnvironment(props: SingleEnvironmentProps) {
+  track("[Experiment] single_environment", props);
+}
+
+export function getExperimentTrackingBreakingChangeEnabled() {
+  return false;
+}
+
+interface ColumnLevelLineageProps {
+  action: "view";
+  source: "schema_column" | "changed_column" | "cll_column";
+}
+
+export function trackColumnLevelLineage(props: ColumnLevelLineageProps) {
+  track("[Web] column_level_lineage", props);
+}
+
+interface ShareStateProps {
+  name: "enable" | "create" | "copy";
+}
+
+export function trackShareState(props: ShareStateProps) {
+  track("[Web] share_state", props);
+}
+
+interface StateActionProps {
+  name: "import" | "export";
+}
+
+export function trackStateAction(props: StateActionProps) {
+  track("[Web] state_action", props);
+}
+
+interface CopyToClipboardProps {
+  from: "run" | "check" | "lineage_view";
+  type: string;
+}
+
+export function trackCopyToClipboard(props: CopyToClipboardProps) {
+  track("[Click] copy_to_clipboard", props);
+}
+
+interface TrackNavProps {
+  from: string;
+  to: string;
+}
+
+export function trackNavigation(props: TrackNavProps) {
+  track("[Web] navigation_change", props);
+}
+
+export interface LineageViewRenderProps {
+  node_count: number;
+  view_mode: string;
+  impact_radius_enabled: boolean;
+  cll_column_active?: boolean;
+  right_sidebar_open: boolean;
+  [status: string]: number | string | boolean | undefined;
+}
+
+export function trackLineageViewRender(props: LineageViewRenderProps) {
+  track("[Web] lineage_view_render", props);
+}
+
+export interface EnvironmentConfigProps {
+  review_mode: boolean;
+  adapter_type: string | null;
+  has_git_info: boolean;
+  has_pr_info: boolean;
+  // Adapter-specific (shape varies by adapter_type)
+  base?: {
+    schema_count?: number;
+    dbt_version?: string | null;
+    timestamp?: string | null;
+    has_env?: boolean;
+  };
+  current?: {
+    schema_count?: number;
+    dbt_version?: string | null;
+    timestamp?: string | null;
+    has_env?: boolean;
+  };
+  schemas_match?: boolean;
+}
+
+export function trackEnvironmentConfig(props: EnvironmentConfigProps) {
+  track("[Web] environment_config", props);
+}
+
+// Explore action types
+export const EXPLORE_ACTION = {
+  ROW_COUNT: "row_count",
+  ROW_COUNT_DIFF: "row_count_diff",
+  PROFILE: "profile",
+  PROFILE_DIFF: "profile_diff",
+  VALUE_DIFF: "value_diff",
+  SCHEMA_DIFF: "schema_diff",
+  LINEAGE_DIFF: "lineage_diff",
+  QUERY: "query",
+  HISTOGRAM_DIFF: "histogram_diff",
+  TOP_K_DIFF: "top_k_diff",
+} as const;
+
+// Explore action sources
+export const EXPLORE_SOURCE = {
+  LINEAGE_VIEW_TOP_BAR: "lineage_view_top_bar",
+  LINEAGE_VIEW_CONTEXT_MENU: "lineage_view_context_menu",
+  NODE_KEBAB_MENU: "node_kebab_menu",
+  NODE_SIDEBAR_SINGLE_ENV: "node_sidebar_single_env",
+  NODE_SIDEBAR_MULTI_ENV: "node_sidebar_multi_env",
+  SCHEMA_ROW_COUNT_BUTTON: "schema_row_count_button",
+  SCHEMA_COLUMN_MENU: "schema_column_menu",
+} as const;
+
+export type ExploreActionType =
+  (typeof EXPLORE_ACTION)[keyof typeof EXPLORE_ACTION];
+export type ExploreSourceType =
+  (typeof EXPLORE_SOURCE)[keyof typeof EXPLORE_SOURCE];
+
+interface ExploreActionProps {
+  action: ExploreActionType;
+  source: ExploreSourceType;
+  node_count?: number;
+}
+
+export function trackExploreAction(props: ExploreActionProps) {
+  track("[Web] explore_action", props);
+}
+
+// Explore action form events
+export const EXPLORE_FORM_EVENT = {
+  EXECUTE: "execute",
+  CANCEL: "cancel",
+} as const;
+
+export type ExploreFormEventType =
+  (typeof EXPLORE_FORM_EVENT)[keyof typeof EXPLORE_FORM_EVENT];
+
+interface ExploreActionFormProps {
+  action: ExploreActionType;
+  event: ExploreFormEventType;
+}
+
+export function trackExploreActionForm(props: ExploreActionFormProps) {
+  track("[Web] explore_action_form", props);
+}
+
+// Helper to check if a run type is an explore action
+export function isExploreAction(type: string): type is ExploreActionType {
+  return Object.values(EXPLORE_ACTION).includes(type as ExploreActionType);
+}
+
+// Lineage selection action types
+export const LINEAGE_SELECTION_ACTION = {
+  SELECT_PARENT_NODES: "select_parent_nodes",
+  SELECT_CHILD_NODES: "select_child_nodes",
+  SELECT_ALL_UPSTREAM: "select_all_upstream",
+  SELECT_ALL_DOWNSTREAM: "select_all_downstream",
+} as const;
+
+export type LineageSelectionActionType =
+  (typeof LINEAGE_SELECTION_ACTION)[keyof typeof LINEAGE_SELECTION_ACTION];
+
+interface LineageSelectionProps {
+  action: LineageSelectionActionType;
+  node_count?: number;
+}
+
+export function trackLineageSelection(props: LineageSelectionProps) {
+  track("[Web] lineage_selection", props);
+}

package/recce-source/js/src/lib/api/types.ts

@@ -0,0 +1,284 @@
+// ============================================================================
+// Base Types
+// ============================================================================
+
+export type AxiosQueryParams = Record<
+  string,
+  string | string[] | number | number[] | undefined
+>;
+
+export type RowDataTypes = number | string | boolean | null | undefined;
+export type RowData = RowDataTypes[];
+
+export type RowObjectType = Record<string, RowDataTypes> & {
+  __status: "added" | "removed" | "modified" | undefined;
+  _index?: number;
+};
+
+export type ColumnType =
+  | "number"
+  | "integer"
+  | "text"
+  | "boolean"
+  | "date"
+  | "datetime"
+  | "timedelta"
+  | "unknown";
+
+export type ColumnRenderMode = "raw" | "percent" | "delta" | 2;
+export interface DataFrame {
+  columns: {
+    key: string;
+    name: string;
+    type: ColumnType;
+  }[];
+  data: RowData[];
+  limit?: number;
+  more?: boolean;
+}
+
+// ============================================================================
+// Run Types - Strict enum without string union
+// ============================================================================
+
+// ============================================================================
+// Inline Param Definitions (defined here to avoid circular dependencies)
+// ============================================================================
+
+// Import types that are defined in other files
+import { RunType } from "@/components/run/registry";
+import type {
+  QueryDiffParams,
+  QueryDiffResult,
+  QueryResult,
+  QueryRunParams,
+} from "./adhocQuery";
+import type { LineageDiffResult } from "./info";
+import type {
+  HistogramDiffParams,
+  HistogramDiffResult,
+  ProfileDiffParams,
+  ProfileDiffResult,
+  TopKDiffParams,
+  TopKDiffResult,
+} from "./profile";
+import type {
+  RowCountDiffParams,
+  RowCountDiffResult,
+  RowCountParams,
+  RowCountResult,
+} from "./rowcount";
+import type {
+  ValueDiffDetailParams,
+  ValueDiffDetailResult,
+  ValueDiffParams,
+  ValueDiffResult,
+} from "./valuediff";
+
+// Define params that don't have their own files yet
+export interface SchemaDiffParams {
+  node_id?: string | string[];
+  select?: string;
+  exclude?: string;
+  packages?: string[];
+  view_mode?: "all" | "changed_models";
+}
+
+export interface LineageDiffParams {
+  select?: string;
+  exclude?: string;
+  packages?: string[];
+  view_mode?: "all" | "changed_models";
+}
+
+// ============================================================================
+// Run - Discriminated Union Type
+// ============================================================================
+
+export type RunParamTypes =
+  | QueryRunParams
+  | QueryDiffParams
+  | ValueDiffParams
+  | SchemaDiffParams
+  | ProfileDiffParams
+  | RowCountParams
+  | RowCountDiffParams
+  | LineageDiffParams
+  | TopKDiffParams
+  | HistogramDiffParams
+  | undefined;
+
+interface BaseRun {
+  type: RunType;
+  run_id: string;
+  run_at: string;
+  name?: string;
+  check_id?: string;
+  progress?: {
+    message?: string;
+    percentage?: number;
+  };
+  error?: string;
+  status?: "finished" | "failed" | "cancelled" | "running";
+}
+
+export type Run =
+  | (BaseRun & {
+      type: "simple";
+      params?: undefined;
+      result?: undefined;
+    })
+  | (BaseRun & {
+      type: "sandbox";
+      params?: undefined;
+      result?: undefined;
+    })
+  | (BaseRun & {
+      type: "query";
+      params?: QueryRunParams;
+      result?: QueryResult;
+    })
+  | (BaseRun & {
+      type: "query_base";
+      params?: QueryRunParams;
+      result?: QueryResult;
+    })
+  | (BaseRun & {
+      type: "query_diff";
+      params?: QueryDiffParams;
+      result?: QueryDiffResult;
+    })
+  | (BaseRun & {
+      type: "value_diff";
+      params?: ValueDiffParams;
+      result?: ValueDiffResult;
+    })
+  | (BaseRun & {
+      type: "value_diff_detail";
+      params?: ValueDiffDetailParams;
+      result?: ValueDiffDetailResult;
+    })
+  | (BaseRun & {
+      type: "schema_diff";
+      params?: SchemaDiffParams;
+      result?: undefined;
+    })
+  | (BaseRun & {
+      type: "profile";
+      params?: ProfileDiffParams;
+      result?: ProfileDiffResult;
+    })
+  | (BaseRun & {
+      type: "profile_diff";
+      params?: ProfileDiffParams;
+      result?: ProfileDiffResult;
+    })
+  | (BaseRun & {
+      type: "row_count";
+      params?: RowCountParams;
+      result?: RowCountResult;
+    })
+  | (BaseRun & {
+      type: "row_count_diff";
+      params?: RowCountDiffParams;
+      result?: RowCountDiffResult;
+    })
+  | (BaseRun & {
+      type: "lineage_diff";
+      params?: LineageDiffParams;
+      result?: LineageDiffResult;
+    })
+  | (BaseRun & {
+      type: "top_k_diff";
+      params?: TopKDiffParams;
+      result?: TopKDiffResult;
+    })
+  | (BaseRun & {
+      type: "histogram_diff";
+      params?: HistogramDiffParams;
+      result?: HistogramDiffResult;
+    });
+
+// ============================================================================
+// Type Guards
+// ============================================================================
+
+export function isSimpleRun(run: Run): run is Extract<Run, { type: "simple" }> {
+  return run.type === "simple";
+}
+
+export function isQueryRun(run: Run): run is Extract<Run, { type: "query" }> {
+  return run.type === "query";
+}
+
+export function isQueryBaseRun(
+  run: Run,
+): run is Extract<Run, { type: "query_base" }> {
+  return run.type === "query_base";
+}
+
+export function isQueryDiffRun(
+  run: Run,
+): run is Extract<Run, { type: "query_diff" }> {
+  return run.type === "query_diff";
+}
+
+export function isValueDiffRun(
+  run: Run,
+): run is Extract<Run, { type: "value_diff" }> {
+  return run.type === "value_diff";
+}
+
+export function isValueDiffDetailRun(
+  run: Run,
+): run is Extract<Run, { type: "value_diff_detail" }> {
+  return run.type === "value_diff_detail";
+}
+
+export function isSchemaDiffRun(
+  run: Run,
+): run is Extract<Run, { type: "schema_diff" }> {
+  return run.type === "schema_diff";
+}
+
+export function isProfileRun(
+  run: Run,
+): run is Extract<Run, { type: "profile" }> {
+  return run.type === "profile";
+}
+
+export function isProfileDiffRun(
+  run: Run,
+): run is Extract<Run, { type: "profile_diff" }> {
+  return run.type === "profile_diff";
+}
+
+export function isRowCountRun(
+  run: Run,
+): run is Extract<Run, { type: "row_count" }> {
+  return run.type === "row_count";
+}
+
+export function isRowCountDiffRun(
+  run: Run,
+): run is Extract<Run, { type: "row_count_diff" }> {
+  return run.type === "row_count_diff";
+}
+
+export function isLineageDiffRun(
+  run: Run,
+): run is Extract<Run, { type: "lineage_diff" }> {
+  return run.type === "lineage_diff";
+}
+
+export function isTopKDiffRun(
+  run: Run,
+): run is Extract<Run, { type: "top_k_diff" }> {
+  return run.type === "top_k_diff";
+}
+
+export function isHistogramDiffRun(
+  run: Run,
+): run is Extract<Run, { type: "histogram_diff" }> {
+  return run.type === "histogram_diff";
+}

package/recce-source/js/src/lib/api/user.ts

@@ -0,0 +1,42 @@
+import axios, { AxiosInstance, AxiosResponse } from "axios";
+import { axiosClient } from "./axiosClient";
+
+export interface User {
+  id: string;
+  login: string;
+  login_type: string;
+  email: string;
+  onboarding_state: string;
+}
+
+interface GitHubUser {
+  login: string;
+  id: number;
+  avatar_url: string;
+}
+
+export async function fetchUser(
+  client: AxiosInstance = axiosClient,
+): Promise<User> {
+  try {
+    const response = await client.get<never, AxiosResponse<User>>("/api/users");
+    return response.data;
+  } catch (error) {
+    console.error("Error fetching user data:", error);
+    throw error;
+  }
+}
+
+export async function fetchGitHubAvatar(
+  userId: string,
+): Promise<string | null> {
+  try {
+    const response = await axios.get<GitHubUser>(
+      `https://api.github.com/user/${userId}`,
+    );
+    return response.data.avatar_url;
+  } catch (error) {
+    console.warn("Failed to fetch GitHub avatar:", error);
+    return null;
+  }
+}

package/recce-source/js/src/lib/api/valuediff.ts

@@ -0,0 +1,46 @@
+import { AxiosInstance } from "axios";
+import { axiosClient } from "./axiosClient";
+import { SubmitOptions, submitRun } from "./runs";
+import { ColumnRenderMode, DataFrame } from "./types";
+
+export interface ValueDiffResult {
+  summary: {
+    total: number;
+    added: number;
+    removed: number;
+  };
+  data: DataFrame;
+}
+
+export interface ValueDiffParams {
+  model: string;
+  primary_key: string | string[];
+  columns?: string[];
+}
+
+export async function submitValueDiff(
+  params: ValueDiffParams,
+  options?: SubmitOptions,
+  client: AxiosInstance = axiosClient,
+) {
+  return await submitRun("value_diff", params, options, client);
+}
+
+export type ValueDiffDetailResult = DataFrame;
+
+export type ValueDiffDetailParams = ValueDiffParams;
+
+export interface ValueDiffDetailViewOptions {
+  changed_only?: boolean;
+  pinned_columns?: string[];
+  display_mode?: "inline" | "side_by_side";
+  columnsRenderMode?: Record<string, ColumnRenderMode>;
+}
+
+export async function submitValueDiffDetail(
+  params: ValueDiffParams,
+  options?: SubmitOptions,
+  client: AxiosInstance = axiosClient,
+) {
+  return await submitRun("value_diff_detail", params, options, client);
+}

package/recce-source/js/src/lib/api/version.ts

@@ -0,0 +1,40 @@
+import { AxiosInstance, AxiosResponse } from "axios";
+import { useEffect, useState } from "react";
+import { useApiConfig } from "../hooks/ApiConfigContext";
+import { axiosClient } from "./axiosClient";
+
+interface VersionResponse {
+  version: string;
+  latestVersion: string;
+}
+
+export async function getVersion(
+  client: AxiosInstance = axiosClient,
+): Promise<VersionResponse> {
+  const response = await client.get<never, AxiosResponse<VersionResponse>>(
+    "/api/version",
+  );
+  return response.data;
+}
+
+export function useVersionNumber() {
+  const [version, setVersion] = useState("");
+  const [latestVersion, setLatestVersion] = useState("");
+  const { apiClient } = useApiConfig();
+
+  useEffect(() => {
+    async function fetchVersion() {
+      try {
+        const { version, latestVersion } = await getVersion(apiClient);
+
+        setVersion(version);
+        setLatestVersion(latestVersion);
+      } catch (error) {
+        console.error("Error fetching version number:", error);
+      }
+    }
+    void fetchVersion();
+  }, [apiClient]);
+
+  return { version, latestVersion };
+}

package/recce-source/js/src/lib/const.ts

@@ -0,0 +1,9 @@
+let apiUrl = process.env.NEXT_PUBLIC_API_URL;
+apiUrl ??= typeof window !== "undefined" ? window.location.origin : "";
+
+export const PUBLIC_API_URL = apiUrl;
+
+let cloudWebUrl = process.env.NEXT_PUBLIC_CLOUD_WEB_URL;
+cloudWebUrl ??= "https://cloud.datarecce.io";
+
+export const PUBLIC_CLOUD_WEB_URL = cloudWebUrl;