feat: use readonly keyword in document and row model params

[ChiragAgg5k]

What does this PR do?

Test Plan

(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work.)

Related PRs and Issues

(If this PR is related to any other PR or resolves any issue or related to any issue link all related PR and issues here.)

Have you read the Contributing Guidelines on issues?

(Write your answer here.)

Summary by CodeRabbit

• New Features
  • Generated TypeScript models now mark read-only fields as readonly across web and React Native outputs.
  • Improves type safety and alignment with API schemas; IDE hints and compile-time checks now enforce immutability.
  • No runtime behavior changes; types and optionality remain the same.
  • May require minor adjustments where code previously mutated read-only fields.

[coderabbitai]

Walkthrough

The change updates TypeScript model generation in two templates: templates/react-native/src/models.ts.twig and templates/web/src/models.ts.twig. Property declarations in generated types now conditionally include the readonly modifier when property.readOnly is true. The optional marker (?) and type resolution via getSubSchema remain unchanged. This affects only the emitted type property lines in the generated model declarations.

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feat-add-readonly

---

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.
  • 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.
• 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

• Add @coderabbitai ignore or @coderabbit 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

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• 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

🧹 Nitpick comments (1)

templates/react-native/src/models.ts.twig (1)

14-14: Potential breaking type change—confirm release notes and versioning

Adding readonly can break existing consumers that mutate these props. Please:

• Mark this as a breaking change in release notes.
• Confirm the generator’s supported TypeScript baseline includes readonly on properties.
• Consider adding a small generation test with a spec that includes readOnly: true to ensure compiled output type-checks.

Happy to provide a minimal schema and expected output for the test.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 8e8e396 and df26cbd.

📒 Files selected for processing (2)

• templates/react-native/src/models.ts.twig (1 hunks)
• templates/web/src/models.ts.twig (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (12)

• GitHub Check: build (8.3, Ruby30)
• GitHub Check: build (8.3, Ruby31)
• GitHub Check: build (8.3, AppleSwift56)
• GitHub Check: build (8.3, Node18)
• GitHub Check: build (8.3, PHP80)
• GitHub Check: build (8.3, Go112)
• GitHub Check: build (8.3, KotlinJava8)
• GitHub Check: build (8.3, CLINode18)
• GitHub Check: build (8.3, FlutterStable)
• GitHub Check: build (8.3, DartStable)
• GitHub Check: build (8.3, FlutterBeta)
• GitHub Check: build (8.3, Android5Java17)

🔇 Additional comments (3)

templates/react-native/src/models.ts.twig (1)

14-14: Readonly placement and syntax look correct

Using readonly before the property name (and before ? when optional) is valid TypeScript and matches intended semantics for readOnly schema fields.

templates/web/src/models.ts.twig (2)

17-17: Matches RN template and TypeScript semantics

The conditional readonly is correctly positioned and keeps optionality and types intact. Parity with the React Native template is good.

---

17-17: Surface area check and comms

Same note as RN: this is a type-level breaking change for consumers who were mutating read-only fields. Please call this out in the changelog and verify the supported TypeScript version across web consumers.