@tanstack/query-core
Version:
The framework agnostic core that powers TanStack Query
219 lines (218 loc) • 11.1 kB
JavaScript
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
const require_classPrivateFieldSet2 = require("./classPrivateFieldSet2-CvCEk6bM.cjs");
const require_utils = require("./utils.cjs");
const require_subscribable = require("./subscribable.cjs");
const require_notifyManager = require("./notifyManager.cjs");
const require_classPrivateMethodInitSpec = require("./classPrivateMethodInitSpec-Nr6mgZRs.cjs");
const require_mutation = require("./mutation.cjs");
//#region src/mutationObserver.ts
var _client = /* @__PURE__ */ new WeakMap();
var _currentResult = /* @__PURE__ */ new WeakMap();
var _currentMutation = /* @__PURE__ */ new WeakMap();
var _mutateOptions = /* @__PURE__ */ new WeakMap();
var _MutationObserver_brand = /* @__PURE__ */ new WeakSet();
/**
* Observes a single mutation and derives a `MutationObserverResult` from it.
* A framework hook like `useMutation` creates one `MutationObserver` per hook
* call, keeps it stable across re-renders, calls `setOptions` when the options
* passed to the hook change, subscribes to it to re-render on updates, and
* reads `getCurrentResult()` for the value to return. Calling `mutate()`
* builds a new underlying `Mutation` in the `MutationCache` and executes it.
* @example
* ```ts
* const observer = new MutationObserver(queryClient, {
* mutationFn: (variables: { title: string }) => addPost(variables),
* })
* ```
*/
var MutationObserver = class extends require_subscribable.Subscribable {
constructor(client, options) {
super();
require_classPrivateMethodInitSpec._classPrivateMethodInitSpec(this, _MutationObserver_brand);
require_classPrivateFieldSet2._classPrivateFieldInitSpec(this, _client, void 0);
require_classPrivateFieldSet2._classPrivateFieldInitSpec(this, _currentResult, void 0);
require_classPrivateFieldSet2._classPrivateFieldInitSpec(this, _currentMutation, void 0);
require_classPrivateFieldSet2._classPrivateFieldInitSpec(this, _mutateOptions, void 0);
require_classPrivateFieldSet2._classPrivateFieldSet2(_client, this, client);
this.setOptions(options);
this.bindMethods();
require_classPrivateFieldSet2._assertClassBrand(_MutationObserver_brand, this, _updateResult).call(this);
}
/**
* Binds the methods of the result (`mutate` and `reset`) to the observer, so they keep working when
* destructured from it.
*/
bindMethods() {
this.mutate = this.mutate.bind(this);
this.reset = this.reset.bind(this);
}
/**
* Updates the observer's options.
*
* If the new `mutationKey` differs from the previous one (and both were
* defined), the observer is reset, detaching it from the mutation it was
* observing. Otherwise, if the currently observed mutation is still
* `pending`, its options are updated in place as well.
* @param options - The new mutation observer options. They are defaulted with {@link
* QueryClient#defaultMutationOptions} before being applied.
* @example
* ```ts
* observer.setOptions({
* mutationFn: (variables: { title: string }) => addPost(variables),
* onSuccess: (data) => console.log(data),
* })
* ```
*/
setOptions(options) {
var _classPrivateFieldGet2$1;
const prevOptions = this.options;
this.options = require_classPrivateFieldSet2._classPrivateFieldGet2(_client, this).defaultMutationOptions(options);
if (!require_utils.shallowEqualObjects(this.options, prevOptions)) require_classPrivateFieldSet2._classPrivateFieldGet2(_client, this).getMutationCache().notify({
type: "observerOptionsUpdated",
mutation: require_classPrivateFieldSet2._classPrivateFieldGet2(_currentMutation, this),
observer: this
});
if ((prevOptions === null || prevOptions === void 0 ? void 0 : prevOptions.mutationKey) && this.options.mutationKey && require_utils.hashKey(prevOptions.mutationKey) !== require_utils.hashKey(this.options.mutationKey)) this.reset();
else if (((_classPrivateFieldGet2$1 = require_classPrivateFieldSet2._classPrivateFieldGet2(_currentMutation, this)) === null || _classPrivateFieldGet2$1 === void 0 ? void 0 : _classPrivateFieldGet2$1.state.status) === "pending") require_classPrivateFieldSet2._classPrivateFieldGet2(_currentMutation, this).setOptions(this.options);
}
onSubscribe() {
if (this.listeners.size === 1 && require_classPrivateFieldSet2._classPrivateFieldGet2(_currentMutation, this)) {
require_classPrivateFieldSet2._classPrivateFieldGet2(_currentMutation, this).addObserver(this);
require_classPrivateFieldSet2._assertClassBrand(_MutationObserver_brand, this, _updateResult).call(this);
}
}
onUnsubscribe() {
if (!this.hasListeners()) {
var _classPrivateFieldGet3;
(_classPrivateFieldGet3 = require_classPrivateFieldSet2._classPrivateFieldGet2(_currentMutation, this)) === null || _classPrivateFieldGet3 === void 0 || _classPrivateFieldGet3.removeObserver(this);
}
}
/**
* Updates the observer's result when the observed mutation changes, and notifies its listeners.
* @internal
* @param action - The action that updated the observed mutation, passed on to the observer's
* callbacks.
*/
onMutationUpdate(action) {
require_classPrivateFieldSet2._assertClassBrand(_MutationObserver_brand, this, _updateResult).call(this);
require_classPrivateFieldSet2._assertClassBrand(_MutationObserver_brand, this, _notify).call(this, action);
}
/**
* Returns the observer's current result, derived from the observed
* mutation's state (or the default, `idle` state if no mutation has been
* built yet, e.g. before the first `mutate()` call or after `reset()`).
* @returns The observer's latest result.
*/
getCurrentResult() {
return require_classPrivateFieldSet2._classPrivateFieldGet2(_currentResult, this);
}
/**
* Detaches the observer from the mutation it is currently observing (if
* any) and resets the observed result back to its default, `idle` state.
*
* This does not cancel an in-flight mutation; the mutation itself keeps
* running to completion and its own callbacks still fire, but this
* observer stops reflecting its state and a subsequent `mutate()` call
* will build a brand new mutation.
* @see {@link MutationObserver#mutate}
* @example
* ```ts
* observer.reset()
* ```
*/
reset() {
var _classPrivateFieldGet4;
(_classPrivateFieldGet4 = require_classPrivateFieldSet2._classPrivateFieldGet2(_currentMutation, this)) === null || _classPrivateFieldGet4 === void 0 || _classPrivateFieldGet4.removeObserver(this);
require_classPrivateFieldSet2._classPrivateFieldSet2(_currentMutation, this, void 0);
require_classPrivateFieldSet2._assertClassBrand(_MutationObserver_brand, this, _updateResult).call(this);
require_classPrivateFieldSet2._assertClassBrand(_MutationObserver_brand, this, _notify).call(this);
}
/**
* Builds a new `Mutation` in the `MutationCache` using the observer's
* current options, detaches this observer from any previously observed
* mutation, attaches it to the new one, and executes it with the given
* variables.
*
* The optional per-call `options` (`onSuccess`/`onError`/`onSettled`) are
* invoked once the mutation settles, in addition to any callbacks defined
* on the observer's own options.
* @param variables - The variables passed to the `mutationFn`.
* @param options - Per-call `onSuccess`, `onError`, and `onSettled` callbacks.
* @returns A promise that resolves with the mutation's data, or rejects with its error.
* @example
* ```ts
* await observer.mutate(
* { title: 'New post' },
* { onSuccess: (data) => console.log(data) },
* )
* ```
*/
mutate(variables, options) {
var _classPrivateFieldGet5;
require_classPrivateFieldSet2._classPrivateFieldSet2(_mutateOptions, this, options);
(_classPrivateFieldGet5 = require_classPrivateFieldSet2._classPrivateFieldGet2(_currentMutation, this)) === null || _classPrivateFieldGet5 === void 0 || _classPrivateFieldGet5.removeObserver(this);
require_classPrivateFieldSet2._classPrivateFieldSet2(_currentMutation, this, require_classPrivateFieldSet2._classPrivateFieldGet2(_client, this).getMutationCache().build(require_classPrivateFieldSet2._classPrivateFieldGet2(_client, this), this.options));
require_classPrivateFieldSet2._classPrivateFieldGet2(_currentMutation, this).addObserver(this);
return require_classPrivateFieldSet2._classPrivateFieldGet2(_currentMutation, this).execute(variables);
}
};
function _updateResult() {
var _classPrivateFieldGet6;
const state = ((_classPrivateFieldGet6 = require_classPrivateFieldSet2._classPrivateFieldGet2(_currentMutation, this)) === null || _classPrivateFieldGet6 === void 0 ? void 0 : _classPrivateFieldGet6.state) ?? require_mutation.getDefaultState();
require_classPrivateFieldSet2._classPrivateFieldSet2(_currentResult, this, {
...state,
isPending: state.status === "pending",
isSuccess: state.status === "success",
isError: state.status === "error",
isIdle: state.status === "idle",
mutate: this.mutate,
reset: this.reset
});
}
function _notify(action) {
require_notifyManager.notifyManager.batch(() => {
const mutateOptions = require_classPrivateFieldSet2._classPrivateFieldGet2(_mutateOptions, this);
if (mutateOptions && this.hasListeners()) {
const variables = require_classPrivateFieldSet2._classPrivateFieldGet2(_currentResult, this).variables;
const onMutateResult = require_classPrivateFieldSet2._classPrivateFieldGet2(_currentResult, this).context;
const context = {
client: require_classPrivateFieldSet2._classPrivateFieldGet2(_client, this),
meta: this.options.meta,
mutationKey: this.options.mutationKey
};
if ((action === null || action === void 0 ? void 0 : action.type) === "success") {
try {
var _mutateOptions$onSucc;
(_mutateOptions$onSucc = mutateOptions.onSuccess) === null || _mutateOptions$onSucc === void 0 || _mutateOptions$onSucc.call(mutateOptions, action.data, variables, onMutateResult, context);
} catch (e) {
Promise.reject(e);
}
try {
var _mutateOptions$onSett;
(_mutateOptions$onSett = mutateOptions.onSettled) === null || _mutateOptions$onSett === void 0 || _mutateOptions$onSett.call(mutateOptions, action.data, null, variables, onMutateResult, context);
} catch (e) {
Promise.reject(e);
}
} else if ((action === null || action === void 0 ? void 0 : action.type) === "error") {
try {
var _mutateOptions$onErro;
(_mutateOptions$onErro = mutateOptions.onError) === null || _mutateOptions$onErro === void 0 || _mutateOptions$onErro.call(mutateOptions, action.error, variables, onMutateResult, context);
} catch (e) {
Promise.reject(e);
}
try {
var _mutateOptions$onSett2;
(_mutateOptions$onSett2 = mutateOptions.onSettled) === null || _mutateOptions$onSett2 === void 0 || _mutateOptions$onSett2.call(mutateOptions, void 0, action.error, variables, onMutateResult, context);
} catch (e) {
Promise.reject(e);
}
}
}
this.listeners.forEach((listener) => {
listener(require_classPrivateFieldSet2._classPrivateFieldGet2(_currentResult, this));
});
});
}
//#endregion
exports.MutationObserver = MutationObserver;
//# sourceMappingURL=mutationObserver.cjs.map