@wrenautomation/vireo 0.11.0 → 0.13.0

package/dist/store.d.ts

@@ -1,6 +1,6 @@
 import { type Collector } from "./collect.js";
 import { type Db, type Hooks, type Tx } from "./db.js";
-import { type Anchor, batches, type GuideState, guides, type Kind, notes, samples, ships, steers, subjects, type Tone, type Verdict, type Width } from "./schema.js";
+import { type Anchor, batches, calls, type GuideState, guides, type Kind, notes, samples, ships, steers, subjects, type Tone, type Verdict, type Width } from "./schema.js";
 import { type Strength } from "./stats.js";
 import { type Source } from "./sync.js";
 export interface Ports {
@@ -33,10 +33,29 @@ export type Parent = number | {
 export type SubjectRow = typeof subjects.$inferSelect;
 export type BatchRow = typeof batches.$inferSelect;
 export type SampleRow = typeof samples.$inferSelect;
+export type CallRow = typeof calls.$inferSelect;
+/** `by` of calls made before calls had a judge (migration 0008); a host may name them after. */
+export declare const EARLIER_JUDGE = "person";
 export type NoteRow = typeof notes.$inferSelect;
 export type GuideRow = typeof guides.$inferSelect;
 export type ShipRow = typeof ships.$inferSelect;
 export type SteerRow = typeof steers.$inferSelect;
+export declare const BATCH_SORTS: readonly ["waiting", "newest", "oldest", "subject", "good"];
+export type BatchSort = (typeof BATCH_SORTS)[number];
+/** A page of batches (D11). `subjects`: only these (a host's folder); `who`: batches they called in. */
+export interface BatchQuery {
+    subjects?: readonly number[];
+    subject?: string | number;
+    kind?: Kind;
+    /** waits = open and its subject's newest */
+    state?: "open" | "closed" | "waits";
+    who?: string;
+    /** default waiting: what waits first, then newest */
+    sort?: BatchSort;
+    limit?: number;
+    /** offset: the `next` of the page before */
+    after?: number;
+}
 /** A steer to set (D10). pin, prune: `sample`. cross: `sample` and `other`. width: `subject`. */
 export type NewSteer = {
     kind: "pin" | "prune";
@@ -53,13 +72,28 @@ export type NewSteer = {
     width: Width;
     why?: string | null;
 };
+type Called = Pick<CallRow, "sampleId" | "by" | "score" | "verdict">;
+/**
+ * One sheet per (batch, person) who called in it: each sample of the batch with that person's
+ * call, or none (unmarked). The unit of every rank and rate (D11).
+ */
+export declare function sheets(rows: readonly Pick<SampleRow, "id" | "batchId">[], cs: readonly Called[]): {
+    batchId: number;
+    by: string;
+    marks: {
+        id: number;
+        call: Called | null;
+    }[];
+}[];
 /**
- * Strength per judged sample: each judged batch is a partial ranking by score, 10 down to 1, ties
- * unordered. Wins from 9 and up count double.
+ * Strength per judged sample: each sheet is a partial ranking by score, 10 down to 1, ties
+ * unordered; unmarked reads as 5. Wins from 9 and up count double.
  */
-export declare function strengths(rows: readonly Pick<SampleRow, "id" | "batchId" | "score">[]): Strength[];
-/** With-vs-without good rate per guide, over judged samples. */
-export declare function guideStats(guideRows: readonly GuideRow[], judged: readonly SampleRow[]): {
+export declare function strengths(rows: readonly Pick<SampleRow, "id" | "batchId">[], cs: readonly Called[]): Strength[];
+/** Good or better over every (sample, person) mark of these sheets; null with none. */
+export declare function goodRateOf(ss: ReturnType<typeof sheets>): number | null;
+/** With-vs-without good rate per guide, over every mark in judged batches. */
+export declare function guideStats(guideRows: readonly GuideRow[], judged: readonly SampleRow[], cs: readonly Called[]): {
     effect: {
         with: {
             good: number;
@@ -99,6 +133,7 @@ export declare class Vireo {
     /** More samples in an open batch: `addBatch` with `into`, the subject read from the batch. */
     appendBatch(ref: string | number, b: {
         why: string;
+        title?: string | null;
         agent?: string | null;
         samples: NewSample[];
     }): Promise<{
@@ -162,6 +197,7 @@ export declare class Vireo {
     /** A new batch, or with `into` (id or `<subject>:<n>`) more samples in an open one. */
     addBatch(ref: string | number, b: {
         why: string;
+        title?: string | null;
         agent?: string | null;
         samples: NewSample[];
         into?: string | number | null;
@@ -222,12 +258,16 @@ export declare class Vireo {
         }[];
         pruned: number[];
     }>;
-    /** Batches that wait on the person, oldest first, with samples and notes: what they have to pick. */
-    queue(ref?: string | number): Promise<{
+    /**
+     * Batches that wait on the person, oldest first, with samples and notes: what they have to pick.
+     * `viewer`: a person sees only their own calls and notes (D11).
+     */
+    queue(ref?: string | number, viewer?: string | null): Promise<{
         batch: {
             id: number;
             subjectId: number;
             n: number;
+            title: string | null;
             why: string;
             agent: string | null;
             state: "open" | "closed";
@@ -247,7 +287,15 @@ export declare class Vireo {
             by: string | null;
             createdAt: Date;
         };
-        samples: {
+        samples: ({
+            calls: {
+                id: number;
+                sampleId: number;
+                by: string;
+                score: number;
+                verdict: "amazing" | "good" | "okay" | "bad";
+                at: Date;
+            }[];
             notes: {
                 id: number;
                 sampleId: number;
@@ -257,6 +305,8 @@ export declare class Vireo {
                 by: string | null;
                 createdAt: Date;
             }[];
+            score: null;
+            verdict: null;
             id: number;
             batchId: number;
             subjectId: number;
@@ -269,20 +319,62 @@ export declare class Vireo {
             guides: number[];
             change: string | null;
             agent: string | null;
-            score: number | null;
-            verdict: "amazing" | "good" | "okay" | "bad" | null;
             keptAt: Date | null;
             createdAt: Date;
-        }[];
+        } | {
+            calls: {
+                id: number;
+                sampleId: number;
+                by: string;
+                score: number;
+                verdict: "amazing" | "good" | "okay" | "bad";
+                at: Date;
+            }[];
+            notes: {
+                id: number;
+                sampleId: number;
+                anchor: Anchor | null;
+                tone: "good" | "bad" | null;
+                text: string | null;
+                by: string | null;
+                createdAt: Date;
+            }[];
+            score: number;
+            verdict: "amazing" | "good" | "okay" | "bad";
+            id: number;
+            batchId: number;
+            subjectId: number;
+            position: number;
+            body: string | null;
+            media: string | null;
+            poster: string | null;
+            source: Source | null;
+            name: string | null;
+            guides: number[];
+            change: string | null;
+            agent: string | null;
+            keptAt: Date | null;
+            createdAt: Date;
+        })[];
     }[]>;
+    private callsOf;
     private notesOf;
     /** Parent edges of these children, main parent first. */
     private lineageOf;
-    /** A call: a 1-10 score, a verdict (its tap score) or null to clear. The verdict follows. */
+    /**
+     * `by`'s call: a 1-10 score, a verdict (its tap score) or null to clear. The verdict follows.
+     * One call per person per sample (D11).
+     */
     judge(sampleId: number, call: number | Verdict | null, by: string | null): Promise<{
         id: number;
-        score: number | null;
-        verdict: "amazing" | "good" | "okay" | "bad" | null;
+        by: string;
+        score: null;
+        verdict: null;
+    } | {
+        id: number;
+        by: string;
+        score: number;
+        verdict: "amazing" | "good" | "okay" | "bad";
     }>;
     addNote(sampleId: number, n: {
         anchor?: Anchor | null;
@@ -317,6 +409,12 @@ export declare class Vireo {
         slug: string;
         name: string;
     } | undefined>;
+    /** A batch's title (id or `<subject>:<n>`); blank refused. */
+    renameBatch(ref: string | number, title: string, by: string | null): Promise<{
+        id: number;
+        n: number;
+        title: string | null;
+    }>;
     /** A sample's short name; blank clears it. */
     renameSample(sampleId: number, name: string | null, by: string | null): Promise<{
         id: number;
@@ -408,7 +506,16 @@ export declare class Vireo {
         }[];
         batches: {
             goodRate: number | null;
-            samples: {
+            judges: string[];
+            samples: ({
+                calls: {
+                    id: number;
+                    sampleId: number;
+                    by: string;
+                    score: number;
+                    verdict: "amazing" | "good" | "okay" | "bad";
+                    at: Date;
+                }[];
                 strength: Strength | null;
                 notes: {
                     id: number;
@@ -423,6 +530,8 @@ export declare class Vireo {
                     id: number;
                     took: string | null;
                 }[];
+                score: null;
+                verdict: null;
                 id: number;
                 batchId: number;
                 subjectId: number;
@@ -435,14 +544,52 @@ export declare class Vireo {
                 guides: number[];
                 change: string | null;
                 agent: string | null;
-                score: number | null;
-                verdict: "amazing" | "good" | "okay" | "bad" | null;
                 keptAt: Date | null;
                 createdAt: Date;
-            }[];
+            } | {
+                calls: {
+                    id: number;
+                    sampleId: number;
+                    by: string;
+                    score: number;
+                    verdict: "amazing" | "good" | "okay" | "bad";
+                    at: Date;
+                }[];
+                strength: Strength | null;
+                notes: {
+                    id: number;
+                    sampleId: number;
+                    anchor: Anchor | null;
+                    tone: "good" | "bad" | null;
+                    text: string | null;
+                    by: string | null;
+                    createdAt: Date;
+                }[];
+                parents: {
+                    id: number;
+                    took: string | null;
+                }[];
+                score: number;
+                verdict: "amazing" | "good" | "okay" | "bad";
+                id: number;
+                batchId: number;
+                subjectId: number;
+                position: number;
+                body: string | null;
+                media: string | null;
+                poster: string | null;
+                source: Source | null;
+                name: string | null;
+                guides: number[];
+                change: string | null;
+                agent: string | null;
+                keptAt: Date | null;
+                createdAt: Date;
+            })[];
             id: number;
             subjectId: number;
             n: number;
+            title: string | null;
             why: string;
             agent: string | null;
             state: "open" | "closed";
@@ -507,6 +654,161 @@ export declare class Vireo {
         }[];
     }>;
     /** Kept samples, newest first, with their subject. */
+    /**
+     * Batches as a page: filters, a sort and an offset (D11). `viewer` = the person reading: an open
+     * batch shows only their own marks, and none of the agent's words.
+     */
+    batches(q?: BatchQuery, viewer?: string | null): Promise<{
+        rows: {
+            ref: string;
+            id: number;
+            n: number;
+            title: string | null;
+            state: "open" | "closed";
+            note: string | null;
+            why: string | null;
+            createdAt: Date;
+            subject: {
+                id: number;
+                slug: string;
+                name: string;
+                kind: "text" | "image" | "video" | "page";
+                brief: string | null;
+                seeds: string[];
+                state: "open" | "paused" | "done";
+                by: string | null;
+                createdAt: Date;
+            };
+            waits: boolean;
+            samples: number;
+            kept: number;
+            marked: number;
+            judges: number | null;
+            goodRate: number | null;
+            tally: {
+                amazing: number;
+                good: number;
+                okay: number;
+                bad: number;
+                unmarked: number;
+            } | null;
+            thumbs: {
+                id: number;
+                poster: string;
+                verdict: "amazing" | "good" | "okay" | "bad" | null;
+            }[];
+        }[];
+        next: number | null;
+        waiting: number;
+    }>;
+    /** One batch whole, for `viewer` (see `batches`); `newer` = the subject's newer open batch. */
+    batch(ref: string | number, viewer?: string | null): Promise<{
+        why: string | null;
+        subject: {
+            id: number;
+            slug: string;
+            name: string;
+            kind: "text" | "image" | "video" | "page";
+            brief: string | null;
+            seeds: string[];
+            state: "open" | "paused" | "done";
+            by: string | null;
+            createdAt: Date;
+        };
+        goodRate: number | null;
+        judges: string[] | null;
+        newer: {
+            n: number;
+            ref: string;
+        } | null;
+        samples: ({
+            calls: {
+                id: number;
+                sampleId: number;
+                by: string;
+                score: number;
+                verdict: "amazing" | "good" | "okay" | "bad";
+                at: Date;
+            }[];
+            notes: {
+                id: number;
+                sampleId: number;
+                anchor: Anchor | null;
+                tone: "good" | "bad" | null;
+                text: string | null;
+                by: string | null;
+                createdAt: Date;
+            }[];
+            parents: {
+                id: number;
+                took: string | null;
+            }[];
+            score: null;
+            verdict: null;
+            name: string | null;
+            change: string | null;
+            id: number;
+            batchId: number;
+            subjectId: number;
+            position: number;
+            body: string | null;
+            media: string | null;
+            poster: string | null;
+            source: Source | null;
+            guides: number[];
+            agent: string | null;
+            keptAt: Date | null;
+            createdAt: Date;
+        } | {
+            calls: {
+                id: number;
+                sampleId: number;
+                by: string;
+                score: number;
+                verdict: "amazing" | "good" | "okay" | "bad";
+                at: Date;
+            }[];
+            notes: {
+                id: number;
+                sampleId: number;
+                anchor: Anchor | null;
+                tone: "good" | "bad" | null;
+                text: string | null;
+                by: string | null;
+                createdAt: Date;
+            }[];
+            parents: {
+                id: number;
+                took: string | null;
+            }[];
+            score: number;
+            verdict: "amazing" | "good" | "okay" | "bad";
+            name: string | null;
+            change: string | null;
+            id: number;
+            batchId: number;
+            subjectId: number;
+            position: number;
+            body: string | null;
+            media: string | null;
+            poster: string | null;
+            source: Source | null;
+            guides: number[];
+            agent: string | null;
+            keptAt: Date | null;
+            createdAt: Date;
+        })[];
+        id: number;
+        subjectId: number;
+        n: number;
+        title: string | null;
+        agent: string | null;
+        state: "open" | "closed";
+        note: string | null;
+        closedAt: Date | null;
+        createdAt: Date;
+        ref: string;
+    }>;
     catalog(opts?: {
         kind?: Kind;
         subject?: string | number;
@@ -524,8 +826,6 @@ export declare class Vireo {
             guides: number[];
             change: string | null;
             agent: string | null;
-            score: number | null;
-            verdict: "amazing" | "good" | "okay" | "bad" | null;
             keptAt: Date | null;
             createdAt: Date;
         };
@@ -538,7 +838,10 @@ export declare class Vireo {
 }
 /** Read models a host's page renders: no hand-copied types. */
 export type Queue = Awaited<ReturnType<Vireo["queue"]>>;
+export type BatchPage = Awaited<ReturnType<Vireo["batches"]>>;
+export type BatchWhole = Awaited<ReturnType<Vireo["batch"]>>;
 export type Feedback = Awaited<ReturnType<Vireo["feedback"]>>;
 export type SubjectList = Awaited<ReturnType<Vireo["listSubjects"]>>;
 export type Catalog = Awaited<ReturnType<Vireo["catalog"]>>;
 export type Steers = Awaited<ReturnType<Vireo["steersOf"]>>;
+export {};