@remix-run/cli 0.0.0 → 0.2.0

package/bootstrap/.agents/skills/remix/references/create-mixins.md

@@ -0,0 +1,158 @@
+# Creating Mixins
+
+## What This Covers
+
+How to author your own reusable host-element behavior with `createMixin`. Read this when the task
+involves:
+
+- Combining multiple low-level events or DOM hooks into one semantic mixin
+- Dispatching custom DOM events from a host node
+- Encapsulating imperative DOM setup that several components share
+- Typing custom events on `HTMLElementEventMap` for use with `on(...)`
+
+For the built-in mixins most code should use, see `mixins-styling-events.md`.
+
+Use `createMixin` from `remix/ui` to author reusable host-element behavior.
+
+Most app code should use built-in core mixins (`on`, `css`, `ref`, `link`, `attrs`) and animation
+mixins from `remix/ui/animation`. Create custom mixins when combining multiple low-level events
+into one semantic event, or when the pattern is reused across components.
+
+## Core Semantics
+
+1. A mixin handle is tied to one mounted host node lifecycle.
+2. `insert` is the host-node availability point for imperative setup.
+3. `remove` is teardown for that same lifecycle.
+4. `queueTask` runs post-commit and receives `(node, signal)` for mixins.
+5. Mixin render functions should stay pure; side effects belong in `insert`, `remove`, or queued
+   work.
+
+```tsx
+import { createMixin } from 'remix/ui'
+
+let myMixin = createMixin<HTMLElement>((handle) => {
+  handle.addEventListener('insert', (event) => {
+    // event.node is the mounted host node
+  })
+
+  handle.addEventListener('remove', () => {
+    // Clean up listeners, timers, observers
+  })
+
+  return (props) => {
+    handle.queueTask((node) => {
+      // Post-commit work that needs the concrete host node
+    })
+    return <handle.element {...props} />
+  }
+})
+```
+
+## Patterns
+
+### Pure prop transform
+
+```tsx
+let withTitle = createMixin((handle) => (title: string, props: { title?: string }) => (
+  <handle.element {...props} title={title} />
+))
+```
+
+### Lifecycle-managed imperative setup
+
+```tsx
+let withFocus = createMixin<HTMLElement>((handle) => {
+  handle.addEventListener('insert', (event) => {
+    event.node.focus()
+  })
+  return (props) => <handle.element {...props} />
+})
+```
+
+## Custom Event Mixins
+
+Create event mixins when you combine multiple low-level events into one semantic custom event that
+is reused across components.
+
+1. Namespace custom event names (`myapp:*`) to avoid collisions.
+2. Extend `Event` with the data consumers need.
+3. Declare the event on `HTMLElementEventMap` for type safety with `on(...)`.
+4. Dispatch from the host node inside the mixin.
+
+```tsx
+import { createMixin, on } from 'remix/ui'
+
+export let dragReleaseType = 'myapp:drag-release' as const
+
+declare global {
+  interface HTMLElementEventMap {
+    [dragReleaseType]: DragReleaseEvent
+  }
+}
+
+export class DragReleaseEvent extends Event {
+  velocityX: number
+  velocityY: number
+  constructor(init: { velocityX: number; velocityY: number }) {
+    super(dragReleaseType, { bubbles: true, cancelable: true })
+    this.velocityX = init.velocityX
+    this.velocityY = init.velocityY
+  }
+}
+
+export let dragRelease = createMixin<HTMLElement>((handle) => {
+  let node: HTMLElement | undefined
+  let tracking = false
+  let velocityX = 0
+  let velocityY = 0
+  let lastX = 0
+  let lastY = 0
+  let lastT = 0
+
+  handle.addEventListener('insert', (event) => {
+    node = event.node
+  })
+
+  return () => (
+    <handle.element
+      mix={[
+        on('pointerdown', (event) => {
+          if (!event.isPrimary) return
+          tracking = true
+          lastX = event.clientX
+          lastY = event.clientY
+          lastT = event.timeStamp
+          node?.setPointerCapture(event.pointerId)
+        }),
+        on('pointermove', (event) => {
+          if (!tracking) return
+          let dt = Math.max(1, event.timeStamp - lastT)
+          velocityX = (event.clientX - lastX) / dt
+          velocityY = (event.clientY - lastY) / dt
+          lastX = event.clientX
+          lastY = event.clientY
+          lastT = event.timeStamp
+        }),
+        on('pointerup', () => {
+          if (!tracking) return
+          tracking = false
+          node?.dispatchEvent(new DragReleaseEvent({ velocityX, velocityY }))
+        }),
+      ]}
+    />
+  )
+})
+```
+
+Consume it:
+
+```tsx
+<div
+  mix={[
+    dragRelease(),
+    on(dragReleaseType, (event) => {
+      console.log('velocity:', event.velocityX, event.velocityY)
+    }),
+  ]}
+/>
+```

package/bootstrap/.agents/skills/remix/references/data-and-validation.md

@@ -0,0 +1,363 @@
+# Data Access and Validation
+
+## What This Covers
+
+How input becomes a value the app trusts, and how that value reaches storage. Read this when the
+task involves:
+
+- Defining database tables, columns, relations, and migrations
+- Querying or mutating persisted data with `Database`
+- Parsing and validating user input from forms, query strings, or external payloads
+- Choosing between schema-level checks, table validation hooks, and migration-level constraints
+
+For where validation runs in the request lifecycle, see `routing-and-controllers.md`. For session
+or identity-bound writes, see `auth-and-sessions.md`.
+
+## Table Definitions (`remix/data-table`)
+
+Define tables with typed columns, relations, and optional validation hooks:
+
+```typescript
+import { belongsTo, column as c, hasMany, table } from 'remix/data-table'
+import type { TableRow, TableRowWith } from 'remix/data-table'
+
+export const books = table({
+  name: 'books',
+  columns: {
+    id: c.integer().primaryKey().autoIncrement(),
+    slug: c.text().notNull().unique(),
+    title: c.text().notNull(),
+    author: c.text().notNull(),
+    price: c.decimal(10, 2).notNull(),
+    genre: c.text().notNull(),
+    in_stock: c.boolean(),
+  },
+})
+
+export const orders = table({
+  name: 'orders',
+  columns: {
+    id: c.integer().primaryKey().autoIncrement(),
+    user_id: c.integer().notNull().references('users', 'id'),
+    total: c.decimal(10, 2).notNull(),
+    created_at: c.integer().notNull(),
+  },
+  relations: {
+    user: belongsTo('users', 'user_id'),
+    items: hasMany('order_items', 'order_id'),
+  },
+})
+
+export type Book = TableRow<typeof books>
+export type Order = TableRow<typeof orders>
+export type OrderWithItems = TableRowWith<typeof orders, 'items'>
+```
+
+### Column types
+
+| Method                        | SQL type           |
+| ----------------------------- | ------------------ |
+| `c.integer()`                 | INTEGER            |
+| `c.text()`                    | TEXT               |
+| `c.boolean()`                 | BOOLEAN            |
+| `c.decimal(precision, scale)` | DECIMAL            |
+| `c.enum([...])`               | TEXT (string enum) |
+| `c.uuid()`                    | UUID / TEXT        |
+| `c.varchar(length)`           | VARCHAR            |
+
+Column modifiers: `.primaryKey()`, `.autoIncrement()`, `.notNull()`, `.unique()`,
+`.references(table, column, fkName?)`, `.onDelete(action)`, `.default(value)`.
+
+Composite primary keys go on the table option, not the column: `primaryKey: ['order_id', 'book_id']`.
+
+### Schema vs migrations
+
+Column modifiers describe SQL constraints — the source of truth for them is your **migration**
+files, where they generate the actual DDL. Runtime `table(...)` definitions in `app/data/schema.ts`
+can use the same modifiers, or they can stay minimal (`c.integer()`, `c.text()`, ...) since the
+runtime only needs the column shape and validation hooks. Two valid patterns:
+
+- **Modifiers in both** — schema and migrations stay in sync visually; useful when you want
+  schema-level docs.
+- **Bare columns in schema, full modifiers in migrations** — schema describes what the app reads
+  and writes; migrations own the DDL and constraints.
+
+Pick one and apply it consistently across the app.
+
+### Table validation hooks
+
+Tables can define `validate`, `beforeWrite`, and `afterRead` hooks:
+
+```typescript
+export const books = table({
+  name: 'books',
+  columns: {
+    /* ... */
+  },
+  validate({ operation, value }) {
+    let issues = []
+    if (operation === 'create' && !value.slug) {
+      issues.push({ message: 'Slug is required.', path: ['slug'] })
+    }
+    return issues.length > 0 ? { issues } : { value }
+  },
+})
+```
+
+## Database Setup
+
+Create a database with an adapter and expose it via middleware:
+
+```typescript
+import BetterSqlite3 from 'better-sqlite3'
+import { createDatabase, Database } from 'remix/data-table'
+import { createSqliteDatabaseAdapter } from 'remix/data-table-sqlite'
+
+let sqlite = new BetterSqlite3('./db/app.db')
+sqlite.pragma('foreign_keys = ON')
+let adapter = createSqliteDatabaseAdapter(sqlite)
+export let db = createDatabase(adapter)
+```
+
+`createSqliteDatabaseAdapter` accepts synchronous SQLite clients with a shared `prepare`/`exec`
+surface, including Node's `node:sqlite`, Bun's `bun:sqlite`, and compatible clients. Use whichever
+client fits the runtime instead of assuming `better-sqlite3` is required.
+
+### Database middleware
+
+```typescript
+import type { Middleware } from 'remix/fetch-router'
+import { Database } from 'remix/data-table'
+
+export function loadDatabase(): Middleware {
+  return async (context, next) => {
+    context.set(Database, db)
+    return next()
+  }
+}
+```
+
+### Querying
+
+```typescript
+let db = get(Database)
+
+// Find by primary key
+let book = await db.find(books, id)
+
+// Find one by condition
+let user = await db.findOne(users, { where: { email } })
+
+// Find many with ordering
+let allBooks = await db.findMany(books, { orderBy: ['id', 'asc'] })
+
+// Count
+let total = await db.count(orders, { where: { user_id: userId } })
+
+// Query builder
+let genres = await db.query(books).select('genre').distinct().orderBy('genre', 'asc').all()
+
+// Create
+let newBook = await db.create(books, { slug: 'new-book', title: 'New Book' /* ... */ })
+
+// Update
+await db.update(books, bookId, { title: 'Updated Title' })
+
+// Delete
+await db.delete(books, bookId)
+```
+
+### Operators
+
+```typescript
+import { inList } from 'remix/data-table/operators'
+
+let featured = await db.findMany(books, {
+  where: inList('slug', ['book-a', 'book-b', 'book-c']),
+})
+```
+
+## Migrations
+
+### Writing migrations
+
+```typescript
+import { column as c, createMigration } from 'remix/data-table/migrations'
+import { table } from 'remix/data-table'
+
+export default createMigration({
+  async up({ schema }) {
+    let users = table({
+      name: 'users',
+      columns: {
+        id: c.integer().primaryKey().autoIncrement(),
+        email: c.text().notNull().unique(),
+        name: c.text().notNull(),
+      },
+    })
+    await schema.createTable(users)
+    await schema.createIndex(users, 'email', { name: 'users_email_idx', unique: true })
+  },
+
+  async down({ schema }) {
+    await schema.dropTable('users')
+  },
+})
+```
+
+Migrations can also import table definitions from the app schema to avoid duplication:
+
+```typescript
+import { createMigration } from 'remix/data-table/migrations'
+import { users, authAccounts } from '../../app/data/schema.ts'
+
+export default createMigration({
+  async up({ schema }) {
+    await schema.createTable(users)
+    await schema.createTable(authAccounts)
+  },
+})
+```
+
+### Running migrations
+
+```typescript
+import { createMigrationRunner } from 'remix/data-table/migrations'
+import { loadMigrations } from 'remix/data-table/migrations/node'
+
+let migrations = await loadMigrations('./db/migrations')
+let runner = createMigrationRunner(adapter, migrations)
+await runner.up()
+```
+
+### Migration file naming
+
+Name migration files with a timestamp prefix: `20260228090000_create_users.ts`. Place them in
+`db/migrations/`.
+
+## Input Validation (`remix/data-schema`)
+
+Use `data-schema` to validate user input (forms, query params, API payloads). This is separate from
+table-level `validate` hooks which run at persistence.
+
+### Schema builders
+
+```typescript
+import * as s from 'remix/data-schema'
+import { email, minLength, maxLength } from 'remix/data-schema/checks'
+
+let userSchema = s.object({
+  name: s.string().pipe(minLength(1)),
+  email: s.string().pipe(email()),
+  age: s.optional(s.number()),
+})
+
+let result = s.parse(userSchema, data)
+```
+
+### FormData validation
+
+Use `remix/data-schema/form-data` to validate `FormData` directly:
+
+```typescript
+import * as s from 'remix/data-schema'
+import * as f from 'remix/data-schema/form-data'
+import { email, minLength } from 'remix/data-schema/checks'
+
+let signupSchema = f.object({
+  name: f.field(s.string().pipe(minLength(1))),
+  email: f.field(s.string().pipe(email())),
+  password: f.field(s.string().pipe(minLength(8))),
+})
+
+// In a controller action:
+let formData = get(FormData)
+let { name, email, password } = s.parse(signupSchema, formData)
+```
+
+### Reading FormData: middleware vs `request.formData()`
+
+There are two ways to get a `FormData` value inside an action.
+
+The recommended way: register `formData()` middleware in the root stack and read with
+`get(FormData)`. The body is parsed once per request, and the typed `FormData` value flows through
+the context system. This also lets `methodOverride()` and CSRF middleware work uniformly.
+
+```typescript
+import { formData } from 'remix/form-data-middleware'
+
+let router = createRouter({
+  middleware: [, /* ... */ formData() /* ... */],
+})
+
+// In an action:
+let parsed = s.parseSafe(signupSchema, get(FormData))
+```
+
+The fallback: `await request.formData()` directly. This works without middleware and is fine for
+small one-off cases, but it bypasses the context system, runs once per call site, and doesn't
+compose with middleware that depends on parsed form fields.
+
+### Safe parsing
+
+`s.parse` throws on invalid input. `s.parseSafe` returns a tagged result and is usually what an
+action wants, since validation failure is an expected outcome (re-render the form with errors)
+rather than an exception:
+
+```typescript
+let result = s.parseSafe(signupSchema, get(FormData))
+if (!result.success) {
+  return render(<SignupPage errors={result.issues} />, { status: 400 })
+}
+let { name, email, password } = result.value
+```
+
+Returning a `Response` for validation failures keeps the route contract honest: the same action
+returns 200 on success, 400 with errors on bad input, no out-of-band exception flow.
+
+### Transforming validated output
+
+Use `.transform(...)` when a schema should validate one shape but return another value or output
+type. Transforms run after validation and compose with `.pipe(...)` and `.refine(...)`:
+
+```typescript
+import * as coerce from 'remix/data-schema/coerce'
+
+let slugSchema = s
+  .string()
+  .pipe(minLength(1))
+  .transform((value) => value.trim().toLowerCase().replace(/\s+/g, '-'))
+
+let pageSchema = f.object({
+  page: f.field(s.defaulted(coerce.coerceNumber(), 1).refine(Number.isInteger)),
+  q: f.field(s.defaulted(s.string(), '').transform((value) => value.trim())),
+})
+
+let { page, q } = s.parse(pageSchema, formData)
+```
+
+### Anti-patterns
+
+Avoid these shapes when reading and validating input:
+
+- **Raw `formData.get('name')` plus an `if (typeof name !== 'string')` guard**, then a thrown
+  custom error. This reinvents what `data-schema` already does, loses the typed result, and
+  pushes error translation into a `try/catch` instead of a return value.
+- **Letting route-local domain errors leak out of the action.** Translate expected outcomes (bad
+  input, missing record, duplicate entry) into the `Response` the route means to return instead of
+  throwing a custom `Error` subclass with a `status` field and catching it later.
+- **Trusting `params`, query strings, or external payloads without a schema.** Anything that
+  crosses a trust boundary should be parsed before it reaches business logic.
+
+### Common patterns
+
+```typescript
+// Optional with default
+let limitSchema = f.field(s.defaulted(s.string(), '10'))
+
+// Union types
+let methodSchema = s.union([s.literal('credentials'), s.literal('google'), s.literal('github')])
+
+// Refinements
+let idSchema = s.number().refine(Number.isInteger, 'Expected an integer')
+```