search

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: extract public api to the composition class #676

Closed nd0ut closed 2 months ago

nd0ut commented 3 months ago

Description

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

[!WARNING]

Review failed

The pull request is closed.

Walkthrough

The changes focus on refining various classes and methods related to file uploading and validation in a JavaScript project. Key updates include the introduction of the UploaderPublicApi class for managing file actions, removal of deprecated methods, and enhanced visibility modifiers for methods. The modifications improve the structure, error handling, and accessibility of the code by centralizing functionalities within the UploaderPublicApi class and updating method references accordingly.

Changes

File(s) Change Summary
abstract/ActivityBlock.js Set *modalActive state to false when no activity is present and updated ActivityType typedef.
abstract/Block.js Removed setActivity method, added visibility modifiers to various methods.
abstract/CTX.js Removed *uploadCollection from uploaderBlockCtx function.
abstract/UploaderBlock.js Restructured initialization, added UploaderPublicApi, and removed multiple deprecated imports.
blocks/ExternalSource/ExternalSource.js Updated method calls from this to this.api for addFileFromUrl.
abstract/UploaderPublicApi.js Added methods for file manipulation and flow control.
abstract/ValidationManager.js Switched function parameters to use api from UploaderPublicApi and updated method calls.
blocks/CameraSource/CameraSource.js Updated method calls from this to this.api for addFileFromObject.
blocks/DropArea/DropArea.js Updated method calls to use this.api.
blocks/SourceBtn/SourceBtn.js Changed openSystemDialog calls to use this.api.
blocks/UploadList/UploadList.js Updated method calls to use this.api for initialization, uploading, and finalization processes.
blocks/UrlSource/UrlSource.js Updated method call from this to this.api for addFileFromUrl.
blocks/SimpleBtn/SimpleBtn.js Updated initFlow call to use this.api.
build-svg-sprite.js Appended newline character after trimming string template.
types/exported.d.ts Added export statement for UploaderPublicApi.
utils/validators/collection/validateCollectionUploadError.js, utils/validators/file/... Replaced references to block with api and updated property accesses and function calls.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant App
    participant UploaderPublicApi

    User ->> App: Initiate file upload
    App ->> UploaderPublicApi: addFileFromObject(file)
    UploaderPublicApi ->> App: Return upload status
    App ->> User: Display upload status
sequenceDiagram
    participant User
    participant App
    participant UploaderPublicApi

    User ->> App: Trigger open system dialog
    App ->> UploaderPublicApi: openSystemDialog(options)
    UploaderPublicApi ->> User: Open file selection dialog
    User ->> UploaderPublicApi: Select file(s)
    UploaderPublicApi ->> App: Return selected files
    App ->> User: Display selected files

Poem

Changes come, as swift as light,
The code refined, now sleek and bright,
Uploader's tasks are clear and true,
With PublicApi, a fresh new view.
Worries fade, like morning dew,
For bugs are scarce and features woo.
A rabbit's joy, in this code's clue. 🐇✨

[!TIP]

Early access features: disabled We are currently testing the following features in early access: - **OpenAI `gpt-4o` model for code reviews and chat**: OpenAI claims that this model is better at understanding and generating code than the previous models. We seek your feedback over the next few weeks before making it generally available. Note: - You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file. - Please join our [Discord Community](https://discord.com/invite/GsXnASn26c) to provide feedback and report issues. - OSS projects are currently opted into early access features by default.
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.