neoorm 0.6.2 → 0.6.3

package/dist/runtime/sqlite-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sqlite-error.js","sourceRoot":"","sources":["../../src/runtime/sqlite-error.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAO5C,MAAM,UAAU,aAAa,CAAC,GAAY;IACzC,IAAI,CAAC,CAAC,GAAG,YAAY,KAAK,CAAC,EAAE,CAAC;QAC7B,OAAO,KAAK,CAAC;IACd,CAAC;IACD,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;IAC5B,OAAO,CACN,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC;QAC3B,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAC;QACrC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC;QACjC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAClC,CAAC;AACH,CAAC;AAED,MAAM,qBAAqB,GAAG;IAC7B,gBAAgB;IAChB,iBAAiB;IACjB,gCAAgC;CAChC,CAAC;AAEF,MAAM,UAAU,0BAA0B,CAAC,OAAe;IACzD,OAAO,qBAAqB,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;AACvE,CAAC;AAED,SAAS,kBAAkB,CAC1B,QAAkB,EAClB,OAA2B;IAE3B,IAAI,CAAC,OAAO;QAAE,OAAO,SAAS,CAAC;IAC/B,OAAO,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,CACzC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,KAAK,OAAO,CACpC,CAAC;AACH,CAAC;AAED,SAAS,qBAAqB,CAAC,OAAe;IAK7C,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAC3B,0CAA0C,CAC1C,CAAC;IACF,IAAI,MAAM,EAAE,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9B,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;IAChE,CAAC;IAED,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,CAC5B,4CAA4C,CAC5C,CAAC;IACF,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;QAChC,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;IACpE,CAAC;IAED,IAAI,gCAAgC,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QACpD,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC;IAChC,CAAC;IAED,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC;IACtD,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAClB,OAAO,EAAE,IAAI,EAAE,eAAe,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;IACrD,CAAC;IAED,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC;IACxD,IAAI,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACnB,OAAO,EAAE,IAAI,EAAE,gBAAgB,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;IACxD,CAAC;IAED,OAAO,EAAE,CAAC;AACX,CAAC;AAED,SAAS,iBAAiB,CAAC,OAAe,EAAE,MAAgD;IAC3F,QAAQ,MAAM,CAAC,IAAI,EAAE,CAAC;QACrB,KAAK,QAAQ;YACZ,OAAO,MAAM,CAAC,MAAM;gBACnB,CAAC,CAAC,kDAAkD,MAAM,CAAC,MAAM,GAAG;gBACpE,CAAC,CAAC,4CAA4C,CAAC;QACjD,KAAK,UAAU;YACd,OAAO,MAAM,CAAC,MAAM;gBACnB,CAAC,CAAC,yBAAyB,MAAM,CAAC,MAAM,gCAAgC;gBACxE,CAAC,CAAC,yCAAyC,CAAC;QAC9C,KAAK,aAAa;YACjB,OAAO,+BAA+B,CAAC;QACxC,KAAK,eAAe;YACnB,OAAO,MAAM,CAAC,KAAK;gBAClB,CAAC,CAAC,UAAU,MAAM,CAAC,KAAK,kBAAkB;gBAC1C,CAAC,CAAC,sBAAsB,CAAC;QAC3B,KAAK,gBAAgB;YACpB,OAAO,MAAM,CAAC,MAAM;gBACnB,CAAC,CAAC,WAAW,MAAM,CAAC,MAAM,kBAAkB;gBAC5C,CAAC,CAAC,uBAAuB,CAAC;QAC5B;YACC,OAAO,OAAO,CAAC;IACjB,CAAC;AACF,CAAC;AAED,SAAS,kBAAkB,CAAC,MAAgD;IAC3E,QAAQ,MAAM,CAAC,IAAI,EAAE,CAAC;QACrB,KAAK,QAAQ;YACZ,OAAO,yBAAyB,CAAC;QAClC,KAAK,UAAU;YACd,OAAO,2BAA2B,CAAC;QACpC,KAAK,aAAa;YACjB,OAAO,8BAA8B,CAAC;QACvC,KAAK,eAAe;YACnB,OAAO,sBAAsB,CAAC;QAC/B,KAAK,gBAAgB;YACpB,OAAO,uBAAuB,CAAC;QAChC;YACC,OAAO,cAAc,CAAC;IACxB,CAAC;AACF,CAAC;AAED,SAAS,oBAAoB,CAC5B,MAAgD,EAChD,KAAgC,EAChC,YAAqB;IAErB,MAAM,WAAW,GAAa,EAAE,CAAC;IAEjC,QAAQ,MAAM,CAAC,IAAI,EAAE,CAAC;QACrB,KAAK,UAAU;YACd,IAAI,YAAY,EAAE,CAAC;gBAClB,WAAW,CAAC,IAAI,CACf,YAAY,YAAY,0BAA0B,CAClD,CAAC;gBACF,MAAM,GAAG,GAAG,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,YAAY,CAAC,CAAC;gBAClE,IAAI,GAAG,EAAE,IAAI,KAAK,IAAI,IAAI,GAAG,CAAC,QAAQ,KAAK,KAAK,EAAE,CAAC;oBAClD,WAAW,CAAC,IAAI,CACf,mEAAmE,CACnE,CAAC;gBACH,CAAC;YACF,CAAC;iBAAM,CAAC;gBACP,WAAW,CAAC,IAAI,CACf,iEAAiE,CACjE,CAAC;YACH,CAAC;YACD,MAAM;QACP,KAAK,QAAQ;YACZ,WAAW,CAAC,IAAI,CACf,oDAAoD,CACpD,CAAC;YACF,WAAW,CAAC,IAAI,CACf,0DAA0D,CAC1D,CAAC;YACF,MAAM;QACP,KAAK,aAAa;YACjB,WAAW,CAAC,IAAI,CAAC,0CAA0C,CAAC,CAAC;YAC7D,WAAW,CAAC,IAAI,CACf,yEAAyE,CACzE,CAAC;YACF,WAAW,CAAC,IAAI,CACf,4DAA4D,CAC5D,CAAC;YACF,MAAM;QACP,KAAK,eAAe;YACnB,WAAW,CAAC,IAAI,CACf,sEAAsE,CACtE,CAAC;YACF,WAAW,CAAC,IAAI,CACf,2EAA2E,CAC3E,CAAC;YACF,MAAM;QACP,KAAK,gBAAgB;YACpB,WAAW,CAAC,IAAI,CACf,uEAAuE,CACvE,CAAC;YACF,IAAI,YAAY,IAAI,KAAK,EAAE,CAAC;gBAC3B,WAAW,CAAC,IAAI,CACf,uCAAuC,YAAY,qBAAqB,CACxE,CAAC;YACH,CAAC;YACD,WAAW,CAAC,IAAI,CACf,2EAA2E,CAC3E,CAAC;YACF,MAAM;QACP;YACC,MAAM;IACR,CAAC;IAED,OAAO,WAAW,CAAC;AACpB,CAAC;AAED,MAAM,UAAU,iBAAiB,CAChC,GAAoB,EACpB,QAAkB,EAClB,IAEC;IAED,MAAM,MAAM,GAAG,qBAAqB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAClD,MAAM,KAAK,GACV,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACtE,kBAAkB,CAAC,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;IAE5C,IAAI,YAAgC,CAAC;IACrC,IAAI,aAAiC,CAAC;IACtC,IAAI,MAAM,CAAC,MAAM,IAAI,KAAK,EAAE,CAAC;QAC5B,MAAM,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC;QACnE,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC;QAC9B,YAAY,GAAG,GAAG,EAAE,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC;IAC7C,CAAC;IAED,MAAM,IAAI,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;IACxC,MAAM,OAAO,GAAsB;QAClC,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,KAAK,EAAE,SAAS;QAChB,GAAG,EAAE,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC;QAC1B,MAAM,EAAE,iBAAiB,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC;QAC9C,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACvC,CAAC;IAEF,MAAM,aAAa,GAAG,IAAI,CAAC,aAAa,IAAI,KAAK,EAAE,QAAQ,CAAC;IAC5D,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;QACjC,OAAO,CAAC,aAAa,GAAG,aAAa,CAAC;IACvC,CAAC;IAED,MAAM,YAAY,GAAG,KAAK,EAAE,OAAO,IAAI,MAAM,CAAC,KAAK,CAAC;IACpD,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;QAChC,OAAO,CAAC,YAAY,GAAG,YAAY,CAAC;IACrC,CAAC;IAED,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;QAChC,OAAO,CAAC,YAAY,GAAG,YAAY,CAAC;IACrC,CAAC;IAED,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;QACjC,OAAO,CAAC,aAAa,GAAG,aAAa,CAAC;IACvC,CAAC;IAED,MAAM,WAAW,GAAG,oBAAoB,CAAC,MAAM,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC;IACtE,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5B,OAAO,CAAC,WAAW,GAAG,WAAW,CAAC;IACnC,CAAC;IAED,IAAI,0BAA0B,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACnE,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IACvB,CAAC;IAED,OAAO,OAAO,CAAC;AAChB,CAAC"}

package/docs/cli.md

@@ -0,0 +1,107 @@
+# CLI reference
+
+## `neoorm init`
+
+Scaffold a new NeoOrm project.
+
+```
+neoorm init [options]
+```
+
+Creates `neoorm.config.ts`, `schema.ts`, and `.env.example` only — no codegen or migrations. Run `neoorm migrate dev` afterwards to generate the client and first migration.
+
+Options:
+- `--provider <provider>` — `postgresql` (default) or `sqlite`. If omitted and running interactively, prompts to choose.
+- `--database-url <url>` — override database URL / file path (default: `postgresql://postgres:postgres@localhost:5432/myapp` for postgres, `./dev.db` for sqlite)
+- `--schema <path>` — schema file path (default: `./schema.ts`)
+- `--out <dir>` — generated output directory (default: `./neoorm`)
+- `--force` — overwrite existing scaffold files
+
+## `neoorm generate`
+
+Generate manifest, typed client, models, includes, and migrations from your schema.
+
+```
+neoorm generate [options]
+```
+
+Options:
+- `--accept-data-loss` — include destructive DDL changes (column drops, type changes)
+
+## `neoorm migrate dev`
+
+Apply pending migrations, then generate a new migration if the schema changed.
+
+```
+neoorm migrate dev
+```
+
+## `neoorm migrate deploy`
+
+Apply all pending migrations.
+
+```
+neoorm migrate deploy
+```
+
+## `neoorm migrate status`
+
+List applied vs pending migrations.
+
+```
+neoorm migrate status
+```
+
+Shows timestamps, pending folders on disk, and warnings for applied migrations missing on disk.
+
+## `neoorm migrate down`
+
+Roll back the most recently applied migration(s).
+
+```
+neoorm migrate down [--steps N]
+```
+
+- `--steps` — number of migrations to roll back (default: 1)
+
+Requires `down.sql` and `snapshot.before.json` in each migration folder (written automatically by `neoorm generate` and `neoorm migrate dev`).
+
+## `neoorm migrate reset`
+
+Drop the `public` schema (PostgreSQL) or all tables (SQLite) and re-apply all migrations.
+
+```
+neoorm migrate reset --force [--skip-apply]
+```
+
+- `--force` — required (safety guard)
+- `--skip-apply` — only drop, don't re-apply
+
+## `neoorm docs`
+
+Serve the NeoOrm documentation locally in your browser.
+
+```
+neoorm docs [options]
+```
+
+Options:
+- `-p, --port <port>` — port to listen on (default: `7583`)
+- `-H, --host <host>` — host to bind (default: `127.0.0.1`)
+- `--open` — open the docs site in your default browser
+
+## `neoorm db push`
+
+Push the current snapshot schema to the database without going through the migration ledger.
+
+```
+neoorm db push
+```
+
+## `neoorm db pull`
+
+Introspect the database and write a schema file.
+
+```
+neoorm db pull
+```

package/docs/configuration.md

@@ -0,0 +1,51 @@
+# Configuration
+
+The `neoorm.config.ts` file configures schema location, output directory, and datasource.
+
+```ts
+// neoorm.config.ts
+import { defineConfig } from "neoorm";
+
+export default defineConfig({
+  schema: "./schema.ts",
+  out: "./neoorm",
+  datasource: {
+    provider: "postgresql",
+    url: process.env.DATABASE_URL!,
+    schema: "public",
+    enum: "check",
+  },
+});
+```
+
+## Options
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| `schema` | `string` | required | Path to the schema file |
+| `out` | `string` | required | Output directory for generated files |
+| `datasource.provider` | `"postgresql" \| "sqlite"` | required | Database provider |
+| `datasource.url` | `string` | required | Connection string (PostgreSQL) or database file path / `:memory:` (SQLite) |
+| `datasource.schema` | `string` | `"public"` | PostgreSQL schema for migrations and queries (SQLite: not applicable) |
+| `datasource.enum` | `"check" \| "union" \| "native"` | `"check"` | How to store enum columns |
+
+### SQLite
+
+Set `provider: "sqlite"` and `url` to a file path or `":memory:"`:
+
+```ts
+datasource: {
+  provider: "sqlite",
+  url: "./dev.db",
+},
+```
+
+`datasource.schema` and `datasource.enum: "native"` are PostgreSQL-only and ignored on SQLite. See [SQLite](sqlite.md).
+
+### Enum modes
+
+| Mode | SQL | DB enforcement |
+|------|-----|----------------|
+| `check` (default) | `TEXT` + `CHECK (...)` | yes |
+| `union` | `TEXT` | no (TypeScript union only) |
+| `native` | Postgres `CREATE TYPE ... AS ENUM` | yes (PostgreSQL only) |

package/docs/errors.md

@@ -0,0 +1,72 @@
+# Common errors
+
+NeoOrm surfaces structured errors with explanations and fix suggestions. Catch them programmatically or read the CLI output after `neoorm generate` / query failures.
+
+## Error types
+
+- **`NeoOrmSchemaError`** — schema compilation (`neoorm generate`) or migration failures
+- **`NeoOrmQueryError`** — query builder mistakes (compile phase) or database runtime failures
+
+Both expose a `.context` object with `detail`, optional `code`, and `suggestions: string[]`.
+
+```ts
+import { NeoOrmQueryError, NeoOrmSchemaError } from "neoorm";
+
+try {
+  await db.users.create({ data: { email: "a@b.com" } });
+} catch (err) {
+  if (err instanceof NeoOrmQueryError) {
+    console.error(err.message);
+    console.error(err.context.suggestions);
+  }
+}
+```
+
+## Schema: use accessors, not SQL names
+
+Foreign keys and `manyToMany()` targets refer to **schema accessors** (the keys in `defineSchema({ ... })`), not SQL table names.
+
+```ts
+// Wrong — "server_members" is the SQL table name
+userId: fk("server_members")
+
+// Right — "serverMembers" is the accessor
+userId: fk("serverMembers")
+```
+
+If you see `Foreign key references unknown table accessor "server_members"`, check the suggestions block for the correct camelCase accessor.
+
+## Queries: use TypeScript column names
+
+Filters, `select`, `omit`, `orderBy`, and `groupBy` use **TypeScript property names** from your schema, not SQL `snake_case` names.
+
+```ts
+// Wrong
+db.users.findMany({ where: { created_at: { gt: date } } });
+
+// Right
+db.users.findMany({ where: { createdAt: { gt: date } } });
+```
+
+## Schema drift
+
+Runtime errors like missing tables/columns often mean the database is behind your schema:
+
+1. Run `neoorm migrate dev` (or `neoorm migrate deploy` in production)
+2. Regenerate the client with `neoorm generate`
+
+`NeoOrmQueryError` may include a **Migration** line with pending migration info when schema drift is detected.
+
+## After changing the schema
+
+Always regenerate after editing `schema.ts`:
+
+```bash
+neoorm generate
+```
+
+If migrations are enabled, create and apply them:
+
+```bash
+neoorm migrate dev
+```