@rozenite/tanstack-query-plugin 1.7.0-rc.2 → 1.8.0

package/dist/sdk/index.js

@@ -0,0 +1,167 @@
+import { defineAgentToolContract as e, defineAgentToolDescriptors as n } from "@rozenite/agent-shared";
+const i = "@rozenite/tanstack-query-plugin", t = {
+  queryHash: {
+    type: "string",
+    description: "TanStack Query queryHash identifying the query."
+  }
+}, o = {
+  mutationId: {
+    type: "number",
+    description: "TanStack Query mutationId identifying the mutation."
+  }
+}, a = {
+  limit: {
+    type: "number",
+    description: "Maximum number of items to return. Defaults to 20. Maximum 100."
+  },
+  cursor: {
+    type: "string",
+    description: "Opaque pagination cursor from a previous list call."
+  }
+}, r = {
+  type: "object",
+  properties: {}
+}, u = {
+  getCacheSummary: e({
+    name: "get-cache-summary",
+    description: "Return aggregate TanStack Query cache health and count information.",
+    inputSchema: r
+  }),
+  getOnlineStatus: e({
+    name: "get-online-status",
+    description: "Return the current TanStack Query onlineManager status.",
+    inputSchema: r
+  }),
+  setOnlineStatus: e({
+    name: "set-online-status",
+    description: "Set the TanStack Query onlineManager status for testing offline/online behavior.",
+    inputSchema: {
+      type: "object",
+      properties: {
+        online: {
+          type: "boolean",
+          description: "Whether the TanStack Query onlineManager should be online."
+        }
+      },
+      required: ["online"]
+    }
+  }),
+  listQueries: e({
+    name: "list-queries",
+    description: "List TanStack Query query summaries using cursor pagination.",
+    inputSchema: {
+      type: "object",
+      properties: a
+    }
+  }),
+  getQueryDetails: e({
+    name: "get-query-details",
+    description: "Return a JSON-safe TanStack Query query snapshot and observer summary.",
+    inputSchema: {
+      type: "object",
+      properties: t,
+      required: ["queryHash"]
+    }
+  }),
+  refetchQuery: e({
+    name: "refetch-query",
+    description: "Refetch a TanStack Query query by queryHash.",
+    inputSchema: {
+      type: "object",
+      properties: t,
+      required: ["queryHash"]
+    }
+  }),
+  setQueryLoading: e({
+    name: "set-query-loading",
+    description: "Enable or disable TanStack Query loading-state simulation for a query by queryHash.",
+    inputSchema: {
+      type: "object",
+      properties: {
+        ...t,
+        enabled: {
+          type: "boolean",
+          description: "Whether the loading-state simulation should be enabled."
+        }
+      },
+      required: ["queryHash", "enabled"]
+    }
+  }),
+  setQueryError: e({
+    name: "set-query-error",
+    description: "Enable or disable TanStack Query error-state simulation for a query by queryHash.",
+    inputSchema: {
+      type: "object",
+      properties: {
+        ...t,
+        enabled: {
+          type: "boolean",
+          description: "Whether the error-state simulation should be enabled."
+        }
+      },
+      required: ["queryHash", "enabled"]
+    }
+  }),
+  invalidateQuery: e({
+    name: "invalidate-query",
+    description: "Invalidate a TanStack Query query by queryHash.",
+    inputSchema: {
+      type: "object",
+      properties: t,
+      required: ["queryHash"]
+    }
+  }),
+  resetQuery: e({
+    name: "reset-query",
+    description: "Reset a TanStack Query query by queryHash.",
+    inputSchema: {
+      type: "object",
+      properties: t,
+      required: ["queryHash"]
+    }
+  }),
+  removeQuery: e({
+    name: "remove-query",
+    description: "Remove a TanStack Query query from the cache by queryHash.",
+    inputSchema: {
+      type: "object",
+      properties: t,
+      required: ["queryHash"]
+    }
+  }),
+  clearQueryCache: e({
+    name: "clear-query-cache",
+    description: "Clear the full TanStack Query query cache.",
+    inputSchema: r
+  }),
+  listMutations: e({
+    name: "list-mutations",
+    description: "List TanStack Query mutation summaries using cursor pagination.",
+    inputSchema: {
+      type: "object",
+      properties: a
+    }
+  }),
+  getMutationDetails: e({
+    name: "get-mutation-details",
+    description: "Return a JSON-safe TanStack Query mutation snapshot for a mutationId.",
+    inputSchema: {
+      type: "object",
+      properties: o,
+      required: ["mutationId"]
+    }
+  }),
+  clearMutationCache: e({
+    name: "clear-mutation-cache",
+    description: "Clear the full TanStack Query mutation cache.",
+    inputSchema: r
+  })
+}, c = n(
+  i,
+  u
+);
+export {
+  i as TANSTACK_QUERY_AGENT_PLUGIN_ID,
+  u as tanstackQueryToolDefinitions,
+  c as tanstackQueryTools
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rozenite/tanstack-query-plugin",
-  "version": "1.7.0-rc.2",
+  "version": "1.8.0",
   "description": "TanStack Query for Rozenite.",
   "type": "module",
   "main": "./dist/react-native/index.cjs",
@@ -16,8 +16,9 @@
   },
   "dependencies": {
     "fast-deep-equal": "^3.1.3",
-    "@rozenite/agent-bridge": "1.7.0-rc.2",
-    "@rozenite/plugin-bridge": "1.7.0-rc.2"
+    "@rozenite/plugin-bridge": "1.8.0",
+    "@rozenite/agent-bridge": "1.8.0",
+    "@rozenite/agent-shared": "1.8.0"
   },
   "devDependencies": {
     "@tanstack/react-query": "^5.0.0",
@@ -33,8 +34,8 @@
     "tailwindcss-animate": "^1.0.7",
     "typescript": "~5.9.3",
     "vite": "^7.3.1",
-    "@rozenite/vite-plugin": "1.7.0-rc.2",
-    "rozenite": "1.7.0-rc.2"
+    "@rozenite/vite-plugin": "1.8.0",
+    "rozenite": "1.8.0"
   },
   "peerDependencies": {
     "@tanstack/react-query": "^5.0.0",
@@ -48,7 +49,13 @@
       "import": "./dist/react-native/index.js",
       "require": "./dist/react-native/index.cjs"
     },
-    "./package.json": "./package.json"
+    "./package.json": "./package.json",
+    "./sdk": {
+      "development": "./sdk.ts",
+      "types": "./dist/sdk/index.d.ts",
+      "import": "./dist/sdk/index.js",
+      "require": "./dist/sdk/index.cjs"
+    }
   },
   "publishConfig": {
     "access": "public"

package/sdk.ts

@@ -0,0 +1,55 @@
+import { defineAgentToolDescriptors } from '@rozenite/agent-shared';
+import {
+  TANSTACK_QUERY_AGENT_PLUGIN_ID,
+  tanstackQueryToolDefinitions,
+} from './src/shared/agent-tools.js';
+
+export {
+  TANSTACK_QUERY_AGENT_PLUGIN_ID,
+  tanstackQueryToolDefinitions,
+};
+
+export const tanstackQueryTools = defineAgentToolDescriptors(
+  TANSTACK_QUERY_AGENT_PLUGIN_ID,
+  tanstackQueryToolDefinitions,
+);
+
+export type {
+  TanStackQueryActionResult,
+  TanStackQueryAgentMutationIdInput,
+  TanStackQueryAgentOnlineStatusInput,
+  TanStackQueryAgentPaginationInput,
+  TanStackQueryAgentQueryHashInput,
+  TanStackQueryAgentQueryToggleInput,
+  TanStackQueryAgentSafeValue,
+  TanStackQueryCacheSummary,
+  TanStackQueryClearMutationCacheArgs,
+  TanStackQueryClearMutationCacheResult,
+  TanStackQueryClearQueryCacheArgs,
+  TanStackQueryClearQueryCacheResult,
+  TanStackQueryGetCacheSummaryArgs,
+  TanStackQueryGetCacheSummaryResult,
+  TanStackQueryGetMutationDetailsArgs,
+  TanStackQueryGetMutationDetailsResult,
+  TanStackQueryGetOnlineStatusArgs,
+  TanStackQueryGetOnlineStatusResult,
+  TanStackQueryGetQueryDetailsArgs,
+  TanStackQueryGetQueryDetailsResult,
+  TanStackQueryInvalidateQueryArgs,
+  TanStackQueryListMutationsArgs,
+  TanStackQueryListMutationsResult,
+  TanStackQueryListQueriesArgs,
+  TanStackQueryListQueriesResult,
+  TanStackQueryMutationOptionsSummary,
+  TanStackQueryMutationSummary,
+  TanStackQueryObserverOptionsSummary,
+  TanStackQueryPage,
+  TanStackQueryQuerySummary,
+  TanStackQueryRefetchQueryArgs,
+  TanStackQueryRemoveQueryArgs,
+  TanStackQueryResetQueryArgs,
+  TanStackQuerySetOnlineStatusArgs,
+  TanStackQuerySetOnlineStatusResult,
+  TanStackQuerySetQueryErrorArgs,
+  TanStackQuerySetQueryLoadingArgs,
+} from './src/shared/agent-tools.js';

package/src/react-native/agent/__tests__/tanstack-query-agent.test.ts

@@ -5,14 +5,12 @@ import {
   QueryObserver,
   onlineManager,
 } from '@tanstack/react-query';
-import {
-  applyTanStackQueryDevtoolsAction,
-} from '../../devtools-actions';
+import { applyTanStackQueryDevtoolsAction } from '../../devtools-actions';
 import {
   createTanStackQueryAgentController,
   serializeForAgent,
-  TANSTACK_QUERY_AGENT_TOOLS,
 } from '../tanstack-query-agent';
+import { tanstackQueryToolDefinitions } from '../../../shared/agent-tools';
 
 const createQueryClient = () =>
   new QueryClient({
@@ -30,7 +28,7 @@ const createQueryClient = () =>
 
 const subscribeController = (
   queryClient: QueryClient,
-  controller: ReturnType<typeof createTanStackQueryAgentController>
+  controller: ReturnType<typeof createTanStackQueryAgentController>,
 ) => {
   const unsubscribeQuery = queryClient
     .getQueryCache()
@@ -58,7 +56,7 @@ const createMutation = (
     context?: unknown;
     failureCount?: number;
     failureReason?: Error | null;
-  }
+  },
 ) => {
   return queryClient.getMutationCache().build(
     queryClient,
@@ -78,7 +76,7 @@ const createMutation = (
       status: options?.status ?? 'success',
       submittedAt: options?.submittedAt ?? Date.now(),
       variables: options?.variables,
-    } as any
+    } as any,
   ) as Mutation<unknown, Error, unknown, unknown>;
 };
 
@@ -89,7 +87,9 @@ afterEach(() => {
 
 describe('tanstack query agent controller', () => {
   it('exposes the expected tool names', () => {
-    expect(TANSTACK_QUERY_AGENT_TOOLS.map((tool) => tool.name)).toEqual([
+    expect(
+      Object.values(tanstackQueryToolDefinitions).map((tool) => tool.name),
+    ).toEqual([
       'get-cache-summary',
       'get-online-status',
       'set-online-status',
@@ -106,6 +106,10 @@ describe('tanstack query agent controller', () => {
       'get-mutation-details',
       'clear-mutation-cache',
     ]);
+    expect(tanstackQueryToolDefinitions.setQueryLoading.inputSchema.required).toEqual([
+      'queryHash',
+      'enabled',
+    ]);
   });
 
   it('lists queries with cursor pagination and invalidates stale cursors after additions', async () => {
@@ -126,8 +130,10 @@ describe('tanstack query agent controller', () => {
       controller.listQueries({
         limit: 1,
         cursor: firstPage.page.nextCursor,
-      })
-    ).toThrow('Cursor does not match the requested listing. Run the command again.');
+      }),
+    ).toThrow(
+      'Cursor does not match the requested listing. Run the command again.',
+    );
 
     unsubscribe();
   });
@@ -147,8 +153,10 @@ describe('tanstack query agent controller', () => {
       controller.listQueries({
         limit: 1,
         cursor: firstPage.page.nextCursor,
-      })
-    ).toThrow('Cursor does not match the requested listing. Run the command again.');
+      }),
+    ).toThrow(
+      'Cursor does not match the requested listing. Run the command again.',
+    );
 
     queryClient.setQueryData(['third'], { value: 3 });
     queryClient.setQueryData(['fourth'], { value: 4 });
@@ -159,8 +167,10 @@ describe('tanstack query agent controller', () => {
       controller.listQueries({
         limit: 1,
         cursor: secondPageSeed.page.nextCursor,
-      })
-    ).toThrow('Cursor does not match the requested listing. Run the command again.');
+      }),
+    ).toThrow(
+      'Cursor does not match the requested listing. Run the command again.',
+    );
 
     unsubscribe();
   });
@@ -194,8 +204,10 @@ describe('tanstack query agent controller', () => {
       controller.listMutations({
         limit: 1,
         cursor: firstPage.page.nextCursor,
-      })
-    ).toThrow('Cursor does not match the requested listing. Run the command again.');
+      }),
+    ).toThrow(
+      'Cursor does not match the requested listing. Run the command again.',
+    );
 
     const mutation = queryClient.getMutationCache().getAll()[0];
     queryClient.getMutationCache().remove(mutation);
@@ -207,8 +219,10 @@ describe('tanstack query agent controller', () => {
       controller.listMutations({
         limit: 1,
         cursor: secondPageSeed.page.nextCursor,
-      })
-    ).toThrow('Cursor does not match the requested listing. Run the command again.');
+      }),
+    ).toThrow(
+      'Cursor does not match the requested listing. Run the command again.',
+    );
 
     unsubscribe();
   });
@@ -234,8 +248,9 @@ describe('tanstack query agent controller', () => {
       queryFn,
     });
 
-    const queryHash = queryClient.getQueryCache().find({ queryKey: ['todos', 1] })!
-      .queryHash;
+    const queryHash = queryClient
+      .getQueryCache()
+      .find({ queryKey: ['todos', 1] })!.queryHash;
     const details = controller.getQueryDetails({ queryHash });
 
     expect(details.query).toMatchObject({
@@ -299,9 +314,9 @@ describe('tanstack query agent controller', () => {
       },
     });
 
-    expect(() =>
-      controller.getMutationDetails({ mutationId: 9999 })
-    ).toThrow('Unknown mutationId "9999"');
+    expect(() => controller.getMutationDetails({ mutationId: 9999 })).toThrow(
+      'Unknown mutationId "9999"',
+    );
 
     unsubscribe();
   });
@@ -310,9 +325,9 @@ describe('tanstack query agent controller', () => {
     const queryClient = createQueryClient();
     const controller = createTanStackQueryAgentController(queryClient);
 
-    expect(() =>
-      controller.getQueryDetails({ queryHash: 'missing' })
-    ).toThrow('Unknown queryHash "missing"');
+    expect(() => controller.getQueryDetails({ queryHash: 'missing' })).toThrow(
+      'Unknown queryHash "missing"',
+    );
   });
 
   it('gets and sets the online manager status', () => {
@@ -461,6 +476,37 @@ describe('tanstack query agent actions', () => {
     });
   });
 
+  it('sets query data through the shared UI dispatcher', async () => {
+    const queryClient = createQueryClient();
+
+    await queryClient.fetchQuery({
+      queryKey: ['editable-query'],
+      queryFn: async () => ({ value: 'initial' }),
+      initialData: { value: 'initial' },
+    });
+
+    const query = queryClient.getQueryCache().find({
+      queryKey: ['editable-query'],
+    })!;
+
+    const result = await applyTanStackQueryDevtoolsAction(queryClient, {
+      type: 'SET_QUERY_DATA',
+      queryHash: query.queryHash,
+      metadata: {
+        data: { value: 'changed' },
+      },
+    });
+
+    expect(result).toMatchObject({
+      applied: true,
+      action: 'SET_QUERY_DATA',
+      queryHash: query.queryHash,
+    });
+    expect(queryClient.getQueryData(['editable-query'])).toEqual({
+      value: 'changed',
+    });
+  });
+
   it('clears mutation cache through the shared UI/agent dispatcher', async () => {
     const queryClient = createQueryClient();
     createMutation(queryClient, {
@@ -501,8 +547,6 @@ describe('serializeForAgent', () => {
       ok: true,
       self: '[circular]',
     });
-    expect(serializeForAgent(new Example())).toBe(
-      '[non-serializable:Example]'
-    );
+    expect(serializeForAgent(new Example())).toBe('[non-serializable:Example]');
   });
 });