@daxiangme/form-vue 0.1.0

package/LICENSE

@@ -0,0 +1,2 @@
+MIT License. See the workspace root LICENSE for the complete text.
+

package/README.md

@@ -0,0 +1,37 @@
+# @daxiangme/form-vue
+
+Vue 3 + Element Plus 的 DX Form 设计器和运行渲染器。
+
+```bash
+pnpm add @daxiangme/form-core @daxiangme/form-vue vue element-plus
+```
+
+样式顺序固定为：
+
+```ts
+import 'element-plus/dist/index.css'
+import 'element-plus/theme-chalk/dark/css-vars.css'
+import '@daxiangme/form-vue/style.css'
+```
+
+```vue
+<script setup lang="ts">
+import { ref } from 'vue'
+import { createEmptyDesignerDocument, type DesignerRuntimeValueStore } from '@daxiangme/form-core'
+import { FormDesigner, FormRenderer } from '@daxiangme/form-vue'
+
+const document = ref(createEmptyDesignerDocument('form-1'))
+const value = ref<DesignerRuntimeValueStore>({ fields: {}, collections: {} })
+</script>
+
+<template>
+  <FormDesigner v-model="document" @save-request="saveDocument" />
+  <FormRenderer v-model="value" :document="document" mode="CREATE" />
+</template>
+```
+
+`FormDesigner` 只发出保存和导出请求，不代替宿主调用业务接口。`FormRenderer` 的文件、目录、OCR、扫码、定位、远程验证和导航能力都通过 `FormRuntimeAdapters` 显式注入；缺少端口时操作失败关闭。
+
+深色模式直接跟随 Element Plus 的 `html.dark`，包内不维护第二套主题状态。
+
+`FormDesigner` 会占满直接父容器；消费方需要为该父容器提供确定高度，但不要求父容器使用 Flex 布局。

package/dist/index.d.ts

@@ -0,0 +1,377 @@
+import { ComponentOptionsMixin } from 'vue';
+import { ComponentProvideOptions } from 'vue';
+import { ComputedRef } from 'vue';
+import { CreateComponentPublicInstanceWithMixins } from 'vue';
+import { DefineComponent } from 'vue';
+import { DesignerDevice } from '@daxiangme/form-core';
+import { DesignerDiagnostic } from '@daxiangme/form-core';
+import { DesignerDocument } from '@daxiangme/form-core';
+import { DesignerDropTarget } from '@daxiangme/form-core';
+import { DesignerInitialDataModel } from '@daxiangme/form-core';
+import { DesignerLayoutNode } from '@daxiangme/form-core';
+import { DesignerOverlayModule } from '@daxiangme/form-core';
+import { DesignerRuntimeAdapters } from '@daxiangme/form-core';
+import { DesignerRuntimeMode } from '@daxiangme/form-core';
+import { DesignerRuntimeValueStore } from '@daxiangme/form-core';
+import { DesignerSubmissionProjection } from '@daxiangme/form-core';
+import { FormRuntimeAdapterContext } from '@daxiangme/form-core';
+import { GlobalComponents } from 'vue';
+import { GlobalDirectives } from 'vue';
+import { Plugin as Plugin_2 } from 'vue';
+import { PublicProps } from 'vue';
+import { Ref } from 'vue';
+
+declare const __VLS_component: DefineComponent<__VLS_Props, {
+markClean: () => void;
+dirty: Readonly<Ref<boolean, boolean>>;
+replaceDocument: typeof replaceDocument;
+currentDocument: typeof currentDocument;
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+"update:modelValue": (document: DesignerDocument) => any;
+diagnostics: (items: DesignerDiagnostic[]) => any;
+"dirty-change": (dirty: boolean) => any;
+"save-request": (document: DesignerDocument) => any;
+"export-request": (document: DesignerDocument) => any;
+}, string, PublicProps, Readonly<__VLS_Props> & Readonly<{
+"onUpdate:modelValue"?: ((document: DesignerDocument) => any) | undefined;
+onDiagnostics?: ((items: DesignerDiagnostic[]) => any) | undefined;
+"onDirty-change"?: ((dirty: boolean) => any) | undefined;
+"onSave-request"?: ((document: DesignerDocument) => any) | undefined;
+"onExport-request"?: ((document: DesignerDocument) => any) | undefined;
+}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {
+workspaceRef: HTMLDivElement;
+canvasRef: CreateComponentPublicInstanceWithMixins<Readonly<{
+document: DesignerDocument;
+selectedNodeId: string;
+device: DesignerDevice;
+viewportWidth?: number;
+zoom: number;
+gridVisible: boolean;
+activeModule?: DesignerOverlayModule;
+}> & Readonly<{
+onSelect?: ((nodeId: string) => any) | undefined;
+onRemove?: ((nodeId: string) => any) | undefined;
+onDrop?: ((payload: string, target: DesignerDropTarget) => any) | undefined;
+onDuplicate?: ((nodeId: string) => any) | undefined;
+onReorder?: ((containerId: string | null, slotCode: string, nodes: DesignerLayoutNode[]) => any) | undefined;
+"onDrag-start"?: (() => any) | undefined;
+"onDrag-end"?: (() => any) | undefined;
+"onUpdate:zoom"?: ((zoom: number) => any) | undefined;
+}>, {
+fitToWidth: () => void;
+captureViewport: () => {
+horizontal: number;
+vertical: number;
+};
+restoreViewport: (position: {
+horizontal: number;
+vertical: number;
+}) => Promise<void>;
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+select: (nodeId: string) => any;
+remove: (nodeId: string) => any;
+drop: (payload: string, target: DesignerDropTarget) => any;
+duplicate: (nodeId: string) => any;
+reorder: (containerId: string | null, slotCode: string, nodes: DesignerLayoutNode[]) => any;
+"drag-start": () => any;
+"drag-end": () => any;
+"update:zoom": (zoom: number) => any;
+}, PublicProps, {}, false, {}, {}, GlobalComponents, GlobalDirectives, string, {
+canvasRef: HTMLElement;
+stageRef: HTMLDivElement;
+surfaceRef: unknown;
+}, HTMLElement, ComponentProvideOptions, {
+P: {};
+B: {};
+D: {};
+C: {};
+M: {};
+Defaults: {};
+}, Readonly<{
+document: DesignerDocument;
+selectedNodeId: string;
+device: DesignerDevice;
+viewportWidth?: number;
+zoom: number;
+gridVisible: boolean;
+activeModule?: DesignerOverlayModule;
+}> & Readonly<{
+onSelect?: ((nodeId: string) => any) | undefined;
+onRemove?: ((nodeId: string) => any) | undefined;
+onDrop?: ((payload: string, target: DesignerDropTarget) => any) | undefined;
+onDuplicate?: ((nodeId: string) => any) | undefined;
+onReorder?: ((containerId: string | null, slotCode: string, nodes: DesignerLayoutNode[]) => any) | undefined;
+"onDrag-start"?: (() => any) | undefined;
+"onDrag-end"?: (() => any) | undefined;
+"onUpdate:zoom"?: ((zoom: number) => any) | undefined;
+}>, {
+fitToWidth: () => void;
+captureViewport: () => {
+horizontal: number;
+vertical: number;
+};
+restoreViewport: (position: {
+horizontal: number;
+vertical: number;
+}) => Promise<void>;
+}, {}, {}, {}, {}> | null;
+importInputRef: HTMLInputElement;
+}, HTMLElement>;
+
+declare const __VLS_component_2: DefineComponent<__VLS_Props_4, {
+busy: ComputedRef<boolean>;
+requestClose: typeof requestClose;
+requestConfirm: typeof requestConfirm;
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+"update:modelValue": (args_0: boolean) => any;
+confirm: () => any;
+cancel: () => any;
+closed: () => any;
+}, string, PublicProps, Readonly<__VLS_Props_4> & Readonly<{
+"onUpdate:modelValue"?: ((args_0: boolean) => any) | undefined;
+onConfirm?: (() => any) | undefined;
+onCancel?: (() => any) | undefined;
+onClosed?: (() => any) | undefined;
+}>, {
+title: string;
+dialogClass: string;
+width: string | number;
+maxHeight: string | number;
+loading: boolean;
+confirmLoading: boolean;
+confirmDisabled: boolean;
+showFooter: boolean;
+showCancel: boolean;
+showConfirm: boolean;
+showClose: boolean;
+cancelText: string;
+confirmText: string;
+destroyOnClose: boolean;
+closeOnClickModal: boolean;
+closeOnPressEscape: boolean;
+alignCenter: boolean;
+draggable: boolean;
+dragOverflow: boolean;
+flushContentVertical: boolean;
+}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+
+declare type __VLS_Props = {
+    modelValue: DesignerDocument;
+    initialDataModel?: DesignerInitialDataModel;
+    adapters?: DesignerRuntimeAdapters;
+    adapterContext?: FormRuntimeAdapterContext;
+    /** @deprecated 请使用 adapters。 */
+    runtimeAdapters?: DesignerRuntimeAdapters;
+};
+
+declare type __VLS_Props_2 = {
+    document: DesignerDocument;
+    modelValue?: DesignerRuntimeValueStore;
+    mode?: Exclude<DesignerRuntimeMode, 'DESIGN'>;
+    device?: DesignerDevice;
+    adapters?: DesignerRuntimeAdapters;
+    adapterContext?: FormRuntimeAdapterContext;
+    activeModule?: string;
+    /** @deprecated 请使用 activeModule。 */
+    initialOverlayCode?: string;
+    overlayOnly?: boolean;
+    showToolbar?: boolean;
+};
+
+declare type __VLS_Props_3 = {
+    /** 随包发布的 Remix Icon 名称，例如 `ri:add-line`。 */
+    icon?: string;
+};
+
+declare type __VLS_Props_4 = {
+    modelValue: boolean;
+    title?: string;
+    dialogClass?: string;
+    width?: string | number;
+    maxHeight?: string | number;
+    loading?: boolean;
+    confirmLoading?: boolean;
+    confirmDisabled?: boolean;
+    showFooter?: boolean;
+    showCancel?: boolean;
+    showConfirm?: boolean;
+    showClose?: boolean;
+    cancelText?: string;
+    confirmText?: string;
+    destroyOnClose?: boolean;
+    closeOnClickModal?: boolean;
+    closeOnPressEscape?: boolean;
+    alignCenter?: boolean;
+    draggable?: boolean;
+    dragOverflow?: boolean;
+    flushContentVertical?: boolean;
+};
+
+declare function __VLS_template(): {
+    attrs: Partial<{}>;
+    slots: {
+        'header-leading'?(_: {}): any;
+    };
+    refs: {
+        workspaceRef: HTMLDivElement;
+        canvasRef: CreateComponentPublicInstanceWithMixins<Readonly<{
+        document: DesignerDocument;
+        selectedNodeId: string;
+        device: DesignerDevice;
+        viewportWidth?: number;
+        zoom: number;
+        gridVisible: boolean;
+        activeModule?: DesignerOverlayModule;
+        }> & Readonly<{
+        onSelect?: ((nodeId: string) => any) | undefined;
+        onRemove?: ((nodeId: string) => any) | undefined;
+        onDrop?: ((payload: string, target: DesignerDropTarget) => any) | undefined;
+        onDuplicate?: ((nodeId: string) => any) | undefined;
+        onReorder?: ((containerId: string | null, slotCode: string, nodes: DesignerLayoutNode[]) => any) | undefined;
+        "onDrag-start"?: (() => any) | undefined;
+        "onDrag-end"?: (() => any) | undefined;
+        "onUpdate:zoom"?: ((zoom: number) => any) | undefined;
+        }>, {
+        fitToWidth: () => void;
+        captureViewport: () => {
+        horizontal: number;
+        vertical: number;
+        };
+        restoreViewport: (position: {
+        horizontal: number;
+        vertical: number;
+        }) => Promise<void>;
+        }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+        select: (nodeId: string) => any;
+        remove: (nodeId: string) => any;
+        drop: (payload: string, target: DesignerDropTarget) => any;
+        duplicate: (nodeId: string) => any;
+        reorder: (containerId: string | null, slotCode: string, nodes: DesignerLayoutNode[]) => any;
+        "drag-start": () => any;
+        "drag-end": () => any;
+        "update:zoom": (zoom: number) => any;
+        }, PublicProps, {}, false, {}, {}, GlobalComponents, GlobalDirectives, string, {
+        canvasRef: HTMLElement;
+        stageRef: HTMLDivElement;
+        surfaceRef: unknown;
+        }, HTMLElement, ComponentProvideOptions, {
+        P: {};
+        B: {};
+        D: {};
+        C: {};
+        M: {};
+        Defaults: {};
+        }, Readonly<{
+        document: DesignerDocument;
+        selectedNodeId: string;
+        device: DesignerDevice;
+        viewportWidth?: number;
+        zoom: number;
+        gridVisible: boolean;
+        activeModule?: DesignerOverlayModule;
+        }> & Readonly<{
+        onSelect?: ((nodeId: string) => any) | undefined;
+        onRemove?: ((nodeId: string) => any) | undefined;
+        onDrop?: ((payload: string, target: DesignerDropTarget) => any) | undefined;
+        onDuplicate?: ((nodeId: string) => any) | undefined;
+        onReorder?: ((containerId: string | null, slotCode: string, nodes: DesignerLayoutNode[]) => any) | undefined;
+        "onDrag-start"?: (() => any) | undefined;
+        "onDrag-end"?: (() => any) | undefined;
+        "onUpdate:zoom"?: ((zoom: number) => any) | undefined;
+        }>, {
+        fitToWidth: () => void;
+        captureViewport: () => {
+        horizontal: number;
+        vertical: number;
+        };
+        restoreViewport: (position: {
+        horizontal: number;
+        vertical: number;
+        }) => Promise<void>;
+        }, {}, {}, {}, {}> | null;
+        importInputRef: HTMLInputElement;
+    };
+    rootEl: HTMLElement;
+};
+
+declare function __VLS_template_2(): {
+    attrs: Partial<{}>;
+    slots: {
+        default?(_: {}): any;
+        footer?(_: {
+            busy: boolean;
+            close: typeof requestClose;
+            confirm: typeof requestConfirm;
+        }): any;
+    };
+    refs: {};
+    rootEl: any;
+};
+
+declare type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+
+declare type __VLS_TemplateResult_2 = ReturnType<typeof __VLS_template_2>;
+
+declare type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+
+declare type __VLS_WithTemplateSlots_2<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+
+/** 返回与 Vue 代理隔离的当前文档。 */
+declare function currentDocument(): DesignerDocument;
+
+/** Vue 3 全局安装入口；按需使用时可以直接导入具名组件。 */
+declare const DaxiangFormVue: Plugin_2;
+export { DaxiangFormVue }
+export default DaxiangFormVue;
+
+/** 设计画布的受控视口档位。 */
+export declare type DesignerCanvasViewportPreset = 'FIT' | 'PC_1920' | 'PC_1440' | 'PC_1280' | 'PC_1024' | 'MOBILE_440' | 'MOBILE_375';
+
+export declare const FormDesigner: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+
+export declare const FormIcon: DefineComponent<__VLS_Props_3, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<__VLS_Props_3> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+
+export declare const FormModalShell: __VLS_WithTemplateSlots_2<typeof __VLS_component_2, __VLS_TemplateResult_2["slots"]>;
+
+export declare const FormRenderer: DefineComponent<__VLS_Props_2, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+"update:modelValue": (value: DesignerRuntimeValueStore) => any;
+submit: (projection: DesignerSubmissionProjection) => any;
+reset: (value: DesignerRuntimeValueStore) => any;
+"runtime-warning": (message: string) => any;
+action: (action: "SUBMIT" | "RESET" | "PRINT") => any;
+"overlay-closed": () => any;
+"overlay-open-failed": (message: string) => any;
+}, string, PublicProps, Readonly<__VLS_Props_2> & Readonly<{
+"onUpdate:modelValue"?: ((value: DesignerRuntimeValueStore) => any) | undefined;
+onSubmit?: ((projection: DesignerSubmissionProjection) => any) | undefined;
+onReset?: ((value: DesignerRuntimeValueStore) => any) | undefined;
+"onRuntime-warning"?: ((message: string) => any) | undefined;
+onAction?: ((action: "SUBMIT" | "RESET" | "PRINT") => any) | undefined;
+"onOverlay-closed"?: (() => any) | undefined;
+"onOverlay-open-failed"?: ((message: string) => any) | undefined;
+}>, {
+mode: Exclude<DesignerRuntimeMode, "DESIGN">;
+device: DesignerDevice;
+adapterContext: FormRuntimeAdapterContext;
+activeModule: string;
+initialOverlayCode: string;
+overlayOnly: boolean;
+showToolbar: boolean;
+}, {}, {}, {}, string, ComponentProvideOptions, false, {}, HTMLDivElement>;
+
+/** 替换文档时重新执行一次性参数判定，并刷新只读来源索引。 */
+declare function replaceDocument(document: DesignerDocument, keepHistory?: boolean): void;
+
+declare function requestClose(): void;
+
+declare function requestConfirm(): void;
+
+export { }