We are excited to announce the release of Node builder version 7.x for VTEX IO apps, effective October 10, 2024. This update is available for everyone using VTEX IO, and developers are encouraged to use it for new and existing apps. Please note that versions 6.x and earlier will be deprecated.
Deprecation schedule of legacy versions
The previous builder versions, 6.x and below, will be deprecated as follows:
- Node builder
4.xdeprecation date: March 2025 - Node builder
6.xdeprecation date: June 2025
We strongly recommend upgrading your node app to the latest Node builder before legacy Node builder versions are deprecated. After deprecation, apps using a legacy builder version will continue to work, but you won't be able to install, release, or publish new versions of the app. See the What needs to be done? section for details.
Why did we make this change?
The Node builder 7.x update comes with new Node.js engine and TypeScript versions. With the new builder, IO apps take advantage of improved performance, security, and new features. For details about these changes, see the Node.js and TypeScript documentation.
Version compatibility
The table below maps each Node builder version with the corresponding Node.js engine, @types/node package (TypeScript definitions for Node), and TypeScript versions.
| Builder version | Node.js | @types/node | TypeScript |
|---|---|---|---|
| 4.x | 12.x | - | 3.9.7 |
| 6.x | 16.x | 12.0.0 | 3.9.7 |
| 7.x | 20.x | 20.0.0 | 5.5.3 |
What needs to be done?
Required actions will vary based on the app’s vendor and status:
| App status | Required actions |
| Native VTEX apps in production | No action is required. VTEX will gradually update supported apps to the latest builder version. |
| Deprecated VTEX apps | Consider finding alternative solutions to prevent future issues. Deprecated VTEX apps are not updated, and using them may lead to conflicts if they are included as dependencies in other applications. Assess your app’s dependencies and explore current options to mitigate risks and enhance stability. |
| New apps and apps in development | Use the updated boilerplates and Node builder version 7.x for new app development. |
| Proprietary apps in production |
|
Native VTEX apps in production
VTEX will gradually update supported apps to the latest builder version before the deprecation date. You can continue using these apps as usual.
Deprecated VTEX apps will remain available for installation and use, regardless of their builder version. However, these apps won't be updated and may cause conflicts if used as dependencies in other Node apps.
New apps and apps in development
If you are developing a new app or working on an app in development, we recommend using the updated boilerplates and the new Node builder version.
Proprietary apps in production
If you have already published and deployed your app, we recommend releasing a new version using the latest Node builder before the deprecation date of the current builder version.
If you keep the current Node builder version, your app will work as usual until the legacy Node builder is deprecated. After this date, your app will still run on our platform, but you won't be able to link, install, and create new app versions with this builder version.
To update your app with Node builder 7.x, follow the instructions in the Node builder 7.x migration guide.
After making the changes, please test your app thoroughly to identify any potential issues, especially regarding dependencies and compatibility.
Support
If you need help with any case related to the builder update, see the troubleshooting section of our migration guide or open a ticket with VTEX support.