Change signature of Validator to be consistent with .finished.* _Ev…

…ents_

.changeset/fair-onions-wonder.md

@@ -0,0 +1,5 @@
+---
+'@farfetched/core': minor
+---
+
+Change signature of Validator to be consistent with `.finished.*` _Events_

apps/website/docs/api/primitives/validator.md

@@ -13,20 +13,21 @@ A _Validator_ have to respond with `ValidationResult` that could be one of the f
 
 ### Function
 
-_Validator_ can be a simple function that accepts `data` and `params` and returns `ValidationResult`.
+_Validator_ can be a simple function that accepts `{ result, params }` object and returns `ValidationResult`.
 
 ```ts
-const validator = (data, params): ValidationResult => data[params.id] !== null;
+const validator = ({ result, params }): ValidationResult =>
+  result[params.id] !== null;
 ```
 
 ### Function with external source
 
-_Validator_ can be an object with field `source` which is any [_Store_](https://effector.dev/docs/api/effector/store) and `fn` witch is a function that accepts `data`, `params`, value of `source` and returns `ValidationResult`.
+_Validator_ can be an object with field `source` which is any [_Store_](https://effector.dev/docs/api/effector/store) and `fn` witch is a function that accepts object `{ result, params }` and the value of `source` and returns `ValidationResult`.
 
 ```ts
 const validator = {
   source: $externalStore,
-  fn: (data, params, externalSource): ValidationResult =>
-    data[params.id] !== null && data[externalSource.id] !== null,
+  fn: ({ result, params }, externalSource): ValidationResult =>
+    result[params.id] !== null && result[externalSource.id] !== null,
 };
 ```

apps/website/docs/releases/0-4.md

@@ -207,3 +207,41 @@ query.finished.success.watch(({ result }) => {
   // ...
 });
 ```
+
+### Change signature of Validator
+
+`Validator` now accepts `{ result, params }` object instead of two separate arguments to be consistent with `.finished.*` [_Events_](https://effector.dev/docs/api/effector/event).
+
+#### Function form
+
+```ts
+// before
+const validator = (result, params) => {
+  // ...
+};
+
+// after
+const validator = ({ result, params }) => {
+  // ...
+};
+```
+
+#### Object form
+
+```ts
+// before
+const validator = {
+  source: $externalStore,
+  fn: (result, params, externalSource) => {
+    // ...
+  },
+};
+
+// after
+const validator = {
+  source: $externalStore,
+  fn: ({ result, params }, externalSource) => {
+    // ...
+  },
+};
+```

apps/website/docs/tutorial/validators.md

@@ -17,7 +17,7 @@ const blockQuery = createQuery({
 
     return response.json();
   }),
-  validate: (data, { id }) => data.id === id,
+  validate: ({ result }, { id }) => result.id === id,
 });
 ```
 

packages/core/src/misc/sourced.ts

@@ -2,9 +2,9 @@ import { combine, createStore, Event, is, sample, Store } from 'effector';
 
 // -- Main case --
 
-type Callback<Data, Result> = (data: Data) => Result;
+export type Callback<Data, Result> = (data: Data) => Result;
 
-type CallbackWithSource<Data, Result, Source> = {
+export type CallbackWithSource<Data, Result, Source> = {
   source: Store<Source>;
   fn: (data: Data, source: Source) => Result;
 };

packages/core/src/mutation/__tests__/create_json_mutation.type_spec.ts

@@ -136,8 +136,8 @@ optional_validation_field: {
       request: { url: '', method: 'GET' },
       response: {
         contract,
-        validate: (data, params) => {
-          expectType<number>(data);
+        validate: ({ result, params }) => {
+          expectType<number>(result);
           expectType<void>(params);
 
           return true;
@@ -151,8 +151,8 @@ optional_validation_field: {
         contract,
         validate: {
           source: createStore<boolean>(false),
-          fn: (data, params, s) => {
-            expectType<number>(data);
+          fn: ({ result, params }, s) => {
+            expectType<number>(result);
             expectType<void>(params);
             expectType<boolean>(s);
 
@@ -171,8 +171,8 @@ optional_validation_field: {
       request: { url: '', method: 'GET' },
       response: {
         contract,
-        validate: (data, params) => {
-          expectType<number>(data);
+        validate: ({ result, params }) => {
+          expectType<number>(result);
           expectType<string>(params);
 
           return true;
@@ -187,8 +187,8 @@ optional_validation_field: {
         contract,
         validate: {
           source: createStore<boolean>(false),
-          fn: (data, params, s) => {
-            expectType<number>(data);
+          fn: ({ result, params }, s) => {
+            expectType<number>(result);
             expectType<string>(params);
             expectType<boolean>(s);
 

packages/core/src/query/__tests__/create_json_query.validate.type_spec.ts

@@ -16,9 +16,9 @@ no_params: {
     },
     response: {
       contract: numberContract,
-      validate: (a, b) => {
-        expectType<number>(a);
-        expectType<void>(b);
+      validate: ({ result, params }) => {
+        expectType<number>(result);
+        expectType<void>(params);
         return true;
       },
     },
@@ -34,9 +34,9 @@ no_params: {
       contract: numberContract,
       validate: {
         source: createStore(false),
-        fn: (a, b, s) => {
-          expectType<number>(a);
-          expectType<void>(b);
+        fn: ({ result, params }, s) => {
+          expectType<number>(result);
+          expectType<void>(params);
           expectType<boolean>(s);
           return true;
         },
@@ -57,9 +57,9 @@ params: {
     },
     response: {
       contract: numberContract,
-      validate: (a, b) => {
-        expectType<number>(a);
-        expectType<string>(b);
+      validate: ({ result, params }) => {
+        expectType<number>(result);
+        expectType<string>(params);
         return true;
       },
     },
@@ -76,9 +76,9 @@ params: {
       contract: numberContract,
       validate: {
         source: createStore(false),
-        fn: (a, b, s) => {
-          expectType<number>(a);
-          expectType<string>(b);
+        fn: ({ result, params }, s) => {
+          expectType<number>(result);
+          expectType<string>(params);
           expectType<boolean>(s);
           return true;
         },

packages/core/src/remote_operation/create_remote_operation.ts

@@ -189,15 +189,13 @@ function createRemoteOperation<
   const { validDataRecieved, __: invalidDataRecieved } = split(
     sample({
       clock: applyContractFx.done,
-      source: normalizeSourced(
-        reduceTwoArgs({
-          field: validate ?? validValidator,
-          clock: applyContractFx.done.map(({ result, params }) => [
-            result,
-            params.params, // Extract original params, it is params of params
-          ]),
-        })
-      ),
+      source: normalizeSourced({
+        field: validate ?? validValidator,
+        clock: applyContractFx.done.map(({ result, params }) => ({
+          result,
+          params: params.params, // Extract original params, it is params of params
+        })),
+      }),
       fn: (validation, { params, result: data }) => ({
         data,
         // Extract original params, it is params of params

packages/core/src/validation/type.ts

@@ -1,12 +1,13 @@
-import { TwoArgsDynamicallySourcedField } from '../misc/sourced';
+import { Callback, CallbackWithSource } from '../misc/sourced';
 
 type ValidationResult = boolean | string | string[];
 
-type Validator<Data, Params, ValidationSource> = TwoArgsDynamicallySourcedField<
-  Data,
-  Params,
-  ValidationResult,
-  ValidationSource
->;
+type Validator<Data, Params, ValidationSource> =
+  | Callback<{ result: Data; params: Params }, ValidationResult>
+  | CallbackWithSource<
+      { result: Data; params: Params },
+      ValidationResult,
+      ValidationSource
+    >;
 
 export { Validator, ValidationResult };