@effector-tanstack-query/core 0.1.0

package/README.md

@@ -0,0 +1,40 @@
+# @effector-tanstack-query/core
+
+Core package: [TanStack Query](https://tanstack.com/query) state and
+operations exposed as effector units.
+
+- Every observer field (`data`, `status`, `isPending`, …) becomes a `Store<T>`
+- Every imperative action (`refetch`, `fetchNextPage`, `mutate`, `reset`, …) is an `EventCallable`
+- A `Store` placed inside `queryKey` triggers automatic refetch on change
+- SSR works via `dehydrate`/`hydrate` for the cache **and** `serialize(scope)`/`fork({ values })` for the effector graph
+
+```bash
+npm install @effector-tanstack-query/core @tanstack/query-core effector
+```
+
+```ts
+import { QueryClient } from '@tanstack/query-core'
+import { setQueryClient, createQuery } from '@effector-tanstack-query/core'
+
+const queryClient = new QueryClient()
+queryClient.mount()
+setQueryClient(queryClient)
+
+const userQuery = createQuery({
+  name: 'user',
+  queryKey: ['user', 1],
+  queryFn: () => fetch('/api/users/1').then((r) => r.json()),
+})
+
+userQuery.mounted()
+```
+
+For React hooks see [`@effector-tanstack-query/react`](https://www.npmjs.com/package/@effector-tanstack-query/react).
+
+**Full documentation:** https://ilyaagarkov.github.io/effector-tanstack-query/
+
+**Source & examples:** https://github.com/ilyaagarkov/effector-tanstack-query
+
+## License
+
+MIT

package/dist/createBaseQuery.cjs

@@ -0,0 +1,208 @@
+'use strict';
+
+var effector = require('effector');
+var queryClient_cjs = require('./queryClient.cjs');
+var resolve_cjs = require('./resolve.cjs');
+
+// src/createBaseQuery.ts
+var SID_PREFIX = "@tanstack/query-effector";
+var warnedNames = /* @__PURE__ */ new Set();
+function warnMissingName(role) {
+  if (typeof process === "undefined" || process.env.NODE_ENV === "production") {
+    return;
+  }
+  if (warnedNames.has(role)) return;
+  warnedNames.add(role);
+  console.warn(
+    `[@tanstack/query-effector] ${role} created without a "name" \u2014 internal stores will be excluded from serialize(scope). Pass a unique "name" to enable SSR via fork({ values: serialize(scope) }).`
+  );
+}
+function sidConfig(name, role) {
+  if (!name) return {};
+  return {
+    sid: `${SID_PREFIX}.${name}.${role}`,
+    name: `${name}.${role}`
+  };
+}
+function createBaseQuery(explicitClient, options, config) {
+  const { name, reactiveRefetchInterval: $reactiveRefetchInterval } = options;
+  const $resolvedKey = resolve_cjs.resolveKey(options.queryKey);
+  const $enabled = resolve_cjs.resolveEnabled(options.enabled);
+  const $effectiveClient = explicitClient ? effector.createStore(explicitClient, {
+    serialize: "ignore"
+  }) : queryClient_cjs.$queryClient;
+  const dataUpdated = effector.createEvent();
+  const errorUpdated = effector.createEvent();
+  const statusUpdated = effector.createEvent();
+  const isFetchingUpdated = effector.createEvent();
+  const fetchStatusUpdated = effector.createEvent();
+  const isPlaceholderDataUpdated = effector.createEvent();
+  const $data = effector.createStore(void 0, {
+    skipVoid: false,
+    ...sidConfig(name, "$data")
+  }).on(dataUpdated, (_, v) => v);
+  const $error = effector.createStore(null, {
+    skipVoid: false,
+    ...sidConfig(name, "$error")
+  }).on(errorUpdated, (_, v) => v);
+  const $status = effector.createStore("pending", {
+    ...sidConfig(name, "$status")
+  }).on(statusUpdated, (_, v) => v);
+  const $isFetching = effector.createStore(false, {
+    ...sidConfig(name, "$isFetching")
+  }).on(isFetchingUpdated, (_, v) => v);
+  const $fetchStatus = effector.createStore("idle", {
+    ...sidConfig(name, "$fetchStatus")
+  }).on(fetchStatusUpdated, (_, v) => v);
+  const $isPlaceholderData = effector.createStore(false, {
+    ...sidConfig(name, "$isPlaceholderData")
+  }).on(isPlaceholderDataUpdated, (_, v) => v);
+  const $isPending = $status.map((s) => s === "pending");
+  const $isSuccess = $status.map((s) => s === "success");
+  const $isError = $status.map((s) => s === "error");
+  const $observer = effector.createStore(null, {
+    serialize: "ignore"
+  });
+  const observerCreated = effector.createEvent();
+  $observer.on(observerCreated, (_, obs) => obs);
+  const observerSubscriptions = /* @__PURE__ */ new WeakMap();
+  const extras = config.setupExtras?.();
+  extras?.setupEffects?.({ $observer });
+  const mountFx = effector.attach({
+    source: { qc: $effectiveClient, observer: $observer },
+    effect: ({ qc, observer: existingObserver }, {
+      key,
+      enabled,
+      refetchInterval
+    }) => {
+      if (!qc) {
+        throw new Error(
+          "[@tanstack/query-effector] No QueryClient is set. Call setQueryClient(qc) before mounting, pass it to fork({ values: [[$queryClient, qc]] }), or pass it explicitly to the factory."
+        );
+      }
+      const observer = existingObserver ?? config.createObserver(qc, { queryKey: key, enabled });
+      const dispatchData = effector.scopeBind(dataUpdated, { safe: true });
+      const dispatchError = effector.scopeBind(errorUpdated, { safe: true });
+      const dispatchStatus = effector.scopeBind(statusUpdated, { safe: true });
+      const dispatchIsFetching = effector.scopeBind(isFetchingUpdated, { safe: true });
+      const dispatchFetchStatus = effector.scopeBind(fetchStatusUpdated, { safe: true });
+      const dispatchIsPlaceholderData = effector.scopeBind(isPlaceholderDataUpdated, {
+        safe: true
+      });
+      const dispatchExtras = extras?.bindDispatcher();
+      observerSubscriptions.get(observer)?.();
+      observer.setOptions({
+        ...observer.options,
+        queryKey: key,
+        enabled,
+        // Only override refetchInterval when the user provided a reactive
+        // Store — otherwise the static value (or function) from the observer
+        // constructor wins.
+        ...$reactiveRefetchInterval ? { refetchInterval } : {}
+      });
+      const dispatch = (result) => {
+        dispatchData(result.data);
+        dispatchError(result.error);
+        dispatchStatus(result.status);
+        dispatchIsFetching(result.isFetching);
+        dispatchFetchStatus(result.fetchStatus);
+        dispatchIsPlaceholderData(result.isPlaceholderData);
+        dispatchExtras?.(result);
+      };
+      const unsubscribe = observer.subscribe(dispatch);
+      observerSubscriptions.set(observer, unsubscribe);
+      dispatch(observer.getCurrentResult());
+      return observer;
+    }
+  });
+  effector.sample({ clock: mountFx.doneData, target: observerCreated });
+  const updateObserverFx = effector.attach({
+    source: $observer,
+    effect: (observer, {
+      key,
+      enabled,
+      refetchInterval
+    }) => {
+      if (!observer) return;
+      const {
+        _defaulted: _d,
+        queryHash: _h,
+        ...baseOptions
+      } = observer.options;
+      observer.setOptions({
+        ...baseOptions,
+        queryKey: key,
+        enabled,
+        ...$reactiveRefetchInterval ? { refetchInterval } : {}
+      });
+    }
+  });
+  const mounted = effector.createEvent();
+  const unmounted = effector.createEvent();
+  const $isMounted = effector.createStore(false, {
+    ...sidConfig(name, "$isMounted")
+  }).on(mounted, () => true).on(unmounted, () => false);
+  const $observerOptions = effector.combine({
+    key: $resolvedKey,
+    enabled: $enabled,
+    refetchInterval: $reactiveRefetchInterval ?? effector.createStore(false)
+  });
+  effector.sample({
+    clock: mounted,
+    source: $observerOptions,
+    target: mountFx
+  });
+  effector.sample({
+    clock: $observerOptions,
+    source: $observerOptions,
+    filter: $isMounted,
+    target: updateObserverFx
+  });
+  const observerDestroyed = effector.createEvent();
+  $observer.on(observerDestroyed, () => null);
+  const unmountFx = effector.attach({
+    source: $observer,
+    effect: (observer) => {
+      if (!observer) return;
+      observerSubscriptions.get(observer)?.();
+      observerSubscriptions.delete(observer);
+      observer.destroy();
+    }
+  });
+  effector.sample({ clock: unmounted, target: unmountFx });
+  effector.sample({ clock: unmountFx.finally, target: observerDestroyed });
+  const refresh = effector.createEvent();
+  const refreshFx = effector.attach({
+    source: { qc: $effectiveClient, key: $resolvedKey },
+    effect: ({ qc, key }) => {
+      if (!qc) return;
+      return qc.invalidateQueries({ queryKey: key });
+    }
+  });
+  effector.sample({ clock: refresh, target: refreshFx });
+  return {
+    $data,
+    $error,
+    $status,
+    $isPending,
+    $isFetching,
+    $isSuccess,
+    $isError,
+    $isPlaceholderData,
+    $fetchStatus,
+    $observer,
+    $queryClient: $effectiveClient,
+    $resolvedKey,
+    $enabled,
+    refresh,
+    mounted,
+    unmounted,
+    ...extras?.stores ?? {}
+  };
+}
+
+exports.createBaseQuery = createBaseQuery;
+exports.sidConfig = sidConfig;
+exports.warnMissingName = warnMissingName;
+//# sourceMappingURL=createBaseQuery.cjs.map
+//# sourceMappingURL=createBaseQuery.cjs.map

package/dist/createBaseQuery.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/createBaseQuery.ts"],"names":["resolveKey","resolveEnabled","createStore","$queryClient","createEvent","attach","scopeBind","sample","combine"],"mappings":";;;;;;;AAyFA,IAAM,UAAA,GAAa,0BAAA;AAEnB,IAAM,WAAA,uBAAkB,GAAA,EAAY;AAE7B,SAAS,gBAAgB,IAAA,EAAoB;AAClD,EAAA,IAAI,OAAO,OAAA,KAAY,WAAA,IAAe,OAAA,CAAQ,GAAA,CAAI,aAAa,YAAA,EAAc;AAC3E,IAAA;AAAA,EACF;AACA,EAAA,IAAI,WAAA,CAAY,GAAA,CAAI,IAAI,CAAA,EAAG;AAC3B,EAAA,WAAA,CAAY,IAAI,IAAI,CAAA;AAEpB,EAAA,OAAA,CAAQ,IAAA;AAAA,IACN,8BAA8B,IAAI,CAAA,mKAAA;AAAA,GAEpC;AACF;AAEO,SAAS,SAAA,CACd,MACA,IAAA,EACoC;AACpC,EAAA,IAAI,CAAC,IAAA,EAAM,OAAO,EAAC;AACnB,EAAA,OAAO;AAAA,IACL,KAAK,CAAA,EAAG,UAAU,CAAA,CAAA,EAAI,IAAI,IAAI,IAAI,CAAA,CAAA;AAAA,IAClC,IAAA,EAAM,CAAA,EAAG,IAAI,CAAA,CAAA,EAAI,IAAI,CAAA;AAAA,GACvB;AACF;AAwCO,SAAS,eAAA,CAOd,cAAA,EACA,OAAA,EACA,MAAA,EAC0D;AAC1D,EAAA,MAAM,EAAE,IAAA,EAAM,uBAAA,EAAyB,wBAAA,EAAyB,GAAI,OAAA;AACpE,EAAA,MAAM,YAAA,GAAeA,sBAAA,CAAW,OAAA,CAAQ,QAAQ,CAAA;AAChD,EAAA,MAAM,QAAA,GAAWC,0BAAA,CAAe,OAAA,CAAQ,OAAO,CAAA;AAO/C,EAAA,MAAM,gBAAA,GAA8C,cAAA,GAChDC,oBAAA,CAAY,cAAA,EAAsC;AAAA,IAChD,SAAA,EAAW;AAAA,GACZ,CAAA,GACDC,4BAAA;AAEJ,EAAA,MAAM,cAAcC,oBAAA,EAA+B;AACnD,EAAA,MAAM,eAAeA,oBAAA,EAA2B;AAChD,EAAA,MAAM,gBAAgBA,oBAAA,EAAyB;AAC/C,EAAA,MAAM,oBAAoBA,oBAAA,EAAqB;AAC/C,EAAA,MAAM,qBAAqBA,oBAAA,EAAyB;AACpD,EAAA,MAAM,2BAA2BA,oBAAA,EAAqB;AAEtD,EAAA,MAAM,KAAA,GAAQF,qBAA+B,MAAA,EAAW;AAAA,IACtD,QAAA,EAAU,KAAA;AAAA,IACV,GAAG,SAAA,CAAU,IAAA,EAAM,OAAO;AAAA,GAC3B,CAAA,CAAE,EAAA,CAAG,aAAa,CAAC,CAAA,EAAG,MAAM,CAAC,CAAA;AAC9B,EAAA,MAAM,MAAA,GAASA,qBAA2B,IAAA,EAAM;AAAA,IAC9C,QAAA,EAAU,KAAA;AAAA,IACV,GAAG,SAAA,CAAU,IAAA,EAAM,QAAQ;AAAA,GAC5B,CAAA,CAAE,EAAA,CAAG,cAAc,CAAC,CAAA,EAAG,MAAM,CAAC,CAAA;AAC/B,EAAA,MAAM,OAAA,GAAUA,qBAAyB,SAAA,EAAW;AAAA,IAClD,GAAG,SAAA,CAAU,IAAA,EAAM,SAAS;AAAA,GAC7B,CAAA,CAAE,EAAA,CAAG,eAAe,CAAC,CAAA,EAAG,MAAM,CAAC,CAAA;AAChC,EAAA,MAAM,WAAA,GAAcA,qBAAY,KAAA,EAAO;AAAA,IACrC,GAAG,SAAA,CAAU,IAAA,EAAM,aAAa;AAAA,GACjC,CAAA,CAAE,EAAA,CAAG,mBAAmB,CAAC,CAAA,EAAG,MAAM,CAAC,CAAA;AACpC,EAAA,MAAM,YAAA,GAAeA,qBAAyB,MAAA,EAAQ;AAAA,IACpD,GAAG,SAAA,CAAU,IAAA,EAAM,cAAc;AAAA,GAClC,CAAA,CAAE,EAAA,CAAG,oBAAoB,CAAC,CAAA,EAAG,MAAM,CAAC,CAAA;AACrC,EAAA,MAAM,kBAAA,GAAqBA,qBAAY,KAAA,EAAO;AAAA,IAC5C,GAAG,SAAA,CAAU,IAAA,EAAM,oBAAoB;AAAA,GACxC,CAAA,CAAE,EAAA,CAAG,0BAA0B,CAAC,CAAA,EAAG,MAAM,CAAC,CAAA;AAK3C,EAAA,MAAM,aAAa,OAAA,CAAQ,GAAA,CAAI,CAAC,CAAA,KAAM,MAAM,SAAS,CAAA;AACrD,EAAA,MAAM,aAAa,OAAA,CAAQ,GAAA,CAAI,CAAC,CAAA,KAAM,MAAM,SAAS,CAAA;AACrD,EAAA,MAAM,WAAW,OAAA,CAAQ,GAAA,CAAI,CAAC,CAAA,KAAM,MAAM,OAAO,CAAA;AAIjD,EAAA,MAAM,SAAA,GAAYA,qBAA8B,IAAA,EAAM;AAAA,IACpD,SAAA,EAAW;AAAA,GACZ,CAAA;AACD,EAAA,MAAM,kBAAkBE,oBAAA,EAAuB;AAC/C,EAAA,SAAA,CAAU,EAAA,CAAG,eAAA,EAAiB,CAAC,CAAA,EAAG,QAAQ,GAAG,CAAA;AAI7C,EAAA,MAAM,qBAAA,uBAA4B,OAAA,EAA+B;AAEjE,EAAA,MAAM,MAAA,GAAS,OAAO,WAAA,IAAc;AACpC,EAAA,MAAA,EAAQ,YAAA,GAAe,EAAE,SAAA,EAAW,CAAA;AAQpC,EAAA,MAAM,UAAUC,eAAA,CAAO;AAAA,IACrB,MAAA,EAAQ,EAAE,EAAA,EAAI,gBAAA,EAAkB,UAAU,SAAA,EAAU;AAAA,IACpD,QAAQ,CACN,EAAE,EAAA,EAAI,QAAA,EAAU,kBAAiB,EACjC;AAAA,MACE,GAAA;AAAA,MACA,OAAA;AAAA,MACA;AAAA,KACF,KAKG;AACH,MAAA,IAAI,CAAC,EAAA,EAAI;AACP,QAAA,MAAM,IAAI,KAAA;AAAA,UACR;AAAA,SAEF;AAAA,MACF;AAEA,MAAA,MAAM,QAAA,GACJ,oBACA,MAAA,CAAO,cAAA,CAAe,IAAI,EAAE,QAAA,EAAU,GAAA,EAAK,OAAA,EAAS,CAAA;AAEtD,MAAA,MAAM,eAAeC,kBAAA,CAAU,WAAA,EAAa,EAAE,IAAA,EAAM,MAAM,CAAA;AAC1D,MAAA,MAAM,gBAAgBA,kBAAA,CAAU,YAAA,EAAc,EAAE,IAAA,EAAM,MAAM,CAAA;AAC5D,MAAA,MAAM,iBAAiBA,kBAAA,CAAU,aAAA,EAAe,EAAE,IAAA,EAAM,MAAM,CAAA;AAC9D,MAAA,MAAM,qBAAqBA,kBAAA,CAAU,iBAAA,EAAmB,EAAE,IAAA,EAAM,MAAM,CAAA;AACtE,MAAA,MAAM,sBAAsBA,kBAAA,CAAU,kBAAA,EAAoB,EAAE,IAAA,EAAM,MAAM,CAAA;AACxE,MAAA,MAAM,yBAAA,GAA4BA,mBAAU,wBAAA,EAA0B;AAAA,QACpE,IAAA,EAAM;AAAA,OACP,CAAA;AACD,MAAA,MAAM,cAAA,GAAiB,QAAQ,cAAA,EAAe;AAE9C,MAAA,qBAAA,CAAsB,GAAA,CAAI,QAAQ,CAAA,IAAI;AACtC,MAAA,QAAA,CAAS,UAAA,CAAW;AAAA,QAClB,GAAG,QAAA,CAAS,OAAA;AAAA,QACZ,QAAA,EAAU,GAAA;AAAA,QACV,OAAA;AAAA;AAAA;AAAA;AAAA,QAIA,GAAI,wBAAA,GAA2B,EAAE,eAAA,KAAoB;AAAC,OACvD,CAAA;AAED,MAAA,MAAM,QAAA,GAAW,CAAC,MAAA,KAAoB;AACpC,QAAA,YAAA,CAAa,OAAO,IAAI,CAAA;AACxB,QAAA,aAAA,CAAc,OAAO,KAAK,CAAA;AAC1B,QAAA,cAAA,CAAe,OAAO,MAAM,CAAA;AAC5B,QAAA,kBAAA,CAAmB,OAAO,UAAU,CAAA;AACpC,QAAA,mBAAA,CAAoB,OAAO,WAAW,CAAA;AACtC,QAAA,yBAAA,CAA0B,OAAO,iBAAiB,CAAA;AAClD,QAAA,cAAA,GAAiB,MAAM,CAAA;AAAA,MACzB,CAAA;AAEA,MAAA,MAAM,WAAA,GAAc,QAAA,CAAS,SAAA,CAAU,QAAQ,CAAA;AAC/C,MAAA,qBAAA,CAAsB,GAAA,CAAI,UAAU,WAAW,CAAA;AAM/C,MAAA,QAAA,CAAS,QAAA,CAAS,kBAAkB,CAAA;AAEpC,MAAA,OAAO,QAAA;AAAA,IACT;AAAA,GACD,CAAA;AAED,EAAAC,eAAA,CAAO,EAAE,KAAA,EAAO,OAAA,CAAQ,QAAA,EAAU,MAAA,EAAQ,iBAAiB,CAAA;AAK3D,EAAA,MAAM,mBAAmBF,eAAA,CAAO;AAAA,IAC9B,MAAA,EAAQ,SAAA;AAAA,IACR,MAAA,EAAQ,CACN,QAAA,EACA;AAAA,MACE,GAAA;AAAA,MACA,OAAA;AAAA,MACA;AAAA,KACF,KAKG;AACH,MAAA,IAAI,CAAC,QAAA,EAAU;AAIf,MAAA,MAAM;AAAA,QACJ,UAAA,EAAY,EAAA;AAAA,QACZ,SAAA,EAAW,EAAA;AAAA,QACX,GAAG;AAAA,UACD,QAAA,CAAS,OAAA;AAIb,MAAA,QAAA,CAAS,UAAA,CAAW;AAAA,QAClB,GAAG,WAAA;AAAA,QACH,QAAA,EAAU,GAAA;AAAA,QACV,OAAA;AAAA,QACA,GAAI,wBAAA,GAA2B,EAAE,eAAA,KAAoB;AAAC,OACvD,CAAA;AAAA,IACH;AAAA,GACD,CAAA;AAED,EAAA,MAAM,UAAUD,oBAAA,EAAkB;AAClC,EAAA,MAAM,YAAYA,oBAAA,EAAkB;AACpC,EAAA,MAAM,UAAA,GAAaF,qBAAY,KAAA,EAAO;AAAA,IACpC,GAAG,SAAA,CAAU,IAAA,EAAM,YAAY;AAAA,GAChC,CAAA,CACE,EAAA,CAAG,OAAA,EAAS,MAAM,IAAI,CAAA,CACtB,EAAA,CAAG,SAAA,EAAW,MAAM,KAAK,CAAA;AAO5B,EAAA,MAAM,mBAAmBM,gBAAA,CAAQ;AAAA,IAC/B,GAAA,EAAK,YAAA;AAAA,IACL,OAAA,EAAS,QAAA;AAAA,IACT,eAAA,EACE,wBAAA,IACAN,oBAAA,CAAwC,KAAK;AAAA,GAChD,CAAA;AAED,EAAAK,eAAA,CAAO;AAAA,IACL,KAAA,EAAO,OAAA;AAAA,IACP,MAAA,EAAQ,gBAAA;AAAA,IACR,MAAA,EAAQ;AAAA,GACT,CAAA;AAED,EAAAA,eAAA,CAAO;AAAA,IACL,KAAA,EAAO,gBAAA;AAAA,IACP,MAAA,EAAQ,gBAAA;AAAA,IACR,MAAA,EAAQ,UAAA;AAAA,IACR,MAAA,EAAQ;AAAA,GACT,CAAA;AAKD,EAAA,MAAM,oBAAoBH,oBAAA,EAAkB;AAC5C,EAAA,SAAA,CAAU,EAAA,CAAG,iBAAA,EAAmB,MAAM,IAAI,CAAA;AAE1C,EAAA,MAAM,YAAYC,eAAA,CAAO;AAAA,IACvB,MAAA,EAAQ,SAAA;AAAA,IACR,MAAA,EAAQ,CAAC,QAAA,KAAa;AACpB,MAAA,IAAI,CAAC,QAAA,EAAU;AACf,MAAA,qBAAA,CAAsB,GAAA,CAAI,QAAQ,CAAA,IAAI;AACtC,MAAA,qBAAA,CAAsB,OAAO,QAAQ,CAAA;AACrC,MAAA,QAAA,CAAS,OAAA,EAAQ;AAAA,IACnB;AAAA,GACD,CAAA;AACD,EAAAE,eAAA,CAAO,EAAE,KAAA,EAAO,SAAA,EAAW,MAAA,EAAQ,WAAW,CAAA;AAC9C,EAAAA,eAAA,CAAO,EAAE,KAAA,EAAO,SAAA,CAAU,OAAA,EAAS,MAAA,EAAQ,mBAAmB,CAAA;AAE9D,EAAA,MAAM,UAAUH,oBAAA,EAAkB;AAClC,EAAA,MAAM,YAAYC,eAAA,CAAO;AAAA,IACvB,MAAA,EAAQ,EAAE,EAAA,EAAI,gBAAA,EAAkB,KAAK,YAAA,EAAa;AAAA,IAClD,MAAA,EAAQ,CAAC,EAAE,EAAA,EAAI,KAAI,KAAM;AACvB,MAAA,IAAI,CAAC,EAAA,EAAI;AACT,MAAA,OAAO,EAAA,CAAG,iBAAA,CAAkB,EAAE,QAAA,EAAU,KAAK,CAAA;AAAA,IAC/C;AAAA,GACD,CAAA;AACD,EAAAE,eAAA,CAAO,EAAE,KAAA,EAAO,OAAA,EAAS,MAAA,EAAQ,WAAW,CAAA;AAE5C,EAAA,OAAO;AAAA,IACL,KAAA;AAAA,IACA,MAAA;AAAA,IACA,OAAA;AAAA,IACA,UAAA;AAAA,IACA,WAAA;AAAA,IACA,UAAA;AAAA,IACA,QAAA;AAAA,IACA,kBAAA;AAAA,IACA,YAAA;AAAA,IACA,SAAA;AAAA,IACA,YAAA,EAAc,gBAAA;AAAA,IACd,YAAA;AAAA,IACA,QAAA;AAAA,IACA,OAAA;AAAA,IACA,OAAA;AAAA,IACA,SAAA;AAAA,IACA,GAAI,MAAA,EAAQ,MAAA,IAAW;AAAC,GAC1B;AACF","file":"createBaseQuery.cjs","sourcesContent":["import {\n  attach,\n  combine,\n  createEvent,\n  createStore,\n  sample,\n  scopeBind,\n} from 'effector'\nimport type { EventCallable, Store } from 'effector'\nimport type {\n  FetchStatus,\n  QueryClient,\n  QueryKey,\n  QueryStatus,\n} from '@tanstack/query-core'\nimport { $queryClient } from './queryClient'\nimport { resolveEnabled, resolveKey } from './resolve'\nimport type { EffectorQueryKey, StoreOrValue } from './types'\n\n/**\n * The minimal shape of an observer that createBaseQuery knows how to drive.\n * Both QueryObserver and InfiniteQueryObserver satisfy this.\n */\nexport interface BaseObserverLike<TResult> {\n  options: { queryKey: QueryKey; _defaulted?: boolean; queryHash?: string }\n  setOptions(options: any): void\n  subscribe(listener: (result: TResult) => void): () => void\n  getCurrentResult(): TResult\n  destroy(): void\n}\n\n/**\n * The subset of observer result fields that createBaseQuery wires up\n * into stores common to all query flavors.\n */\nexport interface BaseObserverResult<TData, TError> {\n  data: TData | undefined\n  error: TError | null\n  status: QueryStatus\n  isFetching: boolean\n  fetchStatus: FetchStatus\n  isPlaceholderData: boolean\n}\n\nexport interface BaseQueryStores<TData, TError, TObserver> {\n  $data: Store<TData | undefined>\n  $error: Store<TError | null>\n  $status: Store<QueryStatus>\n  $isPending: Store<boolean>\n  $isFetching: Store<boolean>\n  $isSuccess: Store<boolean>\n  $isError: Store<boolean>\n  $isPlaceholderData: Store<boolean>\n  $fetchStatus: Store<FetchStatus>\n  /**\n   * Per-scope observer. Populated on first `mounted()` via attach over\n   * `$queryClient` — every fork scope has its own Observer instance bound\n   * to the scope's QueryClient. Read scope-aware via `useUnit($observer)`.\n   */\n  $observer: Store<TObserver | null>\n  /**\n   * Resolved QueryClient store. If the factory was called with an explicit\n   * client, this is a frozen store of that client. Otherwise it's the global\n   * `$queryClient`, which honors `fork({ values })` overrides.\n   */\n  $queryClient: Store<QueryClient | null>\n  /** Internal — used by the React suspense hooks. */\n  $resolvedKey: Store<QueryKey>\n  /** Internal — used by the React suspense hooks. */\n  $enabled: Store<boolean>\n  refresh: EventCallable<void>\n  mounted: EventCallable<void>\n  unmounted: EventCallable<void>\n}\n\nexport interface BaseQueryOptions {\n  queryKey: EffectorQueryKey\n  enabled?: StoreOrValue<boolean>\n  /**\n   * Pre-resolved reactive `refetchInterval`. The per-flavor factory extracts\n   * the original option, and — if it's a Store — passes the Store here while\n   * stripping the value from the observer constructor options. Static values\n   * and function forms continue to flow through `restOptions` to the\n   * observer.\n   */\n  reactiveRefetchInterval?: Store<number | false | undefined>\n  name?: string\n}\n\nconst SID_PREFIX = '@tanstack/query-effector'\n\nconst warnedNames = new Set<string>()\n\nexport function warnMissingName(role: string): void {\n  if (typeof process === 'undefined' || process.env.NODE_ENV === 'production') {\n    return\n  }\n  if (warnedNames.has(role)) return\n  warnedNames.add(role)\n  // eslint-disable-next-line no-console\n  console.warn(\n    `[@tanstack/query-effector] ${role} created without a \"name\" — internal stores will be excluded from serialize(scope). ` +\n      `Pass a unique \"name\" to enable SSR via fork({ values: serialize(scope) }).`,\n  )\n}\n\nexport function sidConfig(\n  name: string | undefined,\n  role: string,\n): { sid: string; name: string } | {} {\n  if (!name) return {}\n  return {\n    sid: `${SID_PREFIX}.${name}.${role}`,\n    name: `${name}.${role}`,\n  }\n}\n\nexport interface ExtrasSetup<TResult, TObserver, TExtraStores> {\n  /** Extra stores/events merged into the final result object. */\n  stores: TExtraStores\n  /**\n   * Invoked inside the mount effect. Must scope-bind any extra events\n   * and return a function that dispatches extra fields from the observer\n   * result. The returned dispatcher is called on every subscription\n   * notification alongside the base dispatcher.\n   */\n  bindDispatcher: () => (result: TResult) => void\n  /**\n   * Lets a flavor wire its own per-observer effects (e.g.\n   * fetchNextPage / fetchPreviousPage for infinite queries). Receives the\n   * per-scope `$observer` store so the flavor can build attach-based\n   * effects that resolve the observer from the current scope.\n   */\n  setupEffects?: (params: { $observer: Store<TObserver | null> }) => void\n}\n\nexport interface CreateBaseQueryConfig<\n  TData,\n  TError,\n  TResult extends BaseObserverResult<TData, TError>,\n  TObserver extends BaseObserverLike<TResult>,\n  TExtraStores,\n> {\n  /** Build the observer for the current scope. Receives the resolved client. */\n  createObserver: (\n    queryClient: QueryClient,\n    initial: { queryKey: QueryKey; enabled: boolean },\n  ) => TObserver\n  /**\n   * Hook for query flavors that need additional stores/events (e.g. infinite\n   * query's hasNextPage, fetchNextPage). Called once at factory time.\n   */\n  setupExtras?: () => ExtrasSetup<TResult, TObserver, TExtraStores>\n}\n\nexport function createBaseQuery<\n  TData,\n  TError,\n  TResult extends BaseObserverResult<TData, TError>,\n  TObserver extends BaseObserverLike<TResult>,\n  TExtraStores = {},\n>(\n  explicitClient: QueryClient | null,\n  options: BaseQueryOptions,\n  config: CreateBaseQueryConfig<TData, TError, TResult, TObserver, TExtraStores>,\n): BaseQueryStores<TData, TError, TObserver> & TExtraStores {\n  const { name, reactiveRefetchInterval: $reactiveRefetchInterval } = options\n  const $resolvedKey = resolveKey(options.queryKey)\n  const $enabled = resolveEnabled(options.enabled)\n\n  // If an explicit client is passed, the factory is locked to it. fork()\n  // values cannot override the captured value because $effectiveClient is a\n  // brand-new store (not the global one). When no explicit client is passed,\n  // we route through $queryClient — which respects fork({ values }) for\n  // per-scope isolation.\n  const $effectiveClient: Store<QueryClient | null> = explicitClient\n    ? createStore(explicitClient as QueryClient | null, {\n        serialize: 'ignore',\n      })\n    : $queryClient\n\n  const dataUpdated = createEvent<TData | undefined>()\n  const errorUpdated = createEvent<TError | null>()\n  const statusUpdated = createEvent<QueryStatus>()\n  const isFetchingUpdated = createEvent<boolean>()\n  const fetchStatusUpdated = createEvent<FetchStatus>()\n  const isPlaceholderDataUpdated = createEvent<boolean>()\n\n  const $data = createStore<TData | undefined>(undefined, {\n    skipVoid: false,\n    ...sidConfig(name, '$data'),\n  }).on(dataUpdated, (_, v) => v)\n  const $error = createStore<TError | null>(null, {\n    skipVoid: false,\n    ...sidConfig(name, '$error'),\n  }).on(errorUpdated, (_, v) => v)\n  const $status = createStore<QueryStatus>('pending', {\n    ...sidConfig(name, '$status'),\n  }).on(statusUpdated, (_, v) => v)\n  const $isFetching = createStore(false, {\n    ...sidConfig(name, '$isFetching'),\n  }).on(isFetchingUpdated, (_, v) => v)\n  const $fetchStatus = createStore<FetchStatus>('idle', {\n    ...sidConfig(name, '$fetchStatus'),\n  }).on(fetchStatusUpdated, (_, v) => v)\n  const $isPlaceholderData = createStore(false, {\n    ...sidConfig(name, '$isPlaceholderData'),\n  }).on(isPlaceholderDataUpdated, (_, v) => v)\n\n  // Derived stores via .map don't accept sid in their config — effector's\n  // serialize() captures source-store values, and derived stores recompute\n  // automatically on the client after fork({ values }).\n  const $isPending = $status.map((s) => s === 'pending')\n  const $isSuccess = $status.map((s) => s === 'success')\n  const $isError = $status.map((s) => s === 'error')\n\n  // Per-scope observer storage. Carries runtime-only references\n  // (subscriptions, callbacks) — must never participate in serialization.\n  const $observer = createStore<TObserver | null>(null, {\n    serialize: 'ignore',\n  })\n  const observerCreated = createEvent<TObserver>()\n  $observer.on(observerCreated, (_, obs) => obs)\n\n  // Per-observer unsubscribe handles. WeakMap so abandoned observers (e.g.\n  // a scope that was discarded without unmount) are GC'able.\n  const observerSubscriptions = new WeakMap<TObserver, () => void>()\n\n  const extras = config.setupExtras?.()\n  extras?.setupEffects?.({ $observer })\n\n  // Runs once per mount. Creates the observer for the current scope (if not\n  // yet created) and attaches the subscription. scopeBind({ safe: true })\n  // reliably captures the fork scope here because this effect is triggered\n  // directly from allSettled(mounted). Bound dispatchers are captured in the\n  // observer callback's closure and reused for all subsequent notifications\n  // (including after key/enabled changes).\n  const mountFx = attach({\n    source: { qc: $effectiveClient, observer: $observer },\n    effect: (\n      { qc, observer: existingObserver },\n      {\n        key,\n        enabled,\n        refetchInterval,\n      }: {\n        key: QueryKey\n        enabled: boolean\n        refetchInterval: number | false | undefined\n      },\n    ) => {\n      if (!qc) {\n        throw new Error(\n          '[@tanstack/query-effector] No QueryClient is set. Call setQueryClient(qc) before mounting, ' +\n            'pass it to fork({ values: [[$queryClient, qc]] }), or pass it explicitly to the factory.',\n        )\n      }\n\n      const observer =\n        existingObserver ??\n        config.createObserver(qc, { queryKey: key, enabled })\n\n      const dispatchData = scopeBind(dataUpdated, { safe: true })\n      const dispatchError = scopeBind(errorUpdated, { safe: true })\n      const dispatchStatus = scopeBind(statusUpdated, { safe: true })\n      const dispatchIsFetching = scopeBind(isFetchingUpdated, { safe: true })\n      const dispatchFetchStatus = scopeBind(fetchStatusUpdated, { safe: true })\n      const dispatchIsPlaceholderData = scopeBind(isPlaceholderDataUpdated, {\n        safe: true,\n      })\n      const dispatchExtras = extras?.bindDispatcher()\n\n      observerSubscriptions.get(observer)?.()\n      observer.setOptions({\n        ...observer.options,\n        queryKey: key,\n        enabled,\n        // Only override refetchInterval when the user provided a reactive\n        // Store — otherwise the static value (or function) from the observer\n        // constructor wins.\n        ...($reactiveRefetchInterval ? { refetchInterval } : {}),\n      })\n\n      const dispatch = (result: TResult) => {\n        dispatchData(result.data)\n        dispatchError(result.error)\n        dispatchStatus(result.status)\n        dispatchIsFetching(result.isFetching)\n        dispatchFetchStatus(result.fetchStatus)\n        dispatchIsPlaceholderData(result.isPlaceholderData)\n        dispatchExtras?.(result)\n      }\n\n      const unsubscribe = observer.subscribe(dispatch)\n      observerSubscriptions.set(observer, unsubscribe)\n\n      // Emit the current state immediately — observer.subscribe() may not\n      // fire the callback synchronously when cached data already matches\n      // the observer's initial result (e.g. staleTime + setQueryData).\n      // This mirrors react-query's getOptimisticResult() on mount.\n      dispatch(observer.getCurrentResult())\n\n      return observer\n    },\n  })\n\n  sample({ clock: mountFx.doneData, target: observerCreated })\n\n  // Runs when key / enabled / reactive refetchInterval change after mount.\n  // Only updates observer options — subscription + dispatchers were already\n  // wired in mountFx.\n  const updateObserverFx = attach({\n    source: $observer,\n    effect: (\n      observer,\n      {\n        key,\n        enabled,\n        refetchInterval,\n      }: {\n        key: QueryKey\n        enabled: boolean\n        refetchInterval: number | false | undefined\n      },\n    ) => {\n      if (!observer) return\n      // Strip _defaulted and queryHash so defaultQueryOptions() recomputes\n      // the hash for the new key. Without this, the old hash is preserved and\n      // QueryObserver#updateQuery() finds the old query — no key switch, no fetch.\n      const {\n        _defaulted: _d,\n        queryHash: _h,\n        ...baseOptions\n      } = observer.options as typeof observer.options & {\n        _defaulted?: boolean\n        queryHash?: string\n      }\n      observer.setOptions({\n        ...baseOptions,\n        queryKey: key,\n        enabled,\n        ...($reactiveRefetchInterval ? { refetchInterval } : {}),\n      })\n    },\n  })\n\n  const mounted = createEvent<void>()\n  const unmounted = createEvent<void>()\n  const $isMounted = createStore(false, {\n    ...sidConfig(name, '$isMounted'),\n  })\n    .on(mounted, () => true)\n    .on(unmounted, () => false)\n\n  // Combine of all reactive options that drive observer.setOptions. Built once\n  // so mountFx and updateObserverFx see the same shape. When the user didn't\n  // pass a reactive `refetchInterval`, we fall back to a static-`false` store\n  // (its emitted value is never read — the spread is guarded by the original\n  // `$reactiveRefetchInterval` reference).\n  const $observerOptions = combine({\n    key: $resolvedKey,\n    enabled: $enabled,\n    refetchInterval:\n      $reactiveRefetchInterval ??\n      createStore<number | false | undefined>(false),\n  })\n\n  sample({\n    clock: mounted,\n    source: $observerOptions,\n    target: mountFx,\n  })\n\n  sample({\n    clock: $observerOptions,\n    source: $observerOptions,\n    filter: $isMounted,\n    target: updateObserverFx,\n  })\n\n  // Single effect: tear down subscription + destroy + clear $observer.\n  // Doing all three in one effect avoids ordering ambiguity vs. separate\n  // events that all sample from `unmounted`.\n  const observerDestroyed = createEvent<void>()\n  $observer.on(observerDestroyed, () => null)\n\n  const unmountFx = attach({\n    source: $observer,\n    effect: (observer) => {\n      if (!observer) return\n      observerSubscriptions.get(observer)?.()\n      observerSubscriptions.delete(observer)\n      observer.destroy()\n    },\n  })\n  sample({ clock: unmounted, target: unmountFx })\n  sample({ clock: unmountFx.finally, target: observerDestroyed })\n\n  const refresh = createEvent<void>()\n  const refreshFx = attach({\n    source: { qc: $effectiveClient, key: $resolvedKey },\n    effect: ({ qc, key }) => {\n      if (!qc) return\n      return qc.invalidateQueries({ queryKey: key })\n    },\n  })\n  sample({ clock: refresh, target: refreshFx })\n\n  return {\n    $data,\n    $error,\n    $status,\n    $isPending,\n    $isFetching,\n    $isSuccess,\n    $isError,\n    $isPlaceholderData,\n    $fetchStatus,\n    $observer,\n    $queryClient: $effectiveClient,\n    $resolvedKey,\n    $enabled,\n    refresh,\n    mounted,\n    unmounted,\n    ...(extras?.stores ?? ({} as TExtraStores)),\n  }\n}\n"]}

package/dist/createBaseQuery.d.cts

@@ -0,0 +1,114 @@
+import { Store, EventCallable } from 'effector';
+import { QueryKey, QueryStatus, FetchStatus, QueryClient } from '@tanstack/query-core';
+import { EffectorQueryKey, StoreOrValue } from './types.cjs';
+
+/**
+ * The minimal shape of an observer that createBaseQuery knows how to drive.
+ * Both QueryObserver and InfiniteQueryObserver satisfy this.
+ */
+interface BaseObserverLike<TResult> {
+    options: {
+        queryKey: QueryKey;
+        _defaulted?: boolean;
+        queryHash?: string;
+    };
+    setOptions(options: any): void;
+    subscribe(listener: (result: TResult) => void): () => void;
+    getCurrentResult(): TResult;
+    destroy(): void;
+}
+/**
+ * The subset of observer result fields that createBaseQuery wires up
+ * into stores common to all query flavors.
+ */
+interface BaseObserverResult<TData, TError> {
+    data: TData | undefined;
+    error: TError | null;
+    status: QueryStatus;
+    isFetching: boolean;
+    fetchStatus: FetchStatus;
+    isPlaceholderData: boolean;
+}
+interface BaseQueryStores<TData, TError, TObserver> {
+    $data: Store<TData | undefined>;
+    $error: Store<TError | null>;
+    $status: Store<QueryStatus>;
+    $isPending: Store<boolean>;
+    $isFetching: Store<boolean>;
+    $isSuccess: Store<boolean>;
+    $isError: Store<boolean>;
+    $isPlaceholderData: Store<boolean>;
+    $fetchStatus: Store<FetchStatus>;
+    /**
+     * Per-scope observer. Populated on first `mounted()` via attach over
+     * `$queryClient` — every fork scope has its own Observer instance bound
+     * to the scope's QueryClient. Read scope-aware via `useUnit($observer)`.
+     */
+    $observer: Store<TObserver | null>;
+    /**
+     * Resolved QueryClient store. If the factory was called with an explicit
+     * client, this is a frozen store of that client. Otherwise it's the global
+     * `$queryClient`, which honors `fork({ values })` overrides.
+     */
+    $queryClient: Store<QueryClient | null>;
+    /** Internal — used by the React suspense hooks. */
+    $resolvedKey: Store<QueryKey>;
+    /** Internal — used by the React suspense hooks. */
+    $enabled: Store<boolean>;
+    refresh: EventCallable<void>;
+    mounted: EventCallable<void>;
+    unmounted: EventCallable<void>;
+}
+interface BaseQueryOptions {
+    queryKey: EffectorQueryKey;
+    enabled?: StoreOrValue<boolean>;
+    /**
+     * Pre-resolved reactive `refetchInterval`. The per-flavor factory extracts
+     * the original option, and — if it's a Store — passes the Store here while
+     * stripping the value from the observer constructor options. Static values
+     * and function forms continue to flow through `restOptions` to the
+     * observer.
+     */
+    reactiveRefetchInterval?: Store<number | false | undefined>;
+    name?: string;
+}
+declare function warnMissingName(role: string): void;
+declare function sidConfig(name: string | undefined, role: string): {
+    sid: string;
+    name: string;
+} | {};
+interface ExtrasSetup<TResult, TObserver, TExtraStores> {
+    /** Extra stores/events merged into the final result object. */
+    stores: TExtraStores;
+    /**
+     * Invoked inside the mount effect. Must scope-bind any extra events
+     * and return a function that dispatches extra fields from the observer
+     * result. The returned dispatcher is called on every subscription
+     * notification alongside the base dispatcher.
+     */
+    bindDispatcher: () => (result: TResult) => void;
+    /**
+     * Lets a flavor wire its own per-observer effects (e.g.
+     * fetchNextPage / fetchPreviousPage for infinite queries). Receives the
+     * per-scope `$observer` store so the flavor can build attach-based
+     * effects that resolve the observer from the current scope.
+     */
+    setupEffects?: (params: {
+        $observer: Store<TObserver | null>;
+    }) => void;
+}
+interface CreateBaseQueryConfig<TData, TError, TResult extends BaseObserverResult<TData, TError>, TObserver extends BaseObserverLike<TResult>, TExtraStores> {
+    /** Build the observer for the current scope. Receives the resolved client. */
+    createObserver: (queryClient: QueryClient, initial: {
+        queryKey: QueryKey;
+        enabled: boolean;
+    }) => TObserver;
+    /**
+     * Hook for query flavors that need additional stores/events (e.g. infinite
+     * query's hasNextPage, fetchNextPage). Called once at factory time.
+     */
+    setupExtras?: () => ExtrasSetup<TResult, TObserver, TExtraStores>;
+}
+declare function createBaseQuery<TData, TError, TResult extends BaseObserverResult<TData, TError>, TObserver extends BaseObserverLike<TResult>, TExtraStores = {}>(explicitClient: QueryClient | null, options: BaseQueryOptions, config: CreateBaseQueryConfig<TData, TError, TResult, TObserver, TExtraStores>): BaseQueryStores<TData, TError, TObserver> & TExtraStores;
+
+export { type BaseObserverLike, type BaseObserverResult, type BaseQueryOptions, type BaseQueryStores, type CreateBaseQueryConfig, type ExtrasSetup, createBaseQuery, sidConfig, warnMissingName };

package/dist/createBaseQuery.d.ts

@@ -0,0 +1,114 @@
+import { Store, EventCallable } from 'effector';
+import { QueryKey, QueryStatus, FetchStatus, QueryClient } from '@tanstack/query-core';
+import { EffectorQueryKey, StoreOrValue } from './types.js';
+
+/**
+ * The minimal shape of an observer that createBaseQuery knows how to drive.
+ * Both QueryObserver and InfiniteQueryObserver satisfy this.
+ */
+interface BaseObserverLike<TResult> {
+    options: {
+        queryKey: QueryKey;
+        _defaulted?: boolean;
+        queryHash?: string;
+    };
+    setOptions(options: any): void;
+    subscribe(listener: (result: TResult) => void): () => void;
+    getCurrentResult(): TResult;
+    destroy(): void;
+}
+/**
+ * The subset of observer result fields that createBaseQuery wires up
+ * into stores common to all query flavors.
+ */
+interface BaseObserverResult<TData, TError> {
+    data: TData | undefined;
+    error: TError | null;
+    status: QueryStatus;
+    isFetching: boolean;
+    fetchStatus: FetchStatus;
+    isPlaceholderData: boolean;
+}
+interface BaseQueryStores<TData, TError, TObserver> {
+    $data: Store<TData | undefined>;
+    $error: Store<TError | null>;
+    $status: Store<QueryStatus>;
+    $isPending: Store<boolean>;
+    $isFetching: Store<boolean>;
+    $isSuccess: Store<boolean>;
+    $isError: Store<boolean>;
+    $isPlaceholderData: Store<boolean>;
+    $fetchStatus: Store<FetchStatus>;
+    /**
+     * Per-scope observer. Populated on first `mounted()` via attach over
+     * `$queryClient` — every fork scope has its own Observer instance bound
+     * to the scope's QueryClient. Read scope-aware via `useUnit($observer)`.
+     */
+    $observer: Store<TObserver | null>;
+    /**
+     * Resolved QueryClient store. If the factory was called with an explicit
+     * client, this is a frozen store of that client. Otherwise it's the global
+     * `$queryClient`, which honors `fork({ values })` overrides.
+     */
+    $queryClient: Store<QueryClient | null>;
+    /** Internal — used by the React suspense hooks. */
+    $resolvedKey: Store<QueryKey>;
+    /** Internal — used by the React suspense hooks. */
+    $enabled: Store<boolean>;
+    refresh: EventCallable<void>;
+    mounted: EventCallable<void>;
+    unmounted: EventCallable<void>;
+}
+interface BaseQueryOptions {
+    queryKey: EffectorQueryKey;
+    enabled?: StoreOrValue<boolean>;
+    /**
+     * Pre-resolved reactive `refetchInterval`. The per-flavor factory extracts
+     * the original option, and — if it's a Store — passes the Store here while
+     * stripping the value from the observer constructor options. Static values
+     * and function forms continue to flow through `restOptions` to the
+     * observer.
+     */
+    reactiveRefetchInterval?: Store<number | false | undefined>;
+    name?: string;
+}
+declare function warnMissingName(role: string): void;
+declare function sidConfig(name: string | undefined, role: string): {
+    sid: string;
+    name: string;
+} | {};
+interface ExtrasSetup<TResult, TObserver, TExtraStores> {
+    /** Extra stores/events merged into the final result object. */
+    stores: TExtraStores;
+    /**
+     * Invoked inside the mount effect. Must scope-bind any extra events
+     * and return a function that dispatches extra fields from the observer
+     * result. The returned dispatcher is called on every subscription
+     * notification alongside the base dispatcher.
+     */
+    bindDispatcher: () => (result: TResult) => void;
+    /**
+     * Lets a flavor wire its own per-observer effects (e.g.
+     * fetchNextPage / fetchPreviousPage for infinite queries). Receives the
+     * per-scope `$observer` store so the flavor can build attach-based
+     * effects that resolve the observer from the current scope.
+     */
+    setupEffects?: (params: {
+        $observer: Store<TObserver | null>;
+    }) => void;
+}
+interface CreateBaseQueryConfig<TData, TError, TResult extends BaseObserverResult<TData, TError>, TObserver extends BaseObserverLike<TResult>, TExtraStores> {
+    /** Build the observer for the current scope. Receives the resolved client. */
+    createObserver: (queryClient: QueryClient, initial: {
+        queryKey: QueryKey;
+        enabled: boolean;
+    }) => TObserver;
+    /**
+     * Hook for query flavors that need additional stores/events (e.g. infinite
+     * query's hasNextPage, fetchNextPage). Called once at factory time.
+     */
+    setupExtras?: () => ExtrasSetup<TResult, TObserver, TExtraStores>;
+}
+declare function createBaseQuery<TData, TError, TResult extends BaseObserverResult<TData, TError>, TObserver extends BaseObserverLike<TResult>, TExtraStores = {}>(explicitClient: QueryClient | null, options: BaseQueryOptions, config: CreateBaseQueryConfig<TData, TError, TResult, TObserver, TExtraStores>): BaseQueryStores<TData, TError, TObserver> & TExtraStores;
+
+export { type BaseObserverLike, type BaseObserverResult, type BaseQueryOptions, type BaseQueryStores, type CreateBaseQueryConfig, type ExtrasSetup, createBaseQuery, sidConfig, warnMissingName };