doover-js 0.3.0 → 0.4.0

package/dist/react/index.d.ts

@@ -6,6 +6,7 @@ export { useAgentConnections, agentConnectionsQueryKey, } from "./useAgentConnec
 export { useChannelSubscription, } from "./useChannelSubscription";
 export type { ChannelSubscriptionHandlers } from "./useChannelSubscription";
 export { useChannelAggregate, channelAggregateQueryKey, } from "./useChannelAggregate";
+export type { UseChannelAggregateResult } from "./useChannelAggregate";
 export { useAgentChannel } from "./useAgentChannel";
 export { useSendMessage } from "./useSendMessage";
 export { useUpdateAggregate } from "./useUpdateAggregate";

package/dist/react/useAgentChannel.d.ts

@@ -4,4 +4,4 @@ import type { Aggregate } from "../types/common";
  * and channel name as separate arguments — the most common shape at call
  * sites where the identifier isn't already a `ChannelIdentifier`.
  */
-export declare function useAgentChannel<TData extends Aggregate["data"] = Aggregate["data"]>(agentId: string | undefined, channelName: string): import("@tanstack/react-query").UseQueryResult<Aggregate<TData> | undefined>;
+export declare function useAgentChannel<TData = Aggregate["data"]>(agentId: string | undefined, channelName: string): import("./useChannelAggregate").UseChannelAggregateResult<TData>;

package/dist/react/useChannelAggregate.d.ts

@@ -2,12 +2,32 @@ import { type UseQueryResult } from "@tanstack/react-query";
 import type { Aggregate } from "../types/common";
 import type { ChannelIdentifier } from "../types/viewer";
 export declare function channelAggregateQueryKey(agentId: string | undefined, channelName: string | undefined): readonly ["doover", "agent", string | undefined, "channel", string | undefined];
+/**
+ * Shape returned by `useChannelAggregate`. Shadows the react-query
+ * `data` field with the unwrapped aggregate payload (`TData`) so the
+ * common call-site pattern — `const { data } = useChannelAggregate(…)` —
+ * just works without a secondary `.data` access or cast. The
+ * `attachments` and `last_updated` slots are hoisted alongside for the
+ * same reason; everything else (isLoading, isError, refetch, status,
+ * …) passes through from react-query unchanged.
+ */
+export interface UseChannelAggregateResult<TData> extends Omit<UseQueryResult<Aggregate<TData> | undefined>, "data"> {
+    /** The aggregate payload. `undefined` until the first fetch lands. */
+    data: TData | undefined;
+    /** Attachments (files/blobs) on the aggregate. */
+    attachments: Aggregate["attachments"] | undefined;
+    /** Server timestamp (epoch seconds) of the last aggregate update. */
+    last_updated: number | null | undefined;
+}
 /**
  * Fetch a channel's aggregate and keep it live via the gateway. Incoming
  * `channelSync` and `aggregateUpdate` events patch the react-query cache
  * under `channelAggregateQueryKey(agentId, channelName)`.
  *
  * Typed on `TData` — the shape of `aggregate.data`. Defaults to the generic
- * `Record<string, JSONValue>` used by `Aggregate`.
+ * `Record<string, JSONValue>` used by `Aggregate`. No `extends` constraint
+ * on the generic: typed aggregate interfaces (e.g. `{ enabled: boolean }`)
+ * don't have the implicit index signature that `Aggregate["data"]` carries
+ * and enforcing compatibility there just forces `as` casts at call sites.
  */
-export declare function useChannelAggregate<TData extends Aggregate["data"] = Aggregate["data"]>(identifier: ChannelIdentifier): UseQueryResult<Aggregate<TData> | undefined>;
+export declare function useChannelAggregate<TData = Aggregate["data"]>(identifier: ChannelIdentifier): UseChannelAggregateResult<TData>;

package/dist/react/useChannelAggregate.js

@@ -15,7 +15,10 @@ function channelAggregateQueryKey(agentId, channelName) {
  * under `channelAggregateQueryKey(agentId, channelName)`.
  *
  * Typed on `TData` — the shape of `aggregate.data`. Defaults to the generic
- * `Record<string, JSONValue>` used by `Aggregate`.
+ * `Record<string, JSONValue>` used by `Aggregate`. No `extends` constraint
+ * on the generic: typed aggregate interfaces (e.g. `{ enabled: boolean }`)
+ * don't have the implicit index signature that `Aggregate["data"]` carries
+ * and enforcing compatibility there just forces `as` casts at call sites.
  */
 function useChannelAggregate(identifier) {
     const client = (0, context_1.useDooverClient)();
@@ -29,10 +32,18 @@ function useChannelAggregate(identifier) {
     // eslint-disable-next-line react-hooks/exhaustive-deps
     [queryClient, agentId, channelName]);
     (0, useChannelSubscription_1.useChannelSubscription)(identifier, { onAggregate });
-    return (0, react_query_1.useQuery)({
+    const query = (0, react_query_1.useQuery)({
         queryKey: key,
         enabled: !!agentId && !!channelName,
         staleTime: Infinity,
         queryFn: () => client.viewer.getAggregate(identifier),
     });
+    const aggregate = query.data;
+    const { data: _ignored, ...rest } = query;
+    return {
+        ...rest,
+        data: aggregate?.data,
+        attachments: aggregate?.attachments,
+        last_updated: aggregate?.last_updated,
+    };
 }

package/dist/test/react.test.js

@@ -131,7 +131,8 @@ function wrapper(client) {
             wrapper: Wrapper,
         });
         await (0, react_1.waitFor)(() => (0, chai_1.expect)(result.current.isSuccess).to.equal(true));
-        (0, chai_1.expect)(result.current.data?.data).to.deep.equal({ x: 1 });
+        (0, chai_1.expect)(result.current.data).to.deep.equal({ x: 1 });
+        (0, chai_1.expect)(result.current.attachments).to.deep.equal([]);
         // Drive a live aggregate update.
         await (0, react_1.act)(async () => {
             const ws = helpers_1.MockWebSocket.instances[0];
@@ -154,7 +155,7 @@ function wrapper(client) {
                 },
             });
         });
-        await (0, react_1.waitFor)(() => (0, chai_1.expect)(result.current.data?.data).to.deep.equal({ x: 2 }));
+        await (0, react_1.waitFor)(() => (0, chai_1.expect)(result.current.data).to.deep.equal({ x: 2 }));
     });
     (0, mocha_1.it)("useSendMessage posts via MessagesApi", async () => {
         const fetchMock = (0, helpers_1.createFetchMock)((url) => {

package/package.json

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