gubersail-platform-ui/src/components/order-form/events.js

/**
 * @fileoverview 订单表单模块事件常量定义
 * @description 定义订单表单组件使用的所有事件名常量，确保事件名的一致性和可维护性
 */

/**
 * 通用事件常量
 * @readonly
 * @enum {string}
 */
export const COMMON_EVENTS = {
  /** 输入事件 */
  INPUT: 'input',
  /** 变更事件 */
  CHANGE: 'change',
  /** 清空事件 */
  CLEAR: 'clear',
  /** 获得焦点事件 */
  FOCUS: 'focus',
  /** 失去焦点事件 */
  BLUR: 'blur'
}

/**
 * 对话框事件常量
 * @readonly
 * @enum {string}
 */
export const DIALOG_EVENTS = {
  /** 更新可见性事件 */
  UPDATE_VISIBLE: 'update:visible',
  /** 确认事件 */
  CONFIRM: 'confirm',
  /** 取消事件 */
  CANCEL: 'cancel'
}

/**
 * 客户选择组件事件常量
 * @readonly
 * @enum {string}
 */
export const CUSTOMER_SELECT_EVENTS = {
  /** 客户选择事件 */
  CUSTOMER_SELECTED: 'customer-selected'
}

/**
 * 地址选择组件事件常量
 * @readonly
 * @enum {string}
 */
export const ADDRESS_SELECT_EVENTS = {
  /** 地址选择事件 */
  ADDRESS_SELECTED: 'address-selected'
}

/**
 * 物料明细表格事件常量
 * @readonly
 * @enum {string}
 */
export const MATERIAL_DETAIL_EVENTS = {
  /** 刷新事件 */
  REFRESH: 'refresh',
  /** 物料导入事件 */
  MATERIAL_IMPORT: 'material-import',
  /** 物料删除事件 */
  MATERIAL_DELETE: 'material-delete',
  /** 物料更新事件 */
  MATERIAL_UPDATE: 'material-update',
  /** 物料批量删除事件 */
  MATERIAL_BATCH_DELETE: 'material-batch-delete'
}

/**
 * 订单表单事件常量
 * @readonly
 */
export const ORDER_FORM_EVENTS = {
  /** 返回事件 */
  BACK: 'back',
  /** 保存成功事件 */
  SAVE_SUCCESS: 'save-success',
  /** 客户选择事件组 */
  CUSTOMER_SELECT: CUSTOMER_SELECT_EVENTS,
  /** 地址选择事件组 */
  ADDRESS_SELECT: ADDRESS_SELECT_EVENTS,
  /** 物料明细事件组 */
  MATERIAL_DETAIL: MATERIAL_DETAIL_EVENTS,
}

/**
 * 所有事件常量的集合
 * @description 将所有事件常量合并为一个对象，便于统一导入和使用
 * @readonly
 */
export const ALL_EVENTS = {
  ...COMMON_EVENTS,
  ...DIALOG_EVENTS,
  ...CUSTOMER_SELECT_EVENTS,
  ...ADDRESS_SELECT_EVENTS,
  ...MATERIAL_DETAIL_EVENTS,
  ...ORDER_FORM_EVENTS
}

// ==================== JSDoc 类型定义 ====================

/**
 * 通用事件类型
 * @typedef {'input'|'change'|'clear'|'focus'|'blur'} CommonEventType
 */

/**
 * 对话框事件类型
 * @typedef {'update:visible'|'confirm'|'cancel'} DialogEventType
 */

/**
 * 客户选择事件类型
 * @typedef {'customer-selected'} CustomerSelectEventType
 */

/**
 * 地址选择事件类型
 * @typedef {'address-selected'} AddressSelectEventType
 */

/**
 * 物料明细事件类型
 * @typedef {'refresh'|'material-import'|'material-delete'|'material-update'|'material-batch-delete'} MaterialDetailEventType
 */

/**
 * 订单表单事件类型
 * @typedef {'back'|'save-success'} OrderFormEventType
 */

/**
 * 所有事件类型的联合类型
 * @typedef {CommonEventType|DialogEventType|CustomerSelectEventType|AddressSelectEventType|MaterialDetailEventType|OrderFormEventType} AllEventType
 */