@multiplatform.one/frappe-ui 7.21.0 → 7.23.0

package/README.md

@@ -24,6 +24,10 @@ pnpm add @multiplatform.one/frappe-ui
 - **Field registry** — maps Frappe fieldtypes to form field components
   (`registerField`, `getFieldComponent`, `initDefaultRegistry`,
   `fieldtypeToTableField`, `childFieldsToColumns`)
+- **Desk list** — `buildListColumns` (the desk list's column derivation, which
+  `FrappeTable` defaults to), `listFieldsToFetch`, and the one filterable-field
+  vocabulary both list stacks read (`filterableFieldsFromMeta`,
+  `docFieldsToFilterFields`, desk's operators and tuple conversion)
 
 ## What it must not do
 
@@ -64,6 +68,16 @@ export function ToDoTable() {
 `FrappeTable` accepts the rest of the `DataTable` props from
 `@multiplatform.one/table` (filtering, sorting, pagination, `serverSide`, …).
 
+`columns` is optional. Without it the table renders the doctype the way desk's
+list does: `buildListColumns` derives the title, the `in_list_view` fields the
+session's roles may read and the activity cluster from the doctype's meta, and
+a bench read asks for `listFieldsToFetch`. The table waits for meta and the
+roles before that read, so it happens once.
+
+```tsx
+<FrappeTable<ToDo> doctype="ToDo" serverSide />
+```
+
 ### Infinite scroll (server-side)
 
 With `serverSide` and `paginationMode="infinite"`, `FrappeTable` supplies the

package/dist/cjs/FrappeForm.cjs

@@ -47,7 +47,12 @@ var import_fetchFrom = require("./formEngine/fetchFrom.cjs");
 var import_fieldPermissions = require("./formEngine/fieldPermissions.cjs");
 var import_formActions = require("./formEngine/formActions.cjs");
 var import_formLayout = require("./formEngine/formLayout.cjs");
+var import_createPrefill = require("./formEngine/createPrefill.cjs");
+var import_docLifecycle = require("./formEngine/docLifecycle.cjs");
+var import_useAmendedAs = require("./formEngine/useAmendedAs.cjs");
 var import_useDocRights = require("./formEngine/useDocRights.cjs");
+var import_useFormEngine = require("./formEngine/useFormEngine.cjs");
+var import_FrappeFormActions = require("./FrappeFormActions.cjs");
 var import_frappeConnections = require("./frappeConnections.cjs");
 var import_FrappeFormConnections = require("./FrappeFormConnections.cjs");
 var import_FrappeRowsReader = require("./FrappeRowsReader.cjs");
@@ -174,6 +179,7 @@ function FrappeFormRoute({
   onCancel,
   onDelete,
   onEdit,
+  onAmend,
   ...props
 }) {
   const router = (0, import_frappeNavigation.useFrappeRouter)();
@@ -216,6 +222,9 @@ function FrappeFormRoute({
     })),
     onDelete: onDelete ?? (() => go({
       mode: "list"
+    })),
+    onAmend: onAmend ?? (() => go({
+      mode: "create"
     }))
   });
 }
@@ -236,6 +245,7 @@ function FrappeFormBody({
   onSave,
   onCancel,
   onDelete,
+  onAmend,
   onEdit,
   showToolbar = true,
   showSidebar = true,
@@ -273,6 +283,7 @@ function FrappeFormBody({
   localDocRef.current = localDoc;
   const baselineRef = (0, import_react2.useRef)(baselineDoc);
   baselineRef.current = baselineDoc;
+  const createDraftRef = (0, import_react2.useRef)(void 0);
   const finalBaseURL = baseURL ?? config?.baseURL;
   const finalAuth = auth ?? config?.auth;
   const finalSyncOptions = syncOptions ?? config?.syncOptions;
@@ -294,12 +305,14 @@ function FrappeFormBody({
     isLoading: isMetaLoading,
     error: metaError
   } = (0, import_frappe.useDocTypeMeta)(frappeConfig, doctype);
+  const isSubmittable = !!meta?.is_submittable;
   const isCreate = !name;
   const docstatus = Number(baselineDoc?.docstatus ?? 0);
   const layoutFields = (0, import_react2.useMemo)(() => {
     if (!meta) return void 0;
     return sections ? sectionsToLayoutFields(sections) : meta.fields;
   }, [meta, sections]);
+  const amendedAs = (0, import_useAmendedAs.useAmendedAs)(isSubmittable && docstatus === 2 ? frappeConfig : void 0, doctype, name);
   const readsWithoutMeta = !children && !meta && Boolean(metaError) && Boolean(name);
   const recordTabs = (0, import_react2.useMemo)(() => {
     if (!readsWithoutMeta || !baselineDoc) return void 0;
@@ -413,6 +426,7 @@ function FrappeFormBody({
   const assignmentRows = (0, import_react2.useMemo)(() => assignmentCollection ? rawAssignmentRows ?? [] : void 0, [assignmentCollection, rawAssignmentRows]);
   (0, import_react2.useEffect)(() => {
     everLoadedRef.current = false;
+    if (name) createDraftRef.current = void 0;
     setWasDeleted(false);
     setConflictFields([]);
     setDocError(null);
@@ -486,7 +500,14 @@ function FrappeFormBody({
     } else if (name && everLoadedRef.current && !liveDoc?.isLoading) {
       setWasDeleted(true);
     } else if (!name) {
+      if (createDraftRef.current?.doctype !== doctype) {
+        createDraftRef.current = {
+          doctype,
+          values: (0, import_createPrefill.takeCreatePrefill)(doctype)
+        };
+      }
       setLocalDoc({
+        ...createDraftRef.current.values,
         doctype
       });
     }
@@ -663,6 +684,43 @@ function FrappeFormBody({
       setIsSubmitting(false);
     }
   };
+  const transitionDocstatus = async (to, question, failure) => {
+    if (!docCollection || !name || wasDeleted || !rights[to === 1 ? "submit" : "cancel"]) return;
+    if (to === 1) {
+      const requiredErrors = validateRequiredFields();
+      if (Object.keys(requiredErrors).length > 0) {
+        setErrors(requiredErrors);
+        return;
+      }
+    }
+    if (!(await import_desktop.dialog.confirm(question))) return;
+    setIsSubmitting(true);
+    setErrors({});
+    try {
+      const tx = docCollection.update(name, draft => {
+        draft.docstatus = to;
+      });
+      await tx.isPersisted.promise;
+    } catch (err) {
+      setErrors({
+        general: (0, import_useFormEngine.extractServerError)(err, failure)
+      });
+    } finally {
+      setIsSubmitting(false);
+    }
+  };
+  const handleSubmitDocument = () => transitionDocstatus(1, t("Permanently Submit {{name}}?", {
+    name
+  }), t("Failed to submit"));
+  const handleCancelDocument = () => transitionDocstatus(2, t("Permanently Cancel {{name}}?", {
+    name
+  }), t("Failed to cancel"));
+  const handleAmend = () => {
+    if (!meta || !name || !onAmend || !rights.amend) return;
+    const draft = (0, import_docLifecycle.buildAmendValues)(meta.fields, localDoc, name);
+    (0, import_createPrefill.setCreatePrefill)(doctype, draft);
+    onAmend(draft);
+  };
   const titleField = meta?.title_field;
   const titleValue = titleField ? localDoc[titleField] : void 0;
   const pageTitle = isCreate ? t("New {{doctype}}", {
@@ -784,12 +842,30 @@ function FrappeFormBody({
   const effectiveDisabled = disabled || wasDeleted;
   const readOnlyView = Boolean(onEdit) || readsWithoutMeta;
   const fieldsDisabled = effectiveDisabled || readOnlyView || !canWriteRecord;
-  const showDelete = Boolean(name && onDelete && !wasDeleted && rights.delete);
-  const showEdit = Boolean(onEdit && rights.write);
-  const showSave = !onEdit && canWriteRecord;
-  const showCancel = !onEdit && Boolean(onCancel);
-  const showNotSaved = hasUnsavedChanges && !onEdit;
-  const toolbarShown = showToolbar && !readsWithoutMeta && (showDelete || showEdit || showSave || showCancel || showNotSaved);
+  const indicator = (0, import_docLifecycle.resolveDocIndicator)({
+    docstatus,
+    isCreate,
+    isDirty: hasUnsavedChanges && !onEdit,
+    isSubmittable
+  });
+  const docAction = (0, import_docLifecycle.resolveDocAction)({
+    docstatus,
+    isCreate,
+    isDirty: hasUnsavedChanges,
+    isSubmittable,
+    perms: {
+      write: canWriteRecord,
+      submit: rights.submit,
+      cancel: rights.cancel,
+      amend: rights.amend
+    },
+    isReadOnlyView: Boolean(onEdit)
+  });
+  const showDelete = Boolean(name && onDelete && !wasDeleted && rights.delete && (0, import_docLifecycle.canDeleteDoc)(docstatus));
+  const showEdit = Boolean(onEdit && rights.write && (0, import_docLifecycle.canEditDoc)(docstatus, meta));
+  const showAmend = Boolean(onAmend && (0, import_docLifecycle.isAmendable)(meta));
+  const showClose = !onEdit && Boolean(onCancel);
+  const toolbarShown = showToolbar && !readsWithoutMeta && Boolean(indicator || docAction || showDelete || showEdit || showClose);
   const shownTabs = formTabs ?? recordTabs;
   const imageFieldName = meta?.image_field;
   const sidebarImageUrl = imageFieldName ? resolveFileUrl(localDoc[imageFieldName], finalBaseURL) : void 0;
@@ -925,52 +1001,20 @@ function FrappeFormBody({
           color: import_forms.formCommonColors.error,
           ...knobProps.body,
           children: errors.general
-        }), toolbarShown && /* @__PURE__ */(0, import_jsx_runtime.jsxs)(import_tamagui.XStack, {
-          ...knobProps.gap,
-          justifyContent: "flex-end",
-          alignItems: "center",
-          paddingTop: "$3",
-          children: [showNotSaved && /* @__PURE__ */(0, import_jsx_runtime.jsx)(import_tamagui.Text, {
-            color: "$orange11",
-            marginInlineEnd: "auto",
-            ...knobProps.body,
-            children: t("Not Saved")
-          }), showDelete && /* @__PURE__ */(0, import_jsx_runtime.jsx)(import_forms.Button, {
-            outlined: true,
-            error: true,
-            icon: import_react.TrashIcon,
-            loading: isSubmitting,
-            disabled: effectiveDisabled,
-            disabledReason: t("Form is read-only"),
-            disabledReasonPlacement: "inline",
-            onPress: handleDelete,
-            children: t("Delete")
-          }), showEdit && /* @__PURE__ */(0, import_jsx_runtime.jsx)(import_forms.Button, {
-            accent: true,
-            icon: import_react.PencilSimpleIcon,
-            disabled: effectiveDisabled,
-            disabledReason: t("Form is read-only"),
-            disabledReasonPlacement: "inline",
-            onPress: onEdit,
-            children: t("Edit")
-          }), showCancel && /* @__PURE__ */(0, import_jsx_runtime.jsx)(import_forms.Button, {
-            outlined: true,
-            icon: import_react.XIcon,
-            disabled,
-            disabledReason: t("Form is read-only"),
-            disabledReasonPlacement: "inline",
-            onPress: handleCancel,
-            children: t("Cancel")
-          }), showSave && /* @__PURE__ */(0, import_jsx_runtime.jsx)(import_forms.Button, {
-            accent: true,
-            icon: import_react.FloppyDiskIcon,
-            loading: isSubmitting,
-            disabled: effectiveDisabled,
-            disabledReason: t("Form is read-only"),
-            disabledReasonPlacement: "inline",
-            onPress: handleSave,
-            children: isSubmitting ? t("Saving...") : t("Save")
-          })]
+        }), toolbarShown && /* @__PURE__ */(0, import_jsx_runtime.jsx)(import_FrappeFormActions.FrappeFormActions, {
+          indicator,
+          action: docAction,
+          busy: isSubmitting,
+          disabled: effectiveDisabled,
+          onSave: handleSave,
+          onSubmit: handleSubmitDocument,
+          onCancelDocument: handleCancelDocument,
+          onAmend: showAmend ? handleAmend : void 0,
+          amendedAs,
+          onDelete: showDelete ? handleDelete : void 0,
+          onEdit: showEdit ? onEdit : void 0,
+          onClose: showClose ? handleCancel : void 0,
+          closeDisabled: disabled
         })]
       })]
     }), showTimeline && name && !readsWithoutMeta && /* @__PURE__ */(0, import_jsx_runtime.jsx)(import_timeline.Timeline, {

package/dist/cjs/FrappeForm.native.js

@@ -51,7 +51,12 @@ var import_fetchFrom = require("./formEngine/fetchFrom.native.js");
 var import_fieldPermissions = require("./formEngine/fieldPermissions.native.js");
 var import_formActions = require("./formEngine/formActions.native.js");
 var import_formLayout = require("./formEngine/formLayout.native.js");
+var import_createPrefill = require("./formEngine/createPrefill.native.js");
+var import_docLifecycle = require("./formEngine/docLifecycle.native.js");
+var import_useAmendedAs = require("./formEngine/useAmendedAs.native.js");
 var import_useDocRights = require("./formEngine/useDocRights.native.js");
+var import_useFormEngine = require("./formEngine/useFormEngine.native.js");
+var import_FrappeFormActions = require("./FrappeFormActions.native.js");
 var import_frappeConnections = require("./frappeConnections.native.js");
 var import_FrappeFormConnections = require("./FrappeFormConnections.native.js");
 var import_FrappeRowsReader = require("./FrappeRowsReader.native.js");
@@ -203,6 +208,7 @@ function FrappeFormRoute(param) {
     onCancel,
     onDelete,
     onEdit,
+    onAmend,
     ...props
   } = param;
   var router = (0, import_frappeNavigation.useFrappeRouter)();
@@ -257,6 +263,11 @@ function FrappeFormRoute(param) {
       return go({
         mode: "list"
       });
+    },
+    onAmend: onAmend !== null && onAmend !== void 0 ? onAmend : function () {
+      return go({
+        mode: "create"
+      });
     }
   });
 }
@@ -278,6 +289,7 @@ function FrappeFormBody(param) {
     onSave,
     onCancel,
     onDelete,
+    onAmend,
     onEdit,
     showToolbar = true,
     showSidebar = true,
@@ -321,6 +333,7 @@ function FrappeFormBody(param) {
   localDocRef.current = localDoc;
   var baselineRef = (0, import_react3.useRef)(baselineDoc);
   baselineRef.current = baselineDoc;
+  var createDraftRef = (0, import_react3.useRef)(void 0);
   var finalBaseURL = baseURL !== null && baseURL !== void 0 ? baseURL : config === null || config === void 0 ? void 0 : config.baseURL;
   var finalAuth = auth !== null && auth !== void 0 ? auth : config === null || config === void 0 ? void 0 : config.auth;
   var finalSyncOptions = syncOptions !== null && syncOptions !== void 0 ? syncOptions : config === null || config === void 0 ? void 0 : config.syncOptions;
@@ -344,12 +357,14 @@ function FrappeFormBody(param) {
     isLoading: isMetaLoading,
     error: metaError
   } = (0, import_frappe.useDocTypeMeta)(frappeConfig, doctype);
+  var isSubmittable = !!(meta === null || meta === void 0 ? void 0 : meta.is_submittable);
   var isCreate = !name;
   var docstatus = Number((_ref = baselineDoc === null || baselineDoc === void 0 ? void 0 : baselineDoc.docstatus) !== null && _ref !== void 0 ? _ref : 0);
   var layoutFields = (0, import_react3.useMemo)(function () {
     if (!meta) return void 0;
     return sections ? sectionsToLayoutFields(sections) : meta.fields;
   }, [meta, sections]);
+  var amendedAs = (0, import_useAmendedAs.useAmendedAs)(isSubmittable && docstatus === 2 ? frappeConfig : void 0, doctype, name);
   var readsWithoutMeta = !children && !meta && Boolean(metaError) && Boolean(name);
   var recordTabs = (0, import_react3.useMemo)(function () {
     if (!readsWithoutMeta || !baselineDoc) return void 0;
@@ -477,6 +492,7 @@ function FrappeFormBody(param) {
   }, [assignmentCollection, rawAssignmentRows]);
   (0, import_react3.useEffect)(function () {
     everLoadedRef.current = false;
+    if (name) createDraftRef.current = void 0;
     setWasDeleted(false);
     setConflictFields([]);
     setDocError(null);
@@ -608,7 +624,15 @@ function FrappeFormBody(param) {
     } else if (name && everLoadedRef.current && !(liveDoc === null || liveDoc === void 0 ? void 0 : liveDoc.isLoading)) {
       setWasDeleted(true);
     } else if (!name) {
+      var _createDraftRef_current;
+      if (((_createDraftRef_current = createDraftRef.current) === null || _createDraftRef_current === void 0 ? void 0 : _createDraftRef_current.doctype) !== doctype) {
+        createDraftRef.current = {
+          doctype,
+          values: (0, import_createPrefill.takeCreatePrefill)(doctype)
+        };
+      }
       setLocalDoc({
+        ...createDraftRef.current.values,
         doctype
       });
     }
@@ -892,6 +916,47 @@ function FrappeFormBody(param) {
       setIsSubmitting(false);
     }
   };
+  var transitionDocstatus = async function transitionDocstatus2(to, question, failure) {
+    if (!docCollection || !name || wasDeleted || !rights[to === 1 ? "submit" : "cancel"]) return;
+    if (to === 1) {
+      var requiredErrors = validateRequiredFields();
+      if (Object.keys(requiredErrors).length > 0) {
+        setErrors(requiredErrors);
+        return;
+      }
+    }
+    if (!(await import_desktop.dialog.confirm(question))) return;
+    setIsSubmitting(true);
+    setErrors({});
+    try {
+      var tx = docCollection.update(name, function (draft) {
+        draft.docstatus = to;
+      });
+      await tx.isPersisted.promise;
+    } catch (err) {
+      setErrors({
+        general: (0, import_useFormEngine.extractServerError)(err, failure)
+      });
+    } finally {
+      setIsSubmitting(false);
+    }
+  };
+  var handleSubmitDocument = function handleSubmitDocument2() {
+    return transitionDocstatus(1, t("Permanently Submit {{name}}?", {
+      name
+    }), t("Failed to submit"));
+  };
+  var handleCancelDocument = function handleCancelDocument2() {
+    return transitionDocstatus(2, t("Permanently Cancel {{name}}?", {
+      name
+    }), t("Failed to cancel"));
+  };
+  var handleAmend = function handleAmend2() {
+    if (!meta || !name || !onAmend || !rights.amend) return;
+    var draft = (0, import_docLifecycle.buildAmendValues)(meta.fields, localDoc, name);
+    (0, import_createPrefill.setCreatePrefill)(doctype, draft);
+    onAmend(draft);
+  };
   var titleField = meta === null || meta === void 0 ? void 0 : meta.title_field;
   var titleValue = titleField ? localDoc[titleField] : void 0;
   var pageTitle = isCreate ? t("New {{doctype}}", {
@@ -1015,12 +1080,30 @@ function FrappeFormBody(param) {
   var effectiveDisabled = disabled || wasDeleted;
   var readOnlyView = Boolean(onEdit) || readsWithoutMeta;
   var fieldsDisabled = effectiveDisabled || readOnlyView || !canWriteRecord;
-  var showDelete = Boolean(name && onDelete && !wasDeleted && rights.delete);
-  var showEdit = Boolean(onEdit && rights.write);
-  var showSave = !onEdit && canWriteRecord;
-  var showCancel = !onEdit && Boolean(onCancel);
-  var showNotSaved = hasUnsavedChanges && !onEdit;
-  var toolbarShown = showToolbar && !readsWithoutMeta && (showDelete || showEdit || showSave || showCancel || showNotSaved);
+  var indicator = (0, import_docLifecycle.resolveDocIndicator)({
+    docstatus,
+    isCreate,
+    isDirty: hasUnsavedChanges && !onEdit,
+    isSubmittable
+  });
+  var docAction = (0, import_docLifecycle.resolveDocAction)({
+    docstatus,
+    isCreate,
+    isDirty: hasUnsavedChanges,
+    isSubmittable,
+    perms: {
+      write: canWriteRecord,
+      submit: rights.submit,
+      cancel: rights.cancel,
+      amend: rights.amend
+    },
+    isReadOnlyView: Boolean(onEdit)
+  });
+  var showDelete = Boolean(name && onDelete && !wasDeleted && rights.delete && (0, import_docLifecycle.canDeleteDoc)(docstatus));
+  var showEdit = Boolean(onEdit && rights.write && (0, import_docLifecycle.canEditDoc)(docstatus, meta));
+  var showAmend = Boolean(onAmend && (0, import_docLifecycle.isAmendable)(meta));
+  var showClose = !onEdit && Boolean(onCancel);
+  var toolbarShown = showToolbar && !readsWithoutMeta && Boolean(indicator || docAction || showDelete || showEdit || showClose);
   var shownTabs = formTabs !== null && formTabs !== void 0 ? formTabs : recordTabs;
   var imageFieldName = meta === null || meta === void 0 ? void 0 : meta.image_field;
   var sidebarImageUrl = imageFieldName ? resolveFileUrl(localDoc[imageFieldName], finalBaseURL) : void 0;
@@ -1176,52 +1259,20 @@ function FrappeFormBody(param) {
           color: import_forms.formCommonColors.error,
           ...knobProps.body,
           children: errors.general
-        }), toolbarShown && /* @__PURE__ */(0, import_jsx_runtime.jsxs)(import_tamagui.XStack, {
-          ...knobProps.gap,
-          justifyContent: "flex-end",
-          alignItems: "center",
-          paddingTop: "$3",
-          children: [showNotSaved && /* @__PURE__ */(0, import_jsx_runtime.jsx)(import_tamagui.Text, {
-            color: "$orange11",
-            marginInlineEnd: "auto",
-            ...knobProps.body,
-            children: t("Not Saved")
-          }), showDelete && /* @__PURE__ */(0, import_jsx_runtime.jsx)(import_forms.Button, {
-            outlined: true,
-            error: true,
-            icon: import_react2.TrashIcon,
-            loading: isSubmitting,
-            disabled: effectiveDisabled,
-            disabledReason: t("Form is read-only"),
-            disabledReasonPlacement: "inline",
-            onPress: handleDelete,
-            children: t("Delete")
-          }), showEdit && /* @__PURE__ */(0, import_jsx_runtime.jsx)(import_forms.Button, {
-            accent: true,
-            icon: import_react2.PencilSimpleIcon,
-            disabled: effectiveDisabled,
-            disabledReason: t("Form is read-only"),
-            disabledReasonPlacement: "inline",
-            onPress: onEdit,
-            children: t("Edit")
-          }), showCancel && /* @__PURE__ */(0, import_jsx_runtime.jsx)(import_forms.Button, {
-            outlined: true,
-            icon: import_react2.XIcon,
-            disabled,
-            disabledReason: t("Form is read-only"),
-            disabledReasonPlacement: "inline",
-            onPress: handleCancel,
-            children: t("Cancel")
-          }), showSave && /* @__PURE__ */(0, import_jsx_runtime.jsx)(import_forms.Button, {
-            accent: true,
-            icon: import_react2.FloppyDiskIcon,
-            loading: isSubmitting,
-            disabled: effectiveDisabled,
-            disabledReason: t("Form is read-only"),
-            disabledReasonPlacement: "inline",
-            onPress: handleSave,
-            children: isSubmitting ? t("Saving...") : t("Save")
-          })]
+        }), toolbarShown && /* @__PURE__ */(0, import_jsx_runtime.jsx)(import_FrappeFormActions.FrappeFormActions, {
+          indicator,
+          action: docAction,
+          busy: isSubmitting,
+          disabled: effectiveDisabled,
+          onSave: handleSave,
+          onSubmit: handleSubmitDocument,
+          onCancelDocument: handleCancelDocument,
+          onAmend: showAmend ? handleAmend : void 0,
+          amendedAs,
+          onDelete: showDelete ? handleDelete : void 0,
+          onEdit: showEdit ? onEdit : void 0,
+          onClose: showClose ? handleCancel : void 0,
+          closeDisabled: disabled
         })]
       })]
     }), /* Timeline (edit mode only) — live Comment/Version via useFrappeCollection */