@get-bb/plugin-sdk 0.4.108 → 0.5.8

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

@@ -7,7 +7,7 @@
 
 import { ReactNode, ComponentType } from 'react';
 import { RenderResult } from '@testing-library/react';
-import { ExperimentalSidebarFooterItemRegistration, PluginProviderIconRegistration, PluginHomepageSectionRegistration, PluginSettingsSectionRegistration, ExperimentalAppOverlayRegistration, PluginNavPanelRegistration, PluginThreadPanelActionRegistration, PluginNewThreadPanelActionRegistration, ComposerCustomization, PluginPendingInteractionRegistration, PluginSidebarFooterActionRegistration, ExperimentalSidebarNavigationRegistration, PluginThreadListRegistration, PluginThreadHeaderActionRegistration, ExperimentalPluginBrowserToolbarActionRegistration, PluginFileOpenerRegistration, PluginSourceCodeRendererRegistration, PluginDiffRendererRegistration, PluginMessageDirectiveRegistration, PluginMessageActionRegistration, ExperimentalIconRegistration, PluginTimelineRendererRegistration, PluginEnvironmentProviderInputsRegistration, PluginMachineProviderInputsRegistration, PluginContentScriptRegistration, PluginComposerScope, PluginComposerTextEffect, PluginComposerMention, ExperimentalComposerSubmitOptions, ExperimentalComposerSelection, PluginComposerThreadRowStatus, ExperimentalOpenFixedTabOptions, JsonValue, BbNavigate, ExperimentalFileOpenOptions, PluginAppDefinition, PluginRpcContract, StandardSchemaV1InferInput, PluginRpcResult, PluginRealtimeConnectionState, PluginSidebarThreadsState, PluginProvidersState, PluginCodeThemeState, BranchesState, CheckoutState, PluginSidebarPullRequest, PluginSidebarThreadActions } from '@get-bb/plugin-sdk';
+import { ExperimentalSidebarFooterItemRegistration, PluginProviderIconRegistration, PluginHomepageSectionRegistration, PluginSettingsSectionRegistration, ExperimentalAppOverlayRegistration, PluginNavPanelRegistration, PluginThreadPanelActionRegistration, PluginNewThreadPanelActionRegistration, ComposerCustomization, PluginPendingInteractionRegistration, PluginSidebarFooterActionRegistration, ExperimentalSidebarNavigationRegistration, PluginThreadListRegistration, PluginThreadHeaderActionRegistration, ExperimentalPluginBrowserToolbarActionRegistration, PluginFileOpenerRegistration, PluginSourceCodeRendererRegistration, PluginDiffRendererRegistration, PluginMessageDirectiveRegistration, PluginMessageActionRegistration, ExperimentalIconRegistration, PluginTimelineRendererRegistration, PluginEnvironmentProviderInputsRegistration, PluginMachineProviderInputsRegistration, PluginContentScriptRegistration, PluginComposerScope, PluginComposerTextEffect, PluginComposerMention, ExperimentalComposerSubmitOptions, ExperimentalComposerSelection, PluginComposerThreadRowStatus, ExperimentalOpenFixedTabOptions, JsonValue, BbNavigate, ExperimentalFileOpenOptions, PluginAppDefinition, PluginRpcContract, StandardSchemaV1InferInput, PluginRpcResult, PluginBrowserBbSdk, PluginRealtimeConnectionState, PluginSidebarThreadsState, PluginProvidersState, PluginCodeThemeState, BranchesState, CheckoutState, PluginSidebarPullRequest, PluginSidebarThreadRowStatus, PluginSidebarThreadShortcut, PluginSidebarSplitLayout, PluginEnvironmentProvidersState, PluginSidebarThreadActions } from '@get-bb/plugin-sdk';
 
 type ExperimentalSidebarFooterCommandKind = "close" | "open" | "toggle";
 interface ExperimentalSidebarFooterRuntimeSnapshot {
@@ -56,6 +56,21 @@ interface RpcCall {
     method: string;
     input: unknown;
 }
+/** One recorded `useSdk()` call, as `"<area>.<method>"` plus its arguments. */
+interface SdkCall {
+    method: string;
+    args: unknown[];
+}
+type PluginSdkFakeTree<T> = {
+    [Key in keyof T]?: T[Key] extends (...args: never[]) => unknown ? T[Key] : PluginSdkFakeTree<T[Key]>;
+};
+/**
+ * Nested partial fakes for `useSdk()`, mirroring the client's areas and
+ * sub-areas (`{ threads: { queuedMessages: { create } } }`). Provide only the
+ * methods the slot calls; a call to anything else throws with the missing
+ * dot-path so the test fails loudly instead of returning undefined.
+ */
+type PluginSdkTestFakes = PluginSdkFakeTree<PluginBrowserBbSdk>;
 type NavigateCall = {
     method: "toThread";
     threadId: string;
@@ -260,6 +275,35 @@ interface RenderSlotOptions<Contract extends PluginRpcContract = PluginRpcContra
      * by thread id. Omitted → every thread reports none.
      */
     sidebarPullRequests?: Record<string, PluginSidebarPullRequest>;
+    /**
+     * Thread ids `useSidebarThreadDraft()` and `useSidebarThreadDraftIds()`
+     * report as holding an unsent draft. Omitted → none.
+     */
+    sidebarDraftThreadIds?: readonly string[];
+    /**
+     * Row statuses `useSidebarThreadRowStatus()` reports, keyed by thread id.
+     * Omitted → every thread reports null.
+     */
+    sidebarRowStatuses?: Record<string, PluginSidebarThreadRowStatus>;
+    /**
+     * Shortcuts `useSidebarThreadShortcut()` reports, keyed by thread id, as
+     * if the app command modifier were held. Omitted → every thread reports
+     * null.
+     */
+    sidebarShortcuts?: Record<string, PluginSidebarThreadShortcut>;
+    /** The split layout `useSidebarSplitLayout()` reports. Omitted → null. */
+    sidebarSplitLayout?: PluginSidebarSplitLayout;
+    /**
+     * The environment provider catalog `useEnvironmentProviders()` reports.
+     * Omitted → a ready, empty list. Pass `{ status: "loading" }` to test that
+     * branch.
+     */
+    environmentProviders?: Partial<PluginEnvironmentProvidersState>;
+    /**
+     * Fakes for `useSdk()`, one partial object per area. Calls are recorded
+     * in `inspection.sdkCalls`; a call to a method you did not provide throws.
+     */
+    sdk?: PluginSdkTestFakes;
     /** Host acceptance for `useBbNavigate().openThreadPanel`. */
     openThreadPanel?: (options: Parameters<BbNavigate["openThreadPanel"]>[0]) => boolean;
     /** Host acceptance for URL intents from the hook or `UrlLink`. */
@@ -301,6 +345,8 @@ interface RenderedSlotInspectionState {
     readonly experimental_fixedTabOpenCalls: ExperimentalFixedTabOpenCall[];
     /** Every `experimental_useSidebarThreadActions()` call, in order. */
     readonly sidebarActionCalls: SidebarActionCall[];
+    /** Every `useSdk()` call, in order, as `"<area>.<method>"`. */
+    readonly sdkCalls: SdkCall[];
     /** Everything written through `useComposer()`. */
     readonly composer: ComposerLog;
 }
@@ -323,4 +369,4 @@ declare function renderSlot<Props extends object, Contract extends PluginRpcCont
 }, props: Props, options?: RenderSlotOptions<Contract>): RenderedSlot;
 
 export { installTestPluginRuntime, loadPluginApp, mountPluginContentScripts, renderSlot };
-export type { CapturedPluginApp, ComposerLog, ContentScriptTestMountOptions, ContentScriptThreadRowStatusCall, ExperimentalFixedTabOpenCall, MountedPluginContentScripts, NavigateCall, PluginAppSource, PluginRpcTestHandlers, RenderSlotOptions, RenderedSlot, RenderedSlotBehaviorDrivers, RenderedSlotInspectionState, RenderedSlotLifecycleControls, RpcCall, SidebarActionCall };
+export type { CapturedPluginApp, ComposerLog, ContentScriptTestMountOptions, ContentScriptThreadRowStatusCall, ExperimentalFixedTabOpenCall, MountedPluginContentScripts, NavigateCall, PluginAppSource, PluginRpcTestHandlers, PluginSdkTestFakes, RenderSlotOptions, RenderedSlot, RenderedSlotBehaviorDrivers, RenderedSlotInspectionState, RenderedSlotLifecycleControls, RpcCall, SdkCall, SidebarActionCall };