@openforge-app/plugin-sdk 0.2.8 → 0.2.9

package/dist/frontend.d.ts

@@ -1,5 +1,5 @@
 import type { BrowserSurfaceCapture, BrowserDevToolsPanel, BrowserSurfaceFeedbackSelection, BrowserSurfaceVisualFeedback, BrowserSurfaceRegion, BrowserSurfaceErrorCode, BrowserSurfaceNavigationError, BrowserSurfacesAPI, GetOrCreateBrowserSurfaceRequest, TaskBrowserSurfaceController, TaskBrowserSurfaceState } from './browserSurfaces';
-import type { CommandDescriptor, CommandRegistry, CommandRegistration, CommandShortcutMetadata, ComposeTaskRequest, ComposeTaskResult, Disposable, FrontendBackendBridge, FrontendOpenForgeAPI, FrontendPlugin, FrontendPluginContext, FrontendSettingsRegistry, FrontendTaskPaneRegistry, FrontendInjectionPointRegistry, FrontendTaskStartRegistry, FrontendTaskUIRegistry, FrontendViewRegistry, InjectionPointLocation, NavigationAPI, OpenForgeContextChangeHandler, OpenForgeContextSnapshot, OpenForgeNavigationRequest, OpenForgeNavigationSnapshot, TaskLinkHandler, TaskLinkHandlerResult, TaskLinkOpenRequest, TaskLinksAPI, PluginIcon, PluginSidebarNavigationProps, PluginSidebarViewIdentity, PluginInjectionPointProps, PluginInjectionPointRegistration, PluginSettingsSectionProps, PluginSettingsSectionRegistration, PluginSettingsSectionScope, PluginStorageScope, PluginSvgIcon, PluginTaskPaneProps, PluginTaskPaneTabRegistration, PluginTaskUISectionProps, PluginTaskUISectionRegistration, PluginViewProps, PluginViewRegistration, TaskStartPrefixContext, TaskStartPrefixProviderRegistration, PtyBufferState, TerminalImageProtocol, TerminalViewSnapshot } from './types';
+import type { CommandDescriptor, CommandRegistry, CommandRegistration, CommandShortcutMetadata, ComposeTaskRequest, ComposeTaskResult, Disposable, FrontendBackendBridge, FrontendOpenForgeAPI, FrontendPlugin, FrontendPluginContext, FrontendSettingsRegistry, FrontendTaskPaneRegistry, FrontendInjectionPointRegistry, FrontendTaskStartRegistry, FrontendReviewUIRegistry, FrontendTaskUIRegistry, FrontendViewRegistry, InjectionPointLocation, NavigationAPI, OpenForgeContextChangeHandler, OpenForgeContextSnapshot, OpenForgeNavigationRequest, OpenForgeNavigationSnapshot, TaskLinkHandler, TaskLinkHandlerResult, TaskLinkOpenRequest, TaskLinksAPI, PluginIcon, PluginSidebarNavigationProps, PluginSidebarViewIdentity, PluginInjectionPointProps, PluginInjectionPointRegistration, PluginSettingsSectionProps, PluginSettingsSectionRegistration, PluginSettingsSectionScope, PluginStorageScope, PluginSvgIcon, PluginTaskPaneProps, PluginTaskPaneTabRegistration, PluginReviewRowActionProps, PluginReviewRowActionRegistration, PluginTaskUISectionProps, PluginTaskUISectionRegistration, PluginViewProps, PluginViewRegistration, TaskStartPrefixContext, TaskStartPrefixProviderRegistration, PtyBufferState, TerminalImageProtocol, TerminalViewSnapshot } from './types';
 export declare const OPENFORGE_FRONTEND_PLUGIN_MARKER = "__openforgeFrontendPlugin";
 export type MarkedFrontendPlugin<TPlugin extends FrontendPlugin = FrontendPlugin> = TPlugin & {
     readonly [OPENFORGE_FRONTEND_PLUGIN_MARKER]: true;
@@ -7,4 +7,4 @@ export type MarkedFrontendPlugin<TPlugin extends FrontendPlugin = FrontendPlugin
 export declare function defineFrontendPlugin<const TPlugin extends FrontendPlugin>(plugin: TPlugin): MarkedFrontendPlugin<TPlugin>;
 export { BrowserSurfaceError, isAllowedBrowserSurfaceUrl } from './browserSurfaces';
 export type { BrowserSurfaceCapture, BrowserDevToolsPanel, BrowserSurfaceFeedbackSelection, BrowserSurfaceVisualFeedback, BrowserSurfaceRegion, BrowserSurfaceErrorCode, BrowserSurfaceNavigationError, BrowserSurfacesAPI, GetOrCreateBrowserSurfaceRequest, TaskBrowserSurfaceController, TaskBrowserSurfaceState, };
-export type { CommandDescriptor, CommandRegistry, CommandRegistration, CommandShortcutMetadata, ComposeTaskRequest, ComposeTaskResult, Disposable, FrontendBackendBridge, FrontendOpenForgeAPI, FrontendPlugin, FrontendPluginContext, FrontendSettingsRegistry, FrontendTaskPaneRegistry, FrontendInjectionPointRegistry, FrontendTaskStartRegistry, FrontendTaskUIRegistry, FrontendViewRegistry, InjectionPointLocation, NavigationAPI, OpenForgeContextChangeHandler, OpenForgeContextSnapshot, OpenForgeNavigationRequest, OpenForgeNavigationSnapshot, TaskLinkHandler, TaskLinkHandlerResult, TaskLinkOpenRequest, TaskLinksAPI, PluginIcon, PluginSidebarNavigationProps, PluginSidebarViewIdentity, PluginInjectionPointProps, PluginInjectionPointRegistration, PluginSettingsSectionProps, PluginSettingsSectionRegistration, PluginSettingsSectionScope, PluginStorageScope, PluginSvgIcon, PluginTaskPaneProps, PluginTaskPaneTabRegistration, PluginTaskUISectionProps, PluginTaskUISectionRegistration, PluginViewProps, PluginViewRegistration, TaskStartPrefixContext, TaskStartPrefixProviderRegistration, PtyBufferState, TerminalImageProtocol, TerminalViewSnapshot, };
+export type { CommandDescriptor, CommandRegistry, CommandRegistration, CommandShortcutMetadata, ComposeTaskRequest, ComposeTaskResult, Disposable, FrontendBackendBridge, FrontendOpenForgeAPI, FrontendPlugin, FrontendPluginContext, FrontendSettingsRegistry, FrontendTaskPaneRegistry, FrontendInjectionPointRegistry, FrontendTaskStartRegistry, FrontendReviewUIRegistry, FrontendTaskUIRegistry, FrontendViewRegistry, InjectionPointLocation, NavigationAPI, OpenForgeContextChangeHandler, OpenForgeContextSnapshot, OpenForgeNavigationRequest, OpenForgeNavigationSnapshot, TaskLinkHandler, TaskLinkHandlerResult, TaskLinkOpenRequest, TaskLinksAPI, PluginIcon, PluginSidebarNavigationProps, PluginSidebarViewIdentity, PluginInjectionPointProps, PluginInjectionPointRegistration, PluginSettingsSectionProps, PluginSettingsSectionRegistration, PluginSettingsSectionScope, PluginStorageScope, PluginSvgIcon, PluginTaskPaneProps, PluginTaskPaneTabRegistration, PluginReviewRowActionProps, PluginReviewRowActionRegistration, PluginTaskUISectionProps, PluginTaskUISectionRegistration, PluginViewProps, PluginViewRegistration, TaskStartPrefixContext, TaskStartPrefixProviderRegistration, PtyBufferState, TerminalImageProtocol, TerminalViewSnapshot, };

package/dist/openforgePackageMetadataSchema.json

@@ -138,7 +138,8 @@
                     "browserSurfaces",
                     "taskLinks",
                     "appEnablement",
-                    "customSidebarNavigation"
+                    "customSidebarNavigation",
+                    "reviewUI"
                 ]
             }
         }

package/dist/testing/contracts.d.ts

@@ -1,9 +1,9 @@
 import type { BrowserSurfaceVisualFeedback } from '../browserSurfaces';
 import type { TestingOpenForgeRegistryFake } from './registryFake';
-import type { BackendMethodRegistration, BackendOpenForgeAPI, BackgroundServiceRegistration, CommandRegistration, CommandShortcutMetadata, ComposeTaskRequest, ConfigureStartPromptContributionRequest, CreateTaskRequest, FrontendOpenForgeAPI, InjectionPointLocation, JsonValue, NotificationRequest, OpenForgeNavigationRequest, OpenForgePackageMetadata, PluginSettingsSectionRegistration, PluginStorage, PluginTaskPaneTabRegistration, PluginTaskUISectionRegistration, PluginViewRegistration, ShellSpawnRequest, SendTaskFollowUpRequest, StartTaskImplementationRequest, TaskLinkOpenRequest, TaskStartPrefixContext, ExternalReadDirectoryRequest, ExternalReadFileRequest, ExternalReadTextFileChunksRequest, UserDataDirectoryRequest, UserDataFileRequest, UserDataFileWriteRequest } from '../types';
+import type { BackendMethodRegistration, BackendOpenForgeAPI, BackgroundServiceRegistration, CommandRegistration, CommandShortcutMetadata, ComposeTaskRequest, ConfigureStartPromptContributionRequest, CreateTaskRequest, FrontendOpenForgeAPI, InjectionPointLocation, JsonValue, NotificationRequest, OpenForgeNavigationRequest, OpenForgePackageMetadata, PluginSettingsSectionRegistration, PluginStorage, PluginTaskPaneTabRegistration, PluginReviewRowActionRegistration, PluginTaskUISectionRegistration, PluginViewRegistration, ShellSpawnRequest, SendTaskFollowUpRequest, StartTaskImplementationRequest, TaskLinkOpenRequest, TaskStartPrefixContext, ExternalReadDirectoryRequest, ExternalReadFileRequest, ExternalReadTextFileChunksRequest, UserDataDirectoryRequest, UserDataFileRequest, UserDataFileWriteRequest } from '../types';
 import type { Task } from '../domain';
 export type TestingRuntimeScope = 'global' | 'project' | 'task';
-export type TestingRuntimeKind = 'commands' | 'events' | 'views' | 'taskPane' | 'taskUI' | 'settings' | 'backend' | 'background';
+export type TestingRuntimeKind = 'commands' | 'events' | 'views' | 'taskPane' | 'taskUI' | 'reviewUI' | 'settings' | 'backend' | 'background';
 export type TestingMaybePromise<T> = T | Promise<T>;
 export type TestingCommandHandler = (payload?: unknown) => TestingMaybePromise<unknown>;
 export type TestingEventHandler = (payload: unknown) => void;
@@ -200,6 +200,7 @@ export type TestingEventListenerContribution = TestingContributionBase & {
 export type TestingViewContribution = TestingContributionBase & PluginViewRegistration;
 export type TestingTaskPaneTabContribution = TestingContributionBase & PluginTaskPaneTabRegistration;
 export type TestingTaskUISectionContribution = TestingContributionBase & PluginTaskUISectionRegistration;
+export type TestingReviewRowActionContribution = TestingContributionBase & PluginReviewRowActionRegistration;
 export type TestingSettingsSectionContribution = TestingContributionBase & PluginSettingsSectionRegistration;
 export type TestingBackendMethodContribution = TestingContributionBase & {
     registration: BackendMethodRegistration;
@@ -223,6 +224,7 @@ export interface TestingOpenForgeRegistrySnapshot {
     views: TestingViewContribution[];
     taskPaneTabs: TestingTaskPaneTabContribution[];
     taskUISections: TestingTaskUISectionContribution[];
+    reviewRowActions: TestingReviewRowActionContribution[];
     settingsSections: TestingSettingsSectionContribution[];
     commands: TestingCommandContribution[];
     eventListeners: TestingEventListenerContribution[];

package/dist/testing/frontendContributionFake.d.ts

@@ -1,14 +1,15 @@
 import { type TaskBrowserSurfaceState } from '../browserSurfaces.js';
 import type { FrontendOpenForgeAPI } from '../types';
 import { type TestingRegistryServices } from './support.js';
-import type { TestingInjectionPointContribution, TestingTaskStartPrefixProviderContribution, TestingSettingsSectionContribution, TestingTaskPaneTabContribution, TestingTaskUISectionContribution, TestingViewContribution } from './contracts';
-type TestingFrontendContributionApi = Pick<FrontendOpenForgeAPI, 'browserSurfaces' | 'taskLinks' | 'views' | 'taskUI' | 'taskPane' | 'settings' | 'backend' | 'injectionPoints' | 'taskStart'>;
+import type { TestingInjectionPointContribution, TestingTaskStartPrefixProviderContribution, TestingSettingsSectionContribution, TestingTaskPaneTabContribution, TestingReviewRowActionContribution, TestingTaskUISectionContribution, TestingViewContribution } from './contracts';
+type TestingFrontendContributionApi = Pick<FrontendOpenForgeAPI, 'browserSurfaces' | 'taskLinks' | 'views' | 'taskUI' | 'reviewUI' | 'taskPane' | 'settings' | 'backend' | 'injectionPoints' | 'taskStart'>;
 export declare class TestingFrontendContributionFake {
     private readonly services;
     private readonly invokeBackendMethod;
     private readonly views;
     private readonly taskPaneTabs;
     private readonly taskUISections;
+    private readonly reviewRowActions;
     private readonly settingsSections;
     private readonly injectionPoints;
     private readonly taskStartPrefixProviders;
@@ -22,6 +23,7 @@ export declare class TestingFrontendContributionFake {
         views: TestingViewContribution[];
         taskPaneTabs: TestingTaskPaneTabContribution[];
         taskUISections: TestingTaskUISectionContribution[];
+        reviewRowActions: TestingReviewRowActionContribution[];
         settingsSections: TestingSettingsSectionContribution[];
         injectionPoints: TestingInjectionPointContribution[];
         taskStartPrefixProviders: TestingTaskStartPrefixProviderContribution[];
@@ -29,6 +31,7 @@ export declare class TestingFrontendContributionFake {
     private registerView;
     private registerTaskPaneTab;
     private registerTaskUISection;
+    private registerReviewRowAction;
     private registerSettingsSection;
     private registerTaskStartPrefixProvider;
     private registerInjectionPoint;

package/dist/testing/frontendContributionFake.js

@@ -7,6 +7,7 @@ export class TestingFrontendContributionFake {
     views = new Map();
     taskPaneTabs = new Map();
     taskUISections = new Map();
+    reviewRowActions = new Map();
     settingsSections = new Map();
     injectionPoints = new Map();
     taskStartPrefixProviders = new Map();
@@ -60,6 +61,9 @@ export class TestingFrontendContributionFake {
                 registerTab: (registration) => this.registerTaskPaneTab(registration),
                 registerSection: (registration) => this.registerTaskUISection(registration),
             },
+            reviewUI: {
+                registerRowAction: (registration) => this.registerReviewRowAction(registration),
+            },
             taskPane: {
                 registerTab: (registration) => this.registerTaskPaneTab(registration),
             },
@@ -93,6 +97,7 @@ export class TestingFrontendContributionFake {
             views: Array.from(this.views.values()),
             taskPaneTabs: Array.from(this.taskPaneTabs.values()),
             taskUISections: Array.from(this.taskUISections.values()),
+            reviewRowActions: Array.from(this.reviewRowActions.values()),
             settingsSections: Array.from(this.settingsSections.values()),
             injectionPoints: Array.from(this.injectionPoints.values()),
             taskStartPrefixProviders: Array.from(this.taskStartPrefixProviders.values()).sort((left, right) => left.order - right.order || left.id.localeCompare(right.id)),
@@ -162,6 +167,23 @@ export class TestingFrontendContributionFake {
             this.services.claims.release('taskUI', qualifiedId);
         });
     }
+    registerReviewRowAction(registration) {
+        const qualifiedId = this.services.localQualifiedId('reviewUI', registration.id);
+        assertFunction('reviewUI', 'component', registration.component);
+        this.services.claims.claim('reviewUI', qualifiedId);
+        const contribution = {
+            ...registration,
+            id: registration.id.trim(),
+            qualifiedId,
+            pluginId: this.services.pluginId,
+            projectId: this.services.projectId,
+        };
+        this.reviewRowActions.set(qualifiedId, contribution);
+        return createDisposable(() => {
+            this.reviewRowActions.delete(qualifiedId);
+            this.services.claims.release('reviewUI', qualifiedId);
+        });
+    }
     registerSettingsSection(registration) {
         const qualifiedId = this.services.localQualifiedId('settings', registration.id);
         assertTitle('settings', registration.title);

package/dist/types.d.ts

@@ -1,6 +1,6 @@
 import type { Component } from 'svelte';
 import type { BrowserSurfacesAPI } from './browserSurfaces';
-import type { AgentSession, CommandInfo, FileContent, FileEntry, Project, ProjectAttention, Task, TaskWorkspaceInfo, WritableBoardStatus } from './domain';
+import type { AgentSession, CommandInfo, FileContent, FileEntry, Project, ProjectAttention, ReviewPullRequest, Task, TaskWorkspaceInfo, WritableBoardStatus } from './domain';
 export type SupportedOpenForgeApiVersion = 1;
 export declare const SUPPORTED_OPENFORGE_API_VERSIONS: readonly [1, ...1[]];
 export declare const OPENFORGE_PLUGIN_API_VERSION: SupportedOpenForgeApiVersion;
@@ -17,7 +17,7 @@ export interface ValidationError {
     path: string;
     message: string;
 }
-declare const OPENFORGE_PLUGIN_CAPABILITY_TYPE_MEMBERS: readonly ['commands', 'events', 'views', 'injectionPoints', 'taskPane', 'taskStart', 'settings', 'background', 'backend', 'storage', 'context', 'navigation', 'tasks', 'projects', 'fs', 'shell', 'notifications', 'attention', 'system.openUrl', 'system.writeClipboardText', 'config', 'projectConfig', 'browserSurfaces', 'taskLinks', 'appEnablement', 'customSidebarNavigation'];
+declare const OPENFORGE_PLUGIN_CAPABILITY_TYPE_MEMBERS: readonly ['commands', 'events', 'views', 'injectionPoints', 'taskPane', 'taskStart', 'settings', 'background', 'backend', 'storage', 'context', 'navigation', 'tasks', 'projects', 'fs', 'shell', 'notifications', 'attention', 'system.openUrl', 'system.writeClipboardText', 'config', 'projectConfig', 'browserSurfaces', 'taskLinks', 'appEnablement', 'customSidebarNavigation', 'reviewUI'];
 export type OpenForgePluginCapability = (typeof OPENFORGE_PLUGIN_CAPABILITY_TYPE_MEMBERS)[number];
 export interface OpenForgePackageMetadata {
     id: string;
@@ -280,9 +280,34 @@ export interface PluginSettingsSectionRegistration {
     scope?: PluginSettingsSectionScope;
     component: PluginComponentLoader<PluginSettingsSectionProps> | PluginComponent<PluginSettingsSectionProps>;
 }
+/**
+ * Props a review-row action receives. `pr` is the review-requested pull request whose row
+ * is being rendered, and `projectId` is the local project that owns its repo (null when the
+ * host surface has none for it). The same contribution renders once per row, so the host
+ * remounts it with a different `pr` rather than handing over the whole list.
+ */
+export interface PluginReviewRowActionProps extends Record<string, unknown> {
+    api: FrontendOpenForgeAPI;
+    context: OpenForgeContextSnapshot;
+    pr: ReviewPullRequest;
+    projectId: string | null;
+}
+export interface PluginReviewRowActionRegistration {
+    id: string;
+    order?: number;
+    component: PluginComponentLoader<PluginReviewRowActionProps> | PluginComponent<PluginReviewRowActionProps>;
+}
 export interface FrontendViewRegistry {
     register(registration: PluginViewRegistration): Disposable;
 }
+export interface FrontendReviewUIRegistry {
+    /**
+     * Contribute a control onto every review-requested pull-request row a host surface shows
+     * (today the attention overview). Rows are narrow and there is one per pull request, so
+     * keep the component to a chip or a single button and let it fetch its own state.
+     */
+    registerRowAction(registration: PluginReviewRowActionRegistration): Disposable;
+}
 export type InjectionPointLocation = 'createTaskPrompt' | 'agentSession' | 'backlogPrompt';
 export interface PluginInjectionPointProps extends Record<string, unknown> {
     api: FrontendOpenForgeAPI;
@@ -592,6 +617,7 @@ export interface FrontendOpenForgeAPI extends OpenForgeCommonAPI {
     navigation: NavigationAPI;
     views: FrontendViewRegistry;
     taskUI: FrontendTaskUIRegistry;
+    reviewUI: FrontendReviewUIRegistry;
     /** @deprecated Use `taskUI.registerTab(...)`. */
     taskPane: FrontendTaskPaneRegistry;
     settings: FrontendSettingsRegistry;

package/dist/types.js

@@ -37,6 +37,7 @@ const OPENFORGE_PLUGIN_CAPABILITY_TYPE_MEMBERS = [
     'taskLinks',
     'appEnablement',
     'customSidebarNavigation',
+    'reviewUI',
 ];
 function assertOpenForgePluginCapabilitiesMatchSchema() {
     const schemaCapabilities = packageMetadataSchemaData.properties.requires.items.enum;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openforge-app/plugin-sdk",
-  "version": "0.2.8",
+  "version": "0.2.9",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -87,28 +87,27 @@
   "publishConfig": {
     "access": "public"
   },
-  "scripts": {
-    "clean": "node -e \"import('node:fs').then(({ rmSync }) => rmSync('dist', { recursive: true, force: true }))\"",
-    "build": "pnpm run clean && tsc && pnpm run build:assets",
-    "build:assets": "node ./scripts/copy-package-assets.mjs",
-    "check:contract": "node ./scripts/check-published-contract.mjs",
-    "icons:generate": "node ./scripts/generate-file-type-icons.mjs",
-    "prepack": "pnpm run build",
-    "prepublishOnly": "pnpm run check:contract",
-    "test": "vitest run"
-  },
   "dependencies": {
-    "dompurify": "catalog:",
-    "marked": "catalog:"
+    "dompurify": "^3.4.13",
+    "marked": "^18.0.10"
   },
   "peerDependencies": {
     "svelte": "^5.0.0"
   },
   "devDependencies": {
-    "@types/node": "catalog:pinned",
-    "svelte": "catalog:pinned",
-    "typescript": "catalog:",
-    "vitest": "catalog:",
+    "@types/node": "26.2.0",
+    "svelte": "5.56.9",
+    "semver": "^7.8.5",
+    "typescript": "^7.0.2",
+    "vitest": "^4.1.11",
     "vscode-material-icons": "^0.1.1"
+  },
+  "scripts": {
+    "clean": "node -e \"import('node:fs').then(({ rmSync }) => rmSync('dist', { recursive: true, force: true }))\"",
+    "build": "pnpm run clean && tsc && pnpm run build:assets",
+    "build:assets": "node ./scripts/copy-package-assets.mjs",
+    "check:contract": "node ./scripts/check-published-contract.mjs",
+    "icons:generate": "node ./scripts/generate-file-type-icons.mjs",
+    "test": "vitest run"
   }
-}
+}