Drizzle ORM Example API

Endpoints:

GET /users - List users
POST /users - Create user
GET /posts - List posts
POST /posts - Create post

View users

View posts

\n `,\n\t\t\t{\n\t\t\t\theaders: { \"Content-Type\": \"text/html\" },\n\t\t\t},\n\t\t);\n\t}\n\n\treturn Response.json({ error: \"Not found\" }, { status: 404 });\n}\n",[19,79],"cd3a7c3a-c8ef-11f0-8c99-42dde27851f2",2,["D",1763959271434],"directory",[19],{"_37":86,"_13":19,"_40":43,"_42":-5,"_44":45,"_46":87,"_48":49,"_50":146,"_17":52,"_53":89,"_55":-5,"_57":58,"_59":-5,"_105":147,"_18":148},{"_37":138,"_13":139,"_40":140,"_42":-5,"_44":45,"_46":141,"_48":49,"_50":142,"_17":52,"_53":24,"_55":143,"_57":58,"_59":-5,"_105":144,"_18":145},{"_37":130,"_13":131,"_40":132,"_42":-5,"_44":45,"_46":133,"_48":49,"_50":134,"_17":52,"_53":24,"_55":135,"_57":58,"_59":-5,"_105":136,"_18":137},{"_37":123,"_13":124,"_40":125,"_42":-5,"_44":45,"_46":66,"_48":49,"_50":126,"_17":52,"_53":24,"_55":127,"_57":58,"_59":-5,"_105":128,"_18":129},{"_37":115,"_13":116,"_40":117,"_42":-5,"_44":45,"_46":118,"_48":49,"_50":119,"_17":52,"_53":24,"_55":120,"_57":58,"_59":-5,"_105":121,"_18":122},{"_37":108,"_13":109,"_40":110,"_42":-5,"_44":45,"_46":83,"_48":49,"_50":111,"_17":52,"_53":24,"_55":112,"_57":58,"_59":-5,"_105":113,"_18":114},{"_37":98,"_13":99,"_40":100,"_42":-5,"_44":45,"_46":101,"_48":49,"_50":102,"_17":103,"_53":54,"_55":104,"_57":58,"_59":-5,"_105":106,"_18":107},"cd655428-c8ef-11f0-bd04-42dde27851f2","main.ts","e6f3abfe-c8ec-11f0-928c-42dde27851f2",7,["D",1763959271707],1,"/**\n * Lightweight Drizzle Schema to SQL Migration Generator\n * Built for Val Town (no filesystem, no drizzle-kit)\n *\n * Usage:\n * import { generateCreateTableSQL, migrate } from '@YOUR_USERNAME/drizzleMigrations';\n *\n * const sql = generateCreateTableSQL(myTable);\n * // or\n * await migrate(db, { users, posts, ... });\n */\n\n// Symbol keys that Drizzle uses\nconst DRIZZLE_SYMBOLS = {\n\tName: Symbol.for(\"drizzle:Name\"),\n\tColumns: Symbol.for(\"drizzle:Columns\"),\n\tSQLiteInlineForeignKeys: Symbol.for(\"drizzle:SQLiteInlineForeignKeys\"),\n\tExtraConfigBuilder: Symbol.for(\"drizzle:ExtraConfigBuilder\"),\n};\n\ninterface ColumnMetadata {\n\tname: string;\n\tcolumnType: string;\n\tdataType: string;\n\tnotNull: boolean;\n\tprimary: boolean;\n\tdefault?: any;\n\tisUnique: boolean;\n\tautoIncrement?: boolean;\n\tenumValues?: string[];\n\tconfig?: any;\n}\n\ninterface ForeignKeyMetadata {\n\treference: () => any;\n\tonUpdate?: string;\n\tonDelete?: string;\n}\n\n/**\n * Generate CREATE TABLE SQL for a Drizzle table\n */\nexport function generateCreateTableSQL(table: any): string {\n\tconst tableName = table[DRIZZLE_SYMBOLS.Name];\n\tconst columns = table[DRIZZLE_SYMBOLS.Columns];\n\n\tif (!tableName || !columns) {\n\t\tthrow new Error(\"Invalid Drizzle table object\");\n\t}\n\n\tconst columnDefs: string[] = [];\n\tconst constraints: string[] = [];\n\n\t// Process columns\n\tfor (const [_key, column] of Object.entries(columns)) {\n\t\tconst col = column as ColumnMetadata;\n\t\tcolumnDefs.push(generateColumnDef(col));\n\t}\n\n\t// Process foreign keys\n\tconst foreignKeys = table[DRIZZLE_SYMBOLS.SQLiteInlineForeignKeys] || [];\n\tfor (const fk of foreignKeys) {\n\t\tconst fkDef = generateForeignKeyDef(fk);\n\t\tif (fkDef) constraints.push(fkDef);\n\t}\n\n\tconst allDefs = [...columnDefs, ...constraints];\n\treturn `CREATE TABLE IF NOT EXISTS \"${tableName}\" (\\n ${allDefs.join(\",\\n \")}\\n);`;\n}\n\n/**\n * Generate column definition\n */\nfunction generateColumnDef(col: ColumnMetadata): string {\n\tlet def = `\"${col.name}\" `;\n\n\t// Map Drizzle types to SQLite types\n\tswitch (col.columnType) {\n\t\tcase \"SQLiteInteger\":\n\t\t\tdef += \"INTEGER\";\n\t\t\tbreak;\n\t\tcase \"SQLiteText\":\n\t\t\tdef += \"TEXT\";\n\t\t\tbreak;\n\t\tcase \"SQLiteReal\":\n\t\t\tdef += \"REAL\";\n\t\t\tbreak;\n\t\tcase \"SQLiteBlob\":\n\t\t\tdef += \"BLOB\";\n\t\t\tbreak;\n\t\tdefault:\n\t\t\tdef += \"TEXT\";\n\t}\n\n\t// PRIMARY KEY\n\tif (col.primary) {\n\t\tdef += \" PRIMARY KEY\";\n\t\tif (col.autoIncrement) {\n\t\t\tdef += \" AUTOINCREMENT\";\n\t\t}\n\t}\n\n\t// NOT NULL\n\tif (col.notNull && !col.primary) {\n\t\tdef += \" NOT NULL\";\n\t}\n\n\t// UNIQUE\n\tif (col.isUnique) {\n\t\tdef += \" UNIQUE\";\n\t}\n\n\t// DEFAULT\n\tif (col.default !== undefined) {\n\t\tif (typeof col.default === \"string\") {\n\t\t\tdef += ` DEFAULT '${col.default}'`;\n\t\t} else if (typeof col.default === \"number\") {\n\t\t\tdef += ` DEFAULT ${col.default}`;\n\t\t} else if (typeof col.default === \"boolean\") {\n\t\t\tdef += ` DEFAULT ${col.default ? 1 : 0}`;\n\t\t}\n\t}\n\n\treturn def;\n}\n\n/**\n * Generate foreign key constraint\n */\nfunction generateForeignKeyDef(fk: ForeignKeyMetadata): string | null {\n\ttry {\n\t\t// Call the reference function to get FK info\n\t\tconst ref = fk.reference();\n\n\t\t// ref has: columns (local), foreignTable, foreignColumns (referenced)\n\t\tif (!ref || !ref.foreignTable || !ref.columns || !ref.foreignColumns) {\n\t\t\treturn null;\n\t\t}\n\n\t\tconst foreignTableName = ref.foreignTable[DRIZZLE_SYMBOLS.Name];\n\t\tif (!foreignTableName) {\n\t\t\treturn null;\n\t\t}\n\n\t\t// Get column names\n\t\tconst localColumns = ref.columns\n\t\t\t.map((col: any) => `\"${col.name}\"`)\n\t\t\t.join(\", \");\n\t\tconst foreignColumns = ref.foreignColumns\n\t\t\t.map((col: any) => `\"${col.name}\"`)\n\t\t\t.join(\", \");\n\n\t\tlet def = `FOREIGN KEY (${localColumns}) REFERENCES \"${foreignTableName}\" (${foreignColumns})`;\n\n\t\tif (fk.onUpdate) {\n\t\t\tdef += ` ON UPDATE ${fk.onUpdate.toUpperCase()}`;\n\t\t}\n\n\t\tif (fk.onDelete) {\n\t\t\tdef += ` ON DELETE ${fk.onDelete.toUpperCase()}`;\n\t\t}\n\n\t\treturn def;\n\t} catch (_e) {\n\t\t// Silently skip FK generation if it fails - not critical\n\t\treturn null;\n\t}\n}\n\n/**\n * Generate CREATE INDEX SQL for a Drizzle index\n */\nexport function generateCreateIndexSQL(\n\ttableName: string,\n\tindexName: string,\n\tindex: any,\n): string {\n\tconst unique = index.config?.unique ? \"UNIQUE \" : \"\";\n\tconst columns = index.config?.columns || [];\n\n\tconst columnNames = columns.map((col: any) => `\"${col.name}\"`).join(\", \");\n\n\treturn `CREATE ${unique}INDEX IF NOT EXISTS \"${indexName}\" ON \"${tableName}\" (${columnNames});`;\n}\n\n/**\n * Extract all indexes from a table\n */\nexport function extractIndexes(\n\ttable: any,\n): Array<{ name: string; sql: string }> {\n\tconst tableName = table[DRIZZLE_SYMBOLS.Name];\n\tconst columns = table[DRIZZLE_SYMBOLS.Columns];\n\tconst extraConfigBuilder = table[DRIZZLE_SYMBOLS.ExtraConfigBuilder];\n\n\tconst indexes: Array<{ name: string; sql: string }> = [];\n\n\tif (extraConfigBuilder) {\n\t\tconst config = extraConfigBuilder(columns);\n\t\tfor (const [name, index] of Object.entries(config)) {\n\t\t\tconst sql = generateCreateIndexSQL(tableName, name, index);\n\t\t\tindexes.push({ name, sql });\n\t\t}\n\t}\n\n\treturn indexes;\n}\n\n/**\n * Migration system - stores state in SQLite\n */\ninterface MigrationState {\n\tversion: number;\n\ttables: Record; // table name -> SQL hash\n\tappliedAt: string;\n}\n\n/**\n * Initialize migrations table\n */\nasync function initMigrationsTable(db: any): Promise {\n\tawait db.execute(`\n CREATE TABLE IF NOT EXISTS __drizzle_migrations (\n id INTEGER PRIMARY KEY AUTOINCREMENT,\n version INTEGER NOT NULL UNIQUE,\n tables TEXT NOT NULL,\n applied_at TEXT NOT NULL DEFAULT (datetime('now'))\n )\n `);\n}\n\n/**\n * Get current migration state\n */\nasync function getCurrentState(db: any): Promise {\n\tconst result = await db.execute(`\n SELECT version, tables, applied_at\n FROM __drizzle_migrations\n ORDER BY version DESC\n LIMIT 1\n `);\n\n\tif (result.rows.length === 0) {\n\t\treturn null;\n\t}\n\n\tconst row = result.rows[0];\n\treturn {\n\t\tversion: row[0] as number,\n\t\ttables: JSON.parse(row[1] as string),\n\t\tappliedAt: row[2] as string,\n\t};\n}\n\n/**\n * Simple hash function for SQL strings\n */\nfunction hashSQL(sql: string): string {\n\tlet hash = 0;\n\tfor (let i = 0; i < sql.length; i++) {\n\t\tconst char = sql.charCodeAt(i);\n\t\thash = (hash << 5) - hash + char;\n\t\thash = hash & hash; // Convert to 32bit integer\n\t}\n\treturn hash.toString(36);\n}\n\n/**\n * Main migration function\n * Pass in your db instance and an object with all your tables\n */\nexport async function migrate(\n\tdb: any,\n\ttables: Record,\n\toptions: { dryRun?: boolean } = {},\n): Promise<{ applied: string[]; skipped: string[]; version?: number }> {\n\tawait initMigrationsTable(db);\n\n\tconst currentState = await getCurrentState(db);\n\tconst newVersion = (currentState?.version || 0) + 1;\n\n\tconst applied: string[] = [];\n\tconst skipped: string[] = [];\n\tconst newTableHashes: Record = {};\n\n\tconsole.log(`\\n=== Migration v${newVersion} ===`);\n\n\t// Generate SQL for all tables\n\tfor (const [tableName, table] of Object.entries(tables)) {\n\t\tconst sql = generateCreateTableSQL(table);\n\t\tconst hash = hashSQL(sql);\n\n\t\tnewTableHashes[tableName] = hash;\n\n\t\t// Check if this table needs to be created/updated\n\t\tconst previousHash = currentState?.tables[tableName];\n\n\t\tif (!previousHash) {\n\t\t\tconsole.log(`[NEW] Creating table: ${tableName}`);\n\t\t\tconsole.log(sql);\n\n\t\t\tif (!options.dryRun) {\n\t\t\t\tawait db.execute(sql);\n\n\t\t\t\t// Create indexes\n\t\t\t\tconst indexes = extractIndexes(table);\n\t\t\t\tfor (const idx of indexes) {\n\t\t\t\t\tconsole.log(`[INDEX] ${idx.name}`);\n\t\t\t\t\tconsole.log(idx.sql);\n\t\t\t\t\tawait db.execute(idx.sql);\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tapplied.push(tableName);\n\t\t} else if (previousHash !== hash) {\n\t\t\tconsole.log(`[CHANGED] Table schema changed: ${tableName}`);\n\t\t\tconsole.log(\"⚠️ Manual migration required for schema changes\");\n\t\t\tconsole.log(\"New SQL:\", sql);\n\t\t\tskipped.push(tableName);\n\t\t} else {\n\t\t\tconsole.log(`[SKIP] No changes: ${tableName}`);\n\t\t\tskipped.push(tableName);\n\t\t}\n\t}\n\n\t// Save new state\n\tif (!options.dryRun && applied.length > 0) {\n\t\tawait db.execute(\n\t\t\t`\n INSERT INTO __drizzle_migrations (version, tables)\n VALUES (?, ?)\n `,\n\t\t\t[newVersion, JSON.stringify(newTableHashes)],\n\t\t);\n\n\t\tconsole.log(`\\n✅ Migration v${newVersion} applied`);\n\t}\n\n\treturn { applied, skipped, version: newVersion };\n}\n\n/**\n * Generate SQL for an entire schema (useful for inspection)\n */\nexport function generateSchemaSQL(tables: Record): string {\n\tconst statements: string[] = [];\n\n\tfor (const [_tableName, table] of Object.entries(tables)) {\n\t\tstatements.push(generateCreateTableSQL(table));\n\n\t\tconst indexes = extractIndexes(table);\n\t\tfor (const idx of indexes) {\n\t\t\tstatements.push(idx.sql);\n\t\t}\n\n\t\tstatements.push(\"\"); // blank line between tables\n\t}\n\n\treturn statements.join(\"\\n\");\n}\n","children",[],[99],"07c197d0-c8f0-11f0-a175-42dde27851f2","deno.json","07c1988e-c8f0-11f0-a175-42dde27851f2",["D",1763959369626],"{\n \"$schema\": \"https://raw.githubusercontent.com/denoland/deno/348900b8b79f4a434cab4c74b3bc8d4d2fa8ee74/cli/schemas/config-file.v1.json\",\n \"compilerOptions\": {\n \"lib\": [\n \"dom\",\n \"dom.iterable\",\n \"dom.asynciterable\",\n \"deno.ns\",\n \"deno.unstable\"\n ],\n \"noImplicitAny\": false,\n \"strict\": false,\n \"types\": [\"https://www.val.town/types/valtown.d.ts\"]\n },\n \"experimental\": {\n \"unstable-node-globals\": true,\n \"unstable-sloppy-imports\": true,\n \"unstable-temporal\": true,\n \"unstable-worker-options\": true\n },\n \"imports\": {\n \"@biomejs/biome\": \"npm:@biomejs/biome@^2.3.7\"\n },\n \"lint\": {\n \"files\": {\n \"include\": [\"deno:/https/esm.town/**/*\"]\n },\n \"rules\": {\n \"exclude\": [\"no-explicit-any\", \"no-import-prefix\"]\n }\n },\n \"lock\": false,\n \"nodeModulesDir\": \"auto\"\n}",[],[109],"07c402ea-c8f0-11f0-88c2-42dde27851f2","biome.json","07c40380-c8f0-11f0-88c2-42dde27851f2",10,["D",1763959369630],"{\n\t\"$schema\": \"https://biomejs.dev/schemas/2.3.7/schema.json\",\n\t\"vcs\": {\n\t\t\"enabled\": false,\n\t\t\"clientKind\": \"git\",\n\t\t\"useIgnoreFile\": false\n\t},\n\t\"files\": {\n\t\t\"ignoreUnknown\": false\n\t},\n\t\"formatter\": {\n\t\t\"enabled\": true,\n\t\t\"indentStyle\": \"tab\"\n\t},\n\t\"linter\": {\n\t\t\"enabled\": true,\n\t\t\"rules\": {\n\t\t\t\"recommended\": true\n\t\t}\n\t},\n\t\"javascript\": {\n\t\t\"formatter\": {\n\t\t\t\"quoteStyle\": \"double\"\n\t\t}\n\t},\n\t\"assist\": {\n\t\t\"enabled\": true,\n\t\t\"actions\": {\n\t\t\t\"source\": {\n\t\t\t\t\"organizeImports\": \"on\"\n\t\t\t}\n\t\t}\n\t}\n}\n",[],[116],"cd59b6e0-c8ef-11f0-bdd0-42dde27851f2","README.md","cd59b7bc-c8ef-11f0-bdd0-42dde27851f2",["D",1763959271562],"# Type-Safe Drizzle Migrations for Val Town\n\nA complete working example of filesystem-free migrations for Drizzle ORM.\n\n## What's Included\n\nFive vals that work together:\n\n1. **@nbbaier/drizzleMigrations** - Core migration library\n2. **@nbbaier/drizzleSchema** - Example schema definitions\n3. **@nbbaier/runDrizzleMigrations** - HTTP endpoint to run migrations\n4. **@nbbaier/inspectDrizzleSchema** - View generated SQL\n5. **@nbbaier/drizzleExampleApp** - Working API example\n\n## Quick Start (5 minutes)\n\n### 1. Run Migrations\n\nVisit: https://nbbaier-runDrizzleMigrations.web.val.run\n\nYou'll see:\n\n```json\n{\n \"success\": true,\n \"version\": 1,\n \"applied\": [\"users\", \"posts\"],\n \"skipped\": []\n}\n```\n\nThis created the `users` and `posts` tables in your SQLite database.\n\n### 2. Try the API\n\nVisit: https://nbbaier-drizzleExampleApp.web.val.run/users\n\nCreate a user:\n\n```bash\ncurl -X POST https://nbbaier-drizzleExampleApp.web.val.run/users \\\n -H \"Content-Type: application/json\" \\\n -d '{\"name\": \"Alice\", \"email\": \"alice@example.com\"}'\n```\n\n### 3. Inspect Generated SQL (Optional)\n\nVisit: https://nbbaier-inspectDrizzleSchema.web.val.run\n\nYou'll see the actual CREATE TABLE statements that were generated.\n\n## How to Use in Your Project\n\n### Step 1: Fork or Reference the Migration Library\n\n```typescript\nimport {\n migrate,\n generateCreateTableSQL,\n} from \"https://esm.town/v/nbbaier/drizzleMigrations\";\n```\n\nOr fork @nbbaier/drizzleMigrations to your own account.\n\n### Step 2: Define Your Schema\n\nCreate a val with your tables:\n\n```typescript\nimport { sqliteTable, text, integer } from \"npm:drizzle-orm/sqlite-core\";\n\nexport const myTable = sqliteTable(\"my_table\", {\n id: integer(\"id\").primaryKey({ autoIncrement: true }),\n name: text(\"name\").notNull(),\n});\n```\n\n### Step 3: Create a Migration Runner\n\n```typescript\nimport { sqlite } from \"https://esm.town/v/std/sqlite\";\nimport { migrate } from \"https://esm.town/v/nbbaier/drizzleMigrations\";\nimport * as schema from \"https://esm.town/v/YOUR_USERNAME/yourSchema\";\n\nexport default async function (req: Request) {\n const result = await migrate(sqlite, schema);\n return Response.json(result);\n}\n```\n\n### Step 4: Use Your Schema\n\n```typescript\nimport { drizzle } from \"npm:drizzle-orm/better-sqlite3\";\nimport { sqlite } from \"https://esm.town/v/std/sqlite\";\nimport * as schema from \"https://esm.town/v/YOUR_USERNAME/yourSchema\";\n\nconst db = drizzle(sqlite, { schema });\n\n// Now you have full type safety!\nconst results = await db.select().from(schema.myTable);\n```\n\n## Features\n\n- ✅ **Type-safe** - Full TypeScript inference from your schema\n- ✅ **No filesystem** - Works in Val Town's sandboxed environment\n- ✅ **Auto migrations** - Creates new tables automatically\n- ✅ **Change detection** - Warns when schemas change\n- ✅ **Foreign keys** - Handles relationships correctly\n- ✅ **Lightweight** - ~300 lines, zero dependencies beyond drizzle-orm\n\n## API Reference\n\n### `migrate(db, tables, options?)`\n\nRun migrations against your database.\n\n**Parameters:**\n\n- `db` - Val Town SQLite instance\n- `tables` - Object with table definitions\n- `options.dryRun` - (optional) Preview without executing\n\n**Returns:**\n\n```typescript\n{\n applied: string[], // New tables created\n skipped: string[], // Unchanged tables\n version: number // Migration version\n}\n```\n\n### `generateCreateTableSQL(table)`\n\nGenerate CREATE TABLE SQL for a single table.\n\n```typescript\nconst sql = generateCreateTableSQL(myTable);\nconsole.log(sql);\n// CREATE TABLE IF NOT EXISTS \"my_table\" (\n// \"id\" INTEGER PRIMARY KEY AUTOINCREMENT,\n// ...\n// );\n```\n\n### `generateSchemaSQL(tables)`\n\nGenerate SQL for all tables and indexes.\n\n```typescript\nconst sql = generateSchemaSQL({ users, posts });\n```\n\n## How It Works\n\n1. **Reads Drizzle metadata** - Uses Symbol keys to introspect schema\n2. **Generates SQL** - Walks column definitions to build CREATE TABLE\n3. **Tracks state in SQLite** - Stores migration versions in `__drizzle_migrations` table\n4. **Detects changes** - Compares SQL hashes to previous version\n5. **Safe updates** - Only creates new tables, warns about changes\n\n## Schema Changes\n\nWhen you modify an existing table:\n\n1. Update your schema val\n2. Run migrations again\n3. You'll see: `[CHANGED] Table schema changed: users`\n4. Write manual ALTER TABLE or recreate the table\n\nExample manual migration:\n\n```typescript\nawait sqlite.execute(`\n ALTER TABLE users ADD COLUMN bio TEXT;\n`);\n```\n\n## Comparison to Drizzle Kit\n\n| Feature | Drizzle Kit | This Solution |\n| --------------- | ----------- | --------------- |\n| Filesystem | Required | None |\n| Val Town | No | Yes |\n| Size | ~5MB | ~10KB |\n| Auto migrations | Yes | New tables only |\n| Type safety | Yes | Yes |\n\n## Tips\n\n### Add Authentication\n\n```typescript\nexport default async function (req: Request) {\n const auth = req.headers.get(\"authorization\");\n if (auth !== `Bearer ${Deno.env.get(\"MIGRATION_TOKEN\")}`) {\n return Response.json({ error: \"Unauthorized\" }, { status: 401 });\n }\n\n const result = await migrate(sqlite, schema);\n return Response.json(result);\n}\n```\n\nSet `MIGRATION_TOKEN` in Val Town secrets.\n\n### Dry Run\n\nSee what would happen without executing:\n\n```typescript\nconst result = await migrate(sqlite, schema, { dryRun: true });\n```\n\n### Multiple Environments\n\nEach Val Town user has their own SQLite database, so you can test changes before deploying.\n\n## Examples\n\nCheck out:\n\n- @nbbaier/drizzleSchema - Schema definitions\n- @nbbaier/runDrizzleMigrations - Migration runner\n- @nbbaier/drizzleExampleApp - Working API\n\n## License\n\nMIT - Use freely!\n\n## Questions?\n\nOpen an issue or ask in Val Town Discord.\n",[],[124],"07caeb8c-c8f0-11f0-8c25-42dde27851f2","AGENTS.md","07caec5e-c8f0-11f0-8c25-42dde27851f2",12,["D",1763959369657],"You are an advanced assistant specialized in generating Val Town code.\n\n## Core Guidelines\n\n- Ask clarifying questions when requirements are ambiguous\n- Provide complete, functional solutions rather than skeleton implementations\n- Test your logic against edge cases before presenting the final solution\n- Ensure all code follows Val Town's specific platform requirements\n- If a section of code that you're working on is getting too complex, consider\n refactoring it into subcomponents\n\n## Code Standards\n\n- Generate code in TypeScript or TSX\n- Add appropriate TypeScript types and interfaces for all data structures\n- Prefer official SDKs or libraries than writing API calls directly\n- Ask the user to supply API or library documentation if you are at all unsure\n about it\n- **Never bake in secrets into the code** - always use environment variables\n- Include comments explaining complex logic (avoid commenting obvious\n operations)\n- Follow modern ES6+ conventions and functional programming practices if\n possible\n\n## Types of triggers\n\n### 1. HTTP Trigger\n\n- Create web APIs and endpoints\n- Handle HTTP requests and responses\n- Example structure:\n\n```ts\nexport default async function (req: Request) {\n return new Response(\"Hello World\");\n}\n```\n\nFiles that are HTTP triggers have http in their name like `foobar.http.tsx`\n\n### 2. Cron Triggers\n\n- Run on a schedule\n- Use cron expressions for timing\n- Example structure:\n\n```ts\nexport default async function () {\n // Scheduled task code\n}\n```\n\nFiles that are Cron triggers have cron in their name like `foobar.cron.tsx`\n\n### 3. Email Triggers\n\n- Process incoming emails\n- Handle email-based workflows\n- Example structure:\n\n```ts\nexport default async function (email: Email) {\n // Process email\n}\n```\n\nFiles that are Email triggers have email in their name like `foobar.email.tsx`\n\n## Val Town Standard Libraries\n\nVal Town provides several hosted services and utility functions.\n\n### Blob Storage\n\n```ts\nimport { blob } from \"https://esm.town/v/std/blob\";\nawait blob.setJSON(\"myKey\", { hello: \"world\" });\nlet blobDemo = await blob.getJSON(\"myKey\");\nlet appKeys = await blob.list(\"app_\");\nawait blob.delete(\"myKey\");\n```\n\n### SQLite\n\n```ts\nimport { sqlite } from \"https://esm.town/v/stevekrouse/sqlite\";\nconst TABLE_NAME = \"todo_app_users_2\";\n// Create table - do this before usage and change table name when modifying schema\nawait sqlite.execute(`CREATE TABLE IF NOT EXISTS ${TABLE_NAME} (\n id INTEGER PRIMARY KEY AUTOINCREMENT,\n name TEXT NOT NULL\n)`);\n// Query data\nconst result = await sqlite.execute(\n `SELECT * FROM ${TABLE_NAME} WHERE id = ?`,\n [1],\n);\n```\n\nNote: When changing a SQLite table's schema, change the table's name (e.g., add\n_2 or _3) to create a fresh table.\n\n### OpenAI\n\n```ts\nimport { OpenAI } from \"https://esm.town/v/std/openai\";\nconst openai = new OpenAI();\nconst completion = await openai.chat.completions.create({\n messages: [\n { role: \"user\", content: \"Say hello in a creative way\" },\n ],\n model: \"gpt-4o-mini\",\n max_tokens: 30,\n});\n```\n\n### Email\n\n```ts\nimport { email } from \"https://esm.town/v/std/email\";\n// By default emails the owner of the val\nawait email({\n subject: \"Hi\",\n text: \"Hi\",\n html: \"

Hi

\",\n});\n```\n\n## Val Town Utility Functions\n\nVal Town provides several utility functions to help with common project tasks.\n\n### Importing Utilities\n\nAlways import utilities with version pins to avoid breaking changes:\n\n```ts\nimport {\n parseProject,\n readFile,\n serveFile,\n} from \"https://esm.town/v/std/utils@85-main/index.ts\";\n```\n\n### Available Utilities\n\n#### **serveFile** - Serve project files with proper content types\n\nFor example, in Hono:\n\n```ts\n// serve all files in frontend/ and shared/\napp.get(\"/frontend/*\", (c) => serveFile(c.req.path, import.meta.url));\napp.get(\"/shared/*\", (c) => serveFile(c.req.path, import.meta.url));\n```\n\n#### **readFile** - Read files from within the project:\n\n```ts\n// Read a file from the project\nconst fileContent = await readFile(\"/frontend/index.html\", import.meta.url);\n```\n\n#### **listFiles** - List all files in the project\n\n```ts\nconst files = await listFiles(import.meta.url);\n```\n\n#### **parseProject** - Extract information about the current project from import.meta.url\n\nThis is useful for including info for linking back to a val, ie in \"view source\"\nurls:\n\n```ts\nconst projectVal = parseProject(import.meta.url);\nconsole.log(projectVal.username); // Owner of the project\nconsole.log(projectVal.name); // Project name\nconsole.log(projectVal.version); // Version number\nconsole.log(projectVal.branch); // Branch name\nconsole.log(projectVal.links.self.project); // URL to the project page\n```\n\nHowever, it's _extremely importing_ to note that `parseProject` and other\nStandard Library utilities ONLY RUN ON THE SERVER. If you need access to this\ndata on the client, run it in the server and pass it to the client by splicing\nit into the HTML page or by making an API request for it.\n\n## Val Town Platform Specifics\n\n- **Redirects:** Use\n `return new Response(null, { status: 302, headers: { Location: \"/place/to/redirect\" }})`\n instead of `Response.redirect` which is broken\n- **Images:** Avoid external images or base64 images. Use emojis, unicode\n symbols, or icon fonts/libraries instead\n- **AI Image:** To inline generate an AI image use:\n `

`\n- **Storage:** DO NOT use the Deno KV module for storage\n- **Browser APIs:** DO NOT use the `alert()`, `prompt()`, or `confirm()` methods\n- **Weather Data:** Use open-meteo for weather data (doesn't require API keys)\n unless otherwise specified\n- **View Source:** Add a view source link by importing & using\n `import.meta.url.replace(\"ems.sh\", \"val.town)\"` (or passing this data to the\n client) and include `target=\"_top\"` attribute\n- **Error Debugging:** Add\n `` to HTML to capture\n client-side errors\n- **Error Handling:** Only use try...catch when there's a clear local\n resolution; Avoid catches that merely log or return 500s. Let errors bubble up\n with full context\n- **Environment Variables:** Use `Deno.env.get('keyname')` when you need to, but\n generally prefer APIs that don't require keys\n- **Imports:** Use `https://esm.sh` for npm and Deno dependencies to ensure\n compatibility on server and browser\n- **Storage Strategy:** Only use backend storage if explicitly required; prefer\n simple static client-side sites\n- **React Configuration:** When using React libraries, pin versions with\n `?deps=react@18.2.0,react-dom@18.2.0` and start the file with\n `/** @jsxImportSource https://esm.sh/react@18.2.0 */`\n- Ensure all React dependencies and sub-dependencies are pinned to the same\n version\n- **Styling:** Default to using TailwindCSS via\n `` unless otherwise\n specified\n\n## Project Structure and Design Patterns\n\n### Recommended Directory Structure\n\n```\n├── backend/\n│ ├── database/\n│ │ ├── migrations.ts # Schema definitions\n│ │ ├── queries.ts # DB query functions\n│ │ └── README.md\n│ └── routes/ # Route modules\n│ ├── [route].ts\n│ └── static.ts # Static file serving\n│ ├── index.ts # Main entry point\n│ └── README.md\n├── frontend/\n│ ├── components/\n│ │ ├── App.tsx\n│ │ └── [Component].tsx\n│ ├── favicon.svg\n│ ├── index.html # Main HTML template\n│ ├── index.tsx # Frontend JS entry point\n│ ├── README.md\n│ └── style.css\n├── README.md\n└── shared/\n ├── README.md\n └── utils.ts # Shared types and functions\n```\n\n### Backend (Hono) Best Practices\n\n- Hono is the recommended API framework\n- Main entry point should be `backend/index.ts`\n- **Static asset serving:** Use the utility functions to read and serve project\n files:\n ```ts\n import {\n readFile,\n serveFile,\n } from \"https://esm.town/v/std/utils@85-main/index.ts\";\n\n // serve all files in frontend/ and shared/\n app.get(\"/frontend/*\", (c) => serveFile(c.req.path, import.meta.url));\n app.get(\"/shared/*\", (c) => serveFile(c.req.path, import.meta.url));\n\n // For index.html, often you'll want to bootstrap with initial data\n app.get(\"/\", async (c) => {\n let html = await readFile(\"/frontend/index.html\", import.meta.url);\n\n // Inject data to avoid extra round-trips\n const initialData = await fetchInitialData();\n const dataScript = ``;\n\n html = html.replace(\"\", `${dataScript}`);\n return c.html(html);\n });\n ```\n- Create RESTful API routes for CRUD operations\n- Always include this snippet at the top-level Hono app to re-throwing errors to\n see full stack traces:\n ```ts\n // Unwrap Hono errors to see original error details\n app.onError((err, c) => {\n throw err;\n });\n ```\n\n### Database Patterns\n\n- Run migrations on startup or comment out for performance\n- Change table names when modifying schemas rather than altering\n- Export clear query functions with proper TypeScript typing\n\n## Common Gotchas and Solutions\n\n1. **Environment Limitations:**\n - Val Town runs on Deno in a serverless context, not Node.js\n - Code in `shared/` must work in both frontend and backend environments\n - Cannot use `Deno` keyword in shared code\n - Use `https://esm.sh` for imports that work in both environments\n\n2. **SQLite Peculiarities:**\n - Limited support for ALTER TABLE operations\n - Create new tables with updated schemas and copy data when needed\n - Always run table creation before querying\n\n3. **React Configuration:**\n - All React dependencies must be pinned to 18.2.0\n - Always include `@jsxImportSource https://esm.sh/react@18.2.0` at the top of\n React files\n - Rendering issues often come from mismatched React versions\n\n4. **File Handling:**\n - Val Town only supports text files, not binary\n - Use the provided utilities to read files across branches and forks\n - For files in the project, use `readFile` helpers\n\n5. **API Design:**\n - `fetch` handler is the entry point for HTTP vals\n - Run the Hono app with\n `export default app.fetch // This is the entry point for HTTP vals`",[],[131],"07c6fe3c-c8f0-11f0-9d62-42dde27851f2",".vtignore","07c6ff54-c8f0-11f0-9d62-42dde27851f2",11,["D",1763959369651],".git\n.vscode\n.cursor\n.DS_Store\nnode_modules\nvendor",[],[139],["D",1763959271434],[149,150,151,152],[19],{"_37":78,"_13":79,"_40":80,"_42":43,"_44":45,"_46":81,"_48":49,"_50":162,"_17":83,"_53":67,"_55":84,"_57":58,"_59":-5,"_105":163,"_18":164},{"_37":70,"_13":71,"_40":72,"_42":43,"_44":45,"_46":73,"_48":49,"_50":159,"_17":75,"_53":67,"_55":76,"_57":58,"_59":-5,"_105":160,"_18":161},{"_37":61,"_13":62,"_40":63,"_42":43,"_44":45,"_46":64,"_48":49,"_50":156,"_17":66,"_53":67,"_55":68,"_57":58,"_59":-5,"_105":157,"_18":158},{"_37":38,"_13":39,"_40":41,"_42":43,"_44":45,"_46":47,"_48":49,"_50":153,"_17":52,"_53":54,"_55":56,"_57":58,"_59":-5,"_105":154,"_18":155},["D",1763959271566],[],[19,39],["D",1763998629627],[],[19,62],["D",1763998629700],[],[19,71],["D",1763998629670],[],[19,79],"e6efa630-c8ec-11f0-928c-42dde27851f2",["D",1763958026076],"deletedAt","legacyEnvVars","privacy","public","httpPrivacy","description","Type-safe Drizzle migrations for Val Town (no filesystem needed)","imageUrl","userId","5d1042a9-7b0b-499d-8a72-3a8ac7a4e185","pinnedFileId","pinPreview","pinMigrated","screenshotVersion","likeCount","orgId","5f80108f-7ca4-4327-b77b-089dbe4b5a82","tursoName","tursoHostname","tursoMeasuredAt","pinned","userPerm","r","valPerm","blobPerm","rw","emailPerm","sqlitePerm","projectPerm","telemetryPerm","user",{"_11":12,"_218":214},"org",{"_11":12,"_212":-5,"_213":214,"_175":176,"_215":216,"_217":58},"branch",{"_17":73,"_13":16,"_37":45,"_204":165,"_205":-5,"_206":-5,"_207":-5,"_208":-5,"_209":-5,"_210":14,"_211":12},"isOwned","projectId","forkedBranchId","forkedBranchVersion","forkedProjectPrivacy","forkedProjectId","forkedProjectOrgId","projectName","userHandle","displayName","avatar","https://secure.gravatar.com/avatar/0129a541b7b3574e92c4afd06c5e32da&d=identicon","tier","pro","canRestrictVals","profileImageUrl","adoptOrgId",{"_37":165,"_13":14,"_50":289,"_167":-5,"_168":58,"_169":170,"_171":170,"_172":173,"_174":-5,"_175":176,"_177":80,"_178":49,"_179":49,"_180":-5,"_181":52,"_182":183,"_184":-5,"_185":-5,"_186":-5,"_187":-5,"_188":189,"_190":189,"_191":192,"_193":192,"_194":192,"_195":189,"_196":189,"_197":290,"_199":291,"_201":292,"_203":58},[256,261,262,263,264,265,266],"files",[256,257,258,259,260,261,262,263,264,265,266],"counts",{"_247":52,"_248":103,"_249":52,"_32":250,"_251":252},[239,240,241,242],{"_37":86,"_13":19,"_40":43,"_42":-5,"_44":45,"_46":87,"_48":49,"_50":88,"_17":52,"_53":89,"_55":-5,"_57":58,"_59":-5,"_18":238},"upstreamProject","upstreamBranch","emptyEnvVars","flags",[],"hasHttpFiles","grants","orgs","customDomains",{},[19],{"_37":78,"_13":79,"_40":80,"_42":43,"_44":45,"_46":81,"_48":49,"_50":82,"_17":83,"_53":67,"_55":84,"_57":58,"_59":-5,"_18":246},{"_37":70,"_13":71,"_40":72,"_42":43,"_44":45,"_46":73,"_48":49,"_50":74,"_17":75,"_53":67,"_55":76,"_57":58,"_59":-5,"_18":245},{"_37":61,"_13":62,"_40":63,"_42":43,"_44":45,"_46":64,"_48":49,"_50":65,"_17":66,"_53":67,"_55":68,"_57":58,"_59":-5,"_18":244},{"_37":38,"_13":39,"_40":41,"_42":43,"_44":45,"_46":47,"_48":49,"_50":51,"_17":52,"_53":54,"_55":56,"_57":58,"_59":-5,"_18":243},[19,39],[19,62],[19,71],[19,79],"pulls","branches","forks",{"_253":52,"_255":52},"connections",{"_253":52,"_254":52},"count","unfilledCount","emptyCount",{"_37":86,"_13":19,"_40":43,"_42":-5,"_44":45,"_46":87,"_48":49,"_50":146,"_17":52,"_53":89,"_55":-5,"_57":58,"_59":-5,"_105":287,"_18":288},{"_37":78,"_13":79,"_40":80,"_42":43,"_44":45,"_46":81,"_48":49,"_50":162,"_17":83,"_53":67,"_55":84,"_57":58,"_59":-5,"_105":285,"_18":286},{"_37":70,"_13":71,"_40":72,"_42":43,"_44":45,"_46":73,"_48":49,"_50":159,"_17":75,"_53":67,"_55":76,"_57":58,"_59":-5,"_105":283,"_18":284},{"_37":61,"_13":62,"_40":63,"_42":43,"_44":45,"_46":64,"_48":49,"_50":156,"_17":66,"_53":67,"_55":68,"_57":58,"_59":-5,"_105":281,"_18":282},{"_37":38,"_13":39,"_40":41,"_42":43,"_44":45,"_46":47,"_48":49,"_50":153,"_17":52,"_53":54,"_55":56,"_57":58,"_59":-5,"_105":279,"_18":280},{"_37":138,"_13":139,"_40":140,"_42":-5,"_44":45,"_46":141,"_48":49,"_50":142,"_17":52,"_53":24,"_55":143,"_57":58,"_59":-5,"_105":277,"_18":278},{"_37":130,"_13":131,"_40":132,"_42":-5,"_44":45,"_46":133,"_48":49,"_50":134,"_17":52,"_53":24,"_55":135,"_57":58,"_59":-5,"_105":275,"_18":276},{"_37":123,"_13":124,"_40":125,"_42":-5,"_44":45,"_46":66,"_48":49,"_50":126,"_17":52,"_53":24,"_55":127,"_57":58,"_59":-5,"_105":273,"_18":274},{"_37":115,"_13":116,"_40":117,"_42":-5,"_44":45,"_46":118,"_48":49,"_50":119,"_17":52,"_53":24,"_55":120,"_57":58,"_59":-5,"_105":271,"_18":272},{"_37":108,"_13":109,"_40":110,"_42":-5,"_44":45,"_46":83,"_48":49,"_50":111,"_17":52,"_53":24,"_55":112,"_57":58,"_59":-5,"_105":269,"_18":270},{"_37":98,"_13":99,"_40":100,"_42":-5,"_44":45,"_46":101,"_48":49,"_50":102,"_17":103,"_53":54,"_55":104,"_57":58,"_59":-5,"_105":267,"_18":268},[],[99],[],[109],[],[116],[],[124],[],[131],[],[139],[],[19,39],[],[19,62],[],[19,71],[],[19,79],[257,258,259,260],[19],["D",1763958026076],{"_11":12,"_218":214},{"_11":12,"_212":-5,"_213":214,"_175":176,"_215":216,"_217":58},{"_17":73,"_13":16,"_37":45,"_204":165,"_205":-5,"_206":-5,"_207":-5,"_208":-5,"_209":-5,"_210":14,"_211":12},"ctx",{"_197":-5,"_235":326,"_327":328,"_329":330,"_331":58,"_332":58,"_333":58,"_334":49,"_335":-5,"_336":-7,"_337":-7,"_338":52,"_339":58,"_340":58,"_341":-5,"_342":58,"_343":58,"_344":58,"_345":-5},"ENV",{"_297":298,"_299":300,"_301":16,"_302":303,"_304":305,"_306":307,"_308":309,"_310":311,"_312":313,"_314":315,"_316":317,"_318":319,"_320":321,"_322":323,"_324":325},"REACT_APP_SENTRY_DSN","https://586020d86f05489db63a554690acf1e9@o1398359.ingest.sentry.io/6724499","RENDER_GIT_COMMIT","81405aa0531e90dfbb71a5bf473aaa0cf4c8702f","RENDER_GIT_BRANCH","POSTHOG_API_TOKEN","phc_nmoyuAkStEZuUp69rYlg1DZgrIt19Gx0Y4Hwf8tGgJP","POSTHOG_API_HOST","https://wart.val.town","WEB_API_TEMPLATE","https://{val}.web.val.run","APP_URL","https://www.val.town","MODULE_URL","https://esm.town","VANITY_WEB_API_TEMPLATE","https://{label}.val.run/","DENOLS_URL","https://lsp.val.town","NODE_ENV","production","CLOUDFLARE_TURNSTILE_SITE_KEY","0x4AAAAAACtaIZJH7s9rBMZ6","GOOGLE_CLIENT_ID","875989696899-jtsqkhlbdv5jrlsk8631p7ipjg3c6o62.apps.googleusercontent.com","STRIPE_PUBLISHABLE_KEY","pk_live_51N2zvWEpZTTLipIkVEwXrUG9AT0yeOOEYxszarZT1jpsZV58Ly6wlg3SltZpHN26CUalOBmUSY7adQRQiSkCZz2500qSXNkf8Y","API_URL","https://api.val.town",[],"preferencesKeybindings","default","preferencesTheme","light","preferencesFixers","preferencesCopilot","preferencesSelectionAi","preferencesCloseBrackets","preferencesChatPanelState","preferencesDprint","preferencesDenofmt","notificationCount","flagDenols","isBusinessOrgMember","businessOrgHandle","isBusinessOrgAdmin","isHigherTownieTier","navCollapsed","currentOrgId"]