feat: Koa.js RBAC middleware with Unkey

[harshsbhat]

Adds a template to showcase the implementation of RBAC middleware using the Koa.js and Unkey.

https://github.com/harshsbhat/unkey-koa

Fixes https://github.com/unkeyed/unkey/issues/2150

Summary by CodeRabbit

• New Features
  • Added a new template entry for using Unkey with the Koa.js framework, including a link to the Koa.js RBAC route protection repository.

[changeset-bot[bot]]

⚠️ No Changeset found

Latest commit: 80b78da1c8814578522da1c7da766c8cf8489841

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[bot]]

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

A member of the Team first needs to authorize it.

[vercel[bot]]

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 20, 2024 9:10am

[coderabbitai[bot]]

📝 Walkthrough

Walkthrough

The pull request updates a document by adding a new entry for a template that demonstrates the use of Unkey with the Koa.js framework. This entry includes the date, contributor's name, and a link to the relevant GitHub repository. The overall structure of the document remains unchanged, maintaining consistency with previous entries.

Changes

Files	Change Summary
oss.gg/7_create_a_template.md	Added a new entry: » 19-October-2024 by Harsh Bhat [Koa.js RBAC route protection using unkey](https://github.com/harshsbhat/unkey-koa.git)

Assessment against linked issues

Objective	Addressed	Explanation
Add a new entry for a contribution (2150)	✅

Possibly related PRs

• #2174: Adds a new entry for a Flask template using Unkey.
• #2191: Updates the document with additional requirements and examples for creating templates using Unkey.
• #2231: Adds a new entry for a project by Harsh Bhat, relevant to the same document.
• #2237: Adds a new entry for a Rust + Axum project, contributing to the same document.
• #2272: Introduces a new side quest and expands the list of contributions in the same document.
• #2286: Adds new entries to the same document, including one by Harsh Bhat.
• #2307: Adds a new entry for a FastAPI boilerplate by Harsh Bhat.
• #2358: Adds a new entry for a Next.js starter kit, contributing to the same document.
• #2471: Focuses on structuring the same document that the main PR updates.

Suggested labels

🕹️ oss.gg, :joystick: 750 points, hacktoberfest

Suggested reviewers

• mcstepp
• chronark
• perkinsjr
• MichaelUnkey

---

📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between d774a4caedb98c15aeeb29dd97856cdb68706afa and 62baf045486814d680578094ebcf1c61807f8943.

📒 Files selected for processing (1)

• oss.gg/7_create_a_template.md (1 hunks)

🧰 Additional context used

🔇 Additional comments (1)

oss.gg/7_create_a_template.md (1)

57-57: LGTM! Please verify license and README.

The new entry for the Koa.js RBAC route protection using Unkey has been added correctly and follows the established format. It appears to be a unique contribution to the list.

To ensure all requirements are met, please run the following script:

✅ Verification successful

Verified! License and README confirmed.

The new entry for the Koa.js RBAC route protection using Unkey meets all the requirements, including the MIT License and the presence of quickstart instructions in the README.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the license and README.md of the new repository

# Test 1: Check if the repository contains a LICENSE file with MIT license
# Expect: File exists and contains "MIT License"
gh repo clone harshsbhat/unkey-koa /tmp/unkey-koa
grep -q "MIT License" /tmp/unkey-koa/LICENSE && echo "LICENSE: OK" || echo "LICENSE: Missing or not MIT"

# Test 2: Check if the repository contains a README.md file with quickstart instructions
# Expect: File exists and contains "quickstart" or "quick start" (case insensitive)
grep -qi "quick\s*start" /tmp/unkey-koa/README.md && echo "README: OK" || echo "README: Missing or no quickstart found"

# Clean up
rm -rf /tmp/unkey-koa

Length of output: 333

---

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.

[github-actions[bot]]

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

[chronark]

can you add the required root key permissions in your link in the readme? like so: https://app.unkey.com/settings/root-keys/new?permissions=api.*.create_api,another..

[harshsbhat]

can you add the required root key permissions in your link in the readme? like so: https://app.unkey.com/settings/root-keys/new?permissions=api.*.create_api,another..

Oh yeah. this feature was introduced recently right?

[harshsbhat]

Done. For all other templates too

[chronark]

/award 750

[oss-gg[bot]]

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