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

package/README.md

@@ -5,7 +5,9 @@ row in one file, and it becomes row-level security: the database filters every r
 the rules don't allow, whatever the code asks.
 
 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. `action(fn)` gives a server action's
+`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`.
 

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.6",
+  "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.6"
+    "@rowstile/client": "0.1.0-alpha.7"
   },
   "peerDependencies": {
     "next": ">=15"