@byteluck-fe/model-driven-core 7.0.0-props.94 → 8.0.0-beta.0

package/dist/types/common/BaseControl/designer.d.ts

@@ -47,12 +47,15 @@ declare class Control {
     toSchema(): BaseControlSchema<ControlsKeys, Property>;
     updateSetting: typeof updateSetting;
     removeSetting: typeof removeSetting;
+    removeSettingByKeyAndName: typeof removeSettingByKeyAndName;
     static updateBasicControl(key: 'setting', setting: {
         add?: SettingOption[];
         remove?: string[];
         update?: string[];
     }): void;
     static removeSettingItem: typeof removeSetting;
+    static removeSettingByKeyAndName: typeof removeSettingByKeyAndName;
+    static removeSettingItemByKeyAndName: typeof removeSettingByKeyAndName;
     static updateSettingItem: typeof updateSetting;
 }
 export default Control;
@@ -63,6 +66,17 @@ export { Control as DesignerControl };
  * @param keys 需要删除的key或key组成的数组
  * */
 declare function removeSetting(keys: Array<string | HideOptions> | string | HideOptions): void;
+/**
+ * @function 根据key和name删除控件或者实例上的setting
+ * @description 用于删除使用公共key但通过name区分的setting项
+ * @param options 需要删除的setting key和name
+ * */
+interface RemoveSettingByKeyAndNameOption {
+    key: string;
+    name: string;
+}
+declare function removeSettingByKeyAndName(options: RemoveSettingByKeyAndNameOption[]): void;
+declare function removeSettingByKeyAndName(key: string, name: string): void;
 interface UpdateSettingOption {
     showItems: COMMON_SETTING_TYPE[];
     type?: 'push' | 'replace';

package/dist/types/common/BaseControl/property.d.ts

@@ -1,3 +1,7 @@
+/**
+ * name: base_property
+ * description: 基础属性定义。提供控件通用的隐藏状态、类名、样式、标题和默认状态配置，是表单、布局、列表等属性模型的公共基类。
+ */
 import { RuleItem } from '../Validator';
 import { BaseStyle } from '../../framework';
 import { MODE } from 'type';
@@ -52,10 +56,34 @@ declare class Property implements PropertyInterface {
     static mode: MODE;
     static readonly Rules: typeof PropertyRules;
     static readonly RuntimeRules: typeof PropertyRuntimeRules;
+    /**
+     * 是否隐藏
+     * @public
+     * @defaultValue false
+     */
     isHide: boolean;
+    /**
+     * 类名
+     * @public
+     * @noSchema
+     */
     className?: string[];
+    /**
+     * 样式
+     * @public
+     * @noSchema
+     */
     style: BaseStyle;
+    /**
+     * 标题
+     * @public
+     * @defaultValue ''
+     */
     caption: string;
+    /**
+     * 默认状态
+     * @public
+     */
     defaultState: 'readonly' | 'default';
     constructor(props?: Partial<Property>, caption?: string);
 }

package/dist/types/common/ColumnControl/property.d.ts

@@ -1,3 +1,7 @@
+/**
+ * name: base_column_control_property
+ * description: 列控件基础属性定义。提供列宽、标题、数据绑定、自适应宽度、冻结、排序、对齐、跨列、自动高度和子控件配置。
+ */
 import { Property, PropertyInterface, PropertyRules, RuntimeControl } from '../BaseControl';
 import { RuleItem } from 'async-validator';
 import { DataBind, DataSourceBind, OptionSetting, AutoWidth } from '../../framework';
@@ -63,16 +67,54 @@ interface ColumnControlPropertyInterface extends PropertyInterface {
  */
 declare class ColumnControlProperty extends Property implements ColumnControlPropertyInterface {
     static readonly Rules: typeof ColumnControlPropertyRules;
+    /**
+     * 宽度类型
+     * @defaultValue 'auto'
+     */
     widthType: 'px' | 'auto' | 'percent';
+    /**
+     * 宽度
+     * @defaultValue 150
+     */
     width: number;
+    /**
+     * 标题
+     */
     caption: string;
+    /**
+     * 绑定数据项
+     */
     dataBind: DataBind;
+    /**
+     * 自适应页面宽度
+     */
     autoWidth: AutoWidth;
+    /**
+     * 冻结
+     * @defaultValue 'none'
+     */
     fixed: 'left' | 'right' | 'none';
+    /**
+     * 表头排序
+     * @defaultValue true
+     */
     sort: boolean;
+    /**
+     * 对齐
+     */
     align?: 'left' | 'right' | 'center';
+    /**
+     * @internal
+     */
     colSpan?: string;
+    /**
+     * 自动高度
+     * @defaultValue false
+     */
     autoHeight: boolean;
+    /**
+     * 子控件
+     */
     children: RuntimeControl[];
     constructor(props?: Partial<ColumnControlProperty>);
 }

package/dist/types/common/LayoutControl/property.d.ts

@@ -1,3 +1,7 @@
+/**
+ * name: base_layout_control_property
+ * description: 布局控件基础属性定义。继承通用属性能力，为行、列、容器、页签等布局类控件提供统一的属性模型。
+ */
 import { Property, PropertyInterface } from '../BaseControl';
 interface LayoutControlPropertyInterface extends PropertyInterface {
 }

package/dist/types/common/ListControl/property.d.ts

@@ -1,3 +1,7 @@
+/**
+ * name: base_list_control_property
+ * description: 列表控件基础属性定义。提供表头、表尾、分页页码、每页条数、分页选项和总条数等列表通用配置。
+ */
 import { DesignerControl, Property, PropertyInterface, RuntimeControl } from '../BaseControl';
 import { ControlsKeys, BaseControlSchema, MODE } from '../../type';
 import { DesignerListControl } from './designer';
@@ -30,11 +34,29 @@ interface ListControlPropertyInterface<Mode extends MODE | 'Schema', Control ext
     totalCount: number;
 }
 declare class ListControlProperty<Mode extends MODE | 'Schema', Control extends object = ControlType<Mode>> extends Property implements ListControlPropertyInterface<Mode, Control> {
+    /**
+     * 表头控件
+     */
     headers: Control[];
+    /**
+     * 表尾控件
+     */
     footers?: Control[];
+    /**
+     * 当前页码
+     */
     pageIndex: number;
+    /**
+     * 每页条数
+     */
     pageSize: number;
+    /**
+     * 每页条数选项
+     */
     pageSizeOptions: number[];
+    /**
+     * 总条数
+     */
     totalCount: number;
     constructor(parent: DesignerListControl | RuntimeListControl, props?: Partial<ListControlProperty<Mode> & {
         headers: Control[];

package/dist/types/common/SearchViewControl/property.d.ts

@@ -1,3 +1,7 @@
+/**
+ * name: base_search_control_property
+ * description: 查询控件基础属性定义。提供查询视图的数据项绑定配置，用于搜索区域控件与数据字段建立关联。
+ */
 import { LayoutControlProperty, LayoutControlPropertyInterface } from '../LayoutControl';
 import { DataBind } from '../../framework';
 interface SearchControlPropertyInterface extends LayoutControlPropertyInterface {
@@ -7,6 +11,9 @@ interface SearchControlPropertyInterface extends LayoutControlPropertyInterface
     dataBind: DataBind;
 }
 declare class SearchControlProperty extends LayoutControlProperty implements SearchControlPropertyInterface {
+    /**
+     * 绑定数据项
+     */
     dataBind: DataBind;
     constructor(props?: Partial<SearchControlProperty>);
 }

package/dist/types/common/WrapControl/property.d.ts

@@ -1,3 +1,7 @@
+/**
+ * name: base_wrap_control_property
+ * description: 包裹控件基础属性定义。继承布局属性能力，为外层包裹类控件提供统一的属性模型。
+ */
 import { LayoutControlProperty, LayoutControlPropertyInterface } from '../LayoutControl';
 interface WrapControlPropertyInterface extends LayoutControlPropertyInterface {
 }

package/dist/types/contracts/build-info.d.ts

@@ -0,0 +1,25 @@
+import { CONTROL_CATALOG_SCHEMA_VERSION, CURRENT_PAGE_SCHEMA_VERSION, HEADLESS_COMPILER_CONTRACT_VERSION, MODEL_DRIVEN_PACKAGE_VERSION } from './versions';
+/**
+ * 可跨 Designer、Runtime 与 FDE 比对的公共构建信息。
+ * catalogRevision 由 controls/catalog 在生成阶段补充，core 不反向依赖 controls。
+ */
+export interface ModelDrivenBuildInfo {
+    packageVersion: typeof MODEL_DRIVEN_PACKAGE_VERSION;
+    pageSchemaVersion: typeof CURRENT_PAGE_SCHEMA_VERSION;
+    compilerContractVersion: typeof HEADLESS_COMPILER_CONTRACT_VERSION;
+    catalogSchemaVersion: typeof CONTROL_CATALOG_SCHEMA_VERSION;
+    catalogRevision?: string;
+}
+/**
+ * 调用方声明的版本期望允许任意字符串，才能在类型安全的调用中表达并检测旧版本。
+ */
+export interface ModelDrivenBuildInfoExpectation {
+    packageVersion?: string;
+    pageSchemaVersion?: string;
+    compilerContractVersion?: string;
+    catalogSchemaVersion?: string;
+    catalogRevision?: string;
+}
+export declare const MODEL_DRIVEN_BUILD_INFO: Readonly<ModelDrivenBuildInfo>;
+/** 返回新对象，避免调用方意外改写共享的版本事实。 */
+export declare function getModelDrivenBuildInfo(): ModelDrivenBuildInfo;

package/dist/types/contracts/diagnostics.d.ts

@@ -0,0 +1,14 @@
+export type ModelDrivenDiagnosticSeverity = 'error' | 'warning' | 'info';
+/**
+ * 纯编译层只返回稳定、短小的诊断信息，不携带完整页面或控件 props，
+ * 便于 FDE 将结果写入日志或工具返回值而不放大模型上下文。
+ */
+export interface ModelDrivenDiagnostic {
+    code: string;
+    message: string;
+    severity: ModelDrivenDiagnosticSeverity;
+    path?: string;
+    controlId?: string;
+    controlType?: string;
+}
+export declare function createModelDrivenDiagnostic(diagnostic: ModelDrivenDiagnostic): ModelDrivenDiagnostic;

package/dist/types/contracts/index.d.ts

@@ -0,0 +1,4 @@
+export * from './versions';
+export * from './build-info';
+export * from './diagnostics';
+export * from './page-model';

package/dist/types/contracts/page-model.d.ts

@@ -0,0 +1,72 @@
+import { ModelDrivenBuildInfo, ModelDrivenBuildInfoExpectation } from './build-info';
+import { ModelDrivenDiagnostic } from './diagnostics';
+export type JsonPrimitive = string | number | boolean | null;
+export type JsonValue = JsonPrimitive | JsonObject | JsonValue[];
+export interface JsonObject {
+    [key: string]: JsonValue | undefined;
+}
+export type PageKind = 'form' | 'list';
+export type ModelDrivenBaseControlType = 'base' | 'form' | 'layout' | 'list' | 'column' | 'search' | 'wrap';
+/** 不依赖 Vue/DOM 的页面控件保存结构。 */
+export interface HeadlessControlNode {
+    id: string;
+    type: string;
+    controlType: ModelDrivenBaseControlType;
+    props: JsonObject;
+    fieldType?: string;
+    children?: HeadlessControlNode[];
+}
+export interface CreateControlNodeInput {
+    type: string;
+    id?: string;
+    props?: JsonObject;
+    fieldType?: string;
+    children?: HeadlessControlNode[];
+}
+/**
+ * 同步文案解析器收到的完整事实；headless 不负责访问接口或读取全局 i18n。
+ */
+export interface HeadlessLocaleMessageContext {
+    key: string;
+    locale: string;
+    fallback: string;
+    values: Readonly<Record<string, string>>;
+}
+export type HeadlessLocaleMessageResolver = (context: HeadlessLocaleMessageContext) => string | undefined;
+export interface HeadlessRuntimeOptions {
+    /** 构造多节点树时应复用同一个工厂；未提供时每个顶层构建使用独立序列。 */
+    idFactory?: () => string;
+    /** 接受任意非空 locale；纯编译层不会自行读取浏览器 locale。 */
+    locale?: string;
+    /** 当前 locale 的扁平消息事实，key 与 catalog/message fact 保持一致。 */
+    localeMessages?: Readonly<Record<string, string>>;
+    /** 可选同步解析器；由调用方接入自己的消息仓库，headless 不访问接口。 */
+    resolveLocaleMessage?: HeadlessLocaleMessageResolver;
+}
+export interface CompilePageModelInput {
+    kind: PageKind;
+    root: HeadlessControlNode;
+    /** 调用方可选传入期望版本；任一不匹配都会 fail-closed。 */
+    expectedBuildInfo?: ModelDrivenBuildInfoExpectation;
+}
+export interface ModelBindInfo {
+    controlId: string;
+    type: string;
+    caption: string;
+    fieldType?: string;
+    parentId: string | null;
+    dataBind?: JsonValue;
+    datasourceBind?: JsonValue;
+    props: JsonObject;
+    required?: boolean;
+    maxLength?: number;
+    encrypted?: boolean;
+    encryptedMode?: string;
+}
+export interface CompilePageModelResult {
+    ok: boolean;
+    model?: HeadlessControlNode[];
+    modelBindInfoList?: ModelBindInfo[];
+    diagnostics: ModelDrivenDiagnostic[];
+    buildInfo: ModelDrivenBuildInfo;
+}

package/dist/types/contracts/versions.d.ts

@@ -0,0 +1,16 @@
+/**
+ * model-driven v8 发布列车的 npm 包版本。
+ *
+ * 注意：npm 包版本、页面持久化 schema 版本和纯编译契约版本是三套独立版本，
+ * 不能再通过其中任意一个推断另外两个。
+ */
+export declare const MODEL_DRIVEN_PACKAGE_VERSION: "8.0.0-beta.0";
+/** 当前设计器写入的页面持久化 schema 版本。 */
+export declare const CURRENT_PAGE_SCHEMA_VERSION: "3.16";
+/** Node 纯编译入口的契约版本。 */
+export declare const HEADLESS_COMPILER_CONTRACT_VERSION: "model-driven.headless.v1";
+/** 静态控件目录的文档结构版本。 */
+export declare const CONTROL_CATALOG_SCHEMA_VERSION: "model-driven.control-catalog.v1";
+export type CurrentPageSchemaVersion = typeof CURRENT_PAGE_SCHEMA_VERSION;
+export type HeadlessCompilerContractVersion = typeof HEADLESS_COMPILER_CONTRACT_VERSION;
+export type ControlCatalogSchemaVersion = typeof CONTROL_CATALOG_SCHEMA_VERSION;

package/dist/types/framework/index.d.ts

@@ -404,6 +404,197 @@ export declare class DataSourceBind {
     openAssignDepartment?: boolean;
     constructor(props?: Partial<DataSourceBind>);
 }
+/**
+ * 业务行动绑定配置
+ * @public
+ */
+export declare class ActionSourceBind {
+    /**
+     * 应用Id
+     * @defaultValue ''
+     * @public
+     */
+    appId: string;
+    /**
+     * 绑定数据源id
+     * @defaultValue ''
+     * @public
+     */
+    dataCode: string;
+    /**
+     * 业务行动编码
+     * @defaultValue ''
+     * @public
+     */
+    actionCode: string;
+    constructor(props?: Partial<ActionSourceBind>);
+}
+/**
+ * 业务行动服务信息
+ * @public
+ */
+export declare class BizActionServiceName {
+    /**
+     * 业务行动编码
+     * @defaultValue ''
+     * @public
+     */
+    actionCode: string;
+    /**
+     * 数据编码
+     * @defaultValue ''
+     * @public
+     */
+    dataCode: string;
+    /**
+     * 名称
+     * @defaultValue ''
+     * @public
+     */
+    name: string;
+    /**
+     * 应用名称
+     * @defaultValue ''
+     * @public
+     */
+    appName: string;
+    /**
+     * 数据名称
+     * @defaultValue ''
+     * @public
+     */
+    dataName: string;
+    /**
+     * 业务行动名称
+     * @defaultValue ''
+     * @public
+     */
+    actionName: string;
+    /**
+     * 展示名称
+     * @defaultValue ''
+     * @public
+     */
+    displayName: string;
+    /**
+     * 服务类型
+     * @defaultValue ''
+     * @public
+     */
+    svcTypeEnum: string;
+    constructor(props?: Partial<BizActionServiceName>);
+}
+/**
+ * 业务行动右值变量
+ * @public
+ */
+export declare class BizActionRightVariable {
+    /**
+     * 变量类型
+     * @defaultValue 'custom'
+     * @public
+     */
+    type: 'form' | 'system' | 'custom' | 'gv';
+    /**
+     * 变量值
+     * @defaultValue []
+     * @public
+     */
+    value: Array<string | number>;
+    /**
+     * 展示对象
+     * @defaultValue []
+     * @public
+     */
+    displayBos: Record<string, unknown>[];
+    constructor(props?: Partial<BizActionRightVariable>);
+}
+/**
+ * 业务行动入参
+ * @public
+ */
+export declare class BizActionInputParam {
+    /**
+     * 参数ID
+     * @defaultValue ''
+     * @public
+     */
+    id: string;
+    /**
+     * 参数名称
+     * @defaultValue ''
+     * @public
+     */
+    name: string;
+    /**
+     * 是否必填
+     * @defaultValue false
+     * @public
+     */
+    required: boolean;
+    /**
+     * 参数类型
+     * @defaultValue ''
+     * @public
+     */
+    paramType: string;
+    /**
+     * 参数右值变量
+     * @defaultValue new BizActionRightVariable()
+     * @public
+     */
+    rightVariableBo: BizActionRightVariable;
+    /**
+     * Child params for object/list_object action params.
+     * @public
+     */
+    children?: BizActionInputParam[];
+    constructor(props?: Partial<BizActionInputParam>);
+}
+/**
+ * 业务行动配置
+ * @public
+ */
+export declare class BizActionObject {
+    /**
+     * 服务信息
+     * @defaultValue new BizActionServiceName()
+     * @public
+     */
+    serviceName: BizActionServiceName;
+    /**
+     * 入参列表
+     * @defaultValue []
+     * @public
+     */
+    inputParam: BizActionInputParam[];
+    constructor(props?: Partial<BizActionObject>);
+}
+/**
+ * 操作行动项配置
+ * @public
+ */
+export declare class ActionObject {
+    /**
+     * 行动编码
+     * @defaultValue ''
+     * @public
+     */
+    actionCode: string;
+    /**
+     * 行动类型
+     * @defaultValue ''
+     * @public
+     */
+    actionType: string;
+    /**
+     * 业务行动配置
+     * @defaultValue new BizActionObject()
+     * @public
+     */
+    bizAction: BizActionObject;
+    constructor(props?: Partial<ActionObject>);
+}
 export declare class SelectedContentConfig {
     /**
      * 展示已选内容
@@ -910,6 +1101,10 @@ export declare class OptObject {
      * @public
      */
     optType: string;
+    /**
+     * @description 操作项构造函数
+     * @param props
+     */
     constructor(props?: Partial<OptObject>);
 }
 export declare class RowStyleRule {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@byteluck-fe/model-driven-core",
-  "version": "7.0.0-props.94",
+  "version": "8.0.0-beta.0",
   "description": "model engine core",
   "author": "郝晨光 <2293885211@qq.com>",
   "homepage": "",
@@ -8,7 +8,29 @@
   "main": "dist/esm/index.js",
   "module": "dist/esm/index.js",
   "umd": "dist/index.umd.js",
-  "types": "dist/types",
+  "types": "dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "default": "./dist/esm/index.js"
+    },
+    "./contracts": {
+      "types": "./dist/types/contracts/index.d.ts",
+      "import": "./dist/contracts/index.mjs",
+      "require": "./dist/contracts/index.js",
+      "default": "./dist/contracts/index.js"
+    },
+    "./dist/index.umd.js": "./dist/index.umd.js",
+    "./package.json": "./package.json"
+  },
+  "typesVersions": {
+    "*": {
+      "contracts": [
+        "dist/types/contracts/index.d.ts"
+      ]
+    }
+  },
   "files": [
     "bin",
     "dist",
@@ -22,13 +44,13 @@
     "compiler": "tsc --emitDeclarationOnly && swc src -d dist/esm -C jsc.target=es5 -D",
     "cleanup": "rimraf ./dist",
     "prepublish": "npm run cleanup && npm run compiler && npm run build",
-    "build": "rollup -c",
+    "build": "rollup -c && rollup -c rollup-subpath.config.js",
     "postpublish": "node ../../scripts/postpublish.js"
   },
   "dependencies": {
-    "@byteluck-fe/model-driven-shared": "7.0.0-props.94",
+    "@byteluck-fe/model-driven-shared": "8.0.0-beta.0",
     "async-validator": "3.5.1",
     "tslib": "^2.1.0"
   },
-  "gitHead": "8e84ad7af5b54bc8621a0d85de2083f830bafc0c"
+  "gitHead": "5d2e57455ab817172b8697a71d003915eeee906b"
 }