1
>
/*---------------------------------------------------------------------------------------------
agentHostSchema.ts
2
>
* Copyright (c) Microsoft Corporation. All rights reserved.
3
>
* Licensed under the MIT License. See License.txt in the project root for license information.
4
>
*--------------------------------------------------------------------------------------------*/
5
>
6
>
import { localize } from '../../../nls.js';
7
>
import { structuralEquals } from '../../../base/common/equals.js';
8
>
import { ConfigurationTarget, type IConfigurationService, type IConfigurationValue } from '../../configuration/common/configuration.js';
9
>
import type { IMcpServerConfiguration } from '../../mcp/common/mcpPlatformTypes.js';
10
>
import { TelemetryConfiguration, TelemetryLevel } from '../../telemetry/common/telemetry.js';
11
>
import { SessionConfigKey } from './sessionConfigKeys.js';
12
>
import type { SessionConfigPropertySchema, SessionConfigSchema } from './state/protocol/commands.js';
13
>
import { JsonRpcErrorCodes, ProtocolError } from './state/sessionProtocol.js';
14
>
15
>
// ---- Schema builder --------------------------------------------------------
16
>
17
>
/**
18
>
* A schema property with a phantom TypeScript type and a precomputed
19
>
* runtime validator.
20
>
*
21
>
* The `<T>` type parameter is the developer's assertion about the
22
>
* property's runtime shape; the validator derived from `protocol`
23
>
* (`type`, `enum`, `items`, `properties`, `required`) enforces it at
24
>
* runtime.
25
>
*/
26
>
export interface ISchemaProperty<T> {
27
>
readonly protocol: SessionConfigPropertySchema;
28
>
/**
29
>
* Returns `true` iff `value` conforms to {@link protocol}. Narrows
30
>
* the type to `T` for callers. The boolean form is preferred for
31
>
* control flow; use {@link assertValid} when you want a descriptive
32
>
* error for the offending path.
33
>
*/
34
>
validate(value: unknown): value is T;
35
>
/**
36
>
* Throws a {@link ProtocolError} with `JsonRpcErrorCodes.InvalidParams`
37
>
* describing the offending path (e.g. `'permissions.allow[2]'`) when
38
>
* `value` does not conform to {@link protocol}. Otherwise returns and
39
>
* narrows the type to `T`.
40
>
*
41
>
* @param path Dotted path prefix to embed in error messages. Defaults
42
>
* to empty (the value itself).
43
>
*/
44
>
assertValid(value: unknown, path?: string): asserts value is T;
45
>
}
46
>
47
>
/**
48
>
* Defines a strongly-typed schema property whose runtime validator is
49
>
* derived from the supplied JSON-schema descriptor.
50
>
*/
51
>
export function schemaProperty<T>(protocol: SessionConfigPropertySchema): ISchemaProperty<T> {
52
>
const assertFn = buildAssert(protocol);
53
>
const assertValid = (value: unknown, path: string = ''): asserts value is T => assertFn(value, path);
54
>
const validate = (value: unknown): value is T => {
55
try {
56
assertFn(value, '');