@vef-framework/components 1.0.122 → 1.0.123

package/esm/vef-form/components/form-row.js

@@ -0,0 +1,99 @@
+"use strict";
+import { jsxs, Fragment, jsx } from '@emotion/react/jsx-runtime';
+import { isDeepEqual, omit } from '@vef-framework/shared';
+import { useMemo, memo } from 'react';
+import VefGrid from '../../vef-grid/index.js';
+import VefGridItem from '../../vef-grid-item/index.js';
+import { useColumnsLayout } from '../hooks/use-columns-layout.js';
+import { useComputedValues } from '../hooks/use-computed-values.js';
+import { useFormContext } from '../hooks/use-form-context.js';
+import VefFormHiddenItem from './form-hidden-item.js';
+import VefFormItem from './form-item.js';
+
+"use strict";
+const formItemMinWidth = 240;
+function VefFormRowBase({
+  rowKey,
+  columns,
+  disabled,
+  autoExpand: rowAutoExpand
+}) {
+  const {
+    layoutMode,
+    autoExpand: formAutoExpand,
+    labelPosition,
+    labelWidth
+  } = useFormContext();
+  const formItemMinWidthToUse = labelPosition === "top" ? formItemMinWidth : formItemMinWidth + (labelWidth ?? 80);
+  const [hiddenItems, filteredColumns] = useMemo(() => {
+    const hiddenItems2 = [];
+    const filteredColumns2 = [];
+    for (const column of columns) {
+      const { items, ...rest } = column;
+      const filteredItems = [];
+      for (const item of items) {
+        const { type } = item;
+        if (type === "Hidden") {
+          hiddenItems2.push(item);
+        } else {
+          filteredItems.push(item);
+        }
+      }
+      if (filteredItems.length > 0) {
+        filteredColumns2.push({
+          ...rest,
+          items: filteredItems
+        });
+      }
+    }
+    return [hiddenItems2, filteredColumns2];
+  }, [columns]);
+  const computedValues = useComputedValues(
+    [
+      ...filteredColumns.map(({ key, show }) => ({
+        key: `show-${key}`,
+        rawValue: show,
+        defaultValue: true
+      })),
+      ...filteredColumns.map(({ key, disabled: columnDisabled }) => ({
+        key: `disabled-${key}`,
+        rawValue: columnDisabled,
+        defaultValue: disabled
+      }))
+    ],
+    true
+  );
+  const showedColumns = useMemo(() => columns.filter(({ key }) => computedValues[`show-${key}`]), [computedValues, columns]);
+  const layout = useColumnsLayout(rowKey, showedColumns, layoutMode, rowAutoExpand ?? formAutoExpand);
+  return /* @__PURE__ */ jsxs(Fragment, { children: [
+    hiddenItems.map((item) => {
+      const { name } = item;
+      return /* @__PURE__ */ jsx(VefFormHiddenItem, { item }, name);
+    }),
+    showedColumns.length > 0 && /* @__PURE__ */ jsx(VefGrid, { baseWidth: formItemMinWidthToUse, gap: [0, "large"], children: showedColumns.map((column) => {
+      const layoutProps = {};
+      if (layoutMode === "responsive") {
+        const columnsLayout = layout;
+        layoutProps.xs = columnsLayout.xs[column.key];
+        layoutProps.sm = columnsLayout.sm[column.key];
+        layoutProps.md = columnsLayout.md[column.key];
+        layoutProps.lg = columnsLayout.lg[column.key];
+        layoutProps.xl = columnsLayout.xl[column.key];
+        layoutProps.xxl = columnsLayout.xxl[column.key];
+      } else {
+        const columnsLayout = layout;
+        layoutProps.span = columnsLayout[column.key];
+      }
+      return /* @__PURE__ */ jsx(VefGridItem, { ...layoutProps, children: column.items.map((item) => /* @__PURE__ */ jsx(VefFormItem, { disabled: disabled || computedValues[`disabled-${column.key}`], item }, item.name)) }, column.key);
+    }) })
+  ] });
+}
+const VefFormRow = memo(
+  VefFormRowBase,
+  (prevProps, nextProps) => isDeepEqual(
+    omit(prevProps, ["columns"]),
+    omit(nextProps, ["columns"])
+  )
+);
+
+export { VefFormRow as default };

package/esm/vef-form/event.js

@@ -0,0 +1,45 @@
+"use strict";
+import { createEventEmitter } from '@vef-framework/shared';
+
+"use strict";
+var __typeError = (msg) => {
+  throw TypeError(msg);
+};
+var __accessCheck = (obj, member, msg) => member.has(obj) || __typeError("Cannot " + msg);
+var __privateGet = (obj, member, getter) => (__accessCheck(obj, member, "read from private field"), getter ? getter.call(obj) : member.get(obj));
+var __privateAdd = (obj, member, value) => member.has(obj) ? __typeError("Cannot add the same private member more than once") : member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
+var _emitter;
+const changeEvent = Symbol("change");
+const submitResultEvent = Symbol("submitResult");
+class FormEventBus {
+  constructor() {
+    /**
+     * The emitter.
+     */
+    __privateAdd(this, _emitter, createEventEmitter());
+  }
+  clear() {
+    __privateGet(this, _emitter).all.clear();
+  }
+  onChange(handler) {
+    __privateGet(this, _emitter).on(changeEvent, handler);
+  }
+  offChange(handler) {
+    __privateGet(this, _emitter).off(changeEvent, handler);
+  }
+  emitChange(value) {
+    __privateGet(this, _emitter).emit(changeEvent, value);
+  }
+  onSubmitResult(handler) {
+    __privateGet(this, _emitter).on(submitResultEvent, handler);
+  }
+  offSubmitResult(handler) {
+    __privateGet(this, _emitter).off(submitResultEvent, handler);
+  }
+  emitSubmitResult(result) {
+    __privateGet(this, _emitter).emit(submitResultEvent, result);
+  }
+}
+_emitter = new WeakMap();
+
+export { FormEventBus };

package/esm/vef-form/helper.js

@@ -0,0 +1,16 @@
+"use strict";
+import { isFunction, isInternalFunction, isExpression, compileDynamicFn } from '@vef-framework/shared';
+
+"use strict";
+function computeValue(value, values, scene, defaultValue) {
+  if (isFunction(value) && !isInternalFunction(value)) {
+    return value(values, scene);
+  }
+  if (isExpression(value)) {
+    const fn = compileDynamicFn(value, "values", "scene", `return ${value.expression}`);
+    return fn(values, scene);
+  }
+  return value ?? defaultValue;
+}
+
+export { computeValue };

package/esm/vef-form/hooks/use-action-handlers.js

@@ -0,0 +1,131 @@
+"use strict";
+import { useApiContext } from '@vef-framework/core';
+import { isFunction, VefError, showLoadingMessage, omit, showSuccessMessage } from '@vef-framework/shared';
+import { useCallback, useMemo } from 'react';
+import { useFormStore } from '../store.js';
+
+"use strict";
+function useActionHandlers({
+  submitApi,
+  submitTip = "提交中...",
+  onBeforeSubmit,
+  onSubmit,
+  onSubmitSuccess,
+  onSubmitFailure,
+  onReset
+}) {
+  const [
+    form,
+    scene,
+    eventBus,
+    setIsLoading,
+    virtualFieldNames,
+    getValues,
+    initialValues,
+    invokeValueChangeHandlers
+  ] = useFormStore((state) => [
+    state.form,
+    state.scene,
+    state.eventBus,
+    state.setIsLoading,
+    state.virtualFieldNames,
+    state.getValues,
+    state.initialValues,
+    state.invokeValueChangeHandlers
+  ]);
+  const { useApiMutation, stubMutationApi } = useApiContext();
+  const { mutate } = useApiMutation(submitApi ?? stubMutationApi);
+  if (!isFunction(onSubmit) && !submitApi) {
+    throw new VefError(-1, "'onSubmit' or 'submitApi' prop is required for VefForm component");
+  }
+  const handleReset = useCallback(() => {
+    const values = getValues();
+    form.resetFields();
+    invokeValueChangeHandlers();
+    eventBus.emitChange(initialValues);
+    onReset?.(values, scene);
+  }, [
+    form,
+    getValues,
+    onReset,
+    scene,
+    invokeValueChangeHandlers,
+    initialValues,
+    eventBus
+  ]);
+  const handleSubmit = useMemo(() => {
+    if (isFunction(onSubmit)) {
+      if (submitApi) {
+        console.warn("'submitApi' prop is ignored when 'onSubmit' prop is provided in VefForm component");
+      }
+      return async (values) => {
+        setIsLoading(true);
+        let valuesToUse = values;
+        let closeLoading = null;
+        try {
+          const submitTipToUse = isFunction(submitTip) ? submitTip(values, scene) : submitTip;
+          closeLoading = showLoadingMessage(submitTipToUse);
+          if (isFunction(onBeforeSubmit)) {
+            valuesToUse = await onBeforeSubmit(valuesToUse, scene);
+          }
+          const valuesToSubmit = omit(valuesToUse, virtualFieldNames);
+          await onSubmit(valuesToSubmit, scene);
+          eventBus.emitSubmitResult(true);
+        } catch (error) {
+          eventBus.emitSubmitResult(false);
+          throw error;
+        } finally {
+          setIsLoading(false);
+          closeLoading?.();
+        }
+      };
+    }
+    return async (values) => {
+      setIsLoading(true);
+      let valuesToUse = values;
+      let closeLoading = null;
+      try {
+        const submitTipToUse = isFunction(submitTip) ? submitTip(values, scene) : submitTip;
+        closeLoading = showLoadingMessage(submitTipToUse);
+        if (isFunction(onBeforeSubmit)) {
+          valuesToUse = await onBeforeSubmit(values, scene);
+        }
+        const toSubmitValues = omit(valuesToUse, virtualFieldNames);
+        const apiResponse = await mutate(toSubmitValues);
+        (onSubmitSuccess ?? (({ message }) => {
+          showSuccessMessage(message);
+        }))(apiResponse, valuesToUse, scene);
+        eventBus.emitSubmitResult(true);
+      } catch (error) {
+        eventBus.emitSubmitResult(false);
+        onSubmitFailure?.(error, valuesToUse, scene);
+      } finally {
+        setIsLoading(false);
+        closeLoading?.();
+      }
+    };
+  }, [
+    onSubmit,
+    submitApi,
+    setIsLoading,
+    submitTip,
+    scene,
+    onBeforeSubmit,
+    virtualFieldNames,
+    eventBus,
+    mutate,
+    onSubmitSuccess,
+    onSubmitFailure
+  ]);
+  const handleSubmitFailed = useCallback(({ values, errorFields }) => {
+    eventBus.emitSubmitResult(false);
+    onSubmitFailure?.(new VefError(-1, errorFields.flatMap((field) => field.errors).join(", ")), values, scene);
+  }, [eventBus, onSubmitFailure, scene]);
+  return {
+    handleReset,
+    handleSubmit,
+    handleSubmitFailed
+  };
+}
+
+export { useActionHandlers };

package/esm/vef-form/hooks/use-columns-layout.js

@@ -0,0 +1,123 @@
+"use strict";
+import { unique, VefError } from '@vef-framework/shared';
+import { useMemo } from 'react';
+
+"use strict";
+const MAX_SPANS = 24;
+const SPAN_BASES = [
+  {
+    breakpoint: "xs",
+    base: MAX_SPANS,
+    spans: 1
+  },
+  {
+    breakpoint: "sm",
+    base: MAX_SPANS / 2,
+    spans: 2
+  },
+  {
+    breakpoint: "md",
+    base: MAX_SPANS / 3,
+    spans: 3
+  },
+  {
+    breakpoint: "lg",
+    base: MAX_SPANS / 4,
+    spans: 4
+  },
+  {
+    breakpoint: "xl",
+    base: MAX_SPANS / 4,
+    spans: 4
+  },
+  {
+    breakpoint: "xxl",
+    base: MAX_SPANS / 6,
+    spans: 6
+  }
+];
+const ALLOWED_SPANS = unique(SPAN_BASES.map((item) => item.spans));
+function calculateResponsiveLayout(rowKey, columns, autoExpand) {
+  const totalSpans = columns.reduce((acc, column) => acc + (column.span ?? 1), 0);
+  if (!ALLOWED_SPANS.includes(totalSpans)) {
+    throw new VefError(-3, `The total spans of the columns of the row [${rowKey}] must be one of the following: ${ALLOWED_SPANS.join(", ")}.`);
+  }
+  const requiredBase = 24 / totalSpans;
+  const layout = {};
+  for (const {
+    breakpoint,
+    base,
+    spans
+  } of SPAN_BASES) {
+    if (requiredBase >= base) {
+      layout[breakpoint] = columns.reduce((acc, column) => {
+        acc[column.key] = (column.span ?? 1) * requiredBase;
+        return acc;
+      }, {});
+    } else {
+      const map = {};
+      let remainingSpans = spans;
+      let lastColumnKey = null;
+      for (const column of columns) {
+        const requiredSpan = column.span ?? 1;
+        if (remainingSpans >= requiredSpan) {
+          map[column.key] = requiredSpan * base;
+          remainingSpans -= requiredSpan;
+          lastColumnKey = column.key;
+        } else {
+          if (lastColumnKey) {
+            if (autoExpand) {
+              map[lastColumnKey] += remainingSpans * base;
+            }
+            remainingSpans = spans;
+            lastColumnKey = null;
+          }
+          if (requiredSpan > spans) {
+            map[column.key] = 24;
+          } else {
+            map[column.key] = requiredSpan * base;
+            remainingSpans -= requiredSpan;
+            lastColumnKey = column.key;
+          }
+        }
+        if (remainingSpans === 0) {
+          remainingSpans = spans;
+          lastColumnKey = null;
+        }
+      }
+      if (remainingSpans > 0) {
+        if (autoExpand) {
+          map[lastColumnKey] += remainingSpans * base;
+        }
+        lastColumnKey = null;
+      }
+      layout[breakpoint] = map;
+    }
+  }
+  return layout;
+}
+function calculateFixedLayout(rowKey, columns) {
+  const totalSpans = columns.reduce((acc, column) => acc + (column.span ?? 1), 0);
+  if (totalSpans > MAX_SPANS || MAX_SPANS % totalSpans !== 0) {
+    throw new VefError(-3, `The total spans of the columns of the row [${rowKey}] must be less than or equal to ${MAX_SPANS} and a divisor of ${MAX_SPANS}.`);
+  }
+  const base = MAX_SPANS / totalSpans;
+  return columns.reduce((acc, column) => {
+    acc[column.key] = (column.span ?? 1) * base;
+    return acc;
+  }, {});
+}
+function useColumnsLayout(rowKey, columns, layoutMode, autoExpand) {
+  return useMemo(() => {
+    if (columns.length === 0) {
+      return {};
+    }
+    if (layoutMode === "responsive") {
+      return calculateResponsiveLayout(rowKey, columns, autoExpand);
+    } else {
+      return calculateFixedLayout(rowKey, columns);
+    }
+  }, []);
+}
+
+export { useColumnsLayout };

package/esm/vef-form/hooks/use-computed-values.js

@@ -0,0 +1,56 @@
+"use strict";
+import { useUpdater, useDeepMemo, useDeepLayoutEffect } from '@vef-framework/hooks';
+import { isFunctionOrExpression, isDeepEqual } from '@vef-framework/shared';
+import { computeValue } from '../helper.js';
+import { useFormStore } from '../store.js';
+
+"use strict";
+function useComputedValues(values, returnAsObject = false) {
+  const [scene, eventBus, getValues] = useFormStore((state) => [state.scene, state.eventBus, state.getValues]);
+  const forceUpdate = useUpdater();
+  const currentValues = getValues();
+  const computedValues = useDeepMemo(() => values.reduce((acc, it) => {
+    const {
+      key,
+      rawValue,
+      defaultValue
+    } = it;
+    const computedValue = computeValue(rawValue, currentValues, scene, defaultValue);
+    acc[key] = computedValue;
+    return acc;
+  }, {}), [currentValues, scene, values]);
+  useDeepLayoutEffect(() => {
+    const realComputedValues = values.filter(({ rawValue }) => isFunctionOrExpression(rawValue));
+    const shouldListenChangeEvent = realComputedValues.length > 0;
+    if (shouldListenChangeEvent) {
+      const handleChange = (newValues) => {
+        for (const value of realComputedValues) {
+          const {
+            key,
+            rawValue,
+            defaultValue
+          } = value;
+          const computedValue = computedValues[key];
+          const refreshedValue = computeValue(rawValue, newValues, scene, defaultValue);
+          if (!isDeepEqual(refreshedValue, computedValue)) {
+            forceUpdate();
+            break;
+          }
+        }
+      };
+      eventBus.onChange(handleChange);
+      return () => {
+        eventBus.offChange(handleChange);
+      };
+    }
+  }, [computedValues, eventBus, forceUpdate, scene, values]);
+  if (returnAsObject) {
+    return values.reduce((acc, { key }) => {
+      acc[key] = computedValues[key];
+      return acc;
+    }, {});
+  }
+  return values.map(({ key }) => computedValues[key]);
+}
+
+export { useComputedValues };

package/esm/vef-form/hooks/use-form-context.js

@@ -0,0 +1,15 @@
+"use strict";
+import { createSelectableContext } from '@vef-framework/shared';
+
+"use strict";
+const {
+  useContextSelector: useFormContextSelector,
+  useContext: useFormContext,
+  ContextProvider: FormContextProvider
+} = createSelectableContext({
+  autoExpand: true,
+  labelPosition: "top",
+  layoutMode: "responsive"
+});
+
+export { FormContextProvider, useFormContext, useFormContextSelector };

package/esm/vef-form/hooks/use-form-initialization.js

@@ -0,0 +1,46 @@
+"use strict";
+import { isNullish, isFunction } from '@vef-framework/shared';
+import { useMemo } from 'react';
+
+"use strict";
+function useFormInitialization(schema, initialValues) {
+  return useMemo(() => {
+    const mergedInitialValues = {
+      ...initialValues
+    };
+    const valueChangeHandlers = {};
+    const virtualFieldNames = [];
+    for (const group of schema) {
+      const { rows } = group;
+      for (const row of rows) {
+        const { columns } = row;
+        for (const column of columns) {
+          const { items } = column;
+          for (const item of items) {
+            const {
+              name,
+              defaultValue,
+              virtual
+            } = item;
+            if (!isNullish(defaultValue) && isNullish(mergedInitialValues[name])) {
+              mergedInitialValues[name] = defaultValue;
+            }
+            if (item.type !== "Hidden" && isFunction(item.onChange)) {
+              valueChangeHandlers[name] = item.onChange;
+            }
+            if (virtual === true) {
+              virtualFieldNames.push(name);
+            }
+          }
+        }
+      }
+    }
+    return {
+      mergedInitialValues,
+      valueChangeHandlers,
+      virtualFieldNames
+    };
+  }, []);
+}
+
+export { useFormInitialization };

package/esm/vef-form/hooks/use-form-instance.js

@@ -0,0 +1,27 @@
+"use strict";
+import { useImperativeHandle } from 'react';
+import { useFormStore } from '../store.js';
+
+"use strict";
+function useFormInstance(ref, reset) {
+  const [form, eventBus, getValues, setValues] = useFormStore((state) => [state.form, state.eventBus, state.getValues, state.setValues]);
+  useImperativeHandle(ref, () => ({
+    submit: () => new Promise((resolve, reject) => {
+      const handleResult = (result) => {
+        eventBus.offSubmitResult(handleResult);
+        if (result) {
+          resolve();
+        } else {
+          reject(result);
+        }
+      };
+      eventBus.onSubmitResult(handleResult);
+      form.submit();
+    }),
+    reset,
+    getValues,
+    setValues
+  }));
+}
+
+export { useFormInstance };

package/esm/vef-form/hooks/use-form-values-change.js

@@ -0,0 +1,31 @@
+"use strict";
+import { isFunction } from '@vef-framework/shared';
+import { useMemo, useEffect, useLayoutEffect } from 'react';
+import { useFormStore } from '../store.js';
+
+"use strict";
+function useFormValuesChange(onChange) {
+  const [scene, eventBus, invokeValueChangeHandlers] = useFormStore((state) => [state.scene, state.eventBus, state.invokeValueChangeHandlers]);
+  const handleValuesChange = useMemo(() => (_, values) => {
+    eventBus.emitChange(values);
+  }, [eventBus]);
+  useEffect(() => {
+    if (isFunction(onChange)) {
+      const handleChange = (values) => {
+        onChange(values, scene);
+      };
+      eventBus.onChange(handleChange);
+      return () => {
+        eventBus.offChange(handleChange);
+      };
+    }
+  }, [eventBus, onChange, scene]);
+  useLayoutEffect(() => {
+    invokeValueChangeHandlers();
+  }, []);
+  return {
+    handleValuesChange
+  };
+}
+
+export { useFormValuesChange };

package/esm/vef-form/hooks/use-label-width.js

@@ -0,0 +1,19 @@
+"use strict";
+import { showWarningMessage } from '@vef-framework/shared';
+import { useMemo } from 'react';
+
+"use strict";
+function useLabelWidth(labelPosition, labelWidth) {
+  const labelWidthToUse = useMemo(() => {
+    if (labelPosition === "top" || !labelWidth) {
+      return;
+    }
+    if (labelWidth < 60 || labelWidth > 120) {
+      showWarningMessage("The labelWidth of VefForm component must be between 60 and 120, otherwise it will be 60 or 120.");
+    }
+    return Math.min(Math.max(labelWidth, 60), 120);
+  }, [labelPosition, labelWidth]);
+  return labelWidthToUse;
+}
+
+export { useLabelWidth };