aegon-lv82 1.0.0

package/src/types/gen-ai/build-report/reportEditor.ts

@@ -0,0 +1,684 @@
+/** 章節狀態：PENDING 未生成 / EDITING 編輯中 / CREATED 已生成 */
+export type GenAiSectionLatestStatus = 'PENDING' | 'EDITING' | 'CREATED'
+
+/** 查詢章節下拉列表 - 請求參數 */
+export interface GenAiGetSectionListParams {
+  /** 報告ID */
+  instanceId: string
+}
+
+/** 章節下拉項 */
+export interface GenAiReportSectionItem {
+  /** 報告ID */
+  instanceId: string
+  /** 章節ID */
+  sectionId: string
+  /** 章節順序 */
+  orderSeq: number
+  /** 章節名稱 */
+  sectionName: string
+  /** 章節描述 */
+  sectionDesc: string
+  /** 章節狀態 */
+  latestStatus: GenAiSectionLatestStatus
+}
+
+/** 查詢章節下拉列表 - 響應 */
+export interface GenAiGetSectionListResponse {
+  success: boolean
+  message: string
+  code: string
+  data: GenAiReportSectionItem[]
+}
+
+/** 更新章節順序 - 單項 */
+export interface GenAiUpdateSectionOrderItem {
+  /** 報告ID */
+  instanceId: string
+  /** 章節ID */
+  sectionId: string
+  /** 調整後章節的新順序 */
+  orderSeq: number
+}
+
+/** 更新章節順序 - 請求參數 */
+export interface GenAiUpdateSectionOrderParams {
+  sections: GenAiUpdateSectionOrderItem[]
+}
+
+/** 更新章節順序 - 響應 */
+export interface GenAiUpdateSectionOrderResponse {
+  success: boolean
+  message: string
+  code: string
+  data: null
+}
+
+/** Y/N 標誌位（後臺慣例，非 boolean） */
+export type GenAiYnFlag = 'Y' | 'N'
+
+/** 查詢版本列表 - 請求參數 */
+export interface GenAiGetSectionVersionListParams {
+  /** 報告ID */
+  instanceId: string
+  /** 章節ID */
+  sectionId: string
+}
+
+/**
+ * 生成表格信息
+ * 調試：chartAsStream 帶 enableTable Y/N；舊接口無表格時可為 null
+ */
+export interface GenAiSectionTableInfo {
+  /** Y=勾選生成表格 / N=未勾選 */
+  enableTable?: GenAiYnFlag
+  /** 表格標題 */
+  tableTitle: string
+  /** 列標籤 */
+  columnLabel: string
+  /** 欄標籤 */
+  barLabel: string
+  /** 內容 */
+  content: string
+}
+
+/**
+ * 引用資訊源圖表信息
+ * 調試：chartAsStream 帶 enableChart Y/N；舊接口無圖表時可為 null
+ */
+export interface GenAiSectionChartInfo {
+  /** Y=勾選引用圖表 / N=未勾選 */
+  enableChart?: GenAiYnFlag
+  /** 圖表描述 */
+  chartDesc: string
+}
+
+/**
+ * 正文引用 tip 數據（與 chartAsStream Type:REF 同形；字段名兼容後端 chunkld 等拼寫）
+ */
+export interface ChartStreamRefRef {
+  chunkId?: string
+  chunkld?: string
+  filePath?: string
+  filePreviewUrl?: string
+  index?: number
+  sourceName?: string
+  sourceText?: string
+}
+
+/**
+ * 章節版本項（getSectionVersionList.data[]）
+ *
+ * 調試注意：
+ * 1. versionNo：章節第幾個版本；「保存」「存為草稿」須原值傳回後臺
+ * 2. draftFlag / promptByGen / backupFlag / finalizedFlag / hasOldAiContent：均為 "Y"|"N" 字符串
+ * 3. hasOldAiContent：後臺邏輯標識；「保存」「存為草稿」須原值傳回後臺
+ * 4. tableInfo / chartInfo：沒有時為 null
+ * 5. seq / promptDetailExt：文檔標註可忽略
+ */
+export interface GenAiSectionVersionItem {
+  /** 忽略 */
+  seq: number
+  /** 版本名稱（如 V2） */
+  objectName: string
+  /** 版本名稱更新人信息 */
+  updateUserId: string
+  /** 版本名稱更新人信息 */
+  updateUserName: string
+  /** 版本名稱更新人信息 */
+  updateUserUnitSeq: string
+  /** 版本更新時間 */
+  updateDatetime: string
+  /** 報告ID */
+  instanceId: string
+  /** 章節ID */
+  sectionId: string
+  /** 版本ID */
+  versionId: string
+  /**
+   * 版本號（即：章節的第幾個版本）
+   * 調試：「保存」和「存為草稿」時，需原值傳回後臺
+   */
+  versionNo: number
+  /** 是否草稿（"Y" 是草稿，否則不是） */
+  draftFlag: GenAiYnFlag
+  /** prompt 內容 */
+  promptDetail: string
+  /** prompt 是否通過 AI 生成（"Y" 是，否則不是） */
+  promptByGen: GenAiYnFlag
+  /** 字數限制 */
+  contentLengthLimit: number
+  /** 章節正文 */
+  contentText: string
+  /**
+   * 引用片段（與 chartAsStream Type:REF 同形；字段名 refList）
+   * 靜態預覽時用 chunkId 匹配正文 [ref:uuid] → tip
+   */
+  refList?: ChartStreamRefRef | ChartStreamRefRef[] | string | null
+  /** @deprecated 請用 refList */
+  Ref?: ChartStreamRefRef | ChartStreamRefRef[] | string | null
+  ref?: ChartStreamRefRef | ChartStreamRefRef[] | string | null
+  refs?: ChartStreamRefRef | ChartStreamRefRef[] | string | null
+  /** 用到的文件 ID 列表 */
+  fileIndexIdList: string[]
+  /** 版本創建人信息 */
+  createdUserId: string
+  /** 版本創建人信息 */
+  createdUserName: string
+  /** 版本創建人信息 */
+  createdUserUnitSeq: string
+  /** 版本創建時間 */
+  createdDatetime: string
+  /** 是否備份版本（"Y" 是，否則不是） */
+  backupFlag: GenAiYnFlag
+  /** 忽略 */
+  promptDetailExt: string
+  /** 生成表格信息（如果沒有的話，對象值為 null） */
+  tableInfo: GenAiSectionTableInfo | null
+  /** 引用資訊源圖表信息（如果沒有的話，對象值為 null） */
+  chartInfo: GenAiSectionChartInfo | null
+  /** 是否定稿版本（"Y" 是，否則不是） */
+  finalizedFlag: GenAiYnFlag
+  /**
+   * 是否有章節正文（"Y" 是，否則不是）
+   * 調試：後臺邏輯標識字段；「保存」和「存為草稿」時，需原值傳回後臺
+   */
+  hasOldAiContent: GenAiYnFlag
+}
+
+/** 查詢版本列表 - 響應 */
+export interface GenAiGetSectionVersionListResponse {
+  success: boolean
+  message: string
+  code: string
+  data: GenAiSectionVersionItem[]
+}
+
+/**
+ * 更新版本名稱 - 請求參數
+ * 調試：章節歷史重命名確認時調用
+ */
+export interface GenAiUpdateSectionVersionNameParams {
+  /** 類型ID */
+  categoryId: number
+  /** 要更新的版本 ID */
+  versionId: string
+  /** 更新後的版本名稱 */
+  objectName: string
+  /** 誰更新的 */
+  updateUserId: string
+  /** 誰更新的 */
+  updateUserName: string
+  /** 誰更新的 */
+  updateUserUnitSeq: string
+}
+
+/** 更新版本名稱 - 響應 */
+export interface GenAiUpdateSectionVersionNameResponse {
+  success: boolean
+  message: string
+  code: string
+  data: null
+}
+
+/**
+ * 更新章節狀態 - 操作標識
+ * 調試：傳 "EDIT" 表示將章節狀態更新為 EDITING（點「編輯」時調用）
+ */
+export type GenAiChangeSectionStatusAction = 'EDIT'
+
+/** 更新章節狀態 - 請求參數（點編輯時調用） */
+export interface GenAiChangeSectionStatusParams {
+  /** 類型ID */
+  categoryId: number
+  /** 要更新的章節的 ID */
+  sectionId: string
+  /**
+   * 操作標識
+   * 調試："EDIT" 表示將狀態更新為 EDITING
+   */
+  action: GenAiChangeSectionStatusAction
+  /** 誰更新的 */
+  updateUserId: string
+  /** 誰更新的 */
+  updateUserName: string
+  /** 誰更新的 */
+  updateUserUnitSeq: string
+}
+
+/** 更新章節狀態 - 響應 */
+export interface GenAiChangeSectionStatusResponse {
+  success: boolean
+  message: string
+  code: string
+  data: null
+}
+
+/**
+ * 版本[保存]/[存為草稿] - 請求參數
+ *
+ * 調試注意：
+ * 1. instanceId / sectionId / versionId / versionNo / hasOldAiContent：
+ *    一律用 getSectionVersionList 返回的原值，勿前端自造
+ * 2. draftFlag："N"=保存，"Y"=存為草稿
+ * 3. contentText：存草稿時可為空；後臺存草稿時不存該字段
+ * 4. promptDetail / promptByGen / contentLengthLimit / contentText /
+ *    fileIndexIdList / tableInfo / chartInfo：用戶更新後的值
+ */
+export interface GenAiSaveSectionVersionParams {
+  /** 類型ID */
+  categoryId: number
+  /** 報告ID（getSectionVersionList 原值） */
+  instanceId: string
+  /** 章節ID（getSectionVersionList 原值） */
+  sectionId: string
+  /** 版本ID（getSectionVersionList 原值） */
+  versionId: string
+  /**
+   * 版本號（即：章節的第幾個版本）
+   * 調試：getSectionVersionList 原值
+   */
+  versionNo: number
+  /**
+   * 是否草稿
+   * 調試："N"=保存，"Y"=存為草稿
+   */
+  draftFlag: GenAiYnFlag
+  /** prompt 內容（用戶更新後的值） */
+  promptDetail: string
+  /** prompt 是否通過 AI 生成（用戶更新後的值） */
+  promptByGen: GenAiYnFlag
+  /** 字數限制（用戶更新後的值） */
+  contentLengthLimit: number
+  /**
+   * 章節正文（用戶更新後的值）
+   * 調試：存草稿時可為空；後臺存草稿時不存該字段
+   */
+  contentText: string
+  /** 用到的文件 ID 列表（用戶更新後的值） */
+  fileIndexIdList: string[]
+  /** 誰更新的 */
+  createdUserId: string
+  /** 誰更新的 */
+  createdUserName: string
+  /** 誰更新的 */
+  createdUserUnitSeq: string
+  /** 生成表格信息（用戶更新後的值；沒有可為 null） */
+  tableInfo: GenAiSectionTableInfo | null
+  /** 引用資訊源圖表信息（用戶更新後的值；沒有可為 null） */
+  chartInfo: GenAiSectionChartInfo | null
+  /**
+   * 是否有章節正文（"Y" 是，否則不是）
+   * 調試：getSectionVersionList 原值，須原值傳回後臺
+   */
+  hasOldAiContent: GenAiYnFlag
+  auditEventId?: string
+}
+
+/** 版本[保存]/[存為草稿] - 響應 */
+export interface GenAiSaveSectionVersionResponse {
+  success: boolean
+  message: string
+  code: string
+  data: null
+}
+
+/**
+ * 刪除版本及草稿 - 請求參數
+ * 調試：刪除指定 versionId；需帶上操作人信息供後臺審計
+ */
+export interface GenAiDeleteSectionVersionParams {
+  /** 要刪除的版本 ID */
+  versionId: string
+  /** 誰刪除的 */
+  updateUserId: string
+  /** 誰刪除的 */
+  updateUserName: string
+  /** 誰刪除的 */
+  updateUserUnitSeq: string
+}
+
+/** 刪除版本及草稿 - 響應 */
+export interface GenAiDeleteSectionVersionResponse {
+  success: boolean
+  message: string
+  code: string
+  data: null
+}
+
+/**
+ * 生成章節內容 - 請求參數
+ * 調試：點「生成章節內容」；入參 = Prompt 面板全部 input + instanceId
+ */
+export interface GenAiGenerateSectionContentParams {
+  instanceId: string
+  prompt: string
+  enableBodyContent: boolean
+  bodyWordLimit: number
+  enableTable: boolean
+  tableTitle: string
+  tableRowLabels: string
+  tableColumnLabels: string
+  tableContent: string
+  enableSourceChart: boolean
+  chartDescription: string
+}
+
+/**
+ * 生成章節內容 - data
+ * 與 AdjustInstance 同形：正文取 instanceContents[].sectionContent
+ */
+export interface GenAiGenerateSectionContentData {
+  instanceContents: GenAiAdjustInstanceContent[]
+  instanceSections: GenAiAdjustInstanceSection[]
+  instanceFileList: GenAiAdjustInstanceFileItem[]
+  existsInstanceVersionNo?: string | null
+  /** 兼容舊字段 */
+  sectionContent?: string
+}
+
+/** PromptType：INSTANCE_PROMPT_DETAIL | COHERENCE_CHECK_PROMPT | AI_PROMPT */
+export type GenAiPromptType =
+  | 'INSTANCE_PROMPT_DETAIL'
+  | 'COHERENCE_CHECK_PROMPT'
+  | 'AI_PROMPT'
+
+/** @deprecated 使用 GenAiPromptType */
+export type GenAiChartAsStreamPromptType = GenAiPromptType
+
+/**
+ * 生成章節 / 報告流式 SSE POST /api/v1/ai/chartAsStream
+ * 入參對齊 ChartAsStreamDTO；event:message + data:片段；data:[DONE] 結束
+ */
+export interface GenAiChartAsStreamParams {
+  modelName: string
+  promptDetail: string
+  promptType: GenAiPromptType
+  contentLengthLimit: number | null
+  tableInfo: GenAiSectionTableInfo | null
+  chartInfo: GenAiSectionChartInfo | null
+  /** 資訊源已勾選檔案 UUID 列表（全選 / 全不選 / 部分勾選） */
+  fileIdList: string[]
+  instanceId: string
+  categoryId: number
+  temperature: number | null
+  maxTokens: number | null
+  stream: boolean
+}
+
+/**
+ * POST /api/v1/Instance/Rpt/AdjustInstance 統一入參
+ * - 報告頁：僅 instanceId
+ * - 智能化生成 Prompt：promptType=AI_PROMPT + sectionTitle/sectionDesc
+ * - 報告連貫性檢查：promptType=COHERENCE_CHECK_PROMPT + versionIdList/instanceSections
+ * - 生成章節內容（舊）：Prompt 面板字段
+ */
+export interface GenAiAdjustInstanceParams {
+  instanceId: string
+  promptType?: GenAiPromptType
+  /** AI_PROMPT：章節標題 */
+  sectionTitle?: string
+  /** AI_PROMPT：章節描述 */
+  sectionDesc?: string
+  /** COHERENCE_CHECK_PROMPT：已勾選章節版本 UUID（上→下） */
+  versionIdList?: string[]
+  /** COHERENCE_CHECK_PROMPT：已勾選章節 + 版本 */
+  instanceSections?: GenAiAdjustInstanceSection[]
+  prompt?: string
+  enableBodyContent?: boolean
+  bodyWordLimit?: number
+  enableTable?: boolean
+  tableTitle?: string
+  tableRowLabels?: string
+  tableColumnLabels?: string
+  tableContent?: string
+  enableSourceChart?: boolean
+  chartDescription?: string
+}
+
+/** 智能化生成 Prompt - AdjustInstance（promptType=AI_PROMPT） */
+export interface GenAiGenerateAiPromptParams {
+  instanceId: string
+  promptType: 'AI_PROMPT'
+  sectionTitle: string
+  sectionDesc: string
+}
+
+/** 報告連貫性檢查 - AdjustInstance（promptType=COHERENCE_CHECK_PROMPT） */
+export interface GenAiCoherenceCheckAdjustParams {
+  instanceId: string
+  promptType: 'COHERENCE_CHECK_PROMPT'
+  versionIdList: string[]
+  instanceSections: GenAiAdjustInstanceSection[]
+}
+
+/** 生成報告返回的章節內容項 */
+export interface GenAiAdjustInstanceContent {
+  /** 章節標題 */
+  sectionTitle: string
+  /** 章節正文（可含 markdown） */
+  sectionContent: string
+  /**
+   * 引用片段（與 chartAsStream Type:REF / getSectionVersionList.refList 同形）
+   * 無打字機預覽時用 chunkId 匹配 [ref:uuid] → tip
+   */
+  refList?: ChartStreamRefRef | ChartStreamRefRef[] | string | null
+  /** @deprecated 請用 refList */
+  Ref?: ChartStreamRefRef | ChartStreamRefRef[] | string | null
+  ref?: ChartStreamRefRef | ChartStreamRefRef[] | string | null
+  refs?: ChartStreamRefRef | ChartStreamRefRef[] | string | null
+}
+
+/** 章節版本選項（右側「章節版本」下拉） */
+export interface GenAiAdjustInstanceVersionOption {
+  /** 下拉展示文本，如 V1 / V3 */
+  text: string
+  /** 版本唯一標識 UUID（select 的 value） */
+  value: string
+  /**
+   * 是否選中：
+   * - 用於章節勾選推斷（無 section.selected 時）
+   * - 同時作為版本下拉默認項
+   */
+  selected: boolean | GenAiYnFlag
+  uploadUsrNameDisplay?: string
+}
+
+/** 右側「生成報告設置」章節行 */
+export interface GenAiAdjustInstanceSection {
+  /** 右側面板展示的章節名稱 */
+  sectionTitle: string
+  /**
+   * 章節是否勾選（若接口有返回則優先使用）
+   * 否則由 versions[].selected 推斷
+   */
+  selected?: boolean | GenAiYnFlag
+  /** 生成人展示名（可選；無則界面為空） */
+  createUserName?: string
+  /** 該章節可選版本列表 */
+  versions: GenAiAdjustInstanceVersionOption[]
+}
+
+/** 資訊源檔案項 */
+export interface GenAiAdjustInstanceFileItem {
+  /** 檔案名稱 */
+  text: string
+  /** 文件唯一標識 UUID */
+  value: string
+  /** 是否勾選反顯；報告歷史環節只讀不可主動改 */
+  selected: boolean | GenAiYnFlag
+}
+
+/**
+ * 生成報告 AdjustInstance - data
+ * existsInstanceVersionNo（兼容 existsInstanceVersionNO）：有值 = 已通過連貫性檢查；
+ * 同時可對照報告歷史 instanceVersionNo 選中 card
+ */
+export interface GenAiAdjustInstanceData {
+  /** 報告內容 = 章節標題 + 章節正文（中欄） */
+  instanceContents: GenAiAdjustInstanceContent[]
+  /** 右側章節列表 + 版本下拉 */
+  instanceSections: GenAiAdjustInstanceSection[]
+  /** 資訊源列表 */
+  instanceFileList: GenAiAdjustInstanceFileItem[]
+  /** 有值 = 已通過連貫性檢查；可與報告歷史 instanceVersionNo 對照選中 */
+  existsInstanceVersionNo?: string | null
+}
+
+/** 生成報告 AdjustInstance - 響應 */
+export interface GenAiAdjustInstanceResponse {
+  success: boolean
+  message: string
+  code: string
+  data: GenAiAdjustInstanceData
+}
+
+/**
+ * 報告歷史查詢 InstHistEnquiry - 請求參數
+ * 調試：報告頁「報告歷史」；參數僅 instanceId
+ */
+export interface GenAiInstHistEnquiryParams {
+  /** 報告 ID */
+  instanceId: string
+}
+
+/**
+ * 報告歷史項（data.instanceVersionVOList[]）
+ * sectionIdList / sectionVersionIdList 為逗號分隔字符串
+ */
+export interface GenAiInstanceVersionVO {
+  instanceId: string
+  /** 納入的章節 ID，逗號分隔，如 "s1,s2" */
+  sectionIdList: string
+  /** 對應章節版本 UUID，逗號分隔 */
+  sectionVersionIdList: string
+  /** 報告版本號 / 展示名（接口若返回則用於歷史標題） */
+  instanceVersionNo?: string | number | null
+  objectName?: string | null
+  createdUserId?: string
+  createdUserName?: string
+  createdUserUnitSeq?: string
+  createdDatetime?: string
+  updateUserId?: string
+  updateUserName?: string
+  updateUserUnitSeq?: string
+  updateDatetime?: string
+  /** 若有獨立版本主鍵則作列表 key */
+  instanceVersionId?: string
+}
+
+/** 報告歷史查詢 - data */
+export interface GenAiInstHistEnquiryData {
+  instanceVersionVOList: GenAiInstanceVersionVO[]
+}
+
+/** 報告歷史查詢 - 響應 */
+export interface GenAiInstHistEnquiryResponse {
+  success: boolean
+  message: string
+  code: string
+  data: GenAiInstHistEnquiryData
+}
+
+/**
+ * 調整報告設置 AdjustInstanceSetting - 請求參數
+ * 調試：勾選章節 / 拖動排序後調用；全部不選不調用
+ * versionIdList = 已勾選章節當前版本 value（UUID），順序=列表上到下
+ */
+export interface GenAiAdjustInstanceSettingParams {
+  instanceId: string
+  versionIdList: string[]
+}
+
+/** 調整報告設置 - data（切換報告歷史 / 勾選章節後刷新設置欄 + 中欄 + 資訊源） */
+export interface GenAiAdjustInstanceSettingData {
+  /** 資訊源列表（與 AdjustInstance.instanceFileList 同形） */
+  instanceFileList: GenAiAdjustInstanceFileItem[]
+  /** 有值 = 已通過連貫性檢查（兼容 existsInstanceVersionNO） */
+  existsInstanceVersionNo?: string | null
+  /** 中欄報告正文（與 AdjustInstance.instanceContents 同形；有則刷新 editor） */
+  instanceContents?: GenAiAdjustInstanceContent[]
+  /** 右側章節列表（與 AdjustInstance.instanceSections 同形；有則刷新生成報告設置） */
+  instanceSections?: GenAiAdjustInstanceSection[]
+}
+
+/** 調整報告設置 - 響應 */
+export interface GenAiAdjustInstanceSettingResponse {
+  success: boolean
+  message: string
+  code: string
+  data: GenAiAdjustInstanceSettingData
+}
+
+/**
+ * 報告定稿 FinalInstance - 請求參數
+ * 調試：生成報告設置頁點「生成報告」後調用
+ * versionIdList = 已勾選章節當前版本 value（UUID），順序=列表上到下
+ */
+export interface GenAiFinalInstanceParams {
+  instanceId: string
+  versionIdList: string[]
+}
+
+/** 報告定稿 - 響應（data 暫無固定結構） */
+export interface GenAiFinalInstanceResponse {
+  success: boolean
+  message: string
+  code: string
+  data?: unknown
+}
+
+/** 繁簡轉換目標語言：CHS=簡體，CHT=繁體 */
+export type GenAiSimTradTargetLang = 'CHS' | 'CHT'
+
+/**
+ * 繁簡轉換 SimTradTransfer - 請求參數
+ * 調試：生成報告設置「語言」下拉切換繁/簡時調用
+ */
+export interface GenAiSimTradTransferParams {
+  /** CHS=簡體中文，CHT=繁體中文 */
+  targetLang: GenAiSimTradTargetLang
+  /** 當前報告章節標題+正文（與 AdjustInstance.instanceContents 同形） */
+  instanceContents: GenAiAdjustInstanceContent[]
+}
+
+/** 繁簡轉換 - data */
+export interface GenAiSimTradTransferData {
+  instanceContents: GenAiAdjustInstanceContent[]
+}
+
+/** 繁簡轉換 - 響應 */
+export interface GenAiSimTradTransferResponse {
+  success: boolean
+  message: string
+  code: string
+  data: GenAiSimTradTransferData
+}
+
+/**
+ * 報告連貫性檢查 CoherenceCheck - 請求參數
+ * 調試：生成報告設置「報告連貫性檢查」
+ */
+export interface GenAiCoherenceCheckParams {
+  instanceId: string
+  /** 已勾選章節版本 UUID（上→下） */
+  versionIdList: string[]
+}
+
+/** 報告連貫性檢查 - data */
+export interface GenAiCoherenceCheckData {
+  /** Y=已做過連貫性檢查；N=未定稿／未檢查完 */
+  beenFinalizedFlag: string
+  /** 連貫性檢查返回文本 */
+  coherenceCheckContentText: string | null
+  /** 章節及順序已有定稿時返回報告名稱，否則 null */
+  instanceName: string | null
+}
+
+/** 報告連貫性檢查 - 響應 */
+export interface GenAiCoherenceCheckResponse {
+  success: boolean
+  message: string
+  code: string
+  data: GenAiCoherenceCheckData
+}