@storix-js/vuex 0.1.0 → 0.1.1

package/README.md

@@ -0,0 +1,24 @@
+# @storix-js/vuex
+
+Vuex bridge helpers for Storix.
+
+## Install
+
+```bash
+npm install @storix-js/core @storix-js/vuex
+```
+
+## Usage
+
+```ts
+import { createVuexBridge, applyVuexPatchMutation } from '@storix-js/vuex';
+
+const bridge = createVuexBridge({
+  store: useAppStore(),
+  vuex: vuexStore,
+  mutationType: 'storix/APPLY_PATCH',
+  immutable: true
+});
+```
+
+Use `applyVuexPatchMutation()` inside your Vuex mutation to apply the incoming patch payload.

package/package.json

@@ -1,10 +1,17 @@
 {
   "name": "@storix-js/vuex",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -19,6 +26,6 @@
     "typecheck": "tsc -p tsconfig.json --noEmit"
   },
   "dependencies": {
-    "@storix-js/core": "workspace:*"
+    "@storix-js/core": "^0.1.1"
   }
 }

package/src/index.ts

@@ -1,91 +0,0 @@
-import {
-  createExternalStoreBridge,
-  isolateSnapshot,
-  type ExternalStoreBridgeHandle,
-  type StoreInstance
-} from '@storix-js/core';
-
-type AnyObject = Record<string, unknown>;
-
-export interface VuexLikeStore<TState extends AnyObject> {
-  state: TState;
-  subscribe(listener: (mutation: unknown, state: TState) => void): () => void;
-  commit(type: string, payload?: unknown): void;
-}
-
-export interface CreateVuexBridgeOptions<TVuexState extends AnyObject> {
-  store: StoreInstance;
-  vuex: VuexLikeStore<TVuexState>;
-  mutationType?: string;
-  projectVuexToStorix?: (state: TVuexState) => Record<string, unknown>;
-  projectStorixToVuex?: (snapshot: Record<string, unknown>) => Record<string, unknown>;
-  equals?: (current: unknown, next: unknown, key: string) => boolean;
-  clone?: <T>(value: T) => T;
-  immutable?: boolean;
-  externalMutationOrigin?: 'local' | 'remote';
-}
-
-const isObjectLike = (value: unknown): value is AnyObject => {
-  return value !== null && typeof value === 'object';
-};
-
-export function deepFreeze<T>(value: T): T {
-  if (!isObjectLike(value)) return value;
-
-  const seen = new WeakSet<object>();
-
-  const freezeRecursively = (candidate: unknown): void => {
-    if (!isObjectLike(candidate)) return;
-
-    const objectCandidate = candidate as object;
-    if (seen.has(objectCandidate)) return;
-    seen.add(objectCandidate);
-
-    const keys = Reflect.ownKeys(objectCandidate);
-    for (const key of keys) {
-      const nested = Reflect.get(objectCandidate, key);
-      freezeRecursively(nested);
-    }
-
-    Object.freeze(objectCandidate);
-  };
-
-  freezeRecursively(value);
-  return value;
-}
-
-export function applyVuexPatchMutation<TState extends AnyObject>(state: TState, patch: Record<string, unknown>) {
-  for (const [key, value] of Object.entries(patch)) {
-    (state as AnyObject)[key] = value;
-  }
-}
-
-export function createVuexBridge<TVuexState extends AnyObject>(
-  options: CreateVuexBridgeOptions<TVuexState>
-): ExternalStoreBridgeHandle {
-  const mutationType = options.mutationType ?? 'storix/APPLY_PATCH';
-  const immutable = options.immutable ?? true;
-  const baseClone = options.clone ?? isolateSnapshot;
-
-  const clone = <T>(value: T): T => {
-    const next = baseClone(value);
-    if (!immutable) return next;
-    return deepFreeze(next);
-  };
-
-  return createExternalStoreBridge({
-    store: options.store,
-    getExternalState: () => options.vuex.state,
-    subscribeExternal: (listener) => {
-      return options.vuex.subscribe(() => listener());
-    },
-    applyExternalPatch: (patch) => {
-      options.vuex.commit(mutationType, clone(patch));
-    },
-    projectExternalToStore: options.projectVuexToStorix,
-    projectStoreToExternal: options.projectStorixToVuex,
-    equals: options.equals,
-    clone,
-    externalMutationOrigin: options.externalMutationOrigin ?? 'local'
-  });
-}

package/tsconfig.build.json

@@ -1,8 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "rootDir": "src",
-    "outDir": "dist",
-    "paths": {}
-  }
-}

package/tsconfig.json

@@ -1,4 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "include": ["src"]
-}

package/vite.config.ts

@@ -1,15 +0,0 @@
-import { defineConfig } from 'vite';
-
-export default defineConfig({
-  build: {
-    lib: {
-      entry: 'src/index.ts',
-      name: 'StorixVuex',
-      fileName: 'index',
-      formats: ['es', 'cjs']
-    }
-  },
-  test: {
-    environment: 'node'
-  }
-});