@easy-editor/react-renderer 0.0.17 → 0.0.18

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

@@ -1,4 +1,4 @@
-import type { DesignMode, JSONObject, Node, NodeSchema, RootSchema, Simulator, SimulatorRenderer } from '@easy-editor/core';
+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';
@@ -86,11 +86,44 @@ export interface RendererComponentInstance extends Component<RendererProps, Rend
     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>;
 }
@@ -104,25 +137,6 @@ export interface JSExpression {
     type: string;
     value: string;
 }
-export interface DataSourceItem {
-    id: string;
-    isInit?: boolean | JSExpression;
-    type?: string;
-    options?: {
-        uri: string | JSExpression;
-        params?: JSONObject | JSExpression;
-        method?: string | JSExpression;
-        shouldFetch?: string;
-        willFetch?: string;
-        fit?: string;
-        didFetch?: string;
-    };
-    dataHandler?: JSExpression;
-}
-export interface DataSource {
-    list?: DataSourceItem[];
-    dataHandler?: JSExpression;
-}
 export interface BaseRendererProps extends RendererProps {
     __appHelper?: RendererAppHelper;
     __components: Record<string, React.ComponentType>;
@@ -185,3 +199,4 @@ export type BaseRendererInstance = Component<BaseRendererProps, Record<string, a
 export interface BaseRenderComponent {
     new (props: BaseRendererProps): BaseRendererInstance;
 }
+export {};

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

@@ -51,3 +51,9 @@ export declare function isString(str: any): boolean;
 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

@@ -0,0 +1,83 @@
+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/request.d.ts

@@ -0,0 +1,43 @@
+/**
+ * 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>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easy-editor/react-renderer",
-  "version": "0.0.17",
+  "version": "0.0.18",
   "description": "React Renderer package for EasyEditor.",
   "type": "module",
   "main": "dist/index.js",
@@ -40,23 +40,23 @@
     "url": "https://github.com/Easy-Editor/EasyEditor/issues"
   },
   "peerDependencies": {
-    "@easy-editor/core": "^0.0.15",
     "mobx-react": "^9.2.0",
     "react": "^18 || ^19",
     "react-dom": "^18 || ^19",
     "@types/react": "^18 || ^19",
-    "@types/react-dom": "^18 || ^19"
+    "@types/react-dom": "^18 || ^19",
+    "@easy-editor/core": "^0.0.16"
   },
   "dependencies": {
     "lodash-es": "^4.17.21",
     "prop-types": "^15.8.1",
-    "react-is": "^18.3.1"
+    "react-is": "^18.3.1",
+    "@easy-editor/datasource-engine": "^0.0.1"
   },
   "devDependencies": {
     "@types/lodash-es": "^4.17.12",
     "@types/prop-types": "^15.7.14",
-    "@types/react-is": "^18.3.0",
-    "@easy-editor/core": "0.0.15"
+    "@types/react-is": "^18.3.0"
   },
   "scripts": {
     "dev": "deno run --watch ./src/index.ts",