viewMapped retain required fields option

[carlbrugger]

Please explain how to summarize this PR for the Changelog:

Tell code reviewer how and what to test:

[elisadinsmore]

Tested and approved!

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This update introduces a new option for the @flatfile/plugin-view-mapped plugin. It defines a new interface, ViewMappedOptions, with an optional property keepRequiredFields. The change updates the viewMappedPlugin function signature to accept these options. The filtering logic now conditionally retains fields based on whether they are mapped or required, depending on the provided option. No changes are made to the public API declarations.

Changes

File(s)	Change Summary
.changeset/two-queens-happen.md	Release note describing the new option to retain required fields in the @flatfile/plugin-view-mapped plugin.
plugins/view-mapped/src/.../view-mapped.ts	Added ViewMappedOptions interface with an optional keepRequiredFields property; updated viewMappedPlugin function signature and adjusted filtering logic to conditionally retain required fields based on mapping and the provided option.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Plugin
    participant FieldProcessor

    Client->>+Plugin: viewMappedPlugin(options)
    Plugin->>Plugin: Begin iterating over workbook fields
    alt Field is mapped
        Plugin->>FieldProcessor: Retain field
    else Field is not mapped
        alt options.keepRequiredFields enabled and field required
            Plugin->>FieldProcessor: Retain required field
        else 
            Plugin->>FieldProcessor: Exclude field
        end
    end
    Plugin-->>-Client: Return filtered fields

Loading

Possibly related PRs

• Update view-mapped plugin to require less user interaction and provide more progress feedback #610: Introduced a new options parameter to the viewMappedPlugin function, aligning with this PR’s addition of the required fields retention option.
• fix: view mapped plugin #758: Modifies the internal logic of the viewMappedPlugin function, creating a direct relationship with the changes in the filtering process.
• view mapped fields only plugin #591: Involves changes to the filtering of mapped fields in the viewMappedPlugin function, similar in focus to retaining required fields.

Suggested Reviewers

• bangarang

---

📜 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 2cd727e and 43da789.

⛔ Files ignored due to path filters (1)

• package-lock.json is excluded by !**/package-lock.json, !**/*.json

📒 Files selected for processing (2)

• .changeset/two-queens-happen.md (1 hunks)
• plugins/view-mapped/src/view-mapped.ts (2 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

[promptless]

📝 Documentation updates detected! You can review documentation updates here