@rozenite/tanstack-query-plugin 1.7.0 → 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",
+  "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",
-    "@rozenite/plugin-bridge": "1.7.0"
+    "@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",
-    "rozenite": "1.7.0"
+    "@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

@@ -9,8 +9,8 @@ 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({
@@ -87,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',
@@ -104,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 () => {

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

@@ -1,7 +1,3 @@
-import type {
-  AgentTool,
-  JSONSchema7,
-} from '@rozenite/agent-bridge';
 import type {
   Mutation,
   MutationCacheNotifyEvent,
@@ -13,47 +9,28 @@ import type {
 } from '@tanstack/react-query';
 import { onlineManager } from '@tanstack/react-query';
 import { applyTanStackQueryDevtoolsAction } from '../devtools-actions';
+import {
+  tanstackQueryToolDefinitions,
+  type TanStackQueryAgentMutationIdInput as MutationIdInput,
+  type TanStackQueryAgentOnlineStatusInput as OnlineStatusInput,
+  type TanStackQueryAgentPaginationInput as PaginationInput,
+  type TanStackQueryAgentQueryHashInput as QueryHashInput,
+  type TanStackQueryAgentQueryToggleInput as QueryToggleInput,
+  type TanStackQueryAgentSafeValue as AgentSafeValue,
+  type TanStackQueryMutationOptionsSummary,
+  type TanStackQueryObserverOptionsSummary,
+} from '../../shared/agent-tools';
 
-const pluginId = '@rozenite/tanstack-query-plugin';
 const DEFAULT_PAGE_LIMIT = 20;
 const MAX_PAGE_LIMIT = 100;
 
 type CursorKind = 'queries' | 'mutations';
 
-type PaginationInput = {
-  limit?: number;
-  cursor?: string;
-};
-
-type QueryHashInput = {
-  queryHash: string;
-};
-
-type QueryToggleInput = QueryHashInput & {
-  enabled: boolean;
-};
-
-type MutationIdInput = {
-  mutationId: number;
-};
-
-type OnlineStatusInput = {
-  online: boolean;
-};
-
 type CursorState = {
   queriesGeneration: number;
   mutationsGeneration: number;
 };
 
-type AgentSafeValue =
-  | null
-  | boolean
-  | number
-  | string
-  | AgentSafeValue[]
-  | { [key: string]: AgentSafeValue };
-
 const isPlainObject = (value: unknown): value is Record<string, unknown> => {
   return (
     !!value &&
@@ -212,202 +189,30 @@ const paginate = <T>(
   };
 };
 
-const queryActionProperties = {
-  queryHash: {
-    type: 'string',
-    description: 'TanStack Query queryHash identifying the query.',
-  },
-} satisfies Record<string, JSONSchema7>;
-
-const mutationActionProperties = {
-  mutationId: {
-    type: 'number',
-    description: 'TanStack Query mutationId identifying the mutation.',
-  },
-} satisfies Record<string, JSONSchema7>;
-
-const paginationProperties = {
-  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.',
-  },
-} satisfies Record<string, JSONSchema7>;
-
-const emptyInputSchema: JSONSchema7 = {
-  type: 'object',
-  properties: {},
-};
-
-export const getCacheSummaryTool: AgentTool = {
-  name: 'get-cache-summary',
-  description:
-    'Return aggregate TanStack Query cache health and count information.',
-  inputSchema: emptyInputSchema,
-};
-
-export const getOnlineStatusTool: AgentTool = {
-  name: 'get-online-status',
-  description: 'Return the current TanStack Query onlineManager status.',
-  inputSchema: emptyInputSchema,
-};
-
-export const setOnlineStatusTool: AgentTool = {
-  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'],
-  },
-};
-
-export const listQueriesTool: AgentTool = {
-  name: 'list-queries',
-  description:
-    'List TanStack Query query summaries using cursor pagination.',
-  inputSchema: {
-    type: 'object',
-    properties: paginationProperties,
-  },
-};
-
-export const getQueryDetailsTool: AgentTool = {
-  name: 'get-query-details',
-  description:
-    'Return a JSON-safe TanStack Query query snapshot and observer summary.',
-  inputSchema: {
-    type: 'object',
-    properties: queryActionProperties,
-    required: ['queryHash'],
-  },
-};
-
-export const refetchQueryTool: AgentTool = {
-  name: 'refetch-query',
-  description: 'Refetch a TanStack Query query by queryHash.',
-  inputSchema: {
-    type: 'object',
-    properties: queryActionProperties,
-    required: ['queryHash'],
-  },
-};
-
-export const setQueryLoadingTool: AgentTool = {
-  name: 'set-query-loading',
-  description:
-    'Enable or disable TanStack Query loading-state simulation for a query by queryHash.',
-  inputSchema: {
-    type: 'object',
-    properties: queryActionProperties,
-    required: ['queryHash', 'enabled'],
-  },
-};
-
-export const setQueryErrorTool: AgentTool = {
-  name: 'set-query-error',
-  description:
-    'Enable or disable TanStack Query error-state simulation for a query by queryHash.',
-  inputSchema: {
-    type: 'object',
-    properties: queryActionProperties,
-    required: ['queryHash', 'enabled'],
-  },
-};
-
-export const invalidateQueryTool: AgentTool = {
-  name: 'invalidate-query',
-  description: 'Invalidate a TanStack Query query by queryHash.',
-  inputSchema: {
-    type: 'object',
-    properties: queryActionProperties,
-    required: ['queryHash'],
-  },
-};
-
-export const resetQueryTool: AgentTool = {
-  name: 'reset-query',
-  description: 'Reset a TanStack Query query by queryHash.',
-  inputSchema: {
-    type: 'object',
-    properties: queryActionProperties,
-    required: ['queryHash'],
-  },
-};
-
-export const removeQueryTool: AgentTool = {
-  name: 'remove-query',
-  description: 'Remove a TanStack Query query from the cache by queryHash.',
-  inputSchema: {
-    type: 'object',
-    properties: queryActionProperties,
-    required: ['queryHash'],
-  },
-};
-
-export const clearQueryCacheTool: AgentTool = {
-  name: 'clear-query-cache',
-  description: 'Clear the full TanStack Query query cache.',
-  inputSchema: emptyInputSchema,
-};
-
-export const listMutationsTool: AgentTool = {
-  name: 'list-mutations',
-  description:
-    'List TanStack Query mutation summaries using cursor pagination.',
-  inputSchema: {
-    type: 'object',
-    properties: paginationProperties,
-  },
-};
-
-export const getMutationDetailsTool: AgentTool = {
-  name: 'get-mutation-details',
-  description:
-    'Return a JSON-safe TanStack Query mutation snapshot for a mutationId.',
-  inputSchema: {
-    type: 'object',
-    properties: mutationActionProperties,
-    required: ['mutationId'],
-  },
-};
-
-export const clearMutationCacheTool: AgentTool = {
-  name: 'clear-mutation-cache',
-  description: 'Clear the full TanStack Query mutation cache.',
-  inputSchema: emptyInputSchema,
-};
-
-export const TANSTACK_QUERY_AGENT_TOOLS: AgentTool[] = [
-  getCacheSummaryTool,
-  getOnlineStatusTool,
-  setOnlineStatusTool,
-  listQueriesTool,
-  getQueryDetailsTool,
-  refetchQueryTool,
-  setQueryLoadingTool,
-  setQueryErrorTool,
-  invalidateQueryTool,
-  resetQueryTool,
-  removeQueryTool,
-  clearQueryCacheTool,
-  listMutationsTool,
-  getMutationDetailsTool,
-  clearMutationCacheTool,
-];
+export const getCacheSummaryTool = tanstackQueryToolDefinitions.getCacheSummary;
+export const getOnlineStatusTool = tanstackQueryToolDefinitions.getOnlineStatus;
+export const setOnlineStatusTool = tanstackQueryToolDefinitions.setOnlineStatus;
+export const listQueriesTool = tanstackQueryToolDefinitions.listQueries;
+export const getQueryDetailsTool = tanstackQueryToolDefinitions.getQueryDetails;
+export const refetchQueryTool = tanstackQueryToolDefinitions.refetchQuery;
+export const setQueryLoadingTool = tanstackQueryToolDefinitions.setQueryLoading;
+export const setQueryErrorTool = tanstackQueryToolDefinitions.setQueryError;
+export const invalidateQueryTool = tanstackQueryToolDefinitions.invalidateQuery;
+export const resetQueryTool = tanstackQueryToolDefinitions.resetQuery;
+export const removeQueryTool = tanstackQueryToolDefinitions.removeQuery;
+export const clearQueryCacheTool = tanstackQueryToolDefinitions.clearQueryCache;
+export const listMutationsTool = tanstackQueryToolDefinitions.listMutations;
+export const getMutationDetailsTool =
+  tanstackQueryToolDefinitions.getMutationDetails;
+export const clearMutationCacheTool =
+  tanstackQueryToolDefinitions.clearMutationCache;
+export const TANSTACK_QUERY_AGENT_TOOLS = Object.values(
+  tanstackQueryToolDefinitions,
+);
 
 const pickObserverOptionsSummary = (
   options: Record<string, unknown> | undefined
-) => {
+): TanStackQueryObserverOptionsSummary | null => {
   if (!options) {
     return null;
   }
@@ -434,7 +239,7 @@ const pickObserverOptionsSummary = (
 
 const pickMutationOptionsSummary = (
   options: MutationObserverOptions<unknown, Error, unknown, unknown>
-) => {
+): TanStackQueryMutationOptionsSummary => {
   return {
     mutationKey: serializeForAgent(options.mutationKey),
     networkMode: serializeForAgent(options.networkMode),
@@ -741,10 +546,3 @@ export const createTanStackQueryAgentController = (queryClient: QueryClient) =>
 export type TanStackQueryAgentController = ReturnType<
   typeof createTanStackQueryAgentController
 >;
-
-export type TanStackQueryAgentPaginationInput = PaginationInput;
-export type TanStackQueryAgentQueryHashInput = QueryHashInput;
-export type TanStackQueryAgentQueryToggleInput = QueryToggleInput;
-export type TanStackQueryAgentMutationIdInput = MutationIdInput;
-export type TanStackQueryAgentOnlineStatusInput = OnlineStatusInput;
-export const TANSTACK_QUERY_AGENT_PLUGIN_ID = pluginId;