interfaces.ts

/*
 * Copyright OpenSearch Contributors
 * SPDX-License-Identifier: Apache-2.0
 */

import { Node, Edge } from 'reactflow';
import { IComponentData } from '../public/component_types';

export type Index = {
  name: string;
  health: 'green' | 'yellow' | 'red';
};

/**
 ********** REACTFLOW TYPES/INTERFACES **********
 */

export type ReactFlowComponent = Node<IComponentData>;

// TODO: we may not need this re-defined type here at all, if we don't add
// any special fields/configuration for an edge. Currently this
// is the same as the default Edge type.
export type ReactFlowEdge = Edge<{}> & {};

type ReactFlowViewport = {
  x: number;
  y: number;
  zoom: number;
};

export type WorkspaceFlowState = {
  nodes: ReactFlowComponent[];
  edges: ReactFlowEdge[];
  viewport?: ReactFlowViewport;
};

/**
 ********** USE CASE TEMPLATE TYPES/INTERFACES **********
 */

export type TemplateNode = {
  id: string;
  inputs: {};
};

export type TemplateEdge = {
  source: string;
  target: string;
};

export type TemplateFlow = {
  userParams: {};
  nodes: TemplateNode[];
  edges: TemplateEdge[];
};

export type TemplateFlows = {
  provision: TemplateFlow;
  ingest: TemplateFlow;
  query: TemplateFlow;
};

export type UseCaseTemplate = {
  type: string;
  name: string;
  description: string;
  userInputs: {};
  workflows: TemplateFlows;
};

export type Workflow = {
  id: string;
  name: string;
  description?: string;
  // ReactFlow state may not exist if a workflow is created via API/backend-only.
  workspaceFlowState?: WorkspaceFlowState;
  template: UseCaseTemplate;
  lastUpdated: number;
  state: WORKFLOW_STATE;
};

export enum USE_CASE {
  SEMANTIC_SEARCH = 'semantic_search',
  CUSTOM = 'custom',
}

/**
 ********** MISC TYPES/INTERFACES ************
 */

// TODO: finalize how we have the launch data model
export type WorkflowLaunch = {
  id: string;
  state: WORKFLOW_STATE;
  lastUpdated: number;
};

// TODO: finalize list of possible workflow states from backend
export enum WORKFLOW_STATE {
  SUCCEEDED = 'Succeeded',
  FAILED = 'Failed',
  IN_PROGRESS = 'In progress',
  NOT_STARTED = 'Not started',
}