@inkeep/agents-run-api 0.1.3 → 0.1.7

package/LICENSE.md

@@ -1,3 +1,10 @@
+<!--
+AUTO-GENERATED FILE - DO NOT EDIT DIRECTLY
+Source: ./LICENSE.md
+This file is automatically copied from the root LICENSE.md during build.
+Any changes should be made to the root LICENSE.md file.
+-->
+
 # Inkeep SDK – Elastic License 2.0 with Supplemental Terms
 
 NOTE: The Inkeep SDK is licensed under the Elastic License 2.0 (ELv2), subject to Supplemental Terms included in [SUPPLEMENTAL_TERMS.md](SUPPLEMENTAL_TERMS.md). In the event of conflict, the Supplemental Terms control.

package/README.md

@@ -1,6 +1,6 @@
-# Inkeep Execution API
+# Inkeep Agents Run API
 
-The Execution API is responsible for runtime agent operations, including Agent-to-Agent (A2A) communication, chat completions, and MCP (Model Context Protocol) tool integrations.
+The Agents Run API is responsible for runtime agent operations, including Agent-to-Agent (A2A) communication, chat completions, and MCP (Model Context Protocol) tool integrations.
 
 ## Overview
 
@@ -82,8 +82,8 @@ The API uses environment-based configuration with defaults for local development
 
 ## Integration
 
-### With Management API
-The Execution API reads agent configurations and relationships created by the Management API but doesn't modify them during runtime.
+### With Agents Manage API
+The Agents Run API reads agent configurations and relationships created by the Agents Manage API but doesn't modify them during runtime.
 
 ### With MCP Tools
 Supports multiple MCP transport types:
@@ -114,4 +114,4 @@ The API implements comprehensive error handling:
 - **API Key Authentication**: Configurable authentication methods
 - **Input Validation**: Request sanitization and type checking  
 - **CORS**: Configurable cross-origin policies
-- **Rate Limiting**: Configurable request throttling
+- **Rate Limiting**: Configurable request throttling

package/SUPPLEMENTAL_TERMS.md

@@ -0,0 +1,40 @@
+<!--
+AUTO-GENERATED FILE - DO NOT EDIT DIRECTLY
+Source: ./SUPPLEMENTAL_TERMS.md
+This file is automatically copied from the root SUPPLEMENTAL_TERMS.md during build.
+Any changes should be made to the root SUPPLEMENTAL_TERMS.md file.
+-->
+
+# Inkeep SDK – Elastic License 2.0 with Supplemental Terms
+
+The Inkeep [SDK] (the "Software") is licensed under the Elastic License 2.0 ("ELv2"), available at [https://www.elastic.co/licensing/elastic-license](https://www.elastic.co/licensing/elastic-license), subject to the supplemental terms below. By using the Software, you, your company, and your licensees agree to both ELv2 and these Supplemental Terms – for purposes of these Supplemental Terms, references to "you" have the same meaning as in ELv2 and include your company and contractors acting on your behalf. In the event of conflict, these Supplemental Terms control.
+
+Any copy or redistribution of the Software must include both the ELv2 license reference and these Supplemental Terms.
+
+## 1. Restrictions
+
+### 1.1
+You may not use the Software, directly or indirectly, to offer, enable, operate, or provide any Agent Builder.
+
+### 1.2
+You may not repackage, rebrand, or otherwise expose the Software's agent-creation or orchestration functionality for third-party use, including in specialized or verticalized offerings that present substantially similar functionality to the Software.
+
+### 1.3
+For clarity, the foregoing restrictions do not prohibit your use of the Software as Embedded Assistants or Professional Services, provided neither allow third parties to create, configure, train, orchestrate, deploy, or manage their own agents or agent workflows.
+
+## 2. Definitions
+
+### 2.1 Inkeep
+**"Inkeep"** means Inkeep, Inc., a Delaware corporation with principal offices at 169 Madison Ave, Ste 2544, New York, NY, 10016, the licensor (as defined in ELv2) of the Software.
+
+### 2.2 Agent Builder
+**"Agent Builder"** means any hosted or on-premise product, platform, UI or API that allows third parties (e.g., customers, developers, or community users other than your personnel) to create, configure, compose, train, orchestrate, deploy, or manage their own Agents using the Software, or that otherwise exposes a substantial set of the Agent-creation and orchestration functionality of the Software.
+
+### 2.3 Agents
+**"Agents"** means autonomous, semi-autonomous, or automated systems — including assistants, copilots, workflows, orchestrations, or other systems powered by or incorporating artificial intelligence, machine learning, large language models, or related technologies.
+
+### 2.4 Embedded Assistant
+**"Embedded Assistant"** means embedding the Software in your own products or services to power a specific assistant/copilot/agent experience for you or your end users (e.g., a support bot in your app or an internal helpdesk agent), where end users do not receive access to any substantial set of the Software's agent-creation or orchestration features.
+
+### 2.5 Professional Services
+**"Professional Services"** means using the Software to deliver a bespoke solution to a single client where only your personnel operate the Software, the client receives access solely to the resulting assistant within the client's environment and not to the agent-creation/orchestration features of the Software, and no multi-tenant or self-service builder is provided.

package/dist/chunk-HO5J26MO.js

@@ -0,0 +1,234 @@
+import { createDatabaseClient, createMessage, getConversationHistory } from '@inkeep/agents-core';
+import { nanoid } from 'nanoid';
+import fs from 'fs';
+import path from 'path';
+import * as dotenv from 'dotenv';
+import { z } from 'zod';
+
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+dotenv.config({ quiet: true });
+z.enum(["development", "production"]).default("development");
+var environmentSchema = z.enum(["development", "pentest", "production", "test"]);
+var criticalEnv = z.object({
+  ENVIRONMENT: environmentSchema
+}).parse(process.env);
+var loadEnvFile = () => {
+  const envPath = path.resolve(process.cwd(), `.env.${criticalEnv.ENVIRONMENT}.nonsecret`);
+  if (fs.existsSync(envPath)) {
+    const envConfig = dotenv.parse(fs.readFileSync(envPath));
+    for (const k in envConfig) {
+      if (!(k in process.env)) {
+        process.env[k] = envConfig[k];
+      }
+    }
+  }
+};
+loadEnvFile();
+var envSchema = z.object({
+  NODE_ENV: z.enum(["development", "production", "test"]).optional(),
+  ENVIRONMENT: z.enum(["development", "production", "pentest", "test"]).optional().default("development"),
+  DB_FILE_NAME: z.string().default("file:../local.db"),
+  AGENTS_RUN_API_URL: z.string().optional().default("http://localhost:3003"),
+  LOG_LEVEL: z.enum(["trace", "debug", "info", "warn", "error"]).optional().default("debug"),
+  NANGO_SECRET_KEY: z.string().optional(),
+  OPENAI_API_KEY: z.string().optional(),
+  ANTHROPIC_API_KEY: z.string(),
+  INKEEP_AGENTS_RUN_API_BYPASS_SECRET: z.string().optional(),
+  OTEL_MAX_EXPORT_BATCH_SIZE: z.coerce.number().optional()
+});
+var parseEnv = () => {
+  try {
+    const parsedEnv = envSchema.parse(process.env);
+    return parsedEnv;
+  } catch (error) {
+    if (error instanceof z.ZodError) {
+      const missingVars = error.issues.map((issue) => issue.path.join("."));
+      throw new Error(
+        `\u274C Invalid environment variables: ${missingVars.join(", ")}
+${error.message}`
+      );
+    }
+    throw error;
+  }
+};
+var env = parseEnv();
+
+// src/data/db/dbClient.ts
+var getDbUrl = () => {
+  if (env.ENVIRONMENT === "test") {
+    return ":memory:";
+  }
+  return env.DB_FILE_NAME;
+};
+var dbClient = createDatabaseClient({ url: getDbUrl() });
+var dbClient_default = dbClient;
+
+// src/data/conversations.ts
+function createDefaultConversationHistoryConfig(mode = "full") {
+  return {
+    mode,
+    limit: 50,
+    includeInternal: true,
+    messageTypes: ["chat"],
+    maxOutputTokens: 4e3
+  };
+}
+function extractA2AMessageText(parts) {
+  return parts.filter((part) => part.kind === "text" && part.text).map((part) => part.text).join("");
+}
+async function saveA2AMessageResponse(response, params) {
+  if (response.error) {
+    throw new Error(response.error.message);
+  }
+  let messageText = "";
+  if (response.result.kind === "message") {
+    messageText = extractA2AMessageText(response.result.parts);
+  } else if (response.result.kind === "task") {
+    if (response.result.artifacts && response.result.artifacts.length > 0) {
+      const firstArtifact = response.result.artifacts[0];
+      if (firstArtifact.parts) {
+        messageText = extractA2AMessageText(firstArtifact.parts);
+      }
+    }
+  } else if (typeof response.result === "string") {
+    messageText = response.result;
+  }
+  if (!messageText || messageText.trim() === "") {
+    return null;
+  }
+  return await createMessage(dbClient_default)({
+    id: nanoid(),
+    tenantId: params.tenantId,
+    projectId: params.projectId,
+    conversationId: params.conversationId,
+    role: "agent",
+    content: {
+      text: messageText
+    },
+    visibility: params.visibility,
+    messageType: params.messageType,
+    fromAgentId: params.fromAgentId,
+    toAgentId: params.toAgentId,
+    fromExternalAgentId: params.fromExternalAgentId,
+    toExternalAgentId: params.toExternalAgentId,
+    a2aTaskId: params.a2aTaskId,
+    a2aSessionId: params.a2aSessionId,
+    metadata: params.metadata
+  });
+}
+async function getScopedHistory({
+  tenantId,
+  projectId,
+  conversationId,
+  filters,
+  options
+}) {
+  try {
+    const messages = await getConversationHistory(dbClient_default)({
+      scopes: { tenantId, projectId },
+      conversationId,
+      options
+    });
+    if (!filters || !filters.agentId && !filters.taskId) {
+      return messages;
+    }
+    const relevantMessages = messages.filter((msg) => {
+      if (msg.role === "user") return true;
+      let matchesAgent = true;
+      let matchesTask = true;
+      if (filters.agentId) {
+        matchesAgent = msg.role === "agent" && msg.visibility === "user-facing" || msg.toAgentId === filters.agentId || msg.fromAgentId === filters.agentId;
+      }
+      if (filters.taskId) {
+        matchesTask = msg.taskId === filters.taskId || msg.a2aTaskId === filters.taskId;
+      }
+      if (filters.agentId && filters.taskId) {
+        return matchesAgent && matchesTask;
+      }
+      if (filters.agentId) {
+        return matchesAgent;
+      }
+      if (filters.taskId) {
+        return matchesTask;
+      }
+      return false;
+    });
+    return relevantMessages;
+  } catch (error) {
+    console.error("Failed to fetch scoped messages:", error);
+    return [];
+  }
+}
+async function getUserFacingHistory(tenantId, projectId, conversationId, limit = 50) {
+  return await getConversationHistory(dbClient_default)({
+    scopes: { tenantId, projectId },
+    conversationId,
+    options: {
+      limit,
+      includeInternal: false,
+      messageTypes: ["chat"]
+    }
+  });
+}
+async function getFullConversationContext(tenantId, projectId, conversationId, maxTokens) {
+  return await getConversationHistory(dbClient_default)({
+    scopes: { tenantId, projectId },
+    conversationId,
+    options: {
+      limit: 100,
+      includeInternal: true,
+      maxOutputTokens: maxTokens
+    }
+  });
+}
+async function getFormattedConversationHistory({
+  tenantId,
+  projectId,
+  conversationId,
+  currentMessage,
+  options,
+  filters
+}) {
+  const historyOptions = options ?? { includeInternal: true };
+  const conversationHistory = await getScopedHistory({
+    tenantId,
+    projectId,
+    conversationId,
+    filters,
+    options: historyOptions
+  });
+  let messagesToFormat = conversationHistory;
+  if (currentMessage && conversationHistory.length > 0) {
+    const lastMessage = conversationHistory[conversationHistory.length - 1];
+    if (lastMessage.content.text === currentMessage) {
+      messagesToFormat = conversationHistory.slice(0, -1);
+    }
+  }
+  if (!messagesToFormat.length) {
+    return "";
+  }
+  const formattedHistory = messagesToFormat.map((msg) => {
+    let roleLabel;
+    if (msg.role === "user") {
+      roleLabel = "user";
+    } else if (msg.role === "agent" && (msg.messageType === "a2a-request" || msg.messageType === "a2a-response")) {
+      const fromAgent = msg.fromAgentId || msg.fromExternalAgentId || "unknown";
+      const toAgent = msg.toAgentId || msg.toExternalAgentId || "unknown";
+      roleLabel = `${fromAgent} to ${toAgent}`;
+    } else if (msg.role === "agent" && msg.messageType === "chat") {
+      const fromAgent = msg.fromAgentId || "unknown";
+      roleLabel = `${fromAgent} to User`;
+    } else {
+      roleLabel = msg.role || "system";
+    }
+    return `${roleLabel}: """${msg.content.text}"""`;
+  }).join("\n");
+  return `<conversation_history>
+${formattedHistory}
+</conversation_history>
+`;
+}
+
+export { __publicField, createDefaultConversationHistoryConfig, dbClient_default, env, getFormattedConversationHistory, getFullConversationContext, getScopedHistory, getUserFacingHistory, saveA2AMessageResponse };

package/dist/conversations-ZQXUNCNE.js

@@ -0,0 +1 @@
+export { createDefaultConversationHistoryConfig, getFormattedConversationHistory, getFullConversationContext, getScopedHistory, getUserFacingHistory, saveA2AMessageResponse } from './chunk-HO5J26MO.js';