mobx-tanstack-query-api 0.13.0 → 0.13.2

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 CHANGED
@@ -1,3 +1,5 @@
1
+ <img src="assets/logo.png" align="right" width="156" alt="logo" />
2
+
1
3
  # mobx-tanstack-query-api
2
4
 
3
5
  [![NPM version][npm-image]][npm-url] [![build status][github-build-actions-image]][github-actions-url] [![npm download][download-image]][download-url] [![bundle size][bundlephobia-image]][bundlephobia-url]
@@ -24,39 +24,39 @@ export interface MetaInfo {
24
24
  }
25
25
  export interface GenerateQueryApiParams {
26
26
  /**
27
- * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/config/#output)
27
+ * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/codegen/config/#output)
28
28
  */
29
29
  output: string;
30
30
  /**
31
- * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/config/#input)
31
+ * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/codegen/config/#input)
32
32
  */
33
33
  input: string | AnyObject;
34
34
  /**
35
- * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/config/#requestpathprefix)
35
+ * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/codegen/config/#requestpathprefix)
36
36
  */
37
37
  requestPathPrefix?: string;
38
38
  /**
39
- * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/config/#requestpathsuffix)
39
+ * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/codegen/config/#requestpathsuffix)
40
40
  */
41
41
  requestPathSuffix?: string;
42
42
  /**
43
- * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/config/#removeunusedtypes)
43
+ * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/codegen/config/#removeunusedtypes)
44
44
  */
45
45
  removeUnusedTypes?: true | {
46
46
  keepTypes?: RemoveUnusedTypesParams['keepTypes'];
47
47
  };
48
48
  /**
49
- * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/config/#formatendpointname)
49
+ * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/codegen/config/#formatendpointname)
50
50
  */
51
51
  formatEndpointName?: (endpointName: string, endpointData: RawRouteInfo) => Maybe<string>;
52
52
  /**
53
- * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/config/#formatexportgroupname)
53
+ * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/codegen/config/#formatexportgroupname)
54
54
  */
55
55
  formatExportGroupName?: (groupName: string, utils: CodegenDataUtils) => string;
56
56
  /**
57
57
  * Various generation output types
58
58
  *
59
- * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/config/#outputtype)
59
+ * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/codegen/config/#outputtype)
60
60
  *
61
61
  * `one-endpoint-per-file`
62
62
  * @example
@@ -98,33 +98,33 @@ export interface GenerateQueryApiParams {
98
98
  /**
99
99
  * Group endpoints and collect it into object
100
100
  *
101
- * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/config/#groupby)
101
+ * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/codegen/config/#groupby)
102
102
  */
103
103
  groupBy?: ((endpoint: EndpointData) => string) | `path-segment` | `path-segment-${number}` | `tag` | `tag-${number}`;
104
104
  /**
105
105
  * Collect all exports into single namespace
106
106
  *
107
- * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/config/#namespace)
107
+ * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/codegen/config/#namespace)
108
108
  */
109
109
  namespace?: string | ((utils: AnyObject) => string);
110
110
  /**
111
- * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/config/#addpathsegmenttoroutename)
111
+ * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/codegen/config/#addpathsegmenttoroutename)
112
112
  */
113
113
  addPathSegmentToRouteName?: boolean | number;
114
114
  /**
115
- * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/config/#queryclient)
115
+ * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/codegen/config/#queryclient)
116
116
  */
117
117
  queryClient?: 'builtin' | ImportFileParams;
118
118
  /**
119
- * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/config/#endpoint)
119
+ * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/codegen/config/#endpoint)
120
120
  */
121
121
  endpoint?: 'builtin' | ImportFileParams;
122
122
  /**
123
- * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/config/#httpclient)
123
+ * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/codegen/config/#httpclient)
124
124
  */
125
125
  httpClient?: 'builtin' | ImportFileParams;
126
126
  /**
127
- * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/config/#getendpointmeta)
127
+ * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/codegen/config/#getendpointmeta)
128
128
  */
129
129
  getEndpointMeta?: (route: AnyObject, utils: AnyObject) => {
130
130
  typeName?: string;
@@ -132,7 +132,7 @@ export interface GenerateQueryApiParams {
132
132
  tmplData: string;
133
133
  };
134
134
  /**
135
- * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/config/#getrequestmeta)
135
+ * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/codegen/config/#getrequestmeta)
136
136
  */
137
137
  getRequestMeta?: (route: AnyObject, utils: AnyObject) => {
138
138
  tmplData: string;
@@ -140,16 +140,16 @@ export interface GenerateQueryApiParams {
140
140
  /**
141
141
  * Additional parameters used to fetch your OpenAPI schema
142
142
  *
143
- * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/config/#fetchschemarequestoptions)
143
+ * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/codegen/config/#fetchschemarequestoptions)
144
144
  */
145
145
  fetchSchemaRequestOptions?: RequestInit;
146
146
  otherCodegenParams?: AnyObject;
147
147
  /**
148
- * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/config/#filterendpoints)
148
+ * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/codegen/config/#filterendpoints)
149
149
  */
150
150
  filterEndpoints?: FilterEndpointsOption;
151
151
  /**
152
- * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/config/#filtergroups)
152
+ * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/codegen/config/#filtergroups)
153
153
  */
154
154
  filterGroups?: FilterGroupsOption;
155
155
  libImports?: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "mobx-tanstack-query-api",
3
- "version": "0.13.0",
3
+ "version": "0.13.2",
4
4
  "keywords": [
5
5
  "mobx",
6
6
  "react-query",
@@ -3,6 +3,9 @@ import type { AnyObject } from 'yummies/utils/types';
3
3
  import type { AnyEndpoint } from './endpoint.types.js';
4
4
  import type { EndpointMutationOptions, EndpointMutationParams } from './endpoint-mutation.types.js';
5
5
  import type { EndpointQueryClient } from './endpoint-query-client.js';
6
+ /**
7
+ * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoint-mutations/)
8
+ */
6
9
  export declare class EndpointMutation<TEndpoint extends AnyEndpoint, TData = unknown, TParams extends AnyObject = AnyObject, TMutationMeta extends AnyObject | void = void, TContext = unknown> extends Mutation<TData, EndpointMutationParams<TParams, TMutationMeta>, TEndpoint['__response']['error'], TContext> {
7
10
  private endpoint;
8
11
  constructor(endpoint: AnyEndpoint, queryClient: EndpointQueryClient, { transform: transformResponse, invalidateEndpoints, ...mutationOptions }: EndpointMutationOptions<TEndpoint, TData, TParams, TMutationMeta, TContext>);
@@ -1 +1 @@
1
- {"version":3,"file":"endpoint-mutation.d.ts","sourceRoot":"","sources":["../../src/runtime/endpoint-mutation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,KAAK,EAAE,SAAS,EAAS,MAAM,qBAAqB,CAAC;AAC5D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EACV,uBAAuB,EACvB,sBAAsB,EACvB,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AAGtE,qBAAa,gBAAgB,CAC3B,SAAS,SAAS,WAAW,EAC7B,KAAK,GAAG,OAAO,EACf,OAAO,SAAS,SAAS,GAAG,SAAS,EACrC,aAAa,SAAS,SAAS,GAAG,IAAI,GAAG,IAAI,EAC7C,QAAQ,GAAG,OAAO,CAClB,SAAQ,QAAQ,CAChB,KAAK,EACL,sBAAsB,CAAC,OAAO,EAAE,aAAa,CAAC,EAC9C,SAAS,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,EAChC,QAAQ,CACT;IAEG,OAAO,CAAC,QAAQ;gBAAR,QAAQ,EAAE,WAAW,EAC7B,WAAW,EAAE,mBAAmB,EAChC,EACE,SAAS,EAAE,iBAAiB,EAC5B,mBAAmB,EACnB,GAAG,eAAe,EACnB,EAAE,uBAAuB,CACxB,SAAS,EACT,KAAK,EACL,OAAO,EACP,aAAa,EACb,QAAQ,CACT;CAoDJ"}
1
+ {"version":3,"file":"endpoint-mutation.d.ts","sourceRoot":"","sources":["../../src/runtime/endpoint-mutation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,KAAK,EAAE,SAAS,EAAS,MAAM,qBAAqB,CAAC;AAC5D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EACV,uBAAuB,EACvB,sBAAsB,EACvB,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AAGtE;;GAEG;AACH,qBAAa,gBAAgB,CAC3B,SAAS,SAAS,WAAW,EAC7B,KAAK,GAAG,OAAO,EACf,OAAO,SAAS,SAAS,GAAG,SAAS,EACrC,aAAa,SAAS,SAAS,GAAG,IAAI,GAAG,IAAI,EAC7C,QAAQ,GAAG,OAAO,CAClB,SAAQ,QAAQ,CAChB,KAAK,EACL,sBAAsB,CAAC,OAAO,EAAE,aAAa,CAAC,EAC9C,SAAS,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,EAChC,QAAQ,CACT;IAEG,OAAO,CAAC,QAAQ;gBAAR,QAAQ,EAAE,WAAW,EAC7B,WAAW,EAAE,mBAAmB,EAChC,EACE,SAAS,EAAE,iBAAiB,EAC5B,mBAAmB,EACnB,GAAG,eAAe,EACnB,EAAE,uBAAuB,CACxB,SAAS,EACT,KAAK,EACL,OAAO,EACP,aAAa,EACb,QAAQ,CACT;CAoDJ"}
@@ -1,4 +1,7 @@
1
1
  import { Mutation } from 'mobx-tanstack-query';
2
+ /**
3
+ * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoint-mutations/)
4
+ */
2
5
  export class EndpointMutation extends Mutation {
3
6
  endpoint;
4
7
  constructor(endpoint, queryClient, { transform: transformResponse, invalidateEndpoints, ...mutationOptions }) {
@@ -1,6 +1,11 @@
1
1
  import { type InvalidateOptions } from '@tanstack/query-core';
2
2
  import { QueryClient, type QueryClientConfig } from 'mobx-tanstack-query';
3
3
  import type { InvalidateEndpointsFilters } from './endpoint-query-client.types.js';
4
+ /**
5
+ * Class that extends `QueryClient` and gives a bit more control over endpoint queries and mutations.
6
+ *
7
+ * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoint-query-client/)
8
+ */
4
9
  export declare class EndpointQueryClient extends QueryClient {
5
10
  constructor(config?: QueryClientConfig);
6
11
  invalidateEndpoints({ group, namespace, operationId, tag, predicate, endpoint, ...queryFilters }: InvalidateEndpointsFilters, options?: InvalidateOptions): Promise<void>;
@@ -1 +1 @@
1
- {"version":3,"file":"endpoint-query-client.d.ts","sourceRoot":"","sources":["../../src/runtime/endpoint-query-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,KAAK,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACvE,OAAO,EAAE,WAAW,EAAE,KAAK,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAG1E,OAAO,KAAK,EAEV,0BAA0B,EAC3B,MAAM,kCAAkC,CAAC;AAE1C,qBAAa,mBAAoB,SAAQ,WAAW;gBACtC,MAAM,CAAC,EAAE,iBAAiB;IActC,mBAAmB,CACjB,EACE,KAAK,EACL,SAAS,EACT,WAAW,EACX,GAAG,EACH,SAAS,EACT,QAAQ,EACR,GAAG,YAAY,EAChB,EAAE,0BAA0B,EAC7B,OAAO,CAAC,EAAE,iBAAiB;CAgE9B"}
1
+ {"version":3,"file":"endpoint-query-client.d.ts","sourceRoot":"","sources":["../../src/runtime/endpoint-query-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,KAAK,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACvE,OAAO,EAAE,WAAW,EAAE,KAAK,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAG1E,OAAO,KAAK,EAEV,0BAA0B,EAC3B,MAAM,kCAAkC,CAAC;AAE1C;;;;GAIG;AACH,qBAAa,mBAAoB,SAAQ,WAAW;gBACtC,MAAM,CAAC,EAAE,iBAAiB;IActC,mBAAmB,CACjB,EACE,KAAK,EACL,SAAS,EACT,WAAW,EACX,GAAG,EACH,SAAS,EACT,QAAQ,EACR,GAAG,YAAY,EAChB,EAAE,0BAA0B,EAC7B,OAAO,CAAC,EAAE,iBAAiB;CAgE9B"}
@@ -1,5 +1,10 @@
1
1
  import { hashKey } from '@tanstack/query-core';
2
2
  import { QueryClient } from 'mobx-tanstack-query';
3
+ /**
4
+ * Class that extends `QueryClient` and gives a bit more control over endpoint queries and mutations.
5
+ *
6
+ * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoint-query-client/)
7
+ */
3
8
  export class EndpointQueryClient extends QueryClient {
4
9
  constructor(config) {
5
10
  super({
@@ -5,6 +5,9 @@ import type { AnyObject, Maybe, MaybeFalsy } from 'yummies/utils/types';
5
5
  import type { AnyEndpoint } from './endpoint.types.js';
6
6
  import type { EndpointQueryFlattenOptions, EndpointQueryOptions, EndpointQueryUniqKey, ExcludedQueryKeys } from './endpoint-query.types.js';
7
7
  import type { EndpointQueryClient } from './endpoint-query-client.js';
8
+ /**
9
+ * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoint-queries/)
10
+ */
8
11
  export declare class EndpointQuery<TEndpoint extends AnyEndpoint, TQueryFnData = TEndpoint['__response']['data'], TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData> extends Query<TQueryFnData, TError, TData, TQueryData> {
9
12
  private endpoint;
10
13
  private _observableData;
@@ -1 +1 @@
1
- {"version":3,"file":"endpoint-query.d.ts","sourceRoot":"","sources":["../../src/runtime/endpoint-query.ts"],"names":[],"mappings":"AAAA,yEAAyE;AACzE,OAAO,KAAK,EACV,YAAY,EACZ,oBAAoB,EACpB,mBAAmB,EACnB,cAAc,EACf,MAAM,sBAAsB,CAAC;AAS9B,OAAO,EAAE,KAAK,EAAE,KAAK,6BAA6B,EAAE,MAAM,qBAAqB,CAAC;AAGhF,OAAO,KAAK,EACV,SAAS,EACT,KAAK,EACL,UAAU,EAEX,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EACV,2BAA2B,EAC3B,oBAAoB,EACpB,oBAAoB,EACpB,iBAAiB,EAClB,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AAWtE,qBAAa,aAAa,CACxB,SAAS,SAAS,WAAW,EAC7B,YAAY,GAAG,SAAS,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,EAC9C,MAAM,GAAG,YAAY,EACrB,KAAK,GAAG,YAAY,EACpB,UAAU,GAAG,YAAY,CACzB,SAAQ,KAAK,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,CAAC;IAIpD,OAAO,CAAC,QAAQ;IAHlB,OAAO,CAAC,eAAe,CAAoC;gBAGjD,QAAQ,EAAE,WAAW,EAC7B,WAAW,EAAE,mBAAmB,EAChC,iBAAiB,EACb,oBAAoB,CAAC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,CAAC,GACxE,CAAC,MAAM,2BAA2B,CAChC,SAAS,EACT,YAAY,EACZ,MAAM,EACN,KAAK,EACL,UAAU,CACX,CAAC;IAqLR,IAAI,MAAM,sCAET;IAED,IAAI,QAAQ,mCAEX;IAED,MAAM,CACJ,YAAY,EAAE,IAAI,CAChB,6BAA6B,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,CAAC,EACtE,iBAAiB,CAClB,GAAG;QACF,MAAM,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC;KAC5C;IA6BH,OAAO,CACL,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAOxC,KAAK,CACT,MAAM,EAAE,UAAU,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,GACxC,OAAO,CAAC,mBAAmB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAa9C,OAAO,IAAI,IAAI;CAOhB;AAED,eAAO,MAAM,oBAAoB,GAAI,KAAK,oBAAoB,CAAC,GAAG,EAAE,GAAG,CAAC,KAChC,WAAW,CAAC,UAAU,CAC7D,CAAC;AAEF,eAAO,MAAM,sBAAsB,GACjC,UAAU,WAAW,EACrB,QAAQ,UAAU,CAAC,SAAS,CAAC,EAC7B,SAAS,KAAK,CAAC,oBAAoB,CAAC,KACnC;IAAE,OAAO,EAAE,OAAO,CAAC;IAAC,QAAQ,EAAE,GAAG,EAAE,CAAA;CAerC,CAAC"}
1
+ {"version":3,"file":"endpoint-query.d.ts","sourceRoot":"","sources":["../../src/runtime/endpoint-query.ts"],"names":[],"mappings":"AAAA,yEAAyE;AACzE,OAAO,KAAK,EACV,YAAY,EACZ,oBAAoB,EACpB,mBAAmB,EACnB,cAAc,EACf,MAAM,sBAAsB,CAAC;AAS9B,OAAO,EAAE,KAAK,EAAE,KAAK,6BAA6B,EAAE,MAAM,qBAAqB,CAAC;AAGhF,OAAO,KAAK,EACV,SAAS,EACT,KAAK,EACL,UAAU,EAEX,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EACV,2BAA2B,EAC3B,oBAAoB,EACpB,oBAAoB,EACpB,iBAAiB,EAClB,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AAWtE;;GAEG;AACH,qBAAa,aAAa,CACxB,SAAS,SAAS,WAAW,EAC7B,YAAY,GAAG,SAAS,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,EAC9C,MAAM,GAAG,YAAY,EACrB,KAAK,GAAG,YAAY,EACpB,UAAU,GAAG,YAAY,CACzB,SAAQ,KAAK,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,CAAC;IAIpD,OAAO,CAAC,QAAQ;IAHlB,OAAO,CAAC,eAAe,CAAoC;gBAGjD,QAAQ,EAAE,WAAW,EAC7B,WAAW,EAAE,mBAAmB,EAChC,iBAAiB,EACb,oBAAoB,CAAC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,CAAC,GACxE,CAAC,MAAM,2BAA2B,CAChC,SAAS,EACT,YAAY,EACZ,MAAM,EACN,KAAK,EACL,UAAU,CACX,CAAC;IAqLR,IAAI,MAAM,sCAET;IAED,IAAI,QAAQ,mCAEX;IAED,MAAM,CACJ,YAAY,EAAE,IAAI,CAChB,6BAA6B,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,CAAC,EACtE,iBAAiB,CAClB,GAAG;QACF,MAAM,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC;KAC5C;IA6BH,OAAO,CACL,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAOxC,KAAK,CACT,MAAM,EAAE,UAAU,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,GACxC,OAAO,CAAC,mBAAmB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAa9C,OAAO,IAAI,IAAI;CAOhB;AAED,eAAO,MAAM,oBAAoB,GAAI,KAAK,oBAAoB,CAAC,GAAG,EAAE,GAAG,CAAC,KAChC,WAAW,CAAC,UAAU,CAC7D,CAAC;AAEF,eAAO,MAAM,sBAAsB,GACjC,UAAU,WAAW,EACrB,QAAQ,UAAU,CAAC,SAAS,CAAC,EAC7B,SAAS,KAAK,CAAC,oBAAoB,CAAC,KACnC;IAAE,OAAO,EAAE,OAAO,CAAC;IAAC,QAAQ,EAAE,GAAG,EAAE,CAAA;CAerC,CAAC"}
@@ -2,6 +2,9 @@ import { comparer, computed, makeObservable, observable, reaction, runInAction,
2
2
  import { Query } from 'mobx-tanstack-query';
3
3
  import { callFunction } from 'yummies/common';
4
4
  import { getMobxAdministration, lazyObserve } from 'yummies/mobx';
5
+ /**
6
+ * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoint-queries/)
7
+ */
5
8
  export class EndpointQuery extends Query {
6
9
  endpoint;
7
10
  _observableData;
@@ -13,6 +13,11 @@ import type { HttpClient, HttpResponse } from './http-client.js';
13
13
  export interface Endpoint<TResponse extends HttpResponse<any, any>, TParams extends AnyObject, TMetaData extends AnyObject = AnyObject> {
14
14
  (...args: IsPartial<TParams> extends true ? [params?: Maybe<TParams>] : [params: TParams]): ReturnType<Endpoint<TResponse, TParams, TMetaData>['request']>;
15
15
  }
16
+ /**
17
+ * This class is a wrapper for your http request.
18
+ *
19
+ * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoints/)
20
+ */
16
21
  export declare class Endpoint<TResponse extends HttpResponse<any, any>, TParams extends AnyObject, TMetaData extends AnyObject = AnyObject> {
17
22
  configuration: EndpointConfiguration<NoInfer<TParams>, TMetaData>;
18
23
  queryClient: EndpointQueryClient;
@@ -1 +1 @@
1
- {"version":3,"file":"endpoint.d.ts","sourceRoot":"","sources":["../../src/runtime/endpoint.ts"],"names":[],"mappings":"AAAA,6HAA6H;AAC7H,OAAO,KAAK,EACV,YAAY,EACZ,iBAAiB,EACjB,sBAAsB,EACvB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,KAAK,EACV,qBAAqB,EACrB,uBAAuB,EACxB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AACrE,OAAO,KAAK,EACV,mCAAmC,EACnC,4BAA4B,EAC7B,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAC5E,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,KAAK,EACV,2BAA2B,EAE3B,oBAAoB,EACpB,oBAAoB,EACrB,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACtE,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,SAAS,CAAC,OAAO,CAAC,SAAS,IAAI,GACpC,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,GACzB,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;IACjE,WAAW,EAAE,mBAAmB;IAChC,UAAU,EAAE,UAAU;IAhB/B,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,EACjE,WAAW,EAAE,mBAAmB,EAChC,UAAU,EAAE,UAAU;IAmC/B,UAAU,CACR,GAAG,IAAI,EAAE,SAAS,CAAC,OAAO,CAAC,SAAS,IAAI,GACpC,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,GACzB,CAAC,MAAM,EAAE,OAAO,CAAC,GACpB,MAAM;IAKT,OAAO,CACL,GAAG,IAAI,EAAE,SAAS,CAAC,OAAO,CAAC,SAAS,IAAI,GACpC,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,GACzB,CAAC,MAAM,EAAE,OAAO,CAAC,GACpB,MAAM;IAKT,IAAI,IAAI,aAEP;IAED,IAAI,IAAI,aAEP;IAED,IAAI,eAAe,WAElB;IAED,IAAI,WAAW,WAEd;IAED,IAAI,KAAK,uBAER;IAED,IAAI,SAAS,uBAEZ;IAED,OAAO,CACL,GAAG,IAAI,EAAE,SAAS,CAAC,OAAO,CAAC,SAAS,IAAI,GACpC,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,GACzB,CAAC,MAAM,EAAE,OAAO,CAAC;IAOvB,WAAW,GAAI,OAAO,SAAS;;;;;;;MASE;IAEjC,UAAU,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,GAAG;IASxE,kBAAkB,CAChB,MAAM,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,EACvB,OAAO,CAAC,EAAE,oBAAoB,GAC7B,GAAG;IAUN,eAAe,CACb,GAAG,IAAI,EAAE,SAAS,CAAC,OAAO,CAAC,SAAS,IAAI,GACpC;QACE,MAAM,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC;QACvB,OAAO,CAAC,EAAE,sBAAsB,GAAG;YAAE,OAAO,CAAC,EAAE,oBAAoB,CAAA;SAAE;QACrE,OAAO,CAAC,EAAE,iBAAiB;KAC5B,GACD;QACE,MAAM,EAAE,OAAO;QACf,OAAO,CAAC,EAAE,sBAAsB,GAAG;YAAE,OAAO,CAAC,EAAE,oBAAoB,CAAA;SAAE;QACrE,OAAO,CAAC,EAAE,iBAAiB;KAC5B;IAYP,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,EACH,oBAAoB,CAAC,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,CAAC,GACnE,CAAC,MAAM,2BAA2B,CAChC,IAAI,EACJ,YAAY,EACZ,MAAM,EACN,KAAK,EACL,UAAU,CACX,CAAC;IASR,eAAe,CACb,KAAK,GAAG,SAAS,CAAC,MAAM,CAAC,EACzB,MAAM,GAAG,YAAY,EACrB,UAAU,GAAG,OAAO,EAEpB,OAAO,EACH,4BAA4B,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,GAC7D,CAAC,MAAM,mCAAmC,CACxC,IAAI,EACJ,KAAK,EACL,MAAM,EACN,UAAU,CACX,CAAC;CAQT"}
1
+ {"version":3,"file":"endpoint.d.ts","sourceRoot":"","sources":["../../src/runtime/endpoint.ts"],"names":[],"mappings":"AAAA,6HAA6H;AAC7H,OAAO,KAAK,EACV,YAAY,EACZ,iBAAiB,EACjB,sBAAsB,EACvB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,KAAK,EACV,qBAAqB,EACrB,uBAAuB,EACxB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AACrE,OAAO,KAAK,EACV,mCAAmC,EACnC,4BAA4B,EAC7B,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAC5E,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,KAAK,EACV,2BAA2B,EAE3B,oBAAoB,EACpB,oBAAoB,EACrB,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACtE,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,SAAS,CAAC,OAAO,CAAC,SAAS,IAAI,GACpC,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,GACzB,CAAC,MAAM,EAAE,OAAO,CAAC,GACpB,UAAU,CAAC,QAAQ,CAAC,SAAS,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;CACnE;AAED;;;;GAIG;AACH,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;IACjE,WAAW,EAAE,mBAAmB;IAChC,UAAU,EAAE,UAAU;IAhB/B,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,EACjE,WAAW,EAAE,mBAAmB,EAChC,UAAU,EAAE,UAAU;IAmC/B,UAAU,CACR,GAAG,IAAI,EAAE,SAAS,CAAC,OAAO,CAAC,SAAS,IAAI,GACpC,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,GACzB,CAAC,MAAM,EAAE,OAAO,CAAC,GACpB,MAAM;IAKT,OAAO,CACL,GAAG,IAAI,EAAE,SAAS,CAAC,OAAO,CAAC,SAAS,IAAI,GACpC,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,GACzB,CAAC,MAAM,EAAE,OAAO,CAAC,GACpB,MAAM;IAKT,IAAI,IAAI,aAEP;IAED,IAAI,IAAI,aAEP;IAED,IAAI,eAAe,WAElB;IAED,IAAI,WAAW,WAEd;IAED,IAAI,KAAK,uBAER;IAED,IAAI,SAAS,uBAEZ;IAED,OAAO,CACL,GAAG,IAAI,EAAE,SAAS,CAAC,OAAO,CAAC,SAAS,IAAI,GACpC,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,GACzB,CAAC,MAAM,EAAE,OAAO,CAAC;IAOvB,WAAW,GAAI,OAAO,SAAS;;;;;;;MASE;IAEjC,UAAU,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,GAAG;IASxE,kBAAkB,CAChB,MAAM,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,EACvB,OAAO,CAAC,EAAE,oBAAoB,GAC7B,GAAG;IAUN,eAAe,CACb,GAAG,IAAI,EAAE,SAAS,CAAC,OAAO,CAAC,SAAS,IAAI,GACpC;QACE,MAAM,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC;QACvB,OAAO,CAAC,EAAE,sBAAsB,GAAG;YAAE,OAAO,CAAC,EAAE,oBAAoB,CAAA;SAAE;QACrE,OAAO,CAAC,EAAE,iBAAiB;KAC5B,GACD;QACE,MAAM,EAAE,OAAO;QACf,OAAO,CAAC,EAAE,sBAAsB,GAAG;YAAE,OAAO,CAAC,EAAE,oBAAoB,CAAA;SAAE;QACrE,OAAO,CAAC,EAAE,iBAAiB;KAC5B;IAYP,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,EACH,oBAAoB,CAAC,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,CAAC,GACnE,CAAC,MAAM,2BAA2B,CAChC,IAAI,EACJ,YAAY,EACZ,MAAM,EACN,KAAK,EACL,UAAU,CACX,CAAC;IASR,eAAe,CACb,KAAK,GAAG,SAAS,CAAC,MAAM,CAAC,EACzB,MAAM,GAAG,YAAY,EACrB,UAAU,GAAG,OAAO,EAEpB,OAAO,EACH,4BAA4B,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,GAC7D,CAAC,MAAM,mCAAmC,CACxC,IAAI,EACJ,KAAK,EACL,MAAM,EACN,UAAU,CACX,CAAC;CAQT"}
@@ -2,6 +2,11 @@ import { callFunction } from 'yummies/common';
2
2
  import { EndpointInfiniteQuery } from './endpoint-infinite-query.js';
3
3
  import { EndpointMutation } from './endpoint-mutation.js';
4
4
  import { EndpointQuery } from './endpoint-query.js';
5
+ /**
6
+ * This class is a wrapper for your http request.
7
+ *
8
+ * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoints/)
9
+ */
5
10
  export class Endpoint {
6
11
  configuration;
7
12
  queryClient;