feat: refine root mappings

[koladilip]

What are the changes introduced in this PR?

root mappings are useful when we want to map some values to root level

What is the related Linear task?

Resolves INT-2160

Please explain the objectives of your changes below

Put down any required details on the broader aspect of your changes. If there are any dependent changes, mandatorily mention them here

Any changes to existing capabilities/behaviour, mention the reason & what are the changes ?

N/A

Any new dependencies introduced with this change?

N/A

Any new generic utility introduced or modified. Please explain the changes.

N/A

Any technical or performance related pointers to consider with the change?

N/A

@coderabbitai review

---

Developer checklist

• My code follows the style guidelines of this project

• No breaking changes are being introduced.

• All related docs linked with the PR?

• All changes manually tested?

• Any documentation changes needed with this change?

• Is the PR limited to 10 file changes?

• Is the PR limited to one linear task?

• Are relevant unit and component test-cases added?

Reviewer checklist

• Is the type of change in the PR title appropriate as per the changes?

• Verified that there are no credentials or confidential data exposed with the changes.

Summary by CodeRabbit

• New Features

  • Introduced a new "Mappings" feature for transforming data using predefined JSON templates.
  • Added a new description field to mapping paths for better context.

• Bug Fixes

  • Improved the processFlatMapping function to handle cases with empty output parts.

• Tests

  • Enhanced test scenarios with additional fields and modified output for more comprehensive coverage.

• Documentation

  • Updated README with examples and references for the new "Mappings" feature.

[coderabbitai]

Warning

Review failed

The pull request is closed.

Walkthrough

The update introduces a new feature called "Mappings" for JSON templates, enabling users to transform data with predefined mappings. Additional changes include a new description field in the FlatMappingPaths type, updates to the processFlatMapping function to handle specific conditions, and alterations to test scenarios and data structures, particularly the inclusion of a details field.

---

Changes

File	Change Summary
readme.md	Introduced Mappings feature, added examples and references.
src/types.ts	Added an optional description field to FlatMappingPaths type.
src/utils/converter.ts	Updated processFlatMapping function to handle empty flatMapping.outputExpr.parts.
test/scenarios/mappings/data.ts	Added details field to input object and modified output field in scenarios.
test/scenarios/mappings/root_mappings.json	Introduced new file defining mappings for transforming input JSON paths.

---

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant JSONTemplate
    participant Mappings
    participant DataProcessor

    User->>JSONTemplate: Provide input JSON
    JSONTemplate->>Mappings: Apply mappings
    Mappings->>DataProcessor: Send transformed data paths
    DataProcessor->>Mappings: Return processed data
    Mappings->>JSONTemplate: Apply processed data
    JSONTemplate->>User: Return transformed JSON

Loading

---

Poem

In JSON lands where data flows,
A mapping feature newly grows.
With paths defined, it guides the way,
Transforming fields by night and day.
Our code is clean, our tests complete,
Now data's rhythm is sweet and neat.
🐇💻✨

---

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

[github-actions]

Coverage report

St.❔	Category	Percentage	Covered / Total
🟢	Statements	100%	4568/4568
🟢	Branches	100%	1219/1219
🟢	Functions	100%	342/342
🟢	Lines	100%	4568/4568

Test suite run success

168 tests passing in 4 suites.

Report generated by 🧪jest coverage report action from 8854130

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud