Fullstack TypeScript toolkit that enhances Prisma ORM with flexible Authorization layer for RBAC/ABAC/PBAC/ReBAC, offering auto-generated type-safe APIs and frontend hooks.
Walkthrough
## Walkthrough
The updates involve a range of enhancements and fixes across various files. Key changes include version updates, improvements to database and query functionalities, refinements in handling policy and permission checks, and added support for integration tests. Additionally, there are updates to documentation, configuration files, and test cases to ensure consistency and clarity.
## Changes
| File/Directory | Change Summary |
|----------------|----------------|
| `.gitattributes` | Introduced configurations for handling text and line endings. |
| `CONTRIBUTING.md` | Added Node.js and pnpm version requirements, PostgreSQL setup instructions for integration tests, and symlink guidance for Windows users. |
| `packages/ide/jetbrains/build.gradle.kts` | Updated version number from "2.1.2" to "2.2.0". |
| `packages/plugins/tanstack-query/src/generator.ts` | Refactored functions to handle query options based on conditions for `vue` and `svelte`. |
| `packages/plugins/tanstack-query/src/runtime-v5/react.ts` | Added `initialPageParam` property to `useInfiniteModelQuery` and `useSuspenseInfiniteModelQuery` functions. |
| `packages/plugins/tanstack-query/src/runtime-v5/svelte.ts` | Refined type parameters and options handling in `useModelQuery` and `useInfiniteModelQuery` functions. |
| `packages/plugins/tanstack-query/src/runtime/vue.ts` | Updated `useInfiniteModelQuery` to include `initialPageParam` and adjust return type. |
| `packages/plugins/tanstack-query/tests/plugin.test.ts` | Added default values for `id` fields, new functions for querying and mutating data in React, Vue, and Svelte, and additional source files for configurations. |
| `packages/plugins/tanstack-query/tests/react-hooks-v5.test.tsx` | Added `useInfiniteModelQuery` and a new test for infinite query functionality. |
| `packages/plugins/tanstack-query/tests/react-hooks.test.tsx` | Added `useInfiniteModelQuery` function and a new test case for infinite queries. |
| `packages/runtime/src/constants.ts` | Removed several declarations related to field-level access control functions and flags. |
| `packages/runtime/src/enhancements/delegate.ts` | Added `isPlainObject` import, checks for specific types, and null checks in `assembleUp` and `assembleDown` functions. |
| `packages/runtime/src/enhancements/policy/constraint-solver.ts` | Renamed `CheckerConstraint` to `PermissionCheckerConstraint`. |
| `packages/runtime/src/enhancements/policy/handler.ts` | Imported `deepmerge`, refactored several methods, and added a method for building an ID filter with an entity checker function. |
| `packages/runtime/src/enhancements/proxy.ts` | Added `createManyAndReturn` method to `PrismaProxyHandler` and `DefaultPrismaProxyHandler` class. |
| `packages/runtime/src/enhancements/types.ts` | Restructured and renamed types related to permission checking and policy definitions. |
| `packages/runtime/src/types.ts` | Updated `DbOperations` interface and renamed `CheckerContext` to `PermissionCheckerContext`. |
| `packages/schema/README.md` | Updated syntax highlighting, configuration instructions, and formatting options for `*.zmodel` files. |
| `packages/schema/src/language-server/validator/datamodel-validator.ts` | Imported `findUpInheritance` from `../../utils/ast-utils`. |
| `packages/schema/src/plugins/enhancer/policy/utils.ts` | Provided functions for generating policy expressions and handling normalized auth references. |
| `tests/regression/tests/issue-1080.test.ts` | Removed `{ logPrismaQuery: true }` argument from a function call. |
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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai)
- [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai)
- [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai)
- [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips
### Chat
There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai):
> :bangbang: **IMPORTANT**
> Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.
- 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 generate interesting stats about this repository and render them as a table.`
- `@coderabbitai show all the console.log statements in this repository.`
- `@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 as 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.
Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed.
### CodeRabbit Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit.
- Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.
- Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
Walkthrough
## Walkthrough The updates involve a range of enhancements and fixes across various files. Key changes include version updates, improvements to database and query functionalities, refinements in handling policy and permission checks, and added support for integration tests. Additionally, there are updates to documentation, configuration files, and test cases to ensure consistency and clarity. ## Changes | File/Directory | Change Summary | |----------------|----------------| | `.gitattributes` | Introduced configurations for handling text and line endings. | | `CONTRIBUTING.md` | Added Node.js and pnpm version requirements, PostgreSQL setup instructions for integration tests, and symlink guidance for Windows users. | | `packages/ide/jetbrains/build.gradle.kts` | Updated version number from "2.1.2" to "2.2.0". | | `packages/plugins/tanstack-query/src/generator.ts` | Refactored functions to handle query options based on conditions for `vue` and `svelte`. | | `packages/plugins/tanstack-query/src/runtime-v5/react.ts` | Added `initialPageParam` property to `useInfiniteModelQuery` and `useSuspenseInfiniteModelQuery` functions. | | `packages/plugins/tanstack-query/src/runtime-v5/svelte.ts` | Refined type parameters and options handling in `useModelQuery` and `useInfiniteModelQuery` functions. | | `packages/plugins/tanstack-query/src/runtime/vue.ts` | Updated `useInfiniteModelQuery` to include `initialPageParam` and adjust return type. | | `packages/plugins/tanstack-query/tests/plugin.test.ts` | Added default values for `id` fields, new functions for querying and mutating data in React, Vue, and Svelte, and additional source files for configurations. | | `packages/plugins/tanstack-query/tests/react-hooks-v5.test.tsx` | Added `useInfiniteModelQuery` and a new test for infinite query functionality. | | `packages/plugins/tanstack-query/tests/react-hooks.test.tsx` | Added `useInfiniteModelQuery` function and a new test case for infinite queries. | | `packages/runtime/src/constants.ts` | Removed several declarations related to field-level access control functions and flags. | | `packages/runtime/src/enhancements/delegate.ts` | Added `isPlainObject` import, checks for specific types, and null checks in `assembleUp` and `assembleDown` functions. | | `packages/runtime/src/enhancements/policy/constraint-solver.ts` | Renamed `CheckerConstraint` to `PermissionCheckerConstraint`. | | `packages/runtime/src/enhancements/policy/handler.ts` | Imported `deepmerge`, refactored several methods, and added a method for building an ID filter with an entity checker function. | | `packages/runtime/src/enhancements/proxy.ts` | Added `createManyAndReturn` method to `PrismaProxyHandler` and `DefaultPrismaProxyHandler` class. | | `packages/runtime/src/enhancements/types.ts` | Restructured and renamed types related to permission checking and policy definitions. | | `packages/runtime/src/types.ts` | Updated `DbOperations` interface and renamed `CheckerContext` to `PermissionCheckerContext`. | | `packages/schema/README.md` | Updated syntax highlighting, configuration instructions, and formatting options for `*.zmodel` files. | | `packages/schema/src/language-server/validator/datamodel-validator.ts` | Imported `findUpInheritance` from `../../utils/ast-utils`. | | `packages/schema/src/plugins/enhancer/policy/utils.ts` | Provided functions for generating policy expressions and handling normalized auth references. | | `tests/regression/tests/issue-1080.test.ts` | Removed `{ logPrismaQuery: true }` argument from a function call. |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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)Tips
### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): > :bangbang: **IMPORTANT** > Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged. - 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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.