mayoiga 0.0.22 → 0.1.3

package/src/index.ts

@@ -0,0 +1,311 @@
+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.
+   */
+  pushFormErrors: (
+    validator: (state: StateBeforeValidation) => Partial<FormErrors<StateBeforeValidation>>,
+  ) => (prev: FullFormState<StateBeforeValidation>) => FullFormState<StateBeforeValidation>;
+
+  reduceFormErrors: (
+    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};
+    },
+    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) => {
+      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;
+  pushFormErrors: (validator: (state: State) => Partial<FormErrors<State>>) => void;
+  handleChange: HandleChangeAction<State>;
+  handleBulkChange: (setter: (prev: State) => Partial<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;
+}

package/tsconfig.json

@@ -0,0 +1,38 @@
+{
+  "compilerOptions": {
+    "target": "esnext",
+    "module": "esnext",
+    "declaration": true,
+    "jsx": "react",
+    "moduleResolution": "node",
+    // TODO: skip while vitest is broken
+    "skipLibCheck": true,
+
+    "strict": true,
+
+    "noUnusedLocals": true,
+    "noUnusedParameters": false,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedIndexedAccess": true,
+    "useUnknownInCatchVariables": true,
+    "exactOptionalPropertyTypes": true,
+
+    "forceConsistentCasingInFileNames": true,
+    "removeComments": false,
+
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "noErrorTruncation": true,
+
+    "lib": ["dom", "esnext"],
+    // TODO: node is for vitest... I should isolate it probably?
+    "types": ["react/next"],
+
+    "rootDir": "./src",
+    "outDir": "./dist"
+  },
+  "include": [
+    "./src/**/*"
+  ],
+}

package/vite.config.js

@@ -0,0 +1,10 @@
+import {defineConfig} from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    globals: true,
+    // environment: 'happy-dom',  DO NOT USE IT
+    environment: 'jsdom',
+    setupFiles: ['./setup/vite-global-setup.js'],
+  },
+})