Elysia Adapter

The @zenstackhq/server/elysia module provides a quick way to install a full set of CRUD API onto Elysia apps. Combined with ZenStack's powerful access policies, you can achieve a secure data backend without manually coding it.

This feature is contributed by @rodrigoburigool.

Installation

npm

npm install @zenstackhq/server@next

pnpm

pnpm add @zenstackhq/server@next

bun

bun add @zenstackhq/server@next

yarn

yarn add @zenstackhq/server@next

Mounting the API

You can use the createElysiaHandler API to create an Elysia request handler that handles CRUD requests automatically:

import { Elysia, Context } from 'elysia';
import { RPCApiHandler } from '@zenstackhq/server/api';
import { createElysiaHandler } from '@zenstackhq/server/elysia';
import { getSessionUser } from '~/auth';
import { client } from '~/db';
import { schema } from '~/zenstack/schema';

const app = new Elysia({ prefix: '/api' });

// install the CRUD middleware under route "/api/crud"
app.group('/crud', (app) =>
    app.use(
        createElysiaHandler({
            apiHandler: new RPCApiHandler({ schema }),
            basePath: '/api/model',
            // getSessionUser extracts the current session user from the request,
            // its implementation depends on your auth solution
            getClient: (context) => client.$setAuth(getSessionUser(context)) }),
        })
    )
);

function getCurrentUser(context: Context) {
    // the implementation depends on your authentication mechanism
    ...
}

app.listen(3000);

The middleware factory takes the following options to initialize:

• getClient (required)

  (ctx: Context) => ClientContract<Schema> | Promise<ClientContract<Schema>>

  A callback for getting a ZenStackClient instance for talking to the database. Usually you'll return a client instance with access policy enabled and user identity bound.

• apiHandler (required)

  ApiHandler

  The API handler instance that determines the API specification.

• basePath (optional)

  string

  Optional base path to strip from the request path before passing to the API handler. E.g., if your CRUD handler is mounted at /api/crud, set this field to '/api/crud'.

Error Handling

Refer to the specific sections for RPC Handler and RESTful Handler.