Merge pull request #458 from psteinroe/feat/abort-signal

feat: support abort signal in react query

.changeset/ten-otters-vanish.md

@@ -0,0 +1,5 @@
+---
+"@supabase-cache-helpers/postgrest-react-query": minor
+---
+
+feat: support abort signal

.changeset/tricky-donuts-do.md

@@ -0,0 +1,5 @@
+---
+"@supabase-cache-helpers/postgrest-core": patch
+---
+
+feat: is transform builder helper

package.json

@@ -31,7 +31,7 @@
     "@changesets/cli": "2.27.0",
     "eslint": "8.54.0",
     "prettier": "3.2.0",
-    "supabase": "^1.145.4",
+    "supabase": "latest",
     "turbo": "1.10.16"
   },
   "engines": {

packages/postgrest-core/__tests__/index.spec.ts

@@ -2,6 +2,6 @@ import * as Import from '../src';
 
 describe('index exports', () => {
   it('should export', () => {
-    expect(Object.keys(Import)).toHaveLength(38);
+    expect(Object.keys(Import)).toHaveLength(39);
   });
 });

packages/postgrest-core/src/index.ts

@@ -8,6 +8,7 @@ export * from './lib/cache-data-types';
 export * from './lib/response-types';
 export * from './lib/encode-object';
 export * from './lib/is-postgrest-builder';
+export * from './lib/is-postgrest-transform-builder';
 export * from './lib/get';
 export * from './lib/set-filter-value';
 export * from './lib/parse-value';

packages/postgrest-core/src/lib/is-postgrest-transform-builder.ts

@@ -0,0 +1,30 @@
+import { PostgrestTransformBuilder } from '@supabase/postgrest-js';
+import { GenericSchema } from '@supabase/postgrest-js/dist/module/types';
+
+export const isPostgrestTransformBuilder = <
+  Schema extends GenericSchema,
+  Row extends Record<string, unknown>,
+  Result,
+  RelationName = unknown,
+  Relationships = unknown,
+>(
+  q: unknown,
+): q is PostgrestTransformBuilder<
+  Schema,
+  Row,
+  Result,
+  RelationName,
+  Relationships
+> => {
+  return (
+    typeof (
+      q as PostgrestTransformBuilder<
+        Schema,
+        Row,
+        Result,
+        RelationName,
+        Relationships
+      >
+    ).abortSignal === 'function'
+  );
+};

packages/postgrest-react-query/src/query/build-query-opts.ts

@@ -2,6 +2,7 @@ import { PostgrestError } from '@supabase/postgrest-js';
 import {
   AnyPostgrestResponse,
   isPostgrestBuilder,
+  isPostgrestTransformBuilder,
 } from '@supabase-cache-helpers/postgrest-core';
 import { UseQueryOptions as UseReactQueryOptions } from '@tanstack/react-query';
 
@@ -16,7 +17,10 @@ export function buildQueryOpts<Result>(
 ): UseReactQueryOptions<AnyPostgrestResponse<Result>, PostgrestError> {
   return {
     queryKey: encode<Result>(query, false),
-    queryFn: async () => {
+    queryFn: async ({ signal }) => {
+      if (isPostgrestTransformBuilder(query)) {
+        query = query.abortSignal(signal);
+      }
       if (isPostgrestBuilder(query)) {
         query = query.throwOnError();
       }