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

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 0.3.3
+
+- A `model` function may return `null` or `undefined`, for example when no API key is set. The drawer
+  then says that no AI model is set up instead of that the AI service did not answer, and the server
+  logs a warning instead of an error. Hosts no longer need a cast to keep the plugin installed
+  without a model.
+
 ## 0.3.2
 
 - One control opens and closes the assistant: the text button with a sparkles icon in Admin's

package/README.md

@@ -57,9 +57,17 @@ with its key, e.g. `createAnthropic({ apiKey: process.env.ANTHROPIC_API_KEY })`.
 Providers also read a default environment variable (`DEEPSEEK_API_KEY`, `ANTHROPIC_API_KEY`, ...)
 when no `apiKey` is passed, but passing it explicitly keeps the connection visible in your config.
 
-If the key is missing or wrong, the drawer shows `provider_error` and the cause is logged on the
+If the key is wrong, the drawer says the AI service did not answer and the cause is logged on the
 server through Payload's logger.
 
+To keep the plugin installed without a key (its tables stay in your schema and migrations), let
+`model` be a function that returns `null` or `undefined` when there is nothing to call. The drawer then
+tells the editor that no AI model is set up, and a warning is logged:
+
+```ts
+model: () => (process.env.DEEPSEEK_API_KEY ? deepSeek("deepseek-chat") : null),
+```
+
 ## What the assistant may do
 
 Nothing is reachable unless you list it. Each collection or global gets the capabilities it allows:

package/dist/components/assistant-context.d.ts

@@ -1,7 +1,7 @@
 import { type ReactNode } from "react";
 import type { AssistantShortcut } from "../types.ts";
 import type { DomSelection } from "./selection-dom.ts";
-export type AssistantChromeStatus = "idle" | "unavailable" | "unauthorized" | "rate_limited" | "timeout" | "provider_error" | "tool_denied" | "stale_context" | "aborted" | "streaming";
+export type AssistantChromeStatus = "idle" | "unavailable" | "unauthorized" | "rate_limited" | "timeout" | "provider_error" | "no_model" | "tool_denied" | "stale_context" | "aborted" | "streaming";
 export type DocumentBridgeSnapshot = {
     collectionSlug?: string;
     globalSlug?: string;

package/dist/components/copy.d.ts

@@ -43,6 +43,7 @@ export declare const COPY: {
             readonly rate_limited: "Too many messages at once. Wait a moment and try again.";
             readonly timeout: "The assistant took too long to answer. Try again.";
             readonly provider_error: "The AI service did not answer. The server log has the cause.";
+            readonly no_model: "No AI model is set up yet, for example because an API key is missing. Ask whoever runs the site to add one.";
             readonly tool_denied: "That is not something the assistant may do here.";
             readonly stale_context: "The form changed in the meantime. Try again.";
             readonly aborted: "Stopped.";
@@ -93,6 +94,7 @@ export declare const COPY: {
             readonly rate_limited: "För många meddelanden på en gång. Vänta en stund och försök igen.";
             readonly timeout: "Assistenten tog för lång tid på sig. Försök igen.";
             readonly provider_error: "AI-tjänsten svarade inte. Orsaken finns i serverloggen.";
+            readonly no_model: "Ingen AI-modell är inställd än, till exempel för att en API-nyckel saknas. Be den som sköter webbplatsen att lägga till en.";
             readonly tool_denied: "Det får assistenten inte göra här.";
             readonly stale_context: "Formuläret ändrades under tiden. Försök igen.";
             readonly aborted: "Stoppat.";

package/dist/components/copy.js

@@ -44,6 +44,7 @@ export const COPY = {
             rate_limited: "Too many messages at once. Wait a moment and try again.",
             timeout: "The assistant took too long to answer. Try again.",
             provider_error: "The AI service did not answer. The server log has the cause.",
+            no_model: "No AI model is set up yet, for example because an API key is missing. Ask whoever runs the site to add one.",
             tool_denied: "That is not something the assistant may do here.",
             stale_context: "The form changed in the meantime. Try again.",
             aborted: "Stopped.",
@@ -94,6 +95,7 @@ export const COPY = {
             rate_limited: "För många meddelanden på en gång. Vänta en stund och försök igen.",
             timeout: "Assistenten tog för lång tid på sig. Försök igen.",
             provider_error: "AI-tjänsten svarade inte. Orsaken finns i serverloggen.",
+            no_model: "Ingen AI-modell är inställd än, till exempel för att en API-nyckel saknas. Be den som sköter webbplatsen att lägga till en.",
             tool_denied: "Det får assistenten inte göra här.",
             stale_context: "Formuläret ändrades under tiden. Försök igen.",
             aborted: "Stoppat.",

package/dist/runtime/agent.js

@@ -10,8 +10,8 @@ const TIMEOUT_MS = 60_000;
 export async function runAgentTurn(req, options, input) {
     const model = await resolveModel(options, req.user?.id);
     if (!model) {
-        logProviderError(req, "no model: the `model` option resolved to nothing for this user");
-        return { ok: false, error: "provider_error" };
+        req.payload?.logger?.warn(`${PACKAGE_NAME}: no model: the \`model\` option resolved to nothing for this user`);
+        return { ok: false, error: "no_model" };
     }
     const ai = await loadAiSdk();
     if (!ai) {

package/dist/types.d.ts

@@ -1,9 +1,13 @@
 import type { EntityCapability } from "./capabilities.ts";
 import type { AdminViewKind } from "./view.ts";
 export type HostLanguageModel = object;
+/**
+ * Returns the model for this request. Returning `null` or `undefined` (no API key set, say) keeps the
+ * plugin installed and tells the editor in the drawer that no model is set up.
+ */
 export type ModelResolver = (args: {
     userId?: string | number;
-}) => HostLanguageModel | Promise<HostLanguageModel>;
+}) => HostLanguageModel | null | undefined | Promise<HostLanguageModel | null | undefined>;
 export type FieldAllowlist = true | {
     include: string[];
 } | {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simmalugnt-se/payload-editor-assistant",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "description": "Context-aware editor assistant plugin for Payload Admin",
   "keywords": [
     "payload",
@@ -53,12 +53,12 @@
     }
   },
   "devDependencies": {
-    "@payloadcms/ui": "3.87.1",
+    "@payloadcms/ui": "3.90.2",
     "@types/node": "^22",
     "@types/react": "^19.2.18",
     "@types/react-dom": "^19.2.4",
-    "next": "16.3.0",
-    "payload": "3.87.1",
+    "next": "16.3.6",
+    "payload": "3.90.2",
     "react": "19.2.8",
     "react-dom": "19.2.8",
     "tsx": "^4.21.0",