Merge branch 'main' into upgrade-nextra-doc-to-v3.2

Author: damien-schneider

docs/pages/storage/queries.mdx

@@ -149,7 +149,7 @@ function Page() {
   </Tabs.Tab>
 </Tabs>
 
-## `useDirectoryUrls`
+## `useDirectoryFileUrls`
 
 Convenience hook that returns the files in a directory similar to `useDirectory` but adds the `url` for each.
 

packages/postgrest-core/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @supabase-cache-helpers/postgrest-core
 
+## 0.8.3
+
+### Patch Changes
+
+- b06405b: fix: make delete work on single query
+
+## 0.8.2
+
+### Patch Changes
+
+- bfdf3ac: fix update fetcher when primary key value is equal to false or 0
+
 ## 0.8.1
 
 ### Patch Changes

packages/postgrest-core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@supabase-cache-helpers/postgrest-core",
-  "version": "0.8.1",
+  "version": "0.8.3",
   "type": "module",
   "main": "./dist/index.js",
   "source": "./src/index.ts",

packages/postgrest-core/src/delete-item.ts

@@ -116,7 +116,16 @@ export const deleteItem = async <KeyType, Type extends Record<string, unknown>>(
               } else if (isAnyPostgrestResponse<Type>(currentData)) {
                 const { data } = currentData;
                 if (!Array.isArray(data)) {
-                  return { data: null };
+                  if (
+                    data &&
+                    op.primaryKeys.some(
+                      (pk) => transformedInput[pk] !== data[pk],
+                    )
+                  ) {
+                    return currentData;
+                  } else {
+                    return { data: null };
+                  }
                 }
 
                 const newData = filterByPks(

packages/postgrest-core/src/update-fetcher.ts

@@ -57,7 +57,8 @@ export const buildUpdateFetcher =
     let filterBuilder = qb.update(payload as any, opts); // todo fix type;
     for (const key of primaryKeys) {
       const value = input[key];
-      if (!value)
+      // The value can be 0 or false, so we need to check if it's null or undefined instead of falsy
+      if (value === null || value === undefined)
         throw new Error(`Missing value for primary key ${String(key)}`);
       filterBuilder = filterBuilder.eq(key as string, value);
     }

packages/postgrest-core/tests/delete-item.spec.ts

@@ -286,6 +286,18 @@ describe('deleteItem', () => {
     });
   });
 
+  it('should not change data if its single and primary keys do not match', async () => {
+    expect(
+      await mutateFnResult(
+        { id_1: '0', id_2: '1', value: 'a' },
+        {},
+        { data: { id_1: '0', id_2: '0', value: 'test' } },
+      ),
+    ).toMatchObject({
+      data: { id_1: '0', id_2: '0', value: 'test' },
+    });
+  });
+
   it('should delete item from cached array and subtract count', async () => {
     expect(
       await mutateFnResult(

packages/postgrest-core/tests/update-fetcher.spec.ts

@@ -147,4 +147,40 @@ describe('update', () => {
       .maybeSingle();
     expect(data?.username).toEqual(`${testRunPrefix}-username-4`);
   });
+
+  it('should not throw error when primary key value is false', async () => {
+    const qb = {
+      update: vi.fn().mockReturnThis(),
+      eq: vi.fn().mockReturnThis(),
+      select: vi.fn().mockReturnThis(),
+      throwOnError: vi.fn().mockReturnThis(),
+      single: vi.fn().mockResolvedValue({ data: null }),
+    };
+
+    await expect(
+      buildUpdateFetcher(qb as any, ['is_active'], {
+        stripPrimaryKeys: false,
+        queriesForTable: () => [],
+      })({ is_active: false, username: 'testuser' }),
+    ).resolves.not.toThrow();
+    expect(qb.eq).toHaveBeenCalledWith('is_active', false);
+  });
+
+  it('should not throw error when primary key value is 0', async () => {
+    const qb = {
+      update: vi.fn().mockReturnThis(),
+      eq: vi.fn().mockReturnThis(),
+      select: vi.fn().mockReturnThis(),
+      throwOnError: vi.fn().mockReturnThis(),
+      single: vi.fn().mockResolvedValue({ data: null }),
+    };
+
+    await expect(
+      buildUpdateFetcher(qb as any, ['id'], {
+        stripPrimaryKeys: false,
+        queriesForTable: () => [],
+      })({ id: 0, username: 'testuser' }),
+    ).resolves.not.toThrow();
+    expect(qb.eq).toHaveBeenCalledWith('id', 0);
+  });
 });

packages/postgrest-react-query/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @supabase-cache-helpers/postgrest-react-query
 
+## 1.11.2
+
+### Patch Changes
+
+- Updated dependencies [b06405b]
+  - @supabase-cache-helpers/postgrest-core@0.8.3
+
+## 1.11.1
+
+### Patch Changes
+
+- Updated dependencies [bfdf3ac]
+  - @supabase-cache-helpers/postgrest-core@0.8.2
+
+## 1.11.0
+
+### Minor Changes
+
+- 74571ce: fix: retain union type in useQuery result
+
 ## 1.10.1
 
 ### Patch Changes

packages/postgrest-react-query/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@supabase-cache-helpers/postgrest-react-query",
-  "version": "1.10.1",
+  "version": "1.11.2",
   "author": "Philipp Steinrötter <[email protected]>",
   "homepage": "https://supabase-cache-helpers.vercel.app",
   "bugs": {

packages/postgrest-react-query/src/query/use-query.ts

@@ -13,11 +13,18 @@ import {
 
 import { buildQueryOpts } from './build-query-opts';
 
+/**
+ * Applies Omit over a union, while preserving its union-ness.
+ */
+type DistributiveOmit<T, K extends keyof any> = T extends any
+  ? Omit<T, K>
+  : never;
+
 /**
  * Represents the return value of the `useQuery` hook when `query` is expected to return
  * a single row.
  */
-export type UseQuerySingleReturn<Result> = Omit<
+export type UseQuerySingleReturn<Result> = DistributiveOmit<
   UseReactQueryResult<PostgrestSingleResponse<Result>['data'], PostgrestError>,
   'refetch'
 > &
@@ -31,7 +38,7 @@ export type UseQuerySingleReturn<Result> = Omit<
  * Represents the return value of the `useQuery` hook when `query` is expected to return
  * either a single row or an empty response.
  */
-export type UseQueryMaybeSingleReturn<Result> = Omit<
+export type UseQueryMaybeSingleReturn<Result> = DistributiveOmit<
   UseReactQueryResult<
     PostgrestMaybeSingleResponse<Result>['data'],
     PostgrestError
@@ -48,7 +55,7 @@ export type UseQueryMaybeSingleReturn<Result> = Omit<
  * Represents the return value of the `useQuery` hook when `query` is expected to return
  * one or more rows.
  */
-export type UseQueryReturn<Result> = Omit<
+export type UseQueryReturn<Result> = DistributiveOmit<
   UseReactQueryResult<PostgrestResponse<Result>['data'], PostgrestError>,
   'refetch'
 > &
@@ -62,7 +69,7 @@ export type UseQueryReturn<Result> = Omit<
  * Represents the return value of the `useQuery` hook when the type of the query response
  * is not known.
  */
-export type UseQueryAnyReturn<Result> = Omit<
+export type UseQueryAnyReturn<Result> = DistributiveOmit<
   UseReactQueryResult<AnyPostgrestResponse<Result>['data'], PostgrestError>,
   'refetch'
 > &
@@ -131,12 +138,24 @@ function useQuery<Result>(
     'queryKey' | 'queryFn'
   >,
 ): UseQueryAnyReturn<Result> {
-  const { data, ...rest } = useReactQuery<
-    AnyPostgrestResponse<Result>,
-    PostgrestError
-  >(buildQueryOpts<Result>(query, config));
+  const result = useReactQuery<AnyPostgrestResponse<Result>, PostgrestError>(
+    buildQueryOpts<Result>(query, config),
+  );
+
+  // isPending and isLoadingError are the only cases in which no data is present
+  if (result.isPending || result.isLoadingError) {
+    return {
+      ...result,
+      data: undefined,
+      count: null,
+    };
+  }
 
-  return { data: data?.data, count: data?.count ?? null, ...rest };
+  return {
+    ...result,
+    data: result.data?.data,
+    count: result.data?.count,
+  };
 }
 
 export { useQuery };

packages/postgrest-swr/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @supabase-cache-helpers/postgrest-swr
 
+## 1.10.3
+
+### Patch Changes
+
+- Updated dependencies [b06405b]
+  - @supabase-cache-helpers/postgrest-core@0.8.3
+
+## 1.10.2
+
+### Patch Changes
+
+- Updated dependencies [bfdf3ac]
+  - @supabase-cache-helpers/postgrest-core@0.8.2
+
 ## 1.10.1
 
 ### Patch Changes

packages/postgrest-swr/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@supabase-cache-helpers/postgrest-swr",
-  "version": "1.10.1",
+  "version": "1.10.3",
   "author": "Philipp Steinrötter <[email protected]>",
   "homepage": "https://supabase-cache-helpers.vercel.app",
   "bugs": {

turbo.json

@@ -7,8 +7,8 @@
       "outputs": ["dist/**", ".next/**"]
     },
     "test": {
-      "outputs": ["coverage/**"],
-      "dependsOn": []
+      "dependsOn": ["^build"],
+      "outputs": ["coverage/**"]
     },
     "clean": {
       "outputs": []