Add ts_type property to IsOption and EveryIsOption - #956
Merged
Conversation
The license reports catch up with the version bump to `2.0.0-SNAPSHOT.440` made earlier on this branch. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The new property tells the name of a TypeScript interface for the annotated message type(s), similarly to the existing `java_type` property. The docs deliberately do not prescribe the base type of a generated interface: the TypeScript toolchain is not settled on Google Protobuf (`protoc`) — Buf is the likely choice — so implementation details stay out of the contract. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The new `ts-codegen-via-buf` project memory records that TypeScript codegen is likely to use Buf, so TS-facing docs in `options.proto` must stay implementation-neutral. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a TypeScript-oriented counterpart to the existing java_type option metadata in spine/options.proto, as groundwork for upcoming TS code generation, and updates the build/dependency metadata on the branch.
Changes:
- Add
ts_typefields toIsOptionandEveryIsOptioninbase/src/main/proto/spine/options.protoand extend the related option documentation. - Bump the published snapshot version to
.440and regenerate dependency/license reports. - Update buildSrc dependency definitions (Log4j2 version + SLF4J2 bridge coordinate; introduce Jackson 2.x BOM coordinates and wire them into
Boms.Optional).
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| version.gradle.kts | Bumps versionToPublish to 2.0.0-SNAPSHOT.440. |
| docs/dependencies/pom.xml | Updates documented dependency-report project version to .440. |
| docs/dependencies/dependencies.md | Regenerates dependency/license report with updated version and timestamp. |
| buildSrc/src/main/kotlin/io/spine/dependency/lib/Log4j2.kt | Updates Log4j2 version and adds log4j-slf4j2-impl coordinate constant. |
| buildSrc/src/main/kotlin/io/spine/dependency/lib/JacksonV2.kt | Introduces Jackson 2.x dependency/BOM coordinates for aligning transitive consumers. |
| buildSrc/src/main/kotlin/io/spine/dependency/lib/Jackson.kt | Updates Jackson docs to reference Jackson 2.x artifacts being declared separately. |
| buildSrc/src/main/kotlin/io/spine/dependency/boms/Boms.kt | Switches Boms.Optional.jackson to point at the Jackson 2.x BOM. |
| base/src/main/proto/spine/options.proto | Adds ts_type to IsOption/EveryIsOption and updates option docs for TypeScript targeting. |
| .agents/tasks/add-ts-type-option.md | Agent task artifact (not reviewed per org policy for .agents/** in consumer repos). |
| .agents/memory/project/ts-codegen-via-buf.md | Agent memory artifact (not reviewed per org policy for .agents/** in consumer repos). |
| .agents/memory/MEMORY.md | Agent memory index update (not reviewed per org policy for .agents/** in consumer repos). |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #956 +/- ##
=======================================
Coverage 94.01% 94.01%
=======================================
Files 194 194
Lines 4177 4177
Branches 345 345
=======================================
Hits 3927 3927
Misses 149 149
Partials 101 101 🚀 New features to boost your workflow:
|
alexander-yevsyukov
enabled auto-merge
August 11, 2026 20:13
armiol
approved these changes
Aug 12, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a
ts_typestring property to theIsOptionandEveryIsOptionmessage types inspine/options.proto, telling the name of a TypeScript interface for the annotated message type(s) — the TypeScript counterpart of the existingjava_typeproperty:IsOption.ts_type = 2— the interface the generated message type implements; must exist.EveryIsOption.ts_type = 3— the common interface for all message types of a file; interplay with thegenerateflag mirrorsjava_type.(is)/(every_is)extension-field docs gain "When targeting TypeScript…" sentences, and both message-level docs now mentionts_type.Why
Groundwork for TypeScript code generation support in the Spine SDK. No consumer of
ts_typeexists yet anywhere in the organization; enforcement of the documented constraints (interface must exist, build fails on a nested interface) lands together with the TS codegen.Notes for reviewers
protobuf-es) rather than thegoogle-protobufprotocstack, so implementation specifics stay out of the contract. Rationale is recorded in.agents/memory/project/ts-codegen-via-buf.md.+10bump (.430→.440). Local review flagged that+1(.431) would match a purely additive change per the version policy — keep.440if the jump is intended to cover theconfig/dependency updates floated onto this branch, otherwise it can be re-bumped before merge..agentstask plan and team memory land in a separate commit for standalone review.🤖 Generated with Claude Code