@storix-js/vuex

Vuex bridge helpers for Storix.

Install

npm install @storix-js/core @storix-js/vuex

Usage

import { createVuexBridge, applyVuexPatchMutation } from '@storix-js/vuex';

const bridge = createVuexBridge({
  store: useAppStore(),
  vuex: vuexStore,
  mutationType: 'storix/APPLY_PATCH',
  immutable: true,
  outboundRoutes: {
    todos: {
      mode: 'dispatch',
      type: 'syncTodosFromStorix',
      mapPayload: ({ storixSnapshot }) => storixSnapshot.todos
    },
    selectedId: {
      mode: 'commit',
      type: 'SET_SELECTED_ID',
      mapPayload: ({ storixSnapshot }) => storixSnapshot.selectedId
    }
  }
});

v1 routing support

createVuexBridge() supports a minimal v1 routing model for Storix -> Vuex writes:

• default patch mode via mutationType
• per-key outbound routes with patch, commit, dispatch, or custom
• optional bridge-echo suppression via suppressBridgeEcho

This keeps simple integrations patch-based while allowing special keys to flow through Vuex business logic.

Use applyVuexPatchMutation() inside your Vuex mutation to apply the incoming patch payload.