@inkeep/agents-api 0.0.0-dev-20260121145510

package/dist/utils/oauthService.js

@@ -0,0 +1,106 @@
+import { getLogger as getLogger$1 } from "../logger.js";
+import { env } from "../env.js";
+import { exchangeMcpAuthorizationCode, initiateMcpOAuthFlow } from "@inkeep/agents-core";
+
+//#region src/utils/oauthService.ts
+const logger = getLogger$1("oauth-service");
+const pkceStore = /* @__PURE__ */ new Map();
+/**
+* Store PKCE verifier and OAuth metadata for later use in token exchange
+*/
+function storePKCEVerifier(state, codeVerifier, toolId, tenantId, projectId, clientInformation, metadata, resourceUrl) {
+	pkceStore.set(state, {
+		codeVerifier,
+		toolId,
+		tenantId,
+		projectId,
+		clientInformation,
+		metadata,
+		resourceUrl
+	});
+	setTimeout(() => {
+		pkceStore.delete(state);
+	}, 600 * 1e3);
+}
+/**
+* Retrieve and remove PKCE verifier
+*/
+function retrievePKCEVerifier(state) {
+	const data = pkceStore.get(state);
+	if (data) {
+		pkceStore.delete(state);
+		return data;
+	}
+	return null;
+}
+/**
+* OAuth service class that handles the complete OAuth flow
+*/
+var OAuthService = class {
+	defaultConfig;
+	constructor(config = {}) {
+		this.defaultConfig = {
+			defaultClientId: config.defaultClientId || process.env.DEFAULT_OAUTH_CLIENT_ID || "mcp-client",
+			clientName: config.clientName || process.env.OAUTH_CLIENT_NAME || "Inkeep Agent Framework",
+			clientUri: config.clientUri || process.env.OAUTH_CLIENT_URI || "https://inkeep.com",
+			logoUri: config.logoUri || process.env.OAUTH_CLIENT_LOGO_URI || "https://inkeep.com/images/logos/inkeep-logo-blue.svg",
+			redirectBaseUrl: config.redirectBaseUrl || env.INKEEP_AGENTS_API_URL
+		};
+	}
+	/**
+	* Initiate OAuth flow for an MCP tool using MCP SDK
+	*/
+	async initiateOAuthFlow(params) {
+		const { tenantId, projectId, toolId, mcpServerUrl, baseUrl } = params;
+		const redirectUri = `${baseUrl || this.defaultConfig.redirectBaseUrl}/manage/oauth/callback`;
+		const state = `tool_${toolId}`;
+		const authResult = await initiateMcpOAuthFlow({
+			mcpServerUrl,
+			redirectUri,
+			state,
+			clientName: this.defaultConfig.clientName,
+			clientUri: this.defaultConfig.clientUri,
+			logoUri: this.defaultConfig.logoUri,
+			defaultClientId: this.defaultConfig.defaultClientId,
+			logger
+		});
+		storePKCEVerifier(state, authResult.codeVerifier, toolId, tenantId, projectId, authResult.clientInformation, authResult.metadata, authResult.resourceUrl);
+		logger.info({
+			toolId,
+			authorizationUrl: authResult.authorizationUrl,
+			tenantId,
+			projectId,
+			scopes: authResult.scopes
+		}, "MCP OAuth flow initiated successfully");
+		return {
+			redirectUrl: authResult.authorizationUrl,
+			state
+		};
+	}
+	/**
+	* Exchange authorization code for access tokens using MCP SDK with stored metadata
+	*/
+	async exchangeCodeForTokens(params) {
+		const { code, codeVerifier, clientInformation, metadata, resourceUrl, mcpServerUrl, baseUrl } = params;
+		const tokens = await exchangeMcpAuthorizationCode({
+			mcpServerUrl,
+			metadata,
+			clientInformation,
+			authorizationCode: code,
+			codeVerifier,
+			redirectUri: `${baseUrl || this.defaultConfig.redirectBaseUrl}/manage/oauth/callback`,
+			resourceUrl,
+			logger
+		});
+		logger.info({
+			tokenType: tokens.token_type,
+			hasRefreshToken: !!tokens.refresh_token,
+			clientId: clientInformation.client_id
+		}, "MCP token exchange successful");
+		return { tokens };
+	}
+};
+const oauthService = new OAuthService();
+
+//#endregion
+export { oauthService, retrievePKCEVerifier };

package/dist/utils/signozHelpers.d.ts

@@ -0,0 +1,9 @@
+//#region src/utils/signozHelpers.d.ts
+/**
+ * Helper function to enforce projectId filter on SigNoz queries.
+ * This modifies the query payload to ensure all builder queries include
+ * a server-side project.id filter, preventing client-side filter bypass.
+ */
+declare function enforceProjectFilter(payload: any, projectId: string): any;
+//#endregion
+export { enforceProjectFilter };

package/dist/utils/signozHelpers.js

@@ -0,0 +1,33 @@
+//#region src/utils/signozHelpers.ts
+/**
+* Helper function to enforce projectId filter on SigNoz queries.
+* This modifies the query payload to ensure all builder queries include
+* a server-side project.id filter, preventing client-side filter bypass.
+*/
+function enforceProjectFilter(payload, projectId) {
+	const modifiedPayload = JSON.parse(JSON.stringify(payload));
+	if (modifiedPayload.compositeQuery?.builderQueries) for (const queryKey in modifiedPayload.compositeQuery.builderQueries) {
+		const query = modifiedPayload.compositeQuery.builderQueries[queryKey];
+		if (!query.filters) query.filters = {
+			op: "AND",
+			items: []
+		};
+		query.filters.items = query.filters.items.filter((item) => item.key?.key !== "project.id");
+		query.filters.items.push({
+			key: {
+				key: "project.id",
+				dataType: "string",
+				type: "tag",
+				isColumn: false,
+				isJSON: false,
+				id: "false"
+			},
+			op: "=",
+			value: projectId
+		});
+	}
+	return modifiedPayload;
+}
+
+//#endregion
+export { enforceProjectFilter };

package/dist/utils/speakeasy.d.ts

@@ -0,0 +1,93 @@
+//#region src/utils/speakeasy.d.ts
+/**
+ * Shared route configurations and helpers
+ */
+/**
+ * Speakeasy pagination input configuration
+ */
+type SpeakeasyPaginationInput = {
+  name: string;
+  in: 'parameters' | 'requestBody';
+  type: 'page' | 'limit' | 'offset' | 'cursor';
+};
+/**
+ * Speakeasy pagination output configuration
+ * Uses JSONPath expressions to locate pagination values in the response
+ */
+type SpeakeasyPaginationOutputs = {
+  numPages?: string;
+  nextCursor?: string;
+  results?: string;
+};
+/**
+ * Speakeasy pagination extension type
+ */
+type SpeakeasyPaginationExtension = {
+  'x-speakeasy-pagination': {
+    type: 'offsetLimit' | 'cursor';
+    inputs: SpeakeasyPaginationInput[];
+    outputs: SpeakeasyPaginationOutputs;
+  };
+};
+/**
+ * Standard pagination response shape that all paginated endpoints should return.
+ * This ensures consistency with the JSONPath '$.pagination.pages' in the Speakeasy extension.
+ */
+type StandardPaginationResponse<T> = {
+  data: T[];
+  pagination: {
+    page: number;
+    limit: number;
+    total: number;
+    pages: number;
+  };
+};
+/**
+ * Creates a Speakeasy pagination extension configuration.
+ * This factory function allows for different pagination strategies while maintaining type safety.
+ *
+ * @example
+ * ```ts
+ * // Offset-limit pagination (default)
+ * const pagination = createSpeakeasyPagination('offsetLimit');
+ *
+ * // Cursor-based pagination (future use)
+ * const cursorPagination = createSpeakeasyPagination('cursor', {
+ *   inputs: [
+ *     { name: 'cursor', in: 'parameters', type: 'cursor' },
+ *     { name: 'limit', in: 'parameters', type: 'limit' },
+ *   ],
+ *   outputs: { nextCursor: '$.pagination.nextCursor' },
+ * });
+ * ```
+ */
+declare function createSpeakeasyPagination(type: 'offsetLimit', config?: Partial<{
+  inputs: SpeakeasyPaginationInput[];
+  outputs: SpeakeasyPaginationOutputs;
+}>): SpeakeasyPaginationExtension;
+declare function createSpeakeasyPagination(type: 'cursor', config: {
+  inputs: SpeakeasyPaginationInput[];
+  outputs: SpeakeasyPaginationOutputs;
+}): SpeakeasyPaginationExtension;
+/**
+ * Speakeasy pagination extension for offset-limit pagination.
+ * Use this in createRoute() calls for list endpoints that support pagination.
+ *
+ * IMPORTANT: Endpoints using this extension MUST return responses matching
+ * the StandardPaginationResponse<T> shape with data from a *Paginated() function
+ * (e.g., listAgentsPaginated, listProjectsPaginated) to ensure the JSONPath
+ * '$.pagination.pages' correctly resolves.
+ *
+ * @example
+ * ```ts
+ * createRoute({
+ *   method: 'get',
+ *   path: '/',
+ *   // ... other config
+ *   ...speakeasyOffsetLimitPagination,
+ * })
+ * ```
+ */
+declare const speakeasyOffsetLimitPagination: SpeakeasyPaginationExtension;
+//#endregion
+export { StandardPaginationResponse, createSpeakeasyPagination, speakeasyOffsetLimitPagination };

package/dist/utils/speakeasy.js

@@ -0,0 +1,44 @@
+//#region src/utils/speakeasy.ts
+function createSpeakeasyPagination(type, config) {
+	if (type === "offsetLimit") return { "x-speakeasy-pagination": {
+		type: "offsetLimit",
+		inputs: config?.inputs ?? [{
+			name: "page",
+			in: "parameters",
+			type: "page"
+		}, {
+			name: "limit",
+			in: "parameters",
+			type: "limit"
+		}],
+		outputs: config?.outputs ?? { numPages: "$.pagination.pages" }
+	} };
+	return { "x-speakeasy-pagination": {
+		type: "cursor",
+		inputs: config?.inputs ?? [],
+		outputs: config?.outputs ?? {}
+	} };
+}
+/**
+* Speakeasy pagination extension for offset-limit pagination.
+* Use this in createRoute() calls for list endpoints that support pagination.
+*
+* IMPORTANT: Endpoints using this extension MUST return responses matching
+* the StandardPaginationResponse<T> shape with data from a *Paginated() function
+* (e.g., listAgentsPaginated, listProjectsPaginated) to ensure the JSONPath
+* '$.pagination.pages' correctly resolves.
+*
+* @example
+* ```ts
+* createRoute({
+*   method: 'get',
+*   path: '/',
+*   // ... other config
+*   ...speakeasyOffsetLimitPagination,
+* })
+* ```
+*/
+const speakeasyOffsetLimitPagination = createSpeakeasyPagination("offsetLimit");
+
+//#endregion
+export { createSpeakeasyPagination, speakeasyOffsetLimitPagination };

package/dist/utils/tempApiKeys.d.ts

@@ -0,0 +1,17 @@
+import { AgentsRunDatabaseClient } from "@inkeep/agents-core";
+
+//#region src/utils/tempApiKeys.d.ts
+interface CreateTempApiKeyParams {
+  tenantId: string;
+  projectId: string;
+  agentId: string;
+  userId: string;
+  expiryHours?: number;
+}
+interface TempApiKeyResult {
+  apiKey: string;
+  expiresAt: string;
+}
+declare function createTempApiKey(db: AgentsRunDatabaseClient, params: CreateTempApiKeyParams): Promise<TempApiKeyResult>;
+//#endregion
+export { CreateTempApiKeyParams, TempApiKeyResult, createTempApiKey };

package/dist/utils/tempApiKeys.js

@@ -0,0 +1,26 @@
+import { createApiKey, generateApiKey } from "@inkeep/agents-core";
+
+//#region src/utils/tempApiKeys.ts
+async function createTempApiKey(db, params) {
+	const expiryHours = params.expiryHours || 1;
+	const expiresAt = new Date(Date.now() + expiryHours * 60 * 60 * 1e3);
+	const keyData = await generateApiKey();
+	await createApiKey(db)({
+		id: keyData.id,
+		publicId: keyData.publicId,
+		keyHash: keyData.keyHash,
+		keyPrefix: keyData.keyPrefix,
+		name: `playground-temp-${params.userId}`,
+		tenantId: params.tenantId,
+		projectId: params.projectId,
+		agentId: params.agentId,
+		expiresAt: expiresAt.toISOString()
+	});
+	return {
+		apiKey: keyData.key,
+		expiresAt: expiresAt.toISOString()
+	};
+}
+
+//#endregion
+export { createTempApiKey };

package/dist/utils/workflowApiHelpers.d.ts

@@ -0,0 +1 @@
+export { };

package/dist/utils/workflowApiHelpers.js

@@ -0,0 +1 @@
+export {  };

package/package.json

@@ -0,0 +1,125 @@
+{
+  "name": "@inkeep/agents-api",
+  "version": "0.0.0-dev-20260121145510",
+  "description": "Unified Inkeep Agents API - combines management, runtime, and evaluation capabilities",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./manage": {
+      "types": "./dist/domains/manage/index.d.ts",
+      "import": "./dist/domains/manage/index.js"
+    },
+    "./run": {
+      "types": "./dist/domains/run/index.d.ts",
+      "import": "./dist/domains/run/index.js"
+    },
+    "./evals": {
+      "types": "./dist/domains/evals/index.d.ts",
+      "import": "./dist/domains/evals/index.js"
+    },
+    "./instrumentation": {
+      "types": "./dist/instrumentation.d.ts",
+      "import": "./dist/instrumentation.js"
+    },
+    "./factory": {
+      "types": "./dist/factory.d.ts",
+      "import": "./dist/factory.js"
+    }
+  },
+  "type": "module",
+  "license": "SEE LICENSE IN LICENSE.md",
+  "dependencies": {
+    "@ai-sdk/anthropic": "3.0.7",
+    "@ai-sdk/gateway": "3.0.9",
+    "@ai-sdk/google": "3.0.4",
+    "@ai-sdk/openai": "3.0.7",
+    "@ai-sdk/openai-compatible": "2.0.4",
+    "@hono/mcp": "^0.1.5",
+    "@hono/otel": "^0.4.0",
+    "@hono/swagger-ui": "^0.5.1",
+    "@hono/zod-openapi": "^1.1.5",
+    "@modelcontextprotocol/sdk": "^1.25.2",
+    "@openrouter/ai-sdk-provider": "^1.2.0",
+    "@opentelemetry/api": "^1.9.0",
+    "@opentelemetry/auto-instrumentations-node": "^0.64.1",
+    "@opentelemetry/baggage-span-processor": "^0.4.0",
+    "@opentelemetry/context-async-hooks": "^2.1.0",
+    "@opentelemetry/core": "^2.1.0",
+    "@opentelemetry/exporter-trace-otlp-http": "^0.205.0",
+    "@opentelemetry/resources": "^2.1.0",
+    "@opentelemetry/sdk-node": "^0.205.0",
+    "@opentelemetry/sdk-trace-base": "^2.1.0",
+    "@opentelemetry/semantic-conventions": "^1.37.0",
+    "@vercel/sandbox": "^0.0.24",
+    "@workflow/builders": "4.0.1-beta.27",
+    "@workflow/world-local": "4.0.1-beta.19",
+    "@workflow/world-postgres": "4.1.0-beta.28",
+    "@workflow/world-vercel": "4.0.1-beta.21",
+    "ai": "6.0.14",
+    "ajv": "^8.17.1",
+    "axios": "^1.13.2",
+    "drizzle-orm": "^0.44.4",
+    "fetch-to-node": "^2.1.0",
+    "hono": "^4.10.4",
+    "hono-pino": "^0.10.1",
+    "jmespath": "^0.16.0",
+    "llm-info": "^1.0.69",
+    "openid-client": "^6.8.1",
+    "pg": "^8.16.3",
+    "workflow": "4.0.1-beta.33",
+    "@inkeep/agents-core": "^0.0.0-dev-20260121145510",
+    "@inkeep/agents-manage-mcp": "^0.0.0-dev-20260121145510"
+  },
+  "peerDependencies": {
+    "@hono/zod-openapi": "^1.1.5",
+    "zod": "^4.1.11"
+  },
+  "devDependencies": {
+    "@hono/vite-dev-server": "^0.20.1",
+    "@opentelemetry/exporter-trace-otlp-proto": "^0.203.0",
+    "@opentelemetry/sdk-metrics": "^2.1.0",
+    "@types/jmespath": "^0.15.2",
+    "@types/node": "^20.11.24",
+    "@types/pg": "^8.15.6",
+    "@vitest/coverage-v8": "^3.2.4",
+    "tsx": "^4.7.1",
+    "typescript": "^5.3.3",
+    "vite": "^7.1.11",
+    "vite-tsconfig-paths": "^5.1.4",
+    "vitest": "^3.2.4"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE.md",
+    "SUPPLEMENTAL_TERMS.md"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/inkeep/agents.git",
+    "directory": "agents-api"
+  },
+  "scripts": {
+    "workflow:build": "tsx src/domains/evals/scripts/build-workflow.ts",
+    "well-known:copy": "tsx scripts/copy-well-known.ts",
+    "dev": "pnpm workflow:build && vite",
+    "build": "pnpm workflow:build && tsdown && pnpm well-known:copy",
+    "start": "node dist/index.js",
+    "test": "vitest --run --config vitest.config.ts",
+    "test:integration": "vitest --run --config vitest.integration.config.ts",
+    "test:watch": "vitest",
+    "test:coverage": "vitest --run --coverage",
+    "openapi:update-snapshot": "UPDATE_OPENAPI_SNAPSHOT=true vitest --run src/__tests__/openapi.test.ts",
+    "typecheck": "tsc --noEmit",
+    "typecheck:watch": "tsc --noEmit --watch",
+    "lint": "biome lint --error-on-warnings",
+    "lint:fix": "biome check --write"
+  }
+}