workflow-common 1.0.0

package/src/tasks/index.ts

@@ -0,0 +1,38 @@
+export * from './AddPropertyToJsonTask';
+export * from './ApplySessionSorageTask';
+export * from './CheckElementExistsTask';
+export * from './ClearInputTask';
+export * from './ClickElementTask';
+export * from './CloseBrowserTask';
+export * from './DeliverViaWebhookTask';
+export * from './DoubleClickElementTask';
+export * from './ExtractElementByTextTask';
+export * from './ExtractTextAndValidateTask';
+export * from './FillCredentialsTask';
+export * from './FillInputTask';
+export * from './GobackTask';
+export * from './GoForwardTask';
+export * from './HoverElementTask';
+export * from './HttpRequestTask';
+export * from './LaunchBrowserTask';
+export * from './LoginViaBasicAuthTask';
+export * from './LogMessageTask';
+export * from './NavigateUrlTask';
+export * from './PageToHtmlTask';
+export * from './PressKeyTask';
+export * from './ReadPropertyFromJsonTask';
+export * from './ReloadPageTask';
+export * from './RightClickElementTask';
+export * from './ScrollToBottomTask';
+export * from './ScrollToElementTask';
+export * from './ScrollToTopTask';
+export * from './SelectDropdownTask';
+export * from './SetCookieTask';
+export * from './StoreAuthTokenTask';
+export * from './TaskRegisteryTask';
+//export * from './ToggleCheckboxTask';
+export * from './UploadFileTask';
+export * from './ValidateCheckboxTask';
+export * from './WaitForElementTask';
+export * from './WaitForNavigationTask';
+export * from './WaitForTimeTask';

package/src/types/appNode.ts

@@ -0,0 +1,25 @@
+import { Node } from '@xyflow/react';
+import { TaskParam, TaskType } from './task';
+
+export interface AppNodeData {
+  [key: string]: unknown;
+  type: TaskType;
+  inputs: Record<string, string>;
+  label: string;
+}
+
+export interface AppNode extends Node {
+  data: AppNodeData;
+}
+
+export interface ParamsProps {
+  param: TaskParam;
+  value: string;
+  updateNodeParamValue: (newValue: string) => void;
+  disabled?: boolean;
+}
+
+export type AppNodeMissingInputs = {
+  nodeId: string;
+  inputs: string[];
+};

package/src/types/common.ts

@@ -0,0 +1,5 @@
+export const Browsers = [
+  { label: 'Chrome', value: 'chrome' },
+  { label: 'Firefox', value: 'firefox' },
+  { label: 'Safari (WebKit)', value: 'safari' },
+];

package/src/types/execution.ts

@@ -0,0 +1,40 @@
+import { WorkflowExecutionStatus, WorkflowExecutionTrigger } from './workflow';
+
+export type WorkflowExecution = {
+  id: string;
+  workflowId: string;
+  userId: string;
+  status: WorkflowExecutionStatus;
+  startedAt?: Date | null;
+  endedAt?: string | null;
+  trigger: WorkflowExecutionTrigger;
+  definition?: string | null;
+  phases?: ExecutionPhase[];
+  browser: string;
+  videoUrl: string | null;
+};
+
+export type ExecutionPhase = {
+  id: string;
+  number: number;
+  userId: string;
+  status: string;
+  startedAt: Date | null;
+  completedAt: Date | null;
+  name: string;
+  node: string;
+  inputs: string | null;
+  outputs: string | null;
+  screenshot: string | null;
+  workflowExecutionId: string;
+  logs: Logs[];
+};
+
+export type Logs = {
+  id: string;
+  phaseId: string;
+  timestamp: Date;
+  message: string;
+  type: string;
+  logLevel: 'info' | 'error' | 'debug' | 'warn';
+};

package/src/types/executor.ts

@@ -0,0 +1,33 @@
+import { Browser, Page } from 'playwright';
+import { LogCollector } from './log';
+import { Workflowtask } from './workflow';
+
+export interface Environment {
+  phases: {
+    [key: string]: {
+      inputs: { [key: string]: string };
+      outputs: { [key: string]: string };
+      screenshot?: string;
+    };
+  };
+  browser?: Browser;
+  page?: Page;
+  browserType?: string;
+}
+
+export interface ExecutionEnvironmentType<T extends Workflowtask> {
+  getInput(name: T['inputs'][number]['name']): string;
+  setOutput(name: T['outputs'][number]['name'], value: string): void;
+
+  getBrowser(): Browser | undefined;
+  setBrowser(browser: Browser): void;
+
+  getPage(): Page | undefined;
+  setPage(page: Page): void;
+
+  setScreenshot(screenshot: string): void;
+
+  getBrowserType(): string;
+
+  log: LogCollector;
+}

package/src/types/index.ts

@@ -0,0 +1,10 @@
+export * from './appNode';
+export * from './executor';
+export * from './common';
+export * from './execution';
+export * from './log';
+export * from './schedule';
+export * from './task';
+export * from './workflow';
+export * from './workflowTasks';
+export * from './suites';

package/src/types/log.ts

@@ -0,0 +1,16 @@
+export interface LogEntry {
+  message: string;
+  timestamp: Date;
+  level: string;
+  type?: string;
+}
+
+export interface LogCollector {
+  info: (message: string) => void;
+  warn: (message: string) => void;
+  error: (message: string) => void;
+  debug: (message: string) => void;
+  console: (message: string) => void;
+  getStandardLogs: () => LogEntry[];
+  getConsoleLogs: () => LogEntry[];
+}

package/src/types/schedule.ts

@@ -0,0 +1,119 @@
+import { Timestamp } from "firebase/firestore";
+import { addDays, addWeeks, addMonths, set, isBefore } from "date-fns";
+
+export enum ScheduleStatus {
+  ENABLED = "ENABLED",
+  DISABLED = "DISABLED",
+  PAUSED = "PAUSED",
+}
+
+export enum ScheduleFrequency {
+  ONCE = "ONCE",
+  DAILY = "DAILY",
+  WEEKLY = "WEEKLY",
+  MONTHLY = "MONTHLY",
+}
+
+export interface Schedule {
+  id: string;
+  workflowId: string;
+  applicationId: string;
+  name: string;
+  description?: string;
+  status: ScheduleStatus;
+  frequency: ScheduleFrequency;
+  nextRunAt: Timestamp;
+  lastRunAt?: Timestamp;
+  lastRunId?: string;
+  lastRunStatus?: "COMPLETED" | "FAILED";
+  createdAt: Timestamp;
+  createdBy: string;
+  updatedAt: Timestamp;
+  updatedBy: string;
+  timezone: string;
+  retryCount: number;
+  maxRetries: number;
+  retryDelay: number; // in minutes
+  configuration: configuration;
+}
+
+export interface configuration {
+  time?: string; // HH:mm format
+  dayOfWeek?: number; // 0-6 (Sunday-Saturday)
+  dayOfMonth?: number; // 1-31
+  browser: string;
+}
+
+export interface ScheduleExecution {
+  id: string;
+  scheduleId: string;
+  workflowId: string;
+  status: "PENDING" | "IN_PROGRESS" | "COMPLETED" | "FAILED";
+  startedAt: Timestamp;
+  completedAt?: Timestamp;
+  error?: string;
+  retryCount: number;
+  nextRetryAt?: Timestamp;
+}
+
+export function calculateNextRunAt(
+  frequency: ScheduleFrequency,
+  configuration: configuration
+) {
+  const now = new Date();
+  const [hour, minute] = (configuration.time || "00:00").split(":").map(Number);
+
+  switch (frequency) {
+    case "ONCE": {
+      const runDate = set(now, {
+        hours: hour,
+        minutes: minute,
+        seconds: 0,
+        milliseconds: 0,
+      });
+      return Timestamp.fromDate(runDate);
+    }
+
+    case "DAILY": {
+      let next = set(now, {
+        hours: hour,
+        minutes: minute,
+        seconds: 0,
+        milliseconds: 0,
+      });
+      if (isBefore(next, now)) next = addDays(next, 1);
+      return Timestamp.fromDate(next);
+    }
+
+    case "WEEKLY": {
+      const targetWeekday = configuration.dayOfWeek ?? 0; // Sunday = 0
+      let next = set(now, {
+        hours: hour,
+        minutes: minute,
+        seconds: 0,
+        milliseconds: 0,
+      });
+      while (next.getDay() !== targetWeekday) {
+        next = addDays(next, 1);
+      }
+      if (isBefore(next, now)) next = addWeeks(next, 1);
+      return Timestamp.fromDate(next);
+    }
+
+    case "MONTHLY": {
+      const targetDay = configuration.dayOfMonth ?? 1;
+      let next = set(now, {
+        date: targetDay,
+        hours: hour,
+        minutes: minute,
+        seconds: 0,
+        milliseconds: 0,
+      });
+      if (isBefore(next, now)) next = addMonths(next, 1);
+      return Timestamp.fromDate(next);
+    }
+
+    default:
+      throw new Error("Invalid frequency type");
+  }
+}

package/src/types/suites.ts

@@ -0,0 +1,13 @@
+import { WorkflowExecutionStatus, WorkflowExecutionTrigger } from './workflow';
+
+export type SuiteExecution = {
+  id: string;
+  status: WorkflowExecutionStatus;
+  startedAt?: Date | null;
+  endedAt?: string | null;
+  trigger: WorkflowExecutionTrigger;
+  browser: string;
+  executionType: string;
+  executionIds: string[];
+  suiteId: string;
+};

package/src/types/task.ts

@@ -0,0 +1,80 @@
+export enum TaskType {
+  //Browser & Page Control
+  LAUNCH_BROWSER = 'LAUNCH_BROWSER',
+  CLOSE_BROWSER = 'CLOSE_BROWSER',
+  RELOAD_PAGE = 'RELOAD_PAGE',
+  NAVIGATE_URL = 'NAVIGATE_URL',
+  GO_BACK = 'GO_BACK',
+  GO_FORWARD = 'GO_FORWARD',
+
+  //Page Content Extraction
+  PAGE_TO_HTML = 'PAGE_TO_HTML',
+  EXTRACT_ELEMENT_BY_TEXT = 'EXTRACT_ELEMENT_BY_TEXT',
+
+  //Interactions & Form Handling
+  FILL_INPUT = 'FILL_INPUT',
+  FILL_CREDENTIAL = 'FILL_CREDENTIAL',
+  CLICK_ELEMENT = 'CLICK_ELEMENT',
+  SELECT_DROPDOWN = 'SELECT_DROPDOWN',
+  VALIDATE_CHECKBOX = 'VALIDATE_CHECKBOX',
+  CLEAR_INPUT = 'CLEAR_INPUT',
+  // TOGGLE_CHECKBOX = 'TOGGLE_CHECKBOX',
+  UPLOAD_FILE = 'UPLOAD_FILE',
+  HOVER_ELEMENT = 'HOVER_ELEMENT',
+  DOUBLE_CLICK_ELEMENT = 'DOUBLE_CLICK_ELEMENT',
+  RIGHT_CLICK_ELEMENT = 'RIGHT_CLICK_ELEMENT',
+  PRESS_KEY = 'PRESS_KEY',
+
+  //Waits & Conditions
+  WAIT_FOR_ELEMENT = 'WAIT_FOR_ELEMENT',
+  WAIT_FOR_TIME = 'WAIT_FOR_TIME',
+  WAIT_FOR_NAVIGATION = 'WAIT_FOR_NAVIGATION',
+  CHECK_ELEMENT_EXISTS = 'CHECK_ELEMENT_EXISTS',
+  EXTRACT_TEXT_AND_VALIDATE = 'EXTRACT_TEXT_AND_VALIDATE',
+
+  //Scrolling
+  SCROLL_TO_ELEMENT = 'SCROLL_TO_ELEMENT',
+  SCROLL_TO_TOP = 'SCROLL_TO_TOP',
+  SCROLL_TO_BOTTOM = 'SCROLL_TO_BOTTOM',
+
+  //Flow & Data Manipulation
+  READ_PROPERTY_FROM_JSON = 'READ_PROPERTY_FROM_JSON',
+  ADD_PROPERTY_TO_JSON = 'ADD_PROPERTY_TO_JSON',
+
+  //Authentication & Session
+  SET_COOKIE = 'SET_COOKIE',
+  LOGIN_VIA_BASIC_AUTH = 'LOGIN_VIA_BASIC_AUTH',
+  APPLY_SESSION_STORAGE = 'APPLY_SESSION_STORAGE',
+  STORE_AUTH_TOKEN = 'STORE_AUTH_TOKEN',
+
+  //Delivery & Output
+  DELIVER_VIA_WEBHOOK = 'DELIVER_VIA_WEBHOOK',
+  HTTP_REQUEST = 'HTTP_REQUEST',
+  LOG_MESSAGE = 'LOG_MESSAGE',
+}
+
+export enum TaskParamType {
+  STRING = 'STRING',
+  BROWSER_INSTANCE = 'BROWSER_INSTANCE',
+  SELECT = 'SELECT',
+  CREDENTIAL = 'CREDENTIAL',
+  JSON = 'JSON',
+  NUMBER = 'NUMBER',
+  BOOLEAN = 'BOOLEAN',
+  ARRAY = 'ARRAY',
+  OBJECT = 'OBJECT',
+}
+
+export interface TaskParam {
+  name: string;
+  type: TaskParamType;
+  helperText?: string;
+  required?: boolean;
+  hideHandle?: boolean;
+  [key: string]: unknown;
+}
+
+export interface TaskOutput {
+  name: string;
+  type: TaskParamType;
+}

package/src/types/workflow.ts

@@ -0,0 +1,49 @@
+import { TaskParam, TaskType } from './task';
+import { AppNode } from './appNode';
+
+export enum WorkflowStatus {
+  DRAFT = 'DRAFT',
+  PUBLISHED = 'PUBLISHED',
+}
+
+export type Workflowtask = {
+  label: string;
+  type: TaskType;
+  isEntryPoint?: boolean;
+  inputs: TaskParam[];
+  outputs: TaskParam[];
+};
+
+export type WorkflowExecutionPlan = WorkflowExecutionPlanPhase[];
+
+export type WorkflowExecutionPlanPhase = {
+  phase: number;
+  nodes: AppNode[];
+};
+
+export enum WorkflowExecutionStatus {
+  PENDING = 'PENDING',
+  RUNNING = 'RUNNING',
+  COMPLETED = 'COMPLETED',
+  FAILED = 'FAILED',
+}
+
+export enum ExecutionPhaseStatus {
+  CREATED = 'CREATED',
+  PENDING = 'PENDING',
+  RUNNING = 'RUNNING',
+  COMPLETED = 'COMPLETED',
+  FAILED = 'FAILED',
+}
+
+export enum WorkflowExecutionTrigger {
+  MANUAL = 'MANUAL',
+  SCHEDULED = 'SCHEDULED',
+}
+
+export enum ScheduleExecutionStatus {
+  PENDING = 'PENDING',
+  RUNNING = 'RUNNING',
+  COMPLETED = 'COMPLETED',
+  FAILED = 'FAILED',
+}

package/src/types/workflowTasks.ts

@@ -0,0 +1,9 @@
+import { TaskParam, TaskType } from './task';
+
+export type WorkflowTask = {
+  label: string;
+  type: TaskType;
+  isEntryPoint?: boolean;
+  inputs: TaskParam[];
+  outputs: TaskParam[];
+};

package/tsconfig.json

@@ -0,0 +1,13 @@
+{
+    "compilerOptions": {
+      "target": "ES2020",
+      "module": "CommonJS",
+      "declaration": true,
+      "outDir": "dist",
+      "rootDir": "src",
+      "strict": true,
+      "esModuleInterop": true
+    },
+    "include": ["src"]
+  }
+