@tanstack/query-core 4.24.10 → 5.0.0-alpha.0

package/src/utils.ts

@@ -2,10 +2,8 @@ import type { Mutation } from './mutation'
 import type { Query } from './query'
 import type {
   FetchStatus,
-  MutationFunction,
   MutationKey,
-  MutationOptions,
-  QueryFunction,
+  MutationStatus,
   QueryKey,
   QueryOptions,
 } from './types'
@@ -53,9 +51,9 @@ export interface MutationFilters {
    */
   mutationKey?: MutationKey
   /**
-   * Include or exclude fetching mutations
+   * Filter by mutation status
    */
-  fetching?: boolean
+  status?: MutationStatus
 }
 
 export type DataUpdateFunction<TInput, TOutput> = (input: TInput) => TOutput
@@ -87,88 +85,10 @@ export function isValidTimeout(value: unknown): value is number {
   return typeof value === 'number' && value >= 0 && value !== Infinity
 }
 
-export function difference<T>(array1: T[], array2: T[]): T[] {
-  return array1.filter((x) => array2.indexOf(x) === -1)
-}
-
-export function replaceAt<T>(array: T[], index: number, value: T): T[] {
-  const copy = array.slice(0)
-  copy[index] = value
-  return copy
-}
-
 export function timeUntilStale(updatedAt: number, staleTime?: number): number {
   return Math.max(updatedAt + (staleTime || 0) - Date.now(), 0)
 }
 
-export function parseQueryArgs<
-  TOptions extends QueryOptions<any, any, any, TQueryKey>,
-  TQueryKey extends QueryKey = QueryKey,
->(
-  arg1: TQueryKey | TOptions,
-  arg2?: QueryFunction<any, TQueryKey> | TOptions,
-  arg3?: TOptions,
-): TOptions {
-  if (!isQueryKey(arg1)) {
-    return arg1 as TOptions
-  }
-
-  if (typeof arg2 === 'function') {
-    return { ...arg3, queryKey: arg1, queryFn: arg2 } as TOptions
-  }
-
-  return { ...arg2, queryKey: arg1 } as TOptions
-}
-
-export function parseMutationArgs<
-  TOptions extends MutationOptions<any, any, any, any>,
->(
-  arg1: MutationKey | MutationFunction<any, any> | TOptions,
-  arg2?: MutationFunction<any, any> | TOptions,
-  arg3?: TOptions,
-): TOptions {
-  if (isQueryKey(arg1)) {
-    if (typeof arg2 === 'function') {
-      return { ...arg3, mutationKey: arg1, mutationFn: arg2 } as TOptions
-    }
-    return { ...arg2, mutationKey: arg1 } as TOptions
-  }
-
-  if (typeof arg1 === 'function') {
-    return { ...arg2, mutationFn: arg1 } as TOptions
-  }
-
-  return { ...arg1 } as TOptions
-}
-
-export function parseFilterArgs<
-  TFilters extends QueryFilters,
-  TOptions = unknown,
->(
-  arg1?: QueryKey | TFilters,
-  arg2?: TFilters | TOptions,
-  arg3?: TOptions,
-): [TFilters, TOptions | undefined] {
-  return (
-    isQueryKey(arg1) ? [{ ...arg2, queryKey: arg1 }, arg3] : [arg1 || {}, arg2]
-  ) as [TFilters, TOptions]
-}
-
-export function parseMutationFilterArgs<
-  TFilters extends MutationFilters,
-  TOptions = unknown,
->(
-  arg1?: QueryKey | TFilters,
-  arg2?: TFilters | TOptions,
-  arg3?: TOptions,
-): [TFilters, TOptions | undefined] {
-  return (
-    isQueryKey(arg1)
-      ? [{ ...arg2, mutationKey: arg1 }, arg3]
-      : [arg1 || {}, arg2]
-  ) as [TFilters, TOptions]
-}
-
 export function matchQuery(
   filters: QueryFilters,
   query: Query<any, any, any, any>,
@@ -182,7 +102,7 @@ export function matchQuery(
     stale,
   } = filters
 
-  if (isQueryKey(queryKey)) {
+  if (queryKey) {
     if (exact) {
       if (query.queryHash !== hashQueryKeyByOptions(queryKey, query.options)) {
         return false
@@ -224,15 +144,13 @@ export function matchMutation(
   filters: MutationFilters,
   mutation: Mutation<any, any>,
 ): boolean {
-  const { exact, fetching, predicate, mutationKey } = filters
-  if (isQueryKey(mutationKey)) {
+  const { exact, status, predicate, mutationKey } = filters
+  if (mutationKey) {
     if (!mutation.options.mutationKey) {
       return false
     }
     if (exact) {
-      if (
-        hashQueryKey(mutation.options.mutationKey) !== hashQueryKey(mutationKey)
-      ) {
+      if (hashKey(mutation.options.mutationKey) !== hashKey(mutationKey)) {
         return false
       }
     } else if (!partialMatchKey(mutation.options.mutationKey, mutationKey)) {
@@ -240,10 +158,7 @@ export function matchMutation(
     }
   }
 
-  if (
-    typeof fetching === 'boolean' &&
-    (mutation.state.status === 'loading') !== fetching
-  ) {
+  if (status && mutation.state.status !== status) {
     return false
   }
 
@@ -258,15 +173,15 @@ export function hashQueryKeyByOptions<TQueryKey extends QueryKey = QueryKey>(
   queryKey: TQueryKey,
   options?: QueryOptions<any, any, any, TQueryKey>,
 ): string {
-  const hashFn = options?.queryKeyHashFn || hashQueryKey
+  const hashFn = options?.queryKeyHashFn || hashKey
   return hashFn(queryKey)
 }
 
 /**
- * Default query keys hash function.
+ * Default query & mutation keys hash function.
  * Hashes the value into a stable hash.
  */
-export function hashQueryKey(queryKey: QueryKey): string {
+export function hashKey(queryKey: QueryKey | MutationKey): string {
   return JSON.stringify(queryKey, (_, val) =>
     isPlainObject(val)
       ? Object.keys(val)
@@ -282,14 +197,8 @@ export function hashQueryKey(queryKey: QueryKey): string {
 /**
  * Checks if key `b` partially matches with key `a`.
  */
-export function partialMatchKey(a: QueryKey, b: QueryKey): boolean {
-  return partialDeepEqual(a, b)
-}
-
-/**
- * Checks if `b` partially matches with `a`.
- */
-export function partialDeepEqual(a: any, b: any): boolean {
+export function partialMatchKey(a: QueryKey, b: QueryKey): boolean
+export function partialMatchKey(a: any, b: any): boolean {
   if (a === b) {
     return true
   }
@@ -299,7 +208,7 @@ export function partialDeepEqual(a: any, b: any): boolean {
   }
 
   if (a && b && typeof a === 'object' && typeof b === 'object') {
-    return !Object.keys(b).some((key) => !partialDeepEqual(a[key], b[key]))
+    return !Object.keys(b).some((key) => !partialMatchKey(a[key], b[key]))
   }
 
   return false
@@ -392,14 +301,6 @@ function hasObjectPrototype(o: any): boolean {
   return Object.prototype.toString.call(o) === '[object Object]'
 }
 
-export function isQueryKey(value: unknown): value is QueryKey {
-  return Array.isArray(value)
-}
-
-export function isError(value: any): value is Error {
-  return value instanceof Error
-}
-
 export function sleep(timeout: number): Promise<void> {
   return new Promise((resolve) => {
     setTimeout(resolve, timeout)
@@ -414,21 +315,11 @@ export function scheduleMicrotask(callback: () => void) {
   sleep(0).then(callback)
 }
 
-export function getAbortController(): AbortController | undefined {
-  if (typeof AbortController === 'function') {
-    return new AbortController()
-  }
-  return
-}
-
 export function replaceData<
   TData,
   TOptions extends QueryOptions<any, any, any, any>,
 >(prevData: TData | undefined, data: TData, options: TOptions): TData {
-  // Use prev data if an isDataEqual function is defined and returns `true`
-  if (options.isDataEqual?.(prevData, data)) {
-    return prevData as TData
-  } else if (typeof options.structuralSharing === 'function') {
+  if (typeof options.structuralSharing === 'function') {
     return options.structuralSharing(prevData, data)
   } else if (options.structuralSharing !== false) {
     // Structurally share data between prev and new data if needed
@@ -436,3 +327,19 @@ export function replaceData<
   }
   return data
 }
+
+export function keepPreviousData<T>(
+  previousData: T | undefined,
+): T | undefined {
+  return previousData
+}
+
+export function addToEnd<T>(items: T[], item: T, max = 0): T[] {
+  const newItems = [...items, item]
+  return max && newItems.length > max ? newItems.slice(1) : newItems
+}
+
+export function addToStart<T>(items: T[], item: T, max = 0): T[] {
+  const newItems = [item, ...items]
+  return max && newItems.length > max ? newItems.slice(0, -1) : newItems
+}

package/build/lib/logger.d.ts

@@ -1,8 +0,0 @@
-export interface Logger {
-    log: LogFunction;
-    warn: LogFunction;
-    error: LogFunction;
-}
-declare type LogFunction = (...args: any[]) => void;
-export declare const defaultLogger: Logger;
-export {};

package/build/lib/logger.esm.js

@@ -1,4 +0,0 @@
-const defaultLogger = console;
-
-export { defaultLogger };
-//# sourceMappingURL=logger.esm.js.map

package/build/lib/logger.esm.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"logger.esm.js","sources":["../../src/logger.ts"],"sourcesContent":["export interface Logger {\n  log: LogFunction\n  warn: LogFunction\n  error: LogFunction\n}\n\ntype LogFunction = (...args: any[]) => void\n\nexport const defaultLogger: Logger = console\n"],"names":["defaultLogger","console"],"mappings":"AAQO,MAAMA,aAAqB,GAAGC;;;;"}

package/build/lib/logger.js

@@ -1,8 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-const defaultLogger = console;
-
-exports.defaultLogger = defaultLogger;
-//# sourceMappingURL=logger.js.map

package/build/lib/logger.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"logger.js","sources":["../../src/logger.ts"],"sourcesContent":["export interface Logger {\n  log: LogFunction\n  warn: LogFunction\n  error: LogFunction\n}\n\ntype LogFunction = (...args: any[]) => void\n\nexport const defaultLogger: Logger = console\n"],"names":["defaultLogger","console"],"mappings":";;;;AAQO,MAAMA,aAAqB,GAAGC;;;;"}

package/build/lib/logger.mjs

@@ -1,4 +0,0 @@
-const defaultLogger = console;
-
-export { defaultLogger };
-//# sourceMappingURL=logger.mjs.map

package/build/lib/logger.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"logger.mjs","sources":["../../src/logger.ts"],"sourcesContent":["export interface Logger {\n  log: LogFunction\n  warn: LogFunction\n  error: LogFunction\n}\n\ntype LogFunction = (...args: any[]) => void\n\nexport const defaultLogger: Logger = console\n"],"names":["defaultLogger","console"],"mappings":"AAQO,MAAMA,aAAqB,GAAGC;;;;"}

package/build/lib/logger.native.d.ts

@@ -1,6 +0,0 @@
-import type { Logger } from './logger';
-/**
- * See https://github.com/tannerlinsley/react-query/issues/795
- * and https://github.com/tannerlinsley/react-query/pull/3246/#discussion_r795105707
- */
-export declare const defaultLogger: Logger;

package/build/lib/logger.native.esm.js

@@ -1,12 +0,0 @@
-/**
- * See https://github.com/tannerlinsley/react-query/issues/795
- * and https://github.com/tannerlinsley/react-query/pull/3246/#discussion_r795105707
- */
-const defaultLogger = {
-  log: console.log,
-  warn: console.warn,
-  error: console.warn
-};
-
-export { defaultLogger };
-//# sourceMappingURL=logger.native.esm.js.map

package/build/lib/logger.native.esm.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"logger.native.esm.js","sources":["../../src/logger.native.ts"],"sourcesContent":["import type { Logger } from './logger'\n\n/**\n * See https://github.com/tannerlinsley/react-query/issues/795\n * and https://github.com/tannerlinsley/react-query/pull/3246/#discussion_r795105707\n */\nexport const defaultLogger: Logger = {\n  log: console.log,\n  warn: console.warn,\n  error: console.warn,\n}\n"],"names":["defaultLogger","log","console","warn","error"],"mappings":"AAEA;AACA;AACA;AACA;AACO,MAAMA,aAAqB,GAAG;EACnCC,GAAG,EAAEC,OAAO,CAACD,GADsB;EAEnCE,IAAI,EAAED,OAAO,CAACC,IAFqB;EAGnCC,KAAK,EAAEF,OAAO,CAACC,IAAAA;AAHoB;;;;"}

package/build/lib/logger.native.js

@@ -1,16 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-/**
- * See https://github.com/tannerlinsley/react-query/issues/795
- * and https://github.com/tannerlinsley/react-query/pull/3246/#discussion_r795105707
- */
-const defaultLogger = {
-  log: console.log,
-  warn: console.warn,
-  error: console.warn
-};
-
-exports.defaultLogger = defaultLogger;
-//# sourceMappingURL=logger.native.js.map

package/build/lib/logger.native.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"logger.native.js","sources":["../../src/logger.native.ts"],"sourcesContent":["import type { Logger } from './logger'\n\n/**\n * See https://github.com/tannerlinsley/react-query/issues/795\n * and https://github.com/tannerlinsley/react-query/pull/3246/#discussion_r795105707\n */\nexport const defaultLogger: Logger = {\n  log: console.log,\n  warn: console.warn,\n  error: console.warn,\n}\n"],"names":["defaultLogger","log","console","warn","error"],"mappings":";;;;AAEA;AACA;AACA;AACA;AACO,MAAMA,aAAqB,GAAG;EACnCC,GAAG,EAAEC,OAAO,CAACD,GADsB;EAEnCE,IAAI,EAAED,OAAO,CAACC,IAFqB;EAGnCC,KAAK,EAAEF,OAAO,CAACC,IAAAA;AAHoB;;;;"}

package/build/lib/logger.native.mjs

@@ -1,12 +0,0 @@
-/**
- * See https://github.com/tannerlinsley/react-query/issues/795
- * and https://github.com/tannerlinsley/react-query/pull/3246/#discussion_r795105707
- */
-const defaultLogger = {
-  log: console.log,
-  warn: console.warn,
-  error: console.warn
-};
-
-export { defaultLogger };
-//# sourceMappingURL=logger.native.mjs.map

package/build/lib/logger.native.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"logger.native.mjs","sources":["../../src/logger.native.ts"],"sourcesContent":["import type { Logger } from './logger'\n\n/**\n * See https://github.com/tannerlinsley/react-query/issues/795\n * and https://github.com/tannerlinsley/react-query/pull/3246/#discussion_r795105707\n */\nexport const defaultLogger: Logger = {\n  log: console.log,\n  warn: console.warn,\n  error: console.warn,\n}\n"],"names":["defaultLogger","log","console","warn","error"],"mappings":"AAEA;AACA;AACA;AACA;AACO,MAAMA,aAAqB,GAAG;EACnCC,GAAG,EAAEC,OAAO,CAACD,GADsB;EAEnCE,IAAI,EAAED,OAAO,CAACC,IAFqB;EAGnCC,KAAK,EAAEF,OAAO,CAACC,IAAAA;AAHoB;;;;"}

package/src/logger.native.ts

@@ -1,11 +0,0 @@
-import type { Logger } from './logger'
-
-/**
- * See https://github.com/tannerlinsley/react-query/issues/795
- * and https://github.com/tannerlinsley/react-query/pull/3246/#discussion_r795105707
- */
-export const defaultLogger: Logger = {
-  log: console.log,
-  warn: console.warn,
-  error: console.warn,
-}

package/src/logger.ts

@@ -1,9 +0,0 @@
-export interface Logger {
-  log: LogFunction
-  warn: LogFunction
-  error: LogFunction
-}
-
-type LogFunction = (...args: any[]) => void
-
-export const defaultLogger: Logger = console