OmniSvelte v0.2 is here! CLI suite, resource() API, and a cleaner config. Read the announcement
omni — emerald teal
OmniSvelte
Configuration

vite.config.ts

Full reference for the omniSvelte plugin configuration in vite.config.ts.

Configuration

All OmniSvelte options are passed to the omniSvelte() plugin in vite.config.ts. This page covers every available option. Standard SvelteKit config options can still be passed under the kit property.

Top-level shape

ts
omniSvelte({
  kit?:            KitConfig; // standard SvelteKit options
  database?:       DatabaseConfig;
  schema?:         SchemaConfig;
  auth?:           AuthConfig;
  logging?:        { enabled: boolean };
  cors?:           { enabled: boolean };
  analytics?:      { enabled: boolean };
  errorReporting?: { enabled: boolean };
})

database

Option Type Default Description
enabled boolean false Enable the database integration
connection.url string — PostgreSQL connection string
schema string | null null Path to a custom Drizzle schema file
js
omniSvelte({
  database: {
    enabled: true,
    connection: { url: process.env.DATABASE_URL }
  }
})

schema

Controls how OmniSvelte discovers and generates code from your .schema.ts files.

Option Type Default Description
mode 'files' 'files' Currently only files mode is supported
input.patterns string[] ['src/**/*.schema.ts'] Glob patterns to discover schema files
input.exclude string[] [] Glob patterns to exclude
output.drizzle.path string 'src/lib/db/server/schema.ts' Output path for the Drizzle schema
output.zod.path string 'src/lib/db/validation' Output path for Zod validators
output.model.path string 'src/lib/db/models' Output path for typed model classes
dev.watch boolean true Watch schema files for changes
dev.generateOnStart boolean true Generate on dev server start
js
omniSvelte({
  schema: {
    input:  { patterns: ['src/**/*.schema.ts'] },
    output: {
      drizzle: { path: 'src/lib/db/server/schema.ts', format: 'single-file' },
      zod:     { path: 'src/lib/db/validation',       format: 'per-schema'  },
      model:   { path: 'src/lib/db/models',           format: 'per-schema'  }
    },
    dev: { watch: true, generateOnStart: true }
  }
})

auth

Configures Better-Auth.

Option Type Default Description
enabled boolean false Enable auth integration
secret string — Secret key for signing sessions
baseURL string http://localhost:5173 Public URL of your app
basePath string /api/auth Auth API route prefix
emailAndPassword.enabled boolean true Enable email + password auth
session.expiresIn number 604800 Session lifetime in seconds (7 days)
plugins.username boolean false Enable username plugin
plugins.magicLink boolean false Enable magic link plugin
plugins.twoFactor boolean false Enable 2FA plugin
plugins.passkey boolean false Enable passkey plugin
js
omniSvelte({
  auth: {
    enabled: true,
    secret: process.env.BETTER_AUTH_SECRET,
    baseURL: process.env.BETTER_AUTH_URL,
    emailAndPassword: { enabled: true },
    plugins: {
      magicLink: true,
      twoFactor: true
    }
  }
})

Standalone Plugin (omni)

By default, omniSvelte() wraps and invokes the official @sveltejs/kit/vite plugin for you. If you need full control over the SvelteKit plugin (e.g., using a custom fork or strictly controlling plugin order), you can use the omni() export instead.

This returns an array of Omni plugins without injecting SvelteKit.

js
// vite.config.ts
import { defineConfig } from 'vite';
import { sveltekit } from '@sveltejs/kit/vite';
import { omni } from 'omni-svelte/vite';
 
export default defineConfig({
  plugins: [
    sveltekit({
      experimental: { remoteFunctions: true },
      compilerOptions: { experimental: { async: true } }
    }), // fully under your control
    ...omni({
      database: { enabled: true },
      schema: { /* ... */ }
    })
  ]
});

Note: When using omni() directly, you are responsible for enabling kit.experimental.remoteFunctions and compilerOptions.experimental.async directly via the options passed to the sveltekit() Vite plugin if you want remote functions to work properly.

Full example

js
// vite.config.ts
import { defineConfig } from 'vite';
import { omniSvelte } from 'omni-svelte/vite';
import adapter from '@sveltejs/adapter-auto';
import { vitePreprocess } from '@sveltejs/vite-plugin-svelte';
 
export default defineConfig({
  plugins: [
    omniSvelte({
      preprocess: vitePreprocess(),
      kit: { adapter: adapter() },
      database: {
        enabled: true,
        connection: { url: process.env.DATABASE_URL }
      },
      schema: {
        input:  { patterns: ['src/**/*.schema.ts'] },
        output: {
          drizzle: { path: 'src/lib/db/server/schema.ts', format: 'single-file' },
          zod:     { path: 'src/lib/db/validation',       format: 'per-schema'  },
          model:   { path: 'src/lib/db/models',           format: 'per-schema'  }
        }
      },
      auth: {
        enabled: true,
        secret: process.env.BETTER_AUTH_SECRET,
        emailAndPassword: { enabled: true }
      }
    })
  ]
});
Previous Comparison Next Environment Variables
Edit this page on GitHub