@get-bb/plugin-sdk 0.4.88 → 0.4.97

package/bundled-types/bb-plugin-sdk-testing.d.ts

@@ -5,7 +5,7 @@
 // Confused by the API, or need a symbol that isn't here? Clone the BB repo
 // and read the real source: https://github.com/get-bb/bb
 
-import { StandardSchemaV1 as StandardSchemaV1$1, StandardSchemaV1InferOutput, PluginMachineValidateDecision, JsonValue as JsonValue$2, PluginEnvironmentProviderRequirements as PluginEnvironmentProviderRequirements$1, PluginEnvironmentValidateDecision, BbPluginApi, PluginSettingValue as PluginSettingValue$1, PluginSharedPortTunnelIdentity, PluginAgentToolPresentation, PluginAgentToolContext, PluginAgentToolResult, PluginCliCommandInfo, PluginCliContext, PluginCliResult, PluginHttpAuthMode, PluginHttpHandler, PluginMentionTrigger, PluginMentionSearchContext, PluginMentionItem, PluginCliExecutionResult, PluginThreadEventName, PluginThreadEventPayloads, PluginAgentConfigurationContext, ExperimentalPluginProviderEnvContext, ExperimentalPluginProviderEnvEntry, ExperimentalPluginProviderEnvHealthContext, ExperimentalPluginProviderEnvHealth, PluginSettingDescriptors, ExperimentalPluginWebSocketHandler, PluginAgentConfiguration, PluginHookName, PluginHookHandler, PluginAiServiceDeclaration, PluginInteractionRequest, MessageDispatchHookContext } from '@get-bb/plugin-sdk';
+import { StandardSchemaV1 as StandardSchemaV1$1, StandardSchemaV1InferOutput, PluginMachineValidateDecision, JsonValue as JsonValue$2, PluginEnvironmentProviderRequirements as PluginEnvironmentProviderRequirements$1, PluginEnvironmentValidateDecision, BbPluginApi, PluginSettingValue as PluginSettingValue$1, PluginSharedPortTunnelIdentity, PluginAgentToolPresentation, PluginAgentToolContext, PluginAgentToolResult, PluginCliCommandInfo, PluginCliContext, PluginCliResult, PluginHttpAuthMode, PluginHttpHandler, PluginMentionTrigger, PluginMentionSearchContext, PluginMentionItem, PluginMentionProviderRegistration, PluginCliExecutionResult, PluginThreadEventName, PluginThreadEventPayloads, PluginAgentConfigurationContext, ExperimentalPluginProviderEnvContext, ExperimentalPluginProviderEnvEntry, ExperimentalPluginProviderEnvHealthContext, ExperimentalPluginProviderEnvHealth, PluginSettingDescriptors, ExperimentalPluginWebSocketHandler, PluginAgentConfiguration, PluginHookName, PluginHookHandler, PluginAiServiceDeclaration, PluginInteractionRequest, MessageDispatchHookContext } from '@get-bb/plugin-sdk';
 import { z } from 'zod';
 
 type PluginMachineProviderResource = Exclude<JsonValue$2, null>;
@@ -77,7 +77,9 @@ interface PluginMachineProviderDefinition<S extends PluginMachineProviderInputsS
         report: PluginMachineProviderProgress;
         signal: AbortSignal;
     }): Promise<PluginMachineProviderRemoveResult>;
+    /** Idempotent: preserve saved state when compute is already stopped; save and stop any remaining compute, including during reconciliation of a suspended machine. */
     suspend?(context: PluginMachineProviderResourceLifecycleContext): Promise<PluginMachineProviderResourceResult>;
+    /** Idempotent: reuse existing running compute instead of allocating a duplicate. */
     resume?(context: PluginMachineProviderResourceLifecycleContext): Promise<PluginMachineProviderResourceResult>;
     remove(context: PluginMachineProviderRemoveContext): Promise<PluginMachineProviderRemoveResult>;
 }
@@ -468,6 +470,14 @@ interface StandardSchemaV1<Input = unknown, Output = Input> {
         readonly version: 1;
         readonly vendor: string;
         readonly validate: (value: unknown) => StandardSchemaV1Result<Output> | Promise<StandardSchemaV1Result<Output>>;
+        readonly jsonSchema?: {
+            readonly input: (options: {
+                target: string;
+            }) => Record<string, unknown>;
+            readonly output: (options: {
+                target: string;
+            }) => Record<string, unknown>;
+        };
         readonly types?: {
             readonly input: Input;
             readonly output: Output;
@@ -486,6 +496,11 @@ interface StandardSchemaV1Issue {
         readonly key: PropertyKey;
     })[];
 }
+interface PluginRpcMethodContract<InputSchema extends StandardSchemaV1 = StandardSchemaV1, OutputSchema extends StandardSchemaV1 = StandardSchemaV1> {
+    readonly experimental_description?: string;
+    readonly input: InputSchema;
+    readonly output: OutputSchema;
+}
 
 type PluginSettingValue = string | number | boolean;
 /**
@@ -688,6 +703,8 @@ interface PluginProviderOptionsContext {
 }
 /** See {@link PluginProviderDeclaration.models}. */
 type PluginProviderModelCatalogScope = "host" | "workspace";
+/** See {@link PluginProviderDeclaration.completedTurnDisplay}. */
+type PluginProviderCompletedTurnDisplay = "collapse" | "flat";
 /**
  * One cold-cache fallback model. The provider's live `model/list` result is
  * the only real model source; this list stands in only while no probe has
@@ -794,6 +811,16 @@ interface PluginProviderDeclaration {
     /** Composer actions this provider supports. No duplicates; may be empty
      * (the universal skills typeahead is implicit). */
     composerActions: readonly PluginProviderComposerAction[];
+    /**
+     * How the thread timeline shows this provider's turns once they finish.
+     * `"collapse"` (the default) folds a finished turn's work into one
+     * "Worked for" row and leaves the final answer visible. `"flat"` keeps
+     * every row of a finished turn visible, as it was while the turn ran. This
+     * is only the provider's default: the user can choose either display for
+     * each provider in Settings → Providers or with
+     * `bb settings completed-turns`, and that choice wins.
+     */
+    completedTurnDisplay?: PluginProviderCompletedTurnDisplay;
     /** Provider copy for core surfaces ({@link PluginProviderStrings}). */
     strings?: PluginProviderStrings;
     /** Service tiers this provider accepts, as picker options. Non-empty when
@@ -907,6 +934,7 @@ type NormalizedPluginProviderDeclaration = Omit<PluginProviderDeclaration, "expe
     readonly experimental_nativeSkillRoots?: ProviderNativeRoots;
     readonly experimental_nativeCommandRoots?: ProviderNativeRoots;
     readonly experimental_resolvesNativeRoots: boolean;
+    readonly completedTurnDisplay: PluginProviderCompletedTurnDisplay;
     readonly maintenance: {
         readonly health: boolean;
         readonly usage: boolean;
@@ -917,6 +945,17 @@ type NormalizedPluginProviderDeclaration = Omit<PluginProviderDeclaration, "expe
         readonly scope: PluginProviderModelCatalogScope;
     };
 };
+declare function readRpcPublicationOptions(value: unknown): {
+    experimental_discoverable: boolean;
+    experimental_description: string | null;
+};
+declare function publishRpcMethod(method: string, contract: PluginRpcMethodContract, options: ReturnType<typeof readRpcPublicationOptions>): {
+    method: string;
+    registrationDescription: string | null;
+    methodDescription: string | null;
+    inputSchema: Record<string, JsonValue$1>;
+    outputSchema: Record<string, JsonValue$1>;
+} | null;
 declare const ENVIRONMENT_PROVIDER_REQUIREMENT_NAMES: readonly ["projectCheckout", "gitCheckout", "gitRemote", "projectless"];
 type NormalizedPluginEnvironmentProviderRequirements = {
     [K in (typeof ENVIRONMENT_PROVIDER_REQUIREMENT_NAMES)[number]]: boolean;
@@ -1107,11 +1146,7 @@ interface FakeMentionProviderRecord {
     label: string;
     triggers: readonly PluginMentionTrigger[];
     search: (ctx: PluginMentionSearchContext) => PluginMentionItem[] | Promise<PluginMentionItem[]>;
-    resolve: (itemId: string) => {
-        context: string;
-    } | Promise<{
-        context: string;
-    }>;
+    resolve: PluginMentionProviderRegistration["resolve"];
 }
 interface FakeRealtimeSignal {
     channel: string;
@@ -1129,6 +1164,7 @@ interface FakePluginRegistrations {
     settingsDescriptors: PluginSettingDescriptors;
     httpRoutes: FakeHttpRouteRecord[];
     websocketRoutes: ExperimentalFakeWebSocketRouteRecord[];
+    experimental_publishedRpcMethods: Array<NonNullable<ReturnType<typeof publishRpcMethod>>>;
     rpcMethods: string[];
     services: FakeServiceRecord[];
     schedules: FakeScheduleRecord[];