@simmalugnt-se/payload-editor-assistant 0.3.3 → 0.5.0

package/dist/components/selection-dom.d.ts

@@ -5,6 +5,10 @@
  */
 /** Visual editing announces preview clicks with this event: `detail: { path }`, `path: null` when cleared. */
 export declare const VISUAL_EDITING_SELECT_EVENT = "visual-editing:select";
+/** Content health announces a field it brought into view from a work list link: `detail: { path }`. */
+export declare const CONTENT_HEALTH_SELECT_EVENT = "content-health:select";
+/** Edit view parameter from content health's work list: a prompt to put in the message box. */
+export declare const ASK_PARAM = "ask";
 /** Visual editing keeps its preview outline when the editor clicks inside this attribute. */
 export declare const KEEP_SELECTION_ATTR = "data-visual-editing-keep-selection";
 export type DomSelection = {

package/dist/components/selection-dom.js

@@ -5,6 +5,10 @@
  */
 /** Visual editing announces preview clicks with this event: `detail: { path }`, `path: null` when cleared. */
 export const VISUAL_EDITING_SELECT_EVENT = "visual-editing:select";
+/** Content health announces a field it brought into view from a work list link: `detail: { path }`. */
+export const CONTENT_HEALTH_SELECT_EVENT = "content-health:select";
+/** Edit view parameter from content health's work list: a prompt to put in the message box. */
+export const ASK_PARAM = "ask";
 /** Visual editing keeps its preview outline when the editor clicks inside this attribute. */
 export const KEEP_SELECTION_ATTR = "data-visual-editing-keep-selection";
 export function selectionFromElement(element) {

package/dist/endpoints/chat.d.ts

@@ -1,3 +1,7 @@
 import type { Endpoint } from "payload";
 import type { ValidatedEditorAssistantOptions } from "../config/validate.ts";
 export declare function createChatEndpoint(options: ValidatedEditorAssistantOptions): Endpoint;
+/** Only a short list of form paths; the prompt names them as data. */
+export declare function sanitizeOpenProposal(value: unknown): {
+    changedPaths: string[];
+} | undefined;

package/dist/endpoints/chat.js

@@ -26,6 +26,8 @@ export function createChatEndpoint(options) {
             if (!beginInflight(actor)) {
                 return Response.json({ error: "rate_limited" }, { status: 429 });
             }
+            // A streamed turn ends when its stream does, not when the handler returns.
+            let streaming = false;
             try {
                 let body;
                 try {
@@ -45,7 +47,8 @@ export function createChatEndpoint(options) {
                     ? body.messages.filter(isChatMessage)
                     : [{ role: "user", text: body.message }];
                 const language = resolveChatLanguage(messages.filter((message) => message.role === "user").map((message) => message.text), nonEmpty(body.uiLanguage));
-                const result = await runAgentTurn(req, options, {
+                const run = (onEvent) => runAgentTurn(req, options, {
+                    onEvent,
                     message: body.message,
                     messages,
                     bridge: {
@@ -58,9 +61,15 @@ export function createChatEndpoint(options) {
                         uiLanguage: nonEmpty(body.uiLanguage)?.startsWith("sv") ? "sv" : "en",
                         view: sanitizeAdminView(body.view, options),
                         selection: typeof body.selection === "string" ? body.selection : undefined,
+                        openProposal: sanitizeOpenProposal(body.openProposal),
                     },
                     formData: body.formData,
                 });
+                if (body.stream === true) {
+                    streaming = true;
+                    return streamTurn(run, language, () => endInflight(actor));
+                }
+                const result = await run();
                 if (!result.ok) {
                     const status = result.error === "timeout" ? 504 : 503;
                     return Response.json({ error: result.error, message: result.message }, { status });
@@ -68,11 +77,69 @@ export function createChatEndpoint(options) {
                 return Response.json({ ...result, language });
             }
             finally {
-                endInflight(actor);
+                if (!streaming) {
+                    endInflight(actor);
+                }
             }
         },
     };
 }
+/**
+ * One JSON object per line: `step` and `proposal` events while the turn runs, then `done` with the
+ * same result the JSON answer has, or `error`. Errors after the stream started cannot change the
+ * HTTP status, so they travel as an event.
+ */
+function streamTurn(run, language, finished) {
+    const encoder = new TextEncoder();
+    const stream = new ReadableStream({
+        async start(controller) {
+            const send = (value) => {
+                try {
+                    controller.enqueue(encoder.encode(`${JSON.stringify(value)}\n`));
+                }
+                catch {
+                    // The editor stopped the request; the turn is aborted through the request signal.
+                }
+            };
+            try {
+                const result = await run(send);
+                send(result.ok
+                    ? { type: "done", result: { ...result, language } }
+                    : { type: "error", error: result.error, message: result.message });
+            }
+            catch {
+                send({ type: "error", error: "provider_error" });
+            }
+            finally {
+                finished();
+                try {
+                    controller.close();
+                }
+                catch {
+                    // Already closed by the client.
+                }
+            }
+        },
+    });
+    return new Response(stream, {
+        headers: {
+            "Content-Type": "application/x-ndjson; charset=utf-8",
+            "Cache-Control": "no-cache, no-transform",
+            "X-Accel-Buffering": "no",
+        },
+    });
+}
+/** Only a short list of form paths; the prompt names them as data. */
+export function sanitizeOpenProposal(value) {
+    const paths = value?.changedPaths;
+    if (!Array.isArray(paths)) {
+        return undefined;
+    }
+    const changedPaths = paths
+        .filter((path) => typeof path === "string" && /^[\w.]{1,200}$/.test(path))
+        .slice(0, 50);
+    return changedPaths.length > 0 ? { changedPaths } : undefined;
+}
 function nonEmpty(value) {
     return typeof value === "string" && value.trim() ? value : undefined;
 }

package/dist/package-name.d.ts

@@ -5,3 +5,8 @@ export declare const DEFAULT_AUDIT_SLUG = "editor-assistant-audit";
 export declare const DEFAULT_APPROVAL_SLUG = "editor-assistant-approvals";
 export declare const CSRF_COOKIE = "payload-editor-assistant-csrf";
 export declare const CSRF_HEADER = "x-editor-assistant-csrf";
+/**
+ * `config.admin.custom[ADMIN_CUSTOM_KEY] = { collections }`: the allowlisted collections, for other
+ * plugins (content health's work list) to know where the assistant works without importing it.
+ */
+export declare const ADMIN_CUSTOM_KEY = "editorAssistant";

package/dist/package-name.js

@@ -5,3 +5,8 @@ export const DEFAULT_AUDIT_SLUG = "editor-assistant-audit";
 export const DEFAULT_APPROVAL_SLUG = "editor-assistant-approvals";
 export const CSRF_COOKIE = "payload-editor-assistant-csrf";
 export const CSRF_HEADER = "x-editor-assistant-csrf";
+/**
+ * `config.admin.custom[ADMIN_CUSTOM_KEY] = { collections }`: the allowlisted collections, for other
+ * plugins (content health's work list) to know where the assistant works without importing it.
+ */
+export const ADMIN_CUSTOM_KEY = "editorAssistant";

package/dist/plugin.js

@@ -6,7 +6,7 @@ import { createChatEndpoint } from "./endpoints/chat.js";
 import { createCsrfEndpoint } from "./endpoints/csrf.js";
 import { createDecideEndpoint } from "./endpoints/decide.js";
 import { createProposeEndpoint } from "./endpoints/propose.js";
-import { CLIENT_ENTRY, DEFAULT_APPROVAL_SLUG } from "./package-name.js";
+import { ADMIN_CUSTOM_KEY, CLIENT_ENTRY, DEFAULT_APPROVAL_SLUG } from "./package-name.js";
 export function editorAssistantPlugin(options = {}) {
     const validated = validateEditorAssistantOptions(options);
     return (config) => {
@@ -40,6 +40,11 @@ export function editorAssistantPlugin(options = {}) {
             ...config,
             admin: {
                 ...config.admin,
+                // Read by @simmalugnt-se/payload-content-health, which offers the assistant only here.
+                custom: {
+                    ...config.admin?.custom,
+                    [ADMIN_CUSTOM_KEY]: { collections: Object.keys(validated.collections) },
+                },
                 components: {
                     ...config.admin?.components,
                     providers: [

package/dist/runtime/agent.d.ts

@@ -32,14 +32,32 @@ type ChatMessage = {
     role: "user" | "assistant" | "system";
     text: string;
 };
-export declare function runAgentTurn(req: PayloadRequest, options: ValidatedEditorAssistantOptions, input: {
+/** What the assistant is doing right now, for the panel to show while the turn runs. */
+export type AgentStep = "thinking" | "searching" | "reading" | "reading_form" | "proposing" | "drafting" | "navigating" | "writing";
+export type AgentEvent = {
+    type: "step";
+    step: AgentStep;
+}
+/** A form proposal, sent as soon as it exists so Admin can show it before the reply is written. */
+ | {
+    type: "proposal";
+    pendingApproval: NonNullable<Extract<AgentChatResult, {
+        ok: true;
+    }>["pendingApproval"]>;
+};
+export type AgentEventSink = (event: AgentEvent) => void;
+type TurnInput = {
     message: string;
     messages?: ChatMessage[];
     bridge: ToolContext["bridge"];
     formData?: Record<string, unknown>;
-}): Promise<AgentChatResult>;
+    onEvent?: AgentEventSink;
+};
+export declare function runAgentTurn(req: PayloadRequest, options: ValidatedEditorAssistantOptions, input: TurnInput): Promise<AgentChatResult>;
 export declare function collectResult(text: string, result: {
     steps?: unknown;
     toolResults?: unknown;
 }, captured: ToolOutcome[], locale: string, expectedProposal?: boolean, previews?: Map<string, ProposalPreview>): AgentChatResult;
+/** Whether a reply in the conversation already said which language the content is in. */
+export declare function contentLanguageNoted(history: ChatMessage[], bridge: Pick<ToolContext["bridge"], "locale">): boolean;
 export {};

package/dist/runtime/agent.js

@@ -3,11 +3,44 @@ import { loadTurnContext } from "./context.js";
 import { needsProposeRetry } from "./propose-loop.js";
 import { buildSystemPrompt } from "./system-prompt.js";
 import { executeTool, fromProviderToolName, TOOL_DESCRIPTIONS, TOOL_JSON_SCHEMAS, toProviderToolName, } from "./tools.js";
-import { editorFacingText } from "./voice.js";
+import { contentLanguageNote, editorFacingText } from "./voice.js";
 const MAX_MESSAGES = 20;
 const MAX_STEPS = 8;
 const TIMEOUT_MS = 60_000;
+const STEP_FOR_TOOL = {
+    "schema.discover": "thinking",
+    "content.find": "searching",
+    "content.findById": "reading",
+    "form.read": "reading_form",
+    "form.propose": "proposing",
+    "draft.create": "drafting",
+    "admin.navigate": "navigating",
+};
 export async function runAgentTurn(req, options, input) {
+    const result = await generateTurn(req, options, input);
+    if (!result.ok || result.pendingApproval?.capability !== "form.propose") {
+        return result;
+    }
+    // The first change written in another language than the chat's says so, once per conversation.
+    // Asked to in the prompt, models said it in every reply, or only in a later one.
+    const chat = input.bridge.language ?? input.bridge.locale;
+    const note = contentLanguageNote(chat, input.bridge.locale);
+    const history = input.messages ?? [];
+    if (!note ||
+        contentLanguageNoted([...history, { role: "assistant", text: result.text }], input.bridge)) {
+        return result;
+    }
+    return { ...result, text: `${note} ${result.text}` };
+}
+async function generateTurn(req, options, input) {
+    const emit = (event) => {
+        try {
+            input.onEvent?.(event);
+        }
+        catch {
+            // A listener that went away (closed stream) does not stop the turn.
+        }
+    };
     const model = await resolveModel(options, req.user?.id);
     if (!model) {
         req.payload?.logger?.warn(`${PACKAGE_NAME}: no model: the \`model\` option resolved to nothing for this user`);
@@ -29,10 +62,11 @@ export async function runAgentTurn(req, options, input) {
     const history = truncateMessages(input.messages ?? [{ role: "user", text: input.message }]);
     const captured = [];
     const previews = new Map();
-    const tools = buildSdkTools(ai, ctx, captured, previews);
+    const tools = buildSdkTools(ai, ctx, captured, previews, emit);
     const turnContext = await loadTurnContext(req, options, input.bridge, input.formData);
     const system = buildSystemPrompt(options.instructions, input.bridge, turnContext);
     const sdkMessages = toSdkMessages(history);
+    emit({ type: "step", step: "thinking" });
     try {
         const first = await generate(ai, {
             model,
@@ -60,7 +94,7 @@ export async function runAgentTurn(req, options, input) {
             return collected;
         }
         const retryCaptured = [];
-        const retryTools = buildSdkTools(ai, ctx, retryCaptured, previews);
+        const retryTools = buildSdkTools(ai, ctx, retryCaptured, previews, emit);
         const retry = await generate(ai, {
             model,
             system,
@@ -168,7 +202,7 @@ function isToolOutcome(value) {
     const record = value;
     return typeof record.ok === "boolean" && typeof record.capability === "string";
 }
-function buildSdkTools(ai, ctx, captured, previews) {
+function buildSdkTools(ai, ctx, captured, previews, emit) {
     const tools = {};
     for (const capability of Object.keys(TOOL_JSON_SCHEMAS)) {
         const schema = TOOL_JSON_SCHEMAS[capability];
@@ -180,6 +214,7 @@ function buildSdkTools(ai, ctx, captured, previews) {
             execute: async (raw) => {
                 try {
                     const input = raw && typeof raw === "object" ? raw : {};
+                    emit({ type: "step", step: STEP_FOR_TOOL[capability] ?? "thinking" });
                     const executed = await executeTool(fromProviderToolName(name), input, ctx);
                     // The whole form with the change applied is for Admin, not another round through the model.
                     const { preview, ...outcome } = executed.ok
@@ -187,7 +222,12 @@ function buildSdkTools(ai, ctx, captured, previews) {
                         : { ...executed, preview: undefined };
                     if (preview && executed.ok && executed.pendingApproval) {
                         previews.set(executed.pendingApproval.approvalId, preview);
+                        emit({ type: "proposal", pendingApproval: { ...executed.pendingApproval, preview } });
                     }
+                    emit({
+                        type: "step",
+                        step: executed.ok && executed.pendingApproval ? "writing" : "thinking",
+                    });
                     captured.push(outcome);
                     return outcome;
                 }
@@ -206,6 +246,16 @@ function buildSdkTools(ai, ctx, captured, previews) {
     }
     return tools;
 }
+/** Names of the content language as the editor would read them, in either chat language. */
+const LANGUAGE_NAMES = {
+    en: /\b(English)\b|engelska/i,
+    sv: /\b(Swedish)\b|svenska/i,
+};
+/** Whether a reply in the conversation already said which language the content is in. */
+export function contentLanguageNoted(history, bridge) {
+    const name = LANGUAGE_NAMES[bridge.locale.split("-")[0]];
+    return Boolean(name && history.some((message) => message.role === "assistant" && name.test(message.text)));
+}
 function truncateMessages(messages) {
     if (messages.length <= MAX_MESSAGES) {
         return messages;

package/dist/runtime/propose-loop.js

@@ -12,9 +12,9 @@ export function offeredValue(text, request) {
 }
 // A request for a change, or a yes to one the assistant asked about. Letter lookarounds rather
 // than \b, which treats å, ä and ö as word boundaries.
-const ASKS_FOR_CHANGE = /(?<!\p{L})(make|change|rewrite|write|add|replace|shorten|tighten|fill|translate|update|improve|set|rename|remove|delete|yes|yeah|sure|ok|okay|do it|go ahead|gör|göra|ändra|skriv|skriva|lägg|lägga|byt|byta|korta|fyll|fylla|översätt|uppdatera|förbättra|sätt|ta bort|ja|japp|kör|gärna)(?!\p{L})/iu;
+const ASKS_FOR_CHANGE = /(?<!\p{L})(make|change|rewrite|write|add|replace|shorten|tighten|fill|translate|update|improve|set|rename|shorter|longer|simpler|remove|delete|yes|yeah|sure|ok|okay|do it|go ahead|gör|göra|ändra|skriv|skriva|lägg|lägga|byt|byta|korta|fyll|fylla|översätt|uppdatera|förbättra|sätt|ta bort|kortare|längre|enklare|ja|japp|kör|gärna)(?!\p{L})/iu;
 const QUOTED = /["“”«»][^"“”«»]{2,}["“”«»]|'[^']{2,}'/;
-const CLAIMED_CHANGE = /godkänn|godkann|approve|rubriken är nu|the headline is now|sparas den på sidan|fälten i på sidan|pending form change|i've applied|i have applied/i;
+const CLAIMED_CHANGE = /godkänn|godkann|approve|rubriken är nu|the headline is now|sparas den på sidan|fälten i på sidan|pending form change|i've applied|i have applied|har lagt in|i've put|i have put/i;
 const ASKED_TO_MUTATE = /ska jag (lägga|fylla|ändra|sätta|uppdatera)|should i (put|fill|change|set|update|apply)|shall i (put|fill|change|set|update|apply)|want me to (put|fill|change|set|update|apply)/i;
 export function needsProposeRetry(input) {
     if (!input.hasOpenDocument || input.pendingApproval || input.navigate) {

package/dist/runtime/system-prompt.js

@@ -7,7 +7,7 @@ export function buildSystemPrompt(instructions, bridge, turnContext) {
         "Two to five short sentences. Use visible field labels (Title, Headline, Summary).",
         "Never ask whether you should proceed. When you have the new values, call form.propose in the same turn.",
         "If the editor confirms a change you already described, call form.propose with those values. Do not ask again.",
-        "Do not claim the form already has the new values. Do not tell the editor to approve; the panel does that when the proposal exists.",
+        'When you call form.propose, the change is shown in the form and preview for the editor to keep or undo. Then offer it in one short sentence, as a suggestion rather than something done: "Here is a shorter headline." or "Jag föreslår en varmare rubrik." Never write that a field "is now" or "är nu" something. Never say it is saved, published or kept, and do not tell them to approve or click anything; the panel does that. Without a form.propose call, do not claim the form has new values.',
         "If form.propose fails, say you could not apply it and they can try again. Never tell them to copy-paste.",
         "When the editor asks you to create a document, call draft.create in the same turn with sensible content based on their request. Do not ask for a title or summary first; they review the draft before it is created.",
         "Never save, publish, unpublish, delete, bulk-mutate, or upload files.",
@@ -62,7 +62,7 @@ function viewLine(turnContext) {
 function thisTurnBlock(bridge, turnContext) {
     const locale = bridge?.locale ?? turnContext?.open?.locale;
     const chat = bridge?.language ?? locale;
-    if (!chat && !turnContext?.form) {
+    if (!chat && !turnContext?.form && !bridge?.openProposal) {
         return "";
     }
     const lines = [
@@ -70,10 +70,7 @@ function thisTurnBlock(bridge, turnContext) {
     ];
     if (locale) {
         const content = languageName(locale);
-        lines.push(`Write every field value in ${content}; that is the language version being edited.`);
-        if (content !== languageName(chat)) {
-            lines.push(`The editor chats in ${languageName(chat)}, so say in one short sentence that the content is written in ${content}.`);
-        }
+        lines.push(`Write every field value in ${content}; that is the language version being edited. Do not point out which language the content is in; the panel does that.`);
     }
     const selection = turnContext?.selection;
     if (selection) {
@@ -81,6 +78,9 @@ function thisTurnBlock(bridge, turnContext) {
             ? `Selected field: ${selection.field.path}.`
             : `Selected: ${selection.path}; its fields are under that path in the form.`);
     }
+    if (bridge?.openProposal) {
+        lines.push(`The form shows your earlier suggestion, not kept yet; it changed ${bridge.openProposal.changedPaths.join(", ")}. Those values are in the form now. If the editor asks to adjust it (shorter, another tone, other wording, one more field), call form.propose now with the adjusted values; it replaces the suggestion in the preview. Do not say it is saved or kept.`);
+    }
     const form = turnContext?.form;
     if (form) {
         const empty = listEmptyTextPaths(form);

package/dist/runtime/tools.d.ts

@@ -18,6 +18,10 @@ export type ToolBridge = {
     view?: AdminView;
     /** Form path of what the editor last clicked or focused in the open form, unverified. */
     selection?: string;
+    /** A suggestion shown in the form that the editor has not kept yet: the paths it changed. */
+    openProposal?: {
+        changedPaths: string[];
+    };
 };
 export type ToolContext = {
     req: PayloadRequest;

package/dist/runtime/voice.d.ts

@@ -7,5 +7,8 @@ export declare function editorFacingText(input: {
     expectedProposal?: boolean;
 }): string;
 export declare function stripInternalSpeech(text: string, locale: string): string;
+export declare function withoutOverclaims(text: string): string;
 export declare function approvalCopy(locale: string, capability: "form.propose" | "draft.create"): string;
 export declare function couldNotStageCopy(locale: string): string;
+/** Tells the editor the content is written in another language than the one they chat in. */
+export declare function contentLanguageNote(chat: string, contentLocale: string): string | undefined;

package/dist/runtime/voice.js

@@ -3,7 +3,12 @@ const INTERNAL = /\b(form\.propose|form_propose|draft\.create|draft_create|schem
 const ENGLISH_META = /\b(despite|therefore|however|the tool|I should|I've|has been issued|appropriate turn|proposed values)\b/i;
 export function editorFacingText(input) {
     if (input.pendingApproval) {
-        return approvalCopy(input.locale, input.pendingApproval.capability);
+        // A form change is in the form now, so the model's own words about it can stand, minus any
+        // claim the panel contradicts. A draft is not created until approved; that keeps fixed copy.
+        const own = input.pendingApproval.capability === "form.propose"
+            ? withoutOverclaims(stripInternalSpeech(input.text, input.locale))
+            : "";
+        return own || approvalCopy(input.locale, input.pendingApproval.capability);
     }
     const cleaned = stripInternalSpeech(input.text, input.locale);
     if (input.expectedProposal ||
@@ -26,6 +31,16 @@ export function stripInternalSpeech(text, locale) {
     });
     return kept.join(" ").replace(/\s+/g, " ").trim();
 }
+/** Keeping, saving and publishing are the editor's; a sentence that claims or asks for them goes. */
+const OVERCLAIM = /godkänn|godkann|approve|spara|sparat|sparad|sparats|publicer|\bsaved?\b|publish|behåll|\bkeep\b|klicka|\bclick|(?:^|\s)är nu\b|\bis now\b/i;
+const MAX_OWN_TEXT = 600;
+export function withoutOverclaims(text) {
+    const kept = splitSentences(text)
+        .filter((sentence) => !OVERCLAIM.test(sentence))
+        .join(" ")
+        .trim();
+    return kept.length <= MAX_OWN_TEXT ? kept : "";
+}
 export function approvalCopy(locale, capability) {
     if (isSwedish(locale)) {
         return capability === "draft.create"
@@ -53,3 +68,19 @@ function splitSentences(text) {
         .map((part) => part.trim())
         .filter(Boolean);
 }
+const CONTENT_LANGUAGE = {
+    en: { sv: "engelska", en: "English" },
+    sv: { sv: "svenska", en: "Swedish" },
+};
+/** Tells the editor the content is written in another language than the one they chat in. */
+export function contentLanguageNote(chat, contentLocale) {
+    const content = contentLocale.split("-")[0];
+    const inChat = isSwedish(chat) ? "sv" : "en";
+    const name = CONTENT_LANGUAGE[content]?.[inChat];
+    if (!name || content === chat.split("-")[0]) {
+        return undefined;
+    }
+    return inChat === "sv"
+        ? `Innehållet skrivs på ${name}, eftersom det är den språkversionen du redigerar.`
+        : `The content is written in ${name}, since that is the language version you are editing.`;
+}

package/dist/styles/assistant.css

@@ -1,5 +1,6 @@
 .ea-root {
-  --ea-aside-width: 400px;
+  /* Narrower on smaller screens, so Admin keeps room. nav-room.ts depends on these numbers. */
+  --ea-aside-width: clamp(320px, 22vw, 400px);
   position: fixed;
   inset: 0;
   display: flex;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simmalugnt-se/payload-editor-assistant",
-  "version": "0.3.3",
+  "version": "0.5.0",
   "description": "Context-aware editor assistant plugin for Payload Admin",
   "keywords": [
     "payload",
@@ -47,11 +47,6 @@
     "react": "^19.0.0",
     "react-dom": "^19.0.0"
   },
-  "peerDependenciesMeta": {
-    "next": {
-      "optional": true
-    }
-  },
   "devDependencies": {
     "@payloadcms/ui": "3.90.2",
     "@types/node": "^22",