Registry / devops / vtex-cms-template-transpiler

vtex-cms-template-transpiler

library1.10.0jsnpmunverified

Template transpiler and local development proxy for Vtex CMS. Version 1.10.0 supports native HTTP proxy, parsing of templates, subtemplates, custom controls, native controls, placeholders, shelves, and shelf controls. It auto-injects base scripts per page type and allows dynamic store replace rules. Requires Node >=15. Still incomplete with missing automated backup and upload features. Support via WhatsApp only. Last release 1.0.2.

devops web-framework

npm install vtex-cms-template-transpiler

github ↗package ↗

INSTALL

IMPORT

SIG · VTEX-CMS-TEMPLATE-

vtex-cms-template-transpiler

devopsjavascriptv1.10.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

VtexCMS

✓ import { VtexCMS } from 'vtex-cms-template-transpiler'

✗ const vtex = require('vtex-cms-template-transpiler')

ESM only; no default export. Requires Node >=15 for native ESM.

startProxy

✓ import { startProxy } from 'vtex-cms-template-transpiler'

✗ const { startProxy } = require('vtex-cms-template-transpiler')

Use named ESM import. No CommonJS support.

parseTemplate

✓ import { parseTemplate } from 'vtex-cms-template-transpiler'

✗ import parseTemplate from 'vtex-cms-template-transpiler'

parseTemplate is a named export, not default.

Starts the native HTTP proxy for local Vtex CMS development with custom port, store URL, and workspace.

import { startProxy } from 'vtex-cms-template-transpiler'; const config = { port: 3000, storeUrl: 'https://myvtexstore.com', workspace: 'test' }; startProxy(config).then(() => { console.log('Proxy running on port 3000'); }).catch(err => { console.error('Failed to start proxy:', err); });

Debug

Known issues

breakingNode.js version >= 15 required - ESM only, no CommonJS support

fix

Update Node.js to v15 or higher and use ESM imports (import ... from).

affects: >=1.0.0

gotchaSupport is only through WhatsApp - no issue tracker or public forum

fix

Contact via https://api.whatsapp.com/send?phone=5511948559073 for help.

affects: >0.0.0

deprecatedaxios security update in v1.0.2 - earlier versions may have vulnerabilities

fix

Upgrade to v1.0.2 or later.

affects: <1.0.2

gotchaPackage is incomplete - many features not yet implemented (backup, upload, etc.)

fix

Check the README for list of unimplemented features before using in production.

affects: <=1.10.0

gotchaDocumentation is in Portuguese only and marked as 'coming soon'

fix

Contact via WhatsApp for setup details.

affects: <=1.10.0

Errors

Common errors & fixes

Error [ERR_REQUIRE_ESM]: require() of ES Module /path/to/node_modules/vtex-cms-template-transpiler/index.js from /path/to/your-file.js not supported.

Package is ESM-only and cannot be required with CommonJS require().

fix

Use import statements and ensure your project is ESM (type: 'module' in package.json or .mjs extension).

SyntaxError: Unexpected token 'export'

Node.js version <15 does not support ESM. The package uses ES modules.

fix

Upgrade Node.js to version >=15 or use a transpiler like Babel.

TypeError: Cannot read properties of undefined (reading 'port')

Missing or invalid configuration object passed to startProxy().

fix

Ensure config object has valid port, storeUrl, and workspace properties.

Upgrade

Version history

1.10.0latest on npm

Audit

Dependencies

axiosrequiredHTTP client for proxy requests and fetching remote resources

Agent activity

7 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/jeffdrumgod/vtex-cms-template-transpiler ↗

packagehttps://www.npmjs.com/package/vtex-cms-template-transpiler ↗