@plasmicpkgs/antd5 0.0.84 → 0.0.85

package/dist/registerForm.d.ts

@@ -1,11 +1,12 @@
 import { CodeComponentMode, ComponentHelpers } from "@plasmicapp/host";
-import { CanvasComponentProps } from "@plasmicapp/host/registerComponent";
 import { Form } from "antd";
 import type { FormInstance, FormProps } from "antd/es/form";
 import type { FormItemProps } from "antd/es/form/FormItem";
 import type { FormListOperation, FormListProps } from "antd/es/form/FormList";
 import React from "react";
 import { Registerable } from "./utils";
+import { CanvasComponentProps } from "@plasmicapp/host/registerComponent";
+import { TableSchema, DataOp } from "@plasmicapp/data-sources";
 interface InternalFormItemProps extends Omit<FormItemProps, "rules"> {
     rules?: PlasmicRule[];
     noLabel?: boolean;
@@ -35,6 +36,18 @@ export interface SimplifiedFormItemsProp extends InternalFormItemProps {
 }
 interface FormWrapperControlContextData {
     formInstance: FormInstance<any>;
+    schema?: TableSchema;
+    minimalFullLengthFields: Partial<SimplifiedFormItemsProp>[];
+    mergedFields: SimplifiedFormItemsProp[];
+}
+export declare enum FormType {
+    NewEntry = 0,
+    UpdateEntry = 1
+}
+interface DBConnectionProp {
+    formType: FormType;
+    dataSchema: DataOp;
+    dataEntry: DataOp;
 }
 interface FormWrapperProps extends FormProps, CanvasComponentProps<FormWrapperControlContextData> {
     /**
@@ -47,7 +60,9 @@ interface FormWrapperProps extends FormProps, CanvasComponentProps<FormWrapperCo
     extendedOnValuesChange?: (values: Parameters<NonNullable<FormProps["onValuesChange"]>>[1]) => void;
     formItems: SimplifiedFormItemsProp[];
     mode?: CodeComponentMode;
+    formType: "new-entry" | "update-entry";
     submitSlot?: boolean;
+    data?: DBConnectionProp;
 }
 interface InternalFormInstanceContextData {
     fireOnValuesChange: () => void;
@@ -65,9 +80,12 @@ interface FormRefActions extends Pick<FormInstance<any>, "setFieldsValue" | "res
 export declare const FormWrapper: React.ForwardRefExoticComponent<FormWrapperProps & React.RefAttributes<FormRefActions>>;
 export declare const formHelpers: ComponentHelpers<FormWrapperProps>;
 export declare const formComponentName = "plasmic-antd5-form";
+export declare const formTypeDescription = "\n  You can create form with two different behaviors:\n  \n\n\n  1. Create a new entry: The form will be created empty and it will create a new row when submitted.\n  2. Update an entry: The form will be pre-filled with the row values and it will update the table entry when submitted.\n  \n\n\n  For both options, you can customize later.\n";
 export declare function registerForm(loader?: Registerable): void;
 interface FormControlContextData {
     internalFormCtx?: InternalFormInstanceContextData;
+    formInstance?: FormInstance<any>;
+    parentFormItemPath: (string | number)[];
 }
 interface CuratedFieldData {
     status: string | undefined;

package/dist/utils.d.ts

@@ -22,6 +22,7 @@ type ReactElt = {
 export declare function traverseReactEltTree(children: React.ReactNode, callback: (elt: ReactElt) => void): void;
 export declare function asArray<T>(x: T[] | T | undefined | null): T[];
 export declare function omit<T extends object>(obj: T, ...keys: (keyof T)[]): Partial<T>;
+export declare function has<T extends object>(obj: T, keys: (keyof T)[]): boolean;
 export declare function usePrevious<T>(value: T | undefined): T | undefined;
 export declare function capitalize(value: string): string;
 export declare function ensureArray<T>(x: T | T[]): T[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plasmicpkgs/antd5",
-  "version": "0.0.84",
+  "version": "0.0.85",
   "description": "Plasmic registration calls for antd components",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -55,7 +55,7 @@
     "antd": "^5.1.6"
   },
   "devDependencies": {
-    "@plasmicapp/host": "1.0.150",
+    "@plasmicapp/host": "1.0.151",
     "@plasmicapp/query": "0.1.67",
     "@types/node": "^14.0.26",
     "@types/react": "^18.0.27",
@@ -76,5 +76,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d933fd1793c7b2d01af2400582593724ec364085"
+  "gitHead": "35d4595c6d82b47128fdb0c536fab54d7bbc609f"
 }

package/skinny/registerForm.cjs.js

@@ -11,6 +11,7 @@ var registerInput = require('./registerInput.cjs.js');
 var registerRadio = require('./registerRadio.cjs.js');
 var registerSwitch = require('./registerSwitch.cjs.js');
 var utils = require('./utils-838eeae8.cjs.js');
+var dataSources = require('@plasmicapp/data-sources');
 require('classnames');
 require('@plasmicapp/host/registerComponent');
 require('@plasmicapp/host/registerGlobalContext');
@@ -67,18 +68,23 @@ var InputType = /* @__PURE__ */ ((InputType2) => {
   InputType2["DatePicker"] = "DatePicker";
   return InputType2;
 })(InputType || {});
+var FormType = /* @__PURE__ */ ((FormType2) => {
+  FormType2[FormType2["NewEntry"] = 0] = "NewEntry";
+  FormType2[FormType2["UpdateEntry"] = 1] = "UpdateEntry";
+  return FormType2;
+})(FormType || {});
 const PathContext = React__default.default.createContext({ relativePath: [], fullPath: [] });
 const InternalFormInstanceContext = React__default.default.createContext(void 0);
 const FormLayoutContext = React__default.default.createContext(void 0);
 const Internal = React__default.default.forwardRef(
   (props, ref) => {
-    var _b, _c, _d, _e, _f;
+    var _b, _c, _d, _e;
     const [form] = antd.Form.useForm();
     const values = form.getFieldsValue(true);
     const lastValue = React__default.default.useRef(values);
     const _a = props, { extendedOnValuesChange, setRemountKey } = _a, rest = __objRest(_a, ["extendedOnValuesChange", "setRemountKey"]);
     let childrenNode;
-    if (props.mode !== "simplified") {
+    if (props.mode === "advanced") {
       childrenNode = typeof props.children === "function" ? props.children(values, form) : props.children;
     } else {
       childrenNode = /* @__PURE__ */ React__default.default.createElement(React__default.default.Fragment, null, ((_b = props.formItems) != null ? _b : []).map((formItem) => /* @__PURE__ */ React__default.default.createElement(
@@ -117,7 +123,6 @@ const Internal = React__default.default.forwardRef(
       },
       [props.layout, (_c = props.labelCol) == null ? void 0 : _c.span]
     );
-    (_d = props.setControlContextData) == null ? void 0 : _d.call(props, { formInstance: form });
     React__default.default.useImperativeHandle(ref, () => ({
       formInstance: form,
       setFieldsValue: (newValues) => {
@@ -158,8 +163,8 @@ const Internal = React__default.default.forwardRef(
             extendedOnValuesChange == null ? void 0 : extendedOnValuesChange(args[1]);
           },
           form,
-          labelCol: ((_e = props.labelCol) == null ? void 0 : _e.horizontalOnly) && props.layout !== "horizontal" ? void 0 : props.labelCol,
-          wrapperCol: ((_f = props.wrapperCol) == null ? void 0 : _f.horizontalOnly) && props.layout !== "horizontal" ? void 0 : props.wrapperCol
+          labelCol: ((_d = props.labelCol) == null ? void 0 : _d.horizontalOnly) && props.layout !== "horizontal" ? void 0 : props.labelCol,
+          wrapperCol: ((_e = props.wrapperCol) == null ? void 0 : _e.horizontalOnly) && props.layout !== "horizontal" ? void 0 : props.wrapperCol
         }),
         /* @__PURE__ */ React__default.default.createElement("style", null, `
           .ant-form-item-explain + div, .ant-form-item-margin-offset {
@@ -171,6 +176,51 @@ const Internal = React__default.default.forwardRef(
     );
   }
 );
+function useFormItemDefinitions(rawData, props, formRef) {
+  const { mode, formItems, setControlContextData } = props;
+  return React__default.default.useMemo(() => {
+    if (mode !== "simplified" || !formRef || !rawData || rawData.error) {
+      return void 0;
+    }
+    const data = dataSources.normalizeData(rawData);
+    const schema = data == null ? void 0 : data.schema;
+    if (!data || !schema || !data.data) {
+      return void 0;
+    }
+    const row = data.data.length > 0 ? data.data[0] : void 0;
+    const { mergedFields, minimalFullLengthFields } = dataSources.deriveFieldConfigs(
+      formItems != null ? formItems : [],
+      schema,
+      (field) => __spreadValues({
+        inputType: "Text" /* Text */
+      }, field && {
+        key: field.id,
+        fieldId: field.id,
+        label: field.label,
+        name: field.id,
+        inputType: field.type === "string" ? "Text" /* Text */ : field.type === "number" ? "Number" /* Number */ : field.type === "boolean" ? "Checkbox" /* Checkbox */ : "Text" /* Text */,
+        //missing date and date-time
+        initialValue: row ? row[field.id] : void 0,
+        hidden: field.primaryKey
+      })
+    );
+    setControlContextData == null ? void 0 : setControlContextData({
+      schema: data.schema,
+      minimalFullLengthFields,
+      mergedFields,
+      formInstance: formRef.formInstance
+    });
+    return mergedFields;
+  }, [mode, setControlContextData, formItems, rawData, formRef]);
+}
+const useRawData = (connection) => {
+  const rawDataSchema = dataSources.usePlasmicDataOp(connection == null ? void 0 : connection.dataSchema);
+  const rawDataEntry = dataSources.usePlasmicDataOp(connection == null ? void 0 : connection.dataEntry);
+  if (!connection) {
+    return void 0;
+  }
+  return 0 /* NewEntry */ === connection.formType ? rawDataSchema : rawDataEntry;
+};
 const FormWrapper = React__default.default.forwardRef(
   (props, ref) => {
     const [remountKey, setRemountKey] = React__default.default.useState(0);
@@ -185,12 +235,24 @@ const FormWrapper = React__default.default.forwardRef(
       ref,
       () => wrapperRef.current ? __spreadValues({}, wrapperRef.current) : {}
     );
+    const rawData = useRawData(props.data);
+    const formItemDefinitions = useFormItemDefinitions(
+      rawData,
+      props,
+      wrapperRef.current
+    );
+    const _a = props, { formItems } = _a, rest = __objRest(_a, ["formItems"]);
+    const actualFormItems = props.mode === "simplified" && formItemDefinitions ? formItemDefinitions : formItems;
+    if (props.mode === "simplified" && rawData && "error" in rawData) {
+      return /* @__PURE__ */ React__default.default.createElement("div", null, "Error when fetching data: ", rawData.error.message);
+    }
     return /* @__PURE__ */ React__default.default.createElement(
       Internal,
       __spreadProps(__spreadValues({
         key: remountKey
-      }, props), {
+      }, rest), {
         setRemountKey,
+        formItems: actualFormItems,
         ref: wrapperRef
       })
     );
@@ -209,7 +271,7 @@ const COMMON_ACTIONS = [
         "children"
       );
     },
-    hidden: (props) => props.mode === "simplified"
+    hidden: (props) => props.mode !== "advanced"
   }
   // {
   //   type: "button-action" as const,
@@ -277,6 +339,60 @@ const formHelpers = {
   }
 };
 const formComponentName = "plasmic-antd5-form";
+const formTypeDescription = `
+  You can create form with two different behaviors:
+  
+
+
+  1. Create a new entry: The form will be created empty and it will create a new row when submitted.
+  2. Update an entry: The form will be pre-filled with the row values and it will update the table entry when submitted.
+  
+
+
+  For both options, you can customize later.
+`;
+const getConnectionDBPropRegistration = () => ({
+  formType: {
+    type: "choice",
+    options: [
+      { label: "New entry", value: 0 /* NewEntry */ },
+      { label: "Update entry", value: 1 /* UpdateEntry */ }
+    ],
+    displayName: "Form Type",
+    disableDynamicValue: true,
+    defaultValueHint: "Select the form type...",
+    description: `
+    You can create form with two different behaviors:
+    
+
+
+    1. Create a new entry: The form will be created empty and it will create a new row when submitted.
+    2. Update an entry: The form will be pre-filled with the row values and it will update the table entry when submitted.
+    
+
+
+    For both options, you can customize later.
+    `
+  },
+  dataSchema: {
+    type: "dataSourceOp",
+    description: "The data to generate the form",
+    hidden: (_ps, _ctx, { item }) => item.formType !== 0 /* NewEntry */,
+    displayName: "",
+    disableDynamicValue: true,
+    allowedOps: () => ["getTableSchema"],
+    hideCacheKey: true
+  },
+  dataEntry: {
+    type: "dataSourceOp",
+    description: "The data to generate the form",
+    hidden: (_ps, _ctx, { item }) => item.formType !== 1 /* UpdateEntry */,
+    displayName: "",
+    disableDynamicValue: true,
+    allowedOps: () => ["getOne"],
+    hideCacheKey: true
+  }
+});
 function registerForm(loader) {
   utils.registerComponentHelper(loader, FormWrapper, {
     name: formComponentName,
@@ -290,13 +406,22 @@ function registerForm(loader) {
         type: "controlMode",
         defaultValue: "simplified"
       },
+      data: {
+        type: "object",
+        fields: getConnectionDBPropRegistration(),
+        hidden: (ps) => ps.mode !== "simplified" || !ps.data,
+        nameFunc: () => "DB Connection"
+      },
       formItems: {
         displayName: "Fields",
         type: "array",
         itemType: {
           type: "object",
           fields: __spreadValues({
-            label: "string",
+            label: {
+              type: "string",
+              defaultValueHint: getDefaultValueHint("label")
+            },
             inputType: {
               type: "choice",
               options: Object.values(InputType).filter(
@@ -306,7 +431,8 @@ function registerForm(loader) {
                   "Radio" /* Radio */
                 ].includes(inputType)
               ),
-              defaultValue: "Text" /* Text */
+              defaultValue: "Text" /* Text */,
+              defaultValueHint: getDefaultValueHint("inputType")
             },
             options: {
               type: "array",
@@ -375,7 +501,10 @@ function registerForm(loader) {
               displayName: "Option Type"
             }
           }, commonFormItemProps),
-          nameFunc: (item) => item.label
+          nameFunc: (item) => {
+            var _a, _b;
+            return (_b = (_a = item.fieldId) != null ? _a : item.label) != null ? _b : item.name;
+          }
         },
         defaultValue: [
           {
@@ -389,7 +518,31 @@ function registerForm(loader) {
             inputType: "Text Area" /* TextArea */
           }
         ],
-        hidden: (props) => props.mode !== "simplified"
+        hidden: (ps) => {
+          if (ps.mode === "advanced") {
+            return true;
+          }
+          if (ps.mode === "simplified") {
+            return false;
+          }
+          return !ps.data || !ps.formType;
+        },
+        unstable__keyFunc: (x) => x.key,
+        unstable__minimalValue: (ps, contextData) => {
+          return ps.mode === "simplified" ? ps.formItems : contextData == null ? void 0 : contextData.minimalFullLengthFields;
+        },
+        unstable__canDelete: (item, ps, ctx) => {
+          if (ps.mode !== "database-schema-driven") {
+            return true;
+          }
+          if (!(ctx == null ? void 0 : ctx.schema)) {
+            return false;
+          }
+          if (item.fieldId && ctx.schema.fields.some((f) => f.id === item.fieldId)) {
+            return false;
+          }
+          return true;
+        }
       },
       submitSlot: __spreadValues({
         type: "slot",
@@ -412,7 +565,7 @@ function registerForm(loader) {
       }),
       children: {
         type: "slot",
-        hidden: (props) => props.mode === "simplified"
+        hidden: (props) => props.mode !== "advanced"
       },
       initialValues: {
         displayName: "Initial field values",
@@ -525,7 +678,13 @@ function registerForm(loader) {
         advanced: true
       }
     },
-    actions: COMMON_ACTIONS,
+    actions: [
+      ...COMMON_ACTIONS,
+      {
+        type: "form-schema",
+        hidden: (ps) => ps.mode !== "simplified" || !!ps.data
+      }
+    ],
     states: {
       value: {
         type: "readonly",
@@ -687,10 +846,13 @@ function FormItemWrapper(props) {
       initialValue: props.initialValue,
       name: props.name
     });
+    const fullPath = React__default.default.useContext(PathContext).fullPath;
     const internalFormCtx = React__default.default.useContext(InternalFormInstanceContext);
     const { fireOnValuesChange, forceRemount } = internalFormCtx != null ? internalFormCtx : {};
     (_b = props.setControlContextData) == null ? void 0 : _b.call(props, {
-      internalFormCtx
+      internalFormCtx,
+      formInstance: form,
+      parentFormItemPath: fullPath
     });
     React__default.default.useEffect(() => {
       if (prevPropValues.current.name !== props.name) {
@@ -720,15 +882,16 @@ function FormItemWrapper(props) {
   );
 }
 function deriveValuePropName(props) {
+  var _a;
   if (props.valuePropName) {
     return props.valuePropName;
   }
-  const valueProps = React__default.default.Children.map(props.children, (child) => {
-    var _a;
+  const valueProps = ((_a = React__default.default.Children.map(props.children, (child) => {
+    var _a2;
     if (React__default.default.isValidElement(child)) {
       const childType = child.type;
       if (childType) {
-        const x = (_a = childType.__plasmicFormFieldMeta) == null ? void 0 : _a.valueProp;
+        const x = (_a2 = childType.__plasmicFormFieldMeta) == null ? void 0 : _a2.valueProp;
         if (x) {
           return x;
         }
@@ -739,7 +902,7 @@ function deriveValuePropName(props) {
       }
     }
     return void 0;
-  }).filter((x) => !!x);
+  })) != null ? _a : []).filter((x) => !!x);
   if (valueProps.length > 0) {
     return valueProps[0];
   }
@@ -771,12 +934,29 @@ function FormItemForwarder(_a) {
     return i === 0 && React.isValidElement(child) ? React.cloneElement(child, newProps) : child;
   });
 }
+function getDefaultValueHint(field) {
+  return (_props, contextData, { item }) => {
+    if (!contextData || !("mergedFields" in contextData)) {
+      return void 0;
+    }
+    if (item == null ? void 0 : item.fieldId) {
+      const fieldSetting = contextData.mergedFields.find(
+        (f) => f.fieldId === item.fieldId
+      );
+      return fieldSetting == null ? void 0 : fieldSetting[field];
+    }
+    return void 0;
+  };
+}
 const commonFormItemProps = {
   name: {
-    type: "string"
+    type: "string",
+    required: true,
+    defaultValueHint: getDefaultValueHint("name")
   },
   initialValue: {
-    type: "string"
+    type: "string",
+    defaultValueHint: getDefaultValueHint("initialValue")
   },
   rules: {
     displayName: "Validation rules",
@@ -819,7 +999,8 @@ const commonFormItemProps = {
   },
   hidden: {
     type: "boolean",
-    advanced: true
+    advanced: true,
+    defaultValueHint: getDefaultValueHint("hidden")
   },
   validateTrigger: {
     type: "choice",
@@ -1190,6 +1371,7 @@ function registerFormList(loader) {
 exports.FormGroup = FormGroup;
 exports.FormItemWrapper = FormItemWrapper;
 exports.FormListWrapper = FormListWrapper;
+exports.FormType = FormType;
 exports.FormWrapper = FormWrapper;
 exports.InputType = InputType;
 exports.formComponentName = formComponentName;
@@ -1197,6 +1379,7 @@ exports.formGroupComponentName = formGroupComponentName;
 exports.formHelpers = formHelpers;
 exports.formItemComponentName = formItemComponentName;
 exports.formListComponentName = formListComponentName;
+exports.formTypeDescription = formTypeDescription;
 exports.registerForm = registerForm;
 exports.registerFormGroup = registerFormGroup;
 exports.registerFormItem = registerFormItem;