dalyathan commented 1 month ago

Description

The changes in this PR implement and close #516

Deploy

This needs to happen to deploy this feature, for example:

[ ] Migrate DB before merging
[X] Merge PR

Breaking changes

Does this PR include any breaking changes we should be aware of? NO

Screenshots

Checklist

📌 Always:

[X] I have set a clear title
[X] My PR is small and contains a single feature
[X] I have checked my own PR

👍 Most of the time:

[X] I have added or updated test cases for important functionality
[X] I have updated the README if needed

📦 For publishable packages:

[X] I have increased the version number in package.json
[X] I have added my changes to the CHANGELOG.md See this example

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes in this pull request include the addition of a new GraphQL query, getKlaviyoReviews, in the Vendure Klaviyo plugin, which allows users to fetch all reviews from Klaviyo. This update is documented in the changelog and README. New types and a resolver class for handling the query have been introduced, along with a service method to interact with the Klaviyo API. Additionally, test cases and mock data have been added to ensure functionality.

Changes

File Path	Change Summary
packages/vendure-plugin-klaviyo/CHANGELOG.md	Updated changelog for version 1.3.0, added entry for `getKlaviyoReviews`.
packages/vendure-plugin-klaviyo/README.md	Added documentation for fetching reviews with a GraphQL query example.
packages/vendure-plugin-klaviyo/src/api/api-extensions.ts	Introduced `KlaviyoReviewStatus` enum, new types, and `getKlaviyoReviews` query.
packages/vendure-plugin-klaviyo/src/api/klaviyo-shop.resolver.ts	Added `KlaviyoShopResolver` class and `getKlaviyoReviews` method.
packages/vendure-plugin-klaviyo/src/klaviyo.plugin.ts	Updated `KlaviyoPlugin` to include `KlaviyoShopResolver` and `shopApiExtension`.
packages/vendure-plugin-klaviyo/src/klaviyo.service.ts	Added `getAllReviews` method to retrieve reviews from Klaviyo API.
packages/vendure-plugin-klaviyo/test/e2e.spec.ts	Added test case for fetching all reviews from Klaviyo.
packages/vendure-plugin-klaviyo/test/mock-data.ts	Introduced `mock-data.ts` with `klaviyoReviews` constant.
packages/vendure-plugin-klaviyo/test/queries.ts	Added `getAllKlaviyoReviews` GraphQL query.

Assessment against linked issues

Objective	Addressed	Explanation
Implement `getKlaviyoReviews()` query in Klaviyo plugin (#516)	✅

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.

martijnvdbrug commented 1 month ago

Placed on hold for now, because of a change in priority in the client project

Pinelab-studio / pinelab-vendure-plugins

GetKlaviyoReviews query #517