@tanstack/angular-query 0.0.0 → 5.0.0-rc.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.
Files changed (77) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +120 -36
  3. package/hydration-state-key.d.ts +4 -0
  4. package/hydration-state-key.mjs +14 -0
  5. package/hydration-state-key.mjs.map +1 -0
  6. package/index.d.ts +22 -0
  7. package/index.mjs +32 -0
  8. package/index.mjs.map +1 -0
  9. package/infinite-query-options.d.ts +216 -0
  10. package/infinite-query-options.mjs +7 -0
  11. package/infinite-query-options.mjs.map +1 -0
  12. package/inject-base-query.d.ts +5 -0
  13. package/inject-base-query.mjs +64 -0
  14. package/inject-base-query.mjs.map +1 -0
  15. package/inject-infinite-query.d.ts +67 -0
  16. package/inject-infinite-query.mjs +38 -0
  17. package/inject-infinite-query.mjs.map +1 -0
  18. package/inject-is-fetching.d.ts +11 -0
  19. package/inject-is-fetching.mjs +18 -0
  20. package/inject-is-fetching.mjs.map +1 -0
  21. package/inject-is-mutating.d.ts +11 -0
  22. package/inject-is-mutating.mjs +18 -0
  23. package/inject-is-mutating.mjs.map +1 -0
  24. package/inject-is-restoring.d.ts +13 -0
  25. package/inject-is-restoring.mjs +21 -0
  26. package/inject-is-restoring.mjs.map +1 -0
  27. package/inject-mutation-state.d.ts +16 -0
  28. package/inject-mutation-state.mjs +28 -0
  29. package/inject-mutation-state.mjs.map +1 -0
  30. package/inject-mutation.d.ts +32 -0
  31. package/inject-mutation.mjs +72 -0
  32. package/inject-mutation.mjs.map +1 -0
  33. package/inject-queries.d.ts +35 -0
  34. package/inject-queries.mjs +120 -0
  35. package/inject-queries.mjs.map +1 -0
  36. package/inject-queries.types.d.ts +109 -0
  37. package/inject-query.d.ts +127 -0
  38. package/inject-query.mjs +20 -0
  39. package/inject-query.mjs.map +1 -0
  40. package/internal.d.ts +8 -0
  41. package/internal.mjs +8 -0
  42. package/internal.mjs.map +1 -0
  43. package/mutation-options.d.ts +84 -0
  44. package/mutation-options.mjs +7 -0
  45. package/mutation-options.mjs.map +1 -0
  46. package/package.json +52 -4
  47. package/providers.d.ts +83 -0
  48. package/providers.mjs +89 -0
  49. package/providers.mjs.map +1 -0
  50. package/query-options.d.ts +208 -0
  51. package/query-options.mjs +7 -0
  52. package/query-options.mjs.map +1 -0
  53. package/query-resource.d.ts +36 -0
  54. package/query-resource.mjs +70 -0
  55. package/query-resource.mjs.map +1 -0
  56. package/schematics/collection.json +10 -0
  57. package/schematics/ng-add/index.js +96 -0
  58. package/schematics/ng-add/schema.js +2 -0
  59. package/schematics/ng-add/schema.json +17 -0
  60. package/schematics/package.json +3 -0
  61. package/types.d.ts +164 -0
  62. package/utils/inject-external-store.d.ts +33 -0
  63. package/utils/inject-external-store.mjs +41 -0
  64. package/utils/inject-external-store.mjs.map +1 -0
  65. package/utils/inject-pending-tasks-lifecycle.d.ts +6 -0
  66. package/utils/inject-pending-tasks-lifecycle.mjs +31 -0
  67. package/utils/inject-pending-tasks-lifecycle.mjs.map +1 -0
  68. package/utils/inject-query-zone.d.ts +2 -0
  69. package/utils/inject-query-zone.mjs +9 -0
  70. package/utils/inject-query-zone.mjs.map +1 -0
  71. package/utils/resource-types.d.ts +8 -0
  72. package/utils/result-fields.d.ts +80 -0
  73. package/utils/result-fields.mjs +65 -0
  74. package/utils/result-fields.mjs.map +1 -0
  75. package/utils/signal-proxy.d.ts +20 -0
  76. package/utils/signal-proxy.mjs +12 -0
  77. package/utils/signal-proxy.mjs.map +1 -0
@@ -0,0 +1,67 @@
1
+ import { DefaultError, InfiniteData, QueryKey } from '@tanstack/query-core';
2
+ import { CreateInfiniteQueryOptions, CreateInfiniteQueryResult, DefinedCreateInfiniteQueryResult } from './types.js';
3
+ import { DefinedInitialDataInfiniteOptions, UndefinedInitialDataInfiniteOptions } from './infinite-query-options.js';
4
+ /**
5
+ * This overload is selected when `initialData` is set, so the resulting `data` signal is never `undefined`
6
+ * (unless a `select` changes `TData` to include `undefined`).
7
+ *
8
+ * @see https://tanstack.com/query/latest/docs/framework/angular/guides/infinite-queries
9
+ * @see {@link infiniteQueryOptions} to share these options between `injectInfiniteQuery` and
10
+ * `queryClient.infiniteQuery`.
11
+ * @param optionsFn - A function returning infinite-query options with `initialData` set. Similar to
12
+ * `computed` from Angular, this function runs in the reactive context.
13
+ * @returns The infinite query result, typed so that `data` is never `undefined`.
14
+ */
15
+ export declare function injectInfiniteQuery<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(optionsFn: () => DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): DefinedCreateInfiniteQueryResult<TData, TError>;
16
+ /**
17
+ * Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
18
+ * Infinite queries can additively "load more" data onto an existing set of data or support infinite scroll.
19
+ *
20
+ * @see https://tanstack.com/query/latest/docs/framework/angular/guides/infinite-queries
21
+ * @see {@link infiniteQueryOptions} to share these options between `injectInfiniteQuery` and
22
+ * `queryClient.infiniteQuery`.
23
+ * @param optionsFn - A function that returns infinite query options. Similar to `computed` from Angular,
24
+ * this function runs in the reactive context, so signals read inside it drive the query.
25
+ * @returns The infinite query result.
26
+ *
27
+ * @example
28
+ * ```angular-ts
29
+ * @Component({
30
+ * selector: 'projects',
31
+ * template: `
32
+ * @if (query.isPending()) {
33
+ * Loading...
34
+ * } @else if (query.isError()) {
35
+ * <span>Error: {{ query.error()?.message }}</span>
36
+ * } @else {
37
+ * @for (page of query.data().pages; track $index) {
38
+ * @for (project of page; track project.id) {
39
+ * <p>{{ project.name }}</p>
40
+ * }
41
+ * }
42
+ * <button (click)="query.fetchNextPage()">Load more</button>
43
+ * }
44
+ * `,
45
+ * })
46
+ * export class Projects {
47
+ * readonly query = injectInfiniteQuery(() => ({
48
+ * queryKey: ['projects'],
49
+ * queryFn: ({ pageParam }) => fetchProjects(pageParam),
50
+ * initialPageParam: 0,
51
+ * getNextPageParam: (lastPage) => lastPage.nextCursor,
52
+ * }))
53
+ * }
54
+ * ```
55
+ */
56
+ export declare function injectInfiniteQuery<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(optionsFn: () => UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): CreateInfiniteQueryResult<TData, TError>;
57
+ /**
58
+ * This overload accepts the general {@link CreateInfiniteQueryOptions} shape rather than the
59
+ * `initialData`-aware overloads above, so whether `data` is defined can't be inferred from the call
60
+ * site — useful when wrapping `injectInfiniteQuery` in your own helper.
61
+ *
62
+ * @see https://tanstack.com/query/latest/docs/framework/angular/guides/infinite-queries
63
+ * @param optionsFn - A function that returns infinite query options. Similar to `computed` from Angular,
64
+ * this function runs in the reactive context, so signals read inside it drive the query.
65
+ * @returns The infinite query result.
66
+ */
67
+ export declare function injectInfiniteQuery<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(optionsFn: () => CreateInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): CreateInfiniteQueryResult<TData, TError>;
@@ -0,0 +1,38 @@
1
+ import { InfiniteQueryObserver } from "@tanstack/query-core";
2
+ import { assertInInjectionContext, untracked } from "@angular/core";
3
+ import { injectQueryZone } from "./utils/inject-query-zone.mjs";
4
+ import { injectBaseQuery } from "./inject-base-query.mjs";
5
+ import { signalProxy } from "./utils/signal-proxy.mjs";
6
+ import { infiniteQueryResultFields } from "./utils/result-fields.mjs";
7
+ function injectInfiniteQuery(optionsFn) {
8
+ if (typeof ngDevMode === "undefined" || ngDevMode) {
9
+ assertInInjectionContext(injectInfiniteQuery);
10
+ }
11
+ const outsideZone = injectQueryZone();
12
+ const [resultSignal, getObserver] = injectBaseQuery(
13
+ optionsFn,
14
+ InfiniteQueryObserver
15
+ );
16
+ const getInfiniteObserver = () => getObserver();
17
+ return Object.assign(
18
+ signalProxy(
19
+ resultSignal,
20
+ infiniteQueryResultFields
21
+ ),
22
+ {
23
+ refetch: (options) => outsideZone(
24
+ () => untracked(() => getInfiniteObserver().refetch(options))
25
+ ),
26
+ fetchNextPage: (options) => outsideZone(
27
+ () => untracked(() => getInfiniteObserver().fetchNextPage(options))
28
+ ),
29
+ fetchPreviousPage: (options) => outsideZone(
30
+ () => untracked(() => getInfiniteObserver().fetchPreviousPage(options))
31
+ )
32
+ }
33
+ );
34
+ }
35
+ export {
36
+ injectInfiniteQuery
37
+ };
38
+ //# sourceMappingURL=inject-infinite-query.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"inject-infinite-query.mjs","sources":["../src/inject-infinite-query.ts"],"sourcesContent":["import { InfiniteQueryObserver } from '@tanstack/query-core'\nimport { assertInInjectionContext, untracked } from '@angular/core'\nimport { injectQueryZone } from './utils/inject-query-zone'\nimport { injectBaseQuery } from './inject-base-query'\nimport { signalProxy } from './utils/signal-proxy'\nimport { infiniteQueryResultFields } from './utils/result-fields'\nimport type {\n DefaultError,\n FetchNextPageOptions,\n FetchPreviousPageOptions,\n InfiniteData,\n InfiniteQueryObserverResult,\n QueryKey,\n QueryObserver,\n RefetchOptions,\n} from '@tanstack/query-core'\nimport type { Signal } from '@angular/core'\nimport type {\n CreateInfiniteQueryOptions,\n CreateInfiniteQueryResult,\n DefinedCreateInfiniteQueryResult,\n} from './types'\nimport type {\n DefinedInitialDataInfiniteOptions,\n UndefinedInitialDataInfiniteOptions,\n} from './infinite-query-options'\n\n/**\n * This overload is selected when `initialData` is set, so the resulting `data` signal is never `undefined`\n * (unless a `select` changes `TData` to include `undefined`).\n *\n * @see https://tanstack.com/query/latest/docs/framework/angular/guides/infinite-queries\n * @see {@link infiniteQueryOptions} to share these options between `injectInfiniteQuery` and\n * `queryClient.infiniteQuery`.\n * @param optionsFn - A function returning infinite-query options with `initialData` set. Similar to\n * `computed` from Angular, this function runs in the reactive context.\n * @returns The infinite query result, typed so that `data` is never `undefined`.\n */\nexport function injectInfiniteQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = InfiniteData<TQueryFnData>,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n>(\n optionsFn: () => DefinedInitialDataInfiniteOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >,\n): DefinedCreateInfiniteQueryResult<TData, TError>\n\n/**\n * Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key.\n * Infinite queries can additively \"load more\" data onto an existing set of data or support infinite scroll.\n *\n * @see https://tanstack.com/query/latest/docs/framework/angular/guides/infinite-queries\n * @see {@link infiniteQueryOptions} to share these options between `injectInfiniteQuery` and\n * `queryClient.infiniteQuery`.\n * @param optionsFn - A function that returns infinite query options. Similar to `computed` from Angular,\n * this function runs in the reactive context, so signals read inside it drive the query.\n * @returns The infinite query result.\n *\n * @example\n * ```angular-ts\n * @Component({\n * selector: 'projects',\n * template: `\n * @if (query.isPending()) {\n * Loading...\n * } @else if (query.isError()) {\n * <span>Error: {{ query.error()?.message }}</span>\n * } @else {\n * @for (page of query.data().pages; track $index) {\n * @for (project of page; track project.id) {\n * <p>{{ project.name }}</p>\n * }\n * }\n * <button (click)=\"query.fetchNextPage()\">Load more</button>\n * }\n * `,\n * })\n * export class Projects {\n * readonly query = injectInfiniteQuery(() => ({\n * queryKey: ['projects'],\n * queryFn: ({ pageParam }) => fetchProjects(pageParam),\n * initialPageParam: 0,\n * getNextPageParam: (lastPage) => lastPage.nextCursor,\n * }))\n * }\n * ```\n */\nexport function injectInfiniteQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = InfiniteData<TQueryFnData>,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n>(\n optionsFn: () => UndefinedInitialDataInfiniteOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >,\n): CreateInfiniteQueryResult<TData, TError>\n\n/**\n * This overload accepts the general {@link CreateInfiniteQueryOptions} shape rather than the\n * `initialData`-aware overloads above, so whether `data` is defined can't be inferred from the call\n * site — useful when wrapping `injectInfiniteQuery` in your own helper.\n *\n * @see https://tanstack.com/query/latest/docs/framework/angular/guides/infinite-queries\n * @param optionsFn - A function that returns infinite query options. Similar to `computed` from Angular,\n * this function runs in the reactive context, so signals read inside it drive the query.\n * @returns The infinite query result.\n */\nexport function injectInfiniteQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = InfiniteData<TQueryFnData>,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n>(\n optionsFn: () => CreateInfiniteQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >,\n): CreateInfiniteQueryResult<TData, TError>\n\nexport function injectInfiniteQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = InfiniteData<TQueryFnData>,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n>(\n optionsFn: () =>\n | DefinedInitialDataInfiniteOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >\n | CreateInfiniteQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >,\n):\n | DefinedCreateInfiniteQueryResult<TData, TError>\n | CreateInfiniteQueryResult<TData, TError> {\n if (typeof ngDevMode === 'undefined' || ngDevMode) {\n assertInInjectionContext(injectInfiniteQuery)\n }\n const outsideZone = injectQueryZone()\n const [resultSignal, getObserver] = injectBaseQuery(\n optionsFn,\n InfiniteQueryObserver as typeof QueryObserver,\n )\n const getInfiniteObserver = () =>\n getObserver() as InfiniteQueryObserver<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >\n return Object.assign(\n signalProxy(\n resultSignal as Signal<InfiniteQueryObserverResult<TData, TError>>,\n infiniteQueryResultFields,\n ),\n {\n refetch: (options?: RefetchOptions) =>\n outsideZone(() =>\n untracked(() => getInfiniteObserver().refetch(options)),\n ),\n fetchNextPage: (options?: FetchNextPageOptions) =>\n outsideZone(() =>\n untracked(() => getInfiniteObserver().fetchNextPage(options)),\n ),\n fetchPreviousPage: (options?: FetchPreviousPageOptions) =>\n outsideZone(() =>\n untracked(() => getInfiniteObserver().fetchPreviousPage(options)),\n ),\n },\n ) as unknown as\n | DefinedCreateInfiniteQueryResult<TData, TError>\n | CreateInfiniteQueryResult<TData, TError>\n}\n"],"names":[],"mappings":";;;;;;AAwIO,SAAS,oBAOd,WAiB2C;AAC3C,MAAI,OAAO,cAAc,eAAe,WAAW;AACjD,6BAAyB,mBAAmB;AAAA,EAC9C;AACA,QAAM,cAAc,gBAAA;AACpB,QAAM,CAAC,cAAc,WAAW,IAAI;AAAA,IAClC;AAAA,IACA;AAAA,EAAA;AAEF,QAAM,sBAAsB,MAC1B,YAAA;AAOF,SAAO,OAAO;AAAA,IACZ;AAAA,MACE;AAAA,MACA;AAAA,IAAA;AAAA,IAEF;AAAA,MACE,SAAS,CAAC,YACR;AAAA,QAAY,MACV,UAAU,MAAM,sBAAsB,QAAQ,OAAO,CAAC;AAAA,MAAA;AAAA,MAE1D,eAAe,CAAC,YACd;AAAA,QAAY,MACV,UAAU,MAAM,sBAAsB,cAAc,OAAO,CAAC;AAAA,MAAA;AAAA,MAEhE,mBAAmB,CAAC,YAClB;AAAA,QAAY,MACV,UAAU,MAAM,sBAAsB,kBAAkB,OAAO,CAAC;AAAA,MAAA;AAAA,IAClE;AAAA,EACJ;AAIJ;"}
@@ -0,0 +1,11 @@
1
+ import { QueryFilters } from '@tanstack/query-core';
2
+ import { Signal } from '@angular/core';
3
+ /**
4
+ * Injects a signal that tracks the number of queries that your application is loading or fetching in the
5
+ * background (useful for app-wide loading indicators).
6
+ *
7
+ * Can be used for app-wide loading indicators
8
+ * @param filters - A reactive factory for the filters.
9
+ * @returns signal with number of loading or fetching queries.
10
+ */
11
+ export declare function injectIsFetching(filters?: () => QueryFilters): Signal<number>;
@@ -0,0 +1,18 @@
1
+ import { assertInInjectionContext, inject } from "@angular/core";
2
+ import { QueryClient } from "@tanstack/query-core";
3
+ import { injectExternalStore } from "./utils/inject-external-store.mjs";
4
+ function injectIsFetching(filters = () => ({})) {
5
+ if (typeof ngDevMode === "undefined" || ngDevMode) {
6
+ assertInInjectionContext(injectIsFetching);
7
+ }
8
+ const queryClient = inject(QueryClient);
9
+ const cache = queryClient.getQueryCache();
10
+ return injectExternalStore(() => ({
11
+ getSnapshot: () => queryClient.isFetching(filters()),
12
+ subscribe: (onStoreChange) => cache.subscribe(onStoreChange)
13
+ }));
14
+ }
15
+ export {
16
+ injectIsFetching
17
+ };
18
+ //# sourceMappingURL=inject-is-fetching.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"inject-is-fetching.mjs","sources":["../src/inject-is-fetching.ts"],"sourcesContent":["import { assertInInjectionContext, inject } from '@angular/core'\nimport { QueryClient } from '@tanstack/query-core'\nimport { injectExternalStore } from './utils/inject-external-store'\nimport type { QueryFilters } from '@tanstack/query-core'\nimport type { Signal } from '@angular/core'\n\n/**\n * Injects a signal that tracks the number of queries that your application is loading or fetching in the\n * background (useful for app-wide loading indicators).\n *\n * Can be used for app-wide loading indicators\n * @param filters - A reactive factory for the filters.\n * @returns signal with number of loading or fetching queries.\n */\nexport function injectIsFetching(\n filters: () => QueryFilters = () => ({}),\n): Signal<number> {\n if (typeof ngDevMode === 'undefined' || ngDevMode) {\n assertInInjectionContext(injectIsFetching)\n }\n const queryClient = inject(QueryClient)\n const cache = queryClient.getQueryCache()\n\n return injectExternalStore(() => ({\n getSnapshot: () => queryClient.isFetching(filters()),\n subscribe: (onStoreChange) => cache.subscribe(onStoreChange),\n }))\n}\n"],"names":[],"mappings":";;;AAcO,SAAS,iBACd,UAA8B,OAAO,CAAA,IACrB;AAChB,MAAI,OAAO,cAAc,eAAe,WAAW;AACjD,6BAAyB,gBAAgB;AAAA,EAC3C;AACA,QAAM,cAAc,OAAO,WAAW;AACtC,QAAM,QAAQ,YAAY,cAAA;AAE1B,SAAO,oBAAoB,OAAO;AAAA,IAChC,aAAa,MAAM,YAAY,WAAW,SAAS;AAAA,IACnD,WAAW,CAAC,kBAAkB,MAAM,UAAU,aAAa;AAAA,EAAA,EAC3D;AACJ;"}
@@ -0,0 +1,11 @@
1
+ import { MutationFilters } from '@tanstack/query-core';
2
+ import { Signal } from '@angular/core';
3
+ /**
4
+ * Injects a signal that tracks the number of mutations that your application currently has `pending`
5
+ * (useful for app-wide loading indicators).
6
+ *
7
+ * Can be used for app-wide loading indicators
8
+ * @param filters - A reactive factory for the filters.
9
+ * @returns A read-only signal with the number of fetching mutations.
10
+ */
11
+ export declare function injectIsMutating(filters?: () => MutationFilters): Signal<number>;
@@ -0,0 +1,18 @@
1
+ import { assertInInjectionContext, inject } from "@angular/core";
2
+ import { QueryClient } from "@tanstack/query-core";
3
+ import { injectExternalStore } from "./utils/inject-external-store.mjs";
4
+ function injectIsMutating(filters = () => ({})) {
5
+ if (typeof ngDevMode === "undefined" || ngDevMode) {
6
+ assertInInjectionContext(injectIsMutating);
7
+ }
8
+ const queryClient = inject(QueryClient);
9
+ const cache = queryClient.getMutationCache();
10
+ return injectExternalStore(() => ({
11
+ getSnapshot: () => queryClient.isMutating(filters()),
12
+ subscribe: (onStoreChange) => cache.subscribe(onStoreChange)
13
+ }));
14
+ }
15
+ export {
16
+ injectIsMutating
17
+ };
18
+ //# sourceMappingURL=inject-is-mutating.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"inject-is-mutating.mjs","sources":["../src/inject-is-mutating.ts"],"sourcesContent":["import { assertInInjectionContext, inject } from '@angular/core'\nimport { QueryClient } from '@tanstack/query-core'\nimport { injectExternalStore } from './utils/inject-external-store'\nimport type { MutationFilters } from '@tanstack/query-core'\nimport type { Signal } from '@angular/core'\n\n/**\n * Injects a signal that tracks the number of mutations that your application currently has `pending`\n * (useful for app-wide loading indicators).\n *\n * Can be used for app-wide loading indicators\n * @param filters - A reactive factory for the filters.\n * @returns A read-only signal with the number of fetching mutations.\n */\nexport function injectIsMutating(\n filters: () => MutationFilters = () => ({}),\n): Signal<number> {\n if (typeof ngDevMode === 'undefined' || ngDevMode) {\n assertInInjectionContext(injectIsMutating)\n }\n const queryClient = inject(QueryClient)\n const cache = queryClient.getMutationCache()\n\n return injectExternalStore(() => ({\n getSnapshot: () => queryClient.isMutating(filters()),\n subscribe: (onStoreChange) => cache.subscribe(onStoreChange),\n }))\n}\n"],"names":[],"mappings":";;;AAcO,SAAS,iBACd,UAAiC,OAAO,CAAA,IACxB;AAChB,MAAI,OAAO,cAAc,eAAe,WAAW;AACjD,6BAAyB,gBAAgB;AAAA,EAC3C;AACA,QAAM,cAAc,OAAO,WAAW;AACtC,QAAM,QAAQ,YAAY,iBAAA;AAE1B,SAAO,oBAAoB,OAAO;AAAA,IAChC,aAAa,MAAM,YAAY,WAAW,SAAS;AAAA,IACnD,WAAW,CAAC,kBAAkB,MAAM,UAAU,aAAa;AAAA,EAAA,EAC3D;AACJ;"}
@@ -0,0 +1,13 @@
1
+ import { Provider, Signal } from '@angular/core';
2
+ /**
3
+ * Injects a readonly signal that is true while the persistence integration restores
4
+ * cached query data. Returns false when no restoration is in progress.
5
+ * @returns The current restoration state.
6
+ */
7
+ export declare function injectIsRestoring(): Signal<boolean>;
8
+ /**
9
+ * Supplies injector-scoped restoration state to the Angular Query integrations.
10
+ * The factory runs once in Angular's injection context.
11
+ * @internal
12
+ */
13
+ export declare function provideIsRestoring(isRestoringFactory: () => Signal<boolean>): Provider;
@@ -0,0 +1,21 @@
1
+ import { assertInInjectionContext, inject, InjectionToken, signal } from "@angular/core";
2
+ const IS_RESTORING = new InjectionToken("", {
3
+ factory: () => signal(false).asReadonly()
4
+ });
5
+ function injectIsRestoring() {
6
+ if (typeof ngDevMode === "undefined" || ngDevMode) {
7
+ assertInInjectionContext(injectIsRestoring);
8
+ }
9
+ return inject(IS_RESTORING);
10
+ }
11
+ function provideIsRestoring(isRestoringFactory) {
12
+ return {
13
+ provide: IS_RESTORING,
14
+ useFactory: isRestoringFactory
15
+ };
16
+ }
17
+ export {
18
+ injectIsRestoring,
19
+ provideIsRestoring
20
+ };
21
+ //# sourceMappingURL=inject-is-restoring.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"inject-is-restoring.mjs","sources":["../src/inject-is-restoring.ts"],"sourcesContent":["import {\n InjectionToken,\n assertInInjectionContext,\n inject,\n signal,\n} from '@angular/core'\nimport type { Provider, Signal } from '@angular/core'\n\n/**\n * Internal token used to track isRestoring state, accessible in public API through `injectIsRestoring` and set via `provideIsRestoring`\n */\nconst IS_RESTORING = new InjectionToken('', {\n factory: () => signal(false).asReadonly(),\n})\n\n/**\n * Injects a readonly signal that is true while the persistence integration restores\n * cached query data. Returns false when no restoration is in progress.\n * @returns The current restoration state.\n */\nexport function injectIsRestoring() {\n if (typeof ngDevMode === 'undefined' || ngDevMode) {\n assertInInjectionContext(injectIsRestoring)\n }\n return inject(IS_RESTORING)\n}\n\n/**\n * Supplies injector-scoped restoration state to the Angular Query integrations.\n * The factory runs once in Angular's injection context.\n * @internal\n */\nexport function provideIsRestoring(\n isRestoringFactory: () => Signal<boolean>,\n): Provider {\n return {\n provide: IS_RESTORING,\n useFactory: isRestoringFactory,\n }\n}\n"],"names":[],"mappings":";AAWA,MAAM,eAAe,IAAI,eAAe,IAAI;AAAA,EAC1C,SAAS,MAAM,OAAO,KAAK,EAAE,WAAA;AAC/B,CAAC;AAOM,SAAS,oBAAoB;AAClC,MAAI,OAAO,cAAc,eAAe,WAAW;AACjD,6BAAyB,iBAAiB;AAAA,EAC5C;AACA,SAAO,OAAO,YAAY;AAC5B;AAOO,SAAS,mBACd,oBACU;AACV,SAAO;AAAA,IACL,SAAS;AAAA,IACT,YAAY;AAAA,EAAA;AAEhB;"}
@@ -0,0 +1,16 @@
1
+ import { Signal } from '@angular/core';
2
+ import { Mutation, MutationFilters, MutationState } from '@tanstack/query-core';
3
+ type MutationTypeFromResult<TResult> = [TResult] extends [
4
+ MutationState<infer TData, infer TError, infer TVariables, infer TOnMutateResult>
5
+ ] ? Mutation<TData, TError, TVariables, TOnMutateResult> : Mutation;
6
+ export type MutationStateOptions<TResult = MutationState, TMutation extends Mutation<any, any, any, any> = MutationTypeFromResult<TResult>> = {
7
+ filters?: MutationFilters;
8
+ select?: (mutation: TMutation) => TResult;
9
+ };
10
+ /**
11
+ * Injects a signal that tracks the state of all mutations.
12
+ * @param options - A function that returns mutation state options.
13
+ * @returns The signal that tracks the state of all mutations.
14
+ */
15
+ export declare function injectMutationState<TResult = MutationState, TMutation extends Mutation<any, any, any, any> = MutationTypeFromResult<TResult>>(options?: () => MutationStateOptions<TResult, TMutation>): Signal<Array<TResult>>;
16
+ export {};
@@ -0,0 +1,28 @@
1
+ import { assertInInjectionContext, inject } from "@angular/core";
2
+ import { QueryClient } from "@tanstack/query-core";
3
+ import { injectExternalStore } from "./utils/inject-external-store.mjs";
4
+ function getResult(mutationCache, options) {
5
+ return mutationCache.findAll(options.filters).map(
6
+ (mutation) => options.select ? options.select(mutation) : mutation.state
7
+ );
8
+ }
9
+ function injectMutationState(options = () => ({})) {
10
+ if (typeof ngDevMode === "undefined" || ngDevMode) {
11
+ assertInInjectionContext(injectMutationState);
12
+ }
13
+ const queryClient = inject(QueryClient);
14
+ const mutationCache = queryClient.getMutationCache();
15
+ return injectExternalStore(
16
+ () => ({
17
+ getSnapshot: () => getResult(mutationCache, options()),
18
+ subscribe: (onStoreChange) => mutationCache.subscribe(onStoreChange)
19
+ }),
20
+ {
21
+ equal: (previous, next) => previous.length === next.length && previous.every((value, index) => Object.is(value, next[index]))
22
+ }
23
+ );
24
+ }
25
+ export {
26
+ injectMutationState
27
+ };
28
+ //# sourceMappingURL=inject-mutation-state.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"inject-mutation-state.mjs","sources":["../src/inject-mutation-state.ts"],"sourcesContent":["import { assertInInjectionContext, inject } from '@angular/core'\nimport { QueryClient } from '@tanstack/query-core'\nimport { injectExternalStore } from './utils/inject-external-store'\nimport type { Signal } from '@angular/core'\nimport type {\n Mutation,\n MutationCache,\n MutationFilters,\n MutationState,\n} from '@tanstack/query-core'\n\ntype MutationTypeFromResult<TResult> = [TResult] extends [\n MutationState<\n infer TData,\n infer TError,\n infer TVariables,\n infer TOnMutateResult\n >,\n]\n ? Mutation<TData, TError, TVariables, TOnMutateResult>\n : Mutation\n\nexport type MutationStateOptions<\n TResult = MutationState,\n TMutation extends Mutation<any, any, any, any> =\n MutationTypeFromResult<TResult>,\n> = {\n filters?: MutationFilters\n select?: (mutation: TMutation) => TResult\n}\n\nfunction getResult<\n TResult = MutationState,\n TMutation extends Mutation<any, any, any, any> =\n MutationTypeFromResult<TResult>,\n>(\n mutationCache: MutationCache,\n options: MutationStateOptions<TResult, TMutation>,\n): Array<TResult> {\n return mutationCache\n .findAll(options.filters)\n .map(\n (mutation): TResult =>\n (options.select\n ? options.select(mutation as TMutation)\n : mutation.state) as TResult,\n )\n}\n\n/**\n * Injects a signal that tracks the state of all mutations.\n * @param options - A function that returns mutation state options.\n * @returns The signal that tracks the state of all mutations.\n */\nexport function injectMutationState<\n TResult = MutationState,\n TMutation extends Mutation<any, any, any, any> =\n MutationTypeFromResult<TResult>,\n>(\n options: () => MutationStateOptions<TResult, TMutation> = () => ({}),\n): Signal<Array<TResult>> {\n if (typeof ngDevMode === 'undefined' || ngDevMode) {\n assertInInjectionContext(injectMutationState)\n }\n const queryClient = inject(QueryClient)\n const mutationCache = queryClient.getMutationCache()\n\n return injectExternalStore(\n () => ({\n getSnapshot: () => getResult(mutationCache, options()),\n subscribe: (onStoreChange) => mutationCache.subscribe(onStoreChange),\n }),\n {\n equal: (previous, next) =>\n previous.length === next.length &&\n previous.every((value, index) => Object.is(value, next[index])),\n },\n )\n}\n"],"names":[],"mappings":";;;AA+BA,SAAS,UAKP,eACA,SACgB;AAChB,SAAO,cACJ,QAAQ,QAAQ,OAAO,EACvB;AAAA,IACC,CAAC,aACE,QAAQ,SACL,QAAQ,OAAO,QAAqB,IACpC,SAAS;AAAA,EAAA;AAErB;AAOO,SAAS,oBAKd,UAA0D,OAAO,CAAA,IACzC;AACxB,MAAI,OAAO,cAAc,eAAe,WAAW;AACjD,6BAAyB,mBAAmB;AAAA,EAC9C;AACA,QAAM,cAAc,OAAO,WAAW;AACtC,QAAM,gBAAgB,YAAY,iBAAA;AAElC,SAAO;AAAA,IACL,OAAO;AAAA,MACL,aAAa,MAAM,UAAU,eAAe,SAAS;AAAA,MACrD,WAAW,CAAC,kBAAkB,cAAc,UAAU,aAAa;AAAA,IAAA;AAAA,IAErE;AAAA,MACE,OAAO,CAAC,UAAU,SAChB,SAAS,WAAW,KAAK,UACzB,SAAS,MAAM,CAAC,OAAO,UAAU,OAAO,GAAG,OAAO,KAAK,KAAK,CAAC,CAAC;AAAA,IAAA;AAAA,EAClE;AAEJ;"}
@@ -0,0 +1,32 @@
1
+ import { DefaultError } from '@tanstack/query-core';
2
+ import { CreateMutationOptions, CreateMutationResult } from './types.js';
3
+ /**
4
+ * Injects a mutation: an imperative function that can be invoked which typically performs server side effects.
5
+ * Unlike queries, mutations are not run automatically.
6
+ *
7
+ * @see https://tanstack.com/query/latest/docs/framework/angular/guides/mutations
8
+ * @see {@link mutationOptions} to share these options between `injectMutation` and `injectMutationState`.
9
+ * @param optionsFn - A function that returns mutation options. Similar to `computed` from Angular, this
10
+ * function runs in the reactive context, so signals read inside it drive the mutation.
11
+ * @returns The mutation result, including `mutate` and `mutateAsync`.
12
+ *
13
+ * @example
14
+ * ```angular-ts
15
+ * @Component({
16
+ * template: `
17
+ * @if (mutation.isPending()) {
18
+ * Saving...
19
+ * } @else if (mutation.isError()) {
20
+ * <span>Error: {{ mutation.error()?.message }}</span>
21
+ * }
22
+ * <button (click)="mutation.mutate({ title: 'New post' })">Create</button>
23
+ * `,
24
+ * })
25
+ * export class CreatePost {
26
+ * readonly mutation = injectMutation(() => ({
27
+ * mutationFn: createPost,
28
+ * }))
29
+ * }
30
+ * ```
31
+ */
32
+ export declare function injectMutation<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown>(optionsFn: () => CreateMutationOptions<TData, TError, TVariables, TOnMutateResult>): CreateMutationResult<TData, TError, TVariables, TOnMutateResult>;
@@ -0,0 +1,72 @@
1
+ import { assertInInjectionContext, inject, computed, untracked, effect } from "@angular/core";
2
+ import { QueryClient, MutationObserver, noop } from "@tanstack/query-core";
3
+ import { injectQueryZone } from "./utils/inject-query-zone.mjs";
4
+ import { signalProxy } from "./utils/signal-proxy.mjs";
5
+ import { mutationResultFields } from "./utils/result-fields.mjs";
6
+ import { injectPendingTasksLifecycle } from "./utils/inject-pending-tasks-lifecycle.mjs";
7
+ import { injectExternalStore } from "./utils/inject-external-store.mjs";
8
+ function injectMutation(optionsFn) {
9
+ if (typeof ngDevMode === "undefined" || ngDevMode) {
10
+ assertInInjectionContext(injectMutation);
11
+ }
12
+ const outsideZone = injectQueryZone();
13
+ const queryClient = inject(QueryClient);
14
+ const lifecycle = injectPendingTasksLifecycle();
15
+ const optionsSignal = computed(optionsFn);
16
+ const observerSignal = computed(
17
+ () => new MutationObserver(queryClient, untracked(optionsSignal))
18
+ );
19
+ effect(() => {
20
+ const options = optionsSignal();
21
+ outsideZone(() => untracked(() => observerSignal().setOptions(options)));
22
+ });
23
+ const mutationStateSignal = injectExternalStore(() => {
24
+ const observer = observerSignal();
25
+ return {
26
+ getSnapshot: () => observer.getCurrentResult(),
27
+ subscribe: (onStoreChange) => observer.subscribe(onStoreChange)
28
+ };
29
+ });
30
+ const mutate = (...args) => {
31
+ mutateAsync(...args).catch(noop);
32
+ };
33
+ let pendingInvocations = 0;
34
+ const mutateAsync = (...args) => {
35
+ return outsideZone(
36
+ () => untracked(() => {
37
+ const observer = observerSignal();
38
+ observer.setOptions(optionsSignal());
39
+ pendingInvocations++;
40
+ lifecycle.setPending(true);
41
+ const settled = () => {
42
+ pendingInvocations--;
43
+ lifecycle.setPending(pendingInvocations > 0);
44
+ };
45
+ try {
46
+ return observer.mutate(args[0], args[1]).finally(settled);
47
+ } catch (error) {
48
+ settled();
49
+ throw error;
50
+ }
51
+ })
52
+ );
53
+ };
54
+ const reset = () => {
55
+ outsideZone(
56
+ () => untracked(() => {
57
+ const observer = observerSignal();
58
+ observer.setOptions(optionsSignal());
59
+ observer.reset();
60
+ })
61
+ );
62
+ };
63
+ return Object.assign(signalProxy(mutationStateSignal, mutationResultFields), {
64
+ mutate,
65
+ mutateAsync,
66
+ reset
67
+ });
68
+ }
69
+ export {
70
+ injectMutation
71
+ };
72
+ //# sourceMappingURL=inject-mutation.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"inject-mutation.mjs","sources":["../src/inject-mutation.ts"],"sourcesContent":["import {\n assertInInjectionContext,\n computed,\n effect,\n inject,\n untracked,\n} from '@angular/core'\nimport { MutationObserver, QueryClient, noop } from '@tanstack/query-core'\nimport { injectQueryZone } from './utils/inject-query-zone'\nimport { signalProxy } from './utils/signal-proxy'\nimport { mutationResultFields } from './utils/result-fields'\nimport { injectPendingTasksLifecycle } from './utils/inject-pending-tasks-lifecycle'\nimport { injectExternalStore } from './utils/inject-external-store'\nimport type { DefaultError } from '@tanstack/query-core'\nimport type {\n CreateMutateAsyncFunction,\n CreateMutateFunction,\n CreateMutationOptions,\n CreateMutationResult,\n} from './types'\n\n/**\n * Injects a mutation: an imperative function that can be invoked which typically performs server side effects.\n * Unlike queries, mutations are not run automatically.\n *\n * @see https://tanstack.com/query/latest/docs/framework/angular/guides/mutations\n * @see {@link mutationOptions} to share these options between `injectMutation` and `injectMutationState`.\n * @param optionsFn - A function that returns mutation options. Similar to `computed` from Angular, this\n * function runs in the reactive context, so signals read inside it drive the mutation.\n * @returns The mutation result, including `mutate` and `mutateAsync`.\n *\n * @example\n * ```angular-ts\n * @Component({\n * template: `\n * @if (mutation.isPending()) {\n * Saving...\n * } @else if (mutation.isError()) {\n * <span>Error: {{ mutation.error()?.message }}</span>\n * }\n * <button (click)=\"mutation.mutate({ title: 'New post' })\">Create</button>\n * `,\n * })\n * export class CreatePost {\n * readonly mutation = injectMutation(() => ({\n * mutationFn: createPost,\n * }))\n * }\n * ```\n */\nexport function injectMutation<\n TData = unknown,\n TError = DefaultError,\n TVariables = void,\n TOnMutateResult = unknown,\n>(\n optionsFn: () => CreateMutationOptions<\n TData,\n TError,\n TVariables,\n TOnMutateResult\n >,\n): CreateMutationResult<TData, TError, TVariables, TOnMutateResult> {\n if (typeof ngDevMode === 'undefined' || ngDevMode) {\n assertInInjectionContext(injectMutation)\n }\n const outsideZone = injectQueryZone()\n const queryClient = inject(QueryClient)\n const lifecycle = injectPendingTasksLifecycle()\n\n const optionsSignal = computed(optionsFn)\n\n const observerSignal = computed(\n () => new MutationObserver(queryClient, untracked(optionsSignal)),\n )\n\n // Configure the observer outside the result computation. Mutation-cache\n // listeners can synchronously read the public result while setOptions emits.\n effect(() => {\n const options = optionsSignal()\n outsideZone(() => untracked(() => observerSignal().setOptions(options)))\n })\n\n const mutationStateSignal = injectExternalStore(() => {\n const observer = observerSignal()\n return {\n getSnapshot: () => observer.getCurrentResult(),\n subscribe: (onStoreChange) => observer.subscribe(onStoreChange),\n }\n })\n\n const mutate: CreateMutateFunction<\n TData,\n TError,\n TVariables,\n TOnMutateResult\n > = (...args) => {\n mutateAsync(...args).catch(noop)\n }\n\n let pendingInvocations = 0\n\n const mutateAsync: CreateMutateAsyncFunction<\n TData,\n TError,\n TVariables,\n TOnMutateResult\n > = (...args) => {\n return outsideZone(() =>\n untracked(() => {\n const observer = observerSignal()\n observer.setOptions(optionsSignal())\n pendingInvocations++\n lifecycle.setPending(true)\n // Track invocations, not the observer's latest result: reset or a later\n // mutation completing must not release work which is still running.\n const settled = () => {\n pendingInvocations--\n lifecycle.setPending(pendingInvocations > 0)\n }\n try {\n return observer\n .mutate(args[0] as TVariables, args[1])\n .finally(settled)\n } catch (error) {\n settled()\n throw error\n }\n }),\n )\n }\n\n const reset = () => {\n outsideZone(() =>\n untracked(() => {\n const observer = observerSignal()\n observer.setOptions(optionsSignal())\n observer.reset()\n }),\n )\n }\n\n return Object.assign(signalProxy(mutationStateSignal, mutationResultFields), {\n mutate,\n mutateAsync,\n reset,\n }) as unknown as CreateMutationResult<\n TData,\n TError,\n TVariables,\n TOnMutateResult\n >\n}\n"],"names":[],"mappings":";;;;;;;AAkDO,SAAS,eAMd,WAMkE;AAClE,MAAI,OAAO,cAAc,eAAe,WAAW;AACjD,6BAAyB,cAAc;AAAA,EACzC;AACA,QAAM,cAAc,gBAAA;AACpB,QAAM,cAAc,OAAO,WAAW;AACtC,QAAM,YAAY,4BAAA;AAElB,QAAM,gBAAgB,SAAS,SAAS;AAExC,QAAM,iBAAiB;AAAA,IACrB,MAAM,IAAI,iBAAiB,aAAa,UAAU,aAAa,CAAC;AAAA,EAAA;AAKlE,SAAO,MAAM;AACX,UAAM,UAAU,cAAA;AAChB,gBAAY,MAAM,UAAU,MAAM,eAAA,EAAiB,WAAW,OAAO,CAAC,CAAC;AAAA,EACzE,CAAC;AAED,QAAM,sBAAsB,oBAAoB,MAAM;AACpD,UAAM,WAAW,eAAA;AACjB,WAAO;AAAA,MACL,aAAa,MAAM,SAAS,iBAAA;AAAA,MAC5B,WAAW,CAAC,kBAAkB,SAAS,UAAU,aAAa;AAAA,IAAA;AAAA,EAElE,CAAC;AAED,QAAM,SAKF,IAAI,SAAS;AACf,gBAAY,GAAG,IAAI,EAAE,MAAM,IAAI;AAAA,EACjC;AAEA,MAAI,qBAAqB;AAEzB,QAAM,cAKF,IAAI,SAAS;AACf,WAAO;AAAA,MAAY,MACjB,UAAU,MAAM;AACd,cAAM,WAAW,eAAA;AACjB,iBAAS,WAAW,eAAe;AACnC;AACA,kBAAU,WAAW,IAAI;AAGzB,cAAM,UAAU,MAAM;AACpB;AACA,oBAAU,WAAW,qBAAqB,CAAC;AAAA,QAC7C;AACA,YAAI;AACF,iBAAO,SACJ,OAAO,KAAK,CAAC,GAAiB,KAAK,CAAC,CAAC,EACrC,QAAQ,OAAO;AAAA,QACpB,SAAS,OAAO;AACd,kBAAA;AACA,gBAAM;AAAA,QACR;AAAA,MACF,CAAC;AAAA,IAAA;AAAA,EAEL;AAEA,QAAM,QAAQ,MAAM;AAClB;AAAA,MAAY,MACV,UAAU,MAAM;AACd,cAAM,WAAW,eAAA;AACjB,iBAAS,WAAW,eAAe;AACnC,iBAAS,MAAA;AAAA,MACX,CAAC;AAAA,IAAA;AAAA,EAEL;AAEA,SAAO,OAAO,OAAO,YAAY,qBAAqB,oBAAoB,GAAG;AAAA,IAC3E;AAAA,IACA;AAAA,IACA;AAAA,EAAA,CACD;AAMH;"}
@@ -0,0 +1,35 @@
1
+ import { InjectQueriesOptions, QueriesResults } from './inject-queries.types.js';
2
+ import { Signal } from '@angular/core';
3
+ /**
4
+ * Injects multiple queries that run in parallel and react to Angular signals.
5
+ *
6
+ * @see https://tanstack.com/query/latest/docs/framework/angular/guides/parallel-queries
7
+ * @param optionsFn - A function that returns the queries' options. Similar to `computed` from Angular,
8
+ * this function runs in the reactive context, so signals read inside it drive the queries.
9
+ * @returns A signal containing the query results in the same order as the input queries.
10
+ *
11
+ * @example
12
+ * ```angular-ts
13
+ * @Component({
14
+ * selector: 'users',
15
+ * template: `
16
+ * @for (query of userQueries(); track $index) {
17
+ * @if (query.isSuccess()) {
18
+ * <p>{{ query.data().name }}</p>
19
+ * }
20
+ * }
21
+ * `,
22
+ * })
23
+ * export class UsersComponent {
24
+ * readonly users = input.required<Array<User>>()
25
+ *
26
+ * readonly userQueries = injectQueries(() => ({
27
+ * queries: this.users().map((user) => ({
28
+ * queryKey: ['user', user.id],
29
+ * queryFn: () => fetchUserById(user.id),
30
+ * })),
31
+ * }))
32
+ * }
33
+ * ```
34
+ */
35
+ export declare function injectQueries<T extends Array<any>, TCombinedResult = QueriesResults<T>>(optionsFn: () => InjectQueriesOptions<T, TCombinedResult>): Signal<TCombinedResult>;
@@ -0,0 +1,120 @@
1
+ import { QueryClient, QueriesObserver } from "@tanstack/query-core";
2
+ import { assertInInjectionContext, inject, computed, untracked, effect } from "@angular/core";
3
+ import { injectQueryZone } from "./utils/inject-query-zone.mjs";
4
+ import { signalProxy } from "./utils/signal-proxy.mjs";
5
+ import { queryResultFields } from "./utils/result-fields.mjs";
6
+ import { injectIsRestoring } from "./inject-is-restoring.mjs";
7
+ import { injectPendingTasksLifecycle } from "./utils/inject-pending-tasks-lifecycle.mjs";
8
+ import { injectExternalStore } from "./utils/inject-external-store.mjs";
9
+ function injectQueries(optionsFn) {
10
+ if (typeof ngDevMode === "undefined" || ngDevMode) {
11
+ assertInInjectionContext(injectQueries);
12
+ }
13
+ const outsideZone = injectQueryZone();
14
+ const queryClient = inject(QueryClient);
15
+ const isRestoring = injectIsRestoring();
16
+ const lifecycle = injectPendingTasksLifecycle();
17
+ const optionsSignal = computed(optionsFn);
18
+ const defaultedQueries = computed(() => {
19
+ return optionsSignal().queries.map((opts) => {
20
+ const defaultedOptions = queryClient.defaultQueryOptions(
21
+ opts
22
+ );
23
+ defaultedOptions._optimisticResults = isRestoring() ? "isRestoring" : "optimistic";
24
+ defaultedOptions.notifyOnChangeProps = "all";
25
+ return defaultedOptions;
26
+ });
27
+ });
28
+ const shouldBlockPendingTasks = (observer, results) => {
29
+ const queries = observer.getQueries();
30
+ return results.some((result, index) => {
31
+ var _a;
32
+ return ((_a = queries[index]) == null ? void 0 : _a.state.fetchStatus) !== "idle" || result.fetchStatus !== "idle" && result.isEnabled;
33
+ });
34
+ };
35
+ const observerSignal = computed(
36
+ () => new QueriesObserver(
37
+ queryClient,
38
+ untracked(defaultedQueries)
39
+ )
40
+ );
41
+ effect(() => {
42
+ const queries = defaultedQueries();
43
+ outsideZone(() => untracked(() => observerSignal().setQueries(queries)));
44
+ });
45
+ const refetches = [];
46
+ const getRefetch = (index) => refetches[index] ?? (refetches[index] = (options) => outsideZone(
47
+ () => untracked(() => {
48
+ const observer = observerSignal();
49
+ observer.setQueries(defaultedQueries());
50
+ const queryObserver = observer.getObservers()[index];
51
+ if (!queryObserver) {
52
+ return Promise.reject(
53
+ new Error(`Cannot refetch removed query at index ${index}`)
54
+ );
55
+ }
56
+ return queryObserver.refetch(options);
57
+ })
58
+ ));
59
+ const resultSignal = injectExternalStore(() => {
60
+ const observer = observerSignal();
61
+ const restoring = isRestoring();
62
+ return {
63
+ getSnapshot: () => {
64
+ const results = observer.getOptimisticResult(
65
+ defaultedQueries(),
66
+ void 0
67
+ )[0];
68
+ refetches.length = results.length;
69
+ return results.map((result, index) => ({
70
+ ...result,
71
+ refetch: getRefetch(index)
72
+ }));
73
+ },
74
+ subscribe: restoring ? void 0 : (onStoreChange) => {
75
+ const unsubscribe = observer.subscribe(() => {
76
+ if (lifecycle.destroyed) return;
77
+ onStoreChange();
78
+ });
79
+ return () => {
80
+ lifecycle.setPending(false);
81
+ unsubscribe();
82
+ };
83
+ }
84
+ };
85
+ });
86
+ effect((onCleanup) => {
87
+ const results = resultSignal();
88
+ if (isRestoring()) {
89
+ lifecycle.setPending(false);
90
+ return;
91
+ }
92
+ lifecycle.setPending(shouldBlockPendingTasks(observerSignal(), results));
93
+ onCleanup(() => lifecycle.setPending(false));
94
+ });
95
+ const createResultProxy = (index) => {
96
+ const resultAtIndexSignal = computed(() => resultSignal()[index]);
97
+ return Object.assign(signalProxy(resultAtIndexSignal, queryResultFields), {
98
+ refetch: getRefetch(index)
99
+ });
100
+ };
101
+ const resultProxies = [];
102
+ const proxiedResultsSignal = computed(() => {
103
+ const results = resultSignal();
104
+ resultProxies.length = results.length;
105
+ return results.map((_, index) => {
106
+ return resultProxies[index] ?? (resultProxies[index] = createResultProxy(index));
107
+ });
108
+ });
109
+ return computed(() => {
110
+ const result = resultSignal();
111
+ const { combine } = optionsSignal();
112
+ if (combine)
113
+ return combine(result);
114
+ return proxiedResultsSignal();
115
+ });
116
+ }
117
+ export {
118
+ injectQueries
119
+ };
120
+ //# sourceMappingURL=inject-queries.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"inject-queries.mjs","sources":["../src/inject-queries.ts"],"sourcesContent":["import { QueriesObserver, QueryClient } from '@tanstack/query-core'\nimport {\n assertInInjectionContext,\n computed,\n effect,\n inject,\n untracked,\n} from '@angular/core'\nimport { injectQueryZone } from './utils/inject-query-zone'\nimport { signalProxy } from './utils/signal-proxy'\nimport { queryResultFields } from './utils/result-fields'\nimport { injectIsRestoring } from './inject-is-restoring'\nimport { injectPendingTasksLifecycle } from './utils/inject-pending-tasks-lifecycle'\nimport { injectExternalStore } from './utils/inject-external-store'\nimport type {\n InjectQueriesOptions,\n QueriesResults,\n} from './inject-queries.types'\nimport type {\n QueryObserverOptions,\n QueryObserverResult,\n} from '@tanstack/query-core'\nimport type { Signal } from '@angular/core'\n\n/**\n * Injects multiple queries that run in parallel and react to Angular signals.\n *\n * @see https://tanstack.com/query/latest/docs/framework/angular/guides/parallel-queries\n * @param optionsFn - A function that returns the queries' options. Similar to `computed` from Angular,\n * this function runs in the reactive context, so signals read inside it drive the queries.\n * @returns A signal containing the query results in the same order as the input queries.\n *\n * @example\n * ```angular-ts\n * @Component({\n * selector: 'users',\n * template: `\n * @for (query of userQueries(); track $index) {\n * @if (query.isSuccess()) {\n * <p>{{ query.data().name }}</p>\n * }\n * }\n * `,\n * })\n * export class UsersComponent {\n * readonly users = input.required<Array<User>>()\n *\n * readonly userQueries = injectQueries(() => ({\n * queries: this.users().map((user) => ({\n * queryKey: ['user', user.id],\n * queryFn: () => fetchUserById(user.id),\n * })),\n * }))\n * }\n * ```\n */\nexport function injectQueries<\n T extends Array<any>,\n TCombinedResult = QueriesResults<T>,\n>(\n optionsFn: () => InjectQueriesOptions<T, TCombinedResult>,\n): Signal<TCombinedResult> {\n if (typeof ngDevMode === 'undefined' || ngDevMode) {\n assertInInjectionContext(injectQueries)\n }\n const outsideZone = injectQueryZone()\n const queryClient = inject(QueryClient)\n const isRestoring = injectIsRestoring()\n const lifecycle = injectPendingTasksLifecycle()\n\n const optionsSignal = computed(optionsFn)\n\n const defaultedQueries = computed(() => {\n return optionsSignal().queries.map((opts) => {\n const defaultedOptions = queryClient.defaultQueryOptions(\n opts as QueryObserverOptions,\n )\n defaultedOptions._optimisticResults = isRestoring()\n ? 'isRestoring'\n : 'optimistic'\n defaultedOptions.notifyOnChangeProps = 'all'\n\n return defaultedOptions as QueryObserverOptions\n })\n })\n\n const shouldBlockPendingTasks = (\n observer: QueriesObserver<TCombinedResult>,\n results: Array<QueryObserverResult>,\n ) => {\n const queries = observer.getQueries()\n\n return results.some((result, index) => {\n return (\n queries[index]?.state.fetchStatus !== 'idle' ||\n (result.fetchStatus !== 'idle' && result.isEnabled)\n )\n })\n }\n\n const observerSignal = computed(\n () =>\n new QueriesObserver<TCombinedResult>(\n queryClient,\n untracked(defaultedQueries),\n ),\n )\n\n effect(() => {\n const queries = defaultedQueries()\n outsideZone(() => untracked(() => observerSignal().setQueries(queries)))\n })\n\n // Methods address the current array slot, including methods handed to combine.\n const refetches: Array<QueryObserverResult['refetch']> = []\n const getRefetch = (index: number): QueryObserverResult['refetch'] =>\n (refetches[index] ??= (options) =>\n outsideZone(() =>\n untracked(() => {\n const observer = observerSignal()\n observer.setQueries(defaultedQueries())\n const queryObserver = observer.getObservers()[index]\n if (!queryObserver) {\n return Promise.reject(\n new Error(`Cannot refetch removed query at index ${index}`),\n )\n }\n return queryObserver.refetch(options)\n }),\n ))\n\n const resultSignal = injectExternalStore(() => {\n const observer = observerSignal()\n const restoring = isRestoring()\n return {\n getSnapshot: () => {\n const results = observer.getOptimisticResult(\n defaultedQueries(),\n undefined,\n )[0]\n refetches.length = results.length\n return results.map((result, index) => ({\n ...result,\n refetch: getRefetch(index),\n }))\n },\n subscribe: restoring\n ? undefined\n : (onStoreChange) => {\n const unsubscribe = observer.subscribe(() => {\n if (lifecycle.destroyed) return\n onStoreChange()\n })\n return () => {\n lifecycle.setPending(false)\n unsubscribe()\n }\n },\n }\n })\n\n effect((onCleanup) => {\n const results = resultSignal()\n if (isRestoring()) {\n lifecycle.setPending(false)\n return\n }\n\n lifecycle.setPending(shouldBlockPendingTasks(observerSignal(), results))\n onCleanup(() => lifecycle.setPending(false))\n })\n\n const createResultProxy = (index: number) => {\n const resultAtIndexSignal = computed(() => resultSignal()[index]!)\n return Object.assign(signalProxy(resultAtIndexSignal, queryResultFields), {\n refetch: getRefetch(index),\n })\n }\n\n const resultProxies: Array<ReturnType<typeof createResultProxy>> = []\n const proxiedResultsSignal = computed(() => {\n const results = resultSignal()\n resultProxies.length = results.length\n\n return results.map((_, index) => {\n return (resultProxies[index] ??= createResultProxy(index))\n })\n })\n\n // Combine in Angular's tracked computation. Core must notify for every raw\n // result change, including changes a previous combine function ignored.\n return computed(() => {\n const result = resultSignal()\n const { combine } = optionsSignal()\n\n if (combine)\n return combine(result as Parameters<NonNullable<typeof combine>>[0])\n\n return proxiedResultsSignal() as unknown as TCombinedResult\n }) as unknown as Signal<TCombinedResult>\n}\n"],"names":[],"mappings":";;;;;;;;AAwDO,SAAS,cAId,WACyB;AACzB,MAAI,OAAO,cAAc,eAAe,WAAW;AACjD,6BAAyB,aAAa;AAAA,EACxC;AACA,QAAM,cAAc,gBAAA;AACpB,QAAM,cAAc,OAAO,WAAW;AACtC,QAAM,cAAc,kBAAA;AACpB,QAAM,YAAY,4BAAA;AAElB,QAAM,gBAAgB,SAAS,SAAS;AAExC,QAAM,mBAAmB,SAAS,MAAM;AACtC,WAAO,cAAA,EAAgB,QAAQ,IAAI,CAAC,SAAS;AAC3C,YAAM,mBAAmB,YAAY;AAAA,QACnC;AAAA,MAAA;AAEF,uBAAiB,qBAAqB,YAAA,IAClC,gBACA;AACJ,uBAAiB,sBAAsB;AAEvC,aAAO;AAAA,IACT,CAAC;AAAA,EACH,CAAC;AAED,QAAM,0BAA0B,CAC9B,UACA,YACG;AACH,UAAM,UAAU,SAAS,WAAA;AAEzB,WAAO,QAAQ,KAAK,CAAC,QAAQ,UAAU;;AACrC,eACE,aAAQ,KAAK,MAAb,mBAAgB,MAAM,iBAAgB,UACrC,OAAO,gBAAgB,UAAU,OAAO;AAAA,IAE7C,CAAC;AAAA,EACH;AAEA,QAAM,iBAAiB;AAAA,IACrB,MACE,IAAI;AAAA,MACF;AAAA,MACA,UAAU,gBAAgB;AAAA,IAAA;AAAA,EAC5B;AAGJ,SAAO,MAAM;AACX,UAAM,UAAU,iBAAA;AAChB,gBAAY,MAAM,UAAU,MAAM,eAAA,EAAiB,WAAW,OAAO,CAAC,CAAC;AAAA,EACzE,CAAC;AAGD,QAAM,YAAmD,CAAA;AACzD,QAAM,aAAa,CAAC,UACjB,wCAAqB,CAAC,YACrB;AAAA,IAAY,MACV,UAAU,MAAM;AACd,YAAM,WAAW,eAAA;AACjB,eAAS,WAAW,kBAAkB;AACtC,YAAM,gBAAgB,SAAS,aAAA,EAAe,KAAK;AACnD,UAAI,CAAC,eAAe;AAClB,eAAO,QAAQ;AAAA,UACb,IAAI,MAAM,yCAAyC,KAAK,EAAE;AAAA,QAAA;AAAA,MAE9D;AACA,aAAO,cAAc,QAAQ,OAAO;AAAA,IACtC,CAAC;AAAA,EAAA;AAGP,QAAM,eAAe,oBAAoB,MAAM;AAC7C,UAAM,WAAW,eAAA;AACjB,UAAM,YAAY,YAAA;AAClB,WAAO;AAAA,MACL,aAAa,MAAM;AACjB,cAAM,UAAU,SAAS;AAAA,UACvB,iBAAA;AAAA,UACA;AAAA,QAAA,EACA,CAAC;AACH,kBAAU,SAAS,QAAQ;AAC3B,eAAO,QAAQ,IAAI,CAAC,QAAQ,WAAW;AAAA,UACrC,GAAG;AAAA,UACH,SAAS,WAAW,KAAK;AAAA,QAAA,EACzB;AAAA,MACJ;AAAA,MACA,WAAW,YACP,SACA,CAAC,kBAAkB;AACjB,cAAM,cAAc,SAAS,UAAU,MAAM;AAC3C,cAAI,UAAU,UAAW;AACzB,wBAAA;AAAA,QACF,CAAC;AACD,eAAO,MAAM;AACX,oBAAU,WAAW,KAAK;AAC1B,sBAAA;AAAA,QACF;AAAA,MACF;AAAA,IAAA;AAAA,EAER,CAAC;AAED,SAAO,CAAC,cAAc;AACpB,UAAM,UAAU,aAAA;AAChB,QAAI,eAAe;AACjB,gBAAU,WAAW,KAAK;AAC1B;AAAA,IACF;AAEA,cAAU,WAAW,wBAAwB,eAAA,GAAkB,OAAO,CAAC;AACvE,cAAU,MAAM,UAAU,WAAW,KAAK,CAAC;AAAA,EAC7C,CAAC;AAED,QAAM,oBAAoB,CAAC,UAAkB;AAC3C,UAAM,sBAAsB,SAAS,MAAM,aAAA,EAAe,KAAK,CAAE;AACjE,WAAO,OAAO,OAAO,YAAY,qBAAqB,iBAAiB,GAAG;AAAA,MACxE,SAAS,WAAW,KAAK;AAAA,IAAA,CAC1B;AAAA,EACH;AAEA,QAAM,gBAA6D,CAAA;AACnE,QAAM,uBAAuB,SAAS,MAAM;AAC1C,UAAM,UAAU,aAAA;AAChB,kBAAc,SAAS,QAAQ;AAE/B,WAAO,QAAQ,IAAI,CAAC,GAAG,UAAU;AAC/B,aAAQ,gDAAyB,kBAAkB,KAAK;AAAA,IAC1D,CAAC;AAAA,EACH,CAAC;AAID,SAAO,SAAS,MAAM;AACpB,UAAM,SAAS,aAAA;AACf,UAAM,EAAE,QAAA,IAAY,cAAA;AAEpB,QAAI;AACF,aAAO,QAAQ,MAAoD;AAErE,WAAO,qBAAA;AAAA,EACT,CAAC;AACH;"}