@humaan/payload-plugin-ai-assistant 0.0.0-stage → 0.1.0

package/dist/chat/history.js

@@ -0,0 +1,165 @@
+import { isToolUIPart } from 'ai';
+import { maxThreadTitleCharacters } from '../constants.js';
+const omitted = {
+    omitted: 'This older result was removed to save space. Call the tool again if you need it.'
+};
+/**
+ * Read results from older turns are the bulk of a long conversation. Plans stay, because later turns refer to them.
+ */ export function pruneToolResults(messages, keepTurns) {
+    const userIndexes = messages.flatMap((message, index)=>message.role === 'user' ? [
+            index
+        ] : []);
+    if (userIndexes.length <= keepTurns) {
+        return messages;
+    }
+    const cutoff = userIndexes[userIndexes.length - keepTurns];
+    return messages.map((message, index)=>{
+        if (index >= cutoff || message.role !== 'assistant') {
+            return message;
+        }
+        return {
+            ...message,
+            parts: message.parts.map((part)=>isToolUIPart(part) && part.type !== 'tool-submitPlan' && part.state === 'output-available' ? {
+                    ...part,
+                    output: omitted
+                } : part)
+        };
+    });
+}
+/**
+ * The JSON field stores an undefined property as null. The message schema allows a missing property but not null,
+ * so a stored thread would fail validation on the next turn. Values inside tool inputs and outputs are left alone.
+ * Empty assistant replies are dropped.
+ */ export function restoreStoredMessages(messages) {
+    return messages.flatMap((message)=>{
+        if (!isRecord(message) || !Array.isArray(message.parts)) {
+            return [];
+        }
+        // A reply that failed before it said anything has no parts, and the model API rejects an empty turn.
+        if (message.role === 'assistant' && message.parts.length === 0) {
+            return [];
+        }
+        const restored = withoutNulls(message);
+        restored.parts = message.parts.filter(isRecord).map(withoutNulls);
+        if (isRecord(message.metadata)) {
+            restored.metadata = withoutNulls(message.metadata);
+        }
+        return [
+            restored
+        ];
+    });
+}
+/**
+ * Adds what the model needs to know about each user message: the open document and its attachments.
+ * This is added for the model run only. The stored thread keeps what the editor typed.
+ */ export function withTurnContext(messages, context) {
+    const lastUser = messages.map((message)=>message.role).lastIndexOf('user');
+    return messages.map((message, index)=>{
+        if (message.role !== 'user') {
+            return message;
+        }
+        const notes = [];
+        if (message.metadata?.context) {
+            notes.push(contextNote(message.metadata.context));
+        }
+        const attachments = message.metadata?.attachments ?? [];
+        const fileParts = [];
+        for (const attachment of attachments){
+            const file = context.files.find((item)=>item.index === attachment.index);
+            notes.push(file ? attachmentNote(file) : `Attachment index ${attachment.index}: ${attachment.name}. No longer available.`);
+            const part = file ? context.fileParts.get(file.index) : undefined;
+            if (part) {
+                fileParts.push(part);
+            }
+        }
+        if (index === lastUser && context.openDocument) {
+            notes.push(`Outline of the open document, including unsaved changes. Text is cut and each block is one line. Call readDocument with a path for full values:\n${context.openDocument}`);
+        }
+        if (notes.length === 0 && fileParts.length === 0) {
+            return message;
+        }
+        const note = {
+            type: 'text',
+            text: `<editor-context>\n${notes.join('\n')}\n</editor-context>`
+        };
+        return {
+            ...message,
+            parts: [
+                note,
+                ...message.parts,
+                ...fileParts
+            ]
+        };
+    });
+}
+/** Records what the editor did with a plan, so the card and the model both see it. */ export function markPlan(messages, planId, update) {
+    let changed = false;
+    const next = messages.map((message)=>{
+        if (message.role !== 'assistant') {
+            return message;
+        }
+        let touched = false;
+        const parts = message.parts.map((part)=>{
+            if (part.type !== 'tool-submitPlan' || part.state !== 'output-available') {
+                return part;
+            }
+            if (!part.output.ok || part.output.plan.id !== planId) {
+                return part;
+            }
+            touched = true;
+            return {
+                ...part,
+                output: {
+                    ...part.output,
+                    ...update
+                }
+            };
+        });
+        if (!touched) {
+            return message;
+        }
+        changed = true;
+        return {
+            ...message,
+            parts
+        };
+    });
+    return {
+        messages: next,
+        changed
+    };
+}
+export function messageText(message) {
+    return message.parts.flatMap((part)=>part.type === 'text' ? [
+            part.text
+        ] : []).join('\n').trim();
+}
+export function threadTitle(text) {
+    const line = text.replace(/\s+/g, ' ').trim();
+    if (!line) {
+        return 'Attached files';
+    }
+    if (line.length <= maxThreadTitleCharacters) {
+        return line;
+    }
+    return `${line.slice(0, maxThreadTitleCharacters - 1).trimEnd()}…`;
+}
+function contextNote(context) {
+    const id = context.id ? `, id ${context.id}` : '';
+    return `Open in the editor when this was sent: ${context.label} (${context.kind} ${context.slug}${id}).`;
+}
+function attachmentNote(file) {
+    if (!file.collection) {
+        return `Attachment index ${file.index}: ${file.name} (${file.type}). It can be read, but not saved: no upload collection the assistant may change accepts it.`;
+    }
+    const saves = file.savesImmediately ? 'saves immediately' : 'saves as a draft';
+    return `Attachment index ${file.index}: ${file.name} (${file.type}). If a plan lists it, it ${saves} to ${file.collection}.`;
+}
+function withoutNulls(value) {
+    return Object.fromEntries(Object.entries(value).filter(([, item])=>item !== null));
+}
+function isRecord(value) {
+    return Boolean(value) && typeof value === 'object' && !Array.isArray(value);
+}
+
+//# sourceMappingURL=history.js.map

package/dist/chat/history.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/chat/history.ts"],"sourcesContent":["import type { FileUIPart } from 'ai'\n\nimport { isToolUIPart } from 'ai'\n\nimport type { IncomingFile } from '../plan/parsePlan.js'\nimport type { AssistantChange, PageContext, PlanStatus } from '../types.js'\nimport type { AssistantUIMessage } from './messages.js'\n\nimport { maxThreadTitleCharacters } from '../constants.js'\n\ntype Part = AssistantUIMessage['parts'][number]\n\nconst omitted = {\n  omitted: 'This older result was removed to save space. Call the tool again if you need it.',\n}\n\n/**\n * Read results from older turns are the bulk of a long conversation. Plans stay, because later turns refer to them.\n */\nexport function pruneToolResults(\n  messages: AssistantUIMessage[],\n  keepTurns: number,\n): AssistantUIMessage[] {\n  const userIndexes = messages.flatMap((message, index) => (message.role === 'user' ? [index] : []))\n  if (userIndexes.length <= keepTurns) {\n    return messages\n  }\n  const cutoff = userIndexes[userIndexes.length - keepTurns]\n\n  return messages.map((message, index) => {\n    if (index >= cutoff || message.role !== 'assistant') {\n      return message\n    }\n    return {\n      ...message,\n      parts: message.parts.map((part) =>\n        isToolUIPart(part) && part.type !== 'tool-submitPlan' && part.state === 'output-available'\n          ? ({ ...part, output: omitted } as Part)\n          : part,\n      ),\n    }\n  })\n}\n\n/**\n * The JSON field stores an undefined property as null. The message schema allows a missing property but not null,\n * so a stored thread would fail validation on the next turn. Values inside tool inputs and outputs are left alone.\n * Empty assistant replies are dropped.\n */\nexport function restoreStoredMessages(messages: unknown[]): AssistantUIMessage[] {\n  return messages.flatMap((message) => {\n    if (!isRecord(message) || !Array.isArray(message.parts)) {\n      return []\n    }\n    // A reply that failed before it said anything has no parts, and the model API rejects an empty turn.\n    if (message.role === 'assistant' && message.parts.length === 0) {\n      return []\n    }\n    const restored = withoutNulls(message)\n    restored.parts = message.parts.filter(isRecord).map(withoutNulls)\n    if (isRecord(message.metadata)) {\n      restored.metadata = withoutNulls(message.metadata)\n    }\n    return [restored as unknown as AssistantUIMessage]\n  })\n}\n\nexport interface TurnContext {\n  /** Images and PDFs the model can look at, by conversation index. */\n  fileParts: ReadonlyMap<number, FileUIPart>\n  /** Files this request uploaded, by conversation index. An earlier file missing here is no longer available. */\n  files: readonly IncomingFile[]\n  /** The open document's current values, added to the newest message only. */\n  openDocument?: string\n}\n\n/**\n * Adds what the model needs to know about each user message: the open document and its attachments.\n * This is added for the model run only. The stored thread keeps what the editor typed.\n */\nexport function withTurnContext(\n  messages: AssistantUIMessage[],\n  context: TurnContext,\n): AssistantUIMessage[] {\n  const lastUser = messages.map((message) => message.role).lastIndexOf('user')\n\n  return messages.map((message, index) => {\n    if (message.role !== 'user') {\n      return message\n    }\n    const notes: string[] = []\n    if (message.metadata?.context) {\n      notes.push(contextNote(message.metadata.context))\n    }\n    const attachments = message.metadata?.attachments ?? []\n    const fileParts: FileUIPart[] = []\n    for (const attachment of attachments) {\n      const file = context.files.find((item) => item.index === attachment.index)\n      notes.push(\n        file\n          ? attachmentNote(file)\n          : `Attachment index ${attachment.index}: ${attachment.name}. No longer available.`,\n      )\n      const part = file ? context.fileParts.get(file.index) : undefined\n      if (part) {\n        fileParts.push(part)\n      }\n    }\n    if (index === lastUser && context.openDocument) {\n      notes.push(\n        `Outline of the open document, including unsaved changes. Text is cut and each block is one line. Call readDocument with a path for full values:\\n${context.openDocument}`,\n      )\n    }\n    if (notes.length === 0 && fileParts.length === 0) {\n      return message\n    }\n\n    const note: Part = {\n      type: 'text',\n      text: `<editor-context>\\n${notes.join('\\n')}\\n</editor-context>`,\n    }\n    return { ...message, parts: [note, ...message.parts, ...fileParts] }\n  })\n}\n\n/** Records what the editor did with a plan, so the card and the model both see it. */\nexport function markPlan(\n  messages: AssistantUIMessage[],\n  planId: string,\n  update: { changes?: AssistantChange[]; status: PlanStatus },\n): { changed: boolean; messages: AssistantUIMessage[] } {\n  let changed = false\n  const next = messages.map((message) => {\n    if (message.role !== 'assistant') {\n      return message\n    }\n    let touched = false\n    const parts = message.parts.map((part) => {\n      if (part.type !== 'tool-submitPlan' || part.state !== 'output-available') {\n        return part\n      }\n      if (!part.output.ok || part.output.plan.id !== planId) {\n        return part\n      }\n      touched = true\n      return { ...part, output: { ...part.output, ...update } }\n    })\n    if (!touched) {\n      return message\n    }\n    changed = true\n    return { ...message, parts }\n  })\n  return { messages: next, changed }\n}\n\nexport function messageText(message: AssistantUIMessage): string {\n  return message.parts\n    .flatMap((part) => (part.type === 'text' ? [part.text] : []))\n    .join('\\n')\n    .trim()\n}\n\nexport function threadTitle(text: string): string {\n  const line = text.replace(/\\s+/g, ' ').trim()\n  if (!line) {\n    return 'Attached files'\n  }\n  if (line.length <= maxThreadTitleCharacters) {\n    return line\n  }\n  return `${line.slice(0, maxThreadTitleCharacters - 1).trimEnd()}…`\n}\n\nfunction contextNote(context: PageContext): string {\n  const id = context.id ? `, id ${context.id}` : ''\n  return `Open in the editor when this was sent: ${context.label} (${context.kind} ${context.slug}${id}).`\n}\n\nfunction attachmentNote(file: IncomingFile): string {\n  if (!file.collection) {\n    return `Attachment index ${file.index}: ${file.name} (${file.type}). It can be read, but not saved: no upload collection the assistant may change accepts it.`\n  }\n  const saves = file.savesImmediately ? 'saves immediately' : 'saves as a draft'\n  return `Attachment index ${file.index}: ${file.name} (${file.type}). If a plan lists it, it ${saves} to ${file.collection}.`\n}\n\nfunction withoutNulls(value: Record<string, unknown>): Record<string, unknown> {\n  return Object.fromEntries(Object.entries(value).filter(([, item]) => item !== null))\n}\n\nfunction isRecord(value: unknown): value is Record<string, unknown> {\n  return Boolean(value) && typeof value === 'object' && !Array.isArray(value)\n}\n"],"names":["isToolUIPart","maxThreadTitleCharacters","omitted","pruneToolResults","messages","keepTurns","userIndexes","flatMap","message","index","role","length","cutoff","map","parts","part","type","state","output","restoreStoredMessages","isRecord","Array","isArray","restored","withoutNulls","filter","metadata","withTurnContext","context","lastUser","lastIndexOf","notes","push","contextNote","attachments","fileParts","attachment","file","files","find","item","attachmentNote","name","get","undefined","openDocument","note","text","join","markPlan","planId","update","changed","next","touched","ok","plan","id","messageText","trim","threadTitle","line","replace","slice","trimEnd","label","kind","slug","collection","saves","savesImmediately","value","Object","fromEntries","entries","Boolean"],"mappings":"AAEA,SAASA,YAAY,QAAQ,KAAI;AAMjC,SAASC,wBAAwB,QAAQ,kBAAiB;AAI1D,MAAMC,UAAU;IACdA,SAAS;AACX;AAEA;;CAEC,GACD,OAAO,SAASC,iBACdC,QAA8B,EAC9BC,SAAiB;IAEjB,MAAMC,cAAcF,SAASG,OAAO,CAAC,CAACC,SAASC,QAAWD,QAAQE,IAAI,KAAK,SAAS;YAACD;SAAM,GAAG,EAAE;IAChG,IAAIH,YAAYK,MAAM,IAAIN,WAAW;QACnC,OAAOD;IACT;IACA,MAAMQ,SAASN,WAAW,CAACA,YAAYK,MAAM,GAAGN,UAAU;IAE1D,OAAOD,SAASS,GAAG,CAAC,CAACL,SAASC;QAC5B,IAAIA,SAASG,UAAUJ,QAAQE,IAAI,KAAK,aAAa;YACnD,OAAOF;QACT;QACA,OAAO;YACL,GAAGA,OAAO;YACVM,OAAON,QAAQM,KAAK,CAACD,GAAG,CAAC,CAACE,OACxBf,aAAae,SAASA,KAAKC,IAAI,KAAK,qBAAqBD,KAAKE,KAAK,KAAK,qBACnE;oBAAE,GAAGF,IAAI;oBAAEG,QAAQhB;gBAAQ,IAC5Ba;QAER;IACF;AACF;AAEA;;;;CAIC,GACD,OAAO,SAASI,sBAAsBf,QAAmB;IACvD,OAAOA,SAASG,OAAO,CAAC,CAACC;QACvB,IAAI,CAACY,SAASZ,YAAY,CAACa,MAAMC,OAAO,CAACd,QAAQM,KAAK,GAAG;YACvD,OAAO,EAAE;QACX;QACA,qGAAqG;QACrG,IAAIN,QAAQE,IAAI,KAAK,eAAeF,QAAQM,KAAK,CAACH,MAAM,KAAK,GAAG;YAC9D,OAAO,EAAE;QACX;QACA,MAAMY,WAAWC,aAAahB;QAC9Be,SAAST,KAAK,GAAGN,QAAQM,KAAK,CAACW,MAAM,CAACL,UAAUP,GAAG,CAACW;QACpD,IAAIJ,SAASZ,QAAQkB,QAAQ,GAAG;YAC9BH,SAASG,QAAQ,GAAGF,aAAahB,QAAQkB,QAAQ;QACnD;QACA,OAAO;YAACH;SAA0C;IACpD;AACF;AAWA;;;CAGC,GACD,OAAO,SAASI,gBACdvB,QAA8B,EAC9BwB,OAAoB;IAEpB,MAAMC,WAAWzB,SAASS,GAAG,CAAC,CAACL,UAAYA,QAAQE,IAAI,EAAEoB,WAAW,CAAC;IAErE,OAAO1B,SAASS,GAAG,CAAC,CAACL,SAASC;QAC5B,IAAID,QAAQE,IAAI,KAAK,QAAQ;YAC3B,OAAOF;QACT;QACA,MAAMuB,QAAkB,EAAE;QAC1B,IAAIvB,QAAQkB,QAAQ,EAAEE,SAAS;YAC7BG,MAAMC,IAAI,CAACC,YAAYzB,QAAQkB,QAAQ,CAACE,OAAO;QACjD;QACA,MAAMM,cAAc1B,QAAQkB,QAAQ,EAAEQ,eAAe,EAAE;QACvD,MAAMC,YAA0B,EAAE;QAClC,KAAK,MAAMC,cAAcF,YAAa;YACpC,MAAMG,OAAOT,QAAQU,KAAK,CAACC,IAAI,CAAC,CAACC,OAASA,KAAK/B,KAAK,KAAK2B,WAAW3B,KAAK;YACzEsB,MAAMC,IAAI,CACRK,OACII,eAAeJ,QACf,CAAC,iBAAiB,EAAED,WAAW3B,KAAK,CAAC,EAAE,EAAE2B,WAAWM,IAAI,CAAC,sBAAsB,CAAC;YAEtF,MAAM3B,OAAOsB,OAAOT,QAAQO,SAAS,CAACQ,GAAG,CAACN,KAAK5B,KAAK,IAAImC;YACxD,IAAI7B,MAAM;gBACRoB,UAAUH,IAAI,CAACjB;YACjB;QACF;QACA,IAAIN,UAAUoB,YAAYD,QAAQiB,YAAY,EAAE;YAC9Cd,MAAMC,IAAI,CACR,CAAC,iJAAiJ,EAAEJ,QAAQiB,YAAY,EAAE;QAE9K;QACA,IAAId,MAAMpB,MAAM,KAAK,KAAKwB,UAAUxB,MAAM,KAAK,GAAG;YAChD,OAAOH;QACT;QAEA,MAAMsC,OAAa;YACjB9B,MAAM;YACN+B,MAAM,CAAC,kBAAkB,EAAEhB,MAAMiB,IAAI,CAAC,MAAM,mBAAmB,CAAC;QAClE;QACA,OAAO;YAAE,GAAGxC,OAAO;YAAEM,OAAO;gBAACgC;mBAAStC,QAAQM,KAAK;mBAAKqB;aAAU;QAAC;IACrE;AACF;AAEA,oFAAoF,GACpF,OAAO,SAASc,SACd7C,QAA8B,EAC9B8C,MAAc,EACdC,MAA2D;IAE3D,IAAIC,UAAU;IACd,MAAMC,OAAOjD,SAASS,GAAG,CAAC,CAACL;QACzB,IAAIA,QAAQE,IAAI,KAAK,aAAa;YAChC,OAAOF;QACT;QACA,IAAI8C,UAAU;QACd,MAAMxC,QAAQN,QAAQM,KAAK,CAACD,GAAG,CAAC,CAACE;YAC/B,IAAIA,KAAKC,IAAI,KAAK,qBAAqBD,KAAKE,KAAK,KAAK,oBAAoB;gBACxE,OAAOF;YACT;YACA,IAAI,CAACA,KAAKG,MAAM,CAACqC,EAAE,IAAIxC,KAAKG,MAAM,CAACsC,IAAI,CAACC,EAAE,KAAKP,QAAQ;gBACrD,OAAOnC;YACT;YACAuC,UAAU;YACV,OAAO;gBAAE,GAAGvC,IAAI;gBAAEG,QAAQ;oBAAE,GAAGH,KAAKG,MAAM;oBAAE,GAAGiC,MAAM;gBAAC;YAAE;QAC1D;QACA,IAAI,CAACG,SAAS;YACZ,OAAO9C;QACT;QACA4C,UAAU;QACV,OAAO;YAAE,GAAG5C,OAAO;YAAEM;QAAM;IAC7B;IACA,OAAO;QAAEV,UAAUiD;QAAMD;IAAQ;AACnC;AAEA,OAAO,SAASM,YAAYlD,OAA2B;IACrD,OAAOA,QAAQM,KAAK,CACjBP,OAAO,CAAC,CAACQ,OAAUA,KAAKC,IAAI,KAAK,SAAS;YAACD,KAAKgC,IAAI;SAAC,GAAG,EAAE,EAC1DC,IAAI,CAAC,MACLW,IAAI;AACT;AAEA,OAAO,SAASC,YAAYb,IAAY;IACtC,MAAMc,OAAOd,KAAKe,OAAO,CAAC,QAAQ,KAAKH,IAAI;IAC3C,IAAI,CAACE,MAAM;QACT,OAAO;IACT;IACA,IAAIA,KAAKlD,MAAM,IAAIV,0BAA0B;QAC3C,OAAO4D;IACT;IACA,OAAO,GAAGA,KAAKE,KAAK,CAAC,GAAG9D,2BAA2B,GAAG+D,OAAO,GAAG,CAAC,CAAC;AACpE;AAEA,SAAS/B,YAAYL,OAAoB;IACvC,MAAM6B,KAAK7B,QAAQ6B,EAAE,GAAG,CAAC,KAAK,EAAE7B,QAAQ6B,EAAE,EAAE,GAAG;IAC/C,OAAO,CAAC,uCAAuC,EAAE7B,QAAQqC,KAAK,CAAC,EAAE,EAAErC,QAAQsC,IAAI,CAAC,CAAC,EAAEtC,QAAQuC,IAAI,GAAGV,GAAG,EAAE,CAAC;AAC1G;AAEA,SAAShB,eAAeJ,IAAkB;IACxC,IAAI,CAACA,KAAK+B,UAAU,EAAE;QACpB,OAAO,CAAC,iBAAiB,EAAE/B,KAAK5B,KAAK,CAAC,EAAE,EAAE4B,KAAKK,IAAI,CAAC,EAAE,EAAEL,KAAKrB,IAAI,CAAC,2FAA2F,CAAC;IAChK;IACA,MAAMqD,QAAQhC,KAAKiC,gBAAgB,GAAG,sBAAsB;IAC5D,OAAO,CAAC,iBAAiB,EAAEjC,KAAK5B,KAAK,CAAC,EAAE,EAAE4B,KAAKK,IAAI,CAAC,EAAE,EAAEL,KAAKrB,IAAI,CAAC,0BAA0B,EAAEqD,MAAM,IAAI,EAAEhC,KAAK+B,UAAU,CAAC,CAAC,CAAC;AAC9H;AAEA,SAAS5C,aAAa+C,KAA8B;IAClD,OAAOC,OAAOC,WAAW,CAACD,OAAOE,OAAO,CAACH,OAAO9C,MAAM,CAAC,CAAC,GAAGe,KAAK,GAAKA,SAAS;AAChF;AAEA,SAASpB,SAASmD,KAAc;IAC9B,OAAOI,QAAQJ,UAAU,OAAOA,UAAU,YAAY,CAAClD,MAAMC,OAAO,CAACiD;AACvE"}

package/dist/chat/messages.d.ts

@@ -0,0 +1,5 @@
+import type { InferUITools, UIDataTypes, UIMessage } from 'ai';
+import type { AssistantMessageMetadata } from '../types.js';
+import type { AssistantTools } from './tools.js';
+/** A message in an assistant conversation. Shared by the chat endpoint, the stored thread, and the drawer. */
+export type AssistantUIMessage = UIMessage<AssistantMessageMetadata, UIDataTypes, InferUITools<AssistantTools>>;

package/dist/chat/messages.js

@@ -0,0 +1,3 @@
+/** A message in an assistant conversation. Shared by the chat endpoint, the stored thread, and the drawer. */ export { };
+
+//# sourceMappingURL=messages.js.map

package/dist/chat/messages.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/chat/messages.ts"],"sourcesContent":["import type { InferUITools, UIDataTypes, UIMessage } from 'ai'\n\nimport type { AssistantMessageMetadata } from '../types.js'\nimport type { AssistantTools } from './tools.js'\n\n/** A message in an assistant conversation. Shared by the chat endpoint, the stored thread, and the drawer. */\nexport type AssistantUIMessage = UIMessage<\n  AssistantMessageMetadata,\n  UIDataTypes,\n  InferUITools<AssistantTools>\n>\n"],"names":[],"mappings":"AAKA,4GAA4G,GAC5G,WAIC"}

package/dist/chat/threads.d.ts

@@ -0,0 +1,33 @@
+import type { PayloadRequest } from 'payload';
+import type { AssistantChange, PlanStatus } from '../types.js';
+import type { AssistantUIMessage } from './messages.js';
+/**
+ * A file attached in the conversation, stored in the attachments collection. Conversations from before
+ * attachments were stored have no id, and their files can no longer be read.
+ */
+export interface ThreadFile {
+    id?: string;
+    name: string;
+    size: number;
+    type: string;
+}
+export interface StoredThread {
+    chatId: string;
+    files: ThreadFile[];
+    id: string;
+    messages: AssistantUIMessage[];
+    title: string;
+}
+/** The editor's own thread. Read access on the collection is limited to the owner. */
+export declare function findThread(req: PayloadRequest, chatId: string): Promise<StoredThread | undefined>;
+/**
+ * Threads are written only by these endpoints, never through the REST API, so a thread's
+ * history cannot be edited to put words in the assistant's mouth. Callers check ownership first.
+ */
+export declare function saveThread(req: PayloadRequest, thread: {
+    id?: string;
+} & Omit<StoredThread, 'id'>): Promise<string>;
+export declare function markPlanInThread(req: PayloadRequest, chatId: string, planId: string, update: {
+    changes?: AssistantChange[];
+    status: PlanStatus;
+}): Promise<void>;

package/dist/chat/threads.js

@@ -0,0 +1,77 @@
+import { aiAssistantThreadSlug } from '../constants.js';
+import { userIdOf } from '../settings.js';
+import { markPlan, restoreStoredMessages } from './history.js';
+/** The editor's own thread. Read access on the collection is limited to the owner. */ export async function findThread(req, chatId) {
+    const found = await req.payload.find({
+        collection: aiAssistantThreadSlug,
+        where: {
+            chatId: {
+                equals: chatId
+            }
+        },
+        limit: 1,
+        depth: 0,
+        pagination: false,
+        overrideAccess: false,
+        req,
+        user: req.user
+    });
+    const doc = found.docs[0];
+    if (!doc) {
+        return undefined;
+    }
+    return {
+        id: String(doc.id),
+        chatId,
+        title: typeof doc.title === 'string' ? doc.title : '',
+        messages: Array.isArray(doc.messages) ? restoreStoredMessages(doc.messages) : [],
+        files: Array.isArray(doc.files) ? doc.files : []
+    };
+}
+/**
+ * Threads are written only by these endpoints, never through the REST API, so a thread's
+ * history cannot be edited to put words in the assistant's mouth. Callers check ownership first.
+ */ export async function saveThread(req, thread) {
+    const data = {
+        chatId: thread.chatId,
+        title: thread.title,
+        messages: thread.messages,
+        files: thread.files
+    };
+    if (thread.id) {
+        await req.payload.update({
+            collection: aiAssistantThreadSlug,
+            id: thread.id,
+            data: data,
+            depth: 0,
+            req
+        });
+        return thread.id;
+    }
+    const created = await req.payload.create({
+        collection: aiAssistantThreadSlug,
+        data: {
+            ...data,
+            owner: userIdOf(req.user)
+        },
+        depth: 0,
+        req
+    });
+    return String(created.id);
+}
+export async function markPlanInThread(req, chatId, planId, update) {
+    const thread = await findThread(req, chatId);
+    if (!thread) {
+        return;
+    }
+    const marked = markPlan(thread.messages, planId, update);
+    if (!marked.changed) {
+        return;
+    }
+    await saveThread(req, {
+        ...thread,
+        messages: marked.messages
+    });
+}
+
+//# sourceMappingURL=threads.js.map

package/dist/chat/threads.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/chat/threads.ts"],"sourcesContent":["import type { CollectionSlug, PayloadRequest } from 'payload'\n\nimport type { AssistantChange, PlanStatus } from '../types.js'\nimport type { AssistantUIMessage } from './messages.js'\n\nimport { aiAssistantThreadSlug } from '../constants.js'\nimport { userIdOf } from '../settings.js'\nimport { markPlan, restoreStoredMessages } from './history.js'\n\n/**\n * A file attached in the conversation, stored in the attachments collection. Conversations from before\n * attachments were stored have no id, and their files can no longer be read.\n */\nexport interface ThreadFile {\n  id?: string\n  name: string\n  size: number\n  type: string\n}\n\nexport interface StoredThread {\n  chatId: string\n  files: ThreadFile[]\n  id: string\n  messages: AssistantUIMessage[]\n  title: string\n}\n\n/** The editor's own thread. Read access on the collection is limited to the owner. */\nexport async function findThread(\n  req: PayloadRequest,\n  chatId: string,\n): Promise<StoredThread | undefined> {\n  const found = await req.payload.find({\n    collection: aiAssistantThreadSlug as CollectionSlug,\n    where: { chatId: { equals: chatId } },\n    limit: 1,\n    depth: 0,\n    pagination: false,\n    overrideAccess: false,\n    req,\n    user: req.user,\n  })\n  const doc = found.docs[0] as unknown as Record<string, unknown> | undefined\n  if (!doc) {\n    return undefined\n  }\n  return {\n    id: String(doc.id),\n    chatId,\n    title: typeof doc.title === 'string' ? doc.title : '',\n    messages: Array.isArray(doc.messages) ? restoreStoredMessages(doc.messages) : [],\n    files: Array.isArray(doc.files) ? (doc.files as ThreadFile[]) : [],\n  }\n}\n\n/**\n * Threads are written only by these endpoints, never through the REST API, so a thread's\n * history cannot be edited to put words in the assistant's mouth. Callers check ownership first.\n */\nexport async function saveThread(\n  req: PayloadRequest,\n  thread: { id?: string } & Omit<StoredThread, 'id'>,\n): Promise<string> {\n  const data = {\n    chatId: thread.chatId,\n    title: thread.title,\n    messages: thread.messages,\n    files: thread.files,\n  }\n  if (thread.id) {\n    await req.payload.update({\n      collection: aiAssistantThreadSlug as CollectionSlug,\n      id: thread.id,\n      data: data as never,\n      depth: 0,\n      req,\n    })\n    return thread.id\n  }\n  const created = await req.payload.create({\n    collection: aiAssistantThreadSlug as CollectionSlug,\n    data: { ...data, owner: userIdOf(req.user) } as never,\n    depth: 0,\n    req,\n  })\n  return String((created as { id: unknown }).id)\n}\n\nexport async function markPlanInThread(\n  req: PayloadRequest,\n  chatId: string,\n  planId: string,\n  update: { changes?: AssistantChange[]; status: PlanStatus },\n): Promise<void> {\n  const thread = await findThread(req, chatId)\n  if (!thread) {\n    return\n  }\n  const marked = markPlan(thread.messages, planId, update)\n  if (!marked.changed) {\n    return\n  }\n  await saveThread(req, { ...thread, messages: marked.messages })\n}\n"],"names":["aiAssistantThreadSlug","userIdOf","markPlan","restoreStoredMessages","findThread","req","chatId","found","payload","find","collection","where","equals","limit","depth","pagination","overrideAccess","user","doc","docs","undefined","id","String","title","messages","Array","isArray","files","saveThread","thread","data","update","created","create","owner","markPlanInThread","planId","marked","changed"],"mappings":"AAKA,SAASA,qBAAqB,QAAQ,kBAAiB;AACvD,SAASC,QAAQ,QAAQ,iBAAgB;AACzC,SAASC,QAAQ,EAAEC,qBAAqB,QAAQ,eAAc;AAqB9D,oFAAoF,GACpF,OAAO,eAAeC,WACpBC,GAAmB,EACnBC,MAAc;IAEd,MAAMC,QAAQ,MAAMF,IAAIG,OAAO,CAACC,IAAI,CAAC;QACnCC,YAAYV;QACZW,OAAO;YAAEL,QAAQ;gBAAEM,QAAQN;YAAO;QAAE;QACpCO,OAAO;QACPC,OAAO;QACPC,YAAY;QACZC,gBAAgB;QAChBX;QACAY,MAAMZ,IAAIY,IAAI;IAChB;IACA,MAAMC,MAAMX,MAAMY,IAAI,CAAC,EAAE;IACzB,IAAI,CAACD,KAAK;QACR,OAAOE;IACT;IACA,OAAO;QACLC,IAAIC,OAAOJ,IAAIG,EAAE;QACjBf;QACAiB,OAAO,OAAOL,IAAIK,KAAK,KAAK,WAAWL,IAAIK,KAAK,GAAG;QACnDC,UAAUC,MAAMC,OAAO,CAACR,IAAIM,QAAQ,IAAIrB,sBAAsBe,IAAIM,QAAQ,IAAI,EAAE;QAChFG,OAAOF,MAAMC,OAAO,CAACR,IAAIS,KAAK,IAAKT,IAAIS,KAAK,GAAoB,EAAE;IACpE;AACF;AAEA;;;CAGC,GACD,OAAO,eAAeC,WACpBvB,GAAmB,EACnBwB,MAAkD;IAElD,MAAMC,OAAO;QACXxB,QAAQuB,OAAOvB,MAAM;QACrBiB,OAAOM,OAAON,KAAK;QACnBC,UAAUK,OAAOL,QAAQ;QACzBG,OAAOE,OAAOF,KAAK;IACrB;IACA,IAAIE,OAAOR,EAAE,EAAE;QACb,MAAMhB,IAAIG,OAAO,CAACuB,MAAM,CAAC;YACvBrB,YAAYV;YACZqB,IAAIQ,OAAOR,EAAE;YACbS,MAAMA;YACNhB,OAAO;YACPT;QACF;QACA,OAAOwB,OAAOR,EAAE;IAClB;IACA,MAAMW,UAAU,MAAM3B,IAAIG,OAAO,CAACyB,MAAM,CAAC;QACvCvB,YAAYV;QACZ8B,MAAM;YAAE,GAAGA,IAAI;YAAEI,OAAOjC,SAASI,IAAIY,IAAI;QAAE;QAC3CH,OAAO;QACPT;IACF;IACA,OAAOiB,OAAO,AAACU,QAA4BX,EAAE;AAC/C;AAEA,OAAO,eAAec,iBACpB9B,GAAmB,EACnBC,MAAc,EACd8B,MAAc,EACdL,MAA2D;IAE3D,MAAMF,SAAS,MAAMzB,WAAWC,KAAKC;IACrC,IAAI,CAACuB,QAAQ;QACX;IACF;IACA,MAAMQ,SAASnC,SAAS2B,OAAOL,QAAQ,EAAEY,QAAQL;IACjD,IAAI,CAACM,OAAOC,OAAO,EAAE;QACnB;IACF;IACA,MAAMV,WAAWvB,KAAK;QAAE,GAAGwB,MAAM;QAAEL,UAAUa,OAAOb,QAAQ;IAAC;AAC/D"}

package/dist/chat/tools.d.ts

@@ -0,0 +1,76 @@
+import type { JSONValue } from 'ai';
+import type { PayloadRequest } from 'payload';
+import type { IncomingFile } from '../plan/parsePlan.js';
+import type { AiAssistantPluginOptions, PageContext, SubmitPlanOutput } from '../types.js';
+export interface AssistantToolsOptions {
+    /** The conversation a submitted plan belongs to, so applying it can update the plan card. */
+    chatId: string;
+    collectionRules?: AiAssistantPluginOptions['collectionRules'];
+    /** Files attached to the conversation that this request uploaded again. */
+    files: IncomingFile[];
+    /** Called once a plan is saved, so the model run can stop. */
+    onPlan: () => void;
+    /** The document open in the editor, read from its form, so reads include unsaved changes. */
+    openDocument?: OpenDocument;
+    req: PayloadRequest;
+}
+export interface OpenDocument {
+    context: PageContext;
+    /** The form values as the assistant reads them. */
+    document: unknown;
+}
+export type PlanInput = Record<string, JSONValue>;
+/**
+ * Every tool reads with the editor's access. Only submitPlan writes, and it writes a plan, not the documents.
+ */
+export declare function assistantTools({ req, chatId, collectionRules, files, onPlan, openDocument, }: AssistantToolsOptions): {
+    listTargets: import("ai").Tool<Record<string, never>, {
+        targets: {
+            slug: string;
+            kind: import("../types.js").PlanTargetKind;
+            label: string;
+            drafts: boolean;
+            upload: boolean;
+            canChange: boolean;
+        }[];
+    }>;
+    describeTarget: import("ai").Tool<{
+        kind: "collection" | "global";
+        slug: string;
+        blocks?: string[] | undefined;
+    }, {
+        blocks?: string;
+        drafts: boolean;
+        guide: string;
+        note?: string;
+        rules?: string;
+        upload: boolean;
+    } | {
+        error: string;
+    }>;
+    searchDocuments: import("ai").Tool<{
+        collection: string;
+        query: string;
+        filters?: {
+            field: string;
+            operator: "equals" | "not_equals" | "in" | "exists" | "like";
+            value: string | number | boolean | (string | number)[];
+        }[] | undefined;
+        limit?: number | undefined;
+    }, unknown>;
+    readDocument: import("ai").Tool<{
+        kind: "collection" | "global";
+        slug: string;
+        id?: string | undefined;
+        path?: string | undefined;
+    }, unknown>;
+    submitPlan: import("ai").Tool<PlanInput, SubmitPlanOutput>;
+};
+export type AssistantTools = ReturnType<typeof assistantTools>;
+/** Reads with the editor's access, so the assistant sees only what the editor can see. */
+export declare function readDocument(req: PayloadRequest, kind: 'collection' | 'global', slug: string, id: string | undefined): Promise<{
+    document: unknown;
+    label: string;
+} | {
+    error: string;
+}>;