search

ballerine-io / ballerine

Open-source infrastructure and data orchestration platform for risk decisioning
https://www.ballerine.com
Other
2.04k stars 183 forks source link

Custom Data Block #2530

Closed Omri-Levy closed 1 month ago

Omri-Levy commented 1 month ago

Summary by CodeRabbit

changeset-bot[bot] commented 1 month ago

⚠️ No Changeset found

Latest commit: 2869b60613dbeed36982a6c14bb8136f335e9b32

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

coderabbitai[bot] commented 1 month ago

Walkthrough

The updates introduce new React components ReadOnlyDetail and ReadOnlyDetailsCell for efficiently displaying read-only information in the back-office application. Additionally, new types Json and ExtendedJson are established to standardize JSON handling across the application. This enhances the clarity and maintainability of the code by integrating structured data representation with user-friendly rendering.

Changes

File Path Change Summary
apps/backoffice-v2/src/common/components/atoms/.../ReadOnlyDetail.tsx Added ReadOnlyDetail component to render various types of read-only data.
apps/backoffice-v2/src/common/types.ts Introduced Json and ExtendedJson types for JSON-compatible structures.
apps/backoffice-v2/src/lib/blocks/components/.../ReadOnlyDetailsCell.tsx Added ReadOnlyDetailsCell component to display read-only details in a structured format.
apps/backoffice-v2/src/lib/blocks/create-blocks-typed/types.ts Updated type definitions to include new ExtendedJson and TReadOnlyDetailsCell types.

Sequence Diagram(s)

Rendering ReadOnlyDetail

sequenceDiagram
    participant ParentComponent
    participant ReadOnlyDetail
    participant UtilityFunctions

    ParentComponent->>ReadOnlyDetail: Render with props (value, parse, className)
    ReadOnlyDetail->>UtilityFunctions: Check value type (date, boolean, URL, etc.)
    UtilityFunctions-->>ReadOnlyDetail: Return formatted data
    ReadOnlyDetail->>ParentComponent: Render formatted data

Rendering ReadOnlyDetailsCell

sequenceDiagram
    participant ParentComponent
    participant ReadOnlyDetailsCell
    participant ReadOnlyDetail

    ParentComponent->>ReadOnlyDetailsCell: Render with props (value, parse, className)
    ReadOnlyDetailsCell->>ReadOnlyDetailsCell: Map over value array
    ReadOnlyDetailsCell->>ReadOnlyDetail: Render each value with ReadOnlyDetail
    ReadOnlyDetail-->>ReadOnlyDetailsCell: Return formatted detail component
    ReadOnlyDetailsCell->>ParentComponent: Render list of formatted details

Poem

In the code where data lies,
A read-only world now complies,
Json, dates, and URLs,
Rendered neat in detailed cells.
Components new, and types refined,
In the back-office, brilliance shines.
🌟✨📜

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 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](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.