@rowstile/pg 0.1.0-alpha.4 → 0.1.0-alpha.6

package/README.md

@@ -1,83 +1,64 @@
-# rowstile for TypeScript
+# @rowstile/pg
 
-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 node-postgres (`pg`). `authz(pool)` gives transactions that sign in as whoever
+the code acts for, the runtime's calls (`can`, `permsOf`, `list`, `share`), and `expect`, which turns an UPDATE
+or DELETE that changed nothing into `NotFound` or `Refused` with the reason. `changes(pool)` is the feed for
+live updates.
+
+```sh
+# @next on each while only an alpha is published: a plain install gets an older one
+npm install @rowstile/client@next @rowstile/pg@next
+npm install --save-dev rowstile@next      # the command: rowstile dev, rowstile migrate
+```
 
 ```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)
+import { authz as rowstile } from "@rowstile/pg";
 
-const adapter = signedIn(new PrismaPg({ connectionString: process.env.DATABASE_URL }),
-                         { user: async () => (await auth())?.user.id });
-export const db = new PrismaClient({ adapter }).$extends(authz());
+    const p = new pg.Pool({ connectionString: APP });
+    const a = rowstile(p);
+      expect(await a.transaction(async (c) => (await c.query("SELECT id FROM app.notes ORDER BY id")).rows.map((r) => r.id), "2")).toEqual([2, 3]);
 ```
 
+`transaction(fn, who)` signs in as `who`, or as whoever `actingAs` set. An UPDATE the rules refuse changes 0
+rows, without an error; `expect` asks the database why:
+
 ```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 });
-});
+      await expect(actingAs("3", () => a.transaction(async (c) => {
+        const r = await c.query("UPDATE app.notes SET body = 'x' WHERE id = 1");
+        return a.expect(r, "app.notes", "update", 1);
+      }))).rejects.toBeRefused("update");
 ```
 
-| package | what |
-|---|---|
-| `@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 |
+## Good to know
+
+- Every transaction signs in, even as nobody, and nothing uses a session-level `SET`: pools and poolers in
+  transaction mode are safe.
+- `await a.check()` at start-up throws `ConnectionProblem` on a connection that skips row-level security (a
+  superuser, `BYPASSRLS`, the tables' owner).
+- `changes(pool)` needs a connection of its own, straight to Postgres: `LISTEN` hears nothing through a
+  pooler in transaction mode.
 
-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)).
+## More
 
-Traps it handles:
+- [Node apps: pg, postgres.js and Drizzle](https://rowstile.dev/stacks/node): 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).
 
-- **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 other packages:
 
-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`).
+| package | for |
+|---|---|
+| [`@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/postgres`](https://www.npmjs.com/package/@rowstile/postgres) | postgres.js |
+| [`@rowstile/drizzle`](https://www.npmjs.com/package/@rowstile/drizzle) | Drizzle ORM |
+| [`@rowstile/next`](https://www.npmjs.com/package/@rowstile/next) | Next.js: route handlers, server actions, caches |
+| [`@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 |
 
-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 is a 0.x preview: names may still change before 1.0. Apache-2.0.

package/dist/index.d.ts

@@ -33,6 +33,7 @@ export declare function authz(pool: Pool, options?: Options): {
         problem: string;
     }[]>;
     expect<R>(result: R, table: string, command: "update" | "delete", id: import("@rowstile/client").Id, row?: object): Promise<R>;
+    verdict(table: string, command: string, id: import("@rowstile/client").Id, row?: object): Promise<import("@rowstile/client").NotFound | import("@rowstile/client").Refused>;
     check(): Promise<void>;
     pool: Pool;
     /** Runs fn in a transaction signed in as whoever the code acts for (or `who`, if given). */

package/package.json

@@ -1,8 +1,10 @@
 {
   "name": "@rowstile/pg",
-  "version": "0.1.0-alpha.4",
+  "version": "0.1.0-alpha.6",
   "description": "rowstile with node-postgres (pg): transactions signed in as the request's user",
   "license": "Apache-2.0",
+  "homepage": "https://rowstile.dev",
+  "keywords": ["rowstile", "postgres", "postgresql", "authorization", "row-level-security", "rls", "permissions", "access-control", "rbac", "rebac", "multi-tenant", "pg", "node-postgres"],
   "repository": { "type": "git", "url": "git+https://github.com/rowstile/rowstile.git", "directory": "sdk/typescript/pg" },
   "type": "module",
   "main": "./dist/index.js",
@@ -10,6 +12,6 @@
   "exports": { ".": { "types": "./dist/index.d.ts", "default": "./dist/index.js" } },
   "files": ["dist"],
   "sideEffects": false,
-  "dependencies": { "@rowstile/client": "0.1.0-alpha.4" },
+  "dependencies": { "@rowstile/client": "0.1.0-alpha.6" },
   "peerDependencies": { "pg": ">=8" }
 }