@kp-ui/lowcode-pc 1.0.0-alpha.1

package/types/core/src/types/designer.d.ts

@@ -0,0 +1,74 @@
+import { Widget, FormConfig } from './schema';
+export interface HistoryStep {
+    widgetList: Widget[];
+    formConfig: FormConfig;
+}
+
+export interface HistoryData {
+    index: number;
+    maxStep: number;
+    steps: HistoryStep[];
+}
+
+export type LayoutType = 'PC' | 'BI' | 'H5';
+
+export interface FormDesigner {
+    widgetList: Widget[];
+    formConfig: FormConfig;
+    selectedId: string | null;
+    selectedWidget: Widget | null;
+    selectedWidgetName: string | null;
+    draggingWidget: Widget | null;
+    draggingWidget: Widget | null;
+    dropPreview: {
+        containerList: Widget[] | null;
+        index: number;
+        rect: { left: number; top: number; width: number; height: number } | null;
+    } | null;
+    vueInstance: any;
+    cssClassList: any[];
+    historyData: HistoryData;
+    clearDesigner(skipHistoryChange?: boolean): void;
+    loadPresetCssCode(preCssCode: string): void;
+    getLayoutType(): LayoutType;
+    changeLayoutType(newType: LayoutType): void;
+    getImportTemplate(): { widgetList: Widget[]; formConfig: FormConfig };
+    loadFormJson(formJson: any): boolean;
+    setSelected(selected: Widget | null): void;
+    updateSelectedWidgetNameAndLabel(
+        selectedWidget: Widget,
+        newName: string,
+        newLabel: string
+    ): void;
+    clearSelected(): void;
+    checkWidgetMove(evt: any): boolean;
+    getContainerByType(typeName: string): Widget | null;
+    getFieldWidgetByType(typeName: string): Widget | null;
+    upgradeFormConfig(oldFormConfig: FormConfig): void;
+    cloneGridCol(widget: Widget, parentWidget: Widget): void;
+    cloneContainer(containWidget: Widget): Widget | null;
+    moveUpWidget(parentList: Widget[], indexOfParentList: number): void;
+    moveDownWidget(parentList: Widget[], indexOfParentList: number): void;
+    removeWidget(parentList: Widget[], indexOfParentList: number, parentWidget?: Widget): void;
+    copyWidget(origin: Widget): Widget;
+    addWidget(widget: Widget, parentList?: Widget[], insertIndex?: number): void;
+    addContainerByDbClick(container: Widget): void;
+    addFieldByDbClick(widget: Widget): void;
+    deleteColOfGrid(gridWidget: Widget, colIdx: number): void;
+    addNewColOfGrid(gridWidget: Widget): void;
+    addTabPaneOfTabs(tabsWidget: Widget): void;
+    deleteTabPaneOfTabs(tabsWidget: Widget, tpIdx: number): void;
+    emitEvent(evtName: string, evtData: any): void;
+    handleEvent(evtName: string, callback: (data: any) => void): void;
+    setCssClassList(cssClassList: any[]): void;
+    getCssClassList(): any[];
+    initHistoryData(): void;
+    emitHistoryChange(): void;
+    saveCurrentHistoryStep(): void;
+    undoHistoryStep(): void;
+    redoHistoryStep(): void;
+    undoEnabled(): boolean;
+    redoEnabled(): boolean;
+    saveFormContentToStorage(): void;
+    loadFormContentFromStorage(): void;
+}

package/types/core/src/types/fileObject.d.ts

@@ -0,0 +1,7 @@
+export interface IFileObjectType {
+  fileName: string;
+  previewUrl?: string;
+  fileType?: string;
+  fileSize?: number;
+  fileCode?: string;
+}

package/types/core/src/types/global.d.ts

@@ -0,0 +1,20 @@
+declare global {
+  interface ImportMetaEnv {
+    [key: string]: any;
+
+    // 打包目录
+    VITE_APP_BUILD_DIR: string;
+    // token名称
+    VITE_APP_TOKEN_NAME: string;
+    // api地址
+    VITE_APP_API_ROOT: string;
+    // 是否开启mock
+    VITE_APP_USE_MOCK: 0 | 1;
+    // 登录地址
+    VITE_APP_LOGIN_URL: string;
+    // 登录回跳地址
+    VITE_APP_LOGIN_RETURN_URL: string;
+    // 用户中心地址
+    VITE_APP_UCENTER_URL: string;
+  }
+}

package/types/core/src/types/index.d.ts

@@ -0,0 +1,8 @@
+export type LayoutType = 'PC' | 'BI' | 'H5';
+export * from './button';
+export * from './designer';
+export * from './global';
+export * from './fileObject';
+export * from './rowSelectionType';
+export * from './schema';
+export * from './widgetProps';

package/types/core/src/types/rowSelectionType.d.ts

@@ -0,0 +1,12 @@
+export type rowSelectionType = {
+    hasRowSelection: boolean;
+    preserveSelectedRowKeys: boolean;
+    fixed: boolean;
+    onChange: string;
+    columnWidth: number;
+    checkMethod?: string;
+    getCheckboxProps?: (record: any) => {
+        disabled: boolean;
+        name: string;
+    };
+};

package/types/core/src/types/schema.d.ts

@@ -0,0 +1,169 @@
+import { WidgetTypeEnum } from '../constants/WidgetTypeEnum';
+import { SizeType } from 'ant-design-vue';
+import { HttpEditorOption } from '../../../tmgc2-share/index.ts';
+/**
+ * Widget 类型定义
+ */
+export interface WidgetOptions {
+    name: string;
+    label?: string;
+    labelAlign?: string;
+    hidden?: boolean;
+    customClass?: string[];
+    locked?: boolean;
+    zIndex?: number;
+    [key: string]: any;
+}
+
+/**
+ * 表单项组件选项
+ */
+interface FormItemWidgetOptions extends WidgetOptions {
+    labelWidth?: number | null;
+    labelHidden?: boolean;
+    placeholder?: string;
+    defaultValue?: any;
+    readonly?: boolean;
+    disabled?: boolean;
+    required?: boolean;
+    requiredHint?: string;
+    validation?: string;
+    validationHint?: string;
+    labelIconClass?: string | null;
+    labelIconPosition?: string;
+    onCreated?: string;
+    onMounted?: string;
+    onInput?: string;
+    onChange?: string;
+    onFocus?: string;
+    onBlur?: string;
+    onValidate?: string;
+}
+
+export interface BiWidgetOptions extends WidgetOptions {
+    rotate?: number;
+    left?: number;
+    top?: number;
+    zIndex?: number;
+}
+
+export type WidgetCategory = 'container' | 'field' | 'bi';
+
+export interface Widget<T extends WidgetOptions = any> {
+    internal?: boolean;
+    showName?: string;
+    key?: string;
+    type: WidgetTypeEnum | ContainerTypeEnum;
+    icon: string;
+    category: WidgetCategory;
+    alias?: string;
+    id: string;
+    options: T;
+    widgetList?: Widget[];
+    cols?: GridColWidget[];
+    tabs?: GridColWidget[];
+    defaultSlotsList?: Widget[];
+    rows?: any[];
+    formItemFlag?: boolean;
+}
+
+/**
+ * 表单配置
+ */
+export interface FormConfig {
+    /**
+     * 标签宽度
+     */
+    labelWidth: number;
+
+    /**
+     * 标签位置：horizontal-水平，vertical-垂直，inline-行内
+     */
+    labelPosition: 'horizontal' | 'vertical' | 'inline';
+
+    /**
+     * 组件尺寸
+     */
+    size: SizeType;
+
+    /**
+     * 标签对齐方式
+     */
+    labelAlign: 'left' | 'right' | 'center';
+
+    /**
+     * 自定义CSS代码
+     */
+    cssCode: string;
+
+    /**
+     * 自定义样式类
+     */
+    customClass: string[];
+
+    /**
+     * 是否回车提交：0-否，1-是
+     */
+    isEnterSubmit: number;
+
+    /**
+     * 全局函数代码
+     */
+    functions: string;
+
+    /**
+     * 布局类型：PC-电脑端，Pad-平板，H5-手机
+     */
+    layoutType: LayoutType;
+
+    /**
+     * 表单创建时钩子函数
+     */
+    onFormCreated: string;
+
+    /**
+     * 表单挂载时钩子函数
+     */
+    onFormMounted: string;
+
+    /**
+     * 表单数据变化时钩子函数
+     */
+    onFormDataChange: string;
+
+    /**
+     * 服务接口配置
+     */
+    serveList: {
+        vformDetail: HttpEditorOption;
+        vformUpdate: HttpEditorOption;
+        list: HttpEditorOption[];
+    };
+
+    /**
+     * 其他自定义属性
+     */
+    [key: string]: any;
+}
+
+/**
+ * 组件树根节点
+ */
+export interface FormJsonType {
+    widgetList: Widget[];
+    formConfig: FormConfig;
+}
+
+export interface OptionItem {
+    label: string;
+    value: string | number;
+    children?: OptionItem[];
+}
+
+export interface HttpType {
+    url: string;
+    method: string;
+    data: Record<string, any>;
+    params: Record<string, any>;
+    [key: string]: any;
+}

package/types/core/src/types/widgetProps.d.ts

@@ -0,0 +1,8 @@
+export interface WidgetProps<T = Widget> {
+    widget: T;
+    field: T;
+    parentWidget?: T | null;
+    indexOfParentList?: number;
+    subFormRowIndex?: number;
+    subFormRowId?: string;
+}

package/types/core/src/utils/emitter.d.ts

@@ -0,0 +1,17 @@
+interface VfEvents {
+    [eventName: string]: Array<(data: unknown) => void>;
+}
+interface EmitterMixin {
+    data(): {
+        vfEvents: VfEvents;
+    };
+    methods: {
+        emit$(eventName: string, data?: unknown): void;
+        on$(eventName: string, fn: (data: unknown) => void): void;
+        off$(eventName: string, fn?: ((data: unknown) => void) | null): void;
+        dispatch(componentName: string, eventName: string, params: unknown[]): void;
+        broadcast(componentName: string, eventName: string, params: unknown[]): void;
+    };
+}
+declare const emitter: EmitterMixin;
+export default emitter;

package/types/core/src/utils/event-bus.d.ts

@@ -0,0 +1,10 @@
+import { Emitter, EventType } from 'mitt';
+type Events = Record<EventType, unknown>;
+declare const instance: Emitter<Events>;
+interface EventBus {
+    $on: typeof instance.on;
+    $off: typeof instance.off;
+    $emit: typeof instance.emit;
+}
+declare const eventBus: EventBus;
+export default eventBus;

package/types/core/src/utils/format.d.ts

@@ -0,0 +1,46 @@
+export declare function formatDate1(date: string | number | Date): string;
+export declare function formatDate2(date: string | number | Date): string;
+export declare function formatDate3(date: string | number | Date): string;
+export declare function formatDate4(date: string | number | Date): string;
+export declare function formatDate5(date: string | number | Date): string;
+export declare function formatNumber1(v: number): string | number;
+export declare function formatNumber2(v: number): string | number;
+export declare function formatNumber3(v: number): string | number;
+export declare function formatNumber4(v: number): string | number;
+export declare function formatNumber5(v: number): string | number;
+export declare function formatNumber6(v: number): string | number;
+export declare function formatNumber7(v: number): string | number;
+interface FieldNames {
+    label: string;
+    value: string;
+    children: string;
+}
+interface TreeItem {
+    [key: string]: unknown;
+}
+/**
+ * 将Cascader转义为汉字
+ * @param arr 数据数组
+ * @param codeList 代码列表
+ * @param fieldNames 字段名称映射
+ * @param emblem 拼接符号
+ * @returns
+ */
+export declare const formateCascaderCode: (arr: TreeItem[] | undefined, codeList: string[] | string[][] | undefined, fieldNames?: FieldNames, emblem?: string) => string | undefined;
+/**
+ * 将tree转义为汉字
+ * @param arr 值数组
+ * @param codeList 代码列表
+ * @param fieldNames 字段名称映射
+ * @param emblem 拼接符号
+ * @returns
+ */
+export declare const formateTreeToName: (arr: string[] | undefined, codeList: TreeItem[] | undefined, fieldNames?: FieldNames, emblem?: string) => string | undefined;
+/**
+ * 格式化尺寸，支持数字、px、%
+ * @param value 尺寸值
+ * @param defaultSize 默认尺寸
+ * @returns 格式化后的尺寸字符串
+ */
+export declare function formatSize(value: string | number | undefined | null, defaultSize?: string): string;
+export {};

package/types/core/src/utils/getFileName.d.ts

@@ -0,0 +1 @@
+export declare function getFileName(path: string): string;

package/types/core/src/utils/i18n.d.ts

@@ -0,0 +1,27 @@
+declare const i18n: {
+    readonly messages: {};
+    $st(path: string, args: any): any;
+    $st2(path: any, path2: any): any;
+    setLang(lang: any): Promise<void>;
+    setLangMessages(lang: any, messages: any): void;
+};
+export declare const translate: (key: string) => string;
+export declare const setLangMessages: (langName: string, messages: any) => void;
+declare const _default: {
+    computed: {
+        getLocale: () => any;
+    };
+    methods: {
+        changeLocale(langName: string): Promise<void>;
+        i18nt(key: string): string;
+        i18n2t(key1: string, key2: string): string;
+        setLocale: any;
+    };
+};
+export default _default;
+export declare function useI18n(): {
+    i18nt: (key: string, obj?: Record<string, any>) => string;
+    i18n2t: (key1: string, key2: string) => string;
+    initLocale: (locale: string) => void;
+};
+export { i18n };

package/types/core/src/utils/index.d.ts

@@ -0,0 +1,7 @@
+export * from './useEmitter';
+export * from './i18n';
+export * from './format';
+export * from './insertAssetsToBody';
+export * from './getFileName';
+export * from './util';
+export { default as FormValidators } from './validators';

package/types/core/src/utils/insertAssetsToBody.d.ts

@@ -0,0 +1,3 @@
+export declare const insertCssToHead: () => void;
+export declare const insertJsToHead: () => void;
+export declare const insertAssetsToBody: () => void;

package/types/core/src/utils/request/handleAxiosError.d.ts

@@ -0,0 +1,11 @@
+import { AxiosResponse } from 'axios';
+export declare const handleErrorStatus: {
+    401: (data: AxiosResponse) => void;
+    403: (data: AxiosResponse) => void;
+    404: (data: AxiosResponse) => void;
+    418: (data: AxiosResponse) => void;
+    429: (data: AxiosResponse) => void;
+    500: (data: AxiosResponse) => void;
+    510: (data: AxiosResponse) => void;
+    599: (data: AxiosResponse) => void;
+};

package/types/core/src/utils/request/http.d.ts

@@ -0,0 +1,4 @@
+import { AxiosInstance } from 'axios';
+declare const http: AxiosInstance;
+export declare const getHttp: () => AxiosInstance;
+export default http;

package/types/core/src/utils/smart-vue-i18n/index.d.ts

@@ -0,0 +1,11 @@
+type i18nOptionsType = {
+    locale: string;
+};
+export declare function createI18n(options: i18nOptionsType): {
+    readonly messages: {};
+    $st(path: string, args: any): any;
+    $st2(path: any, path2: any): any;
+    setLang(lang: any): Promise<void>;
+    setLangMessages(lang: any, messages: any): void;
+};
+export {};

package/types/core/src/utils/transformWidgetList.d.ts

@@ -0,0 +1,2 @@
+import { Widget } from '../types/schema';
+export declare function transformWidgetList(widgetList: Widget[]): Widget[];

package/types/core/src/utils/useEmitter.d.ts

@@ -0,0 +1,31 @@
+import { Ref } from 'vue';
+/**
+ * 事件处理函数类型
+ */
+export type EventHandler<T = any> = (data: T) => void;
+/**
+ * 事件存储对象类型
+ */
+export interface EventsMap {
+    [eventName: string]: EventHandler[];
+}
+export type EditEventHandlerParams = {
+    title?: string;
+    attr: string;
+    eventParams?: string[];
+    mode?: string;
+};
+/**
+ * 组合式API版本的事件总线
+ * 用于组件间通信
+ */
+export declare function useEmitter(): {
+    vfEvents: Ref<EventsMap, EventsMap>;
+    editEventHandler: (eventName: string, eventParams: any[], mode: string) => void;
+    onChangeEditEventHandler: (params: EditEventHandlerParams) => void;
+    emit$: <T = any>(eventName: string, data: T) => void;
+    on$: <T = any>(eventName: string, fn: EventHandler<T>) => void;
+    off$: <T = any>(eventName: string, fn?: EventHandler<T>) => void;
+    dispatch: (componentName: string, eventName: string, params: any) => void;
+    broadcast: (componentName: string, eventName: string, params: any) => void;
+};

package/types/core/src/utils/util.d.ts

@@ -0,0 +1,81 @@
+import { FormConfig, Widget, FormJsonType } from '../..';
+export declare function isNull(value: unknown): value is null | undefined;
+export declare function isNotNull(value: unknown): boolean;
+export declare function isEmptyStr(str: unknown): boolean;
+export declare const generateId: () => number;
+export declare const deepClone: <T>(origin: T) => T;
+export declare const overwriteObj: <T extends Record<string, unknown>>(obj1: T, obj2: Partial<T>) => void;
+export declare const insertCustomCssToHead: (cssCode: string, formId?: string) => void;
+export declare const insertGlobalFunctionsToHtml: (functionsCode: string, formId?: string) => void;
+export declare const optionExists: (optionsObj: Record<string, unknown> | null | undefined, optionName: string) => boolean;
+export declare const loadRemoteScript: (srcPath: string, callback: () => void) => void;
+export type WidgetHandler = (widget: Widget, parent?: Widget | null) => void;
+export type ContainerHandler = (container: Widget) => void;
+export declare function traverseFieldWidgets(widgetList: Widget[] | undefined, handler: WidgetHandler, parent?: Widget | null, staticWidgetsIncluded?: boolean): void;
+export declare function traverseContainerWidgets(widgetList: Widget[] | undefined, handler: ContainerHandler): void;
+export declare function traverseAllWidgets(widgetList: Widget[] | undefined, handler: (widget: Widget) => void): void;
+/**
+ * 遍历容器内的字段组件
+ * @param con
+ * @param handler
+ */
+export declare function traverseFieldWidgetsOfContainer(con: Widget, handler: WidgetHandler): void;
+/**
+ * 遍历容器内部的字段组件和容器组件
+ * @param con
+ * @param fieldHandler
+ * @param containerHandler
+ */
+export declare function traverseWidgetsOfContainer(con: Widget, fieldHandler: WidgetHandler, containerHandler: ContainerHandler): void;
+export interface FieldWidgetInfo {
+    type: string;
+    name: string | undefined;
+    field: Widget;
+}
+/**
+ * 获取所有字段组件
+ * @param widgetList
+ * @param staticWidgetsIncluded 是否包含按钮等静态组件，默认不包含
+ * @returns {[]}
+ */
+export declare function getAllFieldWidgets(widgetList: Widget[] | undefined, staticWidgetsIncluded?: boolean): FieldWidgetInfo[];
+export interface ContainerWidgetInfo {
+    type: string;
+    name: string | undefined;
+    container: Widget;
+}
+/**
+ * 获取所有容器组件
+ * @param widgetList
+ * @returns {[]}
+ */
+export declare function getAllContainerWidgets(widgetList: Widget[] | undefined): ContainerWidgetInfo[];
+export declare function getFieldWidgetByName(widgetList: Widget[] | undefined, fieldName: string, staticWidgetsIncluded?: boolean): Widget | null;
+export declare function getContainerWidgetByName(widgetList: Widget[] | undefined, containerName: string): Widget | null;
+export declare function getContainerWidgetById(widgetList: Widget[] | undefined, containerId: string): Widget | null;
+interface MessageApi {
+    success: (msg: string) => void;
+    error: (msg: string) => void;
+}
+export declare function copyToClipboard(content: string, clickEvent: MouseEvent, $message: MessageApi, successMsg: string, errorMsg: string): void;
+export declare function getQueryParam(variable: string): string | undefined;
+export declare function getDefaultFormConfig(): FormConfig;
+export declare function buildDefaultFormJson(): FormJsonType;
+export declare function cloneFormConfigWithoutEventHandler(formConfig: FormConfig): FormConfig;
+/**
+ * 转译选择项数据
+ * @param rawData
+ * @param widgetType
+ * @param labelKey
+ * @param valueKey
+ * @returns {[]}
+ */
+export declare function translateOptionItems<T extends Record<string, unknown>>(rawData: T[], widgetType: string, labelKey: string, valueKey: string): Array<{
+    label: unknown;
+    value: unknown;
+}> | T[];
+export declare function getDSByName(formConfig: FormConfig, dsName: string): {
+    uniqueName: string;
+    [key: string]: unknown;
+} | null;
+export {};

package/types/core/src/utils/validators.d.ts

@@ -0,0 +1,25 @@
+type RegExpName = 'number' | 'letter' | 'letterAndNumber' | 'mobilePhone' | 'letterStartNumberIncluded' | 'noChinese' | 'chinese' | 'email' | 'url';
+interface ValidationRule {
+    label?: string;
+    errorMsg?: string;
+    regExp?: string;
+    [key: string]: unknown;
+}
+export declare const getRegExp: (validatorName: RegExpName) => RegExp | undefined;
+type ValidatorFn = (rule: ValidationRule, value: unknown) => Promise<void> | void;
+interface FormValidatorsType {
+    number: ValidatorFn;
+    letter: ValidatorFn;
+    letterAndNumber: ValidatorFn;
+    mobilePhone: ValidatorFn;
+    noBlankStart: ValidatorFn;
+    noBlankEnd: ValidatorFn;
+    letterStartNumberIncluded: ValidatorFn;
+    noChinese: ValidatorFn;
+    chinese: ValidatorFn;
+    email: ValidatorFn;
+    url: ValidatorFn;
+    regExp: ValidatorFn;
+}
+declare const FormValidators: FormValidatorsType;
+export default FormValidators;

package/types/index.d.ts

@@ -0,0 +1 @@
+export {}