refactor: enum of tools

[yenche123]

Summary by CodeRabbit

• Chores

  • 各模块版本号已更新至 0.10.1。

• Refactor

  • 优化了日历和计划功能的参数处理，将部分数值参数统一为字符串格式，以提升解析和兼容性；
  • 更新了校验及枚举逻辑，简化了内部转换流程，进一步增强了功能的灵活性和稳定性。

[coderabbitai]

Walkthrough

此次更改主要涉及多个模块的版本号更新（从 0.10.0 到 0.10.1），以及对日历相关云函数中参数处理逻辑的调整。部分归一化代码被移除，同时参数的数据类型由 number 改为 string。公共类型数组与数值转换方法也作相应更新，并引入了动态枚举常量以提升代码灵活性。

Changes

文件/文件组	变更概述
lerna.json; liubai-backends/liubai-ffmpeg/package.json; liubai-backends/liubai-laf/package.json; liubai-docs/package.json; liubai-frontends/liubai-web/package.json; package.json	版本号由 0.10.0 更新至 0.10.1
liubai-backends/.../ai-entrance.ts; liubai-backends/.../ai-prompt.ts; liubai-backends/.../ai-shared.ts; liubai-backends/.../ai-system-two.ts; liubai-backends/.../common-types.ts; liubai-backends/.../common-util.ts	移除部分参数归一化逻辑；修改参数数据类型（由 number 改为 string）；更新数值转换逻辑并引入动态枚举常量

Sequence Diagram(s)

sequenceDiagram
    participant Caller as 调用者
    participant VT as ValueTransform.str2Num
    Caller->>VT: 调用 str2Num(x)
    alt x 是数字
        VT-->>Caller: 返回 {pass: true, data: x}
    else x 是字符串
        VT-->>Caller: 进行转换并返回转换结果
    end

Loading

Poem

我是一只跳跃的小兔子，
代码改进心欢喜，
版本更新如春风，
参数转换舞霓虹，
动态枚举添星彩，
开发之路永不停！
🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e5a084b and eb2ca15.

📒 Files selected for processing (12)

• lerna.json (1 hunks)
• liubai-backends/liubai-ffmpeg/package.json (1 hunks)
• liubai-backends/liubai-laf/cloud-functions/ai-entrance.ts (1 hunks)
• liubai-backends/liubai-laf/cloud-functions/ai-prompt.ts (2 hunks)
• liubai-backends/liubai-laf/cloud-functions/ai-shared.ts (4 hunks)
• liubai-backends/liubai-laf/cloud-functions/ai-system-two.ts (6 hunks)
• liubai-backends/liubai-laf/cloud-functions/common-types.ts (2 hunks)
• liubai-backends/liubai-laf/cloud-functions/common-util.ts (3 hunks)
• liubai-backends/liubai-laf/package.json (1 hunks)
• liubai-docs/package.json (1 hunks)
• liubai-frontends/liubai-web/package.json (1 hunks)
• package.json (1 hunks)

🔇 Additional comments (29)

package.json (1)

4-4: 版本号更新确认：
在此处将版本号从 "0.10.0" 更新为 "0.10.1"，符合统一发布策略。请确认这一变更与后续依赖的版本管理及发布流程保持一致。

lerna.json (1)

2-2: 统一版本管理：
将 "lerna.json" 中的版本号更新为 "0.10.1"，确保各子包版本与主版本保持一致。

liubai-docs/package.json (1)

4-4: 文档中心版本升级：
将文档中心的版本号更新为 "0.10.1"，请确保文档构建流程（如 vitepress 配置）能正常适应此版本更新。

liubai-backends/liubai-ffmpeg/package.json (1)

4-4: 后端 ffmpeg 项目版本升级：
此处版本号更新为 "0.10.1"，请确认与 FFmpeg 相关的依赖及自动化测试在升级后仍能正常工作。

liubai-backends/liubai-laf/package.json (1)

4-4: 后端 Laf 项目版本升级：
版本号已更新为 "0.10.1"，与其它项目保持一致。请确保更改不会影响到依赖此模块的工具枚举逻辑及 API 调用。

liubai-frontends/liubai-web/package.json (1)

4-4: 版本号更新正确

版本号已从 "0.10.0" 更新到 "0.10.1"，这是一个小版本更新，表示有向后兼容的更改或改进。这与PR概述中提到的版本更新保持一致。

liubai-backends/liubai-laf/cloud-functions/ai-entrance.ts (1)

733-733: 注释了日志输出语句

您注释掉了打印最后10个提示信息的日志语句。这是一个好的改变，可以减少不必要的日志输出，提高性能。但请确保在调试时可以方便地取消注释。

liubai-backends/liubai-laf/cloud-functions/ai-prompt.ts (3)

937-939: 类型更改：earlyMinute从number变为string类型

此更改将aiTools数组中add_calendar函数参数earlyMinute的类型从number改为string，与枚举常量aiToolAddCalendarEarlyMinutes保持一致。这提高了代码的灵活性，允许更多样化的输入格式处理。

---

942-943: 类型更改：laterHour从number变为string类型

将laterHour的类型从number修改为string，与枚举常量aiToolAddCalendarLaterHours保持一致。这是枚举工具重构的一部分，增强了参数处理的统一性。

---

963-964: 类型更改：hoursFromNow从number变为string类型

将get_schedule函数的hoursFromNow参数类型从number改为string，与枚举常量aiToolGetScheduleHoursFromNow保持一致。这项改动与其他类似参数的类型变更保持一致性，使代码更加统一和可维护。

liubai-backends/liubai-laf/cloud-functions/ai-shared.ts (4)

1042-1044: 添加数字到字符串的转换逻辑

为确保API一致性，添加了当hoursFromNow已经是数字类型时将其转换为字符串的逻辑。这项改动很好地配合了ai-prompt.ts中参数类型的变更，确保了类型处理的一致性。

---

1053-1058: 优化参数处理：提取和转换hoursFromNow

代码重构将参数处理流程优化为"先提取字符串，再转换为数字"的模式：

1. 从funcJson中提取hoursFromNow并重命名为strHoursFromNow
2. 使用ValueTransform.str2Num将字符串转换为数字
3. 根据转换结果设置最终使用的值

这种处理方式增强了代码的健壮性，可以灵活处理不同格式的输入值。

---

1437-1439: 参数命名规范化：earlyMinute和laterHour

将earlyMinute和laterHour重命名为strEarlyMinute和strLaterHour，明确表示这些是字符串类型的参数，提高了代码的可读性和自解释性。

---

1445-1448: 增强类型处理：字符串到数字的转换

添加了使用ValueTransform.str2Num将字符串参数转换为数字值的逻辑：

1. 将strEarlyMinute转换为数字类型的earlyMinute
2. 将strLaterHour转换为数字类型的laterHour
3. 当转换不成功时设置为undefined

这种处理方式确保了在需要数值计算时有正确的数据类型，同时保持了API层面的灵活性。

liubai-backends/liubai-laf/cloud-functions/common-util.ts (2)

364-370: 增强了对数字类型的直接处理逻辑

在str2Num方法中添加了对数字类型的直接处理，提高了函数的健壮性，避免了不必要的转换操作。这是一个很好的改进，使得函数能够处理更多的输入类型情况。

---

3182-3183: 优化了参数命名和类型转换逻辑

1. 将earlyMinute和laterHour重命名为strEarlyMinute和strLaterHour，明确标识这些是字符串类型的输入。
2. 引入了resEarlyMinute和resLaterHour变量来存储类型转换的结果，并通过条件表达式确保只有在转换成功时才使用转换后的数值。

这些变更提高了代码的类型安全性和可读性，使参数处理逻辑更加清晰。

Also applies to: 3197-3200

liubai-backends/liubai-laf/cloud-functions/common-types.ts (3)

742-742: 类型定义改进：将数值常量转换为字符串常量

这个更改将 aiToolAddCalendarEarlyMinutes 数组中的数值转换为字符串类型。这种改变可以提高类型安全性，并有助于在系统中统一参数类型。

---

748-748: 类型定义改进：将数值常量转换为字符串常量

这个更改将 aiToolAddCalendarLaterHours 数组中的数值转换为字符串类型。这与其他枚举常量的更改保持一致，有助于统一参数处理方式。

---

775-775: 类型定义改进：将数值常量转换为字符串常量

这个更改将 aiToolGetScheduleHoursFromNow 数组中的数值转换为字符串类型。这种变更与移除参数归一化逻辑相配合，使得日历相关云函数中的参数处理更加一致。

liubai-backends/liubai-laf/cloud-functions/ai-system-two.ts (10)

32-40: 新增从 @/common-types 导入工具常量

引入了多个日历功能和图片尺寸类型相关的常量，为后续动态枚举提供基础数据。这是一个良好的重构方向，有助于提高代码的可维护性。

---

63-69: 使用 valTool.objToStr 创建字符串枚举常量

将导入的常量数组转换为字符串枚举格式，这样做使得工具定义更加灵活，并且易于维护。如果常量定义发生变化，只需修改 common-types 中的定义即可。

---

300-301: 更新画图工具的尺寸类型枚举

使用动态生成的 enumImageSizeTypes 代替之前可能硬编码的数组，提高了代码的可维护性和灵活性。

---

386-387: 更新日历特定日期的枚举定义

使用 enumAddCalendarSpecificDates 替换了原来的硬编码枚举数组，使代码更加统一和易于维护。

---

429-430: 更新 specificDate 枚举定义

使用 enumGetScheduleSpecificDates 替换了原来的硬编码枚举数组，与其他枚举修改保持一致性。

---

452-453: 更新卡片类型枚举定义

使用 enumGetCardTypes 替换了原来的硬编码枚举数组，完成了枚举重构的统一处理。

---

398-401:

❓ Verification inconclusive

将 laterHour 参数类型从 number 改为 string 并使用枚举

1. 类型从 number 修改为 string
2. 使用 enumAddCalendarLaterHours 作为枚举值源

同样，这一修改统一了参数处理方式，但需要确保系统其他部分已经适应了这一类型变更。

---

🏁 Script executed:

#!/bin/bash
# 检查是否有其他位置依赖 laterHour 作为数字类型
rg "laterHour.*number" --type=typescript

Length of output: 77

---

下面的命令因使用了不支持的 --type=typescript 选项而报错，我们需要改用正确的文件类型（通常为 .ts 文件）来重新搜索是否有其他地方依赖 laterHour 作为数字类型。如果系统中存在这样的依赖，需要确保相应部分也做了更新以匹配当前修改。

请运行以下新脚本以验证项目中是否有其它位置使用了基于数字类型的 laterHour：

#!/bin/bash
# 检查项目中是否有其它地方使用 laterHour 作为数字类型
rg "laterHour.*number" -t ts

请根据该命令的输出手动确认是否存在依赖问题，并据此确保所有相关代码都兼容当前将 laterHour 类型从 number 改为 string 的修改。

---

393-396:

✅ Verification successful

将 earlyMinute 参数类型从 number 改为 string 并使用枚举

1. 类型从 number 修改为 string
2. 使用 enumAddCalendarEarlyMinutes 作为枚举值源

这一修改统一了参数处理方式，但需要确保系统其他部分已经适应了这一类型变更。

---

🏁 Script executed:

#!/bin/bash
# 检查是否有其他位置依赖 earlyMinute 作为数字类型
rg "earlyMinute.*number" --type=typescript

Length of output: 79

---

通知：请进一步验证 earlyMinute 参数的类型转换影响

由于之前执行的 rg 命令因文件类型识别问题导致错误输出，现提供一份修正后的 shell 脚本，以便检查代码库中是否仍有依赖 earlyMinute 为数字类型的使用情况：

• 确认所有涉及 earlyMinute 的引用均已更新为字符串类型；
• 验证代码库中已无使用 earlyMinute: number 的声明。

请执行以下脚本以收集更多信息：

请在验证后更新相关依赖，确保系统其他部分适应了这一类型变更。

---

🏁 Script executed:

#!/bin/bash
# 检查代码库中是否仍有将 earlyMinute 定义或使用为数字类型的代码
rg "earlyMinute:\\s*number" -g "*.ts"

Length of output: 160

---

验证完毕：早已参数类型修改已全面一致

• 文件 liubai-backends/liubai-laf/cloud-functions/ai-system-two.ts 中将 earlyMinute 参数从 number 修改为 string，同时使用了 enumAddCalendarEarlyMinutes 枚举。
• 经过搜索，未发现其他位置仍依赖 earlyMinute 为数字类型定义的情况。
• 请确保系统其他部分已经适配这一类型变更，并进行最终的手动验证。

---

422-425:

✅ Verification successful

将 hoursFromNow 参数类型从 number 改为 string 并使用枚举

1. 类型从 number 修改为 string
2. 使用 enumGetScheduleHoursFromNow 作为枚举值源

这一修改与前面两处类型修改保持一致，保证了参数类型的统一性。

---

🏁 Script executed:

#!/bin/bash
# 检查是否有其他位置依赖 hoursFromNow 作为数字类型
rg "hoursFromNow.*number" --type=typescript

Length of output: 80

---

下面建议运行以下新的 shell 脚本，以便确认在所有 TypeScript 文件（包括 .ts 和 .tsx）中，是否仍有将 hoursFromNow 定义为 number 类型的情况，从而确保此次将参数类型改为 string 不会产生遗漏的影响：

请运行以上脚本，并根据新的验证结果确认是否需要进一步调整其他引用该参数的代码。

---

🏁 Script executed:

#!/bin/bash
# 检查所有 TypeScript 文件中 hoursFromNow 是否以 number 类型定义
rg "hoursFromNow\s*:\s*number" -g "*.ts" -g "*.tsx"

Length of output: 175

---

验证通过：hoursFromNow 参数类型修改正确

经过扩展搜索，目前在项目中没有发现任何将 hoursFromNow 声明为 number 类型的情况。请继续保持这一修改，确保参数类型在各处保持统一。

• 文件：liubai-backends/liubai-laf/cloud-functions/ai-system-two.ts（第422-425行）中已将类型从 number 修改为 string，并使用了 enumGetScheduleHoursFromNow 枚举。
• 使用 rg 搜索未发现其他地方依赖 number 类型的 hoursFromNow。

---

1521-1543:

❓ Verification inconclusive

add_calendar 方法简化参数处理逻辑

根据代码对比和 AI 摘要，此处移除了之前存在的参数归一化代码（主要针对 earlyMinute 和 laterHour）。这与参数类型从 number 改为 string 的变更相匹配，因为现在使用字符串枚举约束了输入值，减少了运行时验证的需求。

这样的修改简化了代码，但要确保客户端输入符合枚举定义的有效值。

---

🏁 Script executed:

#!/bin/bash
# 查找其他可能需要类似修改的代码位置
rg "normalizeArg|normalize.*earlyMinute|normalize.*laterHour" --type=typescript

Length of output: 116

---

重构意见：简化 add_calendar 参数处理逻辑

当前对 add_calendar 方法的修改已经移除了原有针对 earlyMinute 和 laterHour 参数的归一化逻辑，改用了字符串枚举约束，从而简化了代码结构和运行时校验逻辑。但请注意：

• 客户端校验：确保客户端传入的参数必须严格符合枚举定义的有效值，避免出现非法输入。
• 全局一致性：建议检查项目中是否还存在其他文件中使用旧参数归一化逻辑（如涉及 normalizeArg、normalize...earlyMinute 或 normalize...laterHour 的代码）。

为帮助进一步确认全局是否有类似的归一化处理，请执行下面新的搜索脚本，该脚本针对所有扩展名为 .ts 的 TypeScript 文件进行检索：

请在验证后确认是否需要对其他地方同步进行相应的修改。

---

🏁 Script executed:

#!/bin/bash
# 检索所有 .ts 文件中可能包含旧归一化处理逻辑的相关关键字
rg "normalizeArg|normalize.*earlyMinute|normalize.*laterHour" --glob "*.ts"

Length of output: 199

---

请手动确认全局归一化逻辑是否已完全移除

目前，add_calendar 方法中对参数的处理已简化：原有针对 earlyMinute 和 laterHour 参数的归一化代码已被移除，改为依赖字符串枚举确保输入值有效，从而减少了运行时校验。自动搜索时未发现其他文件中使用 normalizeArg、normalize.*earlyMinute 或 normalize.*laterHour 的代码，但由于搜索过程中出现了错误提示（如 “: command not found”），验证结果可能不够完整。

建议您：

• 客户端输入校验：确认客户端传入的参数严格符合字符串枚举的定义，避免引入非法参数。
• 全局代码检查：手动核实项目中是否还有其他地方依赖旧的归一化逻辑，从而确保代码库的一致性和健壮性。

请继续验证这些风险因素，以确保改动不会引入其他问题。

---

更新建议：请确认全局归一化逻辑已彻底移除并确保客户端数据有效

当前对 add_calendar 方法的改动已移除原先针对 earlyMinute 和 laterHour 的归一化处理，改为通过字符串枚举约束输入，简化了参数校验逻辑。但由于自动化搜索过程中出现错误，未能排除其他模块中存在类似旧逻辑。因此建议：

• 确认客户端传入的参数严格符合字符串枚举定义，避免传入非法数据。
• 手动核查其他可能存在归一化处理的代码区域，以确保没有遗漏旧逻辑的使用。

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.