Merge branch 'main' into poll-1

micheal-parks · web-flow · commit b028f84d71f0 · 2025-10-14T15:33:45.000-04:00
diff --git a/.changeset/large-birds-brake.md b/.changeset/large-birds-brake.md
diff --git a/.prettierignore b/.prettierignore
@@ -1,4 +1,5 @@
 # Package Managers
 package-lock.json
 pnpm-lock.yaml
-yarn.lock
+yarn.lock
+.changeset/*.md
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,26 @@
 # @viamrobotics/svelte-sdk
 
+## 0.7.0
+
+### Minor Changes
+
+- 7e38d05: Export usePolling hook
+- cd4b20f: Add enable queries hook
+
+## 0.6.2
+
+### Patch Changes
+
+- 79604ac: Export streamQueryKey factory to help with query management
+- eb67d3d: Fix create-resource-stream params
+
+## 0.6.1
+
+### Patch Changes
+
+- 92cfb39: Fix tanstack stream query options
+- 5c0c4b4: Use new `robotClient.dial` method for connection
+
 ## 0.6.0
 
 ### Minor Changes
diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
   "name": "@viamrobotics/svelte-sdk",
   "description": "Build Svelte apps with Viam",
   "license": "Apache-2.0",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "scripts": {
     "dev": "vite dev",
     "build": "vite build && npm run prepack",
@@ -44,7 +44,7 @@
   },
   "peerDependencies": {
     "@tanstack/svelte-query": "5.87.1",
-    "@viamrobotics/sdk": ">=0.38",
+    "@viamrobotics/sdk": ">=0.51",
     "svelte": ">=5"
   },
   "devDependencies": {
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/lib/hooks/create-resource-query.svelte.ts b/src/lib/hooks/create-resource-query.svelte.ts
@@ -7,6 +7,7 @@ import type { Resource } from '@viamrobotics/sdk';
 import { toStore, fromStore } from 'svelte/store';
 import { usePolling } from './use-polling.svelte';
 import { useQueryLogger } from '../query-logger';
+import { useEnabledQueries } from './use-enabled-queries.svelte';
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export type ArgumentsType<T> = T extends (...args: infer U) => any ? U : never;
@@ -36,6 +37,7 @@ export const createResourceQuery = <T extends Resource, K extends keyof T>(
     | [options?: (() => QueryOptions) | QueryOptions]
 ): { current: QueryObserverResult<ResolvedReturnType<T[K]>> } => {
   const debug = useQueryLogger();
+  const enabledQueries = useEnabledQueries();
 
   let [args, options] = additional;
 
@@ -62,7 +64,10 @@ export const createResourceQuery = <T extends Resource, K extends keyof T>(
         methodName,
         ...(_args ? [_args] : []),
       ],
-      enabled: client.current !== undefined && _options?.enabled !== false,
+      enabled:
+        client.current !== undefined &&
+        _options?.enabled !== false &&
+        enabledQueries.resourceQueries,
       retry: false,
       queryFn: async () => {
         const clientFunc = client.current?.[method];
diff --git a/src/lib/hooks/create-resource-stream.svelte.ts b/src/lib/hooks/create-resource-stream.svelte.ts
@@ -7,6 +7,7 @@ import {
 import type { Resource } from '@viamrobotics/sdk';
 import { toStore, fromStore } from 'svelte/store';
 import { useQueryLogger } from '../query-logger';
+import { useEnabledQueries } from './use-enabled-queries.svelte';
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export type ArgumentsType<T> = T extends (...args: infer U) => any ? U : never;
@@ -22,12 +23,27 @@ export type StreamItemType<T> = T extends (
 interface QueryOptions {
   // enabled defaults to true if unspecified
   enabled?: boolean;
+  // refetchMode defaults to 'reset' if unspecified
   refetchMode?: 'append' | 'reset' | 'replace';
-  maxChunks?: number;
 }
 
 type QueryResult<U> = QueryObserverResult<U[], Error>;
 
+export const streamQueryKey = (
+  partID: string,
+  name: string | undefined,
+  methodName: string,
+  args?: QueryOptions | unknown
+) => [
+  'viam-svelte-sdk',
+  'partID',
+  partID,
+  'resource',
+  name,
+  methodName,
+  ...(args ? [args] : []),
+];
+
 export const createResourceStream = <T extends Resource, K extends keyof T>(
   client: { current: T | undefined },
   method: K,
@@ -39,6 +55,7 @@ export const createResourceStream = <T extends Resource, K extends keyof T>(
     | [options?: (() => QueryOptions) | QueryOptions]
 ): { current: QueryResult<StreamItemType<T[K]>> } => {
   const debug = useQueryLogger();
+  const enabledQueries = useEnabledQueries();
 
   let [args, options] = additional;
 
@@ -54,15 +71,9 @@ export const createResourceStream = <T extends Resource, K extends keyof T>(
   const _args = $derived(typeof args === 'function' ? args() : args);
   const name = $derived(client.current?.name);
   const methodName = $derived(String(method));
-  const queryKey = $derived([
-    'viam-svelte-sdk',
-    'partID',
-    (client.current as T & { partID: string })?.partID,
-    'resource',
-    name,
-    methodName,
-    ...(_args ? [_args] : []),
-  ]);
+  const refetchMode = $derived(_options?.refetchMode ?? 'reset');
+  const partID = $derived((client.current as T & { partID: string })?.partID);
+  const queryKey = $derived(streamQueryKey(partID, name, methodName, _args));
 
   function processStream() {
     const clientFunc = client.current?.[method];
@@ -94,10 +105,13 @@ export const createResourceStream = <T extends Resource, K extends keyof T>(
   const queryOptions = $derived(
     createQueryOptions({
       queryKey,
-      enabled: client.current !== undefined && _options?.enabled !== false,
+      enabled:
+        client.current !== undefined &&
+        _options?.enabled !== false &&
+        enabledQueries.resourceQueries,
       queryFn: streamedQuery<StreamItemType<T[K]>>({
         streamFn: processStream,
-        ..._options,
+        refetchMode,
       }),
     })
   );
diff --git a/src/lib/hooks/create-robot-query.svelte.ts b/src/lib/hooks/create-robot-query.svelte.ts
@@ -8,6 +8,7 @@ import type { RobotClient } from '@viamrobotics/sdk';
 import { toStore, fromStore } from 'svelte/store';
 import { usePolling } from './use-polling.svelte';
 import { useQueryLogger } from '$lib/query-logger';
+import { useEnabledQueries } from './use-enabled-queries.svelte';
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export type ArgumentsType<T> = T extends (...args: infer U) => any ? U : never;
@@ -37,6 +38,7 @@ export const createRobotQuery = <T extends RobotClient, K extends keyof T>(
     | [options?: (() => QueryOptions) | QueryOptions]
 ): { current: QueryObserverResult<ResolvedReturnType<T[K]>> } => {
   const debug = useQueryLogger();
+  const enabledQueries = useEnabledQueries();
   let [args, options] = additional;
 
   if (options === undefined && args !== undefined) {
@@ -60,7 +62,10 @@ export const createRobotQuery = <T extends RobotClient, K extends keyof T>(
         methodName,
         ...(_args ? [_args] : []),
       ],
-      enabled: client.current !== undefined && _options?.enabled !== false,
+      enabled:
+        client.current !== undefined &&
+        _options?.enabled !== false &&
+        enabledQueries.robotQueries,
       retry: false,
       queryFn: async () => {
         const clientFunc = client.current?.[method];
diff --git a/src/lib/hooks/create-stream-client.svelte.ts b/src/lib/hooks/create-stream-client.svelte.ts
@@ -8,12 +8,14 @@ import {
 } from '@tanstack/svelte-query';
 import { fromStore, toStore } from 'svelte/store';
 import { useQueryLogger } from '../query-logger';
+import { useEnabledQueries } from './use-enabled-queries.svelte';
 
 export const createStreamClient = (
   partID: () => string,
   resourceName: () => string
 ) => {
   const debug = useQueryLogger();
+  const enabledQueries = useEnabledQueries();
   let mediaStream = $state.raw<MediaStream | null>(null);
   let error = $state<Error>();
 
@@ -61,7 +63,7 @@ export const createStreamClient = (
         'stream',
         'getOptions',
       ],
-      enabled: streamClient !== undefined,
+      enabled: streamClient !== undefined && enabledQueries.streams,
       retry: false,
       refetchOnWindowFocus: false,
       queryFn: async () => {
diff --git a/src/lib/hooks/machine-status.svelte.ts b/src/lib/hooks/machine-status.svelte.ts
@@ -10,6 +10,7 @@ import type { PartID } from '$lib/part';
 import type { RobotClient } from '@viamrobotics/sdk';
 import { usePolling } from './use-polling.svelte';
 import { useQueryLogger } from '$lib/query-logger';
+import { useEnabledQueries } from './use-enabled-queries.svelte';
 
 const key = Symbol('machine-status-context');
 
@@ -23,11 +24,12 @@ interface Context {
 export const provideMachineStatusContext = (refetchInterval: () => number) => {
   const clients = useRobotClients();
   const debug = useQueryLogger();
+  const enabledQueries = useEnabledQueries();
 
   const options = $derived(
     Object.entries(clients.current).map(([partID, client]) => {
       return queryOptions({
-        enabled: client !== undefined,
+        enabled: client !== undefined && enabledQueries.machineStatus,
         queryKey: [
           'viam-svelte-sdk',
           'partID',
diff --git a/src/lib/hooks/resource-names.svelte.ts b/src/lib/hooks/resource-names.svelte.ts
@@ -11,6 +11,7 @@ import type { PartID } from '../part';
 import { useMachineStatuses } from './machine-status.svelte';
 import { useQueryLogger } from '$lib/query-logger';
 import { useDebounce } from 'runed';
+import { useEnabledQueries } from './use-enabled-queries.svelte';
 
 const key = Symbol('resources-context');
 
@@ -85,7 +86,7 @@ export const provideResourceNamesContext = () => {
   const machineStatuses = useMachineStatuses();
   const clients = useRobotClients();
   const debug = useQueryLogger();
-
+  const enabledQueries = useEnabledQueries();
   const partIDs = $derived(Object.keys(clients.current));
   const options = $derived.by(() => {
     const results = [];
@@ -96,7 +97,9 @@ export const provideResourceNamesContext = () => {
       const options = queryOptions({
         refetchOnMount: false,
         enabled:
-          client !== undefined && machineStatus?.state === MachineState.Running,
+          client !== undefined &&
+          machineStatus?.state === MachineState.Running &&
+          enabledQueries.resourceNames,
         queryKey: [
           'viam-svelte-sdk',
           'partID',
diff --git a/src/lib/hooks/use-enabled-queries.svelte.ts b/src/lib/hooks/use-enabled-queries.svelte.ts
@@ -0,0 +1,51 @@
+export const useEnabledQueries = () => {
+  let machineStatus = $state(true);
+  let resourceNames = $state(true);
+  let resourceQueries = $state(true);
+  let robotQueries = $state(true);
+  let streams = $state(true);
+
+  const enableResourceQueries = () => (resourceQueries = true);
+  const disableResourceQueries = () => (resourceQueries = false);
+
+  const enableMachineStatus = () => (machineStatus = true);
+  const disableMachineStatus = () => (machineStatus = false);
+
+  const enableResourceNames = () => (resourceNames = true);
+  const disableResourceNames = () => (resourceNames = false);
+
+  const enableRobotQueries = () => (robotQueries = true);
+  const disableRobotQueries = () => (robotQueries = false);
+
+  const enableStreams = () => (streams = true);
+  const disableStreams = () => (streams = false);
+
+  return {
+    get resourceQueries() {
+      return resourceQueries;
+    },
+    get machineStatus() {
+      return machineStatus;
+    },
+    get resourceNames() {
+      return resourceNames;
+    },
+    get robotQueries() {
+      return robotQueries;
+    },
+    get streams() {
+      return streams;
+    },
+
+    enableResourceQueries,
+    disableResourceQueries,
+    enableMachineStatus,
+    disableMachineStatus,
+    enableResourceNames,
+    disableResourceNames,
+    enableRobotQueries,
+    disableRobotQueries,
+    enableStreams,
+    disableStreams,
+  };
+};
diff --git a/src/lib/index.ts b/src/lib/index.ts
@@ -16,12 +16,17 @@ export { createRobotMutation } from './hooks/create-robot-mutation.svelte';
 export { createResourceClient } from './hooks/create-resource-client.svelte';
 export { createResourceQuery } from './hooks/create-resource-query.svelte';
 export { createResourceMutation } from './hooks/create-resource-mutation.svelte';
-export { createResourceStream } from './hooks/create-resource-stream.svelte';
+export {
+  createResourceStream,
+  streamQueryKey,
+} from './hooks/create-resource-stream.svelte';
 export { createStreamClient } from './hooks/create-stream-client.svelte';
 
 export { useMachineStatus } from './hooks/machine-status.svelte';
 export { useResourceNames } from './hooks/resource-names.svelte';
 
+export { usePolling } from './hooks/use-polling.svelte';
+
 // App hooks
 export { useViamClient } from './hooks/app/use-app-client.svelte';
 export { createAppQuery } from './hooks/app/create-app-query.svelte';
