FlatFilers / Guides

Flatfile's Documentation
7 stars 20 forks source link

feat: Replace Deprecated upload:completed Event #1155

Closed ncronquist closed 2 weeks ago

ncronquist commented 2 weeks ago
coderabbitai[bot] commented 2 weeks ago

Walkthrough

The primary change involves updating the event listener in the flatfileEventListener function to listen for the "file:created" event instead of the "upload:completed" event. This adjustment affects how and when the listener triggers, ensuring it responds to the creation of a file rather than the completion of an upload. This change is applied across multiple documentation snippets.

Changes

Files Change Summary
_snippets/guides/documents/document-actions.mdx, _snippets/guides/guest_sidebar/block1.mdx Updated flatfileEventListener to listen to "file:created" instead of "upload:completed".

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant EventSource
    participant flatfileEventListener

    User->>EventSource: Upload file
    EventSource->>flatfileEventListener: Trigger "file:created" event
    flatfileEventListener->>EventSource: Process file creation

Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 688b94908088289310c53ecb1904a784e7cdac2c and e3b19bcc44909aa2cbbd8e6ad715111a66ff99aa.
Files selected for processing (2) * _snippets/guides/documents/document-actions.mdx (2 hunks) * _snippets/guides/guest_sidebar/block1.mdx (2 hunks)
Additional context used
LanguageTool
_snippets/guides/guest_sidebar/block1.mdx
[formatting] ~17-~17: Did you mean “?” (MULTIPLE_PUNCTATION_MARKS_1) Context: ... console.log(updateSpace.data.metadata?.sidebarConfig); // Additional co...
Additional comments not posted (4)
_snippets/guides/guest_sidebar/block1.mdx (2)
`7-7`: The event listener update from "upload:completed" to "file:created" is correctly implemented. --- `34-34`: The TypeScript event listener update is correctly implemented and type-safe.
_snippets/guides/documents/document-actions.mdx (2)
`7-7`: The JavaScript implementation of the event listener for "file:created" is correct and integrates well with the API. --- `40-40`: The TypeScript implementation of the event listener for "file:created" is correct, type-safe, and well-integrated with the API.
---
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.