bini-env 1.0.6 → 1.0.8

package/dist/index.d.cts

@@ -1,79 +0,0 @@
-import { Plugin } from 'vite';
-export { Plugin } from 'vite';
-
-interface BiniEnvPluginOptions {
-    /**
-     * Enable/disable the plugin
-     * @default true
-     */
-    readonly enabled?: boolean;
-    /**
-     * Remove Vite's default header
-     * @default true
-     */
-    readonly clearViteHeader?: boolean;
-    /**
-     * Custom logo/text to display
-     * @default 'ß'
-     */
-    readonly logo?: string;
-    /**
-     * Override the env var prefix exposed to client code.
-     * Defaults to 'BINI_' — so BINI_MY_VAR is accessible via import.meta.env.BINI_MY_VAR
-     * Set to 'VITE_' to keep Vite's default behaviour.
-     * @default 'BINI_'
-     */
-    readonly envPrefix?: string;
-}
-interface DetectedEnvFile {
-    readonly name: string;
-    readonly path: string;
-}
-/**
- * Read an environment variable in any runtime.
- *
- * Priority order:
- *  1. Deno.env       — Netlify edge functions / Deno runtime
- *  2. process.env    — Node.js / Bun / bini-server
- *  3. import.meta.env — Vite client (BINI_-prefixed vars)
- *
- * Usage in API routes:
- *   import { getEnv } from 'bini-env';
- *   const smtpUser = getEnv('SMTP_USER');
- */
-declare function getEnv(key: string): string | undefined;
-/**
- * Read an environment variable and throw if it's missing or empty.
- * Use this for required secrets so you get a clear error at startup
- * instead of a cryptic crash later.
- *
- * Usage:
- *   const smtpPass = requireEnv('SMTP_PASS');
- */
-declare function requireEnv(key: string): string;
-/**
- * Auto-load .env into process.env for Node.js API route contexts.
- *
- * Behaviour by environment:
- *  - Deno (edge functions)  → no-op, Deno/Netlify injects env natively
- *  - NODE_ENV=production    → no-op, host injects env vars automatically
- *  - Node.js dev            → loads .env via dotenv (dynamic import, safe for bundlers)
- *
- * Called automatically by bini-env Vite plugin. You should not need to call this manually.
- */
-declare function loadEnv(projectRoot?: string): Promise<void>;
-/**
- * Detect which .env files exist in the project root, in Vite's priority order.
- */
-declare function detectEnvFiles(projectRoot?: string): DetectedEnvFile[];
-/**
- * Bini.js Vite plugin.
- *
- * What it does:
- *  - Sets envPrefix to 'BINI_' so client code uses import.meta.env.BINI_MY_VAR
- *  - Auto-loads .env for API routes in dev via loadEnv()
- *  - Replaces Vite's startup output with the Bini.js branded header
- */
-declare function biniEnv(options?: Readonly<BiniEnvPluginOptions>): Plugin;
-
-export { type BiniEnvPluginOptions, type DetectedEnvFile, biniEnv, detectEnvFiles, getEnv, loadEnv, requireEnv };