Upgrade rss feed and object transform plugins

[elliotBraem]

Summary by CodeRabbit

• New Features

  • Introduced support for a new RSS distributor plugin with enhanced content transformation fields.
  • Added array handling capabilities in the Object Transform plugin.

• Documentation

  • Updated the RSS plugin guide with expanded features, setup instructions, and security best practices.
  • Enhanced the transformation plugin documentation with detailed examples and new array handling support.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
curatedotfun-app	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 5, 2025 7:10am
curatedotfun-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 5, 2025 7:10am
curatedotfun-landing	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 5, 2025 7:10am

[coderabbitai]

Walkthrough

The pull request updates the main configuration file by adding a new RSS distributor entry and extending the output mappings with a new field. It also introduces a new field in the AI-transform plugin schema for tags. In addition, the documentation for the RSS distributor and object transform plugins has been enhanced with restructured sections, detailed setup guides, expanded configuration references, and examples for handling array fields.

Changes

File(s)	Change Summary
curate.config.json	Added new distributor entry for @curatedotfun/rss, updated the shippost feed's outputs to include createdAt alongside submittedAt, and introduced a new tags field in the ai-transform plugin schema.
docs/.../distributors/rss.md	Updated title to "📰 RSS Plugin"; restructured sections by replacing "Configuration" with "🚀 Features"; added new "🔧 Setup Guide", "🔄 Data Transformation", "🔐 Security Considerations", and "📡 Accessing Your RSS Feed" sections; expanded configuration reference with detailed JSON structure.
docs/.../transformers/object-transform.md	Introduced "Array Support" with a new "Array Fields" section; updated usage examples to demonstrate direct mapping of array fields and the combination of static values with array inputs, including updated output examples.

Sequence Diagram(s)

sequenceDiagram
  participant U as End User
  participant C as curate.config.json
  participant RSS as @curatedotfun/rss Plugin
  participant F as RSS Feed

  U->>C: Retrieve configuration details
  C->>RSS: Provide RSS distributor settings
  RSS->>F: Publish curated content

Loading

sequenceDiagram
  participant I as Input Data
  participant T as Object Transform Plugin
  participant O as Transformed Output

  I->>T: Send data with array fields
  T->>T: Process arrays (combine static & dynamic values)
  T->>O: Output data with transformed arrays

Loading

Possibly related PRs

• Add near social #66: Involves similar modifications to curate.config.json concerning the addition of new distributor plugins and output mapping updates.
• Adds notion for grantwire feed #40: Updates the configuration for a different plugin integration (Notion), with structural changes in property types, closely related to the changes made for the RSS plugin configuration.

Poem

I’m a rabbit in lines of code, so keen,
Hopping through configs, where new fields are seen.
RSS feeds now sparkle with a brand new light,
Arrays and tags add a joyful delight.
With every pull and hop, our code takes flight! 🐰✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 095f36f and a09e6fb.

📒 Files selected for processing (1)

• docs/docs/plugins/distributors/rss.md (1 hunks)

🔇 Additional comments (20)

docs/docs/plugins/distributors/rss.md (20)

5-5: Title Update — Emoji Change
The header title has been updated to “📰 RSS Plugin” (instead of the previous “📡 RSS Plugin”), which better represents the content and purpose of the plugin.

---

7-7: Enhanced Plugin Description
The introductory description now clearly explains that the RSS plugin distributes curated content to multiple RSS feeds. This added context is useful for setting user expectations.

---

9-18: Comprehensive Features List Updated
The “🚀 Features” section now lists key capabilities such as multiple feed formats, standard-compliant URLs, raw data options, HTML sanitization, flexible deployment, secure authentication, and Redis storage. This detailed bullet list effectively communicates the plugin’s functionality.

---

19-28: Clear and Detailed Setup Guide
The new “🔧 Setup Guide” section provides step-by-step deployment instructions, including deploying the RSS service, generating a secure API secret, and noting precautions. The embedded note emphasizes the security of the API secret, which is a valuable addition.

---

29-48: Updated Configuration Example
The configuration snippet for modifying curate.config.json is clear and well-structured. It demonstrates how to integrate the RSS plugin using environment variable injection for the API secret, which improves both clarity and security.

---

50-55: Helpful Explanation on Environment Variable Hydration
The explanatory section following the configuration snippet outlines how environment variables are hydrated at runtime and specifies the required fields (serviceUrl and apiSecret). This additional context enhances usability.

---

56-58: Enhanced Security Warning
The caution block reinforces the importance of keeping the API secret secure, warning against committing it directly to configuration files. This is an important security best practice and is clearly communicated.

---

60-62: Stream Enablement Instruction
The instruction to enable the stream by setting "enabled": true is direct and actionable, ensuring users activate the RSS distribution feature properly.

---

64-77: Detailed Configuration Reference Provided
The “📝 Configuration Reference” section offers a precise JSON example that reiterates the required configuration for the RSS plugin. This reinforces the correct setup and is a helpful reference for users.

---

78-80: Introduction to Data Transformation
The brief introduction to the data transformation process sets the context for the detailed configuration sections that follow. It informs users of the plugin’s ability to handle structured input data and apply defaults.

---

82-141: Comprehensive Input Data Structure Documentation
The TypeScript interface for RssInput is thoroughly documented, outlining required and optional fields—including core fields, author information, media options, and additional metadata. This level of detail is excellent for guiding users on the expected data format.

---

142-144: Clarification on Field Handling
The brief commentary following the interface explains how the plugin supports various field formats (e.g., author, image, audio, video, categories). This reinforces the flexibility provided by the input schema.

---

145-148: Transformer Plugins Overview
The section introducing transformer plugins clearly recommends using @curatedotfun/ai-transform followed by @curatedotfun/object-transform to properly format input data for RSS. This guidance is useful for advanced pipeline setups.

---

149-230: Detailed Transformation Pipeline Example
The recommended transformation pipeline JSON configuration is comprehensive. It integrates both AI transformation and object transformation plugins, detailing prompts, schemas, and mappings. This provides a robust example for users seeking an advanced implementation.

---

232-241: Explanation of the Transformation Pipeline
The explanatory text following the pipeline example succinctly summarizes its two-phase process, clarifying that AI transformation generates content elements (like title, summary, and tags) before object transformation maps them to RSS fields.

---

242-294: Simplified Transformation Pipeline Example
The simplified example offers a minimalist configuration that still covers the essential fields needed to create an RSS item. This is particularly beneficial for users who prefer a streamlined setup.

---

296-296: Summary of Simplified Example
The brief description that follows the simplified configuration clarifies its purpose, ensuring that users understand it creates a basic RSS item with only the essential fields.

---

298-303: Robust Security Considerations
The “🔐 Security Considerations” section outlines key measures such as storing API secrets securely and monitoring service activity. This comprehensive security advice is essential for protecting the RSS service.

---

304-314: Clear Instructions for RSS Feed Access
The “📡 Accessing Your RSS Feed” section explicitly lists endpoint URLs for various feed formats (RSS 2.0, Atom, JSON Feed, and raw JSON). This clear guidance facilitates user access and integration with RSS readers.

---

315-316: Informative Conclusion
The final note concisely informs users how to share their RSS feed URLs, bringing the documentation to a clear and complete end.

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, 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 generate docstrings to generate docstrings for this 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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.