UNPKG

@tanstack/query-core

Version:

The framework agnostic core that powers TanStack Query

414 lines (413 loc) 13.4 kB
import { __privateAdd, __privateGet, __privateMethod, __privateSet } from "./chunk-PXG64RU4.js"; // src/query.ts import { ensureQueryFn, noop, replaceData, resolveEnabled, skipToken, timeUntilStale } from "./utils.js"; import { notifyManager } from "./notifyManager.js"; import { canFetch, createRetryer, isCancelledError } from "./retryer.js"; import { Removable } from "./removable.js"; var _initialState, _revertState, _cache, _client, _retryer, _defaultOptions, _abortSignalConsumed, _Query_instances, dispatch_fn; var Query = class extends Removable { constructor(config) { super(); __privateAdd(this, _Query_instances); __privateAdd(this, _initialState); __privateAdd(this, _revertState); __privateAdd(this, _cache); __privateAdd(this, _client); __privateAdd(this, _retryer); __privateAdd(this, _defaultOptions); __privateAdd(this, _abortSignalConsumed); __privateSet(this, _abortSignalConsumed, false); __privateSet(this, _defaultOptions, config.defaultOptions); this.setOptions(config.options); this.observers = []; __privateSet(this, _client, config.client); __privateSet(this, _cache, __privateGet(this, _client).getQueryCache()); this.queryKey = config.queryKey; this.queryHash = config.queryHash; __privateSet(this, _initialState, getDefaultState(this.options)); this.state = config.state ?? __privateGet(this, _initialState); this.scheduleGc(); } get meta() { return this.options.meta; } get promise() { var _a; return (_a = __privateGet(this, _retryer)) == null ? void 0 : _a.promise; } setOptions(options) { this.options = { ...__privateGet(this, _defaultOptions), ...options }; this.updateGcTime(this.options.gcTime); } optionalRemove() { if (!this.observers.length && this.state.fetchStatus === "idle") { __privateGet(this, _cache).remove(this); } } setData(newData, options) { const data = replaceData(this.state.data, newData, this.options); __privateMethod(this, _Query_instances, dispatch_fn).call(this, { data, type: "success", dataUpdatedAt: options == null ? void 0 : options.updatedAt, manual: options == null ? void 0 : options.manual }); return data; } setState(state, setStateOptions) { __privateMethod(this, _Query_instances, dispatch_fn).call(this, { type: "setState", state, setStateOptions }); } cancel(options) { var _a, _b; const promise = (_a = __privateGet(this, _retryer)) == null ? void 0 : _a.promise; (_b = __privateGet(this, _retryer)) == null ? void 0 : _b.cancel(options); return promise ? promise.then(noop).catch(noop) : Promise.resolve(); } destroy() { super.destroy(); this.cancel({ silent: true }); } reset() { this.destroy(); this.setState(__privateGet(this, _initialState)); } isActive() { return this.observers.some( (observer) => resolveEnabled(observer.options.enabled, this) !== false ); } isDisabled() { if (this.getObserversCount() > 0) { return !this.isActive(); } return this.options.queryFn === skipToken || this.state.dataUpdateCount + this.state.errorUpdateCount === 0; } isStale() { if (this.state.isInvalidated) { return true; } if (this.getObserversCount() > 0) { return this.observers.some( (observer) => observer.getCurrentResult().isStale ); } return this.state.data === void 0; } isStaleByTime(staleTime = 0) { return this.state.isInvalidated || this.state.data === void 0 || !timeUntilStale(this.state.dataUpdatedAt, staleTime); } onFocus() { var _a; const observer = this.observers.find((x) => x.shouldFetchOnWindowFocus()); observer == null ? void 0 : observer.refetch({ cancelRefetch: false }); (_a = __privateGet(this, _retryer)) == null ? void 0 : _a.continue(); } onOnline() { var _a; const observer = this.observers.find((x) => x.shouldFetchOnReconnect()); observer == null ? void 0 : observer.refetch({ cancelRefetch: false }); (_a = __privateGet(this, _retryer)) == null ? void 0 : _a.continue(); } addObserver(observer) { if (!this.observers.includes(observer)) { this.observers.push(observer); this.clearGcTimeout(); __privateGet(this, _cache).notify({ type: "observerAdded", query: this, observer }); } } removeObserver(observer) { if (this.observers.includes(observer)) { this.observers = this.observers.filter((x) => x !== observer); if (!this.observers.length) { if (__privateGet(this, _retryer)) { if (__privateGet(this, _abortSignalConsumed)) { __privateGet(this, _retryer).cancel({ revert: true }); } else { __privateGet(this, _retryer).cancelRetry(); } } this.scheduleGc(); } __privateGet(this, _cache).notify({ type: "observerRemoved", query: this, observer }); } } getObserversCount() { return this.observers.length; } invalidate() { if (!this.state.isInvalidated) { __privateMethod(this, _Query_instances, dispatch_fn).call(this, { type: "invalidate" }); } } fetch(options, fetchOptions) { var _a, _b, _c; if (this.state.fetchStatus !== "idle") { if (this.state.data !== void 0 && (fetchOptions == null ? void 0 : fetchOptions.cancelRefetch)) { this.cancel({ silent: true }); } else if (__privateGet(this, _retryer)) { __privateGet(this, _retryer).continueRetry(); return __privateGet(this, _retryer).promise; } } if (options) { this.setOptions(options); } if (!this.options.queryFn) { const observer = this.observers.find((x) => x.options.queryFn); if (observer) { this.setOptions(observer.options); } } if (process.env.NODE_ENV !== "production") { if (!Array.isArray(this.options.queryKey)) { console.error( `As of v4, queryKey needs to be an Array. If you are using a string like 'repoData', please change it to an Array, e.g. ['repoData']` ); } } const abortController = new AbortController(); const addSignalProperty = (object) => { Object.defineProperty(object, "signal", { enumerable: true, get: () => { __privateSet(this, _abortSignalConsumed, true); return abortController.signal; } }); }; const fetchFn = () => { const queryFn = ensureQueryFn(this.options, fetchOptions); const queryFnContext = { client: __privateGet(this, _client), queryKey: this.queryKey, meta: this.meta }; addSignalProperty(queryFnContext); __privateSet(this, _abortSignalConsumed, false); if (this.options.persister) { return this.options.persister( queryFn, queryFnContext, this ); } return queryFn(queryFnContext); }; const context = { fetchOptions, options: this.options, queryKey: this.queryKey, client: __privateGet(this, _client), state: this.state, fetchFn }; addSignalProperty(context); (_a = this.options.behavior) == null ? void 0 : _a.onFetch( context, this ); __privateSet(this, _revertState, this.state); if (this.state.fetchStatus === "idle" || this.state.fetchMeta !== ((_b = context.fetchOptions) == null ? void 0 : _b.meta)) { __privateMethod(this, _Query_instances, dispatch_fn).call(this, { type: "fetch", meta: (_c = context.fetchOptions) == null ? void 0 : _c.meta }); } const onError = (error) => { var _a2, _b2, _c2, _d; if (!(isCancelledError(error) && error.silent)) { __privateMethod(this, _Query_instances, dispatch_fn).call(this, { type: "error", error }); } if (!isCancelledError(error)) { (_b2 = (_a2 = __privateGet(this, _cache).config).onError) == null ? void 0 : _b2.call( _a2, error, this ); (_d = (_c2 = __privateGet(this, _cache).config).onSettled) == null ? void 0 : _d.call( _c2, this.state.data, error, this ); } this.scheduleGc(); }; __privateSet(this, _retryer, createRetryer({ initialPromise: fetchOptions == null ? void 0 : fetchOptions.initialPromise, fn: context.fetchFn, abort: abortController.abort.bind(abortController), onSuccess: (data) => { var _a2, _b2, _c2, _d; if (data === void 0) { if (process.env.NODE_ENV !== "production") { console.error( `Query data cannot be undefined. Please make sure to return a value other than undefined from your query function. Affected query key: ${this.queryHash}` ); } onError(new Error(`${this.queryHash} data is undefined`)); return; } try { this.setData(data); } catch (error) { onError(error); return; } (_b2 = (_a2 = __privateGet(this, _cache).config).onSuccess) == null ? void 0 : _b2.call(_a2, data, this); (_d = (_c2 = __privateGet(this, _cache).config).onSettled) == null ? void 0 : _d.call( _c2, data, this.state.error, this ); this.scheduleGc(); }, onError, onFail: (failureCount, error) => { __privateMethod(this, _Query_instances, dispatch_fn).call(this, { type: "failed", failureCount, error }); }, onPause: () => { __privateMethod(this, _Query_instances, dispatch_fn).call(this, { type: "pause" }); }, onContinue: () => { __privateMethod(this, _Query_instances, dispatch_fn).call(this, { type: "continue" }); }, retry: context.options.retry, retryDelay: context.options.retryDelay, networkMode: context.options.networkMode, canRun: () => true })); return __privateGet(this, _retryer).start(); } }; _initialState = new WeakMap(); _revertState = new WeakMap(); _cache = new WeakMap(); _client = new WeakMap(); _retryer = new WeakMap(); _defaultOptions = new WeakMap(); _abortSignalConsumed = new WeakMap(); _Query_instances = new WeakSet(); dispatch_fn = function(action) { const reducer = (state) => { switch (action.type) { case "failed": return { ...state, fetchFailureCount: action.failureCount, fetchFailureReason: action.error }; case "pause": return { ...state, fetchStatus: "paused" }; case "continue": return { ...state, fetchStatus: "fetching" }; case "fetch": return { ...state, ...fetchState(state.data, this.options), fetchMeta: action.meta ?? null }; case "success": return { ...state, data: action.data, dataUpdateCount: state.dataUpdateCount + 1, dataUpdatedAt: action.dataUpdatedAt ?? Date.now(), error: null, isInvalidated: false, status: "success", ...!action.manual && { fetchStatus: "idle", fetchFailureCount: 0, fetchFailureReason: null } }; case "error": const error = action.error; if (isCancelledError(error) && error.revert && __privateGet(this, _revertState)) { return { ...__privateGet(this, _revertState), fetchStatus: "idle" }; } return { ...state, error, errorUpdateCount: state.errorUpdateCount + 1, errorUpdatedAt: Date.now(), fetchFailureCount: state.fetchFailureCount + 1, fetchFailureReason: error, fetchStatus: "idle", status: "error" }; case "invalidate": return { ...state, isInvalidated: true }; case "setState": return { ...state, ...action.state }; } }; this.state = reducer(this.state); notifyManager.batch(() => { this.observers.forEach((observer) => { observer.onQueryUpdate(); }); __privateGet(this, _cache).notify({ query: this, type: "updated", action }); }); }; function fetchState(data, options) { return { fetchFailureCount: 0, fetchFailureReason: null, fetchStatus: canFetch(options.networkMode) ? "fetching" : "paused", ...data === void 0 && { error: null, status: "pending" } }; } function getDefaultState(options) { const data = typeof options.initialData === "function" ? options.initialData() : options.initialData; const hasData = data !== void 0; const initialDataUpdatedAt = hasData ? typeof options.initialDataUpdatedAt === "function" ? options.initialDataUpdatedAt() : options.initialDataUpdatedAt : 0; return { data, dataUpdateCount: 0, dataUpdatedAt: hasData ? initialDataUpdatedAt ?? Date.now() : 0, error: null, errorUpdateCount: 0, errorUpdatedAt: 0, fetchFailureCount: 0, fetchFailureReason: null, fetchMeta: null, isInvalidated: false, status: hasData ? "success" : "pending", fetchStatus: "idle" }; } export { Query, fetchState }; //# sourceMappingURL=query.js.map