doover-js 0.4.0 → 0.4.2

package/dist/gateway/gateway-client.js

@@ -243,7 +243,7 @@ class GatewayClient {
                 this.emit("messageCreate", (0, snowflake_1.addTimestampToMessage)(message.d));
                 break;
             case "MessageUpdate":
-                this.emit("messageUpdate", (0, snowflake_1.addTimestampToMessage)(message.d));
+                this.emit("messageUpdate", (0, snowflake_1.addTimestampToMessage)(message.d.message), message.d.request_data);
                 break;
             case "AggregateUpdate":
                 this.emit("aggregateUpdate", message.d);

package/dist/gateway/types.d.ts

@@ -38,10 +38,20 @@ export interface GatewayMessageCreate extends GatewayMessageBase {
     t: "MessageCreate";
     d: Omit<MessageStructure, "timestamp">;
 }
+/**
+ * `message` is the full post-update MessageStructure; `request_data` is the
+ * diff of just-changed fields. Consumers should read `message` for the
+ * current state and only touch `request_data` if they specifically need to
+ * know what changed in this update.
+ */
 export interface GatewayMessageUpdate extends GatewayMessageBase {
     op: 0;
     t: "MessageUpdate";
-    d: Omit<MessageStructure, "timestamp"> & {
+    d: {
+        channel: ChannelRef;
+        author_id: string;
+        organisation_id?: string;
+        message: Omit<MessageStructure, "timestamp">;
         request_data: JSONValue;
     };
 }
@@ -119,9 +129,7 @@ export interface GatewayListenerMap {
     ready: (event: GatewayReady["d"]) => void;
     channelSync: (event: GatewayChannelSync["d"]) => void;
     messageCreate: (event: MessageStructure) => void;
-    messageUpdate: (event: GatewayMessageUpdate["d"] & {
-        timestamp: number;
-    }) => void;
+    messageUpdate: (message: MessageStructure, request_data: JSONValue | undefined) => void;
     aggregateUpdate: (event: GatewayAggregateUpdate["d"]) => void;
     alarmTrigger: (event: GatewayAlarmTrigger["d"]) => void;
     oneShotMessage: (event: GatewayOneShotMessage["d"]) => void;

package/dist/react/index.d.ts

@@ -15,6 +15,8 @@ export { useUpdateMessage } from "./useUpdateMessage";
 export type { UpdateMessageVariables, UseUpdateMessageOptions, } from "./useUpdateMessage";
 export { useChannelMessages, channelMessagesQueryKey, } from "./useChannelMessages";
 export type { UseChannelMessagesOptions, UseChannelMessagesResult, } from "./useChannelMessages";
+export { useChannelMessage, channelMessageQueryKey, } from "./useChannelMessage";
+export type { UseChannelMessageOptions, UseChannelMessageResult, } from "./useChannelMessage";
 export { useSendRpc } from "./useSendRpc";
 export type { RpcCommandId, RpcStatusEvent, SendRpcVariables, UseSendRpcOptions, UseSendRpcResult, } from "./useSendRpc";
 export { useMultiAgentAggregates, multiAgentAggregatesQueryKey, } from "./useMultiAgentAggregates";

package/dist/react/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.resetSharedQueryClient = exports.getSharedQueryClient = exports.useTurnCredentials = exports.multiAgentChannelMessagesQueryKey = exports.useMultiAgentChannelMessages = exports.multiAgentAggregatesQueryKey = exports.useMultiAgentAggregates = exports.useSendRpc = exports.channelMessagesQueryKey = exports.useChannelMessages = exports.useUpdateMessage = exports.useUpdateAggregate = exports.useSendMessage = exports.useAgentChannel = exports.channelAggregateQueryKey = exports.useChannelAggregate = exports.useChannelSubscription = exports.agentConnectionsQueryKey = exports.useAgentConnections = exports.useConnectionState = exports.useDooverClient = exports.DooverProvider = void 0;
+exports.resetSharedQueryClient = exports.getSharedQueryClient = exports.useTurnCredentials = exports.multiAgentChannelMessagesQueryKey = exports.useMultiAgentChannelMessages = exports.multiAgentAggregatesQueryKey = exports.useMultiAgentAggregates = exports.useSendRpc = exports.channelMessageQueryKey = exports.useChannelMessage = exports.channelMessagesQueryKey = exports.useChannelMessages = exports.useUpdateMessage = exports.useUpdateAggregate = exports.useSendMessage = exports.useAgentChannel = exports.channelAggregateQueryKey = exports.useChannelAggregate = exports.useChannelSubscription = exports.agentConnectionsQueryKey = exports.useAgentConnections = exports.useConnectionState = exports.useDooverClient = exports.DooverProvider = void 0;
 var context_1 = require("./context");
 Object.defineProperty(exports, "DooverProvider", { enumerable: true, get: function () { return context_1.DooverProvider; } });
 Object.defineProperty(exports, "useDooverClient", { enumerable: true, get: function () { return context_1.useDooverClient; } });
@@ -25,6 +25,9 @@ Object.defineProperty(exports, "useUpdateMessage", { enumerable: true, get: func
 var useChannelMessages_1 = require("./useChannelMessages");
 Object.defineProperty(exports, "useChannelMessages", { enumerable: true, get: function () { return useChannelMessages_1.useChannelMessages; } });
 Object.defineProperty(exports, "channelMessagesQueryKey", { enumerable: true, get: function () { return useChannelMessages_1.channelMessagesQueryKey; } });
+var useChannelMessage_1 = require("./useChannelMessage");
+Object.defineProperty(exports, "useChannelMessage", { enumerable: true, get: function () { return useChannelMessage_1.useChannelMessage; } });
+Object.defineProperty(exports, "channelMessageQueryKey", { enumerable: true, get: function () { return useChannelMessage_1.channelMessageQueryKey; } });
 var useSendRpc_1 = require("./useSendRpc");
 Object.defineProperty(exports, "useSendRpc", { enumerable: true, get: function () { return useSendRpc_1.useSendRpc; } });
 var useMultiAgentAggregates_1 = require("./useMultiAgentAggregates");

package/dist/react/useChannelMessage.d.ts

@@ -0,0 +1,38 @@
+import { type UseQueryResult } from "@tanstack/react-query";
+import type { JSONValue, MessageAttachment, MessageStructure } from "../types/common";
+import type { ChannelIdentifier } from "../types/viewer";
+export declare function channelMessageQueryKey(agentId: string | undefined, channelName: string | undefined, messageId: string | undefined): readonly ["doover", "agent", string | undefined, "channel", string | undefined, "message", string | undefined];
+export interface UseChannelMessageOptions {
+    /** If false, skip subscribing for live message-update events. Defaults true. */
+    liveUpdates?: boolean;
+}
+/**
+ * Shape returned by `useChannelMessage`. Mirrors `UseChannelAggregateResult`:
+ * `data` is unwrapped to the message payload (`message.data`) so the common
+ * `const { data } = useChannelMessage(…)` pattern works without a secondary
+ * access. The full `MessageStructure` and a couple of useful slots
+ * (`attachments`, `timestamp`) are hoisted alongside.
+ */
+export interface UseChannelMessageResult<TData> extends Omit<UseQueryResult<MessageStructure<TData> | undefined>, "data"> {
+    /** Unwrapped message payload (`message.data`). Undefined until first fetch. */
+    data: TData | undefined;
+    /** Full message structure, or undefined until first fetch. */
+    message: MessageStructure<TData> | undefined;
+    attachments: MessageAttachment[] | undefined;
+    /** Server timestamp reported by the message. */
+    timestamp: number | undefined;
+}
+/**
+ * Fetch a single channel message by id and keep it live via gateway
+ * `MessageUpdate` events. Mirrors `useChannelAggregate`'s pattern: REST seeds
+ * the cache, then `onMessageUpdate` patches it whenever the message body is
+ * mutated server-side — handy for watching long-running RPC-style messages
+ * where the receiver writes progress into a `response` field.
+ *
+ * Channel subscriptions deliver every message in the channel, so the
+ * handlers filter to the requested `messageId` before patching the cache.
+ *
+ * Typed on `TData` — the shape of `message.data`. Defaults to `JSONValue` to
+ * match `MessageStructure`.
+ */
+export declare function useChannelMessage<TData = JSONValue>(identifier: ChannelIdentifier, messageId: string | undefined, options?: UseChannelMessageOptions): UseChannelMessageResult<TData>;

package/dist/react/useChannelMessage.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.channelMessageQueryKey = channelMessageQueryKey;
+exports.useChannelMessage = useChannelMessage;
+const react_1 = require("react");
+const react_query_1 = require("@tanstack/react-query");
+const context_1 = require("./context");
+const useChannelSubscription_1 = require("./useChannelSubscription");
+function channelMessageQueryKey(agentId, channelName, messageId) {
+    return [
+        "doover",
+        "agent",
+        agentId,
+        "channel",
+        channelName,
+        "message",
+        messageId,
+    ];
+}
+/**
+ * Fetch a single channel message by id and keep it live via gateway
+ * `MessageUpdate` events. Mirrors `useChannelAggregate`'s pattern: REST seeds
+ * the cache, then `onMessageUpdate` patches it whenever the message body is
+ * mutated server-side — handy for watching long-running RPC-style messages
+ * where the receiver writes progress into a `response` field.
+ *
+ * Channel subscriptions deliver every message in the channel, so the
+ * handlers filter to the requested `messageId` before patching the cache.
+ *
+ * Typed on `TData` — the shape of `message.data`. Defaults to `JSONValue` to
+ * match `MessageStructure`.
+ */
+function useChannelMessage(identifier, messageId, options) {
+    const client = (0, context_1.useDooverClient)();
+    const queryClient = (0, react_query_1.useQueryClient)();
+    const { agentId, channelName } = identifier;
+    const liveUpdates = options?.liveUpdates ?? true;
+    const key = channelMessageQueryKey(agentId, channelName, messageId);
+    const onMessageUpdate = (0, react_1.useCallback)((message) => {
+        if (message.id !== messageId)
+            return;
+        queryClient.setQueryData(key, message);
+    }, 
+    // The key array is structurally stable per (agentId, channelName, messageId).
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    [queryClient, agentId, channelName, messageId]);
+    // Cover the case where the caller has the id before the create event has
+    // landed on this client — patch the cache when it shows up.
+    const onMessage = (0, react_1.useCallback)((message) => {
+        if (message.id !== messageId)
+            return;
+        queryClient.setQueryData(key, message);
+    }, 
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    [queryClient, agentId, channelName, messageId]);
+    (0, useChannelSubscription_1.useChannelSubscription)(liveUpdates && messageId ? identifier : undefined, { onMessage, onMessageUpdate });
+    const query = (0, react_query_1.useQuery)({
+        queryKey: key,
+        enabled: !!agentId && !!channelName && !!messageId,
+        staleTime: Infinity,
+        queryFn: () => client.messages.getMessage(agentId, channelName, messageId),
+    });
+    const message = query.data;
+    const { data: _ignored, ...rest } = query;
+    return {
+        ...rest,
+        data: message?.data,
+        message,
+        attachments: message?.attachments,
+        timestamp: message?.timestamp,
+    };
+}

package/dist/react/useChannelSubscription.d.ts

@@ -1,8 +1,13 @@
-import type { Aggregate, MessageStructure } from "../types/common";
+import type { Aggregate, JSONValue, MessageStructure } from "../types/common";
 import type { ChannelIdentifier } from "../types/viewer";
 export interface ChannelSubscriptionHandlers {
     onMessage?: (message: MessageStructure) => void;
-    onMessageUpdate?: (message: MessageStructure) => void;
+    /**
+     * Fires on server-side MessageUpdate events. `message` is the full updated
+     * MessageStructure; `request_data` (optional) is the diff of what changed
+     * in this specific update. Most consumers only need `message`.
+     */
+    onMessageUpdate?: (message: MessageStructure, request_data?: JSONValue) => void;
     onAggregate?: (aggregate: Aggregate) => void;
 }
 /**

package/dist/react/useChannelSubscription.js

@@ -24,8 +24,8 @@ function useChannelSubscription(identifier, handlers) {
         const aggregateCallback = (_id, aggregate) => {
             handlersRef.current.onAggregate?.(aggregate);
         };
-        const messageUpdateCallback = (_id, message) => {
-            handlersRef.current.onMessageUpdate?.(message);
+        const messageUpdateCallback = (_id, message, request_data) => {
+            handlersRef.current.onMessageUpdate?.(message, request_data);
         };
         void client.viewer.subscribeToChannel(identifier, messageCallback, aggregateCallback, messageUpdateCallback);
         return () => {

package/dist/test/doover-data-provider.test.js

@@ -289,36 +289,44 @@ const helpers_1 = require("./helpers");
             op: 0,
             t: "MessageUpdate",
             d: {
-                id: rpcId,
-                author_id: "u1",
                 channel: { agent_id: "a1", name: "c1" },
-                data: {
-                    type: "rpc",
-                    method: "ping",
-                    request: {},
-                    status: { code: "acknowledged", message: { timestamp: 1 } },
-                    response: {},
+                author_id: "u1",
+                message: {
+                    id: rpcId,
+                    author_id: "u1",
+                    channel: { agent_id: "a1", name: "c1" },
+                    data: {
+                        type: "rpc",
+                        method: "ping",
+                        request: {},
+                        status: { code: "acknowledged", message: { timestamp: 1 } },
+                        response: {},
+                    },
+                    attachments: [],
                 },
-                attachments: [],
-                request_data: {},
+                request_data: { status: { code: "acknowledged", message: { timestamp: 1 } } },
             },
         });
         ws.receive({
             op: 0,
             t: "MessageUpdate",
             d: {
-                id: rpcId,
-                author_id: "u1",
                 channel: { agent_id: "a1", name: "c1" },
-                data: {
-                    type: "rpc",
-                    method: "ping",
-                    request: {},
-                    status: { code: "success" },
-                    response: { pong: true },
+                author_id: "u1",
+                message: {
+                    id: rpcId,
+                    author_id: "u1",
+                    channel: { agent_id: "a1", name: "c1" },
+                    data: {
+                        type: "rpc",
+                        method: "ping",
+                        request: {},
+                        status: { code: "success" },
+                        response: { pong: true },
+                    },
+                    attachments: [],
                 },
-                attachments: [],
-                request_data: {},
+                request_data: { status: { code: "success" }, response: { pong: true } },
             },
         });
         await (0, chai_1.expect)(promise).to.eventually.deep.equal({ pong: true });
@@ -366,18 +374,22 @@ const helpers_1 = require("./helpers");
             op: 0,
             t: "MessageUpdate",
             d: {
-                id: rpcId,
-                author_id: "u1",
                 channel: { agent_id: "a1", name: "c1" },
-                data: {
-                    type: "rpc",
-                    method: "ping",
-                    request: {},
-                    status: { code: "error", message: "boom" },
-                    response: {},
+                author_id: "u1",
+                message: {
+                    id: rpcId,
+                    author_id: "u1",
+                    channel: { agent_id: "a1", name: "c1" },
+                    data: {
+                        type: "rpc",
+                        method: "ping",
+                        request: {},
+                        status: { code: "error", message: "boom" },
+                        response: {},
+                    },
+                    attachments: [],
                 },
-                attachments: [],
-                request_data: {},
+                request_data: { status: { code: "error", message: "boom" } },
             },
         });
         await (0, chai_1.expect)(promise).to.eventually.be.rejectedWith("boom");

package/dist/test/gateway-client.test.js

@@ -115,12 +115,16 @@ const helpers_1 = require("./helpers");
             op: 0,
             t: "MessageUpdate",
             d: {
-                id,
-                author_id: "u1",
                 channel: { agent_id: "a1", name: "c1" },
-                data: {},
-                attachments: [],
-                request_data: {},
+                author_id: "u1",
+                message: {
+                    id,
+                    author_id: "u1",
+                    channel: { agent_id: "a1", name: "c1" },
+                    data: { full: true },
+                    attachments: [],
+                },
+                request_data: { diff: true },
             },
         });
         ws.receive({
@@ -195,7 +199,7 @@ const helpers_1 = require("./helpers");
         });
         (0, chai_1.expect)(channelSync.calledOnce).to.equal(true);
         (0, chai_1.expect)(messageCreate.calledWithMatch(sinon_1.default.match({ id, timestamp: sinon_1.default.match.number }))).to.equal(true);
-        (0, chai_1.expect)(messageUpdate.calledWithMatch(sinon_1.default.match({ id, timestamp: sinon_1.default.match.number }))).to.equal(true);
+        (0, chai_1.expect)(messageUpdate.calledWithMatch(sinon_1.default.match({ id, data: { full: true }, timestamp: sinon_1.default.match.number }), sinon_1.default.match({ diff: true }))).to.equal(true);
         (0, chai_1.expect)(aggregateUpdate.calledOnce).to.equal(true);
         (0, chai_1.expect)(alarmTrigger.calledOnce).to.equal(true);
         (0, chai_1.expect)(oneShot.calledOnce).to.equal(true);

package/dist/test/react.test.js

@@ -270,6 +270,72 @@ function wrapper(client) {
             liveId,
         ]));
     });
+    (0, mocha_1.it)("useChannelMessage seeds via REST and patches on MessageUpdate", async () => {
+        const messageId = (0, snowflake_1.generateSnowflakeIdAtTime)(new Date("2026-01-01T00:00:00.000Z"));
+        const otherId = (0, snowflake_1.generateSnowflakeIdAtTime)(new Date("2026-01-01T00:00:01.000Z"));
+        const fetchMock = (0, helpers_1.createFetchMock)(() => (0, helpers_1.createJsonResponse)({
+            id: messageId,
+            author_id: "u1",
+            channel: { agent_id: "a1", name: "rpc" },
+            data: { method: "ping", response: { status: "pulling" } },
+            attachments: [],
+        }));
+        const client = new doover_client_1.DooverClient({
+            dataRestUrl: "https://api.example.com",
+            controlApiUrl: "https://control.example.com",
+            dataWssUrl: "wss://ws.example.com",
+            fetchImpl: fetchMock,
+            webSocketImpl: helpers_1.MockWebSocket,
+            disableBrowserLifecycleHooks: true,
+        });
+        const { result } = (0, react_1.renderHook)(() => (0, react_2.useChannelMessage)({ agentId: "a1", channelName: "rpc" }, messageId), { wrapper: wrapper(client) });
+        await (0, react_1.waitFor)(() => (0, chai_1.expect)(result.current.isSuccess).to.equal(true));
+        (0, chai_1.expect)(result.current.data?.response?.status).to.equal("pulling");
+        (0, chai_1.expect)(result.current.message?.id).to.equal(messageId);
+        await (0, react_1.act)(async () => {
+            const ws = helpers_1.MockWebSocket.instances[0];
+            ws.open();
+            ws.receive({ op: 0, t: "Hello", d: {} });
+            ws.receive({
+                op: 0,
+                t: "Ready",
+                d: { session_id: "s1", session_token: "t1", subscriptions: [] },
+            });
+            // Update for an unrelated message — should be ignored.
+            ws.receive({
+                op: 0,
+                t: "MessageUpdate",
+                d: {
+                    channel: { agent_id: "a1", name: "rpc" },
+                    author_id: "u1",
+                    message: {
+                        id: otherId,
+                        author_id: "u1",
+                        channel: { agent_id: "a1", name: "rpc" },
+                        data: { method: "ping", response: { status: "success" } },
+                        attachments: [],
+                    },
+                },
+            });
+            // Update for the message we're watching — should patch.
+            ws.receive({
+                op: 0,
+                t: "MessageUpdate",
+                d: {
+                    channel: { agent_id: "a1", name: "rpc" },
+                    author_id: "u1",
+                    message: {
+                        id: messageId,
+                        author_id: "u1",
+                        channel: { agent_id: "a1", name: "rpc" },
+                        data: { method: "ping", response: { status: "success" } },
+                        attachments: [],
+                    },
+                },
+            });
+        });
+        await (0, react_1.waitFor)(() => (0, chai_1.expect)(result.current.data?.response?.status).to.equal("success"));
+    });
     (0, mocha_1.it)("getSharedQueryClient returns the same QueryClient across callers", () => {
         (0, react_2.resetSharedQueryClient)();
         const a = (0, react_2.getSharedQueryClient)();
@@ -328,18 +394,22 @@ function wrapper(client) {
                 op: 0,
                 t: "MessageUpdate",
                 d: {
-                    id: rpcId,
-                    author_id: "u1",
                     channel: { agent_id: "a1", name: "ui_cmds" },
-                    data: {
-                        type: "rpc",
-                        method: "ping",
-                        request: {},
-                        status: { code: "success" },
-                        response: { pong: true },
+                    author_id: "u1",
+                    message: {
+                        id: rpcId,
+                        author_id: "u1",
+                        channel: { agent_id: "a1", name: "ui_cmds" },
+                        data: {
+                            type: "rpc",
+                            method: "ping",
+                            request: {},
+                            status: { code: "success" },
+                            response: { pong: true },
+                        },
+                        attachments: [],
                     },
-                    attachments: [],
-                    request_data: {},
+                    request_data: { status: { code: "success" }, response: { pong: true } },
                 },
             });
             return promise;

package/dist/viewer/doover-data-provider.d.ts

@@ -6,12 +6,17 @@ import { MessagesApi, type ListMessagesParams } from "../apis/messages-api";
 import type { DooverAuth } from "../auth/doover-auth";
 import { GatewayClient } from "../gateway/gateway-client";
 import { RestClient, type DooverClientConfig } from "../http/rest-client";
-import type { Aggregate, Channel, ConnectionDetails, MessageStructure, RpcRequest, RpcStatus } from "../types/common";
+import type { Aggregate, Channel, ConnectionDetails, JSONValue, MessageStructure, RpcRequest, RpcStatus } from "../types/common";
 import type { Agent, AgentsResponse, ChannelIdentifier, ChannelsDataProvider, SubscriptionDetails, User } from "../types/viewer";
 interface SubscriptionEntry {
     messageCallback: (identifier: ChannelIdentifier, message: MessageStructure) => void;
     aggregateCallback: (identifier: ChannelIdentifier, aggregate: Aggregate) => void;
-    messageUpdateCallback?: (identifier: ChannelIdentifier, message: MessageStructure) => void;
+    /**
+     * `message` is the full post-update MessageStructure (server-side `.message`
+     * field). `request_data` is the diff of just-changed fields, or undefined
+     * if the server didn't provide one. Most consumers only need `message`.
+     */
+    messageUpdateCallback?: (identifier: ChannelIdentifier, message: MessageStructure, request_data?: JSONValue) => void;
 }
 export declare class DooverDataProvider implements ChannelsDataProvider<ChannelIdentifier> {
     private readonly config;

package/dist/viewer/doover-data-provider.js

@@ -34,10 +34,10 @@ class DooverDataProvider {
             const identifier = this.toIdentifier(message.channel.agent_id, message.channel.name);
             this.subscriptions.get(key)?.forEach((entry) => entry.messageCallback(identifier, message));
         });
-        this.gateway.on("messageUpdate", (message) => {
+        this.gateway.on("messageUpdate", (message, request_data) => {
             const key = this.channelKey(message.channel.agent_id, message.channel.name);
             const identifier = this.toIdentifier(message.channel.agent_id, message.channel.name);
-            this.subscriptions.get(key)?.forEach((entry) => entry.messageUpdateCallback?.(identifier, message));
+            this.subscriptions.get(key)?.forEach((entry) => entry.messageUpdateCallback?.(identifier, message, request_data));
         });
         this.gateway.on("channelSync", (event) => {
             const key = this.channelKey(event.channel.agent_id, event.channel.name);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "doover-js",
-  "version": "0.4.0",
+  "version": "0.4.2",
   "description": "TypeScript client for Doover.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",