fix(runtime): properly re-export type declarations of model metadata by Gabrola · Pull Request #2047 · zenstackhq/zenstack

Gabrola · 2025-03-19T05:45:08Z

export * from does not re-export default exports, which is how the metadata is exported.

import metadata from '@zenstackhq/runtime/model-meta`;
//       ^ this contains the correct metadata at runtime but typescript sees it as {}

This change fixes the type declaration and correctly aligns the .d.ts file with the existing .js file

zenstack/packages/runtime/res/model-meta.js

Line 5 in 7c37940

exports.default = require('.zenstack/model-meta').default;

coderabbitai · 2025-03-19T05:45:15Z

📝 Walkthrough

Walkthrough

The pull request updates the export statement in the packages/runtime/res/model-meta.d.ts file. Instead of using a wildcard export to re-export all entities from the .zenstack/model-meta module, it now re-exports only the default export from that module.

Changes

File	Change Summary
`packages/runtime/res/model-meta.d.ts`	Replaced `export * from '.zenstack/model-meta';` with `export { default } from '.zenstack/model-meta';` to export only the default entity.

Suggested reviewers

ymc9

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)

We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
- To enable this feature, set early_access to true under in the settings.

📜 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 606adb5 and 9761c56.

📒 Files selected for processing (1)

packages/runtime/res/model-meta.d.ts (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (5)

GitHub Check: build-test (20.x)
GitHub Check: OSSAR-Scan
GitHub Check: build-test (20.x)
GitHub Check: Analyze (javascript-typescript)
GitHub Check: build-test (20.x)

🔇 Additional comments (1)

packages/runtime/res/model-meta.d.ts (1)

1-1: Good fix for the default export issue!

This change correctly addresses the issue where export * from syntax doesn't re-export default exports. By explicitly using export { default }, you ensure that TypeScript properly recognizes the model metadata object at compile time, which matches the runtime behavior.

This fix aligns with the PR objective to properly re-export type declarations of model metadata, resolving the issue where TypeScript was interpreting the metadata as an empty object ({}).

✨ 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

🪧 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 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.

ymc9 · 2025-03-20T22:41:49Z

Got it, thank you @Gabrola ! Merging it now.

fix(runtime): properly re-export type declarations of model metadata

9761c56

ymc9 approved these changes Mar 20, 2025

View reviewed changes

ymc9 merged commit 6d3d802 into zenstackhq:dev Mar 20, 2025
11 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(runtime): properly re-export type declarations of model metadata#2047

fix(runtime): properly re-export type declarations of model metadata#2047
ymc9 merged 1 commit intozenstackhq:devfrom
Gabrola:fix/model-meta-types

Gabrola commented Mar 19, 2025

Uh oh!

coderabbitai Bot commented Mar 19, 2025 •

edited

Loading

Walkthrough

Changes

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

ymc9 commented Mar 20, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

Gabrola commented Mar 19, 2025

Uh oh!

coderabbitai Bot commented Mar 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

ymc9 commented Mar 20, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

coderabbitai Bot commented Mar 19, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)