@plasmicpkgs/antd5 0.0.187 → 0.0.189

package/dist/form/Form.d.ts

@@ -0,0 +1,72 @@
+import type { DataOp, TableSchema } from "@plasmicapp/data-sources";
+import { CodeComponentMode, ComponentHelpers } from "@plasmicapp/host";
+import { CanvasComponentProps } from "@plasmicapp/host/registerComponent";
+import type { FormInstance, FormProps } from "antd/es/form";
+import React from "react";
+import { CommonFormControlContextData } from "./contexts";
+import { InternalFormItemProps } from "./FormItem";
+export declare enum InputType {
+    Text = "Text",
+    TextArea = "Text Area",
+    Password = "Password",
+    Number = "Number",
+    Select = "Select",
+    Option = "Option",
+    OptionGroup = "Option Group",
+    Radio = "Radio",
+    RadioGroup = "Radio Group",
+    Checkbox = "Checkbox",
+    DatePicker = "DatePicker",
+    Unknown = "Unkown"
+}
+export declare const SchemaFormContext: React.Context<{
+    schema?: TableSchema | undefined;
+    minimalFullLengthFields?: Partial<SimplifiedFormItemsProp>[] | undefined;
+    mergedFields?: SimplifiedFormItemsProp[] | undefined;
+} | undefined>;
+export interface SimplifiedFormItemsProp extends InternalFormItemProps {
+    inputType: InputType;
+    options?: {
+        label: string;
+        value: string;
+    }[];
+    optionType?: "default" | "button";
+    showTime?: boolean;
+    key?: string;
+}
+export interface FormWrapperControlContextData extends CommonFormControlContextData {
+    formInstance?: FormInstance<any>;
+    schema?: TableSchema;
+    minimalFullLengthFields?: Partial<SimplifiedFormItemsProp>[];
+    mergedFields?: SimplifiedFormItemsProp[];
+}
+export declare enum FormType {
+    NewEntry = 0,
+    UpdateEntry = 1
+}
+export interface FormWrapperProps extends FormProps, CanvasComponentProps<FormWrapperControlContextData> {
+    /**
+     * https://ant.design/components/form#setfieldsvalue-do-not-trigger-onfieldschange-or-onvalueschange
+     * Because setFieldsValue doesn't trigger onValuesChange, we need to create our own onChange function.
+     * This will allow us to trigger the onChange function and keep the value state updated in canvas.
+     * We also don't invoke onValuesChange to avoid changing the standard behavior, since users may have
+     * overridden this function in their codebase
+     **/
+    extendedOnValuesChange?: (values: Parameters<NonNullable<FormProps["onValuesChange"]>>[1]) => void;
+    formItems?: SimplifiedFormItemsProp[];
+    dataFormItems?: SimplifiedFormItemsProp[];
+    mode?: CodeComponentMode;
+    formType?: "new-entry" | "update-entry";
+    submitSlot?: React.ReactNode;
+    data?: DataOp;
+}
+export interface FormRefActions extends Pick<FormInstance<any>, "setFieldsValue" | "resetFields" | "setFieldValue" | "validateFields"> {
+    clearFields: () => void;
+    formInstance: FormInstance<any>;
+}
+export declare const FormWrapper: React.ForwardRefExoticComponent<FormWrapperProps & React.RefAttributes<FormRefActions>>;
+export declare const formHelpers: ComponentHelpers<FormWrapperProps>;
+export declare const OPTIMIZED_FORM_IMPORT: {
+    name: string;
+    path: string;
+};

package/dist/form/FormGroup.d.ts

@@ -0,0 +1,6 @@
+import React from "react";
+export interface FormGroupProps {
+    name: string;
+    children: React.ReactNode;
+}
+export declare function FormGroup(props: FormGroupProps): React.JSX.Element;

package/dist/form/FormItem.d.ts

@@ -0,0 +1,33 @@
+import { CanvasComponentProps } from "@plasmicapp/host/registerComponent";
+import { Form } from "antd";
+import type { FormItemProps } from "antd/es/form/FormItem";
+import React from "react";
+import { CommonFormControlContextData } from "./contexts";
+export interface FormItemControlContextData extends CommonFormControlContextData {
+    parentFormItemPath: (string | number)[];
+    status?: ReturnType<typeof Form.Item.useStatus>;
+}
+interface CuratedFieldData {
+    status: string | undefined;
+}
+export interface InternalFormItemProps extends Omit<FormItemProps, "rules" | "name">, CanvasComponentProps<FormItemControlContextData> {
+    rules?: PlasmicRule[];
+    description?: React.ReactNode;
+    noLabel?: boolean;
+    hideValidationMessage?: boolean;
+    customizeProps?: (fieldData: CuratedFieldData, props: InternalFormItemProps) => FormItemProps;
+    alignLabellessWithControls?: boolean;
+    name?: string;
+}
+interface PlasmicRule {
+    ruleType: "enum" | "len" | "max" | "min" | "regex" | "required" | "whitespace" | "advanced";
+    length?: number;
+    pattern?: string;
+    custom?: (...args: any[]) => any;
+    options?: {
+        value: any;
+    }[];
+    message?: string;
+}
+export declare function FormItemWrapper(props: InternalFormItemProps): React.JSX.Element;
+export {};

package/dist/form/FormList.d.ts

@@ -0,0 +1,5 @@
+import type { FormListOperation, FormListProps } from "antd/es/form/FormList";
+import React from "react";
+export declare const FormListWrapper: React.ForwardRefExoticComponent<Omit<FormListProps, "children"> & {
+    children: React.ReactNode;
+} & React.RefAttributes<FormListOperation>>;

package/dist/form/SchemaForm.d.ts

@@ -0,0 +1,9 @@
+import { TableSchema } from "@plasmicapp/data-sources";
+import React from "react";
+import { FormRefActions, FormWrapperProps, SimplifiedFormItemsProp } from "./Form";
+export declare function deriveFormFieldConfigs(dataFormItems: SimplifiedFormItemsProp[], schema: TableSchema, data: any): {
+    mergedFields: SimplifiedFormItemsProp[];
+    minimalFullLengthFields: Partial<SimplifiedFormItemsProp>[];
+};
+export declare const SchemaForm: React.ForwardRefExoticComponent<FormWrapperProps & React.RefAttributes<FormRefActions>>;
+export { SchemaForm as FormWrapper };

package/dist/form/contexts.d.ts

@@ -0,0 +1,40 @@
+import { Form, type FormInstance, type FormItemProps } from "antd";
+import React from "react";
+export declare const PathContext: React.Context<{
+    relativePath: (string | number)[];
+    fullPath: (string | number)[];
+}>;
+export declare const useFormItemRelativeName: (name: FormItemProps["name"]) => any[] | undefined;
+export declare const useFormItemFullName: (name: FormItemProps["name"]) => any[] | undefined;
+export declare function useFormInstanceMaybe(): FormInstance<any> | undefined;
+export interface FieldEntity {
+    fullPath: (string | number)[];
+    name: string | number | undefined;
+    preserve: boolean;
+}
+/**
+ * - registeredFields: current mounted form fields
+ * - preservedRegisteredFields: all fields that were registered and were marked as NOT preserve
+ */
+export interface InternalFieldCtx {
+    registeredFields: FieldEntity[];
+    preservedRegisteredFields: FieldEntity[];
+}
+export interface CommonFormControlContextData {
+    formInstance?: FormInstance<any>;
+    layout?: FormLayoutContextValue;
+    internalFieldCtx?: InternalFieldCtx;
+}
+export interface InternalFormInstanceContext extends CommonFormControlContextData {
+    fireOnValuesChange: () => void;
+    forceRemount: () => void;
+    registerField: (fieldEntity: FieldEntity) => () => void;
+    internalFieldCtx: InternalFieldCtx;
+    initialValues: Record<string, any>;
+}
+export declare const InternalFormInstanceContext: React.Context<InternalFormInstanceContext | undefined>;
+export interface FormLayoutContextValue {
+    layout: React.ComponentProps<typeof Form>["layout"];
+    labelSpan?: number;
+}
+export declare const FormLayoutContext: React.Context<FormLayoutContextValue | undefined>;

package/dist/form/registerForm.d.ts

@@ -0,0 +1,9 @@
+import { Registerable } from "../utils";
+import { formHelpers } from "./Form";
+import { FormWrapper } from "./SchemaForm";
+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;
+export { FormGroup } from "./FormGroup";
+export { FormItemWrapper } from "./FormItem";
+export { FormListWrapper } from "./FormList";
+export { formHelpers, FormWrapper };

package/dist/form/registerFormGroup.d.ts

@@ -0,0 +1,2 @@
+import { Registerable } from "../utils";
+export declare function registerFormGroup(loader?: Registerable): void;

package/dist/form/registerFormItem.d.ts

@@ -0,0 +1,2 @@
+import { Registerable } from "../utils";
+export declare function registerFormItem(loader?: Registerable): void;

package/dist/form/registerFormList.d.ts

@@ -0,0 +1,2 @@
+import { Registerable } from "../utils";
+export declare function registerFormList(loader?: Registerable): void;

package/dist/form/sharedRegistration.d.ts

@@ -0,0 +1,14 @@
+import { ActionProps, PropType } from "@plasmicapp/host";
+import { ArrayType } from "@plasmicapp/host/registerComponent";
+import { FormWrapperControlContextData, FormWrapperProps, SimplifiedFormItemsProp } from "./Form";
+import { FormItemControlContextData, InternalFormItemProps } from "./FormItem";
+export declare const COMMON_ACTIONS: {
+    type: "button-action";
+    label: string;
+    onClick: ({ studioOps }: ActionProps<any>) => void;
+    hidden: (props: any) => boolean;
+}[];
+export declare function getDefaultValueHint(field: keyof SimplifiedFormItemsProp): (_props: any, contextData: FormWrapperControlContextData | FormItemControlContextData | null, { item }: any) => any;
+export declare function commonFormItemProps(usage: "simplified-form-item"): Record<string, PropType<InternalFormItemProps>>;
+export declare function commonFormItemProps(usage: "advanced-form-item"): Record<string, PropType<FormWrapperProps>>;
+export declare const commonSimplifiedFormArrayItemType: (propName: "formItems" | "dataFormItems") => ArrayType<FormWrapperProps>["itemType"];

package/dist/index.d.ts

@@ -1,9 +1,11 @@
-import { InputType } from "./registerForm";
+import { InputType } from "./form/Form";
 import { Registerable } from "./utils";
 export declare function registerAll(loader?: Registerable): void;
-export { buttonComponentName } from "./registerButton";
-export { deriveFormFieldConfigs, formComponentName, formGroupComponentName, formItemComponentName, formListComponentName, FormType, formTypeDescription, InputType, registerForm, registerFormGroup, registerFormItem, useFormInstanceMaybe, } from "./registerForm";
-export type { SimplifiedFormItemsProp } from "./registerForm";
+export { FormType, InputType, OPTIMIZED_FORM_IMPORT } from "./form/Form";
+export type { SimplifiedFormItemsProp } from "./form/Form";
+export { formTypeDescription, registerForm } from "./form/registerForm";
+export { deriveFormFieldConfigs } from "./form/SchemaForm";
+export * from "./names";
 export declare const componentNameToInputType: {
     "plasmic-antd5-input": InputType;
     "plasmic-antd5-textarea": InputType;