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

package/README.md

@@ -1,83 +1,60 @@
-# rowstile for TypeScript
+# @rowstile/client
 
-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 the base of the TypeScript SDK: who a transaction acts for, the errors a refusal becomes, and
+the runtime's calls (`can`, `perms`, `list`, `share`, ...). The driver packages build on it: `@rowstile/prisma`,
+`@rowstile/pg`, `@rowstile/postgres`, `@rowstile/drizzle`. It holds no rowstile logic: it calls the `authz.*`
+functions the policy made, and translates their answers.
 
-```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());
+```sh
+# @next while only an alpha is published: a plain install gets an older one
+npm install @rowstile/client@next
+npm install --save-dev rowstile@next      # the command: rowstile dev, rowstile migrate
 ```
 
+A background job that acts for a service, whatever started it:
+
 ```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 });
-});
+// src/jobs.ts
+import { current, job } from "@rowstile/client";
+import { db } from "./db.ts";
+
+export const digest = job(["service", 1], async () => ({ count: await db.project.count(), who: current() }));
 ```
 
-| 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 |
+## What is in it
 
-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)).
+- `actingAs(who, fn)` and `job(who, fn)`: every transaction `fn` begins signs in as `who`. `42` or `"42"` is
+  a user, `["service", 3]` another principal type of the policy, `null` nobody.
+- `current()`: who the code running now acts for.
+- `Refused` (403, with the rule and the reason), `NotFound` (404), `NotSignedIn`, `ConnectionProblem`.
+- `translate(e)`: any driver's error as one of those, or `null`. `problemOf(e)` and `problemResponse(e)`: the
+  status and an RFC 9457 body for an HTTP answer.
+- `errorCode(e)`: rowstile's code for an error (`AZ709`; `rowstile help AZ709` explains it).
+- `calls(queryable)`: the runtime's functions over anything with `query(text, values)`.
+- `Register`: the interface the generated names fill in (`rowstile client`), so a wrong permission name
+  doesn't type-check.
 
-Traps it handles:
+## More
 
-- **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.
+- [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).
 
-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 other packages:
 
-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`).
+| package | for |
+|---|---|
+| [`@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/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 |
+
+rowstile is a 0.x preview: names may still change before 1.0. Apache-2.0.

package/dist/index.d.ts

@@ -26,6 +26,9 @@ export type Id = string | number | bigint | readonly (string | number | bigint)[
 /** An id as the database compares it: a composite key as Postgres writes a row (every field quoted); a key of
  *  one column given as an array is that value. */
 export declare function idText(id: Id): string;
+/** A row's key as the database writes it, for a message: 7, or (1,2) for a composite key (a field is quoted
+ *  only where Postgres would: when it is empty or holds a comma, a quote, a parenthesis or a space). */
+export declare function idShown(id: Id): string;
 /** A user (type "user"), another principal type the policy declares (a service, a bot), or nobody (id null:
  *  only what `anyone` may see). */
 export interface Principal {
@@ -179,12 +182,16 @@ export interface AuthzCalls {
 /** The runtime's functions over q (a signed-in transaction, or something that signs each query in). */
 export declare function calls(q: Queryable): AuthzCalls & {
     expect<R>(result: R, table: string, command: "update" | "delete", id: Id, row?: object): Promise<R>;
+    /** What an UPDATE or DELETE that changed nothing was, asked of the database: the error to throw. */
+    verdict(table: string, command: string, id: Id, row?: object): Promise<NotFound | Refused>;
     check(): Promise<void>;
 };
 /** Whether an UPDATE or DELETE's result changed anything: rows, a count, {count}, {rowCount}, postgres.js's .count. */
 export declare function changed(result: unknown): boolean;
 /** What an UPDATE or DELETE that changed nothing was: NotFound when the row isn't there for this user (why is
  *  null), or when the rule allows the write (its first line says yes: the statement matched nothing for
- *  another reason, such as a where with more than the key); Refused with the reason otherwise. */
-export declare function verdict(table: string, command: string, id: Id, why: string[] | null): NotFound | Refused;
+ *  another reason, such as a where with more than the key); Refused with the reason otherwise, worded as the
+ *  database words a refused insert: "permission denied: user 2 may not update row 7 of app.notes".
+ *  who: "user 2", as the database says it; left out, whoever the code acts for now. */
+export declare function verdict(table: string, command: string, id: Id, why: string[] | null, who?: string): NotFound | Refused;
 export {};

package/dist/index.js

@@ -23,6 +23,20 @@ export function idText(id) {
     }
     return String(id);
 }
+/** A row's key as the database writes it, for a message: 7, or (1,2) for a composite key (a field is quoted
+ *  only where Postgres would: when it is empty or holds a comma, a quote, a parenthesis or a space). */
+export function idShown(id) {
+    if (!Array.isArray(id))
+        return String(id);
+    if (id.length === 1)
+        return String(id[0]);
+    return "(" + id.map((v) => {
+        if (v === null || v === undefined)
+            return "";
+        const text = String(v);
+        return text === "" || /[",\\()\s]/.test(text) ? '"' + text.replace(/\\/g, "\\\\").replace(/"/g, '""') + '"' : text;
+    }).join(",") + ")";
+}
 export const NOBODY = Object.freeze({ type: "user", id: null });
 export function principal(who) {
     if (who === null || who === undefined)
@@ -272,7 +286,9 @@ export function checkProblems(rows) {
 // looked up on the search_path
 const EXPLAIN_RULE = "SELECT authz.explain_rule(coalesce((SELECT n.nspname || '.' || c.relname FROM pg_catalog.pg_class c " +
     "JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace WHERE position('.' in $1::text) = 0 " +
-    "AND c.oid = pg_catalog.to_regclass(pg_catalog.quote_ident($1::text))), $1::text), $2, $3, $4::jsonb) AS e";
+    "AND c.oid = pg_catalog.to_regclass(pg_catalog.quote_ident($1::text))), $1::text), $2, $3, $4::jsonb) AS e, " +
+    // who is signed in, in the words the database's own refusals use
+    "coalesce((SELECT p.principal_type || ' ' || p.principal_id FROM authz.principal() p), 'someone not signed in') AS who";
 /** The runtime's functions over q (a signed-in transaction, or something that signs each query in). */
 export function calls(q) {
     const one = async (text, values) => (await q.query(text, values)).rows[0];
@@ -300,7 +316,11 @@ export function calls(q) {
         expect: async (result, table, command, id, row) => {
             if (changed(result))
                 return result;
-            throw verdict(table, command, id, await c.explainRule(table, command, id, row));
+            throw await c.verdict(table, command, id, row);
+        },
+        verdict: async (table, command, id, row) => {
+            const got = await one(EXPLAIN_RULE, [table, command, idText(id), row === undefined ? null : JSON.stringify(row)]);
+            return verdict(table, command, id, (got.e ?? null), typeof got.who === "string" ? got.who : undefined);
         },
         /** Throws ConnectionProblem if this connection skips row-level security. As nobody: it runs at start-up,
          *  where there is no request to ask who is signed in. */
@@ -331,9 +351,13 @@ export function changed(result) {
 }
 /** What an UPDATE or DELETE that changed nothing was: NotFound when the row isn't there for this user (why is
  *  null), or when the rule allows the write (its first line says yes: the statement matched nothing for
- *  another reason, such as a where with more than the key); Refused with the reason otherwise. */
-export function verdict(table, command, id, why) {
+ *  another reason, such as a where with more than the key); Refused with the reason otherwise, worded as the
+ *  database words a refused insert: "permission denied: user 2 may not update row 7 of app.notes".
+ *  who: "user 2", as the database says it; left out, whoever the code acts for now. */
+export function verdict(table, command, id, why, who) {
     if (why === null || /^\s*yes\b/.test(why[0] ?? ""))
-        return new NotFound(table, idText(id));
-    return new Refused(`permission denied: may not ${command} ${table} ${idText(id)}`, table, command, why);
+        return new NotFound(table, idShown(id));
+    const p = current() ?? NOBODY;
+    const by = who ?? (p.id === null ? "someone not signed in" : `${p.type} ${p.id}`);
+    return new Refused(`permission denied: ${by} may not ${command} row ${idShown(id)} of ${table}`, table, command, why);
 }

package/package.json

@@ -1,8 +1,10 @@
 {
   "name": "@rowstile/client",
-  "version": "0.1.0-alpha.4",
+  "version": "0.1.0-alpha.6",
   "description": "rowstile for TypeScript apps: who each transaction acts for, refusals as errors, generated names",
   "license": "Apache-2.0",
+  "homepage": "https://rowstile.dev",
+  "keywords": ["rowstile", "postgres", "postgresql", "authorization", "row-level-security", "rls", "permissions", "access-control", "rbac", "rebac", "multi-tenant", "typescript"],
   "repository": { "type": "git", "url": "git+https://github.com/rowstile/rowstile.git", "directory": "sdk/typescript/client" },
   "type": "module",
   "main": "./dist/index.js",