diff --git a/orm/elysia/.gitignore b/orm/elysia/.gitignore new file mode 100644 index 000000000000..f8a906639335 --- /dev/null +++ b/orm/elysia/.gitignore @@ -0,0 +1,45 @@ +# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. + +# dependencies +/node_modules +/.pnp +.pnp.js + +# testing +/coverage + +# next.js +/.next/ +/out/ + +# production +/build + +# misc +.DS_Store +*.pem + +# debug +npm-debug.log* +yarn-debug.log* +yarn-error.log* + +# local env files +.env +.env.local +.env.development.local +.env.test.local +.env.production.local + +# vercel +.vercel + +**/*.trace +**/*.zip +**/*.tar.gz +**/*.tgz +**/*.log +package-lock.json +**/*.bun +/src/generated/prisma +/src/generated/prismabox diff --git a/orm/elysia/README.md b/orm/elysia/README.md new file mode 100644 index 000000000000..b66a8a87037a --- /dev/null +++ b/orm/elysia/README.md @@ -0,0 +1,123 @@ +# REST API Example with Elysia & Prisma + +This example shows how to implement a **simple Todo REST API with TypeScript** using [Elysia](https://elysiajs.com/) and [Prisma Client](https://www.prisma.io/docs/concepts/components/prisma-client). It connects to a Postgres database via the [`@prisma/adapter-pg`](https://www.prisma.io/docs/orm/overview/databases/postgresql/pg-driver-adapter) driver adapter. + +This example uses [Prismabox](https://github.com/m1212e/prismabox) to automatically generate Elysia validation models from the Prisma schema, ensuring type safety and eliminating the need to manually define validation schemas. + +## Project structure + +- `src/index.ts` – defines the Elysia server and the REST routes for todos. +- `src/lib/prisma.ts` – creates a Prisma Client using `@prisma/adapter-pg`. +- `prisma/schema.prisma` – Prisma schema with the `Todo` model. +- `prisma/seed.ts` – seeds the database with sample todos. + +## Getting started + +### 1. Download the example and install dependencies + +```bash +npx try-prisma@latest --template orm/elysia --name elysia +cd elysia +bun install +``` + +> Alternatively clone this repo and run `bun install` inside `prisma-examples/orm/elysia`. + +### 2. Configure `DATABASE_URL` + +Create a Postgres database (Prisma Postgres, Supabase, Railway, Docker, etc.) and copy the direct connection string: + +``` +postgresql://USER:PASSWORD@HOST:PORT/DATABASE?sslmode=require +``` + +Create a `.env` file in the project root and add the URL: + +```bash +touch .env + +# .env +DATABASE_URL="postgresql://USER:PASSWORD@HOST:5432/DATABASE?sslmode=require" +``` + +### 3. Generate Prisma Client & Prismabox models, migrate & seed the database + +```bash +bunx prisma generate +bunx prisma migrate dev --name init +bunx prisma db seed +``` + +This generates: +- **Prisma Client** - for database operations +- **Prismabox models** - Elysia validation schemas (in `src/generated/prismabox/`) +- Creates the tables defined in [`prisma/schema.prisma`](./prisma/schema.prisma) +- Runs [`prisma/seed.ts`](./prisma/seed.ts) to insert demo data + +### 4. Start the REST API server + +```bash +bun run dev +``` + +The server listens on `http://localhost:3000`. + +## API Endpoints + +- `GET /todos` – get all todos +- `GET /todos/:id` – get a single todo by ID +- `POST /todos` – create a new todo +- `PUT /todos/:id` – update a todo +- `PATCH /todos/:id/toggle` – toggle todo completion status +- `DELETE /todos/:id` – delete a todo + +## Example API requests + +### Get all todos + +```bash +curl http://localhost:3000/todos +``` + +### Create a todo + +```bash +curl -X POST http://localhost:3000/todos \ + -H "Content-Type: application/json" \ + -d '{"title": "Buy groceries"}' +``` + +### Update a todo + +```bash +curl -X PUT http://localhost:3000/todos/1 \ + -H "Content-Type: application/json" \ + -d '{"title": "Buy groceries and cook dinner", "completed": true}' +``` + +### Toggle todo completion + +```bash +curl -X PATCH http://localhost:3000/todos/1/toggle +``` + +### Delete a todo + +```bash +curl -X DELETE http://localhost:3000/todos/1 +``` + +## Features + +- **Type-safe API**: Elysia's built-in schema validation with `Elysia.t` ensures type safety at both runtime and compile time. +- **Prismabox Integration**: Automatically generates Elysia validation models from Prisma schema, eliminating manual schema definitions. +- **Prisma ORM**: Full type safety with Prisma Client and automatic type inference. +- **PostgreSQL**: Uses `@prisma/adapter-pg` for direct database connections. +- **Bun runtime**: Optimized for Bun's fast JavaScript runtime. + +## Learn more + +- [Elysia Documentation](https://elysiajs.com/) +- [Prisma Documentation](https://www.prisma.io/docs/) +- [Prismabox Documentation](https://github.com/m1212e/prismabox) +- [Prisma Client API Reference](https://www.prisma.io/docs/reference/api-reference/prisma-client-reference) diff --git a/orm/elysia/package.json b/orm/elysia/package.json new file mode 100644 index 000000000000..895e8fcc823d --- /dev/null +++ b/orm/elysia/package.json @@ -0,0 +1,24 @@ +{ + "name": "elysia", + "version": "1.0.0", + "type": "module", + "scripts": { + "dev": "bun run --watch src/index.ts", + "start": "bun run src/index.ts", + "db:seed": "bun run prisma/seed.ts" + }, + "dependencies": { + "@prisma/adapter-pg": "^7.1.0", + "@prisma/client": "^7.1.0", + "elysia": "latest", + "pg": "^8.16.3", + "prismabox": "^1.1.25" + }, + "devDependencies": { + "bun-types": "latest", + "prisma": "^7.1.0" + }, + "prisma": { + "seed": "bun run prisma/seed.ts" + } +} diff --git a/orm/elysia/prisma.config.ts b/orm/elysia/prisma.config.ts new file mode 100644 index 000000000000..93e2f5df56f0 --- /dev/null +++ b/orm/elysia/prisma.config.ts @@ -0,0 +1,13 @@ +import "dotenv/config"; +import { defineConfig, env } from "prisma/config"; + +export default defineConfig({ + schema: "prisma/schema.prisma", + migrations: { + path: "prisma/migrations", + seed: "bun run prisma/seed.ts", + }, + datasource: { + url: env("DATABASE_URL"), + }, +}); diff --git a/orm/elysia/prisma/schema.prisma b/orm/elysia/prisma/schema.prisma new file mode 100644 index 000000000000..0b181eab7ab6 --- /dev/null +++ b/orm/elysia/prisma/schema.prisma @@ -0,0 +1,27 @@ +// This is your Prisma schema file, +// learn more about it in the docs: https://pris.ly/d/prisma-schema + +generator client { + provider = "prisma-client" + output = "../src/generated/prisma" +} + +generator prismabox { + provider = "prismabox" + typeboxImportDependencyName = "elysia" + typeboxImportVariableName = "t" + inputModel = true + output = "../src/generated/prismabox" +} + +datasource db { + provider = "postgresql" +} + +model Todo { + id Int @id @default(autoincrement()) + title String + completed Boolean @default(false) + createdAt DateTime @default(now()) + updatedAt DateTime @updatedAt +} diff --git a/orm/elysia/prisma/seed.ts b/orm/elysia/prisma/seed.ts new file mode 100644 index 000000000000..c21f84ccdb7d --- /dev/null +++ b/orm/elysia/prisma/seed.ts @@ -0,0 +1,36 @@ +import { PrismaClient } from '../src/generated/prisma/client.js' +import { PrismaPg } from '@prisma/adapter-pg' + +if (!process.env.DATABASE_URL) { + throw new Error('DATABASE_URL is not set') +} + +const adapter = new PrismaPg({ connectionString: process.env.DATABASE_URL }) +const prisma = new PrismaClient({ adapter }) + +const todoData = [ + { title: 'Learn Elysia' }, + { title: 'Learn Prisma' }, + { title: 'Build something awesome', completed: true }, +] + +async function main() { + console.log('Start seeding...') + for (const todo of todoData) { + const created = await prisma.todo.create({ + data: todo, + }) + console.log(`Created todo with id: ${created.id}`) + } + console.log('Seeding finished.') +} + +main() + .then(async () => { + await prisma.$disconnect() + }) + .catch(async (e) => { + console.error(e) + await prisma.$disconnect() + process.exit(1) + }) diff --git a/orm/elysia/src/index.ts b/orm/elysia/src/index.ts new file mode 100644 index 000000000000..03b907f858cd --- /dev/null +++ b/orm/elysia/src/index.ts @@ -0,0 +1,178 @@ +import { Elysia, t } from 'elysia' +import { prisma } from './lib/prisma' +import { TodoPlain, TodoPlainInputCreate, TodoPlainInputUpdate } from './generated/prismabox/Todo' + +const app = new Elysia() + // Health check + .get('/', () => { + return { message: 'Hello Elysia with Prisma!' } + }) + + // Get all todos + .get( + '/todos', + async () => { + const todos = await prisma.todo.findMany({ + orderBy: { createdAt: 'desc' }, + }) + return todos + }, + { + response: t.Array(TodoPlain), + } + ) + + // Get a single todo by ID + .get( + '/todos/:id', + async ({ params, set }) => { + const id = Number(params.id) + const todo = await prisma.todo.findUnique({ + where: { id }, + }) + + if (!todo) { + set.status = 404 + return { error: 'Todo not found' } + } + + return todo + }, + { + params: t.Object({ + id: t.Numeric(), + }), + response: { + 200: TodoPlain, + 404: t.Object({ + error: t.String(), + }), + }, + } + ) + + // Create a new todo + .post( + '/todos', + async ({ body }) => { + const todo = await prisma.todo.create({ + data: { + title: body.title, + }, + }) + return todo + }, + { + body: TodoPlainInputCreate, + response: TodoPlain, + } + ) + + // Update a todo + .put( + '/todos/:id', + async ({ params, body, set }) => { + const id = Number(params.id) + + try { + const todo = await prisma.todo.update({ + where: { id }, + data: { + title: body.title, + completed: body.completed, + }, + }) + return todo + } catch { + set.status = 404 + return { error: 'Todo not found' } + } + }, + { + params: t.Object({ + id: t.Numeric(), + }), + body: TodoPlainInputUpdate, + response: { + 200: TodoPlain, + 404: t.Object({ + error: t.String(), + }), + }, + } + ) + + // Toggle todo completion + .patch( + '/todos/:id/toggle', + async ({ params, set }) => { + const id = Number(params.id) + + try { + const todo = await prisma.todo.findUnique({ + where: { id }, + }) + + if (!todo) { + set.status = 404 + return { error: 'Todo not found' } + } + + const updated = await prisma.todo.update({ + where: { id }, + data: { completed: !todo.completed }, + }) + + return updated + } catch { + set.status = 404 + return { error: 'Todo not found' } + } + }, + { + params: t.Object({ + id: t.Numeric(), + }), + response: { + 200: TodoPlain, + 404: t.Object({ + error: t.String(), + }), + }, + } + ) + + // Delete a todo + .delete( + '/todos/:id', + async ({ params, set }) => { + const id = Number(params.id) + + try { + const todo = await prisma.todo.delete({ + where: { id }, + }) + return todo + } catch { + set.status = 404 + return { error: 'Todo not found' } + } + }, + { + params: t.Object({ + id: t.Numeric(), + }), + response: { + 200: TodoPlain, + 404: t.Object({ + error: t.String(), + }), + }, + } + ) + + .listen(3000) + +console.log( + `🦊 Elysia is running at ${app.server?.hostname}:${app.server?.port}` +) diff --git a/orm/elysia/src/lib/prisma.ts b/orm/elysia/src/lib/prisma.ts new file mode 100644 index 000000000000..2f8a642c287d --- /dev/null +++ b/orm/elysia/src/lib/prisma.ts @@ -0,0 +1,12 @@ +import { PrismaClient } from '../generated/prisma/client.js' +import { PrismaPg } from '@prisma/adapter-pg' + +const databaseUrl = process.env.DATABASE_URL + +if (!databaseUrl) { + throw new Error('DATABASE_URL is not set') +} + +const adapter = new PrismaPg({ connectionString: databaseUrl }) +export const prisma = new PrismaClient({ adapter }) + diff --git a/orm/elysia/tsconfig.json b/orm/elysia/tsconfig.json new file mode 100644 index 000000000000..1ca2350aee63 --- /dev/null +++ b/orm/elysia/tsconfig.json @@ -0,0 +1,103 @@ +{ + "compilerOptions": { + /* Visit https://aka.ms/tsconfig to read more about this file */ + + /* Projects */ + // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */ + // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */ + // "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */ + // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */ + // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */ + // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */ + + /* Language and Environment */ + "target": "ES2021", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */ + // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */ + // "jsx": "preserve", /* Specify what JSX code is generated. */ + // "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */ + // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */ + // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */ + // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */ + // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */ + // "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */ + // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */ + // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */ + // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */ + + /* Modules */ + "module": "ES2022", /* Specify what module code is generated. */ + // "rootDir": "./", /* Specify the root folder within your source files. */ + "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */ + // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */ + // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */ + // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */ + // "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */ + "types": ["bun-types"], /* Specify type package names to be included without being referenced in a source file. */ + // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ + // "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */ + // "resolveJsonModule": true, /* Enable importing .json files. */ + // "noResolve": true, /* Disallow 'import's, 'require's or ''s from expanding the number of files TypeScript should add to a project. */ + + /* JavaScript Support */ + // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */ + // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */ + // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */ + + /* Emit */ + // "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ + // "declarationMap": true, /* Create sourcemaps for d.ts files. */ + // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ + // "sourceMap": true, /* Create source map files for emitted JavaScript files. */ + // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */ + // "outDir": "./", /* Specify an output folder for all emitted files. */ + // "removeComments": true, /* Disable emitting comments. */ + // "noEmit": true, /* Disable emitting files from a compilation. */ + // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */ + // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */ + // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */ + // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */ + // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */ + // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */ + // "newLine": "crlf", /* Set the newline character for emitting files. */ + // "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */ + // "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */ + // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */ + // "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */ + // "declarationDir": "./", /* Specify the output directory for generated declaration files. */ + // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */ + + /* Interop Constraints */ + // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */ + // "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */ + "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */ + // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */ + "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */ + + /* Type Checking */ + "strict": true, /* Enable all strict type-checking options. */ + // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */ + // "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */ + // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */ + // "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */ + // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */ + // "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */ + // "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */ + // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */ + // "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */ + // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */ + // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */ + // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */ + // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */ + // "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */ + // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */ + // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */ + // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */ + // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */ + + /* Completeness */ + // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */ + "skipLibCheck": true /* Skip type checking all .d.ts files. */ + } +}