react-query-tree 0.0.8 → 0.0.10
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/README.md +4 -3
- package/dist/api.d.ts +5 -5
- package/dist/api.d.ts.map +1 -1
- package/dist/api.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -9,7 +9,7 @@ React Query Tree lets you define your API as a tree of queries and mutations, wi
|
|
|
9
9
|
**☹️ Traditional method**
|
|
10
10
|
|
|
11
11
|
- Query keys and path keys are not typed
|
|
12
|
-
- No obvious way to
|
|
12
|
+
- No obvious way to organize collections of queries and mutations that is structured and accessible.
|
|
13
13
|
|
|
14
14
|
```ts
|
|
15
15
|
const todosQuery = useQuery({
|
|
@@ -25,7 +25,7 @@ const todosQuery = useQuery({
|
|
|
25
25
|
**🥳 With React Query Tree**
|
|
26
26
|
|
|
27
27
|
- Single object for accessing all queries and mutations
|
|
28
|
-
- Query keys are typed
|
|
28
|
+
- Query keys are typed, making invalidation a breeze
|
|
29
29
|
|
|
30
30
|
**api.ts**
|
|
31
31
|
|
|
@@ -73,6 +73,7 @@ const usersApi = createApi({
|
|
|
73
73
|
},
|
|
74
74
|
}),
|
|
75
75
|
});
|
|
76
|
+
|
|
76
77
|
export const api = createApi({
|
|
77
78
|
todos: todosApi,
|
|
78
79
|
users: usersApi,
|
|
@@ -110,7 +111,7 @@ const todosApi = createApi({
|
|
|
110
111
|
});
|
|
111
112
|
},
|
|
112
113
|
onSuccess: () => {
|
|
113
|
-
queryClient.invalidateQueries({ queryKey:
|
|
114
|
+
queryClient.invalidateQueries({ queryKey: todosApi.list.queryKey() });
|
|
114
115
|
},
|
|
115
116
|
}),
|
|
116
117
|
});
|
package/dist/api.d.ts
CHANGED
|
@@ -2,9 +2,6 @@ import type { DefinedInitialDataOptions, MutationKey, QueryKey, UndefinedInitial
|
|
|
2
2
|
import { type MutationBrand } from "./mutation";
|
|
3
3
|
import { type QueryBrand } from "./query";
|
|
4
4
|
import type { DeepPartial } from "./types";
|
|
5
|
-
export type Collection = {
|
|
6
|
-
[key: string]: QueryBrand | MutationBrand | ((filter: any) => QueryBrand) | Collection | OutputApi<any>;
|
|
7
|
-
};
|
|
8
5
|
type Query<T> = T extends Omit<DefinedInitialDataOptions<infer TQueryFnData, infer TError, infer TData> & QueryBrand, "queryKey"> ? {
|
|
9
6
|
queryOptions: <TInnerData = TData>(opts?: Partial<Omit<DefinedInitialDataOptions<TQueryFnData, TError, TInnerData>, "queryKey">>) => Omit<DefinedInitialDataOptions<TQueryFnData, TError, TInnerData>, "queryKey"> & {
|
|
10
7
|
queryKey: QueryKey;
|
|
@@ -50,7 +47,10 @@ type Mutation<T> = T extends Omit<UseMutationOptions<infer TData, infer TError,
|
|
|
50
47
|
mutationKey: () => MutationKey;
|
|
51
48
|
pathKey: () => string[];
|
|
52
49
|
} : never;
|
|
53
|
-
export type
|
|
50
|
+
export type Config = {
|
|
51
|
+
[key: string]: QueryBrand | MutationBrand | ((filter: any) => QueryBrand) | Config | OutputApi<any>;
|
|
52
|
+
};
|
|
53
|
+
export type OutputApi<T extends Config> = {
|
|
54
54
|
[K in keyof T]: T[K] extends {
|
|
55
55
|
"~type": "query";
|
|
56
56
|
} ? Query<T[K]> : T[K] extends {
|
|
@@ -61,6 +61,6 @@ export type OutputApi<T extends Collection> = {
|
|
|
61
61
|
pathKey: () => string[];
|
|
62
62
|
} : never;
|
|
63
63
|
};
|
|
64
|
-
export declare function createApi<T extends
|
|
64
|
+
export declare function createApi<T extends Config>(config: T): OutputApi<T>;
|
|
65
65
|
export {};
|
|
66
66
|
//# sourceMappingURL=api.d.ts.map
|
package/dist/api.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,yBAAyB,EACzB,WAAW,EACX,QAAQ,EACR,2BAA2B,EAC3B,sBAAsB,EACtB,kBAAkB,EAClB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,KAAK,aAAa,EAAiB,MAAM,YAAY,CAAC;AAC/D,OAAO,EAAE,KAAK,UAAU,EAAc,MAAM,SAAS,CAAC;AACtD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;
|
|
1
|
+
{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,yBAAyB,EACzB,WAAW,EACX,QAAQ,EACR,2BAA2B,EAC3B,sBAAsB,EACtB,kBAAkB,EAClB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,KAAK,aAAa,EAAiB,MAAM,YAAY,CAAC;AAC/D,OAAO,EAAE,KAAK,UAAU,EAAc,MAAM,SAAS,CAAC;AACtD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAK3C,KAAK,KAAK,CAAC,CAAC,IACX,CAAC,SAAS,IAAI,CACb,yBAAyB,CAAC,MAAM,YAAY,EAAE,MAAM,MAAM,EAAE,MAAM,KAAK,CAAC,GAAG,UAAU,EACrF,UAAU,CACV,GACE;IACA,YAAY,EAAE,CAAC,UAAU,GAAG,KAAK,EAChC,IAAI,CAAC,EAAE,OAAO,CACb,IAAI,CAAC,yBAAyB,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,UAAU,CAAC,CAC7E,KACG,IAAI,CAAC,yBAAyB,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,UAAU,CAAC,GAAG;QACpF,QAAQ,EAAE,QAAQ,CAAC;KACnB,CAAC;IACF,QAAQ,EAAE,MAAM,QAAQ,CAAC;IACzB,OAAO,EAAE,MAAM,MAAM,EAAE,CAAC;CACxB,GACA,CAAC,SAAS,IAAI,CACb,sBAAsB,CAAC,MAAM,YAAY,EAAE,MAAM,MAAM,EAAE,MAAM,KAAK,CAAC,GAAG,UAAU,EAClF,UAAU,CACV,GACA;IACA,YAAY,EAAE,CAAC,UAAU,GAAG,KAAK,EAChC,IAAI,CAAC,EAAE,IAAI,CAAC,sBAAsB,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,UAAU,CAAC,KAC7E,IAAI,CAAC,sBAAsB,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,UAAU,CAAC,GAAG;QACjF,QAAQ,EAAE,QAAQ,CAAC;KACnB,CAAC;IACF,QAAQ,EAAE,MAAM,QAAQ,CAAC;IACzB,OAAO,EAAE,MAAM,MAAM,EAAE,CAAC;CACxB,GACA,CAAC,SAAS,IAAI,CACb,2BAA2B,CAAC,MAAM,YAAY,EAAE,MAAM,MAAM,EAAE,MAAM,KAAK,CAAC,GAAG,UAAU,EACvF,UAAU,CACV,GACA;IACA,YAAY,EAAE,CAAC,UAAU,GAAG,KAAK,EAChC,IAAI,CAAC,EAAE,IAAI,CACV,2BAA2B,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,CAAC,EAC7D,UAAU,CACV,KACG,IAAI,CAAC,2BAA2B,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,UAAU,CAAC,GAAG;QACtF,QAAQ,EAAE,QAAQ,CAAC;KACnB,CAAC;IACF,QAAQ,EAAE,MAAM,QAAQ,CAAC;IACzB,OAAO,EAAE,MAAM,MAAM,EAAE,CAAC;CACxB,GACA,KAAK,CAAC;AAEZ,KAAK,eAAe,CAAC,CAAC,SAAS,CAAC,MAAM,EAAE,GAAG,KAAK,GAAG,IAClD,UAAU,CAAC,CAAC,CAAC,SAAS,IAAI,CACzB,yBAAyB,CAAC,MAAM,YAAY,EAAE,MAAM,MAAM,EAAE,MAAM,KAAK,CAAC,GAAG,UAAU,EACrF,UAAU,CACV,GACE;IACA,YAAY,EAAE,CAAC,UAAU,GAAG,KAAK,EAChC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EACxB,IAAI,CAAC,EAAE,OAAO,CACb,IAAI,CAAC,yBAAyB,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,UAAU,CAAC,CAC7E,KACG,UAAU,CAAC,CAAC,CAAC,GAAG;QAAE,QAAQ,EAAE,QAAQ,CAAA;KAAE,CAAC;IAC5C,QAAQ,EAAE,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC;IAC/D,OAAO,EAAE,MAAM,MAAM,EAAE,CAAC;CACxB,GACA,UAAU,CAAC,CAAC,CAAC,SAAS,IAAI,CACzB,sBAAsB,CAAC,MAAM,YAAY,EAAE,MAAM,MAAM,EAAE,MAAM,KAAK,CAAC,GAAG,UAAU,EAClF,UAAU,CACV,GACA;IACA,YAAY,EAAE,CAAC,UAAU,GAAG,KAAK,EAChC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EACxB,IAAI,CAAC,EAAE,IAAI,CAAC,sBAAsB,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,UAAU,CAAC,KAC7E,UAAU,CAAC,CAAC,CAAC,GAAG;QAAE,QAAQ,EAAE,QAAQ,CAAA;KAAE,CAAC;IAC5C,QAAQ,EAAE,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC;IAC/D,OAAO,EAAE,MAAM,MAAM,EAAE,CAAC;CACxB,GACA,UAAU,CAAC,CAAC,CAAC,SAAS,IAAI,CACzB,2BAA2B,CAAC,MAAM,YAAY,EAAE,MAAM,MAAM,EAAE,MAAM,KAAK,CAAC,GAAG,UAAU,EACvF,UAAU,CACV,GACA;IACA,YAAY,EAAE,CAAC,UAAU,GAAG,KAAK,EAChC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EACxB,IAAI,CAAC,EAAE,IAAI,CACV,2BAA2B,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,CAAC,EAC7D,UAAU,CACV,KACG,UAAU,CAAC,CAAC,CAAC,GAAG;QAAE,QAAQ,EAAE,QAAQ,CAAA;KAAE,CAAC;IAC5C,QAAQ,EAAE,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC;IAC/D,OAAO,EAAE,MAAM,MAAM,EAAE,CAAC;CACxB,GACA,KAAK,CAAC;AAEZ,KAAK,QAAQ,CAAC,CAAC,IACd,CAAC,SAAS,IAAI,CACb,kBAAkB,CAAC,MAAM,KAAK,EAAE,MAAM,MAAM,EAAE,MAAM,UAAU,EAAE,MAAM,QAAQ,CAAC,EAC/E,aAAa,CACb,GACE;IACA,eAAe,EAAE,CAAC,aAAa,GAAG,QAAQ,EACzC,IAAI,CAAC,EAAE,IAAI,CACV,kBAAkB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,aAAa,CAAC,EAC5D,aAAa,GAAG,YAAY,CAC5B,KACG,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,CAAC,EAAE,aAAa,CAAC,GAAG;QACnF,WAAW,EAAE,WAAW,CAAC;KACzB,CAAC;IACF,WAAW,EAAE,MAAM,WAAW,CAAC;IAC/B,OAAO,EAAE,MAAM,MAAM,EAAE,CAAC;CACxB,GACA,KAAK,CAAC;AAEV,MAAM,MAAM,MAAM,GAAG;IACpB,CAAC,GAAG,EAAE,MAAM,GACT,UAAU,GACV,aAAa,GACb,CAAC,CAAC,MAAM,EAAE,GAAG,KAAK,UAAU,CAAC,GAC7B,MAAM,GACN,SAAS,CAAC,GAAG,CAAC,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,MAAM,IAAI;KACxC,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,GAC9C,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACX,CAAC,CAAC,CAAC,CAAC,SAAS;QAAE,OAAO,EAAE,UAAU,CAAA;KAAE,GACnC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACd,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,EAAE,GAAG,KAAK,GAAG,GAChC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACrB,CAAC,CAAC,CAAC,CAAC,SAAS,SAAS,CAAC,MAAM,CAAC,CAAC,GAC9B,SAAS,CAAC,CAAC,CAAC,GAAG;QAAE,OAAO,EAAE,MAAM,MAAM,EAAE,CAAA;KAAE,GAC1C,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC/B,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG;QAAE,OAAO,EAAE,MAAM,MAAM,EAAE,CAAA;KAAE,GAC7C,KAAK;CACZ,CAAC;AAEF,wBAAgB,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CA0EnE"}
|
package/dist/api.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAQA,OAAO,EAAsB,aAAa,EAAE,MAAM,YAAY,CAAC;AAC/D,OAAO,EAAmB,UAAU,EAAE,MAAM,SAAS,CAAC;AAEtD,OAAO,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;
|
|
1
|
+
{"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAQA,OAAO,EAAsB,aAAa,EAAE,MAAM,YAAY,CAAC;AAC/D,OAAO,EAAmB,UAAU,EAAE,MAAM,SAAS,CAAC;AAEtD,OAAO,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAE/C,MAAM,YAAY,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;AAuIxC,MAAM,UAAU,SAAS,CAAmB,MAAS;IACpD,MAAM,WAAW,GAAG,CAAC,WAAgB,EAAE,OAAiB,EAAE,EAAO,EAAE;QAClE,OAAO,IAAI,KAAK,CAAC,WAAW,EAAE;YAC7B,GAAG,CAAC,GAAG,EAAE,IAAI;gBACZ,IAAI,IAAI,KAAK,YAAY,EAAE,CAAC;oBAC3B,OAAO,IAAI,CAAC;gBACb,CAAC;gBAED,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;oBACnD,OAAO,GAAG,CAAC,IAAI,CAAC,CAAC;gBAClB,CAAC;gBACD,MAAM,KAAK,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC;gBACxB,MAAM,WAAW,GAAG,CAAC,GAAG,IAAI,EAAE,IAAc,CAAC,CAAC;gBAE9C,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;oBACxB,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC;gBACnB,CAAC;gBAED,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;oBACvB,OAAO,GAAG,CAAC;gBACZ,CAAC;gBAED,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC;oBAC/D,OAAO,WAAW,CAAC,KAAK,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;gBAC/C,CAAC;gBAED,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;oBAClF,OAAO;wBACN,YAAY,EAAE,CAAC,IAAU,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,CAAC;wBAC5E,QAAQ,EAAE,GAAG,EAAE,CAAC,WAAW;wBAC3B,OAAO,EAAE,GAAG,EAAE,CAAC,WAAW;qBAC1B,CAAC;gBACH,CAAC;gBAED,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;oBACrF,OAAO;wBACN,eAAe,EAAE,CAAC,IAAU,EAAE,EAAE,CAC/B,oBAAoB,CAAC,KAAK,EAAE,EAAE,WAAW,EAAE,WAAW,EAAE,EAAE,IAAI,CAAC;wBAChE,WAAW,EAAE,GAAG,EAAE,CAAC,WAAW;wBAC9B,OAAO,EAAE,GAAG,EAAE,CAAC,WAAW;qBAC1B,CAAC;gBACH,CAAC;gBAED,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;oBACjC,OAAO;wBACN,YAAY,EAAE,CAAC,MAAW,EAAE,IAAU,EAAE,EAAE,CAAC,CAAC;4BAC3C,GAAG,KAAK,CAAC,MAAM,CAAC;4BAChB,QAAQ,EAAE,CAAC,GAAG,WAAW,EAAE,MAAM,CAAC;4BAClC,GAAG,IAAI;yBACP,CAAC;wBACF,QAAQ,EAAE,CAAC,MAAY,EAAE,EAAE,CAAC,CAAC,GAAG,WAAW,EAAE,MAAM,CAAC;wBACpD,OAAO,EAAE,GAAG,EAAE,CAAC,WAAW;qBAC1B,CAAC;gBACH,CAAC;gBAED,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;oBACxC,OAAO,WAAW,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;gBACxC,CAAC;gBAED,OAAO,KAAK,CAAC;YACd,CAAC;YACD,GAAG;gBACF,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;YAC5D,CAAC;YACD,OAAO,CAAC,MAAM;gBACb,OAAO,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAChC,CAAC;YACD,wBAAwB,CAAC,MAAM,EAAE,IAAI;gBACpC,OAAO,OAAO,CAAC,wBAAwB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YACvD,CAAC;SACD,CAAC,CAAC;IACJ,CAAC,CAAC;IAEF,OAAO,WAAW,CAAC,MAAM,CAAC,CAAC;AAC5B,CAAC"}
|