Upload data session

[david-roper]

Will close issue #918

This pull request will add:

A new upload via CSV feature An instrument upload select table page An upload page where user can download proper csv data templated for their selected instrument A file dropzone on said page where users can submit their filled out data template A submit button that will parse the csv, approve it via zod schema and send it to backend to be stored An API backend to validate and process the upload request, enter the data in the instrument records data table

Summary by CodeRabbit

Release Notes

• New Features

  • Introduced a new upload functionality for instrument records, allowing users to upload multiple records via CSV files.
  • Added a user-friendly interface for selecting instruments and managing uploads.
  • New navigation item for uploads in the application menu.
  • Comprehensive guide on how to upload data is now available.

• Translations

  • Added English and French translations for upload-related terms, enhancing accessibility for users.

• Documentation

  • New guide on uploading data to assist users in the process, detailing steps and requirements for successful uploads.

[joshunrau]

@coderabbitai review

[coderabbitai[bot]]

Walkthrough

The changes introduce a new upload feature for instrument records within the application. This includes the addition of a data transfer object (UploadInstrumentRecordDto), a controller method for handling uploads, and a service method for processing multiple records. New React components and routes facilitate the user interface for uploading CSV files. Additionally, utility functions for data validation and transformation are implemented, alongside corresponding translations and documentation to support the feature.

Changes

File	Change Summary
apps/api/src/instrument-records/dto/upload-instrument-record.dto.ts	Added class UploadInstrumentRecordDto with properties for upload validation.
apps/api/src/instrument-records/instrument-records.controller.ts	Added method upload to handle uploads and import UploadInstrumentRecordDto.
apps/api/src/instrument-records/instrument-records.service.ts	Added method upload for processing multiple records and updated imports.
apps/web/src/Routes.tsx	Added uploadRoute to protected routes.
apps/web/src/features/upload/components/UploadSelectTable.tsx	Added component UploadSelectTable for selecting instruments.
apps/web/src/features/upload/index.tsx	Introduced routing for upload feature with uploadRoute.
apps/web/src/features/upload/pages/UploadPage.tsx	Added component UploadPage for handling CSV uploads.
apps/web/src/features/upload/pages/UploadSelectPage.tsx	Added component UploadSelectPage for selecting instruments.
apps/web/src/features/upload/utils.ts	Added utility functions for data validation and CSV processing.
apps/web/src/translations/layout.json	Added translations for "Upload" in English and French.
apps/web/src/translations/upload.json	Introduced translations for instrument title in English and French.
docs/en/3-guides/3.3-how-to-upload-data.md	Added guide on how to upload data to the system.
packages/schemas/src/instrument-records/instrument-records.ts	Added new schema $UploadInstrumentRecordData for upload data structure.

Poem

In the meadow where data flows,
A new way to upload now grows.
With tables and routes, oh what a sight,
Instruments dance in the soft moonlight.
Click, drag, and drop with glee,
A rabbit's joy, as easy as can be! 🐰✨

---

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

[coderabbitai[bot]]

:white_check_mark: Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[david-roper]

@coderabbitai review

[coderabbitai[bot]]

@david-roper: I will review the changes.

:white_check_mark: Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[david-roper]

@coderabbitai please do another review

[coderabbitai[bot]]

@david-roper: I will redo the entire review of the pull request.

:white_check_mark: Actions performed

Full review triggered.