mobx-tanstack-query-api 0.0.70 → 0.0.71
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/package.json
CHANGED
|
@@ -13,7 +13,7 @@ export interface EndpointQueryMeta {
|
|
|
13
13
|
group?: string;
|
|
14
14
|
namespace?: string;
|
|
15
15
|
}
|
|
16
|
-
export type
|
|
16
|
+
export type EndpointQueryUniqKey = Maybe<FnValue<string | number | AnyObject | boolean>>;
|
|
17
17
|
export type EndpointQueryOptions<TEndpoint extends AnyEndpoint, TQueryFnData = TEndpoint['__response']['data'], TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData> = {
|
|
18
18
|
params?: () => MaybeFalsy<TEndpoint['__params']>;
|
|
19
19
|
/**
|
|
@@ -21,7 +21,7 @@ export type EndpointQueryOptions<TEndpoint extends AnyEndpoint, TQueryFnData = T
|
|
|
21
21
|
*/
|
|
22
22
|
transform?: (response: TEndpoint['__response']) => TQueryFnData | Promise<TQueryFnData>;
|
|
23
23
|
} & Omit<QueryConfig<NoInfer<TQueryFnData>, TError, TData, TQueryData>, 'options' | 'queryFn' | 'queryClient' | 'queryKey' | '_defaulted' | '_optimisticResults' | 'experimental_prefetchInRender' | 'enabled' | 'queryHash' | 'queryKeyHashFn'> & {
|
|
24
|
-
uniqKey?:
|
|
24
|
+
uniqKey?: EndpointQueryUniqKey;
|
|
25
25
|
enabled?: boolean;
|
|
26
26
|
};
|
|
27
27
|
//# sourceMappingURL=endpoint-query.types.d.ts.map
|
package/runtime/endpoint.d.ts
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
import { DefaultError } from '@tanstack/query-core';
|
|
1
|
+
import { DefaultError, InvalidateOptions, InvalidateQueryFilters } from '@tanstack/query-core';
|
|
2
2
|
import { AllPropertiesOptional, AnyObject } from 'yummies/utils/types';
|
|
3
3
|
import { EndpointMutation } from './endpoint-mutation.js';
|
|
4
4
|
import { EndpointMutationOptions } from './endpoint-mutation.types.js';
|
|
5
5
|
import { EndpointQueryClient } from './endpoint-query-client.js';
|
|
6
6
|
import { EndpointQuery } from './endpoint-query.js';
|
|
7
|
-
import { EndpointQueryOptions,
|
|
7
|
+
import { EndpointQueryOptions, EndpointQueryUniqKey } from './endpoint-query.types.js';
|
|
8
8
|
import { EndpointConfiguration, EndpointMutationPresets } from './endpoint.types.js';
|
|
9
9
|
import type { HttpClient, HttpResponse } from './http-client.js';
|
|
10
10
|
export interface Endpoint<TResponse extends HttpResponse<any, any>, TParams extends AnyObject, TMetaData extends AnyObject = AnyObject> {
|
|
@@ -30,7 +30,20 @@ export declare class Endpoint<TResponse extends HttpResponse<any, any>, TParams
|
|
|
30
30
|
get group(): string | undefined;
|
|
31
31
|
get namespace(): string | undefined;
|
|
32
32
|
request(...args: AllPropertiesOptional<TParams> extends true ? [input?: TParams] : [input: TParams]): Promise<TResponse>;
|
|
33
|
-
getQueryKey(...args: AllPropertiesOptional<TParams> extends true ? [input?: TParams, uniqKey?:
|
|
33
|
+
getQueryKey(...args: AllPropertiesOptional<TParams> extends true ? [input?: TParams, uniqKey?: EndpointQueryUniqKey] : [input: TParams, uniqKey?: EndpointQueryUniqKey]): any[];
|
|
34
|
+
invalidateQuery(...args: AllPropertiesOptional<TParams> extends true ? [
|
|
35
|
+
input?: TParams,
|
|
36
|
+
filters?: InvalidateQueryFilters & {
|
|
37
|
+
uniqKey?: EndpointQueryUniqKey;
|
|
38
|
+
},
|
|
39
|
+
options?: InvalidateOptions
|
|
40
|
+
] : [
|
|
41
|
+
input: TParams,
|
|
42
|
+
filters?: InvalidateQueryFilters & {
|
|
43
|
+
uniqKey?: EndpointQueryUniqKey;
|
|
44
|
+
},
|
|
45
|
+
options?: InvalidateOptions
|
|
46
|
+
]): void;
|
|
34
47
|
toMutation<TData = TResponse['data'], TMutationMeta extends AnyObject | void = void, TContext = unknown>(options: EndpointMutationOptions<this, TData, TParams, TMutationMeta, TContext>): EndpointMutation<this, TData, TParams, TMutationMeta, TContext>;
|
|
35
48
|
toQuery<TQueryFnData = TResponse['data'], TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData>(options: EndpointQueryOptions<this, TQueryFnData, TError, TData, TQueryData>): EndpointQuery<this, TQueryFnData, TError, TData, TQueryData>;
|
|
36
49
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"endpoint.d.ts","sourceRoot":"","sources":["../../src/runtime/endpoint.ts"],"names":[],"mappings":"AACA,OAAO,
|
|
1
|
+
{"version":3,"file":"endpoint.d.ts","sourceRoot":"","sources":["../../src/runtime/endpoint.ts"],"names":[],"mappings":"AACA,OAAO,EACL,YAAY,EACZ,iBAAiB,EACjB,sBAAsB,EACvB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,qBAAqB,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAEvE,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EACL,oBAAoB,EACpB,oBAAoB,EACrB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EACL,qBAAqB,EACrB,uBAAuB,EACxB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAEjE,MAAM,WAAW,QAAQ,CACvB,SAAS,SAAS,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,EACxC,OAAO,SAAS,SAAS,EACzB,SAAS,SAAS,SAAS,GAAG,SAAS;IAEvC,CACE,GAAG,IAAI,EAAE,qBAAqB,CAAC,OAAO,CAAC,SAAS,IAAI,GAChD,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,GAClB,CAAC,MAAM,EAAE,OAAO,CAAC,GACpB,UAAU,CAAC,QAAQ,CAAC,SAAS,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;CACnE;AAED,qBAAa,QAAQ,CACnB,SAAS,SAAS,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,EACxC,OAAO,SAAS,SAAS,EACzB,SAAS,SAAS,SAAS,GAAG,SAAS;IAgB9B,aAAa,EAAE,qBAAqB,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC;IACxE,SAAS,CAAC,WAAW,EAAE,mBAAmB;IAC1C,SAAS,CAAC,IAAI,EAAE,UAAU;IAhB5B,UAAU,EAAE,MAAM,CAAC;IAEnB,OAAO,EAAE;QACP,SAAS,EAAE,uBAAuB,CAAC;KACpC,CAEC;IAEF,QAAQ,EAAG,OAAO,CAAC;IACnB,UAAU,EAAG,SAAS,CAAC;IAEvB,IAAI,EAAG,SAAS,CAAC;gBAGR,aAAa,EAAE,qBAAqB,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,EAC9D,WAAW,EAAE,mBAAmB,EAChC,IAAI,EAAE,UAAU;IAkC5B,UAAU,CACR,GAAG,IAAI,EAAE,qBAAqB,CAAC,OAAO,CAAC,SAAS,IAAI,GAChD,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,GACjB,CAAC,KAAK,EAAE,OAAO,CAAC,GACnB,MAAM;IAKT,OAAO,CACL,GAAG,IAAI,EAAE,qBAAqB,CAAC,OAAO,CAAC,SAAS,IAAI,GAChD,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,GACjB,CAAC,KAAK,EAAE,OAAO,CAAC,GACnB,MAAM;IAKT,IAAI,IAAI,aAEP;IAED,IAAI,IAAI,aAEP;IAED,IAAI,WAAW,WAEd;IAED,IAAI,KAAK,uBAER;IAED,IAAI,SAAS,uBAEZ;IAED,OAAO,CACL,GAAG,IAAI,EAAE,qBAAqB,CAAC,OAAO,CAAC,SAAS,IAAI,GAChD,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,GACjB,CAAC,KAAK,EAAE,OAAO,CAAC;IAOtB,WAAW,CACT,GAAG,IAAI,EAAE,qBAAqB,CAAC,OAAO,CAAC,SAAS,IAAI,GAChD,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,oBAAoB,CAAC,GACjD,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,oBAAoB,CAAC,GACnD,GAAG,EAAE;IAWR,eAAe,CACb,GAAG,IAAI,EAAE,qBAAqB,CAAC,OAAO,CAAC,SAAS,IAAI,GAChD;QACE,KAAK,CAAC,EAAE,OAAO;QACf,OAAO,CAAC,EAAE,sBAAsB,GAAG;YAAE,OAAO,CAAC,EAAE,oBAAoB,CAAA;SAAE;QACrE,OAAO,CAAC,EAAE,iBAAiB;KAC5B,GACD;QACE,KAAK,EAAE,OAAO;QACd,OAAO,CAAC,EAAE,sBAAsB,GAAG;YAAE,OAAO,CAAC,EAAE,oBAAoB,CAAA;SAAE;QACrE,OAAO,CAAC,EAAE,iBAAiB;KAC5B;IAaP,UAAU,CACR,KAAK,GAAG,SAAS,CAAC,MAAM,CAAC,EACzB,aAAa,SAAS,SAAS,GAAG,IAAI,GAAG,IAAI,EAC7C,QAAQ,GAAG,OAAO,EAElB,OAAO,EAAE,uBAAuB,CAC9B,IAAI,EACJ,KAAK,EACL,OAAO,EACP,aAAa,EACb,QAAQ,CACT;IAcH,OAAO,CACL,YAAY,GAAG,SAAS,CAAC,MAAM,CAAC,EAChC,MAAM,GAAG,YAAY,EACrB,KAAK,GAAG,YAAY,EACpB,UAAU,GAAG,YAAY,EAEzB,OAAO,EAAE,oBAAoB,CAC3B,IAAI,EACJ,YAAY,EACZ,MAAM,EACN,KAAK,EACL,UAAU,CACX;CAQJ"}
|
package/runtime/endpoint.js
CHANGED
|
@@ -74,6 +74,14 @@ export class Endpoint {
|
|
|
74
74
|
resolveFnValue(args[1]),
|
|
75
75
|
];
|
|
76
76
|
}
|
|
77
|
+
invalidateQuery(...args) {
|
|
78
|
+
this.queryClient.invalidateQueries({
|
|
79
|
+
// @ts-ignore
|
|
80
|
+
queryKey: this.getQueryKey(args[0], args[1]?.uniqKey),
|
|
81
|
+
exact: true,
|
|
82
|
+
...args[1],
|
|
83
|
+
}, args[2]);
|
|
84
|
+
}
|
|
77
85
|
toMutation(options) {
|
|
78
86
|
return new EndpointMutation(this, this.queryClient, {
|
|
79
87
|
...options,
|