fix: fix some ts error

This commit is contained in:
liujuping 2023-02-27 19:59:54 +08:00 committed by 林熠
parent 65a040390f
commit d8014c9d1a
34 changed files with 454 additions and 302 deletions

View File

@ -20,7 +20,7 @@ module.exports = {
'no-await-in-loop': 0,
'no-plusplus': 0,
'@typescript-eslint/no-parameter-properties': 0,
'@typescript-eslint/no-unused-vars': 1,
'no-restricted-exports': ['error'],
'no-multi-assign': 1,
'no-dupe-class-members': 1,
'react/no-deprecated': 1,

View File

@ -56,7 +56,8 @@ export function buildFilter(rule?: string | string[] | RegExp | IPublicTypeNesti
return (testNode: Node | IPublicTypeNodeSchema) => list.includes(testNode.componentName);
}
export interface IComponentMeta extends IPublicModelComponentMeta {
export interface IComponentMeta extends IPublicModelComponentMeta<INode> {
prototype?: any;
}
export class ComponentMeta implements IComponentMeta {

View File

@ -30,7 +30,7 @@ import { ActiveTracker, IActiveTracker } from './active-tracker';
import { Detecting } from './detecting';
import { DropLocation } from './location';
import { OffsetObserver, createOffsetObserver } from './offset-observer';
import { SettingTopEntry } from './setting';
import { ISettingTopEntry, SettingTopEntry } from './setting';
import { BemToolsManager } from '../builtin-simulator/bem-tools/manager';
import { ComponentActions } from '../component-actions';
@ -61,6 +61,7 @@ export interface DesignerProps {
}
export interface IDesigner {
readonly shellModelFactory: IShellModelFactory;
get dragon(): IPublicModelDragon;
@ -91,6 +92,12 @@ export interface IDesigner {
getComponentMetasMap(): Map<string, IComponentMeta>;
addPropsReducer(reducer: IPublicTypePropsTransducer, stage: IPublicEnumTransformStage): void;
postEvent(event: string, ...args: any[]): void;
transformProps(props: IPublicTypeCompositeObject | IPublicTypePropsList, node: Node, stage: IPublicEnumTransformStage): IPublicTypeCompositeObject | IPublicTypePropsList;
createSettingEntry(nodes: INode[]): ISettingTopEntry;
}
export class Designer implements IDesigner {
@ -331,7 +338,7 @@ export class Designer implements IDesigner {
this.oobxList.forEach((item) => item.compute());
}
createSettingEntry(nodes: Node[]) {
createSettingEntry(nodes: INode[]): ISettingTopEntry {
return new SettingTopEntry(this.editor, nodes);
}

View File

@ -4,8 +4,11 @@ import { IDocumentModel } from '../document/document-model';
import { INode } from '../document/node/node';
const DETECTING_CHANGE_EVENT = 'detectingChange';
export interface IDetecting extends Omit< IPublicModelDetecting, 'capture' | 'release' | 'leave' > {
export interface IDetecting extends Omit< IPublicModelDetecting<INode>,
'capture' |
'release' |
'leave'
> {
capture(node: INode | null): void;
release(node: INode | null): void;

View File

@ -1,7 +1,6 @@
import { INode } from '../document';
import { IDocumentModel, INode } from '../document';
import { ILocateEvent } from './dragon';
import {
IPublicModelDocumentModel,
IPublicModelDropLocation,
IPublicTypeLocationDetailType,
IPublicTypeRect,
@ -105,7 +104,7 @@ export interface IDropLocation extends Omit< IPublicModelDropLocation, 'target'
get target(): INode;
get document(): IPublicModelDocumentModel;
get document(): IDocumentModel | null;
clone(event: IPublicModelLocateEvent): IDropLocation;
}
@ -119,7 +118,7 @@ export class DropLocation implements IDropLocation {
readonly source: string;
get document(): IPublicModelDocumentModel {
get document(): IDocumentModel | null {
return this.target.document;
}
@ -159,7 +158,7 @@ export class DropLocation implements IDropLocation {
if (this.detail.index <= 0) {
return null;
}
return this.target.children.get(this.detail.index - 1);
return this.target.children?.get(this.detail.index - 1);
}
return (this.detail as any)?.near?.node;
}

View File

@ -4,19 +4,22 @@ import { computed, IEventBus, createModuleEventBus } from '@alilc/lowcode-editor
import { SettingEntry } from './setting-entry';
import { SettingField } from './setting-field';
import { SettingPropEntry } from './setting-prop-entry';
import { Node } from '../../document';
import { INode } from '../../document';
import { ComponentMeta } from '../../component-meta';
import { Designer } from '../designer';
import { IDesigner } from '../designer';
import { Setters } from '@alilc/lowcode-shell';
function generateSessionId(nodes: Node[]) {
function generateSessionId(nodes: INode[]) {
return nodes
.map((node) => node.id)
.sort()
.join(',');
}
export class SettingTopEntry implements SettingEntry {
export interface ISettingTopEntry extends SettingEntry {
}
export class SettingTopEntry implements ISettingTopEntry {
private emitter: IEventBus = createModuleEventBus('SettingTopEntry');
private _items: Array<SettingField | IPublicTypeCustomView> = [];
@ -68,21 +71,21 @@ export class SettingTopEntry implements SettingEntry {
readonly id: string;
readonly first: Node;
readonly first: INode;
readonly designer: Designer;
readonly designer: IDesigner | undefined;
readonly setters: Setters;
disposeFunctions: any[] = [];
constructor(readonly editor: IPublicModelEditor, readonly nodes: Node[]) {
constructor(readonly editor: IPublicModelEditor, readonly nodes: INode[]) {
if (!Array.isArray(nodes) || nodes.length < 1) {
throw new ReferenceError('nodes should not be empty');
}
this.id = generateSessionId(nodes);
this.first = nodes[0];
this.designer = this.first.document.designer;
this.designer = this.first.document?.designer;
this.setters = editor.get('setters') as Setters;
// setups
@ -229,7 +232,6 @@ export class SettingTopEntry implements SettingEntry {
this.disposeFunctions = [];
}
getProp(propName: string | number) {
return this.get(propName);
}

View File

@ -1,4 +1,13 @@
import { makeObservable, obx, engineConfig, action, runWithGlobalEventOff, wrapWithEventSwitch, createModuleEventBus, IEventBus } from '@alilc/lowcode-editor-core';
import {
makeObservable,
obx,
engineConfig,
action,
runWithGlobalEventOff,
wrapWithEventSwitch,
createModuleEventBus,
IEventBus,
} from '@alilc/lowcode-editor-core';
import {
IPublicTypeNodeData,
IPublicTypeNodeSchema,
@ -8,20 +17,32 @@ import {
IPublicTypeDragNodeObject,
IPublicTypeDragNodeDataObject,
IPublicModelDocumentModel,
IPublicModelHistory,
IPublicModelNode,
IPublicEnumTransformStage,
IPublicTypeOnChangeOptions,
IPublicTypeDisposable,
} from '@alilc/lowcode-types';
import {
IDropLocation,
} from '@alilc/lowcode-designer';
import {
uniqueId,
isPlainObject,
compatStage,
isJSExpression,
isDOMText,
isNodeSchema,
isDragNodeObject,
isDragNodeDataObject,
isNode,
} from '@alilc/lowcode-utils';
import { IProject, Project } from '../project';
import { ISimulatorHost } from '../simulator';
import { ComponentMeta } from '../component-meta';
import { IDropLocation, Designer, IHistory } from '../designer';
import { Node, insertChildren, insertChild, RootNode, INode } from './node/node';
import { IComponentMeta } from '../component-meta';
import { IDesigner, IHistory } from '../designer';
import { insertChildren, insertChild, RootNode, INode } from './node/node';
import { Selection, ISelection } from './selection';
import { History } from './history';
import { IModalNodesManager, ModalNodesManager } from './node';
import { uniqueId, isPlainObject, compatStage, isJSExpression, isDOMText, isNodeSchema, isDragNodeObject, isDragNodeDataObject, isNode } from '@alilc/lowcode-utils';
import { IModalNodesManager, ModalNodesManager, Node } from './node';
import { EDITOR_EVENT } from '../types';
export type GetDataType<T, NodeType> = T extends undefined
@ -32,21 +53,39 @@ export type GetDataType<T, NodeType> = T extends undefined
: any
: T;
export interface IDocumentModel extends Omit< IPublicModelDocumentModel, 'selection' | 'checkNesting' > {
export interface IDocumentModel extends Omit< IPublicModelDocumentModel<
ISelection,
IHistory,
INode | RootNode,
IDropLocation,
IModalNodesManager,
IProject
>,
'detecting' |
'checkNesting' |
'getNodeById' |
// 以下属性在内部的 document 中不存在
'exportSchema' |
'importSchema' |
'onAddNode' |
'onRemoveNode' |
'onChangeDetecting' |
'onChangeSelection' |
'onMountNode' |
'onChangeNodeProp' |
'onImportSchema' |
'isDetectingNode' |
'onFocusNodeChanged' |
'onDropLocationChanged'
> {
readonly designer: Designer;
readonly designer: IDesigner;
/**
*
*/
readonly selection: ISelection;
get rootNode(): INode | null;
readonly project: IProject;
get simulator(): ISimulatorHost | null;
/**
*
*/
readonly modalNodesManager: IModalNodesManager;
get active(): boolean;
/**
* id
@ -55,16 +94,26 @@ export interface IDocumentModel extends Omit< IPublicModelDocumentModel, 'select
getHistory(): IHistory;
get focusNode(): INode | null;
get rootNode(): INode | null;
checkNesting(
dropTarget: INode,
dragObject: IPublicTypeDragNodeObject | IPublicTypeNodeSchema | INode | IPublicTypeDragNodeDataObject,
): boolean;
getNodeCount(): number;
nextId(possibleId: string | undefined): string;
import(schema: IPublicTypeRootSchema, checkId?: boolean): void;
export(stage: IPublicEnumTransformStage): IPublicTypeRootSchema | undefined;
onNodeCreate(func: (node: INode) => void): IPublicTypeDisposable;
onNodeDestroy(func: (node: INode) => void): IPublicTypeDisposable;
onChangeNodeVisible(fn: (node: INode, visible: boolean) => void): IPublicTypeDisposable;
addWillPurge(node: INode): void;
}
export class DocumentModel implements IDocumentModel {
@ -86,20 +135,20 @@ export class DocumentModel implements IDocumentModel {
/**
*
*/
readonly history: IPublicModelHistory;
readonly history: IHistory;
/**
*
*/
readonly modalNodesManager: IModalNodesManager;
modalNodesManager: IModalNodesManager;
private _nodesMap = new Map<string, IPublicModelNode>();
private _nodesMap = new Map<string, INode>();
readonly project: IProject;
readonly designer: Designer;
readonly designer: IDesigner;
@obx.shallow private nodes = new Set<IPublicModelNode>();
@obx.shallow private nodes = new Set<INode>();
private seqId = 0;
@ -119,7 +168,7 @@ export class DocumentModel implements IDocumentModel {
return this.project.simulator;
}
get nodesMap(): Map<string, Node> {
get nodesMap(): Map<string, INode> {
return this._nodesMap;
}
@ -131,7 +180,7 @@ export class DocumentModel implements IDocumentModel {
this.rootNode?.getExtraProp('fileName', true)?.setValue(fileName);
}
get focusNode(): INode {
get focusNode(): INode | null {
if (this._drillDownNode) {
return this._drillDownNode;
}
@ -142,7 +191,7 @@ export class DocumentModel implements IDocumentModel {
return this.rootNode;
}
@obx.ref private _drillDownNode: Node | null = null;
@obx.ref private _drillDownNode: INode | null = null;
private _modalNode?: INode;
@ -150,7 +199,7 @@ export class DocumentModel implements IDocumentModel {
private inited = false;
@obx.shallow private willPurgeSpace: Node[] = [];
@obx.shallow private willPurgeSpace: INode[] = [];
get modalNode() {
return this._modalNode;
@ -160,7 +209,7 @@ export class DocumentModel implements IDocumentModel {
return this.modalNode || this.focusNode;
}
@obx.shallow private activeNodes?: Node[];
@obx.shallow private activeNodes?: INode[];
@obx.ref private _dropLocation: IDropLocation | null = null;
@ -236,7 +285,7 @@ export class DocumentModel implements IDocumentModel {
// 兼容 vision
this.id = project.getSchema()?.id || this.id;
this.rootNode = this.createNode<RootNode>(
this.rootNode = this.createNode(
schema || {
componentName: 'Page',
id: 'root',
@ -257,11 +306,11 @@ export class DocumentModel implements IDocumentModel {
this.inited = true;
}
drillDown(node: Node | null) {
drillDown(node: INode | null) {
this._drillDownNode = node;
}
onChangeNodeVisible(fn: (node: IPublicModelNode, visible: boolean) => void): () => void {
onChangeNodeVisible(fn: (node: INode, visible: boolean) => void): IPublicTypeDisposable {
this.designer.editor?.eventBus.on(EDITOR_EVENT.NODE_CHILDREN_CHANGE, fn);
return () => {
@ -269,7 +318,7 @@ export class DocumentModel implements IDocumentModel {
};
}
onChangeNodeChildren(fn: (info: IPublicTypeOnChangeOptions) => void): () => void {
onChangeNodeChildren(fn: (info: IPublicTypeOnChangeOptions) => void): IPublicTypeDisposable {
this.designer.editor?.eventBus.on(EDITOR_EVENT.NODE_VISIBLE_CHANGE, fn);
return () => {
@ -277,11 +326,11 @@ export class DocumentModel implements IDocumentModel {
};
}
addWillPurge(node: Node) {
addWillPurge(node: INode) {
this.willPurgeSpace.push(node);
}
removeWillPurge(node: Node) {
removeWillPurge(node: INode) {
const i = this.willPurgeSpace.indexOf(node);
if (i > -1) {
this.willPurgeSpace.splice(i, 1);
@ -295,7 +344,7 @@ export class DocumentModel implements IDocumentModel {
/**
* id
*/
nextId(possibleId: string | undefined) {
nextId(possibleId: string | undefined): string {
let id = possibleId;
while (!id || this.nodesMap.get(id)) {
id = `node_${(String(this.id).slice(-10) + (++this.seqId).toString(36)).toLocaleLowerCase()}`;
@ -330,7 +379,7 @@ export class DocumentModel implements IDocumentModel {
* schema
*/
@action
createNode<T extends Node = Node, C = undefined>(data: GetDataType<C, T>, checkId: boolean = true): T {
createNode<T extends INode = INode, C = undefined>(data: GetDataType<C, T>, checkId: boolean = true): T {
let schema: any;
if (isDOMText(data) || isJSExpression(data)) {
schema = {
@ -341,7 +390,7 @@ export class DocumentModel implements IDocumentModel {
schema = data;
}
let node: Node | null = null;
let node: INode | null = null;
if (this.hasNode(schema?.id)) {
schema.id = null;
}
@ -373,30 +422,30 @@ export class DocumentModel implements IDocumentModel {
return node as any;
}
public destroyNode(node: Node) {
public destroyNode(node: INode) {
this.emitter.emit('nodedestroy', node);
}
/**
*
*/
insertNode(parent: INode, thing: Node | IPublicTypeNodeData, at?: number | null, copy?: boolean): Node {
insertNode(parent: INode, thing: INode | IPublicTypeNodeData, at?: number | null, copy?: boolean): INode {
return insertChild(parent, thing, at, copy);
}
/**
*
*/
insertNodes(parent: INode, thing: Node[] | IPublicTypeNodeData[], at?: number | null, copy?: boolean) {
insertNodes(parent: INode, thing: INode[] | IPublicTypeNodeData[], at?: number | null, copy?: boolean) {
return insertChildren(parent, thing, at, copy);
}
/**
*
*/
removeNode(idOrNode: string | Node) {
removeNode(idOrNode: string | INode) {
let id: string;
let node: Node | null;
let node: INode | null;
if (typeof idOrNode === 'string') {
id = idOrNode;
node = this.getNode(id);
@ -413,14 +462,14 @@ export class DocumentModel implements IDocumentModel {
/**
*
*/
internalRemoveAndPurgeNode(node: Node, useMutator = false) {
internalRemoveAndPurgeNode(node: INode, useMutator = false) {
if (!this.nodes.has(node)) {
return;
}
node.remove(useMutator);
}
unlinkNode(node: Node) {
unlinkNode(node: INode) {
this.nodes.delete(node);
this._nodesMap.delete(node.id);
}
@ -428,7 +477,7 @@ export class DocumentModel implements IDocumentModel {
/**
*
*/
wrapWith(schema: IPublicTypeNodeSchema): Node | null {
wrapWith(schema: IPublicTypeNodeSchema): INode | null {
const nodes = this.selection.getTopNodes();
if (nodes.length < 1) {
return null;
@ -465,17 +514,17 @@ export class DocumentModel implements IDocumentModel {
});
}
export(stage: IPublicEnumTransformStage = IPublicEnumTransformStage.Serilize) {
export(stage: IPublicEnumTransformStage = IPublicEnumTransformStage.Serilize): IPublicTypeRootSchema | undefined {
stage = compatStage(stage);
// 置顶只作用于 Page 的第一级子节点,目前还用不到里层的置顶;如果后面有需要可以考虑将这段写到 node-children 中的 export
const currentSchema = this.rootNode?.export(stage);
if (Array.isArray(currentSchema?.children) && currentSchema?.children.length > 0) {
const FixedTopNodeIndex = currentSchema.children
const currentSchema = this.rootNode?.export<IPublicTypeRootSchema>(stage);
if (Array.isArray(currentSchema?.children) && currentSchema?.children?.length && currentSchema?.children?.length > 0) {
const FixedTopNodeIndex = currentSchema?.children
.filter(i => isPlainObject(i))
.findIndex((i => (i as IPublicTypeNodeSchema).props?.__isTopFixed__));
if (FixedTopNodeIndex > 0) {
const FixedTopNode = currentSchema.children.splice(FixedTopNodeIndex, 1);
currentSchema.children.unshift(FixedTopNode[0]);
const FixedTopNode = currentSchema?.children.splice(FixedTopNodeIndex, 1);
currentSchema?.children.unshift(FixedTopNode[0]);
}
}
return currentSchema;
@ -504,7 +553,7 @@ export class DocumentModel implements IDocumentModel {
return this.simulator!.getComponent(componentName);
}
getComponentMeta(componentName: string): ComponentMeta {
getComponentMeta(componentName: string): IComponentMeta {
return this.designer.getComponentMeta(
componentName,
() => this.simulator?.generateComponentMetadata(componentName) || null,
@ -579,10 +628,10 @@ export class DocumentModel implements IDocumentModel {
dropTarget: INode,
dragObject: IPublicTypeDragNodeObject | IPublicTypeNodeSchema | INode | IPublicTypeDragNodeDataObject,
): boolean {
let items: Array<Node | IPublicTypeNodeSchema>;
let items: Array<INode | IPublicTypeNodeSchema>;
if (isDragNodeDataObject(dragObject)) {
items = Array.isArray(dragObject.data) ? dragObject.data : [dragObject.data];
} else if (isDragNodeObject(dragObject)) {
} else if (isDragNodeObject<INode>(dragObject)) {
items = dragObject.nodes;
} else if (isNode(dragObject) || isNodeSchema(dragObject)) {
items = [dragObject];
@ -599,11 +648,13 @@ export class DocumentModel implements IDocumentModel {
* Use checkNesting method instead.
*/
checkDropTarget(dropTarget: INode, dragObject: IPublicTypeDragNodeObject | IPublicTypeDragNodeDataObject): boolean {
let items: Array<Node | IPublicTypeNodeSchema>;
let items: Array<INode | IPublicTypeNodeSchema>;
if (isDragNodeDataObject(dragObject)) {
items = Array.isArray(dragObject.data) ? dragObject.data : [dragObject.data];
} else {
} else if (isDragNodeObject<INode>(dragObject)) {
items = dragObject.nodes;
} else {
return false;
}
return items.every((item) => this.checkNestingUp(dropTarget, item));
}
@ -611,7 +662,7 @@ export class DocumentModel implements IDocumentModel {
/**
* parentWhitelist
*/
checkNestingUp(parent: INode, obj: IPublicTypeNodeSchema | Node): boolean {
checkNestingUp(parent: INode, obj: IPublicTypeNodeSchema | INode): boolean {
if (isNode(obj) || isNodeSchema(obj)) {
const config = isNode(obj) ? obj.componentMeta : this.getComponentMeta(obj.componentName);
if (config) {
@ -625,7 +676,7 @@ export class DocumentModel implements IDocumentModel {
/**
* childWhitelist
*/
checkNestingDown(parent: INode, obj: IPublicTypeNodeSchema | Node): boolean {
checkNestingDown(parent: INode, obj: IPublicTypeNodeSchema | INode): boolean {
const config = parent.componentMeta;
return config.checkNestingDown(parent, obj);
}
@ -666,7 +717,9 @@ export class DocumentModel implements IDocumentModel {
*/
/* istanbul ignore next */
exportAddonData() {
const addons = {};
const addons: {
[key: string]: any;
} = {};
this._addons.forEach((addon) => {
const data = addon.exportData();
if (data === null) {

View File

@ -1,9 +1,9 @@
import { INode, Node } from './node';
import { INode } from './node';
import { DocumentModel } from '../document-model';
import { IPublicModelModalNodesManager } from '@alilc/lowcode-types';
import { createModuleEventBus, IEventBus } from '@alilc/lowcode-editor-core';
export function getModalNodes(node: INode | Node) {
export function getModalNodes(node: INode) {
if (!node) return [];
let nodes: any = [];
if (node.componentMeta.isModal) {
@ -18,11 +18,7 @@ export function getModalNodes(node: INode | Node) {
return nodes;
}
export interface IModalNodesManager extends IPublicModelModalNodesManager {
getModalNodes(): INode[];
getVisibleModalNode(): INode | null;
export interface IModalNodesManager extends IPublicModelModalNodesManager<INode> {
}
export class ModalNodesManager implements IModalNodesManager {

View File

@ -10,7 +10,12 @@ export interface IOnChangeOptions {
node: Node;
}
export interface INodeChildren extends Omit<IPublicModelNodeChildren, 'forEach' | 'map' | 'every' | 'some' | 'filter' | 'find' | 'reduce' | 'mergeChildren' > {
export interface INodeChildren extends Omit<IPublicModelNodeChildren<INode>,
'importSchema' |
'exportSchema' |
'isEmpty' |
'notEmpty'
> {
get owner(): INode;
unlinkChild(node: INode): void;
@ -42,31 +47,17 @@ export interface INodeChildren extends Omit<IPublicModelNodeChildren, 'forEach'
forEach(fn: (item: INode, index: number) => void): void;
map<T>(fn: (item: INode, index: number) => T): T[] | null;
every(fn: (item: INode, index: number) => any): boolean;
some(fn: (item: INode, index: number) => any): boolean;
filter(fn: (item: INode, index: number) => any): any;
find(fn: (item: INode, index: number) => boolean): any;
reduce(fn: (acc: any, cur: INode) => any, initialValue: any): void;
reverse(): INode[];
mergeChildren(
remover: (node: INode, idx: number) => boolean,
adder: (children: INode[]) => IPublicTypeNodeData[] | null,
sorter: (firstNode: INode, secondNode: INode) => number,
): any;
/**
*
*/
get(index: number): INode | null;
isEmpty(): boolean;
notEmpty(): boolean;
internalInitParent(): void;
/** overriding methods end */
}
export class NodeChildren implements INodeChildren {
@ -140,12 +131,12 @@ export class NodeChildren implements INodeChildren {
const child = originChildren[i];
const item = data[i];
let node: Node | undefined;
let node: INode | undefined | null;
if (isNodeSchema(item) && !checkId && child && child.componentName === item.componentName) {
node = child;
node.import(item);
} else {
node = this.owner.document.createNode(item, checkId);
node = this.owner.document?.createNode(item, checkId);
}
children[i] = node;
}
@ -436,7 +427,7 @@ export class NodeChildren implements INodeChildren {
return this.children.filter(fn);
}
find(fn: (item: INode, index: number) => boolean) {
find(fn: (item: INode, index: number) => boolean): INode | undefined {
return this.children.find(fn);
}
@ -471,7 +462,7 @@ export class NodeChildren implements INodeChildren {
const items = adder(this.children);
if (items && items.length > 0) {
items.forEach((child: IPublicTypeNodeData) => {
const node = this.owner.document?.createNode(child);
const node: INode = this.owner.document?.createNode(child);
this.children.push(node);
node.internalSetParent(this.owner);
});

View File

@ -16,9 +16,10 @@ import {
IPublicModelExclusiveGroup,
IPublicEnumTransformStage,
IPublicTypeDisposable,
IBaseModelNode,
} from '@alilc/lowcode-types';
import { compatStage, isDOMText, isJSExpression, isNode } from '@alilc/lowcode-utils';
import { SettingTopEntry } from '@alilc/lowcode-designer';
import { ISettingTopEntry, SettingTopEntry } from '@alilc/lowcode-designer';
import { Props, getConvertedExtraKey, IProps } from './props/props';
import { DocumentModel, IDocumentModel } from '../document-model';
import { NodeChildren, INodeChildren } from './node-children';
@ -36,28 +37,38 @@ export interface NodeStatus {
inPlaceEditing: boolean;
}
export interface INode extends IPublicModelNode {
/**
*
*/
get children(): INodeChildren | null;
/**
*
*/
get prevSibling(): INode | null;
/**
*
*/
get nextSibling(): INode | null;
/**
*
*/
get parent(): INode | null;
export interface INode extends Omit<IBaseModelNode<
IDocumentModel,
INode,
INodeChildren,
IComponentMeta,
ISettingTopEntry
>,
'slots' |
'slotFor' |
'props' |
'getProp' |
'getExtraProp' |
'replaceChild' |
'isRoot' |
'isPage' |
'isComponent' |
'isModal' |
'isSlot' |
'isParental' |
'isLeaf' |
'settingEntry' |
// 在内部的 node 模型中不存在
'getExtraPropValue' |
'setExtraPropValue' |
'exportSchema' |
'visible' |
'importSchema' |
'isEmptyNode' |
// 内外实现有差异
'isContainer' |
'isEmpty'
> {
get slots(): INode[];
/**
@ -69,7 +80,9 @@ export interface INode extends IPublicModelNode {
get componentMeta(): IComponentMeta;
get document(): IDocumentModel;
get settingEntry(): SettingTopEntry;
get isPurged(): boolean;
setVisible(flag: boolean): void;
@ -79,7 +92,7 @@ export interface INode extends IPublicModelNode {
* 使
* @param useMutator
*/
internalSetParent(parent: INode | null, useMutator: boolean): void;
internalSetParent(parent: INode | null, useMutator?: boolean): void;
setConditionGroup(grp: IPublicModelExclusiveGroup | string | null): void;
@ -89,12 +102,10 @@ export interface INode extends IPublicModelNode {
unlinkSlot(slotNode: Node): void;
didDropOut(dragment: Node): void;
/**
* schema
*/
export(stage: IPublicEnumTransformStage, options?: any): IPublicTypeNodeSchema;
export<T = IPublicTypeNodeSchema>(stage: IPublicEnumTransformStage, options?: any): T;
emitPropChange(val: IPublicTypePropChangeOptions): void;
@ -117,6 +128,38 @@ export interface INode extends IPublicModelNode {
onChildrenChange(fn: (param?: { type: string; node: INode }) => void): IPublicTypeDisposable;
onPropChange(func: (info: IPublicTypePropChangeOptions) => void): IPublicTypeDisposable;
isModal(): boolean;
isRoot(): boolean;
isPage(): boolean;
isComponent(): boolean;
isSlot(): boolean;
isParental(): boolean;
isLeaf(): boolean;
isContainer(): boolean;
isEmpty(): boolean;
remove(
useMutator?: boolean,
purge?: boolean,
options?: NodeRemoveOptions,
): void;
didDropIn(dragment: Node): void;
didDropOut(dragment: Node): void;
get isPurging(): boolean;
purge(): void;
}
/**
@ -251,9 +294,9 @@ export class Node<Schema extends IPublicTypeNodeSchema = IPublicTypeNodeSchema>
isInited = false;
_settingEntry: SettingTopEntry;
_settingEntry: ISettingTopEntry;
get settingEntry(): SettingTopEntry {
get settingEntry(): ISettingTopEntry {
if (this._settingEntry) return this._settingEntry;
this._settingEntry = this.document.designer.createSettingEntry([this]);
return this._settingEntry;
@ -319,7 +362,7 @@ export class Node<Schema extends IPublicTypeNodeSchema = IPublicTypeNodeSchema>
pseudo: false,
};
constructor(readonly document: IDocumentModel, nodeSchema: Schema, options: any = {}) {
constructor(readonly document: IDocumentModel, nodeSchema: Schema) {
makeObservable(this);
const { componentName, id, children, props, ...extras } = nodeSchema;
this.id = document.nextId(id);
@ -347,7 +390,7 @@ export class Node<Schema extends IPublicTypeNodeSchema = IPublicTypeNodeSchema>
this.onVisibleChange((visible: boolean) => {
editor?.eventBus.emit(EDITOR_EVENT.NODE_VISIBLE_CHANGE, this, visible);
});
this.onChildrenChange((info?: { type: string; node: Node }) => {
this.onChildrenChange((info?: { type: string; node: INode }) => {
editor?.eventBus.emit(EDITOR_EVENT.NODE_VISIBLE_CHANGE, info);
});
}
@ -475,7 +518,7 @@ export class Node<Schema extends IPublicTypeNodeSchema = IPublicTypeNodeSchema>
this.document.addWillPurge(this);
}
private didDropIn(dragment: Node) {
didDropIn(dragment: Node) {
const { callbacks } = this.componentMeta.advanced;
if (callbacks?.onNodeAdd) {
const cbThis = this.internalToShellNode();
@ -486,7 +529,7 @@ export class Node<Schema extends IPublicTypeNodeSchema = IPublicTypeNodeSchema>
}
}
private didDropOut(dragment: Node) {
didDropOut(dragment: Node) {
const { callbacks } = this.componentMeta.advanced;
if (callbacks?.onNodeRemove) {
const cbThis = this.internalToShellNode();
@ -869,7 +912,7 @@ export class Node<Schema extends IPublicTypeNodeSchema = IPublicTypeNodeSchema>
/**
* schema
*/
export(stage: IPublicEnumTransformStage = IPublicEnumTransformStage.Save, options: any = {}): Schema {
export<T = IPublicTypeNodeSchema>(stage: IPublicEnumTransformStage = IPublicEnumTransformStage.Save, options: any = {}): T {
stage = compatStage(stage);
const baseSchema: any = {
componentName: this.componentName,
@ -955,7 +998,7 @@ export class Node<Schema extends IPublicTypeNodeSchema = IPublicTypeNodeSchema>
/**
* Slot节点
*/
removeSlot(slotNode: Node, purge = false): boolean {
removeSlot(slotNode: Node): boolean {
// if (purge) {
// // should set parent null
// slotNode?.internalSetParent(null, false);
@ -1047,16 +1090,16 @@ export class Node<Schema extends IPublicTypeNodeSchema = IPublicTypeNodeSchema>
return this.componentName;
}
insert(node: Node, ref?: Node, useMutator = true) {
insert(node: Node, ref?: INode, useMutator = true) {
this.insertAfter(node, ref, useMutator);
}
insertBefore(node: Node, ref?: Node, useMutator = true) {
insertBefore(node: INode, ref?: INode, useMutator = true) {
const nodeInstance = ensureNode(node, this.document);
this.children?.internalInsert(nodeInstance, ref ? ref.index : null, useMutator);
}
insertAfter(node: any, ref?: Node, useMutator = true) {
insertAfter(node: any, ref?: INode, useMutator = true) {
const nodeInstance = ensureNode(node, this.document);
this.children?.internalInsert(nodeInstance, ref ? ref.index + 1 : null, useMutator);
}
@ -1085,15 +1128,15 @@ export class Node<Schema extends IPublicTypeNodeSchema = IPublicTypeNodeSchema>
return this.props;
}
onChildrenChange(fn: (param?: { type: string; node: Node }) => void): IPublicTypeDisposable {
onChildrenChange(fn: (param?: { type: string; node: INode }) => void): IPublicTypeDisposable {
const wrappedFunc = wrapWithEventSwitch(fn);
return this.children?.onChange(wrappedFunc);
}
mergeChildren(
remover: () => any,
adder: (children: Node[]) => IPublicTypeNodeData[] | null,
sorter: () => any,
remover: (node: INode, idx: number) => any,
adder: (children: INode[]) => IPublicTypeNodeData[] | null,
sorter: (firstNode: INode, secondNode: INode) => any,
) {
this.children?.mergeChildren(remover, adder, sorter);
}

View File

@ -2,7 +2,7 @@ import { untracked, computed, obx, engineConfig, action, makeObservable, mobx, r
import { IPublicTypeCompositeValue, GlobalEvent, IPublicTypeJSSlot, IPublicTypeSlotSchema, IPublicEnumTransformStage, IPublicModelProp } from '@alilc/lowcode-types';
import { uniqueId, isPlainObject, hasOwnProperty, compatStage, isJSExpression, isJSSlot } from '@alilc/lowcode-utils';
import { valueToSource } from './value-to-source';
import { Props, IProps, IPropParent } from './props';
import { IProps, IPropParent } from './props';
import { SlotNode, INode } from '../node';
// import { TransformStage } from '../transform-stage';
@ -13,7 +13,7 @@ export type UNSET = typeof UNSET;
export interface IProp extends Omit<IPublicModelProp, 'exportSchema' | 'node' | 'slotNode' > {
readonly props: Props;
readonly props: IProps;
readonly owner: INode;
@ -24,6 +24,8 @@ export interface IProp extends Omit<IPublicModelProp, 'exportSchema' | 'node' |
export(stage: IPublicEnumTransformStage): IPublicTypeCompositeValue;
getNode(): INode;
getAsString(): string;
}
export type ValueTypes = 'unset' | 'literal' | 'map' | 'list' | 'expression' | 'slot';
@ -43,7 +45,7 @@ export class Prop implements IProp, IPropParent {
*/
@obx spread: boolean;
readonly props: Props;
readonly props: IProps;
readonly options: any;

View File

@ -1,8 +1,8 @@
import { computed, makeObservable, obx, action } from '@alilc/lowcode-editor-core';
import { IPublicTypePropsMap, IPublicTypePropsList, IPublicTypeCompositeValue, IPublicEnumTransformStage, IPublicModelProps } from '@alilc/lowcode-types';
import { IPublicTypePropsMap, IPublicTypePropsList, IPublicTypeCompositeValue, IPublicEnumTransformStage, IBaseModelProps } from '@alilc/lowcode-types';
import { uniqueId, compatStage } from '@alilc/lowcode-utils';
import { Prop, IProp, UNSET } from './prop';
import { INode, Node } from '../node';
import { INode } from '../node';
// import { TransformStage } from '../transform-stage';
interface ExtrasObject {
@ -34,18 +34,24 @@ export interface IPropParent {
delete(prop: Prop): void;
query(path: string, createIfNone: boolean): Prop | null;
}
export interface IProps extends Omit<IPublicModelProps, 'getProp' | 'getExtraProp' | 'getExtraPropValue' | 'setExtraPropValue' | 'node'> {
export interface IProps extends Omit<IBaseModelProps<IProp>, | 'getExtraProp' | 'getExtraPropValue' | 'setExtraPropValue' | 'node'> {
/**
* props node
*/
getNode(): INode;
getProp(path: string): IProp | null;
get(path: string, createIfNone?: boolean): Prop | null;
get(path: string, createIfNone: boolean): Prop;
export(stage?: IPublicEnumTransformStage): {
props?: IPublicTypePropsMap | IPublicTypePropsList;
extras?: ExtrasObject;
};
merge(value: IPublicTypePropsMap, extras?: IPublicTypePropsMap): void;
}
export class Props implements IProps, IPropParent {

View File

@ -1,20 +1,10 @@
import { obx, makeObservable, IEventBus, createModuleEventBus } from '@alilc/lowcode-editor-core';
import { Node, INode, comparePosition, PositionNO } from './node/node';
import { INode, comparePosition, PositionNO } from './node/node';
import { DocumentModel } from './document-model';
import { IPublicModelSelection } from '@alilc/lowcode-types';
export interface ISelection extends Omit< IPublicModelSelection, 'getNodes' | 'getTopNodes' > {
export interface ISelection extends Omit<IPublicModelSelection<INode>, 'node'> {
/**
*
* @returns
*/
getNodes(): INode[];
/**
*
*/
getTopNodes(includeRoot?: boolean): INode[];
}
export class Selection implements ISelection {
@ -115,7 +105,7 @@ export class Selection implements ISelection {
/**
*
*/
containsNode(node: Node, excludeRoot = false) {
containsNode(node: INode, excludeRoot = false) {
for (const id of this._selected) {
const parent = this.doc.getNode(id);
if (excludeRoot && parent?.contains(this.doc.focusNode)) {
@ -131,8 +121,8 @@ export class Selection implements ISelection {
/**
*
*/
getNodes(): Node[] {
const nodes = [];
getNodes(): INode[] {
const nodes: INode[] = [];
for (const id of this._selected) {
const node = this.doc.getNode(id);
if (node) {

View File

@ -12,13 +12,31 @@ import {
import { isLowCodeComponentType, isProCodeComponentType } from '@alilc/lowcode-utils';
import { ISimulatorHost } from '../simulator';
export interface IProject extends Omit< IPublicApiProject, 'simulatorHost' | 'importSchema' | 'exportSchema' | 'openDocument' | 'getDocumentById' | 'getCurrentDocument' | 'addPropsTransducer' | 'onRemoveDocument' | 'onChangeDocument' | 'onSimulatorHostReady' | 'onSimulatorRendererReady' | 'setI18n' > {
export interface IProject extends Omit< IPublicApiProject,
'simulatorHost' |
'importSchema' |
'exportSchema' |
'openDocument' |
'getDocumentById' |
'getCurrentDocument' |
'addPropsTransducer' |
'onRemoveDocument' |
'onChangeDocument' |
'onSimulatorHostReady' |
'onSimulatorRendererReady' |
'setI18n' |
'currentDocument' |
'selection' |
'documents' |
'createDocument' |
'getDocumentByFileName'
> {
get designer(): IDesigner;
get simulator(): ISimulatorHost | null;
get currentDocument(): IDocumentModel | null;
get currentDocument(): IDocumentModel | null | undefined;
get documents(): IDocumentModel[];
@ -60,6 +78,8 @@ export interface IProject extends Omit< IPublicApiProject, 'simulatorHost' | 'im
// eslint-disable-next-line @typescript-eslint/no-unused-vars
value: any,
): void;
checkExclusive(activeDoc: DocumentModel): void;
}
export class Project implements IProject {
@ -85,7 +105,7 @@ export class Project implements IProject {
return this._simulator || null;
}
@computed get currentDocument(): IDocumentModel | null {
@computed get currentDocument(): IDocumentModel | null | undefined {
return this.documents.find((doc) => doc.active);
}

View File

@ -2,7 +2,7 @@ import { ComponentType } from 'react';
import { IPublicTypeComponentMetadata, IPublicTypeNodeSchema, IPublicTypeScrollable, IPublicTypeComponentInstance, IPublicModelSensor, IPublicTypeNodeInstance } from '@alilc/lowcode-types';
import { Point, ScrollTarget, ILocateEvent } from './designer';
import { BuiltinSimulatorRenderer } from './builtin-simulator/renderer';
import { Node, INode } from './document';
import { INode } from './document';
export type AutoFit = '100%';
// eslint-disable-next-line no-redeclare
@ -132,7 +132,7 @@ export interface ISimulatorHost<P = object> extends IPublicModelSensor {
/**
*
*/
scrollToNode(node: Node, detail?: any): void;
scrollToNode(node: INode, detail?: any): void;
/**
*
@ -147,7 +147,7 @@ export interface ISimulatorHost<P = object> extends IPublicModelSensor {
/**
*
*/
getComponentInstances(node: Node): IPublicTypeComponentInstance[] | null;
getComponentInstances(node: INode): IPublicTypeComponentInstance[] | null;
/**
* schema
@ -157,11 +157,11 @@ export interface ISimulatorHost<P = object> extends IPublicModelSensor {
/**
*
*/
getComponentContext(node: Node): object | null;
getComponentContext(node: INode): object | null;
getClosestNodeInstance(from: IPublicTypeComponentInstance, specId?: string): IPublicTypeNodeInstance | null;
computeRect(node: Node): DOMRect | null;
computeRect(node: INode): DOMRect | null;
computeComponentInstanceRect(instance: IPublicTypeComponentInstance, selector?: string): DOMRect | null;
@ -189,6 +189,6 @@ export function isSimulatorHost(obj: any): obj is ISimulatorHost {
export type Component = ComponentType<any> | object;
export interface INodeSelector {
node: Node;
node: INode;
instance?: IPublicTypeComponentInstance;
}

View File

@ -21,6 +21,7 @@ import {
IPublicApiCanvas,
IPublicTypeDisposable,
IPublicModelEditor,
IPublicTypeNodeSchema,
} from '@alilc/lowcode-types';
import { isDragNodeObject } from '@alilc/lowcode-utils';
import { Node as ShellNode } from './node';
@ -195,7 +196,7 @@ export class DocumentModel implements IPublicModelDocumentModel {
* @param data
* @returns
*/
createNode(data: any): IPublicModelNode | null {
createNode(data: IPublicTypeNodeSchema): IPublicModelNode | null {
return ShellNode.create(this[documentSymbol].createNode(data));
}
@ -289,7 +290,7 @@ export class DocumentModel implements IPublicModelDocumentModel {
* @param fn
*/
onChangeNodeVisible(fn: (node: IPublicModelNode, visible: boolean) => void): IPublicTypeDisposable {
return this[documentSymbol].onChangeNodeVisible((node: IPublicModelNode, visible: boolean) => {
return this[documentSymbol].onChangeNodeVisible((node: InnerNode, visible: boolean) => {
fn(ShellNode.create(node)!, visible);
});
}

View File

@ -362,9 +362,9 @@ export class Node implements IPublicModelNode {
* @param sorter
*/
mergeChildren(
remover: (node: IPublicModelNode, idx: number) => boolean,
adder: (children: IPublicModelNode[]) => any,
sorter: (firstNode: IPublicModelNode, secondNode: IPublicModelNode) => number,
remover: (node: Node, idx: number) => boolean,
adder: (children: Node[]) => any,
sorter: (firstNode: Node, secondNode: Node) => number,
): any {
return this.children?.mergeChildren(remover, adder, sorter);
}

View File

@ -1,14 +1,14 @@
import {
IDocumentModel as InnerDocumentModel,
INode as InnerNode,
ISelection as InnerSelection,
ISelection,
} from '@alilc/lowcode-designer';
import { Node as ShellNode } from './node';
import { selectionSymbol } from '../symbols';
import { IPublicModelSelection, IPublicModelNode, IPublicTypeDisposable } from '@alilc/lowcode-types';
export class Selection implements IPublicModelSelection {
private readonly [selectionSymbol]: InnerSelection;
private readonly [selectionSymbol]: ISelection;
constructor(document: InnerDocumentModel) {
this[selectionSymbol] = document.selection;

View File

@ -2,7 +2,9 @@ import { IPublicTypeNodeSchema, IPublicTypeNodeData, IPublicTypeIconType, IPubli
import { ReactElement } from 'react';
import { IPublicModelNode } from './node';
export interface IPublicModelComponentMeta {
export interface IPublicModelComponentMeta<
Node = IPublicModelNode
> {
/**
*
@ -92,7 +94,7 @@ export interface IPublicModelComponentMeta {
* @param my
* @param parent
*/
checkNestingUp(my: IPublicModelNode | IPublicTypeNodeData, parent: any): boolean;
checkNestingUp(my: Node | IPublicTypeNodeData, parent: any): boolean;
/**
*
@ -101,8 +103,8 @@ export interface IPublicModelComponentMeta {
* @param parent
*/
checkNestingDown(
my: IPublicModelNode | IPublicTypeNodeData,
target: IPublicTypeNodeSchema | IPublicModelNode | IPublicTypeNodeSchema[],
my: Node | IPublicTypeNodeData,
target: IPublicTypeNodeSchema | Node | IPublicTypeNodeSchema[],
): boolean;
/**

View File

@ -1,7 +1,7 @@
import { IPublicModelNode } from './';
import { IPublicTypeDisposable } from '../type';
export interface IPublicModelDetecting {
export interface IPublicModelDetecting<Node = IPublicModelNode> {
/**
*
@ -15,7 +15,7 @@ export interface IPublicModelDetecting {
* get current hovering node
* @since v1.0.16
*/
get current(): IPublicModelNode | null;
get current(): Node | null;
/**
* hover
@ -42,5 +42,5 @@ export interface IPublicModelDetecting {
* set callback which will be called when hovering object changed.
* @since v1.1.0
*/
onDetectingChange(fn: (node: IPublicModelNode | null) => void): IPublicTypeDisposable;
onDetectingChange(fn: (node: Node | null) => void): IPublicTypeDisposable;
}

View File

@ -2,15 +2,22 @@ import { IPublicTypeRootSchema, IPublicTypeDragNodeDataObject, IPublicTypeDragNo
import { IPublicEnumTransformStage } from '../enum';
import { IPublicApiProject } from '../api';
import { IPublicModelDropLocation, IPublicModelDetecting, IPublicModelNode, IPublicModelSelection, IPublicModelHistory, IPublicModelModalNodesManager } from './';
import { IPublicTypeOnChangeOptions } from '@alilc/lowcode-types';
import { IPublicTypeNodeData, IPublicTypeNodeSchema, IPublicTypeOnChangeOptions } from '@alilc/lowcode-types';
export interface IPublicModelDocumentModel {
export interface IPublicModelDocumentModel<
Selection = IPublicModelSelection,
History = IPublicModelHistory,
Node = IPublicModelNode,
DropLocation = IPublicModelDropLocation,
ModalNodesManager = IPublicModelModalNodesManager,
Project = IPublicApiProject
> {
/**
*
* instance of selection
*/
selection: IPublicModelSelection;
selection: Selection;
/**
* hover
@ -22,7 +29,7 @@ export interface IPublicModelDocumentModel {
*
* instance of history
*/
history: IPublicModelHistory;
history: History;
/**
* id
@ -36,30 +43,30 @@ export interface IPublicModelDocumentModel {
* get project which this documentModel belongs to
* @returns
*/
get project(): IPublicApiProject;
get project(): Project;
/**
*
* root node of this documentModel
* @returns
*/
get root(): IPublicModelNode | null;
get root(): Node | null;
get focusNode(): IPublicModelNode | null;
get focusNode(): Node | null;
set focusNode(node: IPublicModelNode | null);
set focusNode(node: Node | null);
/**
*
* @returns
*/
get nodesMap(): Map<string, IPublicModelNode>;
get nodesMap(): Map<string, Node>;
/**
*
* get instance of modalNodesManager
*/
get modalNodesManager(): IPublicModelModalNodesManager | null;
get modalNodesManager(): ModalNodesManager | null;
/**
* nodeId Node
@ -67,7 +74,7 @@ export interface IPublicModelDocumentModel {
* @param nodeId
* @returns
*/
getNodeById(nodeId: string): IPublicModelNode | null;
getNodeById(nodeId: string): Node | null;
/**
* schema
@ -89,11 +96,11 @@ export interface IPublicModelDocumentModel {
* insert a node
*/
insertNode(
parent: IPublicModelNode,
thing: IPublicModelNode,
parent: Node,
thing: Node | IPublicTypeNodeData,
at?: number | null | undefined,
copy?: boolean | undefined
): IPublicModelNode | null;
): Node | null;
/**
*
@ -101,14 +108,14 @@ export interface IPublicModelDocumentModel {
* @param data
* @returns
*/
createNode(data: any): IPublicModelNode | null;
createNode(data: IPublicTypeNodeSchema): Node | null;
/**
* /id
* remove a node by node instance or nodeId
* @param idOrNode
*/
removeNode(idOrNode: string | IPublicModelNode): void;
removeNode(idOrNode: string | Node): void;
/**
* componentsMap of documentModel
@ -126,7 +133,7 @@ export interface IPublicModelDocumentModel {
* @since v1.0.16
*/
checkNesting(
dropTarget: IPublicModelNode,
dropTarget: Node,
dragObject: IPublicTypeDragNodeObject | IPublicTypeDragNodeDataObject
): boolean;
@ -134,26 +141,26 @@ export interface IPublicModelDocumentModel {
* document
* set callback for event on node is created for a document
*/
onAddNode(fn: (node: IPublicModelNode) => void): IPublicTypeDisposable;
onAddNode(fn: (node: Node) => void): IPublicTypeDisposable;
/**
* document document
* set callback for event on node is mounted to canvas
*/
onMountNode(fn: (payload: { node: IPublicModelNode }) => void): IPublicTypeDisposable;
onMountNode(fn: (payload: { node: Node }) => void): IPublicTypeDisposable;
/**
* document
* set callback for event on node is removed
*/
onRemoveNode(fn: (node: IPublicModelNode) => void): IPublicTypeDisposable;
onRemoveNode(fn: (node: Node) => void): IPublicTypeDisposable;
/**
* document hover
*
* set callback for event on detecting changed
*/
onChangeDetecting(fn: (node: IPublicModelNode) => void): IPublicTypeDisposable;
onChangeDetecting(fn: (node: Node) => void): IPublicTypeDisposable;
/**
* document
@ -166,7 +173,7 @@ export interface IPublicModelDocumentModel {
* set callback for event on visibility changed for certain node
* @param fn
*/
onChangeNodeVisible(fn: (node: IPublicModelNode, visible: boolean) => void): IPublicTypeDisposable;
onChangeNodeVisible(fn: (node: Node, visible: boolean) => void): IPublicTypeDisposable;
/**
* document children
@ -193,21 +200,21 @@ export interface IPublicModelDocumentModel {
* @param node
* @since v1.1.0
*/
isDetectingNode(node: IPublicModelNode): boolean;
isDetectingNode(node: Node): boolean;
/**
* DropLocation
* get current drop location
* @since v1.1.0
*/
get dropLocation(): IPublicModelDropLocation | null;
get dropLocation(): DropLocation | null;
/**
* DropLocation
* set current drop location
* @since v1.1.0
*/
set dropLocation(loc: IPublicModelDropLocation | null);
set dropLocation(loc: DropLocation | null);
/**
*
@ -216,7 +223,7 @@ export interface IPublicModelDocumentModel {
* @since v1.1.0
*/
onFocusNodeChanged(
fn: (doc: IPublicModelDocumentModel, focusNode: IPublicModelNode) => void,
fn: (doc: IPublicModelDocumentModel, focusNode: Node) => void,
): IPublicTypeDisposable;
/**

View File

@ -1,6 +1,6 @@
import { IPublicModelNode } from './';
export interface IPublicModelModalNodesManager {
export interface IPublicModelModalNodesManager<Node = IPublicModelNode> {
/**
*
@ -12,13 +12,13 @@ export interface IPublicModelModalNodesManager {
*
* get modal nodes
*/
getModalNodes(): IPublicModelNode[];
getModalNodes(): Node[];
/**
*
* get current visible modal node
*/
getVisibleModalNode(): IPublicModelNode | null;
getVisibleModalNode(): Node | null;
/**
*
@ -31,12 +31,12 @@ export interface IPublicModelModalNodesManager {
* set specfic model node as visible
* @param node Node
*/
setVisible(node: IPublicModelNode): void;
setVisible(node: Node): void;
/**
*
* set specfic model node as invisible
* @param node Node
*/
setInvisible(node: IPublicModelNode): void;
setInvisible(node: Node): void;
}

View File

@ -2,13 +2,15 @@ import { IPublicTypeNodeSchema, IPublicTypeNodeData } from '../type';
import { IPublicEnumTransformStage } from '../enum';
import { IPublicModelNode } from './';
export interface IPublicModelNodeChildren {
export interface IPublicModelNodeChildren<
Node = IPublicModelNode
> {
/**
* children
* get owner node of this nodeChildren
*/
get owner(): IPublicModelNode | null;
get owner(): Node | null;
/**
* children
@ -45,7 +47,7 @@ export interface IPublicModelNodeChildren {
* delete the node
* @param node
*/
delete(node: IPublicModelNode): boolean;
delete(node: Node): boolean;
/**
*
@ -54,7 +56,7 @@ export interface IPublicModelNodeChildren {
* @param at
* @returns
*/
insert(node: IPublicModelNode, at?: number | null): void;
insert(node: Node, at?: number | null): void;
/**
*
@ -62,7 +64,7 @@ export interface IPublicModelNodeChildren {
* @param node
* @returns
*/
indexOf(node: IPublicModelNode): number;
indexOf(node: Node): number;
/**
* splice
@ -71,7 +73,7 @@ export interface IPublicModelNodeChildren {
* @param deleteCount
* @param node
*/
splice(start: number, deleteCount: number, node?: IPublicModelNode): any;
splice(start: number, deleteCount: number, node?: Node): any;
/**
*
@ -79,7 +81,7 @@ export interface IPublicModelNodeChildren {
* @param index
* @returns
*/
get(index: number): IPublicModelNode | null;
get(index: number): Node | null;
/**
*
@ -87,62 +89,62 @@ export interface IPublicModelNodeChildren {
* @param node
* @returns
*/
has(node: IPublicModelNode): boolean;
has(node: Node): boolean;
/**
* forEach
* provide the same function with {Array.prototype.forEach}
* @param fn
*/
forEach(fn: (node: IPublicModelNode, index: number) => void): void;
forEach(fn: (node: Node, index: number) => void): void;
/**
* reverse
* provide the same function with {Array.prototype.reverse}
*/
reverse(): IPublicModelNode[];
reverse(): Node[];
/**
* map
* provide the same function with {Array.prototype.map}
* @param fn
*/
map<T>(fn: (node: IPublicModelNode, index: number) => T[]): any[] | null;
map<T = any>(fn: (node: Node, index: number) => T): T[] | null;
/**
* every
* provide the same function with {Array.prototype.every}
* @param fn
*/
every(fn: (node: IPublicModelNode, index: number) => boolean): boolean;
every(fn: (node: Node, index: number) => boolean): boolean;
/**
* some
* provide the same function with {Array.prototype.some}
* @param fn
*/
some(fn: (node: IPublicModelNode, index: number) => boolean): boolean;
some(fn: (node: Node, index: number) => boolean): boolean;
/**
* filter
* provide the same function with {Array.prototype.filter}
* @param fn
*/
filter(fn: (node: IPublicModelNode, index: number) => boolean): any;
filter(fn: (node: Node, index: number) => boolean): any;
/**
* find
* provide the same function with {Array.prototype.find}
* @param fn
*/
find(fn: (node: IPublicModelNode, index: number) => boolean): IPublicModelNode | null;
find(fn: (node: Node, index: number) => boolean): Node | null | undefined;
/**
* reduce
* provide the same function with {Array.prototype.reduce}
* @param fn
*/
reduce(fn: (acc: any, cur: IPublicModelNode) => any, initialValue: any): void;
reduce(fn: (acc: any, cur: Node) => any, initialValue: any): void;
/**
* schema
@ -166,9 +168,9 @@ export interface IPublicModelNodeChildren {
* @param sorter
*/
mergeChildren(
remover: (node: IPublicModelNode, idx: number) => boolean,
adder: (children: IPublicModelNode[]) => IPublicTypeNodeData[] | null,
sorter: (firstNode: IPublicModelNode, secondNode: IPublicModelNode) => number
remover: (node: Node, idx: number) => boolean,
adder: (children: Node[]) => IPublicTypeNodeData[] | null,
sorter: (firstNode: Node, secondNode: Node) => number
): any;
}

View File

@ -3,7 +3,13 @@ import { IPublicTypeNodeSchema, IPublicTypeIconType, IPublicTypeI18nData, IPubli
import { IPublicEnumTransformStage } from '../enum';
import { IPublicModelNodeChildren, IPublicModelComponentMeta, IPublicModelProp, IPublicModelProps, IPublicModelSettingTopEntry, IPublicModelDocumentModel, IPublicModelExclusiveGroup } from './';
export interface IPublicModelNode {
export interface IBaseModelNode<
Document = IPublicModelDocumentModel,
Node = IPublicModelNode,
NodeChildren = IPublicModelNodeChildren,
ComponentMeta = IPublicModelComponentMeta,
SettingTopEntry = IPublicModelSettingTopEntry
> {
/**
* id
@ -185,43 +191,43 @@ export interface IPublicModelNode {
*
* get component meta of this node
*/
get componentMeta(): IPublicModelComponentMeta | null;
get componentMeta(): ComponentMeta | null;
/**
*
* get documentModel of this node
*/
get document(): IPublicModelDocumentModel | null;
get document(): Document | null;
/**
*
* get previous sibling of this node
*/
get prevSibling(): IPublicModelNode | null;
get prevSibling(): Node | null;
/**
*
* get next sibling of this node
*/
get nextSibling(): IPublicModelNode | null;
get nextSibling(): Node | null;
/**
*
* get parent of this node
*/
get parent(): IPublicModelNode | null;
get parent(): Node | null;
/**
*
* get children of this node
*/
get children(): IPublicModelNodeChildren | null;
get children(): NodeChildren | null;
/**
*
* get slots of this node
*/
get slots(): IPublicModelNode[];
get slots(): Node[];
/**
*
@ -258,7 +264,7 @@ export interface IPublicModelNode {
* get setting entry of this node
* @since v1.1.0
*/
get settingEntry(): IPublicModelSettingTopEntry;
get settingEntry(): SettingTopEntry;
/**
*
@ -359,8 +365,8 @@ export interface IPublicModelNode {
* @param useMutator
*/
insertBefore(
node: IPublicModelNode,
ref?: IPublicModelNode | undefined,
node: Node,
ref?: Node | undefined,
useMutator?: boolean,
): void;
@ -372,8 +378,8 @@ export interface IPublicModelNode {
* @param useMutator
*/
insertAfter(
node: IPublicModelNode,
ref?: IPublicModelNode | undefined,
node: Node,
ref?: Node | undefined,
useMutator?: boolean,
): void;
@ -384,7 +390,7 @@ export interface IPublicModelNode {
* @param data
* @returns
*/
replaceChild(node: IPublicModelNode, data: any): IPublicModelNode | null;
replaceChild(node: Node, data: any): Node | null;
/**
*
@ -427,9 +433,9 @@ export interface IPublicModelNode {
* @since v1.1.0
*/
mergeChildren(
remover: (node: IPublicModelNode, idx: number) => boolean,
adder: (children: IPublicModelNode[]) => any,
sorter: (firstNode: IPublicModelNode, secondNode: IPublicModelNode) => number
remover: (node: Node, idx: number) => boolean,
adder: (children: Node[]) => any,
sorter: (firstNode: Node, secondNode: Node) => number
): any;
/**
@ -438,7 +444,7 @@ export interface IPublicModelNode {
* @param node
* @since v1.1.0
*/
contains(node: IPublicModelNode): boolean;
contains(node: Node): boolean;
/**
* action
@ -476,3 +482,5 @@ export interface IPublicModelNode {
*/
setConditionalVisible(): void;
}
export interface IPublicModelNode extends IBaseModelNode<IPublicModelDocumentModel, IPublicModelNode> {}

View File

@ -1,7 +1,9 @@
import { IPublicTypeCompositeValue } from '../type';
import { IPublicModelNode, IPublicModelProp } from './';
import { IPublicModelNode } from './';
export interface IPublicModelProps {
export interface IBaseModelProps<
Prop
> {
/**
* id
@ -24,7 +26,7 @@ export interface IPublicModelProps {
* get prop by path
* @param path a / a.b / a.0
*/
getProp(path: string): IPublicModelProp | null;
getProp(path: string): Prop | null;
/**
* path
@ -39,7 +41,7 @@ export interface IPublicModelProps {
* get extra prop by path
* @param path a / a.b / a.0
*/
getExtraProp(path: string): IPublicModelProp | null;
getExtraProp(path: string): Prop | null;
/**
* path
@ -83,3 +85,5 @@ export interface IPublicModelProps {
add(value: IPublicTypeCompositeValue, key?: string | number | undefined): any;
}
export type IPublicModelProps = IBaseModelProps<IPublicModelProps>;

View File

@ -1,7 +1,9 @@
import { IPublicModelNode } from './';
import { IPublicTypeDisposable } from '../type';
export interface IPublicModelSelection {
export interface IPublicModelSelection<
Node = IPublicModelNode
> {
/**
* id
@ -14,7 +16,7 @@ export interface IPublicModelSelection {
* return selected Node instancereturn the first one if multiple nodes are selected
* @since v1.1.0
*/
get node(): IPublicModelNode | null;
get node(): Node | null;
/**
*
@ -62,7 +64,7 @@ export interface IPublicModelSelection {
*
* get selected nodes
*/
getNodes(): IPublicModelNode[];
getNodes(): Node[];
/**
*
@ -72,7 +74,7 @@ export interface IPublicModelSelection {
* getTopNodes() will return [A, B], subA will be removed
* @since v1.0.16
*/
getTopNodes(includeRoot?: boolean): IPublicModelNode[];
getTopNodes(includeRoot?: boolean): Node[];
/**
* selection

View File

@ -1,7 +1,7 @@
import { IPublicModelNode } from '..';
import { IPublicEnumDragObjectType } from '../enum';
export interface IPublicTypeDragNodeObject {
export interface IPublicTypeDragNodeObject<Node = IPublicModelNode> {
type: IPublicEnumDragObjectType.Node;
nodes: IPublicModelNode[];
nodes: Node[];
}

View File

@ -13,7 +13,7 @@ export interface IPublicTypeFieldConfig extends IPublicTypeFieldExtraProps {
/**
* the name of this setting field, which used in quickEditor
*/
name: string | number;
name?: string | number;
/**
* the field title

View File

@ -19,12 +19,12 @@ export interface IPublicTypeFieldExtraProps {
/**
* get value for field
*/
getValue?: (target: IPublicModelSettingTarget, fieldValue: any) => any;
getValue?: (target: IPublicModelSettingPropEntry, fieldValue: any) => any;
/**
* set value for field
*/
setValue?: (target: IPublicModelSettingTarget, value: any) => void;
setValue?: (target: IPublicModelSettingPropEntry, value: any) => void;
/**
* the field conditional show, is not set always true

View File

@ -1,5 +1,5 @@
import { IPublicTypePropType, IPublicTypeComponentAction } from './';
import { IPublicModelProp, IPublicModelSettingTarget } from '../model';
import { IPublicModelNode, IPublicModelProp, IPublicModelSettingTarget } from '../model';
/**
*
@ -184,20 +184,20 @@ export interface ConfigureSupport {
*/
export interface IPublicTypeCallbacks {
// hooks
onMouseDownHook?: (e: MouseEvent, currentNode: any) => any;
onDblClickHook?: (e: MouseEvent, currentNode: any) => any;
onClickHook?: (e: MouseEvent, currentNode: any) => any;
onMouseDownHook?: (e: MouseEvent, currentNode: IPublicModelNode) => any;
onDblClickHook?: (e: MouseEvent, currentNode: IPublicModelNode) => any;
onClickHook?: (e: MouseEvent, currentNode: IPublicModelNode) => any;
// onLocateHook?: (e: any, currentNode: any) => any;
// onAcceptHook?: (currentNode: any, locationData: any) => any;
onMoveHook?: (currentNode: any) => boolean;
onMoveHook?: (currentNode: IPublicModelNode) => boolean;
// thinkof 限制性拖拽
onHoverHook?: (currentNode: any) => boolean;
onChildMoveHook?: (childNode: any, currentNode: any) => boolean;
onHoverHook?: (currentNode: IPublicModelNode) => boolean;
onChildMoveHook?: (childNode: IPublicModelNode, currentNode: IPublicModelNode) => boolean;
// events
onNodeRemove?: (removedNode: any, currentNode: any) => void;
onNodeAdd?: (addedNode: any, currentNode: any) => void;
onSubtreeModified?: (currentNode: any, options: any) => void;
onNodeRemove?: (removedNode: IPublicModelNode, currentNode: IPublicModelNode) => void;
onNodeAdd?: (addedNode: IPublicModelNode, currentNode: IPublicModelNode) => void;
onSubtreeModified?: (currentNode: IPublicModelNode, options: any) => void;
onResize?: (
e: MouseEvent & {
trigger: string;
@ -220,6 +220,6 @@ export interface IPublicTypeCallbacks {
deltaX?: number;
deltaY?: number;
},
currentNode: any,
currentNode: IPublicModelNode,
) => void;
}

View File

@ -6,49 +6,60 @@ import { IPublicTypeDynamicProps } from './dynamic-props';
*
*/
export interface IPublicTypeSetterConfig {
// if *string* passed must be a registered Setter Name
/**
* setter
*/
componentName: string | IPublicTypeCustomView;
/**
* setter
*
* the props pass to Setter Component
*/
props?: Record<string, unknown> | IPublicTypeDynamicProps;
/**
* @deprecated
*/
children?: any;
/**
*
*
* ArraySetter
*/
isRequired?: boolean;
/**
* Setter
*
* @todo initialValue defaultValue
*/
initialValue?: any | ((target: IPublicModelSettingTarget) => any);
defaultValue?: any;
// for MixedSetter
/**
* MixedSetter Setter
*/
title?: IPublicTypeTitleContent;
// for MixedSetter check this is available
/**
* MixedSetter
*/
condition?: (target: IPublicModelSettingTarget) => boolean;
/**
* MixedSetter
*
* @todo
*/
valueType?: IPublicTypeCompositeValue[];
// 标识是否为动态 setter默认为 true
isDynamic?: boolean;
}

View File

@ -1,5 +1,5 @@
import { IPublicEnumDragObjectType } from '@alilc/lowcode-types';
import { IPublicEnumDragObjectType, IPublicTypeDragNodeDataObject } from '@alilc/lowcode-types';
export function isDragNodeDataObject(obj: any): boolean {
export function isDragNodeDataObject(obj: any): obj is IPublicTypeDragNodeDataObject {
return obj && obj.type === IPublicEnumDragObjectType.NodeData;
}

View File

@ -1,5 +1,5 @@
import { IPublicEnumDragObjectType } from '@alilc/lowcode-types';
import { IPublicEnumDragObjectType, IPublicModelNode, IPublicTypeDragNodeObject } from '@alilc/lowcode-types';
export function isDragNodeObject(obj: any): boolean {
export function isDragNodeObject<Node = IPublicModelNode>(obj: any): obj is IPublicTypeDragNodeObject<Node> {
return obj && obj.type === IPublicEnumDragObjectType.Node;
}

View File

@ -1,3 +1,5 @@
export function isNode(node: any): boolean {
import { IPublicModelNode } from '@alilc/lowcode-types';
export function isNode<Node = IPublicModelNode>(node: any): node is Node {
return node && node.isNode;
}