@fork-api/chat-sdk 0.1.180 → 0.1.182

package/dist/index.d.cts

@@ -1,6 +1,50 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { ReactNode, ReactElement, ComponentType } from 'react';
 
+/**
+ * DOM element picker — the Chrome-DevTools-inspect experience for the chat
+ * panel. While active it paints a highlight overlay + label over whatever
+ * host-page element the cursor is on; clicking captures a structured context
+ * blob for the agent, Esc cancels.
+ *
+ * The overlay mounts directly on document.body (NOT inside the panel's
+ * shadow root) so it can sit over host elements, and it is pointer-events:
+ * none so document.elementFromPoint() resolves the real host target.
+ * Everything inside the Fork panel/launcher hosts is ignored — hovering the
+ * panel clears the highlight, clicking it neither selects nor cancels.
+ */
+interface SelectedElementContext {
+    tag: string;
+    id?: string;
+    classes?: string[];
+    selector?: string;
+    componentName?: string;
+    text?: string;
+    html?: string;
+    rect?: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+}
+
+/** Image attachment riding on a fork prompt (raw base64 + media type). */
+interface ForkPromptAttachment {
+    mediaType: string;
+    data: string;
+}
+/** Options for submitting a prompt from the chat panel. */
+interface ForkSubmitOptions {
+    /** Follow-up on this fork (otherwise a new fork is composed). */
+    forkId?: string | null;
+    /** Force a new fork even when one exists for the target. */
+    forceNew?: boolean;
+    /** Screenshots pasted/uploaded into the composer. */
+    attachments?: ForkPromptAttachment[];
+    /** DOM element the user picked on the page for context. */
+    selectedElement?: SelectedElementContext | null;
+}
 interface Fork {
     id: string;
     userId: string;
@@ -296,11 +340,8 @@ interface ForkPanelProps {
     targetId?: string;
     targetLabel?: string;
     historyMode?: "slot" | "boundary" | "none";
-    onSubmit: (prompt: string, targetId: string, containerId?: string | null, opts?: {
-        forkId?: string | null;
-        forceNew?: boolean;
-    }) => void;
-    onUndo?: (targetId: string) => Promise<any>;
+    onSubmit: (prompt: string, targetId: string, containerId?: string | null, opts?: ForkSubmitOptions) => void;
+    onUndo?: (targetId: string, forkId?: string | null) => Promise<any>;
     onClose: () => void;
     baseUrl?: string;
     apiKey?: string;
@@ -330,10 +371,7 @@ declare function useFork(): {
     runs: Record<string, ForkRun>;
     open: () => void;
     close: () => void;
-    startFork: (prompt: string, slotId?: string, containerId?: string | null, opts?: {
-        forkId?: string | null;
-        forceNew?: boolean;
-    }) => Promise<void>;
+    startFork: (prompt: string, slotId?: string, containerId?: string | null, opts?: ForkSubmitOptions) => Promise<void>;
     undoFork: (slotId: string) => Promise<any>;
     adoptRunningFork: (forkId: string) => Promise<void>;
 };
@@ -346,11 +384,8 @@ declare function useBoundaryFork(boundaryId: string): {
     runs: Record<string, ForkRun>;
     open: () => void;
     close: () => void;
-    startFork: (prompt: string, containerId?: string | null, opts?: {
-        forkId?: string | null;
-        forceNew?: boolean;
-    }) => Promise<void>;
-    undoFork: () => Promise<any>;
+    startFork: (prompt: string, containerId?: string | null, opts?: ForkSubmitOptions) => Promise<void>;
+    undoFork: (forkId?: string | null) => Promise<any>;
     adoptRunningFork: (forkId: string) => Promise<void>;
 };
 
@@ -360,22 +395,16 @@ declare function useForkChatPanel(options: ForkChatPanelOptions): {
     targetId: string;
     targetLabel: string | undefined;
     historyMode: "slot" | "boundary";
-    submit: (prompt: string, submittedTargetId?: string, containerId?: string | null, opts?: {
-        forkId?: string | null;
-        forceNew?: boolean;
-    }) => Promise<void>;
-    undo: (submittedTargetId?: string) => Promise<any>;
+    submit: (prompt: string, submittedTargetId?: string, containerId?: string | null, opts?: ForkSubmitOptions) => Promise<void>;
+    undo: (submittedTargetId?: string, forkId?: string | null) => Promise<any>;
     buttonProps: {
         onClick: () => void;
         hasNotification: boolean;
         activity: ForkActivitySummary;
     };
     panelProps: {
-        onSubmit: (prompt: string, submittedTargetId?: string, containerId?: string | null, opts?: {
-            forkId?: string | null;
-            forceNew?: boolean;
-        }) => Promise<void>;
-        onUndo: (submittedTargetId?: string) => Promise<any>;
+        onSubmit: (prompt: string, submittedTargetId?: string, containerId?: string | null, opts?: ForkSubmitOptions) => Promise<void>;
+        onUndo: (submittedTargetId?: string, forkId?: string | null) => Promise<any>;
         onClose: (() => void) | (() => void);
         baseUrl: string;
         apiKey: string;
@@ -391,11 +420,8 @@ declare function useForkChatPanel(options: ForkChatPanelOptions): {
         error: string | null;
         runs: Record<string, ForkRun>;
     } | {
-        onSubmit: (prompt: string, submittedTargetId?: string, containerId?: string | null, opts?: {
-            forkId?: string | null;
-            forceNew?: boolean;
-        }) => Promise<void>;
-        onUndo: (submittedTargetId?: string) => Promise<any>;
+        onSubmit: (prompt: string, submittedTargetId?: string, containerId?: string | null, opts?: ForkSubmitOptions) => Promise<void>;
+        onUndo: (submittedTargetId?: string, forkId?: string | null) => Promise<any>;
         onClose: (() => void) | (() => void);
         baseUrl: string;
         apiKey: string;
@@ -425,22 +451,16 @@ declare function useForkChatPanel(options: ForkChatPanelOptions): {
     targetId: string;
     targetLabel: string | undefined;
     historyMode: "slot" | "boundary";
-    submit: (prompt: string, submittedTargetId?: string, containerId?: string | null, opts?: {
-        forkId?: string | null;
-        forceNew?: boolean;
-    }) => Promise<void>;
-    undo: (submittedTargetId?: string) => Promise<any>;
+    submit: (prompt: string, submittedTargetId?: string, containerId?: string | null, opts?: ForkSubmitOptions) => Promise<void>;
+    undo: (submittedTargetId?: string, forkId?: string | null) => Promise<any>;
     buttonProps: {
         onClick: () => void;
         hasNotification: boolean;
         activity: ForkActivitySummary;
     };
     panelProps: {
-        onSubmit: (prompt: string, submittedTargetId?: string, containerId?: string | null, opts?: {
-            forkId?: string | null;
-            forceNew?: boolean;
-        }) => Promise<void>;
-        onUndo: (submittedTargetId?: string) => Promise<any>;
+        onSubmit: (prompt: string, submittedTargetId?: string, containerId?: string | null, opts?: ForkSubmitOptions) => Promise<void>;
+        onUndo: (submittedTargetId?: string, forkId?: string | null) => Promise<any>;
         onClose: (() => void) | (() => void);
         baseUrl: string;
         apiKey: string;
@@ -456,11 +476,8 @@ declare function useForkChatPanel(options: ForkChatPanelOptions): {
         error: string | null;
         runs: Record<string, ForkRun>;
     } | {
-        onSubmit: (prompt: string, submittedTargetId?: string, containerId?: string | null, opts?: {
-            forkId?: string | null;
-            forceNew?: boolean;
-        }) => Promise<void>;
-        onUndo: (submittedTargetId?: string) => Promise<any>;
+        onSubmit: (prompt: string, submittedTargetId?: string, containerId?: string | null, opts?: ForkSubmitOptions) => Promise<void>;
+        onUndo: (submittedTargetId?: string, forkId?: string | null) => Promise<any>;
         onClose: (() => void) | (() => void);
         baseUrl: string;
         apiKey: string;
@@ -851,4 +868,4 @@ declare function clearCachedManifest(tenantId: string, appId: string, userId: st
  */
 declare function manifestDiffers(a: Manifest | null, b: Manifest | null): boolean;
 
-export { type AdminContainer, type AdminContext, type EnsureFeatureInput, type EnsureLlmJobsInput, type Fork, type ForkActivity, type ForkActivitySummary, type ForkActivityTargetKind, type ForkBoundaryDefinition, ForkBoundaryUI, ForkButton, ForkChatInterface, type ForkChatInterfaceProps, type ForkChatPanelOptions, type ForkChatTarget, type ForkDataClient, type ForkDataClientConfig, type ForkDataSource, type ForkDataStatus, type ForkEntityRef, type ForkEvent, type ForkFeature, type ForkFeatureKind, type ForkFeatureOption, type ForkFeatureValue, type ForkLlmJob, type ForkLlmJobStatus, ForkPanel, ForkProvider, type ForkProviderProps, type ForkSharedRegistry, ForkSlot, type ForkSlotProps, type ForkState, ForkUI, type LoadManifestInput, type Manifest, type ManifestEntry, type ManifestModuleEntry, type QueryLlmJobsInput, type QueryValuesInput, type SetOptionsInput, type SetValuesInput, type UseForkFeatureValuesInput, type UseForkLlmJobsInput, clearCachedManifest, createForkDataClient, forkEntityValueKey, forkable, loadManifest, manifestDiffers, readCachedManifest, registerForkShared, useBoundaryFork, useFork, useForkChatPanel, useForkDataClient, useForkDataMutation, useForkFeatureValues, useForkLlmJobs, writeCachedManifest };
+export { type AdminContainer, type AdminContext, type EnsureFeatureInput, type EnsureLlmJobsInput, type Fork, type ForkActivity, type ForkActivitySummary, type ForkActivityTargetKind, type ForkBoundaryDefinition, ForkBoundaryUI, ForkButton, ForkChatInterface, type ForkChatInterfaceProps, type ForkChatPanelOptions, type ForkChatTarget, type ForkDataClient, type ForkDataClientConfig, type ForkDataSource, type ForkDataStatus, type ForkEntityRef, type ForkEvent, type ForkFeature, type ForkFeatureKind, type ForkFeatureOption, type ForkFeatureValue, type ForkLlmJob, type ForkLlmJobStatus, ForkPanel, type ForkPromptAttachment, ForkProvider, type ForkProviderProps, type ForkSharedRegistry, ForkSlot, type ForkSlotProps, type ForkState, type ForkSubmitOptions, ForkUI, type LoadManifestInput, type Manifest, type ManifestEntry, type ManifestModuleEntry, type QueryLlmJobsInput, type QueryValuesInput, type SelectedElementContext, type SetOptionsInput, type SetValuesInput, type UseForkFeatureValuesInput, type UseForkLlmJobsInput, clearCachedManifest, createForkDataClient, forkEntityValueKey, forkable, loadManifest, manifestDiffers, readCachedManifest, registerForkShared, useBoundaryFork, useFork, useForkChatPanel, useForkDataClient, useForkDataMutation, useForkFeatureValues, useForkLlmJobs, writeCachedManifest };

package/dist/index.d.ts

@@ -1,6 +1,50 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { ReactNode, ReactElement, ComponentType } from 'react';
 
+/**
+ * DOM element picker — the Chrome-DevTools-inspect experience for the chat
+ * panel. While active it paints a highlight overlay + label over whatever
+ * host-page element the cursor is on; clicking captures a structured context
+ * blob for the agent, Esc cancels.
+ *
+ * The overlay mounts directly on document.body (NOT inside the panel's
+ * shadow root) so it can sit over host elements, and it is pointer-events:
+ * none so document.elementFromPoint() resolves the real host target.
+ * Everything inside the Fork panel/launcher hosts is ignored — hovering the
+ * panel clears the highlight, clicking it neither selects nor cancels.
+ */
+interface SelectedElementContext {
+    tag: string;
+    id?: string;
+    classes?: string[];
+    selector?: string;
+    componentName?: string;
+    text?: string;
+    html?: string;
+    rect?: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+}
+
+/** Image attachment riding on a fork prompt (raw base64 + media type). */
+interface ForkPromptAttachment {
+    mediaType: string;
+    data: string;
+}
+/** Options for submitting a prompt from the chat panel. */
+interface ForkSubmitOptions {
+    /** Follow-up on this fork (otherwise a new fork is composed). */
+    forkId?: string | null;
+    /** Force a new fork even when one exists for the target. */
+    forceNew?: boolean;
+    /** Screenshots pasted/uploaded into the composer. */
+    attachments?: ForkPromptAttachment[];
+    /** DOM element the user picked on the page for context. */
+    selectedElement?: SelectedElementContext | null;
+}
 interface Fork {
     id: string;
     userId: string;
@@ -296,11 +340,8 @@ interface ForkPanelProps {
     targetId?: string;
     targetLabel?: string;
     historyMode?: "slot" | "boundary" | "none";
-    onSubmit: (prompt: string, targetId: string, containerId?: string | null, opts?: {
-        forkId?: string | null;
-        forceNew?: boolean;
-    }) => void;
-    onUndo?: (targetId: string) => Promise<any>;
+    onSubmit: (prompt: string, targetId: string, containerId?: string | null, opts?: ForkSubmitOptions) => void;
+    onUndo?: (targetId: string, forkId?: string | null) => Promise<any>;
     onClose: () => void;
     baseUrl?: string;
     apiKey?: string;
@@ -330,10 +371,7 @@ declare function useFork(): {
     runs: Record<string, ForkRun>;
     open: () => void;
     close: () => void;
-    startFork: (prompt: string, slotId?: string, containerId?: string | null, opts?: {
-        forkId?: string | null;
-        forceNew?: boolean;
-    }) => Promise<void>;
+    startFork: (prompt: string, slotId?: string, containerId?: string | null, opts?: ForkSubmitOptions) => Promise<void>;
     undoFork: (slotId: string) => Promise<any>;
     adoptRunningFork: (forkId: string) => Promise<void>;
 };
@@ -346,11 +384,8 @@ declare function useBoundaryFork(boundaryId: string): {
     runs: Record<string, ForkRun>;
     open: () => void;
     close: () => void;
-    startFork: (prompt: string, containerId?: string | null, opts?: {
-        forkId?: string | null;
-        forceNew?: boolean;
-    }) => Promise<void>;
-    undoFork: () => Promise<any>;
+    startFork: (prompt: string, containerId?: string | null, opts?: ForkSubmitOptions) => Promise<void>;
+    undoFork: (forkId?: string | null) => Promise<any>;
     adoptRunningFork: (forkId: string) => Promise<void>;
 };
 
@@ -360,22 +395,16 @@ declare function useForkChatPanel(options: ForkChatPanelOptions): {
     targetId: string;
     targetLabel: string | undefined;
     historyMode: "slot" | "boundary";
-    submit: (prompt: string, submittedTargetId?: string, containerId?: string | null, opts?: {
-        forkId?: string | null;
-        forceNew?: boolean;
-    }) => Promise<void>;
-    undo: (submittedTargetId?: string) => Promise<any>;
+    submit: (prompt: string, submittedTargetId?: string, containerId?: string | null, opts?: ForkSubmitOptions) => Promise<void>;
+    undo: (submittedTargetId?: string, forkId?: string | null) => Promise<any>;
     buttonProps: {
         onClick: () => void;
         hasNotification: boolean;
         activity: ForkActivitySummary;
     };
     panelProps: {
-        onSubmit: (prompt: string, submittedTargetId?: string, containerId?: string | null, opts?: {
-            forkId?: string | null;
-            forceNew?: boolean;
-        }) => Promise<void>;
-        onUndo: (submittedTargetId?: string) => Promise<any>;
+        onSubmit: (prompt: string, submittedTargetId?: string, containerId?: string | null, opts?: ForkSubmitOptions) => Promise<void>;
+        onUndo: (submittedTargetId?: string, forkId?: string | null) => Promise<any>;
         onClose: (() => void) | (() => void);
         baseUrl: string;
         apiKey: string;
@@ -391,11 +420,8 @@ declare function useForkChatPanel(options: ForkChatPanelOptions): {
         error: string | null;
         runs: Record<string, ForkRun>;
     } | {
-        onSubmit: (prompt: string, submittedTargetId?: string, containerId?: string | null, opts?: {
-            forkId?: string | null;
-            forceNew?: boolean;
-        }) => Promise<void>;
-        onUndo: (submittedTargetId?: string) => Promise<any>;
+        onSubmit: (prompt: string, submittedTargetId?: string, containerId?: string | null, opts?: ForkSubmitOptions) => Promise<void>;
+        onUndo: (submittedTargetId?: string, forkId?: string | null) => Promise<any>;
         onClose: (() => void) | (() => void);
         baseUrl: string;
         apiKey: string;
@@ -425,22 +451,16 @@ declare function useForkChatPanel(options: ForkChatPanelOptions): {
     targetId: string;
     targetLabel: string | undefined;
     historyMode: "slot" | "boundary";
-    submit: (prompt: string, submittedTargetId?: string, containerId?: string | null, opts?: {
-        forkId?: string | null;
-        forceNew?: boolean;
-    }) => Promise<void>;
-    undo: (submittedTargetId?: string) => Promise<any>;
+    submit: (prompt: string, submittedTargetId?: string, containerId?: string | null, opts?: ForkSubmitOptions) => Promise<void>;
+    undo: (submittedTargetId?: string, forkId?: string | null) => Promise<any>;
     buttonProps: {
         onClick: () => void;
         hasNotification: boolean;
         activity: ForkActivitySummary;
     };
     panelProps: {
-        onSubmit: (prompt: string, submittedTargetId?: string, containerId?: string | null, opts?: {
-            forkId?: string | null;
-            forceNew?: boolean;
-        }) => Promise<void>;
-        onUndo: (submittedTargetId?: string) => Promise<any>;
+        onSubmit: (prompt: string, submittedTargetId?: string, containerId?: string | null, opts?: ForkSubmitOptions) => Promise<void>;
+        onUndo: (submittedTargetId?: string, forkId?: string | null) => Promise<any>;
         onClose: (() => void) | (() => void);
         baseUrl: string;
         apiKey: string;
@@ -456,11 +476,8 @@ declare function useForkChatPanel(options: ForkChatPanelOptions): {
         error: string | null;
         runs: Record<string, ForkRun>;
     } | {
-        onSubmit: (prompt: string, submittedTargetId?: string, containerId?: string | null, opts?: {
-            forkId?: string | null;
-            forceNew?: boolean;
-        }) => Promise<void>;
-        onUndo: (submittedTargetId?: string) => Promise<any>;
+        onSubmit: (prompt: string, submittedTargetId?: string, containerId?: string | null, opts?: ForkSubmitOptions) => Promise<void>;
+        onUndo: (submittedTargetId?: string, forkId?: string | null) => Promise<any>;
         onClose: (() => void) | (() => void);
         baseUrl: string;
         apiKey: string;
@@ -851,4 +868,4 @@ declare function clearCachedManifest(tenantId: string, appId: string, userId: st
  */
 declare function manifestDiffers(a: Manifest | null, b: Manifest | null): boolean;
 
-export { type AdminContainer, type AdminContext, type EnsureFeatureInput, type EnsureLlmJobsInput, type Fork, type ForkActivity, type ForkActivitySummary, type ForkActivityTargetKind, type ForkBoundaryDefinition, ForkBoundaryUI, ForkButton, ForkChatInterface, type ForkChatInterfaceProps, type ForkChatPanelOptions, type ForkChatTarget, type ForkDataClient, type ForkDataClientConfig, type ForkDataSource, type ForkDataStatus, type ForkEntityRef, type ForkEvent, type ForkFeature, type ForkFeatureKind, type ForkFeatureOption, type ForkFeatureValue, type ForkLlmJob, type ForkLlmJobStatus, ForkPanel, ForkProvider, type ForkProviderProps, type ForkSharedRegistry, ForkSlot, type ForkSlotProps, type ForkState, ForkUI, type LoadManifestInput, type Manifest, type ManifestEntry, type ManifestModuleEntry, type QueryLlmJobsInput, type QueryValuesInput, type SetOptionsInput, type SetValuesInput, type UseForkFeatureValuesInput, type UseForkLlmJobsInput, clearCachedManifest, createForkDataClient, forkEntityValueKey, forkable, loadManifest, manifestDiffers, readCachedManifest, registerForkShared, useBoundaryFork, useFork, useForkChatPanel, useForkDataClient, useForkDataMutation, useForkFeatureValues, useForkLlmJobs, writeCachedManifest };
+export { type AdminContainer, type AdminContext, type EnsureFeatureInput, type EnsureLlmJobsInput, type Fork, type ForkActivity, type ForkActivitySummary, type ForkActivityTargetKind, type ForkBoundaryDefinition, ForkBoundaryUI, ForkButton, ForkChatInterface, type ForkChatInterfaceProps, type ForkChatPanelOptions, type ForkChatTarget, type ForkDataClient, type ForkDataClientConfig, type ForkDataSource, type ForkDataStatus, type ForkEntityRef, type ForkEvent, type ForkFeature, type ForkFeatureKind, type ForkFeatureOption, type ForkFeatureValue, type ForkLlmJob, type ForkLlmJobStatus, ForkPanel, type ForkPromptAttachment, ForkProvider, type ForkProviderProps, type ForkSharedRegistry, ForkSlot, type ForkSlotProps, type ForkState, type ForkSubmitOptions, ForkUI, type LoadManifestInput, type Manifest, type ManifestEntry, type ManifestModuleEntry, type QueryLlmJobsInput, type QueryValuesInput, type SelectedElementContext, type SetOptionsInput, type SetValuesInput, type UseForkFeatureValuesInput, type UseForkLlmJobsInput, clearCachedManifest, createForkDataClient, forkEntityValueKey, forkable, loadManifest, manifestDiffers, readCachedManifest, registerForkShared, useBoundaryFork, useFork, useForkChatPanel, useForkDataClient, useForkDataMutation, useForkFeatureValues, useForkLlmJobs, writeCachedManifest };