mayoiga 0.1.2 → 0.1.5

package/src/component.test.tsx

@@ -1,4 +1,3 @@
-
 import {render, screen, waitFor} from '@testing-library/react';
 import userEvent from '@testing-library/user-event';
 import React from 'react';
@@ -7,14 +6,19 @@ import {test, expect} from 'vitest';
 
 import * as zod from 'zod';
 
-import { Field, Slicer } from './component';
+import {Field, Slicer} from './component';
+
+import {createFormHook} from './index';
 
-import {createFormHook, } from './index';
+import type {Controller} from './index';
 
 const testSchema = zod.object({
   name: zod.string(),
   description: zod.string(),
-  age: zod.string().transform(val => Number(val)).refine(val => Number.isNaN(val) ? 0 : val),
+  age: zod
+    .string()
+    .transform((val) => Number(val))
+    .refine((val) => (Number.isNaN(val) ? 0 : val)),
   marked: zod.boolean(),
 });
 
@@ -24,9 +28,9 @@ type FormStateBeforeValidation = {
   description: string;
   age: string;
   marked: boolean;
-}
+};
 
-const createTestHook =  () => createFormHook({name:'', description: '', age: '', marked: false} as FormStateBeforeValidation, testSchema);
+const createTestHook = () => createFormHook({name: '', description: '', age: '', marked: false} as FormStateBeforeValidation, testSchema);
 
 // afterEach(cleanup);
 
@@ -36,11 +40,11 @@ test('Field component works fine in basic usage.', async () => {
   const Top = () => {
     return (
       <div>
-        <Field controller={TestFormHook.controller} name="age">{
-          (tool) => <input data-testid="age-input" {...tool} />
-        }</Field>
+        <Field controller={TestFormHook.controller} name="age">
+          {(tool) => <input data-testid="age-input" {...tool} />}
+        </Field>
       </div>
-    )
+    );
   };
 
   render(<Top />);
@@ -66,11 +70,13 @@ test('Slice component works fine in basic usage.', async () => {
   const Top = () => {
     return (
       <div>
-        <Slicer controller={TestFormHook.controller} selector={s => [s.value.age] as const}>{
-          (tool, age: string) => <input data-testid="age-input" name="age" value={age} onChange={e => tool.handleChange('age' as const, e.target.value)} />
-        }</Slicer>
+        <Slicer controller={TestFormHook.controller} selector={(s) => [s.value.age] as const}>
+          {(tool, age: string) => (
+            <input data-testid="age-input" name="age" value={age} onChange={(e) => tool.handleChange('age' as const, e.target.value)} />
+          )}
+        </Slicer>
       </div>
-    )
+    );
   };
 
   render(<Top />);
@@ -89,3 +95,110 @@ test('Slice component works fine in basic usage.', async () => {
     });
   });
 });
+
+test('A user able to create a reusable component', async () => {
+  const TestFormHook = createTestHook();
+
+  function NarrowTypedExpected(props: {controller: Controller<{age: string}>}) {
+    return (
+      <Field controller={props.controller} name="age">
+        {(tool) => <input data-testid="age-input" {...tool} />}
+      </Field>
+    );
+  }
+
+  function ErrorDisplayer(props: {controller: Controller<{age: string}>}) {
+    const {controller} = props;
+    return (
+      <Slicer controller={controller} selector={(s) => [s.value.age] as const}>
+        {(tool, age: string) => (
+          <button
+            onClick={(e) => {
+              controller.actions.pushFormErrors((_state) => ({age: age === '42' ? 'yes!!!' : 'noooo'}));
+            }}
+          />
+        )}
+      </Slicer>
+    );
+  }
+
+  render(
+    <div>
+      <NarrowTypedExpected controller={TestFormHook.controller} />
+      <ErrorDisplayer controller={TestFormHook.controller} />
+    </div>,
+  );
+
+  const INPUT_AGE = '42';
+
+  // calling `userEvent` in here will cause race condition...
+  await userEvent.type(screen.getByTestId('age-input'), INPUT_AGE);
+  await userEvent.click(screen.getByRole('button'));
+
+  await waitFor(() => {
+    const ageInput: HTMLInputElement = screen.getByTestId('age-input');
+    expect(ageInput.value).toBe(INPUT_AGE);
+    TestFormHook.api.actions.peek((s) => {
+      expect(s.value.age).toBe(INPUT_AGE);
+      expect(s.errors.age).toBe('yes!!!');
+    });
+  });
+});
+
+test('`deps` field could destruct memoization', async () => {
+  const TestFormHook = createTestHook();
+  // intentional sample to replicate the situation
+  const OtherFormHook = createFormHook({minAge: '30'}, zod.object({minAge: zod.string()}));
+
+  const DATA_ID_RE_RENDER_BY_DEPS = 'refresh-by-deps';
+  const DATA_ID_NOT_RERENDER_NO_DEPS = 'no-refersh-no-deps';
+
+  function App() {
+    const minAge = OtherFormHook.useSelector((s) => Number(s.value.minAge));
+
+    return (
+      <div>
+        <Field controller={OtherFormHook.controller} name="minAge">
+          {(tool) => <input data-testid="minAgeInput" type="number" {...tool} />}
+        </Field>
+        <Field controller={TestFormHook.controller} name="age">
+          {(tool) => <input data-testid="ageInput" type="number" {...tool} />}
+        </Field>
+        <Slicer controller={TestFormHook.controller} selector={(s) => [Number(s.value.age)]} deps={[minAge]}>
+          {(_tool, age: number) => (
+            <div data-testid={DATA_ID_RE_RENDER_BY_DEPS}>{age >= minAge ? 'You can buy this content' : 'go home'}</div>
+          )}
+        </Slicer>
+        <Slicer controller={TestFormHook.controller} selector={(s) => [Number(s.value.age)]}>
+          {(_tool, age: number) => (
+            <div data-testid={DATA_ID_NOT_RERENDER_NO_DEPS}>{age >= minAge ? 'You can buy this content' : 'go home'}</div>
+          )}
+        </Slicer>
+      </div>
+    );
+  }
+
+  render(<App />);
+
+  await userEvent.type(screen.getByTestId('ageInput'), '16');
+
+  await waitFor(() => {
+    expect(screen.getByTestId(DATA_ID_RE_RENDER_BY_DEPS).textContent).toBe('go home');
+    // expect(await screen.findByText('You can buy this content')).toBeDefined();
+  });
+
+  await userEvent.clear(screen.getByTestId('minAgeInput'));
+  await userEvent.type(screen.getByTestId('minAgeInput'), '10');
+
+  await waitFor(() => {
+    expect(screen.getByTestId(DATA_ID_RE_RENDER_BY_DEPS).textContent, 'Slicer should re-execute renderProps if `deps` are changed').toBe(
+      'You can buy this content',
+    );
+  });
+  await waitFor(() => {
+    expect(
+      screen.getByTestId(DATA_ID_NOT_RERENDER_NO_DEPS).textContent,
+      'Same logic but would not refresh because external dependencies are not applied',
+    ).toBe('go home');
+  });
+});

package/src/component.tsx

@@ -1,18 +1,22 @@
 import React from 'react';
 
-import type {SliceProps, FieldProps, StateRestriction, Controller, } from './index';
+import type {SliceProps, FieldProps, StateRestriction, Controller} from './index';
 
-type ControlledComponentProps<State, Props> = Props & {
+type ControlledComponentProps<State extends StateRestriction, Props> = Props & {
   controller: Controller<State>;
-}
+};
 
-export function Slicer<State extends StateRestriction, R extends ReadonlyArray<unknown>>(props: ControlledComponentProps<State, SliceProps<State, R>>) {
+export function Slicer<State extends StateRestriction, R extends ReadonlyArray<unknown>>(
+  props: ControlledComponentProps<State, SliceProps<State, R>>,
+) {
   const {controller, ...restProps} = props;
   const {Slicer: Delegate} = controller.components;
   return <Delegate {...restProps} />;
 }
 
-export function Field<State extends StateRestriction, Name extends keyof State>(props: ControlledComponentProps<State, FieldProps<State, Name>>) {
+export function Field<State extends StateRestriction, Name extends keyof State>(
+  props: ControlledComponentProps<State, FieldProps<State, Name>>,
+) {
   const {controller, ...restProps} = props;
   const {Field: Delegate} = controller.components;
   return <Delegate {...restProps} />;

package/src/index.test.tsx

@@ -7,14 +7,16 @@ import {test, expect} from 'vitest';
 import * as zod from 'zod';
 
 import {createFormHook, useFormSlice} from './index';
- 
-import type {Controller} from './index';
 
+import type {Controller} from './index';
 
 const testSchema = zod.object({
   name: zod.string(),
   description: zod.string(),
-  age: zod.string().transform(val => Number(val)).refine(val => Number.isNaN(val) ? 0 : val),
+  age: zod
+    .string()
+    .transform((val) => Number(val))
+    .refine((val) => (Number.isNaN(val) ? 0 : val)),
   marked: zod.boolean(),
 });
 
@@ -24,13 +26,13 @@ type FormStateBeforeValidation = {
   description: string;
   age: string;
   marked: boolean;
-}
+};
 
-const createTestHook =  () => createFormHook({name:'', description: '', age: '', marked: false} as FormStateBeforeValidation, testSchema);
+const createTestHook = () => createFormHook({name: '', description: '', age: '', marked: false} as FormStateBeforeValidation, testSchema);
 
 const AgeInputComponent = (props: {controller: Controller<FormStateBeforeValidation>}) => {
   const {controller} = props;
-  const [[age, errorMessage], {handleChange}] = useFormSlice(controller, s => [s.value.age, s.errors.age] as const);
+  const [[age, errorMessage], {handleChange}] = useFormSlice(controller, (s) => [s.value.age, s.errors.age] as const);
   return (
     <div>
       <input
@@ -56,7 +58,7 @@ test('useSelector can select the fields', async () => {
       <div>
         <AgeInputComponent controller={TestFormHook.controller} />
       </div>
-    )
+    );
   };
 
   render(<Top />);
@@ -81,12 +83,12 @@ test('zod parse value before submit', async () => {
   const PARSED_RESULT = Number(INPUT_AGE);
 
   const handleSubmitTester = TestFormHook.handleSubmit((e) => (result) => {
-      if (result.success) {
-        expect(result.data.age).toBe(PARSED_RESULT);
-      } else {
-        expect('should not called').toBe(result.error);
-      }
-    });
+    if (result.success) {
+      expect(result.data.age).toBe(PARSED_RESULT);
+    } else {
+      expect('should not called').toBe(result.error);
+    }
+  });
 
   const Top = () => {
     return (
@@ -94,16 +96,16 @@ test('zod parse value before submit', async () => {
         <AgeInputComponent controller={TestFormHook} />
         <button data-testid="submit-button" onClick={handleSubmitTester} />
       </div>
-    )
+    );
   };
 
   render(<Top />);
 
-  const ageInput: HTMLInputElement = screen.getByTestId('age-input') ;
+  const ageInput: HTMLInputElement = screen.getByTestId('age-input');
   await userEvent.type(ageInput, INPUT_AGE);
 
   await waitFor(() => {
-    const ageInput: HTMLInputElement = screen.getByTestId('age-input') ;
+    const ageInput: HTMLInputElement = screen.getByTestId('age-input');
     expect(ageInput.value).toBe(INPUT_AGE);
   });
 
@@ -117,4 +119,4 @@ test('zod parse value before submit', async () => {
       expect(s.errors.age).toBeNull();
     });
   });
-});
+});

package/src/index.ts

@@ -35,14 +35,29 @@ export type FieldProps<State extends StateRestriction, Name extends keyof State>
     value: State[Name],
     errorMessage: string | null,
   ) => ReactNode;
+
+  /**
+   * Mayoiga Field will memoize the result of renderProps for performance.
+   * If your renderProps depends on external variables, you should apply those on deps
+   */
+  deps?: ReadonlyArray<unknown>;
 };
 
 export type SliceProps<State extends StateRestriction, Selected extends ReadonlyArray<unknown>> = {
   selector: (s: FullFormState<State>) => Selected;
   children: (tool: {handleChange: HandleChangeAction<State>}, ...value: Readonly<Selected>) => ReactNode;
+  /**
+   * Mayoiga Slicer will memoize the result of renderProps for performance.
+   * If your renderProps depends on external variables, you should apply those on deps
+   *
+   * ```typescript
+   * <Slicer selector={s => [s.value.selected]} deps={[selection]}>{(tools, selected: string) => <AwesomeSelection value={selected} options={selection} />}</Slicer>
+   * ```
+   */
+  deps?: ReadonlyArray<unknown>;
 };
 
-type FormControllerBehavior<StateBeforeValidation> = {
+type FormControllerBehavior<StateBeforeValidation extends StateRestriction> = {
   /** For testing */
   peek: (
     eyeball: (prev: FullFormState<StateBeforeValidation>) => void,
@@ -65,7 +80,11 @@ type FormControllerBehavior<StateBeforeValidation> = {
   /**
    * You can handle server side or other external error via this action.
    */
-  handleError: (
+  pushFormErrors: (
+    validator: (state: StateBeforeValidation) => Partial<FormErrors<StateBeforeValidation>>,
+  ) => (prev: FullFormState<StateBeforeValidation>) => FullFormState<StateBeforeValidation>;
+
+  reduceFormErrors: (
     reducer: (prev: FormErrors<StateBeforeValidation>) => FormErrors<StateBeforeValidation>,
   ) => (prev: FullFormState<StateBeforeValidation>) => FullFormState<StateBeforeValidation>;
 
@@ -150,7 +169,11 @@ function createFormStore<StateBeforeValidation extends StateRestriction, Schema
 
       return {...prev, isDirty: true, isValid: false, errors: newErrors};
     },
-    handleError: (reducer) => (prev) => {
+    pushFormErrors: (validator) => (prev) => {
+      const pushedErrors = validator(prev.value);
+      return {...prev, errors: {...prev.errors, ...pushedErrors}};
+    },
+    reduceFormErrors: (reducer) => (prev) => {
       return {...prev, errors: reducer(prev.errors)};
     },
     handleChange: (name, value) => (prev) => {
@@ -174,9 +197,9 @@ function createFormStore<StateBeforeValidation extends StateRestriction, Schema
 type ActionsCanBePublic<State extends StateRestriction> = {
   reset: VoidFunction;
   initializeForm: (initial: Partial<State>) => void;
+  pushFormErrors: (validator: (state: State) => Partial<FormErrors<State>>) => void;
   handleChange: HandleChangeAction<State>;
   handleBulkChange: (setter: (prev: State) => Partial<State>) => void;
-  handleError: (reducer: (prev: FormErrors<State>) => FormErrors<State>) => void;
 };
 
 /**
@@ -211,7 +234,7 @@ type FormHook<State extends StateRestriction, Schema extends ZodType<any, any, a
 /**
  * @typeParam InitialState should be shallow
  */
-export function createFormHook<StateBeforeValidation, Schema extends ZodType<any, any, any>>(
+export function createFormHook<StateBeforeValidation extends StateRestriction, Schema extends ZodType<any, any, any>>(
   initialState: StateBeforeValidation,
   schema: Schema,
 ): FormHook<StateBeforeValidation, Schema> {
@@ -248,40 +271,46 @@ export function createFormHook<StateBeforeValidation, Schema extends ZodType<any
 
     components: {
       Slicer<R extends ReadonlyArray<unknown>>(props: SliceProps<StateBeforeValidation, R>) {
-        const {selector, children} = props;
-        const value = formHook.useSelector(selector);
-        return useMemo(() => {
-          const renderContent = children({handleChange: formHook.actions.handleChange}, ...value);
-          return createElement(Fragment, {}, renderContent);
-        }, value);
+        const {selector, children, deps} = props;
+        const slicedValues = formHook.useSelector(selector);
+        return useMemo(
+          () => {
+            const renderContent = children({handleChange: formHook.actions.handleChange}, ...slicedValues);
+            return createElement(Fragment, {}, renderContent);
+          },
+          deps ? [...slicedValues, ...deps] : slicedValues,
+        );
       },
       Field<Name extends keyof StateBeforeValidation>(props: FieldProps<StateBeforeValidation, Name>) {
-        const {name, children} = props;
+        const {name, children, deps} = props;
         const [value, errMsg] = store.useSelector((s) => [s.value[name], s.errors[name]] as const);
-        return useMemo(() => {
-          const renderContent = children(
-            {
-              name,
-              value,
-              onChange: (name_or_event: unknown, value_or_none?: unknown) => {
-                if (typeof name_or_event === 'string') {
-                  // assumes name is valid if it's string
-                  // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-                  return store.actions.handleChange(name_or_event as Name, value_or_none as any);
-                }
-                if (isChangeEvent(name_or_event)) {
-                  const target: any = name_or_event.currentTarget || name_or_event.target;
-                  // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-member-access
-                  return store.actions.handleChange(target.name, target.value);
-                }
-                throw new Error('`handleChange` handles unexpected formed object.');
+        return useMemo(
+          () => {
+            const renderContent = children(
+              {
+                name,
+                value,
+                onChange: (name_or_event: unknown, value_or_none?: unknown) => {
+                  if (typeof name_or_event === 'string') {
+                    // assumes name is valid if it's string
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+                    return store.actions.handleChange(name_or_event as Name, value_or_none as any);
+                  }
+                  if (isChangeEvent(name_or_event)) {
+                    const target: any = name_or_event.currentTarget || name_or_event.target;
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-member-access
+                    return store.actions.handleChange(target.name, target.value);
+                  }
+                  throw new Error('`handleChange` handles unexpected formed object.');
+                },
               },
-            },
-            value,
-            errMsg,
-          );
-          return createElement(Fragment, {}, renderContent);
-        }, [value, errMsg]);
+              value,
+              errMsg,
+            );
+            return createElement(Fragment, {}, renderContent);
+          },
+          deps ? [value, errMsg, ...deps] : [value, errMsg],
+        );
       },
     },
     actions: store.actions,