FlatFilers / Guides

Flatfile's Documentation
7 stars 20 forks source link

Update sdk change log #1151

Closed meritmalling closed 4 months ago

coderabbitai[bot] commented 4 months ago

Walkthrough

The recent updates in May 2024 for various SDK versions introduce new methods, enhance event handling, and improve default page settings for the Flatfile Portal embed. Notable additions include the unmount() method in the EventDriver class and new methods for managing default pages. Updates from April and March 2024 focus on refining event handling, space creation, and fixing bugs across different SDK versions.

Changes

File Path Change Summary
changelog/sdks.mdx Documented updates for new methods, event handling improvements, and bug fixes across various SDK versions.
...@flatfile/javascript Added updateDefaultPageInSpace and findDefaultPage methods.
...@flatfile/listener Added unmount() and unmountEventHandler() methods in the EventDriver class.
...@flatfile/javascript Updated closeSpace.operation and closeSpace.onClose properties, and dependencies.
...@flatfile/listener Added off() and detach() methods, introduced FlatfileProvider component.
...@flatfile/react Enabled clipboard read and write functionality in the embedded Flatfile iframe component, fixed usePortal hook bug.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant FlatfilePortal
    participant EventDriver
    participant SpaceManager

    User->>+FlatfilePortal: Load Portal
    FlatfilePortal->>+EventDriver: Initialize
    EventDriver->>+SpaceManager: Set Default Page
    SpaceManager-->>EventDriver: Default Page Set
    EventDriver-->>FlatfilePortal: Ready
    FlatfilePortal-->>User: Portal Loaded

    User->>+FlatfilePortal: Unmount Portal
    FlatfilePortal->>+EventDriver: unmount()
    EventDriver-->>FlatfilePortal: Unmounted
    FlatfilePortal-->>User: Portal Unmounted

Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between a2534e37e1a2427ba6be3a0fa15d0a21a53e3ac6 and ce38bfcfb823dd829cfb531fac47959df0b9c0c3.
Files selected for processing (1) * changelog/sdks.mdx (3 hunks)
Files skipped from review as they are similar to previous changes (1) * changelog/sdks.mdx
---
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.