aldinokemal / go-whatsapp-web-multidevice

API for Whatsapp Web Multi Device Version, Support UI & Webhook
MIT License
582 stars 245 forks source link

feat: add newsletter #204

Closed aldinokemal closed 1 month ago

aldinokemal commented 1 month ago

Context

Test Results

channel

coderabbitai[bot] commented 1 month ago

[!CAUTION]

Review failed

The head commit changed during the review from 0cfb6a6332f2e2551c21888bb6e6f22e52d2336c to 6c1b43716759476c6805db2ec3b1e39e2ba43af3.

Walkthrough

The changes in this pull request primarily focus on enhancing the WhatsApp API and its associated documentation. The OpenAPI specification has been updated to version 4.3.0, introducing new endpoints and schemas for managing newsletters. The documentation has been improved to include support for ARM architecture and new features related to message handling. Additionally, several components in the frontend have been updated to utilize a new FormRecipient component for handling user input, while new backend services and methods have been added to manage newsletters effectively.

Changes

File Change Summary
docs/openapi.yaml Updated OpenAPI spec to version 4.3.0; added "newsletter" tag; new endpoints for newsletters; modified group endpoint; new schemas for newsletters and groups.
readme.md Enhanced documentation for ARM support; updated API features; clarified user interface instructions.
src/cmd/root.go Introduced newsletterService and initialized REST endpoints for newsletters.
src/domains/newletter/newsletter.go Added INewsletterService interface and UnfollowRequest struct for newsletter management.
src/domains/user/account.go Introduced MyListNewsletterResponse type for newsletter-related information.
src/domains/user/user.go Added MyListNewsletter method to IUserService interface for fetching newsletters.
src/internal/rest/newsletter.go Implemented RESTful API for managing newsletters; added Unfollow method.
src/internal/rest/user.go Added /user/my/newsletters endpoint for retrieving user newsletters.
src/pkg/whatsapp/whatsapp.go Refactored ParseJID function for better readability and maintainability.
src/services/newsletter.go Introduced newsletterService struct and Unfollow method for managing subscriptions.
src/services/user.go Added MyListNewsletter method to retrieve user's subscribed newsletters.
src/validations/newsletter_validation.go Added ValidateUnfollowNewsletter function for validating unfollow requests.
src/views/components/AccountAvatar.js Updated to use FormRecipient component for user input.
src/views/components/AccountUserInfo.js Updated to use FormRecipient component for user input.
src/views/components/MessageDelete.js Updated to use FormRecipient component for user input.
src/views/components/MessageReact.js Updated to use FormRecipient component for user input.
src/views/components/MessageRevoke.js Updated to use FormRecipient component for user input.
src/views/components/MessageUpdate.js Updated to use FormRecipient component for user input.
src/views/components/NewsletterList.js Added new component for managing newsletter lists and unfollowing functionality.
src/views/components/SendAudio.js Updated to use FormRecipient component for user input.
src/views/components/SendContact.js Updated to use FormRecipient component for user input.
src/views/components/SendFile.js Updated to use FormRecipient component for user input.
src/views/components/SendImage.js Updated to use FormRecipient component for user input.
src/views/components/SendLocation.js Updated to use FormRecipient component for user input.
src/views/components/SendMessage.js Updated to use FormRecipient component for user input.
src/views/components/SendPoll.js Updated to use FormRecipient component for user input.
src/views/components/SendVideo.js Updated to use FormRecipient component for user input.
src/views/components/generic/FormRecipient.js Introduced a new component for handling recipient type and phone input.
src/views/index.html Enhanced UI with new newsletter section; updated JavaScript variables for user types.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant NewsletterService
    participant API
    participant Database

    User->>API: Request to unfollow newsletter
    API->>NewsletterService: Call Unfollow method
    NewsletterService->>Database: Validate and process unfollow request
    Database-->>NewsletterService: Return success/error
    NewsletterService-->>API: Return response
    API-->>User: Return success/error response

🐰 In the meadow, changes bloom bright,
New newsletters take flight,
With forms to fill and options to choose,
Our API's magic, we can't lose!
Hopping along, we celebrate,
Enhancements made, oh, isn't it great!
🌼✨


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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 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 , 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](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](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.