Implement user server with JavaScript

We provide an official package to make it easier to build user servers with JavaScript and TypeScript. This package works in the latest versions of Node.js, Deno, Bun, Cloudflare Workers, Netlify Edge Functions, and Vercel Edge Functions.

See the package API reference for details.

npm install @faroe/user-server

Implement the Actions interface.

interface Actions {
    createUserAction();
    getUserAction();
    getUserByEmailAddressAction();
    updateUserEmailAddressAction();
    updateUserPasswordHashAction();
    incrementUserSessionsCounterAction();
    deleteUserAction();
}

Example implementations using ORMs are available:

• Drizzle with MySQL
• Drizzle with PostgreSQL
• Drizzle with SQLite
• Prisma

Example implementations using plain SQL are also available:

• MySQL
• PostgreSQL
• SQLite

Then, create a new Server instance.

Use the Server.resolveActionInvocationEndpointRequest() to create an action invocation endpoint. It takes a request body of an action invocation request and returns the response body. It will return an error if the request is invalid.

The action invocation endpoint should be protected and only accessible to trusted clients. Some options are private networks and request signing.

// TODO: Protect route.

const server = new faroe_user_server.Server(actions);

let bodyJSON: string;

// Get request body

let responseBodyJSON: string;
try {
    responseBodyJSON = await server.resolveActionInvocationEndpointRequest(bodyJSON);
} catch {
    // Failed to parse JSON, unknown action, etc
    // Return 400 response
}

// Returns body

Example implementations are available:

• Astro
• Hono
• Next.js App Router
• Nuxt
• SvelteKit