create-pmos 0.38.8 → 0.40.0

package/workspace/lib/brief.js

@@ -0,0 +1,113 @@
+'use strict';
+/* brief.js — the morning brief: what a session submits, checked once, and how it is ordered.
+ *
+ * The workspace server makes no model or network call and reaches no connector. A scheduled skill runs in an agent session,
+ * reads the sources the profile declares and the settings allow, and submits ONE brief. This module owns the shape of that
+ * brief and the check of it. A brief in any other shape is refused with the reason, never repaired. Every text field has a
+ * short limit, so a message body cannot be stored here by accident.
+ *
+ *   validateBrief(raw, {now, settings})   → {ok:true, brief} | {ok:false, error}
+ *   greeting(now, name)                   → the one line Today opens with
+ *   localDate(now)                        → YYYY-MM-DD on this machine's clock
+ *
+ * The bucket is derived: an item under WORTH_ASKING confidence is "worth asking", whatever the session said. The order is
+ * fixed and stated: higher confidence first, then PM-owned before agent-owned, then by title.
+ */
+const crypto = require('crypto');
+
+const SOURCES = ['calendar', 'wispr', 'mail', 'jira', 'confluence'];
+const ITEM_SOURCES = [...SOURCES, 'derived'];
+const SOURCE_STATES = ['read', 'not-reached', 'off'];
+const OWNERS = ['pm', 'agent'];
+const EFFORTS = ['minutes', 'an-hour', 'half-day', 'day'];
+const WORTH_ASKING = 0.5;
+const MAX_ITEMS = 12;
+const MAX_EVENTS = 20;
+const INI_RE = /^[a-z0-9][a-z0-9._-]*$/i;
+const clip = (s, n) => String(s == null ? '' : s).replace(/\s+/g, ' ').trim().slice(0, n);
+
+const pad = (n) => String(n).padStart(2, '0');
+const localDate = (now) => { const d = new Date(now); return `${d.getFullYear()}-${pad(d.getMonth() + 1)}-${pad(d.getDate())}`; };
+function greeting(now, name) {
+  const h = new Date(now).getHours();
+  const part = h < 12 ? 'Good morning' : h < 18 ? 'Good afternoon' : 'Good evening';
+  return part + (name ? ', ' + name : '') + '.';
+}
+
+const tooLong = (v, n) => typeof v === 'string' && v.trim().length > n;
+
+/** @returns {{ok:true, brief:object}|{ok:false, error:string}} */
+function validateBrief(raw, ctx = {}) {
+  const now = ctx.now || Date.now();
+  const settings = ctx.settings || {};
+  const on = (src) => !settings.briefSources || settings.briefSources[src] !== false;
+  if (!raw || typeof raw !== 'object' || Array.isArray(raw)) return { ok: false, error: 'a brief is a JSON object' };
+  const date = raw.date === undefined ? localDate(now) : raw.date;
+  if (typeof date !== 'string' || !/^\d{4}-\d{2}-\d{2}$/.test(date) || Number.isNaN(Date.parse(date))) return { ok: false, error: 'date must be YYYY-MM-DD' };
+
+  const sources = {};
+  const given = raw.sources === undefined ? {} : raw.sources;
+  if (!given || typeof given !== 'object' || Array.isArray(given)) return { ok: false, error: `sources must be an object of ${SOURCES.join(', ')} → ${SOURCE_STATES.join(' | ')}` };
+  for (const k of Object.keys(given)) if (!SOURCES.includes(k)) return { ok: false, error: `unknown source "${k}" — one of ${SOURCES.join(', ')}` };
+  for (const k of SOURCES) {
+    const v = given[k] === undefined ? 'not-reached' : given[k];
+    if (!SOURCE_STATES.includes(v)) return { ok: false, error: `source "${k}" must be one of ${SOURCE_STATES.join(', ')}` };
+    if (!on(k) && v === 'read') return { ok: false, error: `"${k}" is switched off in the settings, so it cannot be reported as read` };
+    sources[k] = !on(k) ? 'off' : v;
+  }
+
+  const ev = raw.calendar === undefined ? [] : raw.calendar;
+  if (!Array.isArray(ev)) return { ok: false, error: 'calendar must be a list of events' };
+  if (ev.length > MAX_EVENTS) return { ok: false, error: `calendar has ${ev.length} events — at most ${MAX_EVENTS}` };
+  if (ev.length && sources.calendar !== 'read') return { ok: false, error: 'calendar events were given but calendar is not reported as read' };
+  const calendar = [];
+  for (const [i, e] of ev.entries()) {
+    if (!e || typeof e !== 'object' || Array.isArray(e)) return { ok: false, error: `calendar event ${i + 1} is not an object` };
+    if (typeof e.title !== 'string' || !e.title.trim()) return { ok: false, error: `calendar event ${i + 1} needs a title` };
+    if (tooLong(e.title, 120)) return { ok: false, error: `calendar event ${i + 1}: title is over 120 characters` };
+    if (typeof e.start !== 'string' || Number.isNaN(Date.parse(e.start))) return { ok: false, error: `calendar event ${i + 1}: start must be a date and time` };
+    if (e.end !== undefined && (typeof e.end !== 'string' || Number.isNaN(Date.parse(e.end)))) return { ok: false, error: `calendar event ${i + 1}: end must be a date and time` };
+    if (e.with !== undefined && tooLong(e.with, 120)) return { ok: false, error: `calendar event ${i + 1}: "with" is over 120 characters` };
+    calendar.push({ start: e.start, end: e.end || null, title: clip(e.title, 120), with: e.with ? clip(e.with, 120) : null });
+  }
+  calendar.sort((a, b) => Date.parse(a.start) - Date.parse(b.start));
+
+  const it = raw.items === undefined ? [] : raw.items;
+  if (!Array.isArray(it)) return { ok: false, error: 'items must be a list' };
+  if (it.length > MAX_ITEMS) return { ok: false, error: `items has ${it.length} entries — at most ${MAX_ITEMS}` };
+  const items = [];
+  for (const [i, x] of it.entries()) {
+    const at = `item ${i + 1}`;
+    if (!x || typeof x !== 'object' || Array.isArray(x)) return { ok: false, error: `${at} is not an object` };
+    if (typeof x.title !== 'string' || !x.title.trim()) return { ok: false, error: `${at} needs a title` };
+    if (tooLong(x.title, 140)) return { ok: false, error: `${at}: title is over 140 characters` };
+    if (typeof x.why_now !== 'string' || !x.why_now.trim()) return { ok: false, error: `${at} needs why_now` };
+    if (tooLong(x.why_now, 240)) return { ok: false, error: `${at}: why_now is over 240 characters` };
+    if (x.evidence !== undefined && tooLong(x.evidence, 240)) return { ok: false, error: `${at}: evidence is over 240 characters` };
+    if (!ITEM_SOURCES.includes(x.source)) return { ok: false, error: `${at}: source must be one of ${ITEM_SOURCES.join(', ')}` };
+    if (x.source !== 'derived' && sources[x.source] !== 'read') return { ok: false, error: `${at}: source "${x.source}" is not reported as read, so it cannot support an item` };
+    if (!OWNERS.includes(x.owner)) return { ok: false, error: `${at}: owner must be one of ${OWNERS.join(', ')}` };
+    if (!EFFORTS.includes(x.effort)) return { ok: false, error: `${at}: effort must be one of ${EFFORTS.join(', ')}` };
+    if (typeof x.confidence !== 'number' || !Number.isFinite(x.confidence) || x.confidence < 0 || x.confidence > 1) return { ok: false, error: `${at}: confidence must be a number from 0 to 1` };
+    if (x.initiative_id !== undefined && x.initiative_id !== null && (typeof x.initiative_id !== 'string' || !INI_RE.test(x.initiative_id))) return { ok: false, error: `${at}: initiative_id is not an initiative id` };
+    const title = clip(x.title, 140);
+    items.push({
+      id: crypto.createHash('sha1').update(`${date}|${x.source}|${title}`).digest('hex').slice(0, 12),
+      title, why_now: clip(x.why_now, 240), evidence: clip(x.evidence, 240), source: x.source, initiative_id: x.initiative_id || null,
+      owner: x.owner, effort: x.effort, confidence: x.confidence, worth_asking: x.confidence < WORTH_ASKING,
+    });
+  }
+  items.sort((a, b) => b.confidence - a.confidence || (a.owner === b.owner ? 0 : a.owner === 'pm' ? -1 : 1) || a.title.localeCompare(b.title));
+  const ids = new Set(items.map((x) => x.id));
+  if (ids.size !== items.length) return { ok: false, error: 'two items have the same source and title' };
+
+  let judgment = { used: false };
+  if (raw.judgment !== undefined) {
+    if (!raw.judgment || typeof raw.judgment !== 'object' || typeof raw.judgment.used !== 'boolean') return { ok: false, error: 'judgment must be {"used": true|false}' };
+    if (raw.judgment.used && !settings.briefScoring) return { ok: false, error: 'typed scoring is not switched on in the settings, so a brief cannot say it used it' };
+    judgment = { used: raw.judgment.used };
+  }
+  return { ok: true, brief: { date, generated_at: new Date(now).toISOString(), sources, calendar, priorities: items.filter((x) => !x.worth_asking), worth_asking: items.filter((x) => x.worth_asking), judgment } };
+}
+
+module.exports = { SOURCES, ITEM_SOURCES, SOURCE_STATES, OWNERS, EFFORTS, WORTH_ASKING, MAX_ITEMS, MAX_EVENTS, validateBrief, greeting, localDate };