chore(runtime): create a separate export for edge

[ymc9]

Summary by CodeRabbit

• New Features

  • Introduced new enhancements in the ZenStack Language Tools.
  • Added new exports to the @zenstackhq/runtime package.

• Chores

  • Updated version numbers across various packages and plugins to "2.0.0-beta.15".

• Refactor

  • Adjusted internal import locations for enhancement functionalities in the ZenStack Language Tools.

[coderabbitai]

Walkthrough

Walkthrough

This update primarily advances the version of various packages from "2.0.0-beta.14" to "2.0.0-beta.15" across the ZenStack project. It introduces a new file to support edge environments and modifies import paths to enhance the API generation process. This aligns with efforts to improve compatibility and functionality in edge computing scenarios.

Changes

File or Directory	Change Summary
package.json in multiple directories	Updated version from "2.0.0-beta.14" to "2.0.0-beta.15"
packages/ide/jetbrains/build.gradle.kts	Version updated to "2.0.0-beta.15"
packages/ide/jetbrains/package.json	Version updated to "2.0.0-beta.15"
packages/runtime/package.json	Version updated; new exports added
packages/runtime/src/edge.ts	New file index.ts added
packages/schema/package.json	Version updated to "2.0.0-beta.15"
packages/schema/src/plugins/enhancer/enhance/index.ts	Modified import of createEnhancement

Possibly related issues

• ZenStack Issue [Feature Request] Compatibility with Edge Runtime #785: The addition of a new file in the runtime package for edge environments and the update in API generation process might address the objectives related to enhancing ZenStack's compatibility with edge environments like Vercel and CloudFlare. This aligns with the issue's goals of enabling ZenStack to run on edge platforms and improving the API generation to avoid dynamic require calls.

---

Recent Review Details

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 334b8d3 and 9d7cc5c.

Files selected for processing (16)

• package.json (1 hunks)
• packages/ide/jetbrains/build.gradle.kts (1 hunks)
• packages/ide/jetbrains/package.json (1 hunks)
• packages/language/package.json (1 hunks)
• packages/misc/redwood/package.json (1 hunks)
• packages/plugins/openapi/package.json (1 hunks)
• packages/plugins/swr/package.json (1 hunks)
• packages/plugins/tanstack-query/package.json (1 hunks)
• packages/plugins/trpc/package.json (1 hunks)
• packages/runtime/package.json (3 hunks)
• packages/runtime/src/edge.ts (1 hunks)
• packages/schema/package.json (1 hunks)
• packages/schema/src/plugins/enhancer/enhance/index.ts (1 hunks)
• packages/sdk/package.json (1 hunks)
• packages/server/package.json (1 hunks)
• packages/testtools/package.json (1 hunks)

Files skipped from review due to trivial changes (8)

• package.json
• packages/ide/jetbrains/package.json
• packages/language/package.json
• packages/plugins/trpc/package.json
• packages/schema/package.json
• packages/sdk/package.json
• packages/server/package.json
• packages/testtools/package.json

Additional comments not posted (9)

packages/runtime/src/edge.ts (1)

1-1: Ensure the file is correctly named and located as index.ts in the src directory of the @zenstackhq/runtime package.

packages/plugins/openapi/package.json (1)

4-4: Version update to "2.0.0-beta.15" is consistent with the PR objectives for a uniform version increment across the ZenStack suite.

packages/misc/redwood/package.json (1)

4-4: Version update to "2.0.0-beta.15" is consistent with the PR objectives for a uniform version increment across the ZenStack suite.

packages/plugins/swr/package.json (1)

4-4: Version update to "2.0.0-beta.15" is consistent with the PR objectives for a uniform version increment across the ZenStack suite.

packages/ide/jetbrains/build.gradle.kts (1)

12-12: Version update to "2.0.0-beta.15" is consistent with the PR objectives for a uniform version increment across the ZenStack suite.

packages/runtime/package.json (2)

4-4: Version update to "2.0.0-beta.15" is consistent with the PR objectives for a uniform version increment across the ZenStack suite.

---

18-48: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [21-68]

Verify that the new exports (./edge, ./enhancements, ./zod/input, ./zod/models, ./zod/objects, ./models) are correctly implemented and necessary for the intended functionalities.

packages/plugins/tanstack-query/package.json (1)

4-4: Version update to "2.0.0-beta.15" is consistent with the PR objectives for a uniform version increment across the ZenStack suite.

packages/schema/src/plugins/enhancer/enhance/index.ts (1)

89-90: Verify that the new import path for createEnhancement is correct and that the function is appropriately used in the context of the enhancements.

Verification successful

---

The verification process has confirmed that the createEnhancement function exists at the specified location (@zenstackhq/runtime/enhancements) as indicated by its presence in the file packages/runtime/src/enhancements/create-enhancement.ts. This aligns with the import statement used in the enhance.ts file, confirming that the import path is correct and appropriately used.

• File: packages/runtime/src/enhancements/create-enhancement.ts - Confirms the existence and location of createEnhancement.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Check for the existence of the `createEnhancement` function in the specified new location within the runtime package
ast-grep --lang typescript --pattern $'import { createEnhancement } from "@zenstackhq/runtime/enhancements";'

Length of output: 110

---

---

Script:

#!/bin/bash
# Search for the `createEnhancement` function across the `@zenstackhq/runtime` package to confirm its existence and correct import path
rg "export function createEnhancement" -g "*.ts" --files-with-matches

Length of output: 127

---

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:

Note: Auto-reply has been disabled for this repository by the repository owner. 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.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @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: 1

[coderabbitai]

Tip

Codebase Verification

The verification process has identified that most of the specified modules exist within the packages/runtime/src/ directory. However, there are some discrepancies:

• The enhancements module does not exist as a single file; instead, there is a file named enhancements/types.ts, which might suggest a different structure or partial implementation.
• There is no file named enhance.ts.

Given these findings, further review or adjustments might be necessary to ensure all components are correctly implemented, especially in the context of edge computing.

• packages/runtime/src/error.ts
• packages/runtime/src/types.ts
• packages/runtime/src/validation.ts
• packages/runtime/src/version.ts
• packages/runtime/src/enhancements/types.ts (Possible structure issue)
• No enhance.ts file found

Analysis chain

Verify that all exported modules (enhancements, error, types, validation, version, enhance) exist and are correctly implemented, especially in the context of edge computing.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Check for the existence of the specified modules in the runtime package
fd '(enhancements|error|types|validation|version|enhance)\.ts' --type f --full-path packages/runtime/src/

Length of output: 313