workflow-common 1.0.0

package/README.md

@@ -0,0 +1,25 @@
+# Workflow Common Library
+
+The **Workflow Common Library** is a shared library designed to support both the **Bolt UI** and backend systems. It provides a collection of reusable tasks, types, and utilities to streamline workflow execution and automation processes.
+
+---
+
+## Features
+
+- **Reusable Tasks**: Includes a variety of pre-built tasks such as browser automation, HTTP requests, form filling, and more.
+- **Type Definitions**: Provides strongly-typed models for workflows, tasks, execution plans, and more.
+- **Integration with Playwright**: Leverages Playwright for browser automation and testing.
+- **Firebase Support**: Includes utilities for Firebase integration.
+- **Date Utilities**: Uses `date-fns` for date manipulation and formatting.
+
+---
+
+## Getting Started
+
+### Installation
+
+To use this library in your project, install it via npm:
+
+```bash
+npm install workflow-common
+```

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "workflow-common",
+  "version": "1.0.0",
+  "description": "this is shared library project for bolt ui and backend",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "commonjs",
+  "scripts": {
+    "build": "tsc",
+    "watch": "tsc -w"
+  },
+  "author": "Aviral Kesarwani",
+  "license": "ISC",
+  "dependencies": {
+    "@playwright/test": "^1.53.2",
+    "@xyflow/react": "^12.8.2",
+    "date-fns": "^4.1.0",
+    "firebase": "^11.10.0",
+    "typescript": "^5.8.3"
+  },
+  "devDependencies": {
+    "@types/react": "^19.1.9"
+  }
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from './tasks';
+export * from './types';

package/src/tasks/AddPropertyToJsonTask.ts

@@ -0,0 +1,31 @@
+import { WorkflowTask } from '../types/workflowTasks';
+import { TaskParamType, TaskType } from '../types/task';
+
+export const AddPropertyToJsonTask: WorkflowTask = {
+  type: TaskType.ADD_PROPERTY_TO_JSON,
+  label: 'Add Property to JSON',
+  isEntryPoint: false,
+  inputs: [
+    {
+      name: 'JSON',
+      type: TaskParamType.STRING,
+      required: true,
+    },
+    {
+      name: 'Property name',
+      type: TaskParamType.STRING,
+      required: true,
+    },
+    {
+      name: 'Property value',
+      type: TaskParamType.STRING,
+      required: true,
+    },
+  ] as const,
+  outputs: [
+    {
+      name: 'Updated JSON',
+      type: TaskParamType.STRING,
+    },
+  ] as const,
+};

package/src/tasks/ApplySessionSorageTask.ts

@@ -0,0 +1,31 @@
+import { WorkflowTask } from '../types/workflowTasks';
+import { TaskParamType, TaskType } from '../types/task';
+
+export const ApplySessionStorageTask: WorkflowTask = {
+  type: TaskType.APPLY_SESSION_STORAGE,
+  label: 'Apply Session Storage',
+  isEntryPoint: false,
+  inputs: [
+    {
+      name: 'Web page',
+      type: TaskParamType.BROWSER_INSTANCE,
+      required: true,
+    },
+    {
+      name: 'Key',
+      type: TaskParamType.STRING,
+      required: true,
+    },
+    {
+      name: 'Value',
+      type: TaskParamType.STRING,
+      required: true,
+    },
+  ] as const,
+  outputs: [
+    {
+      name: 'Web page',
+      type: TaskParamType.BROWSER_INSTANCE,
+    },
+  ] as const,
+};

package/src/tasks/CheckElementExistsTask.ts

@@ -0,0 +1,30 @@
+import { WorkflowTask } from '../types/workflowTasks';
+import { TaskParamType, TaskType } from '../types/task';
+
+export const CheckElementExistsTask: WorkflowTask = {
+  type: TaskType.CHECK_ELEMENT_EXISTS,
+  label: 'Check Element Exists',
+  isEntryPoint: false,
+  inputs: [
+    {
+      name: 'Web page',
+      type: TaskParamType.BROWSER_INSTANCE,
+      required: true,
+    },
+    {
+      name: 'Selector',
+      type: TaskParamType.STRING,
+      required: true,
+    },
+  ] as const,
+  outputs: [
+    {
+      name: 'Exists',
+      type: TaskParamType.BOOLEAN,
+    },
+    {
+      name: 'Web page',
+      type: TaskParamType.BROWSER_INSTANCE,
+    },
+  ] as const,
+};

package/src/tasks/ClearInputTask.ts

@@ -0,0 +1,26 @@
+import { WorkflowTask } from '../types/workflowTasks';
+import { TaskParamType, TaskType } from '../types/task';
+
+export const ClearInputTask: WorkflowTask = {
+  type: TaskType.CLEAR_INPUT,
+  label: 'Clear Input Field',
+  isEntryPoint: false,
+  inputs: [
+    {
+      name: 'Web page',
+      type: TaskParamType.BROWSER_INSTANCE,
+      required: true,
+    },
+    {
+      name: 'Selector',
+      type: TaskParamType.STRING,
+      required: true,
+    },
+  ] as const,
+  outputs: [
+    {
+      name: 'Web page',
+      type: TaskParamType.BROWSER_INSTANCE,
+    },
+  ] as const,
+};

package/src/tasks/ClickElementTask.ts

@@ -0,0 +1,26 @@
+import { WorkflowTask } from '../types/workflowTasks';
+import { TaskParamType, TaskType } from '../types/task';
+
+export const ClickElementTask: WorkflowTask = {
+  type: TaskType.CLICK_ELEMENT,
+  label: 'Click element',
+  isEntryPoint: false,
+  inputs: [
+    {
+      name: 'Web page',
+      type: TaskParamType.BROWSER_INSTANCE,
+      required: true,
+    },
+    {
+      name: 'Selector',
+      type: TaskParamType.STRING,
+      required: true,
+    },
+  ] as const,
+  outputs: [
+    {
+      name: 'Web page',
+      type: TaskParamType.BROWSER_INSTANCE,
+    },
+  ] as const,
+};

package/src/tasks/CloseBrowserTask.ts

@@ -0,0 +1,16 @@
+import { WorkflowTask } from '../types/workflowTasks';
+import { TaskParamType, TaskType } from '../types/task';
+
+export const CloseBrowserTask: WorkflowTask = {
+  type: TaskType.CLOSE_BROWSER,
+  label: 'Close Browser',
+  isEntryPoint: false,
+  inputs: [
+    {
+      name: 'Web page',
+      type: TaskParamType.BROWSER_INSTANCE,
+      required: true,
+    },
+  ] as const,
+  outputs: [] as const, // No output because browser is closed
+};

package/src/tasks/DeliverViaWebhookTask.ts

@@ -0,0 +1,21 @@
+import { WorkflowTask } from '../types/workflowTasks';
+import { TaskParamType, TaskType } from '../types/task';
+
+export const DeliverViaWebhookTask: WorkflowTask = {
+  type: TaskType.DELIVER_VIA_WEBHOOK,
+  label: 'Deliver via webhook',
+  isEntryPoint: false,
+  inputs: [
+    {
+      name: 'Target URL',
+      type: TaskParamType.STRING,
+      required: true,
+    },
+    {
+      name: 'Body',
+      type: TaskParamType.STRING,
+      required: true,
+    },
+  ] as const,
+  outputs: [] as const,
+};

package/src/tasks/DoubleClickElementTask.ts

@@ -0,0 +1,26 @@
+import { WorkflowTask } from '../types/workflowTasks';
+import { TaskParamType, TaskType } from '../types/task';
+
+export const DoubleClickElementTask: WorkflowTask = {
+  type: TaskType.DOUBLE_CLICK_ELEMENT,
+  label: 'Double Click Element',
+  isEntryPoint: false,
+  inputs: [
+    {
+      name: 'Web page',
+      type: TaskParamType.BROWSER_INSTANCE,
+      required: true,
+    },
+    {
+      name: 'Selector',
+      type: TaskParamType.STRING,
+      required: true,
+    },
+  ] as const,
+  outputs: [
+    {
+      name: 'Web page',
+      type: TaskParamType.BROWSER_INSTANCE,
+    },
+  ] as const,
+};

package/src/tasks/ExtractElementByTextTask.ts

@@ -0,0 +1,46 @@
+import { WorkflowTask } from '../types/workflowTasks';
+import { TaskParamType, TaskType } from '../types/task';
+
+export const ExtractElementByTextTask: WorkflowTask = {
+  type: TaskType.EXTRACT_ELEMENT_BY_TEXT,
+  label: 'Extract Element by text',
+  isEntryPoint: false,
+  inputs: [
+    {
+      name: 'Web page',
+      type: TaskParamType.BROWSER_INSTANCE,
+      required: true,
+    },
+    {
+      name: 'text',
+      type: TaskParamType.STRING,
+      required: true,
+    },
+    {
+      name: 'element',
+      type: TaskParamType.SELECT,
+      hideHandle: true,
+      required: true,
+      options: [
+        {
+          label: 'div',
+          value: 'div',
+        },
+        {
+          label: 'button',
+          value: 'button',
+        },
+      ],
+    },
+  ] as const,
+  outputs: [
+    {
+      name: 'Web page',
+      type: TaskParamType.BROWSER_INSTANCE,
+    },
+    {
+      name: 'Element Selector',
+      type: TaskParamType.STRING,
+    },
+  ] as const,
+};

package/src/tasks/ExtractTextAndValidateTask.ts

@@ -0,0 +1,36 @@
+import { WorkflowTask } from '../types/workflowTasks';
+import { TaskParamType, TaskType } from '../types/task';
+
+export const ExtractTextAndValidateTask: WorkflowTask = {
+  type: TaskType.EXTRACT_TEXT_AND_VALIDATE,
+  label: 'Extract text and validate',
+  isEntryPoint: false,
+  inputs: [
+    {
+      name: 'Web page',
+      type: TaskParamType.BROWSER_INSTANCE,
+      required: true,
+      variant: 'textarea',
+    },
+    {
+      name: 'Selector',
+      type: TaskParamType.STRING,
+      required: true,
+    },
+    {
+      name: 'Exptected text',
+      type: TaskParamType.STRING,
+      required: true,
+    },
+  ] as const,
+  outputs: [
+    {
+      name: 'Extracted text',
+      type: TaskParamType.STRING,
+    },
+    {
+      name: 'Web page',
+      type: TaskParamType.BROWSER_INSTANCE,
+    },
+  ] as const,
+};

package/src/tasks/FillCredentialsTask.ts

@@ -0,0 +1,31 @@
+import { WorkflowTask } from '../types/workflowTasks';
+import { TaskParamType, TaskType } from '../types/task';
+
+export const FillCredentialTask: WorkflowTask = {
+  type: TaskType.FILL_CREDENTIAL,
+  label: 'Fill Credential',
+  isEntryPoint: false,
+  inputs: [
+    {
+      name: 'Web page',
+      type: TaskParamType.BROWSER_INSTANCE,
+      required: true,
+    },
+    {
+      name: 'Selector',
+      type: TaskParamType.STRING,
+      required: true,
+    },
+    {
+      name: 'Credential',
+      type: TaskParamType.CREDENTIAL,
+      required: true,
+    },
+  ] as const,
+  outputs: [
+    {
+      name: 'Web page',
+      type: TaskParamType.BROWSER_INSTANCE,
+    },
+  ] as const,
+};

package/src/tasks/FillInputTask.ts

@@ -0,0 +1,31 @@
+import { WorkflowTask } from '../types/workflowTasks';
+import { TaskParamType, TaskType } from '../types/task';
+
+export const FillInputTask: WorkflowTask = {
+  type: TaskType.FILL_INPUT,
+  label: 'Fill Input',
+  isEntryPoint: false,
+  inputs: [
+    {
+      name: 'Web Page',
+      type: TaskParamType.BROWSER_INSTANCE,
+      required: true,
+    },
+    {
+      name: 'Selector',
+      type: TaskParamType.STRING,
+      required: true,
+    },
+    {
+      name: 'Value',
+      type: TaskParamType.STRING,
+      required: true,
+    },
+  ] as const,
+  outputs: [
+    {
+      name: 'Web Page',
+      type: TaskParamType.BROWSER_INSTANCE,
+    },
+  ] as const,
+};

package/src/tasks/GoForwardTask.ts

@@ -0,0 +1,21 @@
+import { WorkflowTask } from '../types/workflowTasks';
+import { TaskParamType, TaskType } from '../types/task';
+
+export const GoForwardTask: WorkflowTask = {
+  type: TaskType.GO_FORWARD,
+  label: 'Go Forward',
+  isEntryPoint: false,
+  inputs: [
+    {
+      name: 'Web page',
+      type: TaskParamType.BROWSER_INSTANCE,
+      required: true,
+    },
+  ] as const,
+  outputs: [
+    {
+      name: 'Web page',
+      type: TaskParamType.BROWSER_INSTANCE,
+    },
+  ] as const,
+};

package/src/tasks/GobackTask.ts

@@ -0,0 +1,21 @@
+import { WorkflowTask } from '../types/workflowTasks';
+import { TaskParamType, TaskType } from '../types/task';
+
+export const GoBackTask: WorkflowTask = {
+  type: TaskType.GO_BACK,
+  label: 'Go Back',
+  isEntryPoint: false,
+  inputs: [
+    {
+      name: 'Web page',
+      type: TaskParamType.BROWSER_INSTANCE,
+      required: true,
+    },
+  ] as const,
+  outputs: [
+    {
+      name: 'Web page',
+      type: TaskParamType.BROWSER_INSTANCE,
+    },
+  ] as const,
+};

package/src/tasks/HoverElementTask.ts

@@ -0,0 +1,26 @@
+import { WorkflowTask } from '../types/workflowTasks';
+import { TaskParamType, TaskType } from '../types/task';
+
+export const HoverElementTask: WorkflowTask = {
+  type: TaskType.HOVER_ELEMENT,
+  label: 'Hover Over Element',
+  isEntryPoint: false,
+  inputs: [
+    {
+      name: 'Web page',
+      type: TaskParamType.BROWSER_INSTANCE,
+      required: true,
+    },
+    {
+      name: 'Selector',
+      type: TaskParamType.STRING,
+      required: true,
+    },
+  ] as const,
+  outputs: [
+    {
+      name: 'Web page',
+      type: TaskParamType.BROWSER_INSTANCE,
+    },
+  ] as const,
+};

package/src/tasks/HttpRequestTask.ts

@@ -0,0 +1,57 @@
+import { WorkflowTask } from '../types/workflowTasks';
+import { TaskParamType, TaskType } from '../types/task';
+
+export const HttpRequestTask: WorkflowTask = {
+  type: TaskType.HTTP_REQUEST,
+  label: 'HTTP Request',
+  isEntryPoint: false,
+  inputs: [
+    {
+      name: 'Web Page',
+      type: TaskParamType.BROWSER_INSTANCE,
+      required: true,
+    },
+    {
+      name: 'URL',
+      type: TaskParamType.STRING,
+      required: true,
+    },
+    {
+      name: 'Method',
+      type: TaskParamType.SELECT,
+      required: true,
+      options: [
+        { label: 'GET', value: 'GET' },
+        { label: 'POST', value: 'POST' },
+        { label: 'PUT', value: 'PUT' },
+        { label: 'DELETE', value: 'DELETE' },
+        { label: 'PATCH', value: 'PATCH' },
+      ],
+    },
+    {
+      name: 'Headers (JSON)',
+      type: TaskParamType.JSON,
+      required: false,
+    },
+    {
+      name: 'Body (JSON)',
+      type: TaskParamType.JSON,
+      required: false,
+    },
+  ] as const,
+  outputs: [
+    {
+      name: 'Response Status',
+      type: TaskParamType.NUMBER,
+    },
+    {
+      name: 'Response Body',
+      type: TaskParamType.JSON,
+    },
+    {
+      name: 'Web Page',
+      type: TaskParamType.BROWSER_INSTANCE,
+      required: true,
+    },
+  ] as const,
+};

package/src/tasks/LaunchBrowserTask.ts

@@ -0,0 +1,20 @@
+import { WorkflowTask } from '../types/workflowTasks';
+import { TaskParamType, TaskType } from '../types/task';
+
+export const LaunchBrowserTask: WorkflowTask = {
+  type: TaskType.LAUNCH_BROWSER,
+  label: 'Launch Browser',
+  isEntryPoint: true,
+  inputs: [
+    {
+      name: 'Website URL',
+      type: TaskParamType.STRING,
+      helperText: 'eg: https://www.google.com',
+      required: true,
+      hideHandle: true,
+    },
+  ] as const,
+  outputs: [
+    { name: 'Web Page', type: TaskParamType.BROWSER_INSTANCE },
+  ] as const,
+};

package/src/tasks/LogMessageTask.ts

@@ -0,0 +1,36 @@
+import { WorkflowTask } from '../types/workflowTasks';
+import { TaskParamType, TaskType } from '../types/task';
+
+export const LogMessageTask: WorkflowTask = {
+  type: TaskType.LOG_MESSAGE,
+  label: 'Log Message',
+  isEntryPoint: false,
+  inputs: [
+    {
+      name: 'Web Page',
+      type: TaskParamType.BROWSER_INSTANCE,
+      required: true,
+    },
+    {
+      name: 'Message',
+      type: TaskParamType.STRING,
+      required: true,
+    },
+    {
+      name: 'Message Type',
+      type: TaskParamType.SELECT,
+      required: true,
+      options: [
+        { label: 'Info', value: 'info' },
+        { label: 'Error', value: 'error' },
+      ],
+    },
+  ] as const,
+  outputs: [
+    {
+      name: 'Web Page',
+      type: TaskParamType.BROWSER_INSTANCE,
+      required: true,
+    },
+  ] as const,
+};

package/src/tasks/LoginViaBasicAuthTask.ts

@@ -0,0 +1,31 @@
+import { WorkflowTask } from '../types/workflowTasks';
+import { TaskParamType, TaskType } from '../types/task';
+
+export const LoginViaBasicAuthTask: WorkflowTask = {
+  type: TaskType.LOGIN_VIA_BASIC_AUTH,
+  label: 'Login via Basic Auth',
+  isEntryPoint: false,
+  inputs: [
+    {
+      name: 'Web page',
+      type: TaskParamType.BROWSER_INSTANCE,
+      required: true,
+    },
+    {
+      name: 'Username',
+      type: TaskParamType.STRING,
+      required: true,
+    },
+    {
+      name: 'Password',
+      type: TaskParamType.STRING,
+      required: true,
+    },
+  ] as const,
+  outputs: [
+    {
+      name: 'Web page',
+      type: TaskParamType.BROWSER_INSTANCE,
+    },
+  ] as const,
+};

package/src/tasks/NavigateUrlTask.ts

@@ -0,0 +1,26 @@
+import { WorkflowTask } from '../types/workflowTasks';
+import { TaskParamType, TaskType } from '../types/task';
+
+export const NavigateUrlTask: WorkflowTask = {
+  type: TaskType.NAVIGATE_URL,
+  label: 'Navigate Url',
+  isEntryPoint: false,
+  inputs: [
+    {
+      name: 'Web page',
+      type: TaskParamType.BROWSER_INSTANCE,
+      required: true,
+    },
+    {
+      name: 'Url',
+      type: TaskParamType.STRING,
+      required: true,
+    },
+  ] as const,
+  outputs: [
+    {
+      name: 'Web page',
+      type: TaskParamType.BROWSER_INSTANCE,
+    },
+  ] as const,
+};

package/src/tasks/PageToHtmlTask.ts

@@ -0,0 +1,25 @@
+import { WorkflowTask } from '../types/workflowTasks';
+import { TaskParamType, TaskType } from '../types/task';
+
+export const PageToHtmlTask: WorkflowTask = {
+  type: TaskType.PAGE_TO_HTML,
+  label: 'Get Web page HTML',
+  isEntryPoint: false,
+  inputs: [
+    {
+      name: 'Web Page',
+      type: TaskParamType.BROWSER_INSTANCE,
+      required: true,
+    },
+  ] as const,
+  outputs: [
+    {
+      name: 'Html',
+      type: TaskParamType.STRING,
+    },
+    {
+      name: 'Web Page',
+      type: TaskParamType.BROWSER_INSTANCE,
+    },
+  ] as const,
+};