workflow-common 1.0.0 → 1.0.2

package/README.md

@@ -22,4 +22,27 @@ To use this library in your project, install it via npm:
 
 ```bash
 npm install workflow-common
-```
+```
+
+---
+
+## How to Use
+
+After installing the library, you can import and use its features in your project. Below is an example of how to use a reusable task and a utility function:
+
+```javascript
+// Import the library
+const { executeTask, formatDate } = require('workflow-common');
+
+// Example: Executing a reusable task
+executeTask('httpRequest', {
+  url: 'https://api.example.com/data',
+  method: 'GET',
+}).then((response) => {
+  console.log('Response:', response);
+});
+
+// Example: Using a date utility
+const formattedDate = formatDate(new Date(), 'yyyy-MM-dd');
+console.log('Formatted Date:', formattedDate);
+```

package/{src/index.ts → index.d.ts}

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

package/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./tasks"), exports);
+__exportStar(require("./types"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "workflow-common",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "this is shared library project for bolt ui and backend",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/tasks/AddPropertyToJsonTask.d.ts

@@ -0,0 +1,2 @@
+import { WorkflowTask } from '../types/workflowTasks';
+export declare const AddPropertyToJsonTask: WorkflowTask;

package/tasks/AddPropertyToJsonTask.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AddPropertyToJsonTask = void 0;
+const task_1 = require("../types/task");
+exports.AddPropertyToJsonTask = {
+    type: task_1.TaskType.ADD_PROPERTY_TO_JSON,
+    label: 'Add Property to JSON',
+    isEntryPoint: false,
+    inputs: [
+        {
+            name: 'JSON',
+            type: task_1.TaskParamType.STRING,
+            required: true,
+        },
+        {
+            name: 'Property name',
+            type: task_1.TaskParamType.STRING,
+            required: true,
+        },
+        {
+            name: 'Property value',
+            type: task_1.TaskParamType.STRING,
+            required: true,
+        },
+    ],
+    outputs: [
+        {
+            name: 'Updated JSON',
+            type: task_1.TaskParamType.STRING,
+        },
+    ],
+};

package/tasks/ApplySessionSorageTask.d.ts

@@ -0,0 +1,2 @@
+import { WorkflowTask } from '../types/workflowTasks';
+export declare const ApplySessionStorageTask: WorkflowTask;

package/tasks/ApplySessionSorageTask.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApplySessionStorageTask = void 0;
+const task_1 = require("../types/task");
+exports.ApplySessionStorageTask = {
+    type: task_1.TaskType.APPLY_SESSION_STORAGE,
+    label: 'Apply Session Storage',
+    isEntryPoint: false,
+    inputs: [
+        {
+            name: 'Web page',
+            type: task_1.TaskParamType.BROWSER_INSTANCE,
+            required: true,
+        },
+        {
+            name: 'Key',
+            type: task_1.TaskParamType.STRING,
+            required: true,
+        },
+        {
+            name: 'Value',
+            type: task_1.TaskParamType.STRING,
+            required: true,
+        },
+    ],
+    outputs: [
+        {
+            name: 'Web page',
+            type: task_1.TaskParamType.BROWSER_INSTANCE,
+        },
+    ],
+};

package/tasks/CheckElementExistsTask.d.ts

@@ -0,0 +1,2 @@
+import { WorkflowTask } from '../types/workflowTasks';
+export declare const CheckElementExistsTask: WorkflowTask;

package/tasks/CheckElementExistsTask.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CheckElementExistsTask = void 0;
+const task_1 = require("../types/task");
+exports.CheckElementExistsTask = {
+    type: task_1.TaskType.CHECK_ELEMENT_EXISTS,
+    label: 'Check Element Exists',
+    isEntryPoint: false,
+    inputs: [
+        {
+            name: 'Web page',
+            type: task_1.TaskParamType.BROWSER_INSTANCE,
+            required: true,
+        },
+        {
+            name: 'Selector',
+            type: task_1.TaskParamType.STRING,
+            required: true,
+        },
+    ],
+    outputs: [
+        {
+            name: 'Exists',
+            type: task_1.TaskParamType.BOOLEAN,
+        },
+        {
+            name: 'Web page',
+            type: task_1.TaskParamType.BROWSER_INSTANCE,
+        },
+    ],
+};

package/tasks/ClearInputTask.d.ts

@@ -0,0 +1,2 @@
+import { WorkflowTask } from '../types/workflowTasks';
+export declare const ClearInputTask: WorkflowTask;

package/tasks/ClearInputTask.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClearInputTask = void 0;
+const task_1 = require("../types/task");
+exports.ClearInputTask = {
+    type: task_1.TaskType.CLEAR_INPUT,
+    label: 'Clear Input Field',
+    isEntryPoint: false,
+    inputs: [
+        {
+            name: 'Web page',
+            type: task_1.TaskParamType.BROWSER_INSTANCE,
+            required: true,
+        },
+        {
+            name: 'Selector',
+            type: task_1.TaskParamType.STRING,
+            required: true,
+        },
+    ],
+    outputs: [
+        {
+            name: 'Web page',
+            type: task_1.TaskParamType.BROWSER_INSTANCE,
+        },
+    ],
+};

package/tasks/ClickElementTask.d.ts

@@ -0,0 +1,2 @@
+import { WorkflowTask } from '../types/workflowTasks';
+export declare const ClickElementTask: WorkflowTask;

package/tasks/ClickElementTask.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClickElementTask = void 0;
+const task_1 = require("../types/task");
+exports.ClickElementTask = {
+    type: task_1.TaskType.CLICK_ELEMENT,
+    label: 'Click element',
+    isEntryPoint: false,
+    inputs: [
+        {
+            name: 'Web page',
+            type: task_1.TaskParamType.BROWSER_INSTANCE,
+            required: true,
+        },
+        {
+            name: 'Selector',
+            type: task_1.TaskParamType.STRING,
+            required: true,
+        },
+    ],
+    outputs: [
+        {
+            name: 'Web page',
+            type: task_1.TaskParamType.BROWSER_INSTANCE,
+        },
+    ],
+};

package/tasks/CloseBrowserTask.d.ts

@@ -0,0 +1,2 @@
+import { WorkflowTask } from '../types/workflowTasks';
+export declare const CloseBrowserTask: WorkflowTask;

package/tasks/CloseBrowserTask.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CloseBrowserTask = void 0;
+const task_1 = require("../types/task");
+exports.CloseBrowserTask = {
+    type: task_1.TaskType.CLOSE_BROWSER,
+    label: 'Close Browser',
+    isEntryPoint: false,
+    inputs: [
+        {
+            name: 'Web page',
+            type: task_1.TaskParamType.BROWSER_INSTANCE,
+            required: true,
+        },
+    ],
+    outputs: [], // No output because browser is closed
+};

package/tasks/DeliverViaWebhookTask.d.ts

@@ -0,0 +1,2 @@
+import { WorkflowTask } from '../types/workflowTasks';
+export declare const DeliverViaWebhookTask: WorkflowTask;

package/tasks/DeliverViaWebhookTask.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeliverViaWebhookTask = void 0;
+const task_1 = require("../types/task");
+exports.DeliverViaWebhookTask = {
+    type: task_1.TaskType.DELIVER_VIA_WEBHOOK,
+    label: 'Deliver via webhook',
+    isEntryPoint: false,
+    inputs: [
+        {
+            name: 'Target URL',
+            type: task_1.TaskParamType.STRING,
+            required: true,
+        },
+        {
+            name: 'Body',
+            type: task_1.TaskParamType.STRING,
+            required: true,
+        },
+    ],
+    outputs: [],
+};

package/tasks/DoubleClickElementTask.d.ts

@@ -0,0 +1,2 @@
+import { WorkflowTask } from '../types/workflowTasks';
+export declare const DoubleClickElementTask: WorkflowTask;

package/tasks/DoubleClickElementTask.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DoubleClickElementTask = void 0;
+const task_1 = require("../types/task");
+exports.DoubleClickElementTask = {
+    type: task_1.TaskType.DOUBLE_CLICK_ELEMENT,
+    label: 'Double Click Element',
+    isEntryPoint: false,
+    inputs: [
+        {
+            name: 'Web page',
+            type: task_1.TaskParamType.BROWSER_INSTANCE,
+            required: true,
+        },
+        {
+            name: 'Selector',
+            type: task_1.TaskParamType.STRING,
+            required: true,
+        },
+    ],
+    outputs: [
+        {
+            name: 'Web page',
+            type: task_1.TaskParamType.BROWSER_INSTANCE,
+        },
+    ],
+};

package/tasks/ExtractElementByTextTask.d.ts

@@ -0,0 +1,2 @@
+import { WorkflowTask } from '../types/workflowTasks';
+export declare const ExtractElementByTextTask: WorkflowTask;

package/tasks/ExtractElementByTextTask.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExtractElementByTextTask = void 0;
+const task_1 = require("../types/task");
+exports.ExtractElementByTextTask = {
+    type: task_1.TaskType.EXTRACT_ELEMENT_BY_TEXT,
+    label: 'Extract Element by text',
+    isEntryPoint: false,
+    inputs: [
+        {
+            name: 'Web page',
+            type: task_1.TaskParamType.BROWSER_INSTANCE,
+            required: true,
+        },
+        {
+            name: 'text',
+            type: task_1.TaskParamType.STRING,
+            required: true,
+        },
+        {
+            name: 'element',
+            type: task_1.TaskParamType.SELECT,
+            hideHandle: true,
+            required: true,
+            options: [
+                {
+                    label: 'div',
+                    value: 'div',
+                },
+                {
+                    label: 'button',
+                    value: 'button',
+                },
+            ],
+        },
+    ],
+    outputs: [
+        {
+            name: 'Web page',
+            type: task_1.TaskParamType.BROWSER_INSTANCE,
+        },
+        {
+            name: 'Element Selector',
+            type: task_1.TaskParamType.STRING,
+        },
+    ],
+};

package/tasks/ExtractTextAndValidateTask.d.ts

@@ -0,0 +1,2 @@
+import { WorkflowTask } from '../types/workflowTasks';
+export declare const ExtractTextAndValidateTask: WorkflowTask;

package/tasks/ExtractTextAndValidateTask.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExtractTextAndValidateTask = void 0;
+const task_1 = require("../types/task");
+exports.ExtractTextAndValidateTask = {
+    type: task_1.TaskType.EXTRACT_TEXT_AND_VALIDATE,
+    label: 'Extract text and validate',
+    isEntryPoint: false,
+    inputs: [
+        {
+            name: 'Web page',
+            type: task_1.TaskParamType.BROWSER_INSTANCE,
+            required: true,
+            variant: 'textarea',
+        },
+        {
+            name: 'Selector',
+            type: task_1.TaskParamType.STRING,
+            required: true,
+        },
+        {
+            name: 'Exptected text',
+            type: task_1.TaskParamType.STRING,
+            required: true,
+        },
+    ],
+    outputs: [
+        {
+            name: 'Extracted text',
+            type: task_1.TaskParamType.STRING,
+        },
+        {
+            name: 'Web page',
+            type: task_1.TaskParamType.BROWSER_INSTANCE,
+        },
+    ],
+};

package/tasks/FillCredentialsTask.d.ts

@@ -0,0 +1,2 @@
+import { WorkflowTask } from '../types/workflowTasks';
+export declare const FillCredentialTask: WorkflowTask;

package/tasks/FillCredentialsTask.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FillCredentialTask = void 0;
+const task_1 = require("../types/task");
+exports.FillCredentialTask = {
+    type: task_1.TaskType.FILL_CREDENTIAL,
+    label: 'Fill Credential',
+    isEntryPoint: false,
+    inputs: [
+        {
+            name: 'Web page',
+            type: task_1.TaskParamType.BROWSER_INSTANCE,
+            required: true,
+        },
+        {
+            name: 'Selector',
+            type: task_1.TaskParamType.STRING,
+            required: true,
+        },
+        {
+            name: 'Credential',
+            type: task_1.TaskParamType.CREDENTIAL,
+            required: true,
+        },
+    ],
+    outputs: [
+        {
+            name: 'Web page',
+            type: task_1.TaskParamType.BROWSER_INSTANCE,
+        },
+    ],
+};

package/tasks/FillInputTask.d.ts

@@ -0,0 +1,2 @@
+import { WorkflowTask } from '../types/workflowTasks';
+export declare const FillInputTask: WorkflowTask;

package/tasks/FillInputTask.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FillInputTask = void 0;
+const task_1 = require("../types/task");
+exports.FillInputTask = {
+    type: task_1.TaskType.FILL_INPUT,
+    label: 'Fill Input',
+    isEntryPoint: false,
+    inputs: [
+        {
+            name: 'Web Page',
+            type: task_1.TaskParamType.BROWSER_INSTANCE,
+            required: true,
+        },
+        {
+            name: 'Selector',
+            type: task_1.TaskParamType.STRING,
+            required: true,
+        },
+        {
+            name: 'Value',
+            type: task_1.TaskParamType.STRING,
+            required: true,
+        },
+    ],
+    outputs: [
+        {
+            name: 'Web Page',
+            type: task_1.TaskParamType.BROWSER_INSTANCE,
+        },
+    ],
+};

package/tasks/GoForwardTask.d.ts

@@ -0,0 +1,2 @@
+import { WorkflowTask } from '../types/workflowTasks';
+export declare const GoForwardTask: WorkflowTask;

package/tasks/GoForwardTask.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GoForwardTask = void 0;
+const task_1 = require("../types/task");
+exports.GoForwardTask = {
+    type: task_1.TaskType.GO_FORWARD,
+    label: 'Go Forward',
+    isEntryPoint: false,
+    inputs: [
+        {
+            name: 'Web page',
+            type: task_1.TaskParamType.BROWSER_INSTANCE,
+            required: true,
+        },
+    ],
+    outputs: [
+        {
+            name: 'Web page',
+            type: task_1.TaskParamType.BROWSER_INSTANCE,
+        },
+    ],
+};

package/tasks/GobackTask.d.ts

@@ -0,0 +1,2 @@
+import { WorkflowTask } from '../types/workflowTasks';
+export declare const GoBackTask: WorkflowTask;

package/tasks/GobackTask.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GoBackTask = void 0;
+const task_1 = require("../types/task");
+exports.GoBackTask = {
+    type: task_1.TaskType.GO_BACK,
+    label: 'Go Back',
+    isEntryPoint: false,
+    inputs: [
+        {
+            name: 'Web page',
+            type: task_1.TaskParamType.BROWSER_INSTANCE,
+            required: true,
+        },
+    ],
+    outputs: [
+        {
+            name: 'Web page',
+            type: task_1.TaskParamType.BROWSER_INSTANCE,
+        },
+    ],
+};

package/tasks/HoverElementTask.d.ts

@@ -0,0 +1,2 @@
+import { WorkflowTask } from '../types/workflowTasks';
+export declare const HoverElementTask: WorkflowTask;

package/tasks/HoverElementTask.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HoverElementTask = void 0;
+const task_1 = require("../types/task");
+exports.HoverElementTask = {
+    type: task_1.TaskType.HOVER_ELEMENT,
+    label: 'Hover Over Element',
+    isEntryPoint: false,
+    inputs: [
+        {
+            name: 'Web page',
+            type: task_1.TaskParamType.BROWSER_INSTANCE,
+            required: true,
+        },
+        {
+            name: 'Selector',
+            type: task_1.TaskParamType.STRING,
+            required: true,
+        },
+    ],
+    outputs: [
+        {
+            name: 'Web page',
+            type: task_1.TaskParamType.BROWSER_INSTANCE,
+        },
+    ],
+};

package/tasks/HttpRequestTask.d.ts

@@ -0,0 +1,2 @@
+import { WorkflowTask } from '../types/workflowTasks';
+export declare const HttpRequestTask: WorkflowTask;

package/tasks/HttpRequestTask.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpRequestTask = void 0;
+const task_1 = require("../types/task");
+exports.HttpRequestTask = {
+    type: task_1.TaskType.HTTP_REQUEST,
+    label: 'HTTP Request',
+    isEntryPoint: false,
+    inputs: [
+        {
+            name: 'Web Page',
+            type: task_1.TaskParamType.BROWSER_INSTANCE,
+            required: true,
+        },
+        {
+            name: 'URL',
+            type: task_1.TaskParamType.STRING,
+            required: true,
+        },
+        {
+            name: 'Method',
+            type: task_1.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: task_1.TaskParamType.JSON,
+            required: false,
+        },
+        {
+            name: 'Body (JSON)',
+            type: task_1.TaskParamType.JSON,
+            required: false,
+        },
+    ],
+    outputs: [
+        {
+            name: 'Response Status',
+            type: task_1.TaskParamType.NUMBER,
+        },
+        {
+            name: 'Response Body',
+            type: task_1.TaskParamType.JSON,
+        },
+        {
+            name: 'Web Page',
+            type: task_1.TaskParamType.BROWSER_INSTANCE,
+            required: true,
+        },
+    ],
+};

package/tasks/LaunchBrowserTask.d.ts

@@ -0,0 +1,2 @@
+import { WorkflowTask } from '../types/workflowTasks';
+export declare const LaunchBrowserTask: WorkflowTask;

package/tasks/LaunchBrowserTask.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LaunchBrowserTask = void 0;
+const task_1 = require("../types/task");
+exports.LaunchBrowserTask = {
+    type: task_1.TaskType.LAUNCH_BROWSER,
+    label: 'Launch Browser',
+    isEntryPoint: true,
+    inputs: [
+        {
+            name: 'Website URL',
+            type: task_1.TaskParamType.STRING,
+            helperText: 'eg: https://www.google.com',
+            required: true,
+            hideHandle: true,
+        },
+    ],
+    outputs: [
+        { name: 'Web Page', type: task_1.TaskParamType.BROWSER_INSTANCE },
+    ],
+};