@octanejs/tanstack-store

TanStack Store bindings for the Octane UI framework.

This package ports @tanstack/[email protected] by reusing the framework-agnostic @tanstack/store core unchanged and transcribing its small React hook layer onto Octane. The supported runtime and type surfaces match the React package, so an application can migrate by changing its import:

// before
import { createStore, useSelector } from '@tanstack/react-store'

// after
import { createStore, useSelector } from '@octanejs/tanstack-store'

import { createStore, useSelector } from '@octanejs/tanstack-store'

const counter = createStore({ count: 0 })

export function Counter() @{
  const count = useSelector(counter, (state) => state.count)

  <button
    onClick={() =>
      counter.setState((state) => ({ count: state.count + 1 }))
    }
  >
    {'Count: ' + count}
  </button>
}

API

The package re-exports all of @tanstack/[email protected], including atoms, stores, actions, derived sources, shallow, and async atoms. It also provides the stable adapter surface from @tanstack/[email protected]:

• useSelector reads any atom or store and supports a custom comparator.
• useAtom returns a writable atom's current value and setter.
• useCreateAtom and useCreateStore create a stable source for a component lifetime.
• createStoreContext transports typed bundles of atoms and stores through an Octane subtree.
• useStore remains available as the upstream-deprecated compatibility alias for useSelector.

The upstream experimental _useStore export is intentionally omitted. Use useSelector with store.actions or store.setState instead.

The adapter forwards Octane's compiler-assigned hook slots through its composed hooks. Distinct calls in one component therefore keep independent subscriptions and component-created sources, including when optional selector and comparator arguments are omitted.

Verification

Behavioral tests cover writable and derived sources, comparator semantics, source replacement, multiple hook call sites, context nesting, subscription cleanup, actions, and server rendering. Differential tests compile the same .tsrx fixture for Octane and React and compare rendered output after each interaction. Compile-time tests cover overload inference and readonly versus writable source constraints.

Current scope and verification status are tracked in the generated bindings status table, sourced from this package's status.json.