@zhubangyun/lowcode-core 1.1.3 → 1.1.5

package/lib/utils/designer/assets/assets.typing.d.ts

@@ -0,0 +1,298 @@
+import { IPublicTypeProjectSchema } from "@alilc/lowcode-types/lib/shell/type/project-schema";
+import { IPublicTypeFieldConfig, IPublicTypeNpmInfo } from "@alilc/lowcode-types";
+/**
+ * 资产包协议
+ */
+export interface Assets {
+    /**
+     * 资产包协议版本号
+     */
+    version?: string;
+    /**
+     * 资源列表
+     */
+    packages: Array<Package>;
+    /**
+     * 所有组件的描述协议集合
+     */
+    components: Array<ComponentDescription | RemoteComponentDescription>;
+    /**
+     * 低代码编辑器插件集合
+     */
+    plugins?: Array<PluginDescription>;
+    /**
+     * 低代码设置器集合
+     */
+    setters?: Array<SetterDescription>;
+    /**
+     * 平台扩展配置
+     */
+    extConfig?: AssetsExtConfig;
+    /**
+     * 用于描述组件面板中的 tab 和 category
+     */
+    sort?: ComponentSort;
+}
+export interface AssetsExtConfig {
+    [index: string]: any;
+}
+/**
+ * 描述组件面板中的 tab 和 category 排布
+ */
+export interface ComponentSort {
+    /**
+     * 用于描述组件面板的 tab 项及其排序，例如：["精选组件", "原子组件"]
+     */
+    groupList?: String[];
+    /**
+     * 组件面板中同一个 tab 下的不同区间用 category 区分，category 的排序依照 categoryList 顺序排列；
+     */
+    categoryList?: String[];
+}
+/**
+ * 定义资产包依赖信息
+ */
+export interface Package {
+    /**
+     * 唯一标识
+     */
+    id?: string;
+    /**
+     * 包名
+     */
+    package: string;
+    /**
+     * 包版本号
+     */
+    version: string;
+    /**
+     * 资源类型
+     */
+    type?: string;
+    /**
+     * 组件渲染态视图打包后的 CDN url 列表，包含 js 和 css
+     */
+    urls?: string[] | any;
+    /**
+     * 组件多个渲染态视图打包后的 CDN url 列表，包含 js 和 css，优先级高于 urls
+     */
+    advancedUrls?: ComplexUrls;
+    /**
+     * 组件编辑态视图打包后的 CDN url 列表，包含 js 和 css
+     */
+    editUrls?: string[] | any;
+    /**
+     * 组件多个编辑态视图打包后的 CDN url 列表，包含 js 和 css，优先级高于 editUrls
+     */
+    advancedEditUrls?: ComplexUrls;
+    /**
+     * 低代码组件的 schema 内容
+     */
+    schema?: IPublicTypeProjectSchema;
+    /**
+     * 当前资源所依赖的其他资源包的 id 列表
+     */
+    deps?: string[];
+    /**
+     * 指定当前资源加载的环境
+     */
+    loadEnv?: LoadEnv[];
+    /**
+     * 当前资源是否是 external 资源
+     */
+    external?: boolean;
+    /**
+     * 作为全局变量引用时的名称，和 webpack output.library 字段含义一样，用来定义全局变量名
+     */
+    library: string;
+    /**
+     * 组件描述导出名字，可以通过 window[exportName] 获取到组件描述的 Object 内容；
+     */
+    exportName?: string;
+    /**
+     * 标识当前 package 资源加载在 window.library 上的是否是一个异步对象
+     */
+    async?: boolean;
+    /**
+     * 标识当前 package 从其他 package 的导出方式
+     */
+    exportMode?: string;
+    /**
+     * 标识当前 package 内容是从哪个 package 导出来的
+     */
+    exportSourceId?: string;
+    /**
+     * 标识当前 package 是从 window 上的哪个属性导出来的
+     */
+    exportSourceLibrary?: string;
+}
+/**
+ * 复杂 urls 结构，同时兼容简单结构和多模态结构
+ */
+export declare type ComplexUrls = string[] | MultiModeUrls;
+/**
+ * 多模态资源
+ */
+export interface MultiModeUrls {
+    /**
+     * 默认的资源 url
+     */
+    default: string[];
+    /**
+     * 其他模态资源的 url
+     */
+    [index: string]: string[];
+}
+/**
+ * 资源加载环境种类
+ */
+export declare enum LoadEnv {
+    /**
+     * 设计态
+     */
+    design = "design",
+    /**
+     * 运行态
+     */
+    runtime = "runtime"
+}
+/**
+ * 低代码设置器描述
+ */
+export declare type SetterDescription = PluginDescription;
+/**
+ * 低代码插件器描述
+ */
+export interface PluginDescription {
+    /**
+     * 插件名称
+     */
+    name: string;
+    /**
+     * 插件标题
+     */
+    title: string;
+    /**
+     * 插件类型
+     */
+    type?: string;
+    /**
+     * 插件描述
+     */
+    description?: string;
+    /**
+     * 插件文档地址
+     */
+    docUrl: string;
+    /**
+     * 插件截图
+     */
+    screenshot: string;
+    /**
+     * 插件相关的标签
+     */
+    tags?: string[];
+    /**
+     * 插件关键字
+     */
+    keywords?: string[];
+    /**
+     * 插件引用的资源信息
+     */
+    reference: Reference;
+}
+/**
+ * 资源引用信息，Npm 的升级版本，
+ */
+export interface Reference {
+    /**
+     * 引用资源的 id 标识
+     */
+    id?: string;
+    /**
+     * 引用资源的包名
+     */
+    package?: string;
+    /**
+     * 引用资源的导出对象中的属性值名称
+     */
+    exportName: string;
+    /**
+     * 引用 exportName 上的子对象
+     */
+    subName: string;
+    /**
+     * 引用的资源主入口
+     */
+    main?: string;
+    /**
+     * 是否从引用资源的导出对象中获取属性值
+     */
+    destructuring: boolean;
+    /**
+     * 资源版本号
+     */
+    version: string;
+}
+/**
+ * 低代码片段
+ *
+ * 内容为组件不同状态下的低代码 schema (可以有多个)，用户从组件面板拖入组件到设计器时会向页面 schema 中插入 snippets 中定义的组件低代码 schema
+ */
+export interface Snippet {
+    title: string;
+    screenshot?: string;
+    schema: any;
+}
+/**
+ * 组件低代码描述
+ */
+export interface ComponentDescription {
+    componentName: string;
+    title: string;
+    description?: string;
+    docUrl: string;
+    screenshot: string;
+    icon?: string;
+    tags?: string[];
+    keywords?: string[];
+    devMode?: 'proCode' | 'lowCode';
+    npm: IPublicTypeNpmInfo;
+    configure: IPublicTypeFieldConfig;
+    snippets: Snippet[];
+    group: string;
+    category: string;
+    priority: number;
+    /**
+     * 组件引用的资源信息
+     */
+    reference: Reference;
+}
+/**
+ * 远程物料描述
+ */
+export interface RemoteComponentDescription {
+    /**
+     * 组件描述导出名字，可以通过 window[exportName] 获取到组件描述的 Object 内容；
+     */
+    exportName?: string;
+    /**
+     * 组件描述的资源链接；
+     */
+    url?: string;
+    /**
+     * 组件多模态描述的资源信息，优先级高于 url
+     */
+    advancedUrls?: ComplexUrl;
+    /**
+     * 组件(库)的 npm 信息；
+     */
+    package?: {
+        npm?: string;
+    };
+}
+export declare type ComplexUrl = string | MultiModeUrl;
+export interface MultiModeUrl {
+    default: string;
+    [index: string]: string;
+}

package/lib/utils/designer/assets/assets.typing.js

@@ -0,0 +1,47 @@
+"use strict";
+
+exports.__esModule = true;
+exports.LoadEnv = void 0;
+/**
+ * 资产包协议
+ */
+/**
+ * 描述组件面板中的 tab 和 category 排布
+ */
+/**
+ * 定义资产包依赖信息
+ */
+/**
+ * 复杂 urls 结构，同时兼容简单结构和多模态结构
+ */
+/**
+ * 多模态资源
+ */
+/**
+ * 资源加载环境种类
+ */
+var LoadEnv = exports.LoadEnv = /*#__PURE__*/function (LoadEnv) {
+  LoadEnv["design"] = "design";
+  LoadEnv["runtime"] = "runtime";
+  return LoadEnv;
+}({});
+/**
+ * 低代码设置器描述
+ */
+/**
+ * 低代码插件器描述
+ */
+/**
+ * 资源引用信息，Npm 的升级版本，
+ */
+/**
+ * 低代码片段
+ *
+ * 内容为组件不同状态下的低代码 schema (可以有多个)，用户从组件面板拖入组件到设计器时会向页面 schema 中插入 snippets 中定义的组件低代码 schema
+ */
+/**
+ * 组件低代码描述
+ */
+/**
+ * 远程物料描述
+ */

package/lib/utils/designer/assets/index.d.ts

@@ -0,0 +1,10 @@
+import { Assets } from "./assets.typing";
+export declare type DefaultAssertsType = "antd" | "chart";
+export declare class DesignerAssets {
+    data: Assets;
+    constructor();
+    addDefaultAssets(types?: DefaultAssertsType[]): void;
+    addAssets(assert: Assets): void;
+    private addPackage;
+    private addComponent;
+}

package/lib/utils/designer/assets/index.js

@@ -0,0 +1,55 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+exports.__esModule = true;
+exports.DesignerAssets = void 0;
+var _assetsData = _interopRequireDefault(require("./assets.data.base"));
+var _assetsData2 = _interopRequireDefault(require("./assets.data.design"));
+var _assetsData3 = _interopRequireDefault(require("./assets.data.antd"));
+var _assetsData4 = _interopRequireDefault(require("./assets.data.chart"));
+var DesignerAssets = exports.DesignerAssets = /*#__PURE__*/function () {
+  function DesignerAssets() {
+    var _this = this;
+    this.data = void 0;
+    this.addPackage = function (pkg) {
+      if (!pkg) return;
+      _this.data.packages.push(pkg);
+    };
+    this.addComponent = function (component) {
+      if (!component) return;
+      _this.data.components.push(component);
+    };
+    this.data = JSON.parse(JSON.stringify(_assetsData["default"]));
+    console.log(this.data);
+    // @ts-ignore
+    if (window.AliLowCodeEngine) {
+      this.addAssets(_assetsData2["default"]);
+    }
+  }
+  var _proto = DesignerAssets.prototype;
+  _proto.addDefaultAssets = function addDefaultAssets(types) {
+    var _types, _types2;
+    if (types === void 0) {
+      types = [];
+    }
+    if ((_types = types) !== null && _types !== void 0 && _types.includes("antd")) {
+      this.addAssets(_assetsData3["default"]);
+    }
+    if ((_types2 = types) !== null && _types2 !== void 0 && _types2.includes("chart")) {
+      this.addAssets(_assetsData4["default"]);
+    }
+  };
+  _proto.addAssets = function addAssets(assert) {
+    var _assert$components, _assert$components$fo, _assert$packages, _assert$packages$forE;
+    var _self = this;
+    var addPackage = this.addPackage,
+      addComponent = this.addComponent;
+    (_assert$components = assert.components) === null || _assert$components === void 0 ? void 0 : (_assert$components$fo = _assert$components.forEach) === null || _assert$components$fo === void 0 ? void 0 : _assert$components$fo.call(_assert$components, function (item) {
+      addComponent.apply(_self, [item]);
+    });
+    (_assert$packages = assert.packages) === null || _assert$packages === void 0 ? void 0 : (_assert$packages$forE = _assert$packages.forEach) === null || _assert$packages$forE === void 0 ? void 0 : _assert$packages$forE.call(_assert$packages, function (item) {
+      addPackage.apply(_self, [item]);
+    });
+  };
+  return DesignerAssets;
+}();

package/lib/utils/designer/engine/index.d.ts

@@ -0,0 +1,19 @@
+import { Project } from "@alilc/lowcode-shell";
+import { DefaultAssertsType, DesignerAssets } from "../assets";
+export declare class Engine {
+    project: Project;
+    assets: DesignerAssets;
+    _engine: any;
+    constructor();
+    /**
+     * 注入资产
+     */
+    injectAssets(types?: DefaultAssertsType[]): Promise<void>;
+    /**
+     * 初始化
+     * @param container
+     * @param schema
+     */
+    init(container: HTMLElement, schema: any): Promise<void>;
+    openDocument(schema?: any): Promise<void>;
+}

package/lib/utils/designer/engine/index.js

@@ -0,0 +1,121 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+exports.__esModule = true;
+exports.Engine = void 0;
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+var _assets = require("../assets");
+var _assets2 = require("../assets/assets.parse");
+var _lowcodeDatasourceFetchHandler = require("@alilc/lowcode-datasource-fetch-handler");
+var Engine = exports.Engine = /*#__PURE__*/function () {
+  function Engine() {
+    this.project = void 0;
+    this.assets = void 0;
+    this._engine = void 0;
+    // @ts-ignore
+    this._engine = window.AliLowCodeEngine;
+    this.project = this._engine.project;
+    this.assets = new _assets.DesignerAssets();
+  }
+
+  /**
+   * 注入资产
+   */
+  var _proto = Engine.prototype;
+  _proto.injectAssets =
+  /*#__PURE__*/
+  function () {
+    var _injectAssets = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee(types) {
+      var engine, assetsData, asserts, _yield$assetsParse, components;
+      return _regenerator["default"].wrap(function _callee$(_context) {
+        while (1) switch (_context.prev = _context.next) {
+          case 0:
+            // @ts-ignore
+            engine = window.AliLowCodeEngine;
+            this.assets.addDefaultAssets(types);
+            assetsData = this.assets.data; // @ts-ignore
+            _context.next = 5;
+            return engine.injectAssets(assetsData);
+          case 5:
+            asserts = _context.sent;
+            _context.next = 8;
+            return engine.material.setAssets(asserts);
+          case 8:
+            _context.next = 10;
+            return (0, _assets2.assetsParse)(assetsData);
+          case 10:
+            _yield$assetsParse = _context.sent;
+            components = _yield$assetsParse.components;
+            // @ts-ignore
+            window.components = components;
+          case 13:
+          case "end":
+            return _context.stop();
+        }
+      }, _callee, this);
+    }));
+    function injectAssets(_x) {
+      return _injectAssets.apply(this, arguments);
+    }
+    return injectAssets;
+  }()
+  /**
+   * 初始化
+   * @param container
+   * @param schema
+   */
+  ;
+  _proto.init =
+  /*#__PURE__*/
+  function () {
+    var _init = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee2(container, schema) {
+      return _regenerator["default"].wrap(function _callee2$(_context2) {
+        while (1) switch (_context2.prev = _context2.next) {
+          case 0:
+            _context2.next = 2;
+            return this._engine.init(container, {
+              designMode: "design",
+              enableCondition: true,
+              enableCanvasLock: true,
+              supportVariableGlobally: true,
+              requestHandlersMap: {
+                fetch: (0, _lowcodeDatasourceFetchHandler.createFetchHandler)()
+              }
+            });
+          case 2:
+            _context2.next = 4;
+            return this.openDocument(schema);
+          case 4:
+          case "end":
+            return _context2.stop();
+        }
+      }, _callee2, this);
+    }));
+    function init(_x2, _x3) {
+      return _init.apply(this, arguments);
+    }
+    return init;
+  }();
+  _proto.openDocument = /*#__PURE__*/function () {
+    var _openDocument = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee3(schema) {
+      return _regenerator["default"].wrap(function _callee3$(_context3) {
+        while (1) switch (_context3.prev = _context3.next) {
+          case 0:
+            if (schema === void 0) {
+              schema = {};
+            }
+            this._engine.project.openDocument(schema);
+          case 2:
+          case "end":
+            return _context3.stop();
+        }
+      }, _callee3, this);
+    }));
+    function openDocument(_x4) {
+      return _openDocument.apply(this, arguments);
+    }
+    return openDocument;
+  }();
+  return Engine;
+}();

package/lib/utils/designer/index.d.ts

@@ -0,0 +1,3 @@
+export { assetsParse } from "./assets/assets.parse";
+import { Engine } from "./engine";
+export declare function initEngine(): Promise<Engine>;

package/lib/utils/designer/index.js

@@ -0,0 +1,34 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+exports.__esModule = true;
+exports.assetsParse = void 0;
+exports.initEngine = initEngine;
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+var _common = require("../common");
+var _assets = require("./assets/assets.parse");
+exports.assetsParse = _assets.assetsParse;
+var _engine = require("./engine");
+function initEngine() {
+  return _initEngine.apply(this, arguments);
+}
+function _initEngine() {
+  _initEngine = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee() {
+    return _regenerator["default"].wrap(function _callee$(_context) {
+      while (1) switch (_context.prev = _context.next) {
+        case 0:
+          _context.next = 2;
+          return (0, _common.loadPlugins)(["variables.css", "next.var.min.css", "react.production.min.js", "react-dom.production.min.js", "prop-types.js", "react15-polyfill.js", "lodash.min.js", "moment.min.js", "next.min.js", "engine-core.css", "engine-core.js", "engine-ext.js", "engine-ext.css", "index.css", "index.js"].map(function (uri) {
+            return "https://cdn.zhiyunhe.com/lowcode/designer/" + uri;
+          }));
+        case 2:
+          return _context.abrupt("return", new _engine.Engine());
+        case 3:
+        case "end":
+          return _context.stop();
+      }
+    }, _callee);
+  }));
+  return _initEngine.apply(this, arguments);
+}

package/lib/utils/index.d.ts

@@ -1,17 +1,12 @@
 export * from "./api";
 export * from "./common";
-export * from "./lowcode";
+export * from "./designer";
 import * as common from "./common";
 import * as api from "./api";
-import * as lowcode from "./lowcode";
+import * as designer from "./designer";
 declare const _default: {
-    uuid(prefix?: string, separator?: string): string;
-    RestApi: typeof common.RestApi;
-    RestFormApi: typeof common.RestFormApi;
-    ClientCache: typeof common.ClientCache;
-    loadPlugins: typeof common.loadPlugins;
-    schemaCache: common.ClientCache;
     api: typeof api;
-    lowcode: typeof lowcode;
+    designer: typeof designer;
+    common: typeof common;
 };
 export default _default;

package/lib/utils/index.js

@@ -1,10 +1,8 @@
 "use strict";
 
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 exports.__esModule = true;
 var _exportNames = {};
 exports["default"] = void 0;
-var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
 var api = _interopRequireWildcard(require("./api"));
 Object.keys(api).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
@@ -19,16 +17,17 @@ Object.keys(common).forEach(function (key) {
   if (key in exports && exports[key] === common[key]) return;
   exports[key] = common[key];
 });
-var lowcode = _interopRequireWildcard(require("./lowcode"));
-Object.keys(lowcode).forEach(function (key) {
+var designer = _interopRequireWildcard(require("./designer"));
+Object.keys(designer).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
   if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
-  if (key in exports && exports[key] === lowcode[key]) return;
-  exports[key] = lowcode[key];
+  if (key in exports && exports[key] === designer[key]) return;
+  exports[key] = designer[key];
 });
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { "default": e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n["default"] = e, t && t.set(e, n), n; }
-var _default = exports["default"] = (0, _extends2["default"])({
+var _default = exports["default"] = {
   api: api,
-  lowcode: lowcode
-}, common);
+  designer: designer,
+  common: common
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zhubangyun/lowcode-core",
-  "version": "1.1.3",
+  "version": "1.1.5",
   "description": "低代码核心",
   "files": [
     "lib",
@@ -11,9 +11,11 @@
   "scripts": {
     "bundle:types": "node bundle-dts.js",
     "dev": "build-scripts start --config build.dev.json",
+
     "build:npm": "build-scripts build",
-    "publish:npm": "build-scripts build && npm publish",
     "build:umd": "build-scripts build --config build.umd.json",
+
+    "publish:npm": "build-scripts build && npm publish",
     "publish:umd": "npm run build:umd && node scripts/publishToCdn.ts"
   },
   "dependencies": {

package/readme.md

@@ -0,0 +1,2 @@
+npm config set registry https://registry.npmjs.org/
+npm config set registry https://mirrors.huaweicloud.com/repository/npm/