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

Configuration

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

Configuration

Breaking change in v0.2: Configuration moved from svelte.config.js to vite.config.ts. If you were setting omni options inside svelte.config.js, move them to the omniSvelte() plugin call instead. SvelteKit options now go under the kit namespace inside omniSvelte().

In SvelteKit 3, configuration is passed directly to the omniSvelte() plugin in vite.config.ts.

Top-level shape

ts
// vite.config.ts
import { defineConfig } from 'vite';
import { omniSvelte } from 'omni-svelte/vite';
 
export default defineConfig({
  plugins: [
    omniSvelte({
      database?: DatabaseConfig;
      schema?: SchemaConfig;
      auth?: AuthConfig;
      logging?: { enabled: boolean };
      cors?: { enabled: boolean };
      analytics?: { enabled: boolean };
      errorReporting?: { enabled: boolean };
      kit?: KitConfig; // SvelteKit plugin options
    })
  ]
});

Omni-svelte options (database, schema, auth, etc.) are defined at the top level of the object passed to omniSvelte(). Standard SvelteKit options can still be configured under the kit namespace.

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

schema

Controls how omni-svelte discovers and generates code from your .schema.ts files.

Option Type Default Description
mode 'files' 'files' Currently only files is supported
input.patterns string[] — Glob patterns to discover schema files
input.exclude string[] — Glob patterns to exclude
output.drizzle.path string — Output path for the generated Drizzle schema
output.zod.path string — Output path for generated Zod validators
output.model.path string — Output path for typed model classes
dev.watch boolean true Watch schema files for changes
dev.generateOnStart boolean true Generate on dev server start

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
Next Introduction
Edit this page on GitHub