@sortedyuan/maybecode 0.3.2 → 0.5.0

package/dist/settings.d.ts

@@ -0,0 +1,718 @@
+import { type MayConfig } from "@sortedyuan/may/config";
+import type { RunBudget } from "@sortedyuan/may/core";
+import type { PluginModuleSelection } from "@sortedyuan/may/plugin";
+import type { MaybeCodeSubagentSettings } from "@sortedyuan/coordination/delegation/configuration";
+import type { CodingExecutionIsolation, FetchToolOptions } from "@sortedyuan/coding-tools";
+export declare const MAYBECODE_APPLICATION_ID = "maybecode";
+export interface MaybeCodeGitSettings {
+    readonly autoCommit?: boolean;
+    readonly readOnly?: boolean;
+    readonly dataRoot?: string;
+    readonly worktreesRoot?: string;
+    readonly excludedPaths?: readonly string[];
+}
+export interface MaybeCodeMcpHostSettings {
+    readonly roots?: boolean;
+    readonly sampling?: boolean;
+    readonly legacyRequests?: "isolated";
+}
+interface MaybeCodeMcpServerBaseSettings {
+    readonly enabled?: boolean;
+    readonly required?: boolean;
+    readonly protocolMode?: "legacy" | "auto";
+    readonly host?: MaybeCodeMcpHostSettings;
+    readonly tasks?: boolean;
+    readonly requestTimeoutMs?: number;
+    readonly maxTotalTimeoutMs?: number;
+}
+export interface MaybeCodeMcpStdioServerSettings extends MaybeCodeMcpServerBaseSettings {
+    readonly transport?: "stdio";
+    readonly command?: string;
+    readonly args?: readonly string[];
+    readonly cwd?: string;
+    readonly env?: Readonly<Record<string, string>>;
+    readonly maxBufferSize?: number;
+    readonly stderrMaxBytes?: number;
+}
+export interface MaybeCodeMcpOAuthSettings {
+    readonly type: "oauth";
+    readonly account?: string;
+    readonly clientId?: string;
+    readonly expectedIssuer?: string;
+    readonly clientMetadataUrl?: string;
+    readonly scopes?: readonly string[];
+    readonly authorizationOrigins?: readonly string[];
+    readonly callbackPort?: number;
+}
+export interface MaybeCodeMcpHttpServerSettings extends MaybeCodeMcpServerBaseSettings {
+    readonly transport: "streamable-http";
+    readonly url?: string;
+    readonly headers?: Readonly<Record<string, string>>;
+    readonly auth?: MaybeCodeMcpOAuthSettings;
+}
+export type MaybeCodeMcpServerSettings = MaybeCodeMcpStdioServerSettings | MaybeCodeMcpHttpServerSettings;
+export interface MaybeCodeObservabilitySettings {
+    readonly enabled?: boolean;
+    readonly exporter?: "file";
+    readonly file?: string;
+    readonly samplingRatio?: number;
+    readonly retentionDays?: number;
+    readonly batch?: {
+        readonly maxQueueSize?: number;
+        readonly maxExportBatchSize?: number;
+        readonly scheduledDelayMs?: number;
+    };
+}
+export interface MaybeCodeRetrySettings {
+    readonly maxAttempts?: number;
+    readonly baseDelayMs?: number;
+    readonly maxDelayMs?: number;
+    readonly jitterRatio?: number;
+}
+/** The `apps.maybecode` entry of a May configuration file, validated against `config-schema.json`. */
+export interface MaybeCodeSettings {
+    readonly execution?: CodingExecutionIsolation;
+    readonly fetch?: FetchToolOptions;
+    readonly requestRecording?: "off" | "required";
+    readonly providerBodyRecording?: boolean;
+    readonly git?: false | MaybeCodeGitSettings;
+    readonly plugins?: readonly PluginModuleSelection[];
+    readonly permissionMode?: "default" | "yolo";
+    readonly persistentRules?: boolean;
+    readonly delegationNotifications?: boolean;
+    readonly instructionsDirectory?: string;
+    readonly skills?: false | {
+        readonly directories?: readonly string[];
+    };
+    readonly runBudget?: RunBudget;
+    readonly subagents?: false | MaybeCodeSubagentSettings;
+    readonly autoCompaction?: {
+        readonly mode?: "prune-summary" | "history-reference" | "provider-native";
+    };
+    readonly retry?: false | MaybeCodeRetrySettings;
+    readonly observability?: false | MaybeCodeObservabilitySettings;
+    readonly mcpServers?: false | Readonly<Record<string, MaybeCodeMcpServerSettings>>;
+}
+export declare const maybeCodeConfigSection: {
+    type: string;
+    description: string;
+    properties: {
+        execution: {
+            default: {
+                mode: string;
+            };
+            oneOf: ({
+                type: string;
+                properties: {
+                    mode: {
+                        const: string;
+                    };
+                    image?: never;
+                    network?: never;
+                    memoryBytes?: never;
+                    cpuCount?: never;
+                };
+                required: string[];
+                additionalProperties: boolean;
+            } | {
+                type: string;
+                properties: {
+                    mode: {
+                        const: string;
+                    };
+                    image: {
+                        $ref: string;
+                    };
+                    network: {
+                        const: string;
+                    };
+                    memoryBytes: {
+                        $ref: string;
+                    };
+                    cpuCount: {
+                        type: string;
+                        exclusiveMinimum: number;
+                    };
+                };
+                required: string[];
+                additionalProperties: boolean;
+            })[];
+        };
+        fetch: {
+            type: string;
+            properties: {
+                allowedOrigins: {
+                    type: string;
+                    uniqueItems: boolean;
+                    items: {
+                        type: string;
+                        pattern: string;
+                    };
+                };
+                maxBytes: {
+                    $ref: string;
+                };
+                timeoutMs: {
+                    $ref: string;
+                };
+                maxRedirects: {
+                    type: string;
+                    minimum: number;
+                };
+            };
+            additionalProperties: boolean;
+        };
+        requestRecording: {
+            enum: string[];
+            default: string;
+        };
+        providerBodyRecording: {
+            type: string;
+            default: boolean;
+        };
+        git: {
+            oneOf: ({
+                const: boolean;
+                type?: never;
+                properties?: never;
+                additionalProperties?: never;
+            } | {
+                const?: never;
+                type: string;
+                properties: {
+                    autoCommit: {
+                        type: string;
+                        default: boolean;
+                    };
+                    readOnly: {
+                        type: string;
+                        default: boolean;
+                    };
+                    dataRoot: {
+                        $ref: string;
+                    };
+                    worktreesRoot: {
+                        $ref: string;
+                    };
+                    excludedPaths: {
+                        type: string;
+                        items: {
+                            $ref: string;
+                        };
+                    };
+                };
+                additionalProperties: boolean;
+            })[];
+        };
+        plugins: {
+            $ref: string;
+        };
+        permissionMode: {
+            enum: string[];
+            default: string;
+            description: string;
+        };
+        persistentRules: {
+            type: string;
+            default: boolean;
+            description: string;
+        };
+        delegationNotifications: {
+            type: string;
+            default: boolean;
+            description: string;
+        };
+        instructionsDirectory: {
+            $ref: string;
+        };
+        skills: {
+            oneOf: ({
+                type?: never;
+                properties?: never;
+                additionalProperties?: never;
+                const: boolean;
+            } | {
+                const?: never;
+                type: string;
+                properties: {
+                    directories: {
+                        type: string;
+                        maxItems: number;
+                        items: {
+                            $ref: string;
+                        };
+                    };
+                };
+                additionalProperties: boolean;
+            })[];
+        };
+        runBudget: {
+            $ref: string;
+        };
+        subagents: {
+            oneOf: ({
+                type?: never;
+                properties?: never;
+                additionalProperties?: never;
+                const: boolean;
+            } | {
+                const?: never;
+                type: string;
+                properties: {
+                    enabled: {
+                        type: string;
+                        default: boolean;
+                        description: string;
+                    };
+                    roles: {
+                        type: string;
+                        minProperties: number;
+                        maxProperties: number;
+                        propertyNames: {
+                            $ref: string;
+                        };
+                        additionalProperties: {
+                            $ref: string;
+                        };
+                    };
+                    defaultRole: {
+                        $ref: string;
+                    };
+                    limits: {
+                        type: string;
+                        properties: {
+                            maxConcurrent: {
+                                type: string;
+                                minimum: number;
+                                maximum: number;
+                                default: number;
+                            };
+                            maxTasks: {
+                                type: string;
+                                minimum: number;
+                                maximum: number;
+                                default: number;
+                            };
+                            maxDepth: {
+                                type: string;
+                                minimum: number;
+                                maximum: number;
+                                default: number;
+                            };
+                            maxTaskTurns: {
+                                type: string;
+                                minimum: number;
+                                maximum: number;
+                                default: number;
+                            };
+                            maxDurationMs: {
+                                type: string;
+                                minimum: number;
+                                maximum: number;
+                                default: number;
+                            };
+                            maxInputBytes: {
+                                type: string;
+                                minimum: number;
+                                maximum: number;
+                                default: number;
+                            };
+                            maxOutputBytes: {
+                                type: string;
+                                minimum: number;
+                                maximum: number;
+                                default: number;
+                            };
+                        };
+                        additionalProperties: boolean;
+                    };
+                    runBudget: {
+                        $ref: string;
+                        description: string;
+                    };
+                    maxModelCalls: {
+                        type: string;
+                        minimum: number;
+                        maximum: number;
+                        default: number;
+                        description: string;
+                    };
+                    maxTotalTokens: {
+                        $ref: string;
+                        description: string;
+                    };
+                    reservationTokens: {
+                        type: string;
+                        minimum: number;
+                        maximum: number;
+                        default: number;
+                    };
+                };
+                additionalProperties: boolean;
+            })[];
+        };
+        autoCompaction: {
+            type: string;
+            properties: {
+                mode: {
+                    enum: string[];
+                    default: string;
+                };
+            };
+            additionalProperties: boolean;
+        };
+        retry: {
+            oneOf: ({
+                type?: never;
+                properties?: never;
+                additionalProperties?: never;
+                const: boolean;
+            } | {
+                const?: never;
+                type: string;
+                properties: {
+                    maxAttempts: {
+                        $ref: string;
+                    };
+                    baseDelayMs: {
+                        type: string;
+                        minimum: number;
+                    };
+                    maxDelayMs: {
+                        type: string;
+                        minimum: number;
+                    };
+                    jitterRatio: {
+                        type: string;
+                        minimum: number;
+                        maximum: number;
+                    };
+                };
+                additionalProperties: boolean;
+            })[];
+        };
+        observability: {
+            oneOf: ({
+                type?: never;
+                properties?: never;
+                additionalProperties?: never;
+                const: boolean;
+            } | {
+                const?: never;
+                type: string;
+                properties: {
+                    enabled: {
+                        type: string;
+                        default: boolean;
+                    };
+                    exporter: {
+                        const: string;
+                        default: string;
+                    };
+                    file: {
+                        $ref: string;
+                    };
+                    samplingRatio: {
+                        type: string;
+                        minimum: number;
+                        maximum: number;
+                    };
+                    retentionDays: {
+                        $ref: string;
+                        default: number;
+                    };
+                    batch: {
+                        type: string;
+                        properties: {
+                            maxQueueSize: {
+                                $ref: string;
+                            };
+                            maxExportBatchSize: {
+                                $ref: string;
+                            };
+                            scheduledDelayMs: {
+                                type: string;
+                                minimum: number;
+                            };
+                        };
+                        additionalProperties: boolean;
+                    };
+                };
+                additionalProperties: boolean;
+            })[];
+        };
+        mcpServers: {
+            oneOf: ({
+                type?: never;
+                additionalProperties?: never;
+                const: boolean;
+                propertyNames?: never;
+            } | {
+                const?: never;
+                type: string;
+                propertyNames: {
+                    pattern: string;
+                };
+                additionalProperties: {
+                    oneOf: {
+                        $ref: string;
+                    }[];
+                };
+            })[];
+        };
+    };
+    additionalProperties: boolean;
+    $defs: {
+        subagentIdentifier: {
+            type: string;
+            pattern: string;
+            not: {
+                enum: string[];
+            };
+        };
+        subagentRole: {
+            type: string;
+            properties: {
+                model: {
+                    $ref: string;
+                    description: string;
+                };
+                reasoningEffort: {
+                    type: string;
+                    pattern: string;
+                    maxLength: number;
+                };
+                instructions: {
+                    type: string;
+                    pattern: string;
+                    maxLength: number;
+                };
+                tools: {
+                    type: string;
+                    maxItems: number;
+                    uniqueItems: boolean;
+                    items: {
+                        enum: string[];
+                    };
+                };
+                delegateTo: {
+                    type: string;
+                    maxItems: number;
+                    uniqueItems: boolean;
+                    items: {
+                        $ref: string;
+                    };
+                };
+                runBudget: {
+                    $ref: string;
+                };
+            };
+            additionalProperties: boolean;
+        };
+        mcpStdioServer: {
+            type: string;
+            properties: {
+                enabled: {
+                    type: string;
+                    default: boolean;
+                };
+                required: {
+                    type: string;
+                    default: boolean;
+                };
+                transport: {
+                    const: string;
+                    default: string;
+                };
+                protocolMode: {
+                    enum: string[];
+                    default: string;
+                };
+                host: {
+                    $ref: string;
+                };
+                tasks: {
+                    type: string;
+                    default: boolean;
+                    description: string;
+                };
+                command: {
+                    $ref: string;
+                };
+                args: {
+                    type: string;
+                    items: {
+                        type: string;
+                    };
+                };
+                cwd: {
+                    $ref: string;
+                };
+                env: {
+                    type: string;
+                    propertyNames: {
+                        minLength: number;
+                    };
+                    additionalProperties: {
+                        type: string;
+                    };
+                };
+                requestTimeoutMs: {
+                    $ref: string;
+                };
+                maxTotalTimeoutMs: {
+                    $ref: string;
+                };
+                maxBufferSize: {
+                    $ref: string;
+                };
+                stderrMaxBytes: {
+                    $ref: string;
+                    default: number;
+                };
+            };
+            anyOf: ({
+                required: string[];
+                properties: {
+                    enabled: {
+                        const: boolean;
+                    };
+                };
+            } | {
+                properties?: never;
+                required: string[];
+            })[];
+            additionalProperties: boolean;
+        };
+        mcpHttpServer: {
+            type: string;
+            required: string[];
+            properties: {
+                enabled: {
+                    type: string;
+                    default: boolean;
+                };
+                required: {
+                    type: string;
+                    default: boolean;
+                };
+                transport: {
+                    const: string;
+                };
+                url: {
+                    $ref: string;
+                    description: string;
+                };
+                headers: {
+                    type: string;
+                    propertyNames: {
+                        minLength: number;
+                    };
+                    additionalProperties: {
+                        type: string;
+                    };
+                };
+                auth: {
+                    $ref: string;
+                };
+                protocolMode: {
+                    enum: string[];
+                    default: string;
+                };
+                host: {
+                    $ref: string;
+                };
+                tasks: {
+                    type: string;
+                    default: boolean;
+                    description: string;
+                };
+                requestTimeoutMs: {
+                    $ref: string;
+                };
+                maxTotalTimeoutMs: {
+                    $ref: string;
+                };
+            };
+            anyOf: ({
+                required: string[];
+                properties: {
+                    enabled: {
+                        const: boolean;
+                    };
+                };
+            } | {
+                properties?: never;
+                required: string[];
+            })[];
+            additionalProperties: boolean;
+        };
+        mcpHostOptions: {
+            type: string;
+            description: string;
+            properties: {
+                roots: {
+                    type: string;
+                    default: boolean;
+                };
+                sampling: {
+                    type: string;
+                    default: boolean;
+                };
+                legacyRequests: {
+                    const: string;
+                    description: string;
+                };
+            };
+            additionalProperties: boolean;
+        };
+        mcpOAuthOptions: {
+            type: string;
+            required: string[];
+            properties: {
+                type: {
+                    const: string;
+                };
+                account: {
+                    $ref: string;
+                };
+                clientId: {
+                    $ref: string;
+                };
+                expectedIssuer: {
+                    $ref: string;
+                };
+                clientMetadataUrl: {
+                    $ref: string;
+                };
+                scopes: {
+                    type: string;
+                    items: {
+                        $ref: string;
+                    };
+                };
+                authorizationOrigins: {
+                    type: string;
+                    items: {
+                        $ref: string;
+                    };
+                };
+                callbackPort: {
+                    type: string;
+                    minimum: number;
+                    maximum: number;
+                };
+            };
+            dependentRequired: {
+                clientId: string[];
+            };
+            not: {
+                required: string[];
+            };
+            additionalProperties: boolean;
+        };
+    };
+};
+export declare function readMaybeCodeSettings(config: MayConfig): MaybeCodeSettings;
+export {};
+//# sourceMappingURL=settings.d.ts.map