{"id":22910,"library":"vite-plugin-vinext-zephyr","title":"Vite Plugin Vinext Zephyr","description":"Vite plugin for deploying Vinext applications (Next.js-compatible framework built on Vite) to Zephyr Cloud. Currently at v1.0.2, with active development and patch releases every few weeks. Key differentiators: tightly integrated with Zephyr's deployment platform, handles build and upload of Vinext apps, supports ESM-only usage, and includes security fixes for dependency vulnerabilities. Alternative to manual deployment scripts or cloud-specific plugins.","status":"active","version":"1.0.2","language":"javascript","source_language":"en","source_url":"https://github.com/ZephyrCloudIO/zephyr-packages","tags":["javascript","vite-plugin","vite","vinext","zephyr","deploy","typescript"],"install":[{"cmd":"npm install vite-plugin-vinext-zephyr","lang":"bash","label":"npm"},{"cmd":"yarn add vite-plugin-vinext-zephyr","lang":"bash","label":"yarn"},{"cmd":"pnpm add vite-plugin-vinext-zephyr","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"Peer dependency: required to function as a Vite plugin","package":"vite","optional":false}],"imports":[{"note":"ESM-only package; CommonJS require is not supported.","wrong":"const { vitePluginVinextZephyr } = require('vite-plugin-vinext-zephyr')","symbol":"vitePluginVinextZephyr","correct":"import { vitePluginVinextZephyr } from 'vite-plugin-vinext-zephyr'"},{"note":"Default export is available but named export is preferred. Only the default export is documented, but the named export also exists.","wrong":"import { default } from 'vite-plugin-vinext-zephyr'","symbol":"default","correct":"import vitePluginVinextZephyr from 'vite-plugin-vinext-zephyr'"},{"note":"Types are shipped, but no explicit type exports are documented; use `typeof vitePluginVinextZephyr` if needed.","symbol":"type imports","correct":"import type { ZephyrOptions } from 'vite-plugin-vinext-zephyr'"}],"quickstart":{"code":"// vite.config.ts\nimport { vitePluginVinextZephyr } from 'vite-plugin-vinext-zephyr';\nimport { defineConfig } from 'vite';\n\nexport default defineConfig({\n  plugins: [\n    vitePluginVinextZephyr({\n      // Optional: Zephyr configuration\n      // If not provided, uses environment variables\n      orgSlug: process.env.ZEPHYR_ORG_SLUG ?? '',\n      projectSlug: process.env.ZEPHYR_PROJECT_SLUG ?? '',\n      apiKey: process.env.ZEPHYR_API_KEY ?? '',\n    })\n  ],\n});\n\n// Ensure environment variables are set before building:\n// ZEPHYR_ORG_SLUG=my-org ZEPHYR_PROJECT_SLUG=my-project ZEPHYR_API_KEY=xxx npx vite build","lang":"typescript","description":"Configures Vite with the Vinext Zephyr plugin using environment variables for authentication."},"warnings":[{"fix":"Update Vite to 7.x or 8.x.","message":"The plugin requires Vite ^7.0.0 || ^8.0.0. Using older Vite versions will cause errors.","severity":"gotcha","affected_versions":">=1.0.0"},{"fix":"Review migration guide at https://github.com/ZephyrCloudIO/zephyr-packages/releases/tag/v1.0.0","message":"v1.0.0 introduced breaking changes from v0.x; see changelog for migration.","severity":"breaking","affected_versions":">=1.0.0 <1.0.0"},{"fix":"Use import { vitePluginVinextZephyr } from 'vite-plugin-vinext-zephyr'","message":"Using default import may change in future; named export is preferred.","severity":"deprecated","affected_versions":">=1.0.0"},{"fix":"Explicitly pass options or set ZEPHYR_ORG_SLUG, ZEPHYR_PROJECT_SLUG, ZEPHYR_API_KEY before build.","message":"The plugin's API relies on environment variables for authentication; missing env vars can lead to silent failures.","severity":"gotcha","affected_versions":">=0.1.0"}],"env_vars":null,"last_verified":"2026-04-27T00:00:00.000Z","next_check":"2026-07-26T00:00:00.000Z","problems":[{"fix":"Ensure your project uses ESM (type: module in package.json) and TypeScript has moduleResolution set to 'bundler' or 'node16'.","cause":"Package is ESM-only; CommonJS require or missing tsconfig settings.","error":"Cannot find module 'vite-plugin-vinext-zephyr' or its corresponding type declarations."},{"fix":"Use vitePluginVinextZephyr() (call the function) in the plugins array.","cause":"Passing the plugin as a function call without instantiation (e.g., using vitePluginVinextZephyr instead of vitePluginVinextZephyr()).","error":"TypeError: Plugin configuration is invalid: plugins must be an array of Vite plugins."},{"fix":"Set ZEPHYR_API_KEY environment variable or pass apiKey in plugin options.","cause":"Missing ZEPHYR_API_KEY or options.apiKey.","error":"Error: [Zephyr] API_KEY is required for authentication. Please provide via environment variable or options."}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}