@stackfactor/agent-utils 1.0.22 → 1.0.24

package/README.md

@@ -62,32 +62,6 @@ const result = await langChain.runPromptWithModel(
 
 ---
 
-### `langChain.runChatPromptWithModel(modelName, config, prompt, onProgressReport?)`
-
-Sends a conversational chat prompt to an LLM and returns a plain HTML response. Built for the StackFactor Mentor chat feature — system messages are wrapped with topic-constraint instructions that decline off-topic questions.
-
-| Parameter          | Type                 | Default | Description                                           |
-| ------------------ | -------------------- | ------- | ----------------------------------------------------- |
-| `modelName`        | `string`             | —       | Model identifier                                      |
-| `config`           | `object`             | —       | API keys and optional `temperature`                   |
-| `prompt`           | `string \| object[]` | —       | Plain string or array of `{ role, content }` messages |
-| `onProgressReport` | `function \| null`   | `null`  | Streaming progress callback                           |
-
-**Returns:** Raw HTML string.
-
-```typescript
-const html = await langChain.runChatPromptWithModel(
-  "claude-3-5-sonnet",
-  { anthropicAPIKey: "sk-ant-..." },
-  [
-    { role: "system", content: "Topic: JavaScript closures" },
-    { role: "user", content: "Explain closures with an example" },
-  ],
-);
-```
-
----
-
 ### `langChain.createAIAgent(name, modelName, systemPrompt, tools?, responseFormat?, config, onReportProgress?, minPercent?, maxPercent?)`
 
 Constructs a LangChain agent with a model, system prompt, and tools. When `onReportProgress` is provided, a `report_progress` tool is automatically added.

package/dist/cjs/langChain.d.ts

@@ -1,10 +1,11 @@
 declare const _default: {
+    checkIfAIProviderConfigured: (config: any) => void;
     createAgent: (name: string, modelName: string, systemPrompt: string, tools: any[], responseFormat: any, config: any) => any;
     runAgent: (agent: any, prompt: string, config: any, onProgress?: Function | null) => Promise<any>;
-    runChatPromptWithModel: (modelName: string, config: any, prompt: any, onProgressReport: any) => any;
     runPromptWithModel: (modelName: string, config: any, prompt: any, onProgressReport: any, minPercent?: number, maxPercent?: number, expectsJsonResponse?: boolean, schema?: any, agentName?: string, tools?: any[]) => Promise<any>;
     runPromptWithModelForImageGeneration: (modelName: string, config: any, prompt: string, options?: any) => Promise<any>;
     throwErrorIfNotSuccessful: (response: any) => string;
+    validateModel: (selectedModel: string, supportedModels: string[]) => string;
 };
 export default _default;
 //# sourceMappingURL=langChain.d.ts.map

package/dist/cjs/langChain.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"langChain.d.ts","sourceRoot":"","sources":["../../src/langChain.ts"],"names":[],"mappings":";wBAogBQ,MAAM,aACD,MAAM,gBACH,MAAM,SACb,GAAG,EAAE,kBACI,GAAG,UACX,GAAG,KACV,GAAG;sBAyBG,GAAG,UACF,MAAM,UACN,GAAG,eACC,QAAQ,GAAG,IAAI,KAC1B,OAAO,CAAC,GAAG,CAAC;wCA2xBF,MAAM,UACT,GAAG,UACH,GAAG,oBACO,GAAG,KACpB,GAAG;oCA1bO,MAAM,UACT,GAAG,UACH,GAAG,oBACO,GAAG,eACT,MAAM,eACN,MAAM,wBACG,OAAO,WACpB,GAAG,cACA,MAAM,UACV,GAAG,EAAE,KACX,OAAO,CAAC,GAAG,CAAC;sDAsvBF,MAAM,UACT,GAAG,UACH,MAAM,YACL,GAAG,KACX,OAAO,CAAC,GAAG,CAAC;0CAngC8B,GAAG,KAAG,MAAM;;AA8jCzD,wBAOE"}
+{"version":3,"file":"langChain.d.ts","sourceRoot":"","sources":["../../src/langChain.ts"],"names":[],"mappings":";0CAgD6C,GAAG,KAAG,IAAI;wBAke/C,MAAM,aACD,MAAM,gBACH,MAAM,SACb,GAAG,EAAE,kBACI,GAAG,UACX,GAAG,KACV,GAAG;sBAyBG,GAAG,UACF,MAAM,UACN,GAAG,eACC,QAAQ,GAAG,IAAI,KAC1B,OAAO,CAAC,GAAG,CAAC;oCAuXF,MAAM,UACT,GAAG,UACH,GAAG,oBACO,GAAG,eACT,MAAM,eACN,MAAM,wBACG,OAAO,WACpB,GAAG,cACA,MAAM,UACV,GAAG,EAAE,KACX,OAAO,CAAC,GAAG,CAAC;sDA6rBF,MAAM,UACT,GAAG,UACH,MAAM,YACL,GAAG,KACX,OAAO,CAAC,GAAG,CAAC;0CA59B8B,GAAG,KAAG,MAAM;mCAoBxC,MAAM,mBACJ,MAAM,EAAE,KACxB,MAAM;;AAigCT,wBAQE"}

package/dist/cjs/langChain.js

@@ -36,6 +36,14 @@ const assertQuotaAvailable = () => {
         throw errorHandling_js_1.default.create(const_js_1.default.HTTP_CODES.PAYMENT_REQUIRED, const_js_1.default.ERROR.QUOTA_EXHAUSTED);
     }
 };
+const checkIfAIProviderConfigured = (config) => {
+    if (!config ||
+        !config.openAIAPIKey ||
+        !config.googleAPIKey ||
+        !config.anthropicAPIKey) {
+        throw errorHandling_js_1.default.create(const_js_1.default.HTTP_CODES.INTERNAL_SERVER_ERROR, "The integration is not properly configured with all AI providers.");
+    }
+};
 /**
  * Subtracts the given USD cost from `global.quota.remaining` and adds it to
  * `global.quota.usedThisSession`. Silently no-ops when the quota globals are not
@@ -581,6 +589,20 @@ const throwErrorIfNotSuccessful = (response) => {
         throw errorHandling_js_1.default.create(const_js_1.default.HTTP_CODES.INTERNAL_SERVER_ERROR, const_js_1.default.ERROR.UNABLE_TO_GENERATE_CONTENT);
     }
 };
+/**
+ * Returns `selectedModel` when it appears in `supportedModels`, otherwise returns
+ * the first entry in `supportedModels` as a safe fallback. Use this to coerce a
+ * caller-supplied model identifier to one the current integration is known to
+ * support, instead of failing or silently passing an unsupported model to
+ * `getLLMModel`. When `supportedModels` is empty there is no fallback to pick,
+ * so the original `selectedModel` is returned unchanged.
+ */
+const validateModel = (selectedModel, supportedModels) => {
+    if (supportedModels.includes(selectedModel)) {
+        return selectedModel;
+    }
+    return supportedModels[0] ?? selectedModel;
+};
 const MAX_VALIDATION_RETRIES = 3;
 const MAX_RATE_LIMIT_RETRIES = 2;
 const RATE_LIMIT_MIN_WAIT_MS = 30_000;
@@ -1137,47 +1159,6 @@ const runPromptWithModel = async (modelName, config, prompt, onProgressReport, m
         }
     }
 };
-/**
- * Sends a conversational chat prompt to an LLM and returns a plain HTML response
- * intended for end-user display. This function is purpose-built for the StackFactor
- * Mentor chat feature: when the prompt is an array of messages, each `system` message
- * is wrapped in an enhanced system prompt that instructs the model to answer only
- * questions related to the provided topic, decline off-topic questions, and return
- * results as simple HTML without markdown code-block notation. The call is delegated to
- * `runPromptWithModel` with `expectsJsonResponse` set to `false`.
- * @param modelName - The model identifier, e.g. `"gpt-4o"`, `"claude-3-5-sonnet"`
- * @param config - Configuration object with API keys and optional `temperature`
- * @param prompt - A plain string user message, or an array of `{ role, content }`
- *   message objects; `system` messages have the topic-constraint wrapper applied
- * @param onProgressReport - Optional callback for streaming progress updates passed
- *   through to `runPromptWithModel`
- * @returns The model's response as a raw HTML string
- */
-const runChatPromptWithModel = (modelName, config, prompt, onProgressReport) => {
-    let messages = prompt;
-    // If prompt is an array, check for system message and enhance it
-    if (Array.isArray(prompt)) {
-        messages = prompt.map((msg) => {
-            if (msg.role === "system") {
-                return {
-                    ...msg,
-                    content: `You are StackFactor Mentor, an AI assistant that helps users by providing information related to the specified topic.
-          
-          ### Objective:
-          Respond to the user question considering just related to the selected topic and all previous interactions:
-          - If the question is unrelated decline to respond.
-          - Return the results as a simple HMTL but don't include notations for formatting blocks.
-          
-          ### TOPIC INFORMATION:\n
-          ${msg.content}
-          `,
-                };
-            }
-            return msg;
-        });
-    }
-    return runPromptWithModel(modelName, config, messages, onProgressReport, 0, 100, false);
-};
 /**
  * Determines the image generation provider for a given model name based on its prefix.
  * `dall-e-` and `gpt-image-` prefixes map to `"openai"`. `gemini-` and `imagen-`
@@ -1439,10 +1420,11 @@ const runPromptWithModelForImageGeneration = async (modelName, config, prompt, o
     }
 };
 exports.default = {
+    checkIfAIProviderConfigured,
     createAgent,
     runAgent,
-    runChatPromptWithModel,
     runPromptWithModel,
     runPromptWithModelForImageGeneration,
     throwErrorIfNotSuccessful,
+    validateModel,
 };

package/dist/esm/langChain.d.ts

@@ -1,10 +1,11 @@
 declare const _default: {
+    checkIfAIProviderConfigured: (config: any) => void;
     createAgent: (name: string, modelName: string, systemPrompt: string, tools: any[], responseFormat: any, config: any) => any;
     runAgent: (agent: any, prompt: string, config: any, onProgress?: Function | null) => Promise<any>;
-    runChatPromptWithModel: (modelName: string, config: any, prompt: any, onProgressReport: any) => any;
     runPromptWithModel: (modelName: string, config: any, prompt: any, onProgressReport: any, minPercent?: number, maxPercent?: number, expectsJsonResponse?: boolean, schema?: any, agentName?: string, tools?: any[]) => Promise<any>;
     runPromptWithModelForImageGeneration: (modelName: string, config: any, prompt: string, options?: any) => Promise<any>;
     throwErrorIfNotSuccessful: (response: any) => string;
+    validateModel: (selectedModel: string, supportedModels: string[]) => string;
 };
 export default _default;
 //# sourceMappingURL=langChain.d.ts.map

package/dist/esm/langChain.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"langChain.d.ts","sourceRoot":"","sources":["../../src/langChain.ts"],"names":[],"mappings":";wBAogBQ,MAAM,aACD,MAAM,gBACH,MAAM,SACb,GAAG,EAAE,kBACI,GAAG,UACX,GAAG,KACV,GAAG;sBAyBG,GAAG,UACF,MAAM,UACN,GAAG,eACC,QAAQ,GAAG,IAAI,KAC1B,OAAO,CAAC,GAAG,CAAC;wCA2xBF,MAAM,UACT,GAAG,UACH,GAAG,oBACO,GAAG,KACpB,GAAG;oCA1bO,MAAM,UACT,GAAG,UACH,GAAG,oBACO,GAAG,eACT,MAAM,eACN,MAAM,wBACG,OAAO,WACpB,GAAG,cACA,MAAM,UACV,GAAG,EAAE,KACX,OAAO,CAAC,GAAG,CAAC;sDAsvBF,MAAM,UACT,GAAG,UACH,MAAM,YACL,GAAG,KACX,OAAO,CAAC,GAAG,CAAC;0CAngC8B,GAAG,KAAG,MAAM;;AA8jCzD,wBAOE"}
+{"version":3,"file":"langChain.d.ts","sourceRoot":"","sources":["../../src/langChain.ts"],"names":[],"mappings":";0CAgD6C,GAAG,KAAG,IAAI;wBAke/C,MAAM,aACD,MAAM,gBACH,MAAM,SACb,GAAG,EAAE,kBACI,GAAG,UACX,GAAG,KACV,GAAG;sBAyBG,GAAG,UACF,MAAM,UACN,GAAG,eACC,QAAQ,GAAG,IAAI,KAC1B,OAAO,CAAC,GAAG,CAAC;oCAuXF,MAAM,UACT,GAAG,UACH,GAAG,oBACO,GAAG,eACT,MAAM,eACN,MAAM,wBACG,OAAO,WACpB,GAAG,cACA,MAAM,UACV,GAAG,EAAE,KACX,OAAO,CAAC,GAAG,CAAC;sDA6rBF,MAAM,UACT,GAAG,UACH,MAAM,YACL,GAAG,KACX,OAAO,CAAC,GAAG,CAAC;0CA59B8B,GAAG,KAAG,MAAM;mCAoBxC,MAAM,mBACJ,MAAM,EAAE,KACxB,MAAM;;AAigCT,wBAQE"}

package/dist/esm/langChain.js

@@ -31,6 +31,14 @@ const assertQuotaAvailable = () => {
         throw errorHandlingHelper.create(constants.HTTP_CODES.PAYMENT_REQUIRED, constants.ERROR.QUOTA_EXHAUSTED);
     }
 };
+const checkIfAIProviderConfigured = (config) => {
+    if (!config ||
+        !config.openAIAPIKey ||
+        !config.googleAPIKey ||
+        !config.anthropicAPIKey) {
+        throw errorHandlingHelper.create(constants.HTTP_CODES.INTERNAL_SERVER_ERROR, "The integration is not properly configured with all AI providers.");
+    }
+};
 /**
  * Subtracts the given USD cost from `global.quota.remaining` and adds it to
  * `global.quota.usedThisSession`. Silently no-ops when the quota globals are not
@@ -576,6 +584,20 @@ const throwErrorIfNotSuccessful = (response) => {
         throw errorHandlingHelper.create(constants.HTTP_CODES.INTERNAL_SERVER_ERROR, constants.ERROR.UNABLE_TO_GENERATE_CONTENT);
     }
 };
+/**
+ * Returns `selectedModel` when it appears in `supportedModels`, otherwise returns
+ * the first entry in `supportedModels` as a safe fallback. Use this to coerce a
+ * caller-supplied model identifier to one the current integration is known to
+ * support, instead of failing or silently passing an unsupported model to
+ * `getLLMModel`. When `supportedModels` is empty there is no fallback to pick,
+ * so the original `selectedModel` is returned unchanged.
+ */
+const validateModel = (selectedModel, supportedModels) => {
+    if (supportedModels.includes(selectedModel)) {
+        return selectedModel;
+    }
+    return supportedModels[0] ?? selectedModel;
+};
 const MAX_VALIDATION_RETRIES = 3;
 const MAX_RATE_LIMIT_RETRIES = 2;
 const RATE_LIMIT_MIN_WAIT_MS = 30_000;
@@ -1132,47 +1154,6 @@ const runPromptWithModel = async (modelName, config, prompt, onProgressReport, m
         }
     }
 };
-/**
- * Sends a conversational chat prompt to an LLM and returns a plain HTML response
- * intended for end-user display. This function is purpose-built for the StackFactor
- * Mentor chat feature: when the prompt is an array of messages, each `system` message
- * is wrapped in an enhanced system prompt that instructs the model to answer only
- * questions related to the provided topic, decline off-topic questions, and return
- * results as simple HTML without markdown code-block notation. The call is delegated to
- * `runPromptWithModel` with `expectsJsonResponse` set to `false`.
- * @param modelName - The model identifier, e.g. `"gpt-4o"`, `"claude-3-5-sonnet"`
- * @param config - Configuration object with API keys and optional `temperature`
- * @param prompt - A plain string user message, or an array of `{ role, content }`
- *   message objects; `system` messages have the topic-constraint wrapper applied
- * @param onProgressReport - Optional callback for streaming progress updates passed
- *   through to `runPromptWithModel`
- * @returns The model's response as a raw HTML string
- */
-const runChatPromptWithModel = (modelName, config, prompt, onProgressReport) => {
-    let messages = prompt;
-    // If prompt is an array, check for system message and enhance it
-    if (Array.isArray(prompt)) {
-        messages = prompt.map((msg) => {
-            if (msg.role === "system") {
-                return {
-                    ...msg,
-                    content: `You are StackFactor Mentor, an AI assistant that helps users by providing information related to the specified topic.
-          
-          ### Objective:
-          Respond to the user question considering just related to the selected topic and all previous interactions:
-          - If the question is unrelated decline to respond.
-          - Return the results as a simple HMTL but don't include notations for formatting blocks.
-          
-          ### TOPIC INFORMATION:\n
-          ${msg.content}
-          `,
-                };
-            }
-            return msg;
-        });
-    }
-    return runPromptWithModel(modelName, config, messages, onProgressReport, 0, 100, false);
-};
 /**
  * Determines the image generation provider for a given model name based on its prefix.
  * `dall-e-` and `gpt-image-` prefixes map to `"openai"`. `gemini-` and `imagen-`
@@ -1434,10 +1415,11 @@ const runPromptWithModelForImageGeneration = async (modelName, config, prompt, o
     }
 };
 export default {
+    checkIfAIProviderConfigured,
     createAgent,
     runAgent,
-    runChatPromptWithModel,
     runPromptWithModel,
     runPromptWithModelForImageGeneration,
     throwErrorIfNotSuccessful,
+    validateModel,
 };

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "restricted"
   },
-  "version": "1.0.22",
+  "version": "1.0.24",
   "description": "",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",