@openforge-app/plugin-sdk 0.1.0 → 0.2.3

package/dist/testing.d.ts

@@ -1,223 +1,3 @@
-import type { BackendMethodRegistration, BackendOpenForgeAPI, BackendPlugin, BackendPluginContext, BackgroundServiceRegistration, CommandRegistration, CommandShortcutMetadata, ConfigureStartPromptContributionRequest, CreateTaskRequest, Disposable, FrontendOpenForgeAPI, FrontendPlugin, FrontendPluginContext, JsonValue, NotificationRequest, OpenForgeNavigationRequest, OpenForgePackageMetadata, PluginSettingsSectionRegistration, PluginStorage, PluginTaskPaneTabRegistration, StartTaskImplementationRequest, PluginViewRegistration, SubscriptionSink } from './types';
-export type TestingRuntimeScope = 'global' | 'project' | 'task';
-export type TestingRuntimeKind = 'commands' | 'events' | 'views' | 'taskPane' | 'settings' | 'backend' | 'background';
-type MaybePromise<T> = T | Promise<T>;
-type CommandHandler = (payload?: unknown) => MaybePromise<unknown>;
-type EventHandler = (payload: unknown) => void;
-export interface TestingOpenForgeApiOptions {
-    pluginId?: string;
-    projectId?: string | null;
-    taskId?: string | null;
-    /** The active view key reported by `navigation.get().currentView`. Defaults to `'board'`. */
-    viewId?: string;
-    packageMetadata?: OpenForgePackageMetadata;
-    storage?: PluginStorage;
-}
-export interface TestingOpenForgeApiCalls {
-    commandInvocations: Array<{
-        id: string;
-        qualifiedId: string;
-        payload: unknown;
-    }>;
-    globalCommandInvocations: Array<{
-        qualifiedId: string;
-        payload: unknown;
-    }>;
-    backendInvocations: Array<{
-        method: string;
-        qualifiedId: string;
-        payload: unknown;
-    }>;
-    emittedEvents: Array<{
-        event: string;
-        qualifiedEvent: string;
-        payload: unknown;
-    }>;
-    emittedGlobalEvents: Array<{
-        qualifiedEvent: string;
-        payload: unknown;
-    }>;
-    openUrl: string[];
-    navigationRequests: OpenForgeNavigationRequest[];
-    notify: NotificationRequest[];
-    taskCreations: CreateTaskRequest[];
-    startPromptContributionConfigurations: ConfigureStartPromptContributionRequest[];
-    taskImplementationStarts: StartTaskImplementationRequest[];
-    taskSummaryUpdates: Array<{
-        taskId: string;
-        summary: string;
-    }>;
-    taskStatusUpdates: Array<{
-        taskId: string;
-        status: string;
-    }>;
-    configWrites: Array<{
-        key: string;
-        value: JsonValue;
-        projectId: string | null;
-    }>;
-    fsWrites: Array<{
-        projectId: string;
-        path: string;
-        content: string;
-    }>;
-    shellSpawns: Array<{
-        taskId: string;
-        cwd: string;
-        cols: number;
-        rows: number;
-        terminalIndex: number;
-    }>;
-    shellWrites: Array<{
-        taskId: string;
-        terminalIndex: number;
-        data: string;
-    }>;
-    shellResizes: Array<{
-        taskId: string;
-        terminalIndex: number;
-        cols: number;
-        rows: number;
-    }>;
-    shellKills: Array<{
-        taskId: string;
-        terminalIndex: number;
-    }>;
-    shellBuffers: Array<{
-        taskId: string;
-        terminalIndex: number;
-    }>;
-    storageGets: Array<{
-        scope: TestingRuntimeScope;
-        scopeId: string | null;
-        key: string;
-    }>;
-    storageSets: Array<{
-        scope: TestingRuntimeScope;
-        scopeId: string | null;
-        key: string;
-        value: JsonValue;
-    }>;
-    storageDeletes: Array<{
-        scope: TestingRuntimeScope;
-        scopeId: string | null;
-        key: string;
-    }>;
-}
-export interface TestingContributionBase {
-    id: string;
-    qualifiedId: string;
-    pluginId: string;
-    projectId: string | null;
-}
-export type TestingCommandContribution = TestingContributionBase & CommandRegistration & {
-    title: string;
-    icon?: string;
-    shortcut?: CommandShortcutMetadata;
-    handler: CommandHandler;
-};
-export type TestingEventListenerContribution = TestingContributionBase & {
-    handler: EventHandler;
-    global: boolean;
-};
-export type TestingViewContribution = TestingContributionBase & PluginViewRegistration;
-export type TestingTaskPaneTabContribution = TestingContributionBase & PluginTaskPaneTabRegistration;
-export type TestingSettingsSectionContribution = TestingContributionBase & PluginSettingsSectionRegistration;
-export type TestingBackendMethodContribution = TestingContributionBase & {
-    registration: BackendMethodRegistration;
-};
-export type TestingBackgroundServiceContribution = TestingContributionBase & BackgroundServiceRegistration & {
-    started: boolean;
-};
-export interface TestingOpenForgeRegistrySnapshot {
-    pluginId: string;
-    projectId: string | null;
-    views: TestingViewContribution[];
-    taskPaneTabs: TestingTaskPaneTabContribution[];
-    settingsSections: TestingSettingsSectionContribution[];
-    commands: TestingCommandContribution[];
-    eventListeners: TestingEventListenerContribution[];
-    backendMethods: TestingBackendMethodContribution[];
-    backgroundServices: TestingBackgroundServiceContribution[];
-}
-export type MockFrontendOpenForgeAPI = FrontendOpenForgeAPI & {
-    readonly __testing: {
-        readonly calls: TestingOpenForgeApiCalls;
-        readonly registry: TestingOpenForgeRegistryFake;
-    };
-};
-export type MockBackendOpenForgeAPI = BackendOpenForgeAPI & {
-    readonly __testing: {
-        readonly calls: TestingOpenForgeApiCalls;
-        readonly registry: TestingOpenForgeRegistryFake;
-    };
-};
-export declare class TestingSubscriptionSink implements SubscriptionSink {
-    readonly subscriptions: Disposable[];
-    add(subscription: Disposable | (() => void)): void;
-    disposeAll(): Promise<void>;
-}
-export declare class TestingOpenForgeRegistryFake {
-    readonly pluginId: string;
-    readonly projectId: string | null;
-    readonly taskId: string | null;
-    readonly viewId: string;
-    readonly packageMetadata: OpenForgePackageMetadata;
-    readonly calls: TestingOpenForgeApiCalls;
-    readonly storage: PluginStorage;
-    readonly frontendSubscriptions: TestingSubscriptionSink;
-    readonly backendSubscriptions: TestingSubscriptionSink;
-    private readonly commands;
-    private readonly views;
-    private readonly taskPaneTabs;
-    private readonly settingsSections;
-    private readonly eventListeners;
-    private readonly eventHandlers;
-    private readonly backendMethods;
-    private readonly backgroundServices;
-    private readonly claimedIds;
-    private readonly config;
-    private eventListenerSequence;
-    private cachedFrontendApi;
-    private cachedBackendApi;
-    constructor(options?: TestingOpenForgeApiOptions);
-    get frontendApi(): MockFrontendOpenForgeAPI;
-    get backendApi(): MockBackendOpenForgeAPI;
-    get snapshot(): TestingOpenForgeRegistrySnapshot;
-    createFrontendApi(): MockFrontendOpenForgeAPI;
-    createBackendApi(): MockBackendOpenForgeAPI;
-    createFrontendContext(): FrontendPluginContext;
-    createBackendContext(): BackendPluginContext;
-    activateFrontend(plugin: FrontendPlugin): Promise<void>;
-    activateBackend(plugin: BackendPlugin): Promise<void>;
-    disposeAll(): Promise<void>;
-    getSnapshot(): TestingOpenForgeRegistrySnapshot;
-    private createContext;
-    private startPromptContributions;
-    private createCommonApi;
-    private getContextSnapshot;
-    private getNavigationSnapshot;
-    private localQualifiedId;
-    private claim;
-    private release;
-    private registerCommand;
-    private registerView;
-    private registerTaskPaneTab;
-    private registerSettingsSection;
-    private registerBackendMethod;
-    private registerBackgroundService;
-    private registerEventListener;
-    private startBackgroundServices;
-    private invokeCommand;
-    private invokeGlobalCommand;
-    private invokeBackend;
-    private emitEvent;
-}
-export declare function createOpenForgeRegistryFake(options?: TestingOpenForgeApiOptions): TestingOpenForgeRegistryFake;
-export declare function createMockOpenForgeApi(options?: TestingOpenForgeApiOptions): MockFrontendOpenForgeAPI;
-export declare function createMockFrontendOpenForgeApi(options?: TestingOpenForgeApiOptions): MockFrontendOpenForgeAPI;
-export declare function createMockBackendOpenForgeApi(options?: TestingOpenForgeApiOptions): MockBackendOpenForgeAPI;
-export declare function createMockPluginContext(options?: TestingOpenForgeApiOptions): FrontendPluginContext;
-export declare function createMemoryPluginStorage(calls?: TestingOpenForgeApiCalls): PluginStorage;
-export declare function createTestingCalls(): TestingOpenForgeApiCalls;
-export {};
+export { createMockBackendOpenForgeApi, createMockFrontendOpenForgeApi, createMockOpenForgeApi, createMockPluginContext, createOpenForgeRegistryFake, TestingOpenForgeRegistryFake, } from './testing/registryFake';
+export { createMemoryPluginStorage, createTestingCalls, TestingSubscriptionSink, } from './testing/support';
+export type { MockBackendOpenForgeAPI, MockFrontendOpenForgeAPI, TestingBackgroundServiceContribution, TestingBackendMethodContribution, TestingCommandContribution, TestingContributionBase, TestingEventListenerContribution, TestingInjectionPointContribution, TestingOpenForgeApiCalls, TestingOpenForgeApiOptions, TestingOpenForgeRegistrySnapshot, TestingRuntimeKind, TestingRuntimeScope, TestingSettingsSectionContribution, TestingTaskPaneTabContribution, TestingTaskUISectionContribution, TestingViewContribution, } from './testing/contracts';