@inkeep/agents-manage-api 0.39.5 → 0.40.0

package/dist/routes/credentials.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 { 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/routes/credentials.ts
+const app = new OpenAPIHono();
+app.use("/", async (c, next) => {
+	if (c.req.method === "POST") return requirePermission({ credential: ["create"] })(c, next);
+	return next();
+});
+app.use("/:id", async (c, next) => {
+	if (c.req.method === "PATCH") return requirePermission({ credential: ["update"] })(c, next);
+	if (c.req.method === "DELETE") return requirePermission({ credential: ["delete"] })(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 { 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(dbClient_default)({
+		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(dbClient_default)({
+		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 { tenantId, projectId } = c.req.valid("param");
+	const credentialData = {
+		...c.req.valid("json"),
+		tenantId,
+		projectId
+	};
+	const credential = await createCredentialReference(dbClient_default)(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 { tenantId, projectId, id } = c.req.valid("param");
+	const body = c.req.valid("json");
+	const updatedCredential = await updateCredentialReference(dbClient_default)({
+		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 { tenantId, projectId, id } = c.req.valid("param");
+	const credential = await getCredentialReferenceById(dbClient_default)({
+		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(dbClient_default)({
+		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/routes/dataComponents.d.ts

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

package/dist/routes/dataComponents.js

@@ -0,0 +1,188 @@
+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 { DataComponentApiInsertSchema, DataComponentApiUpdateSchema, DataComponentListResponse, DataComponentResponse, ErrorResponseSchema, PaginationQueryParamsSchema, TenantProjectIdParamsSchema, TenantProjectParamsSchema, commonGetErrorResponses, createApiError, createDataComponent, deleteDataComponent, getDataComponent, listDataComponentsPaginated, updateDataComponent, validatePropsAsJsonSchema } from "@inkeep/agents-core";
+
+//#region src/routes/dataComponents.ts
+const app = new OpenAPIHono();
+app.use("/", async (c, next) => {
+	if (c.req.method === "POST") return requirePermission({ data_component: ["create"] })(c, next);
+	return next();
+});
+app.use("/:id", async (c, next) => {
+	if (c.req.method === "PATCH") return requirePermission({ data_component: ["update"] })(c, next);
+	if (c.req.method === "DELETE") return requirePermission({ data_component: ["delete"] })(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 { 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(dbClient_default)({
+		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 { tenantId, projectId, id } = c.req.valid("param");
+	const dataComponent = await getDataComponent(dbClient_default)({
+		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 { 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(dbClient_default)(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 { 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(dbClient_default)({
+		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 { tenantId, projectId, id } = c.req.valid("param");
+	if (!await deleteDataComponent(dbClient_default)({
+		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/routes/externalAgents.d.ts

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

package/dist/routes/externalAgents.js

@@ -0,0 +1,195 @@
+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 { ErrorResponseSchema, ExternalAgentApiInsertSchema, ExternalAgentApiUpdateSchema, ExternalAgentListResponse, ExternalAgentResponse, PaginationQueryParamsSchema, TenantProjectIdParamsSchema, TenantProjectParamsSchema, commonGetErrorResponses, createApiError, createExternalAgent, deleteExternalAgent, generateId, getExternalAgent, listExternalAgentsPaginated, updateExternalAgent } from "@inkeep/agents-core";
+
+//#region src/routes/externalAgents.ts
+const app = new OpenAPIHono();
+app.use("/", async (c, next) => {
+	if (c.req.method === "POST") return requirePermission({ external_agent: ["create"] })(c, next);
+	return next();
+});
+app.use("/:id", async (c, next) => {
+	if (c.req.method === "PATCH") return requirePermission({ external_agent: ["update"] })(c, next);
+	if (c.req.method === "DELETE") return requirePermission({ external_agent: ["delete"] })(c, next);
+	return next();
+});
+app.openapi(createRoute({
+	method: "get",
+	path: "/",
+	summary: "List External Agents",
+	operationId: "list-external-agents",
+	tags: ["External Agents"],
+	request: {
+		params: TenantProjectParamsSchema,
+		query: PaginationQueryParamsSchema
+	},
+	responses: {
+		200: {
+			description: "List of external agents retrieved successfully",
+			content: { "application/json": { schema: ExternalAgentListResponse } }
+		},
+		...commonGetErrorResponses
+	},
+	...speakeasyOffsetLimitPagination
+}), async (c) => {
+	const { tenantId, projectId } = c.req.valid("param");
+	const { page, limit } = c.req.valid("query");
+	const result = await listExternalAgentsPaginated(dbClient_default)({
+		scopes: {
+			tenantId,
+			projectId
+		},
+		pagination: {
+			page,
+			limit
+		}
+	});
+	const dataWithType = {
+		...result,
+		data: result.data.map((agent) => ({
+			...agent,
+			type: "external"
+		}))
+	};
+	return c.json(dataWithType);
+});
+app.openapi(createRoute({
+	method: "get",
+	path: "/{id}",
+	summary: "Get External Agent",
+	operationId: "get-external-agent-by-id",
+	tags: ["External Agents"],
+	request: { params: TenantProjectIdParamsSchema },
+	responses: {
+		200: {
+			description: "External agent found",
+			content: { "application/json": { schema: ExternalAgentResponse } }
+		},
+		...commonGetErrorResponses
+	}
+}), async (c) => {
+	const { tenantId, projectId, id } = c.req.valid("param");
+	const externalAgent = await getExternalAgent(dbClient_default)({
+		scopes: {
+			tenantId,
+			projectId
+		},
+		externalAgentId: id
+	});
+	if (!externalAgent) throw createApiError({
+		code: "not_found",
+		message: "External agent not found"
+	});
+	const agentWithType = {
+		...externalAgent,
+		type: "external"
+	};
+	return c.json({ data: agentWithType });
+});
+app.openapi(createRoute({
+	method: "post",
+	path: "/",
+	summary: "Create External Agent",
+	operationId: "create-external-agent",
+	tags: ["External Agents"],
+	request: {
+		params: TenantProjectParamsSchema,
+		body: { content: { "application/json": { schema: ExternalAgentApiInsertSchema } } }
+	},
+	responses: {
+		201: {
+			description: "External agent created successfully",
+			content: { "application/json": { schema: ExternalAgentResponse } }
+		},
+		...commonGetErrorResponses
+	}
+}), async (c) => {
+	const { tenantId, projectId } = c.req.valid("param");
+	const body = c.req.valid("json");
+	const externalAgentData = {
+		tenantId,
+		projectId,
+		id: body.id ? String(body.id) : generateId(),
+		name: body.name,
+		description: body.description,
+		baseUrl: body.baseUrl,
+		credentialReferenceId: body.credentialReferenceId || void 0
+	};
+	const agentWithType = {
+		...await createExternalAgent(dbClient_default)(externalAgentData),
+		type: "external"
+	};
+	return c.json({ data: agentWithType }, 201);
+});
+app.openapi(createRoute({
+	method: "put",
+	path: "/{id}",
+	summary: "Update External Agent",
+	operationId: "update-external-agent",
+	tags: ["External Agents"],
+	request: {
+		params: TenantProjectIdParamsSchema,
+		body: { content: { "application/json": { schema: ExternalAgentApiUpdateSchema } } }
+	},
+	responses: {
+		200: {
+			description: "External agent updated successfully",
+			content: { "application/json": { schema: ExternalAgentResponse } }
+		},
+		...commonGetErrorResponses
+	}
+}), async (c) => {
+	const { tenantId, projectId, id } = c.req.valid("param");
+	const body = c.req.valid("json");
+	const updatedExternalAgent = await updateExternalAgent(dbClient_default)({
+		scopes: {
+			tenantId,
+			projectId
+		},
+		externalAgentId: id,
+		data: body
+	});
+	if (!updatedExternalAgent) throw createApiError({
+		code: "not_found",
+		message: "External agent not found"
+	});
+	const agentWithType = {
+		...updatedExternalAgent,
+		type: "external"
+	};
+	return c.json({ data: agentWithType });
+});
+app.openapi(createRoute({
+	method: "delete",
+	path: "/{id}",
+	summary: "Delete External Agent",
+	operationId: "delete-external-agent",
+	tags: ["External Agents"],
+	request: { params: TenantProjectIdParamsSchema },
+	responses: {
+		204: { description: "External agent deleted successfully" },
+		404: {
+			description: "External agent not found",
+			content: { "application/json": { schema: ErrorResponseSchema } }
+		}
+	}
+}), async (c) => {
+	const { tenantId, projectId, id } = c.req.valid("param");
+	if (!await deleteExternalAgent(dbClient_default)({
+		scopes: {
+			tenantId,
+			projectId
+		},
+		externalAgentId: id
+	})) throw createApiError({
+		code: "not_found",
+		message: "External agent not found"
+	});
+	return c.body(null, 204);
+});
+var externalAgents_default = app;
+
+//#endregion
+export { externalAgents_default as default };

package/dist/routes/functionTools.d.ts

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