fix(cli): generated TS typing for auth() access is too strong

[ymc9]

No description provided.

[coderabbitai]

Walkthrough

Walkthrough

The changes in the generateAuthType function within the schema package focus on handling required relation fields and ensuring auth model ID fields are required. This enhances the processing logic for fields and types. Additionally, a new test case was added to verify that optional fields remain optional in model schemas.

Changes

File Path	Change Summary
packages/schema/src/plugins/enhancer/enhance/auth-type-generator.ts	Modified generateAuthType to handle required relation fields, ensuring auth model ID fields are required, and streamlined field/type processing logic. Removed pickFields, ensureType, addPickField, isIgnoredField, and updated addAddField.
tests/integration/tests/enhancements/with-policy/auth.test.ts	Added a new test case to verify that an optional field remains optional in a model schema, involving a custom authorization directive.

Sequence Diagram(s)

sequenceDiagram
  participant Model
  participant AuthModel
  participant generateAuthType
  Model ->> generateAuthType: Call with Model and AuthModel
  generateAuthType ->> AuthModel: Process required relation fields
  generateAuthType ->> generateAuthType: Ensure auth model ID fields are required
  generateAuthType ->> Model: Return updated Model with required fields

Loading

---

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:

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

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3140d9b and 9fd0653.

Files selected for processing (2)

• packages/schema/src/plugins/enhancer/enhance/auth-type-generator.ts (6 hunks)
• tests/integration/tests/enhancements/with-policy/auth.test.ts (1 hunks)

Files skipped from review due to trivial changes (1)

• tests/integration/tests/enhancements/with-policy/auth.test.ts

Additional comments not posted (5)

packages/schema/src/plugins/enhancer/enhance/auth-type-generator.ts (5)

Line range hint 1-22:
LGTM! Initialization and imports are correct.

The imports and initial setup for the generateAuthType function, including the new requiredRelations parameter, are correctly implemented.

---

26-30: LGTM! ensureType function is correctly implemented.

The ensureType function ensures that each model has an entry in the types map, consistent with the new requiredRelations structure.

---

37-41: LGTM! addAddField function is correctly implemented.

The addAddField function correctly handles adding required relation fields to the types map, ensuring no duplicates are added.

---

91-101: LGTM! Correct handling of ID fields and required relations.

The code correctly ensures that the auth model's ID fields are always required and merges required relation fields into the type definition.

---

104-105: LGTM! Addition of Record<string, unknown> is correct.

The addition of Record<string, unknown> to the type definition ensures flexibility by allowing additional fields.