@mvriu5/payload-ai 0.5.0 → 0.5.8

package/README.md

@@ -5,7 +5,7 @@ AI assistant plugin for Payload CMS. It adds an admin dashboard assistant that c
 ## Install
 
 ```bash
-pnpm add payload-ai-plugin
+npm add @mvriu5/payload-ai
 ```
 
 ## Usage
@@ -30,7 +30,7 @@ The plugin adds two fields to the configured Payload admin user collection:
 - `aiProvider`
 - `aiApiKey`
 
-Users can select their provider and store their own API key in account settings. The key is used server-side when the chat endpoint calls the selected model.
+Users can select their provider and optionally store their own API key in account settings. If no account-level key is set, the chat endpoint uses provider environment variables.
 
 ## Options
 
@@ -38,8 +38,14 @@ Users can select their provider and store their own API key in account settings.
 import type { PayloadAiPluginOptions } from "payload-ai-plugin";
 
 const options: PayloadAiPluginOptions = {
+  allowUserApiKeys: false,
   collections: {
-    posts: true,
+    posts: {
+      read: true,
+      create: true,
+      update: true,
+      delete: false,
+    },
   },
   models: {
     defaults: {
@@ -59,22 +65,63 @@ const options: PayloadAiPluginOptions = {
 
 Restricts AI read and write proposals to enabled collection slugs. If omitted, all non-internal Payload collections are available.
 
+Use `true` to enable all AI actions for a collection:
+
+```ts
+payloadAiPlugin({
+  collections: {
+    posts: true,
+  },
+})
+```
+
+Use granular permissions to control each action:
+
+```ts
+payloadAiPlugin({
+  collections: {
+    posts: {
+      read: true,
+      create: true,
+      update: true,
+      delete: false,
+    },
+  },
+})
+```
+
+`read` controls schema/context access, document search, and mentions. `create`, `update`, and `delete` control AI action proposals and server-side apply permissions.
+
 ### `models`
 
 Overrides the model list shown in the admin UI and the default model per provider.
 
+### `allowUserApiKeys`
+
+Controls whether the plugin adds an `aiApiKey` field to the admin user collection.
+
+```ts
+payloadAiPlugin({
+  allowUserApiKeys: false,
+})
+```
+
+When disabled, users can still select an AI provider, but API keys must come from environment variables.
+
 ### `disabled`
 
 Disables endpoint and UI registration while keeping the plugin call in your config.
 
 ## Provider Environment Variables
 
-Account-level API keys take priority. If a user has no key configured, the server falls back to provider environment variables:
+API key priority is:
+
+1. account-level API key, unless `allowUserApiKeys: false`
+2. provider environment variables
 
 - `OPENAI_API_KEY`, `OPENAI_MODEL`
 - `ANTHROPIC_API_KEY`, `ANTHROPIC_MODEL`
 - `GOOGLE_GENERATIVE_AI_API_KEY`, `GOOGLE_GENERATIVE_AI_MODEL`
-- `GROQ_API_KEY`, `GROQ_MODEL`
 - `MISTRAL_API_KEY`, `MISTRAL_MODEL`
 
 `PAYLOAD_SECRET` is required for signing AI action proposals.

package/dist/ai/providerOptions.d.ts

@@ -26,19 +26,6 @@ declare const aiProviderModels: {
         readonly label: "Gemini 2.5 Pro";
         readonly value: "gemini-2.5-pro";
     }];
-    readonly groq: readonly [{
-        readonly label: "Llama 3.3 70B Versatile";
-        readonly value: "llama-3.3-70b-versatile";
-    }, {
-        readonly label: "Llama 3.1 8B Instant";
-        readonly value: "llama-3.1-8b-instant";
-    }, {
-        readonly label: "GPT OSS 120B";
-        readonly value: "openai/gpt-oss-120b";
-    }, {
-        readonly label: "GPT OSS 20B";
-        readonly value: "openai/gpt-oss-20b";
-    }];
     readonly mistral: readonly [{
         readonly label: "Mistral Small";
         readonly value: "mistral-small-latest";
@@ -78,7 +65,7 @@ export type AIModelConfig = {
     providers?: Partial<Record<AIProvider, AIProviderModelOption[]>>;
 };
 export declare const getResolvedAIModelConfig: (modelConfig?: AIModelConfig) => {
-    defaults: Record<"claude" | "google" | "groq" | "mistral" | "openai", string>;
+    defaults: Record<"claude" | "google" | "mistral" | "openai", string>;
     providers: AIProviderModels;
 };
 export declare const isAIProvider: (provider: string) => provider is AIProvider;

package/dist/ai/providerOptions.js

@@ -31,24 +31,6 @@ const aiProviderModels = {
             value: "gemini-2.5-pro"
         }
     ],
-    groq: [
-        {
-            label: "Llama 3.3 70B Versatile",
-            value: "llama-3.3-70b-versatile"
-        },
-        {
-            label: "Llama 3.1 8B Instant",
-            value: "llama-3.1-8b-instant"
-        },
-        {
-            label: "GPT OSS 120B",
-            value: "openai/gpt-oss-120b"
-        },
-        {
-            label: "GPT OSS 20B",
-            value: "openai/gpt-oss-20b"
-        }
-    ],
     mistral: [
         {
             label: "Mistral Small",
@@ -95,10 +77,6 @@ export const aiProviders = [
         label: "Google Gemini",
         value: "google"
     },
-    {
-        label: "Groq",
-        value: "groq"
-    },
     {
         label: "Mistral",
         value: "mistral"
@@ -111,7 +89,6 @@ export const aiProviders = [
 export const defaultAIModels = {
     claude: aiProviderModels.claude[0].value,
     google: aiProviderModels.google[0].value,
-    groq: aiProviderModels.groq[0].value,
     mistral: aiProviderModels.mistral[0].value,
     openai: aiProviderModels.openai[0].value
 };

package/dist/ai/providerRuntime.d.ts

@@ -1,7 +1,8 @@
 import type { LanguageModel } from "ai";
-import { type AIProvider } from "./providerOptions.js";
+import { type AIProvider, type AIModelConfig } from "./providerOptions.js";
 type ProviderConfig = {
     apiKey?: string | null;
+    defaultModels?: AIModelConfig["defaults"];
     model?: string | null;
     provider: AIProvider;
 };
@@ -10,7 +11,7 @@ type ModelConfig = {
     model: string;
     provider: AIProvider;
 };
-export declare const getProviderConfig: ({ apiKey, model, provider, }: ProviderConfig) => {
+export declare const getProviderConfig: ({ apiKey, defaultModels, model, provider, }: ProviderConfig) => {
     apiKey: string | undefined;
     modelID: string;
 };

package/dist/ai/providerRuntime.js

@@ -1,37 +1,31 @@
 import { createAnthropic } from "@ai-sdk/anthropic";
 import { createGoogleGenerativeAI } from "@ai-sdk/google";
-import { createGroq } from "@ai-sdk/groq";
 import { createMistral } from "@ai-sdk/mistral";
 import { createOpenAI } from "@ai-sdk/openai";
 import { defaultAIModels } from "./providerOptions.js";
-export const getProviderConfig = ({ apiKey, model, provider })=>{
+export const getProviderConfig = ({ apiKey, defaultModels, model, provider })=>{
+    const defaultModel = defaultModels?.[provider] || defaultAIModels[provider];
     if (provider === "claude") {
         return {
             apiKey: apiKey || process.env.ANTHROPIC_API_KEY,
-            modelID: model || process.env.ANTHROPIC_MODEL || defaultAIModels.claude
+            modelID: model || process.env.ANTHROPIC_MODEL || defaultModel
         };
     }
     if (provider === "google") {
         return {
             apiKey: apiKey || process.env.GOOGLE_GENERATIVE_AI_API_KEY,
-            modelID: model || process.env.GOOGLE_GENERATIVE_AI_MODEL || defaultAIModels.google
-        };
-    }
-    if (provider === "groq") {
-        return {
-            apiKey: apiKey || process.env.GROQ_API_KEY,
-            modelID: model || process.env.GROQ_MODEL || defaultAIModels.groq
+            modelID: model || process.env.GOOGLE_GENERATIVE_AI_MODEL || defaultModel
         };
     }
     if (provider === "mistral") {
         return {
             apiKey: apiKey || process.env.MISTRAL_API_KEY,
-            modelID: model || process.env.MISTRAL_MODEL || defaultAIModels.mistral
+            modelID: model || process.env.MISTRAL_MODEL || defaultModel
         };
     }
     return {
         apiKey: apiKey || process.env.OPENAI_API_KEY,
-        modelID: model || process.env.OPENAI_MODEL || defaultAIModels.openai
+        modelID: model || process.env.OPENAI_MODEL || defaultModel
     };
 };
 export const getModel = ({ apiKey, model, provider })=>{
@@ -41,9 +35,6 @@ export const getModel = ({ apiKey, model, provider })=>{
     if (provider === "google") return createGoogleGenerativeAI({
         apiKey
     })(model);
-    if (provider === "groq") return createGroq({
-        apiKey
-    })(model);
     if (provider === "mistral") return createMistral({
         apiKey
     })(model);

package/dist/components/AIActionProposalList.d.ts

@@ -21,5 +21,5 @@ type AIActionProposalListProps = {
     onApply: (proposal: AIActionProposal, index: number) => void;
     proposals: AIActionProposal[];
 };
-export declare const AIActionProposalList: ({ appliedProposalIndexes, description, error, getViewURL, isApplying, onDismiss, onDismissError, onApply, proposals, }: AIActionProposalListProps) => import("react/jsx-runtime").JSX.Element | null;
+export declare const AIActionProposalList: ({ appliedProposalIndexes, description, error, getViewURL, isApplying, onDismiss, onDismissError, onApply, proposals, }: AIActionProposalListProps) => import("react").JSX.Element | null;
 export {};

package/dist/components/AIApiKeyField.js

@@ -1,13 +1,5 @@
 "use client";
 import { useField } from "@payloadcms/ui";
-const getLabel = (label, fallback)=>{
-    if (typeof label === "string") return label;
-    if (label && typeof label === "object") {
-        const firstLabel = Object.values(label)[0];
-        if (typeof firstLabel === "string") return firstLabel;
-    }
-    return fallback;
-};
 const getFieldClassName = ({ className, isReadOnly, showError })=>[
         "field-type",
         "password",

package/dist/components/AIInput.d.ts

@@ -1 +1 @@
-export declare const AIInput: () => import("react/jsx-runtime").JSX.Element;
+export declare const AIInput: () => import("react").JSX.Element;

package/dist/components/AIInput.js

@@ -7,6 +7,7 @@ import { getSerializableLabel, isInternalCollection } from "../payload/shared.js
 import { AIActionProposalList } from "./AIActionProposalList.js";
 import styles from "./AIInput.module.css";
 import { CollectionMentionPopover } from "./CollectionMentionPopover.js";
+import { ClaudeIcon, GoogleGeminiIcon, MistralAiIcon, OpenaiIcon } from "./Icons.js";
 import { useAISettings } from "./hooks/useAISettings.js";
 import { useDocumentMentionSuggestions } from "./hooks/useDocumentMentionSuggestions.js";
 const collectBlockOptions = ({ fields, parent })=>{
@@ -35,6 +36,24 @@ const collectBlockOptions = ({ fields, parent })=>{
     }
     return options;
 };
+const getProviderIcon = (provider)=>{
+    const iconProps = {
+        "aria-hidden": true,
+        className: styles.selectProviderIcon
+    };
+    switch(provider){
+        case "claude":
+            return /*#__PURE__*/ React.createElement(ClaudeIcon, iconProps);
+        case "google":
+            return /*#__PURE__*/ React.createElement(GoogleGeminiIcon, iconProps);
+        case "mistral":
+            return /*#__PURE__*/ React.createElement(MistralAiIcon, iconProps);
+        case "openai":
+            return /*#__PURE__*/ React.createElement(OpenaiIcon, iconProps);
+        default:
+            return null;
+    }
+};
 export const AIInput = ()=>{
     const { config } = useConfig();
     const editorRef = useRef(null);
@@ -58,7 +77,12 @@ export const AIInput = ()=>{
     const [proposals, setProposals] = useState([]);
     const [isLoading, setIsLoading] = useState(false);
     const [isApplying, setIsApplying] = useState(false);
-    const collections = config.collections.filter((collection)=>!isInternalCollection(collection.slug)).map((collection)=>({
+    const enabledCollectionSlugs = config.admin?.custom?.payloadAiPlugin?.collectionSlugs;
+    const enabledCollectionSlugSet = useMemo(()=>enabledCollectionSlugs ? new Set(enabledCollectionSlugs) : null, [
+        enabledCollectionSlugs
+    ]);
+    const isCollectionMentionEnabled = (slug)=>!enabledCollectionSlugSet || enabledCollectionSlugSet.has(slug);
+    const collections = config.collections.filter((collection)=>!isInternalCollection(collection.slug)).filter((collection)=>isCollectionMentionEnabled(collection.slug)).map((collection)=>({
             label: getSerializableLabel(collection.labels?.singular, collection.slug),
             slug: collection.slug,
             type: "collection"
@@ -69,7 +93,7 @@ export const AIInput = ()=>{
             type: "global"
         })) || [];
     const blocks = [
-        ...config.collections.flatMap((collection)=>collectBlockOptions({
+        ...config.collections.filter((collection)=>isCollectionMentionEnabled(collection.slug)).flatMap((collection)=>collectBlockOptions({
                 fields: collection.fields,
                 parent: collection.slug
             })),
@@ -106,14 +130,6 @@ export const AIInput = ()=>{
         clonedRange.setEnd(range.endContainer, range.endOffset);
         return clonedRange.toString().length;
     };
-    const moveCaretToEnd = (element)=>{
-        const selection = window.getSelection();
-        const range = document.createRange();
-        range.selectNodeContents(element);
-        range.collapse(false);
-        selection?.removeAllRanges();
-        selection?.addRange(range);
-    };
     const getTextNodeAtOffset = (element, offset)=>{
         const walker = document.createTreeWalker(element, NodeFilter.SHOW_TEXT);
         let currentOffset = 0;
@@ -349,17 +365,19 @@ export const AIInput = ()=>{
         className: styles.setting
     }, /*#__PURE__*/ React.createElement("span", {
         className: styles.settingLabel
-    }, "Model"), /*#__PURE__*/ React.createElement("select", {
+    }, "Model"), /*#__PURE__*/ React.createElement("div", {
+        className: styles.selectWrapper
+    }, getProviderIcon(settingsProvider), /*#__PURE__*/ React.createElement("select", {
         className: styles.select,
         disabled: !settingsProvider,
         onChange: (event)=>setSelectedModel(event.target.value),
         value: selectedModel
-    }, !settingsProvider ? /*#__PURE__*/ React.createElement("option", {
+    }, !settingsProvider && /*#__PURE__*/ React.createElement("option", {
         value: ""
-    }, "Select provider in account settings") : null, settingsProvider ? aiModelConfig.providers[settingsProvider].map((model)=>/*#__PURE__*/ React.createElement("option", {
+    }, "Select provider in account settings"), settingsProvider && aiModelConfig.providers[settingsProvider].map((model)=>/*#__PURE__*/ React.createElement("option", {
             key: model.value,
             value: model.value
-        }, model.label)) : null))), /*#__PURE__*/ React.createElement("button", {
+        }, model.label)))))), /*#__PURE__*/ React.createElement("button", {
         className: styles.chatButton,
         disabled: !prompt.trim() || !settingsProvider || !selectedModel || isLoading,
         onClick: ()=>void handleSubmit(),