@stina/extension-api 0.20.0 → 0.22.0

package/dist/{types.tools-DgCozsOW.d.ts → types.tools-BXGZf8zc.d.ts}

@@ -334,6 +334,26 @@ interface ModalProps extends ExtensionComponentData {
     /** Action to call when the modal is closed. */
     onCloseAction?: ExtensionActionRef;
 }
+/**
+ * The extension API properties for the ConditionalGroup component.
+ * Renders children only when the condition evaluates to true.
+ */
+interface ConditionalGroupProps extends ExtensionComponentData {
+    component: 'ConditionalGroup';
+    /**
+     * Condition expression to evaluate.
+     * Supports:
+     * - Comparison: ==, !=
+     * - Logical: && (and), || (or)
+     * - Values: $references, 'strings', numbers, true, false, null
+     *
+     * @example "$form.provider == 'imap'"
+     * @example "$form.provider == 'gmail' || $form.provider == 'outlook'"
+     */
+    condition: string;
+    /** Children to render when condition is true. */
+    children: ExtensionComponentChildren;
+}
 
 /**
  * Contribution Types
@@ -887,6 +907,8 @@ interface ExtensionContext {
     readonly database?: DatabaseAPI;
     /** Local storage (if permitted) */
     readonly storage?: StorageAPI;
+    /** Background workers (if permitted) */
+    readonly backgroundWorkers?: BackgroundWorkersAPI;
     /** Logging (always available) */
     readonly log: LogAPI;
 }
@@ -1157,6 +1179,191 @@ interface ExtensionModule {
      */
     deactivate?(): void | Promise<void>;
 }
+/**
+ * Restart policy for background tasks.
+ * Controls how tasks are restarted after failures.
+ */
+interface BackgroundRestartPolicy {
+    /**
+     * When to restart the task:
+     * - 'always': Always restart, regardless of exit reason
+     * - 'on-failure': Only restart if the task threw an error
+     * - 'never': Never restart automatically
+     */
+    type: 'always' | 'on-failure' | 'never';
+    /**
+     * Maximum number of restarts before giving up.
+     * 0 means unlimited restarts.
+     * @default 0
+     */
+    maxRestarts?: number;
+    /**
+     * Initial delay in milliseconds before first restart.
+     * @default 1000
+     */
+    initialDelayMs?: number;
+    /**
+     * Maximum delay in milliseconds between restarts.
+     * @default 60000
+     */
+    maxDelayMs?: number;
+    /**
+     * Multiplier for exponential backoff.
+     * @default 2
+     */
+    backoffMultiplier?: number;
+}
+/**
+ * Configuration for a background task.
+ */
+interface BackgroundTaskConfig {
+    /**
+     * Unique identifier for the task within the extension.
+     * Used to reference the task for stopping or checking status.
+     */
+    id: string;
+    /**
+     * Human-readable name for observability and logging.
+     */
+    name: string;
+    /**
+     * User ID that owns this task.
+     * Background tasks are always user-scoped.
+     */
+    userId: string;
+    /**
+     * Policy for restarting the task after failures.
+     */
+    restartPolicy: BackgroundRestartPolicy;
+    /**
+     * Optional payload data passed to the task callback.
+     */
+    payload?: Record<string, unknown>;
+}
+/**
+ * Context provided to background task callbacks.
+ * Extends ExecutionContext with task-specific functionality.
+ */
+interface BackgroundTaskContext extends ExecutionContext {
+    /**
+     * AbortSignal that is triggered when the task should stop.
+     * Check this signal regularly and exit gracefully when aborted.
+     */
+    readonly signal: AbortSignal;
+    /**
+     * Report the current health status of the task.
+     * Use this to provide observability into what the task is doing.
+     *
+     * @param status Human-readable status message
+     */
+    reportHealth(status: string): void;
+    /**
+     * Task-specific logging API.
+     * Messages are tagged with the task ID for easier debugging.
+     */
+    readonly log: LogAPI;
+}
+/**
+ * Callback function for background tasks.
+ * The function should run until the signal is aborted, then clean up and return.
+ *
+ * @example
+ * ```typescript
+ * const callback: BackgroundTaskCallback = async (ctx) => {
+ *   const connection = await createConnection()
+ *   try {
+ *     while (!ctx.signal.aborted) {
+ *       ctx.reportHealth('Waiting for messages...')
+ *       const message = await connection.receive({ signal: ctx.signal })
+ *       await processMessage(message)
+ *     }
+ *   } finally {
+ *     await connection.close()
+ *   }
+ * }
+ * ```
+ */
+type BackgroundTaskCallback = (context: BackgroundTaskContext) => Promise<void>;
+/**
+ * Health status of a background task.
+ */
+interface BackgroundTaskHealth {
+    /**
+     * Unique task identifier within the extension.
+     */
+    taskId: string;
+    /**
+     * Human-readable task name.
+     */
+    name: string;
+    /**
+     * User ID that owns this task.
+     */
+    userId: string;
+    /**
+     * Current task status.
+     */
+    status: 'pending' | 'running' | 'stopped' | 'failed' | 'restarting';
+    /**
+     * Number of times the task has been restarted.
+     */
+    restartCount: number;
+    /**
+     * Last health status message reported by the task.
+     */
+    lastHealthStatus?: string;
+    /**
+     * Timestamp of the last health report.
+     */
+    lastHealthTime?: string;
+    /**
+     * Error message if the task failed.
+     */
+    error?: string;
+}
+/**
+ * API for managing background workers.
+ * Background workers are long-running tasks that can be automatically restarted.
+ *
+ * @example
+ * ```typescript
+ * const task = await context.backgroundWorkers.start({
+ *   id: 'my-task',
+ *   name: 'My Background Task',
+ *   userId: 'user-123',
+ *   restartPolicy: { type: 'always', maxRestarts: 0 }
+ * }, async (ctx) => {
+ *   while (!ctx.signal.aborted) {
+ *     // Do work...
+ *   }
+ * })
+ *
+ * // Later, to stop the task:
+ * task.dispose()
+ * ```
+ */
+interface BackgroundWorkersAPI {
+    /**
+     * Start a new background task.
+     *
+     * @param config Task configuration
+     * @param callback Function to execute as the background task
+     * @returns Disposable that stops the task when disposed
+     */
+    start(config: BackgroundTaskConfig, callback: BackgroundTaskCallback): Promise<Disposable>;
+    /**
+     * Stop a running background task.
+     *
+     * @param taskId The task ID to stop
+     */
+    stop(taskId: string): Promise<void>;
+    /**
+     * Get the health status of all background tasks for this extension.
+     *
+     * @returns Array of task health statuses
+     */
+    getStatus(): Promise<BackgroundTaskHealth[]>;
+}
 
 /**
  * Tool and Action Types
@@ -1222,4 +1429,4 @@ interface ActionResult {
     error?: string;
 }
 
-export { type AIProvider as $, type ActionResult as A, type ExtensionContext as B, type ChatMessage as C, type Disposable as D, type ExtensionContributions as E, type SettingsAPI as F, type GetModelsOptions as G, type ProvidersAPI as H, type ToolsAPI as I, type ActionsAPI as J, type EventsAPI as K, type LocalizedString as L, type ModelInfo as M, type NetworkAPI as N, type SchedulerAPI as O, type PanelDefinition as P, type SchedulerJobRequest as Q, type SchedulerSchedule as R, type SchedulerFirePayload as S, type ToolResult as T, type UserAPI as U, type UserProfile as V, type ChatAPI as W, type ChatInstructionMessage as X, type DatabaseAPI as Y, type StorageAPI as Z, type LogAPI as _, type ChatOptions as a, type ToolCall as a0, type Tool as a1, type Action as a2, type ExtensionModule as a3, type AllowedCSSProperty as a4, type ExtensionComponentStyle as a5, type ExtensionComponentData as a6, type ExtensionComponentIterator as a7, type ExtensionComponentChildren as a8, type ExtensionActionCall as a9, type ExecutionContext as aA, type ExtensionActionRef as aa, type ExtensionDataSource as ab, type ExtensionPanelDefinition as ac, type HeaderProps as ad, type LabelProps as ae, type ParagraphProps as af, type ButtonProps as ag, type TextInputProps as ah, type DateTimeInputProps as ai, type SelectProps as aj, type VerticalStackProps as ak, type HorizontalStackProps as al, type GridProps as am, type DividerProps as an, type IconProps as ao, type IconButtonType as ap, type IconButtonProps as aq, type PanelAction as ar, type PanelProps as as, type ToggleProps as at, type CollapsibleProps as au, type PillVariant as av, type PillProps as aw, type CheckboxProps as ax, type MarkdownProps as ay, type ModalProps as az, type StreamEvent as b, type SettingDefinition as c, type SettingOptionsMapping as d, type SettingCreateMapping as e, type ToolSettingsViewDefinition as f, type ToolSettingsView as g, type ToolSettingsListView as h, type ToolSettingsListMapping as i, type ToolSettingsComponentView as j, type ToolSettingsActionDataSource as k, type PanelView as l, type PanelComponentView as m, type PanelActionDataSource as n, type PanelUnknownView as o, type ProviderDefinition as p, type PromptContribution as q, resolveLocalizedString as r, type PromptSection as s, type ToolDefinition as t, type CommandDefinition as u, type ProviderConfigSchema as v, type ProviderConfigProperty as w, type ProviderConfigPropertyType as x, type ProviderConfigSelectOption as y, type ProviderConfigValidation as z };
+export { type BackgroundWorkersAPI as $, type ActionResult as A, type ExtensionContext as B, type ChatMessage as C, type Disposable as D, type ExtensionContributions as E, type SettingsAPI as F, type GetModelsOptions as G, type ProvidersAPI as H, type ToolsAPI as I, type ActionsAPI as J, type EventsAPI as K, type LocalizedString as L, type ModelInfo as M, type NetworkAPI as N, type SchedulerAPI as O, type PanelDefinition as P, type SchedulerJobRequest as Q, type SchedulerSchedule as R, type SchedulerFirePayload as S, type ToolResult as T, type UserAPI as U, type UserProfile as V, type ChatAPI as W, type ChatInstructionMessage as X, type DatabaseAPI as Y, type StorageAPI as Z, type LogAPI as _, type ChatOptions as a, type BackgroundTaskConfig as a0, type BackgroundTaskCallback as a1, type BackgroundTaskContext as a2, type BackgroundTaskHealth as a3, type BackgroundRestartPolicy as a4, type AIProvider as a5, type ToolCall as a6, type Tool as a7, type Action as a8, type ExtensionModule as a9, type CollapsibleProps as aA, type PillVariant as aB, type PillProps as aC, type CheckboxProps as aD, type MarkdownProps as aE, type ModalProps as aF, type ConditionalGroupProps as aG, type ExecutionContext as aH, type AllowedCSSProperty as aa, type ExtensionComponentStyle as ab, type ExtensionComponentData as ac, type ExtensionComponentIterator as ad, type ExtensionComponentChildren as ae, type ExtensionActionCall as af, type ExtensionActionRef as ag, type ExtensionDataSource as ah, type ExtensionPanelDefinition as ai, type HeaderProps as aj, type LabelProps as ak, type ParagraphProps as al, type ButtonProps as am, type TextInputProps as an, type DateTimeInputProps as ao, type SelectProps as ap, type VerticalStackProps as aq, type HorizontalStackProps as ar, type GridProps as as, type DividerProps as at, type IconProps as au, type IconButtonType as av, type IconButtonProps as aw, type PanelAction as ax, type PanelProps as ay, type ToggleProps as az, type StreamEvent as b, type SettingDefinition as c, type SettingOptionsMapping as d, type SettingCreateMapping as e, type ToolSettingsViewDefinition as f, type ToolSettingsView as g, type ToolSettingsListView as h, type ToolSettingsListMapping as i, type ToolSettingsComponentView as j, type ToolSettingsActionDataSource as k, type PanelView as l, type PanelComponentView as m, type PanelActionDataSource as n, type PanelUnknownView as o, type ProviderDefinition as p, type PromptContribution as q, resolveLocalizedString as r, type PromptSection as s, type ToolDefinition as t, type CommandDefinition as u, type ProviderConfigSchema as v, type ProviderConfigProperty as w, type ProviderConfigPropertyType as x, type ProviderConfigSelectOption as y, type ProviderConfigValidation as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stina/extension-api",
-  "version": "0.20.0",
+  "version": "0.22.0",
   "private": false,
   "repository": {
     "type": "git",