@vtj/core 0.1.2 → 0.7.1

package/types/models/project.d.ts

@@ -0,0 +1,168 @@
+import type { ProjectSchema, Dependencie, PageFile, BlockFile, ApiSchema } from '../protocols';
+import { type ModelEventType } from '../tools';
+export interface ProjectModelEvent {
+    model: ProjectModel;
+    type: ModelEventType;
+    data: any;
+}
+/**
+ * 项目信息更新时触发事件
+ */
+export declare const EVENT_PROJECT_CHANGE = "EVENT_PROJECT_CHANGE";
+/**
+ * 打开/关闭文件时触发事件
+ */
+export declare const EVENT_PROJECT_ACTIVED = "EVENT_PROJECT_ACTIVED";
+/**
+ * 依赖更新时触发
+ */
+export declare const EVENT_PROJECT_DEPS_CHANGE = "EVENT_PROJECT_DEPS_CHANGE";
+/**
+ * 页面文件更新
+ */
+export declare const EVENT_PROJECT_PAGES_CHANGE = "EVENT_PROJECT_PAGES_CHANGE";
+/**
+ * 区块文件更新
+ */
+export declare const EVENT_PROJECT_BLOCKS_CHANGE = "EVENT_PROJECT_BLOCKS_CHANGE";
+/**
+ * API更新
+ */
+export declare const EVENT_PROJECT_APIS_CHANGE = "EVENT_PROJECT_APIS_CHANGE";
+/**
+ * 项目发布
+ */
+export declare const EVENT_PROJECT_PUBLISH = "EVENT_PROJECT_PUBLISH";
+/**
+ * 项目文件发布
+ */
+export declare const EVENT_PROJECT_FILE_PUBLISH = "EVENT_PROJECT_FILE_PUBLISH";
+export declare class ProjectModel {
+    id: string;
+    name: string;
+    description: string;
+    homepage: string;
+    dependencies: Dependencie[];
+    pages: PageFile[];
+    blocks: BlockFile[];
+    apis: ApiSchema[];
+    currentFile: PageFile | BlockFile | null;
+    static attrs: string[];
+    constructor(schema: ProjectSchema);
+    update(schema: Partial<ProjectSchema>, silent?: boolean): void;
+    isPageFile(file: PageFile | BlockFile): file is PageFile;
+    toDsl(): ProjectSchema;
+    /**
+     * 打开文件
+     * @param file
+     * @param silent
+     */
+    active(file: BlockFile | PageFile, silent?: boolean): void;
+    /**
+     * 关闭文件
+     * @param silent
+     */
+    deactivate(silent?: boolean): void;
+    /**
+     * 新增或更新依赖
+     * @param item
+     * @param silent
+     */
+    setDeps(item: Dependencie, silent?: boolean): void;
+    /**
+     * 删除依赖
+     * @param item
+     * @param silent
+     */
+    removeDeps(item: Dependencie, silent?: boolean): void;
+    /**
+     * 根据页面id查找页面或目录
+     * @param id
+     * @returns
+     */
+    getPage(id: string): PageFile | undefined;
+    /**
+     * 查找全部页面，不含目录
+     * @returns
+     */
+    getPages(): PageFile[];
+    /**
+     * 新建页面
+     * @param page
+     * @param parentId
+     * @param silent
+     */
+    createPage(page: PageFile, parentId?: string, silent?: boolean): void;
+    /**
+     * 更新页面
+     * @param page
+     * @param silent
+     */
+    updatePage(page: PageFile, silent?: boolean): void;
+    /**
+     * 复制页面
+     * @param page
+     * @param parentId
+     * @param silent
+     */
+    clonePage(page: PageFile, parentId?: string, silent?: boolean): void;
+    /**
+     * 删除页面或目录
+     * @param id
+     * @param silent
+     */
+    removePage(id: string, silent?: boolean): void;
+    /**
+     * 获取区块文件
+     * @param id
+     * @returns
+     */
+    getBlock(id: string): BlockFile | undefined;
+    /**
+     * 创建区块
+     * @param block
+     * @param silent
+     */
+    createBlock(block: BlockFile, silent?: boolean): void;
+    /**
+     *
+     * @param block 更新区块
+     * @param silent
+     */
+    updateBlock(block: BlockFile, silent?: boolean): void;
+    /**
+     * 删除区块
+     * @param id
+     * @param silent
+     */
+    removeBlock(id: string, silent?: boolean): void;
+    /**
+     * 检查是否存在名称的区块
+     * @param name
+     * @param excludes
+     * @returns
+     */
+    existBlockName(name: string, excludes?: string[]): boolean;
+    /**
+     * 检测是否存在名称的页面
+     * @param name
+     * @param excludes
+     * @returns
+     */
+    existPageName(name: string, excludes?: string[]): boolean;
+    /**
+     * 新增或更新api
+     * @param item
+     * @param silent
+     */
+    setApi(item: ApiSchema, silent?: boolean): void;
+    /**
+     * 删除api
+     * @param name
+     * @param silent
+     */
+    removeApi(name: string, silent?: boolean): void;
+    existApiName(name: string, excludes?: string[]): boolean;
+    setHomepage(id: string, silent?: boolean): void;
+    publish(file?: PageFile | BlockFile): void;
+}

package/types/models/prop.d.ts

@@ -0,0 +1,15 @@
+import type { JSONValue, JSExpression, JSFunction, NodeProps } from '../protocols';
+export declare class PropModel {
+    name: string;
+    value?: JSONValue | JSExpression | JSFunction;
+    defaultValue?: JSONValue | JSExpression | JSFunction;
+    /**
+     * 标识是否设置了值， 设置的值与默认值一致，表示未设置，在转换成dsl时会排查该属性
+     */
+    isUnset: boolean;
+    constructor(name: string, value?: JSONValue | JSExpression | JSFunction, defaultValue?: JSONValue | JSExpression | JSFunction);
+    setValue(value: JSONValue | JSExpression | JSFunction): void;
+    getValue(): JSONValue | JSExpression | JSFunction;
+    static toDsl(props?: Record<string, PropModel>): NodeProps;
+    static parse(props?: NodeProps): Record<string, PropModel>;
+}

package/types/protocols/assets/dependencie.d.ts

@@ -0,0 +1,41 @@
+/**
+ * 依赖包
+ */
+export interface Dependencie {
+    /**
+     * 包名
+     */
+    package: string;
+    /**
+     * 版本号
+     */
+    version: string;
+    /**
+     * 必须依赖
+     */
+    required?: boolean;
+    /**
+     * 官方内置提供
+     */
+    official?: boolean;
+    /**
+     * 启用
+     */
+    enabled?: boolean;
+    /**
+     * 库导出名称
+     */
+    library: string;
+    /**
+     * 加载资源url
+     */
+    urls: string[];
+    /**
+     * 资产配置url
+     */
+    assetsUrl?: string;
+    /**
+     * 资产配置导出名称
+     */
+    assetsLibrary?: string;
+}

package/types/protocols/assets/index.d.ts

@@ -0,0 +1,2 @@
+export * from './material';
+export * from './dependencie';

package/types/protocols/assets/material.d.ts

@@ -0,0 +1,198 @@
+import type { JSONValue, DataType } from '../shared';
+import type { NodeSchema, NodeFrom } from '../schemas';
+/**
+ *  物料描述
+ */
+export interface Material {
+    /**
+     * 版本号
+     */
+    version: string;
+    /**
+     * 物料名称标识
+     */
+    name: string;
+    /**
+     * 产出导出变量名称
+     */
+    library: string;
+    /**
+     * 物料中文名称
+     */
+    label: string;
+    /**
+     * 分类配置
+     */
+    categories: MaterialCategory[];
+    /**
+     * 组件描述
+     */
+    components: MaterialDescription[];
+    /**
+     * 排序号，物料在组件库的排序，数字小的在前
+     */
+    order: number;
+}
+export interface MaterialCategory {
+    id: number | string;
+    category: string;
+}
+export interface MaterialDescription {
+    /**
+     * 组件名称
+     */
+    name: string;
+    /**
+     * 组件别名，即组件库导出的原始名称 如 import { Button } from 'ant-design-vue'
+     */
+    alias?: string;
+    /**
+     * 组件库导出的名称 如 import { Button } from 'ant-design-vue'
+     * parent: Button
+     * alias: Group
+     * name: AButtonGroup
+     * const AButtonGroup = Button.Group;
+     * 当 parent 有值时 alias 可以设置多级，如 Group.Item
+     *
+     */
+    parent?: string;
+    /**
+     * 组件预览图标
+     */
+    icon?: string;
+    /**
+     * 组件中文名称描述
+     */
+    label?: string;
+    /**
+     * 组件文档Url
+     */
+    doc?: string;
+    /**
+     * 分类Id
+     */
+    categoryId?: number | string;
+    /**
+     * 组件支持属性，待定义
+     */
+    props?: MaterialProp[];
+    /**
+     * 组件支持事件
+     */
+    events?: Array<string | MaterialEvent>;
+    /**
+     * 组件支持的插槽
+     */
+    slots?: Array<string | MaterialSlot>;
+    /**
+     * 初始化时的低代码片段
+     */
+    snippet?: Partial<NodeSchema>;
+    /**
+     * 只能放置在哪些组件内， 如果不设置，则表示可以放置在任何组件内, false表示不能放置在任何组件内
+     */
+    parentIncludes?: boolean | string[];
+    /**
+     * 只能允许哪些子组件， 如果不设置，则表示可以放置任何子组件, false表示不能放置在任何子组件
+     */
+    childIncludes?: boolean | string[];
+    /**
+     * 不显示在组件面板
+     */
+    hidden?: boolean;
+    /**
+     * 组件来源
+     */
+    from?: NodeFrom;
+    /**
+     * Block Id
+     */
+    id?: string;
+    /**
+     * 所属包名
+     */
+    package?: string;
+}
+/**
+ * 组件支持的属性
+ */
+export interface MaterialProp {
+    /**
+     * 属性名称
+     */
+    name: string;
+    /**
+     * 属性名称 中文
+     */
+    label?: string;
+    /**
+     * 提示说明
+     */
+    title?: string;
+    /**
+     * 默认值
+     */
+    defaultValue?: JSONValue;
+    /**
+     * 设置器
+     */
+    setters?: string | MaterialSetter | Array<string | MaterialSetter>;
+    /**
+     * 值可选项
+     */
+    options?: string[] | {
+        label: string;
+        value: JSONValue;
+    }[];
+    /**
+     * 数据类型
+     */
+    type?: DataType[];
+}
+/**
+ * 属性设置器
+ */
+export interface MaterialSetter {
+    /**
+     * 设置器名称标识
+     */
+    name: string;
+    /**
+     * 实现组件
+     */
+    component?: any;
+    /**
+     * 显示描述文本
+     */
+    label?: string;
+    /**
+     * 组件配置参数
+     */
+    props?: Record<string, any>;
+}
+/**
+ * 组件支持的事件
+ */
+export interface MaterialEvent {
+    /**
+     * 事件名称
+     */
+    name: string;
+    /**
+     * 事件回调参数名
+     */
+    params?: string[];
+}
+/**
+ * 组件支持的插槽
+ */
+export interface MaterialSlot {
+    /**
+     * 插槽名称
+     */
+    name: string;
+    /**
+     * 插槽回传的参数名
+     */
+    params?: string[];
+}

package/types/protocols/index.d.ts

@@ -0,0 +1,4 @@
+export * from './shared';
+export * from './assets';
+export * from './schemas';
+export * from './service';

package/types/protocols/schemas/block.d.ts

@@ -0,0 +1,106 @@
+import type { JSExpression, JSFunction, JSONValue } from '../shared';
+import type { NodeSchema } from './node';
+import type { DataSourceSchema } from './dataSource';
+export interface BlockSchema {
+    /**
+     * 唯一标识
+     */
+    id?: string;
+    /**
+     * 组件名
+     */
+    name: string;
+    /**
+     * 锁定
+     */
+    locked?: boolean;
+    /**
+     * 注入
+     */
+    inject?: BlockInject[];
+    /**
+     * 状态数据
+     */
+    state?: BlockState;
+    /**
+     * 生命周期集
+     */
+    lifeCycles?: Record<string, JSFunction>;
+    /**
+     * 自定义方法
+     */
+    methods?: Record<string, JSFunction>;
+    /**
+     * 计算属性
+     */
+    computed?: Record<string, JSFunction>;
+    /**
+     * 侦听器
+     */
+    watch?: BlockWatch[];
+    /**
+     * 样式
+     */
+    css?: string;
+    /**
+     * 定义属性参数
+     */
+    props?: Array<string | BlockProp>;
+    /**
+     * 定义事件
+     */
+    emits?: string[];
+    /**
+     * 定义插槽
+     */
+    slots?: string[];
+    /**
+     * 节点树
+     */
+    nodes?: NodeSchema[];
+    /**
+     * 数据源
+     */
+    dataSources?: Record<string, DataSourceSchema>;
+    /**
+     * babel代码转换缓存
+     */
+    transform?: Record<string, string>;
+    /**
+     * 标记
+     */
+    __VTJ_BLOCK__?: boolean;
+    /**
+     * 版本
+     */
+    __VERSION__?: string;
+}
+/**
+ * 注入描述
+ */
+export interface BlockInject {
+    name: string;
+    from?: string | JSExpression;
+    default?: JSONValue | JSExpression;
+}
+/**
+ * 组件状态描述
+ */
+export type BlockState = Record<string, JSONValue | JSExpression | JSFunction>;
+/**
+ * 侦听器描述
+ */
+export interface BlockWatch {
+    id?: string;
+    source: JSFunction | JSExpression;
+    deep?: boolean;
+    immediate?: boolean;
+    handler: JSFunction;
+}
+export interface BlockProp {
+    name: string;
+    type?: BlockPropDataType | BlockPropDataType[];
+    required?: boolean;
+    default?: JSONValue | JSExpression;
+}
+export type BlockPropDataType = 'String' | 'Number' | 'Boolean' | 'Array' | 'Object' | 'Function' | 'Date';

package/types/protocols/schemas/dataSource.d.ts

@@ -0,0 +1,75 @@
+import type { JSFunction, JSExpression } from '../shared';
+/**
+ * 数据源类型，目前仅实现api类型
+ */
+export type DataSourceType = 'api' | 'cube' | 'meta';
+/**
+ * 请求方法
+ */
+export type ApiMethod = 'get' | 'post' | 'put' | 'delete' | 'patch' | 'jsonp';
+/**
+ * 项目级API类型数据源
+ */
+export interface ApiSchema {
+    /**
+     * 唯一标识
+     */
+    id: string;
+    /**
+     * 接口名称
+     */
+    name: string;
+    /**
+     * 接口描述说明
+     */
+    label?: string;
+    /**
+     * 接口请求url
+     */
+    url: string;
+    /**
+     * 接口请求方法
+     */
+    method?: ApiMethod;
+    /**
+     * 请求 设置配置
+     */
+    settings?: Record<string, any>;
+    /**
+     * 请求头配置
+     */
+    headers?: JSExpression | JSFunction;
+    /**
+     * jsonp请求配置
+     */
+    jsonpOptions?: Record<string, any>;
+}
+/**
+ * 页面级引用数据源
+ */
+export interface DataSourceSchema {
+    /**
+     * 数据源类型
+     */
+    type: DataSourceType;
+    /**
+     * 数据源引用唯一标识
+     */
+    ref: string;
+    /**
+     * 数据源名称
+     */
+    name: string;
+    /**
+     * 描述标题
+     */
+    label?: string;
+    /**
+     * 数据转换函数
+     */
+    transform?: JSFunction;
+    /**
+     * 测试用例
+     */
+    test?: JSFunction;
+}

package/types/protocols/schemas/file.d.ts

@@ -0,0 +1,56 @@
+import type { BlockSchema } from './block';
+/**
+ * 文件类型
+ */
+export type FileType = 'block' | 'page';
+export interface BlockFile {
+    /**
+     * 文件类型
+     */
+    type: FileType;
+    /**
+     * 唯一标识
+     */
+    id: string;
+    /**
+     *  文件名
+     */
+    name: string;
+    /**
+     * 页面标题
+     */
+    title: string;
+    /**
+     * 文件内容
+     */
+    dsl?: BlockSchema;
+}
+/**
+ * 页面描述
+ */
+export interface PageFile extends BlockFile {
+    /**
+     * 是否目录
+     */
+    dir?: boolean;
+    /**
+     * 菜单icon
+     */
+    icon?: string;
+    /**
+     * 目录包含的页面
+     */
+    children?: PageFile[];
+    /**
+     * 是否在母版内
+     */
+    mask?: boolean;
+    /**
+     * 不在菜单显示
+     */
+    hidden?: boolean;
+    /**
+     * 源码文件，非低代码页面
+     */
+    raw?: boolean;
+}

package/types/protocols/schemas/history.d.ts

@@ -0,0 +1,31 @@
+import type { BlockSchema } from './block';
+/**
+ * 历史记录描述
+ */
+export interface HistorySchema {
+    /**
+     * 页面或区块文件id
+     */
+    id: string;
+    /**
+     * 历史记录项
+     */
+    items?: HistoryItem[];
+}
+/**
+ * 记录项
+ */
+export interface HistoryItem {
+    /**
+     * 记录项唯一标识
+     */
+    id: string;
+    /**
+     * 记录项描述
+     */
+    label: string;
+    /**
+     * 记录项内容
+     */
+    dsl?: BlockSchema;
+}

package/types/protocols/schemas/index.d.ts

@@ -0,0 +1,6 @@
+export * from './node';
+export * from './block';
+export * from './dataSource';
+export * from './file';
+export * from './project';
+export * from './history';