@tramvai/react-query 2.130.11 → 2.132.0

package/lib/baseQuery/types.d.ts

@@ -4,6 +4,8 @@ import type { Container, ProvideDepsIterator, ProviderDeps } from '@tinkoff/dipp
 export declare const QUERY_PARAMETERS = "__query_parameters__";
 export interface ReactQueryContext<Deps extends ProviderDeps> {
     deps: ProvideDepsIterator<Deps>;
+    abortController?: AbortController;
+    abortSignal?: AbortSignal;
 }
 export type ReactQueryKeyOrString = ReactQueryKey | string;
 export type QueryKey<Options, Deps extends ProviderDeps> = ((this: ReactQueryContext<Deps>, options: Options) => ReactQueryKeyOrString) | ReactQueryKeyOrString;

package/lib/infiniteQuery/create.es.js

@@ -6,6 +6,7 @@ import { DI_TOKEN } from '@tinkoff/dippy';
 import { QUERY_PARAMETERS } from '../baseQuery/types.es.js';
 import { normalizeKey } from '../shared/normalizeKey.es.js';
 import { resolveDI } from '../shared/resolveDI.es.js';
+import { mapQuerySignalToxecutionContext } from '../shared/signal.es.js';
 
 const convertToRawQuery = (query, di, options) => {
     const { key = identity, fn, getNextPageParam, getPreviousPageParam, deps = {}, conditions, infiniteQueryOptions, } = query[QUERY_PARAMETERS];
@@ -15,8 +16,10 @@ const convertToRawQuery = (query, di, options) => {
     const queryKey = normalizeKey(rawQueryKey);
     const actionWrapper = declareAction({
         name: 'infiniteQueryExecution',
-        async fn(pageParam) {
-            return fn.call(ctx, options, pageParam, ctx.deps);
+        async fn(queryContext) {
+            const { abortSignal, abortController } = this;
+            mapQuerySignalToxecutionContext(queryContext, this);
+            return fn.call({ ...ctx, abortSignal, abortController }, options, queryContext.pageParam, ctx.deps);
         },
         conditionsFailResult: 'reject',
         deps,
@@ -30,9 +33,9 @@ const convertToRawQuery = (query, di, options) => {
         tramvaiOptions: {
             conditions,
         },
-        queryFn: ({ pageParam }) => {
+        queryFn: (queryContext) => {
             const context = di.get(CONTEXT_TOKEN);
-            return context.executeAction(actionWrapper, pageParam);
+            return context.executeAction(actionWrapper, queryContext);
         },
     };
 };

package/lib/infiniteQuery/create.js

@@ -10,6 +10,7 @@ var dippy = require('@tinkoff/dippy');
 var types = require('../baseQuery/types.js');
 var normalizeKey = require('../shared/normalizeKey.js');
 var resolveDI = require('../shared/resolveDI.js');
+var signal = require('../shared/signal.js');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -23,8 +24,10 @@ const convertToRawQuery = (query, di, options) => {
     const queryKey = normalizeKey.normalizeKey(rawQueryKey);
     const actionWrapper = core.declareAction({
         name: 'infiniteQueryExecution',
-        async fn(pageParam) {
-            return fn.call(ctx, options, pageParam, ctx.deps);
+        async fn(queryContext) {
+            const { abortSignal, abortController } = this;
+            signal.mapQuerySignalToxecutionContext(queryContext, this);
+            return fn.call({ ...ctx, abortSignal, abortController }, options, queryContext.pageParam, ctx.deps);
         },
         conditionsFailResult: 'reject',
         deps,
@@ -38,9 +41,9 @@ const convertToRawQuery = (query, di, options) => {
         tramvaiOptions: {
             conditions,
         },
-        queryFn: ({ pageParam }) => {
+        queryFn: (queryContext) => {
             const context = di.get(tokensCommon.CONTEXT_TOKEN);
-            return context.executeAction(actionWrapper, pageParam);
+            return context.executeAction(actionWrapper, queryContext);
         },
     };
 };

package/lib/query/create.es.js

@@ -6,6 +6,7 @@ import { CONTEXT_TOKEN } from '@tramvai/tokens-common';
 import { QUERY_PARAMETERS } from '../baseQuery/types.es.js';
 import { normalizeKey } from '../shared/normalizeKey.es.js';
 import { resolveDI } from '../shared/resolveDI.es.js';
+import { mapQuerySignalToxecutionContext } from '../shared/signal.es.js';
 
 const convertToRawQuery = (query, di, options) => {
     const { key = identity, fn, deps = {}, conditions, queryOptions } = query[QUERY_PARAMETERS];
@@ -15,8 +16,10 @@ const convertToRawQuery = (query, di, options) => {
     const queryKey = normalizeKey(rawQueryKey);
     const actionWrapper = declareAction({
         name: 'queryExecution',
-        async fn() {
-            return fn.call(ctx, options, ctx.deps);
+        async fn(queryContext) {
+            const { abortSignal, abortController } = this;
+            mapQuerySignalToxecutionContext(queryContext, this);
+            return fn.call({ ...ctx, abortSignal, abortController }, options, ctx.deps);
         },
         deps,
         conditions,
@@ -28,9 +31,9 @@ const convertToRawQuery = (query, di, options) => {
         tramvaiOptions: {
             conditions,
         },
-        queryFn: () => {
+        queryFn: (queryContext) => {
             const context = di.get(CONTEXT_TOKEN);
-            return context.executeAction(actionWrapper);
+            return context.executeAction(actionWrapper, queryContext);
         },
     };
 };

package/lib/query/create.js

@@ -10,6 +10,7 @@ var tokensCommon = require('@tramvai/tokens-common');
 var types = require('../baseQuery/types.js');
 var normalizeKey = require('../shared/normalizeKey.js');
 var resolveDI = require('../shared/resolveDI.js');
+var signal = require('../shared/signal.js');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -23,8 +24,10 @@ const convertToRawQuery = (query, di, options) => {
     const queryKey = normalizeKey.normalizeKey(rawQueryKey);
     const actionWrapper = core.declareAction({
         name: 'queryExecution',
-        async fn() {
-            return fn.call(ctx, options, ctx.deps);
+        async fn(queryContext) {
+            const { abortSignal, abortController } = this;
+            signal.mapQuerySignalToxecutionContext(queryContext, this);
+            return fn.call({ ...ctx, abortSignal, abortController }, options, ctx.deps);
         },
         deps,
         conditions,
@@ -36,9 +39,9 @@ const convertToRawQuery = (query, di, options) => {
         tramvaiOptions: {
             conditions,
         },
-        queryFn: () => {
+        queryFn: (queryContext) => {
             const context = di.get(tokensCommon.CONTEXT_TOKEN);
-            return context.executeAction(actionWrapper);
+            return context.executeAction(actionWrapper, queryContext);
         },
     };
 };

package/lib/shared/signal.d.ts

@@ -0,0 +1,4 @@
+import type { TramvaiActionContext } from '@tramvai/core';
+export declare const mapQuerySignalToxecutionContext: (queryContext: {
+    signal?: AbortSignal | undefined;
+} | undefined, actionContext: TramvaiActionContext<any>) => void;

package/lib/shared/signal.es.js

@@ -0,0 +1,16 @@
+// Support query cancellation - https://tanstack.com/query/v4/docs/react/guides/query-cancellation
+const mapQuerySignalToxecutionContext = (queryContext = {}, actionContext) => {
+    if (queryContext.signal) {
+        if (queryContext.signal.aborted) {
+            actionContext.abortController.abort();
+        }
+        else {
+            // abort action context AbortController if react-query AbortController was aborted
+            queryContext.signal.addEventListener('abort', () => {
+                actionContext.abortController.abort();
+            });
+        }
+    }
+};
+
+export { mapQuerySignalToxecutionContext };

package/lib/shared/signal.js

@@ -0,0 +1,20 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+// Support query cancellation - https://tanstack.com/query/v4/docs/react/guides/query-cancellation
+const mapQuerySignalToxecutionContext = (queryContext = {}, actionContext) => {
+    if (queryContext.signal) {
+        if (queryContext.signal.aborted) {
+            actionContext.abortController.abort();
+        }
+        else {
+            // abort action context AbortController if react-query AbortController was aborted
+            queryContext.signal.addEventListener('abort', () => {
+                actionContext.abortController.abort();
+            });
+        }
+    }
+};
+
+exports.mapQuerySignalToxecutionContext = mapQuerySignalToxecutionContext;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tramvai/react-query",
-  "version": "2.130.11",
+  "version": "2.132.0",
   "description": "",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -18,10 +18,10 @@
   },
   "dependencies": {
     "@tinkoff/react-hooks": "0.1.6",
-    "@tramvai/core": "2.130.11",
-    "@tramvai/module-react-query": "2.130.11",
-    "@tramvai/react": "2.130.11",
-    "@tramvai/tokens-common": "2.130.11"
+    "@tramvai/core": "2.132.0",
+    "@tramvai/module-react-query": "2.132.0",
+    "@tramvai/react": "2.132.0",
+    "@tramvai/tokens-common": "2.132.0"
   },
   "peerDependencies": {
     "@tinkoff/dippy": "0.8.15",