@exulu/backend 1.57.0 → 1.59.0

package/dist/index.d.cts

@@ -10,6 +10,7 @@ import { z } from 'zod';
 import { Tiktoken } from 'tiktoken/lite';
 import models from 'tiktoken/model_to_encoding.json';
 
+type ApiKeyScopeMode = "admin" | "agents";
 type User = {
     id: number;
     firstname?: string;
@@ -20,6 +21,8 @@ type User = {
     anthropic_token?: string;
     super_admin?: boolean;
     favourite_agents?: string[];
+    scope_mode?: ApiKeyScopeMode;
+    agent_ids?: string[];
     role: {
         id: string;
         name: string;
@@ -39,8 +42,12 @@ type ExuluProviderConfig = {
     name: string;
     instructions: string;
     model: {
-        create: ({ apiKey }: {
+        create: ({ apiKey, user, role, project, agent }: {
             apiKey?: string | undefined;
+            user?: number;
+            role?: string;
+            project?: string;
+            agent?: string;
         }) => LanguageModel;
     };
     custom?: {
@@ -57,11 +64,21 @@ type ExuluProviderConfig = {
     };
 };
 
+type AgentRateLimitBucket = {
+    limit: number;
+    window_seconds: number;
+};
+type AgentRateLimits = {
+    requests?: AgentRateLimitBucket;
+    input_tokens?: AgentRateLimitBucket;
+    output_tokens?: AgentRateLimitBucket;
+};
 interface ExuluAgent {
     id: string;
     modelName?: string;
     providerName?: string;
-    provider: string;
+    /** @deprecated Hydrated for read compatibility; the underlying DB column is gone. */
+    provider?: string;
     source: "code" | "database";
     memory?: string;
     welcomemessage?: string;
@@ -69,7 +86,8 @@ interface ExuluAgent {
     type: "agent";
     name: string;
     image?: string;
-    providerapikey?: string;
+    /** FK to models.id — replaces legacy provider + providerapikey columns. */
+    model?: string;
     workflows?: ExuluProviderWorkflowConfig;
     firewall?: {
         enabled: boolean;
@@ -85,6 +103,7 @@ interface ExuluAgent {
     description?: string;
     instructions?: string;
     feedback?: boolean;
+    suggestions_enabled?: boolean;
     slug?: string;
     tools?: {
         id: string;
@@ -124,6 +143,7 @@ interface ExuluAgent {
             rights: 'read' | 'write';
         }>;
     };
+    rate_limits?: AgentRateLimits;
     createdAt?: string;
     updatedAt?: string;
 }
@@ -168,7 +188,7 @@ declare class ExuluTool {
     description: string;
     category: string;
     inputSchema?: z.ZodType;
-    type: "context" | "function" | "agent" | "web_search";
+    type: "context" | "function" | "agent" | "web_search" | "skill";
     tool: Tool;
     needsApproval: boolean;
     config: {
@@ -183,7 +203,7 @@ declare class ExuluTool {
         description: string;
         category?: string;
         inputSchema?: z.ZodType;
-        type: "context" | "function" | "agent" | "web_search";
+        type: "context" | "function" | "agent" | "web_search" | "skill";
         config: {
             name: string;
             description: string;
@@ -699,6 +719,17 @@ type ExuluAgentToolConfig = {
     }[];
 };
 
+type ExuluSkill = {
+    id: string;
+    name: string;
+    description: string;
+    s3folder: string;
+    tags: string[];
+    usage_count: number;
+    favorite_count: number;
+    current_version: number;
+};
+
 type ExuluProviderWorkflowConfig = {
     enabled: boolean;
     queue?: Promise<ExuluQueueConfig>;
@@ -721,7 +752,6 @@ interface ExuluProviderParams {
         audio: audioTypes$1[];
         video: videoTypes$1[];
     };
-    outputSchema?: z.ZodType;
     rateLimit?: RateLimiterRule;
 }
 declare class ExuluProvider {
@@ -739,8 +769,12 @@ declare class ExuluProvider {
     rateLimit?: RateLimiterRule;
     config?: ExuluProviderConfig | undefined;
     model?: {
-        create: ({ apiKey }: {
+        create: ({ apiKey, user, role, project, agent }: {
             apiKey?: string | undefined;
+            user?: number;
+            role?: string;
+            project?: string;
+            agent?: string;
         }) => LanguageModel;
     };
     capabilities: {
@@ -754,7 +788,7 @@ declare class ExuluProvider {
     get providerName(): string;
     get modelName(): string;
     tool: (instance: string, providers: ExuluProvider[], contexts: ExuluContext[], rerankers: ExuluReranker[]) => Promise<ExuluTool | null>;
-    generateSync: ({ prompt, req, user, session, inputMessages, approvedTools, currentTools, allExuluTools, statistics, toolConfigs, providerapikey, contexts, rerankers, exuluConfig, outputSchema, agent, instructions, maxStepCount, }: {
+    generateSync: ({ prompt, req, user, session, inputMessages, approvedTools, currentTools, currentSkills, allExuluTools, statistics, toolConfigs, providerapikey, languageModel, contexts, rerankers, exuluConfig, agent, instructions, maxStepCount, onTokenUsage, }: {
         prompt?: string;
         user?: User;
         maxStepCount?: number;
@@ -764,15 +798,20 @@ declare class ExuluProvider {
         approvedTools?: string[];
         inputMessages?: UIMessage[];
         currentTools?: ExuluTool[];
+        currentSkills?: ExuluSkill[];
         allExuluTools?: ExuluTool[];
         statistics?: ExuluStatisticParams;
         toolConfigs?: ExuluAgentToolConfig[];
         providerapikey?: string | undefined;
+        languageModel: LanguageModel;
         contexts?: ExuluContext[] | undefined;
         rerankers?: ExuluReranker[] | undefined;
         exuluConfig?: ExuluConfig;
         instructions?: string;
-        outputSchema?: z.ZodTypeAny;
+        onTokenUsage?: (usage: {
+            inputTokens: number;
+            outputTokens: number;
+        }) => Promise<void> | void;
     }) => Promise<any>;
     /**
      * Convert file parts in messages to OpenAI Responses API compatible format.
@@ -782,7 +821,7 @@ declare class ExuluProvider {
      * - Image files -> image parts (which ARE supported by Responses API)
      */
     private processFilePartsInMessages;
-    generateStream: ({ user, session, agent, message, previousMessages, currentTools, approvedTools, allExuluTools, toolConfigs, providerapikey, contexts, rerankers, exuluConfig, instructions, req, maxStepCount }: {
+    generateStream: ({ user, session, agent, message, previousMessages, currentTools, currentSkills, approvedTools, allExuluTools, toolConfigs, providerapikey, languageModel, contexts, rerankers, exuluConfig, instructions, req, maxStepCount }: {
         user?: User;
         session?: string;
         agent?: ExuluAgent;
@@ -790,10 +829,12 @@ declare class ExuluProvider {
         message?: UIMessage;
         previousMessages?: UIMessage[];
         currentTools?: ExuluTool[];
+        currentSkills?: ExuluSkill[];
         approvedTools?: string[];
         allExuluTools?: ExuluTool[];
         toolConfigs?: ExuluAgentToolConfig[];
         providerapikey?: string | undefined;
+        languageModel: LanguageModel;
         contexts?: ExuluContext[] | undefined;
         rerankers?: ExuluReranker[] | undefined;
         exuluConfig?: ExuluConfig;
@@ -886,6 +927,14 @@ type ExuluConfig = {
     privacy?: {
         systemPromptPersonalization?: boolean;
     };
+    /**
+     * When true, ExuluApp.create() throws if any required system binary
+     * (pandoc / soffice / pdftoppm — needed by built-in skills like docx) is
+     * missing. When false or unset, the missing deps are logged as a warning
+     * and the app continues to start; skills that need the binary will fail
+     * at use time instead. Recommended `true` in production deployments.
+     */
+    requireSystemDependencies?: boolean;
 };
 declare class ExuluApp {
     private _providers;
@@ -1916,12 +1965,6 @@ declare class MarkdownChunker {
     }[]>;
 }
 
-/**
- * Python Environment Setup Utility
- *
- * Provides functions to set up and validate the Python environment for Exulu backend.
- * This can be called manually by package consumers or run automatically on install.
- */
 /**
  * Options for Python environment setup
  */
@@ -2093,6 +2136,7 @@ declare const ExuluDefaultProviders: {
         vertexGemini25Flash: ExuluProvider;
         vertexGemini25Pro: ExuluProvider;
         vertexGemini3Pro: ExuluProvider;
+        vertexLlamaScout4: ExuluProvider;
     };
     openai: {
         gpt5Mini: ExuluProvider;
@@ -2134,11 +2178,13 @@ declare const ExuluOtel: {
 };
 
 declare const ExuluDatabase: {
-    init: ({ contexts }: {
+    init: ({ contexts, litellm }: {
         contexts: ExuluContext[];
+        litellm?: boolean;
     }) => Promise<void>;
-    update: ({ contexts }: {
+    update: ({ contexts, litellm }: {
         contexts: ExuluContext[];
+        litellm?: boolean;
     }) => Promise<void>;
     api: {
         key: {

package/dist/index.d.ts

@@ -10,6 +10,7 @@ import { z } from 'zod';
 import { Tiktoken } from 'tiktoken/lite';
 import models from 'tiktoken/model_to_encoding.json';
 
+type ApiKeyScopeMode = "admin" | "agents";
 type User = {
     id: number;
     firstname?: string;
@@ -20,6 +21,8 @@ type User = {
     anthropic_token?: string;
     super_admin?: boolean;
     favourite_agents?: string[];
+    scope_mode?: ApiKeyScopeMode;
+    agent_ids?: string[];
     role: {
         id: string;
         name: string;
@@ -39,8 +42,12 @@ type ExuluProviderConfig = {
     name: string;
     instructions: string;
     model: {
-        create: ({ apiKey }: {
+        create: ({ apiKey, user, role, project, agent }: {
             apiKey?: string | undefined;
+            user?: number;
+            role?: string;
+            project?: string;
+            agent?: string;
         }) => LanguageModel;
     };
     custom?: {
@@ -57,11 +64,21 @@ type ExuluProviderConfig = {
     };
 };
 
+type AgentRateLimitBucket = {
+    limit: number;
+    window_seconds: number;
+};
+type AgentRateLimits = {
+    requests?: AgentRateLimitBucket;
+    input_tokens?: AgentRateLimitBucket;
+    output_tokens?: AgentRateLimitBucket;
+};
 interface ExuluAgent {
     id: string;
     modelName?: string;
     providerName?: string;
-    provider: string;
+    /** @deprecated Hydrated for read compatibility; the underlying DB column is gone. */
+    provider?: string;
     source: "code" | "database";
     memory?: string;
     welcomemessage?: string;
@@ -69,7 +86,8 @@ interface ExuluAgent {
     type: "agent";
     name: string;
     image?: string;
-    providerapikey?: string;
+    /** FK to models.id — replaces legacy provider + providerapikey columns. */
+    model?: string;
     workflows?: ExuluProviderWorkflowConfig;
     firewall?: {
         enabled: boolean;
@@ -85,6 +103,7 @@ interface ExuluAgent {
     description?: string;
     instructions?: string;
     feedback?: boolean;
+    suggestions_enabled?: boolean;
     slug?: string;
     tools?: {
         id: string;
@@ -124,6 +143,7 @@ interface ExuluAgent {
             rights: 'read' | 'write';
         }>;
     };
+    rate_limits?: AgentRateLimits;
     createdAt?: string;
     updatedAt?: string;
 }
@@ -168,7 +188,7 @@ declare class ExuluTool {
     description: string;
     category: string;
     inputSchema?: z.ZodType;
-    type: "context" | "function" | "agent" | "web_search";
+    type: "context" | "function" | "agent" | "web_search" | "skill";
     tool: Tool;
     needsApproval: boolean;
     config: {
@@ -183,7 +203,7 @@ declare class ExuluTool {
         description: string;
         category?: string;
         inputSchema?: z.ZodType;
-        type: "context" | "function" | "agent" | "web_search";
+        type: "context" | "function" | "agent" | "web_search" | "skill";
         config: {
             name: string;
             description: string;
@@ -699,6 +719,17 @@ type ExuluAgentToolConfig = {
     }[];
 };
 
+type ExuluSkill = {
+    id: string;
+    name: string;
+    description: string;
+    s3folder: string;
+    tags: string[];
+    usage_count: number;
+    favorite_count: number;
+    current_version: number;
+};
+
 type ExuluProviderWorkflowConfig = {
     enabled: boolean;
     queue?: Promise<ExuluQueueConfig>;
@@ -721,7 +752,6 @@ interface ExuluProviderParams {
         audio: audioTypes$1[];
         video: videoTypes$1[];
     };
-    outputSchema?: z.ZodType;
     rateLimit?: RateLimiterRule;
 }
 declare class ExuluProvider {
@@ -739,8 +769,12 @@ declare class ExuluProvider {
     rateLimit?: RateLimiterRule;
     config?: ExuluProviderConfig | undefined;
     model?: {
-        create: ({ apiKey }: {
+        create: ({ apiKey, user, role, project, agent }: {
             apiKey?: string | undefined;
+            user?: number;
+            role?: string;
+            project?: string;
+            agent?: string;
         }) => LanguageModel;
     };
     capabilities: {
@@ -754,7 +788,7 @@ declare class ExuluProvider {
     get providerName(): string;
     get modelName(): string;
     tool: (instance: string, providers: ExuluProvider[], contexts: ExuluContext[], rerankers: ExuluReranker[]) => Promise<ExuluTool | null>;
-    generateSync: ({ prompt, req, user, session, inputMessages, approvedTools, currentTools, allExuluTools, statistics, toolConfigs, providerapikey, contexts, rerankers, exuluConfig, outputSchema, agent, instructions, maxStepCount, }: {
+    generateSync: ({ prompt, req, user, session, inputMessages, approvedTools, currentTools, currentSkills, allExuluTools, statistics, toolConfigs, providerapikey, languageModel, contexts, rerankers, exuluConfig, agent, instructions, maxStepCount, onTokenUsage, }: {
         prompt?: string;
         user?: User;
         maxStepCount?: number;
@@ -764,15 +798,20 @@ declare class ExuluProvider {
         approvedTools?: string[];
         inputMessages?: UIMessage[];
         currentTools?: ExuluTool[];
+        currentSkills?: ExuluSkill[];
         allExuluTools?: ExuluTool[];
         statistics?: ExuluStatisticParams;
         toolConfigs?: ExuluAgentToolConfig[];
         providerapikey?: string | undefined;
+        languageModel: LanguageModel;
         contexts?: ExuluContext[] | undefined;
         rerankers?: ExuluReranker[] | undefined;
         exuluConfig?: ExuluConfig;
         instructions?: string;
-        outputSchema?: z.ZodTypeAny;
+        onTokenUsage?: (usage: {
+            inputTokens: number;
+            outputTokens: number;
+        }) => Promise<void> | void;
     }) => Promise<any>;
     /**
      * Convert file parts in messages to OpenAI Responses API compatible format.
@@ -782,7 +821,7 @@ declare class ExuluProvider {
      * - Image files -> image parts (which ARE supported by Responses API)
      */
     private processFilePartsInMessages;
-    generateStream: ({ user, session, agent, message, previousMessages, currentTools, approvedTools, allExuluTools, toolConfigs, providerapikey, contexts, rerankers, exuluConfig, instructions, req, maxStepCount }: {
+    generateStream: ({ user, session, agent, message, previousMessages, currentTools, currentSkills, approvedTools, allExuluTools, toolConfigs, providerapikey, languageModel, contexts, rerankers, exuluConfig, instructions, req, maxStepCount }: {
         user?: User;
         session?: string;
         agent?: ExuluAgent;
@@ -790,10 +829,12 @@ declare class ExuluProvider {
         message?: UIMessage;
         previousMessages?: UIMessage[];
         currentTools?: ExuluTool[];
+        currentSkills?: ExuluSkill[];
         approvedTools?: string[];
         allExuluTools?: ExuluTool[];
         toolConfigs?: ExuluAgentToolConfig[];
         providerapikey?: string | undefined;
+        languageModel: LanguageModel;
         contexts?: ExuluContext[] | undefined;
         rerankers?: ExuluReranker[] | undefined;
         exuluConfig?: ExuluConfig;
@@ -886,6 +927,14 @@ type ExuluConfig = {
     privacy?: {
         systemPromptPersonalization?: boolean;
     };
+    /**
+     * When true, ExuluApp.create() throws if any required system binary
+     * (pandoc / soffice / pdftoppm — needed by built-in skills like docx) is
+     * missing. When false or unset, the missing deps are logged as a warning
+     * and the app continues to start; skills that need the binary will fail
+     * at use time instead. Recommended `true` in production deployments.
+     */
+    requireSystemDependencies?: boolean;
 };
 declare class ExuluApp {
     private _providers;
@@ -1916,12 +1965,6 @@ declare class MarkdownChunker {
     }[]>;
 }
 
-/**
- * Python Environment Setup Utility
- *
- * Provides functions to set up and validate the Python environment for Exulu backend.
- * This can be called manually by package consumers or run automatically on install.
- */
 /**
  * Options for Python environment setup
  */
@@ -2093,6 +2136,7 @@ declare const ExuluDefaultProviders: {
         vertexGemini25Flash: ExuluProvider;
         vertexGemini25Pro: ExuluProvider;
         vertexGemini3Pro: ExuluProvider;
+        vertexLlamaScout4: ExuluProvider;
     };
     openai: {
         gpt5Mini: ExuluProvider;
@@ -2134,11 +2178,13 @@ declare const ExuluOtel: {
 };
 
 declare const ExuluDatabase: {
-    init: ({ contexts }: {
+    init: ({ contexts, litellm }: {
         contexts: ExuluContext[];
+        litellm?: boolean;
     }) => Promise<void>;
-    update: ({ contexts }: {
+    update: ({ contexts, litellm }: {
         contexts: ExuluContext[];
+        litellm?: boolean;
     }) => Promise<void>;
     api: {
         key: {