Migration script to add modules

[Behzad-rabiei]

Summary by CodeRabbit

• Documentation

  • Expanded API documentation to include three new module types: communityInsights, communityHealth, and announcements.
  • Updated module schema documentation to include a new required boolean property, activated, indicating module activation status.
  • Provided detailed descriptions for all module properties in the documentation.

• New Features

  • Added support for communityInsights, communityHealth, and announcements as valid module types.
  • Introduced an activated field for modules, allowing modules to be enabled or disabled.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes expand the module API and validation logic to support three new module types: communityInsights, communityHealth, and announcements. The API documentation is updated to include these types in the module schema and request parameters. A new boolean property, activated, is introduced to represent the activation status of a module, and is now required in create and update requests as well as in the module schema. The validation logic is updated to handle the new module types, allowing the activated field to be set for them during updates.

Changes

File(s)	Change Summary
src/docs/module.doc.yml	Added communityInsights, communityHealth, and announcements to allowed module names; introduced activated boolean field in schemas; expanded module schema to explicitly define all properties including activated.
src/validations/module.validation.ts	Updated dynamicModuleUpdate logic to handle new module types, allowing optional activated boolean in update validation for these modules.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    participant Validation

    Client->>API: Create/Update Module (with name and activated)
    API->>Validation: Validate request (name & activated)
    Validation-->>API: Validation result
    API-->>Client: Response with module schema (including activated)

Loading

Possibly related PRs

• 466 turn offon all module #469: Updates migration tracking to include the addition of the activated field to modules, directly supporting the schema and validation changes in this PR.

Poem

In the garden of modules, three sprouts appear,
Insights, Health, Announcements—rabbits cheer!
With a hop and a skip, “activated” shines bright,
Now toggled with ease, from morning to night.
Documentation grows, validation’s in tune,
CodeRabbit hops forward—new features soon! 🐇✨

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)

• We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

---

📜 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 646e338 and f316e47.

📒 Files selected for processing (2)

• src/docs/module.doc.yml (4 hunks)
• src/validations/module.validation.ts (1 hunks)

✨ 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.