workflow-common 1.1.12 → 1.1.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +56 -0
- package/package.json +1 -1
- package/tasks/ClickElementTask.js +1 -0
package/README.md
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# Workflow Common Library
|
|
2
|
+
|
|
3
|
+
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.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Features
|
|
8
|
+
|
|
9
|
+
- **Reusable Tasks**: Includes a variety of pre-built tasks such as browser automation, HTTP requests, form filling, and more.
|
|
10
|
+
- **Type Definitions**: Provides strongly-typed models for workflows, tasks, execution plans, and more.
|
|
11
|
+
- **Integration with Playwright**: Leverages Playwright for browser automation and testing.
|
|
12
|
+
- **Firebase Support**: Includes utilities for Firebase integration.
|
|
13
|
+
- **Date Utilities**: Uses `date-fns` for date manipulation and formatting.
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## Getting Started
|
|
18
|
+
|
|
19
|
+
### Installation
|
|
20
|
+
|
|
21
|
+
To use this library in your project, install it via npm:
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
npm install workflow-common
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## How to Use
|
|
30
|
+
|
|
31
|
+
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:
|
|
32
|
+
|
|
33
|
+
```javascript
|
|
34
|
+
// Import the library
|
|
35
|
+
const { executeTask, formatDate } = require('workflow-common');
|
|
36
|
+
|
|
37
|
+
// Example: Executing a reusable task
|
|
38
|
+
executeTask('httpRequest', {
|
|
39
|
+
url: 'https://api.example.com/data',
|
|
40
|
+
method: 'GET',
|
|
41
|
+
}).then((response) => {
|
|
42
|
+
console.log('Response:', response);
|
|
43
|
+
});
|
|
44
|
+
|
|
45
|
+
// Example: Using a date utility
|
|
46
|
+
const formattedDate = formatDate(new Date(), 'yyyy-MM-dd');
|
|
47
|
+
console.log('Formatted Date:', formattedDate);
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## About
|
|
51
|
+
|
|
52
|
+
The **Workflow Common Library** is maintained and developed by **SouthIndus Labs**.
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
If you need help installing or using the library, please reach out to **SouthIndus Labs** via our [Support Center](https://www.southindus.com/contact/).
|
package/package.json
CHANGED