@object-ui/plugin-chatbot 5.4.1 → 6.0.0

package/dist/packages/plugin-chatbot/src/useHitlInChat.d.ts

@@ -0,0 +1,66 @@
+import { ChatMessage, ToolDecisionState } from './ChatbotEnhanced';
+import { ApproveOutcome, RejectOutcome } from './usePendingActions';
+export type { ToolDecisionState };
+export interface UseHitlInChatOptions {
+    /**
+     * Chat message list (already-mapped `ChatMessage[]` from `useObjectChat`
+     * or `uiMessagesToChatMessages`). The hook scans `toolInvocations[*]`
+     * looking for entries with `pendingActionId` and indexes them.
+     */
+    messages: ChatMessage[];
+    /**
+     * Framework AI base URL — for example `http://localhost:3004/api/v1/ai`.
+     * Defaults to `/api/v1/ai` (same-origin) to match `usePendingActions`.
+     */
+    apiBase?: string;
+    /** Extra headers (e.g. `X-Environment-Id`, `Authorization`). */
+    headers?: Record<string, string>;
+    /**
+     * Optional callback fired after a decision completes (regardless of
+     * success/failure). Useful for refreshing the inbox view if it is also
+     * mounted on the same page.
+     */
+    onDecided?: (toolCallId: string, outcome: ApproveOutcome | RejectOutcome) => void;
+    /**
+     * When set, on a *successful* decision the hook synthesizes a short
+     * follow-up prompt (e.g. "Operator approved pa_xxx. Result: {...}.
+     * Continue.") and invokes this callback. Wire to `useObjectChat`'s
+     * `sendMessage` to close the conversation loop — the LLM then continues
+     * reasoning with full awareness of the executed action's outcome.
+     *
+     * Failures (`status: 'failed'`, transport errors) still surface in
+     * `decisions[toolCallId]` but do NOT trigger a continuation prompt — the
+     * operator is expected to read the error and decide what to do next.
+     */
+    continueConversation?: (prompt: string, context: ContinueContext) => void;
+}
+/** Argument passed to {@link UseHitlInChatOptions.continueConversation}. */
+export interface ContinueContext {
+    toolCallId: string;
+    pendingActionId: string;
+    decision: 'approved' | 'rejected';
+    /** Raw REST payload — `{ status, result?, error?, … }`. */
+    outcome: ApproveOutcome | RejectOutcome;
+    /** Tool name as it appeared in the message part (e.g. `action_delete_task`). */
+    toolName?: string;
+}
+export interface UseHitlInChatReturn {
+    /**
+     * Map keyed by toolCallId. Pass directly to `<ChatbotEnhanced
+     * toolDecisions={…}>` to render inline status under each pending tool.
+     */
+    decisions: Record<string, ToolDecisionState>;
+    /**
+     * Approve / reject handler — wire to `onToolApprove`. Looks up the
+     * `pendingActionId` registered by `mapMessages` for the given toolCallId
+     * and calls the matching REST endpoint.
+     */
+    decide: (toolCallId: string, approved: boolean, reason?: string) => Promise<void>;
+    /**
+     * True while at least one in-flight REST call is outstanding.
+     * (Useful for disabling chat input while approvals settle, if desired.)
+     */
+    isDeciding: boolean;
+}
+export declare function useHitlInChat(options: UseHitlInChatOptions): UseHitlInChatReturn;
+//# sourceMappingURL=useHitlInChat.d.ts.map

package/dist/packages/plugin-chatbot/src/useHitlInChat.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useHitlInChat.d.ts","sourceRoot":"","sources":["../../../../src/useHitlInChat.ts"],"names":[],"mappings":"AAsCA,OAAO,KAAK,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACxE,OAAO,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEzE,YAAY,EAAE,iBAAiB,EAAE,CAAC;AAElC,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gEAAgE;IAChE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC;;;;OAIG;IACH,SAAS,CAAC,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,GAAG,aAAa,KAAK,IAAI,CAAC;IAClF;;;;;;;;;;OAUG;IACH,oBAAoB,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,eAAe,KAAK,IAAI,CAAC;CAC3E;AAED,4EAA4E;AAC5E,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,EAAE,UAAU,GAAG,UAAU,CAAC;IAClC,2DAA2D;IAC3D,OAAO,EAAE,cAAc,GAAG,aAAa,CAAC;IACxC,gFAAgF;IAChF,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAC7C;;;;OAIG;IACH,MAAM,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAClF;;;OAGG;IACH,UAAU,EAAE,OAAO,CAAC;CACrB;AA0BD,wBAAgB,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,mBAAmB,CAiJhF"}

package/dist/packages/plugin-chatbot/src/useObjectChat.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useObjectChat.d.ts","sourceRoot":"","sources":["../../../../src/useObjectChat.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,KAAK,EAAE,WAAW,IAAI,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAKtE;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,eAAe,CAAC,EAAE,cAAc,EAAE,CAAC;IACnC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IACjC;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAGxB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,EAAE,KAAK,IAAI,CAAC;CAChE;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,4BAA4B;IAC5B,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B,+DAA+D;IAC/D,SAAS,EAAE,OAAO,CAAC;IACnB,4BAA4B;IAC5B,KAAK,EAAE,KAAK,GAAG,SAAS,CAAC;IACzB,8BAA8B;IAC9B,WAAW,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,IAAI,EAAE,KAAK,IAAI,CAAC;IACvD,0CAA0C;IAC1C,IAAI,EAAE,MAAM,IAAI,CAAC;IACjB,gDAAgD;IAChD,MAAM,EAAE,MAAM,IAAI,CAAC;IACnB,yBAAyB;IACzB,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,4DAA4D;IAC5D,SAAS,EAAE,OAAO,CAAC;IACnB,wDAAwD;IACxD,KAAK,EAAE,MAAM,CAAC;IACd,sBAAsB;IACtB,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAClC,gCAAgC;IAChC,iBAAiB,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,gBAAgB,GAAG,mBAAmB,CAAC,KAAK,IAAI,CAAC;CAC3F;AAmBD;;;;;;;;;;;GAWG;AACH,wBAAgB,aAAa,CAAC,OAAO,GAAE,oBAAyB,GAAG,mBAAmB,CA2QrF"}
+{"version":3,"file":"useObjectChat.d.ts","sourceRoot":"","sources":["../../../../src/useObjectChat.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,KAAK,EAAE,WAAW,IAAI,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAMtE;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,eAAe,CAAC,EAAE,cAAc,EAAE,CAAC;IACnC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IACjC;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAGxB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,EAAE,KAAK,IAAI,CAAC;CAChE;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,4BAA4B;IAC5B,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B,+DAA+D;IAC/D,SAAS,EAAE,OAAO,CAAC;IACnB,4BAA4B;IAC5B,KAAK,EAAE,KAAK,GAAG,SAAS,CAAC;IACzB,8BAA8B;IAC9B,WAAW,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,IAAI,EAAE,KAAK,IAAI,CAAC;IACvD,0CAA0C;IAC1C,IAAI,EAAE,MAAM,IAAI,CAAC;IACjB,gDAAgD;IAChD,MAAM,EAAE,MAAM,IAAI,CAAC;IACnB,yBAAyB;IACzB,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,4DAA4D;IAC5D,SAAS,EAAE,OAAO,CAAC;IACnB,wDAAwD;IACxD,KAAK,EAAE,MAAM,CAAC;IACd,sBAAsB;IACtB,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAClC,gCAAgC;IAChC,iBAAiB,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,gBAAgB,GAAG,mBAAmB,CAAC,KAAK,IAAI,CAAC;CAC3F;AAmBD;;;;;;;;;;;GAWG;AACH,wBAAgB,aAAa,CAAC,OAAO,GAAE,oBAAyB,GAAG,mBAAmB,CA6NrF"}

package/dist/packages/plugin-chatbot/src/usePendingActions.d.ts

@@ -0,0 +1,120 @@
+/**
+ * ObjectUI
+ * Copyright (c) 2024-present ObjectStack Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+export type PendingActionStatus = 'pending' | 'approved' | 'executed' | 'failed' | 'rejected';
+/**
+ * Wire-format row returned by
+ * `GET /api/v1/ai/pending-actions` and friends. Mirrors the
+ * `ai_pending_action` object schema declared in
+ * `@objectstack/service-ai`.
+ */
+export interface PendingActionRow {
+    id: string;
+    conversation_id?: string | null;
+    message_id?: string | null;
+    object_name: string;
+    action_name: string;
+    tool_name: string;
+    /** JSON-encoded string. Consumers typically `JSON.parse` to render. */
+    tool_input: string;
+    status: PendingActionStatus | string;
+    result?: string | null;
+    error?: string | null;
+    rejection_reason?: string | null;
+    proposed_by?: string | null;
+    decided_by?: string | null;
+    proposed_at?: string;
+    decided_at?: string | null;
+    created_at?: string;
+    updated_at?: string;
+    [k: string]: unknown;
+}
+/**
+ * Successful approval outcome returned by
+ * `POST /api/v1/ai/pending-actions/:id/approve`.
+ *
+ * The HTTP status is 200 when `status === 'executed'` and 500 when the
+ * downstream dispatcher failed (`status === 'failed'`). The hook surfaces
+ * both as a normal resolved value so the UI can show the error inline
+ * without throwing.
+ */
+export interface ApproveOutcome {
+    id: string;
+    status: 'executed' | 'failed' | string;
+    result?: unknown;
+    error?: string;
+    [k: string]: unknown;
+}
+export interface RejectOutcome {
+    id: string;
+    status: 'rejected' | string;
+}
+export interface UsePendingActionsOptions {
+    /**
+     * Base URL of the AI service, e.g. `http://localhost:3000/api/v1/ai`.
+     * Falls back to `/api/v1/ai` (same-origin) when unset.
+     */
+    apiBase?: string;
+    /**
+     * Status filter forwarded as `?status=` to the list endpoint. Set to
+     * `'all'` (or undefined) to fetch every row.
+     */
+    status?: PendingActionStatus | 'all';
+    /**
+     * Conversation filter forwarded as `?conversationId=`. Useful for
+     * scoping the inbox to a specific chat thread.
+     */
+    conversationId?: string;
+    /** Hard limit forwarded as `?limit=`. */
+    limit?: number;
+    /**
+     * Extra headers merged into every request (e.g. `X-Environment-Id`,
+     * `Authorization`). Cookies are always sent via `credentials: 'include'`.
+     */
+    headers?: Record<string, string>;
+    /**
+     * Polling interval in ms. `0` disables polling (caller must invoke
+     * `refresh()` manually). Default: 5000.
+     */
+    pollInterval?: number;
+    /** Disable the hook entirely (skips initial fetch + polling). */
+    enabled?: boolean;
+}
+export interface UsePendingActionsReturn {
+    items: PendingActionRow[];
+    total: number;
+    isLoading: boolean;
+    error: Error | undefined;
+    /** Re-fetch the list. Awaitable. */
+    refresh: () => Promise<void>;
+    /**
+     * Approve a row. Resolves with the dispatcher outcome (success or
+     * failed). Re-fetches the list on completion. Throws on transport,
+     * 404, or 409 errors.
+     */
+    approve: (id: string) => Promise<ApproveOutcome>;
+    /**
+     * Reject a row with an optional reason. Re-fetches the list on
+     * completion. Throws on transport, 404, or 409 errors.
+     */
+    reject: (id: string, reason?: string) => Promise<RejectOutcome>;
+}
+/**
+ * Hook that drives the HITL pending-actions inbox.
+ *
+ * @example
+ * ```tsx
+ * const { items, isLoading, error, approve, reject, refresh } =
+ *   usePendingActions({
+ *     apiBase: 'http://localhost:3004/api/v1/ai',
+ *     status: 'pending',
+ *     headers: { 'X-Environment-Id': 'env_local' },
+ *   });
+ * ```
+ */
+export declare function usePendingActions(options?: UsePendingActionsOptions): UsePendingActionsReturn;
+//# sourceMappingURL=usePendingActions.d.ts.map

package/dist/packages/plugin-chatbot/src/usePendingActions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"usePendingActions.d.ts","sourceRoot":"","sources":["../../../../src/usePendingActions.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAoBH,MAAM,MAAM,mBAAmB,GAC3B,SAAS,GACT,UAAU,GACV,UAAU,GACV,QAAQ,GACR,UAAU,CAAC;AAEf;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,uEAAuE;IACvE,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,mBAAmB,GAAG,MAAM,CAAC;IACrC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,UAAU,GAAG,QAAQ,GAAG,MAAM,CAAC;IACvC,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,MAAM,CAAC,EAAE,mBAAmB,GAAG,KAAK,CAAC;IACrC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,yCAAyC;IACzC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iEAAiE;IACjE,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,uBAAuB;IACtC,KAAK,EAAE,gBAAgB,EAAE,CAAC;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,KAAK,GAAG,SAAS,CAAC;IACzB,oCAAoC;IACpC,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7B;;;;OAIG;IACH,OAAO,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IACjD;;;OAGG;IACH,MAAM,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,aAAa,CAAC,CAAC;CACjE;AAgDD;;;;;;;;;;;;GAYG;AACH,wBAAgB,iBAAiB,CAC/B,OAAO,GAAE,wBAA6B,GACrC,uBAAuB,CAiFzB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@object-ui/plugin-chatbot",
-  "version": "5.4.1",
+  "version": "6.0.0",
   "type": "module",
   "license": "MIT",
   "description": "Chatbot interface plugin for Object UI",
@@ -38,10 +38,10 @@
     "shiki": "^4.0.2",
     "streamdown": "^1.4.1",
     "use-stick-to-bottom": "^1.1.1",
-    "@object-ui/components": "5.4.1",
-    "@object-ui/core": "5.4.1",
-    "@object-ui/react": "5.4.1",
-    "@object-ui/types": "5.4.1"
+    "@object-ui/core": "6.0.0",
+    "@object-ui/components": "6.0.0",
+    "@object-ui/react": "6.0.0",
+    "@object-ui/types": "6.0.0"
   },
   "peerDependencies": {
     "react": "^18.0.0 || ^19.0.0",