Export VersionVector

[chacha912]

What this PR does / why we need it?

Export VersionVector class to support applySnapshot that requires VersionVector

Any background context you want to provide?

What are the relevant tickets?

Fixes #

Checklist

• Added relevant tests or not required
• Didn't break anything

Summary by CodeRabbit

• New Features
  • Introduced a new export, VersionVector, enhancing the functionality of the SDK for users.

[coderabbitai]

Walkthrough

The changes introduce a new export called VersionVector from the module @yorkie-js-sdk/src/document/time/version_vector in the yorkie.ts file. This addition enhances the available functionalities of the module without altering existing exports, logic, or control flow. The structure of the exports remains intact, ensuring a seamless integration of the new entity.

Changes

File Path	Change Summary
packages/sdk/src/yorkie.ts	Added new export: VersionVector from @yorkie-js-sdk/src/document/time/version_vector

Sequence Diagram(s)

sequenceDiagram
    participant C as Consumer
    participant Y as Yorkie Module
    C->>Y: Import VersionVector
    Y-->>C: Provide VersionVector

Loading

🐇 "In the code where bunnies play,
A new export hops in today!
VersionVector joins the fun,
Enhancing features, one by one.
With every change, we leap and cheer,
A brighter future, oh so near!" 🌟

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between bd5e50f and bb85f83.

📒 Files selected for processing (1)

• packages/sdk/src/yorkie.ts (1 hunks)

🧰 Additional context used

🔇 Additional comments (2)

packages/sdk/src/yorkie.ts (2)

65-65: LGTM! Export statement is correctly placed.

The VersionVector export is appropriately positioned among related time-based exports and follows the consistent export syntax pattern.

---

65-65: Verify if VersionVector should be added to default exports.

The VersionVector is exported but not included in the default export object or global assignment. If this is intended for internal use only, this is fine. However, if it's meant to be part of the public API (given it's needed for applySnapshot), consider adding it to both exports.

Let's check if other files are using VersionVector through the default export:

Also applies to: 124-146

✅ Verification successful

Let me gather more information about the usage and context of VersionVector.

---

Based on the analysis of the codebase, I can now provide a final response regarding whether VersionVector should be added to default exports.

VersionVector should remain as a named export only

The search results show that VersionVector is an internal implementation detail primarily used for:

1. Garbage collection functionality (seen in multiple test files using garbageCollect() with MaxVersionVector)
2. Change tracking and synchronization between clients (used in document/change/ modules)
3. Protocol buffer message handling (in api/ directory)

The class is not meant to be directly used by end users as part of the public API. Its current usage patterns show it's correctly exported as a named export for internal module consumption, while keeping the public API surface clean and focused.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for usage patterns of VersionVector through default export or global yorkie
rg "yorkie\.VersionVector|globalThis\.yorkie\.VersionVector"

Length of output: 62

---

Script:

#!/bin/bash
# Search for any imports or usage of VersionVector
rg "VersionVector" -A 2

# Check if VersionVector is used in type definitions or interfaces
ast-grep --pattern 'interface $_ {
  $$$
  VersionVector
  $$$
}'

# Look for files that might be using VersionVector through the SDK
fd "test|spec|example" -e ts -e js --exec rg "VersionVector" {}

Length of output: 72867

---

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:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • 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 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 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.

[hackerwins]

Thanks for your contribution.