@inkeep/agents-api 0.0.1

package/dist/domains/manage/routes/conversations.js

@@ -0,0 +1,59 @@
+import runDbClient_default from "../../../data/db/runDbClient.js";
+import { OpenAPIHono, createRoute, z } from "@hono/zod-openapi";
+import { TenantProjectIdParamsSchema, commonGetErrorResponses, createApiError, formatMessagesForLLMContext, getConversationHistory } from "@inkeep/agents-core";
+
+//#region src/domains/manage/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(runDbClient_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/domains/manage/routes/credentialStores.d.ts

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

package/dist/domains/manage/routes/credentialStores.js

@@ -0,0 +1,86 @@
+import { requireProjectPermission } from "../../../middleware/projectAccess.js";
+import { OpenAPIHono, createRoute } from "@hono/zod-openapi";
+import { CreateCredentialInStoreRequestSchema, CreateCredentialInStoreResponseSchema, CredentialStoreListResponseSchema, TenantProjectIdParamsSchema, TenantProjectParamsSchema, commonGetErrorResponses, createApiError } from "@inkeep/agents-core";
+
+//#region src/domains/manage/routes/credentialStores.ts
+const app = new OpenAPIHono();
+app.use("/:id/credentials", async (c, next) => {
+	if (c.req.method === "POST") return requireProjectPermission("edit")(c, next);
+	return next();
+});
+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/domains/manage/routes/credentials.d.ts

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

package/dist/domains/manage/routes/credentials.js

@@ -0,0 +1,207 @@
+import { requireProjectPermission } from "../../../middleware/projectAccess.js";
+import { speakeasyOffsetLimitPagination } from "../../../utils/speakeasy.js";
+import { OpenAPIHono, createRoute } from "@hono/zod-openapi";
+import { CredentialReferenceApiInsertSchema, CredentialReferenceApiSelectSchema, CredentialReferenceApiUpdateSchema, CredentialReferenceListResponse, CredentialReferenceResponse, ErrorResponseSchema, ListResponseSchema, PaginationQueryParamsSchema, TenantProjectIdParamsSchema, TenantProjectParamsSchema, commonGetErrorResponses, createApiError, createCredentialReference, deleteCredentialReference, getCredentialReferenceById, getCredentialReferenceWithResources, getCredentialStoreLookupKeyFromRetrievalParams, listCredentialReferencesPaginated, updateCredentialReference } from "@inkeep/agents-core";
+
+//#region src/domains/manage/routes/credentials.ts
+const app = new OpenAPIHono();
+app.use("/", async (c, next) => {
+	if (c.req.method === "POST") return requireProjectPermission("edit")(c, next);
+	return next();
+});
+app.use("/:id", async (c, next) => {
+	if (c.req.method === "PATCH") return requireProjectPermission("edit")(c, next);
+	if (c.req.method === "DELETE") return requireProjectPermission("edit")(c, next);
+	return next();
+});
+app.openapi(createRoute({
+	method: "get",
+	path: "/",
+	summary: "List Credentials",
+	operationId: "list-credentials",
+	tags: ["Credential"],
+	request: {
+		params: TenantProjectParamsSchema,
+		query: PaginationQueryParamsSchema
+	},
+	responses: {
+		200: {
+			description: "List of credentials retrieved successfully",
+			content: { "application/json": { schema: CredentialReferenceListResponse } }
+		},
+		...commonGetErrorResponses
+	},
+	...speakeasyOffsetLimitPagination
+}), async (c) => {
+	const db = c.get("db");
+	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 listCredentialReferencesPaginated(db)({
+		scopes: {
+			tenantId,
+			projectId
+		},
+		pagination: {
+			page,
+			limit
+		}
+	});
+	const validatedResult = ListResponseSchema(CredentialReferenceApiSelectSchema).parse(result);
+	return c.json(validatedResult);
+});
+app.openapi(createRoute({
+	method: "get",
+	path: "/{id}",
+	summary: "Get Credential",
+	operationId: "get-credential-by-id",
+	tags: ["Credential"],
+	request: { params: TenantProjectIdParamsSchema },
+	responses: {
+		200: {
+			description: "Credential found",
+			content: { "application/json": { schema: CredentialReferenceResponse } }
+		},
+		...commonGetErrorResponses
+	}
+}), async (c) => {
+	const { tenantId, projectId, id } = c.req.valid("param");
+	const credential = await getCredentialReferenceWithResources(c.get("db"))({
+		scopes: {
+			tenantId,
+			projectId
+		},
+		id
+	});
+	if (!credential) throw createApiError({
+		code: "not_found",
+		message: "Credential not found"
+	});
+	const validatedCredential = CredentialReferenceApiSelectSchema.parse(credential);
+	return c.json({ data: validatedCredential });
+});
+app.openapi(createRoute({
+	method: "post",
+	path: "/",
+	summary: "Create Credential",
+	operationId: "create-credential",
+	tags: ["Credential"],
+	request: {
+		params: TenantProjectParamsSchema,
+		body: { content: { "application/json": { schema: CredentialReferenceApiInsertSchema } } }
+	},
+	responses: {
+		201: {
+			description: "Credential created successfully",
+			content: { "application/json": { schema: CredentialReferenceResponse } }
+		},
+		...commonGetErrorResponses
+	}
+}), async (c) => {
+	const db = c.get("db");
+	const { tenantId, projectId } = c.req.valid("param");
+	const credentialData = {
+		...c.req.valid("json"),
+		tenantId,
+		projectId
+	};
+	const credential = await createCredentialReference(db)(credentialData);
+	const validatedCredential = CredentialReferenceApiSelectSchema.parse(credential);
+	return c.json({ data: validatedCredential }, 201);
+});
+app.openapi(createRoute({
+	method: "put",
+	path: "/{id}",
+	summary: "Update Credential",
+	operationId: "update-credential",
+	tags: ["Credential"],
+	request: {
+		params: TenantProjectIdParamsSchema,
+		body: { content: { "application/json": { schema: CredentialReferenceApiUpdateSchema } } }
+	},
+	responses: {
+		200: {
+			description: "Credential updated successfully",
+			content: { "application/json": { schema: CredentialReferenceResponse } }
+		},
+		...commonGetErrorResponses
+	}
+}), async (c) => {
+	const db = c.get("db");
+	const { tenantId, projectId, id } = c.req.valid("param");
+	const body = c.req.valid("json");
+	const updatedCredential = await updateCredentialReference(db)({
+		scopes: {
+			tenantId,
+			projectId
+		},
+		id,
+		data: body
+	});
+	if (!updatedCredential) throw createApiError({
+		code: "not_found",
+		message: "Credential not found"
+	});
+	const validatedCredential = CredentialReferenceApiSelectSchema.parse(updatedCredential);
+	return c.json({ data: validatedCredential });
+});
+app.openapi(createRoute({
+	method: "delete",
+	path: "/{id}",
+	summary: "Delete Credential",
+	operationId: "delete-credential",
+	tags: ["Credential"],
+	request: { params: TenantProjectIdParamsSchema },
+	responses: {
+		204: { description: "Credential deleted successfully" },
+		404: {
+			description: "Credential not found",
+			content: { "application/json": { schema: ErrorResponseSchema } }
+		}
+	}
+}), async (c) => {
+	const db = c.get("db");
+	const { tenantId, projectId, id } = c.req.valid("param");
+	const credential = await getCredentialReferenceById(db)({
+		scopes: {
+			tenantId,
+			projectId
+		},
+		id
+	});
+	if (!credential) throw createApiError({
+		code: "not_found",
+		message: "Credential not found"
+	});
+	const credentialStore = c.get("credentialStores").get(credential.credentialStoreId);
+	if (credentialStore && credential.retrievalParams) {
+		const lookupKey = getCredentialStoreLookupKeyFromRetrievalParams({
+			retrievalParams: credential.retrievalParams,
+			credentialStoreType: credentialStore.type
+		});
+		if (!lookupKey) throw createApiError({
+			code: "bad_request",
+			message: "Could not generate lookup key for credential store"
+		});
+		try {
+			await credentialStore.delete(lookupKey);
+		} catch (error) {
+			console.error(`Failed to delete credential from external store "${credential.credentialStoreId}":`, error);
+		}
+	}
+	if (!await deleteCredentialReference(db)({
+		scopes: {
+			tenantId,
+			projectId
+		},
+		id
+	})) throw createApiError({
+		code: "not_found",
+		message: "Failed to delete credential"
+	});
+	return c.body(null, 204);
+});
+var credentials_default = app;
+
+//#endregion
+export { credentials_default as default };

package/dist/domains/manage/routes/dataComponents.d.ts

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

package/dist/domains/manage/routes/dataComponents.js

@@ -0,0 +1,192 @@
+import { requireProjectPermission } from "../../../middleware/projectAccess.js";
+import { speakeasyOffsetLimitPagination } from "../../../utils/speakeasy.js";
+import { OpenAPIHono, createRoute } from "@hono/zod-openapi";
+import { DataComponentApiInsertSchema, DataComponentApiUpdateSchema, DataComponentListResponse, DataComponentResponse, ErrorResponseSchema, PaginationQueryParamsSchema, TenantProjectIdParamsSchema, TenantProjectParamsSchema, commonGetErrorResponses, createApiError, createDataComponent, deleteDataComponent, getDataComponent, listDataComponentsPaginated, updateDataComponent, validatePropsAsJsonSchema } from "@inkeep/agents-core";
+
+//#region src/domains/manage/routes/dataComponents.ts
+const app = new OpenAPIHono();
+app.use("/", async (c, next) => {
+	if (c.req.method === "POST") return requireProjectPermission("edit")(c, next);
+	return next();
+});
+app.use("/:id", async (c, next) => {
+	if (c.req.method === "PATCH") return requireProjectPermission("edit")(c, next);
+	if (c.req.method === "DELETE") return requireProjectPermission("edit")(c, next);
+	return next();
+});
+app.openapi(createRoute({
+	method: "get",
+	path: "/",
+	summary: "List Data Components",
+	operationId: "list-data-components",
+	tags: ["Data Component"],
+	request: {
+		params: TenantProjectParamsSchema,
+		query: PaginationQueryParamsSchema
+	},
+	responses: {
+		200: {
+			description: "List of data components retrieved successfully",
+			content: { "application/json": { schema: DataComponentListResponse } }
+		},
+		...commonGetErrorResponses
+	},
+	...speakeasyOffsetLimitPagination
+}), async (c) => {
+	const db = c.get("db");
+	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 listDataComponentsPaginated(db)({
+		scopes: {
+			tenantId,
+			projectId
+		},
+		pagination: {
+			page,
+			limit
+		}
+	});
+	return c.json(result);
+});
+app.openapi(createRoute({
+	method: "get",
+	path: "/{id}",
+	summary: "Get Data Component",
+	operationId: "get-data-component-by-id",
+	tags: ["Data Component"],
+	request: { params: TenantProjectIdParamsSchema },
+	responses: {
+		200: {
+			description: "Data component found",
+			content: { "application/json": { schema: DataComponentResponse } }
+		},
+		...commonGetErrorResponses
+	}
+}), async (c) => {
+	const db = c.get("db");
+	const { tenantId, projectId, id } = c.req.valid("param");
+	const dataComponent = await getDataComponent(db)({
+		scopes: {
+			tenantId,
+			projectId
+		},
+		dataComponentId: id
+	});
+	if (!dataComponent) throw createApiError({
+		code: "not_found",
+		message: "Data component not found"
+	});
+	return c.json({ data: dataComponent });
+});
+app.openapi(createRoute({
+	method: "post",
+	path: "/",
+	summary: "Create Data Component",
+	operationId: "create-data-component",
+	tags: ["Data Component"],
+	request: {
+		params: TenantProjectParamsSchema,
+		body: { content: { "application/json": { schema: DataComponentApiInsertSchema } } }
+	},
+	responses: {
+		201: {
+			description: "Data component created successfully",
+			content: { "application/json": { schema: DataComponentResponse } }
+		},
+		...commonGetErrorResponses
+	}
+}), async (c) => {
+	const db = c.get("db");
+	const { tenantId, projectId } = c.req.valid("param");
+	const body = c.req.valid("json");
+	if (body.props) {
+		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 dataComponentData = {
+		...body,
+		tenantId,
+		projectId
+	};
+	const dataComponent = await createDataComponent(db)(dataComponentData);
+	return c.json({ data: dataComponent }, 201);
+});
+app.openapi(createRoute({
+	method: "put",
+	path: "/{id}",
+	summary: "Update Data Component",
+	operationId: "update-data-component",
+	tags: ["Data Component"],
+	request: {
+		params: TenantProjectIdParamsSchema,
+		body: { content: { "application/json": { schema: DataComponentApiUpdateSchema } } }
+	},
+	responses: {
+		200: {
+			description: "Data component updated successfully",
+			content: { "application/json": { schema: DataComponentResponse } }
+		},
+		...commonGetErrorResponses
+	}
+}), async (c) => {
+	const db = c.get("db");
+	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 updatedDataComponent = await updateDataComponent(db)({
+		scopes: {
+			tenantId,
+			projectId
+		},
+		dataComponentId: id,
+		data: body
+	});
+	if (!updatedDataComponent) throw createApiError({
+		code: "not_found",
+		message: "Data component not found"
+	});
+	return c.json({ data: updatedDataComponent });
+});
+app.openapi(createRoute({
+	method: "delete",
+	path: "/{id}",
+	summary: "Delete Data Component",
+	operationId: "delete-data-component",
+	tags: ["Data Component"],
+	request: { params: TenantProjectIdParamsSchema },
+	responses: {
+		204: { description: "Data component deleted successfully" },
+		404: {
+			description: "Data component not found",
+			content: { "application/json": { schema: ErrorResponseSchema } }
+		}
+	}
+}), async (c) => {
+	const db = c.get("db");
+	const { tenantId, projectId, id } = c.req.valid("param");
+	if (!await deleteDataComponent(db)({
+		scopes: {
+			tenantId,
+			projectId
+		},
+		dataComponentId: id
+	})) throw createApiError({
+		code: "not_found",
+		message: "Data component not found"
+	});
+	return c.body(null, 204);
+});
+var dataComponents_default = app;
+
+//#endregion
+export { dataComponents_default as default };

package/dist/domains/manage/routes/evals/datasetItems.d.ts

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