@rowstile/next 0.1.0-alpha.5 → 0.1.0-alpha.7

package/README.md

@@ -1,83 +1,86 @@
-# rowstile for TypeScript
+# @rowstile/next
 
-The SDK for TypeScript apps on a rowstile policy: every transaction signs in as whoever the request
-or the job acts for, refused writes become a 403 with the database's reason, rows the user can't see a 404,
-signed-in reads stay out of Next.js's caches, and the app refuses to start on a connection that skips
-row-level security. It holds no rowstile logic: it calls the `authz.*` functions the policy made, and
-translates their answers.
+[rowstile](https://rowstile.dev) is a policy language for PostgreSQL. You write who may see and change each
+row in one file, and it becomes row-level security: the database filters every read and refuses every write
+the rules don't allow, whatever the code asks.
 
-Next.js with Prisma:
+This package is rowstile for Next.js (App Router). Importing it keeps signed-in reads out of Next's caches.
+`route(handler)` answers a refusal with 403 and a hidden row with 404 (and what a call names that isn't there
+404, a missing or wrong argument 400, a call that needs someone signed in 401, a move inside itself 409).
+`action(fn)` gives a server action's
+refusal back as a value. `authzRoutes()` is what the React kit calls, and `checkAtStart()` stops a server
+whose connection skips row-level security. It goes with a driver package, most often `@rowstile/prisma`.
+
+```sh
+# @next on each while only an alpha is published: a plain install gets an older one
+npm install @rowstile/next@next @rowstile/prisma@next
+npm install --save-dev rowstile@next      # the command: rowstile dev, rowstile migrate
+```
+
+A route handler with no checks: a hidden note is 404, one the user may not edit 403 with the reason.
 
 ```ts
-// src/db.ts
-import { PrismaPg } from "@prisma/adapter-pg";
-import { authz, signedIn } from "@rowstile/prisma";
-import "@rowstile/next";                         // signed-in reads never land in a cache
-import "./authz.gen";                            // the policy's names (rowstile client)
-
-const adapter = signedIn(new PrismaPg({ connectionString: process.env.DATABASE_URL }),
-                         { user: async () => (await auth())?.user.id });
-export const db = new PrismaClient({ adapter }).$extends(authz());
+import { route } from "@rowstile/next";
+import { db } from "@/db";
+
+type Params = { params: Promise<{ id: string }> };
+
+export const PATCH = route(async (req: Request, { params }: Params) => {
+  const id = Number((await params).id);
+  const { body } = (await req.json()) as { body: string };
+  await db.note.update({ where: { id }, data: { body } });
+  return Response.json({ id });
+});
 ```
 
+A server action: Next.js hides a thrown error's message, so the refusal comes back as `{ ok: false, problem }`.
+
 ```ts
-// app/api/folders/[id]/route.ts: no checks; a hidden folder is 404, one the user may not rename 403
-export const PATCH = route(async (req: Request, { params }: { params: Promise<{ id: string }> }) => {
-  await db.folder.update({ where: { id: Number((await params).id) }, data: await req.json() });
-  return Response.json({ ok: true });
+// app/actions.ts
+import { action } from "@rowstile/next";
+
+export const renameNote = action(async (id: number, body: string) => {
+  await db.note.update({ where: { id }, data: { body } });
+  return id;
 });
 ```
 
-| package | what |
+At start-up:
+
+```ts
+// instrumentation.ts
+import { checkAtStart } from "@rowstile/next";
+
+export async function register() {
+  if (process.env.NEXT_RUNTIME === "nodejs") await checkAtStart((await import("./src/db.ts")).db.$authz);
+}
+```
+
+## Good to know
+
+- Before a transaction signs in as someone, it calls Next's `connection()`: the render is dynamic, and a
+  signed-in read inside `"use cache"` or `unstable_cache` fails instead of being cached for the next user.
+  Reads as nobody may be cached.
+- `authzRoutes({ calls, changes })` in `app/api/authz/[...authz]/route.ts` serves `@rowstile/react`:
+  permissions for a list, shares, access requests, live updates.
+
+## More
+
+- [Next.js with Prisma](https://rowstile.dev/stacks/nextjs): the whole setup, step by step, from an app the tests run.
+- [The TypeScript SDK](https://rowstile.dev/sdk/typescript): every package, and the traps they handle.
+- [Getting started](https://rowstile.dev/getting-started): a first policy, step by step.
+- [Source and issues](https://github.com/rowstile/rowstile).
+
+The other packages:
+
+| package | for |
 |---|---|
-| `@rowstile/client` | `actingAs(who, fn)`, `job(who, fn)`, `current()`, `Refused`, `NotFound`, `NotSignedIn`, `translate(e)` and `problemResponse(e)` for any driver's error, `errorCode(e)` (rowstile's code: `AZ709`), `calls(queryable)` (the runtime's functions), the `Register` the generated names fill in |
-| `@rowstile/prisma` | `signedIn(adapter, { user })`: every transaction Prisma begins signs in; `authz()`: P2025 as `NotFound` or `Refused` with the reason, refused creates naming the rule, `db.$authz` (`can`, `ids`, `permsOf`, `share`, `check`, ...) |
-| `@rowstile/pg` | `authz(pool, { user })`: `transaction(fn)`, `query()`, the runtime's functions; `changes(pool)` for live updates |
-| `@rowstile/postgres` | `authz(sql, { user })`: `begin(fn)`, the runtime's functions |
-| `@rowstile/drizzle` | `withAuthz(db, { user })`: `transaction(fn)`; `inIds(column, type, perm)` and `ids()` for `where`; `expect(tx, result, ...)` for updates and deletes that changed nothing |
-| `@rowstile/next` | `route(handler)` (403 and 404 problem bodies), `action(fn)` (`{ ok, value }` or `{ ok: false, problem }`), `authzRoutes()` (what the React kit calls), `checkAtStart()` for `instrumentation.ts`; importing it keeps signed-in reads out of caches |
-| `@rowstile/react` | `<AuthzProvider>`, `usePerms(type, ids)` (one call for a list), `<Can>`, `useShares` and a headless `<ShareDialog>`, `useAccessRequest`; kept current over server-sent events |
-| `@rowstile/vitest` | `expect.extend(matchers)`: `toBeRefused(command, reason)`, `toBeNotFound()`; `asUser(who, fn)`; `databasePerWorker(url)`. Vitest 4 or 5 |
-
-Who a transaction acts for: `42` or `"42"` (a user), `["service", 3]` (another principal type of the policy),
-or `null` (nobody: only what `anyone` may see). A plain id is always a user's, whatever it holds: `"service:3"`
-is the user with that id, so an id from outside (a username, an identity provider's subject) can't name a
-service. `parsePrincipal("service:3")` reads back what `describe()` wrote, for text your own code wrote. Whoever the code acts for (`actingAs`, a `job`)
-comes first, else the `user` function, else nobody; a `who` given to one call (`transaction(fn, who)`) comes
-before all, and `null` there is nobody. Every transaction signs in, even as nobody, and nothing uses a
-session-level `SET`, so pools and poolers in transaction mode are safe; the change feed needs its own connection
-to Postgres ([Behind a pooler](../../docs/operations.md#behind-a-pooler)).
-
-Traps it handles:
-
-- **Next.js caching.** Before a transaction signs in as someone, `@rowstile/next` calls Next's `connection()`:
-  the render is dynamic, and a signed-in read inside `"use cache"` or `unstable_cache` fails instead of being
-  cached for the next user. Reads as nobody may be cached.
-- **Prisma answers some calls together.** It dispatches the `findUnique` calls of one tick, and array
-  transactions, from the first caller's context. `authz()` runs each `findUnique` in a transaction of its own,
-  and refuses `$transaction([...])` (use `$transaction(async (tx) => ...)`), so no query runs as someone else.
-  Use the client `$extends(authz())` returns, and only that one: the client it was made from is refused
-  whenever it is used, inside your own extensions too. An extension you add to the client `authz()` returns is
-  placed before it, so `authz()` stays the last one: each of your query hooks runs once for a call, and sees
-  the errors `authz()` makes (`Refused`, `NotFound`).
-- **Inserts that read the row back** (`RETURNING`, Prisma's `create`) also need the select rule: Postgres's own
-  message comes back as `Refused` naming the select rule.
-- **Prisma's promises are lazy**: `actingAs` and `job` await what they return inside their scope.
-- **A connection that drops.** node-postgres stops the process when a client that is checked out loses its
-  connection and nobody listens: `@rowstile/pg` listens while it holds one, so the transaction fails instead.
-  `changes(pool)` listens again after its connection drops, and tells its subscribers once.
-- **An update that changed nothing** is `NotFound` when the user can't see the row, `Refused` when the database
-  says no, and `NotFound` again when the rule allows it and the statement matched nothing for another reason
-  (a `where` with more than the key).
-- **The answers in the browser are one user's.** Give `<AuthzProvider user={id}>` if the user can change
-  without a page load: the hooks forget what they had and ask again.
-
-The types and permissions of the policy are generated names: with a `@rowstile/*` dependency in
-`package.json`, `rowstile client` writes only the names (`[clients] ts = "src/authz.gen.ts"`), registered with
-the SDK, so `db.$authz.can("note", 1, "edt")` doesn't type-check. Policy changes ship as migrations for your
-tool (`rowstile migrate`, with `tool = "prisma"` or `"drizzle"` in `rowstile.toml`).
-
-The packages are an npm workspace at the repository root (`npm ci`, then `npx tsc -b sdk/typescript`).
-`integrations/nextjs/` is the conformance suite: a small Next.js app on Prisma 7 and Prisma Migrate, and the
-checks every supported stack passes, with pg, postgres.js, Drizzle and the React kit
-(`integrations/nextjs/test.sh`).
+| [`@rowstile/client`](https://www.npmjs.com/package/@rowstile/client) | who a transaction acts for, the errors, the runtime's calls |
+| [`@rowstile/prisma`](https://www.npmjs.com/package/@rowstile/prisma) | Prisma |
+| [`@rowstile/pg`](https://www.npmjs.com/package/@rowstile/pg) | node-postgres |
+| [`@rowstile/postgres`](https://www.npmjs.com/package/@rowstile/postgres) | postgres.js |
+| [`@rowstile/drizzle`](https://www.npmjs.com/package/@rowstile/drizzle) | Drizzle ORM |
+| [`@rowstile/react`](https://www.npmjs.com/package/@rowstile/react) | React: hooks and a share dialog |
+| [`@rowstile/vitest`](https://www.npmjs.com/package/@rowstile/vitest) | Vitest: matchers, a database per worker |
+
+rowstile is a 0.x preview: names may still change before 1.0. Apache-2.0.

package/dist/index.d.ts

@@ -10,7 +10,10 @@ declare function keepOutOfCaches(p: Principal): Promise<void>;
 export declare function checkAtStart(calls: {
     check(): Promise<void>;
 }): Promise<void>;
-/** A route handler whose refusals answer 403 with the reason, and hidden rows 404 (RFC 9457 problem bodies). */
+/** A route handler whose refusals answer 403 with the reason, and hidden rows 404 (RFC 9457 problem bodies); a call
+ *  the database turns down that is no refusal answers as its code's page says, with its words: 401 for a login
+ *  refused or a call that needs someone signed in (AZ703, AZ714), 404 for something it names that isn't there
+ *  (AZ708), 400 for an argument missing or wrong (AZ710), 409 for a move inside itself (AZ713). */
 export declare function route<A extends unknown[]>(handler: (...args: A) => Response | Promise<Response>): (...args: A) => Promise<Response>;
 /** What a server action returns: its value, or the problem (a server action can't answer 403, and Next.js hides
  *  a thrown error's message in production). */
@@ -21,7 +24,8 @@ export type ActionResult<R> = {
     ok: false;
     problem: Problem;
 };
-/** A server action whose refusals and hidden rows come back as { ok: false, problem } instead of an error. */
+/** A server action whose refusals and hidden rows come back as { ok: false, problem } instead of an error, and
+ *  so does what route() answers 401, 404, 400 or 409 for (AZ703, AZ714, AZ708, AZ710, AZ713). */
 export declare function action<A extends unknown[], R>(fn: (...args: A) => Promise<R>): (...args: A) => Promise<ActionResult<R>>;
 export interface RoutesOptions {
     /** The runtime's functions, each signed in as the request's user: db.$authz (Prisma), authz(pool) (pg), ... */
@@ -36,7 +40,9 @@ export interface RoutesOptions {
  *  GET perms?type=folder&ids=1&ids=2 (POST perms {type, ids} for a long list), GET shares?type=folder&id=3,
  *  GET events (server-sent events), POST share, POST unshare, POST request. Each answers as the signed-in
  *  user, and only what they may see. The POST routes take application/json only: a form on another site
- *  can't send that without the browser asking this one first. */
+ *  can't send that without the browser asking this one first. They answer as route() does: a share with
+ *  someone who doesn't exist 404, a request for access without a reason 400, and one from someone not signed in
+ *  401, with the database's words. */
 export declare function authzRoutes(options: RoutesOptions): {
     GET: (req: Request) => Promise<Response>;
     POST: (req: Request) => Promise<Response>;

package/dist/index.js

@@ -43,7 +43,10 @@ export async function checkAtStart(calls) {
         process.exit(1);
     }
 }
-/** A route handler whose refusals answer 403 with the reason, and hidden rows 404 (RFC 9457 problem bodies). */
+/** A route handler whose refusals answer 403 with the reason, and hidden rows 404 (RFC 9457 problem bodies); a call
+ *  the database turns down that is no refusal answers as its code's page says, with its words: 401 for a login
+ *  refused or a call that needs someone signed in (AZ703, AZ714), 404 for something it names that isn't there
+ *  (AZ708), 400 for an argument missing or wrong (AZ710), 409 for a move inside itself (AZ713). */
 export function route(handler) {
     return async (...args) => {
         try {
@@ -57,7 +60,8 @@ export function route(handler) {
         }
     };
 }
-/** A server action whose refusals and hidden rows come back as { ok: false, problem } instead of an error. */
+/** A server action whose refusals and hidden rows come back as { ok: false, problem } instead of an error, and
+ *  so does what route() answers 401, 404, 400 or 409 for (AZ703, AZ714, AZ708, AZ710, AZ713). */
 export function action(fn) {
     return async (...args) => {
         try {
@@ -76,7 +80,9 @@ const json = (body, status = 200) => new Response(JSON.stringify(body), { status
  *  GET perms?type=folder&ids=1&ids=2 (POST perms {type, ids} for a long list), GET shares?type=folder&id=3,
  *  GET events (server-sent events), POST share, POST unshare, POST request. Each answers as the signed-in
  *  user, and only what they may see. The POST routes take application/json only: a form on another site
- *  can't send that without the browser asking this one first. */
+ *  can't send that without the browser asking this one first. They answer as route() does: a share with
+ *  someone who doesn't exist 404, a request for access without a reason 400, and one from someone not signed in
+ *  401, with the database's words. */
 export function authzRoutes(options) {
     const { calls } = options;
     const streams = { open: 0, most: options.maxStreams ?? 1000 };
@@ -130,32 +136,28 @@ function events(req, changes, streams) {
         return json({ title: "Service Unavailable", status: 503, detail: "too many event streams open" }, 503);
     }
     const encoder = new TextEncoder();
-    let stop = () => { };
+    let stop; // set as the stream starts, which is at once
     const stream = new ReadableStream({
         start(controller) {
             streams.open += 1;
             let counted = true;
-            controller.enqueue(encoder.encode(": connected\n\n"));
-            const unsubscribe = changes(() => {
+            // a stream that ended, told of a change all the same: nothing to send, and it stops
+            const send = (text) => {
                 try {
-                    controller.enqueue(encoder.encode("event: changed\ndata: {}\n\n"));
+                    controller.enqueue(encoder.encode(text));
                 }
                 catch {
                     stop();
                 }
-            });
-            const ping = setInterval(() => {
-                try {
-                    controller.enqueue(encoder.encode(": ping\n\n"));
-                }
-                catch {
-                    stop();
-                }
-            }, 25000);
+            };
+            send(": connected\n\n");
+            const unsubscribe = changes(() => send("event: changed\ndata: {}\n\n"));
+            const ping = setInterval(() => send(": ping\n\n"), 25000);
             stop = () => {
-                if (counted)
-                    streams.open -= 1;
+                if (!counted)
+                    return; // once: a page that leaves cancels the stream and aborts the request
                 counted = false;
+                streams.open -= 1;
                 clearInterval(ping);
                 unsubscribe();
                 try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rowstile/next",
-  "version": "0.1.0-alpha.5",
+  "version": "0.1.0-alpha.7",
   "description": "rowstile with Next.js: signed-in reads kept out of caches, 403 and 404 from route handlers and server actions",
   "license": "Apache-2.0",
   "homepage": "https://rowstile.dev",
@@ -20,7 +20,7 @@
   ],
   "sideEffects": true,
   "dependencies": {
-    "@rowstile/client": "0.1.0-alpha.5"
+    "@rowstile/client": "0.1.0-alpha.7"
   },
   "peerDependencies": {
     "next": ">=15"