mayoiga 0.0.21 → 0.1.2

package/package.json

@@ -1,19 +1,25 @@
 {
   "name": "mayoiga",
-  "version": "0.0.21",
-  "description": "Form library for React",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
+  "version": "0.1.2",
+  "description": "Type safe hook based form library for React",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "files": [
-    "lib"
+    "dist",
+    "/component.js",
+    "/component.d.ts",
+    "!*.test.js"
   ],
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "type-check": "tsc example/src/demo-app.tsx --noEmit --jsx preserve",
-    "clean": "rm -rf lib/",
-    "docs": "typedoc --name Mayoiga --mode modules --excludePrivate --out docs/",
-    "compile": "tsc",
-    "prepublish": "npm run clean && npm run compile"
+    "clean": "rm -rf dist",
+    "test": "vitest run",
+    "prebuild": "npm run clean",
+    "build": "tsc",
+    "check:style": "prettier --check 'src/**/*.{js,ts}'",
+    "check:lint": "eslint 'src/**/*.{ts,tsx}'",
+    "check-all": "npm run check:style && npm run check:lint && npm run build --noEmit && npm run test",
+    "fix-all": "npm run check:style --write && npm run check:lint --fix",
+    "prepublish": "npm run check-all && npm run build"
   },
   "repository": {
     "type": "git",
@@ -26,45 +32,36 @@
     "validation",
     "state"
   ],
-  "author": "Ogura Daiki",
+  "author": "OGURA Daiki",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/hachibeeDI/mayoiga/issues"
   },
   "homepage": "https://github.com/hachibeeDI/mayoiga#readme",
-  "devDependencies": {
-    "@babel/cli": "^7.4.4",
-    "@babel/core": "^7.4.5",
-    "@babel/plugin-proposal-class-properties": "^7.4.4",
-    "@babel/plugin-proposal-object-rest-spread": "^7.4.4",
-    "@babel/preset-env": "^7.4.5",
-    "@babel/preset-react": "^7.0.0",
-    "@babel/preset-typescript": "^7.3.3",
-    "@types/node": "^11.11.4",
-    "@types/react": "^16.8.19",
-    "@types/react-dom": "^16.8.2",
-    "babel-loader": "^8.0.6",
-    "prettier": "^1.18.2",
-    "react": "^16.8.6",
-    "react-dom": "^16.8.6",
-    "tslint": "^5.14.0",
-    "tslint-config-prettier": "^1.18.0",
-    "tslint-immutable": "^6.0.0",
-    "tslint-plugin-prettier": "^2.0.1",
-    "tslint-react": "^4.0.0",
-    "typedoc": "^0.14.2",
-    "typescript": "^3.5.1",
-    "typescript-eslint-parser": "^22.0.0",
-    "webpack": "^4.29.6",
-    "webpack-cli": "^3.3.3",
-    "webpack-dev-server": "^3.7.1"
-  },
   "peerDependencies": {
-    "react": "^16.8.0"
+    "zod": "^3.14.4"
   },
-
-  "resolutions": {
-    "@types/react": "^16.8.19"
+  "dependencies": {
+    "nozuchi": "^0.0.3"
   },
-  "dependencies": {}
+  "devDependencies": {
+    "@testing-library/react": "^13.0.0",
+    "@testing-library/user-event": "^14.1.1",
+    "@types/node": "^17.0.23",
+    "@types/react": "^18.0.1",
+    "@types/use-sync-external-store": "^0.0.3",
+    "@typescript-eslint/eslint-plugin": "^5.20.0",
+    "@typescript-eslint/parser": "^5.20.0",
+    "eslint": "^8.13.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-testing-library": "^5.3.1",
+    "jsdom": "^19.0.0",
+    "prettier": "^2.6.2",
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0",
+    "typescript": "^4.6.3",
+    "use-sync-external-store": "^1.0.0",
+    "vitest": "^0.9.3",
+    "zod": "^3.14.4"
+  }
 }

package/setup/vite-global-setup.js

@@ -0,0 +1 @@
+globalThis.IS_REACT_ACT_ENVIRONMENT = true;

package/src/component.test.tsx

@@ -0,0 +1,91 @@
+
+import {render, screen, waitFor} from '@testing-library/react';
+import userEvent from '@testing-library/user-event';
+import React from 'react';
+
+import {test, expect} from 'vitest';
+
+import * as zod from 'zod';
+
+import { Field, Slicer } from './component';
+
+import {createFormHook, } 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),
+  marked: zod.boolean(),
+});
+
+// every fields are optional for test
+type FormStateBeforeValidation = {
+  name: string;
+  description: string;
+  age: string;
+  marked: boolean;
+}
+
+const createTestHook =  () => createFormHook({name:'', description: '', age: '', marked: false} as FormStateBeforeValidation, testSchema);
+
+// afterEach(cleanup);
+
+test('Field component works fine in basic usage.', async () => {
+  const TestFormHook = createTestHook();
+
+  const Top = () => {
+    return (
+      <div>
+        <Field controller={TestFormHook.controller} name="age">{
+          (tool) => <input data-testid="age-input" {...tool} />
+        }</Field>
+      </div>
+    )
+  };
+
+  render(<Top />);
+
+  const INPUT_AGE = '42';
+
+  // calling `userEvent` in here will cause race condition...
+  await userEvent.type(screen.getByTestId('age-input'), INPUT_AGE);
+
+  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).toBeNull();
+    });
+  });
+});
+
+test('Slice component works fine in basic usage.', async () => {
+  const TestFormHook = createTestHook();
+
+  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>
+      </div>
+    )
+  };
+
+  render(<Top />);
+
+  const INPUT_AGE = '42';
+
+  // calling `userEvent` in here will cause race condition...
+  await userEvent.type(screen.getByTestId('age-input'), INPUT_AGE);
+
+  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).toBeNull();
+    });
+  });
+});

package/src/component.tsx

@@ -0,0 +1,19 @@
+import React from 'react';
+
+import type {SliceProps, FieldProps, StateRestriction, Controller, } from './index';
+
+type ControlledComponentProps<State, Props> = Props & {
+  controller: Controller<State>;
+}
+
+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>>) {
+  const {controller, ...restProps} = props;
+  const {Field: Delegate} = controller.components;
+  return <Delegate {...restProps} />;
+}

package/src/index.test.tsx

@@ -0,0 +1,120 @@
+import {render, screen, waitFor} from '@testing-library/react';
+import userEvent from '@testing-library/user-event';
+import React from 'react';
+
+import {test, expect} from 'vitest';
+
+import * as zod from 'zod';
+
+import {createFormHook, useFormSlice} 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),
+  marked: zod.boolean(),
+});
+
+// every fields are optional for test
+type FormStateBeforeValidation = {
+  name: string;
+  description: string;
+  age: string;
+  marked: boolean;
+}
+
+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);
+  return (
+    <div>
+      <input
+        data-testid="age-input"
+        value={age}
+        name="age"
+        onChange={(e) => {
+          handleChange('age' as const, e.currentTarget.value);
+        }}
+      />
+      <span data-testid="age-error">{errorMessage}</span>
+    </div>
+  );
+};
+
+// afterEach(cleanup);
+
+test('useSelector can select the fields', async () => {
+  const TestFormHook = createTestHook();
+
+  const Top = () => {
+    return (
+      <div>
+        <AgeInputComponent controller={TestFormHook.controller} />
+      </div>
+    )
+  };
+
+  render(<Top />);
+
+  const INPUT_AGE = '4';
+
+  // fireEvent.change(screen.getByTestId('age-input') , {target: {value: INPUT_AGE}})
+  // calling `userEvent` in here will cause race condition...
+  await userEvent.type(screen.getByTestId('age-input'), INPUT_AGE);
+  // TestFormHook.actions.handleBulkChange(prev => ({...prev, name: 'test', description: 'desc'}));
+
+  await waitFor(() => {
+    const ageInput: HTMLInputElement = screen.getByTestId('age-input');
+    expect(ageInput.value).toBe(INPUT_AGE);
+  });
+});
+
+test('zod parse value before submit', async () => {
+  const TestFormHook = createTestHook();
+
+  const INPUT_AGE = '9';
+  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);
+      }
+    });
+
+  const Top = () => {
+    return (
+      <div>
+        <AgeInputComponent controller={TestFormHook} />
+        <button data-testid="submit-button" onClick={handleSubmitTester} />
+      </div>
+    )
+  };
+
+  render(<Top />);
+
+  const ageInput: HTMLInputElement = screen.getByTestId('age-input') ;
+  await userEvent.type(ageInput, INPUT_AGE);
+
+  await waitFor(() => {
+    const ageInput: HTMLInputElement = screen.getByTestId('age-input') ;
+    expect(ageInput.value).toBe(INPUT_AGE);
+  });
+
+  const submitButton = screen.getByTestId('submit-button');
+  await userEvent.click(submitButton);
+
+  await waitFor(() => {
+    console.log('waiting');
+    TestFormHook.api.actions.peek((s) => {
+      expect(s.value.age).toBe(INPUT_AGE);
+      expect(s.errors.age).toBeNull();
+    });
+  });
+});

package/src/index.ts

@@ -0,0 +1,303 @@
+import {createStore} from 'nozuchi';
+import {createElement, Fragment, useEffect, useMemo} from 'react';
+
+import {isChangeEvent} from './utils';
+
+import type {Subscriber} from 'nozuchi';
+import type {BaseSyntheticEvent, ChangeEvent, ReactNode, ReactElement} from 'react';
+
+import type {infer as zodInfer, SafeParseReturnType, ZodIssue, ZodType} from 'zod';
+
+export type StateRestriction = Record<string, any>;
+
+type FormStatus = {
+  isDirty: boolean;
+  isValid: boolean;
+};
+
+type FormErrors<State extends StateRestriction> = {
+  [k in keyof State]: string | null;
+};
+
+export type FullFormState<State extends StateRestriction> = FormStatus & {value: State; errors: FormErrors<State>};
+
+export type HandleChangeAction<State extends StateRestriction, R = void> = <Name extends keyof State>(name: Name, value: State[Name]) => R;
+
+export type FieldProps<State extends StateRestriction, Name extends keyof State> = {
+  name: Name;
+  children: (
+    tool: {
+      name: Name;
+      value: State[Name];
+      onChange(this: void, name: Name, value: State[Name]): void;
+      onChange(this: void, e: ChangeEvent<HTMLElement>): void;
+    },
+    value: State[Name],
+    errorMessage: string | null,
+  ) => ReactNode;
+};
+
+export type SliceProps<State extends StateRestriction, Selected extends ReadonlyArray<unknown>> = {
+  selector: (s: FullFormState<State>) => Selected;
+  children: (tool: {handleChange: HandleChangeAction<State>}, ...value: Readonly<Selected>) => ReactNode;
+};
+
+type FormControllerBehavior<StateBeforeValidation> = {
+  /** For testing */
+  peek: (
+    eyeball: (prev: FullFormState<StateBeforeValidation>) => void,
+  ) => (prev: FullFormState<StateBeforeValidation>) => FullFormState<StateBeforeValidation>;
+
+  reset: () => () => FullFormState<StateBeforeValidation>;
+
+  /**
+   * Initialize form state without validation.
+   */
+  initializeForm: (
+    initialVal: Partial<StateBeforeValidation>,
+  ) => (prev: FullFormState<StateBeforeValidation>) => FullFormState<StateBeforeValidation>;
+
+  /**
+   * Handle issue that zod reported
+   */
+  handleIssues: (issues: ReadonlyArray<ZodIssue>) => (prev: FullFormState<StateBeforeValidation>) => FullFormState<StateBeforeValidation>;
+
+  /**
+   * You can handle server side or other external error via this action.
+   */
+  handleError: (
+    reducer: (prev: FormErrors<StateBeforeValidation>) => FormErrors<StateBeforeValidation>,
+  ) => (prev: FullFormState<StateBeforeValidation>) => FullFormState<StateBeforeValidation>;
+
+  /**
+   */
+  handleChange: HandleChangeAction<
+    StateBeforeValidation,
+    (prev: FullFormState<StateBeforeValidation>) => FullFormState<StateBeforeValidation>
+  >;
+
+  reduceFormState: (
+    reducer: (prevValue: StateBeforeValidation) => StateBeforeValidation,
+  ) => (prev: FullFormState<StateBeforeValidation>) => FullFormState<StateBeforeValidation>;
+  handleBulkChange: (
+    setter: (prev: StateBeforeValidation) => Partial<StateBeforeValidation>,
+  ) => (prev: FullFormState<StateBeforeValidation>) => FullFormState<StateBeforeValidation>;
+};
+
+const initialFormState = Object.freeze({isDirty: false, isValid: false});
+
+function createFormStore<StateBeforeValidation extends StateRestriction, Schema extends ZodType<any, any, any>>(
+  initialState: StateBeforeValidation,
+  schema: Schema,
+): Subscriber<FullFormState<StateBeforeValidation>, FormControllerBehavior<StateBeforeValidation>> {
+  type FullState = FullFormState<StateBeforeValidation>;
+  type Err = FormErrors<StateBeforeValidation>;
+  type StateKeys = keyof StateBeforeValidation;
+
+  const initialErrors = Object.freeze(
+    Object.keys(initialState).reduce((buf, k) => {
+      buf[k as StateKeys] = null;
+      return buf;
+    }, {} as any as Err),
+  );
+
+  const fullInitialState: FullState = Object.freeze({
+    ...initialFormState,
+    value: {...initialState},
+    errors: {...initialErrors},
+  });
+
+  const withValidation = (prev: FullState, newValue: StateBeforeValidation) => {
+    const result = schema.safeParse(newValue);
+    if (result.success) {
+      return {...prev, isDirty: true, isValid: true, value: newValue, errors: initialErrors};
+    }
+    const newErrors = result.error.issues.reduce((buf, iss) => {
+      // TODO: should support nested value?
+      const shallowPath = iss.path[0];
+      if (shallowPath === undefined) {
+        return buf;
+      }
+      buf[shallowPath as any as StateKeys] = iss.message;
+      return buf;
+    }, {} as any as Err);
+
+    return {...prev, isDirty: true, isValid: false, errors: newErrors, value: newValue};
+  };
+
+  return createStore(fullInitialState, {
+    peek: (eyeball) => (prev) => {
+      eyeball(prev);
+      return prev;
+    },
+
+    reset: () => () => fullInitialState,
+    initializeForm: (initialVal) => (prev) => ({
+      ...prev,
+      value: {...prev.value, ...initialVal},
+      errors: {...initialErrors},
+    }),
+    handleIssues: (issues) => (prev) => {
+      // FIXME: handle duplication
+      const newErrors = issues.reduce((buf, iss) => {
+        const shallowPath = iss.path[0];
+        if (shallowPath === undefined) {
+          return buf;
+        }
+        buf[shallowPath as any as StateKeys] = iss.message;
+        return buf;
+      }, {} as any as Err);
+
+      return {...prev, isDirty: true, isValid: false, errors: newErrors};
+    },
+    handleError: (reducer) => (prev) => {
+      return {...prev, errors: reducer(prev.errors)};
+    },
+    handleChange: (name, value) => (prev) => {
+      if (name in prev.value === false) {
+        return prev;
+      }
+      const newValue = {...prev.value, [name]: value};
+      return withValidation(prev, newValue);
+    },
+    reduceFormState: (reducer) => (prev) => {
+      const reducedState = reducer(prev.value);
+      return withValidation(prev, reducedState);
+    },
+    handleBulkChange: (setter) => (prev) => {
+      const mergedNewState = {...prev.value, ...setter(prev.value)};
+      return withValidation(prev, mergedNewState);
+    },
+  });
+}
+
+type ActionsCanBePublic<State extends StateRestriction> = {
+  reset: VoidFunction;
+  initializeForm: (initial: Partial<State>) => void;
+  handleChange: HandleChangeAction<State>;
+  handleBulkChange: (setter: (prev: State) => Partial<State>) => void;
+  handleError: (reducer: (prev: FormErrors<State>) => FormErrors<State>) => void;
+};
+
+/**
+ * Restricted type interface of the form store
+ * TODO: more restriction
+ */
+export type Controller<State extends StateRestriction> = {
+  useInitialize: (initialValue: Partial<State>) => void;
+  useSelector: <R>(selector: (state: FullFormState<State>) => R, isEqual?: (prev: R, current: R) => boolean) => R;
+
+  actions: ActionsCanBePublic<State>;
+  components: {
+    Field: <Name extends keyof State>(props: FieldProps<State, Name>) => ReactElement<any, any> | null;
+    Slicer: <Selected extends ReadonlyArray<unknown>>(props: SliceProps<State, Selected>) => ReactElement<any, any> | null;
+  };
+};
+
+type FormHook<State extends StateRestriction, Schema extends ZodType<any, any, any>> = {
+  controller: Controller<State>;
+
+  handleSubmit: (
+    handler: (
+      e: BaseSyntheticEvent,
+    ) => (
+      val: {success: true; data: zodInfer<Schema>; error: undefined} | {success: false; error: ReadonlyArray<ZodIssue>},
+    ) => void | Promise<void>,
+  ) => (e: BaseSyntheticEvent) => void;
+
+  api: Subscriber<FullFormState<State>, FormControllerBehavior<State>>;
+} & Controller<State>;
+
+/**
+ * @typeParam InitialState should be shallow
+ */
+export function createFormHook<StateBeforeValidation, Schema extends ZodType<any, any, any>>(
+  initialState: StateBeforeValidation,
+  schema: Schema,
+): FormHook<StateBeforeValidation, Schema> {
+  const store = createFormStore(initialState, schema);
+
+  const formHook = {
+    useInitialize: (initialValue: Partial<StateBeforeValidation>) => {
+      useEffect(() => {
+        store.actions.initializeForm(initialValue);
+      }, []);
+    },
+    useSelector: store.useSelector,
+    handleSubmit: (
+      handler: (
+        e: BaseSyntheticEvent,
+      ) => (
+        val: {success: true; data: zodInfer<Schema>; error: undefined} | {success: false; error: ReadonlyArray<ZodIssue>},
+      ) => void | Promise<void>,
+    ) => {
+      return (e: BaseSyntheticEvent) => {
+        const eventHandled = handler(e);
+        const value = store.getState().value;
+        return schema.safeParseAsync(value).then((result: SafeParseReturnType<StateBeforeValidation, zodInfer<typeof schema>>) => {
+          // FIXME: hook formを捨ててzodのバージョンをあげればこの辺に型をつけられる
+          if (result.success) {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+            return eventHandled({success: true, data: result.data, error: undefined});
+          }
+          void eventHandled({success: false, error: result.error.issues});
+          store.actions.handleIssues(result.error.issues);
+        });
+      };
+    },
+
+    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);
+      },
+      Field<Name extends keyof StateBeforeValidation>(props: FieldProps<StateBeforeValidation, Name>) {
+        const {name, children} = 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.');
+              },
+            },
+            value,
+            errMsg,
+          );
+          return createElement(Fragment, {}, renderContent);
+        }, [value, errMsg]);
+      },
+    },
+    actions: store.actions,
+  };
+
+  return {
+    controller: formHook,
+    api: store,
+    ...formHook,
+  };
+}
+
+export function useFormSlice<State extends StateRestriction, Sliced>(
+  formController: Controller<State>,
+  selector: (s: FullFormState<State>) => Sliced,
+) {
+  const sliced = formController.useSelector((s) => selector(s));
+  return [sliced, formController.actions] as const;
+}

package/src/utils.ts

@@ -0,0 +1,8 @@
+import type {ChangeEvent} from 'react';
+
+export function isChangeEvent<T>(x: any): x is ChangeEvent<T> {
+  if (typeof x !== 'object') {
+    return false;
+  }
+  return 'target' in x;
+}