@byfriends/sdk 0.3.0 → 0.3.1

package/dist/index.d.mts

@@ -65,9 +65,6 @@ declare interface AgentAPI {
     setPermission: (payload: SetPermissionPayload) => void;
     setModel: (payload: SetModelPayload) => SetModelResult;
     getModel: (payload: EmptyPayload) => string;
-    enterPlan: (payload: EmptyPayload) => void;
-    cancelPlan: (payload: CancelPlanPayload) => void;
-    clearPlan: (payload: EmptyPayload) => void;
     beginCompaction: (payload: BeginCompactionPayload) => void;
     cancelCompaction: (payload: EmptyPayload) => void;
     registerTool: (payload: RegisterToolPayload) => void;
@@ -81,7 +78,6 @@ declare interface AgentAPI {
     getContext: (payload: EmptyPayload) => AgentContextData;
     getConfig: (payload: EmptyPayload) => AgentConfigData;
     getPermission: (payload: EmptyPayload) => PermissionData;
-    getPlan: (payload: EmptyPayload) => PlanData;
     getUsage: (payload: EmptyPayload) => UsageStatus;
     getTools: (payload: EmptyPayload) => readonly ToolInfo[];
     getBackground: (payload: GetBackgroundPayload) => readonly BackgroundTaskInfo[];
@@ -178,15 +174,6 @@ declare interface AgentRecordEvents {
     };
     'permission.record_approval_result': PermissionApprovalResultRecord;
     'full_compaction.begin': CompactionBeginData;
-    'plan_mode.enter': {
-        id: string;
-    };
-    'plan_mode.cancel': {
-        id?: string;
-    };
-    'plan_mode.exit': {
-        id?: string;
-    };
     'tools.register_user_tool': UserToolRegistration;
     'tools.unregister_user_tool': {
         name: string;
@@ -260,9 +247,6 @@ declare class AgentRecords {
 export declare type AgentReplayRecord = {
     type: 'message';
     message: ContextMessage;
-} | {
-    type: 'plan_updated';
-    enabled: boolean;
 } | {
     type: 'config_updated';
     config: AgentConfigUpdateData;
@@ -1149,8 +1133,8 @@ declare const ByfConfigPatchSchema: z.ZodObject<{
     defaultThinking: z.ZodOptional<z.ZodBoolean>;
     defaultPermissionMode: z.ZodOptional<z.ZodEnum<{
         auto: "auto";
-        yolo: "yolo";
         manual: "manual";
+        yolo: "yolo";
     }>>;
     permission: z.ZodOptional<z.ZodObject<{
         rules: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodObject<{
@@ -1190,19 +1174,19 @@ declare const ByfConfigPatchSchema: z.ZodObject<{
         timeout: z.ZodOptional<z.ZodNumber>;
     }, z.core.$strict>>>;
     services: z.ZodOptional<z.ZodObject<{
-        byfSearch: z.ZodOptional<z.ZodObject<{
-            baseUrl: z.ZodOptional<z.ZodOptional<z.ZodString>>;
-            apiKey: z.ZodOptional<z.ZodOptional<z.ZodString>>;
-            oauth: z.ZodOptional<z.ZodOptional<z.ZodObject<{
-                storage: z.ZodEnum<{
-                    file: "file";
-                    keyring: "keyring";
+        webSearch: z.ZodOptional<z.ZodObject<{
+            providers: z.ZodArray<z.ZodObject<{
+                type: z.ZodEnum<{
+                    exa: "exa";
+                    brave: "brave";
+                    firecrawl: "firecrawl";
                 }>;
-                key: z.ZodString;
-            }, z.core.$strip>>>;
-            customHeaders: z.ZodOptional<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>;
+                apiKeys: z.ZodArray<z.ZodString>;
+                baseUrl: z.ZodOptional<z.ZodString>;
+                priority: z.ZodNumber;
+            }, z.core.$strip>>;
         }, z.core.$strip>>;
-        byfFetch: z.ZodOptional<z.ZodObject<{
+        fetchUrl: z.ZodOptional<z.ZodObject<{
             baseUrl: z.ZodOptional<z.ZodOptional<z.ZodString>>;
             apiKey: z.ZodOptional<z.ZodOptional<z.ZodString>>;
             oauth: z.ZodOptional<z.ZodOptional<z.ZodObject<{
@@ -1287,8 +1271,8 @@ declare const ByfConfigSchema: z.ZodObject<{
     defaultThinking: z.ZodOptional<z.ZodBoolean>;
     defaultPermissionMode: z.ZodOptional<z.ZodEnum<{
         auto: "auto";
-        yolo: "yolo";
         manual: "manual";
+        yolo: "yolo";
     }>>;
     permission: z.ZodOptional<z.ZodObject<{
         rules: z.ZodOptional<z.ZodArray<z.ZodObject<{
@@ -1328,19 +1312,19 @@ declare const ByfConfigSchema: z.ZodObject<{
         timeout: z.ZodOptional<z.ZodNumber>;
     }, z.core.$strict>>>;
     services: z.ZodOptional<z.ZodObject<{
-        byfSearch: z.ZodOptional<z.ZodObject<{
-            baseUrl: z.ZodOptional<z.ZodString>;
-            apiKey: z.ZodOptional<z.ZodString>;
-            oauth: z.ZodOptional<z.ZodObject<{
-                storage: z.ZodEnum<{
-                    file: "file";
-                    keyring: "keyring";
+        webSearch: z.ZodOptional<z.ZodObject<{
+            providers: z.ZodArray<z.ZodObject<{
+                type: z.ZodEnum<{
+                    exa: "exa";
+                    brave: "brave";
+                    firecrawl: "firecrawl";
                 }>;
-                key: z.ZodString;
+                apiKeys: z.ZodArray<z.ZodString>;
+                baseUrl: z.ZodOptional<z.ZodString>;
+                priority: z.ZodNumber;
             }, z.core.$strip>>;
-            customHeaders: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
         }, z.core.$strip>>;
-        byfFetch: z.ZodOptional<z.ZodObject<{
+        fetchUrl: z.ZodOptional<z.ZodObject<{
             baseUrl: z.ZodOptional<z.ZodString>;
             apiKey: z.ZodOptional<z.ZodString>;
             oauth: z.ZodOptional<z.ZodObject<{
@@ -1406,9 +1390,6 @@ declare class ByfCore implements PromisableMethods<CoreAPI> {
     setThinking({ sessionId, ...payload }: SessionAgentPayload<SetThinkingPayload>): void | Promise<void>;
     setPermission({ sessionId, ...payload }: SessionAgentPayload<SetPermissionPayload>): void | Promise<void>;
     getModel({ sessionId, ...payload }: SessionAgentPayload<EmptyPayload>): string | Promise<string>;
-    enterPlan({ sessionId, ...payload }: SessionAgentPayload<EmptyPayload>): void | Promise<void>;
-    cancelPlan({ sessionId, ...payload }: SessionAgentPayload<CancelPlanPayload>): void | Promise<void>;
-    clearPlan({ sessionId, ...payload }: SessionAgentPayload<EmptyPayload>): void | Promise<void>;
     beginCompaction({ sessionId, ...payload }: SessionAgentPayload<BeginCompactionPayload>): void | Promise<void>;
     cancelCompaction({ sessionId, ...payload }: SessionAgentPayload<EmptyPayload>): void | Promise<void>;
     registerTool({ sessionId, ...payload }: SessionAgentPayload<RegisterToolPayload>): void | Promise<void>;
@@ -1422,7 +1403,6 @@ declare class ByfCore implements PromisableMethods<CoreAPI> {
     getContext({ sessionId, ...payload }: SessionAgentPayload<EmptyPayload>): AgentContextData | Promise<AgentContextData>;
     getConfig({ sessionId, ...payload }: SessionAgentPayload<EmptyPayload>): AgentConfigData | Promise<AgentConfigData>;
     getPermission({ sessionId, ...payload }: SessionAgentPayload<EmptyPayload>): PermissionData | Promise<PermissionData>;
-    getPlan({ sessionId, ...payload }: SessionAgentPayload<EmptyPayload>): Promise<null> | null;
     getUsage({ sessionId, ...payload }: SessionAgentPayload<EmptyPayload>): UsageStatus | Promise<UsageStatus>;
     getTools({ sessionId, ...payload }: SessionAgentPayload<EmptyPayload>): readonly ToolInfo[] | Promise<readonly ToolInfo[]>;
     getBackground({ sessionId, ...payload }: SessionAgentPayload<GetBackgroundPayload>): readonly BackgroundTaskInfo[] | Promise<readonly BackgroundTaskInfo[]>;
@@ -1514,7 +1494,7 @@ export declare class ByfHarness {
     get sessions(): ReadonlyMap<string, Session>;
     get interactiveAgentId(): string;
     set interactiveAgentId(agentId: string);
-    track(event: string, properties?: Record<string, unknown>): void;
+    track(_event: string, _properties?: Record<string, unknown>): void;
     createSession(options: CreateSessionOptions): Promise<Session>;
     resumeSession(input: ResumeSessionInput): Promise<Session>;
     forkSession(input: ForkSessionInput): Promise<Session>;
@@ -1527,6 +1507,7 @@ export declare class ByfHarness {
     ensureConfigFile(): Promise<void>;
     setConfig(patch: ByfConfigPatch): Promise<ByfConfig>;
     removeProvider(providerId: string): Promise<ByfConfig>;
+    updateConfig(input?: UpdateConfigInput): Promise<UpdateConfigResult>;
     shellExec(command: string, options?: {
         cwd?: string;
         timeout?: number;
@@ -1539,6 +1520,7 @@ export declare interface ByfHarnessOptions {
     readonly identity?: HostIdentity | undefined;
     readonly homeDir?: string | undefined;
     readonly configPath?: string | undefined;
+    readonly runtime?: RuntimeConfig | undefined;
     readonly autoLoadConfig?: boolean | undefined;
     readonly uiMode?: string;
     readonly skillDirs?: readonly string[];
@@ -1621,10 +1603,6 @@ declare interface CancelPayload {
     readonly turnId?: number;
 }
 
-declare interface CancelPlanPayload {
-    readonly id?: string;
-}
-
 /** Top-level catalog: `{ [providerId]: ProviderEntry }` (e.g. models.dev/api.json). */
 export declare type Catalog = Record<string, CatalogProviderEntry>;
 
@@ -2210,6 +2188,28 @@ export declare function fetchModelsByType(type: string, baseUrl: string, apiKey:
  */
 export declare function findCatalogModel(catalog: Catalog, modelId: string): CatalogModel | undefined;
 
+/**
+ * Update-rules for `byf update-config`.
+ *
+ * Each rule corresponds to a deprecated / renamed / migrated field that
+ * `analyzeConfig` can detect in `config.raw` and (where applicable) that
+ * `applyFixes` can clean up.
+ *
+ * **Principles** (from PRD-0013 grill decisions):
+ * - G2 — Whitelist approach: only fields explicitly registered here are removed.
+ * - Every rule carries a `deprecatedSince` version annotation so the report
+ *   tells the user *when* the field became obsolete.
+ */
+export declare interface Finding {
+    kind: 'removed' | 'renamed' | 'migrated' | 'dangling' | 'unknown' | 'invalid-value';
+    /** TOML dotted path, e.g. `'services.byf_search'`, `'loop_control.max_steps_per_run'`. */
+    path: string;
+    /** Human-readable description of what was found and what will happen. */
+    detail: string;
+    /** Version when this field was deprecated (optional — may be unknown for very old fields). */
+    deprecatedSince?: string;
+}
+
 /**
  * Normalized finish-reason signal indicating why a generation stopped.
  *
@@ -3531,15 +3531,6 @@ declare type PermissionRuleDecision = 'allow' | 'deny' | 'ask';
  */
 declare type PermissionRuleScope = 'turn-override' | 'session-runtime' | 'project' | 'user';
 
-declare type PlanData = null;
-
-export declare interface PlanInfo {
-    readonly id: string;
-    readonly exists: boolean;
-    readonly content: string;
-    readonly path: string;
-}
-
 declare type PreparedSystemPromptContext = Pick<SystemPromptContext, 'cwd' | 'agentsMd'>;
 
 declare interface PrepareToolExecutionResult {
@@ -3959,7 +3950,6 @@ export declare interface ResumedAgentState {
     readonly context: AgentContextData;
     readonly replay: readonly AgentReplayRecord[];
     readonly permission: PermissionData;
-    readonly plan: PlanData;
     readonly usage: UsageStatus;
     readonly tools: readonly ToolInfo[];
     readonly toolStore?: Readonly<Record<string, unknown>>;
@@ -4097,8 +4087,6 @@ declare class SDKRpcClient {
     setModel(input: SetSessionModelRpcInput): Promise<SetSessionModelRpcResult>;
     setThinking(input: SetSessionThinkingRpcInput): Promise<void>;
     setPermission(input: SetSessionPermissionRpcInput): Promise<void>;
-    getPlan(input: SessionIdRpcInput): Promise<SessionPlan>;
-    clearPlan(input: SessionIdRpcInput): Promise<void>;
     compact(input: SessionIdRpcInput & CompactOptions): Promise<void>;
     cancelCompaction(input: SessionIdRpcInput): Promise<void>;
     getUsage(input: SessionIdRpcInput): Promise<SessionUsage>;
@@ -4145,6 +4133,7 @@ declare interface SDKRpcClientOptions {
     readonly homeDir?: string | undefined;
     readonly configPath?: string | undefined;
     readonly skillDirs?: readonly string[];
+    readonly runtime?: RuntimeConfig | undefined;
 }
 
 declare type SDKSessionAPI = WithAgentId<SDKAgentAPI>;
@@ -4158,19 +4147,19 @@ declare interface ServicesConfig_2 {
 }
 
 declare const ServicesConfigSchema: z.ZodObject<{
-    byfSearch: z.ZodOptional<z.ZodObject<{
-        baseUrl: z.ZodOptional<z.ZodString>;
-        apiKey: z.ZodOptional<z.ZodString>;
-        oauth: z.ZodOptional<z.ZodObject<{
-            storage: z.ZodEnum<{
-                file: "file";
-                keyring: "keyring";
+    webSearch: z.ZodOptional<z.ZodObject<{
+        providers: z.ZodArray<z.ZodObject<{
+            type: z.ZodEnum<{
+                exa: "exa";
+                brave: "brave";
+                firecrawl: "firecrawl";
             }>;
-            key: z.ZodString;
+            apiKeys: z.ZodArray<z.ZodString>;
+            baseUrl: z.ZodOptional<z.ZodString>;
+            priority: z.ZodNumber;
         }, z.core.$strip>>;
-        customHeaders: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
     }, z.core.$strip>>;
-    byfFetch: z.ZodOptional<z.ZodObject<{
+    fetchUrl: z.ZodOptional<z.ZodObject<{
         baseUrl: z.ZodOptional<z.ZodString>;
         apiKey: z.ZodOptional<z.ZodString>;
         oauth: z.ZodOptional<z.ZodObject<{
@@ -4208,8 +4197,6 @@ export declare class Session {
     setModel(model: string): Promise<void>;
     setThinking(level: string): Promise<void>;
     setPermission(mode: PermissionMode): Promise<void>;
-    getPlan(): Promise<SessionPlan>;
-    clearPlan(): Promise<void>;
     compact(options?: CompactOptions): Promise<void>;
     cancelCompaction(): Promise<void>;
     getUsage(): Promise<SessionUsage>;
@@ -4385,8 +4372,6 @@ declare interface SessionOptions {
     readonly onClose?: (() => void | Promise<void>) | undefined;
 }
 
-export declare type SessionPlan = PlanInfo | null;
-
 declare interface SessionPromptRpcInput {
     readonly sessionId: string;
     readonly input: PromptInput;
@@ -5304,6 +5289,17 @@ declare interface UnregisterToolPayload {
 
 export declare type Unsubscribe = () => void;
 
+export declare interface UpdateConfigInput {
+    readonly fix?: boolean;
+    readonly configPath?: string;
+}
+
+export declare interface UpdateConfigResult {
+    readonly findings: readonly Finding[];
+    readonly fixed: boolean;
+    readonly backupPath?: string;
+}
+
 declare interface UpdateSessionMetadataPayload {
     readonly metadata: SessionMetadataPatch;
 }