@simpleform/render 2.0.7 → 3.0.0

package/lib/store.d.ts

@@ -1,36 +1,26 @@
 /// <reference types="react" />
-import { CustomUnionType, FormNodeProps, GenerateParams, PropertiesData } from "./types";
+import { CustomUnionType, GenerateParams, WidgetItem, WidgetList } from "./types";
 export type FormRenderListener = (newValue?: any, oldValue?: any) => void;
 export declare class SimpleFormRender {
     plugins: any;
     components: any;
-    private properties;
-    private lastProperties;
-    private propertiesListeners;
+    private widgetList;
+    private lastWidgetList;
+    private widgetListListeners;
     constructor();
     addPlugin(data: any): void;
     registry(data: any): void;
     getFormComponent(target?: CustomUnionType): import("react").ComponentType<{}> | null | undefined;
     createFormElement(target?: CustomUnionType, commonProps?: GenerateParams): any;
-    getProperties(): PropertiesData;
-    setProperties(data?: PropertiesData): void;
-    updateItemByPath: (data?: any, path?: string, attributeName?: string) => void;
-    setItemByPath: (data?: any, path?: string, attributeName?: string) => void;
-    setItemByIndex: (data?: any, index?: number, parent?: {
-        path?: string;
-        attributeName?: string;
-    }) => void;
+    getWidgetList(): WidgetList;
+    setWidgetList(data?: WidgetList): void;
+    setItemByPath: (data?: any, path?: string) => void;
+    setItemByIndex: (data?: any, index?: number, parent?: string) => void;
     updateNameByPath: (endName?: string, path?: string) => void;
-    insertItemByIndex: (data: Partial<PropertiesData> | Array<FormNodeProps>, index?: number, parent?: {
-        path?: string;
-        attributeName?: string;
-    }) => void;
-    delItemByPath: (path?: string, attributeName?: string) => void;
-    getItemByPath: (path?: string, attributeName?: string) => any;
-    getItemByIndex: (index: number, parent: {
-        path?: string;
-        attributeName?: string;
-    }) => any;
+    insertItemByIndex: (data: WidgetItem | Array<WidgetItem>, index?: number, parent?: string) => void;
+    delItemByPath: (path?: string) => void;
+    getItemByPath: (path?: string) => any;
+    getItemByIndex: (index: number, parent?: string) => any;
     moveItemByPath: (from: {
         parent?: string;
         index: number;
@@ -38,7 +28,7 @@ export declare class SimpleFormRender {
         parent?: string;
         index?: number;
     }) => void;
-    subscribeProperties(listener: FormRenderListener): () => void;
-    unsubscribeProperties(): void;
-    private notifyProperties;
+    subscribeWidgetList(listener: FormRenderListener): () => void;
+    unsubscribeWidgetList(): void;
+    private notifyWidgetList;
 }

package/lib/types.d.ts

@@ -1,59 +1,49 @@
-import { ReactNode } from "react";
+import React, { ReactNode } from "react";
 import { FormItemProps, FormProps, FormRule, SimpleForm } from "@simpleform/form";
 import { SimpleFormRender } from "./store";
-export interface FormComponent {
+export interface CustomWidget {
     type?: string;
-    props?: any & {
-        children?: any | Array<FormComponent>;
+    props?: Record<string, any> & {
+        children?: any | Array<CustomWidget>;
     };
+    widgetList?: WidgetList;
 }
-export type UnionComponent<P> = React.ComponentType<P> | React.ForwardRefExoticComponent<P> | React.FC<P> | keyof React.ReactHTML;
-export type CustomUnionType = FormComponent | Array<FormComponent> | UnionComponent<any> | Function | ReactNode;
-export type PropertiesData = {
-    [name: string]: FormNodeProps;
-} | FormNodeProps[];
-export type GenerateFormNodeProps<T = {}> = FormComponent & FormItemProps & T & {
-    ignore?: boolean;
+export type UnionComponent<P> = React.ComponentType<P> | React.ForwardRefExoticComponent<P> | keyof React.ReactHTML;
+export type CustomUnionType = CustomWidget | Array<CustomWidget> | UnionComponent<any> | Function | ReactNode;
+export type WidgetList = Array<WidgetItem>;
+export type GenerateWidgetItem<T extends Record<string, any> = {}> = CustomWidget & FormItemProps & T & {
     inside?: CustomUnionType;
     outside?: CustomUnionType;
     readOnly?: boolean;
     readOnlyRender?: CustomUnionType;
     typeRender?: CustomUnionType;
-    properties?: PropertiesData;
     hidden?: boolean;
 };
 export type CustomRenderType = (params: GenerateParams<any> & {
     children?: any;
 }) => any;
-export type FormNodeProps = {
-    [key in keyof GenerateFormNodeProps]: key extends 'rules' ? (string | Array<{
+export type WidgetItem = {
+    [key in keyof GenerateWidgetItem]: key extends 'rules' ? (string | Array<{
         [key in keyof FormRule]: FormRule[key] | string;
-    }> | GenerateFormNodeProps[key]) : (key extends 'properties' ? GenerateFormNodeProps[key] : (string | GenerateFormNodeProps[key]));
+    }> | GenerateWidgetItem[key]) : (string | GenerateWidgetItem[key]);
 };
-export interface FormChildrenProps<T = {}> {
+export interface FormChildrenProps<T extends Record<string, any> = {}> {
     form?: SimpleForm;
     formrender?: SimpleFormRender;
-    options?: GenerateFormNodeProps<T> | ((params: GenerateFormNodeProps<T>) => GenerateFormNodeProps<T>);
-    evalPropNames?: Array<string>;
+    options?: GenerateWidgetItem<T> | ((params: GenerateWidgetItem<T>) => GenerateWidgetItem<T>);
     uneval?: boolean;
-    components?: any;
-    plugins?: any;
+    components?: Record<any, React.ReactNode>;
+    plugins?: Record<string, any>;
     inside?: CustomUnionType;
-    properties?: PropertiesData;
+    widgetList?: WidgetList;
     renderList?: CustomRenderType;
     renderItem?: CustomRenderType;
-    onPropertiesChange?: (newValue: PropertiesData, oldValue?: PropertiesData) => void;
+    onRenderChange?: (newValue: WidgetList, oldValue?: WidgetList) => void;
 }
-export type FormRenderProps<T = {}> = Omit<FormProps, 'form'> & FormChildrenProps<T>;
-export interface GenerateParams<T = {}> {
-    name?: string;
+export type FormRenderProps<T extends Record<string, any> = {}> = Omit<FormProps, 'form'> & FormChildrenProps<T>;
+export interface GenerateParams<T extends Record<string, any> = {}> {
     path?: string;
-    field?: GenerateFormNodeProps<T>;
-    parent?: {
-        name?: string;
-        path?: string;
-        field?: GenerateFormNodeProps<T>;
-    };
+    widgetItem?: GenerateWidgetItem<T>;
     formrender?: SimpleFormRender;
     form?: SimpleForm;
 }

package/lib/utils/object.d.ts

@@ -1,3 +1,2 @@
 export declare function deepClone<T = any>(value: T): T;
 export declare function isEqual(a: any, b: any): boolean;
-export declare const deepMergeObject: (obj1: any, obj2: any) => any;

package/lib/utils/utils.d.ts

@@ -1,29 +1,18 @@
-import { FormNodeProps, PropertiesData } from "../types";
+import { WidgetItem, WidgetList } from "../types";
 export declare const matchExpression: (value?: any) => string | undefined;
-export declare const getPathEnd: (path?: string) => string | undefined;
-export declare const getParent: (path?: string) => string | undefined;
-export declare const endIsListItem: (path?: string) => boolean | undefined;
-export declare const updateItemByPath: (properties: PropertiesData, data?: any, path?: string, attributeName?: string) => PropertiesData;
-export declare const setItemByPath: (properties: PropertiesData, data?: any, path?: string, attributeName?: string) => PropertiesData;
-export declare const getItemByPath: (properties?: PropertiesData, path?: string, attributeName?: string) => any;
-export declare const getKeyValueByIndex: (properties: PropertiesData, index?: number, parent?: {
-    path?: string | undefined;
-    attributeName?: string | undefined;
-} | undefined) => [string | number, any] | undefined;
+export declare const getPathEnd: (path?: string) => string | number | undefined;
+export declare const getParent: (path?: string) => string;
+export declare const getPathLen: (path?: string) => number;
+export declare const setItemByPath: (widgetList: WidgetList, data?: any, path?: string) => WidgetList;
+export declare const getItemByPath: (widgetList?: WidgetList, path?: string) => any;
+export declare const getKeyValueByIndex: (widgetList: WidgetList, index?: number, parent?: string) => [string | number, any] | undefined;
 export declare const toEntries: (data: any) => {
     isList: boolean;
     entries: [string, any][];
 };
-export declare const updateName: (properties: PropertiesData, newName?: string, pathStr?: string) => any[] | {
-    [k: string]: any;
-};
-export declare const insertItemByIndex: (properties: PropertiesData, data?: Partial<PropertiesData> | Array<FormNodeProps>, index?: number, parent?: {
-    path?: string | undefined;
-    attributeName?: string | undefined;
-} | undefined) => any[] | {
-    [k: string]: any;
-};
-export declare const moveSameLevel: (properties: PropertiesData, from: {
+export declare const updateName: (widgetList: WidgetList, newName?: string, path?: string) => WidgetList;
+export declare const insertItemByIndex: (widgetList: WidgetList, data?: WidgetItem | Array<WidgetItem>, index?: number, parent?: string) => WidgetList;
+export declare const moveSameLevel: (widgetList: WidgetList, from: {
     parent?: string;
     index: number;
 }, to: {
@@ -32,13 +21,11 @@ export declare const moveSameLevel: (properties: PropertiesData, from: {
 }) => any[] | {
     [k: string]: any;
 } | undefined;
-export declare const moveDiffLevel: (properties: PropertiesData, from: {
+export declare const moveDiffLevel: (widgetList: WidgetList, from: {
     parent?: string;
     index: number;
 }, to: {
     parent?: string;
     index?: number;
-}) => any[] | {
-    [k: string]: any;
-};
-export declare const getInitialValues: (properties?: PropertiesData) => {} | undefined;
+}) => WidgetList;
+export declare const getInitialValues: (widgetList?: WidgetList) => {} | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simpleform/render",
-  "version": "2.0.7",
+  "version": "3.0.0",
   "description": "dynamic rendering core of simple form",
   "author": "mezhanglei <496623925@qq.com>",
   "homepage": "https://github.com/mezhanglei/simpleform#readme",
@@ -43,7 +43,7 @@
     "react-router-dom": "^6.19.0"
   },
   "dependencies": {
-    "@simpleform/form": "^2.0.5",
+    "@simpleform/form": "^2.0.8",
     "classnames": "^2.3.2",
     "copy-anything": "^3.0.5",
     "react-fast-compare": "^3.2.2"