@effector-tanstack-query/core 0.3.0 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/createQueries.cjs +262 -0
- package/dist/createQueries.cjs.map +1 -0
- package/dist/createQueries.d.cts +32 -0
- package/dist/createQueries.d.ts +32 -0
- package/dist/createQueries.js +260 -0
- package/dist/createQueries.js.map +1 -0
- package/dist/index.cjs +5 -0
- package/dist/index.d.cts +2 -1
- package/dist/index.d.ts +2 -1
- package/dist/index.js +1 -0
- package/dist/types.d.cts +111 -1
- package/dist/types.d.ts +111 -1
- package/package.json +2 -2
- package/src/createQueries.ts +442 -0
- package/src/index.ts +5 -0
- package/src/types.ts +146 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/createQueries.ts"],"names":["$queryClient","$globalQueryClient"],"mappings":";;;;;;AAuBA,IAAM,cAAwE,EAAC;AA6CxE,SAAS,aAAA,CAOd,MAGA,IAAA,EACqC;AACrC,EAAA,MAAM,CAAC,cAAA,EAAgB,OAAO,CAAA,GAAI,SAAA,CAMhC,MAAM,IAAI,CAAA;AAEZ,EAAA,MAAM,EAAE,IAAA,EAAM,MAAA,EAAQ,KAAA,EAAO,GAAG,eAAc,GAAI,OAAA;AAElD,EAAA,IAAI,CAAC,IAAA,EAAM,eAAA,CAAgB,eAAe,CAAA;AAE1C,EAAA,MAAMA,cAAA,GAA0C,cAAA,GAC5C,WAAA,CAAY,cAAA,EAAsC;AAAA,IAChD,SAAA,EAAW;AAAA,GACZ,CAAA,GACDC,YAAA;AAGJ,EAAA,MAAM,UAAA,GAAa,WAAA;AAAA,wBACb,GAAA,EAAI;AAAA,IACR,EAAE,WAAW,QAAA;AAAS,GACxB;AAIA,EAAA,MAAM,YAAY,WAAA,CAAoB,CAAA,EAAG,EAAE,SAAA,EAAW,UAAU,CAAA;AAGhE,EAAA,MAAM,eAAe,WAAA,EAEnB;AACF,EAAA,MAAM,MAAA,GAAS,YAEb,WAAA,EAAoE;AAAA,IACpE,GAAG,SAAA,CAAU,IAAA,EAAM,QAAQ;AAAA,GAC5B,CAAA,CAAE,EAAA,CAAG,cAAc,CAAC,CAAA,EAAG,UAAU,KAAK,CAAA;AAEvC,EAAA,MAAM,mBAAmB,WAAA,EAEvB;AACF,EAAA,UAAA,CAAW,EAAA,CAAG,gBAAA,EAAkB,CAAC,CAAA,EAAG,SAAS,IAAI,CAAA;AAEjD,EAAA,MAAM,kBAAkB,WAAA,EAAoB;AAC5C,EAAA,SAAA,CAAU,EAAA,CAAG,eAAA,EAAiB,CAAC,CAAA,EAAG,SAAS,IAAI,CAAA;AAE/C,EAAA,MAAM,UAAU,WAAA,EAAkB;AAClC,EAAA,MAAM,YAAY,WAAA,EAAkB;AACpC,EAAA,MAAM,UAAU,WAAA,EAAkB;AAClC,EAAA,MAAM,aAAa,WAAA,EAAmB;AACtC,EAAA,MAAM,WAAW,WAAA,EAAkB;AAGnC,EAAA,SAAS,kBAAA,CACP,KACA,SAAA,EACqD;AACrD,IAAA,OAAO,GAAA,CAAI,GAAA,CAAI,CAAC,IAAA,KAAS;AACvB,MAAA,MAAM,IAAA,GAAO,MAAM,IAAI,CAAA;AACvB,MAAA,MAAM,IAAA,GAAO,OAAA,CAAQ,IAAA,CAAK,QAAkC,CAAA;AAC5D,MAAA,MAAM,KAAA,GAAQ,SAAA,CAAU,GAAA,CAAI,IAAI,CAAA;AAChC,MAAA,IAAI,CAAC,KAAA,EAAO,OAAO,gBAAA,CAAiB,IAAI,CAAA;AACxC,MAAA,MAAM,CAAA,GAAI,KAAA,CAAM,QAAA,CAAS,gBAAA,EAAiB;AAC1C,MAAA,OAAO;AAAA,QACL,MAAA,EAAQ,IAAA;AAAA,QACR,MAAM,CAAA,CAAE,IAAA;AAAA,QACR,OAAO,CAAA,CAAE,KAAA;AAAA,QACT,QAAQ,CAAA,CAAE,MAAA;AAAA,QACV,WAAW,CAAA,CAAE,SAAA;AAAA,QACb,YAAY,CAAA,CAAE,UAAA;AAAA,QACd,WAAW,CAAA,CAAE,SAAA;AAAA,QACb,SAAS,CAAA,CAAE,OAAA;AAAA,QACX,mBAAmB,CAAA,CAAE,iBAAA;AAAA,QACrB,aAAa,CAAA,CAAE;AAAA,OACjB;AAAA,IACF,CAAC,CAAA;AAAA,EACH;AAEA,EAAA,SAAS,qBAAqB,IAAA,EAAa;AACzC,IAAA,MAAM,QAAA,GAAW,MAAM,IAAI,CAAA;AAC3B,IAAA,OAAO;AAAA,MACL,GAAG,aAAA;AAAA,MACH,GAAG,QAAA;AAAA,MACH,OAAA,EAAS,SAAS,OAAA,IAAW;AAAA,KAC/B;AAAA,EACF;AAMA,EAAA,SAAS,UAAA,CACP,EAAA,EACA,GAAA,EACA,IAAA,EACA,WACA,iBAAA,EAIA;AACA,IAAA,MAAM,IAAA,GAAO,IAAI,GAAA,CAAI,IAAI,CAAA;AACzB,IAAA,MAAM,IAAA,uBAAW,GAAA,EAAY;AAE7B,IAAA,KAAA,MAAW,QAAQ,GAAA,EAAK;AACtB,MAAA,MAAM,IAAA,GAAO,MAAM,IAAI,CAAA;AACvB,MAAA,MAAM,IAAA,GAAO,OAAA,CAAQ,IAAA,CAAK,QAAkC,CAAA;AAC5D,MAAA,IAAA,CAAK,IAAI,IAAI,CAAA;AACb,MAAA,IAAI,KAAA,GAAQ,IAAA,CAAK,GAAA,CAAI,IAAI,CAAA;AACzB,MAAA,IAAI,CAAC,KAAA,EAAO;AACV,QAAA,MAAM,MAAM,IAAI,aAAA;AAAA,UACd,EAAA;AAAA,UACA,qBAAqB,IAAI;AAAA,SAC3B;AACA,QAAA,KAAA,GAAQ;AAAA,UACN,QAAA,EAAU,GAAA;AAAA,UACV,WAAA,EAAa;AAAA,SACf;AACA,QAAA,IAAA,CAAK,GAAA,CAAI,MAAM,KAAK,CAAA;AAAA,MACtB,CAAA,MAAO;AAGL,QAAA,KAAA,CAAM,SAAS,UAAA,CAAW;AAAA,UACxB,GAAG,MAAM,QAAA,CAAS,OAAA;AAAA,UAClB,GAAI,qBAAqB,IAAI;AAAA,SAC9B,CAAA;AAAA,MACH;AAKA,MAAA,IAAI,SAAA,IAAa,CAAC,KAAA,CAAM,WAAA,EAAa;AACnC,QAAA,KAAA,CAAM,WAAA,GAAc,KAAA,CAAM,QAAA,CAAS,SAAA,CAAU,iBAAiB,CAAA;AAAA,MAChE;AAAA,IACF;AAEA,IAAA,KAAA,MAAW,CAAC,IAAA,EAAM,KAAK,CAAA,IAAK,IAAA,EAAM;AAChC,MAAA,IAAI,CAAC,IAAA,CAAK,GAAA,CAAI,IAAI,CAAA,EAAG;AACnB,QAAA,KAAA,CAAM,WAAA,IAAc;AACpB,QAAA,KAAA,CAAM,SAAS,OAAA,EAAQ;AACvB,QAAA,IAAA,CAAK,OAAO,IAAI,CAAA;AAAA,MAClB;AAAA,IACF;AAEA,IAAA,OAAO,EAAE,IAAA,EAAM,KAAA,EAAO,kBAAA,CAAmB,GAAA,EAAK,IAAI,CAAA,EAAE;AAAA,EACtD;AAIA,EAAA,MAAM,cAAc,MAAA,CAAO;AAAA,IACzB,MAAA,EAAQ,EAAE,SAAA,EAAW,UAAA,EAAY,eAAe,MAAA,EAAO;AAAA,IACvD,MAAA,EAAQ,CAAC,EAAE,SAAA,EAAW,eAAc,KAAM;AACxC,MAAA,OAAO,kBAAA,CAAmB,eAAe,SAAS,CAAA;AAAA,IACpD;AAAA,GACD,CAAA;AACD,EAAA,MAAA,CAAO,EAAE,KAAA,EAAO,WAAA,CAAY,QAAA,EAAU,MAAA,EAAQ,cAAc,CAAA;AAQ5D,EAAA,MAAM,SAAS,MAAA,CAAO;AAAA,IACpB,MAAA,EAAQ;AAAA,MACN,EAAA,EAAID,cAAA;AAAA,MACJ,SAAA,EAAW,UAAA;AAAA,MACX,QAAA,EAAU,SAAA;AAAA,MACV,aAAA,EAAe;AAAA,KACjB;AAAA,IACA,QAAQ,CAAC,EAAE,IAAI,SAAA,EAAW,QAAA,EAAU,eAAc,KAAM;AACtD,MAAA,IAAI,CAAC,EAAA,EAAI;AACP,QAAA,OAAO;AAAA,UACL,IAAA,EAAM,SAAA;AAAA,UACN,KAAA,EAAO,aAAA,CAAc,GAAA,CAAI,gBAAgB;AAAA,SAC3C;AAAA,MACF;AACA,MAAA,MAAM,oBAAoB,SAAA,CAAU,WAAA,EAAa,EAAE,IAAA,EAAM,MAAM,CAAA;AAC/D,MAAA,OAAO,UAAA;AAAA,QACL,EAAA;AAAA,QACA,aAAA;AAAA,QACA,SAAA;AAAA,QACA,QAAA,GAAW,CAAA;AAAA,QACX,MAAM,iBAAA;AAAkB,OAC1B;AAAA,IACF;AAAA,GACD,CAAA;AACD,EAAA,MAAA,CAAO;AAAA,IACL,OAAO,MAAA,CAAO,QAAA;AAAA,IACd,EAAA,EAAI,CAAC,OAAA,KAAY,OAAA,CAAQ,IAAA;AAAA,IACzB,MAAA,EAAQ;AAAA,GACT,CAAA;AACD,EAAA,MAAA,CAAO;AAAA,IACL,OAAO,MAAA,CAAO,QAAA;AAAA,IACd,EAAA,EAAI,CAAC,OAAA,KAAY,OAAA,CAAQ,KAAA;AAAA,IACzB,MAAA,EAAQ;AAAA,GACT,CAAA;AAED,EAAA,MAAA,CAAO,EAAE,KAAA,EAAO,MAAA,EAAQ,MAAA,EAAQ,QAAQ,CAAA;AACxC,EAAA,MAAA,CAAO,EAAE,KAAA,EAAOA,cAAA,EAAc,MAAA,EAAQ,QAAQ,CAAA;AAO9C,EAAA,MAAM,UAAU,MAAA,CAAO;AAAA,IACrB,MAAA,EAAQ,SAAA;AAAA,IACR,MAAA,EAAQ,CAAC,QAAA,KAAa,QAAA,GAAW;AAAA,GAClC,CAAA;AACD,EAAA,MAAA,CAAO,EAAE,KAAA,EAAO,OAAA,EAAS,MAAA,EAAQ,SAAS,CAAA;AAC1C,EAAA,MAAA,CAAO,EAAE,KAAA,EAAO,OAAA,CAAQ,QAAA,EAAU,MAAA,EAAQ,iBAAiB,CAAA;AAC3D,EAAA,MAAA,CAAO,EAAE,KAAA,EAAO,OAAA,CAAQ,IAAA,EAAM,MAAA,EAAQ,QAAQ,CAAA;AAE9C,EAAA,MAAM,YAAY,MAAA,CAAO;AAAA,IACvB,MAAA,EAAQ,EAAE,SAAA,EAAW,UAAA,EAAY,UAAU,SAAA,EAAU;AAAA,IACrD,MAAA,EAAQ,CAAC,EAAE,SAAA,EAAW,UAAS,KAAM;AACnC,MAAA,MAAM,YAAA,GAAe,IAAA,CAAK,GAAA,CAAI,CAAA,EAAG,WAAW,CAAC,CAAA;AAC7C,MAAA,IAAI,iBAAiB,CAAA,EAAG;AACtB,QAAA,KAAA,MAAW,KAAA,IAAS,SAAA,CAAU,MAAA,EAAO,EAAG;AACtC,UAAA,KAAA,CAAM,WAAA,IAAc;AACpB,UAAA,KAAA,CAAM,WAAA,GAAc,IAAA;AAAA,QACtB;AAAA,MACF;AACA,MAAA,OAAO,YAAA;AAAA,IACT;AAAA,GACD,CAAA;AACD,EAAA,MAAA,CAAO,EAAE,KAAA,EAAO,SAAA,EAAW,MAAA,EAAQ,WAAW,CAAA;AAC9C,EAAA,MAAA,CAAO,EAAE,KAAA,EAAO,SAAA,CAAU,QAAA,EAAU,MAAA,EAAQ,iBAAiB,CAAA;AAI7D,EAAA,MAAM,YAAY,MAAA,CAAO;AAAA,IACvB,MAAA,EAAQ,UAAA;AAAA,IACR,MAAA,EAAQ,OAAO,SAAA,KAAc;AAC3B,MAAA,MAAM,OAAA,CAAQ,GAAA;AAAA,QACZ,CAAC,GAAG,SAAA,CAAU,MAAA,EAAQ,CAAA,CAAE,GAAA;AAAA,UAAI,CAAC,UAC3B,KAAA,CAAM,QAAA,CAAS,SAAQ,CAAE,KAAA,CAAM,MAAM,MAAS;AAAA;AAChD,OACF;AAAA,IACF;AAAA,GACD,CAAA;AACD,EAAA,MAAA,CAAO,EAAE,KAAA,EAAO,OAAA,EAAS,MAAA,EAAQ,WAAW,CAAA;AAE5C,EAAA,MAAM,eAAe,MAAA,CAAO;AAAA,IAC1B,MAAA,EAAQ,UAAA;AAAA,IACR,MAAA,EAAQ,OACN,SAAA,EACA,IAAA,KACG;AACH,MAAA,MAAM,IAAA,GAAO,MAAM,IAAI,CAAA;AACvB,MAAA,MAAM,IAAA,GAAO,OAAA,CAAQ,IAAA,CAAK,QAAkC,CAAA;AAC5D,MAAA,MAAM,KAAA,GAAQ,SAAA,CAAU,GAAA,CAAI,IAAI,CAAA;AAChC,MAAA,IAAI,CAAC,KAAA,EAAO;AACZ,MAAA,MAAM,MAAM,QAAA,CAAS,OAAA,EAAQ,CAAE,KAAA,CAAM,MAAM,MAAS,CAAA;AAAA,IACtD;AAAA,GACD,CAAA;AACD,EAAA,MAAA,CAAO,EAAE,KAAA,EAAO,UAAA,EAAY,MAAA,EAAQ,cAAc,CAAA;AAKlD,EAAA,MAAM,aAAa,MAAA,CAAO;AAAA,IACxB,MAAA,EAAQ,EAAE,EAAA,EAAIA,cAAA,EAAc,eAAe,MAAA,EAAO;AAAA,IAClD,MAAA,EAAQ,OAAO,EAAE,EAAA,EAAI,eAAc,KAAM;AACvC,MAAA,IAAI,CAAC,EAAA,EAAI;AACT,MAAA,MAAM,OAAA,CAAQ,GAAA;AAAA,QACZ,aAAA,CAAc,GAAA,CAAI,CAAC,IAAA,KAAS;AAC1B,UAAA,MAAM,IAAA,GAAO,MAAM,IAAI,CAAA;AACvB,UAAA,IAAI,IAAA,CAAK,OAAA,KAAY,KAAA,EAAO,OAAO,QAAQ,OAAA,EAAQ;AACnD,UAAA,OAAO,GACJ,UAAA,CAAW;AAAA,YACV,GAAG,aAAA;AAAA,YACH,GAAG;AAAA,WACG,CAAA,CACP,KAAA,CAAM,MAAM,MAAS,CAAA;AAAA,QAC1B,CAAC;AAAA,OACH;AAAA,IACF;AAAA,GACD,CAAA;AACD,EAAA,MAAA,CAAO,EAAE,KAAA,EAAO,QAAA,EAAU,MAAA,EAAQ,YAAY,CAAA;AAE9C,EAAA,MAAA,CAAO,EAAE,KAAA,EAAO,UAAA,CAAW,IAAA,EAAM,MAAA,EAAQ,QAAQ,CAAA;AAGjD,EAAA,MAAM,KAAA,GAAQ,MAAA,CAAO,GAAA,CAAI,CAAC,KAAA,KAAU,KAAA,CAAM,GAAA,CAAI,CAAC,EAAA,KAAO,EAAA,CAAG,IAAI,CAAC,CAAA;AAC9D,EAAA,MAAM,aAAa,MAAA,CAAO,GAAA;AAAA,IAAI,CAAC,KAAA,KAC7B,KAAA,CAAM,MAAA,KAAW,CAAA,GAAI,KAAA,GAAQ,KAAA,CAAM,IAAA,CAAK,CAAC,EAAA,KAAO,EAAA,CAAG,SAAS;AAAA,GAC9D;AACA,EAAA,MAAM,aAAa,MAAA,CAAO,GAAA;AAAA,IAAI,CAAC,KAAA,KAC7B,KAAA,CAAM,MAAA,KAAW,CAAA,GAAI,IAAA,GAAO,KAAA,CAAM,KAAA,CAAM,CAAC,EAAA,KAAO,EAAA,CAAG,SAAS;AAAA,GAC9D;AACA,EAAA,MAAM,WAAA,GAAc,MAAA,CAAO,GAAA,CAAI,CAAC,KAAA,KAAU,KAAA,CAAM,IAAA,CAAK,CAAC,EAAA,KAAO,EAAA,CAAG,UAAU,CAAC,CAAA;AAC3E,EAAA,MAAM,QAAA,GAAW,MAAA,CAAO,GAAA,CAAI,CAAC,KAAA,KAAU,KAAA,CAAM,IAAA,CAAK,CAAC,EAAA,KAAO,EAAA,CAAG,OAAO,CAAC,CAAA;AAErE,EAAA,MAAM,MAAA,GAA8C;AAAA,IAClD,MAAA;AAAA,IACA,KAAA;AAAA,IACA,UAAA;AAAA,IACA,UAAA;AAAA,IACA,WAAA;AAAA,IACA,QAAA;AAAA,IACA,OAAA;AAAA,IACA,SAAA;AAAA,IACA,OAAA;AAAA,IACA,UAAA;AAAA,IACA,QAAA;AAAA,kBACAA,cAAA;AAAA,IACA,QAAA,EAAU;AAAA,GACZ;AAOA,EAAA,MAAA,CAAO,cAAA,CAAe,QAAQ,YAAA,EAAc;AAAA,IAC1C,UAAA,EAAY,KAAA;AAAA,IACZ,KAAA,EAAO;AAAA,GACR,CAAA;AAED,EAAA,OAAO,MAAA;AAEP,EAAA,SAAS,iBAAiB,IAAA,EAAmD;AAC3E,IAAA,OAAO;AAAA,MACL,MAAA,EAAQ,IAAA;AAAA,MACR,IAAA,EAAM,MAAA;AAAA,MACN,KAAA,EAAO,IAAA;AAAA,MACP,MAAA,EAAQ,SAAA;AAAA,MACR,SAAA,EAAW,IAAA;AAAA,MACX,UAAA,EAAY,KAAA;AAAA,MACZ,SAAA,EAAW,KAAA;AAAA,MACX,OAAA,EAAS,KAAA;AAAA,MACT,iBAAA,EAAmB,KAAA;AAAA,MACnB,WAAA,EAAa;AAAA,KACf;AAAA,EACF;AACF;AAEA,SAAS,SAAA,CACP,MAGA,IAAA,EAIA;AACA,EAAA,IAAI,SAAS,MAAA,EAAW;AACtB,IAAA,OAAO,CAAC,MAAqB,IAAI,CAAA;AAAA,EACnC;AACA,EAAA,OAAO;AAAA,IACL,IAAA;AAAA,IACA;AAAA,GAOF;AACF","file":"createQueries.js","sourcesContent":["import {\n attach,\n createEvent,\n createStore,\n sample,\n scopeBind,\n type Store,\n} from 'effector'\nimport { QueryObserver, hashKey } from '@tanstack/query-core'\nimport type { QueryClient } from '@tanstack/query-core'\nimport { $queryClient as $globalQueryClient } from './queryClient'\nimport { sidConfig, warnMissingName } from './createBaseQuery'\nimport type {\n CreateQueriesOptions,\n QueriesResult,\n QueryItemState,\n} from './types'\n\ninterface ObserverEntry<TData, TError> {\n observer: QueryObserver<TData, TError>\n unsubscribe: (() => void) | null\n}\n\nconst EMPTY_ITEMS: ReadonlyArray<QueryItemState<unknown, unknown, unknown>> = []\n\n/**\n * Reactive family of parallel queries indexed by a source store. See\n * {@link CreateQueriesOptions} for the input shape and\n * {@link QueriesResult} for the output API.\n *\n * Internals:\n *\n * - Each `source` element gets one `QueryObserver` (deduplicated by\n * `hashKey(query(item).queryKey)`). Observers live in a per-scope\n * `Map` held in a `serialize: 'ignore'` store (instances can't ride\n * through `serialize(scope)`).\n * - On every `source` update the family diffs prev/next, spawns\n * observers for new items, disposes observers for removed items,\n * and updates `$items`. Re-ordering without add/remove is cheap —\n * observers stay, `$items` just re-projects.\n * - Observer subscriptions are reference-counted via `mounted()` /\n * `unmounted()`. First mount subscribes every observer; last\n * unmount unsubscribes. Subsequent source changes while mounted\n * auto-subscribe new observers.\n * - SSR works via `prefetch`: triggers `qc.fetchQuery(...)` for every\n * current source item in parallel, populates the QC cache, then\n * mounts observers so `$items` snapshot carries the data through\n * `serialize(scope)`.\n */\nexport function createQueries<\n TItem,\n TQueryFnData = unknown,\n TError = Error,\n TData = TQueryFnData,\n TQueryKey extends ReadonlyArray<unknown> = ReadonlyArray<unknown>,\n>(\n options: CreateQueriesOptions<TItem, TQueryFnData, TError, TData, TQueryKey>,\n): QueriesResult<TItem, TData, TError>\nexport function createQueries<\n TItem,\n TQueryFnData = unknown,\n TError = Error,\n TData = TQueryFnData,\n TQueryKey extends ReadonlyArray<unknown> = ReadonlyArray<unknown>,\n>(\n queryClient: QueryClient,\n options: CreateQueriesOptions<TItem, TQueryFnData, TError, TData, TQueryKey>,\n): QueriesResult<TItem, TData, TError>\nexport function createQueries<\n TItem,\n TQueryFnData = unknown,\n TError = Error,\n TData = TQueryFnData,\n TQueryKey extends ReadonlyArray<unknown> = ReadonlyArray<unknown>,\n>(\n arg1:\n | QueryClient\n | CreateQueriesOptions<TItem, TQueryFnData, TError, TData, TQueryKey>,\n arg2?: CreateQueriesOptions<TItem, TQueryFnData, TError, TData, TQueryKey>,\n): QueriesResult<TItem, TData, TError> {\n const [explicitClient, options] = parseArgs<\n TItem,\n TQueryFnData,\n TError,\n TData,\n TQueryKey\n >(arg1, arg2)\n\n const { name, source, query, ...sharedOptions } = options\n\n if (!name) warnMissingName('createQueries')\n\n const $queryClient: Store<QueryClient | null> = explicitClient\n ? createStore(explicitClient as QueryClient | null, {\n serialize: 'ignore',\n })\n : $globalQueryClient\n\n // Per-scope observer storage. Map keyed by queryKey hash.\n const $observers = createStore<Map<string, ObserverEntry<TData, TError>>>(\n new Map(),\n { serialize: 'ignore' },\n )\n\n // Per-scope ref-count: number of active consumers that called mounted().\n // First mount subscribes observers, last unmount unsubscribes them.\n const $refCount = createStore<number>(0, { serialize: 'ignore' })\n\n // The serializable result snapshot.\n const itemsUpdated = createEvent<\n ReadonlyArray<QueryItemState<TItem, TData, TError>>\n >()\n const $items = createStore<\n ReadonlyArray<QueryItemState<TItem, TData, TError>>\n >(EMPTY_ITEMS as ReadonlyArray<QueryItemState<TItem, TData, TError>>, {\n ...sidConfig(name, '$items'),\n }).on(itemsUpdated, (_, items) => items)\n\n const observersChanged = createEvent<\n Map<string, ObserverEntry<TData, TError>>\n >()\n $observers.on(observersChanged, (_, next) => next)\n\n const refCountChanged = createEvent<number>()\n $refCount.on(refCountChanged, (_, next) => next)\n\n const mounted = createEvent<void>()\n const unmounted = createEvent<void>()\n const refresh = createEvent<void>()\n const refreshOne = createEvent<TItem>()\n const prefetch = createEvent<void>()\n\n // Snapshot helpers — pure, run from effects.\n function itemsFromObservers(\n src: ReadonlyArray<TItem>,\n observers: Map<string, ObserverEntry<TData, TError>>,\n ): ReadonlyArray<QueryItemState<TItem, TData, TError>> {\n return src.map((item) => {\n const opts = query(item)\n const hash = hashKey(opts.queryKey as ReadonlyArray<unknown>)\n const entry = observers.get(hash)\n if (!entry) return defaultItemState(item)\n const r = entry.observer.getCurrentResult()\n return {\n source: item,\n data: r.data,\n error: r.error,\n status: r.status,\n isPending: r.isPending,\n isFetching: r.isFetching,\n isSuccess: r.isSuccess,\n isError: r.isError,\n isPlaceholderData: r.isPlaceholderData,\n fetchStatus: r.fetchStatus,\n }\n })\n }\n\n function buildObserverOptions(item: TItem) {\n const itemOpts = query(item)\n return {\n ...sharedOptions,\n ...itemOpts,\n enabled: itemOpts.enabled ?? true,\n } as ConstructorParameters<typeof QueryObserver<TQueryFnData, TError, TData>>[1]\n }\n\n // Diff source against current observers. Spawns / disposes observers\n // to match the desired set; subscribes the ones that should be live\n // given the current mount state. Idempotent — calling twice with the\n // same input + state is a no-op.\n function diffSource(\n qc: QueryClient,\n src: ReadonlyArray<TItem>,\n prev: Map<string, ObserverEntry<TData, TError>>,\n isMounted: boolean,\n dispatchRecompute: () => void,\n ): {\n next: Map<string, ObserverEntry<TData, TError>>\n items: ReadonlyArray<QueryItemState<TItem, TData, TError>>\n } {\n const next = new Map(prev)\n const keep = new Set<string>()\n\n for (const item of src) {\n const opts = query(item)\n const hash = hashKey(opts.queryKey as ReadonlyArray<unknown>)\n keep.add(hash)\n let entry = next.get(hash)\n if (!entry) {\n const obs = new QueryObserver<TQueryFnData, TError, TData>(\n qc,\n buildObserverOptions(item) as any,\n )\n entry = {\n observer: obs as unknown as QueryObserver<TData, TError>,\n unsubscribe: null,\n }\n next.set(hash, entry)\n } else {\n // Same queryKey but `query(item)` might have changed `enabled`\n // (or other passthrough options). Keep observer options in sync.\n entry.observer.setOptions({\n ...entry.observer.options,\n ...(buildObserverOptions(item) as any),\n })\n }\n // Ensure subscription state matches mount state — covers both\n // newly-spawned observers and pre-existing observers that were\n // created while unmounted (`syncFx` ran on source change before\n // anyone called `mounted()`).\n if (isMounted && !entry.unsubscribe) {\n entry.unsubscribe = entry.observer.subscribe(dispatchRecompute)\n }\n }\n\n for (const [hash, entry] of next) {\n if (!keep.has(hash)) {\n entry.unsubscribe?.()\n entry.observer.destroy()\n next.delete(hash)\n }\n }\n\n return { next, items: itemsFromObservers(src, next) }\n }\n\n // Triggered whenever an observer emits a result (subscribe callback)\n // OR when source changes — re-projects $items.\n const recomputeFx = attach({\n source: { observers: $observers, currentSource: source },\n effect: ({ observers, currentSource }) => {\n return itemsFromObservers(currentSource, observers)\n },\n })\n sample({ clock: recomputeFx.doneData, target: itemsUpdated })\n\n // Source sync effect — applies diff, mutates observer subscriptions\n // when mounted, then dispatches the items snapshot. When the scope\n // has no QueryClient yet we still run, but the diff produces an\n // empty observer set (no `new QueryObserver(qc, ...)` calls), so\n // `$items` shows default-pending state and observers spawn the\n // moment qc becomes available.\n const syncFx = attach({\n source: {\n qc: $queryClient,\n observers: $observers,\n refCount: $refCount,\n currentSource: source,\n },\n effect: ({ qc, observers, refCount, currentSource }) => {\n if (!qc) {\n return {\n next: observers,\n items: currentSource.map(defaultItemState),\n }\n }\n const dispatchRecompute = scopeBind(recomputeFx, { safe: true })\n return diffSource(\n qc,\n currentSource,\n observers,\n refCount > 0,\n () => dispatchRecompute(),\n )\n },\n })\n sample({\n clock: syncFx.doneData,\n fn: (payload) => payload.next,\n target: observersChanged,\n })\n sample({\n clock: syncFx.doneData,\n fn: (payload) => payload.items,\n target: itemsUpdated,\n })\n\n sample({ clock: source, target: syncFx })\n sample({ clock: $queryClient, target: syncFx })\n\n // Mount lifecycle — increment refCount, then run syncFx so observers\n // get spawned (if missing) and subscribed (because `refCount > 0`\n // now). Same path covers the first-ever mount AND\n // existing-but-unsubscribed observers (created while unmounted, e.g.\n // on a source-change in a not-yet-mounted scope).\n const mountFx = attach({\n source: $refCount,\n effect: (refCount) => refCount + 1,\n })\n sample({ clock: mounted, target: mountFx })\n sample({ clock: mountFx.doneData, target: refCountChanged })\n sample({ clock: mountFx.done, target: syncFx })\n\n const unmountFx = attach({\n source: { observers: $observers, refCount: $refCount },\n effect: ({ observers, refCount }) => {\n const nextRefCount = Math.max(0, refCount - 1)\n if (nextRefCount === 0) {\n for (const entry of observers.values()) {\n entry.unsubscribe?.()\n entry.unsubscribe = null\n }\n }\n return nextRefCount\n },\n })\n sample({ clock: unmounted, target: unmountFx })\n sample({ clock: unmountFx.doneData, target: refCountChanged })\n\n // Refresh — invalidate all observed queries; observer subscribers\n // pick up the refetched data and refresh $items via recomputeFx.\n const refreshFx = attach({\n source: $observers,\n effect: async (observers) => {\n await Promise.all(\n [...observers.values()].map((entry) =>\n entry.observer.refetch().catch(() => undefined),\n ),\n )\n },\n })\n sample({ clock: refresh, target: refreshFx })\n\n const refreshOneFx = attach({\n source: $observers,\n effect: async (\n observers,\n item: TItem,\n ) => {\n const opts = query(item)\n const hash = hashKey(opts.queryKey as ReadonlyArray<unknown>)\n const entry = observers.get(hash)\n if (!entry) return\n await entry.observer.refetch().catch(() => undefined)\n },\n })\n sample({ clock: refreshOne, target: refreshOneFx })\n\n // Prefetch — for SSR. Walks source, calls qc.fetchQuery for each item\n // in parallel, then re-runs syncFx so $items reflects the populated\n // cache.\n const prefetchFx = attach({\n source: { qc: $queryClient, currentSource: source },\n effect: async ({ qc, currentSource }) => {\n if (!qc) return\n await Promise.all(\n currentSource.map((item) => {\n const opts = query(item)\n if (opts.enabled === false) return Promise.resolve()\n return qc\n .fetchQuery({\n ...sharedOptions,\n ...opts,\n } as any)\n .catch(() => undefined)\n }),\n )\n },\n })\n sample({ clock: prefetch, target: prefetchFx })\n // After prefetch resolves, re-sync to update $items from QC cache.\n sample({ clock: prefetchFx.done, target: syncFx })\n\n // Derived stores — convenience views.\n const $data = $items.map((items) => items.map((it) => it.data))\n const $isPending = $items.map((items) =>\n items.length === 0 ? false : items.some((it) => it.isPending),\n )\n const $isSuccess = $items.map((items) =>\n items.length === 0 ? true : items.every((it) => it.isSuccess),\n )\n const $isFetching = $items.map((items) => items.some((it) => it.isFetching))\n const $isError = $items.map((items) => items.some((it) => it.isError))\n\n const result: QueriesResult<TItem, TData, TError> = {\n $items,\n $data,\n $isPending,\n $isSuccess,\n $isFetching,\n $isError,\n mounted,\n unmounted,\n refresh,\n refreshOne,\n prefetch,\n $queryClient,\n __family: true,\n }\n\n // Internal: callable from the suspense hook to reconstruct the\n // QueryObserver options for one source item (with sharedOptions\n // merged on top of `query(item)` and the default `enabled: true`).\n // The hook then feeds this into `qc.fetchQuery` to obtain a\n // deduped-by-queryHash inflight promise to throw at React.\n Object.defineProperty(result, '__queryFor', {\n enumerable: false,\n value: buildObserverOptions,\n })\n\n return result\n\n function defaultItemState(item: TItem): QueryItemState<TItem, TData, TError> {\n return {\n source: item,\n data: undefined,\n error: null,\n status: 'pending',\n isPending: true,\n isFetching: false,\n isSuccess: false,\n isError: false,\n isPlaceholderData: false,\n fetchStatus: 'idle',\n }\n }\n}\n\nfunction parseArgs<TItem, TQueryFnData, TError, TData, TQueryKey extends ReadonlyArray<unknown>>(\n arg1:\n | QueryClient\n | CreateQueriesOptions<TItem, TQueryFnData, TError, TData, TQueryKey>,\n arg2?: CreateQueriesOptions<TItem, TQueryFnData, TError, TData, TQueryKey>,\n): [\n QueryClient | null,\n CreateQueriesOptions<TItem, TQueryFnData, TError, TData, TQueryKey>,\n] {\n if (arg2 !== undefined) {\n return [arg1 as QueryClient, arg2]\n }\n return [\n null,\n arg1 as CreateQueriesOptions<\n TItem,\n TQueryFnData,\n TError,\n TData,\n TQueryKey\n >,\n ]\n}\n"]}
|
package/dist/index.cjs
CHANGED
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
var createQuery_cjs = require('./createQuery.cjs');
|
|
4
4
|
var createInfiniteQuery_cjs = require('./createInfiniteQuery.cjs');
|
|
5
|
+
var createQueries_cjs = require('./createQueries.cjs');
|
|
5
6
|
var createMutation_cjs = require('./createMutation.cjs');
|
|
6
7
|
var createInvalidate_cjs = require('./createInvalidate.cjs');
|
|
7
8
|
var queryClient_cjs = require('./queryClient.cjs');
|
|
@@ -17,6 +18,10 @@ Object.defineProperty(exports, "createInfiniteQuery", {
|
|
|
17
18
|
enumerable: true,
|
|
18
19
|
get: function () { return createInfiniteQuery_cjs.createInfiniteQuery; }
|
|
19
20
|
});
|
|
21
|
+
Object.defineProperty(exports, "createQueries", {
|
|
22
|
+
enumerable: true,
|
|
23
|
+
get: function () { return createQueries_cjs.createQueries; }
|
|
24
|
+
});
|
|
20
25
|
Object.defineProperty(exports, "createMutation", {
|
|
21
26
|
enumerable: true,
|
|
22
27
|
get: function () { return createMutation_cjs.createMutation; }
|
package/dist/index.d.cts
CHANGED
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
export { createQuery } from './createQuery.cjs';
|
|
2
2
|
export { createInfiniteQuery } from './createInfiniteQuery.cjs';
|
|
3
|
+
export { createQueries } from './createQueries.cjs';
|
|
3
4
|
export { createMutation } from './createMutation.cjs';
|
|
4
5
|
export { CreateInvalidateOptions, createInvalidate } from './createInvalidate.cjs';
|
|
5
6
|
export { $queryClient, setQueryClient } from './queryClient.cjs';
|
|
6
7
|
export { PrefetchQueriesConfig, PrefetchableQuery, prefetchQueries } from './prefetchQueries.cjs';
|
|
7
|
-
export { CreateInfiniteQueryOptions, CreateMutationOptions, CreateQueryOptions, EffectorQueryKey, InfiniteQueryResult, MutationResult, MutationStatus, QueryResult, StoreOrValue } from './types.cjs';
|
|
8
|
+
export { CreateInfiniteQueryOptions, CreateMutationOptions, CreateQueriesItemOptions, CreateQueriesOptions, CreateQueryOptions, EffectorQueryKey, InfiniteQueryResult, MutationResult, MutationStatus, QueriesResult, QueryItemState, QueryResult, StoreOrValue } from './types.cjs';
|
|
8
9
|
import '@tanstack/query-core';
|
|
9
10
|
import 'effector';
|
package/dist/index.d.ts
CHANGED
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
export { createQuery } from './createQuery.js';
|
|
2
2
|
export { createInfiniteQuery } from './createInfiniteQuery.js';
|
|
3
|
+
export { createQueries } from './createQueries.js';
|
|
3
4
|
export { createMutation } from './createMutation.js';
|
|
4
5
|
export { CreateInvalidateOptions, createInvalidate } from './createInvalidate.js';
|
|
5
6
|
export { $queryClient, setQueryClient } from './queryClient.js';
|
|
6
7
|
export { PrefetchQueriesConfig, PrefetchableQuery, prefetchQueries } from './prefetchQueries.js';
|
|
7
|
-
export { CreateInfiniteQueryOptions, CreateMutationOptions, CreateQueryOptions, EffectorQueryKey, InfiniteQueryResult, MutationResult, MutationStatus, QueryResult, StoreOrValue } from './types.js';
|
|
8
|
+
export { CreateInfiniteQueryOptions, CreateMutationOptions, CreateQueriesItemOptions, CreateQueriesOptions, CreateQueryOptions, EffectorQueryKey, InfiniteQueryResult, MutationResult, MutationStatus, QueriesResult, QueryItemState, QueryResult, StoreOrValue } from './types.js';
|
|
8
9
|
import '@tanstack/query-core';
|
|
9
10
|
import 'effector';
|
package/dist/index.js
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
export { createQuery } from './createQuery.js';
|
|
2
2
|
export { createInfiniteQuery } from './createInfiniteQuery.js';
|
|
3
|
+
export { createQueries } from './createQueries.js';
|
|
3
4
|
export { createMutation } from './createMutation.js';
|
|
4
5
|
export { createInvalidate } from './createInvalidate.js';
|
|
5
6
|
export { $queryClient, setQueryClient } from './queryClient.js';
|
package/dist/types.d.cts
CHANGED
|
@@ -229,5 +229,115 @@ interface MutationResult<TData = unknown, TError = Error, TVariables = void> {
|
|
|
229
229
|
}>;
|
|
230
230
|
};
|
|
231
231
|
}
|
|
232
|
+
/**
|
|
233
|
+
* Per-item snapshot inside a `createQueries` family. Parallel to the
|
|
234
|
+
* factory's `source` array — one entry per item, in source order.
|
|
235
|
+
*/
|
|
236
|
+
interface QueryItemState<TItem, TData, TError = Error> {
|
|
237
|
+
/** The source item this entry was derived from. */
|
|
238
|
+
source: TItem;
|
|
239
|
+
data: TData | undefined;
|
|
240
|
+
error: TError | null;
|
|
241
|
+
status: QueryStatus;
|
|
242
|
+
isPending: boolean;
|
|
243
|
+
isFetching: boolean;
|
|
244
|
+
isSuccess: boolean;
|
|
245
|
+
isError: boolean;
|
|
246
|
+
isPlaceholderData: boolean;
|
|
247
|
+
fetchStatus: FetchStatus;
|
|
248
|
+
}
|
|
249
|
+
/**
|
|
250
|
+
* Per-item query options produced by `createQueries({ query })`. A pure
|
|
251
|
+
* function of one source item — no effector stores, no closures over
|
|
252
|
+
* mutable state. Reactivity comes from the source store; whenever it
|
|
253
|
+
* updates, this callback re-runs to compute fresh options.
|
|
254
|
+
*
|
|
255
|
+
* `enabled` is a plain boolean (not a `Store`) for the same reason —
|
|
256
|
+
* it's derived from the item, so reactivity is already covered.
|
|
257
|
+
*/
|
|
258
|
+
interface CreateQueriesItemOptions<TQueryFnData, TError, TData, TQueryKey extends ReadonlyArray<unknown>> extends Omit<QueryObserverOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>, 'queryKey' | 'enabled'> {
|
|
259
|
+
queryKey: TQueryKey;
|
|
260
|
+
enabled?: boolean;
|
|
261
|
+
}
|
|
262
|
+
interface CreateQueriesOptions<TItem, TQueryFnData = unknown, TError = Error, TData = TQueryFnData, TQueryKey extends ReadonlyArray<unknown> = ReadonlyArray<unknown>> {
|
|
263
|
+
/**
|
|
264
|
+
* Stable name used to derive the SID of the result `$items` store so
|
|
265
|
+
* `serialize(scope)` round-trips it for SSR. Without a name, the
|
|
266
|
+
* QueryClient cache still hydrates via `dehydrate`/`hydrate`, but the
|
|
267
|
+
* `$items` snapshot is silently dropped from `serialize(scope)`.
|
|
268
|
+
*/
|
|
269
|
+
name?: string;
|
|
270
|
+
/**
|
|
271
|
+
* Reactive list of items. Each item becomes one parallel query in the
|
|
272
|
+
* family. Adding / removing items updates the family (spawn / dispose
|
|
273
|
+
* observer). Order is preserved in `$items`.
|
|
274
|
+
*
|
|
275
|
+
* Duplicates in `source` deduplicate observers (same `queryKey` hash)
|
|
276
|
+
* but produce separate `$items` entries — one per occurrence.
|
|
277
|
+
*/
|
|
278
|
+
source: Store<ReadonlyArray<TItem>>;
|
|
279
|
+
/**
|
|
280
|
+
* Per-item options builder. MUST be pure — same item in, same options
|
|
281
|
+
* out. Reactivity is driven by the source store; this callback fires
|
|
282
|
+
* synchronously when source updates.
|
|
283
|
+
*/
|
|
284
|
+
query: (item: TItem) => CreateQueriesItemOptions<TQueryFnData, TError, TData, TQueryKey>;
|
|
285
|
+
/** Shared QueryObserver defaults applied on top of `query(item)`. */
|
|
286
|
+
staleTime?: number;
|
|
287
|
+
gcTime?: number;
|
|
288
|
+
retry?: QueryObserverOptions<TQueryFnData, TError, TData>['retry'];
|
|
289
|
+
retryDelay?: QueryObserverOptions<TQueryFnData, TError, TData>['retryDelay'];
|
|
290
|
+
refetchOnMount?: QueryObserverOptions<TQueryFnData, TError, TData>['refetchOnMount'];
|
|
291
|
+
refetchOnReconnect?: QueryObserverOptions<TQueryFnData, TError, TData>['refetchOnReconnect'];
|
|
292
|
+
refetchOnWindowFocus?: QueryObserverOptions<TQueryFnData, TError, TData>['refetchOnWindowFocus'];
|
|
293
|
+
networkMode?: QueryObserverOptions<TQueryFnData, TError, TData>['networkMode'];
|
|
294
|
+
}
|
|
295
|
+
/**
|
|
296
|
+
* Result of `createQueries(...)`. A reactive "family" of parallel
|
|
297
|
+
* queries indexed by a source store. Composes naturally with
|
|
298
|
+
* `useUnit($items)` for non-Suspense usage and with
|
|
299
|
+
* `useQueries(family)` / `useSuspenseQueries(family)` for React-style
|
|
300
|
+
* consumption.
|
|
301
|
+
*/
|
|
302
|
+
interface QueriesResult<TItem, TData = unknown, TError = Error> {
|
|
303
|
+
/** Per-item snapshots, parallel to `source`. */
|
|
304
|
+
$items: Store<ReadonlyArray<QueryItemState<TItem, TData, TError>>>;
|
|
305
|
+
/** Just the `data` field of `$items` — shortcut for common UIs. */
|
|
306
|
+
$data: Store<ReadonlyArray<TData | undefined>>;
|
|
307
|
+
/** `true` while **any** query in the family is pending. */
|
|
308
|
+
$isPending: Store<boolean>;
|
|
309
|
+
/** `true` only when **every** query in the family has succeeded. */
|
|
310
|
+
$isSuccess: Store<boolean>;
|
|
311
|
+
/** `true` if **any** query in the family is currently fetching. */
|
|
312
|
+
$isFetching: Store<boolean>;
|
|
313
|
+
/** `true` if **any** query in the family errored. */
|
|
314
|
+
$isError: Store<boolean>;
|
|
315
|
+
/**
|
|
316
|
+
* Triggers a parallel `fetchQuery` for every current source item.
|
|
317
|
+
* SSR-friendly — `await allSettled(family.prefetch, { scope })`
|
|
318
|
+
* returns after every queryFn has resolved (or failed).
|
|
319
|
+
*/
|
|
320
|
+
prefetch: EventCallable<void>;
|
|
321
|
+
/**
|
|
322
|
+
* Increment the per-scope refcount and ensure every observer is
|
|
323
|
+
* subscribed to the QueryClient. Call from `useEffect` (or its
|
|
324
|
+
* effector equivalent). The matching `unmounted()` decrements; when
|
|
325
|
+
* the count hits zero, observers unsubscribe.
|
|
326
|
+
*/
|
|
327
|
+
mounted: EventCallable<void>;
|
|
328
|
+
unmounted: EventCallable<void>;
|
|
329
|
+
/** Invalidates every query in the family — re-fetches in background. */
|
|
330
|
+
refresh: EventCallable<void>;
|
|
331
|
+
/** Invalidates one specific item's query. */
|
|
332
|
+
refreshOne: EventCallable<TItem>;
|
|
333
|
+
/** See {@link QueryResult.$queryClient}. */
|
|
334
|
+
$queryClient: Store<QueryClient | null>;
|
|
335
|
+
/**
|
|
336
|
+
* Discriminator that lets `useQueries` / `useSuspenseQueries` and
|
|
337
|
+
* other helpers distinguish a family from a tuple of factories at
|
|
338
|
+
* runtime. Not part of the public API.
|
|
339
|
+
*/
|
|
340
|
+
readonly __family: true;
|
|
341
|
+
}
|
|
232
342
|
|
|
233
|
-
export type { CreateInfiniteQueryOptions, CreateMutationOptions, CreateQueryOptions, EffectorQueryKey, InfiniteQueryResult, MutationResult, MutationStatus, QueryResult, ResolveQueryKeyElement, ResolvedQueryKey, StoreOrValue };
|
|
343
|
+
export type { CreateInfiniteQueryOptions, CreateMutationOptions, CreateQueriesItemOptions, CreateQueriesOptions, CreateQueryOptions, EffectorQueryKey, InfiniteQueryResult, MutationResult, MutationStatus, QueriesResult, QueryItemState, QueryResult, ResolveQueryKeyElement, ResolvedQueryKey, StoreOrValue };
|
package/dist/types.d.ts
CHANGED
|
@@ -229,5 +229,115 @@ interface MutationResult<TData = unknown, TError = Error, TVariables = void> {
|
|
|
229
229
|
}>;
|
|
230
230
|
};
|
|
231
231
|
}
|
|
232
|
+
/**
|
|
233
|
+
* Per-item snapshot inside a `createQueries` family. Parallel to the
|
|
234
|
+
* factory's `source` array — one entry per item, in source order.
|
|
235
|
+
*/
|
|
236
|
+
interface QueryItemState<TItem, TData, TError = Error> {
|
|
237
|
+
/** The source item this entry was derived from. */
|
|
238
|
+
source: TItem;
|
|
239
|
+
data: TData | undefined;
|
|
240
|
+
error: TError | null;
|
|
241
|
+
status: QueryStatus;
|
|
242
|
+
isPending: boolean;
|
|
243
|
+
isFetching: boolean;
|
|
244
|
+
isSuccess: boolean;
|
|
245
|
+
isError: boolean;
|
|
246
|
+
isPlaceholderData: boolean;
|
|
247
|
+
fetchStatus: FetchStatus;
|
|
248
|
+
}
|
|
249
|
+
/**
|
|
250
|
+
* Per-item query options produced by `createQueries({ query })`. A pure
|
|
251
|
+
* function of one source item — no effector stores, no closures over
|
|
252
|
+
* mutable state. Reactivity comes from the source store; whenever it
|
|
253
|
+
* updates, this callback re-runs to compute fresh options.
|
|
254
|
+
*
|
|
255
|
+
* `enabled` is a plain boolean (not a `Store`) for the same reason —
|
|
256
|
+
* it's derived from the item, so reactivity is already covered.
|
|
257
|
+
*/
|
|
258
|
+
interface CreateQueriesItemOptions<TQueryFnData, TError, TData, TQueryKey extends ReadonlyArray<unknown>> extends Omit<QueryObserverOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>, 'queryKey' | 'enabled'> {
|
|
259
|
+
queryKey: TQueryKey;
|
|
260
|
+
enabled?: boolean;
|
|
261
|
+
}
|
|
262
|
+
interface CreateQueriesOptions<TItem, TQueryFnData = unknown, TError = Error, TData = TQueryFnData, TQueryKey extends ReadonlyArray<unknown> = ReadonlyArray<unknown>> {
|
|
263
|
+
/**
|
|
264
|
+
* Stable name used to derive the SID of the result `$items` store so
|
|
265
|
+
* `serialize(scope)` round-trips it for SSR. Without a name, the
|
|
266
|
+
* QueryClient cache still hydrates via `dehydrate`/`hydrate`, but the
|
|
267
|
+
* `$items` snapshot is silently dropped from `serialize(scope)`.
|
|
268
|
+
*/
|
|
269
|
+
name?: string;
|
|
270
|
+
/**
|
|
271
|
+
* Reactive list of items. Each item becomes one parallel query in the
|
|
272
|
+
* family. Adding / removing items updates the family (spawn / dispose
|
|
273
|
+
* observer). Order is preserved in `$items`.
|
|
274
|
+
*
|
|
275
|
+
* Duplicates in `source` deduplicate observers (same `queryKey` hash)
|
|
276
|
+
* but produce separate `$items` entries — one per occurrence.
|
|
277
|
+
*/
|
|
278
|
+
source: Store<ReadonlyArray<TItem>>;
|
|
279
|
+
/**
|
|
280
|
+
* Per-item options builder. MUST be pure — same item in, same options
|
|
281
|
+
* out. Reactivity is driven by the source store; this callback fires
|
|
282
|
+
* synchronously when source updates.
|
|
283
|
+
*/
|
|
284
|
+
query: (item: TItem) => CreateQueriesItemOptions<TQueryFnData, TError, TData, TQueryKey>;
|
|
285
|
+
/** Shared QueryObserver defaults applied on top of `query(item)`. */
|
|
286
|
+
staleTime?: number;
|
|
287
|
+
gcTime?: number;
|
|
288
|
+
retry?: QueryObserverOptions<TQueryFnData, TError, TData>['retry'];
|
|
289
|
+
retryDelay?: QueryObserverOptions<TQueryFnData, TError, TData>['retryDelay'];
|
|
290
|
+
refetchOnMount?: QueryObserverOptions<TQueryFnData, TError, TData>['refetchOnMount'];
|
|
291
|
+
refetchOnReconnect?: QueryObserverOptions<TQueryFnData, TError, TData>['refetchOnReconnect'];
|
|
292
|
+
refetchOnWindowFocus?: QueryObserverOptions<TQueryFnData, TError, TData>['refetchOnWindowFocus'];
|
|
293
|
+
networkMode?: QueryObserverOptions<TQueryFnData, TError, TData>['networkMode'];
|
|
294
|
+
}
|
|
295
|
+
/**
|
|
296
|
+
* Result of `createQueries(...)`. A reactive "family" of parallel
|
|
297
|
+
* queries indexed by a source store. Composes naturally with
|
|
298
|
+
* `useUnit($items)` for non-Suspense usage and with
|
|
299
|
+
* `useQueries(family)` / `useSuspenseQueries(family)` for React-style
|
|
300
|
+
* consumption.
|
|
301
|
+
*/
|
|
302
|
+
interface QueriesResult<TItem, TData = unknown, TError = Error> {
|
|
303
|
+
/** Per-item snapshots, parallel to `source`. */
|
|
304
|
+
$items: Store<ReadonlyArray<QueryItemState<TItem, TData, TError>>>;
|
|
305
|
+
/** Just the `data` field of `$items` — shortcut for common UIs. */
|
|
306
|
+
$data: Store<ReadonlyArray<TData | undefined>>;
|
|
307
|
+
/** `true` while **any** query in the family is pending. */
|
|
308
|
+
$isPending: Store<boolean>;
|
|
309
|
+
/** `true` only when **every** query in the family has succeeded. */
|
|
310
|
+
$isSuccess: Store<boolean>;
|
|
311
|
+
/** `true` if **any** query in the family is currently fetching. */
|
|
312
|
+
$isFetching: Store<boolean>;
|
|
313
|
+
/** `true` if **any** query in the family errored. */
|
|
314
|
+
$isError: Store<boolean>;
|
|
315
|
+
/**
|
|
316
|
+
* Triggers a parallel `fetchQuery` for every current source item.
|
|
317
|
+
* SSR-friendly — `await allSettled(family.prefetch, { scope })`
|
|
318
|
+
* returns after every queryFn has resolved (or failed).
|
|
319
|
+
*/
|
|
320
|
+
prefetch: EventCallable<void>;
|
|
321
|
+
/**
|
|
322
|
+
* Increment the per-scope refcount and ensure every observer is
|
|
323
|
+
* subscribed to the QueryClient. Call from `useEffect` (or its
|
|
324
|
+
* effector equivalent). The matching `unmounted()` decrements; when
|
|
325
|
+
* the count hits zero, observers unsubscribe.
|
|
326
|
+
*/
|
|
327
|
+
mounted: EventCallable<void>;
|
|
328
|
+
unmounted: EventCallable<void>;
|
|
329
|
+
/** Invalidates every query in the family — re-fetches in background. */
|
|
330
|
+
refresh: EventCallable<void>;
|
|
331
|
+
/** Invalidates one specific item's query. */
|
|
332
|
+
refreshOne: EventCallable<TItem>;
|
|
333
|
+
/** See {@link QueryResult.$queryClient}. */
|
|
334
|
+
$queryClient: Store<QueryClient | null>;
|
|
335
|
+
/**
|
|
336
|
+
* Discriminator that lets `useQueries` / `useSuspenseQueries` and
|
|
337
|
+
* other helpers distinguish a family from a tuple of factories at
|
|
338
|
+
* runtime. Not part of the public API.
|
|
339
|
+
*/
|
|
340
|
+
readonly __family: true;
|
|
341
|
+
}
|
|
232
342
|
|
|
233
|
-
export type { CreateInfiniteQueryOptions, CreateMutationOptions, CreateQueryOptions, EffectorQueryKey, InfiniteQueryResult, MutationResult, MutationStatus, QueryResult, ResolveQueryKeyElement, ResolvedQueryKey, StoreOrValue };
|
|
343
|
+
export type { CreateInfiniteQueryOptions, CreateMutationOptions, CreateQueriesItemOptions, CreateQueriesOptions, CreateQueryOptions, EffectorQueryKey, InfiniteQueryResult, MutationResult, MutationStatus, QueriesResult, QueryItemState, QueryResult, ResolveQueryKeyElement, ResolvedQueryKey, StoreOrValue };
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@effector-tanstack-query/core",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"description": "Effector bindings for TanStack Query — core factories (createQuery, createMutation, createInfiniteQuery)",
|
|
3
|
+
"version": "0.4.0",
|
|
4
|
+
"description": "Effector bindings for TanStack Query — core factories (createQuery, createMutation, createInfiniteQuery, createQueries)",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "Ilya Agarkov <ilya.al.ag@gmail.com>",
|
|
7
7
|
"repository": {
|