chore: add package.json export to sql.js project

[ymc9]

Summary by CodeRabbit

• Documentation
  • Clarified that the VSCode extension may use a different version than other packages due to Marketplace restrictions on pre-release versions.
• Chores
  • Exposed package metadata by exporting package.json in @zenstackhq/kysely-sql-js, allowing tools and consumers to access version and metadata via import/require. Improves compatibility with bundlers and environments that rely on explicit subpath exports. No runtime behavior or public API changes.

[coderabbitai]

Walkthrough

Adds a documentation note about VSCode package versioning and updates the @zenstackhq/kysely-sql-js package exports to include ./package.json for both import and require resolutions.

Changes

Cohort / File(s)	Summary
Documentation CLAUDE.md	Adds a bullet clarifying the ide/vscode package uses a different version due to VSCode marketplace pre-release restrictions.
Packaging / Exports packages/dialects/sql.js/package.json	Adds ./package.json to the package exports map for both import and require.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

A bunny taps keys with gentle delight,
“Exports mapped! Docs clear!” in the moonlit night.
Version hops for VSCode’s gate,
Package.json joins the export crate.
Thump-thump—release feels light and bright! 🐇✨

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch chore/sqljs-pkgjson

---

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.

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.

[Copilot]

Pull Request Overview

This PR adds a package.json export to the sql.js dialect package to improve module resolution capabilities. It also includes an update to the CLAUDE.md documentation file.

• Adds explicit package.json export mapping for both import and require conditions
• Updates documentation to clarify VSCode package versioning strategy

Reviewed Changes

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

File	Description
packages/dialects/sql.js/package.json	Adds package.json export mapping for module resolution
CLAUDE.md	Documents VSCode package versioning approach

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[claude]

Claude finished @ymc9's task —— View job

---

PR Review Complete ✅

I've thoroughly reviewed this PR. Here's my comprehensive feedback:

• Analyze changed files and understand modifications
• Review package.json export configuration
• Evaluate documentation updates
• Assess code quality and best practices
• Check for potential bugs or issues
• Consider performance implications
• Review security considerations
• Evaluate test coverage needs
• Provide comprehensive feedback

Summary

This PR adds a package.json export to the @zenstackhq/kysely-sql-js package and updates documentation in CLAUDE.md. The changes are small but important for module resolution consistency.

Code Quality & Best Practices ✅

Excellent adherence to established patterns:

• The package.json export follows the exact same pattern used in @zenstackhq/runtime (lines 62-65 in /packages/runtime/package.json)
• Export structure is consistent: both import and require conditions pointing to ./package.json
• Maintains consistency across the monorepo's package export strategy

TypeScript & Build Configuration:

• The export paths correctly match the tsup.config.ts build output structure
• Based on tsup config, the package generates both ESM (./dist/index.js) and CJS (./dist/index.cjs) with corresponding type definitions
• Export configuration properly handles dual-format publishing

Potential Issues ❌

No issues found:

• Export syntax is correct and follows Node.js package.json specification
• File paths are valid and match expected build outputs
• No breaking changes to existing API surface

Performance Considerations ✅

Positive impact:

• Adding explicit package.json export improves module resolution performance
• Helps bundlers and tools better understand package structure
• No runtime performance implications (purely build-time/resolution)

Security Considerations ✅

No security concerns:

• Changes are purely declarative exports configuration
• No executable code modifications
• Documentation update is informational only
• No exposure of sensitive information

Test Coverage Assessment ⚠️

Consideration needed:

• This change is low-risk (configuration only) but consider:
  • Testing import/require of @zenstackhq/kysely-sql-js/package.json works as expected
  • Verifying the package can still be imported normally after the export addition
• The existing test suite in test/getting-started/ should continue to work unchanged

Documentation Update Review ✅

CLAUDE.md addition (line 85):

+ The "ide/vscode" package by-design has a different version from the rest of the packages as VSCode doesn't allow pre-release versions in its marketplace.

• Appropriate: This clarification explains versioning strategy differences
• Well-placed: Added to Development Notes section where it belongs
• Helpful: Prevents confusion about version mismatches in the VSCode extension package

Recommendations

1. ✅ Approve: The changes are well-executed and follow established patterns
2. ✅ Consistent: Export matches other packages in the monorepo
3. ✅ Safe: Low-risk configuration change with no breaking changes
4. Optional: Consider adding a brief test to verify the new package.json export works correctly

Overall Assessment

This is a well-crafted maintenance PR that:

• Brings the sql.js dialect package in line with other packages
• Improves module resolution capabilities
• Adds helpful documentation context
• Introduces no risks or breaking changes

Recommendation: ✅ Approve and merge

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

CLAUDE.md (1)

85-85: Tighten wording and fix product name ("VS Code")

Suggest minor grammar/style tweaks.

- - The "ide/vscode" package by-design has a different version from the rest of the packages as VSCode doesn't allow pre-release versions in its marketplace.
+ - The "ide/vscode" package, by design, uses a different version than the rest because the VS Code Marketplace doesn't allow pre-release versions.

packages/dialects/sql.js/package.json (1)

28-32: Add default subpath export and document JSON import assertions

The exports["./package.json"] entry currently only covers CJS and ESM without a default condition. Add the "default" condition for broader tool compatibility and update the package’s README to document ESM JSON imports requiring assert { type: 'json' }.

         },
-        "./package.json": {
-            "import": "./package.json",
-            "require": "./package.json"
-        }
+        "./package.json": {
+            "import": "./package.json",
+            "require": "./package.json",
+            "default": "./package.json"
+        }

📜 Review details

Configuration used: Path: .coderabbit.yaml

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 cc8af45 and ae82cf5.

📒 Files selected for processing (2)

• CLAUDE.md (1 hunks)
• packages/dialects/sql.js/package.json (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

{packages,samples,tests}/**

📄 CodeRabbit inference engine (CLAUDE.md)

Packages are located in packages/, samples/, and tests/

Files:

• packages/dialects/sql.js/package.json

🧠 Learnings (1)

📚 Learning: 2025-08-04T08:43:33.161Z

Learnt from: CR
PR: zenstackhq/zenstack-v3#0
File: CLAUDE.md:0-0
Timestamp: 2025-08-04T08:43:33.161Z
Learning: Database migrations still use Prisma CLI under the hood

Applied to files:

• CLAUDE.md

🪛 LanguageTool

CLAUDE.md

[grammar] ~85-~85: There might be a mistake here.
Context: ...pre-release versions in its marketplace.

(QB_NEW_EN)

⏰ 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). (2)

• GitHub Check: claude-review
• GitHub Check: build-test (20.x)