RuimteDocs

Changes to the API

What changed in the extension API, and what to change in an extension that was written before.

API version 1 is a preview. It goes to a small group of invited developers first, and it can still change before Ruimte offers extensions to everyone. Every change lands on this page, newest first, with what an extension has to do about it.

1, preview, first changes (November 2026)

  • getServer calls the server part outside a component, such as in a command's run. An extension needs no change.
  • createTestHost throws for an option or an answer it does not know. A test that gave server beside answers fails now, and passes again with server under answers, where it was always read.

1, preview (November 2026)

The first version shared with invited developers.

  • Every call that can fail for an expected reason answers a Result, so an extension checks ok instead of catching.
  • The client and the server part use the same shapes: NodeRef, ViewRef, near, and typed events on both sides.
  • @ruimte/extension/testing runs an extension's client and server part without Ruimte: createTestHost, render and createTestServer.
  • The store is not open yet. Share an extension as a .rex and install it with Install from disk in Settings, Extensions.