@cicctencent/low-code-simulate-base 0.0.0-stage → 1.1.10

package/README.md

@@ -1,3 +1 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+# 模拟器基础包

package/__tests__/plugin.spec.ts

@@ -0,0 +1,40 @@
+import { findComponentById } from '../src/plugin/onH5PageValidate';
+test('plugin/onH5PageValidate', () => {
+  const case1 = findComponentById([{ componentId: 1, title: '组件1' }], 1);
+  expect(case1).toEqual({ componentId: 1, title: '组件1' });
+  const case2 = findComponentById(
+    [
+      { componentId: 1, title: '组件1' },
+      {
+        componentId: 2,
+        title: '分组1',
+        children: [
+          {
+            componentId: 3,
+            title: '组件2',
+          },
+          {
+            componentId: 4,
+            title: '组件2',
+          },
+        ],
+      },
+      {
+        componentId: 5,
+        title: '分组2',
+        children: [
+          {
+            componentId: 6,
+            title: '组件3',
+          },
+          {
+            componentId: 7,
+            title: '组件4',
+          },
+        ],
+      },
+    ],
+    6
+  );
+  expect(case2).toEqual({ componentId: 6, title: '组件3' });
+});

package/__tests__/utils.transform.test.ts

@@ -0,0 +1,37 @@
+import { getObjectPath } from '../src/utils/transform';
+
+describe('getObjectPath', () => {
+
+  it('should handle basic objects', () => {
+    const obj = { a: 1, b: 2 };
+    const result = getObjectPath(obj);
+    expect(result).toEqual(['a', 'b']);
+  });
+
+  it('should handle nested objects', () => {
+    const obj = { a: { b: { c: 3 } } };
+    const result = getObjectPath(obj);
+    expect(result).toEqual(['a', 'a.b', 'a.b.c']);
+  });
+
+  it('should handle arrays', () => {
+    const obj = { a: [1, 2, 3] };
+    const result = getObjectPath(obj);
+    expect(result).toEqual(['a', 'a.0', 'a.1', 'a.2']);
+  });
+
+  it('should handle circular references', () => {
+    const obj = {} as any;
+    obj.self = obj;
+    const result = getObjectPath(obj);
+    expect(result).toEqual(['self']);
+  });
+
+  it('should handle non-object inputs', () => {
+    expect(getObjectPath(null)).toEqual([]);
+    expect(getObjectPath(123)).toEqual([]);
+    expect(getObjectPath('string')).toEqual([]);
+    expect(getObjectPath(undefined)).toEqual([]);
+  });
+
+});

package/api-extractor.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+  "projectFolder": "./",
+  "mainEntryPointFilePath": "<projectFolder>/dist/index.d.ts",
+  "apiReport": {
+    "enabled": false
+  },
+  "docModel": {
+    "enabled": true,
+    "apiJsonFilePath": "./docs/.api/<unscopedPackageName>.api.json"
+  },
+  "dtsRollup": {
+    "enabled": false
+  },
+  "tsdocMetadata": {},
+  "messages": {
+    "compilerMessageReporting": {
+      "default": {
+        "logLevel": "warning"
+      }
+    },
+    "extractorMessageReporting": {
+      "default": {
+        "logLevel": "warning"
+      },
+      "ae-internal-missing-underscore": {
+        "logLevel": "none"
+      }
+    },
+    "tsdocMessageReporting": {
+      "default": {
+        "logLevel": "warning"
+      }
+    }
+  }
+}

package/build/md.js

@@ -0,0 +1,25 @@
+const fs = require('fs');
+const path = require('path');
+
+/**
+ * 避免vitepress构建报错，转换部分字符
+ * @param {*} dir
+ */
+function traverseDir(dir) {
+  fs.readdirSync(dir).forEach(file => {
+    const pathname = path.join(dir, file);
+    const stat = fs.statSync(pathname);
+    if (stat.isDirectory()) {
+      traverseDir(pathname);
+    } else if (stat.isFile() && path.extname(pathname) === '.md') {
+      let content = fs.readFileSync(pathname, 'utf-8');
+      content = content
+        .replace('Entity<T>  EventEmitter', 'Entity\\<T\\>  EventEmitter')
+        .replace(/[\{\}\<\>]/g, $0 => `\\${$0}`);
+
+      fs.writeFileSync(pathname, content, 'utf-8');
+    }
+  });
+}
+
+traverseDir(path.resolve(__dirname, '../docs/api'));

package/dist/VCComponent.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @public
+ */
+export declare const VcComponent: any;
+export default VcComponent;

package/dist/VCComponent.js

@@ -0,0 +1,91 @@
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+import { h, getCurrentInstance, isVue3 } from 'vue-demi';
+import * as Vue from 'vue-demi';
+import { camelize } from '@cicctencent/ark-util';
+import { generateEventHandlers } from './event/generateEventHandler';
+function renderVue3(item) {
+    //@ts-ignore
+    var that = getCurrentInstance();
+    var name = item.name, componentId = item.componentId, _a = item.formData, style = _a.style, props = _a.props, _b = _a.event, event = _b === void 0 ? { list: [] } : _b;
+    var component;
+    if (isVue3) {
+        component = Vue.resolveComponent(name);
+    }
+    var _c = generateEventHandlers(
+    // this.$children[0],
+    that, event.list || []), on = _c.on, nativeOn = _c.nativeOn;
+    var eventObj = __assign(__assign({}, on), nativeOn);
+    var onEvent = {};
+    // 处理和过滤事件
+    Object.keys(eventObj).forEach(function (eventType) {
+        // 如果有生命周期的事件 不直接添加到组件上
+        if (['mounted'].includes(eventType))
+            return;
+        var eventKey = camelize("on-".concat(eventType));
+        onEvent[eventKey] = eventObj[eventType];
+    });
+    return h(component, __assign(__assign(__assign({ componentId: componentId }, props), { style: style, key: "".concat(name, "-").concat(componentId) }), onEvent), __assign({}, that.slots));
+}
+function renderVue2(item, c, thisArg) {
+    //@ts-ignore
+    var name = item.name, componentId = item.componentId, _a = item.formData, style = _a.style, props = _a.props, _b = _a.event, event = _b === void 0 ? { list: [] } : _b;
+    var _c = generateEventHandlers(
+    // this.$children[0],
+    thisArg, event.list || []), on = _c.on, nativeOn = _c.nativeOn;
+    // 获取所有的插槽（包括具名插槽和默认插槽）
+    var slots = __assign(__assign({}, thisArg.$slots), thisArg.$scopedSlots);
+    // 将插槽转换为函数对象
+    var scopedSlots = Object.keys(slots).reduce(function (acc, key) {
+        acc[key] = function (props) { return slots[key](props); };
+        return acc;
+    }, {});
+    return c(name, {
+        key: "".concat(name, "-").concat(componentId),
+        props: __assign({ componentId: componentId }, props),
+        style: style,
+        on: on,
+        nativeOn: nativeOn,
+        scopedSlots: scopedSlots
+    });
+}
+/**
+ * @public
+ */
+export var VcComponent = {
+    name: 'VCComponent',
+    props: {
+        componentDescriptor: Object,
+    },
+    computed: {
+        eventObj: function () {
+            var _a = this.componentDescriptor.formData.event, event = _a === void 0 ? { list: [] } : _a;
+            var _b = generateEventHandlers(this, event.list || []), on = _b.on, nativeOn = _b.nativeOn;
+            return __assign(__assign({}, on), nativeOn);
+        },
+    },
+    mounted: function () {
+        if (Object.keys(this.eventObj).includes('mounted')) {
+            this.eventObj['mounted']();
+        }
+    },
+    render: function (c) {
+        var that = this;
+        return isVue3
+            ? renderVue3(that.componentDescriptor)
+            : renderVue2(that.componentDescriptor, c, that);
+    },
+};
+VcComponent.install = function (app) {
+    app.component('VcComponent', VcComponent);
+};
+export default VcComponent;

package/dist/domain/BaseProjectDomain.d.ts

@@ -0,0 +1,389 @@
+import type { NavTreeData, SchemaData, Component, ComponentTreeData, ComponentItem, MenuData, Project, GroupTree, LowCodeKey, ProjectData, FunctionData, FunctionConfig, EditorConfig } from '@cicctencent/low-code-core';
+import { ComponentType } from '@cicctencent/low-code-core';
+import ComponentManager from './ComponentManager';
+/**
+ * @public
+ */
+export interface ProjectDomainState {
+    basePath?: string;
+    project: Project;
+    pageConfig: Record<string, any>;
+    componentConfigs: Component[];
+    groupConfig: GroupTree[];
+    functionConfig: FunctionConfig;
+}
+import ProjectDomain from '../domain/ProjectDomain';
+/**
+ * @public
+ */
+export default class BaseProjectDomain extends ProjectDomain {
+    /**
+     *  @public
+     *  获取配置
+     */
+    get config(): EditorConfig;
+    /**
+     * @public
+     */
+    staticPath: string;
+    /**
+     * @public
+     */
+    currentPageIndex: number;
+    /**
+     * @public
+     */
+    currentComponentPath: string;
+    /**
+     * @public
+     */
+    cManager: ComponentManager;
+    /**
+     *  @public
+     */
+    get basePath(): string;
+    /**
+    *  @public
+    */
+    constructor(state: ProjectDomainState);
+    /**
+     * @public
+     */
+    private Id2ComponentPathMap;
+    /**
+     * 根据id在pages中找到组件 生成componentPath
+     * @param id - 组件ID
+     * @returns 组件路径
+     * @example
+     * const pages = [{components:[{list:[{componentId:1}]}]}];
+     * const componentId = 1;
+     * generateComponentPath(componentId)
+     * // => 0.components.0.list.0
+     */
+    /**
+   * @public
+   */
+    generateComponentPath(id: number, pageIndex?: number): string;
+    /**
+     * @public
+     * 获取父组件数据
+     * @param childPath - 子组件路径
+     * @returns 父组件数据
+     */
+    getParent(childPath?: string): number | null;
+    /**
+     * @public
+     * 更新数据
+     * @param oldProject - 旧Project
+     * @returns true 新增记录  false 更新记录
+     */
+    needUpdateHistory(oldProject: any): boolean;
+    /**
+     * @public
+     * 根据组件路径获取组件位置、组件所在列表路径、组件父组件路径以及组件数据
+     * @param path - 组件路径
+     * @returns
+     * @example
+     */
+    getIndexByKey(path: string): {
+        index: number;
+        pageIndex: number;
+        componentListPath: string;
+        parentComponentPath: string;
+        component: ComponentItem;
+    };
+    /**
+     * @public
+     * 判断是否符合插入容器组件的条件
+     * @param child - 子容器组件配置
+     * @param container - 容器组件数据
+     * @returns
+     * @example
+     */
+    canInsertContainer(child: Component, container: ComponentItem): boolean;
+    /**
+     * @public
+     * @param name - 组件名
+     * @param data - 数据
+     */
+    action(name: string, data: any): void;
+    /**
+     * @public
+     */
+    get title(): string;
+    /**
+   * @public
+   */
+    get isNoLogin(): boolean;
+    /**
+     * @public
+     */
+    get pages(): ProjectData;
+    /**
+     * @public
+     */
+    get components(): ComponentItem[];
+    /**
+   * @public
+   * 含包含config的数据
+   */
+    get componentsWithConfig(): {
+        componentId: number;
+        formData: import("@cicctencent/low-code-core").ComponentFormData;
+        children?: ComponentItem[];
+        placeholderConfig?: import("@cicctencent/low-code-core").PlaceholderConfig;
+        slotName?: string;
+        insertConfig?: {
+            syncChildrenName?: string;
+            syncChildrenProp?: string;
+            allowList: string[];
+            allowErrorMessage: string;
+            aloneList: string[];
+            aloneErrorMessage: string;
+        };
+        guideConfig?: {
+            sampleUrl: string;
+            explain: string;
+            skill: string;
+        };
+        copyClearPaths?: string[];
+        customCopy?: boolean;
+        name: string;
+        group?: string;
+        icon?: string;
+        picture?: string;
+        type: ComponentType;
+        invalid?: boolean;
+        immobile?: boolean;
+        unlinkable?: boolean;
+        title: string;
+        key?: LowCodeKey;
+        isNoLogin?: boolean;
+        config?: {
+            props?: import("@cicctencent/low-code-core").Schema;
+            style?: import("@cicctencent/low-code-core").Schema;
+            event?: import("@cicctencent/low-code-core").Schema;
+        };
+        slot?: Record<string | number, Component>;
+        childContainer?: Component;
+    }[];
+    /**
+     *  @public
+     */
+    get pageMeta(): {
+        props?: Record<string, any>;
+        style?: Record<string, any>;
+        plugin?: Record<string, any>;
+        event?: Record<string, any>;
+    };
+    /**
+    *  @public
+    */
+    get currentComponent(): any;
+    /**
+    *  @public
+    *  获取导航树数据
+    */
+    get navTreeData(): NavTreeData[];
+    /**
+     * @public
+     * 获取当前配置表单数据
+     */
+    get schemaData(): SchemaData;
+    /**
+     * @public
+     * 获取组件树数据
+     */
+    get componentTreeData(): ComponentTreeData;
+    /**
+     * @public
+     * 获取右键菜单数据 没有考虑有容器组件的情况
+     */
+    get menuData(): MenuData;
+    /**
+     * @public
+     * 生成占位词对应的真实数据
+     * @param index - 校验时需要传入的组件位置
+     * @returns
+     */
+    getComponentSelectors(index?: number): {
+        label: string;
+        value: string;
+    }[];
+    /**
+     *  @public
+     * 当前组件之后的选择器选项（不包括当前组件）
+     * @param index - 下标
+     * @returns
+     */
+    getAfterComponentSelectors(index?: number): {
+        label: string;
+        value: string;
+    }[];
+    /**
+     * @public
+     * 占位词映射表
+     * @param index - 下标
+     * @returns
+     */
+    getFlagWordMap(index?: number): {
+        $componentSelectors: {
+            label: string;
+            value: string;
+        }[];
+        $afterComponentSelectors: {
+            label: string;
+            value: string;
+        }[];
+        $componentId: any;
+        $componentName: any;
+        $components: ComponentItem[];
+    };
+    /**
+     * @public
+     * 激活导航树
+     * @param key - 组件LowCodeKey
+     */
+    activate(key: LowCodeKey): void;
+    /**
+     * @public
+     * 生成编辑器删除操作二次确认弹出框所需的数据
+     * @param key - 组件LowCodeKey
+     * @returns
+     */
+    componentDeleteWithConfirm(key: LowCodeKey): void;
+    /**
+     * @public
+     * 组件列表元素处理
+     * @param start - 组件插入的位置
+     * @param deleteNum - 删除的组件个数
+     * @param item - 组件数据
+     * @param componentListPath - 组件所在列表的路径
+     * @returns
+     * @example
+     */
+    componentListSplice(start: number, deleteNum: number, item?: ComponentItem | Component, componentListPath?: string): any[];
+    /**
+     * @public
+     * 移动组件到某个位置
+     * @param originPath - 原路径
+     * @param newPath - 目标路径
+     * @example
+     * moveTo('0.components.0.list.0', '0.components.0.list.1')
+     **/
+    moveTo(originPath: any, newPath: any): void;
+    /**
+     * @public
+     * 删除组件
+     * @param key - 组件LowCodeKey
+     * @returns
+     */
+    componentDelete(key: LowCodeKey): void;
+    /**
+     * @public
+     * 复制组件
+     * @param key - 组件LowCodeKey
+     * @returns
+     */
+    componentCopy(key: LowCodeKey): void;
+    /**
+     * @public
+     * 拖动组件
+     * @param key - 组件LowCodeKey
+     * @param value - 数据
+     */
+    componentDrag(key: LowCodeKey, value: {
+        x: number;
+        y: number;
+        name: string;
+    }): void;
+    /**
+     * @public
+     * 点击时插入组件 直接插到模拟器最后
+     * @param key - 组件LowCodeKey
+     * @returns
+     */
+    componentInsert(key: LowCodeKey): void;
+    /**
+     * @public
+     * 组件上移
+     * @param key - 组件LowCodeKey
+     * @returns
+     */
+    componentMoveUp(key: LowCodeKey): void;
+    /**
+     * @public
+     * 组件下移
+     * @param key - 组件LowCodeKey
+     * @returns
+     */
+    componentMoveDown(key: LowCodeKey): void;
+    /**
+    * @public
+    * 打开图片上传
+    * @param key - 组件LowCodeKey
+    * @returns
+    */
+    componentImageOpen(key: LowCodeKey): void;
+    /**
+     * @public
+     * 修改表单更新项目数据
+     * @param path - 路径
+     * @param value - 值
+     */
+    setPathDataWithValidate(path: string, value: any): void;
+    /**
+     * @public
+     * 设置project数据 构造函数里和init时调用
+     * @param project - 项目数据
+     */
+    setProject(project: any): void;
+    /**
+     * @public
+     * 替换project数据 undo，redo
+     * @param project - project数据
+     */
+    replaceProject(project: any): void;
+    /**
+     * @public
+     * @param result - 模拟器校验二倍图的结果
+     * @param path - 图片地址的路径
+     * @returns
+     */
+    validateImage(result: boolean, path: string, imgUrl: string): {
+        text?: undefined;
+        icon?: undefined;
+        guide?: undefined;
+    } | {
+        text: any;
+        icon: string;
+        guide: any;
+    };
+    /**
+     * @public
+     * todo: 挪走
+     * 二倍图校验失败需要返回的弹窗配置
+     * @returns
+     */
+    validateImageFail(imgUrl: string): {
+        text?: undefined;
+        icon?: undefined;
+        guide?: undefined;
+    } | {
+        text: any;
+        icon: string;
+        guide: any;
+    };
+    /**
+     * @public
+     * 获取功能数据
+     */
+    get functionData(): FunctionData;
+    /**
+     *  @public
+     * @param componentId - 组件id
+     * @param newValue - 新的值
+     * @param oldValue - 旧的值
+     */
+    syncChildren(componentId: number, newValue?: any[], oldValue?: any[]): void;
+}