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

package/README.md

@@ -32,7 +32,9 @@ export const digest = job(["service", 1], async () => ({ count: await db.project
 - `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.
+  status and an RFC 9457 body for an HTTP answer (and 404 for what a call names that isn't there, AZ708; 400
+  for a missing or wrong argument, AZ710; 401 for a call that needs someone signed in or a login refused,
+  AZ714 and AZ703; 409 for a move inside itself, AZ713).
 - `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

package/dist/index.d.ts

@@ -84,9 +84,11 @@ export declare class Refused extends Error {
     command?: string | undefined;
     why: string[];
     readonly status = 403;
-    readonly code = "AZ709";
+    /** rowstile's code for it: AZ709 for a rule's refusal, the database's own for another (AZ705: a share). */
+    readonly code: string;
     constructor(message: string, table?: string | undefined, command?: string | undefined, why?: string[], options?: {
         cause?: unknown;
+        code?: string;
     });
     problem(): Problem;
 }
@@ -131,12 +133,18 @@ export declare function sqlstate(e: unknown): string | undefined;
  *  policies with the rule and why), else null. `schemaOf` qualifies a bare table name (Prisma knows it).
  *  Another 42501 (a table the app role was never granted) is the app's mistake, not a refusal: null. */
 export declare function refusal(e: unknown, schemaOf?: (table: string) => string | undefined): Refused | null;
-/** Whether e is strict sign-in's error: a query that needs to know who is asking, and nobody signed in. */
+/** Whether e is strict sign-in's error (rowstile help AZ701): a query that needs to know who is asking, and nobody
+ *  signed in. A login refused (AZ703) and settings changed by hand (AZ702) share its SQLSTATE, 28000, but are no
+ *  such thing. */
 export declare function notSignedIn(e: unknown): boolean;
 /** e as rowstile's error: Refused, NotFound or NotSignedIn as they are, a database refusal as Refused, strict
  *  sign-in's error as NotSignedIn; null for anything else. */
 export declare function translate(e: unknown, schemaOf?: (table: string) => string | undefined): Refused | NotFound | NotSignedIn | null;
-/** The problem body and status for e (Refused: 403, NotFound: 404), or null. */
+/** The problem body and status for e (Refused: 403, NotFound: 404), or null. A call the database turns down that is
+ *  no refusal answers as its code's page says, with the database's words: a login refused or a call that needs
+ *  someone signed in 401 (AZ703, AZ714), something it names that isn't there 404 (AZ708: a share with someone who
+ *  doesn't exist), an argument missing or wrong 400 (AZ710: a negative page size), a move inside itself 409
+ *  (AZ713). */
 export declare function problemOf(e: unknown): Problem | null;
 /** A Response (application/problem+json) for e, or null: for route handlers. */
 export declare function problemResponse(e: unknown): Response | null;
@@ -184,6 +192,9 @@ 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>;
+    /** The table as the policy names it, with its schema: a bare name (a model that names no schema) is looked
+     *  up on the search_path, once. */
+    tableName(table: string): Promise<string>;
     check(): Promise<void>;
 };
 /** Whether an UPDATE or DELETE's result changed anything: rows, a count, {count}, {rowCount}, postgres.js's .count. */

package/dist/index.js

@@ -126,13 +126,15 @@ export class Refused extends Error {
     command;
     why;
     status = 403;
-    code = "AZ709"; // rowstile help AZ709
+    /** rowstile's code for it: AZ709 for a rule's refusal, the database's own for another (AZ705: a share). */
+    code; // rowstile help AZ709
     constructor(message, table, command, why = [], options) {
         super(message, options);
         this.table = table;
         this.command = command;
         this.why = why;
         this.name = "Refused";
+        this.code = options?.code ?? "AZ709";
     }
     problem() {
         return { type: "https://rowstile.dev/problems/refused", title: "Forbidden", status: 403, detail: this.message,
@@ -222,6 +224,15 @@ export function sqlstate(e) {
 }
 const RLS_GENERIC = /^new row violates row-level security policy (\(USING expression\) )?for table "([^"]+)"/;
 const OURS = /may not (insert|update|delete) this row (?:into|of) (\S+?)(?: to these values)?$/;
+/** The table in a column rule's refusal, "changing locked of app.notes 7 needs: folder.manage" (always an
+ *  update); undefined for any other message. Read with indexOf: a pattern here would backtrack on a long one. */
+function columnRuleTable(message) {
+    const of = message.indexOf(" of "), needs = message.indexOf(" needs: ");
+    if (!message.startsWith("changing ") || of < 0 || needs < of)
+        return undefined;
+    const named = message.slice(of + 4, needs); // "app.notes 7"
+    return named.split(" ", 1)[0] || undefined;
+}
 /** A Refused for an error that is the database refusing a write (SQLSTATE 42501, raised by rowstile's
  *  policies with the rule and why), else null. `schemaOf` qualifies a bare table name (Prisma knows it).
  *  Another 42501 (a table the app role was never granted) is the app's mistake, not a refusal: null. */
@@ -244,15 +255,25 @@ export function refusal(e, schemaOf) {
             "back (RETURNING); read it back only if the select rule allows it", table, "select", [], { cause: e });
     }
     const ours = OURS.exec(err.message);
-    if (!ours && !err.constraint?.startsWith("authz_") && errorCode(e) === undefined)
+    const code = errorCode(e);
+    if (!ours && !err.constraint?.startsWith("authz_") && code === undefined)
+        return null;
+    // sign in first (AZ714) is a 42501 too, but no refusal: a 401
+    if (code !== undefined && CALL_PROBLEMS.has(code))
         return null;
-    const table = err.schema && err.table ? `${err.schema}.${err.table}` : err.table ?? ours?.[2];
-    const command = err.constraint?.startsWith("authz_") ? err.constraint.slice(6) : ours?.[1];
-    return new Refused(err.message, table, command, err.detail ? err.detail.split("\n") : [], { cause: e });
+    // the error's own fields say which table and command; a driver that drops them (Prisma's adapters) leaves
+    // the message, which names both
+    const column = columnRuleTable(err.message);
+    const table = err.schema && err.table ? `${err.schema}.${err.table}` : err.table ?? ours?.[2] ?? column;
+    const command = err.constraint?.startsWith("authz_") ? err.constraint.slice(6) : ours?.[1] ?? (column ? "update" : undefined);
+    return new Refused(err.message, table, command, err.detail ? err.detail.split("\n") : [], { cause: e, code });
 }
-/** Whether e is strict sign-in's error: a query that needs to know who is asking, and nobody signed in. */
+/** Whether e is strict sign-in's error (rowstile help AZ701): a query that needs to know who is asking, and nobody
+ *  signed in. A login refused (AZ703) and settings changed by hand (AZ702) share its SQLSTATE, 28000, but are no
+ *  such thing. */
 export function notSignedIn(e) {
-    return sqlstate(e) === "28000";
+    const code = errorCode(e);
+    return sqlstate(e) === "28000" && (code === undefined || code === "AZ701");
 }
 /** e as rowstile's error: Refused, NotFound or NotSignedIn as they are, a database refusal as Refused, strict
  *  sign-in's error as NotSignedIn; null for anything else. */
@@ -268,10 +289,28 @@ export function translate(e, schemaOf) {
     }
     return null;
 }
-/** The problem body and status for e (Refused: 403, NotFound: 404), or null. */
+// rowstile's codes for a call the database turned down that is no refusal, and what their pages say to answer
+// (rowstile help AZ703: a login refused; AZ708: what the call names isn't there; AZ710: a missing or wrong
+// argument; AZ713: moved inside itself; AZ714: sign in first)
+const CALL_PROBLEMS = new Map([
+    ["AZ703", { type: "https://rowstile.dev/problems/not-signed-in", title: "Unauthorized", status: 401 }],
+    ["AZ708", { type: "https://rowstile.dev/problems/not-found", title: "Not Found", status: 404 }],
+    ["AZ710", { type: "https://rowstile.dev/problems/bad-argument", title: "Bad Request", status: 400 }],
+    ["AZ713", { type: "https://rowstile.dev/problems/conflict", title: "Conflict", status: 409 }],
+    ["AZ714", { type: "https://rowstile.dev/problems/not-signed-in", title: "Unauthorized", status: 401 }],
+]);
+/** The problem body and status for e (Refused: 403, NotFound: 404), or null. A call the database turns down that is
+ *  no refusal answers as its code's page says, with the database's words: a login refused or a call that needs
+ *  someone signed in 401 (AZ703, AZ714), something it names that isn't there 404 (AZ708: a share with someone who
+ *  doesn't exist), an argument missing or wrong 400 (AZ710: a negative page size), a move inside itself 409
+ *  (AZ713). */
 export function problemOf(e) {
     const t = translate(e);
-    return t instanceof Refused || t instanceof NotFound ? t.problem() : null;
+    if (t instanceof Refused || t instanceof NotFound)
+        return t.problem();
+    const code = errorCode(e);
+    const call = code === undefined ? undefined : CALL_PROBLEMS.get(code);
+    return call ? { ...call, detail: dbError(e).message, code } : null;
 }
 /** A Response (application/problem+json) for e, or null: for route handlers. */
 export function problemResponse(e) {
@@ -284,20 +323,24 @@ export function checkProblems(rows) {
 }
 // The policy names tables with their schema; a table named without one (a model that names no schema) is
 // 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 " +
+const TABLE_NAME = "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)";
+const EXPLAIN_RULE = "SELECT authz.explain_rule(t.tbl, $2, $3, $4::jsonb) AS e, t.tbl, " +
     // 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";
+    "coalesce((SELECT p.principal_type || ' ' || p.principal_id FROM authz.principal() p), 'someone not signed in') AS who " +
+    `FROM (SELECT ${TABLE_NAME} AS tbl) t`;
 /** 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];
+    const names = new Map(); // a table as the app names it -> as the policy does
     const c = {
         can: async (type, id, perm) => Boolean((await one("SELECT authz.can($1, $2::text, $3) AS ok", [type, idText(id), perm])).ok),
-        perms: async (type, id) => ((await one("SELECT authz.perms($1, $2::text) AS p", [type, idText(id)])).p ?? []),
+        // (an array, empty at worst: authz.perms never answers null)
+        perms: async (type, id) => (await one("SELECT authz.perms($1, $2::text) AS p", [type, idText(id)])).p,
         permsOf: async (type, ids) => {
             const rows = (await q.query("SELECT id, perms FROM authz.perms_of($1, $2::text[])", [type, ids.map(idText)])).rows;
-            return Object.fromEntries(rows.map((r) => [r.id, r.perms ?? []]));
+            return Object.fromEntries(rows.map((r) => [r.id, r.perms]));
         },
         list: async (type, perm, page = {}) => (await q.query("SELECT x FROM authz.list($1, $2, $3, $4) x", [type, perm, page.after === undefined ? null : idText(page.after), page.limit ?? null])).rows.map((r) => r.x),
         listShares: async (type, id) => (await q.query("SELECT * FROM authz.list_shares($1, $2::text)", [type, idText(id)])).rows,
@@ -320,7 +363,17 @@ export function calls(q) {
         },
         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);
+            // named as the database names it, as in a refused insert: "public.Note" for a model that says "Note" (the
+            // statement's tbl and who are text, never null)
+            const named = String(got.tbl);
+            names.set(table, named);
+            return verdict(named, command, id, (got.e ?? null), String(got.who));
+        },
+        tableName: async (table) => {
+            if (!names.has(table) && !table.includes(".")) {
+                names.set(table, String((await one(`SELECT ${TABLE_NAME} AS tbl`, [table])).tbl));
+            }
+            return names.get(table) ?? table;
         },
         /** 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. */
@@ -355,7 +408,7 @@ export function changed(result) {
  *  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] ?? ""))
+    if (why === null || /^\s*yes\b/.test(why[0]))
         return new NotFound(table, idShown(id));
     const p = current() ?? NOBODY;
     const by = who ?? (p.id === null ? "someone not signed in" : `${p.type} ${p.id}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rowstile/client",
-  "version": "0.1.0-alpha.6",
+  "version": "0.1.0-alpha.7",
   "description": "rowstile for TypeScript apps: who each transaction acts for, refusals as errors, generated names",
   "license": "Apache-2.0",
   "homepage": "https://rowstile.dev",