Skip to content

docs: reserve TypeScript bindings for 0.5.0 - #51

Merged
0xgleb merged 1 commit into
masterfrom
docs/0.5-typescript-bindings
Aug 15, 2026
Merged

0xgleb merged 1 commit into
masterfrom
docs/0.5-typescript-bindings

Conversation

@0xgleb

@0xgleb 0xgleb commented Jul 16, 2026 •

Copy link
Copy Markdown
Member

Record TypeScript bindings as the 0.5.0 direction and clarify the relationship between this experimental fork and the ST0x-owned original project.

Closes #85.


This is part 31 of 32 in a stack made with GitButler:

Summary by CodeRabbit

  • Documentation
    • Clarified the repository’s experimental status, ownership, and relationship to the original project.
    • Added a roadmap for a planned typed TypeScript binding in version 0.5.0.
    • Confirmed that TypeScript support is not included in version 0.4.0 and requires future compatibility decisions.

@coderabbitai

coderabbitai Bot commented Jul 16, 2026 •

Copy link
Copy Markdown

Review Change Stack

Walkthrough

The documentation now identifies the repository as an experimental Data Clique-maintained fork, clarifies its relationship to ST0x, and documents planned typed TypeScript bindings over the shared Rust engine for release 0.5.0.

Changes

Fork scope and TypeScript roadmap

Layer / File(s) Summary
Fork ownership and specification scope
README.md, SPEC.md
README.md and SPEC.md clarify the experimental fork’s ownership, maintenance boundaries, and relationship to the original ST0x project.
TypeScript binding direction
ROADMAP.md, SPEC.md
Documentation records planned typed TypeScript bindings for 0.5.0, reusing the shared Rust engine while remaining outside 0.4.0 scope.

Possibly related PRs

  • dataclique/event-sorcery#14: Updates release documentation around versioned engine contracts referenced by the planned TypeScript binding.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main documentation change: reserving TypeScript bindings for version 0.5.0.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/0.5-typescript-bindings

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

Comment @coderabbitai help to get the list of available commands.

@0xgleb 0xgleb self-assigned this Jul 16, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@ROADMAP.md`:
- Around line 41-45: Update the Release 0.5.0 statement in ROADMAP.md to
describe the typed TypeScript binding as intended or planned rather than
guaranteed. Preserve the existing details about the shared Rust engine and the
pending runtime, packaging, public API, specification, and compatibility
decisions.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 76fa5b71-361e-4b25-88cd-c9aae9763739

📥 Commits

Reviewing files that changed from the base of the PR and between f6f39bc and 62c0cc2.

📒 Files selected for processing (3)
  • README.md
  • ROADMAP.md
  • SPEC.md
📜 Review details
⏰ Context from checks skipped due to timeout. (6)
  • GitHub Check: clippy
  • GitHub Check: hooks
  • GitHub Check: examples
  • GitHub Check: fmt
  • GitHub Check: check
  • GitHub Check: test
🧰 Additional context used
📓 Path-based instructions (4)
**/*.{rs,toml,sql,md}

📄 CodeRabbit inference engine (AGENTS.md)

Read SPEC.md and docs/domain.md before doing work; update README.md and relevant docs when implementation or architecture changes.

Files:

  • README.md
  • ROADMAP.md
  • SPEC.md
**/*

📄 CodeRabbit inference engine (AGENTS.md)

**/*: Generated files must be placed under .tmp/; do not add ad-hoc top-level generated entries to .gitignore.
Do not read secret-bearing files such as .env*, credentials.json, *.key, *.pem, *.p12, or *.pfx without explicit permission.
Never bypass, disable, or suppress quality-control mechanisms without explicit permission; fix lint and test failures at their root.
Before handover, review the diff, revert unjustified changes, and check for scope creep.

Files:

  • README.md
  • ROADMAP.md
  • SPEC.md
*

⚙️ CodeRabbit configuration file

Focus on providing constructive criticism. Whenever you see a suboptimal approach, suggest more idiomatic or robust alternative(s). Flag potential footguns. Suggest FP alternatives to mutable/imperative code. Point out architectural flaws like leaky abstractions, tight coupling, wrong level of abstraction, poor type modeling, over-abstraction, unclear domain boundaries. Code should generally be organized based on business concerns rather than technical aspects - suggest improvements if you find violations. Point out gaps in test coverage but suggest tests that are not too coupled to the implementation and actually test domain invariants and business logic

Files:

  • README.md
  • ROADMAP.md
  • SPEC.md
**/*.md

⚙️ CodeRabbit configuration file

Focus on the contents of the docs and not on cosmetic things like markdown formatting. We use markdown files for various docs including but not limited to guidelines for AI contributors (AGENTS.md), project overview and instructions for human contributors (README.md), and topic-focused references under docs/ (cqrs.md, sqlx.md, ttdd.md). Think about the target audience of a document when deciding what comment to leave. For instructions, suggest better rules and guidelines and point out missing instructions. For topic references, suggest improvements that would make non-obvious framework behavior or pitfalls easier to discover. In all cases, flag needless bloat, prefer clear concise writing, and consider the structure of the document and order of the sections

Files:

  • README.md
  • ROADMAP.md
  • SPEC.md
🔇 Additional comments (2)
README.md (1)

24-32: LGTM!

SPEC.md (1)

20-24: LGTM!

Also applies to: 69-79

Comment thread ROADMAP.md Outdated
@0xgleb
0xgleb force-pushed the test/0.4-protocol-properties branch from f6f39bc to 7491299 Compare July 16, 2026 07:43
@0xgleb
0xgleb force-pushed the docs/0.5-typescript-bindings branch from 62c0cc2 to 1d420fb Compare July 16, 2026 07:43
@0xgleb
0xgleb force-pushed the test/0.4-protocol-properties branch from 7491299 to 3b9c05d Compare July 16, 2026 08:15
@0xgleb
0xgleb force-pushed the docs/0.5-typescript-bindings branch from 1d420fb to 58c8e36 Compare July 16, 2026 08:15
@0xgleb
0xgleb force-pushed the test/0.4-protocol-properties branch from 3b9c05d to c172781 Compare July 16, 2026 08:23
@0xgleb
0xgleb force-pushed the docs/0.5-typescript-bindings branch from 58c8e36 to e1f127b Compare July 16, 2026 08:23
@0xgleb 0xgleb added this to the 0.5.0 milestone Jul 16, 2026
@0xgleb 0xgleb moved this from Todo to In Progress in event-sorcery Jul 16, 2026
@0xgleb
0xgleb force-pushed the test/0.4-protocol-properties branch from c172781 to 7b2d843 Compare July 16, 2026 14:00
@0xgleb
0xgleb force-pushed the docs/0.5-typescript-bindings branch from e1f127b to 6c4d2dc Compare July 16, 2026 14:00
@0xgleb
0xgleb force-pushed the test/0.4-protocol-properties branch from 7b2d843 to 4611d3b Compare August 12, 2026 04:46
@0xgleb
0xgleb force-pushed the docs/0.5-typescript-bindings branch 2 times, most recently from 727bf34 to f8a9b9d Compare August 12, 2026 05:04
@0xgleb
0xgleb force-pushed the test/0.4-protocol-properties branch from 4611d3b to 12d6265 Compare August 12, 2026 05:04
@0xgleb
0xgleb force-pushed the test/0.4-protocol-properties branch from 12d6265 to a8fa575 Compare August 12, 2026 05:24
@0xgleb
0xgleb force-pushed the docs/0.5-typescript-bindings branch from f8a9b9d to 3217fbf Compare August 12, 2026 05:24
Base automatically changed from test/0.4-protocol-properties to master August 15, 2026 22:53
@0xgleb
0xgleb added this pull request to the merge queue Aug 15, 2026
Merged via the queue into master with commit 684b07a Aug 15, 2026
8 of 15 checks passed
@0xgleb
0xgleb deleted the docs/0.5-typescript-bindings branch August 15, 2026 22:59
@github-project-automation github-project-automation Bot moved this from In Progress to Done in event-sorcery Aug 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

TypeScript binding scope is undocumented

1 participant