@mvriu5/payload-ai 0.5.9 → 1.1.1

package/README.md

@@ -5,14 +5,28 @@ AI assistant plugin for Payload CMS. It adds an admin dashboard assistant that c
 ## Install
 
 ```bash
-npm add @mvriu5/payload-ai
+npm add @mvriu5/payload-ai @ai-sdk/openai
+```
+
+Install only the provider SDKs you actually use:
+
+```bash
+npm add @mvriu5/payload-ai @ai-sdk/anthropic
+npm add @mvriu5/payload-ai @ai-sdk/google
+npm add @mvriu5/payload-ai @ai-sdk/mistral
+```
+
+OpenRouter uses the community OpenRouter provider:
+
+```bash
+npm add @mvriu5/payload-ai @openrouter/ai-sdk-provider
 ```
 
 ## Usage
 
 ```ts
 import { buildConfig } from "payload";
-import { payloadAiPlugin } from "payload-ai-plugin";
+import { payloadAiPlugin } from "@mvriu5/payload-ai";
 
 export default buildConfig({
   plugins: [
@@ -35,7 +49,7 @@ Users can select their provider and optionally store their own API key in accoun
 ## Options
 
 ```ts
-import type { PayloadAiPluginOptions } from "payload-ai-plugin";
+import type { PayloadAiPluginOptions } from "@mvriu5/payload-ai";
 
 const options: PayloadAiPluginOptions = {
   allowUserApiKeys: false,
@@ -46,10 +60,12 @@ const options: PayloadAiPluginOptions = {
       update: true,
       delete: false,
     },
+    users: true,
   },
   models: {
     defaults: {
       openai: "gpt-4.1-mini",
+      openrouter: "openai/gpt-oss-120b",
     },
     providers: {
       openai: [
@@ -58,6 +74,7 @@ const options: PayloadAiPluginOptions = {
       ],
     },
   },
+  maxOutputTokens: 1200,
 };
 ```
 
@@ -90,12 +107,47 @@ payloadAiPlugin({
 })
 ```
 
+You can mix both forms in the same object:
+
+```ts
+payloadAiPlugin({
+  collections: {
+    posts: true,
+    pages: true,
+    users: {
+      read: true,
+      update: true,
+    },
+  },
+})
+```
+
 `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.
 
+Built-in providers are `openai`, `openrouter`, `claude`, `mistral`, and `google`.
+
+OpenRouter includes these built-in model options:
+
+- `openrouter/auto`
+- `openai/gpt-oss-120b`
+- `openai/gpt-4o-mini`
+- `anthropic/claude-3.5-sonnet`
+- `google/gemini-2.0-flash-001`
+
+### `maxOutputTokens`
+
+Controls the maximum number of output tokens the chat endpoint may generate per request. If omitted, the plugin uses `700`.
+
+```ts
+payloadAiPlugin({
+  maxOutputTokens: 1200,
+})
+```
+
 ### `allowUserApiKeys`
 
 Controls whether the plugin adds an `aiApiKey` field to the admin user collection.
@@ -114,12 +166,16 @@ Disables endpoint and UI registration while keeping the plugin call in your conf
 
 ## Provider Environment Variables
 
+The package lazy-loads provider SDKs at runtime. If a user selects `claude`, `google`, `mistral`, `openai`, or `openrouter`, the matching provider package must be installed in the host app.
+`openrouter` uses `@openrouter/ai-sdk-provider`.
+
 API key priority is:
 
 1. account-level API key, unless `allowUserApiKeys: false`
 2. provider environment variables
 
 - `OPENAI_API_KEY`, `OPENAI_MODEL`
+- `OPENROUTER_API_KEY`, `OPENROUTER_MODEL`
 - `ANTHROPIC_API_KEY`, `ANTHROPIC_MODEL`
 - `GOOGLE_GENERATIVE_AI_API_KEY`, `GOOGLE_GENERATIVE_AI_MODEL`
 - `MISTRAL_API_KEY`, `MISTRAL_MODEL`
@@ -135,12 +191,12 @@ The apply endpoint returns only minimal status/doc references and does not retur
 ## Exports
 
 ```ts
-import { payloadAiPlugin } from "payload-ai-plugin";
-import type { PayloadAiPluginOptions } from "payload-ai-plugin";
+import { payloadAiPlugin } from "@mvriu5/payload-ai";
+import type { PayloadAiPluginOptions } from "@mvriu5/payload-ai";
 ```
 
 Client components are exported through:
 
 ```ts
-import { AIInput, AIApiKeyField } from "payload-ai-plugin/client";
+import { AIInput, AIApiKeyField } from "@mvriu5/payload-ai/client";
 ```

package/dist/ai/{proposals.d.ts → proposalSigning.d.ts}

@@ -8,5 +8,5 @@ type SignableProposal = Record<string, unknown> & {
 export declare const signAIActionProposal: <Proposal extends SignableProposal>(proposal: Proposal) => Proposal & {
     _aiSignature: AIActionSignature;
 };
-export declare const verifyAIActionProposal: (proposal: SignableProposal) => boolean;
+export declare const verifyActionProposal: (proposal: SignableProposal) => boolean;
 export {};

package/dist/ai/{proposals.js → proposalSigning.js}

@@ -1,10 +1,9 @@
 import { createHmac, timingSafeEqual } from "node:crypto";
+import { isRecord } from "../payload/shared.js";
 const signatureTTL = 10 * 60 * 1000;
 const stableStringify = (value)=>{
-    if (Array.isArray(value)) {
-        return `[${value.map(stableStringify).join(",")}]`;
-    }
-    if (value && typeof value === "object") {
+    if (Array.isArray(value)) return `[${value.map(stableStringify).join(",")}]`;
+    if (isRecord(value)) {
         const entries = Object.entries(value).filter(([key])=>key !== "_aiSignature").sort(([a], [b])=>a.localeCompare(b));
         return `{${entries.map(([key, entryValue])=>`${JSON.stringify(key)}:${stableStringify(entryValue)}`).join(",")}}`;
     }
@@ -12,9 +11,7 @@ const stableStringify = (value)=>{
 };
 const getSigningSecret = ()=>{
     const secret = process.env.PAYLOAD_SECRET;
-    if (!secret) {
-        throw new Error("PAYLOAD_SECRET is required to sign AI proposals.");
-    }
+    if (!secret) throw new Error("PAYLOAD_SECRET is required to sign AI proposals.");
     return secret;
 };
 const getSignaturePayload = (proposal, expiresAt)=>{
@@ -23,9 +20,7 @@ const getSignaturePayload = (proposal, expiresAt)=>{
         proposal
     });
 };
-const signPayload = (payload)=>{
-    return createHmac("sha256", getSigningSecret()).update(payload).digest("hex");
-};
+const signPayload = (payload)=>createHmac("sha256", getSigningSecret()).update(payload).digest("hex");
 export const signAIActionProposal = (proposal)=>{
     const expiresAt = new Date(Date.now() + signatureTTL).toISOString();
     const value = signPayload(getSignaturePayload(proposal, expiresAt));
@@ -37,7 +32,7 @@ export const signAIActionProposal = (proposal)=>{
         }
     };
 };
-export const verifyAIActionProposal = (proposal)=>{
+export const verifyActionProposal = (proposal)=>{
     const signature = proposal._aiSignature;
     if (!signature?.expiresAt || !signature.value) return false;
     if (Number.isNaN(new Date(signature.expiresAt).getTime())) return false;

package/dist/ai/providerOptions.d.ts

@@ -52,6 +52,22 @@ declare const aiProviderModels: {
         readonly label: "GPT-4o Mini";
         readonly value: "gpt-4o-mini";
     }];
+    readonly openrouter: readonly [{
+        readonly label: "OpenRouter Auto";
+        readonly value: "openrouter/auto";
+    }, {
+        readonly label: "GPT-OSS-120B";
+        readonly value: "openai/gpt-oss-120b";
+    }, {
+        readonly label: "GPT-4o Mini";
+        readonly value: "openai/gpt-4o-mini";
+    }, {
+        readonly label: "Claude 3.5 Sonnet";
+        readonly value: "anthropic/claude-3.5-sonnet";
+    }, {
+        readonly label: "Gemini 2.0 Flash";
+        readonly value: "google/gemini-2.0-flash-001";
+    }];
 };
 export type AIProvider = keyof typeof aiProviderModels;
 type AIProviderModels = Record<AIProvider, AIProviderModelOption[]>;
@@ -65,7 +81,7 @@ export type AIModelConfig = {
     providers?: Partial<Record<AIProvider, AIProviderModelOption[]>>;
 };
 export declare const getResolvedAIModelConfig: (modelConfig?: AIModelConfig) => {
-    defaults: Record<"claude" | "google" | "mistral" | "openai", string>;
+    defaults: Record<"claude" | "google" | "mistral" | "openai" | "openrouter", string>;
     providers: AIProviderModels;
 };
 export declare const isAIProvider: (provider: string) => provider is AIProvider;

package/dist/ai/providerOptions.js

@@ -66,6 +66,28 @@ const aiProviderModels = {
             label: "GPT-4o Mini",
             value: "gpt-4o-mini"
         }
+    ],
+    openrouter: [
+        {
+            label: "OpenRouter Auto",
+            value: "openrouter/auto"
+        },
+        {
+            label: "GPT-OSS-120B",
+            value: "openai/gpt-oss-120b"
+        },
+        {
+            label: "GPT-4o Mini",
+            value: "openai/gpt-4o-mini"
+        },
+        {
+            label: "Claude 3.5 Sonnet",
+            value: "anthropic/claude-3.5-sonnet"
+        },
+        {
+            label: "Gemini 2.0 Flash",
+            value: "google/gemini-2.0-flash-001"
+        }
     ]
 };
 export const aiProviders = [
@@ -84,21 +106,29 @@ export const aiProviders = [
     {
         label: "OpenAI",
         value: "openai"
+    },
+    {
+        label: "OpenRouter",
+        value: "openrouter"
     }
 ];
 export const defaultAIModels = {
     claude: aiProviderModels.claude[0].value,
     google: aiProviderModels.google[0].value,
     mistral: aiProviderModels.mistral[0].value,
-    openai: aiProviderModels.openai[0].value
+    openai: aiProviderModels.openai[0].value,
+    openrouter: aiProviderModels.openrouter[0].value
 };
 export const getResolvedAIModelConfig = (modelConfig)=>{
-    const providers = Object.fromEntries(Object.entries(aiProviderModels).map(([provider, models])=>[
+    const providers = Object.fromEntries(Object.entries(aiProviderModels).map(([provider, models])=>{
+        const providerKey = provider;
+        return [
             provider,
-            modelConfig?.providers?.[provider] || [
+            modelConfig?.providers?.[providerKey] || [
                 ...models
             ]
-        ]));
+        ];
+    }));
     const defaults = Object.fromEntries(Object.entries(defaultAIModels).map(([provider, defaultModel])=>{
         const providerKey = provider;
         const configuredDefault = modelConfig?.defaults?.[providerKey];
@@ -113,6 +143,4 @@ export const getResolvedAIModelConfig = (modelConfig)=>{
         providers
     };
 };
-export const isAIProvider = (provider)=>{
-    return provider in aiProviderModels;
-};
+export const isAIProvider = (provider)=>provider in aiProviderModels;

package/dist/ai/providerRuntime.d.ts

@@ -11,9 +11,9 @@ type ModelConfig = {
     model: string;
     provider: AIProvider;
 };
-export declare const getProviderConfig: ({ apiKey, defaultModels, model, provider, }: ProviderConfig) => {
+export declare const getProviderConfig: ({ apiKey, defaultModels, model, provider }: ProviderConfig) => {
     apiKey: string | undefined;
     modelID: string;
 };
-export declare const getModel: ({ apiKey, model, provider }: ModelConfig) => LanguageModel;
+export declare const getModel: ({ apiKey, model, provider }: ModelConfig) => Promise<LanguageModel>;
 export {};

package/dist/ai/providerRuntime.js

@@ -1,7 +1,3 @@
-import { createAnthropic } from "@ai-sdk/anthropic";
-import { createGoogleGenerativeAI } from "@ai-sdk/google";
-import { createMistral } from "@ai-sdk/mistral";
-import { createOpenAI } from "@ai-sdk/openai";
 import { defaultAIModels } from "./providerOptions.js";
 export const getProviderConfig = ({ apiKey, defaultModels, model, provider })=>{
     const defaultModel = defaultModels?.[provider] || defaultAIModels[provider];
@@ -23,22 +19,60 @@ export const getProviderConfig = ({ apiKey, defaultModels, model, provider })=>{
             modelID: model || process.env.MISTRAL_MODEL || defaultModel
         };
     }
+    if (provider === "openrouter") {
+        return {
+            apiKey: apiKey || process.env.OPENROUTER_API_KEY,
+            modelID: model || process.env.OPENROUTER_MODEL || defaultModel
+        };
+    }
     return {
         apiKey: apiKey || process.env.OPENAI_API_KEY,
         modelID: model || process.env.OPENAI_MODEL || defaultModel
     };
 };
-export const getModel = ({ apiKey, model, provider })=>{
-    if (provider === "claude") return createAnthropic({
-        apiKey
-    })(model);
-    if (provider === "google") return createGoogleGenerativeAI({
-        apiKey
-    })(model);
-    if (provider === "mistral") return createMistral({
-        apiKey
-    })(model);
-    return createOpenAI({
+const getMissingProviderDependencyError = (packageName, provider)=>{
+    return new Error(`Missing optional dependency ${packageName}. Install it to use the ${provider} provider.`);
+};
+export const getModel = async ({ apiKey, model, provider })=>{
+    const providerOptions = {
         apiKey
-    })(model);
+    };
+    if (provider === "claude") {
+        try {
+            const { createAnthropic } = await import("@ai-sdk/anthropic");
+            return createAnthropic(providerOptions)(model);
+        } catch (error) {
+            throw getMissingProviderDependencyError("@ai-sdk/anthropic", provider);
+        }
+    }
+    if (provider === "google") {
+        try {
+            const { createGoogleGenerativeAI } = await import("@ai-sdk/google");
+            return createGoogleGenerativeAI(providerOptions)(model);
+        } catch (error) {
+            throw getMissingProviderDependencyError("@ai-sdk/google", provider);
+        }
+    }
+    if (provider === "mistral") {
+        try {
+            const { createMistral } = await import("@ai-sdk/mistral");
+            return createMistral(providerOptions)(model);
+        } catch (error) {
+            throw getMissingProviderDependencyError("@ai-sdk/mistral", provider);
+        }
+    }
+    if (provider === "openrouter") {
+        try {
+            const { createOpenRouter } = await import("@openrouter/ai-sdk-provider");
+            return createOpenRouter(providerOptions)(model);
+        } catch (error) {
+            throw getMissingProviderDependencyError("@openrouter/ai-sdk-provider", provider);
+        }
+    }
+    try {
+        const { createOpenAI } = await import("@ai-sdk/openai");
+        return createOpenAI(providerOptions)(model);
+    } catch (error) {
+        throw getMissingProviderDependencyError("@ai-sdk/openai", provider);
+    }
 };

package/dist/ai/sensitiveData.js

@@ -1,3 +1,4 @@
+import { isRecord } from "../payload/shared.js";
 const sensitiveKeyPatterns = [
     /^apiKey$/i,
     /^api_key$/i,
@@ -7,12 +8,7 @@ const sensitiveKeyPatterns = [
     /^refreshToken$/i,
     /^secret$/i
 ];
-const isRecord = (value)=>{
-    return Boolean(value) && typeof value === "object" && !Array.isArray(value);
-};
-const isSensitiveKey = (key)=>{
-    return sensitiveKeyPatterns.some((pattern)=>pattern.test(key));
-};
+const isSensitiveKey = (key)=>sensitiveKeyPatterns.some((pattern)=>pattern.test(key));
 export const containsSensitiveData = (value)=>{
     if (Array.isArray(value)) return value.some(containsSensitiveData);
     if (!isRecord(value)) return false;

package/dist/components/AIInput.d.ts

@@ -1 +1,2 @@
-export declare const AIInput: () => import("react").JSX.Element;
+declare const AIInput: () => import("react").JSX.Element;
+export default AIInput;