feat: add accessibleQuery function

[joshunrau]

Summary by CodeRabbit

• New Features

  • Enhanced the authentication configuration to accept a broader range of input types.
  • Expanded the public interface with additional type definitions and a new utility that streamlines permission-based data queries.
  • Introduced an advanced type mapping to improve safety in database operations.

• Tests

  • Added new tests to validate the behavior of the access-controlled query functionality.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request modifies public API definitions and adds new utilities in both authentication and Prisma modules. The AuthModule’s defineAbility method now accepts an untyped payload instead of a strictly typed object. Export statements in src/index.ts are updated to include additional types and functions. In the Prisma module, a new type (PrismaModelWhereInputMap) is introduced, a helper function (accessibleQuery) is added along with its tests, and related import statements are updated accordingly.

Changes

Files	Change Summary
example/app.ts	Updated AuthModule’s defineAbility method by removing the explicit { isAdmin: boolean } type for payload.
src/index.ts	Updated the export of types to include AppAbility alongside AuthModuleOptions and added accessibleQuery to the exports from Prisma utilities.
src/modules/prisma/prisma.utils.ts, src/modules/prisma/prisma.types.ts	Added new accessibleQuery function and introduced the PrismaModelWhereInputMap type, along with updated imports.
src/modules/prisma/__tests__/prisma.utils.test.ts	Created new test file for accessibleQuery function with unit tests verifying its behavior.

Sequence Diagram(s)

sequenceDiagram
    participant C as Caller
    participant AQ as accessibleQuery
    participant AB as accessibleBy
    C->>AQ: Call accessibleQuery(ability, action, modelName)
    alt Ability is undefined
        AQ-->>C: Return {}
    else Ability is provided
        AQ->>AB: Invoke accessibleBy(ability, action)
        AB-->>AQ: Return permissions map
        AQ-->>C: Return permissions for modelName
    end

Loading

Possibly related PRs

• fix: add explicit schema for token payload #10: Introduces a new schema for tokenPayload that includes a boolean property isAdmin, which is directly related to the modifications in the defineAbility method’s payload type.

Poem

I'm a coding bunny on a quest,
Hopping through files, giving code its best.
Types once strict now freely roam,
Exports and queries find a new home.
With tests to guide each quirky leap,
I celebrate change before I fall asleep. 🐇

---

📜 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 eabc2f8 and 2f92de5.

📒 Files selected for processing (5)

• example/app.ts (1 hunks)
• src/index.ts (1 hunks)
• src/modules/prisma/__tests__/prisma.utils.test.ts (1 hunks)
• src/modules/prisma/prisma.types.ts (1 hunks)
• src/modules/prisma/prisma.utils.ts (2 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
• @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]

🎉 This PR is included in version 2.1.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀