Campaign Tracker Plugin

[martijnvdbrug]

Description

New plugin for tracking campaigns server side.

• Create campaigns with codes in Vendure
• Have your storefront assign campaign codes to orders, e.g. by specifying a query param for your urls campaign=spring_sale_2024
• View revenue per campaign in your Vendure dashboard

Screenshots

Checklist

📌 Always:

• [x] I have set a clear title
• [ ] My PR is small and contains a single feature
• [ ] 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]]

Walkthrough

This pull request introduces the initial setup for the vendure-plugin-campaign-tracker, marking its first version (0.0.1). It includes the creation of a changelog, README documentation outlining integration steps, and the addition of new GraphQL API extensions for campaign tracking. The plugin allows tracking of campaign revenue and includes various attribution models. Additional files include service implementations, entity definitions, utility functions, and test configurations to support the functionality of the plugin.

Changes

File	Change Summary
packages/vendure-plugin-campaign-tracker/CHANGELOG.md	Added initial changelog entry for version 0.0.1.
packages/vendure-plugin-campaign-tracker/README.md	Documented plugin implementation details, including attribution models and setup instructions.
packages/vendure-plugin-campaign-tracker/eslint.config.js	Introduced ESLint configuration extending base settings with TypeScript options.
packages/vendure-plugin-campaign-tracker/src/api/api-extensions.ts	Added GraphQL API extensions, including scalar types, Campaign type, and mutations for campaign management.
packages/vendure-plugin-campaign-tracker/src/api/campaign-tracker-admin.resolver.ts	Created resolver for admin campaign management with methods for querying and mutating campaigns.
packages/vendure-plugin-campaign-tracker/src/api/campaign-tracker-shop.resolver.ts	Introduced resolver for shop context to handle campaign-related mutations.
packages/vendure-plugin-campaign-tracker/src/campaign-tracker.plugin.ts	Defined CampaignTrackerPlugin class with configuration options and API extensions.
packages/vendure-plugin-campaign-tracker/src/constants.ts	Added constants for plugin options and logging context.
packages/vendure-plugin-campaign-tracker/src/entities/campaign.entity.ts	Created Campaign entity class with properties for tracking campaign data.
packages/vendure-plugin-campaign-tracker/src/entities/order-campaign.entity.ts	Added OrderCampaign entity to represent the relationship between orders and campaigns.
packages/vendure-plugin-campaign-tracker/src/index.ts	Established entry point for exporting campaign tracker modules.
packages/vendure-plugin-campaign-tracker/src/services/attribution-models.spec.ts	Introduced unit tests for attribution models.
packages/vendure-plugin-campaign-tracker/src/services/attribution-models.ts	Defined interfaces and classes for campaign attribution models.
packages/vendure-plugin-campaign-tracker/src/services/campaign-tracker.service.ts	Implemented service class for managing campaigns, including methods for CRUD operations and revenue calculations.
packages/vendure-plugin-campaign-tracker/src/services/campaign-util.spec.ts	Added unit tests for utility functions related to campaign revenue calculations.
packages/vendure-plugin-campaign-tracker/src/services/campaign-util.ts	Introduced utility functions for date checks and revenue calculations.
packages/vendure-plugin-campaign-tracker/src/types.ts	Added TypeScript interfaces for campaign options and order data structures.
packages/vendure-plugin-campaign-tracker/src/ui/queries.ts	Created new GraphQL queries and mutations for campaign management.
packages/vendure-plugin-campaign-tracker/test/dev-server.ts	Set up a testing environment for the plugin.
packages/vendure-plugin-campaign-tracker/test/e2e.spec.ts	Introduced end-to-end tests for campaign tracking functionalities.
packages/vendure-plugin-campaign-tracker/test/queries.ts	Added GraphQL mutation for adding campaigns to orders.
packages/vendure-plugin-campaign-tracker/vitest.config.js	Configured Vitest for testing with SWC integration.

---

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.