@chamn/engine 0.0.1 → 0.0.3

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## [0.0.2](https://github.com/ByteCrazy/chameleon/compare/v0.0.1...v0.0.2) (2023-03-27)
+
+### 🐛 Bug Fixes | Bug 修复
+
+* **engine:** 🐛 fix engine not incluce dist folder ([fc2c39e](https://github.com/ByteCrazy/chameleon/commit/fc2c39e88aa2eeb82ba5e3989e5bdf244d112dfb))

package/build.config.js

@@ -23,6 +23,7 @@ const mainConfig = {
   libMode: process.env.BUILD_TYPE !== 'APP',
   entry: './src/Engine.tsx',
   libName: 'CEngine',
+  fileName: 'index',
   external: ['react', 'react-dom'],
   global: {
     react: 'React',

package/dist/Engine.d.ts

@@ -0,0 +1,40 @@
+import React from 'react';
+import { Workbench } from './component/Workbench';
+import { CPlugin, PluginManager } from './core/pluginManager';
+import { Emitter } from 'mitt';
+import { AssetPackage, CMaterialType, CNode, CPage, CPageDataType, CRootNode } from '@chamn/model';
+export type EnginContext = {
+    pluginManager: PluginManager;
+    engine: Engine;
+};
+export type EngineProps = {
+    plugins: CPlugin[];
+    schema: CPageDataType;
+    material?: CMaterialType[];
+    assets?: AssetPackage[];
+    assetPackagesList?: AssetPackage[];
+    beforePluginRun?: (options: {
+        pluginManager: PluginManager;
+    }) => void;
+    onReady?: (ctx: EnginContext) => void;
+};
+declare class Engine extends React.Component<EngineProps> {
+    currentSelectNode: CNode | CRootNode | null;
+    pluginManager: PluginManager;
+    workbenchRef: React.RefObject<Workbench>;
+    pageSchema: CPageDataType | undefined;
+    pageModel: CPage;
+    material: CMaterialType[] | undefined;
+    emitter: Emitter<any>;
+    constructor(props: EngineProps);
+    updateCurrentSelectNode(node: CNode | CRootNode): void;
+    componentDidMount(): Promise<void>;
+    getActiveNode(): CNode | CRootNode | null;
+    updatePage: (page: CPageDataType) => void;
+    updateDesignerAssets: (assets: AssetPackage[]) => void;
+    updateMaterial: (material: CMaterialType[]) => void;
+    refresh: () => void;
+    getWorkbench: () => Workbench | null;
+    render(): JSX.Element;
+}
+export default Engine;

package/dist/component/Workbench/index.d.ts

@@ -0,0 +1,57 @@
+import React from 'react';
+import { ResizeCallback } from 're-resizable';
+import { Emitter } from 'mitt';
+export interface PluginContext {
+    openPanel: () => void;
+    closePanel: () => void;
+    getPlugin: (pluginName: string) => any;
+    emitter: Emitter<any>;
+}
+type PanelItem = {
+    name: string;
+    title: string | React.ReactNode;
+    icon: React.ReactNode;
+    render: React.ReactNode;
+};
+type WorkbenchStateType = {
+    leftBoxVisible: boolean;
+    leftBoxSize: {
+        width: number;
+        height: number | string;
+    };
+    leftBoxFixed: boolean;
+    rightBoxSize: {
+        width: number;
+        height: number | string;
+    };
+    rightBoxVisible: boolean;
+    currentActiveLeftPanel: string;
+    leftPanels: PanelItem[];
+    bodyView: React.ReactNode | null;
+    rightView: React.ReactNode | null;
+    topToolBarView: React.ReactNode | null;
+};
+export type WorkbenchPropsType = {
+    emitter: Emitter<any>;
+};
+export declare class Workbench extends React.Component<WorkbenchPropsType, WorkbenchStateType> {
+    emitter: Emitter<any>;
+    leftPanelContentRef: React.RefObject<HTMLDivElement>;
+    constructor(props: WorkbenchPropsType);
+    addLeftPanel: (panel: PanelItem) => void;
+    openLeftPanel: (currentActiveLeftPanel?: string) => Promise<void>;
+    closeLeftPanel: () => Promise<void>;
+    toggleLeftPanel: () => void;
+    onPluginIconClick: (panel: PanelItem) => void;
+    openRightPanel: () => void;
+    closeRightPanel: () => void;
+    replaceBodyView: (newView: React.ReactNode) => void;
+    replaceRightView: (newView: React.ReactNode) => void;
+    replaceTopBarView: (newView: React.ReactNode) => void;
+    toggleRightPanel: () => void;
+    onLeftBoxResizeStop: ResizeCallback;
+    onGlobalClick: (e: MouseEvent) => void;
+    componentDidMount(): void;
+    render(): JSX.Element;
+}
+export {};

package/dist/core/pluginManager.d.ts

@@ -0,0 +1,56 @@
+import Engine from '../Engine';
+import { AssetPackage, CPage } from '@chamn/model';
+import { Emitter } from 'mitt';
+import { Workbench } from '../component/Workbench';
+import { CustomI18n } from '../i18n';
+export type PluginObj = {
+    name: string;
+    init: (ctx: CPluginCtx) => Promise<void>;
+    destroy: (ctx: CPluginCtx) => Promise<void>;
+    exports: (ctx: CPluginCtx) => any;
+    meta: {
+        engine: {
+            version: string;
+        };
+    };
+};
+export type CPlugin = PluginObj | ((ctx: CPluginCtx) => PluginObj);
+type PluginManagerOptions = {
+    getWorkbench: () => Workbench;
+    emitter: Emitter<any>;
+    pageModel: CPage;
+    i18n: CustomI18n;
+    assets: AssetPackage[];
+    engine: Engine;
+};
+export type CPluginCtx<C = any> = {
+    globalEmitter: Emitter<any>;
+    config: C;
+    pluginManager: PluginManager;
+    pluginReadyOk: () => void;
+} & PluginManagerOptions;
+export type PluginInstance = {
+    ctx: CPluginCtx;
+    exports: any;
+    source: PluginObj;
+    ready: boolean;
+};
+export type CustomPluginHook = (pluginInstance: PluginInstance) => PluginInstance;
+export declare class PluginManager {
+    plugins: Map<string, PluginInstance>;
+    emitter: Emitter<any>;
+    getWorkbench: () => Workbench;
+    pageModel: CPage;
+    i18n: CustomI18n;
+    assets: AssetPackage[];
+    engine: Engine;
+    customPluginHooks: Record<string, CustomPluginHook[]>;
+    constructor({ getWorkbench, emitter, pageModel, i18n, assets, engine }: PluginManagerOptions);
+    customPlugin: (pluginName: string, customPluginHook: CustomPluginHook) => void;
+    createPluginCtx: () => CPluginCtx<any>;
+    add(plugin: CPlugin): Promise<void>;
+    get(pluginName: string): Promise<PluginInstance | undefined>;
+    remove(name: string): Promise<void>;
+    onPluginReadyOk(pluginName: string, cb?: (pluginHandle: PluginInstance) => void): Promise<PluginInstance> | undefined;
+}
+export {};

package/dist/i18n/en_US/index.d.ts

@@ -0,0 +1,5 @@
+export declare const en_US: {
+    translation: {
+        'Welcome to React': string;
+    };
+};

package/dist/i18n/index.d.ts

@@ -0,0 +1,6 @@
+import i18n from 'i18next';
+export type CustomI18n = typeof i18n & {
+    update: () => void;
+};
+declare const customI18n: CustomI18n;
+export default customI18n;

package/dist/i18n/zh_CN/index.d.ts

@@ -0,0 +1,5 @@
+export declare const zh_CN: {
+    translation: {
+        'Welcome to React': string;
+    };
+};