mirror of
https://github.com/openclaw/openclaw.git
synced 2026-07-24 04:41:14 +00:00
76796d7c69
* refactor(gateway): share closed TypeBox objects * fix(gateway): remove unused TypeBox import
58 lines
2.6 KiB
TypeScript
58 lines
2.6 KiB
TypeScript
import type { Static } from "typebox";
|
|
// Gateway Protocol schema module defines protocol validation shapes.
|
|
import { Type } from "typebox";
|
|
import { closedObject } from "./closed-object.js";
|
|
import { NonEmptyString } from "./primitives.js";
|
|
|
|
/**
|
|
* Plugin approval schemas.
|
|
*
|
|
* These payloads cross from plugin/tool execution into reviewer-facing UI, so
|
|
* title, description, decision set, and timeout limits are part of the public
|
|
* gateway contract.
|
|
*/
|
|
const MAX_PLUGIN_APPROVAL_TIMEOUT_MS = 600_000;
|
|
const PLUGIN_APPROVAL_TITLE_MAX_LENGTH = 80;
|
|
const PLUGIN_APPROVAL_DESCRIPTION_MAX_LENGTH = 512;
|
|
|
|
/** Approval request raised by a plugin before a sensitive tool action proceeds. */
|
|
export const PluginApprovalRequestParamsSchema = closedObject({
|
|
pluginId: Type.Optional(NonEmptyString),
|
|
title: Type.String({ minLength: 1, maxLength: PLUGIN_APPROVAL_TITLE_MAX_LENGTH }),
|
|
description: Type.String({ minLength: 1, maxLength: PLUGIN_APPROVAL_DESCRIPTION_MAX_LENGTH }),
|
|
severity: Type.Optional(Type.String({ enum: ["info", "warning", "critical"] })),
|
|
toolName: Type.Optional(Type.String()),
|
|
toolCallId: Type.Optional(Type.String()),
|
|
allowedDecisions: Type.Optional(
|
|
Type.Array(Type.String({ enum: ["allow-once", "allow-always", "deny"] }), {
|
|
minItems: 1,
|
|
maxItems: 3,
|
|
}),
|
|
),
|
|
agentId: Type.Optional(Type.String()),
|
|
sessionKey: Type.Optional(Type.String()),
|
|
approvalReviewerDeviceIds: Type.Optional(
|
|
Type.Array(NonEmptyString, {
|
|
description:
|
|
"Trusted approval-runtime metadata naming operator devices that may review this approval; ordinary Gateway clients may send the field, but the Gateway only binds it for internal approval-runtime requests.",
|
|
}),
|
|
),
|
|
turnSourceChannel: Type.Optional(Type.String()),
|
|
turnSourceTo: Type.Optional(Type.String()),
|
|
turnSourceAccountId: Type.Optional(Type.String()),
|
|
turnSourceThreadId: Type.Optional(Type.Union([Type.String(), Type.Number()])),
|
|
timeoutMs: Type.Optional(Type.Integer({ minimum: 1, maximum: MAX_PLUGIN_APPROVAL_TIMEOUT_MS })),
|
|
twoPhase: Type.Optional(Type.Boolean()),
|
|
});
|
|
|
|
/** Reviewer decision payload resolving one pending plugin approval request. */
|
|
export const PluginApprovalResolveParamsSchema = closedObject({
|
|
id: NonEmptyString,
|
|
decision: NonEmptyString,
|
|
});
|
|
|
|
// Owner-local wire types derived directly from local schema consts so the
|
|
// public plugin-sdk declaration graph never pulls in the ProtocolSchemas registry.
|
|
export type PluginApprovalRequestParams = Static<typeof PluginApprovalRequestParamsSchema>;
|
|
export type PluginApprovalResolveParams = Static<typeof PluginApprovalResolveParamsSchema>;
|