Merge pull request #385 from psteinroe/feat/build-query-opts-storage

feat: add query opt builder fns for storage
psteinroe · Feb 14, 2024 · a1c4848 · a1c4848
2 parents 6ddf52a + bfbb039
commit a1c4848
Show file tree

Hide file tree

Showing 4 changed files with 66 additions and 16 deletions.
diff --git a/.changeset/hungry-tools-raise.md b/.changeset/hungry-tools-raise.md
@@ -0,0 +1,5 @@
+---
+"@supabase-cache-helpers/storage-react-query": minor
+---
+
+feat: add query opt builder fns for storage
diff --git a/packages/storage-react-query/src/query/use-directory-urls.ts b/packages/storage-react-query/src/query/use-directory-urls.ts
@@ -12,6 +12,29 @@ import {
 
 import { encode, StorageFileApi } from '../lib';
 
+function buildDirectoryUrlsQueryOpts(
+  fileApi: StorageFileApi,
+  path: string,
+  mode: StoragePrivacy,
+  config?: Omit<
+    UseReactQueryOptions<
+      (FileObject & { url: string })[] | undefined,
+      StorageError
+    >,
+    'queryKey' | 'queryFn'
+  > &
+    Pick<URLFetcherConfig, 'expiresIn'>,
+): UseReactQueryOptions<
+  (FileObject & { url: string })[] | undefined,
+  StorageError
+> {
+  return {
+    queryKey: encode([fileApi, path]),
+    queryFn: () => createDirectoryUrlsFetcher(mode, config)(fileApi, path),
+    ...config,
+  };
+}
+
 /**
  * Convenience hook to fetch all files in a directory, and their corresponding URLs, from Supabase Storage using React Query.
  *
@@ -41,11 +64,7 @@ function useDirectoryFileUrls(
   return useReactQuery<
     (FileObject & { url: string })[] | undefined,
     StorageError
-  >({
-    queryKey: encode([fileApi, path]),
-    queryFn: () => createDirectoryUrlsFetcher(mode, config)(fileApi, path),
-    ...config,
-  });
+  >(buildDirectoryUrlsQueryOpts(fileApi, path, mode, config));
 }
 
-export { useDirectoryFileUrls };
+export { useDirectoryFileUrls, buildDirectoryUrlsQueryOpts };
diff --git a/packages/storage-react-query/src/query/use-directory.ts b/packages/storage-react-query/src/query/use-directory.ts
@@ -8,6 +8,21 @@ import {
 
 import { StorageFileApi, encode } from '../lib';
 
+function buildDirectoryQueryOpts(
+  fileApi: StorageFileApi,
+  path: string,
+  config?: Omit<
+    UseReactQueryOptions<FileObject[] | undefined, StorageError>,
+    'queryKey' | 'queryFn'
+  >,
+): UseReactQueryOptions<FileObject[] | undefined, StorageError> {
+  return {
+    queryKey: encode([fileApi, path]),
+    queryFn: () => fetchDirectory(fileApi, path),
+    ...config,
+  };
+}
+
 /**
  * Convenience hook to fetch a directory from Supabase Storage using React Query.
  *
@@ -24,11 +39,7 @@ function useDirectory(
     'queryKey' | 'queryFn'
   >,
 ): UseReactQueryResult<FileObject[] | undefined, StorageError> {
-  return useReactQuery({
-    queryKey: encode([fileApi, path]),
-    queryFn: () => fetchDirectory(fileApi, path),
-    ...config,
-  });
+  return useReactQuery(buildDirectoryQueryOpts(fileApi, path, config));
 }
 
 export { useDirectory };
diff --git a/packages/storage-react-query/src/query/use-file-url.ts b/packages/storage-react-query/src/query/use-file-url.ts
@@ -12,6 +12,23 @@ import {
 
 import { StorageFileApi, encode } from '../lib';
 
+function buildFileUrlQueryOpts(
+  fileApi: StorageFileApi,
+  path: string,
+  mode: StoragePrivacy,
+  config?: Omit<
+    UseReactQueryOptions<string | undefined, StorageError>,
+    'queryKey' | 'queryFn'
+  > &
+    URLFetcherConfig,
+): UseReactQueryOptions<string | undefined, StorageError> {
+  return {
+    queryKey: encode([fileApi, path]),
+    queryFn: () => createUrlFetcher(mode, config)(fileApi, path),
+    ...config,
+  };
+}
+
 /**
  * A hook to fetch the URL for a file in the Storage.
  *
@@ -31,11 +48,9 @@ function useFileUrl(
   > &
     URLFetcherConfig,
 ): UseReactQueryResult<string | undefined, StorageError> {
-  return useReactQuery<string | undefined, StorageError>({
-    queryKey: encode([fileApi, path]),
-    queryFn: () => createUrlFetcher(mode, config)(fileApi, path),
-    ...config,
-  });
+  return useReactQuery<string | undefined, StorageError>(
+    buildFileUrlQueryOpts(fileApi, path, mode, config),
+  );
 }
 
 export { useFileUrl };