Rstore Vue

Build typed, cache-first Vue data flows with @rstore/vue, including core engine and shared contract behavior.

Documentation map

Core concepts

Quick start

import { createStore, RstorePlugin, withItemType } from '@rstore/vue'

export const todos = withItemType<Todo>().defineCollection({
  name: 'todos',
})

const store = await createStore({
  schema: [todos],
  plugins: [],
})

app.use(RstorePlugin, { store })

Task workflow

1. Define collections and relations first.
2. Create a store with createStore({ schema, plugins }).
3. Install RstorePlugin in app code or set setActiveStore(store) in tests/non-injection contexts.
4. Use collection APIs (find*, query, liveQuery) instead of custom fetch refs.
5. Use createForm/updateForm for mutation UIs and createFormObject for custom flows.
6. Move transport/data-source behavior into definePlugin hooks, not component-level code.
7. When behavior is unclear, check docs and skill references first; if docs are incomplete or wrong, fix docs before updating this skill.

Query and form guidance

Notes:

• createFormObject supports validateOnSubmit, transformData, resetOnSuccess, $changedProps, and $valid.
• Form objects expose $opLog for undo/redo and optimized form operations.
• Use $rebase, $conflicts, and $resolveConflict for collaborative editing flows.
• $save() and $onSaved() are deprecated compatibility aliases. Prefer $submit() and $onSuccess().

Modules and plugins

• defineModule(name, cb) caches module instances in store.$modulesCache.
• defineModule requires injection context or an explicit/active store.
• definePlugin({ name, category, scopeId?, setup }) is the extension point for fetch/cache/mutation/subscription/sync hooks.
• realtimeReconnectEventHook should be triggered by realtime plugins only after transport recovery; liveQuery refreshes automatically when it fires.
• addCollectionDefaults(...) is the right place for shared field parsing/default behavior.
• Keep plugin behavior keyed by store/scope instead of global mutable state.

Guardrails

1. Calling useStore() without installation/active store throws.
2. defineModule outside setup without an available store throws.
3. Query no-cache and cache-* behaviors differ materially; align changes with the documented query fetch-policy behavior.
4. experimentalGarbageCollection affects query tracking behavior; use only with explicit coverage.
5. Dynamic store.$collection(name) calls throw for unknown collection names.
6. Avoid duplicating entity state outside store cache unless intentionally divergent.

References

Further reading

• Guide index: https://rstore.akryum.dev/guide/learn-more
• Query docs: https://rstore.akryum.dev/guide/data/query
• Mutation docs: https://rstore.akryum.dev/guide/data/mutation
• Form docs: https://rstore.akryum.dev/guide/data/form
• Plugin hook docs: https://rstore.akryum.dev/guide/plugin/hooks