Merge pull request #54 from viamrobotics/add-resource-stream-hook

add create resource stream hook

Author: DTCurrie

.changeset/cuddly-kids-love.md

@@ -0,0 +1,5 @@
+---
+'@viamrobotics/svelte-sdk': minor
+---
+
+Add createResourceStream hook

package.json

@@ -63,7 +63,7 @@
     "@testing-library/svelte": "^5.2.8",
     "@viamrobotics/eslint-config": "^1.1.0",
     "@viamrobotics/prettier-config-svelte": "^1.1.0",
-    "@viamrobotics/sdk": "^0.45.0",
+    "@viamrobotics/sdk": "^0.49.1",
     "@viamrobotics/typescript-config": "^0.1.1",
     "eslint": "^9.30.0",
     "eslint-config-prettier": "^10.1.5",

pnpm-lock.yaml

@@ -0,0 +1,106 @@
+import {
+  experimental_streamedQuery as streamedQuery,
+  createQuery,
+  type QueryObserverResult,
+  queryOptions as createQueryOptions,
+} 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 StreamItemType<T> = T extends (
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  ...args: any[]
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+) => AsyncGenerator<infer R, any, any>
+  ? R
+  : never;
+
+interface QueryOptions {
+  // enabled defaults to true if unspecified
+  enabled?: boolean;
+  refetchMode?: 'append' | 'reset' | 'replace';
+  maxChunks?: number;
+}
+
+type QueryResult<U> = QueryObserverResult<U[], Error>;
+
+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]
+): { current: QueryResult<StreamItemType<T[K]>> } => {
+  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] : []),
+  ]);
+
+  function processStream() {
+    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 = clientFunc?.apply(
+        client.current,
+        _args
+      ) as AsyncGenerator<StreamItemType<T[K]>>;
+      console.log('response', typeof response);
+
+      logger('RES', name, methodName, response);
+      return response;
+    } catch (error) {
+      logger('ERR', name, methodName, error);
+      throw error;
+    }
+  }
+
+  const queryOptions = $derived(
+    createQueryOptions({
+      queryKey,
+      enabled: client.current !== undefined && _options?.enabled !== false,
+      queryFn: streamedQuery<StreamItemType<T[K]>>({
+        queryFn: processStream,
+        ..._options,
+      }),
+    })
+  );
+
+  return fromStore(createQuery(toStore(() => queryOptions)));
+};

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';

src/lib/index.ts

@@ -43,10 +43,7 @@ let { children }: Props = $props();
   {/each}
 </div>
 
-<ViamProvider
-  {dialConfigs}
-  logQueries
->
+<ViamProvider {dialConfigs}>
   <Parts />
   {@render children()}
   <SvelteQueryDevtools />