add create resource stream hook

Author: DTCurrie

package.json

@@ -89,7 +89,10 @@
   "pnpm": {
     "onlyBuiltDependencies": [
       "esbuild"
-    ]
+    ],
+    "overrides": {
+      "@viamrobotics/sdk": "link:../viam-typescript-sdk"
+    }
   },
   "packageManager": "[email protected]"
 }

pnpm-lock.yaml

@@ -0,0 +1,98 @@
+import {
+  experimental_streamedQuery as streamedQuery,
+  type QueryFunction,
+} from '@tanstack/svelte-query';
+import type { Resource } from '@viamrobotics/sdk';
+import { toStore, fromStore } from 'svelte/store';
+import { useQueryLogger } from '../query-logger';
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type ArgumentsType<T> = T extends (...args: infer U) => any ? U : never;
+
+export type ResolvedReturnType<T> = T extends (
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  ...args: any[]
+) => Promise<infer R>
+  ? R
+  : never;
+
+interface QueryOptions {
+  // enabled defaults to true if unspecified
+  enabled?: boolean;
+  refetchMode?: 'append' | 'reset' | 'replace';
+  maxChunks?: number;
+}
+
+export const createResourceStream = <T extends Resource, K extends keyof T>(
+  client: { current: T | undefined },
+  method: K,
+  ...additional:
+    | [
+        args?: (() => ArgumentsType<T[K]>) | ArgumentsType<T[K]>,
+        options?: (() => QueryOptions) | QueryOptions,
+      ]
+    | [options?: (() => QueryOptions) | QueryOptions]
+): QueryFunction<ResolvedReturnType<T[K]>[], typeof queryKey> => {
+  const debug = useQueryLogger();
+
+  let [args, options] = additional;
+
+  if (options === undefined && args !== undefined) {
+    options = args as QueryOptions;
+    args = undefined;
+  }
+
+  const _options = $derived(
+    typeof options === 'function' ? options() : options
+  );
+  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 queryOptions = $derived({
+    queryKey,
+    queryFn: async () => {
+      const clientFunc = client.current?.[method];
+
+      if (typeof clientFunc !== 'function') {
+        throw new TypeError(
+          `${String(method)} is not a method on the resource client.`
+        );
+      }
+
+      const logger = debug.createLogger();
+      logger('REQ', name, methodName, _args);
+
+      try {
+        const response = (await clientFunc?.apply(
+          client.current,
+          _args
+        )) as AsyncIterable<ResolvedReturnType<T[K]>>;
+
+        logger('RES', name, methodName, response);
+        return response;
+      } catch (error) {
+        logger('ERR', name, methodName, error);
+        throw error;
+      }
+    },
+    ..._options,
+  });
+
+  const queryOptionsStore = fromStore(toStore(() => queryOptions));
+  const query = streamedQuery<ResolvedReturnType<T[K]>, typeof queryKey>(
+    queryOptionsStore.current
+  );
+
+  return query;
+};

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

@@ -16,6 +16,7 @@ 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 { createStreamClient } from './hooks/create-stream-client.svelte';
 
 export { useMachineStatus } from './hooks/machine-status.svelte';