@simmalugnt-se/payload-editor-assistant 0.1.1 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 0.2.0
+
+Breaking: options that were accepted but did nothing are removed.
+
+- `tools` (and the `HostToolDefinition` type): host tools were validated but never given to the
+  model. They will come back when the assistant can run them.
+- `audit.retentionDays`: nothing deleted old audit entries.
+
+Also: README documents `validateProposal`.
+
 ## 0.1.1
 
 - Provider failures are logged on the server through Payload's logger (missing model, `ai` not

package/README.md

@@ -87,6 +87,7 @@ secrets (`password`, `token`, `apiKey`, ...) are always off limits.
 | `shortcuts` | One-click prompts in the drawer: `{ id, label, prompt, when?, entities? }`. |
 | `enabled` | `({ userId }) => boolean` to offer the assistant to some users only. |
 | `redact` | `({ slug, data }) => data` to strip values before documents reach the model. |
+| `validateProposal` | `({ operations, data }) => ({ ok: true } \| { ok: false, errors })` for project rules. Runs before a proposal reaches the editor; errors go back to the assistant, which can correct itself. |
 | `trustedOrigins` | Origins allowed to call the assistant's endpoints. Default: only the origin serving Admin. When set, only the listed origins. |
 | `audit.collection` | Slug of the collection that logs assistant actions (default `editor-assistant-audit`). |
 | `disabled` | Turn the plugin off without removing its config. |

package/dist/config/validate.d.ts

@@ -1,15 +1,13 @@
-import type { EditorAssistantPluginOptions, EntityAllowlist, HostToolDefinition } from "../types.ts";
+import type { EditorAssistantPluginOptions, EntityAllowlist } from "../types.ts";
 export type ValidatedEditorAssistantOptions = EditorAssistantPluginOptions & {
     disabled: boolean;
     collections: Record<string, EntityAllowlist>;
     globals: Record<string, EntityAllowlist>;
     denyFields: string[];
     shortcuts: NonNullable<EditorAssistantPluginOptions["shortcuts"]>;
-    tools: HostToolDefinition[];
     trustedOrigins: string[];
     audit: {
         collection: string;
-        retentionDays?: number;
     };
 };
 export declare function validateEditorAssistantOptions(options: EditorAssistantPluginOptions): ValidatedEditorAssistantOptions;

package/dist/config/validate.js

@@ -1,6 +1,5 @@
-import { BUILTIN_RISK, EMBEDDED_ONLY_CAPABILITIES, isBuiltinCapability, isEntityCapability, } from "../capabilities.js";
+import { isEntityCapability } from "../capabilities.js";
 import { isDeniedCollectionSlug } from "./denied-fields.js";
-const RISK_ORDER = { auto: 0, approval: 1, forbidden: 2 };
 export function validateEditorAssistantOptions(options) {
     const disabled = options.disabled === true;
     const collections = options.collections ?? {};
@@ -11,7 +10,6 @@ export function validateEditorAssistantOptions(options) {
         }
         validateEntityMap("collections", collections, { allowDraftCreate: true });
         validateEntityMap("globals", globals, { allowDraftCreate: false });
-        validateHostTools(options.tools ?? []);
     }
     return {
         ...options,
@@ -20,11 +18,9 @@ export function validateEditorAssistantOptions(options) {
         globals,
         denyFields: options.denyFields ?? [],
         shortcuts: options.shortcuts ?? [],
-        tools: options.tools ?? [],
         trustedOrigins: options.trustedOrigins ?? [],
         audit: {
             collection: options.audit?.collection ?? "editor-assistant-audit",
-            retentionDays: options.audit?.retentionDays,
         },
     };
 }
@@ -62,25 +58,3 @@ function validateFields(entry, label) {
         throw new Error(`payload-editor-assistant: ${label} fields.exclude must be an array.`);
     }
 }
-function validateHostTools(tools) {
-    for (const tool of tools) {
-        if (!tool.id || !tool.capabilityId) {
-            throw new Error("payload-editor-assistant: host tools require id and capabilityId.");
-        }
-        const risk = tool.risk ?? "approval";
-        if (risk !== "auto" && risk !== "approval" && risk !== "forbidden") {
-            throw new Error(`payload-editor-assistant: host tool "${tool.id}" has invalid risk.`);
-        }
-        if (isBuiltinCapability(tool.capabilityId)) {
-            if (RISK_ORDER[risk] < RISK_ORDER[BUILTIN_RISK[tool.capabilityId]]) {
-                throw new Error(`payload-editor-assistant: host tool "${tool.id}" cannot loosen risk below ${tool.capabilityId}.`);
-            }
-            if (tool.mcp && EMBEDDED_ONLY_CAPABILITIES.has(tool.capabilityId)) {
-                throw new Error(`payload-editor-assistant: host tool "${tool.id}" cannot mark ${tool.capabilityId} as MCP-eligible.`);
-            }
-        }
-        if (risk === "auto" && tool.mcp === true && tool.capabilityId === "form.propose") {
-            throw new Error(`payload-editor-assistant: host tool "${tool.id}" cannot expose form writes to MCP.`);
-        }
-    }
-}

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export type { BuiltinCapability, CapabilityRisk, EntityCapability } from "./capabilities.ts";
 export { BUILTIN_CAPABILITIES, BUILTIN_RISK, ENTITY_CAPABILITIES } from "./capabilities.ts";
 export { editorAssistantPlugin } from "./plugin.ts";
-export type { AssistantShortcut, EditorAssistantPluginOptions, EntityAllowlist, FieldAllowlist, HostLanguageModel, HostToolDefinition, ModelResolver, ProposalValidationResult, } from "./types.ts";
+export type { AssistantShortcut, EditorAssistantPluginOptions, EntityAllowlist, FieldAllowlist, HostLanguageModel, ModelResolver, ProposalValidationResult, } from "./types.ts";
 export { defineEditorAssistantConfig } from "./types.ts";

package/dist/types.d.ts

@@ -22,13 +22,6 @@ export type AssistantShortcut = {
     /** Collection or global slugs where the shortcut is shown. Views without an entity (dashboard) are not filtered. */
     entities?: string[];
 };
-export type HostToolRisk = "auto" | "approval" | "forbidden";
-export type HostToolDefinition = {
-    id: string;
-    capabilityId: string;
-    risk?: HostToolRisk;
-    mcp?: boolean;
-};
 export type ProposalValidationResult = {
     ok: true;
 } | {
@@ -43,7 +36,6 @@ export type EditorAssistantPluginOptions = {
     denyFields?: string[];
     instructions?: string;
     shortcuts?: AssistantShortcut[];
-    tools?: HostToolDefinition[];
     validateProposal?: (input: unknown) => ProposalValidationResult | Promise<ProposalValidationResult>;
     redact?: (input: {
         slug: string;
@@ -55,7 +47,6 @@ export type EditorAssistantPluginOptions = {
     trustedOrigins?: string[];
     audit?: {
         collection?: string;
-        retentionDays?: number;
     };
 };
 export declare function defineEditorAssistantConfig<T extends EditorAssistantPluginOptions>(options: T): T;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simmalugnt-se/payload-editor-assistant",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Context-aware editor assistant plugin for Payload Admin",
   "keywords": [
     "payload",