@openapi-qraft/tanstack-query-react-types 2.1.0 → 2.1.1

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 (14) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/dist/types/service-operation/ServiceOperationIsMutatingQueries.d.ts +1 -1
  3. package/dist/types/service-operation/ServiceOperationIsMutatingQueries.d.ts.map +1 -1
  4. package/dist/types/service-operation/ServiceOperationUseIsMutating.d.ts +1 -1
  5. package/dist/types/service-operation/ServiceOperationUseIsMutating.d.ts.map +1 -1
  6. package/dist/types/service-operation/ServiceOperationUseMutation.d.ts +2 -2
  7. package/dist/types/service-operation/ServiceOperationUseMutation.d.ts.map +1 -1
  8. package/dist/types/service-operation/ServiceOperationUseMutationState.d.ts +3 -3
  9. package/dist/types/service-operation/ServiceOperationUseMutationState.d.ts.map +1 -1
  10. package/package.json +1 -1
  11. package/src/service-operation/ServiceOperationIsMutatingQueries.ts +2 -2
  12. package/src/service-operation/ServiceOperationUseIsMutating.ts +2 -2
  13. package/src/service-operation/ServiceOperationUseMutation.ts +2 -2
  14. package/src/service-operation/ServiceOperationUseMutationState.ts +4 -4
package/CHANGELOG.md CHANGED
@@ -1,5 +1,12 @@
1
1
  # @openapi-qraft/tanstack-query-react-types
2
2
 
3
+ ## 2.1.1
4
+
5
+ ### Patch Changes
6
+
7
+ - 8a52230: Enhanced type consistency: now, in addition to the standard errors declared in the OpenAPI Document, all methods and
8
+ hook-off mutations will also return the `Error` type.
9
+
3
10
  ## 2.1.0
4
11
 
5
12
  ## 2.1.0-beta.0
package/dist/types/service-operation/ServiceOperationIsMutatingQueries.d.ts CHANGED
@@ -3,6 +3,6 @@ export interface ServiceOperationIsMutatingQueries<TSchema extends {
3
3
  url: string;
4
4
  method: string;
5
5
  }, TBody, TMutationData, TParams, TError> {
6
- isMutating<TContext>(filters?: MutationFiltersByParameters<TBody, TMutationData, TParams, TError, TContext> | MutationFiltersByMutationKey<TSchema, TBody, TMutationData, TParams, TError, TContext>): number;
6
+ isMutating<TContext>(filters?: MutationFiltersByParameters<TBody, TMutationData, TParams, TError | Error, TContext> | MutationFiltersByMutationKey<TSchema, TBody, TMutationData, TParams, TError | Error, TContext>): number;
7
7
  }
8
8
  //# sourceMappingURL=ServiceOperationIsMutatingQueries.d.ts.map
package/dist/types/service-operation/ServiceOperationIsMutatingQueries.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"ServiceOperationIsMutatingQueries.d.ts","sourceRoot":"","sources":["../../../src/service-operation/ServiceOperationIsMutatingQueries.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,4BAA4B,EAC5B,2BAA2B,EAC5B,MAAM,2CAA2C,CAAC;AAEnD,MAAM,WAAW,iCAAiC,CAChD,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,KAAK,EACL,aAAa,EACb,OAAO,EACP,MAAM;IAEN,UAAU,CAAC,QAAQ,EACjB,OAAO,CAAC,EACJ,2BAA2B,CACzB,KAAK,EACL,aAAa,EACb,OAAO,EACP,MAAM,EACN,QAAQ,CACT,GACD,4BAA4B,CAC1B,OAAO,EACP,KAAK,EACL,aAAa,EACb,OAAO,EACP,MAAM,EACN,QAAQ,CACT,GACJ,MAAM,CAAC;CACX"}
1
+ {"version":3,"file":"ServiceOperationIsMutatingQueries.d.ts","sourceRoot":"","sources":["../../../src/service-operation/ServiceOperationIsMutatingQueries.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,4BAA4B,EAC5B,2BAA2B,EAC5B,MAAM,2CAA2C,CAAC;AAEnD,MAAM,WAAW,iCAAiC,CAChD,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,KAAK,EACL,aAAa,EACb,OAAO,EACP,MAAM;IAEN,UAAU,CAAC,QAAQ,EACjB,OAAO,CAAC,EACJ,2BAA2B,CACzB,KAAK,EACL,aAAa,EACb,OAAO,EACP,MAAM,GAAG,KAAK,EACd,QAAQ,CACT,GACD,4BAA4B,CAC1B,OAAO,EACP,KAAK,EACL,aAAa,EACb,OAAO,EACP,MAAM,GAAG,KAAK,EACd,QAAQ,CACT,GACJ,MAAM,CAAC;CACX"}
package/dist/types/service-operation/ServiceOperationUseIsMutating.d.ts CHANGED
@@ -3,6 +3,6 @@ export interface ServiceOperationUseIsMutating<TSchema extends {
3
3
  url: string;
4
4
  method: string;
5
5
  }, TBody, TMutationData, TParams, TError> {
6
- useIsMutating<TContext = unknown>(filters?: MutationFiltersByParameters<TBody, TMutationData, TParams, TError, TContext> | MutationFiltersByMutationKey<TSchema, TBody, TMutationData, TParams, TError, TContext>): number;
6
+ useIsMutating<TContext = unknown>(filters?: MutationFiltersByParameters<TBody, TMutationData, TParams, TError | Error, TContext> | MutationFiltersByMutationKey<TSchema, TBody, TMutationData, TParams, TError | Error, TContext>): number;
7
7
  }
8
8
  //# sourceMappingURL=ServiceOperationUseIsMutating.d.ts.map
package/dist/types/service-operation/ServiceOperationUseIsMutating.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"ServiceOperationUseIsMutating.d.ts","sourceRoot":"","sources":["../../../src/service-operation/ServiceOperationUseIsMutating.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,4BAA4B,EAC5B,2BAA2B,EAC5B,MAAM,2CAA2C,CAAC;AAEnD,MAAM,WAAW,6BAA6B,CAC5C,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,KAAK,EACL,aAAa,EACb,OAAO,EACP,MAAM;IAEN,aAAa,CAAC,QAAQ,GAAG,OAAO,EAC9B,OAAO,CAAC,EACJ,2BAA2B,CACzB,KAAK,EACL,aAAa,EACb,OAAO,EACP,MAAM,EACN,QAAQ,CACT,GACD,4BAA4B,CAC1B,OAAO,EACP,KAAK,EACL,aAAa,EACb,OAAO,EACP,MAAM,EACN,QAAQ,CACT,GACJ,MAAM,CAAC;CACX"}
1
+ {"version":3,"file":"ServiceOperationUseIsMutating.d.ts","sourceRoot":"","sources":["../../../src/service-operation/ServiceOperationUseIsMutating.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,4BAA4B,EAC5B,2BAA2B,EAC5B,MAAM,2CAA2C,CAAC;AAEnD,MAAM,WAAW,6BAA6B,CAC5C,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,KAAK,EACL,aAAa,EACb,OAAO,EACP,MAAM;IAEN,aAAa,CAAC,QAAQ,GAAG,OAAO,EAC9B,OAAO,CAAC,EACJ,2BAA2B,CACzB,KAAK,EACL,aAAa,EACb,OAAO,EACP,MAAM,GAAG,KAAK,EACd,QAAQ,CACT,GACD,4BAA4B,CAC1B,OAAO,EACP,KAAK,EACL,aAAa,EACb,OAAO,EACP,MAAM,GAAG,KAAK,EACd,QAAQ,CACT,GACJ,MAAM,CAAC;CACX"}
package/dist/types/service-operation/ServiceOperationUseMutation.d.ts CHANGED
@@ -5,7 +5,7 @@ export interface ServiceOperationUseMutation<TSchema extends {
5
5
  method: string;
6
6
  }, TBody, TMutationData, TParams, TError> {
7
7
  getMutationKey(parameters: TParams | void): ServiceOperationMutationKey<TSchema, TParams>;
8
- useMutation<TVariables extends TBody, TContext = unknown>(parameters: TParams, options?: ServiceOperationUseMutationOptions<TSchema, TMutationData, TParams, TVariables, TError, TContext>): UseMutationResult<TMutationData, TError | Error, AreAllOptional<TVariables> extends true ? TVariables | void : TVariables, TContext>;
9
- useMutation<TVariables extends MutationVariables<TBody, TParams>, TContext = unknown>(parameters: void, options?: ServiceOperationUseMutationOptions<TSchema, TMutationData, TParams, TVariables, TError, TContext>): UseMutationResult<TMutationData, TError | Error, TVariables, TContext>;
8
+ useMutation<TVariables extends TBody, TContext = unknown>(parameters: TParams, options?: ServiceOperationUseMutationOptions<TSchema, TMutationData, TParams, TVariables, TError | Error, TContext>): UseMutationResult<TMutationData, TError | Error, AreAllOptional<TVariables> extends true ? TVariables | void : TVariables, TContext>;
9
+ useMutation<TVariables extends MutationVariables<TBody, TParams>, TContext = unknown>(parameters: void, options?: ServiceOperationUseMutationOptions<TSchema, TMutationData, TParams, TVariables, TError | Error, TContext>): UseMutationResult<TMutationData, TError | Error, TVariables, TContext>;
10
10
  }
11
11
  //# sourceMappingURL=ServiceOperationUseMutation.d.ts.map
package/dist/types/service-operation/ServiceOperationUseMutation.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"ServiceOperationUseMutation.d.ts","sourceRoot":"","sources":["../../../src/service-operation/ServiceOperationUseMutation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,iBAAiB,EACjB,2BAA2B,EAC3B,kCAAkC,EACnC,MAAM,2CAA2C,CAAC;AACnD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAE/D,MAAM,WAAW,2BAA2B,CAC1C,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,KAAK,EACL,aAAa,EACb,OAAO,EACP,MAAM;IAEN,cAAc,CACZ,UAAU,EAAE,OAAO,GAAG,IAAI,GACzB,2BAA2B,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAEjD,WAAW,CAAC,UAAU,SAAS,KAAK,EAAE,QAAQ,GAAG,OAAO,EACtD,UAAU,EAAE,OAAO,EACnB,OAAO,CAAC,EAAE,kCAAkC,CAC1C,OAAO,EACP,aAAa,EACb,OAAO,EACP,UAAU,EACV,MAAM,EACN,QAAQ,CACT,GACA,iBAAiB,CAClB,aAAa,EACb,MAAM,GAAG,KAAK,EACd,cAAc,CAAC,UAAU,CAAC,SAAS,IAAI,GAAG,UAAU,GAAG,IAAI,GAAG,UAAU,EACxE,QAAQ,CACT,CAAC;IAEF,WAAW,CACT,UAAU,SAAS,iBAAiB,CAAC,KAAK,EAAE,OAAO,CAAC,EACpD,QAAQ,GAAG,OAAO,EAElB,UAAU,EAAE,IAAI,EAChB,OAAO,CAAC,EAAE,kCAAkC,CAC1C,OAAO,EACP,aAAa,EACb,OAAO,EACP,UAAU,EACV,MAAM,EACN,QAAQ,CACT,GACA,iBAAiB,CAAC,aAAa,EAAE,MAAM,GAAG,KAAK,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;CAC3E"}
1
+ {"version":3,"file":"ServiceOperationUseMutation.d.ts","sourceRoot":"","sources":["../../../src/service-operation/ServiceOperationUseMutation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,iBAAiB,EACjB,2BAA2B,EAC3B,kCAAkC,EACnC,MAAM,2CAA2C,CAAC;AACnD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAE/D,MAAM,WAAW,2BAA2B,CAC1C,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,KAAK,EACL,aAAa,EACb,OAAO,EACP,MAAM;IAEN,cAAc,CACZ,UAAU,EAAE,OAAO,GAAG,IAAI,GACzB,2BAA2B,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAEjD,WAAW,CAAC,UAAU,SAAS,KAAK,EAAE,QAAQ,GAAG,OAAO,EACtD,UAAU,EAAE,OAAO,EACnB,OAAO,CAAC,EAAE,kCAAkC,CAC1C,OAAO,EACP,aAAa,EACb,OAAO,EACP,UAAU,EACV,MAAM,GAAG,KAAK,EACd,QAAQ,CACT,GACA,iBAAiB,CAClB,aAAa,EACb,MAAM,GAAG,KAAK,EACd,cAAc,CAAC,UAAU,CAAC,SAAS,IAAI,GAAG,UAAU,GAAG,IAAI,GAAG,UAAU,EACxE,QAAQ,CACT,CAAC;IAEF,WAAW,CACT,UAAU,SAAS,iBAAiB,CAAC,KAAK,EAAE,OAAO,CAAC,EACpD,QAAQ,GAAG,OAAO,EAElB,UAAU,EAAE,IAAI,EAChB,OAAO,CAAC,EAAE,kCAAkC,CAC1C,OAAO,EACP,aAAa,EACb,OAAO,EACP,UAAU,EACV,MAAM,GAAG,KAAK,EACd,QAAQ,CACT,GACA,iBAAiB,CAAC,aAAa,EAAE,MAAM,GAAG,KAAK,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;CAC3E"}
package/dist/types/service-operation/ServiceOperationUseMutationState.d.ts CHANGED
@@ -4,9 +4,9 @@ export interface ServiceOperationUseMutationState<TSchema extends {
4
4
  url: string;
5
5
  method: string;
6
6
  }, TBody, TMutationData, TParams, TError> {
7
- useMutationState<TContext = unknown, TResult = MutationState<TMutationData, TError, MutationVariables<TBody, TParams>, TContext>>(options?: {
8
- filters?: MutationFiltersByParameters<TBody, TMutationData, TParams, TError, TContext> | MutationFiltersByMutationKey<TSchema, TBody, TMutationData, TParams, TError, TContext>;
9
- select?: (mutation: Mutation<TMutationData, TError, MutationVariables<TBody, TParams>, TContext>) => TResult;
7
+ useMutationState<TContext = unknown, TResult = MutationState<TMutationData, TError | Error, MutationVariables<TBody, TParams>, TContext>>(options?: {
8
+ filters?: MutationFiltersByParameters<TBody, TMutationData, TParams, TError | Error, TContext> | MutationFiltersByMutationKey<TSchema, TBody, TMutationData, TParams, TError | Error, TContext>;
9
+ select?: (mutation: Mutation<TMutationData, TError | Error, MutationVariables<TBody, TParams>, TContext>) => TResult;
10
10
  }): Array<TResult>;
11
11
  }
12
12
  //# sourceMappingURL=ServiceOperationUseMutationState.d.ts.map
package/dist/types/service-operation/ServiceOperationUseMutationState.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"ServiceOperationUseMutationState.d.ts","sourceRoot":"","sources":["../../../src/service-operation/ServiceOperationUseMutationState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,4BAA4B,EAC5B,2BAA2B,EAC3B,iBAAiB,EAClB,MAAM,2CAA2C,CAAC;AACnD,OAAO,KAAK,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAEpE,MAAM,WAAW,gCAAgC,CAC/C,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,KAAK,EACL,aAAa,EACb,OAAO,EACP,MAAM;IAEN,gBAAgB,CACd,QAAQ,GAAG,OAAO,EAClB,OAAO,GAAG,aAAa,CACrB,aAAa,EACb,MAAM,EACN,iBAAiB,CAAC,KAAK,EAAE,OAAO,CAAC,EACjC,QAAQ,CACT,EACD,OAAO,CAAC,EAAE;QACV,OAAO,CAAC,EACJ,2BAA2B,CACzB,KAAK,EACL,aAAa,EACb,OAAO,EACP,MAAM,EACN,QAAQ,CACT,GACD,4BAA4B,CAC1B,OAAO,EACP,KAAK,EACL,aAAa,EACb,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;QACN,MAAM,CAAC,EAAE,CACP,QAAQ,EAAE,QAAQ,CAChB,aAAa,EACb,MAAM,EACN,iBAAiB,CAAC,KAAK,EAAE,OAAO,CAAC,EACjC,QAAQ,CACT,KACE,OAAO,CAAC;KACd,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;CACpB"}
1
+ {"version":3,"file":"ServiceOperationUseMutationState.d.ts","sourceRoot":"","sources":["../../../src/service-operation/ServiceOperationUseMutationState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,4BAA4B,EAC5B,2BAA2B,EAC3B,iBAAiB,EAClB,MAAM,2CAA2C,CAAC;AACnD,OAAO,KAAK,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAEpE,MAAM,WAAW,gCAAgC,CAC/C,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,KAAK,EACL,aAAa,EACb,OAAO,EACP,MAAM;IAEN,gBAAgB,CACd,QAAQ,GAAG,OAAO,EAClB,OAAO,GAAG,aAAa,CACrB,aAAa,EACb,MAAM,GAAG,KAAK,EACd,iBAAiB,CAAC,KAAK,EAAE,OAAO,CAAC,EACjC,QAAQ,CACT,EACD,OAAO,CAAC,EAAE;QACV,OAAO,CAAC,EACJ,2BAA2B,CACzB,KAAK,EACL,aAAa,EACb,OAAO,EACP,MAAM,GAAG,KAAK,EACd,QAAQ,CACT,GACD,4BAA4B,CAC1B,OAAO,EACP,KAAK,EACL,aAAa,EACb,OAAO,EACP,MAAM,GAAG,KAAK,EACd,QAAQ,CACT,CAAC;QACN,MAAM,CAAC,EAAE,CACP,QAAQ,EAAE,QAAQ,CAChB,aAAa,EACb,MAAM,GAAG,KAAK,EACd,iBAAiB,CAAC,KAAK,EAAE,OAAO,CAAC,EACjC,QAAQ,CACT,KACE,OAAO,CAAC;KACd,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;CACpB"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openapi-qraft/tanstack-query-react-types",
3
- "version": "2.1.0",
3
+ "version": "2.1.1",
4
4
  "scripts": {
5
5
  "build": "yarn clean && NODE_ENV=production rollup --config rollup.config.mjs && tsc --project tsconfig.build.json --emitDeclarationOnly",
6
6
  "dev": "yarn clean && tsc --project tsconfig.build.json --watch --outDir ./dist/esm --noEmitOnError false",
package/src/service-operation/ServiceOperationIsMutatingQueries.ts CHANGED
@@ -16,7 +16,7 @@ export interface ServiceOperationIsMutatingQueries<
16
16
  TBody,
17
17
  TMutationData,
18
18
  TParams,
19
- TError,
19
+ TError | Error,
20
20
  TContext
21
21
  >
22
22
  | MutationFiltersByMutationKey<
@@ -24,7 +24,7 @@ export interface ServiceOperationIsMutatingQueries<
24
24
  TBody,
25
25
  TMutationData,
26
26
  TParams,
27
- TError,
27
+ TError | Error,
28
28
  TContext
29
29
  >
30
30
  ): number;
package/src/service-operation/ServiceOperationUseIsMutating.ts CHANGED
@@ -16,7 +16,7 @@ export interface ServiceOperationUseIsMutating<
16
16
  TBody,
17
17
  TMutationData,
18
18
  TParams,
19
- TError,
19
+ TError | Error,
20
20
  TContext
21
21
  >
22
22
  | MutationFiltersByMutationKey<
@@ -24,7 +24,7 @@ export interface ServiceOperationUseIsMutating<
24
24
  TBody,
25
25
  TMutationData,
26
26
  TParams,
27
- TError,
27
+ TError | Error,
28
28
  TContext
29
29
  >
30
30
  ): number;
package/src/service-operation/ServiceOperationUseMutation.ts CHANGED
@@ -24,7 +24,7 @@ export interface ServiceOperationUseMutation<
24
24
  TMutationData,
25
25
  TParams,
26
26
  TVariables,
27
- TError,
27
+ TError | Error,
28
28
  TContext
29
29
  >
30
30
  ): UseMutationResult<
@@ -44,7 +44,7 @@ export interface ServiceOperationUseMutation<
44
44
  TMutationData,
45
45
  TParams,
46
46
  TVariables,
47
- TError,
47
+ TError | Error,
48
48
  TContext
49
49
  >
50
50
  ): UseMutationResult<TMutationData, TError | Error, TVariables, TContext>;
package/src/service-operation/ServiceOperationUseMutationState.ts CHANGED
@@ -16,7 +16,7 @@ export interface ServiceOperationUseMutationState<
16
16
  TContext = unknown,
17
17
  TResult = MutationState<
18
18
  TMutationData,
19
- TError,
19
+ TError | Error,
20
20
  MutationVariables<TBody, TParams>,
21
21
  TContext
22
22
  >,
@@ -26,7 +26,7 @@ export interface ServiceOperationUseMutationState<
26
26
  TBody,
27
27
  TMutationData,
28
28
  TParams,
29
- TError,
29
+ TError | Error,
30
30
  TContext
31
31
  >
32
32
  | MutationFiltersByMutationKey<
@@ -34,13 +34,13 @@ export interface ServiceOperationUseMutationState<
34
34
  TBody,
35
35
  TMutationData,
36
36
  TParams,
37
- TError,
37
+ TError | Error,
38
38
  TContext
39
39
  >;
40
40
  select?: (
41
41
  mutation: Mutation<
42
42
  TMutationData,
43
- TError,
43
+ TError | Error,
44
44
  MutationVariables<TBody, TParams>,
45
45
  TContext
46
46
  >