@jxyszb/jxy-form-designer 0.1.0

package/types/index.d.ts

@@ -0,0 +1,345 @@
+import type { Component, DefineComponent, Plugin } from 'vue';
+import type { StoreDefinition } from 'pinia';
+
+export type JxyFormData = Record<string, unknown>;
+export type JxyComponentRegistry = Record<string, Component>;
+
+export interface JxyOption {
+  label: string;
+  value: unknown;
+  disabled?: boolean;
+  children?: JxyOption[];
+  [key: string]: unknown;
+}
+
+export interface JxyDataSourceProvider {
+  loadDictOptions?(dictType: string, dictUrl: string): Promise<JxyOption[]>;
+  loadApiOptions?(url: string, params?: Record<string, unknown>): Promise<JxyOption[]>;
+  clearDictCache?(dictUrl?: string): void;
+  listApiSources?(): unknown[];
+}
+
+export type JxyRequestClient = (config: Record<string, unknown>) => Promise<unknown>;
+
+export interface JxyFormPluginOptions {
+  request?: JxyRequestClient;
+  dataSourceProvider?: JxyDataSourceProvider;
+  components?: {
+    fileUpload?: Component;
+    editor?: Component;
+  };
+}
+
+export interface JxyDataSourceConfig {
+  dictUrl?: string;
+  [key: string]: unknown;
+}
+
+export interface JxyStaticDataSource {
+  id: string;
+  name: string;
+  type: 'static';
+  options: JxyOption[];
+}
+
+export interface JxyDictDataSource {
+  id: string;
+  name: string;
+  type: 'dict';
+  dictType: string;
+}
+
+export interface JxyApiParam {
+  key: string;
+  valueType: 'field' | 'constant';
+  field?: string;
+  value?: unknown;
+  required?: boolean;
+}
+
+export interface JxyApiDataSource {
+  id: string;
+  name: string;
+  type: 'api';
+  url: string;
+  params: JxyApiParam[];
+  apiKey?: string;
+}
+
+export type JxyDataSource = JxyStaticDataSource | JxyDictDataSource | JxyApiDataSource;
+
+export interface JxyTitleNode {
+  id: string;
+  nodeType: 'title';
+  sort?: number;
+  title: string;
+  description?: string;
+  level?: number;
+  customClass?: string;
+}
+
+export interface JxyFieldSuffixExtension {
+  enabled?: boolean;
+  width?: number | '';
+  [key: string]: unknown;
+}
+
+export interface JxyFieldExtensions {
+  suffix?: JxyFieldSuffixExtension;
+  [key: string]: unknown;
+}
+
+export interface JxyFieldNode {
+  id: string;
+  nodeType: 'field';
+  sort?: number;
+  prop: string;
+  label: string;
+  type: string;
+  defaultValue?: unknown;
+  placeholder?: string;
+  required?: boolean;
+  disabled?: boolean;
+  hidden?: boolean;
+  labelWidth?: number | '';
+  customClass?: string;
+  dataSourceId?: string;
+  componentKey?: string;
+  componentProps?: Record<string, unknown>;
+  props?: Record<string, unknown>;
+  validations?: Array<Record<string, unknown>>;
+  extensions?: JxyFieldExtensions;
+}
+
+export interface JxyGridColumn {
+  id: string;
+  sort?: number;
+  span: number;
+  labelWidth?: number | '';
+  customClass?: string;
+  children: JxyFieldNode[];
+}
+
+export interface JxyGridNode {
+  id: string;
+  nodeType: 'grid';
+  sort?: number;
+  gutter?: number;
+  labelWidth?: number | '';
+  customClass?: string;
+  columns: JxyGridColumn[];
+}
+
+export type JxyFormNode = JxyTitleNode | JxyFieldNode | JxyGridNode;
+
+export interface JxyReaction {
+  id: string;
+  sourceField: string;
+  condition?: Record<string, unknown>;
+  effects: Array<Record<string, unknown>>;
+}
+
+export interface JxyFormSchema {
+  schemaVersion: string;
+  meta: Record<string, unknown>;
+  config: Record<string, unknown>;
+  dataSourceConfig?: JxyDataSourceConfig;
+  dataSources: JxyDataSource[];
+  reactions: JxyReaction[];
+  nodes: JxyFormNode[];
+  [key: string]: unknown;
+}
+
+export interface JxyValidationResult {
+  valid: boolean;
+  errors: string[];
+  warnings: string[];
+}
+
+export interface JxySchemaError {
+  type: string;
+  message: string;
+  component?: string;
+  field?: string;
+  [key: string]: unknown;
+}
+
+export interface JxyDataSourceError {
+  prop: string;
+  error: unknown;
+}
+
+export interface JxyFieldChangePayload {
+  prop: string;
+  value: unknown;
+  oldValue: unknown;
+}
+
+export interface JxyFieldSuffixSlotScope {
+  field: JxyFieldNode;
+  fieldId: string;
+  prop: string;
+  label: string;
+  value: unknown;
+  disabled: boolean;
+  required: boolean;
+}
+
+export interface JxyFieldSuffixSlots {
+  'field-suffix'?: (scope: JxyFieldSuffixSlotScope) => unknown;
+}
+
+export interface JxyPreviewActionSlots {
+  'preview-actions'?: () => unknown;
+}
+
+export interface JxyFormDesignerSlots extends JxyFieldSuffixSlots, JxyPreviewActionSlots {}
+export interface JxyRuntimePreviewPanelSlots extends JxyFieldSuffixSlots, JxyPreviewActionSlots {}
+
+export interface JxyFormDesignerProps {
+  dataSourceProvider?: JxyDataSourceProvider | null;
+  componentRegistry?: JxyComponentRegistry;
+}
+
+export interface JxyFormDesignerExpose {
+  getSchema(): JxyFormSchema;
+  loadSchema(schema: JxyFormSchema): void;
+  saveDraft(): { success: true };
+  publish(): { success: boolean; errors?: string[]; warnings?: string[] };
+}
+
+export interface JxyFormRuntimeProps {
+  schema: JxyFormSchema;
+  modelValue?: JxyFormData;
+  disabled?: boolean;
+  dataSourceProvider?: JxyDataSourceProvider | null;
+  componentRegistry?: JxyComponentRegistry;
+}
+
+export interface JxyFormRuntimeEmits {
+  (event: 'update:modelValue', value: JxyFormData): void;
+  (event: 'field-change', payload: JxyFieldChangePayload): void;
+  (event: 'data-source-error', payload: JxyDataSourceError): void;
+  (event: 'schema-error', payload: JxySchemaError): void;
+}
+
+export interface JxyFormRuntimeExpose {
+  validate(): Promise<boolean>;
+  getData(): JxyFormData;
+  setData(data: JxyFormData): Promise<void>;
+  resetFields(): Promise<void>;
+  clearValidate(prop?: string | string[]): void;
+  reloadOptions(prop: string): Promise<void>;
+  getOptions(prop: string): JxyOption[];
+}
+
+export interface JxyRuntimePreviewPanelProps {
+  schema: JxyFormSchema;
+  dataSourceProvider?: JxyDataSourceProvider | null;
+  disabled?: boolean;
+  componentRegistry?: JxyComponentRegistry;
+  showActions?: boolean;
+  layout?: 'default' | 'dialog';
+}
+
+export interface JxyRuntimePreviewPanelExpose {
+  validate(): Promise<boolean> | undefined;
+  resetFields(): Promise<void> | undefined;
+  getData(): JxyFormData | undefined;
+}
+
+export type JxyFormDesignerComponent = DefineComponent<JxyFormDesignerProps> & {
+  new (): JxyFormDesignerExpose & {
+    $props: JxyFormDesignerProps;
+    $slots: JxyFormDesignerSlots;
+  };
+};
+
+export type JxyFormRuntimeComponent = DefineComponent<JxyFormRuntimeProps> & {
+  new (): JxyFormRuntimeExpose & {
+    $props: JxyFormRuntimeProps;
+    $emit: JxyFormRuntimeEmits;
+    $slots: JxyFieldSuffixSlots;
+  };
+};
+
+export type JxyRuntimePreviewPanelComponent = DefineComponent<JxyRuntimePreviewPanelProps> & {
+  new (): JxyRuntimePreviewPanelExpose & {
+    $props: JxyRuntimePreviewPanelProps;
+    $slots: JxyRuntimePreviewPanelSlots;
+  };
+};
+
+export const JXYFormDesigner: JxyFormDesignerComponent;
+export const JXYFormRuntime: JxyFormRuntimeComponent;
+export const JXYRuntimePreviewPanel: JxyRuntimePreviewPanelComponent;
+
+export function createJxyFormPlugin(options?: JxyFormPluginOptions): Plugin;
+export function createRequestDataSourceProvider(requestClient: JxyRequestClient): JxyDataSourceProvider;
+
+export interface JxyFormDesignerStoreState {
+  schema: JxyFormSchema;
+  selectedNodeId: string;
+  readonly selectedNode: JxyFormNode | null;
+  activePanel: string;
+  clipboard: JxyFormNode | null;
+  draggingState: Record<string, unknown>;
+  canvasState: Record<string, unknown>;
+  history: Record<string, unknown>;
+  readonly canUndo: boolean;
+  readonly canRedo: boolean;
+  readonly allFieldNodes: JxyFieldNode[];
+  readonly allFieldProps: string[];
+}
+
+export interface JxyFormDesignerStoreActions {
+  undo(): void;
+  redo(): void;
+  selectNode(id: string): void;
+  clearSelection(): void;
+  addNodeFromPalette(item: Record<string, unknown>, targetList: JxyFormNode[], index: number): void;
+  deleteNode(id: string): boolean;
+  deleteSelectedNode(): boolean;
+  copyNode(id?: string): void;
+  pasteNode(targetList: JxyFormNode[], index: number): void;
+  updateNodeProp(key: string, value: unknown): void;
+  onDragSortEnd(): void;
+  addDataSource(dataSource: JxyDataSource): void;
+  removeDataSource(id: string): void;
+  updateDataSource(id: string, updates: Partial<JxyDataSource>): void;
+  addReaction(reaction: JxyReaction): void;
+  removeReaction(id: string): void;
+  updateReaction(id: string, updates: Partial<JxyReaction>): void;
+  updateFormConfig(key: string, value: unknown): void;
+  updateFormMeta(key: string, value: unknown): void;
+  updateDataSourceConfig(key: string, value: unknown): void;
+  loadSchema(schema: JxyFormSchema): void;
+  resetSchema(): void;
+  initDesigner(): void;
+  saveDraft(): { success: true };
+  publish(): { success: boolean; errors?: string[]; warnings?: string[] };
+  validateDraft(): JxyValidationResult;
+  getPublishedSchema(formCode: string): JxyFormSchema | null;
+  setActivePanel(panel: string): void;
+}
+
+export const useFormDesignerStore: StoreDefinition<
+  'jxyFormDesigner',
+  JxyFormDesignerStoreState,
+  Record<string, never>,
+  JxyFormDesignerStoreActions
+>;
+
+export const SCHEMA_VERSION: string;
+export const COMPONENT_GROUPS: Array<Record<string, unknown>>;
+export function createDefaultSchema(): JxyFormSchema;
+export function createFieldNode(type: string): JxyFieldNode;
+export function createTitleNode(): JxyTitleNode;
+export function createGridNode(columnCount?: number): JxyGridNode;
+export function createNodeFromPaletteItem(item: Record<string, unknown>): JxyFormNode;
+export function migrateSchema(schema: JxyFormSchema): { schema: JxyFormSchema; warnings: string[] };
+export function normalizeImport(input: string | JxyFormSchema): { schema: JxyFormSchema; errors: string[]; warnings: string[] };
+export function validateJxyFormSchema(schema: JxyFormSchema, options?: { mode?: 'draft' | 'publish' }): JxyValidationResult;
+
+declare const pluginFactory: typeof createJxyFormPlugin;
+export default pluginFactory;

package/types/runtime.d.ts

@@ -0,0 +1,22 @@
+export {
+  JXYFormRuntime,
+  JXYRuntimePreviewPanel,
+  createRequestDataSourceProvider
+} from './index';
+export type {
+  JxyDataSourceProvider,
+  JxyRequestClient,
+  JxyFormRuntimeProps,
+  JxyFormRuntimeEmits,
+  JxyFormRuntimeExpose,
+  JxyRuntimePreviewPanelProps,
+  JxyRuntimePreviewPanelExpose,
+  JxySchemaError,
+  JxyDataSourceError,
+  JxyFieldChangePayload,
+  JxyFieldSuffixSlotScope,
+  JxyFieldSuffixSlots,
+  JxyPreviewActionSlots,
+  JxyRuntimePreviewPanelSlots
+} from './index';
+export { JXYFormRuntime as default } from './index';

package/types/schema.d.ts

@@ -0,0 +1,31 @@
+export {
+  SCHEMA_VERSION,
+  COMPONENT_GROUPS,
+  createDefaultSchema,
+  createFieldNode,
+  createTitleNode,
+  createGridNode,
+  createNodeFromPaletteItem,
+  migrateSchema,
+  normalizeImport,
+  validateJxyFormSchema
+} from './index';
+export type {
+  JxyFormSchema,
+  JxyValidationResult,
+  JxyOption,
+  JxyDataSourceConfig,
+  JxyDataSource,
+  JxyStaticDataSource,
+  JxyDictDataSource,
+  JxyApiDataSource,
+  JxyApiParam,
+  JxyFormNode,
+  JxyTitleNode,
+  JxyGridNode,
+  JxyGridColumn,
+  JxyFieldNode,
+  JxyFieldExtensions,
+  JxyFieldSuffixExtension,
+  JxyReaction
+} from './index';

package/types/testing.d.ts

@@ -0,0 +1,3 @@
+import type { JxyDataSourceProvider, JxyFormSchema } from './index';
+export const mockDataSourceProvider: JxyDataSourceProvider;
+export const DEMO_SCHEMA: JxyFormSchema;