uploadcare / file-uploader

Stack-agnostic library for uploading, processing, and editing images on-the-fly
https://uploadcare.com/docs/file-uploader/
MIT License
61 stars 12 forks source link

feat(public-upload-api): allow to switch activity to the cloud image editor with predefined file opened #719

Closed nd0ut closed 1 month ago

nd0ut commented 1 month ago

Description

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The recent changes enhance the robustness and clarity of the upload management system. Key improvements include better type safety for activity parameters, streamlined error handling during activity transitions, and a more structured way of managing internal states across various classes. These modifications simplify the code while ensuring reliable functionality throughout the application.

Changes

File(s) Change Summary
abstract/ActivityBlock.js Introduced ActivityParamsMap for type safety; modified control flow with error handling; refined type definitions for activities and parameters.
abstract/CTX.js Removed '*focusedEntry' from uploaderBlockCtx, altering the context structure for uploads.
abstract/UploaderBlock.js Changed storage of activity parameters to a new *currentActivityParams object for clarity.
abstract/UploaderPublicApi.js Updated setCurrentActivity method to use generics for type safety in parameters based on activity type.
blocks/CloudImageEditorActivity/CloudImageEditorActivity.js Added ActivityParams type; modified parameter handling and error management in the constructor and methods.
blocks/ExternalSource/ExternalSource.js Introduced a new activityParams getter for validation of external source parameters.
blocks/FileItem/FileItem.js Simplified the onEdit method by removing conditional logic, ensuring consistent activity setting.
types/test/public-upload-api.test-d.tsx New test suite for verifying the UploadCtxProvider functionality, focusing on setCurrentActivity.
types/test/uc-upload-ctx-provider.test-d.tsx Streamlined imports by removing duplicates and unnecessary references, improving code clarity.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant UploaderPublicApi
    participant ActivityBlock
    participant CloudImageEditorActivity

    User->>UploaderPublicApi: setCurrentActivity(activityType, params)
    UploaderPublicApi->>ActivityBlock: validate params
    ActivityBlock->>UploaderPublicApi: params validated
    UploaderPublicApi->>CloudImageEditorActivity: initialize with params
    CloudImageEditorActivity->>User: activity initialized successfully

πŸ‡ In the code, where once it was cluttered,
A clearer path now lies, unshuttered.
With types that guide and errors that fade,
The upload journey is sweetly laid!
Hooray for changes, let’s cheer and dance,
For now, our code has a brighter chance! πŸŽ‰


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 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](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.
egordidenko commented 1 month ago

@nd0ut good update!