workos-convex-sveltekit

This library is designed to augment WorkOS AuthKit + Convex with built in user management functionality. It provides wrappers for some convex-svelte and @workos/authkit-sveltekit functions that keep the convex users database in sync with user data from AuthKit

- Installation
- Install npm package
- Configure project
- Configure WorkOS account
- Configure environment variables
- Copy template files
- Convex Deployment (dev)
- Deployment
- Convex Deployment (prod)
- Environment Variables
- WorkOS Production Config
- Optional Configurations
- Usage
- Schema Helpers Usage
- Library Exports
- Client Setup (+layout.svelte)
- Authenticating Server Routes
- Auth routes provided by the template
- Using queries in pages
- Role check example
- Server actions
- Best Practices
- CLI Options
- Example
- Conflict Handling
- Development
- Project Structure
- Linking locally (dev workflow)
- Debugging
- Planned improvements
- License

Installation

Be sure to follow all the steps in the installation guide, see referenced documenation for more information. The guide assumes you have a new or existing sveltekit project and that all commands are run from within that project directory.

Install npm package

Convex and AuthKit dependencies:
``

bash
npm install -S convex convex-svelte @workos-inc/node @workos/authkit-sveltekit

This package:`bash npm install workos-convex-sveltekit`

`Configure project`

Follow the steps below from the Convex & WorkOS AuthKit documentation:

`$3`


- Sign up for an account at: https://signin.workos.com/sign-up
- Enable AuthKit on your account
- Add callback endpoint during setup:

https:///api/auth/callback


- Copy Client and API keys
- Enable CORS for your domain (eg.

https://localhost:5173

 for development) in the WorkOS Dashboard
- [Optional] Create a WorkOS Organization that your users will belong to. As of

v1.1.0

 this package adds org based auth for authenticated routes. If you choose not to use org based authentication, leave the

WORKOS_ORGANIZATION_ID

 env var unset.
- Set up custom JWT template. Navigate to WorkOS Dashboard > Authentication > Sessions and add the following custom JWT template:

json
   {
     "aud": "",
     "user_id": {{user.id}},
     "email": {{user.email}},
     "first_name": {{user.first_name}},
     "last_name": {{user.last_name}},
     "name": "{{user.first_name}} {{user.last_name}}",
     "email_verified": {{user.email_verified}},
     "org_id": {{organization.id}},
     "org_name": {{organization.name}},
     "org_role": {{organization_membership.role}}
   }


> NOTE We have to supply the workos client id here in the JWT response manually because the convex library expects our JWT to have the "aud" claim, which is not included by WorkOS by default.
$3

Create .env.localwith the following contents in the project root:`

`WorkOS AuthKit Configuration`


WORKOS_CLIENT_ID=
WORKOS_API_KEY=
WORKOS_REDIRECT_URI=http://localhost:5173/api/auth/callback
WORKOS_COOKIE_PASSWORD=
WORKOS_ORGANIZATION_ID=
#
Convex (public) URL

CONVEX_DEPLOYMENT=dev:convex-deployment-123
PUBLIC_CONVEX_URL=https://convex-deployment.convex.cloud

> TIP To generate a secure cookie password use: openssl rand -base64 24

> SECURITY Don't commit your secrets!!! Add .env.local to your .gitignore

`Copy template files`

The library provides a CLI that automatically copies necessary files to your project. These files provide all the boilerplate needed for a basic Convex + WorkOS SvelteKit auth integration.

The CLI tool will prompt you to overwite, merge, or skip any conflicting files:

`bash npx workos-convex-sveltekit copy`


See all template files

- src/convex/auth.config.ts: Default authentication configuration for convex. Copied directly from the Convex Documentation -src/convex/users.ts- Convex user query functions -src/convex/schema.ts- Convex schema file -src/routes/api/auth/callback/+server.ts- Handles the auth callback -src/routes/api/auth/logout/+server.ts- Handles logging the user out -src/routes/api/auth/token/+server.ts- Returns a JWT token for the currently authenticated user -src/routes/+error.svelte - Custom error page that displays sveltekit errors. Added to properly handle 403 org auth errors in version 1.1.0-src/routes/+layout.svelte- Base layout file that configures auth on the client -src/routes/admin/+layout.server.ts- Example of how to use the authenticatedRoute to protect a specific route -src/hooks.server.ts- SvelteKit server hooks to handle configuring auth -src/app.d.ts- Extended global types for SvelteKit -convex.json - Configure the convex directory to be inside src

See CLI Options for more details about the CLI tool.

`Convex Deployment (dev)`


You'll need to create a new convex deployment and configure it. Run the

npx convex dev

 command and follow the prompts to either create or use an existing project. See Convex Quickstart and Convex CLI docs for more info on convex deployments.

After your convex deployment is created, visit the Convex Dashboard and add the WORKOS_CLIENT_ID environment variable

> On successful authentication, the library uses ConvexHttpClient and calls users:store convex function to upsert the current user in your users table. Existing roles are preserved; new users start with roles: [].

`Deployment`

`Convex Deployment (prod)`


To ensure that convex functions are deployed at build time, you'll need to add

npx convex codegen

 to your build script:

json
"scripts": {
    ...
    "build": "npx convex codegen && vite build",
    ...
}

Then ensure that your hosting/CI build command is set to npx convex deploy --cmd 'npm run build'

`Environment Variables`


For production deployments, you need to configure some environment variables in convex and some in your production environment.

Required env vars in Convex: -WORKOS_CLIENT_ID

Required env vars for production environment: -CONVEX_DEPLOY_KEY-CONVEX_DEPLOYMENT-PUBLIC_CONVEX_URL-WORKOS_API_KEY-WORKOS_CLIENT_ID-WORKOS_COOKIE_PASSWORD-WORKOS_REDIRECT_URI

It is recommended to generate a separate cookie password for production deployments.

`WorkOS Production Config`


Make sure that WorkOS is configured to accept CORS from your production domain: Authentication > Sessions > Cross-Origin Resource Sharing (CORS)

Ensure that your production callback url (eg. https:///api/auth/callback) is configured under Redirects

`Optional Configurations`


TODO: This section will outline some additional configurations that can be made in the WorkOS UI, and how to integrate them with this library.
Usage

Once you have all the Configuration steps completed, you're ready to start using the library.
Schema Helpers Usage

ts
// src/convex/schema.ts
import { defineSchema } from 'convex/server';
import { v } from 'convex/values';
import { defaultUsers, extendUsers } from 'workos-convex-sveltekit/schema';
export default defineSchema({
  users: defaultUsers(v)
});

// Or extend with custom fields (+ you can chain your own indexes) // users: extendUsers(v, { extraField: v.string() }) // .index('by_extra_field', ['extraField'])`Notes: - The helpers already apply indexesby_email and by_workos_user_id. - No generics are required.

`Library Exports`

ts
// Server utilities
import {
  configureServerAuth,
  authenticatedRequest,
  handleToken,
  handleSignOut,
  handleSignIn,
} from 'workos-convex-sveltekit';
// Client utility
import { configureClientAuth } from 'workos-convex-sveltekit';

// Schema helpers import { defaultUsers, extendUsers } from 'workos-convex-sveltekit/schema';`

`Client Setup (+layout.svelte)`

svelte

{@render children?.()}`

`Authenticating Server Routes`


You can authenticate a server route using the

authenticatedRequest function in any +layout.server.ts file:

`ts import type { LayoutServerLoad } from './$types'; import { authenticatedRequest } from 'workos-convex-sveltekit'; import { authKit } from '@workos/authkit-sveltekit';

export const load: LayoutServerLoad = authenticatedRequest(authKit, async ({ auth, url, locals }) => { const user = auth.user;

//User is authenticated here

return { user: user }; });`

`Auth routes provided by the template`

GET /api/auth/callback

 (WorkOS callback)
-

GET /api/auth/token (returns JWT via handleToken

)
-

GET /api/auth/logout (signs out via handleSignOut

)
Using queries in pages

In any

+page.svelte, you can access the useQuery() or convex.mutation() functions in your svelte app. The template provides user queries in src/convex/users.ts

:
 -

store (mutation): upserts the current user on sign-in; preserves existing roles; initializes roles: [] for new users; updates lastSignInAt

 and timestamps.
 -

getCurrentUser (query): returns the current authenticated user or null

.
 -

getUserById (query): looks up a user by workosUserId

.
 -

getUserByEmail

 (query): looks up a user by email.
 -

getAllUsers

 (query): returns all users.
 -

hasRole (query): returns true/false

 if the current user has the provided role.

svelte

	
	{#if queryResult.isLoading}
		Loading...

	{:else if queryResult.error}
		Error: {queryResult.error.message}

	{:else if !queryResult.data || queryResult.data.length === 0}
		No data here!

	{:else}
		{#each queryResult.data as item, index}
			item

		{/each}
	{/if}
	
	
	 { e.preventDefault(); handleSubmit(); }} class="form">
					type="text"
			bind:value={textInput}
			placeholder="Enter some text..."
		/>

$3

svelte


Server actions

You can also use SvelteKits server actions

ts
import { authenticatedRequest } from "workos-convex-sveltekit";
import { authKit } from "@workos/authkit-sveltekit";
import { api } from "../../convex/_generated/api.js";
import { PUBLIC_CONVEX_URL } from "$env/static/public";
import { ConvexHttpClient } from "convex/browser";
export const actions = {
    privateAction: authenticatedRequest(authKit, async ({auth, request}) => {
        const convex = new ConvexHttpClient(PUBLIC_CONVEX_URL);
        convex.setAuth(auth.accessToken as string);
        const result = await convex.query(api.users.getAllUsers, { });

return { data: result }; }) };`

`Best Practices`


These are some best practices that I have come up with
- Authorization inside your convex query/mutation functions. Limit client side trust as much as possible.
CLI Options

The

workos-convex-sveltekit

 CLI provides several options to control how files are copied and how conflicts are handled. These can be combined as needed.
| Option               | Alias   | Description                                                                                  | Default                   |
|----------------------|---------|----------------------------------------------------------------------------------------------|---------------------------|
|

--dest

      |         | Destination directory for copied files                                                        | Current working directory |
|

--force | | Overwrite conflicting files without prompting | false

|
|

--yes | -y | Assume "yes" to all prompts (non-interactive). Combine with CI use | false

|
|

--dry-run

          |         | Show planned actions (which files would be created, overwritten, or skipped), but make no changes |

false

|
|

--backup | | When overwriting, create backups of existing files | false

|
|

--merge | | Merge changes with Git-style conflict markers (for code files) | false

|
|

--verbose | -v | Print verbose output, including individual file actions | false

|
|

--help | -h

    | Show usage help                                                                              |                           |
|

--version | -V

    | Show CLI version                                                                             |                           |
$3

bash
npx workos-convex-sveltekit copy --dry-run --verbose
or explicitly target the project root

npx workos-convex-sveltekit copy --dest . --dry-run --verbose


- This will show a summary of all file actions that would be taken, writing nothing.

`bash

`Merge conflicting files with Git-style conflict markers`


npx workos-convex-sveltekit copy --merge


- This will merge conflicting code files using conflict markers, allowing you to manually resolve differences.
$3

- By default, if a destination file already exists and contents differ, you'll be shown a colorized diff and prompted for action (

overwrite, skip, backup, merge, overwrite all, skip all, merge all

).
- The

merge option uses Git-style conflict markers (<<<<<<< HEAD, =======, >>>>>>> template) to combine existing and template content, allowing manual resolution. Merge works for code files (.js, .ts, .jsx, .tsx, .svelte, .vue, .css, .scss, .html, .json

).
- Use

--backup to always back up existing files before overwriting.

See the output of:`bash npx workos-convex-sveltekit --help`for a full list of options.

`Development`

`Project Structure`


workos-convex-sveltekit/
├── src/
│   ├── index.ts            # Main library exports
│   ├── schema.ts           # Schema helpers (exported as subpath)
│   ├── users.ts            # User management utilities
│   ├── cli.ts              # CLI tool (exported as command)
│   ├── cli/                # CLI implementation
│   │   ├── args.ts
│   │   ├── copy.ts
│   │   ├── log.ts
│   │   ├── paths.ts
│   │   └── prompts.ts
│   └── types/              # TypeScript type definitions
│       └── index.ts
├── templates/              # Files copied into consuming app
│   ├── convex.json         # Convex configuration
│   └── src/
│       ├── app.d.ts        # Extended global types for SvelteKit
│       ├── hooks.server.ts # SvelteKit server hooks
│       ├── convex/
│       │   ├── auth.config.ts
│       │   ├── schema.ts
│       │   └── users.ts
│       └── routes/
│           ├── +error.svelte
│           ├── +layout.svelte
│           ├── admin/
│           │   └── +layout.server.ts
│           └── api/
│               └── auth/
│                   ├── callback/
│                   │   └── +server.ts
│                   ├── logout/
│                   │   └── +server.ts
│                   └── token/
│                       └── +server.ts
├── package.json
├── tsconfig.json
└── tsup.config.ts

`bash

`Build the library`


npm run build
Clean build artifacts

npm run clean


Linking locally (dev workflow)

`bash

`In this repo`


npm run build && npm link
In your consuming app

npm link --save workos-convex-sveltekit
workos-convex-sveltekit copy --dry-run --verbose


Debugging

To show debug messages set environment variable:

WORKOS_CONVEX_SVELTEKIT_DEBUG=true`

#### Planned improvements:
- [ ] Look more into how profile images are handled and how we might allow users to change them and not have them re-written by workos syncing. Or maybe they can be updated through workos directly?
- [x] Figure out how to get the users queries exported with proper typescript support, to avoid copying them all directly from the template. This will help with handling udpates where changes may be needed to the functionality of users queries.
- [x] Add support for organizations, and role based authorization
- [ ]

License

ISC

workos-convex-sveltekit

Installation

Install npm package

Convex and AuthKit dependencies:
``

bash
npm install -S convex convex-svelte @workos-inc/node @workos/authkit-sveltekit

This package:`bash npm install workos-convex-sveltekit`

`Configure project`

Follow the steps below from the Convex & WorkOS AuthKit documentation:

`$3`


- Sign up for an account at: https://signin.workos.com/sign-up
- Enable AuthKit on your account
- Add callback endpoint during setup:

https:///api/auth/callback


- Copy Client and API keys
- Enable CORS for your domain (eg.

https://localhost:5173

 for development) in the WorkOS Dashboard
- [Optional] Create a WorkOS Organization that your users will belong to. As of

v1.1.0

 this package adds org based auth for authenticated routes. If you choose not to use org based authentication, leave the

WORKOS_ORGANIZATION_ID

 env var unset.
- Set up custom JWT template. Navigate to WorkOS Dashboard > Authentication > Sessions and add the following custom JWT template:

json
   {
     "aud": "",
     "user_id": {{user.id}},
     "email": {{user.email}},
     "first_name": {{user.first_name}},
     "last_name": {{user.last_name}},
     "name": "{{user.first_name}} {{user.last_name}}",
     "email_verified": {{user.email_verified}},
     "org_id": {{organization.id}},
     "org_name": {{organization.name}},
     "org_role": {{organization_membership.role}}
   }


> NOTE We have to supply the workos client id here in the JWT response manually because the convex library expects our JWT to have the "aud" claim, which is not included by WorkOS by default.
$3

Create .env.localwith the following contents in the project root:`

`WorkOS AuthKit Configuration`


WORKOS_CLIENT_ID=
WORKOS_API_KEY=
WORKOS_REDIRECT_URI=http://localhost:5173/api/auth/callback
WORKOS_COOKIE_PASSWORD=
WORKOS_ORGANIZATION_ID=
#
Convex (public) URL

CONVEX_DEPLOYMENT=dev:convex-deployment-123
PUBLIC_CONVEX_URL=https://convex-deployment.convex.cloud

> TIP To generate a secure cookie password use: openssl rand -base64 24

> SECURITY Don't commit your secrets!!! Add .env.local to your .gitignore

`Copy template files`

The library provides a CLI that automatically copies necessary files to your project. These files provide all the boilerplate needed for a basic Convex + WorkOS SvelteKit auth integration.

The CLI tool will prompt you to overwite, merge, or skip any conflicting files:

`bash npx workos-convex-sveltekit copy`


See all template files

See CLI Options for more details about the CLI tool.

`Convex Deployment (dev)`


You'll need to create a new convex deployment and configure it. Run the

npx convex dev

 command and follow the prompts to either create or use an existing project. See Convex Quickstart and Convex CLI docs for more info on convex deployments.

After your convex deployment is created, visit the Convex Dashboard and add the WORKOS_CLIENT_ID environment variable

`Deployment`

`Convex Deployment (prod)`


To ensure that convex functions are deployed at build time, you'll need to add

npx convex codegen

 to your build script:

json
"scripts": {
    ...
    "build": "npx convex codegen && vite build",
    ...
}

Then ensure that your hosting/CI build command is set to npx convex deploy --cmd 'npm run build'

`Environment Variables`


For production deployments, you need to configure some environment variables in convex and some in your production environment.

Required env vars in Convex: -WORKOS_CLIENT_ID

Required env vars for production environment: -CONVEX_DEPLOY_KEY-CONVEX_DEPLOYMENT-PUBLIC_CONVEX_URL-WORKOS_API_KEY-WORKOS_CLIENT_ID-WORKOS_COOKIE_PASSWORD-WORKOS_REDIRECT_URI

It is recommended to generate a separate cookie password for production deployments.

`WorkOS Production Config`


Make sure that WorkOS is configured to accept CORS from your production domain: Authentication > Sessions > Cross-Origin Resource Sharing (CORS)

Ensure that your production callback url (eg. https:///api/auth/callback) is configured under Redirects

`Optional Configurations`


TODO: This section will outline some additional configurations that can be made in the WorkOS UI, and how to integrate them with this library.
Usage

Once you have all the Configuration steps completed, you're ready to start using the library.
Schema Helpers Usage

ts
// src/convex/schema.ts
import { defineSchema } from 'convex/server';
import { v } from 'convex/values';
import { defaultUsers, extendUsers } from 'workos-convex-sveltekit/schema';
export default defineSchema({
  users: defaultUsers(v)
});

`Library Exports`

ts
// Server utilities
import {
  configureServerAuth,
  authenticatedRequest,
  handleToken,
  handleSignOut,
  handleSignIn,
} from 'workos-convex-sveltekit';
// Client utility
import { configureClientAuth } from 'workos-convex-sveltekit';

// Schema helpers import { defaultUsers, extendUsers } from 'workos-convex-sveltekit/schema';`

`Client Setup (+layout.svelte)`

svelte

{@render children?.()}`

`Authenticating Server Routes`


You can authenticate a server route using the

authenticatedRequest function in any +layout.server.ts file:

`ts import type { LayoutServerLoad } from './$types'; import { authenticatedRequest } from 'workos-convex-sveltekit'; import { authKit } from '@workos/authkit-sveltekit';

export const load: LayoutServerLoad = authenticatedRequest(authKit, async ({ auth, url, locals }) => { const user = auth.user;

//User is authenticated here

return { user: user }; });`

`Auth routes provided by the template`

GET /api/auth/callback

 (WorkOS callback)
-

GET /api/auth/token (returns JWT via handleToken

)
-

GET /api/auth/logout (signs out via handleSignOut

)
Using queries in pages

In any

+page.svelte, you can access the useQuery() or convex.mutation() functions in your svelte app. The template provides user queries in src/convex/users.ts

:
 -

store (mutation): upserts the current user on sign-in; preserves existing roles; initializes roles: [] for new users; updates lastSignInAt

 and timestamps.
 -

getCurrentUser (query): returns the current authenticated user or null

.
 -

getUserById (query): looks up a user by workosUserId

.
 -

getUserByEmail

 (query): looks up a user by email.
 -

getAllUsers

 (query): returns all users.
 -

hasRole (query): returns true/false

 if the current user has the provided role.

svelte

	
	{#if queryResult.isLoading}
		Loading...

	{:else if queryResult.error}
		Error: {queryResult.error.message}

	{:else if !queryResult.data || queryResult.data.length === 0}
		No data here!

	{:else}
		{#each queryResult.data as item, index}
			item

		{/each}
	{/if}
	
	
	 { e.preventDefault(); handleSubmit(); }} class="form">
					type="text"
			bind:value={textInput}
			placeholder="Enter some text..."
		/>

$3

svelte


Server actions

You can also use SvelteKits server actions

ts
import { authenticatedRequest } from "workos-convex-sveltekit";
import { authKit } from "@workos/authkit-sveltekit";
import { api } from "../../convex/_generated/api.js";
import { PUBLIC_CONVEX_URL } from "$env/static/public";
import { ConvexHttpClient } from "convex/browser";
export const actions = {
    privateAction: authenticatedRequest(authKit, async ({auth, request}) => {
        const convex = new ConvexHttpClient(PUBLIC_CONVEX_URL);
        convex.setAuth(auth.accessToken as string);
        const result = await convex.query(api.users.getAllUsers, { });

return { data: result }; }) };`

`Best Practices`


These are some best practices that I have come up with
- Authorization inside your convex query/mutation functions. Limit client side trust as much as possible.
CLI Options

The

workos-convex-sveltekit

 CLI provides several options to control how files are copied and how conflicts are handled. These can be combined as needed.
| Option               | Alias   | Description                                                                                  | Default                   |
|----------------------|---------|----------------------------------------------------------------------------------------------|---------------------------|
|

--dest

      |         | Destination directory for copied files                                                        | Current working directory |
|

--force | | Overwrite conflicting files without prompting | false

|
|

--yes | -y | Assume "yes" to all prompts (non-interactive). Combine with CI use | false

|
|

--dry-run

          |         | Show planned actions (which files would be created, overwritten, or skipped), but make no changes |

false

|
|

--backup | | When overwriting, create backups of existing files | false

|
|

--merge | | Merge changes with Git-style conflict markers (for code files) | false

|
|

--verbose | -v | Print verbose output, including individual file actions | false

|
|

--help | -h

    | Show usage help                                                                              |                           |
|

--version | -V

    | Show CLI version                                                                             |                           |
$3

bash
npx workos-convex-sveltekit copy --dry-run --verbose
or explicitly target the project root

npx workos-convex-sveltekit copy --dest . --dry-run --verbose


- This will show a summary of all file actions that would be taken, writing nothing.

`bash

`Merge conflicting files with Git-style conflict markers`


npx workos-convex-sveltekit copy --merge


- This will merge conflicting code files using conflict markers, allowing you to manually resolve differences.
$3

- By default, if a destination file already exists and contents differ, you'll be shown a colorized diff and prompted for action (

overwrite, skip, backup, merge, overwrite all, skip all, merge all

).
- The

).
- Use

--backup to always back up existing files before overwriting.

See the output of:`bash npx workos-convex-sveltekit --help`for a full list of options.

`Development`

`Project Structure`


workos-convex-sveltekit/
├── src/
│   ├── index.ts            # Main library exports
│   ├── schema.ts           # Schema helpers (exported as subpath)
│   ├── users.ts            # User management utilities
│   ├── cli.ts              # CLI tool (exported as command)
│   ├── cli/                # CLI implementation
│   │   ├── args.ts
│   │   ├── copy.ts
│   │   ├── log.ts
│   │   ├── paths.ts
│   │   └── prompts.ts
│   └── types/              # TypeScript type definitions
│       └── index.ts
├── templates/              # Files copied into consuming app
│   ├── convex.json         # Convex configuration
│   └── src/
│       ├── app.d.ts        # Extended global types for SvelteKit
│       ├── hooks.server.ts # SvelteKit server hooks
│       ├── convex/
│       │   ├── auth.config.ts
│       │   ├── schema.ts
│       │   └── users.ts
│       └── routes/
│           ├── +error.svelte
│           ├── +layout.svelte
│           ├── admin/
│           │   └── +layout.server.ts
│           └── api/
│               └── auth/
│                   ├── callback/
│                   │   └── +server.ts
│                   ├── logout/
│                   │   └── +server.ts
│                   └── token/
│                       └── +server.ts
├── package.json
├── tsconfig.json
└── tsup.config.ts

`bash

`Build the library`


npm run build
Clean build artifacts

npm run clean


Linking locally (dev workflow)

`bash

`In this repo`


npm run build && npm link
In your consuming app

npm link --save workos-convex-sveltekit
workos-convex-sveltekit copy --dry-run --verbose


Debugging

To show debug messages set environment variable:

WORKOS_CONVEX_SVELTEKIT_DEBUG=true`

License

ISC

workos-convex-sveltekit

workos-convex-sveltekit

Table of Contents

Installation

Install npm package

Configure project

$3

$3

WorkOS AuthKit Configuration

Convex (public) URL

Copy template files

Convex Deployment (dev)

Deployment

Convex Deployment (prod)

Environment Variables

WorkOS Production Config

Optional Configurations

Usage

Schema Helpers Usage

Library Exports

Client Setup (+layout.svelte)

Authenticating Server Routes

Auth routes provided by the template

Using queries in pages

$3

Server actions

Best Practices

CLI Options

$3

or explicitly target the project root

Merge conflicting files with Git-style conflict markers

$3

Development

Project Structure

Build the library

Clean build artifacts

Linking locally (dev workflow)

In this repo

In your consuming app

Debugging

License

workos-convex-sveltekit

workos-convex-sveltekit

Table of Contents

Installation

Install npm package

Configure project

$3

$3

WorkOS AuthKit Configuration

Convex (public) URL

Copy template files

Convex Deployment (dev)

Deployment

Convex Deployment (prod)

Environment Variables

WorkOS Production Config

Optional Configurations

Usage

Schema Helpers Usage

Library Exports

Client Setup (+layout.svelte)

Authenticating Server Routes

Auth routes provided by the template

Using queries in pages

$3

Server actions

Best Practices

CLI Options

$3

or explicitly target the project root

Merge conflicting files with Git-style conflict markers

$3

Development

Project Structure

Build the library

Clean build artifacts

Linking locally (dev workflow)

In this repo

In your consuming app

`Configure project`

`$3`

`WorkOS AuthKit Configuration`

`Copy template files`

`Convex Deployment (dev)`

`Deployment`

`Convex Deployment (prod)`

`Environment Variables`

`WorkOS Production Config`

`Optional Configurations`

`Library Exports`

`Client Setup (+layout.svelte)`

`Authenticating Server Routes`

`Auth routes provided by the template`

`Best Practices`

`Merge conflicting files with Git-style conflict markers`

`Development`

`Project Structure`

`Build the library`

`In this repo`

`Configure project`

`$3`

`WorkOS AuthKit Configuration`

`Copy template files`

`Convex Deployment (dev)`

`Deployment`

`Convex Deployment (prod)`

`Environment Variables`

`WorkOS Production Config`

`Optional Configurations`

`Library Exports`

`Client Setup (+layout.svelte)`

`Authenticating Server Routes`

`Auth routes provided by the template`

`Best Practices`

`Merge conflicting files with Git-style conflict markers`

`Development`

`Project Structure`

`Build the library`

`In this repo`