summaryrefslogtreecommitdiff
path: root/packages/aml-backoffice-ui/src/hooks/form.ts
blob: e14e29819642c3ee2731661778a588949a3496eb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
/*
 This file is part of GNU Taler
 (C) 2022-2024 Taler Systems S.A.

 GNU Taler is free software; you can redistribute it and/or modify it under the
 terms of the GNU General Public License as published by the Free Software
 Foundation; either version 3, or (at your option) any later version.

 GNU Taler is distributed in the hope that it will be useful, but WITHOUT ANY
 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

 You should have received a copy of the GNU General Public License along with
 GNU Taler; see the file COPYING.  If not, see <http://www.gnu.org/licenses/>
 */

import {
  AmountJson,
  TalerExchangeApi,
  TranslatedString,
} from "@gnu-taler/taler-util";
import { useState } from "preact/hooks";
import { UIField } from "@gnu-taler/web-util/browser";

// export type UIField = {
//   value: string | undefined;
//   onUpdate: (s: string) => void;
//   error: TranslatedString | undefined;
// };

type FormHandler<T> = {
  [k in keyof T]?: T[k] extends string
    ? UIField
    : T[k] extends AmountJson
      ? UIField
      : T[k] extends TalerExchangeApi.AmlState
        ? UIField
        : FormHandler<T[k]>;
};

export type FormValues<T> = {
  [k in keyof T]: T[k] extends string ? string | undefined : FormValues<T[k]>;
};

export type RecursivePartial<T> = {
  [k in keyof T]?: T[k] extends string
    ? string
    : T[k] extends AmountJson
      ? AmountJson
      : T[k] extends TalerExchangeApi.AmlState
        ? TalerExchangeApi.AmlState
        : RecursivePartial<T[k]>;
};

export type FormErrors<T> = {
  [k in keyof T]?: T[k] extends string
    ? TranslatedString
    : T[k] extends AmountJson
      ? TranslatedString
      : T[k] extends TalerExchangeApi.AmlState
        ? TranslatedString
        : FormErrors<T[k]>;
};

export type FormStatus<T> =
  | {
      status: "ok";
      result: T;
      errors: undefined;
    }
  | {
      status: "fail";
      result: RecursivePartial<T>;
      errors: FormErrors<T>;
    };

function constructFormHandler<T>(
  form: RecursivePartial<FormValues<T>>,
  updateForm: (d: RecursivePartial<FormValues<T>>) => void,
  errors: FormErrors<T> | undefined,
): FormHandler<T> {
  const keys = Object.keys(form) as Array<keyof T>;

  const handler = keys.reduce((prev, fieldName) => {
    const currentValue: unknown = form[fieldName];
    const currentError: unknown =
      errors !== undefined ? errors[fieldName] : undefined;
    function updater(newValue: unknown) {
      updateForm({ ...form, [fieldName]: newValue });
    }
    /**
     * There is no clear way to know if this object is a custom field
     * or a group of fields
     */
    if (typeof currentValue === "object") {
      // @ts-expect-error FIXME better typing
      const group = constructFormHandler(currentValue, updater, currentError);
      // @ts-expect-error FIXME better typing
      prev[fieldName] = group;
      return prev;
    }

    const field: UIField = {
      // @ts-expect-error FIXME better typing
      error: currentError,
      // @ts-expect-error FIXME better typing
      value: currentValue,
      onChange: updater,
      state: {},
    };
    // @ts-expect-error FIXME better typing
    prev[fieldName] = field;
    return prev;
  }, {} as FormHandler<T>);

  return handler;
}

/**
 * FIXME: Consider sending this to web-utils
 *
 *
 * @param defaultValue
 * @param check
 * @returns
 */
export function useFormState<T>(
  defaultValue: RecursivePartial<FormValues<T>>,
  check: (f: RecursivePartial<FormValues<T>>) => FormStatus<T>,
): [FormHandler<T>, FormStatus<T>] {
  const [form, updateForm] =
    useState<RecursivePartial<FormValues<T>>>(defaultValue);

  const status = check(form);
  const handler = constructFormHandler(form, updateForm, status.errors);

  return [handler, status];
}