@datarecce/ui 0.1.40 → 0.2.0

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

@@ -1,252 +0,0 @@
-/**
- * Check Events API - Types and Client Functions
- *
- * Provides timeline/conversation functionality for Checks, enabling
- * GitHub PR-style discussions with comments and automatic tracking
- * of state changes.
- *
- * NOTE: This feature is only available when connected to Recce Cloud.
- */
-
-import { AxiosInstance, AxiosResponse } from "axios";
-import { axiosClient } from "./axiosClient";
-
-// ============================================================================
-// Event Types
-// ============================================================================
-
-export type CheckEventType =
-  | "check_created"
-  | "comment"
-  | "approval_change"
-  | "description_change"
-  | "name_change"
-  | "preset_applied";
-
-export type ActorType = "user" | "recce_ai" | "preset_system";
-
-// ============================================================================
-// Actor Interface
-// ============================================================================
-
-export interface CheckEventActor {
-  type: ActorType;
-  user_id: number | null;
-  login: string | null;
-  fullname: string | null;
-}
-
-// ============================================================================
-// Check Event Interface
-// ============================================================================
-
-export interface CheckEvent {
-  id: string;
-  check_id: string;
-  event_type: CheckEventType;
-  actor: CheckEventActor;
-  content: string | null;
-  old_value: string | null;
-  new_value: string | null;
-  is_edited: boolean;
-  is_deleted: boolean;
-  created_at: string;
-  updated_at: string;
-}
-
-// ============================================================================
-// Request/Response Types
-// ============================================================================
-
-export interface CreateCommentRequest {
-  content: string;
-}
-
-export interface UpdateCommentRequest {
-  content: string;
-}
-
-export interface CheckEventsListResponse {
-  events: CheckEvent[];
-}
-
-// ============================================================================
-// API Client Functions
-// ============================================================================
-
-/**
- * List all events for a check in chronological order.
- *
- * @param checkId - The check ID
- * @param client - Optional axios instance for API configuration
- * @returns Promise resolving to array of CheckEvent objects
- */
-export async function listCheckEvents(
-  checkId: string,
-  client: AxiosInstance = axiosClient,
-): Promise<CheckEvent[]> {
-  const response = await client.get<never, AxiosResponse<CheckEvent[]>>(
-    `/api/checks/${checkId}/events`,
-  );
-  return response.data;
-}
-
-/**
- * Get a specific event by ID.
- *
- * @param checkId - The check ID
- * @param eventId - The event ID
- * @param client - Optional axios instance for API configuration
- * @returns Promise resolving to a CheckEvent object
- */
-export async function getCheckEvent(
-  checkId: string,
-  eventId: string,
-  client: AxiosInstance = axiosClient,
-): Promise<CheckEvent> {
-  const response = await client.get<never, AxiosResponse<CheckEvent>>(
-    `/api/checks/${checkId}/events/${eventId}`,
-  );
-  return response.data;
-}
-
-/**
- * Create a new comment on a check.
- *
- * @param checkId - The check ID
- * @param content - The comment content (plain text for now, markdown later)
- * @param client - Optional axios instance for API configuration
- * @returns Promise resolving to the created CheckEvent
- */
-export async function createComment(
-  checkId: string,
-  content: string,
-  client: AxiosInstance = axiosClient,
-): Promise<CheckEvent> {
-  const response = await client.post<
-    CreateCommentRequest,
-    AxiosResponse<CheckEvent>
-  >(`/api/checks/${checkId}/events`, { content });
-  return response.data;
-}
-
-/**
- * Update an existing comment.
- * Only the author or an admin can update a comment.
- *
- * @param checkId - The check ID
- * @param eventId - The event ID of the comment to update
- * @param content - The new comment content
- * @param client - Optional axios instance for API configuration
- * @returns Promise resolving to the updated CheckEvent
- */
-export async function updateComment(
-  checkId: string,
-  eventId: string,
-  content: string,
-  client: AxiosInstance = axiosClient,
-): Promise<CheckEvent> {
-  const response = await client.patch<
-    UpdateCommentRequest,
-    AxiosResponse<CheckEvent>
-  >(`/api/checks/${checkId}/events/${eventId}`, { content });
-  return response.data;
-}
-
-/**
- * Delete a comment (soft delete).
- * Only the author or an admin can delete a comment.
- *
- * @param checkId - The check ID
- * @param eventId - The event ID of the comment to delete
- * @param client - Optional axios instance for API configuration
- * @returns Promise resolving when deletion is complete
- */
-export async function deleteComment(
-  checkId: string,
-  eventId: string,
-  client: AxiosInstance = axiosClient,
-): Promise<void> {
-  await client.delete(`/api/checks/${checkId}/events/${eventId}`);
-}
-
-// ============================================================================
-// Type Guards
-// ============================================================================
-
-export function isCommentEvent(event: CheckEvent): boolean {
-  return event.event_type === "comment";
-}
-
-export function isStateChangeEvent(event: CheckEvent): boolean {
-  return (
-    event.event_type === "approval_change" ||
-    event.event_type === "description_change" ||
-    event.event_type === "name_change"
-  );
-}
-
-export function isSystemEvent(event: CheckEvent): boolean {
-  return (
-    event.event_type === "check_created" ||
-    event.event_type === "preset_applied"
-  );
-}
-
-// ============================================================================
-// Display Helpers
-// ============================================================================
-
-/**
- * Get a human-readable description of an event for display.
- */
-export function getEventDescription(event: CheckEvent): string {
-  const actorName = event.actor.fullname || event.actor.login || "Someone";
-
-  switch (event.event_type) {
-    case "check_created":
-      return `${actorName} created this check`;
-    case "comment":
-      if (event.is_deleted) {
-        return "Comment deleted";
-      }
-      return event.content || "";
-    case "approval_change":
-      if (event.new_value === "true") {
-        return `${actorName} approved this check`;
-      }
-      return `${actorName} unapproved this check`;
-    case "description_change":
-      return `${actorName} updated the description`;
-    case "name_change":
-      return `${actorName} renamed this check`;
-    case "preset_applied":
-      return `${actorName} applied a preset`;
-    default:
-      return `${actorName} made a change`;
-  }
-}
-
-/**
- * Get the appropriate icon name for an event type.
- * Returns a string that can be used with react-icons.
- */
-export function getEventIconType(
-  event: CheckEvent,
-): "comment" | "approve" | "unapprove" | "edit" | "create" | "preset" {
-  switch (event.event_type) {
-    case "check_created":
-      return "create";
-    case "comment":
-      return "comment";
-    case "approval_change":
-      return event.new_value === "true" ? "approve" : "unapprove";
-    case "description_change":
-    case "name_change":
-      return "edit";
-    case "preset_applied":
-      return "preset";
-    default:
-      return "edit";
-  }
-}

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

@@ -1,129 +0,0 @@
-import { useQuery } from "@tanstack/react-query";
-import { AxiosInstance, AxiosResponse } from "axios";
-import { RunType } from "@/components/run/registry";
-import { useApiConfig } from "../hooks/ApiConfigContext";
-import { axiosClient } from "./axiosClient";
-import { cacheKeys } from "./cacheKeys";
-import { getExperimentTrackingBreakingChangeEnabled } from "./track";
-import { Run, RunParamTypes } from "./types";
-
-export interface Check<PT = unknown, VO = unknown> {
-  check_id: string;
-  name: string;
-  description?: string;
-  type: RunType;
-  params?: PT;
-  view_options?: VO;
-  is_checked?: boolean;
-  is_preset?: boolean;
-  last_run?: Run;
-}
-
-export interface CreateCheckBody {
-  name?: string;
-  description?: string;
-  run_id?: string;
-  type?: RunType;
-  params?: Record<string, string | boolean>;
-  view_options?: Record<string, string | boolean>;
-  track_props?: Record<string, string | boolean>;
-}
-
-export async function createSimpleCheck(
-  client: AxiosInstance = axiosClient,
-): Promise<Check> {
-  const response = await client.post<CreateCheckBody, AxiosResponse<Check>>(
-    "/api/checks",
-    {
-      type: "simple",
-    },
-  );
-  return response.data;
-}
-
-export async function createCheckByRun(
-  runId: string,
-  viewOptions?: Record<string, unknown>,
-  client: AxiosInstance = axiosClient,
-): Promise<Check> {
-  const track_props = getExperimentTrackingBreakingChangeEnabled()
-    ? { breaking_change_analysis: true }
-    : {};
-  const response = await client.post<CreateCheckBody, AxiosResponse<Check>>(
-    "/api/checks",
-    {
-      run_id: runId,
-      view_options: viewOptions,
-      track_props,
-    },
-  );
-  return response.data;
-}
-
-export async function listChecks(
-  client: AxiosInstance = axiosClient,
-): Promise<Check[]> {
-  return (await client.get<never, AxiosResponse<Check[]>>("/api/checks")).data;
-}
-
-export function useChecks(enabled: boolean) {
-  const { apiClient } = useApiConfig();
-  return useQuery({
-    queryKey: cacheKeys.checks(),
-    queryFn: () => listChecks(apiClient),
-    enabled,
-  });
-}
-
-export async function getCheck(
-  checkId: string,
-  client: AxiosInstance = axiosClient,
-): Promise<Check<RunParamTypes>> {
-  const response = await client.get<never, AxiosResponse<Check<RunParamTypes>>>(
-    `/api/checks/${checkId}`,
-  );
-  return response.data;
-}
-
-export async function updateCheck(
-  checkId: string,
-  payload: Partial<Check>,
-  client: AxiosInstance = axiosClient,
-): Promise<Check> {
-  const response = await client.patch<Partial<Check>, AxiosResponse<Check>>(
-    `/api/checks/${checkId}`,
-    payload,
-  );
-  return response.data;
-}
-
-export async function deleteCheck(
-  checkId: string,
-  client: AxiosInstance = axiosClient,
-) {
-  const response = await client.delete<
-    never,
-    AxiosResponse<Pick<Check, "check_id">>
-  >(`/api/checks/${checkId}`);
-  return response.data;
-}
-
-export async function reorderChecks(
-  order: {
-    source: number;
-    destination: number;
-  },
-  client: AxiosInstance = axiosClient,
-) {
-  return await client.post<
-    { source: number; destination: number },
-    AxiosResponse<unknown>
-  >("/api/checks/reorder", order);
-}
-
-export async function markAsPresetCheck(
-  checkId: string,
-  client: AxiosInstance = axiosClient,
-): Promise<void> {
-  await client.post(`/api/checks/${checkId}/mark-as-preset`);
-}

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

@@ -1,53 +0,0 @@
-import { AxiosInstance, AxiosResponse } from "axios";
-import { axiosClient } from "./axiosClient";
-import { NodeColumnData } from "./info";
-
-export interface CllInput {
-  node_id?: string;
-  column?: string;
-  change_analysis?: boolean;
-  no_cll?: boolean;
-  no_upstream?: boolean;
-  no_downstream?: boolean;
-}
-
-export interface ImpactRadiusParams {
-  node_id: string;
-}
-
-export interface CllNodeData {
-  id: string;
-  name: string;
-  source_name: string;
-  resource_type: string;
-  raw_code?: string;
-  change_status?: "added" | "removed" | "modified";
-  change_category?:
-    | "breaking"
-    | "non_breaking"
-    | "partial_breaking"
-    | "unknown";
-  impacted?: boolean;
-  columns?: Record<string, NodeColumnData>;
-}
-
-export interface ColumnLineageData {
-  current: {
-    nodes: Record<string, CllNodeData>;
-    columns: Record<string, NodeColumnData>;
-    parent_map: Record<string, Set<string>>;
-    child_map: Record<string, Set<string>>;
-  };
-}
-
-export async function getCll(
-  input: CllInput,
-  client: AxiosInstance = axiosClient,
-): Promise<ColumnLineageData> {
-  const response = await client.post<
-    CllInput,
-    AxiosResponse<ColumnLineageData>
-  >("/api/cll", input);
-
-  return response.data;
-}

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

@@ -1,13 +0,0 @@
-import { AxiosInstance } from "axios";
-import { axiosClient } from "./axiosClient";
-
-export interface ConnectToCloud {
-  connection_url: string;
-}
-
-export async function connectToCloud(
-  client: AxiosInstance = axiosClient,
-): Promise<ConnectToCloud> {
-  const data = await client.post<ConnectToCloud>("/api/connect");
-  return data.data;
-}

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

@@ -1,37 +0,0 @@
-import { AxiosInstance, AxiosResponse } from "axios";
-import { axiosClient } from "./axiosClient";
-
-export interface RecceServerFlags {
-  single_env_onboarding: boolean;
-  show_relaunch_hint: boolean;
-}
-
-export async function getServerFlag(
-  client: AxiosInstance = axiosClient,
-): Promise<RecceServerFlags> {
-  return (await client.get<never, AxiosResponse<RecceServerFlags>>("/api/flag"))
-    .data;
-}
-
-// This was used for showing onboarding guide. Check DRC-1320 for more detials
-export async function markOnboardingCompleted(
-  client: AxiosInstance = axiosClient,
-): Promise<void> {
-  try {
-    await client.post<never, AxiosResponse<never>>("/api/onboarding/completed");
-  } catch (_error) {
-    // skip any errors
-  }
-}
-
-export async function markRelaunchHintCompleted(
-  client: AxiosInstance = axiosClient,
-): Promise<void> {
-  try {
-    await client.post<never, AxiosResponse<never>>(
-      "/api/relaunch-hint/completed",
-    );
-  } catch (_error) {
-    // skip any errors
-  }
-}

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

@@ -1,198 +0,0 @@
-import { AxiosError, AxiosInstance, AxiosResponse } from "axios";
-import { axiosClient } from "./axiosClient";
-
-/**
- * The data from the API
- */
-export interface NodeColumnData {
-  name: string;
-  type: string;
-  transformation_type?: string;
-  change_status?: "added" | "removed" | "modified";
-  not_null?: boolean;
-  unique?: boolean;
-}
-export interface NodeData {
-  id: string;
-  unique_id: string;
-  name: string;
-  schema?: string;
-  checksum?: {
-    name: string;
-    checksum: string;
-  };
-  raw_code?: string;
-  resource_type?: string;
-  package_name?: string;
-  columns?: Record<string, NodeColumnData | undefined>;
-  primary_key?: string;
-}
-
-// https://docs.getdbt.com/reference/artifacts/dbt-artifacts#common-metadata
-interface ArtifactMetadata {
-  dbt_version: string;
-  dbt_schema_version: string;
-  generated_at: string;
-  adapter_type: string;
-  env: Record<string, string>;
-  invocation_id: string;
-}
-export interface ManifestMetadata extends ArtifactMetadata {
-  project_id?: string;
-  project_name?: string;
-  user_id?: string;
-}
-export interface SQLMeshInfo {
-  base_env: string;
-  current_env: string;
-}
-
-export type CatalogMetadata = ArtifactMetadata;
-
-export interface LineageData {
-  metadata: {
-    pr_url: string;
-    git_branch?: string;
-  };
-  nodes: Record<string, NodeData>;
-  parent_map: Record<string, string[]>;
-  manifest_metadata?: ManifestMetadata | null;
-  catalog_metadata?: CatalogMetadata | null;
-}
-
-export interface LineageDataFromMetadata extends Omit<LineageData, "nodes"> {
-  nodes: Record<string, NodeData | undefined>;
-}
-
-export type LineageDiffData = Record<
-  string,
-  {
-    change_status: "added" | "removed" | "modified";
-    change: {
-      category: "breaking" | "non_breaking" | "partial_breaking" | "unknown";
-      columns: Record<string, "added" | "removed" | "modified"> | null;
-    } | null;
-  }
->;
-
-interface LineageOutput {
-  error?: string;
-  data?: LineageData;
-}
-
-export async function getLineage(base = false): Promise<LineageData> {
-  const response = await axiosClient.get<LineageData>(
-    `/api/lineage?base=${base}`,
-  );
-  return response.data;
-}
-
-export async function getLineageWithError(
-  base = false,
-): Promise<LineageOutput> {
-  try {
-    const data = await getLineage(base);
-    return { data };
-  } catch (err: unknown) {
-    if (err instanceof AxiosError) {
-      const data = err.response?.data as Record<string, unknown> | undefined;
-      const detail = data?.detail as string | undefined;
-      if (detail) {
-        return { error: detail };
-      } else {
-        return { error: err.message };
-      }
-    } else if (err instanceof Error) {
-      return { error: err.message };
-    } else {
-      return { error: "An unknown error occurred" };
-    }
-  }
-}
-
-export interface LineageDiffResult {
-  base?: LineageData;
-  current?: LineageData;
-  base_error?: string;
-  current_error?: string;
-}
-
-export async function getLineageDiff(): Promise<LineageDiffResult> {
-  const [base, current] = await Promise.all([
-    getLineageWithError(true),
-    getLineageWithError(false),
-  ]);
-
-  return {
-    base: base.data,
-    current: current.data,
-    base_error: base.error,
-    current_error: current.error,
-  };
-}
-
-export interface stateMetadata {
-  schema_version: string;
-  recce_version: string;
-  generated_at: string;
-}
-
-export interface gitInfo {
-  branch?: string;
-}
-
-export interface pullRequestInfo {
-  id?: string | number;
-  title?: string;
-  url?: string;
-  branch?: string;
-  base_branch?: string;
-}
-
-export interface ServerInfoResult {
-  state_metadata: stateMetadata;
-  adapter_type: string;
-  review_mode: boolean;
-  cloud_mode: boolean;
-  file_mode: boolean;
-  filename?: string;
-  git?: gitInfo;
-  pull_request?: pullRequestInfo;
-  sqlmesh?: SQLMeshInfo;
-  lineage: {
-    base: LineageData;
-    current: LineageData;
-    diff: LineageDiffData;
-  };
-  demo: boolean;
-  codespace: boolean;
-  support_tasks: Record<string, boolean>;
-}
-
-export async function getServerInfo(
-  client: AxiosInstance = axiosClient,
-): Promise<ServerInfoResult> {
-  return (await client.get<never, AxiosResponse<ServerInfoResult>>(`/api/info`))
-    .data;
-}
-
-export interface ModelInfoResult {
-  model: {
-    base: {
-      columns?: Record<string, NodeColumnData>;
-      primary_key?: string;
-    };
-    current: {
-      columns?: Record<string, NodeColumnData>;
-      primary_key?: string;
-    };
-  };
-}
-
-export async function getModelInfo(model: string): Promise<ModelInfoResult> {
-  return (
-    await axiosClient.get<never, AxiosResponse<ModelInfoResult>>(
-      `/api/model/${model}`,
-    )
-  ).data;
-}

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

@@ -1,25 +0,0 @@
-import { AxiosInstance, AxiosResponse } from "axios";
-import { axiosClient } from "./axiosClient";
-
-export interface RecceInstanceInfo {
-  server_mode: "server" | "preview" | "read-only";
-  single_env: boolean;
-  authed: boolean;
-  cloud_instance: boolean;
-  lifetime_expired_at?: Date;
-  idle_timeout?: number;
-  share_url?: string;
-  session_id?: string;
-  organization_name?: string;
-  web_url?: string;
-}
-
-export async function getRecceInstanceInfo(
-  client: AxiosInstance = axiosClient,
-): Promise<RecceInstanceInfo> {
-  return (
-    await client.get<never, AxiosResponse<RecceInstanceInfo>>(
-      "/api/instance-info",
-    )
-  ).data;
-}