Fix error type of operation created by createJson* (#265)

* fixed docs import typo * added default request error type to handle unknown coming from error generic param in queries * Revert "added default request error type to handle unknown coming from error generic param in queries" This reverts commit b7bb0ab. * replaced json query and json mutation error type to uncontrollable JsonApiRequest error * Error generic is removed in create_json_query and create_json_mutation and replaced with default JsonApiRequestsError
igorkamyshev · Feb 14, 2023 · 25c051f · 25c051f
1 parent 568cb3a
commit 25c051f
Show file tree

Hide file tree

Showing 8 changed files with 32 additions and 44 deletions.
diff --git a/.changeset/empty-mayflies-count.md b/.changeset/empty-mayflies-count.md
@@ -0,0 +1,5 @@
+---
+'@farfetched/core': patch
+---
+
+Error generic is removed in create_json_query and create_json_mutation and replaced with default JsonApiRequestsError
diff --git a/apps/website/docs/recipes/custom_mutation.md b/apps/website/docs/recipes/custom_mutation.md
@@ -23,7 +23,7 @@ function createAsyncStorageMutation({ storageKey }) {
 Of course, it looks pretty verbose, so Farfetched provides a special helper that aims to simplify creation of custom [_Mutation_](/api/primitives/mutation.md) factories — `createHeadlessMutation`. Let us rewrite provided example with this helper 👇
 
 ```ts
-import { createHeadlessMutation } from '@fafetched/core';
+import { createHeadlessMutation } from '@farfetched/core';
 
 function createAsyncStorageMutation({ storageKey }) {
   const executeFx = createEffect((value) =>

diff --git a/apps/website/docs/recipes/custom_query.md b/apps/website/docs/recipes/custom_query.md
@@ -24,7 +24,7 @@ function createAsyncStorageQuery({ storageKey }) {
 Of course, it looks pretty hard, so Farfetched provides a special helper that aims to simplify creation of custom [_Query_](/api/primitives/query) factories — `createHeadlessQuery`. Let us rewrite provided example with this helper 👇
 
 ```ts
-import { createHeadlessQuery } from '@fafetched/core';
+import { createHeadlessQuery } from '@farfetched/core';
 
 function createAsyncStorageQuery({ storageKey }) {
   const fetchFx = createEffect(() => asyncLocalStorage.getItem(storageKey));

diff --git a/packages/core/src/fetch/api.ts b/packages/core/src/fetch/api.ts
@@ -17,6 +17,7 @@ import { NonOptionalKeys } from '../libs/lohyphen';
 import {
   AbortError,
   HttpError,
+  InvalidDataError,
   NetworkError,
   PreparationError,
   TimeoutError,
@@ -153,6 +154,8 @@ export type ApiRequestError =
   | NetworkError
   | HttpError;
 
+export type JsonApiRequestError = ApiRequestError | InvalidDataError;
+
 export function createApiRequest<
   R extends CreationRequestConfig<B>,
   P,

diff --git a/packages/core/src/mutation/__tests__/create_json_mutation.test-d.ts b/packages/core/src/mutation/__tests__/create_json_mutation.test-d.ts
@@ -7,6 +7,7 @@ import { ExecutionMeta } from '../../remote_operation/type';
 import { declareParams } from '../../remote_operation/params';
 import { createJsonMutation } from '../create_json_mutation';
 import { Mutation } from '../type';
+import { JsonApiRequestError } from '../../fetch/api';
 
 describe('createJsonMutation', () => {
   test('no params and no body in GET', () => {
@@ -417,6 +418,8 @@ describe('createJsonMutation', () => {
       response: { contract: unknownContract },
     });
 
-    expectTypeOf(mutation).toEqualTypeOf<Mutation<void, unknown, unknown>>();
+    expectTypeOf(mutation).toEqualTypeOf<
+      Mutation<void, unknown, JsonApiRequestError>
+    >();
   });
 });
diff --git a/packages/core/src/mutation/create_json_mutation.ts b/packages/core/src/mutation/create_json_mutation.ts
@@ -3,7 +3,7 @@ import { attach, createEvent, Event, sample, type Json } from 'effector';
 import { Contract } from '../contract/type';
 import { unknownContract } from '../contract/unknown_contract';
 import { InvalidDataError } from '../errors/type';
-import { ApiRequestError, HttpMethod } from '../fetch/api';
+import { ApiRequestError, HttpMethod, JsonApiRequestError } from '../fetch/api';
 import { createJsonApiRequest } from '../fetch/json';
 import { FetchApiRecord } from '../fetch/lib';
 import { ParamsDeclaration } from '../remote_operation/params';
@@ -84,7 +84,6 @@ export function createJsonMutation<
   Params,
   Data,
   TransformedData,
-  Error,
   BodySource = void,
   QuerySource = void,
   HeadersSource = void,
@@ -111,17 +110,12 @@ export function createJsonMutation<
       status?: { expected: number | number[] };
     };
   }
-): Mutation<
-  Params,
-  TransformedData,
-  ApiRequestError | Error | InvalidDataError
->;
+): Mutation<Params, TransformedData, JsonApiRequestError>;
 
 // params + no mapData
 export function createJsonMutation<
   Params,
   Data,
-  Error,
   BodySource = void,
   QuerySource = void,
   HeadersSource = void,
@@ -142,13 +136,12 @@ export function createJsonMutation<
       status?: { expected: number | number[] };
     };
   }
-): Mutation<Params, Data, ApiRequestError | Error | InvalidDataError>;
+): Mutation<Params, Data, JsonApiRequestError>;
 
 // No params + mapData
 export function createJsonMutation<
   Data,
   TransformedData,
-  Error,
   BodySource = void,
   QuerySource = void,
   HeadersSource = void,
@@ -174,12 +167,11 @@ export function createJsonMutation<
       status?: { expected: number | number[] };
     };
   }
-): Mutation<void, TransformedData, ApiRequestError | Error | InvalidDataError>;
+): Mutation<void, TransformedData, JsonApiRequestError>;
 
 // No params + no mapData
 export function createJsonMutation<
   Data,
-  Error,
   BodySource = void,
   QuerySource = void,
   HeadersSource = void,
@@ -199,7 +191,7 @@ export function createJsonMutation<
       status?: { expected: number | number[] };
     };
   }
-): Mutation<void, Data, ApiRequestError | Error | InvalidDataError>;
+): Mutation<void, Data, JsonApiRequestError>;
 
 // -- Implementation --
 export function createJsonMutation(config: any): Mutation<any, any, any> {

diff --git a/packages/core/src/query/__tests__/create_json-query.test-d.ts b/packages/core/src/query/__tests__/create_json-query.test-d.ts
@@ -3,6 +3,7 @@ import { describe, test, expectTypeOf } from 'vitest';
 import { unknownContract } from '../../contract/unknown_contract';
 import { Query } from '../type';
 import { createJsonQuery } from '../create_json_query';
+import { JsonApiRequestError } from '../../fetch/api';
 
 describe('createJsonQuery', () => {
   test('allow to pass credentials', () => {
@@ -15,6 +16,8 @@ describe('createJsonQuery', () => {
       response: { contract: unknownContract },
     });
 
-    expectTypeOf(mutation).toEqualTypeOf<Query<void, unknown, unknown>>();
+    expectTypeOf(mutation).toEqualTypeOf<
+      Query<void, unknown, JsonApiRequestError>
+    >();
   });
 });
diff --git a/packages/core/src/query/create_json_query.ts b/packages/core/src/query/create_json_query.ts
@@ -2,7 +2,7 @@ import { attach, createEvent, Event, sample, type Json } from 'effector';
 
 import { Contract } from '../contract/type';
 import { createJsonApiRequest } from '../fetch/json';
-import { ApiRequestError, HttpMethod } from '../fetch/api';
+import { ApiRequestError, HttpMethod, JsonApiRequestError } from '../fetch/api';
 import {
   normalizeSourced,
   type SourcedField,
@@ -85,7 +85,6 @@ export function createJsonQuery<
   Params,
   Data,
   TransformedData,
-  Error,
   BodySource = void,
   QuerySource = void,
   HeadersSource = void,
@@ -111,13 +110,12 @@ export function createJsonQuery<
       validate?: Validator<TransformedData, Params, ValidationSource>;
     };
   }
-): Query<Params, TransformedData, ApiRequestError | Error | InvalidDataError>;
+): Query<Params, TransformedData, JsonApiRequestError>;
 
 export function createJsonQuery<
   Params,
   Data,
   TransformedData,
-  Error,
   BodySource = void,
   QuerySource = void,
   HeadersSource = void,
@@ -144,18 +142,12 @@ export function createJsonQuery<
       validate?: Validator<TransformedData, Params, ValidationSource>;
     };
   }
-): Query<
-  Params,
-  TransformedData,
-  ApiRequestError | Error | InvalidDataError,
-  TransformedData
->;
+): Query<Params, TransformedData, JsonApiRequestError, TransformedData>;
 
 // params + no mapData
 export function createJsonQuery<
   Params,
   Data,
-  Error,
   BodySource = void,
   QuerySource = void,
   HeadersSource = void,
@@ -175,12 +167,11 @@ export function createJsonQuery<
       validate?: Validator<Data, Params, ValidationSource>;
     };
   }
-): Query<Params, Data, ApiRequestError | Error | InvalidDataError>;
+): Query<Params, Data, JsonApiRequestError>;
 
 export function createJsonQuery<
   Params,
   Data,
-  Error,
   BodySource = void,
   QuerySource = void,
   HeadersSource = void,
@@ -201,13 +192,12 @@ export function createJsonQuery<
       validate?: Validator<Data, Params, ValidationSource>;
     };
   }
-): Query<Params, Data, ApiRequestError | Error | InvalidDataError, Data>;
+): Query<Params, Data, JsonApiRequestError, Data>;
 
 // No params + mapData
 export function createJsonQuery<
   Data,
   TransformedData,
-  Error,
   BodySource = void,
   QuerySource = void,
   HeadersSource = void,
@@ -232,12 +222,11 @@ export function createJsonQuery<
       validate?: Validator<TransformedData, void, ValidationSource>;
     };
   }
-): Query<void, TransformedData, ApiRequestError | Error | InvalidDataError>;
+): Query<void, TransformedData, JsonApiRequestError>;
 
 export function createJsonQuery<
   Data,
   TransformedData,
-  Error,
   BodySource = void,
   QuerySource = void,
   HeadersSource = void,
@@ -263,17 +252,11 @@ export function createJsonQuery<
       validate?: Validator<TransformedData, void, ValidationSource>;
     };
   }
-): Query<
-  void,
-  TransformedData,
-  ApiRequestError | Error | InvalidDataError,
-  TransformedData
->;
+): Query<void, TransformedData, JsonApiRequestError, TransformedData>;
 
 // No params + no mapData
 export function createJsonQuery<
   Data,
-  Error,
   BodySource = void,
   QuerySource = void,
   HeadersSource = void,
@@ -292,11 +275,10 @@ export function createJsonQuery<
       validate?: Validator<Data, void, ValidationSource>;
     };
   }
-): Query<void, Data, ApiRequestError | Error | InvalidDataError>;
+): Query<void, Data, JsonApiRequestError>;
 
 export function createJsonQuery<
   Data,
-  Error,
   BodySource = void,
   QuerySource = void,
   HeadersSource = void,
@@ -316,7 +298,7 @@ export function createJsonQuery<
       validate?: Validator<Data, void, ValidationSource>;
     };
   }
-): Query<void, Data, ApiRequestError | Error | InvalidDataError, Data>;
+): Query<void, Data, JsonApiRequestError, Data>;
 
 // -- Implementation --
 export function createJsonQuery(config: any) {