-
Notifications
You must be signed in to change notification settings - Fork 13
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Bump up proto files to the latest #149
Conversation
WalkthroughThe recent updates to the Yorkie API involve enhancements and additions across several message types and enums. Key changes include new fields in Changes
Poem
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
Outside diff range and nitpick comments (1)
src/api/yorkie/v1/resources_pb.js (1)
Line range hint
20-21
: Remove redundant 'use strict' directive.- "use strict";
As per ECMAScript modules' specification, the entire contents are automatically in strict mode. The explicit declaration is redundant and can be safely removed.
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- src/api/yorkie/v1/resources.proto (5 hunks)
- src/api/yorkie/v1/resources_pb.d.ts (7 hunks)
- src/api/yorkie/v1/resources_pb.js (8 hunks)
Additional context used
Biome
src/api/yorkie/v1/resources_pb.js
[error] 20-21: Redundant use strict directive. (lint/suspicious/noRedundantUseStrict)
The entire contents of JavaScript modules are automatically in strict mode, with no statement needed to initiate it.
Safe fix: Remove the redundant use strict directive.
Additional comments not posted (21)
src/api/yorkie/v1/resources.proto (7)
114-114
: Addedcreated_at_map_by_actor
field toOperation_Style
.This addition aligns with the updates in the corresponding JavaScript and TypeScript files, ensuring consistency across implementations.
127-127
: Addedsplit_level
field toOperation_TreeEdit
.This field is crucial for managing tree edits at different levels, enhancing the flexibility of tree operations.
136-137
: Addedattributes_to_remove
and updatedcreated_at_map_by_actor
inOperation_TreeStyle
.These additions allow for more granular control over style attributes in tree structures, which is beneficial for dynamic styling scenarios.
229-229
: Addedis_removed
field toNodeAttr
.This field is essential for tracking the removal status of nodes, which can be critical for rendering decisions and state management in client applications.
365-366
: AddedDOC_EVENT_TYPE_DOCUMENT_BROADCAST
toDocEventType
.This new enum value supports a broader range of document-related events, potentially enhancing real-time collaboration features.
368-370
: IntroducedDocEventBody
with fieldstopic
andpayload
.This new message type enriches the capabilities of document events by allowing custom data to be transmitted alongside event notifications.
376-376
: Addedbody
field toDocEvent
.This optional field allows for the inclusion of
DocEventBody
, providing flexibility in event handling by including additional context or data.src/api/yorkie/v1/resources_pb.js (7)
58-58
: AddedDOCUMENT_BROADCAST
toDocEventType
enum.This addition ensures that the enum in the JavaScript file is consistent with the proto definition, supporting the new document broadcast event type.
242-242
: Addedcreated_at_map_by_actor
toOperation_Style
.This field mirrors the addition in the proto file, maintaining consistency across different implementations of the API.
271-271
: Addedsplit_level
toOperation_TreeEdit
.This field is crucial for managing edits at different levels of the tree structure, aligning with the proto changes.
288-289
: Addedattributes_to_remove
and updatedcreated_at_map_by_actor
inOperation_TreeStyle
.These changes enhance the flexibility and control over tree styling operations, consistent with the proto updates.
439-439
: Addedis_removed
field toNodeAttr
.This addition is crucial for accurately representing the state of node attributes, particularly their removal status, aligning with the proto changes.
655-665
: IntroducedDocEventBody
message type with fieldstopic
andpayload
.This addition enriches the event system by allowing custom data to be associated with document events, consistent with the proto updates.
674-674
: Addedbody
field toDocEvent
.This update allows for the inclusion of
DocEventBody
, providing flexibility in how document events are handled and what data they can carry.src/api/yorkie/v1/resources_pb.d.ts (7)
118-121
: Added new enum valueDOCUMENT_BROADCAST
toDocEventType
.This addition aligns with the updates in the proto files and ensures the TypeScript definitions are consistent with the backend specifications.
649-652
: AddedcreatedAtMapByActor
field toOperation_Style
.This field likely tracks the creation times of styles by different actors, which could be useful for conflict resolution or history tracking in a collaborative environment.
732-735
: AddedsplitLevel
field toOperation_TreeEdit
.This field seems to be intended for managing hierarchical data structures more efficiently, possibly related to how deep the tree edits should apply.
786-794
: AddedattributesToRemove
andcreatedAtMapByActor
fields toOperation_TreeStyle
.These additions enhance the functionality of tree styling operations, allowing for more granular control over style attributes and tracking their creation times.
1231-1234
: AddedisRemoved
field toNodeAttr
.This field is essential for tracking the deletion state of node attributes, which is crucial for undo/redo functionality and synchronization of document states.
1851-1877
: IntroducedDocEventBody
class with fieldstopic
andpayload
.This new class supports the encapsulation of event data, making the event handling system more robust and flexible by allowing arbitrary data to be associated with document events.
1893-1896
: Added optionalbody
field toDocEvent
.This change allows
DocEvent
to carry detailed event data, enhancing the event system's capabilities to handle complex scenarios.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for your contribution.
What this PR does / why we need it?
Bump up proto files to the latest
Any background context you want to provide?
What are the relevant tickets?
Fixes #
Checklist
Summary by CodeRabbit
New Features
DOCUMENT_BROADCAST
type.DocEventBody
to encapsulate event details, improving event management and tracking.Bug Fixes
createdAtMapByActor
andisRemoved
.