@object-ui/plugin-chatbot 5.4.2 → 6.0.0

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.2",
+  "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.2",
-    "@object-ui/core": "5.4.2",
-    "@object-ui/react": "5.4.2",
-    "@object-ui/types": "5.4.2"
+    "@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",