Public API

[nevo-david]

• feat: public api
• feat: higher limit
• feat: public api

Summary by CodeRabbit

Release Notes

• New Features

  • Introduced a public API module with various functionalities, including file uploads and post management.
  • Added a new PublicComponent to enhance user settings based on subscription tier.

• Enhancements

  • Modified file upload handling for improved efficiency.
  • Added a publicApi property to user context to manage API key visibility.
  • Implemented throttling features to manage API request rates.

• Bug Fixes

  • Adjusted validation for month property in post retrieval to ensure appropriate range.

• Chores

  • Updated dependencies to include @nestjs/throttler for enhanced request management.

[vercel]

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

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
gitroom	⬜️ Ignored (Inspect)	Visit Preview		Dec 14, 2024 10:31am
postiz	⬜️ Ignored (Inspect)	Visit Preview		Dec 14, 2024 10:31am

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request introduces a comprehensive enhancement to the application's public API capabilities. The changes span multiple components, including backend modules, controllers, middleware, and frontend components. The primary focus is on implementing a new public API feature with API key management, introducing rate limiting, and adding a new public API tier. The modifications include adding new modules, controllers, and middleware to support public API interactions, along with frontend components to display and manage the API key.

Changes

File	Change Summary
apps/backend/src/api/routes/media.controller.ts	Updated uploadFile method, removing file interceptor decorators and simplifying upload handling
apps/backend/src/api/routes/users.controller.ts	Added publicApi property to getSelf method response
apps/backend/src/app.module.ts	Added PublicApiModule and ThrottlerModule, configured with ThrottlerBehindProxyGuard
apps/frontend/src/components/layout/settings.component.tsx	Added conditional rendering for PublicComponent
apps/frontend/src/components/layout/user.context.tsx	Added publicApi property to user context
libraries/nestjs-libraries/src/database/prisma/schema.prisma	Added optional apiKey field to Organization model
libraries/nestjs-libraries/src/database/prisma/subscriptions/pricing.ts	Added public_api property to pricing tiers

Sequence Diagram

sequenceDiagram
    participant User
    participant Frontend
    participant Backend
    participant AuthMiddleware
    participant OrganizationService
    
    User->>Frontend: Access Settings
    Frontend->>Backend: Request User Details
    Backend->>AuthMiddleware: Authenticate
    AuthMiddleware->>OrganizationService: Check/Generate API Key
    OrganizationService-->>AuthMiddleware: Return Organization
    Backend-->>Frontend: Return User Details with Public API Key
    Frontend->>User: Display Public API Section

Loading

Possibly related PRs

• instagram stories, add collaborators, infrastructure for settings in validation #468: Potential connection through media upload functionality enhancements

Poem

🐰 A Rabbit's Ode to Public API

With keys unlocked and throttles set,
Our API dances without regret
Public routes now shine so bright
Integrations take their flight!
Code hops forward with delight 🚀

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. This feature will be included in our Pro Plan when released.

---

📜 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 87892ed and 92fa8f9.

⛔ Files ignored due to path filters (1)

• package-lock.json is excluded by !**/package-lock.json

📒 Files selected for processing (17)

• apps/backend/src/api/routes/media.controller.ts (0 hunks)
• apps/backend/src/api/routes/users.controller.ts (2 hunks)
• apps/backend/src/app.module.ts (1 hunks)
• apps/backend/src/public-api/public.api.module.ts (1 hunks)
• apps/backend/src/public-api/routes/v1/public.integrations.controller.ts (1 hunks)
• apps/backend/src/services/auth/auth.middleware.ts (1 hunks)
• apps/backend/src/services/auth/public.auth.middleware.ts (1 hunks)
• apps/frontend/src/components/layout/settings.component.tsx (2 hunks)
• apps/frontend/src/components/layout/user.context.tsx (2 hunks)
• apps/frontend/src/components/public-api/public.component.tsx (1 hunks)
• libraries/nestjs-libraries/src/database/prisma/organizations/organization.repository.ts (4 hunks)
• libraries/nestjs-libraries/src/database/prisma/organizations/organization.service.ts (4 hunks)
• libraries/nestjs-libraries/src/database/prisma/schema.prisma (1 hunks)
• libraries/nestjs-libraries/src/database/prisma/subscriptions/pricing.ts (6 hunks)
• libraries/nestjs-libraries/src/dtos/posts/get.posts.dto.ts (1 hunks)
• libraries/nestjs-libraries/src/throttler/throttler.provider.ts (1 hunks)
• package.json (1 hunks)

---

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
• Mastodon
• Reddit
• LinkedIn

🪧 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. (Beta)
• @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.