docs: Protecting TypeScript NestJS Web API Template

[djnovin]

What does this PR do?

In this pull request, I've integrated Unkey to provide route protection and rate limiting for the application for hackathon. This is a side quest to make a template using a framework.

API Key Verification: Added middleware to verify API keys using Unkey. Only requests with valid API keys in the Authorization header (Bearer token) are allowed to access protected routes.

Fixes #2361

If there is not an issue for this, please create one first. This is used to tracking purposes and also helps use understand why this PR exists

Type of change

• Bug fix (non-breaking change which fixes an issue)
• Chore (refactoring code, technical debt, workflow improvements)
• Enhancement (small improvements)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

How should this be tested?

git clone https://github.com/djnovin/unkey-ts-nestjs

pnpm install

pnpm run start

curl http://localhost:3000/api/v1/protected -H "Authorization: Bearer <YOUR_API_KEY>"

Checklist

Required

• Filled out the "How to test" section in this PR
• Read Contributing Guide
• Self-reviewed my own code
• Commented on my code in hard-to-understand areas
• Ran pnpm build
• Ran pnpm fmt
• Checked for warnings, there are none
• Removed all console.logs
• Merged the latest changes from main onto my branch with git pull origin main
• My changes don't cause any responsiveness issues

Appreciated

• If a UI change was made: Added a screen recording or screenshots to this PR
• Updated the Unkey Docs if changes were necessary

Summary by CodeRabbit

Summary by CodeRabbit

• New Features
  • Added two new project entries demonstrating the integration of Unkey with various frameworks:
    • Prabin Subedi: "Starter template for Unkey Route protection in Hono Webframework in Cloudflare workers" (11-October-2024) - GitHub Repository
    • Novin Noori: "Protect TypeScript + NestJS Web API with Unkey" (13-October-2024) - GitHub Repository

[changeset-bot]

⚠️ No Changeset found

Latest commit: c52a509

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
engineering	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 17, 2024 1:12pm

[coderabbitai]

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

The pull request updates the document oss.gg/7_create_a_template.md by adding two new entries that showcase projects integrating Unkey with various frameworks. The first entry, contributed by Prabin Subedi, is titled "Starter template for Unkey Route protection in Hono Webframework in Cloudflare workers," dated 11-October-2024, and includes a link to its GitHub repository. The second entry, by Novin Noori, is titled "Protect TypeScript + NestJS Web API with Unkey," dated 13-October-2024, also with a link to its GitHub repository.

Changes

Files	Change Summary
oss.gg/7_create_a_template.md	Added new entries: » 11-October-2024 by Prabin Subedi [Starter template for Unkey Route protection in Hono Webframework in Cloudflare workers](https://github.com/prabincankod/hono-unkey-cflare) and » 13-October-2024 by Novin Noori [Protect TypeScript + NestJS Web API with Unkey](https://github.com/djnovin/unkey-ts-nestjs)

Assessment against linked issues

Objective	Addressed	Explanation
Create a template of using some framework or language to build an API and protect it with Unkey. (#2361)	✅

Possibly related PRs

• docs: Protecting TypeScript NestJS Web API Template  #2362: This PR adds a new entry for "Protect TypeScript + NestJS Web API with Unkey," which is directly related to the main PR's addition of a similar entry by Novin Noori.
• [oss.gg] side quest : added another framework; hono on cloudflare edge #2345: This PR includes the entry for "Starter template for Unkey Route protection in Hono Webframework in Cloudflare workers," which matches the new entry added in the main PR.
• chore: Rust + Axum template [SIDE QUEST] #2237: This PR features a new entry for "Protect your Rust + Axum API with Unkey," which is relevant as it showcases another project utilizing Unkey, similar to the entries added in the main PR.
• feat: Create a template with Unkey #2272: This PR also adds multiple entries related to Unkey templates, including those that demonstrate integration with various frameworks, aligning with the main PR's objective of expanding the collection of templates.

Suggested reviewers

• mcstepp
• perkinsjr
• MichaelUnkey

---

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 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.

[vercel]

@djnovin is attempting to deploy a commit to the Unkey Team on Vercel.

A member of the Team first needs to authorize it.

[github-actions]

Thank you for following the naming conventions for pull request titles! 🙏

[chronark]

private async validateBearerToken(token: string): Promise<boolean> {
    const validationResponse = await verifyKey(token);

    if (!validationResponse) return false;

    if (validationResponse.error) return false;

    return true;
  }

This is completely insecure and does not check the status of verification at all.
You must check the validationResponse.valid property

Also looks like you copy pasted from another template, so your setup and testing instructions are wrong

[djnovin]

private async validateBearerToken(token: string): Promise<boolean> {
    const validationResponse = await verifyKey(token);

    if (!validationResponse) return false;

    if (validationResponse.error) return false;

    return true;
  }

This is completely insecure and does not check the status of verification at all. You must check the validationResponse.valid property

Also looks like you copy pasted from another template, so your setup and testing instructions are wrong

Updated to utilise result.valid. @chronark

  private async validateBearerToken(token: string): Promise<boolean> {
    try {
      const { result } = await verifyKey(token);

      return result.valid;
    } catch (err) {
      return false;
    }
  }
  

I have also updated PR instructions to point to correct git repo.

[oss-gg]

Awarding djnovin: 750 points 🕹️ Well done! Check out your new contribution on oss.gg/djnovin