@fork-api/chat-sdk 0.1.151 → 0.1.154

package/dist/index.d.cts

@@ -19,6 +19,32 @@ interface Fork {
     completedAt?: string;
     error?: string;
 }
+type ForkActivityTargetKind = "slot" | "module";
+interface ForkActivity {
+    id: string;
+    status: Fork["status"];
+    targetKind: ForkActivityTargetKind;
+    targetId: string;
+    summary?: string | null;
+    latestMessage?: string | null;
+    estimateMinutes?: number | null;
+    promptCount?: number;
+    messageCount?: number;
+    isActive?: boolean;
+    createdAt: string;
+    updatedAt: string;
+    completedAt?: string | null;
+    unread?: boolean;
+}
+interface ForkActivitySummary {
+    state: "idle" | "running" | "complete" | "error";
+    label: string;
+    detail?: string;
+    count: number;
+    runningCount: number;
+    unreadCompletedCount: number;
+    latest: ForkActivity | null;
+}
 interface ForkEvent {
     type: "status" | "agent_message" | "tool_use" | "build_start" | "build_complete" | "build_error" | "complete" | "error";
     data: unknown;
@@ -39,11 +65,10 @@ interface ForkProviderBase {
  *   The SDK calls this on mount (same-origin, cookies sent automatically).
  *   Your backend computes: userHash = HMAC-SHA256(sk_fork_key, userId).
  *   This provides verified per-user fork isolation.
- *   To auto-enter admin mode for tenant operators, authUrl may also return
- *   `{ forkUserId, forkOperatorExpiresAt, forkOperatorHash }`, where
- *   forkOperatorExpiresAt is a unix-seconds timestamp no more than 10 minutes
- *   in the future and forkOperatorHash is HMAC-SHA256(sk_fork_key,
- *   `fork-operator:v1:${appId}:${userId}:${forkUserId}:${forkOperatorExpiresAt}`).
+ *   If the verified user is also a Fork tenant operator (their email matches
+ *   a fork_users row with a user_roles entry on this tenant), the SDK
+ *   transparently enters admin mode and acts as their mapped end-user — set
+ *   the mapping in Fork's Team Settings → End user.
  */
 type ForkProviderProps = ForkProviderBase & ({
     userId: string;
@@ -100,6 +125,12 @@ type ForkChatInterfaceProps = ForkChatTargetInput & {
      * shell (e.g. Chrome's native side panel).
      */
     embedded?: boolean;
+    /**
+     * How the completed-fork summary renders. "bubble" (default) is the chat
+     * bubble layout; "item" is the shadcn-Item layout (icon tile + title +
+     * description + Undo action).
+     */
+    completeVariant?: "bubble" | "item";
 };
 interface ForkSlotProps {
     slotId: string;
@@ -205,8 +236,10 @@ interface ForkUIProps {
 }
 declare function ForkUI({ slotId, title, slotLabel }: ForkUIProps): react_jsx_runtime.JSX.Element;
 
-declare function ForkButton({ onClick }: {
+declare function ForkButton({ onClick, hasNotification, activity, }: {
     onClick?: () => void;
+    hasNotification?: boolean;
+    activity?: ForkActivitySummary;
 }): react_jsx_runtime.JSX.Element;
 
 interface ForkPanelProps {
@@ -236,8 +269,13 @@ interface ForkPanelProps {
      * panel.
      */
     embedded?: boolean;
+    /**
+     * Rendering style for the "applied" summary in the complete state.
+     * "bubble" (default) is the chat bubble. "item" is a shadcn-Item layout.
+     */
+    completeVariant?: "bubble" | "item";
 }
-declare function ForkPanel({ state, fork, events, error, slotId, targetId, targetLabel, historyMode, onSubmit, onUndo, onClose, baseUrl, apiKey, userId, userHash, appId, embedded, }: ForkPanelProps): react_jsx_runtime.JSX.Element;
+declare function ForkPanel({ state, fork, events, error, slotId, targetId, targetLabel, historyMode, onSubmit, onUndo, onClose, baseUrl, apiKey, userId, userHash, appId, embedded, completeVariant, }: ForkPanelProps): react_jsx_runtime.JSX.Element;
 
 declare function useFork(): {
     state: ForkState;
@@ -251,6 +289,7 @@ declare function useFork(): {
         forceNew?: boolean;
     }) => Promise<void>;
     undoFork: (slotId: string) => Promise<any>;
+    adoptRunningFork: (forkId: string) => Promise<void>;
 };
 
 declare function useBoundaryFork(boundaryId: string): {
@@ -265,9 +304,11 @@ declare function useBoundaryFork(boundaryId: string): {
         forceNew?: boolean;
     }) => Promise<void>;
     undoFork: () => Promise<any>;
+    adoptRunningFork: (forkId: string) => Promise<void>;
 };
 
 declare function useForkChatPanel(options: ForkChatPanelOptions): {
+    open: () => void;
     target: ForkChatTarget;
     targetId: string;
     targetLabel: string | undefined;
@@ -278,7 +319,9 @@ declare function useForkChatPanel(options: ForkChatPanelOptions): {
     }) => Promise<void>;
     undo: (submittedTargetId?: string) => Promise<any>;
     buttonProps: {
-        onClick: (() => void) | (() => void);
+        onClick: () => void;
+        hasNotification: boolean;
+        activity: ForkActivitySummary;
     };
     panelProps: {
         onSubmit: (prompt: string, submittedTargetId?: string, containerId?: string | null, opts?: {
@@ -324,9 +367,10 @@ declare function useForkChatPanel(options: ForkChatPanelOptions): {
     events: ForkEvent[];
     error: string | null;
     isOpen: boolean;
-    open: () => void;
     close: () => void;
+    adoptRunningFork: (forkId: string) => Promise<void>;
 } | {
+    open: () => void;
     target: ForkChatTarget;
     targetId: string;
     targetLabel: string | undefined;
@@ -337,7 +381,9 @@ declare function useForkChatPanel(options: ForkChatPanelOptions): {
     }) => Promise<void>;
     undo: (submittedTargetId?: string) => Promise<any>;
     buttonProps: {
-        onClick: (() => void) | (() => void);
+        onClick: () => void;
+        hasNotification: boolean;
+        activity: ForkActivitySummary;
     };
     panelProps: {
         onSubmit: (prompt: string, submittedTargetId?: string, containerId?: string | null, opts?: {
@@ -383,8 +429,8 @@ declare function useForkChatPanel(options: ForkChatPanelOptions): {
     events: ForkEvent[];
     error: string | null;
     isOpen: boolean;
-    open: () => void;
     close: () => void;
+    adoptRunningFork: (forkId: string) => Promise<void>;
 };
 
 /**
@@ -482,4 +528,4 @@ declare function clearCachedManifest(tenantId: string, appId: string, userId: st
  */
 declare function manifestDiffers(a: Manifest | null, b: Manifest | null): boolean;
 
-export { type Fork, type ForkBoundaryDefinition, ForkBoundaryUI, ForkButton, ForkChatInterface, type ForkChatInterfaceProps, type ForkChatPanelOptions, type ForkChatTarget, type ForkEvent, ForkPanel, ForkProvider, type ForkProviderProps, type ForkSharedRegistry, ForkSlot, type ForkSlotProps, type ForkState, ForkUI, type LoadManifestInput, type Manifest, type ManifestEntry, type ManifestModuleEntry, type PreviewSessionPayload, clearCachedManifest, forkable, loadManifest, manifestDiffers, readCachedManifest, registerForkShared, useBoundaryFork, useFork, useForkChatPanel, usePreviewSession, writeCachedManifest };
+export { type Fork, type ForkActivity, type ForkActivitySummary, type ForkActivityTargetKind, type ForkBoundaryDefinition, ForkBoundaryUI, ForkButton, ForkChatInterface, type ForkChatInterfaceProps, type ForkChatPanelOptions, type ForkChatTarget, type ForkEvent, ForkPanel, ForkProvider, type ForkProviderProps, type ForkSharedRegistry, ForkSlot, type ForkSlotProps, type ForkState, ForkUI, type LoadManifestInput, type Manifest, type ManifestEntry, type ManifestModuleEntry, type PreviewSessionPayload, clearCachedManifest, forkable, loadManifest, manifestDiffers, readCachedManifest, registerForkShared, useBoundaryFork, useFork, useForkChatPanel, usePreviewSession, writeCachedManifest };

package/dist/index.d.ts

@@ -19,6 +19,32 @@ interface Fork {
     completedAt?: string;
     error?: string;
 }
+type ForkActivityTargetKind = "slot" | "module";
+interface ForkActivity {
+    id: string;
+    status: Fork["status"];
+    targetKind: ForkActivityTargetKind;
+    targetId: string;
+    summary?: string | null;
+    latestMessage?: string | null;
+    estimateMinutes?: number | null;
+    promptCount?: number;
+    messageCount?: number;
+    isActive?: boolean;
+    createdAt: string;
+    updatedAt: string;
+    completedAt?: string | null;
+    unread?: boolean;
+}
+interface ForkActivitySummary {
+    state: "idle" | "running" | "complete" | "error";
+    label: string;
+    detail?: string;
+    count: number;
+    runningCount: number;
+    unreadCompletedCount: number;
+    latest: ForkActivity | null;
+}
 interface ForkEvent {
     type: "status" | "agent_message" | "tool_use" | "build_start" | "build_complete" | "build_error" | "complete" | "error";
     data: unknown;
@@ -39,11 +65,10 @@ interface ForkProviderBase {
  *   The SDK calls this on mount (same-origin, cookies sent automatically).
  *   Your backend computes: userHash = HMAC-SHA256(sk_fork_key, userId).
  *   This provides verified per-user fork isolation.
- *   To auto-enter admin mode for tenant operators, authUrl may also return
- *   `{ forkUserId, forkOperatorExpiresAt, forkOperatorHash }`, where
- *   forkOperatorExpiresAt is a unix-seconds timestamp no more than 10 minutes
- *   in the future and forkOperatorHash is HMAC-SHA256(sk_fork_key,
- *   `fork-operator:v1:${appId}:${userId}:${forkUserId}:${forkOperatorExpiresAt}`).
+ *   If the verified user is also a Fork tenant operator (their email matches
+ *   a fork_users row with a user_roles entry on this tenant), the SDK
+ *   transparently enters admin mode and acts as their mapped end-user — set
+ *   the mapping in Fork's Team Settings → End user.
  */
 type ForkProviderProps = ForkProviderBase & ({
     userId: string;
@@ -100,6 +125,12 @@ type ForkChatInterfaceProps = ForkChatTargetInput & {
      * shell (e.g. Chrome's native side panel).
      */
     embedded?: boolean;
+    /**
+     * How the completed-fork summary renders. "bubble" (default) is the chat
+     * bubble layout; "item" is the shadcn-Item layout (icon tile + title +
+     * description + Undo action).
+     */
+    completeVariant?: "bubble" | "item";
 };
 interface ForkSlotProps {
     slotId: string;
@@ -205,8 +236,10 @@ interface ForkUIProps {
 }
 declare function ForkUI({ slotId, title, slotLabel }: ForkUIProps): react_jsx_runtime.JSX.Element;
 
-declare function ForkButton({ onClick }: {
+declare function ForkButton({ onClick, hasNotification, activity, }: {
     onClick?: () => void;
+    hasNotification?: boolean;
+    activity?: ForkActivitySummary;
 }): react_jsx_runtime.JSX.Element;
 
 interface ForkPanelProps {
@@ -236,8 +269,13 @@ interface ForkPanelProps {
      * panel.
      */
     embedded?: boolean;
+    /**
+     * Rendering style for the "applied" summary in the complete state.
+     * "bubble" (default) is the chat bubble. "item" is a shadcn-Item layout.
+     */
+    completeVariant?: "bubble" | "item";
 }
-declare function ForkPanel({ state, fork, events, error, slotId, targetId, targetLabel, historyMode, onSubmit, onUndo, onClose, baseUrl, apiKey, userId, userHash, appId, embedded, }: ForkPanelProps): react_jsx_runtime.JSX.Element;
+declare function ForkPanel({ state, fork, events, error, slotId, targetId, targetLabel, historyMode, onSubmit, onUndo, onClose, baseUrl, apiKey, userId, userHash, appId, embedded, completeVariant, }: ForkPanelProps): react_jsx_runtime.JSX.Element;
 
 declare function useFork(): {
     state: ForkState;
@@ -251,6 +289,7 @@ declare function useFork(): {
         forceNew?: boolean;
     }) => Promise<void>;
     undoFork: (slotId: string) => Promise<any>;
+    adoptRunningFork: (forkId: string) => Promise<void>;
 };
 
 declare function useBoundaryFork(boundaryId: string): {
@@ -265,9 +304,11 @@ declare function useBoundaryFork(boundaryId: string): {
         forceNew?: boolean;
     }) => Promise<void>;
     undoFork: () => Promise<any>;
+    adoptRunningFork: (forkId: string) => Promise<void>;
 };
 
 declare function useForkChatPanel(options: ForkChatPanelOptions): {
+    open: () => void;
     target: ForkChatTarget;
     targetId: string;
     targetLabel: string | undefined;
@@ -278,7 +319,9 @@ declare function useForkChatPanel(options: ForkChatPanelOptions): {
     }) => Promise<void>;
     undo: (submittedTargetId?: string) => Promise<any>;
     buttonProps: {
-        onClick: (() => void) | (() => void);
+        onClick: () => void;
+        hasNotification: boolean;
+        activity: ForkActivitySummary;
     };
     panelProps: {
         onSubmit: (prompt: string, submittedTargetId?: string, containerId?: string | null, opts?: {
@@ -324,9 +367,10 @@ declare function useForkChatPanel(options: ForkChatPanelOptions): {
     events: ForkEvent[];
     error: string | null;
     isOpen: boolean;
-    open: () => void;
     close: () => void;
+    adoptRunningFork: (forkId: string) => Promise<void>;
 } | {
+    open: () => void;
     target: ForkChatTarget;
     targetId: string;
     targetLabel: string | undefined;
@@ -337,7 +381,9 @@ declare function useForkChatPanel(options: ForkChatPanelOptions): {
     }) => Promise<void>;
     undo: (submittedTargetId?: string) => Promise<any>;
     buttonProps: {
-        onClick: (() => void) | (() => void);
+        onClick: () => void;
+        hasNotification: boolean;
+        activity: ForkActivitySummary;
     };
     panelProps: {
         onSubmit: (prompt: string, submittedTargetId?: string, containerId?: string | null, opts?: {
@@ -383,8 +429,8 @@ declare function useForkChatPanel(options: ForkChatPanelOptions): {
     events: ForkEvent[];
     error: string | null;
     isOpen: boolean;
-    open: () => void;
     close: () => void;
+    adoptRunningFork: (forkId: string) => Promise<void>;
 };
 
 /**
@@ -482,4 +528,4 @@ declare function clearCachedManifest(tenantId: string, appId: string, userId: st
  */
 declare function manifestDiffers(a: Manifest | null, b: Manifest | null): boolean;
 
-export { type Fork, type ForkBoundaryDefinition, ForkBoundaryUI, ForkButton, ForkChatInterface, type ForkChatInterfaceProps, type ForkChatPanelOptions, type ForkChatTarget, type ForkEvent, ForkPanel, ForkProvider, type ForkProviderProps, type ForkSharedRegistry, ForkSlot, type ForkSlotProps, type ForkState, ForkUI, type LoadManifestInput, type Manifest, type ManifestEntry, type ManifestModuleEntry, type PreviewSessionPayload, clearCachedManifest, forkable, loadManifest, manifestDiffers, readCachedManifest, registerForkShared, useBoundaryFork, useFork, useForkChatPanel, usePreviewSession, writeCachedManifest };
+export { type Fork, type ForkActivity, type ForkActivitySummary, type ForkActivityTargetKind, type ForkBoundaryDefinition, ForkBoundaryUI, ForkButton, ForkChatInterface, type ForkChatInterfaceProps, type ForkChatPanelOptions, type ForkChatTarget, type ForkEvent, ForkPanel, ForkProvider, type ForkProviderProps, type ForkSharedRegistry, ForkSlot, type ForkSlotProps, type ForkState, ForkUI, type LoadManifestInput, type Manifest, type ManifestEntry, type ManifestModuleEntry, type PreviewSessionPayload, clearCachedManifest, forkable, loadManifest, manifestDiffers, readCachedManifest, registerForkShared, useBoundaryFork, useFork, useForkChatPanel, usePreviewSession, writeCachedManifest };