@inkeep/agents-manage-api 0.39.5 → 0.41.0

package/dist/routes/agent.js

@@ -0,0 +1,244 @@
+import dbClient_default from "../data/db/dbClient.js";
+import { requirePermission } from "../middleware/require-permission.js";
+import { speakeasyOffsetLimitPagination } from "./shared.js";
+import { OpenAPIHono, createRoute } from "@hono/zod-openapi";
+import { AgentApiInsertSchema, AgentApiUpdateSchema, AgentListResponse, AgentResponse, AgentWithinContextOfProjectResponse, ErrorResponseSchema, PaginationQueryParamsSchema, RelatedAgentInfoListResponse, TenantProjectAgentParamsSchema, TenantProjectAgentSubAgentParamsSchema, TenantProjectIdParamsSchema, TenantProjectParamsSchema, commonGetErrorResponses, createAgent, createApiError, deleteAgent, generateId, getAgentById, getAgentSubAgentInfos, getFullAgentDefinition, listAgentsPaginated, updateAgent } from "@inkeep/agents-core";
+
+//#region src/routes/agent.ts
+const app = new OpenAPIHono();
+app.use("/", async (c, next) => {
+	if (c.req.method === "POST") return requirePermission({ agent: ["create"] })(c, next);
+	return next();
+});
+app.use("/:id", async (c, next) => {
+	if (c.req.method === "PUT") return requirePermission({ agent: ["update"] })(c, next);
+	if (c.req.method === "DELETE") return requirePermission({ agent: ["delete"] })(c, next);
+	return next();
+});
+app.openapi(createRoute({
+	method: "get",
+	path: "/",
+	summary: "List Agents",
+	operationId: "list-agents",
+	tags: ["Agents"],
+	request: {
+		params: TenantProjectParamsSchema,
+		query: PaginationQueryParamsSchema
+	},
+	responses: {
+		200: {
+			description: "List of agents retrieved successfully",
+			content: { "application/json": { schema: AgentListResponse } }
+		},
+		...commonGetErrorResponses
+	},
+	...speakeasyOffsetLimitPagination
+}), async (c) => {
+	const { tenantId, projectId } = c.req.valid("param");
+	const page = Number(c.req.query("page")) || 1;
+	const limit = Math.min(Number(c.req.query("limit")) || 10, 100);
+	const result = await listAgentsPaginated(dbClient_default)({
+		scopes: {
+			tenantId,
+			projectId
+		},
+		pagination: {
+			page,
+			limit
+		}
+	});
+	return c.json(result);
+});
+app.openapi(createRoute({
+	method: "get",
+	path: "/{id}",
+	summary: "Get Agent",
+	operationId: "get-agent",
+	tags: ["Agents"],
+	request: { params: TenantProjectIdParamsSchema },
+	responses: {
+		200: {
+			description: "Agent found",
+			content: { "application/json": { schema: AgentResponse } }
+		},
+		...commonGetErrorResponses
+	}
+}), async (c) => {
+	const { tenantId, projectId, id } = c.req.valid("param");
+	const agent = await getAgentById(dbClient_default)({ scopes: {
+		tenantId,
+		projectId,
+		agentId: id
+	} });
+	if (!agent) throw createApiError({
+		code: "not_found",
+		message: "Agent not found"
+	});
+	return c.json({ data: agent });
+});
+app.openapi(createRoute({
+	method: "get",
+	path: "/{agentId}/sub-agents/{subAgentId}/related",
+	summary: "Get Related Agent Infos",
+	operationId: "get-related-agent-infos",
+	tags: ["Agent"],
+	request: { params: TenantProjectAgentSubAgentParamsSchema },
+	responses: {
+		200: {
+			description: "Related agent infos retrieved successfully",
+			content: { "application/json": { schema: RelatedAgentInfoListResponse } }
+		},
+		...commonGetErrorResponses
+	}
+}), async (c) => {
+	const { tenantId, projectId, agentId, subAgentId } = c.req.valid("param");
+	const relatedAgents = await getAgentSubAgentInfos(dbClient_default)({
+		scopes: {
+			tenantId,
+			projectId
+		},
+		agentId,
+		subAgentId
+	});
+	return c.json({
+		data: relatedAgents,
+		pagination: {
+			page: 1,
+			limit: relatedAgents.length,
+			total: relatedAgents.length,
+			pages: 1
+		}
+	});
+});
+app.openapi(createRoute({
+	method: "get",
+	path: "/{agentId}/full",
+	summary: "Get Full Agent Definition",
+	operationId: "get-full-agent-definition",
+	tags: ["Agent"],
+	request: { params: TenantProjectAgentParamsSchema },
+	responses: {
+		200: {
+			description: "Full agent definition retrieved successfully",
+			content: { "application/json": { schema: AgentWithinContextOfProjectResponse } }
+		},
+		...commonGetErrorResponses
+	}
+}), async (c) => {
+	const { tenantId, projectId, agentId } = c.req.valid("param");
+	const fullAgent = await getFullAgentDefinition(dbClient_default)({ scopes: {
+		tenantId,
+		projectId,
+		agentId
+	} });
+	if (!fullAgent) throw createApiError({
+		code: "not_found",
+		message: "Agent not found"
+	});
+	return c.json({ data: fullAgent });
+});
+app.openapi(createRoute({
+	method: "post",
+	path: "/",
+	summary: "Create Agent",
+	operationId: "create-agent",
+	tags: ["Agents"],
+	request: {
+		params: TenantProjectParamsSchema,
+		body: { content: { "application/json": { schema: AgentApiInsertSchema } } }
+	},
+	responses: {
+		201: {
+			description: "Agent created successfully",
+			content: { "application/json": { schema: AgentResponse } }
+		},
+		...commonGetErrorResponses
+	}
+}), async (c) => {
+	const { tenantId, projectId } = c.req.valid("param");
+	const validatedBody = c.req.valid("json");
+	try {
+		const agent = await createAgent(dbClient_default)({
+			tenantId,
+			projectId,
+			id: validatedBody.id || generateId(),
+			name: validatedBody.name,
+			defaultSubAgentId: validatedBody.defaultSubAgentId,
+			contextConfigId: validatedBody.contextConfigId ?? void 0
+		});
+		return c.json({ data: agent }, 201);
+	} catch (error) {
+		if (error?.cause?.code === "23505") throw createApiError({
+			code: "conflict",
+			message: `An agent with ID '${validatedBody.id || "unknown"}' already exists`
+		});
+		throw error;
+	}
+});
+app.openapi(createRoute({
+	method: "put",
+	path: "/{id}",
+	summary: "Update Agent",
+	operationId: "update-agent",
+	tags: ["Agents"],
+	request: {
+		params: TenantProjectIdParamsSchema,
+		body: { content: { "application/json": { schema: AgentApiUpdateSchema } } }
+	},
+	responses: {
+		200: {
+			description: "Agent updated successfully",
+			content: { "application/json": { schema: AgentResponse } }
+		},
+		...commonGetErrorResponses
+	}
+}), async (c) => {
+	const { tenantId, projectId, id } = c.req.valid("param");
+	const validatedBody = c.req.valid("json");
+	const updatedAgent = await updateAgent(dbClient_default)({
+		scopes: {
+			tenantId,
+			projectId,
+			agentId: id
+		},
+		data: {
+			defaultSubAgentId: validatedBody.defaultSubAgentId,
+			contextConfigId: validatedBody.contextConfigId ?? void 0
+		}
+	});
+	if (!updatedAgent) throw createApiError({
+		code: "not_found",
+		message: "Agent not found"
+	});
+	return c.json({ data: updatedAgent });
+});
+app.openapi(createRoute({
+	method: "delete",
+	path: "/{id}",
+	summary: "Delete Agent",
+	operationId: "delete-agent",
+	tags: ["Agents"],
+	request: { params: TenantProjectIdParamsSchema },
+	responses: {
+		204: { description: "Agent deleted successfully" },
+		404: {
+			description: "Agent not found",
+			content: { "application/json": { schema: ErrorResponseSchema } }
+		}
+	}
+}), async (c) => {
+	const { tenantId, projectId, id } = c.req.valid("param");
+	if (!await deleteAgent(dbClient_default)({ scopes: {
+		tenantId,
+		projectId,
+		agentId: id
+	} })) throw createApiError({
+		code: "not_found",
+		message: "Agent not found"
+	});
+	return c.body(null, 204);
+});
+var agent_default = app;
+
+//#endregion
+export { agent_default as default };

package/dist/routes/agentFull.d.ts

@@ -0,0 +1,9 @@
+import { BaseAppVariables } from "../types/app.js";
+import { OpenAPIHono } from "@hono/zod-openapi";
+
+//#region src/routes/agentFull.d.ts
+declare const app: OpenAPIHono<{
+  Variables: BaseAppVariables;
+}, {}, "/">;
+//#endregion
+export { app as default };

package/dist/routes/agentFull.js

@@ -0,0 +1,188 @@
+import { getLogger as getLogger$1 } from "../logger.js";
+import dbClient_default from "../data/db/dbClient.js";
+import { requirePermission } from "../middleware/require-permission.js";
+import { OpenAPIHono, createRoute, z } from "@hono/zod-openapi";
+import { AgentWithinContextOfProjectResponse, AgentWithinContextOfProjectSchema, ErrorResponseSchema, TenantProjectAgentParamsSchema, TenantProjectParamsSchema, commonGetErrorResponses, createApiError, createFullAgentServerSide, deleteFullAgent, getFullAgent, updateFullAgentServerSide } from "@inkeep/agents-core";
+
+//#region src/routes/agentFull.ts
+const logger = getLogger$1("agentFull");
+const app = new OpenAPIHono();
+app.use("/", async (c, next) => {
+	if (c.req.method === "POST") return requirePermission({ agent: ["create"] })(c, next);
+	return next();
+});
+app.use("/:agentId", async (c, next) => {
+	if (c.req.method === "PUT") return requirePermission({ agent: ["update"] })(c, next);
+	if (c.req.method === "DELETE") return requirePermission({ agent: ["delete"] })(c, next);
+	return next();
+});
+app.openapi(createRoute({
+	method: "post",
+	path: "/",
+	summary: "Create Full Agent",
+	operationId: "create-full-agent",
+	tags: ["Full Agent"],
+	description: "Create a complete agent with all agents, tools, and relationships from JSON definition",
+	request: {
+		params: TenantProjectParamsSchema,
+		body: { content: { "application/json": { schema: AgentWithinContextOfProjectSchema } } }
+	},
+	responses: {
+		201: {
+			description: "Full agent created successfully",
+			content: { "application/json": { schema: AgentWithinContextOfProjectResponse } }
+		},
+		409: {
+			description: "Agent already exists",
+			content: { "application/json": { schema: ErrorResponseSchema } }
+		},
+		...commonGetErrorResponses
+	}
+}), async (c) => {
+	const { tenantId, projectId } = c.req.valid("param");
+	const agentData = c.req.valid("json");
+	const validatedAgentData = AgentWithinContextOfProjectSchema.parse(agentData);
+	const createdAgent = await createFullAgentServerSide(dbClient_default, logger)({
+		tenantId,
+		projectId
+	}, validatedAgentData);
+	return c.json({ data: createdAgent }, 201);
+});
+app.openapi(createRoute({
+	method: "get",
+	path: "/{agentId}",
+	summary: "Get Full Agent",
+	operationId: "get-full-agent",
+	tags: ["Full Agent"],
+	description: "Retrieve a complete agent definition with all agents, tools, and relationships",
+	request: { params: TenantProjectAgentParamsSchema },
+	responses: {
+		200: {
+			description: "Full agent found",
+			content: { "application/json": { schema: AgentWithinContextOfProjectResponse } }
+		},
+		...commonGetErrorResponses
+	}
+}), async (c) => {
+	const { tenantId, projectId, agentId } = c.req.valid("param");
+	try {
+		const agent = await getFullAgent(dbClient_default, logger)({ scopes: {
+			tenantId,
+			projectId,
+			agentId
+		} });
+		if (!agent) throw createApiError({
+			code: "not_found",
+			message: "Agent not found"
+		});
+		return c.json({ data: agent });
+	} catch (error) {
+		if (error instanceof Error && error.message.includes("not found")) throw createApiError({
+			code: "not_found",
+			message: "Agent not found"
+		});
+		throw createApiError({
+			code: "internal_server_error",
+			message: error instanceof Error ? error.message : "Failed to retrieve agent"
+		});
+	}
+});
+app.openapi(createRoute({
+	method: "put",
+	path: "/{agentId}",
+	summary: "Update Full Agent",
+	operationId: "update-full-agent",
+	tags: ["Full Agent"],
+	description: "Update or create a complete agent with all agents, tools, and relationships from JSON definition",
+	request: {
+		params: TenantProjectAgentParamsSchema,
+		body: { content: { "application/json": { schema: AgentWithinContextOfProjectSchema } } }
+	},
+	responses: {
+		200: {
+			description: "Full agent updated successfully",
+			content: { "application/json": { schema: AgentWithinContextOfProjectResponse } }
+		},
+		201: {
+			description: "Full agent created successfully",
+			content: { "application/json": { schema: AgentWithinContextOfProjectResponse } }
+		},
+		...commonGetErrorResponses
+	}
+}), async (c) => {
+	const { tenantId, projectId, agentId } = c.req.valid("param");
+	const agentData = c.req.valid("json");
+	try {
+		logger.info({}, "test agent data");
+		const validatedAgentData = AgentWithinContextOfProjectSchema.parse(agentData);
+		if (agentId !== validatedAgentData.id) throw createApiError({
+			code: "bad_request",
+			message: `Agent ID mismatch: expected ${agentId}, got ${validatedAgentData.id}`
+		});
+		const isCreate = !await getFullAgent(dbClient_default, logger)({ scopes: {
+			tenantId,
+			projectId,
+			agentId
+		} });
+		const updatedAgent = isCreate ? await createFullAgentServerSide(dbClient_default, logger)({
+			tenantId,
+			projectId
+		}, validatedAgentData) : await updateFullAgentServerSide(dbClient_default, logger)({
+			tenantId,
+			projectId
+		}, validatedAgentData);
+		return c.json({ data: updatedAgent }, isCreate ? 201 : 200);
+	} catch (error) {
+		if (error instanceof z.ZodError) throw createApiError({
+			code: "bad_request",
+			message: "Invalid agent definition"
+		});
+		if (error instanceof Error && error.message.includes("ID mismatch")) throw createApiError({
+			code: "bad_request",
+			message: error.message
+		});
+		throw createApiError({
+			code: "internal_server_error",
+			message: error instanceof Error ? error.message : "Failed to update agent"
+		});
+	}
+});
+app.openapi(createRoute({
+	method: "delete",
+	path: "/{agentId}",
+	summary: "Delete Full Agent",
+	operationId: "delete-full-agent",
+	tags: ["Full Agent"],
+	description: "Delete a complete agent and cascade to all related entities (relationships, not other agents/tools)",
+	request: { params: TenantProjectAgentParamsSchema },
+	responses: {
+		204: { description: "Agent deleted successfully" },
+		...commonGetErrorResponses
+	}
+}), async (c) => {
+	const { tenantId, projectId, agentId } = c.req.valid("param");
+	try {
+		if (!await deleteFullAgent(dbClient_default, logger)({ scopes: {
+			tenantId,
+			projectId,
+			agentId
+		} })) throw createApiError({
+			code: "not_found",
+			message: "Agent not found"
+		});
+		return c.body(null, 204);
+	} catch (error) {
+		if (error instanceof Error && error.message.includes("not found")) throw createApiError({
+			code: "not_found",
+			message: "Agent not found"
+		});
+		throw createApiError({
+			code: "internal_server_error",
+			message: error instanceof Error ? error.message : "Failed to delete agent"
+		});
+	}
+});
+var agentFull_default = app;
+
+//#endregion
+export { agentFull_default as default };

package/dist/routes/agentToolRelations.d.ts

@@ -0,0 +1,9 @@
+import { BaseAppVariables } from "../types/app.js";
+import { OpenAPIHono } from "@hono/zod-openapi";
+
+//#region src/routes/agentToolRelations.d.ts
+declare const app: OpenAPIHono<{
+  Variables: BaseAppVariables;
+}, {}, "/">;
+//#endregion
+export { app as default };