@simmalugnt-se/payload-editor-assistant 0.14.0 → 0.15.0

package/dist/runtime/tools.js

@@ -1,245 +1,26 @@
-import { writeAudit } from "../domain/audit.js";
-import { findContent, findContentById } from "../domain/content.js";
-import { MAX_IMAGES_PER_CALL, MAX_IMAGES_PER_TURN, viewMedia, viewMediaList, } from "../domain/media.js";
-import { canNavigate, navigateAdmin } from "../domain/navigate.js";
-import { proposeChange } from "../domain/propose.js";
-import { discoverSchema, entityFields } from "../schema/discover.js";
-import { projectRecord } from "../schema/project.js";
-export const TOOL_JSON_SCHEMAS = {
-    "schema.discover": {
-        type: "object",
-        properties: {},
-    },
-    "content.find": {
-        type: "object",
-        additionalProperties: false,
-        properties: {
-            collection: { type: "string" },
-            query: { type: "string" },
-        },
-    },
-    "content.findById": {
-        type: "object",
-        additionalProperties: false,
-        properties: {
-            collection: { type: "string" },
-            global: { type: "string" },
-            documentId: { type: ["string", "number"] },
-            locale: { type: "string" },
-        },
-    },
-    "form.read": {
-        type: "object",
-        properties: {},
-    },
-    "media.view": {
-        type: "object",
-        additionalProperties: false,
-        properties: {
-            collection: { type: "string" },
-            ids: { type: "array", items: { type: ["string", "number"] }, maxItems: MAX_IMAGES_PER_CALL },
-        },
-    },
-    "admin.navigate": {
-        type: "object",
-        additionalProperties: false,
-        properties: {
-            collection: { type: "string" },
-            global: { type: "string" },
-            documentId: { type: ["string", "number"] },
-            query: { type: "string" },
-        },
-    },
-    "form.propose": {
-        type: "object",
-        properties: {
-            operations: {
-                description: 'Array of patches. Use dotted paths such as layout.0.headline. Example item: {"op":"set","path":"layout.0.headline","value":"Välkommen"}.',
-            },
-            patches: {},
-            changes: {},
-        },
-    },
-    "draft.create": {
-        type: "object",
-        additionalProperties: false,
-        properties: {
-            collection: { type: "string" },
-            operations: { type: "array" },
-        },
-        required: ["collection", "operations"],
-    },
-};
-export const TOOL_DESCRIPTIONS = {
-    "schema.discover": "List allowlisted collections, globals, fields, and constraints. Never invent fields.",
-    "content.find": "Search or list allowlisted documents by title, slug, or id. Omit query to list recent documents. Returns identity only, not a summary.",
-    "content.findById": "Read one allowlisted document or global. Pass locale to read another language of the same document. For the currently open form, prefer form.read.",
-    "form.read": "Read the currently open unsaved form in the current language. No document ID needed.",
-    "media.view": `Look at images. Without ids: the image of the open media document; call it before writing or judging an alt text, caption or anything else about what it shows. With ids (from content.find on a media collection): up to ${MAX_IMAGES_PER_CALL} images to compare when picking one, ${MAX_IMAGES_PER_TURN} per turn at most.`,
-    "form.propose": 'Stage a structured patch against the open unsaved form in the current language. Call this as soon as you have the new field values. Do not ask the editor to confirm in chat; they approve in the panel. Example: {"op":"set","path":"layout.0.headline","value":"Välkommen"}. Requires editor approval.',
-    "admin.navigate": "Navigate Admin to an allowlisted collection, global, or unique document match.",
-    "draft.create": 'Stage creation of one draft document. Requires editor approval. Never publishes. The document starts empty: set top-level fields with {"op":"set","path":"title","value":"Start"}, and add each layout block with {"op":"blocks.insert","path":"layout","index":0,"blockType":"hero","data":{"headline":"Välkommen"}} using only block types and fields from the quoted context. Rich text fields take Markdown (headings, lists, **bold**, [links](https://…)).',
-};
-/** Tools a batch turn has no use for: it stays on its one saved document. */
-const NOT_IN_BATCH = new Set(["admin.navigate", "draft.create"]);
-/** The tools the model is given for this turn. */
-export function toolNamesFor(bridge) {
-    return Object.keys(TOOL_JSON_SCHEMAS).filter((name) => !(bridge.batch && NOT_IN_BATCH.has(name)));
+import { BUILTIN_TOOLS } from "./capabilities/index.js";
+/** The tools the model is given for this turn: the built-in ones, then the extensions'. */
+export function toolsFor(bridge, extensions = []) {
+    return [...BUILTIN_TOOLS, ...extensions.flatMap((extension) => extension.tools)].filter((tool) => !(bridge.batch && tool.notInBatch));
+}
+/** Capability ids of the tools the model is given for this turn. */
+export function toolNamesFor(bridge, extensions) {
+    return toolsFor(bridge, extensions).map((tool) => tool.name);
 }
 /** Provider APIs reject dots in tool names (`^[a-zA-Z0-9_-]+$`). Capability IDs stay dotted. */
 export function toProviderToolName(capability) {
     return capability.replaceAll(".", "_");
 }
-export function fromProviderToolName(name) {
-    const match = Object.keys(TOOL_JSON_SCHEMAS).find((capability) => toProviderToolName(capability) === name);
-    return match ?? name;
+export function fromProviderToolName(name, extensions) {
+    const match = toolsFor({ locale: "" }, extensions).find((tool) => toProviderToolName(tool.name) === name);
+    return match?.name ?? name;
 }
 export async function executeTool(name, input, ctx) {
-    switch (name) {
-        case "schema.discover":
-            return {
-                ok: true,
-                capability: name,
-                data: discoverSchema(ctx.req, ctx.options),
-            };
-        case "content.find":
-            return wrap(name, await findContent(ctx.req, ctx.options, {
-                collection: asString(input.collection),
-                query: asString(input.query) ?? "",
-                locale: ctx.bridge.locale,
-            }));
-        case "content.findById":
-            return wrap(name, await findContentById(ctx.req, ctx.options, {
-                collection: asString(input.collection) ?? ctx.bridge.collection,
-                global: asString(input.global) ?? ctx.bridge.global,
-                documentId: input.documentId ?? ctx.bridge.documentId,
-                locale: asString(input.locale) ?? ctx.bridge.locale,
-            }));
-        case "form.read": {
-            if (!ctx.bridge.collection && !ctx.bridge.global) {
-                return {
-                    ok: false,
-                    capability: name,
-                    error: "tool_denied",
-                    message: "No document is open. Open an allowlisted document to read the form.",
-                };
-            }
-            const fields = entityFields(ctx.req, ctx.options, {
-                collection: ctx.bridge.collection,
-                global: ctx.bridge.global,
-            });
-            const projected = projectRecord(ctx.formData ?? {}, fields, ctx.options.redact, ctx.bridge.collection ?? ctx.bridge.global);
-            return { ok: true, capability: name, data: projected };
-        }
-        case "media.view": {
-            ctx.imageBudget ??= { remaining: MAX_IMAGES_PER_TURN };
-            const ids = Array.isArray(input.ids)
-                ? input.ids.filter((id) => typeof id === "string" || typeof id === "number")
-                : [];
-            if (ids.length > 0) {
-                const listed = await viewMediaList(ctx.req, ctx.options, {
-                    collection: asString(input.collection),
-                    ids,
-                    budget: ctx.imageBudget,
-                });
-                if (!listed.ok) {
-                    return { ok: false, capability: name, error: listed.error, message: listed.message };
-                }
-                return { ok: true, capability: name, data: listed.data, images: listed.images };
-            }
-            // The open document: its id comes from the bridge, never from the model.
-            if (ctx.imageBudget.remaining <= 0) {
-                return {
-                    ok: false,
-                    capability: name,
-                    error: "tool_denied",
-                    message: `You have looked at ${MAX_IMAGES_PER_TURN} images this turn, the most allowed.`,
-                };
-            }
-            const viewed = await viewMedia(ctx.req, ctx.options, {
-                collection: ctx.bridge.collection,
-                documentId: ctx.bridge.documentId,
-            });
-            if (!viewed.ok) {
-                return { ok: false, capability: name, error: viewed.error, message: viewed.message };
-            }
-            ctx.imageBudget.remaining -= 1;
-            return { ok: true, capability: name, data: viewed.data, images: [viewed.image] };
-        }
-        case "admin.navigate": {
-            if (!canNavigate(ctx.options)) {
-                return {
-                    ok: false,
-                    capability: name,
-                    error: "tool_denied",
-                    message: "Nothing is allowlisted.",
-                };
-            }
-            const result = await navigateAdmin(ctx.req, ctx.options, {
-                collection: asString(input.collection),
-                global: asString(input.global),
-                documentId: input.documentId,
-                query: asString(input.query),
-                locale: ctx.bridge.locale,
-            });
-            if (!result.ok) {
-                return { ok: false, capability: name, error: result.error, message: result.message };
-            }
-            await writeAudit(ctx.req, ctx.options, {
-                capability: name,
-                risk: "auto",
-                outcome: "executed",
-                targetCollection: asString(input.collection),
-                targetGlobal: asString(input.global),
-                locale: ctx.bridge.locale,
-            });
-            if ("href" in result) {
-                return { ok: true, capability: name, navigate: { href: result.href, label: result.label } };
-            }
-            return { ok: true, capability: name, navigate: { candidates: result.candidates } };
-        }
-        case "form.propose":
-        case "draft.create": {
-            if (ctx.bridge.batch && name === "draft.create") {
-                return { ok: false, capability: name, error: "tool_denied", message: "Not in a batch." };
-            }
-            const batch = ctx.bridge.batch;
-            const capability = batch ? "content.update" : name;
-            const proposed = await proposeChange(ctx.req, ctx.options, {
-                capability,
-                allowedPaths: batch?.allowedPaths,
-                requestId: batch?.requestId,
-                collection: name === "draft.create" ? asString(input.collection) : ctx.bridge.collection,
-                global: name === "form.propose" ? ctx.bridge.global : undefined,
-                documentId: name === "form.propose" ? ctx.bridge.documentId : undefined,
-                locale: ctx.bridge.locale,
-                language: ctx.bridge.uiLanguage ?? ctx.bridge.language,
-                operations: input.operations ?? input.patches ?? input.changes ?? input.ops,
-                formData: name === "form.propose" && !batch ? ctx.formData : undefined,
-            });
-            if (!proposed.ok) {
-                return { ok: false, capability: name, error: proposed.error, message: proposed.message };
-            }
-            // Models count characters badly; the count lets them correct a text that misses a length.
-            const counted = Object.keys(proposed.characters).length > 0;
-            return {
-                ok: true,
-                capability: name,
-                ...(counted ? { data: { characters: proposed.characters } } : {}),
-                pendingApproval: {
-                    title: proposed.title,
-                    summary: proposed.summary,
-                    approvalId: proposed.approvalId,
-                    nonce: proposed.nonce,
-                    capability,
-                },
-                lines: proposed.lines,
-                preview: proposed.preview,
-            };
-        }
-        default:
-            return { ok: false, capability: name, error: "tool_denied", message: "Unknown tool." };
+    const tool = toolsFor(ctx.bridge, ctx.extensions).find((entry) => entry.name === name);
+    if (!tool) {
+        return { ok: false, capability: name, error: "tool_denied", message: "Unknown tool." };
     }
+    return tool.run(input, ctx);
 }
 /**
  * What the model gets back from a tool: images as file parts, each after a line with its id when it
@@ -272,12 +53,3 @@ export function toolModelOutput(outcome) {
         ],
     };
 }
-function wrap(capability, result) {
-    if (!result.ok) {
-        return { ok: false, capability, error: result.error, message: result.message };
-    }
-    return { ok: true, capability, data: "results" in result ? result.results : result.data };
-}
-function asString(value) {
-    return typeof value === "string" && value.trim() ? value : undefined;
-}

package/dist/types.d.ts

@@ -52,5 +52,12 @@ export type EditorAssistantPluginOptions = {
     audit?: {
         collection?: string;
     };
+    /**
+     * Extensions from other packages to turn on, by id: `true` for all their tools, or the tools
+     * allowed. Off until named here. See `AssistantExtension` in `extensions/contract.ts`.
+     */
+    extensions?: Record<string, true | {
+        tools: string[];
+    }>;
 };
 export declare function defineEditorAssistantConfig<T extends EditorAssistantPluginOptions>(options: T): T;

package/dist/view.d.ts

@@ -10,6 +10,11 @@ export type AdminView = {
 } | {
     kind: "global";
     global: string;
+}
+/** Another Admin view, such as one a plugin adds: its path under the admin route. */
+ | {
+    kind: "custom";
+    path: string;
 } | {
     kind: "other";
 };
@@ -21,8 +26,11 @@ export declare function parseAdminView(pathname: string, adminRoute?: string): A
  * user is known but the login page is still open.
  */
 export declare function isAuthView(pathname: string, adminRoute: string, routes?: Partial<Record<string, string>>): boolean;
-/** Keep only views that point at something the host allowlisted. */
+/**
+ * Keep only views that point at something the host allowlisted, and custom views an enabled
+ * extension describes (`customPaths`).
+ */
 export declare function sanitizeAdminView(value: unknown, allowed: {
     collections: Record<string, unknown>;
     globals: Record<string, unknown>;
-}): AdminView;
+}, customPaths?: string[]): AdminView;

package/dist/view.js

@@ -22,7 +22,10 @@ export function parseAdminView(pathname, adminRoute = "/admin") {
     if (section === "globals" && slug) {
         return { kind: "global", global: slug };
     }
-    return { kind: "other" };
+    if (section === "collections" || section === "globals") {
+        return { kind: "other" };
+    }
+    return { kind: "custom", path: `/${segments.join("/")}` };
 }
 /** Payload's own sign-in routes (`admin.routes`), with Payload's defaults. */
 const AUTH_ROUTES = {
@@ -51,8 +54,11 @@ export function isAuthView(pathname, adminRoute, routes = {}) {
         return Boolean(route) && (rest === route || rest.startsWith(`${route}/`));
     });
 }
-/** Keep only views that point at something the host allowlisted. */
-export function sanitizeAdminView(value, allowed) {
+/**
+ * Keep only views that point at something the host allowlisted, and custom views an enabled
+ * extension describes (`customPaths`).
+ */
+export function sanitizeAdminView(value, allowed, customPaths = []) {
     if (!value || typeof value !== "object") {
         return { kind: "other" };
     }
@@ -76,6 +82,10 @@ export function sanitizeAdminView(value, allowed) {
             return has(allowed.globals, view.global)
                 ? { kind: "global", global: view.global }
                 : { kind: "other" };
+        case "custom":
+            return typeof view.path === "string" && customPaths.includes(view.path)
+                ? { kind: "custom", path: view.path }
+                : { kind: "other" };
         default:
             return { kind: "other" };
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simmalugnt-se/payload-editor-assistant",
-  "version": "0.14.0",
+  "version": "0.15.0",
   "description": "Context-aware editor assistant plugin for Payload Admin",
   "keywords": [
     "payload",
@@ -8,11 +8,7 @@
   ],
   "license": "MIT",
   "author": "Simmalugnt AB",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/simmalugnt-se/payload-plugins.git",
-    "directory": "packages/payload-editor-assistant"
-  },
+  "homepage": "https://simmalugnt.se",
   "type": "module",
   "engines": {
     "node": ">=22"