@redhare/lowcode-types/lib/shell/type/project-schema.d.ts

Types for Ali lowCode engine

import { InterpretDataSource as DataSource } from '@redhare/lowcode-datasource-types';
import { IPublicTypeJSONObject, IPublicTypeRootSchema, IPublicTypeI18nMap, IPublicTypeAppConfig, IPublicTypeComponentsMap, IPublicTypeJSExpression, IPublicTypeJSFunction, IPublicTypeNpmInfo } from './';
export interface IPublicTypeInternalUtils {
    name: string;
    type: 'function';
    content: IPublicTypeJSFunction | IPublicTypeJSExpression;
}
export interface IPublicTypeExternalUtils {
    name: string;
    type: 'npm' | 'tnpm';
    content: IPublicTypeNpmInfo;
}
export declare type IPublicTypeUtilItem = IPublicTypeInternalUtils | IPublicTypeExternalUtils;
export declare type IPublicTypeUtilsMap = IPublicTypeUtilItem[];
/**
 * 应用描述
 */
export interface IPublicTypeProjectSchema<T = IPublicTypeRootSchema> {
    id?: string;
    /**
     * 当前应用协议版本号
     */
    version: string;
    /**
     * 当前应用所有组件映射关系
     */
    componentsMap: IPublicTypeComponentsMap;
    /**
     * 描述应用所有页面、低代码组件的组件树
     * 低代码业务组件树描述
     * 是长度固定为 1 的数组，即数组内仅包含根容器的描述（低代码业务组件容器类型）
     */
    componentsTree: T[];
    /**
     * 国际化语料
     */
    i18n?: IPublicTypeI18nMap;
    /**
     * 应用范围内的全局自定义函数或第三方工具类扩展
     */
    utils?: IPublicTypeUtilsMap;
    /**
     * 应用范围内的全局常量
     */
    constants?: IPublicTypeJSONObject;
    /**
     * 应用范围内的全局样式
     */
    css?: string;
    /**
     * 当前应用的公共数据源
     */
    dataSource?: DataSource;
    /**
     * 当前应用配置信息
     *
     * TODO: 需要在后续版本中移除 `Record<string, unknown>` 类型签名
     */
    config?: IPublicTypeAppConfig & Record<string, unknown>;
    /**
     * 当前应用元数据信息
     */
    meta?: Record<string, any>;
}