@inkeep/agents-manage-api 0.39.4 → 0.40.0

package/dist/routes/artifactComponents.d.ts

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

package/dist/routes/artifactComponents.js

@@ -0,0 +1,204 @@
+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 { ArtifactComponentApiInsertSchema, ArtifactComponentApiUpdateSchema, ArtifactComponentListResponse, ArtifactComponentResponse, ErrorResponseSchema, PaginationQueryParamsSchema, TenantProjectIdParamsSchema, TenantProjectParamsSchema, commonGetErrorResponses, createApiError, createArtifactComponent, deleteArtifactComponent, generateId, getArtifactComponentById, listArtifactComponentsPaginated, updateArtifactComponent, validatePropsAsJsonSchema } from "@inkeep/agents-core";
+
+//#region src/routes/artifactComponents.ts
+const app = new OpenAPIHono();
+app.use("/", async (c, next) => {
+	if (c.req.method === "POST") return requirePermission({ artifact_component: ["create"] })(c, next);
+	return next();
+});
+app.use("/:id", async (c, next) => {
+	if (c.req.method === "PATCH") return requirePermission({ artifact_component: ["update"] })(c, next);
+	if (c.req.method === "DELETE") return requirePermission({ artifact_component: ["delete"] })(c, next);
+	return next();
+});
+app.openapi(createRoute({
+	method: "get",
+	path: "/",
+	summary: "List Artifact Components",
+	operationId: "list-artifact-components",
+	tags: ["Artifact Component"],
+	request: {
+		params: TenantProjectParamsSchema,
+		query: PaginationQueryParamsSchema
+	},
+	responses: {
+		200: {
+			description: "List of artifact components retrieved successfully",
+			content: { "application/json": { schema: ArtifactComponentListResponse } }
+		},
+		...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 listArtifactComponentsPaginated(dbClient_default)({
+		scopes: {
+			tenantId,
+			projectId
+		},
+		pagination: {
+			page,
+			limit
+		}
+	});
+	return c.json(result);
+});
+app.openapi(createRoute({
+	method: "get",
+	path: "/{id}",
+	summary: "Get Artifact Component",
+	operationId: "get-artifact-component-by-id",
+	tags: ["Artifact Component"],
+	request: { params: TenantProjectIdParamsSchema },
+	responses: {
+		200: {
+			description: "Artifact component found",
+			content: { "application/json": { schema: ArtifactComponentResponse } }
+		},
+		...commonGetErrorResponses
+	}
+}), async (c) => {
+	const { tenantId, projectId, id } = c.req.valid("param");
+	const artifactComponent = await getArtifactComponentById(dbClient_default)({
+		scopes: {
+			tenantId,
+			projectId
+		},
+		id
+	});
+	if (!artifactComponent) throw createApiError({
+		code: "not_found",
+		message: "Artifact component not found"
+	});
+	return c.json({ data: artifactComponent });
+});
+app.openapi(createRoute({
+	method: "post",
+	path: "/",
+	summary: "Create Artifact Component",
+	operationId: "create-artifact-component",
+	tags: ["Artifact Component"],
+	request: {
+		params: TenantProjectParamsSchema,
+		body: { content: { "application/json": { schema: ArtifactComponentApiInsertSchema } } }
+	},
+	responses: {
+		201: {
+			description: "Artifact component created successfully",
+			content: { "application/json": { schema: ArtifactComponentResponse } }
+		},
+		...commonGetErrorResponses
+	}
+}), async (c) => {
+	const { tenantId, projectId } = c.req.valid("param");
+	const body = c.req.valid("json");
+	if (body.props !== null && body.props !== void 0) {
+		const propsValidation = validatePropsAsJsonSchema(body.props);
+		if (!propsValidation.isValid) throw createApiError({
+			code: "bad_request",
+			message: `Invalid props schema: ${propsValidation.errors.map((e) => `${e.field}: ${e.message}`).join(", ")}`
+		});
+	}
+	const finalId = body.id ? String(body.id) : generateId();
+	const componentData = {
+		tenantId,
+		projectId,
+		id: finalId,
+		name: String(body.name),
+		description: String(body.description),
+		props: body.props ?? null
+	};
+	try {
+		const artifactComponent = await createArtifactComponent(dbClient_default)({ ...componentData });
+		return c.json({ data: artifactComponent }, 201);
+	} catch (error) {
+		if (error?.cause?.code === "23505") throw createApiError({
+			code: "conflict",
+			message: `Artifact component with ID '${finalId}' already exists`
+		});
+		throw error;
+	}
+});
+app.openapi(createRoute({
+	method: "put",
+	path: "/{id}",
+	summary: "Update Artifact Component",
+	operationId: "update-artifact-component",
+	tags: ["Artifact Component"],
+	request: {
+		params: TenantProjectIdParamsSchema,
+		body: { content: { "application/json": { schema: ArtifactComponentApiUpdateSchema } } }
+	},
+	responses: {
+		200: {
+			description: "Artifact component updated successfully",
+			content: { "application/json": { schema: ArtifactComponentResponse } }
+		},
+		...commonGetErrorResponses
+	}
+}), async (c) => {
+	const { tenantId, projectId, id } = c.req.valid("param");
+	const body = c.req.valid("json");
+	if (body.props !== void 0 && body.props !== null) {
+		const propsValidation = validatePropsAsJsonSchema(body.props);
+		if (!propsValidation.isValid) throw createApiError({
+			code: "bad_request",
+			message: `Invalid props schema: ${propsValidation.errors.map((e) => `${e.field}: ${e.message}`).join(", ")}`
+		});
+	}
+	const updateData = {};
+	if (body.name !== void 0) updateData.name = String(body.name);
+	if (body.description !== void 0) updateData.description = String(body.description);
+	if (body.props !== void 0) updateData.props = body.props ?? null;
+	const updatedArtifactComponent = await updateArtifactComponent(dbClient_default)({
+		scopes: {
+			tenantId,
+			projectId
+		},
+		id,
+		data: updateData
+	});
+	if (!updatedArtifactComponent) throw createApiError({
+		code: "not_found",
+		message: "Artifact component not found"
+	});
+	return c.json({ data: updatedArtifactComponent });
+});
+app.openapi(createRoute({
+	method: "delete",
+	path: "/{id}",
+	summary: "Delete Artifact Component",
+	operationId: "delete-artifact-component",
+	tags: ["Artifact Component"],
+	request: { params: TenantProjectIdParamsSchema },
+	responses: {
+		204: { description: "Artifact component deleted successfully" },
+		404: {
+			description: "Artifact component not found",
+			content: { "application/json": { schema: ErrorResponseSchema } }
+		}
+	}
+}), async (c) => {
+	const { tenantId, projectId, id } = c.req.valid("param");
+	if (!await deleteArtifactComponent(dbClient_default)({
+		scopes: {
+			tenantId,
+			projectId
+		},
+		id
+	})) throw createApiError({
+		code: "not_found",
+		message: "Artifact component not found"
+	});
+	return c.body(null, 204);
+});
+var artifactComponents_default = app;
+
+//#endregion
+export { artifactComponents_default as default };

package/dist/routes/cliAuth.d.ts

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

package/dist/routes/cliAuth.js

@@ -0,0 +1,60 @@
+import dbClient_default from "../data/db/dbClient.js";
+import { sessionAuth } from "../middleware/session-auth.js";
+import { OpenAPIHono, createRoute, z } from "@hono/zod-openapi";
+import { getUserOrganizations } from "@inkeep/agents-core";
+
+//#region src/routes/cliAuth.ts
+const cliAuthRoutes = new OpenAPIHono();
+const CLIMeResponseSchema = z.object({
+	user: z.object({
+		id: z.string(),
+		email: z.string(),
+		name: z.string().nullable()
+	}),
+	organization: z.object({
+		id: z.string(),
+		name: z.string(),
+		slug: z.string(),
+		role: z.string()
+	})
+});
+cliAuthRoutes.openapi(createRoute({
+	method: "get",
+	path: "/me",
+	tags: ["cli"],
+	summary: "Get CLI user info",
+	description: "Get the current authenticated user and their organization for CLI usage",
+	middleware: [sessionAuth()],
+	responses: {
+		200: {
+			description: "User info with organization",
+			content: { "application/json": { schema: CLIMeResponseSchema } }
+		},
+		401: { description: "Not authenticated" },
+		404: { description: "User has no organization" }
+	}
+}), async (c) => {
+	const user = c.get("user");
+	const userId = c.get("userId");
+	if (!user || !userId) return c.json({ error: "Not authenticated" }, 401);
+	const organizations = await getUserOrganizations(dbClient_default)(userId);
+	if (organizations.length === 0) return c.json({ error: "User has no organization" }, 404);
+	const org = organizations[0];
+	return c.json({
+		user: {
+			id: user.id,
+			email: user.email,
+			name: user.name || null
+		},
+		organization: {
+			id: org.organizationId,
+			name: org.organizationName || "",
+			slug: org.organizationSlug || "",
+			role: org.role
+		}
+	});
+});
+var cliAuth_default = cliAuthRoutes;
+
+//#endregion
+export { cliAuth_default as default };

package/dist/routes/contextConfigs.d.ts

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

package/dist/routes/contextConfigs.js

@@ -0,0 +1,175 @@
+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 { ContextConfigApiInsertSchema, ContextConfigApiUpdateSchema, ContextConfigListResponse, ContextConfigResponse, PaginationQueryParamsSchema, TenantProjectAgentIdParamsSchema, TenantProjectAgentParamsSchema, commonDeleteErrorResponses, commonGetErrorResponses, commonUpdateErrorResponses, createApiError, createContextConfig, deleteContextConfig, getContextConfigById, listContextConfigsPaginated, updateContextConfig } from "@inkeep/agents-core";
+
+//#region src/routes/contextConfigs.ts
+const app = new OpenAPIHono();
+app.use("/", async (c, next) => {
+	if (c.req.method === "POST") return requirePermission({ context_config: ["create"] })(c, next);
+	return next();
+});
+app.use("/:id", async (c, next) => {
+	if (c.req.method === "PUT") return requirePermission({ context_config: ["update"] })(c, next);
+	if (c.req.method === "DELETE") return requirePermission({ context_config: ["delete"] })(c, next);
+	return next();
+});
+app.openapi(createRoute({
+	method: "get",
+	path: "/",
+	summary: "List Context Configurations",
+	operationId: "list-context-configs",
+	tags: ["Context Config"],
+	request: {
+		params: TenantProjectAgentParamsSchema,
+		query: PaginationQueryParamsSchema
+	},
+	responses: {
+		200: {
+			description: "List of context configurations retrieved successfully",
+			content: { "application/json": { schema: ContextConfigListResponse } }
+		},
+		...commonGetErrorResponses
+	},
+	...speakeasyOffsetLimitPagination
+}), async (c) => {
+	const { tenantId, projectId, agentId } = 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 listContextConfigsPaginated(dbClient_default)({
+		scopes: {
+			tenantId,
+			projectId,
+			agentId
+		},
+		pagination: {
+			page,
+			limit
+		}
+	});
+	return c.json(result);
+});
+app.openapi(createRoute({
+	method: "get",
+	path: "/{id}",
+	summary: "Get Context Configuration",
+	operationId: "get-context-config-by-id",
+	tags: ["Context Config"],
+	request: { params: TenantProjectAgentIdParamsSchema },
+	responses: {
+		200: {
+			description: "Context configuration found",
+			content: { "application/json": { schema: ContextConfigResponse } }
+		},
+		...commonGetErrorResponses
+	}
+}), async (c) => {
+	const { tenantId, projectId, agentId, id } = c.req.valid("param");
+	const contextConfig = await getContextConfigById(dbClient_default)({
+		scopes: {
+			tenantId,
+			projectId,
+			agentId
+		},
+		id
+	});
+	if (!contextConfig) throw createApiError({
+		code: "not_found",
+		message: "Context configuration not found"
+	});
+	return c.json({ data: contextConfig });
+});
+app.openapi(createRoute({
+	method: "post",
+	path: "/",
+	summary: "Create Context Configuration",
+	operationId: "create-context-config",
+	tags: ["Context Config"],
+	request: {
+		params: TenantProjectAgentParamsSchema,
+		body: { content: { "application/json": { schema: ContextConfigApiInsertSchema } } }
+	},
+	responses: {
+		201: {
+			description: "Context configuration created successfully",
+			content: { "application/json": { schema: ContextConfigResponse } }
+		},
+		...commonGetErrorResponses
+	}
+}), async (c) => {
+	const { tenantId, projectId, agentId } = c.req.valid("param");
+	const configData = {
+		tenantId,
+		projectId,
+		agentId,
+		...c.req.valid("json")
+	};
+	const contextConfig = await createContextConfig(dbClient_default)(configData);
+	return c.json({ data: contextConfig }, 201);
+});
+app.openapi(createRoute({
+	method: "put",
+	path: "/{id}",
+	summary: "Update Context Configuration",
+	operationId: "update-context-config",
+	tags: ["Context Config"],
+	request: {
+		params: TenantProjectAgentIdParamsSchema,
+		body: { content: { "application/json": { schema: ContextConfigApiUpdateSchema } } }
+	},
+	responses: {
+		200: {
+			description: "Context configuration updated successfully",
+			content: { "application/json": { schema: ContextConfigResponse } }
+		},
+		...commonUpdateErrorResponses
+	}
+}), async (c) => {
+	const { tenantId, projectId, agentId, id } = c.req.valid("param");
+	const body = c.req.valid("json");
+	const updatedContextConfig = await updateContextConfig(dbClient_default)({
+		scopes: {
+			tenantId,
+			projectId,
+			agentId
+		},
+		id,
+		data: body
+	});
+	if (!updatedContextConfig) throw createApiError({
+		code: "not_found",
+		message: "Context configuration not found"
+	});
+	return c.json({ data: updatedContextConfig });
+});
+app.openapi(createRoute({
+	method: "delete",
+	path: "/{id}",
+	summary: "Delete Context Configuration",
+	operationId: "delete-context-config",
+	tags: ["Context Config"],
+	request: { params: TenantProjectAgentIdParamsSchema },
+	responses: {
+		204: { description: "Context configuration deleted successfully" },
+		...commonDeleteErrorResponses
+	}
+}), async (c) => {
+	const { tenantId, projectId, agentId, id } = c.req.valid("param");
+	if (!await deleteContextConfig(dbClient_default)({
+		scopes: {
+			tenantId,
+			projectId,
+			agentId
+		},
+		id
+	})) throw createApiError({
+		code: "not_found",
+		message: "Context configuration not found"
+	});
+	return c.body(null, 204);
+});
+var contextConfigs_default = app;
+
+//#endregion
+export { contextConfigs_default as default };

package/dist/routes/conversations.d.ts

@@ -0,0 +1,7 @@
+import { OpenAPIHono } from "@hono/zod-openapi";
+import * as hono5 from "hono";
+
+//#region src/routes/conversations.d.ts
+declare const app: OpenAPIHono<hono5.Env, {}, "/">;
+//#endregion
+export { app as default };

package/dist/routes/conversations.js

@@ -0,0 +1,59 @@
+import dbClient_default from "../data/db/dbClient.js";
+import { OpenAPIHono, createRoute, z } from "@hono/zod-openapi";
+import { TenantProjectIdParamsSchema, commonGetErrorResponses, createApiError, formatMessagesForLLMContext, getConversationHistory } from "@inkeep/agents-core";
+
+//#region src/routes/conversations.ts
+const app = new OpenAPIHono();
+const ConversationQueryParamsSchema = z.object({
+	limit: z.coerce.number().min(1).max(200).default(20).optional(),
+	includeInternal: z.coerce.boolean().default(false).optional()
+});
+const ConversationWithFormattedMessagesResponse = z.object({ data: z.object({
+	messages: z.array(z.any()),
+	formatted: z.object({ llmContext: z.string() })
+}) }).openapi("ConversationWithFormattedMessagesResponse");
+app.openapi(createRoute({
+	method: "get",
+	path: "/{id}",
+	summary: "Get Conversation",
+	operationId: "get-conversation",
+	tags: ["Conversations"],
+	request: {
+		params: TenantProjectIdParamsSchema,
+		query: ConversationQueryParamsSchema
+	},
+	responses: {
+		200: {
+			description: "Conversation found with formatted messages for LLM use",
+			content: { "application/json": { schema: ConversationWithFormattedMessagesResponse } }
+		},
+		...commonGetErrorResponses
+	}
+}), async (c) => {
+	const { tenantId, projectId, id } = c.req.valid("param");
+	const { limit = 20, includeInternal = true } = c.req.valid("query");
+	const messages = await getConversationHistory(dbClient_default)({
+		scopes: {
+			tenantId,
+			projectId
+		},
+		conversationId: id,
+		options: {
+			limit,
+			includeInternal
+		}
+	});
+	if (!messages || messages.length === 0) throw createApiError({
+		code: "not_found",
+		message: "Conversation not found"
+	});
+	const llmContext = formatMessagesForLLMContext(messages);
+	return c.json({ data: {
+		messages,
+		formatted: { llmContext }
+	} });
+});
+var conversations_default = app;
+
+//#endregion
+export { conversations_default as default };

package/dist/routes/credentialStores.d.ts

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

package/dist/routes/credentialStores.js

@@ -0,0 +1,81 @@
+import { OpenAPIHono, createRoute } from "@hono/zod-openapi";
+import { CreateCredentialInStoreRequestSchema, CreateCredentialInStoreResponseSchema, CredentialStoreListResponseSchema, TenantProjectIdParamsSchema, TenantProjectParamsSchema, commonGetErrorResponses, createApiError } from "@inkeep/agents-core";
+
+//#region src/routes/credentialStores.ts
+const app = new OpenAPIHono();
+app.openapi(createRoute({
+	method: "get",
+	path: "/",
+	summary: "List Credential Stores",
+	operationId: "list-credential-stores",
+	tags: ["Credential Store"],
+	request: { params: TenantProjectParamsSchema },
+	responses: {
+		200: {
+			description: "List of credential stores retrieved successfully",
+			content: { "application/json": { schema: CredentialStoreListResponseSchema } }
+		},
+		...commonGetErrorResponses
+	}
+}), async (c) => {
+	const allStores = c.get("credentialStores").getAll();
+	const storeStatuses = await Promise.all(allStores.map(async (store) => {
+		const { available, reason } = await store.checkAvailability();
+		return {
+			id: store.id,
+			type: store.type,
+			available,
+			reason: reason || null
+		};
+	}));
+	return c.json({ data: storeStatuses });
+});
+app.openapi(createRoute({
+	method: "post",
+	path: "/{id}/credentials",
+	summary: "Create Credential in Store",
+	operationId: "create-credential-in-store",
+	tags: ["Credential Store"],
+	request: {
+		params: TenantProjectIdParamsSchema,
+		body: { content: { "application/json": { schema: CreateCredentialInStoreRequestSchema } } }
+	},
+	responses: {
+		201: {
+			description: "Credential created successfully",
+			content: { "application/json": { schema: CreateCredentialInStoreResponseSchema } }
+		},
+		...commonGetErrorResponses
+	}
+}), async (c) => {
+	const { id: storeId } = c.req.param();
+	const { key, value, metadata } = await c.req.json();
+	const store = c.get("credentialStores").get(storeId);
+	if (!store) throw createApiError({
+		code: "not_found",
+		message: `Credential store '${storeId}' not found`
+	});
+	try {
+		const { available, reason } = await store.checkAvailability();
+		if (!available) throw createApiError({
+			code: "internal_server_error",
+			message: `Credential store '${storeId}' is not available: ${reason}`
+		});
+		await store.set(key, value, metadata ?? {});
+		return c.json({ data: {
+			key,
+			storeId,
+			createdAt: (/* @__PURE__ */ new Date()).toISOString()
+		} }, 201);
+	} catch (error) {
+		console.error(`Error setting credential in store ${storeId}:`, error);
+		throw createApiError({
+			code: "internal_server_error",
+			message: `Failed to store credential: ${error instanceof Error ? error.message : "Unknown error"}`
+		});
+	}
+});
+var credentialStores_default = app;
+
+//#endregion
+export { credentialStores_default as default };

package/dist/routes/credentials.d.ts

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