@easy-editor/react-renderer 0.0.18 → 1.0.1

package/dist/renderer-core/adapter/index.d.ts

@@ -1,17 +0,0 @@
-import type { ComponentType } from 'react';
-import type { BaseRenderComponent } from '../types';
-export interface RendererModules {
-    BaseRenderer?: BaseRenderComponent;
-    PageRenderer: BaseRenderComponent;
-    ComponentRenderer: BaseRenderComponent;
-}
-declare class Adapter {
-    renderers: RendererModules;
-    setRenderers(renderers: RendererModules): void;
-    setBaseRenderer(BaseRenderer: BaseRenderComponent): void;
-    setPageRenderer(PageRenderer: BaseRenderComponent): void;
-    setComponentRenderer(ComponentRenderer: BaseRenderComponent): void;
-    getRenderers(): Record<string, ComponentType<any>>;
-}
-export declare const adapter: Adapter;
-export {};

package/dist/renderer-core/component.d.ts

@@ -1,2 +0,0 @@
-import type { BaseRenderComponent } from './types';
-export declare function componentRendererFactory(): BaseRenderComponent;

package/dist/renderer-core/components/FaultComponent.d.ts

@@ -1,7 +0,0 @@
-import type { NodeSchema } from '@easy-editor/core';
-import type { FC } from 'react';
-export interface FaultComponentProps extends NodeSchema {
-    error?: Error | string;
-}
-declare const FaultComponent: FC<FaultComponentProps>;
-export default FaultComponent;

package/dist/renderer-core/components/NotFoundComponent.d.ts

@@ -1,7 +0,0 @@
-import type { NodeSchema } from '@easy-editor/core';
-import type { FC } from 'react';
-export interface NotFoundComponentProps extends NodeSchema {
-    enableStrictNotFoundMode?: boolean;
-}
-declare const NotFoundComponent: FC<NotFoundComponentProps>;
-export default NotFoundComponent;

package/dist/renderer-core/index.d.ts

@@ -1,9 +0,0 @@
-export * from './adapter';
-export * from './base';
-export * from './component';
-export * from './context';
-export * from './hoc';
-export * from './page';
-export * from './renderer';
-export * from './types';
-export * from './utils';

package/dist/renderer-core/page.d.ts

@@ -1,2 +0,0 @@
-import type { BaseRenderComponent } from './types';
-export declare function pageRendererFactory(): BaseRenderComponent;

package/dist/renderer-core/renderer.d.ts

@@ -1,2 +0,0 @@
-import type { RenderComponent } from './types';
-export declare function rendererFactory(): RenderComponent;

package/dist/renderer-core/types.d.ts

@@ -1,202 +0,0 @@
-import type { DesignMode, Node, NodeSchema, RootSchema, Simulator, SimulatorRenderer } from '@easy-editor/core';
-import type { Component } from 'react';
-import type { FaultComponentProps } from './components/FaultComponent';
-import type { NotFoundComponentProps } from './components/NotFoundComponent';
-export type Schema = NodeSchema | RootSchema;
-export interface RendererState {
-    engineRenderError?: boolean;
-    error?: Error;
-}
-export interface RendererProps {
-    /** 符合低代码搭建协议的数据 */
-    schema: RootSchema | NodeSchema;
-    /** 组件依赖的实例 */
-    components: Record<string, React.ComponentType<any>>;
-    /** CSS 类名 */
-    className?: string;
-    /** style */
-    style?: React.CSSProperties;
-    /** id */
-    id?: string | number;
-    /** 当前文档的 id */
-    documentId?: string;
-    /** 主要用于设置渲染模块的全局上下文，里面定义的内容可以在低代码中通过 this 来访问，比如 this.utils */
-    appHelper?: RendererAppHelper;
-    /**
-     * 配置规范参见《低代码搭建组件描述协议》https://lowcode-engine.cn/lowcode
-     * 主要在搭建场景中使用，用于提升用户搭建体验。
-     *
-     * > 在生产环境下不需要设置
-     */
-    componentsMap?: Record<string, any>;
-    /** 设计模式，可选值：live、design */
-    designMode?: DesignMode;
-    /** 渲染模块是否挂起，当设置为 true 时，渲染模块最外层容器的 shouldComponentUpdate 将始终返回false，在下钻编辑或者多引擎渲染的场景会用到该参数。 */
-    suspended?: boolean;
-    /** 组件获取 ref 时触发的钩子 */
-    onCompGetRef?: (schema: NodeSchema, ref: any) => void;
-    /** 组件 ctx 更新回调 */
-    onCompGetCtx?: (schema: NodeSchema, ref: any) => void;
-    /** 传入的 schema 是否有变更 */
-    getSchemaChangedSymbol?: () => boolean;
-    /** 设置 schema 是否有变更 */
-    setSchemaChangedSymbol?: (symbol: boolean) => void;
-    /** 自定义创建 element 的钩子 */
-    customCreateElement?: (Component: any, props: any, children: any) => any;
-    /** 渲染类型，标识当前模块是以什么类型进行渲染的 */
-    rendererName?: 'LowCodeRenderer' | 'PageRenderer' | string;
-    /** 当找不到组件时，显示的组件 */
-    notFoundComponent?: React.ComponentType<NotFoundComponentProps>;
-    /** 当组件渲染异常时，显示的组件 */
-    faultComponent?: React.ComponentType<FaultComponentProps>;
-    /** 设备信息 */
-    device?: 'default' | 'pc' | 'mobile' | string;
-    /**
-     * 当开启组件未找到严格模式时，渲染模块不会默认给一个容器组件
-     * @default false
-     */
-    enableStrictNotFoundMode?: boolean;
-    /** 获取节点的方法 */
-    getNode?: (id: string) => Node;
-    /** 渲染模块的 host */
-    __host?: Simulator;
-    /** 渲染模块的 container */
-    __container?: SimulatorRenderer;
-    /**
-     * 是否在设计模式下执行生命周期方法
-     * @default false
-     */
-    excuteLifeCycleInDesignMode?: boolean;
-}
-export interface RenderComponent {
-    displayName: string;
-    defaultProps: RendererProps;
-    new (props: RendererProps): RendererComponentInstance;
-}
-export interface RendererComponentInstance extends Component<RendererProps, RendererState> {
-    [x: string]: any;
-    __getRef: (ref: any) => void;
-    componentDidMount(): Promise<void> | void;
-    componentDidUpdate(): Promise<void> | void;
-    componentWillUnmount(): Promise<void> | void;
-    componentDidCatch(e: any): Promise<void> | void;
-    shouldComponentUpdate(nextProps: RendererProps): boolean;
-    isValidComponent(SetComponent: any): any;
-    createElement(SetComponent: any, props: any, children?: any): any;
-    getNotFoundComponent(): any;
-    getFaultComponent(): any;
-}
-/**
- * duck-typed History
- *
- * @see https://github.com/ReactTraining/history/tree/master/docs/api-reference.md
- */
-interface IHistoryLike {
-    readonly action: any;
-    readonly location: ILocationLike;
-    createHref: (to: any) => string;
-    push: (to: any, state?: any) => void;
-    replace: (to: any, state?: any) => void;
-    go: (delta: any) => void;
-    back: () => void;
-    forward: () => void;
-    listen: (listener: any) => () => void;
-    block: (blocker: any) => () => void;
-}
-/**
- * duck-typed History.Location
- *
- * @see https://github.com/remix-run/history/blob/dev/docs/api-reference.md#location
- */
-export interface ILocationLike {
-    pathname: any;
-    search: any;
-    state: any;
-    hash: any;
-    key?: any;
-}
-export interface RendererAppHelper {
-    /** 全局公共函数 */
-    utils?: Record<string, any>;
-    /** 全局常量 */
-    constants?: Record<string, any>;
-    /** react-router 的 location 实例 */
-    location?: ILocationLike;
-    /** react-router 的 history 实例 */
-    history?: IHistoryLike;
-    /** @experimental 内部使用 */
-    requestHandlersMap?: Record<string, any>;
-}
-export interface NodeInfo {
-    schema?: NodeSchema;
-    Comp: any;
-    componentInfo?: any;
-    componentChildren?: any;
-}
-export interface JSExpression {
-    type: string;
-    value: string;
-}
-export interface BaseRendererProps extends RendererProps {
-    __appHelper?: RendererAppHelper;
-    __components: Record<string, React.ComponentType>;
-    __ctx?: Record<string, any>;
-    __schema: RootSchema;
-    __designMode?: DesignMode;
-    __host?: Simulator;
-    __container?: SimulatorRenderer;
-    config?: Record<string, any>;
-    designMode?: DesignMode;
-    className?: string;
-    style?: React.CSSProperties;
-    id?: string | number;
-    getSchemaChangedSymbol?: () => boolean;
-    setSchemaChangedSymbol?: (symbol: boolean) => void;
-    documentId?: string;
-    getNode?: any;
-    /**
-     * 设备类型，默认值：'default'
-     */
-    device?: 'default' | 'pc' | 'mobile' | string;
-    componentName?: string;
-}
-export interface BaseRendererContext {
-    appHelper: RendererAppHelper;
-    components: Record<string, React.ComponentType>;
-    engine: RendererComponentInstance;
-    pageContext?: BaseRenderComponent;
-    compContext?: BaseRenderComponent;
-}
-export type BaseRendererInstance = Component<BaseRendererProps, Record<string, any>, any> & {
-    reloadDataSource(): Promise<any>;
-    __beforeInit(props: BaseRendererProps): void;
-    __init(props: BaseRendererProps): void;
-    __afterInit(props: BaseRendererProps): void;
-    __executeLifeCycleMethod(method: string, args?: any[]): void;
-    __getComponentView(): React.ComponentType | undefined;
-    __bindCustomMethods(props: BaseRendererProps): void;
-    __generateCtx(ctx: Record<string, any>): void;
-    __parseData(data: any, ctx?: any): any;
-    __initDataSource(props: BaseRendererProps): void;
-    __writeCss(props: BaseRendererProps): void;
-    __render(): void;
-    __getRef(ref: any): void;
-    __getSchemaChildrenVirtualDom(schema: NodeSchema | undefined, Comp: any, nodeChildrenMap?: any): any;
-    __getComponentProps(schema: NodeSchema | undefined, scope: any, Comp: any, componentInfo?: any): any;
-    __createDom(): any;
-    __createVirtualDom(schema: any, self: any, parentInfo: NodeInfo, idx: string | number): any;
-    __createLoopVirtualDom(schema: any, self: any, parentInfo: NodeInfo, idx: number | string): any;
-    __parseProps(props: any, self: any, path: string, info: NodeInfo): any;
-    __renderContextProvider(customProps?: object, children?: any): any;
-    __renderContextConsumer(children: any): any;
-    __renderContent(children: any): any;
-    __checkSchema(schema: NodeSchema | undefined, extraComponents?: string | string[]): any;
-    __renderComp(Comp: any, ctxProps: object): any;
-    $(id: string, instance?: any): any;
-    context: BaseRendererContext;
-    __designModeIsDesign?: boolean;
-};
-export interface BaseRenderComponent {
-    new (props: BaseRendererProps): BaseRendererInstance;
-}
-export {};

package/dist/renderer-core/utils/classnames.d.ts

@@ -1 +0,0 @@
-export declare const classnames: (...args: any[]) => string;

package/dist/renderer-core/utils/common.d.ts

@@ -1,59 +0,0 @@
-import { type NodeSchema } from '@easy-editor/core';
-import { type ComponentClass, type ComponentType } from 'react';
-export declare function inSameDomain(): boolean;
-/**
- * get css styled name from schema`s fileName
- * FileName -> lce-file-name
- * @returns string
- */
-export declare function getFileCssName(fileName: string): string | undefined;
-export declare const isSchema: (schema: any) => schema is NodeSchema;
-export declare const getValue: (obj: any, path: string, defaultValue?: {}) => any;
-export declare function transformArrayToMap(arr: any[], key: string, overwrite?: boolean): any;
-interface IParseOptions {
-    logScope?: string;
-}
-export declare const parseData: (schema: unknown, self: any, options?: IParseOptions) => any;
-export declare const isUseLoop: (loop: null | any[], isDesignMode: boolean) => boolean;
-export declare function checkPropTypes(value: any, name: string, rule: any, componentName: string): boolean;
-/**
- * transform string to a function
- * @param str function in string form
- * @returns funtion
- */
-export declare function transformStringToFunction(str: string): any;
-/**
- * 对象类型JSExpression，支持省略this
- * @param str expression in string form
- * @param self scope object
- * @returns funtion
- */
-declare function parseExpression(options: {
-    str: any;
-    self: any;
-    thisRequired?: boolean;
-    logScope?: string;
-}): any;
-declare function parseExpression(str: any, self: any, thisRequired?: boolean): any;
-export { parseExpression };
-export declare function parseThisRequiredExpression(str: any, self: any): any;
-/**
- * check str passed in is a string type of not
- * @param str obj to be checked
- * @returns boolean
- */
-export declare function isString(str: any): boolean;
-/**
- * capitalize first letter
- * @param word string to be proccessed
- * @returns string capitalized string
- */
-export declare function capitalizeFirstLetter(word: string): string;
-export declare const isReactClass: (obj: any) => obj is ComponentClass<any>;
-export declare function isReactComponent(obj: any): obj is ComponentType<any>;
-/**
- * process params for using in a url query
- * @param obj params to be processed
- * @returns string
- */
-export declare function serializeParams(obj: any): any;

package/dist/renderer-core/utils/data-helper.d.ts

@@ -1,83 +0,0 @@
-import { type DataSource } from '@easy-editor/core';
-import type { RendererAppHelper } from '../types';
-type DataSourceType = 'fetch';
-/**
- * do request for standard DataSourceType
- * @param {DataSourceType} type type of DataSourceItem
- * @param {any} options
- */
-export declare function doRequest(type: DataSourceType, options: any): Promise<unknown> | undefined;
-export declare class DataHelper {
-    /**
-     * host object that will be "this" object when excuting dataHandler
-     *
-     * @type {*}
-     * @memberof DataHelper
-     */
-    host: any;
-    /**
-     * data source config
-     *
-     * @type {DataSource}
-     * @memberof DataHelper
-     */
-    config: DataSource;
-    /**
-     * a parser function which will be called to process config data
-     * which eventually will call common/utils.processData() to process data
-     * (originalConfig) => parsedConfig
-     * @type {*}
-     * @memberof DataHelper
-     */
-    parser: any;
-    /**
-     * config.list
-     *
-     * @type {any[]}
-     * @memberof DataHelper
-     */
-    ajaxList: any[];
-    /**
-     * dataHandler
-     *
-     * @type {*}
-     * @memberof DataHelper
-     */
-    dataHandler: any;
-    ajaxMap: any;
-    dataSourceMap: any;
-    appHelper: RendererAppHelper;
-    constructor(comp: any, config: DataSource, appHelper: RendererAppHelper, parser: any);
-    updateConfig(config?: {}): any;
-    generateDataSourceMap(): any;
-    updateDataSourceMap(id: string, data: any, error: any): void;
-    /**
-     * get all dataSourceItems which marked as isInit === true
-     * @private
-     * @returns
-     * @memberof DataHelper
-     */
-    getInitDataSourseConfigs(): any;
-    /**
-     * process all dataSourceItems which marked as isInit === true, and get dataSource request results.
-     * @public
-     * @returns
-     * @memberof DataHelper
-     */
-    getInitData(): Promise<any>;
-    reloadDataSource(): Promise<void>;
-    getDataSource(id: string, params: any, otherOptions: any, callback: any): Promise<any> | undefined;
-    asyncDataHandler(asyncDataList: any[]): Promise<unknown>;
-    /**
-     * process data using dataHandler
-     *
-     * @param {(string | null)} id request id, will be used in error message, can be null
-     * @param {*} dataHandler
-     * @param {*} data
-     * @param {*} error
-     * @returns
-     * @memberof DataHelper
-     */
-    handleData(id: string | null, dataHandler: any, data: any, error: any): any;
-}
-export {};

package/dist/renderer-core/utils/index.d.ts

@@ -1,4 +0,0 @@
-export * from './classnames';
-export * from './common';
-export * from './hoc';
-export * from './logger';

package/dist/renderer-core/utils/logger.d.ts

@@ -1,5 +0,0 @@
-export declare const logger: {
-    log: (message?: any, ...optionalParams: any[]) => void;
-    error: (message?: any, ...optionalParams: any[]) => void;
-    warn: (message?: any, ...optionalParams: any[]) => void;
-};

package/dist/renderer-core/utils/request.d.ts

@@ -1,43 +0,0 @@
-/**
- * this is a private method, export for testing purposes only.
- *
- * @export
- * @param {*} dataAPI
- * @param {*} params
- * @returns
- */
-export declare function buildUrl(dataAPI: any, params: any): any;
-/**
- * do Get request
- *
- * @export
- * @param {*} dataAPI
- * @param {*} [params={}]
- * @param {*} [headers={}]
- * @param {*} [otherProps={}]
- * @returns
- */
-export declare function get(dataAPI: any, params?: {}, headers?: {}, otherProps?: {}): Promise<unknown>;
-/**
- * do Post request
- *
- * @export
- * @param {*} dataAPI
- * @param {*} [params={}]
- * @param {*} [headers={}]
- * @param {*} [otherProps={}]
- * @returns
- */
-export declare function post(dataAPI: any, params?: {}, headers?: any, otherProps?: {}): Promise<unknown>;
-/**
- * do request
- *
- * @export
- * @param {*} dataAPI
- * @param {string} [method='GET']
- * @param {*} data
- * @param {*} [headers={}]
- * @param {*} [otherProps={}]
- * @returns
- */
-export declare function request(dataAPI: any, method: string | undefined, data: any, headers?: {}, otherProps?: any): Promise<unknown>;