@rozenite/tanstack-query-plugin 2.1.0 → 2.3.0

package/dist/react-native/src/shared/agent-tools.js

@@ -0,0 +1,194 @@
+import { defineAgentToolContract, definePaginatedAgentToolContract, } from '@rozenite/agent-shared';
+export const TANSTACK_QUERY_AGENT_PLUGIN_ID = '@rozenite/tanstack-query-plugin';
+const queryActionProperties = {
+    queryHash: {
+        type: 'string',
+        description: 'TanStack Query queryHash identifying the query.',
+    },
+};
+const mutationActionProperties = {
+    mutationId: {
+        type: 'number',
+        description: 'TanStack Query mutationId identifying the mutation.',
+    },
+};
+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.',
+    },
+};
+const emptyInputSchema = {
+    type: 'object',
+    properties: {},
+};
+export const tanstackQueryToolDefinitions = {
+    getCacheSummary: defineAgentToolContract({
+        name: 'get-cache-summary',
+        description: 'Return aggregate TanStack Query cache health and count information.',
+        inputSchema: emptyInputSchema,
+    }),
+    getOnlineStatus: defineAgentToolContract({
+        name: 'get-online-status',
+        description: 'Return the current TanStack Query onlineManager status.',
+        inputSchema: emptyInputSchema,
+    }),
+    setOnlineStatus: defineAgentToolContract({
+        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: definePaginatedAgentToolContract({
+        name: 'list-queries',
+        description: 'List TanStack Query query summaries using cursor pagination.',
+        inputSchema: {
+            type: 'object',
+            properties: paginationProperties,
+        },
+        pagination: {
+            kind: 'cursor',
+            fields: [
+                'queryHash',
+                'queryKey',
+                'status',
+                'fetchStatus',
+                'observersCount',
+                'isInvalidated',
+                'dataUpdatedAt',
+                'errorUpdatedAt',
+                'hasData',
+                'hasError',
+            ],
+            defaultFields: ['queryHash', 'queryKey', 'status', 'fetchStatus', 'hasError'],
+        },
+    }),
+    getQueryDetails: defineAgentToolContract({
+        name: 'get-query-details',
+        description: 'Return a JSON-safe TanStack Query query snapshot and observer summary.',
+        inputSchema: {
+            type: 'object',
+            properties: queryActionProperties,
+            required: ['queryHash'],
+        },
+    }),
+    refetchQuery: defineAgentToolContract({
+        name: 'refetch-query',
+        description: 'Refetch a TanStack Query query by queryHash.',
+        inputSchema: {
+            type: 'object',
+            properties: queryActionProperties,
+            required: ['queryHash'],
+        },
+    }),
+    setQueryLoading: defineAgentToolContract({
+        name: 'set-query-loading',
+        description: 'Enable or disable TanStack Query loading-state simulation for a query by queryHash.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                ...queryActionProperties,
+                enabled: {
+                    type: 'boolean',
+                    description: 'Whether the loading-state simulation should be enabled.',
+                },
+            },
+            required: ['queryHash', 'enabled'],
+        },
+    }),
+    setQueryError: defineAgentToolContract({
+        name: 'set-query-error',
+        description: 'Enable or disable TanStack Query error-state simulation for a query by queryHash.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                ...queryActionProperties,
+                enabled: {
+                    type: 'boolean',
+                    description: 'Whether the error-state simulation should be enabled.',
+                },
+            },
+            required: ['queryHash', 'enabled'],
+        },
+    }),
+    invalidateQuery: defineAgentToolContract({
+        name: 'invalidate-query',
+        description: 'Invalidate a TanStack Query query by queryHash.',
+        inputSchema: {
+            type: 'object',
+            properties: queryActionProperties,
+            required: ['queryHash'],
+        },
+    }),
+    resetQuery: defineAgentToolContract({
+        name: 'reset-query',
+        description: 'Reset a TanStack Query query by queryHash.',
+        inputSchema: {
+            type: 'object',
+            properties: queryActionProperties,
+            required: ['queryHash'],
+        },
+    }),
+    removeQuery: defineAgentToolContract({
+        name: 'remove-query',
+        description: 'Remove a TanStack Query query from the cache by queryHash.',
+        inputSchema: {
+            type: 'object',
+            properties: queryActionProperties,
+            required: ['queryHash'],
+        },
+    }),
+    clearQueryCache: defineAgentToolContract({
+        name: 'clear-query-cache',
+        description: 'Clear the full TanStack Query query cache.',
+        inputSchema: emptyInputSchema,
+    }),
+    listMutations: definePaginatedAgentToolContract({
+        name: 'list-mutations',
+        description: 'List TanStack Query mutation summaries using cursor pagination.',
+        inputSchema: {
+            type: 'object',
+            properties: paginationProperties,
+        },
+        pagination: {
+            kind: 'cursor',
+            fields: [
+                'mutationId',
+                'mutationKey',
+                'status',
+                'isPaused',
+                'submittedAt',
+                'failureCount',
+                'hasData',
+                'hasError',
+            ],
+            defaultFields: ['mutationId', 'mutationKey', 'status', 'hasError'],
+        },
+    }),
+    getMutationDetails: defineAgentToolContract({
+        name: 'get-mutation-details',
+        description: 'Return a JSON-safe TanStack Query mutation snapshot for a mutationId.',
+        inputSchema: {
+            type: 'object',
+            properties: mutationActionProperties,
+            required: ['mutationId'],
+        },
+    }),
+    clearMutationCache: defineAgentToolContract({
+        name: 'clear-mutation-cache',
+        description: 'Clear the full TanStack Query mutation cache.',
+        inputSchema: emptyInputSchema,
+    }),
+};

package/dist/react-native/src/shared/dehydrate.d.ts

@@ -0,0 +1,6 @@
+import type { Query, Mutation, QueryClient } from '@tanstack/react-query';
+import type { SerializableQuery, SerializableMutation, SerializableObserver, SerializableQueryClient } from './types';
+export declare const dehydrateObservers: (query: Query) => SerializableObserver[];
+export declare const dehydrateQuery: (query: Query) => SerializableQuery;
+export declare const dehydrateMutation: (mutation: Mutation) => SerializableMutation;
+export declare const dehydrateQueryClient: (queryClient: QueryClient) => SerializableQueryClient;

package/dist/react-native/src/shared/dehydrate.js

@@ -0,0 +1,28 @@
+export const dehydrateObservers = (query) => {
+    return query.observers.map((observer) => ({
+        queryHash: query.queryHash,
+        options: observer.options,
+    }));
+};
+export const dehydrateQuery = (query) => {
+    const dehydratedObservers = dehydrateObservers(query);
+    return {
+        state: query.state,
+        queryKey: query.queryKey,
+        queryHash: query.queryHash,
+        observers: dehydratedObservers,
+    };
+};
+export const dehydrateMutation = (mutation) => {
+    return {
+        mutationId: mutation.mutationId,
+        state: mutation.state,
+        options: mutation.options,
+    };
+};
+export const dehydrateQueryClient = (queryClient) => {
+    return {
+        queries: queryClient.getQueryCache().getAll().map(dehydrateQuery),
+        mutations: queryClient.getMutationCache().getAll().map(dehydrateMutation),
+    };
+};

package/dist/react-native/src/shared/messaging.d.ts

@@ -0,0 +1,44 @@
+import type { RozeniteDevToolsClient } from '@rozenite/plugin-bridge';
+import { DevToolsActionType, SerializableQueryClient, SerializableQuery, SerializableMutation, SerializableObserver, PartialQueryState } from './types';
+export type TanStackQueryPluginEventMap = {
+    'online-status-changed': {
+        online: boolean;
+    };
+    'devtools-action': {
+        type: DevToolsActionType;
+        queryHash: string;
+        metadata?: {
+            data?: unknown;
+        };
+    };
+    /**
+     * Announced by the device once it is listening for panel messages. The panel
+     * is recreated on every app reload and asks for the cache immediately, which
+     * can land before the app's React tree has mounted the plugin; this lets the
+     * panel ask again instead of staying empty until the app is restarted.
+     */
+    'device-ready': unknown;
+    'request-initial-data': unknown;
+    'sync-data': {
+        data: SerializableQueryClient;
+    };
+    'sync-query-event': {
+        type: 'added' | 'removed';
+        data: SerializableQuery;
+    } | {
+        type: 'updated';
+        action?: string;
+        data: SerializableQuery | PartialQueryState;
+    } | {
+        type: 'observerAdded' | 'observerRemoved' | 'observerOptionsUpdated';
+        data: {
+            queryHash: string;
+            observers: SerializableObserver[];
+        };
+    };
+    'sync-mutation-event': {
+        type: 'added' | 'updated' | 'removed' | 'observerAdded' | 'observerRemoved' | 'observerResultsUpdated' | 'observerOptionsUpdated';
+        data: SerializableMutation;
+    };
+};
+export type TanStackQueryPluginClient = RozeniteDevToolsClient<TanStackQueryPluginEventMap>;

package/dist/react-native/src/shared/messaging.js

@@ -0,0 +1 @@
+export {};

package/dist/react-native/src/shared/types.d.ts

@@ -0,0 +1,25 @@
+import type { QueryKey, MutationState, QueryState, QueryObserverOptions, InfiniteQueryObserverOptions, MutationOptions } from '@tanstack/react-query';
+export type SerializableQuery = {
+    queryHash: string;
+    state: QueryState;
+    queryKey: QueryKey;
+    observers: SerializableObserver[];
+};
+export type PartialQueryState = {
+    queryHash: string;
+    state: Partial<QueryState>;
+};
+export type SerializableMutation = {
+    mutationId: number;
+    options: MutationOptions;
+    state: MutationState;
+};
+export type SerializableObserver = {
+    queryHash: string;
+    options: QueryObserverOptions | InfiniteQueryObserverOptions;
+};
+export type SerializableQueryClient = {
+    queries: SerializableQuery[];
+    mutations: SerializableMutation[];
+};
+export type DevToolsActionType = 'REFETCH' | 'SET_QUERY_DATA' | 'INVALIDATE' | 'RESET' | 'REMOVE' | 'TRIGGER_ERROR' | 'RESTORE_ERROR' | 'TRIGGER_LOADING' | 'RESTORE_LOADING' | 'CLEAR_MUTATION_CACHE' | 'CLEAR_QUERY_CACHE';

package/dist/react-native/src/shared/types.js

@@ -0,0 +1 @@
+export {};

package/dist/react-native/src/shared/useSyncOnlineStatus.d.ts

@@ -0,0 +1,2 @@
+import { TanStackQueryPluginClient } from './messaging';
+export declare const useSyncOnlineStatus: (client: TanStackQueryPluginClient | null) => void;

package/dist/react-native/src/shared/useSyncOnlineStatus.js

@@ -0,0 +1,19 @@
+import { useEffect } from 'react';
+import { onlineManager } from '@tanstack/react-query';
+export const useSyncOnlineStatus = (client) => {
+    useEffect(() => {
+        if (!client) {
+            return;
+        }
+        const onlineManagerSubscription = onlineManager.subscribe((online) => {
+            client.send('online-status-changed', { online });
+        });
+        const onlineMessageSubscription = client.onMessage('online-status-changed', ({ online }) => {
+            onlineManager.setOnline(online);
+        });
+        return () => {
+            onlineManagerSubscription();
+            onlineMessageSubscription.remove();
+        };
+    }, [client]);
+};

package/dist/rozenite.json

@@ -1 +1 @@
-{"name":"@rozenite/tanstack-query-plugin","version":"2.1.0","description":"TanStack Query for Rozenite.","panels":[{"name":"Tanstack Query","source":"/devtools/tanstack-query.html"}]}
+{"name":"@rozenite/tanstack-query-plugin","version":"2.3.0","description":"TanStack Query for Rozenite.","panels":[{"name":"Tanstack Query","source":"/devtools/tanstack-query.html"}],"integrations":["react-native","react-native-web","lynx","lynx-web"]}

package/dist/sdk/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}