Granular access

[sogehige]

CHECKLIST

• [ ] I read contributing docs
• Not hooked on socket but needs update
  • [x] Timers
  • [x] Permissions
  • [x] Core/Stats
  • [x] Registries/Alert
  • [x] Randomizer

Summary by CodeRabbit

• New Features

  • Introduced a new type Unpacked<T> for enhanced type extraction.
  • Added scope methods across various classes for refined permission and scope management.
  • Implemented decorators for HTTP endpoints (Post, Get, Delete) to streamline API request handling.
  • Enhanced settings management with support for sensitive settings and scope-based visibility.

• Refactor

  • Generalized event handler signatures and updated method calls for consistency and flexibility.
  • Transitioned to a class-based approach in database entity definitions for better structure and TypeORM integration.
  • Refined permission handling with new properties and updated logic for permission scopes.
  • Consolidated endpoint and socket handling with new functions and middleware for improved scope and privilege management.

• Bug Fixes

  • Fixed permission assignment logic to correctly utilize user's highest permission level.
  • Adjusted menu and widget configurations to correctly incorporate scope and permission considerations.

• Chores

  • Database migrations added for updating permissions table with new scope-related columns.

[coderabbitai[bot]]

[!IMPORTANT]

Review skipped

More than 25% of the files skipped due to max files limit. The review is being skipped to prevent a low-quality review.

88 files out of 147 files are above the max files limit of 50. Please upgrade to Pro plan to get higher limits.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This update ushers in a wave of enhancements across the system, focusing on refining permissions management, bolstering API endpoint security, and enhancing system extensibility. Key highlights include the introduction of the Unpacked<T> type for improved type extraction, alongside the implementation of scope-based permissions and endpoint definitions. These changes streamline error handling, fortify settings management, and optimize socket communication, paving the way for a more resilient and adaptable framework for future developments.

Changes

Files	Change Summary
d.ts/global.d.ts, d.ts/index.d.ts	Added mocha property and Unpacked<T> type
d.ts/src/helpers/socket.d.ts	Generalized stopwatch::update event handler signature
src/_interface.ts, src/helpers/socket.ts, src/permissions.ts, ...	Enhanced permissions, endpoint security, and settings management. Introduced randomUUID import, scope handling, and error response improvements.
src/database/..., src/database/migration/*/*/1678892044040-permissionScopes.ts	Database schema updates for permissions and migration scripts for permissions table changes.
src/decorators.ts, src/decorators/endpoint.ts, src/decorators/on.ts	Added endpoint and event decorators, and modified settings function.
src/integrations/*, src/overlays/*, src/plugins.ts, src/registries/overlays.ts, src/socket.ts, src/ui.ts, src/widgets/*	Refactored to use new endpoint function and adjusted for scope-based permissions.
src/systems/*	Added API endpoint decorators and refactored for API request handling.

Poem

In the realm of code, where bits do play,
A rabbit toils, improving day by day.
🐾 Through data fields, it dances free,
🌟 Securing systems, for you and me.
With scopes and permissions, a tale so grand,
Crafting a world, with a gentle hand.
🚀 To the future, it leaps and flies,
🐇 CodeRabbit's work, reaching the skies.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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 resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.