mirror of
https://github.com/ToolJet/ToolJet
synced 2026-04-21 21:47:17 +00:00
66 lines
2.6 KiB
Markdown
66 lines
2.6 KiB
Markdown
|
---
|
||
|
|
id: js
|
||
|
|
title: JavaScript
|
||
|
|
---
|
||
|
|
|
||
|
|
<br/>
|
||
|
|
|
||
|
|
ToolJet workflows let you import **npm packages** into your workflow so that every JavaScript node can use them. Once a package is added, it is bundled and available across all JavaScript nodes in that workflow version.
|
||
|
|
|
||
|
|
:::info
|
||
|
|
External library support for workflows is available on **Enterprise Edition** plans.
|
||
|
|
:::
|
||
|
|
|
||
|
|
## Adding Packages
|
||
|
|
|
||
|
|
1. Open your workflow in the editor.
|
||
|
|
2. Click the **Packages** icon in the left sidebar to open the package manager panel.
|
||
|
|
3. Type a package name (e.g., `lodash`) in the search field — results are fetched from the npm registry.
|
||
|
|
4. Select the package and version you want to install, then click **Add**.
|
||
|
|
5. The package is added to the workflow's dependency list and a bundle build starts automatically.
|
||
|
|
|
||
|
|
You can add multiple packages before the bundle finishes building. The bundle regenerates with all current dependencies.
|
||
|
|
|
||
|
|
## Bundle Status
|
||
|
|
|
||
|
|
After adding or removing packages, ToolJet generates a bundle in the background. The package manager panel displays the current status:
|
||
|
|
|
||
|
|
| Status | Meaning |
|
||
|
|
|--------|---------|
|
||
|
|
| **None** | No packages have been added yet. |
|
||
|
|
| **Building** | The bundle is being generated. JavaScript nodes will use the previous bundle (if any) until the new one is ready. |
|
||
|
|
| **Ready** | The bundle is built and available for all JavaScript nodes in this workflow version. |
|
||
|
|
| **Failed** | Bundle generation encountered an error. Check the error message in the panel and try rebuilding. |
|
||
|
|
|
||
|
|
You can manually trigger a rebuild by clicking the **Rebuild** button in the package manager panel.
|
||
|
|
|
||
|
|
## Using Packages in JavaScript Nodes
|
||
|
|
|
||
|
|
Once the bundle status is **Ready**, you can `import` the packages directly in any JavaScript node:
|
||
|
|
|
||
|
|
```js
|
||
|
|
import lodash from 'lodash';
|
||
|
|
import { v4 as uuidv4 } from 'uuid';
|
||
|
|
|
||
|
|
const grouped = lodash.groupBy(getOrders.data, 'status');
|
||
|
|
|
||
|
|
return {
|
||
|
|
requestId: uuidv4(),
|
||
|
|
summary: grouped
|
||
|
|
};
|
||
|
|
```
|
||
|
|
|
||
|
|
Packages are available to all JavaScript nodes in the workflow — you don't need to import them separately per node.
|
||
|
|
|
||
|
|
## Removing Packages
|
||
|
|
|
||
|
|
1. Open the package manager panel.
|
||
|
|
2. Click the **Remove** icon next to the package you want to remove.
|
||
|
|
3. The bundle regenerates automatically without the removed package.
|
||
|
|
|
||
|
|
## Limitations
|
||
|
|
|
||
|
|
- **Enterprise only** — package management is not available in the Community Edition.
|
||
|
|
- **npm packages only** — packages must be published to the npm registry.
|
||
|
|
- **Bundle per workflow version** — each workflow version maintains its own independent set of dependencies.
|
||
|
|
- **No native add-ons** — packages that require native C/C++ compilation during install are not supported. Pure JavaScript and pre-compiled packages work.
|