@sanity/ailf 0.1.34 → 0.2.0

package/dist/pipeline/report-title.js

@@ -0,0 +1,118 @@
+/**
+ * pipeline/report-title.ts
+ *
+ * Pure function that generates descriptive report titles from provenance
+ * metadata. The title is the primary display string shown in dashboards,
+ * Slack digests, and Studio views — it conveys trigger context, evaluated
+ * areas, source/perspective, and document scope at a glance.
+ *
+ * Score is intentionally omitted from the title since it is surfaced
+ * heavily elsewhere in the UI. The `tag` field (on Report) is preserved
+ * as a secondary label; the title is the primary display string.
+ *
+ * Segments are joined with ` · ` (middle dot with spaces).
+ *
+ * @see docs/design-docs/report-store/domain-model.md
+ * @see packages/eval/src/pipeline/provenance.ts — builds the provenance input
+ */
+// ---------------------------------------------------------------------------
+// Segment builders
+// ---------------------------------------------------------------------------
+const SEPARATOR = " · ";
+/** Segment 1 — human-readable trigger context */
+function triggerSegment(trigger) {
+    switch (trigger.type) {
+        case "scheduled": {
+            const name = trigger.schedule.replace(/-/g, " ");
+            return name.charAt(0).toUpperCase() + name.slice(1);
+        }
+        case "ci":
+            return "CI eval";
+        case "webhook":
+            return "Content change";
+        case "cross-repo": {
+            // Only show the repo name if callerRepo looks like "owner/repo".
+            // Numeric IDs (e.g. GITHUB_REPOSITORY_OWNER_ID fallback) are not useful.
+            const repo = trigger.callerRepo;
+            if (repo.includes("/")) {
+                const shortName = repo.split("/").pop() ?? repo;
+                return `Cross-repo (${shortName})`;
+            }
+            return "Cross-repo";
+        }
+        case "manual":
+            return "Manual eval";
+    }
+}
+/** Segment 2 — areas evaluated (omitted when empty) */
+function areasSegment(areas, totalAreaCount) {
+    if (areas.length === 0)
+        return undefined;
+    if (areas.length <= 3) {
+        return areas.join(", ");
+    }
+    if (totalAreaCount !== undefined && areas.length === totalAreaCount) {
+        return "All areas";
+    }
+    return `${areas.length} areas`;
+}
+/** Segment 3 — source context (omitted when default production, no perspective) */
+function sourceSegment(source) {
+    const parts = [];
+    if (source.perspective) {
+        parts.push(`perspective: ${source.perspective}`);
+    }
+    if (source.name !== "production") {
+        parts.push(source.name);
+    }
+    return parts.length > 0 ? parts.join(", ") : undefined;
+}
+/** Segment 4 — target documents (omitted when not scoped) */
+function targetDocumentsSegment(targetDocuments) {
+    if (!targetDocuments || targetDocuments.length === 0)
+        return undefined;
+    if (targetDocuments.length === 1) {
+        return targetDocuments[0];
+    }
+    return `${targetDocuments.length} documents`;
+}
+// ---------------------------------------------------------------------------
+// Public API
+// ---------------------------------------------------------------------------
+/**
+ * Generate a descriptive report title from provenance metadata.
+ *
+ * The title is composed of up to four segments separated by ` · `:
+ *
+ * 1. **Trigger context** — what initiated the evaluation (always present)
+ * 2. **Areas** — which feature areas were evaluated (omitted if empty)
+ * 3. **Source context** — non-default source or perspective (omitted if default)
+ * 4. **Target documents** — scoped document IDs (omitted if not scoped)
+ *
+ * @example
+ * ```ts
+ * generateReportTitle({
+ *   provenance: {
+ *     areas: ["GROQ", "Mutations"],
+ *     mode: "baseline",
+ *     source: { name: "production" },
+ *     trigger: { type: "manual" },
+ *   },
+ * })
+ * // → "Manual eval · GROQ, Mutations"
+ * ```
+ */
+export function generateReportTitle(input) {
+    const { provenance, totalAreaCount } = input;
+    const segments = [triggerSegment(provenance.trigger)];
+    const areas = areasSegment(provenance.areas, totalAreaCount);
+    if (areas)
+        segments.push(areas);
+    const source = sourceSegment(provenance.source);
+    if (source)
+        segments.push(source);
+    const docs = targetDocumentsSegment(provenance.targetDocuments);
+    if (docs)
+        segments.push(docs);
+    return segments.join(SEPARATOR);
+}

package/dist/report-store.js

@@ -203,6 +203,7 @@ export class ReportStore {
                 reportId: report.id,
                 summary: report.summary,
                 tag: report.tag ?? null,
+                title: report.title ?? null,
             });
             return report.id;
         }
@@ -255,5 +256,6 @@ function toReport(doc) {
         provenance: doc.provenance,
         summary: doc.summary,
         tag: doc.tag,
+        title: doc.title,
     };
 }

package/dist/sinks/bigquery/index.d.ts

@@ -71,6 +71,7 @@ export interface ReportRow {
     source_name: string;
     source_perspective: null | string;
     tag: null | string;
+    title: null | string;
     total_cost: null | number;
     trigger_caller_repo: null | string;
     trigger_type: string;

package/dist/sinks/bigquery/index.js

@@ -213,6 +213,7 @@ export function flattenReportRow(report) {
         source_name: provenance.source.name,
         source_perspective: provenance.source.perspective ?? null,
         tag: report.tag ?? null,
+        title: report.title ?? null,
         total_cost: summary.overall.cost?.total ?? null,
         trigger_caller_repo: provenance.trigger.type === "cross-repo"
             ? provenance.trigger.callerRepo

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/ailf",
-  "version": "0.1.34",
+  "version": "0.2.0",
   "private": false,
   "publishConfig": {
     "access": "restricted"
@@ -23,6 +23,27 @@
     "canonical",
     "tasks"
   ],
+  "dependencies": {
+    "@google-cloud/bigquery": "^8.1.1",
+    "@inquirer/prompts": "^8.3.0",
+    "@portabletext/markdown": "^1.0.0",
+    "@sanity/client": "^7.3.0",
+    "commander": "^14.0.3",
+    "dotenv": "^16.4.7",
+    "dotenv-cli": "^11.0.0",
+    "js-yaml": "^4.1.0",
+    "promptfoo": "^0.120.24",
+    "zod": "^4.3.6"
+  },
+  "devDependencies": {
+    "@types/js-yaml": "^4.0.9",
+    "@types/node": "^22.13.1",
+    "tsx": "^4.19.2",
+    "typescript": "^5.7.3",
+    "@sanity/ailf-core": "0.1.0",
+    "@sanity/ailf-shared": "0.1.0",
+    "@sanity/ailf-tasks": "0.1.4"
+  },
   "scripts": {
     "build": "tsc && tsx scripts/bundle-workspace-deps.ts",
     "generate-configs": "tsx src/cli.ts generate-configs",
@@ -48,26 +69,5 @@
     "discovery-report": "tsx src/cli.ts discovery-report",
     "webhook-server": "tsx src/cli.ts webhook-server",
     "weekly-digest": "tsx src/cli.ts weekly-digest"
-  },
-  "dependencies": {
-    "@google-cloud/bigquery": "^8.1.1",
-    "@inquirer/prompts": "^8.3.0",
-    "@portabletext/markdown": "^1.0.0",
-    "@sanity/client": "^7.3.0",
-    "commander": "^14.0.3",
-    "dotenv": "^16.4.7",
-    "dotenv-cli": "^11.0.0",
-    "js-yaml": "^4.1.0",
-    "promptfoo": "^0.120.24",
-    "zod": "^4.3.6"
-  },
-  "devDependencies": {
-    "@sanity/ailf-core": "workspace:*",
-    "@sanity/ailf-shared": "workspace:*",
-    "@sanity/ailf-tasks": "workspace:*",
-    "@types/js-yaml": "^4.0.9",
-    "@types/node": "^22.13.1",
-    "tsx": "^4.19.2",
-    "typescript": "^5.7.3"
   }
-}
+}