feat(schema): generate enum type helpers

[ymc9]

No description provided.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

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

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

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.

[Copilot]

Pull Request Overview

This PR updates enum handling to generate enum helpers (const alias and union type) instead of native TypeScript enums, and adapts samples and tests to use the new pattern.

• In the SDK generator, emit export const Enum = schema.enums.Enum plus a corresponding export type Enum = … helper and adjust the documentation generator.
• Update the sample blog models and runtime typing tests to import and use the new enum helpers.
• Extend the test schema and zmodel to define a Role enum and add a role field to the User model.

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
samples/blog/zenstack/models.ts	Replace native enum Role with generated const Role alias and type Role union helper
packages/sdk/src/ts-schema-generator.ts	Change enum emission to variable statement + type alias, update generateDocs signature
packages/runtime/test/typing/verify-typing.ts	Add enums() function and tests to verify the new Role helper types
packages/runtime/test/typing/typing-test.zmodel	Define enum Role and add role field to the User model
packages/runtime/test/typing/schema.ts	Add role property under User and top‐level enums.Role definition
packages/runtime/test/typing/models.ts	Export Role as const and as a union type in the test models file

Comments suppressed due to low confidence (2)

samples/blog/zenstack/models.ts:29

• [nitpick] The JSDoc for "User roles" applies to the type Role but not to the const Role. Moving or duplicating this comment above the const Role = schema.enums.Role; declaration would improve IDE hover documentation.

/**

packages/sdk/src/ts-schema-generator.ts:1024

• The commented example for generating native enums is now outdated. Consider removing or updating that block to clearly show the new export const Enum = schema.enums.Enum pattern.

            // generate: export const Enum = schema.enums.Enum;