OmniSvelte v0.1 is here! A schema-driven data layer and first-class auth for SvelteKit. Read the announcement
omni — emerald teal
OmniSvelte
Configuration

svelte.config.js

Full reference for the omni config block in svelte.config.js.

Configuration

All OmniSvelte options live under the omni key in svelte.config.js. This page covers every available option. Config can also be passed in the vite plugin.

Note: In SvelteKit 3, svelte.config.js would be removed, so the default way to set config would be using the Vite plugin. This would be the recommended way to define config, and we will update this guide as soon as possible

Top-level shape

ts
omni: {
  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
omni: {
  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
omni: {
  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
omni: {
  auth: {
    enabled: true,
    secret: process.env.BETTER_AUTH_SECRET,
    baseURL: process.env.BETTER_AUTH_URL,
    emailAndPassword: { enabled: true },
    plugins: {
      magicLink: true,
      twoFactor: true
    }
  }
}

Full example

js
// svelte.config.js
import adapter from '@sveltejs/adapter-auto';
import { vitePreprocess } from '@sveltejs/vite-plugin-svelte';
 
const config = {
  preprocess: vitePreprocess(),
  kit: { adapter: adapter() },
  omni: {
    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 }
    }
  }
};
 
export default config;
Previous Comparison Next Environment Variables
Edit this page on GitHub