Merge pull request #24 from viamrobotics/query-keys

Improve query keys

Author: micheal-parks

.changeset/shy-worlds-juggle.md

@@ -0,0 +1,5 @@
+---
+'@viamrobotics/svelte-sdk': patch
+---
+
+Improve query keys

src/lib/hooks/create-resource-mutation.svelte.ts

@@ -16,6 +16,7 @@ export const createResourceMutation = <T extends Resource, K extends keyof T>(
 
   const mutationOptions = $derived({
     mutationKey: [
+      'viam-svelte-sdk',
       'partID',
       (client.current as T & { partID: string })?.partID,
       'resource',

src/lib/hooks/create-resource-query.svelte.ts

@@ -48,6 +48,7 @@ export const createResourceQuery = <T extends Resource, K extends keyof T>(
   const queryOptions = $derived(
     createQueryOptions({
       queryKey: [
+        'viam-svelte-sdk',
         'partID',
         (client.current as T & { partID: string })?.partID,
         'resource',

src/lib/hooks/create-robot-mutation.svelte.ts

@@ -16,6 +16,7 @@ export const createRobotMutation = <T extends RobotClient, K extends keyof T>(
 
   const mutationOptions = $derived({
     mutationKey: [
+      'viam-svelte-sdk',
       'partID',
       (client.current as T & { partID: string })?.partID,
       'robotClient',

src/lib/hooks/create-robot-query.svelte.ts

@@ -49,6 +49,7 @@ export const createRobotQuery = <T extends RobotClient, K extends keyof T>(
   const queryOptions = $derived(
     createQueryOptions({
       queryKey: [
+        'viam-svelte-sdk',
         'partID',
         (client.current as T & { partID: string })?.partID,
         'robotClient',

src/lib/hooks/create-stream-client.svelte.ts

@@ -42,6 +42,7 @@ export const createStreamClient = (
   const queryOptions = $derived(
     createQueryOptions({
       queryKey: [
+        'viam-svelte-sdk',
         'partID',
         partID(),
         'resource',
@@ -62,6 +63,7 @@ export const createStreamClient = (
 
   const mutationOptions = $derived({
     mutationKey: [
+      'viam-svelte-sdk',
       'partID',
       partID(),
       'resource',

src/lib/hooks/machine-status.svelte.ts

@@ -25,7 +25,13 @@ export const provideMachineStatusContext = (refetchInterval: () => number) => {
     Object.entries(clients.current).map(([partID, client]) => {
       return queryOptions({
         enabled: client !== undefined,
-        queryKey: ['partID', partID, 'robotClient', 'machineStatus'],
+        queryKey: [
+          'viam-svelte-sdk',
+          'partID',
+          partID,
+          'robotClient',
+          'machineStatus',
+        ],
         refetchInterval: refetchInterval(),
         queryFn: async (): Promise<MachineStatus> => {
           if (!client) {

src/lib/hooks/resource-names.svelte.ts

@@ -36,7 +36,14 @@ export const provideResourceNamesContext = () => {
 
       return queryOptions({
         enabled: client !== undefined,
-        queryKey: ['partID', partID, 'robotClient', 'resourceNames', revision],
+        queryKey: [
+          'viam-svelte-sdk',
+          'partID',
+          partID,
+          'robotClient',
+          'resourceNames',
+          revision,
+        ],
         queryFn: async () => {
           if (!client) {
             throw new Error('No client');

src/lib/hooks/robot-clients.svelte.ts

@@ -51,7 +51,9 @@ export const provideRobotClientsContext = (
 
     await Promise.all([
       client?.disconnect(),
-      queryClient.cancelQueries({ queryKey: ['partID', partID] }),
+      queryClient.cancelQueries({
+        queryKey: ['viam-svelte-sdk', 'partID', partID],
+      }),
     ]);
 
     client.listeners['connectionstatechange']?.clear();