amis-editor 5.5.0 → 5.6.1

package/lib/builder/DSBuilder.d.ts

@@ -0,0 +1,171 @@
+/**
+ * @file DSBuilder.ts
+ * @desc 数据源配置构建器
+ */
+import { EditorManager } from 'amis-editor-core';
+import type { EditorNodeType } from 'amis-editor-core';
+import type { DSFeatureType, GenericSchema, CRUDScaffoldConfig, FormScaffoldConfig } from './type';
+export interface DSBuilderBaseOptions {
+    /** 渲染器类型 */
+    renderer: string;
+    /** Form应用场景 */
+    feat?: DSFeatureType;
+    /** CRUD应用场景 */
+    feats?: DSFeatureType[];
+    /** 当前组件的 Schema */
+    schema?: GenericSchema;
+    /** 数据源字段名 */
+    sourceKey?: string;
+    /** 是否在脚手架环境中 */
+    inScaffold?: boolean;
+    /** 如果为列表类容器，则会返回对应的节点 */
+    scopeNode?: EditorNodeType;
+    /** 数据源控件配置项 */
+    sourceSettings?: Record<string, any>;
+    /** 字段控件配置项 */
+    fieldSettings?: Record<string, any>;
+    [propName: string]: any;
+}
+export interface DSBuilderInterface<T extends DSBuilderBaseOptions = DSBuilderBaseOptions> {
+    /** 数据源中文名称，主要用于前端展示 */
+    readonly name: string;
+    /** 构造器排序权重，数字越小排序越靠前，支持负数 */
+    readonly order: number;
+    /** 数据源支持的功能场景 */
+    readonly features: DSFeatureType[];
+    /** 是否为默认 */
+    isDefault?: boolean;
+    /** 实例获取数据源的key */
+    key: string;
+    /** 是否禁用 */
+    disabledOn?: () => boolean;
+    /** 获取功能场景的value */
+    getFeatValueByKey(feat: DSFeatureType): string;
+    /** 获取功能场景的label */
+    getFeatLabelByKey(feat: DSFeatureType): string;
+    /** 按照功能场景过滤 */
+    filterByFeat(feat: any): boolean;
+    /** 根据schema，判断是否匹配当前数据源  */
+    match(schema?: any, key?: string): boolean;
+    /** 当前上下文中使用的字段 */
+    getContextFields(options: T): Promise<any>;
+    /** 当前上下文可以使用的字段 */
+    getAvailableContextFields(options: Omit<T, 'renderer'>, target: EditorNodeType): Promise<any>;
+    /** 获取CRUD列表字段 */
+    getCRUDListFields?: <F extends Record<string, any>>(options: T) => Promise<F[]>;
+    /** 获取CRUD简单查询字段 */
+    getCRUDSimpleQueryFields?: <F extends Record<string, any>>(options: T) => Promise<F[]>;
+    /** 构建简单查询表单项 */
+    buildSimpleQueryCollectionSchema?: (options: T) => Promise<GenericSchema[] | undefined>;
+    /** 获取CRUD高级查询字段 */
+    getCRUDAdvancedQueryFields?: <F extends Record<string, any>>(options: T) => Promise<F[]>;
+    /** 构建高级查询 */
+    buildAdvancedQuerySchema?: (options: T) => Promise<GenericSchema | undefined>;
+    /** 获取CRUD模糊查询字段 */
+    getCRUDFuzzyQueryFields?: <F extends Record<string, any>>(options: T) => Promise<F[]>;
+    /** 构建模糊查询 */
+    buildFuzzyQuerySchema?: (options: T) => Promise<GenericSchema | undefined>;
+    /** 构造数据源的可视化配置表单 */
+    makeSourceSettingForm(options: T): any[];
+    /** 构造数据源字段的可视化配置表单 */
+    makeFieldsSettingForm(options: T): any[];
+    /** 新建数据 */
+    buildInsertSchema(options: T, componentId?: string): Promise<any>;
+    /** 编辑数据 */
+    buildEditSchema(options: T, componentId?: string): Promise<any>;
+    /** 批量编辑数据 */
+    buildBulkEditSchema(options: T, componentId?: string): Promise<any>;
+    /** 查看详情数据 */
+    buildViewSchema(options: T, componentId?: string): Promise<any>;
+    /** 删除数据 */
+    buildCRUDDeleteSchema(options: T, componentId?: string): Promise<any>;
+    /** 批量删除数据 */
+    buildCRUDBulkDeleteSchema(options: T, componentId?: string): Promise<any>;
+    /** 构建 CRUD 的顶部工具栏 */
+    buildCRUDHeaderToolbar?: (options: T, componentId?: string) => Promise<GenericSchema>;
+    /** 表格的表头查询 */
+    buildCRUDFilterSchema(options: T, componentId?: string): Promise<any>;
+    /** 表格单列 */
+    buildCRUDColumn?: (field: Record<string, any>, options: T, componentId?: string) => Promise<any>;
+    /** 表格操作列 */
+    buildCRUDOpColumn?: (options: T, componentId?: string) => Promise<any>;
+    /** 表格列 */
+    buildCRUDColumnsSchema(options: T, componentId?: string): Promise<any>;
+    /** 表格构建 */
+    buildCRUDSchema(options: T): Promise<any>;
+    /** 表单构建 */
+    buildFormSchema(options: T): Promise<any>;
+    /** 基于 schema 还原CRUD脚手架配置 */
+    guessCRUDScaffoldConfig<T extends CRUDScaffoldConfig<any, any>>(options: {
+        schema: GenericSchema;
+        [propName: string]: any;
+    }): Promise<T> | T;
+    /** 基于 schema 还原Form脚手架配置 */
+    guessFormScaffoldConfig<T extends FormScaffoldConfig<any, any>>(options: {
+        schema: GenericSchema;
+        [propName: string]: any;
+    }): Promise<T> | T;
+    /** 重新构建 API 配置 */
+    buildApiSchema(options: T): Promise<any>;
+}
+export declare abstract class DSBuilder<T extends DSBuilderBaseOptions> implements DSBuilderInterface<T> {
+    readonly manager: EditorManager;
+    static key: string;
+    readonly name: string;
+    readonly order: number;
+    /** 是否为默认 */
+    readonly isDefault?: boolean;
+    features: DSFeatureType[];
+    constructor(manager: EditorManager);
+    /** 实例获取数据源的key */
+    get key(): string;
+    /** 获取功能场景的value */
+    getFeatValueByKey(feat: DSFeatureType): string;
+    /** 获取功能场景的label */
+    getFeatLabelByKey(feat: DSFeatureType): string;
+    filterByFeat(feat: any): any;
+    abstract match(schema?: any, key?: string): boolean;
+    abstract getContextFields(options: T): Promise<any>;
+    abstract getAvailableContextFields(options: Omit<T, 'renderer'>, target: EditorNodeType): Promise<any>;
+    abstract makeSourceSettingForm(options: T): any[];
+    abstract makeFieldsSettingForm(options: T): any[];
+    /** 新建数据 */
+    abstract buildInsertSchema(options: T): Promise<any>;
+    /** 查看详情数据 */
+    abstract buildViewSchema(options: T): Promise<any>;
+    /** 编辑数据 */
+    abstract buildEditSchema(options: T): Promise<any>;
+    /** 批量编辑数据 */
+    abstract buildBulkEditSchema(options: T): Promise<any>;
+    /** 删除数据 */
+    abstract buildCRUDDeleteSchema(options: T): Promise<any>;
+    /** 批量删除数据 */
+    abstract buildCRUDBulkDeleteSchema(options: T): Promise<any>;
+    /** 表格的表头查询 */
+    abstract buildCRUDFilterSchema(options: T): Promise<any>;
+    /** 表格列 */
+    abstract buildCRUDColumnsSchema(options: T): Promise<any>;
+    /** 表格 */
+    abstract buildCRUDSchema(options: T): Promise<any>;
+    /** 表单 */
+    abstract buildFormSchema(options: T): Promise<any>;
+    /** 基于 schema 还原CRUD脚手架配置 */
+    abstract guessCRUDScaffoldConfig<T extends CRUDScaffoldConfig<any, any>>(options: {
+        schema: GenericSchema;
+        [propName: string]: any;
+    }): Promise<T> | T;
+    /** 基于 schema 还原Form脚手架配置 */
+    abstract guessFormScaffoldConfig<T extends FormScaffoldConfig<any, any>>(options: {
+        schema: GenericSchema;
+        [propName: string]: any;
+    }): Promise<T> | T;
+    abstract buildApiSchema(options: T): Promise<any>;
+}
+export interface DSBuilderClass {
+    new (manager: EditorManager): DSBuilderInterface;
+    /** 数据源类型，使用英文，可以覆盖同名 */
+    key: string;
+}
+export declare const builderFactory: Map<string, DSBuilderClass>;
+/** 注册数据源构造器 */
+export declare const registerDSBuilder: (klass: DSBuilderClass) => void;

package/lib/builder/DSBuilder.js

@@ -0,0 +1,55 @@
+/**
+ * amis-editor v5.5.2-beta.2
+ * build time: 2023-09-28
+ * Copyright 2018-2023 @fex
+ */
+
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var utils = require('./utils.js');
+
+/**
+ * @file DSBuilder.ts
+ * @desc 数据源配置构建器
+ */
+var DSBuilder = /** @class */ (function () {
+    function DSBuilder(manager) {
+        this.manager = manager;
+    }
+    Object.defineProperty(DSBuilder.prototype, "key", {
+        /** 实例获取数据源的key */
+        get: function () {
+            return this.constructor.key;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /** 获取功能场景的value */
+    DSBuilder.prototype.getFeatValueByKey = function (feat) {
+        return utils.getFeatValueByKey(feat);
+    };
+    /** 获取功能场景的label */
+    DSBuilder.prototype.getFeatLabelByKey = function (feat) {
+        return utils.getFeatLabelByKey(feat);
+    };
+    DSBuilder.prototype.filterByFeat = function (feat) {
+        return feat && this.features.includes(feat);
+    };
+    return DSBuilder;
+}());
+var builderFactory = new Map();
+/** 注册数据源构造器 */
+var registerDSBuilder = function (klass) {
+    if (builderFactory.has(klass.key)) {
+        console.warn("[amis-editor][DSBuilder] duplicate DSBuilder\u300C".concat(klass.key, "\u300D"));
+    }
+    /** 重名覆盖 */
+    builderFactory.set(klass.key, klass);
+};
+
+exports.DSBuilder = DSBuilder;
+exports.builderFactory = builderFactory;
+exports.registerDSBuilder = registerDSBuilder;
+window.amisEditorVersionInfo={version:'5.5.2-beta.2',buildTime:'2023-09-28'};

package/lib/builder/DSBuilderManager.d.ts

@@ -0,0 +1,62 @@
+/**
+ * @file DSBuilderManager
+ * @desc 数据源构造管理器
+ */
+import { DSBuilderInterface } from './DSBuilder';
+import type { EditorManager } from 'amis-editor-core';
+import type { GenericSchema } from './type';
+export declare class DSBuilderManager {
+    private builders;
+    constructor(manager: EditorManager);
+    get size(): number;
+    getBuilderByKey(key: string): DSBuilderInterface<import("./DSBuilder").DSBuilderBaseOptions> | undefined;
+    getBuilderByScaffoldSetting(scaffoldConfig: any): DSBuilderInterface<import("./DSBuilder").DSBuilderBaseOptions> | undefined;
+    getBuilderBySchema(schema: any): DSBuilderInterface<import("./DSBuilder").DSBuilderBaseOptions>;
+    /**
+     * 获取默认构建器Key
+     *
+     * @returns 返回默认构建器Key
+     */
+    getDefaultBuilderKey(): string;
+    /**
+     * 获取默认构建器
+     *
+     * @returns {Object} 默认构建器
+     */
+    getDefaultBuilder(): DSBuilderInterface<import("./DSBuilder").DSBuilderBaseOptions>;
+    /**
+     * 获取可用的构建器列表
+     *
+     * @returns 返回可用构建器的列表
+     */
+    getAvailableBuilders(): [string, DSBuilderInterface<import("./DSBuilder").DSBuilderBaseOptions>][];
+    /**
+     * 获取数据选择器Schema
+     *
+     * @param patch - 需要进行补丁修复的配置对象
+     * @param config - 包含运行上下文和源键的配置对象
+     * @returns 返回一个对象，包含类型、标签、名称、可见性、选项、默认值和pipeIn等属性
+     */
+    getDSSelectorSchema(patch: Record<string, any>, config?: {
+        /** 组件 Schema */
+        schema: GenericSchema;
+        /** 组件数据源 Key */
+        sourceKey: string;
+        /** 获取默认值函数 */
+        getDefautlValue?: (key: string, builder: DSBuilderInterface) => Boolean;
+    }): {
+        value?: string | undefined;
+        type: string;
+        label: string;
+        name: string;
+        visible: boolean;
+        options: Option[];
+    };
+    /**
+     * 从构建器中生成集合
+     *
+     * @param callback 回调函数，用于处理每个构建器、构建器键和索引
+     * @returns 返回生成的集合
+     */
+    buildCollectionFromBuilders(callback: (builder: DSBuilderInterface, builderKey: string, index: number) => any): any[];
+}

package/lib/builder/DSBuilderManager.js

@@ -0,0 +1,211 @@
+/**
+ * amis-editor v5.5.2-beta.2
+ * build time: 2023-09-28
+ * Copyright 2018-2023 @fex
+ */
+
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var tslib = require('tslib');
+var DSBuilder = require('./DSBuilder.js');
+var i18nRuntime = require('i18n-runtime');
+
+/**
+ * @file DSBuilderManager
+ * @desc 数据源构造管理器
+ */
+var DSBuilderManager = /** @class */function () {
+  function DSBuilderManager(manager) {
+    var _this = this;
+    this.builders = new Map();
+    DSBuilder.builderFactory.forEach(function (Builder, key) {
+      _this.builders.set(key, new Builder(manager));
+    });
+  }
+  Object.defineProperty(DSBuilderManager.prototype, "size", {
+    get: function () {
+      return this.builders.size;
+    },
+    enumerable: false,
+    configurable: true
+  });
+  DSBuilderManager.prototype.getBuilderByKey = function (key) {
+    return this.builders.get(key);
+  };
+  DSBuilderManager.prototype.getBuilderByScaffoldSetting = function (scaffoldConfig) {
+    return this.builders.get(scaffoldConfig.dsType);
+  };
+  DSBuilderManager.prototype.getBuilderBySchema = function (schema) {
+    var e_1, _a;
+    var builder;
+    try {
+      for (var _b = tslib.__values(Array.from(this.builders.entries())), _c = _b.next(); !_c.done; _c = _b.next()) {
+        var _d = tslib.__read(_c.value, 2),
+          key = _d[0],
+          value = _d[1];
+        if (value.match(schema)) {
+          builder = value;
+          break;
+        }
+      }
+    } catch (e_1_1) {
+      e_1 = {
+        error: e_1_1
+      };
+    } finally {
+      try {
+        if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+      } finally {
+        if (e_1) throw e_1.error;
+      }
+    }
+    return builder ? builder : this.getDefaultBuilder();
+  };
+  /**
+   * 获取默认构建器Key
+   *
+   * @returns 返回默认构建器Key
+   */
+  DSBuilderManager.prototype.getDefaultBuilderKey = function () {
+    var _a, _b, _c;
+    var collections = Array.from(this.builders.entries()).filter(function (_a) {
+      var _b;
+      var _c = tslib.__read(_a, 2);
+        _c[0];
+        var builder = _c[1];
+      return ((_b = builder === null || builder === void 0 ? void 0 : builder.disabledOn) === null || _b === void 0 ? void 0 : _b.call(builder)) !== true;
+    });
+    var _d = tslib.__read((_c = (_a = collections.find(function (_a) {
+        var _b = tslib.__read(_a, 2);
+          _b[0];
+          var builder = _b[1];
+        return builder.isDefault === true;
+      })) !== null && _a !== void 0 ? _a : (_b = collections.sort(function (lhs, rhs) {
+        var _a, _b;
+        return ((_a = lhs[1].order) !== null && _a !== void 0 ? _a : 0) - ((_b = rhs[1].order) !== null && _b !== void 0 ? _b : 0);
+      })) === null || _b === void 0 ? void 0 : _b[0]) !== null && _c !== void 0 ? _c : [], 2),
+      defaultKey = _d[0];
+      _d[1];
+    return defaultKey;
+  };
+  /**
+   * 获取默认构建器
+   *
+   * @returns {Object} 默认构建器
+   */
+  DSBuilderManager.prototype.getDefaultBuilder = function () {
+    var _a, _b, _c;
+    var collections = Array.from(this.builders.entries()).filter(function (_a) {
+      var _b;
+      var _c = tslib.__read(_a, 2);
+        _c[0];
+        var builder = _c[1];
+      return ((_b = builder === null || builder === void 0 ? void 0 : builder.disabledOn) === null || _b === void 0 ? void 0 : _b.call(builder)) !== true;
+    });
+    var _d = tslib.__read((_c = (_a = collections.find(function (_a) {
+        var _b = tslib.__read(_a, 2);
+          _b[0];
+          var builder = _b[1];
+        return builder.isDefault === true;
+      })) !== null && _a !== void 0 ? _a : (_b = collections.sort(function (lhs, rhs) {
+        var _a, _b;
+        return ((_a = lhs[1].order) !== null && _a !== void 0 ? _a : 0) - ((_b = rhs[1].order) !== null && _b !== void 0 ? _b : 0);
+      })) === null || _b === void 0 ? void 0 : _b[0]) !== null && _c !== void 0 ? _c : [], 2);
+      _d[0];
+      var defaultBuilder = _d[1];
+    return defaultBuilder;
+  };
+  /**
+   * 获取可用的构建器列表
+   *
+   * @returns 返回可用构建器的列表
+   */
+  DSBuilderManager.prototype.getAvailableBuilders = function () {
+    return Array.from(this.builders.entries()).filter(function (_a) {
+      var _b;
+      var _c = tslib.__read(_a, 2);
+        _c[0];
+        var builder = _c[1];
+      return ((_b = builder === null || builder === void 0 ? void 0 : builder.disabledOn) === null || _b === void 0 ? void 0 : _b.call(builder)) !== true;
+    }).sort(function (lhs, rhs) {
+      var _a, _b;
+      return ((_a = lhs[1].order) !== null && _a !== void 0 ? _a : 0) - ((_b = rhs[1].order) !== null && _b !== void 0 ? _b : 0);
+    });
+  };
+  /**
+   * 获取数据选择器Schema
+   *
+   * @param patch - 需要进行补丁修复的配置对象
+   * @param config - 包含运行上下文和源键的配置对象
+   * @returns 返回一个对象，包含类型、标签、名称、可见性、选项、默认值和pipeIn等属性
+   */
+  DSBuilderManager.prototype.getDSSelectorSchema = function (patch, config) {
+    var e_2, _a;
+    var _b = config || {},
+      schema = _b.schema,
+      sourceKey = _b.sourceKey,
+      getDefautlValue = _b.getDefautlValue;
+    var builders = this.getAvailableBuilders();
+    var defaultValue = schema === null || schema === void 0 ? void 0 : schema.dsType;
+    var options = [];
+    try {
+      for (var builders_1 = tslib.__values(builders), builders_1_1 = builders_1.next(); !builders_1_1.done; builders_1_1 = builders_1.next()) {
+        var _c = tslib.__read(builders_1_1.value, 2),
+          key = _c[0],
+          builder = _c[1];
+        if (schema && !defaultValue) {
+          if (getDefautlValue && typeof getDefautlValue === 'function' && getDefautlValue(key, builder)) {
+            defaultValue = key;
+          } else if (builder.match(schema, sourceKey)) {
+            defaultValue = key;
+          }
+        }
+        options.push({
+          label: builder.name,
+          value: key
+        });
+      }
+    } catch (e_2_1) {
+      e_2 = {
+        error: e_2_1
+      };
+    } finally {
+      try {
+        if (builders_1_1 && !builders_1_1.done && (_a = builders_1.return)) _a.call(builders_1);
+      } finally {
+        if (e_2) throw e_2.error;
+      }
+    }
+    return tslib.__assign(tslib.__assign({
+      type: 'radios',
+      label: i18nRuntime.i18n("a094e5b7699ea4b61094cc4120170423"),
+      name: 'dsType',
+      visible: options.length > 0,
+      options: options
+    }, defaultValue ? {
+      value: defaultValue
+    } : {}), patch);
+  };
+  /**
+   * 从构建器中生成集合
+   *
+   * @param callback 回调函数，用于处理每个构建器、构建器键和索引
+   * @returns 返回生成的集合
+   */
+  DSBuilderManager.prototype.buildCollectionFromBuilders = function (callback) {
+    var builders = this.getAvailableBuilders();
+    var collection = builders.map(function (_a, index) {
+      var _b = tslib.__read(_a, 2),
+        key = _b[0],
+        builder = _b[1];
+      return callback(builder, key, index);
+    }).filter(Boolean);
+    return collection;
+  };
+  return DSBuilderManager;
+}();
+
+exports.DSBuilderManager = DSBuilderManager;
+window.amisEditorVersionInfo={version:'5.5.2-beta.2',buildTime:'2023-09-28'};

package/lib/builder/constants.d.ts

@@ -0,0 +1,97 @@
+/**
+ * @file constants.ts
+ * @desc builder 相关常量
+ */
+import { FormOperatorValue, FormOperator } from './type';
+/**
+ * 数据源所需操作，目前是因为schema从后端来
+ */
+export declare enum DSBehavior {
+    /** 创建操作 */
+    create = "create",
+    /** 查询操作 */
+    view = "view",
+    /** 更新操作 */
+    update = "update",
+    table = "table",
+    filter = "filter"
+}
+/** 数据粒度 */
+export declare enum DSGrain {
+    /** 实体 */
+    entity = "entity",
+    /** 多条数据 */
+    list = "list",
+    /** 单条数据 */
+    piece = "piece"
+}
+/** 数据源所使用的功能场景 */
+export declare const DSFeature: {
+    List: {
+        value: string;
+        label: string;
+    };
+    Insert: {
+        value: string;
+        label: string;
+    };
+    View: {
+        value: string;
+        label: string;
+    };
+    Edit: {
+        value: string;
+        label: string;
+    };
+    Delete: {
+        value: string;
+        label: string;
+    };
+    BulkEdit: {
+        value: string;
+        label: string;
+    };
+    BulkDelete: {
+        value: string;
+        label: string;
+    };
+    Import: {
+        value: string;
+        label: string;
+    };
+    Export: {
+        value: string;
+        label: string;
+    };
+    SimpleQuery: {
+        value: string;
+        label: string;
+    };
+    FuzzyQuery: {
+        value: string;
+        label: string;
+    };
+    AdvancedQuery: {
+        value: string;
+        label: string;
+    };
+};
+export declare enum DSFeatureEnum {
+    List = "List",
+    Insert = "Insert",
+    View = "View",
+    Edit = "Edit",
+    Delete = "Delete",
+    BulkEdit = "BulkEdit",
+    BulkDelete = "BulkDelete",
+    Import = "Import",
+    Export = "Export",
+    SimpleQuery = "SimpleQuery",
+    FuzzyQuery = "FuzzyQuery",
+    AdvancedQuery = "AdvancedQuery"
+}
+export declare const DSFeatureList: ("Edit" | "View" | "Delete" | "List" | "Insert" | "Import" | "Export" | "BulkEdit" | "BulkDelete" | "SimpleQuery" | "FuzzyQuery" | "AdvancedQuery")[];
+export declare const FormOperatorMap: Record<FormOperatorValue, FormOperator>;
+export declare const ModelDSBuilderKey = "model-entity";
+export declare const ApiDSBuilderKey = "api";
+export declare const ApiCenterDSBuilderKey = "apicenter";