{"id":26609,"library":"vtex-cms-template-transpiler","title":"Vtex CMS Template Transpiler","description":"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.","status":"active","version":"1.10.0","language":"javascript","source_language":"en","source_url":"ssh://git@github.com/jeffdrumgod/vtex-cms-template-transpiler","tags":["javascript","vtex","npm","proxy","server","cms"],"install":[{"cmd":"npm install vtex-cms-template-transpiler","lang":"bash","label":"npm"},{"cmd":"yarn add vtex-cms-template-transpiler","lang":"bash","label":"yarn"},{"cmd":"pnpm add vtex-cms-template-transpiler","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"HTTP client for proxy requests and fetching remote resources","package":"axios","optional":false}],"imports":[{"note":"ESM only; no default export. Requires Node >=15 for native ESM.","wrong":"const vtex = require('vtex-cms-template-transpiler')","symbol":"VtexCMS","correct":"import { VtexCMS } from 'vtex-cms-template-transpiler'"},{"note":"Use named ESM import. No CommonJS support.","wrong":"const { startProxy } = require('vtex-cms-template-transpiler')","symbol":"startProxy","correct":"import { startProxy } from 'vtex-cms-template-transpiler'"},{"note":"parseTemplate is a named export, not default.","wrong":"import parseTemplate from 'vtex-cms-template-transpiler'","symbol":"parseTemplate","correct":"import { parseTemplate } from 'vtex-cms-template-transpiler'"}],"quickstart":{"code":"import { startProxy } from 'vtex-cms-template-transpiler';\n\nconst config = {\n  port: 3000,\n  storeUrl: 'https://myvtexstore.com',\n  workspace: 'test'\n};\n\nstartProxy(config).then(() => {\n  console.log('Proxy running on port 3000');\n}).catch(err => {\n  console.error('Failed to start proxy:', err);\n});","lang":"typescript","description":"Starts the native HTTP proxy for local Vtex CMS development with custom port, store URL, and workspace."},"warnings":[{"fix":"Update Node.js to v15 or higher and use ESM imports (import ... from).","message":"Node.js version >= 15 required - ESM only, no CommonJS support","severity":"breaking","affected_versions":">=1.0.0"},{"fix":"Contact via https://api.whatsapp.com/send?phone=5511948559073 for help.","message":"Support is only through WhatsApp - no issue tracker or public forum","severity":"gotcha","affected_versions":">0.0.0"},{"fix":"Upgrade to v1.0.2 or later.","message":"axios security update in v1.0.2 - earlier versions may have vulnerabilities","severity":"deprecated","affected_versions":"<1.0.2"},{"fix":"Check the README for list of unimplemented features before using in production.","message":"Package is incomplete - many features not yet implemented (backup, upload, etc.)","severity":"gotcha","affected_versions":"<=1.10.0"},{"fix":"Contact via WhatsApp for setup details.","message":"Documentation is in Portuguese only and marked as 'coming soon'","severity":"gotcha","affected_versions":"<=1.10.0"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Use import statements and ensure your project is ESM (type: 'module' in package.json or .mjs extension).","cause":"Package is ESM-only and cannot be required with CommonJS require().","error":"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."},{"fix":"Upgrade Node.js to version >=15 or use a transpiler like Babel.","cause":"Node.js version <15 does not support ESM. The package uses ES modules.","error":"SyntaxError: Unexpected token 'export'"},{"fix":"Ensure config object has valid port, storeUrl, and workspace properties.","cause":"Missing or invalid configuration object passed to startProxy().","error":"TypeError: Cannot read properties of undefined (reading 'port')"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}