diff --git a/orm/elysia/.env.example b/orm/elysia/.env.example new file mode 100644 index 000000000000..04edbb80ccb9 --- /dev/null +++ b/orm/elysia/.env.example @@ -0,0 +1 @@ +DATABASE_URL="postgresql://postgres:postgres@localhost:5432/postgres" diff --git a/orm/elysia/.gitignore b/orm/elysia/.gitignore new file mode 100644 index 000000000000..1b41cc7a4920 --- /dev/null +++ b/orm/elysia/.gitignore @@ -0,0 +1,46 @@ +# 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.local +.env.development.local +.env.test.local +.env.production.local + +# vercel +.vercel + +**/*.trace +**/*.zip +**/*.tar.gz +**/*.tgz +**/*.log +package-lock.json +**/*.bun + +# Prisma - Generated files and migrations +/prisma/generated +/prisma/migrations diff --git a/orm/elysia/README.md b/orm/elysia/README.md new file mode 100644 index 000000000000..a9f3f2b045ca --- /dev/null +++ b/orm/elysia/README.md @@ -0,0 +1,112 @@ +# Elysia + Prisma with Bun + +Example of using [Elysia](https://elysiajs.com) with [Prisma ORM](https://www.prisma.io) on the Bun runtime. + +## Stack + +- **Framework**: Elysia +- **ORM**: Prisma +- **Runtime**: Bun +- **Database**: PostgreSQL +- **Validation**: Prismabox + +## Quick Start + +### Prerequisites + +- Bun installed +- PostgreSQL database running + +### Setup + +1. Download the example and install dependencies: +```bash +bunx --bun try-prisma@latest --template orm/elysia --name hono +cd hono +``` + +2. Install dependencies: +```bash +bun install +``` + +3. Create `.env.local` from the example: +```bash +cp .env.example .env.local +``` + +4. Configure database connection in `.env.local`: +``` +DATABASE_URL="postgresql://user:password@localhost:5432/dbname" +``` + +5. Generate Prisma client: +```bash +bunx --bun prisma generate +``` + +6. Run migrations: +```bash +bunx --bun prisma migrate dev +``` + +### Development + +Start the development server: +```bash +bun run dev +``` + +Server runs at `http://localhost:3000` + +## Project Structure + +``` +prisma/ +├── schema.prisma # Database schema +├── generated/ # Generated files (not committed) +│ ├── client/ # Prisma client +│ └── prismabox/ # Type validators +└── migrations/ # Database migrations (not committed) + +src/ +└── index.ts # Application entry point +``` + +## Database Schema + +The example includes two models: + +- **User**: `id`, `email`, `name`, `posts` +- **Post**: `id`, `title`, `content`, `published`, `author`, `authorId` + +View and edit the schema in `prisma/schema.prisma` + +## API + +### Create User +```bash +curl -X PUT http://localhost:3000 \ + -H "Content-Type: application/json" \ + -d '{"email":"user@example.com","name":"John"}' +``` + +### Get User by ID +```bash +curl http://localhost:3000/id/1 +``` + +## Regenerating Prisma Client + +After modifying `prisma/schema.prisma`: + +```bash +bunx prisma generate +``` + +## Learn More + +- [Elysia + Prisma Documentation](https://elysiajs.com/integrations/prisma.html) +- [Prisma Documentation](https://www.prisma.io/docs) +- [Prisma Adapter for PostgreSQL](https://www.prisma.io/docs/orm/overview/databases/postgresql) +- [Prismabox Documentation](https://github.com/m1212e/prismabox) diff --git a/orm/elysia/package.json b/orm/elysia/package.json new file mode 100644 index 000000000000..4aa4f5865ef8 --- /dev/null +++ b/orm/elysia/package.json @@ -0,0 +1,22 @@ +{ + "name": "elysia-prisma", + "version": "1.0.50", + "packageManager": "bun@1.3.0", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1", + "dev": "bun run --watch src/index.ts" + }, + "dependencies": { + "@prisma/adapter-pg": "^7.0.1", + "@prisma/client": "^7.0.1", + "elysia": "latest", + "pg": "^8.16.3", + "prismabox": "^1.1.25" + }, + "devDependencies": { + "@types/bun": "^1.3.3", + "@types/pg": "^8.15.6", + "prisma": "^7.0.1" + }, + "module": "src/index.js" +} diff --git a/orm/elysia/prisma.config.ts b/orm/elysia/prisma.config.ts new file mode 100644 index 000000000000..6f9985c1dee6 --- /dev/null +++ b/orm/elysia/prisma.config.ts @@ -0,0 +1,16 @@ +import { defineConfig } from "prisma/config"; + +const databaseUrl = process.env.DATABASE_URL; +if (!databaseUrl) { + throw new Error("DATABASE_URL environment variable is not set"); +} + +export default defineConfig({ + schema: "prisma/schema.prisma", + migrations: { + path: "prisma/migrations", + }, + datasource: { + url: databaseUrl, + }, +}); diff --git a/orm/elysia/prisma/schema.prisma b/orm/elysia/prisma/schema.prisma new file mode 100644 index 000000000000..a3c408cd1dad --- /dev/null +++ b/orm/elysia/prisma/schema.prisma @@ -0,0 +1,33 @@ +generator client { + provider = "prisma-client" + output = "./generated/client" + runtime = "bun" +} + +datasource db { + provider = "postgresql" +} + +generator prismabox { + provider = "prismabox" + typeboxImportDependencyName = "elysia" + typeboxImportVariableName = "t" + inputModel = true + output = "./generated/prismabox" +} + +model User { + id Int @id @default(autoincrement()) + email String @unique + name String? + posts Post[] +} + +model Post { + id Int @id @default(autoincrement()) + title String + content String? + published Boolean @default(false) + author User @relation(fields: [authorId], references: [id]) + authorId Int +} diff --git a/orm/elysia/src/index.ts b/orm/elysia/src/index.ts new file mode 100644 index 000000000000..acde725cbc48 --- /dev/null +++ b/orm/elysia/src/index.ts @@ -0,0 +1,51 @@ +import { PrismaPg } from "@prisma/adapter-pg"; +import { Elysia, t } from "elysia"; +import { Pool } from "pg"; +import { PrismaClient } from "../prisma/generated/client/client"; +import { + UserPlain, + UserPlainInputCreate, +} from "../prisma/generated/prismabox/User"; + +const pool = new Pool({ + connectionString: process.env.DATABASE_URL, +}); + +const adapter = new PrismaPg(pool); +const prisma = new PrismaClient({ adapter }); + +const app = new Elysia() + .put( + "/", + async ({ body }) => + prisma.user.create({ + data: body, + }), + { + body: UserPlainInputCreate, + response: UserPlain, + }, + ) + .get( + "/id/:id", + async ({ params: { id }, status }) => { + const user = await prisma.user.findUnique({ + where: { id: Number(id) }, + }); + + if (!user) return status(404, "User not found"); + + return user; + }, + { + response: { + 200: UserPlain, + 404: t.String(), + }, + }, + ) + .listen(3000); + +console.log( + `🦊 Elysia is running at ${app.server?.hostname}:${app.server?.port}`, +); 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. */ + } +}